vrshoot

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

find changesets by author, revision, files, or words in the commit message
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 FBXTokenizer.h
nuclear@0 42 * @brief FBX lexer
nuclear@0 43 */
nuclear@0 44 #ifndef INCLUDED_AI_FBX_TOKENIZER_H
nuclear@0 45 #define INCLUDED_AI_FBX_TOKENIZER_H
nuclear@0 46
nuclear@0 47 #include <boost/shared_ptr.hpp>
nuclear@0 48
nuclear@0 49 #include "FBXCompileConfig.h"
nuclear@0 50
nuclear@0 51 namespace Assimp {
nuclear@0 52 namespace FBX {
nuclear@0 53
nuclear@0 54 /** Rough classification for text FBX tokens used for constructing the
nuclear@0 55 * basic scope hierarchy. */
nuclear@0 56 enum TokenType
nuclear@0 57 {
nuclear@0 58 // {
nuclear@0 59 TokenType_OPEN_BRACKET = 0,
nuclear@0 60
nuclear@0 61 // }
nuclear@0 62 TokenType_CLOSE_BRACKET,
nuclear@0 63
nuclear@0 64 // '"blablubb"', '2', '*14' - very general token class,
nuclear@0 65 // further processing happens at a later stage.
nuclear@0 66 TokenType_DATA,
nuclear@0 67
nuclear@0 68 //
nuclear@0 69 TokenType_BINARY_DATA,
nuclear@0 70
nuclear@0 71 // ,
nuclear@0 72 TokenType_COMMA,
nuclear@0 73
nuclear@0 74 // blubb:
nuclear@0 75 TokenType_KEY
nuclear@0 76 };
nuclear@0 77
nuclear@0 78
nuclear@0 79 /** Represents a single token in a FBX file. Tokens are
nuclear@0 80 * classified by the #TokenType enumerated types.
nuclear@0 81 *
nuclear@0 82 * Offers iterator protocol. Tokens are immutable. */
nuclear@0 83 class Token
nuclear@0 84 {
nuclear@0 85
nuclear@0 86 private:
nuclear@0 87
nuclear@0 88 static const unsigned int BINARY_MARKER = static_cast<unsigned int>(-1);
nuclear@0 89
nuclear@0 90 public:
nuclear@0 91
nuclear@0 92 /** construct a textual token */
nuclear@0 93 Token(const char* sbegin, const char* send, TokenType type, unsigned int line, unsigned int column);
nuclear@0 94
nuclear@0 95 /** construct a binary token */
nuclear@0 96 Token(const char* sbegin, const char* send, TokenType type, unsigned int offset);
nuclear@0 97
nuclear@0 98 ~Token();
nuclear@0 99
nuclear@0 100 public:
nuclear@0 101
nuclear@0 102 std::string StringContents() const {
nuclear@0 103 return std::string(begin(),end());
nuclear@0 104 }
nuclear@0 105
nuclear@0 106 public:
nuclear@0 107
nuclear@0 108 bool IsBinary() const {
nuclear@0 109 return column == BINARY_MARKER;
nuclear@0 110 }
nuclear@0 111
nuclear@0 112 const char* begin() const {
nuclear@0 113 return sbegin;
nuclear@0 114 }
nuclear@0 115
nuclear@0 116 const char* end() const {
nuclear@0 117 return send;
nuclear@0 118 }
nuclear@0 119
nuclear@0 120 TokenType Type() const {
nuclear@0 121 return type;
nuclear@0 122 }
nuclear@0 123
nuclear@0 124 unsigned int Offset() const {
nuclear@0 125 ai_assert(IsBinary());
nuclear@0 126 return offset;
nuclear@0 127 }
nuclear@0 128
nuclear@0 129 unsigned int Line() const {
nuclear@0 130 ai_assert(!IsBinary());
nuclear@0 131 return line;
nuclear@0 132 }
nuclear@0 133
nuclear@0 134 unsigned int Column() const {
nuclear@0 135 ai_assert(!IsBinary());
nuclear@0 136 return column;
nuclear@0 137 }
nuclear@0 138
nuclear@0 139 private:
nuclear@0 140
nuclear@0 141 #ifdef DEBUG
nuclear@0 142 // full string copy for the sole purpose that it nicely appears
nuclear@0 143 // in msvc's debugger window.
nuclear@0 144 const std::string contents;
nuclear@0 145 #endif
nuclear@0 146
nuclear@0 147
nuclear@0 148 const char* const sbegin;
nuclear@0 149 const char* const send;
nuclear@0 150 const TokenType type;
nuclear@0 151
nuclear@0 152 union {
nuclear@0 153 const unsigned int line;
nuclear@0 154 unsigned int offset;
nuclear@0 155 };
nuclear@0 156 const unsigned int column;
nuclear@0 157 };
nuclear@0 158
nuclear@0 159 // XXX should use C++11's unique_ptr - but assimp's need to keep working with 03
nuclear@0 160 typedef const Token* TokenPtr;
nuclear@0 161 typedef std::vector< TokenPtr > TokenList;
nuclear@0 162
nuclear@0 163 #define new_Token new Token
nuclear@0 164
nuclear@0 165
nuclear@0 166 /** Main FBX tokenizer function. Transform input buffer into a list of preprocessed tokens.
nuclear@0 167 *
nuclear@0 168 * Skips over comments and generates line and column numbers.
nuclear@0 169 *
nuclear@0 170 * @param output_tokens Receives a list of all tokens in the input data.
nuclear@0 171 * @param input_buffer Textual input buffer to be processed, 0-terminated.
nuclear@0 172 * @throw DeadlyImportError if something goes wrong */
nuclear@0 173 void Tokenize(TokenList& output_tokens, const char* input);
nuclear@0 174
nuclear@0 175
nuclear@0 176 /** Tokenizer function for binary FBX files.
nuclear@0 177 *
nuclear@0 178 * Emits a token list suitable for direct parsing.
nuclear@0 179 *
nuclear@0 180 * @param output_tokens Receives a list of all tokens in the input data.
nuclear@0 181 * @param input_buffer Binary input buffer to be processed.
nuclear@0 182 * @param length Length of input buffer, in bytes. There is no 0-terminal.
nuclear@0 183 * @throw DeadlyImportError if something goes wrong */
nuclear@0 184 void TokenizeBinary(TokenList& output_tokens, const char* input, unsigned int length);
nuclear@0 185
nuclear@0 186
nuclear@0 187 } // ! FBX
nuclear@0 188 } // ! Assimp
nuclear@0 189
nuclear@0 190 #endif // ! INCLUDED_AI_FBX_PARSER_H