* check for a valid foldername
[modest] / src / modest-runtime.h
index c02c1e8..304739d 100644 (file)
 #include <modest-conf.h>
 #include <modest-account-mgr.h>
 #include <modest-cache-mgr.h>
+#include <modest-email-clipboard.h>
 #include <modest-mail-operation-queue.h>
 #include <modest-tny-account-store.h>
-#include <modest-widget-factory.h>
 #include <modest-tny-send-queue.h>
+#include <tny-platform-factory.h>
+#include "widgets/modest-window-mgr.h"
 
 G_BEGIN_DECLS
 
@@ -49,7 +51,7 @@ typedef enum {
        MODEST_RUNTIME_DEBUG_LOG_ACTIONS           = 1 << 1, /* not in use atm */
        MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS         = 1 << 2, /* for g_type_init */
        MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS         = 1 << 3, /* for g_type_init */
-       MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS      = 1 << 4, /* reset to factory defaults */
+       MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS      = 1 << 4  /* reset to factory defaults */
 } ModestRuntimeDebugFlags;
 
 /**
@@ -66,18 +68,6 @@ gboolean modest_runtime_init (void);
 
 
 /**
- * modest_runtime_init_ui:
- * @argc: the #argc argument to the main function
- * @argv: the #argv argument to the main function
- * 
- * initialize the modest UI; this replaces the call to
- * gtk_init
- *  
- * TRUE if this succeeded, FALSE otherwise.
- */
-gboolean modest_runtime_init_ui (gint argc, gchar** argv);
-
-/**
  * modest_runtime_uinit:
  *
  * uninitialize the modest runtime system; free all the
@@ -86,7 +76,7 @@ gboolean modest_runtime_init_ui (gint argc, gchar** argv);
  * TRUE if this succeeded, FALSE otherwise
  */
 gboolean modest_runtime_uninit (void);
-
+       
 
 /**
  * modest_runtime_get_debug_flags 
@@ -97,11 +87,10 @@ gboolean modest_runtime_uninit (void);
  * - "abort-on-warning": abort the program when a gtk/glib/.. warning occurs.
  * useful when running in debugger
  * - "log-actions": log user actions (not in use atm)
- * - "track-object": track the use of (g)objects in the program. this option influences
+ * - "debug-objects": track the use of (g)objects in the program. this option influences
  *  g_type_init_with_debug_flags
- *  - "track-signals": track the use of (g)signals in the program. this option influences
+ *  - "debug-signals": track the use of (g)signals in the program. this option influences
  *  g_type_init_with_debug_flags
- *  - "disable-cache": disable caching of strings and pixbuf
  * if you would want to track signals and log actions, you could do something like:
  *  MODEST_DEBUG="log-actions:track-signals" ./modest
  * NOTE that the flags will stay the same during the run of the program, even
@@ -116,7 +105,7 @@ ModestRuntimeDebugFlags modest_runtime_get_debug_flags  (void) G_GNUC_CONST;
  * 
  * get the ModestConf singleton instance
  * 
- * Returns: the ModestConf singleton
+ * Returns: the ModestConf singleton. This should NOT be unref'd.
  **/
 ModestConf*         modest_runtime_get_conf   (void);
 
@@ -126,16 +115,25 @@ ModestConf*         modest_runtime_get_conf   (void);
  * 
  * get the ModestAccountMgr singleton instance
  * 
- * Returns: the ModestAccountMgr singleton
+ * Returns: the ModestAccountMgr singleton. This should NOT be unref'd.
  **/
 ModestAccountMgr*         modest_runtime_get_account_mgr   (void);
 
 /**
+ * modest_runtime_get_email_clipboard:
+ * 
+ * get the #ModestEmailClipboard singleton instance
+ * 
+ * Returns: the #ModestEamilClipboard singleton. This should NOT be unref'd.
+ **/
+ModestEmailClipboard*     modest_runtime_get_email_clipboard   (void);
+
+/**
  * modest_runtime_get_account_store:
  * 
  * get the ModestTnyAccountStore singleton instance
  *
- * Returns: the ModestTnyAccountStore singleton
+ * Returns: the ModestTnyAccountStore singleton. This should NOT be unref'd.
  **/
 ModestTnyAccountStore*    modest_runtime_get_account_store (void);
 
@@ -145,31 +143,43 @@ ModestTnyAccountStore*    modest_runtime_get_account_store (void);
  * 
  * get the ModestCacheMgr singleton instance
  *
- * Returns: the ModestCacheMgr singleton
+ * Returns: the #ModestCacheMgr singleton. This should NOT be unref'd.
  **/
 ModestCacheMgr*           modest_runtime_get_cache_mgr     (void);
 
 
+
 /**
- * modest_runtime_get_mail_operation_queue:
+ * modest_runtime_get_device:
  * 
- * get the #ModestMailOperationQueue singleton instance
+ * get the #TnyDevice singleton instance
  *
- * Returns: the #ModestMailOperationQueue singleton
+ * Returns: the #TnyDevice singleton. This should NOT be unref'd.
  **/
-ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
+TnyDevice*                    modest_runtime_get_device     (void);
 
 
 /**
- * modest_runtime_get_widget_factory:
+ * modest_runtime_get_platform_factory:
  * 
- * get the #ModestWidgetFactory singleton instance
+ * get the #TnyPlatformFactory singleton instance
  *
- * Returns: the #ModestCacheMgr singleton
+ * Returns: the #TnyPlatformFactory singleton. This should NOT be unref'd.
  **/
-ModestWidgetFactory*      modest_runtime_get_widget_factory     (void);
+TnyPlatformFactory*           modest_runtime_get_platform_factory     (void);
+
+
 
 
+/**
+ * modest_runtime_get_mail_operation_queue:
+ * 
+ * get the #ModestMailOperationQueue singleton instance
+ *
+ * Returns: the #ModestMailOperationQueue singleton. This should NOT be unref'd.
+ **/
+ModestMailOperationQueue* modest_runtime_get_mail_operation_queue (void);
+
 
 /**
  * modest_runtime_get_send_queue:
@@ -178,10 +188,72 @@ ModestWidgetFactory*      modest_runtime_get_widget_factory     (void);
  * get the send queue for the given account
  *
  * Returns: the #ModestTnySendQueue singleton instance for this account
- * (ie., one singleton per account)
+ * (ie., one singleton per account). This should NOT be unref'd.
  **/
 ModestTnySendQueue* modest_runtime_get_send_queue        (TnyTransportAccount *account);
 
+/**
+ * modest_runtime_remove_all_send_queues:
+ * 
+ * Removes all send queues, ready for them to be recreated, for instance 
+ * with a new connection.
+ **/
+void modest_runtime_remove_all_send_queues ();
+
+/**
+ * modest_runtime_get_window_mgr:
+ *
+ * get the #ModestWindowMgr singleton instance
+ *
+ * Returns: the #ModestWindowMgr singleton. This should NOT be unref'd.
+ **/
+ModestWindowMgr* modest_runtime_get_window_mgr (void);
+
+/**
+ * modest_runtime_verify_object_last_ref
+ * @OBJ: some (GObject) ptr
+ * @NAME: name of @OBJ
+ * 
+ * macro to check whether @obj holds only one more ref (ie. after the
+ * next unref it will die)
+ * 
+ * not, a g_warning will be issued on stderr. NOTE: this is only active
+ * when MODEST_DEBUG contains "debug-objects".
+ *
+ ***/
+#define modest_runtime_verify_object_last_ref(OBJ,name)                                                       \
+       do {                                                                                           \
+               if (modest_runtime_get_debug_flags() & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS)             \
+                       if (G_IS_OBJECT(OBJ) && G_OBJECT(OBJ)->ref_count != 1)                         \
+                               g_warning ("%s:%d: %s ("                                               \
+                                          #OBJ ") still holds a ref count of %d",                     \
+                                          __FILE__,__LINE__,name, G_OBJECT(OBJ)->ref_count);          \
+       } while (0)
+
+
+
+/**
+ * modest_runtime_not_implemented
+ * @WIN: the parent GtkWindow, or NULL
+ *
+ * give a not-implemented-yet warning popup or g_warning
+ *
+ ***/
+#define modest_runtime_not_implemented(WIN)    \
+       do {                                   \
+               if (gtk_main_level() > 0) {    \
+                       GtkWidget *popup;      \
+                       popup = gtk_message_dialog_new (WIN,\
+                                                       GTK_DIALOG_MODAL|GTK_DIALOG_DESTROY_WITH_PARENT,\
+                                                       GTK_MESSAGE_WARNING, \
+                                                       GTK_BUTTONS_OK, \
+                                                       "Not yet implemented");\
+                       gtk_dialog_run (GTK_DIALOG(popup));             \
+                       gtk_widget_destroy (popup);                     \
+               } else                                                  \
+                       g_warning ("%s:%d: Not yet implemented",__FILE__,__LINE__); \
+       } while (0)                                                     \
+
 
 G_END_DECLS