src/uobject/module.h

   1 /*
   2  *  upkg: tool for manipulating Unreal Tournament packages.
   3  *  Copyright (C) 2009 Nick Bowler
   4  *
   5  *  This program is free software; you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation; either version 2 of the License, or
   8  *  (at your option) any later version.
   9  *
  10  *  This program 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
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with this program; if not, write to the Free Software
  17  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  */
  19
  20 #ifndef UOBJECT_MODULE_H_
  21 #define UOBJECT_MODULE_H_
  22
  23 #include <glib-object.h>
  24
  25 /*
  26  * Initialize the UObject module system.  Returns 0 on success, -1 otherwise.
  27  * The module system can be safely initialized multiple times.
  28  */
  29 int uobject_module_init(void);
  30
  31 /*
  32  * Shutdown the UObject module system.  Returns 0 on success, -1 otherwise.
  33  * The module system is only shut down when this function has been called as
  34  * many times as uobject_module_init.
  35  */
  36 int uobject_module_exit(void);
  37
  38 /*
  39  * Get a class handle from the UObject module system.  This will load the
  40  * appropriate shared object if necessary.  The resulting handle can then be
  41  * used to create instances of the class with g_object_new.
  42  *
  43  * Returns 0 on failure.
  44  */
  45 GType uobject_module_get_class(const char *package, const char *class);
  46
  47 #endif