1 /* === S Y N F I G ========================================================= */
3 ** \brief General macros, classes, and procedure declarations
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
10 ** This package is free software; you can redistribute it and/or
11 ** modify it under the terms of the GNU General Public License as
12 ** published by the Free Software Foundation; either version 2 of
13 ** the License, or (at your option) any later version.
15 ** This package is distributed in the hope that it will be useful,
16 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 ** General Public License for more details.
21 /* ========================================================================= */
23 /* === S T A R T =========================================================== */
25 #ifndef __SYNFIG_GENERAL_H
26 #define __SYNFIG_GENERAL_H
28 /* === H E A D E R S ======================================================= */
30 #include <ETL/stringf>
36 /* === M A C R O S ========================================================= */
38 #define _(x) dgettext("synfig",x)
39 #define gettext_noop(x) x
40 #define N_(x) gettext_noop(x)
42 #define SYNFIG_COPYRIGHT "Copyright (c) 2001-2005 Robert B. Quattlebaum Jr., Adrian Bentley"
47 #define DEBUGPOINT() synfig::warning(etl::strprintf(__FILE__":"__FUNC__":%d DEBUGPOINT",__LINE__))
48 #define DEBUGINFO(x) synfig::warning(etl::strprintf(__FILE__":"__FUNC__":%d:DEBUGINFO:",__LINE__)+x)
50 #define DEBUGPOINT() synfig::warning(etl::strprintf(__FILE__":%d DEBUGPOINT",__LINE__))
51 #define DEBUGINFO(x) synfig::warning(etl::strprintf(__FILE__":%d:DEBUGINFO:",__LINE__)+x)
59 /* === C L A S S E S & S T R U C T S ======================================= */
64 const String previous;
67 ChangeLocale(int category, const char *locale):
68 previous(setlocale(category,locale)),category(category)
72 setlocale(category,previous.c_str());
76 /*! \class ProgressCallback
79 class ProgressCallback
83 virtual ~ProgressCallback() { }
84 virtual bool task(const String &/*task*/) { return true; }
85 virtual bool error(const String &/*task*/) { return true; }
86 virtual bool warning(const String &/*task*/) { return true; }
87 virtual bool amount_complete(int /*current*/, int /*total*/) { return true; }
89 virtual bool valid() const { return true; }
92 typedef ProgressCallback ProgressManager;
94 /*! \class SuperCallback
97 class SuperCallback : public ProgressCallback
104 SuperCallback() { cb=NULL; }
105 SuperCallback(ProgressCallback *cb,int start, int end, int total):cb(cb),start(start),end(end),tot(total)
107 //make sure we don't "inherit" if our subcallback is invalid
108 if(!cb || !cb->valid())
112 virtual bool task(const String &task) { if(cb)return cb->task(task); return true; }
113 virtual bool error(const String &task) { if(cb)return cb->error(task); return true; }
114 virtual bool warning(const String &task) { if(cb)return cb->warning(task); return true; }
115 virtual bool amount_complete(int cur, int total) { if(cb)return cb->amount_complete(start+cur*w/total,tot); return true; }
117 virtual bool valid() const { return cb != 0; }
120 /*! \class SoftwareExpired
121 ** \brief This class is thrown when the software timeout has been reached.
123 class SoftwareExpired
125 }; // END of class SoftwareExpired
129 inline void CHECK_EXPIRE_TIME() { if(time(0)>DEATH_TIME) throw SoftwareExpired(); }
131 #define CHECK_EXPIRE_TIME() while(0){ }
135 extern bool add_to_module_search_path(const std:string &path);
136 extern bool add_to_config_search_path(const std:string &path);
139 //! Shutdown the synfig environment
140 extern void shutdown();
143 /*! Call this when an error occurs, describing what happened */
144 extern void error(const char *format,...);
145 extern void error(const String &str);
147 //! Reports a warning
148 /*! Call this when something questionable occurs, describing what happened */
149 extern void warning(const char *format,...);
150 extern void warning(const String &str);
152 //! Reports some information
153 /*! Call this to report various information. Please be sparse... */
154 extern void info(const char *format,...);
155 extern void info(const String &str);
157 }; // END of namespace synfig
159 /* === E N D =============================================================== */