synfig-core/trunk/src/synfig/loadcanvas.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file loadcanvas.h
   3 **      \brief writeme
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007 Chris Moore
  10 **
  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.
  15 **
  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.
  20 **      \endlegal
  21 */
  22 /* ========================================================================= */
  23
  24 /* === S T A R T =========================================================== */
  25
  26 #ifndef __SYNFIG_LOADCANVAS_H
  27 #define __SYNFIG_LOADCANVAS_H
  28
  29 /* === H E A D E R S ======================================================= */
  30
  31 #include "string.h"
  32 #include "canvas.h"
  33 #include "valuenode.h"
  34 #include "vector.h"
  35 #include "value.h"
  36 #include "valuenode_subtract.h"
  37 #include "valuenode_animated.h"
  38 #include "valuenode_composite.h"
  39 #include "valuenode_dynamiclist.h"
  40 #include "keyframe.h"
  41 #include "guid.h"
  42
  43 /* === M A C R O S ========================================================= */
  44
  45 /* === T Y P E D E F S ===================================================== */
  46
  47 /* === C L A S S E S & S T R U C T S ======================================= */
  48
  49 namespace xmlpp { class Node; class Element; };
  50
  51 namespace synfig {
  52
  53 /*!     \class CanvasParser
  54 **      \todo writeme
  55 */
  56 class CanvasParser
  57 {
  58         /*
  59  --     ** -- D A T A -------------------------------------------------------------
  60         */
  61
  62 private:
  63
  64         int max_warnings_;
  65
  66     int total_warnings_;
  67
  68     int total_errors_;
  69
  70         bool allow_errors_;
  71
  72         String filename;
  73
  74         String path;
  75
  76         GUID guid_;
  77
  78         /*
  79  --     ** -- C O N S T R U C T O R S ---------------------------------------------
  80         */
  81
  82 public:
  83
  84         CanvasParser():
  85                 max_warnings_   (1000),
  86                 total_warnings_ (0),
  87                 total_errors_   (0),
  88                 allow_errors_   (false)
  89         { }
  90
  91         /*
  92  --     ** -- M E M B E R   F U N C T I O N S -------------------------------------
  93         */
  94
  95 public:
  96
  97         //! \todo writeme
  98         CanvasParser &set_allow_errors(bool x) { allow_errors_=x; return *this; }
  99
 100         //! Sets the maximum number of warnings before a fatal error is thrown
 101         CanvasParser &set_max_warnings(int i) { max_warnings_=i; return *this; }
 102
 103         //! Returns the maximum number of warnings before a fatal_error is thrown
 104         int get_max_warnings() { return max_warnings_; }
 105
 106         //! Returns the number of errors in the last parse
 107         int error_count()const { return total_errors_; }
 108
 109         //! Returns the number of warnings in the last parse
 110         int warning_count()const { return total_warnings_; }
 111
 112         void set_path(const synfig::String& x) { path=x; }
 113
 114         const synfig::String& get_path()const { return path; }
 115
 116         //! \todo writeme
 117         Canvas::Handle parse_from_file(const String &filename);
 118
 119         Canvas::Handle parse_from_file_as(const String &filename,const String &as);
 120
 121         //! \todo writeme
 122         Canvas::Handle parse_from_string(const String &data);
 123
 124 private:
 125
 126         // Error/Warning handling functions
 127
 128         void error(xmlpp::Node *node,const String &text);
 129         void fatal_error(xmlpp::Node *node,const String &text);
 130         void warning(xmlpp::Node *node,const String &text);
 131         void error_unexpected_element(xmlpp::Node *node,const String &got, const String &expected);
 132         void error_unexpected_element(xmlpp::Node *node,const String &got);
 133
 134         // Parsing Functions
 135
 136         Canvas::Handle parse_canvas(xmlpp::Element *node,Canvas::Handle parent=0,bool inline_=false, String path=".");
 137         void parse_canvas_defs(xmlpp::Element *node,Canvas::Handle canvas);
 138         etl::handle<Layer> parse_layer(xmlpp::Element *node,Canvas::Handle canvas);
 139         ValueBase parse_value(xmlpp::Element *node,Canvas::Handle canvas);
 140         etl::handle<ValueNode> parse_value_node(xmlpp::Element *node,Canvas::Handle canvas);
 141
 142         // ValueBase Parsing Functions
 143
 144         Real parse_real(xmlpp::Element *node);
 145         Time parse_time(xmlpp::Element *node,Canvas::Handle canvas);
 146         int parse_integer(xmlpp::Element *node);
 147         Vector parse_vector(xmlpp::Element *node);
 148         Color parse_color(xmlpp::Element *node);
 149         Angle parse_angle(xmlpp::Element *node);
 150         String parse_string(xmlpp::Element *node);
 151         bool parse_bool(xmlpp::Element *node);
 152         Segment parse_segment(xmlpp::Element *node);
 153         ValueBase parse_list(xmlpp::Element *node,Canvas::Handle canvas);
 154         Gradient parse_gradient(xmlpp::Element *node);
 155         BLinePoint parse_bline_point(xmlpp::Element *node);
 156
 157         Keyframe parse_keyframe(xmlpp::Element *node,Canvas::Handle canvas);
 158
 159         // ValueNode Parsing Functions
 160
 161         etl::handle<ValueNode_Animated> parse_animated(xmlpp::Element *node,Canvas::Handle canvas);
 162         etl::handle<ValueNode_Subtract> parse_subtract(xmlpp::Element *node,Canvas::Handle canvas);
 163         etl::handle<LinkableValueNode> parse_linkable_value_node(xmlpp::Element *node,Canvas::Handle canvas);
 164         etl::handle<ValueNode_Composite> parse_composite(xmlpp::Element *node,Canvas::Handle canvas);
 165         etl::handle<ValueNode_DynamicList> parse_dynamic_list(xmlpp::Element *node,Canvas::Handle canvas);
 166
 167 }; // END of CanvasParser
 168
 169 /* === E X T E R N S ======================================================= */
 170
 171 //!     Loads a canvas from \a filename
 172 /*!     \return The Canvas's handle on success, an empty handle on failure */
 173 extern Canvas::Handle open_canvas(const String &filename);
 174 extern Canvas::Handle open_canvas_as(const String &filename,const String &as);
 175
 176 //! Retrieves a Canvas from a string in XML format
 177 extern Canvas::Handle string_to_canvas(const String &data);
 178
 179 std::map<synfig::String, etl::loose_handle<Canvas> >& get_open_canvas_map();
 180
 181 }; // END of namespace synfig
 182
 183 /* === E N D =============================================================== */
 184
 185 #endif