1 /* === S Y N F I G ========================================================= */
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 ** Copyright (c) 2007, 2008 Chris Moore
11 ** This package is free software; you can redistribute it and/or
12 ** modify it under the terms of the GNU General Public License as
13 ** published by the Free Software Foundation; either version 2 of
14 ** the License, or (at your option) any later version.
16 ** This package is distributed in the hope that it will be useful,
17 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 ** General Public License for more details.
22 /* ========================================================================= */
24 /* === S T A R T =========================================================== */
26 #ifndef __SYNFIG_LOADCANVAS_H
27 #define __SYNFIG_LOADCANVAS_H
29 /* === H E A D E R S ======================================================= */
33 #include "valuenode.h"
36 #include "valuenode_subtract.h"
37 #include "valuenode_animated.h"
38 #include "valuenode_composite.h"
39 #include "valuenode_dynamiclist.h"
43 /* === M A C R O S ========================================================= */
45 /* === T Y P E D E F S ===================================================== */
47 /* === C L A S S E S & S T R U C T S ======================================= */
49 namespace xmlpp { class Node; class Element; };
53 /*! \class CanvasParser
59 -- ** -- D A T A -------------------------------------------------------------
82 -- ** -- C O N S T R U C T O R S ---------------------------------------------
95 -- ** -- M E M B E R F U N C T I O N S -------------------------------------
101 CanvasParser &set_allow_errors(bool x) { allow_errors_=x; return *this; }
103 //! Sets the maximum number of warnings before a fatal error is thrown
104 CanvasParser &set_max_warnings(int i) { max_warnings_=i; return *this; }
106 //! Returns the maximum number of warnings before a fatal_error is thrown
107 int get_max_warnings() { return max_warnings_; }
109 //! Returns the number of errors in the last parse
110 int error_count()const { return total_errors_; }
112 //! Returns the number of warnings in the last parse
113 int warning_count()const { return total_warnings_; }
115 void set_path(const synfig::String& x) { path=x; }
117 const synfig::String& get_path()const { return path; }
119 const synfig::String& get_errors_text()const { return errors_text; }
120 const synfig::String& get_warnings_text()const { return warnings_text; }
122 static void register_canvas_in_map(Canvas::Handle canvas, String as);
125 Canvas::Handle parse_from_file_as(const String &filename,const String &as,String &errors);
127 static std::set<String> loading_;
131 // Error/Warning handling functions
133 void error(xmlpp::Node *node,const String &text);
134 void fatal_error(xmlpp::Node *node,const String &text);
135 void warning(xmlpp::Node *node,const String &text);
136 void error_unexpected_element(xmlpp::Node *node,const String &got, const String &expected);
137 void error_unexpected_element(xmlpp::Node *node,const String &got);
141 Canvas::Handle parse_canvas(xmlpp::Element *node,Canvas::Handle parent=0,bool inline_=false, String path=".");
142 void parse_canvas_defs(xmlpp::Element *node,Canvas::Handle canvas);
143 etl::handle<Layer> parse_layer(xmlpp::Element *node,Canvas::Handle canvas);
144 ValueBase parse_value(xmlpp::Element *node,Canvas::Handle canvas);
145 etl::handle<ValueNode> parse_value_node(xmlpp::Element *node,Canvas::Handle canvas);
147 // ValueBase Parsing Functions
149 Real parse_real(xmlpp::Element *node);
150 Time parse_time(xmlpp::Element *node,Canvas::Handle canvas);
151 int parse_integer(xmlpp::Element *node);
152 Vector parse_vector(xmlpp::Element *node);
153 Color parse_color(xmlpp::Element *node);
154 Angle parse_angle(xmlpp::Element *node);
155 String parse_string(xmlpp::Element *node);
156 bool parse_bool(xmlpp::Element *node);
157 Segment parse_segment(xmlpp::Element *node);
158 ValueBase parse_list(xmlpp::Element *node,Canvas::Handle canvas);
159 Gradient parse_gradient(xmlpp::Element *node);
160 BLinePoint parse_bline_point(xmlpp::Element *node);
162 Keyframe parse_keyframe(xmlpp::Element *node,Canvas::Handle canvas);
164 // ValueNode Parsing Functions
166 etl::handle<ValueNode_Animated> parse_animated(xmlpp::Element *node,Canvas::Handle canvas);
167 etl::handle<ValueNode_Subtract> parse_subtract(xmlpp::Element *node,Canvas::Handle canvas);
168 etl::handle<LinkableValueNode> parse_linkable_value_node(xmlpp::Element *node,Canvas::Handle canvas);
169 etl::handle<ValueNode_DynamicList> parse_dynamic_list(xmlpp::Element *node,Canvas::Handle canvas);
171 }; // END of CanvasParser
173 /* === E X T E R N S ======================================================= */
175 //! Loads a canvas from \a filename
176 /*! \return The Canvas's handle on success, an empty handle on failure */
177 extern Canvas::Handle open_canvas(const String &filename,String &errors,String &warnings);
178 extern Canvas::Handle open_canvas_as(const String &filename,const String &as,String &errors,String &warnings);
180 std::map<synfig::String, etl::loose_handle<Canvas> >& get_open_canvas_map();
182 }; // END of namespace synfig
184 /* === E N D =============================================================== */