Enabled $Id$ expansion.
[synfig.git] / synfig-core / trunk / src / synfig / general.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file general.h
3 **      \brief General macros, classes, and prodecure declarations
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **
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.
14 **
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.
19 **      \endlegal
20 */
21 /* ========================================================================= */
22
23 /* === S T A R T =========================================================== */
24
25 #ifndef __SYNFIG_GENERAL_H
26 #define __SYNFIG_GENERAL_H
27
28 /* === H E A D E R S ======================================================= */
29
30 #include <ETL/stringf>
31 #include "string.h"
32 #include "version.h"
33 #include <locale.h>
34
35 /* === M A C R O S ========================================================= */
36
37 // Quick hack to keep stuff working until gettext support is added
38 #ifndef _
39 #define _(x)            (x)
40 #define N_(x)           (x)
41 //#define gettext(x)    (x)
42 #endif
43
44 #define SYNFIG_COPYRIGHT "Copyright (c) 2001-2005 Robert B. Quattlebaum Jr., Adrian Bentley"
45
46
47 #ifdef _DEBUG
48 #ifdef __FUNC__
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)
51 #else
52 #define DEBUGPOINT()    synfig::warning(etl::strprintf(__FILE__":%d DEBUGPOINT",__LINE__))
53 #define DEBUGINFO(x)    synfig::warning(etl::strprintf(__FILE__":%d:DEBUGINFO:",__LINE__)+x)
54 #endif
55
56 #else
57 #define DEBUGPOINT()
58 #define DEBUGINFO(x)
59 #endif
60
61 /* === C L A S S E S & S T R U C T S ======================================= */
62
63 namespace synfig {
64
65 class ChangeLocale {
66     const String previous;
67     const int category;
68 public:
69     ChangeLocale(int category, const char *locale):
70         previous(setlocale(category,locale)),category(category)
71     {
72     }
73     ~ChangeLocale() {
74         setlocale(category,previous.c_str());
75     }
76 };
77
78 /*!     \class ProgressCallback
79 **      \todo writeme
80 */
81 class ProgressCallback
82 {
83 public:
84
85         virtual ~ProgressCallback() { }
86         virtual bool task(const String &task) { return true; }
87         virtual bool error(const String &task) { return true; }
88         virtual bool warning(const String &task) { return true; }
89         virtual bool amount_complete(int current, int total) { return true; }
90
91         virtual bool valid() const { return true; }
92 };
93
94 typedef ProgressCallback ProgressManager;
95
96 /*!     \class SuperCallback
97 **      \todo writeme
98 */
99 class SuperCallback : public ProgressCallback
100 {
101         ProgressCallback *cb;
102         int start,end,tot;
103         int w;
104 public:
105
106         SuperCallback() { cb=NULL; }
107         SuperCallback(ProgressCallback *cb,int start, int end, int total):cb(cb),start(start),end(end),tot(total)
108         {
109                 //make sure we don't "inherit" if our subcallback is invalid
110                 if(!cb || !cb->valid())
111                         cb = NULL;
112                 w=end-start;
113         }
114         virtual bool task(const String &task) { if(cb)return cb->task(task); return true; }
115         virtual bool error(const String &task) { if(cb)return cb->error(task); return true; }
116         virtual bool warning(const String &task) { if(cb)return cb->warning(task); return true; }
117         virtual bool amount_complete(int cur, int total) { if(cb)return cb->amount_complete(start+cur*w/total,tot); return true; }
118
119         virtual bool valid() const { return cb != 0; }
120 };
121
122 /*! \class SoftwareExpired
123 **      \brief This class is thrown when the software timeout has been reached.
124 */
125 class SoftwareExpired
126 {
127 }; // END of class SoftwareExpired
128
129
130 #ifdef DEATH_TIME
131 inline void CHECK_EXPIRE_TIME() { if(time(0)>DEATH_TIME) throw SoftwareExpired(); }
132 #else
133 #define CHECK_EXPIRE_TIME() while(0){ }
134 #endif
135
136 /*
137 extern bool add_to_module_search_path(const std:string &path);
138 extern bool add_to_config_search_path(const std:string &path);
139 */
140
141 //! Shutdown the synfig environment
142 extern void shutdown();
143
144 //! Reports an error
145 /*! Call this when an error occurs, describing what happened */
146 extern void error(const char *format,...);
147 extern void error(const String &str);
148
149 //! Reports a warning
150 /*! Call this when something questionable occurs, describing what happened */
151 extern void warning(const char *format,...);
152 extern void warning(const String &str);
153
154 //! Reports some information
155 /*! Call this to report various information. Please be sparse... */
156 extern void info(const char *format,...);
157 extern void info(const String &str);
158
159 }; // END of namespace synfig
160
161 /* === E N D =============================================================== */
162
163 #endif