glib/gmodule/gmodule.h
changeset 18 47c74d1534e1
equal deleted inserted replaced
0:e4d67989cc36 18:47c74d1534e1
       
     1 /* GMODULE - GLIB wrapper code for dynamic module loading
       
     2  * Copyright (C) 1998 Tim Janik
       
     3  * Portions copyright (c) 2006-2009 Nokia Corporation.  All rights reserved.
       
     4  *
       
     5  * This library is free software; you can redistribute it and/or
       
     6  * modify it under the terms of the GNU Lesser General Public
       
     7  * License as published by the Free Software Foundation; either
       
     8  * version 2 of the License, or (at your option) any later version.
       
     9  *
       
    10  * This library is distributed in the hope that it will be useful,
       
    11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
       
    12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the GNU
       
    13  * Lesser General Public License for more details.
       
    14  *
       
    15  * You should have received a copy of the GNU Lesser General Public
       
    16  * License along with this library; if not, write to the
       
    17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
       
    18  * Boston, MA 02111-1307, USA.
       
    19  */
       
    20 
       
    21 /*
       
    22  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
       
    23  * file for a list of people on the GLib Team.  See the ChangeLog
       
    24  * files for a list of changes.  These files are distributed with
       
    25  * GLib at ftp://ftp.gtk.org/pub/gtk/. 
       
    26  */
       
    27 
       
    28 #ifndef __GMODULE_H__
       
    29 #define __GMODULE_H__
       
    30 
       
    31 #include <glib.h>
       
    32 
       
    33 G_BEGIN_DECLS
       
    34 
       
    35 /* exporting and importing functions, this is special cased
       
    36  * to feature Windows dll stubs.
       
    37  */
       
    38 #define	G_MODULE_IMPORT		extern
       
    39 #ifdef G_PLATFORM_WIN32
       
    40 #  define	G_MODULE_EXPORT		__declspec(dllexport)
       
    41 #else /* !G_PLATFORM_WIN32 */
       
    42 #  define	G_MODULE_EXPORT
       
    43 #endif /* !G_PLATFORM_WIN32 */
       
    44 
       
    45 typedef enum
       
    46 {
       
    47   G_MODULE_BIND_LAZY	= 1 << 0,
       
    48   G_MODULE_BIND_LOCAL	= 1 << 1,
       
    49   G_MODULE_BIND_MASK	= 0x03
       
    50 } GModuleFlags;
       
    51 
       
    52 typedef	struct _GModule			 GModule;
       
    53 typedef const gchar* (*GModuleCheckInit) (GModule	*module);
       
    54 typedef void	     (*GModuleUnload)	 (GModule	*module);
       
    55 
       
    56 #ifdef G_OS_WIN32
       
    57 #define g_module_open g_module_open_utf8
       
    58 #define g_module_name g_module_name_utf8
       
    59 #endif
       
    60 
       
    61 /* return TRUE if dynamic module loading is supported */
       
    62 IMPORT_C gboolean	g_module_supported	   (void) G_GNUC_CONST;
       
    63 
       
    64 /* open a module `file_name' and return handle, which is NULL on error */
       
    65 IMPORT_C GModule*              g_module_open          (const gchar  *file_name,
       
    66 					      GModuleFlags  flags);
       
    67 
       
    68 /* close a previously opened module, returns TRUE on success */
       
    69 IMPORT_C gboolean              g_module_close         (GModule      *module);
       
    70 
       
    71 /* make a module resident so g_module_close on it will be ignored */
       
    72 IMPORT_C void                  g_module_make_resident (GModule      *module);
       
    73 
       
    74 /* query the last module error as a string */
       
    75 IMPORT_C G_CONST_RETURN gchar* g_module_error         (void);
       
    76 
       
    77 /* retrieve a symbol pointer from `module', returns TRUE on success */
       
    78 IMPORT_C gboolean              g_module_symbol        (GModule      *module,
       
    79 					      const gchar  *symbol_name,
       
    80 					      gpointer     *symbol);
       
    81 
       
    82 /* retrieve the file name from an existing module */
       
    83 IMPORT_C G_CONST_RETURN gchar* g_module_name          (GModule      *module);
       
    84 
       
    85 /* Build the actual file name containing a module. `directory' is the
       
    86  * directory where the module file is supposed to be, or NULL or empty
       
    87  * in which case it should either be in the current directory or, on
       
    88  * some operating systems, in some standard place, for instance on the
       
    89  * PATH. Hence, to be absoultely sure to get the correct module,
       
    90  * always pass in a directory. The file name consists of the directory,
       
    91  * if supplied, and `module_name' suitably decorated accoring to
       
    92  * the operating system's conventions (for instance lib*.so or *.dll).
       
    93  *
       
    94  * No checks are made that the file exists, or is of correct type.
       
    95  */
       
    96 IMPORT_C gchar*                g_module_build_path    (const gchar  *directory,
       
    97 					      const gchar  *module_name);
       
    98 
       
    99 
       
   100 G_END_DECLS
       
   101 
       
   102 #endif /* __GMODULE_H__ */