1 /* === S Y N F I G ========================================================= */
3 ** \brief Implementation for the Synfig Canvas Loader (canvas file parser)
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2007, 2008 Chris Moore
10 ** Copyright (c) 2009 Carlos A. Sosa Navarro
12 ** This package is free software; you can redistribute it and/or
13 ** modify it under the terms of the GNU General Public License as
14 ** published by the Free Software Foundation; either version 2 of
15 ** the License, or (at your option) any later version.
17 ** This package is distributed in the hope that it will be useful,
18 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 ** General Public License for more details.
23 /* ========================================================================= */
25 /* === S T A R T =========================================================== */
27 #ifndef __SYNFIG_LOADCANVAS_H
28 #define __SYNFIG_LOADCANVAS_H
30 /* === H E A D E R S ======================================================= */
34 #include "valuenode.h"
37 #include "valuenode_subtract.h"
38 #include "valuenode_animated.h"
39 #include "valuenode_composite.h"
40 #include "valuenode_dynamiclist.h"
44 /* === M A C R O S ========================================================= */
46 /* === T Y P E D E F S ===================================================== */
48 /* === C L A S S E S & S T R U C T S ======================================= */
50 namespace xmlpp { class Node; class Element; };
54 /*! \class CanvasParser
55 ** \brief Class that handles xmlpp elements from a sif file and converts
56 * them into Synfig objects
61 -- ** -- D A T A -------------------------------------------------------------
65 //! Maximun number of allowed warnings before fatal error is thrown
67 //! Total number of warning during canvas parsing
69 //! Total number of errors during canvas parsing
71 //! True if errors doesn't stop canvas parsing
73 //! File name to parse
75 //! Path of the file name to parse
77 //! Error text when errors found
79 //! Warning text when warnings found
81 //! Seems not to be used
85 -- ** -- C O N S T R U C T O R S ---------------------------------------------
98 -- ** -- M E M B E R F U N C T I O N S -------------------------------------
103 //! Sets allow errors variable
104 CanvasParser &set_allow_errors(bool x) { allow_errors_=x; return *this; }
106 //! Sets the maximum number of warnings before a fatal error is thrown
107 CanvasParser &set_max_warnings(int i) { max_warnings_=i; return *this; }
109 //! Returns the maximum number of warnings before a fatal_error is thrown
110 int get_max_warnings() { return max_warnings_; }
112 //! Returns the number of errors in the last parse
113 int error_count()const { return total_errors_; }
115 //! Returns the number of warnings in the last parse
116 int warning_count()const { return total_warnings_; }
118 //! Sets the path of the file to parse
119 void set_path(const synfig::String& x) { path=x; }
121 //! Gets the path of the file to parse
122 const synfig::String& get_path()const { return path; }
124 //! Gets error text string
125 const synfig::String& get_errors_text()const { return errors_text; }
126 //! Gets warning text string
127 const synfig::String& get_warnings_text()const { return warnings_text; }
129 //! Register a canvas in the canvas map
130 /*! \param canvas The handle to the canvas to register
131 * \param as The absolute path to the file that represents the canvas
132 * Apart of store the pair canvas and */
133 static void register_canvas_in_map(Canvas::Handle canvas, String as);
136 static void show_canvas_map(String file, int line, String text);
139 //! Parse a Cavnas form a file with absolute path.
140 Canvas::Handle parse_from_file_as(const String &filename,const String &as,String &errors);
141 //! Parse a Canvas from a xmlpp root node
142 Canvas::Handle parse_as(xmlpp::Element* node,String &errors);
144 //! Set of absolute file names of the canvases currently being parsed
145 static std::set<String> loading_;
149 // Error/Warning handling functions
151 void error(xmlpp::Node *node,const String &text);
152 void fatal_error(xmlpp::Node *node,const String &text);
153 void warning(xmlpp::Node *node,const String &text);
154 void error_unexpected_element(xmlpp::Node *node,const String &got, const String &expected);
155 void error_unexpected_element(xmlpp::Node *node,const String &got);
159 Canvas::Handle parse_canvas(xmlpp::Element *node,Canvas::Handle parent=0,bool inline_=false, String path=".");
160 void parse_canvas_defs(xmlpp::Element *node,Canvas::Handle canvas);
161 etl::handle<Layer> parse_layer(xmlpp::Element *node,Canvas::Handle canvas);
162 ValueBase parse_value(xmlpp::Element *node,Canvas::Handle canvas);
163 etl::handle<ValueNode> parse_value_node(xmlpp::Element *node,Canvas::Handle canvas);
165 // ValueBase Parsing Functions
167 Real parse_real(xmlpp::Element *node);
168 Time parse_time(xmlpp::Element *node,Canvas::Handle canvas);
169 int parse_integer(xmlpp::Element *node);
170 Vector parse_vector(xmlpp::Element *node);
171 Color parse_color(xmlpp::Element *node);
172 Angle parse_angle(xmlpp::Element *node);
173 String parse_string(xmlpp::Element *node);
174 bool parse_bool(xmlpp::Element *node);
175 Segment parse_segment(xmlpp::Element *node);
176 ValueBase parse_list(xmlpp::Element *node,Canvas::Handle canvas);
177 Gradient parse_gradient(xmlpp::Element *node);
178 BLinePoint parse_bline_point(xmlpp::Element *node);
180 Keyframe parse_keyframe(xmlpp::Element *node,Canvas::Handle canvas);
182 // ValueNode Parsing Functions
184 etl::handle<ValueNode_Animated> parse_animated(xmlpp::Element *node,Canvas::Handle canvas);
185 etl::handle<ValueNode_Subtract> parse_subtract(xmlpp::Element *node,Canvas::Handle canvas);
186 etl::handle<LinkableValueNode> parse_linkable_value_node(xmlpp::Element *node,Canvas::Handle canvas);
187 etl::handle<ValueNode_DynamicList> parse_dynamic_list(xmlpp::Element *node,Canvas::Handle canvas);
189 }; // END of CanvasParser
191 /* === E X T E R N S ======================================================= */
193 //! Loads a canvas from \a filename
194 /*! \return The Canvas's handle on success, an empty handle on failure */
195 extern Canvas::Handle open_canvas(xmlpp::Element* node,String &errors,String &warnings);
196 extern Canvas::Handle open_canvas(const String &filename,String &errors,String &warnings);
197 extern Canvas::Handle open_canvas_as(const String &filename,const String &as,String &errors,String &warnings);
199 std::map<synfig::String, etl::loose_handle<Canvas> >& get_open_canvas_map();
201 }; // END of namespace synfig
203 /* === E N D =============================================================== */