1 /*
2 Open Asset Import Library (assimp)
3 ----------------------------------------------------------------------
4 
5 Copyright (c) 2006-2012, 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  FBXDocumentUtil.h
42  *  @brief FBX internal utilities used by the DOM reading code
43  */
44 #ifndef INCLUDED_AI_FBX_DOCUMENT_UTIL_H
45 #define INCLUDED_AI_FBX_DOCUMENT_UTIL_H
46 
47 #include <assimp/defs.h>
48 #include <string>
49 #include <memory>
50 #include "FBXDocument.h"
51 
52 struct Token;
53 struct Element;
54 
55 namespace Assimp {
56 namespace FBX {
57 namespace Util {
58 
59 /* DOM/Parse error reporting - does not return */
60 AI_WONT_RETURN void DOMError(const std::string& message, const Token& token) AI_WONT_RETURN_SUFFIX;
61 AI_WONT_RETURN void DOMError(const std::string& message, const Element* element = NULL) AI_WONT_RETURN_SUFFIX;
62 
63 // does return
64 void DOMWarning(const std::string& message, const Token& token);
65 void DOMWarning(const std::string& message, const Element* element = NULL);
66 
67 
68 // fetch a property table and the corresponding property template
69 std::shared_ptr<const PropertyTable> GetPropertyTable(const Document& doc,
70     const std::string& templateName,
71     const Element &element,
72     const Scope& sc,
73     bool no_warn = false);
74 
75 // ------------------------------------------------------------------------------------------------
76 template <typename T>
77 inline
78 const T* ProcessSimpleConnection(const Connection& con,
79     bool is_object_property_conn,
80     const char* name,
81     const Element& element,
82     const char** propNameOut = nullptr)
83 {
84     if (is_object_property_conn && !con.PropertyName().length()) {
85         DOMWarning("expected incoming " + std::string(name) +
86             " link to be an object-object connection, ignoring",
87             &element
88             );
89         return nullptr;
90     }
91     else if (!is_object_property_conn && con.PropertyName().length()) {
92         DOMWarning("expected incoming " + std::string(name) +
93             " link to be an object-property connection, ignoring",
94             &element
95             );
96         return nullptr;
97     }
98 
99     if(is_object_property_conn && propNameOut) {
100         // note: this is ok, the return value of PropertyValue() is guaranteed to
101         // remain valid and unchanged as long as the document exists.
102         *propNameOut = con.PropertyName().c_str();
103     }
104 
105     const Object* const ob = con.SourceObject();
106     if(!ob) {
107         DOMWarning("failed to read source object for incoming " + std::string(name) +
108             " link, ignoring",
109             &element);
110         return nullptr;
111     }
112 
113     return dynamic_cast<const T*>(ob);
114 }
115 
116 } //!Util
117 } //!FBX
118 } //!Assimp
119 
120 #endif
121