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 FBXUtil.h
43 * @brief FBX utility functions for internal use
44 */
45#ifndef INCLUDED_AI_FBX_UTIL_H
46#define INCLUDED_AI_FBX_UTIL_H
47
48#include "FBXCompileConfig.h"
49#include "FBXTokenizer.h"
50
51namespace Assimp {
52namespace FBX {
53
54
55namespace Util {
56
57
58/** helper for std::for_each to delete all heap-allocated items in a container */
59template<typename T>
60struct delete_fun
61{
62 void operator()(const volatile T* del) {
63 delete del;
64 }
65};
66
67/** Get a string representation for a #TokenType. */
68const char* TokenTypeString(TokenType t);
69
70
71
72/** Format log/error messages using a given offset in the source binary file
73 *
74 * @param prefix Message prefix to be preprended to the location info.
75 * @param text Message text
76 * @param line Line index, 1-based
77 * @param column Column index, 1-based
78 * @return A string of the following format: {prefix} (offset 0x{offset}) {text}*/
79std::string AddOffset(const std::string& prefix, const std::string& text, unsigned int offset);
80
81
82/** Format log/error messages using a given line location in the source file.
83 *
84 * @param prefix Message prefix to be preprended to the location info.
85 * @param text Message text
86 * @param line Line index, 1-based
87 * @param column Column index, 1-based
88 * @return A string of the following format: {prefix} (line {line}, col {column}) {text}*/
89std::string AddLineAndColumn(const std::string& prefix, const std::string& text, unsigned int line, unsigned int column);
90
91
92/** Format log/error messages using a given cursor token.
93 *
94 * @param prefix Message prefix to be preprended to the location info.
95 * @param text Message text
96 * @param tok Token where parsing/processing stopped
97 * @return A string of the following format: {prefix} ({token-type}, line {line}, col {column}) {text}*/
98std::string AddTokenText(const std::string& prefix, const std::string& text, const Token* tok);
99
100}
101}
102}
103
104#endif // ! INCLUDED_AI_FBX_UTIL_H
105