1 /* === S Y N F I G ========================================================= */
3 ** \brief General macros, classes, and prodecure declarations
5 ** $Id: general.h,v 1.1.1.1 2005/01/04 01:23:14 darco Exp $
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>
35 /* === M A C R O S ========================================================= */
37 // Quick hack to keep stuff working until gettext support is added
41 //#define gettext(x) (x)
44 #define SYNFIG_COPYRIGHT "Copyright (c) 2001-2005 Robert B. Quattlebaum Jr., Adrian Bentley"
49 #define DEBUGPOINT() synfig::warning(etl::strprintf(__FILE__":"__FUNC__":%d DEBUGPOINT",__LINE__))
50 #define DEBUGINFO(x) synfig::warning(etl::strprintf(__FILE__":"__FUNC__":%d:DEBUGINFO:",__LINE__)+x)
52 #define DEBUGPOINT() synfig::warning(etl::strprintf(__FILE__":%d DEBUGPOINT",__LINE__))
53 #define DEBUGINFO(x) synfig::warning(etl::strprintf(__FILE__":%d:DEBUGINFO:",__LINE__)+x)
61 /* === C L A S S E S & S T R U C T S ======================================= */
69 ChangeLocale(int category, const char *locale):
70 previous(setlocale(category,NULL)),category(category)
72 setlocale(category,locale);
75 setlocale(category,previous);
79 /*! \class ProgressCallback
82 class ProgressCallback
86 virtual ~ProgressCallback() { }
87 virtual bool task(const String &task) { return true; }
88 virtual bool error(const String &task) { return true; }
89 virtual bool warning(const String &task) { return true; }
90 virtual bool amount_complete(int current, int total) { return true; }
92 virtual bool valid() const { return true; }
95 typedef ProgressCallback ProgressManager;
97 /*! \class SuperCallback
100 class SuperCallback : public ProgressCallback
102 ProgressCallback *cb;
107 SuperCallback() { cb=NULL; }
108 SuperCallback(ProgressCallback *cb,int start, int end, int total):cb(cb),start(start),end(end),tot(total)
110 //make sure we don't "inherit" if our subcallback is invalid
111 if(!cb || !cb->valid())
115 virtual bool task(const String &task) { if(cb)return cb->task(task); return true; }
116 virtual bool error(const String &task) { if(cb)return cb->error(task); return true; }
117 virtual bool warning(const String &task) { if(cb)return cb->warning(task); return true; }
118 virtual bool amount_complete(int cur, int total) { if(cb)return cb->amount_complete(start+cur*w/total,tot); return true; }
120 virtual bool valid() const { return cb != 0; }
123 /*! \class SoftwareExpired
124 ** \brief This class is thrown when the software timeout has been reached.
126 class SoftwareExpired
128 }; // END of class SoftwareExpired
132 inline void CHECK_EXPIRE_TIME() { if(time(0)>DEATH_TIME) throw SoftwareExpired(); }
134 #define CHECK_EXPIRE_TIME() while(0){ }
138 extern bool add_to_module_search_path(const std:string &path);
139 extern bool add_to_config_search_path(const std:string &path);
142 //! Shutdown the synfig environment
143 extern void shutdown();
146 /*! Call this when an error occurs, describing what happened */
147 extern void error(const char *format,...);
148 extern void error(const String &str);
150 //! Reports a warning
151 /*! Call this when something questionable occurs, describing what happened */
152 extern void warning(const char *format,...);
153 extern void warning(const String &str);
155 //! Reports some information
156 /*! Call this to report various information. Please be sparse... */
157 extern void info(const char *format,...);
158 extern void info(const String &str);
160 }; // END of namespace synfig
162 /* === E N D =============================================================== */