vrshoot

annotate libs/assimp/RemoveComments.h @ 0:b2f14e535253

initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
rev   line source
nuclear@0 1 /*
nuclear@0 2 Open Asset Import Library (assimp)
nuclear@0 3 ----------------------------------------------------------------------
nuclear@0 4
nuclear@0 5 Copyright (c) 2006-2012, assimp team
nuclear@0 6 All rights reserved.
nuclear@0 7
nuclear@0 8 Redistribution and use of this software in source and binary forms,
nuclear@0 9 with or without modification, are permitted provided that the
nuclear@0 10 following conditions are met:
nuclear@0 11
nuclear@0 12 * Redistributions of source code must retain the above
nuclear@0 13 copyright notice, this list of conditions and the
nuclear@0 14 following disclaimer.
nuclear@0 15
nuclear@0 16 * Redistributions in binary form must reproduce the above
nuclear@0 17 copyright notice, this list of conditions and the
nuclear@0 18 following disclaimer in the documentation and/or other
nuclear@0 19 materials provided with the distribution.
nuclear@0 20
nuclear@0 21 * Neither the name of the assimp team, nor the names of its
nuclear@0 22 contributors may be used to endorse or promote products
nuclear@0 23 derived from this software without specific prior
nuclear@0 24 written permission of the assimp team.
nuclear@0 25
nuclear@0 26 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0 27 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0 28 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0 29 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0 30 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0 31 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0 32 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0 33 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0 34 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0 35 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0 36 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0 37
nuclear@0 38 ----------------------------------------------------------------------
nuclear@0 39 */
nuclear@0 40
nuclear@0 41 /** @file Declares a helper class, "CommentRemover", which can be
nuclear@0 42 * used to remove comments (single and multi line) from a text file.
nuclear@0 43 */
nuclear@0 44 #ifndef AI_REMOVE_COMMENTS_H_INC
nuclear@0 45 #define AI_REMOVE_COMMENTS_H_INC
nuclear@0 46
nuclear@0 47 #include "assimp/ai_assert.h"
nuclear@0 48
nuclear@0 49 namespace Assimp {
nuclear@0 50
nuclear@0 51 // ---------------------------------------------------------------------------
nuclear@0 52 /** \brief Helper class to remove single and multi line comments from a file
nuclear@0 53 *
nuclear@0 54 * Some mesh formats like MD5 have comments that are quite similar
nuclear@0 55 * to those in C or C++ so this code has been moved to a separate
nuclear@0 56 * module.
nuclear@0 57 */
nuclear@0 58 class CommentRemover
nuclear@0 59 {
nuclear@0 60 // class cannot be instanced
nuclear@0 61 CommentRemover() {}
nuclear@0 62
nuclear@0 63 public:
nuclear@0 64
nuclear@0 65 //! Remove single-line comments. The end of a line is
nuclear@0 66 //! expected to be either NL or CR or NLCR.
nuclear@0 67 //! \param szComment The start sequence of the comment, e.g. "//"
nuclear@0 68 //! \param szBuffer Buffer to work with
nuclear@0 69 //! \param chReplacement Character to be used as replacement
nuclear@0 70 //! for commented lines. By default this is ' '
nuclear@0 71 static void RemoveLineComments(const char* szComment,
nuclear@0 72 char* szBuffer, char chReplacement = ' ');
nuclear@0 73
nuclear@0 74 //! Remove multi-line comments. The end of a line is
nuclear@0 75 //! expected to be either NL or CR or NLCR. Multi-line comments
nuclear@0 76 //! may not be nested (as in C).
nuclear@0 77 //! \param szCommentStart The start sequence of the comment, e.g. "/*"
nuclear@0 78 //! \param szCommentEnd The end sequence of the comment, e.g. "*/"
nuclear@0 79 //! \param szBuffer Buffer to work with
nuclear@0 80 //! \param chReplacement Character to be used as replacement
nuclear@0 81 //! for commented lines. By default this is ' '
nuclear@0 82 static void RemoveMultiLineComments(const char* szCommentStart,
nuclear@0 83 const char* szCommentEnd,char* szBuffer,
nuclear@0 84 char chReplacement = ' ');
nuclear@0 85 };
nuclear@0 86 } // ! Assimp
nuclear@0 87
nuclear@0 88 #endif // !! AI_REMOVE_COMMENTS_H_INC