b05f67c5d90a6ca86dcdf6f970e0dabbf7b79726
1 #ifndef __INK_EXTENSION_H__
2 #define __INK_EXTENSION_H__
4 /** \file
5 * Frontend to certain, possibly pluggable, actions.
6 */
8 /*
9 * Authors:
10 * Ted Gould <ted@gould.cx>
11 *
12 * Copyright (C) 2002-2005 Authors
13 *
14 * Released under GNU GPL, read the file 'COPYING' for more information
15 */
17 #include <ostream>
18 #include <fstream>
19 #include <vector>
20 #include <gtkmm/widget.h>
21 #include <gtkmm/box.h>
22 #include <gtkmm/table.h>
23 #include <glibmm/ustring.h>
24 #include "xml/repr.h"
25 #include "document.h"
26 #include "extension/extension-forward.h"
28 /** The key that is used to identify that the I/O should be autodetected */
29 #define SP_MODULE_KEY_AUTODETECT "autodetect"
30 /** This is the key for the SVG input module */
31 #define SP_MODULE_KEY_INPUT_SVG "org.inkscape.input.svg"
32 #define SP_MODULE_KEY_INPUT_SVGZ "org.inkscape.input.svgz"
33 /** Specifies the input module that should be used if none are selected */
34 #define SP_MODULE_KEY_INPUT_DEFAULT SP_MODULE_KEY_AUTODETECT
35 /** The key for outputing standard W3C SVG */
36 #define SP_MODULE_KEY_OUTPUT_SVG "org.inkscape.output.svg.plain"
37 #define SP_MODULE_KEY_OUTPUT_SVGZ "org.inkscape.output.svgz.plain"
38 /** This is an output file that has SVG data with the Sodipodi namespace extensions */
39 #define SP_MODULE_KEY_OUTPUT_SVG_INKSCAPE "org.inkscape.output.svg.inkscape"
40 #define SP_MODULE_KEY_OUTPUT_SVGZ_INKSCAPE "org.inkscape.output.svgz.inkscape"
41 /** Which output module should be used? */
42 #define SP_MODULE_KEY_OUTPUT_DEFAULT SP_MODULE_KEY_AUTODETECT
44 /** Defines the key for Postscript printing */
45 #define SP_MODULE_KEY_PRINT_PS "org.inkscape.print.ps"
46 #define SP_MODULE_KEY_PRINT_CAIRO_PS "org.inkscape.print.ps.cairo"
47 /** Defines the key for PDF printing */
48 #define SP_MODULE_KEY_PRINT_PDF "org.inkscape.print.pdf"
49 #define SP_MODULE_KEY_PRINT_CAIRO_PDF "org.inkscape.print.pdf.cairo"
50 /** Defines the key for LaTeX printing */
51 #define SP_MODULE_KEY_PRINT_LATEX "org.inkscape.print.latex"
52 /** Defines the key for printing with GNOME Print */
53 #define SP_MODULE_KEY_PRINT_GNOME "org.inkscape.print.gnome"
54 /** Defines the key for printing under Win32 */
55 #define SP_MODULE_KEY_PRINT_WIN32 "org.inkscape.print.win32"
56 #ifdef WIN32
57 /** Defines the default printing to use */
58 #define SP_MODULE_KEY_PRINT_DEFAULT SP_MODULE_KEY_PRINT_WIN32
59 #else
60 /** Defines the default printing to use */
61 #define SP_MODULE_KEY_PRINT_DEFAULT SP_MODULE_KEY_PRINT_PS
62 #endif
64 /** Mime type for SVG */
65 #define MIME_SVG "image/svg+xml"
67 /** Name of the extension error file */
68 #define EXTENSION_ERROR_LOG_FILENAME "extension-errors.log"
71 #define INKSCAPE_EXTENSION_URI "http://www.inkscape.org/namespace/inkscape/extension"
72 #define INKSCAPE_EXTENSION_NS_NC "extension"
73 #define INKSCAPE_EXTENSION_NS "extension:"
75 namespace Inkscape {
76 namespace Extension {
78 /** The object that is the basis for the Extension system. This object
79 contains all of the information that all Extension have. The
80 individual items are detailed within. This is the interface that
81 those who want to _use_ the extensions system should use. This
82 is most likely to be those who are inside the Inkscape program. */
83 class Extension {
84 public:
85 /** An enumeration to identify if the Extension has been loaded or not. */
86 typedef enum {
87 STATE_LOADED, /**< The extension has been loaded successfully */
88 STATE_UNLOADED, /**< The extension has not been loaded */
89 STATE_DEACTIVATED /**< The extension is missing something which makes it unusable */
90 } state_t;
91 static std::vector<const gchar *> search_path; /**< A vector of paths to search for extensions */
93 private:
94 gchar *id; /**< The unique identifier for the Extension */
95 gchar *name; /**< A user friendly name for the Extension */
96 gchar *_help; /**< A string that contains a help text for the user */
97 state_t _state; /**< Which state the Extension is currently in */
98 std::vector<Dependency *> _deps; /**< Dependencies for this extension */
99 static std::ofstream error_file; /**< This is the place where errors get reported */
101 protected:
102 Inkscape::XML::Node *repr; /**< The XML description of the Extension */
103 Implementation::Implementation * imp; /**< An object that holds all the functions for making this work */
104 ExpirationTimer * timer; /**< Timeout to unload after a given time */
106 public:
107 Extension (Inkscape::XML::Node * in_repr,
108 Implementation::Implementation * in_imp);
109 virtual ~Extension (void);
111 void set_state (state_t in_state);
112 state_t get_state (void);
113 bool loaded (void);
114 virtual bool check (void);
115 Inkscape::XML::Node * get_repr (void);
116 gchar * get_id (void);
117 gchar * get_name (void);
118 /** \brief Gets the help string for this extension */
119 gchar const * get_help (void) { return _help; }
120 void deactivate (void);
121 bool deactivated (void);
122 void printFailure (Glib::ustring reason);
123 Implementation::Implementation * get_imp (void) { return imp; };
125 /* Parameter Stuff */
126 private:
127 GSList * parameters; /**< A table to store the parameters for this extension.
128 This only gets created if there are parameters in this
129 extension */
131 public:
132 /** \brief A function to get the the number of parameters that
133 the extension has.
134 \return The number of parameters. */
135 unsigned int param_count ( ) { return parameters == NULL ? 0 :
136 g_slist_length(parameters); };
137 /** \brief A function to get the the number of parameters that
138 are visible to the user that the extension has.
139 \return The number of visible parameters.
141 \note Currently this just calls param_count as visible isn't implemented
142 but in the future it'll do something different. Please call
143 the appropriate function in code so that it'll work in the
144 future.
145 */
146 unsigned int param_visible_count ( );
148 public:
149 /** An error class for when a parameter is called on a type it is not */
150 class param_wrong_type {};
151 class param_not_color_param {};
152 class param_not_enum_param {};
153 class param_not_string_param {};
154 class param_not_float_param {};
155 class param_not_int_param {};
156 class param_not_bool_param {};
158 /** An error class for when a parameter is looked for that just
159 * simply doesn't exist */
160 class param_not_exist {};
162 /** An error class for when a filename already exists, but the user
163 * doesn't want to overwrite it */
164 class no_overwrite {};
166 private:
167 void make_param (Inkscape::XML::Node * paramrepr);
168 #if 0
169 inline param_t * param_shared (const gchar * name,
170 GSList * list);
171 #endif
172 public:
173 bool get_param_bool (const gchar * name,
174 const SPDocument * doc = NULL,
175 const Inkscape::XML::Node * node = NULL);
176 int get_param_int (const gchar * name,
177 const SPDocument * doc = NULL,
178 const Inkscape::XML::Node * node = NULL);
179 float get_param_float (const gchar * name,
180 const SPDocument * doc = NULL,
181 const Inkscape::XML::Node * node = NULL);
182 const gchar * get_param_string (const gchar * name,
183 const SPDocument * doc = NULL,
184 const Inkscape::XML::Node * node = NULL);
185 guint32 get_param_color (const gchar * name,
186 const SPDocument * doc = NULL,
187 const Inkscape::XML::Node * node = NULL);
188 const gchar * get_param_enum (const gchar * name,
189 const SPDocument * doc = NULL,
190 const Inkscape::XML::Node * node = NULL);
191 bool set_param_bool (const gchar * name,
192 bool value,
193 SPDocument * doc = NULL,
194 Inkscape::XML::Node * node = NULL);
195 int set_param_int (const gchar * name,
196 int value,
197 SPDocument * doc = NULL,
198 Inkscape::XML::Node * node = NULL);
199 float set_param_float (const gchar * name,
200 float value,
201 SPDocument * doc = NULL,
202 Inkscape::XML::Node * node = NULL);
203 const gchar * set_param_string (const gchar * name,
204 const gchar * value,
205 SPDocument * doc = NULL,
206 Inkscape::XML::Node * node = NULL);
207 guint32 set_param_color (const gchar * name,
208 guint32 color,
209 SPDocument * doc = NULL,
210 Inkscape::XML::Node * node = NULL);
212 /* Error file handling */
213 public:
214 static void error_file_open (void);
215 static void error_file_close (void);
217 public:
218 Gtk::Widget * autogui (SPDocument * doc, Inkscape::XML::Node * node, sigc::signal<void> * changeSignal = NULL);
219 void paramListString (std::list <std::string> & retlist);
221 /* Extension editor dialog stuff */
222 public:
223 Gtk::VBox * get_info_widget(void);
224 Gtk::VBox * get_help_widget(void);
225 Gtk::VBox * get_params_widget(void);
226 protected:
227 inline static void add_val(Glib::ustring labelstr, Glib::ustring valuestr, Gtk::Table * table, int * row);
229 };
233 /*
235 This is a prototype for how collections should work. Whoever gets
236 around to implementing this gets to decide what a 'folder' and an
237 'item' really is. That is the joy of implementing it, eh?
239 class Collection : public Extension {
241 public:
242 folder get_root (void);
243 int get_count (folder);
244 thumbnail get_thumbnail(item);
245 item[] get_items(folder);
246 folder[] get_folders(folder);
247 metadata get_metadata(item);
248 image get_image(item);
250 };
251 */
253 } /* namespace Extension */
254 } /* namespace Inkscape */
256 #endif /* __INK_EXTENSION_H__ */
258 /*
259 Local Variables:
260 mode:c++
261 c-file-style:"stroustrup"
262 c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
263 indent-tabs-mode:nil
264 fill-column:99
265 End:
266 */
267 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :