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