cleanup
[platform/upstream/glib.git] / gmodule / gmodule.h
index 62fd16a..194fa6e 100644 (file)
@@ -2,46 +2,48 @@
  * Copyright (C) 1998 Tim Janik
  *
  * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Library General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  */
-#ifndef __GMODULE_H__
-#define __GMODULE_H__
 
+/*
+ * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
+ * file for a list of people on the GLib Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GLib at ftp://ftp.gtk.org/pub/gtk/. 
+ */
 
-#ifdef __cplusplus
-extern "C" {
-#endif /* __cplusplus */
+#ifndef __GMODULE_H__
+#define __GMODULE_H__
 
-extern const char      *g_log_domain_gmodule;
 #include <glib.h>
 
+G_BEGIN_DECLS
 
 /* exporting and importing functions, this is special cased
  * to feature Windows dll stubs.
  */
 #define        G_MODULE_IMPORT         extern
-#ifdef NATIVE_WIN32
+#ifdef G_PLATFORM_WIN32
 #  define      G_MODULE_EXPORT         __declspec(dllexport)
-#else /* !NATIVE_WIN32 */
+#else /* !G_PLATFORM_WIN32 */
 #  define      G_MODULE_EXPORT
-#endif /* !NATIVE_WIN32 */
+#endif /* !G_PLATFORM_WIN32 */
 
 typedef enum
 {
   G_MODULE_BIND_LAZY   = 1 << 0,
-  G_MODULE_BIND_MASK   = 0x01
+  G_MODULE_BIND_LOCAL  = 1 << 1,
+  G_MODULE_BIND_MASK   = 0x03
 } GModuleFlags;
 
 typedef        struct _GModule                  GModule;
@@ -49,47 +51,65 @@ typedef const gchar* (*GModuleCheckInit) (GModule   *module);
 typedef void        (*GModuleUnload)    (GModule       *module);
 
 /* return TRUE if dynamic module loading is supported */
-gboolean       g_module_supported         (void);
+GLIB_AVAILABLE_IN_ALL
+gboolean       g_module_supported         (void) G_GNUC_CONST;
 
-/* open a module `file_name' and return handle, which is NULL on error */
-GModule*       g_module_open              (const gchar         *file_name,
-                                           GModuleFlags         flags);
+/* open a module 'file_name' and return handle, which is NULL on error */
+GLIB_AVAILABLE_IN_ALL
+GModule*              g_module_open          (const gchar  *file_name,
+                                             GModuleFlags  flags);
 
 /* close a previously opened module, returns TRUE on success */
-gboolean       g_module_close             (GModule             *module);
+GLIB_AVAILABLE_IN_ALL
+gboolean              g_module_close         (GModule      *module);
 
 /* make a module resident so g_module_close on it will be ignored */
-void           g_module_make_resident     (GModule             *module);
+GLIB_AVAILABLE_IN_ALL
+void                  g_module_make_resident (GModule      *module);
 
 /* query the last module error as a string */
-gchar*         g_module_error             (void);
-
-/* retrive a symbol pointer from `module', returns TRUE on success */
-gboolean       g_module_symbol            (GModule             *module,
-                                           const gchar         *symbol_name,
-                                           gpointer            *symbol);
+GLIB_AVAILABLE_IN_ALL
+const gchar *         g_module_error         (void);
 
-/* retrive the file name from an existing module */
-gchar*         g_module_name              (GModule             *module);
+/* retrieve a symbol pointer from 'module', returns TRUE on success */
+GLIB_AVAILABLE_IN_ALL
+gboolean              g_module_symbol        (GModule      *module,
+                                             const gchar  *symbol_name,
+                                             gpointer     *symbol);
 
+/* retrieve the file name from an existing module */
+GLIB_AVAILABLE_IN_ALL
+const gchar *         g_module_name          (GModule      *module);
 
-/* Build the actual file name containing a module. `directory' is the
+/* Build the actual file name containing a module. 'directory' is the
  * directory where the module file is supposed to be, or NULL or empty
  * in which case it should either be in the current directory or, on
  * some operating systems, in some standard place, for instance on the
  * PATH. Hence, to be absoultely sure to get the correct module,
  * always pass in a directory. The file name consists of the directory,
- * if supplied, and `module_name' suitably decorated accoring to
+ * if supplied, and 'module_name' suitably decorated according to
  * the operating system's conventions (for instance lib*.so or *.dll).
  *
  * No checks are made that the file exists, or is of correct type.
  */
-gchar*         g_module_build_path       (const gchar          *directory,
-                                          const gchar          *module_name);
+GLIB_AVAILABLE_IN_ALL
+gchar*                g_module_build_path    (const gchar  *directory,
+                                             const gchar  *module_name);
+
+
+#ifndef __GTK_DOC_IGNORE__
+#ifdef G_OS_WIN32
+#define g_module_open g_module_open_utf8
+#define g_module_name g_module_name_utf8
 
-#ifdef __cplusplus
-}
-#endif /* __cplusplus */
+GLIB_AVAILABLE_IN_ALL
+GModule *    g_module_open_utf8 (const gchar  *file_name,
+                                 GModuleFlags  flags);
+GLIB_AVAILABLE_IN_ALL
+const gchar *g_module_name_utf8 (GModule      *module);
+#endif
+#endif
 
+G_END_DECLS
 
 #endif /* __GMODULE_H__ */