include <stdlib.h> and <stddef.h> if STDC_HEADERS is defined.
[platform/upstream/glib.git] / glib.h
diff --git a/glib.h b/glib.h
index 12fa999..7f31ba9 100644 (file)
--- a/glib.h
+++ b/glib.h
@@ -55,6 +55,7 @@
  *  gint16, guint16
  *  gint32, guint32
  *  gint64, guint64
+ *  gssize, gsize
  *
  * It defines the G_BYTE_ORDER symbol to one of G_*_ENDIAN (see later in
  * this file). 
@@ -426,6 +427,8 @@ extern "C" {
 
 #define g_return_if_fail(expr)
 #define g_return_val_if_fail(expr,val)
+#define g_return_if_reached() return
+#define g_return_val_if_reached(val) return (val)
 
 #else /* !G_DISABLE_CHECKS */
 
@@ -436,7 +439,7 @@ extern "C" {
        {                                                               \
         g_log (G_LOG_DOMAIN,                                           \
                G_LOG_LEVEL_CRITICAL,                                   \
-               "file %s: line %d (%s): assertion `%s' failed.",        \
+               "file %s: line %d (%s): assertion `%s' failed",         \
                __FILE__,                                               \
                __LINE__,                                               \
                __PRETTY_FUNCTION__,                                    \
@@ -449,14 +452,32 @@ extern "C" {
        {                                                               \
         g_log (G_LOG_DOMAIN,                                           \
                G_LOG_LEVEL_CRITICAL,                                   \
-               "file %s: line %d (%s): assertion `%s' failed.",        \
+               "file %s: line %d (%s): assertion `%s' failed",         \
                __FILE__,                                               \
                __LINE__,                                               \
                __PRETTY_FUNCTION__,                                    \
                #expr);                                                 \
-        return val;                                                    \
+        return (val);                                                  \
        };                              }G_STMT_END
 
+#define g_return_if_reached()          G_STMT_START{                   \
+     g_log (G_LOG_DOMAIN,                                              \
+           G_LOG_LEVEL_CRITICAL,                                       \
+           "file %s: line %d (%s): should not be reached",             \
+           __FILE__,                                                   \
+           __LINE__,                                                   \
+           __PRETTY_FUNCTION__);                                       \
+     return;                           }G_STMT_END
+
+#define g_return_val_if_reached(val)   G_STMT_START{                   \
+     g_log (G_LOG_DOMAIN,                                              \
+           G_LOG_LEVEL_CRITICAL,                                       \
+           "file %s: line %d (%s): should not be reached",             \
+           __FILE__,                                                   \
+           __LINE__,                                                   \
+           __PRETTY_FUNCTION__);                                       \
+     return (val);                     }G_STMT_END
+
 #else /* !__GNUC__ */
 
 #define g_return_if_fail(expr)         G_STMT_START{           \
@@ -464,7 +485,7 @@ extern "C" {
        {                                                       \
         g_log (G_LOG_DOMAIN,                                   \
                G_LOG_LEVEL_CRITICAL,                           \
-               "file %s: line %d: assertion `%s' failed.",     \
+               "file %s: line %d: assertion `%s' failed",      \
                __FILE__,                                       \
                __LINE__,                                       \
                #expr);                                         \
@@ -476,13 +497,29 @@ extern "C" {
        {                                                       \
         g_log (G_LOG_DOMAIN,                                   \
                G_LOG_LEVEL_CRITICAL,                           \
-               "file %s: line %d: assertion `%s' failed.",     \
+               "file %s: line %d: assertion `%s' failed",      \
                __FILE__,                                       \
                __LINE__,                                       \
                #expr);                                         \
-        return val;                                            \
+        return (val);                                          \
        };                              }G_STMT_END
 
+#define g_return_if_reached()          G_STMT_START{           \
+     g_log (G_LOG_DOMAIN,                                      \
+           G_LOG_LEVEL_CRITICAL,                               \
+           "file %s: line %d: should not be reached",          \
+           __FILE__,                                           \
+           __LINE__);                                          \
+     return;                           }G_STMT_END
+
+#define g_return_val_if_reached(val)   G_STMT_START{           \
+     g_log (G_LOG_DOMAIN,                                      \
+           G_LOG_LEVEL_CRITICAL,                               \
+           "file %s: line %d: should not be reached",          \
+           __FILE__,                                           \
+           __LINE__);                                          \
+     return (val);                     }G_STMT_END
+
 #endif /* !__GNUC__ */
 
 #endif /* !G_DISABLE_CHECKS */
@@ -500,6 +537,7 @@ typedef short  gshort;
 typedef long   glong;
 typedef int    gint;
 typedef gint   gboolean;
+typedef gchar* gstring;
 
 typedef unsigned char  guchar;
 typedef unsigned short gushort;
@@ -531,8 +569,6 @@ typedef void* gpointer;
 typedef const void *gconstpointer;
 
 
-typedef gint32 gssize;
-typedef guint32 gsize;
 typedef guint32 GQuark;
 typedef gint32 GTime;
 
@@ -697,19 +733,19 @@ typedef gint32    GTime;
  */
 #ifdef G_OS_WIN32
 #  ifdef GLIB_COMPILATION
-#    define GUTILS_C_VAR __declspec(dllexport)
+#    define GLIB_VAR __declspec(dllexport)
 #  else /* !GLIB_COMPILATION */
-#    define GUTILS_C_VAR extern __declspec(dllimport)
+#    define GLIB_VAR extern __declspec(dllimport)
 #  endif /* !GLIB_COMPILATION */
 #else /* !G_OS_WIN32 */
-#  define GUTILS_C_VAR extern
+#  define GLIB_VAR extern
 #endif /* !G_OS_WIN32 */
 
-GUTILS_C_VAR const guint glib_major_version;
-GUTILS_C_VAR const guint glib_minor_version;
-GUTILS_C_VAR const guint glib_micro_version;
-GUTILS_C_VAR const guint glib_interface_age;
-GUTILS_C_VAR const guint glib_binary_age;
+GLIB_VAR const guint glib_major_version;
+GLIB_VAR const guint glib_minor_version;
+GLIB_VAR const guint glib_micro_version;
+GLIB_VAR const guint glib_interface_age;
+GLIB_VAR const guint glib_binary_age;
 
 #define GLIB_CHECK_VERSION(major,minor,micro)    \
     (GLIB_MAJOR_VERSION > (major) || \
@@ -1113,8 +1149,6 @@ gboolean    g_hash_table_lookup_extended(GHashTable       *hash_table,
                                         gconstpointer   lookup_key,
                                         gpointer       *orig_key,
                                         gpointer       *value);
-void       g_hash_table_freeze         (GHashTable     *hash_table);
-void       g_hash_table_thaw           (GHashTable     *hash_table);
 void       g_hash_table_foreach        (GHashTable     *hash_table,
                                         GHFunc          func,
                                         gpointer        user_data);
@@ -1123,6 +1157,10 @@ guint        g_hash_table_foreach_remove (GHashTable     *hash_table,
                                         gpointer        user_data);
 guint      g_hash_table_size           (GHashTable     *hash_table);
 
+/* The following two functions are deprecated and will be removed in
+ * the next major release. They do no good. */
+void       g_hash_table_freeze         (GHashTable     *hash_table);
+void       g_hash_table_thaw           (GHashTable     *hash_table);
 
 /* Caches
  */
@@ -1439,6 +1477,9 @@ GLogLevelFlags    g_log_set_always_fatal  (GLogLevelFlags  fatal_mask);
 #define        g_message(format, args...)      g_log (G_LOG_DOMAIN, \
                                               G_LOG_LEVEL_MESSAGE, \
                                               format, ##args)
+#define        g_critical(format, args...)     g_log (G_LOG_DOMAIN, \
+                                              G_LOG_LEVEL_CRITICAL, \
+                                              format, ##args)
 #define        g_warning(format, args...)      g_log (G_LOG_DOMAIN, \
                                               G_LOG_LEVEL_WARNING, \
                                               format, ##args)
@@ -1462,6 +1503,15 @@ g_message (const gchar *format,
   va_end (args);
 }
 static void
+g_critical (const gchar *format,
+           ...)
+{
+  va_list args;
+  va_start (args, format);
+  g_logv (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL, format, args);
+  va_end (args);
+}
+static void
 g_warning (const gchar *format,
           ...)
 {
@@ -1698,18 +1748,25 @@ gint    g_vsnprintf             (gchar       *string,
                                 gulong       n,
                                 gchar const *format,
                                 va_list      args);
-gchar* g_basename              (const gchar *file_name);
 /* Check if a file name is an absolute path */
 gboolean g_path_is_absolute    (const gchar *file_name);
 /* In case of absolute paths, skip the root part */
 gchar*  g_path_skip_root       (gchar       *file_name);
 
-/* strings are newly allocated with g_malloc() */
+/* These two functions are deprecated and will be removed in the next
+ * major release of GLib. Use g_path_get_dirname/g_path_get_basename
+ * instead. Whatch out! The string returned by g_path_get_basename
+ * must be g_freed, while the string returned by g_basename must not.*/
+gchar* g_basename              (const gchar *file_name);
 gchar* g_dirname               (const gchar *file_name);
+
+/* The returned strings are newly allocated with g_malloc() */
 gchar* g_get_current_dir       (void);
+gchar* g_path_get_basename     (const gchar *file_name);
+gchar* g_path_get_dirname      (const gchar *file_name);
 
 /* Get the codeset for the current locale */
-gchar * g_get_codeset    (void);
+/* gchar * g_get_codeset    (void); */
 
 /* return the environment string for the variable. The returned memory
  * must not be freed. */
@@ -1864,6 +1921,9 @@ GString*     g_string_new         (const gchar     *init);
 GString*     g_string_sized_new         (guint           dfl_size);
 void        g_string_free              (GString         *string,
                                         gboolean         free_segment);
+gboolean     g_string_equal             (const GString  *v,
+                                        const GString   *v2);
+guint        g_string_hash              (const GString   *str);
 GString*     g_string_assign            (GString        *string,
                                         const gchar     *rval);
 GString*     g_string_truncate          (GString        *string,
@@ -1988,13 +2048,13 @@ GByteArray* g_byte_array_remove_index_fast (GByteArray   *array,
 
 /* Hash Functions
  */
-gint  g_str_equal (gconstpointer   v,
-                  gconstpointer   v2);
-guint g_str_hash  (gconstpointer   v);
+gboolean g_str_equal (gconstpointer   v,
+                     gconstpointer   v2);
+guint   g_str_hash  (gconstpointer   v);
 
-gint  g_int_equal (gconstpointer   v,
-                  gconstpointer   v2);
-guint g_int_hash  (gconstpointer   v);
+gint    g_int_equal (gconstpointer   v,
+                     gconstpointer   v2);
+guint   g_int_hash  (gconstpointer   v);
 
 /* This "hash" function will just return the key's adress as an
  * unsigned integer. Useful for hashing on plain adresses or
@@ -2268,8 +2328,6 @@ void              g_scanner_scope_foreach_symbol  (GScanner       *scanner,
                                                 gpointer        user_data);
 gpointer       g_scanner_lookup_symbol         (GScanner       *scanner,
                                                 const gchar    *symbol);
-void           g_scanner_freeze_symbol_table   (GScanner       *scanner);
-void           g_scanner_thaw_symbol_table     (GScanner       *scanner);
 void           g_scanner_unexp_token           (GScanner       *scanner,
                                                 GTokenType     expected_token,
                                                 const gchar    *identifier_spec,
@@ -2295,6 +2353,10 @@ gint             g_scanner_stat_mode             (const gchar    *filename);
   g_scanner_scope_foreach_symbol ((scanner), 0, (func), (data)); \
 } G_STMT_END
 
+/* The following two functions are deprecated and will be removed in
+ * the next major release. They do no good. */
+void           g_scanner_freeze_symbol_table   (GScanner       *scanner);
+void           g_scanner_thaw_symbol_table     (GScanner       *scanner);
 
 /* GCompletion
  */
@@ -2829,7 +2891,7 @@ gint        g_io_channel_unix_get_fd (GIOChannel *channel);
 
 #ifdef G_OS_WIN32
 
-GUTILS_C_VAR guint g_pipe_readable_msg;
+GLIB_VAR guint g_pipe_readable_msg;
 
 #define G_WIN32_MSG_HANDLE 19981206
 
@@ -3024,9 +3086,9 @@ struct _GThreadFunctions
   void      (*thread_self)        (gpointer              thread);
 };
 
-GUTILS_C_VAR GThreadFunctions  g_thread_functions_for_glib_use;
-GUTILS_C_VAR gboolean          g_thread_use_default_impl;
-GUTILS_C_VAR gboolean          g_threads_got_initialized;
+GLIB_VAR GThreadFunctions      g_thread_functions_for_glib_use;
+GLIB_VAR gboolean              g_thread_use_default_impl;
+GLIB_VAR gboolean              g_threads_got_initialized;
 
 /* initializes the mutex/cond/private implementation for glib, might
  * only be called once, and must not be called directly or indirectly
@@ -3325,5 +3387,7 @@ void            g_thread_pool_stop_unused_threads    (void);
 }
 #endif /* __cplusplus */
 
+#include <gunicode.h>
+#include <gerror.h>
 
 #endif /* __G_LIB_H__ */