1 /* 2 Open Asset Import Library (assimp) 3 ---------------------------------------------------------------------- 4 5 Copyright (c) 2006-2015, assimp team 6 All rights reserved. 7 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: 11 12 * Redistributions of source code must retain the above 13 copyright notice, this list of conditions and the 14 following disclaimer. 15 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. 20 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. 25 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. 37 38 ---------------------------------------------------------------------- 39 */ 40 41 /** @file FBXUtil.h 42 * @brief FBX utility functions for internal use 43 */ 44 #ifndef INCLUDED_AI_FBX_UTIL_H 45 #define INCLUDED_AI_FBX_UTIL_H 46 47 #include <string> 48 #include "FBXCompileConfig.h" 49 #include "FBXTokenizer.h" 50 51 namespace Assimp { 52 namespace FBX { 53 54 55 namespace Util { 56 57 58 /** helper for std::for_each to delete all heap-allocated items in a container */ 59 template<typename T> 60 struct delete_fun 61 { operatordelete_fun62 void operator()(const volatile T* del) { 63 delete del; 64 } 65 }; 66 67 /** Get a string representation for a #TokenType. */ 68 const 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 Colum index, 1-based 78 * @return A string of the following format: {prefix} (offset 0x{offset}) {text}*/ 79 std::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 Colum index, 1-based 88 * @return A string of the following format: {prefix} (line {line}, col {column}) {text}*/ 89 std::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}*/ 98 std::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