more updates

[synfig.git] / synfig-core / trunk / src / synfig / general.h

diff --git a/synfig-core/trunk/src/synfig/general.h b/synfig-core/trunk/src/synfig/general.h
new file mode 100644 (file)
index 0000000..2af68c5
--- /dev/null
+++ b/synfig-core/trunk/src/synfig/general.h
@@ -0,0 +1,148 @@
+/* === S I N F G =========================================================== */
+/*!    \file general.h
+**     \brief General macros, classes, and prodecure declarations
+**
+**     $Id: general.h,v 1.1.1.1 2005/01/04 01:23:14 darco Exp $
+**
+**     \legal
+**     Copyright (c) 2002 Robert B. Quattlebaum Jr.
+**
+**     This software and associated documentation
+**     are CONFIDENTIAL and PROPRIETARY property of
+**     the above-mentioned copyright holder.
+**
+**     You may not copy, print, publish, or in any
+**     other way distribute this software without
+**     a prior written agreement with
+**     the copyright holder.
+**     \endlegal
+*/
+/* ========================================================================= */
+
+/* === S T A R T =========================================================== */
+
+#ifndef __SINFG_GENERAL_H
+#define __SINFG_GENERAL_H
+
+/* === H E A D E R S ======================================================= */
+
+#include <ETL/stringf>
+#include "string.h"
+#include "version.h"
+
+/* === M A C R O S ========================================================= */
+
+// Quick hack to keep stuff working until gettext support is added
+#ifndef _
+#define _(x)           (x)
+#define N_(x)          (x)
+//#define gettext(x)   (x)
+#endif
+
+#define SINFG_COPYRIGHT "Copyright (c) 2001-2004 Voria Software, LLC"
+
+
+#ifdef _DEBUG
+#ifdef __FUNC__
+#define DEBUGPOINT()   sinfg::warning(etl::strprintf(__FILE__":"__FUNC__":%d DEBUGPOINT",__LINE__))
+#define DEBUGINFO(x)   sinfg::warning(etl::strprintf(__FILE__":"__FUNC__":%d:DEBUGINFO:",__LINE__)+x)
+#else
+#define DEBUGPOINT()   sinfg::warning(etl::strprintf(__FILE__":%d DEBUGPOINT",__LINE__))
+#define DEBUGINFO(x)   sinfg::warning(etl::strprintf(__FILE__":%d:DEBUGINFO:",__LINE__)+x)
+#endif
+
+#else
+#define DEBUGPOINT()
+#define DEBUGINFO(x)
+#endif
+
+/* === C L A S S E S & S T R U C T S ======================================= */
+
+namespace sinfg {
+
+/*!    \class ProgressCallback
+**     \todo writeme
+*/
+class ProgressCallback
+{
+public:
+
+       virtual ~ProgressCallback() { }
+       virtual bool task(const String &task) { return true; }
+       virtual bool error(const String &task) { return true; }
+       virtual bool warning(const String &task) { return true; }
+       virtual bool amount_complete(int current, int total) { return true; }
+       
+       virtual bool valid() const { return true; }
+};
+
+typedef ProgressCallback ProgressManager;
+
+/*!    \class SuperCallback
+**     \todo writeme
+*/
+class SuperCallback : public ProgressCallback
+{
+       ProgressCallback *cb;
+       int start,end,tot;
+       int w;
+public:
+
+       SuperCallback() { cb=NULL; }
+       SuperCallback(ProgressCallback *cb,int start, int end, int total):cb(cb),start(start),end(end),tot(total)
+       {
+               //make sure we don't "inherit" if our subcallback is invalid
+               if(!cb || !cb->valid())
+                       cb = NULL;
+               w=end-start;
+       }
+       virtual bool task(const String &task) { if(cb)return cb->task(task); return true; }
+       virtual bool error(const String &task) { if(cb)return cb->error(task); return true; }
+       virtual bool warning(const String &task) { if(cb)return cb->warning(task); return true; }
+       virtual bool amount_complete(int cur, int total) { if(cb)return cb->amount_complete(start+cur*w/total,tot); return true; }
+       
+       virtual bool valid() const { return cb != 0; }
+};
+
+/*! \class SoftwareExpired
+**     \brief This class is thrown when the software timeout has been reached.
+*/
+class SoftwareExpired
+{
+}; // END of class SoftwareExpired
+
+
+#ifdef DEATH_TIME
+inline void CHECK_EXPIRE_TIME() { if(time(0)>DEATH_TIME) throw SoftwareExpired(); }
+#else
+#define CHECK_EXPIRE_TIME() while(0){ }
+#endif
+
+/*
+extern bool add_to_module_search_path(const std:string &path);
+extern bool add_to_config_search_path(const std:string &path);
+*/
+
+//! Shutdown the sinfg environment
+extern void shutdown();
+
+//! Reports an error
+/*! Call this when an error occurs, describing what happened */
+extern void error(const char *format,...);
+extern void error(const String &str);
+
+//! Reports a warning
+/*! Call this when something questionable occurs, describing what happened */
+extern void warning(const char *format,...);
+extern void warning(const String &str);
+
+//! Reports some information
+/*! Call this to report various information. Please be sparse... */
+extern void info(const char *format,...);
+extern void info(const String &str);
+
+}; // END of namespace sinfg
+
+/* === E N D =============================================================== */
+
+#endif