deprecated.h File Reference


Detailed Description

transitional header from libqof1 to libqof2

Definition in file deprecated.h.

#include "qof.h"

Go to the source code of this file.

Defines

#define gncLogLevel   QofLogLevel
#define GNC_LOG_FATAL   QOF_LOG_FATAL
#define GNC_LOG_ERROR   QOF_LOG_ERROR
#define GNC_LOG_WARNING   QOF_LOG_WARNING
#define GNC_LOG_INFO   QOF_LOG_INFO
#define GNC_LOG_DEBUG   QOF_LOG_DEBUG
#define GNC_LOG_DETAIL   QOF_LOG_DETAIL
#define GNC_LOG_TRACE   QOF_LOG_TRACE
#define GNC_EVENT_NONE   QOF_EVENT_NONE
#define GNC_EVENT_CREATE   QOF_EVENT_CREATE
#define GNC_EVENT_MODIFY   QOF_EVENT_MODIFY
#define GNC_EVENT_DESTROY   QOF_EVENT_DESTROY
#define GNC_EVENT_ADD   QOF_EVENT_ADD
#define GNC_EVENT_REMOVE   QOF_EVENT_REMOVE
#define GNC_EVENT_ALL   QOF_EVENT_ALL
#define GNCEngineEventType   QofEventId
#define qof_book_mergeResult   QofBookMergeResult
#define qof_book_mergeRule   QofBookMergeRule
#define qof_book_mergeData   QofBookMergeData
#define SAFE_STRCMP_REAL(fcn, da, db)
#define SAFE_STRCMP(da, db)   SAFE_STRCMP_REAL(strcmp,(da),(db))
#define SAFE_STRCASECMP(da, db)   SAFE_STRCMP_REAL(strcasecmp,(da),(db))
#define GNC_SCANF_LLD   QOF_SCANF_LLD

Typedefs

typedef void(* GNCEngineEventHandler )(GUID *entity, QofIdType type, QofEventId event_type, gpointer user_data)
typedef void(* qof_book_mergeRuleForeachCB )(QofBookMergeData *, QofBookMergeRule *, guint)

Functions

void gnc_log_init (void)
void gnc_set_log_level (QofLogModule module, QofLogLevel level)
void gnc_set_log_level_global (QofLogLevel level)
void qof_log_set_level_global (QofLogLevel level)
void gnc_set_logfile (FILE *outfile)
const char * gnc_log_prettify (const char *name)
gboolean gnc_should_log (QofLogModule log_module, QofLogLevel log_level)
void gnc_start_clock (int, QofLogModule, QofLogLevel, const char *, const char *,...)
void gnc_report_clock (int, QofLogModule, QofLogLevel, const char *, const char *,...)
void gnc_report_clock_total (int, QofLogModule, QofLogLevel, const char *, const char *,...)
gint qof_event_register_old_handler (GNCEngineEventHandler old_handler, gpointer user_data)
gint gnc_engine_register_event_handler (GNCEngineEventHandler handler, gpointer user_data)
void gnc_engine_unregister_event_handler (gint handler_id)
void gnc_engine_gen_event (QofEntity *entity, QofEventId event_type)
void gnc_engine_suspend_events (void)
void gnc_engine_resume_events (void)
void gnc_engine_generate_event (const GUID *guid, QofIdType e_type, QofEventId event_type)
QofBookMergeDataqof_book_mergeInit (QofBook *importBook, QofBook *targetBook)
void qof_book_mergeRuleForeach (QofBookMergeData *mergeData, QofBookMergeRuleForeachCB callback, QofBookMergeResult mergeResult)
QofBookMergeDataqof_book_mergeUpdateResult (QofBookMergeData *mergeData, QofBookMergeResult tag)
gint qof_book_mergeCommit (QofBookMergeData *mergeData)
gpointer gnc_string_cache_insert (gconstpointer key)
gchar * gnc_stpcpy (gchar *dest, const gchar *src)
GCache * gnc_engine_get_string_cache (void)
GCache * qof_util_get_string_cache (void)
void gnc_engine_string_cache_destroy (void)
void gnc_string_cache_remove (gconstpointer key)
void qof_book_set_schedxactions (QofBook *book, GList *newList)


Define Documentation

#define GNC_EVENT_ADD   QOF_EVENT_ADD
 

Deprecated:
use QOF_EVENT_ADD instead.

Definition at line 99 of file deprecated.h.

#define GNC_EVENT_ALL   QOF_EVENT_ALL
 

Deprecated:

Definition at line 103 of file deprecated.h.

#define GNC_EVENT_CREATE   QOF_EVENT_CREATE
 

Deprecated:
use QOF_EVENT_CREATE instead.

Definition at line 93 of file deprecated.h.

#define GNC_EVENT_DESTROY   QOF_EVENT_DESTROY
 

Deprecated:
use QOF_EVENT_DESTROY instead.

Definition at line 97 of file deprecated.h.

#define GNC_EVENT_MODIFY   QOF_EVENT_MODIFY
 

Deprecated:
use QOF_EVENT_MODIFY instead.

Definition at line 95 of file deprecated.h.

#define GNC_EVENT_NONE   QOF_EVENT_NONE
 

Deprecated:
use QOF_EVENT_NONE instead.

Definition at line 91 of file deprecated.h.

#define GNC_EVENT_REMOVE   QOF_EVENT_REMOVE
 

Deprecated:
use QOF_EVENT_REMOVE instead.

Definition at line 101 of file deprecated.h.

#define GNC_LOG_DEBUG   QOF_LOG_DEBUG
 

Deprecated:

Definition at line 77 of file deprecated.h.

#define GNC_LOG_DETAIL   QOF_LOG_DETAIL
 

Deprecated:

Definition at line 79 of file deprecated.h.

#define GNC_LOG_ERROR   QOF_LOG_ERROR
 

Deprecated:

Definition at line 71 of file deprecated.h.

#define GNC_LOG_FATAL   QOF_LOG_FATAL
 

Deprecated:

Definition at line 69 of file deprecated.h.

#define GNC_LOG_INFO   QOF_LOG_INFO
 

Deprecated:

Definition at line 75 of file deprecated.h.

#define GNC_LOG_TRACE   QOF_LOG_TRACE
 

Deprecated:

Definition at line 81 of file deprecated.h.

#define GNC_LOG_WARNING   QOF_LOG_WARNING
 

Deprecated:

Definition at line 73 of file deprecated.h.

#define GNC_SCANF_LLD   QOF_SCANF_LLD
 

Deprecated:
use QOF_SCANF_LLD instead.

Definition at line 171 of file deprecated.h.

#define GNCEngineEventType   QofEventId
 

Deprecated:
use QofEventName instead.

Definition at line 105 of file deprecated.h.

#define gncLogLevel   QofLogLevel
 

Deprecated:
use QofLogLevel instead

Definition at line 34 of file deprecated.h.

#define qof_book_mergeData   QofBookMergeData
 

Deprecated:
use QofBookMergeData instead.

Definition at line 134 of file deprecated.h.

#define qof_book_mergeResult   QofBookMergeResult
 

Deprecated:
use QofBookMergeResult instead.

Definition at line 130 of file deprecated.h.

#define qof_book_mergeRule   QofBookMergeRule
 

Deprecated:
use QofBookMergeRule instead.

Definition at line 132 of file deprecated.h.

#define SAFE_STRCASECMP da,
db   )     SAFE_STRCMP_REAL(strcasecmp,(da),(db))
 

Deprecated:
use safe_strcasecmp()

Definition at line 168 of file deprecated.h.

#define SAFE_STRCMP da,
db   )     SAFE_STRCMP_REAL(strcmp,(da),(db))
 

Deprecated:
use safe_strcmp()

Definition at line 166 of file deprecated.h.

#define SAFE_STRCMP_REAL fcn,
da,
db   ) 
 

Value:

{    \
  if ((da) && (db)) {                    \
    if ((da) != (db)) {                  \
      gint retval = fcn ((da), (db));    \
      /* if strings differ, return */    \
      if (retval) return retval;         \
    }                                    \
  } else                                 \
  if ((!(da)) && (db)) {                 \
    return -1;                           \
  } else                                 \
  if ((da) && (!(db))) {                 \
    return +1;                           \
  }                                      \
}
Deprecated:
Use the function versions, safe_strcmp() and safe_strcasecmp() instead.

Definition at line 150 of file deprecated.h.


Typedef Documentation

typedef void(* GNCEngineEventHandler)(GUID *entity, QofIdType type, QofEventId event_type, gpointer user_data)
 

Deprecated:
use QofEventHandler instead.

Definition at line 107 of file deprecated.h.

typedef void(* qof_book_mergeRuleForeachCB)(QofBookMergeData *, QofBookMergeRule *, guint)
 

Deprecated:
use QofBookMergeRuleForeachCB instead.

Definition at line 138 of file deprecated.h.


Function Documentation

void gnc_engine_gen_event QofEntity entity,
QofEventId  event_type
 

Deprecated:
use qof_event_gen instead.

Definition at line 80 of file deprecated.c.

00081 {
00082         qof_event_gen(entity, event_type, NULL);
00083 }

void gnc_engine_generate_event const GUID guid,
QofIdType  e_type,
QofEventId  event_type
 

Deprecated:
use qof_event_generate instead.

GCache* gnc_engine_get_string_cache void   ) 
 

Deprecated:
use qof_init instead.

Definition at line 115 of file deprecated.c.

00116 {
00117     return qof_util_get_string_cache();
00118 }

gint gnc_engine_register_event_handler GNCEngineEventHandler  handler,
gpointer  user_data
 

Deprecated:
use qof_event_register_handler instead.

Definition at line 63 of file deprecated.c.

00065 {
00066         return qof_event_register_old_handler(handler, user_data);
00067 }

void gnc_engine_resume_events void   ) 
 

Deprecated:
use qof_event_resume instead.

Definition at line 76 of file deprecated.c.

00077 {
00078         qof_event_resume();
00079 }

void gnc_engine_string_cache_destroy void   ) 
 

Deprecated:
use qof_close instead.

Definition at line 119 of file deprecated.c.

00120 {
00121     qof_util_string_cache_destroy();
00122 }

void gnc_engine_suspend_events void   ) 
 

Deprecated:
use qof_event_suspend instead.

Definition at line 72 of file deprecated.c.

00073 {
00074         qof_event_suspend();
00075 }

void gnc_engine_unregister_event_handler gint  handler_id  ) 
 

Deprecated:
use qof_event_unregister_handler instead.

Definition at line 68 of file deprecated.c.

00069 {
00070         qof_event_unregister_handler(handler_id);
00071 }

void gnc_log_init void   ) 
 

Deprecated:
use qof_log_init_filename instead

const char* gnc_log_prettify const char *  name  ) 
 

Deprecated:
use qof_log_prettify instead.

Definition at line 51 of file deprecated.c.

00052 {
00053         return qof_log_prettify(name);
00054 }

void gnc_report_clock int  ,
QofLogModule  ,
QofLogLevel  ,
const char *  ,
const char *  ,
  ...
 

Deprecated:
use qof_report_clock

Definition at line 56 of file deprecated.c.

00056 { }

void gnc_report_clock_total int  ,
QofLogModule  ,
QofLogLevel  ,
const char *  ,
const char *  ,
  ...
 

Deprecated:
use qof_report_clock_total

Definition at line 57 of file deprecated.c.

00057 { }

void gnc_set_log_level QofLogModule  module,
QofLogLevel  level
 

Deprecated:
use qof_log_set_level insead.

Definition at line 35 of file deprecated.c.

00036 {
00037         qof_log_set_level(log_module, (QofLogLevel)level);
00038 }

void gnc_set_log_level_global QofLogLevel  level  ) 
 

Deprecated:
use qof_log_set_level_registered instead.

Definition at line 39 of file deprecated.c.

00040 {
00041         qof_log_set_level_registered((QofLogLevel)level);
00042 }

void gnc_set_logfile FILE *  outfile  ) 
 

Deprecated:
use qof_log_set_file instead.

Definition at line 47 of file deprecated.c.

00048 {
00049         qof_log_set_file(outfile);
00050 }

gboolean gnc_should_log QofLogModule  log_module,
QofLogLevel  log_level
 

Deprecated:
use qof_log_check instead.

Definition at line 58 of file deprecated.c.

00059 {
00060         return qof_log_check(log_module, log_level);
00061 }

void gnc_start_clock int  ,
QofLogModule  ,
QofLogLevel  ,
const char *  ,
const char *  ,
  ...
 

Deprecated:
use qof_start_clock

Definition at line 55 of file deprecated.c.

00055 { }

gchar* gnc_stpcpy gchar *  dest,
const gchar *  src
 

Deprecated:
use qof_util_stpcpy instead.

Definition at line 111 of file deprecated.c.

00112 {
00113     return g_stpcpy(dest, src);
00114 }

gpointer gnc_string_cache_insert gconstpointer  key  ) 
 

Deprecated:
use qof_util_string_cache_insert instead.

Definition at line 107 of file deprecated.c.

00108 {
00109     return (gpointer)qof_util_string_cache_insert(key);
00110 }

void gnc_string_cache_remove gconstpointer  key  ) 
 

Deprecated:
use qof_util_string_cache_remove instead.

Definition at line 123 of file deprecated.c.

00124 {
00125     qof_util_string_cache_remove(key);
00126 }

gint qof_book_mergeCommit QofBookMergeData mergeData  ) 
 

Deprecated:
use qof_book_merge_commit instead.

Definition at line 96 of file deprecated.c.

00097 {
00098         return qof_book_merge_commit(mergeData);
00099 }

QofBookMergeData* qof_book_mergeInit QofBook importBook,
QofBook targetBook
 

Deprecated:
use qof_book_merge_init instead.

Definition at line 85 of file deprecated.c.

00086 {
00087         return qof_book_merge_init(importBook, targetBook);
00088 }

void qof_book_mergeRuleForeach QofBookMergeData mergeData,
QofBookMergeRuleForeachCB  callback,
QofBookMergeResult  mergeResult
 

Deprecated:
use qof_book_merge_rule_foreach instead.

Definition at line 101 of file deprecated.c.

00104 {
00105     qof_book_merge_rule_foreach(mergeData, cb, mergeResult);
00106 }

QofBookMergeData* qof_book_mergeUpdateResult QofBookMergeData mergeData,
QofBookMergeResult  tag
 

Deprecated:
use qof_book_merge_update_result instead.

Definition at line 90 of file deprecated.c.

00092 {
00093         return qof_book_merge_update_result(mergeData, tag);
00094 }

void qof_book_set_schedxactions QofBook book,
GList *  newList
 

Deprecated:
no replacement.

gint qof_event_register_old_handler GNCEngineEventHandler  old_handler,
gpointer  user_data
 

Deprecated:
For backwards compatibility - New code must not use this function. The function and the handler prototype will be remove from qofevent.c in libqoqf2

Definition at line 74 of file qofevent.c.

00075 {
00076   HandlerInfo *hi;
00077   gint handler_id;
00078 
00079   ENTER ("(handler=%p, data=%p)", handler, user_data);
00080 
00081   /* sanity check */
00082   if (!handler)
00083   {
00084     PERR ("no handler specified");
00085     return 0;
00086   }
00087   PINFO (" deprecated handler specified");
00088 
00089   handler_id = find_next_handler_id();
00090   /* Found one, add the handler */
00091   hi = g_new0 (HandlerInfo, 1);
00092 
00093   hi->old_handler = handler;
00094   hi->user_data = user_data;
00095   hi->handler_id = handler_id;
00096 
00097   handlers = g_list_prepend (handlers, hi);
00098 
00099   LEAVE (" (handler=%p, data=%p) handler_id=%d", handler, user_data, handler_id);
00100   return handler_id;
00101 
00102 }

void qof_log_set_level_global QofLogLevel  level  ) 
 

Deprecated:
use qof_log_set_level_registered instead.
This function has been deprecated because the function name is very misleading. It may, in future, be modified to be truly global (i.e. make changes to log modules where no log_level has been explicitly set) but, despite the name, it only ever modified known (gnucash) modules. Future changes would require that if this function is made truly global it must preserve the effect of qof_log_set_level_registered and the advantages of silent log_modules for those programs that do not use _global. Support could be required for removing log_modules from the hashtable.

Definition at line 43 of file deprecated.c.

00044 {
00045         qof_log_set_level_registered((QofLogLevel)level);
00046 }

GCache* qof_util_get_string_cache void   ) 
 

Deprecated:
use qof_init instead.

Definition at line 345 of file qofutil.c.

00347 {
00348     if(!qof_string_cache) {
00349         qof_string_cache = g_cache_new(
00350             (GCacheNewFunc) g_strdup, /* value_new_func     */
00351             g_free,                   /* value_destroy_func */
00352             (GCacheDupFunc) g_strdup, /* key_dup_func       */
00353             g_free,                   /* key_destroy_func   */
00354             g_str_hash,               /* hash_key_func      */
00355             g_str_hash,               /* hash_value_func    */
00356             g_str_equal);             /* key_equal_func     */
00357     }
00358     return qof_string_cache;
00359 }


Generated on Fri May 12 18:00:34 2006 for QOF by  doxygen 1.4.4