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