src/uobject/module.h

   1 /*
   2  *  upkg: tool for manipulating Unreal Tournament packages.
   3  *  Copyright © 2009-2011 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 3 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, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef U_OBJECT_MODULE_H_
  20 #define U_OBJECT_MODULE_H_
  21
  22 #include <glib-object.h>
  23
  24 /*
  25  * Initialize the UObject module system.  Returns 0 on success, -1 otherwise.
  26  * The module system can be safely initialized multiple times.
  27  */
  28 int u_object_module_init(void);
  29
  30 /*
  31  * Shutdown the UObject module system.  Returns 0 on success, -1 otherwise.
  32  * The module system is only shut down when this function has been called as
  33  * many times as u_object_module_init.
  34  */
  35 int u_object_module_exit(void);
  36
  37 /*
  38  * Get a class handle from the UObject module system.  This will load the
  39  * appropriate shared object if necessary.  The resulting handle can then be
  40  * used to create instances of the class with g_object_new.
  41  *
  42  * Returns 0 on failure.
  43  */
  44 GType u_object_module_get_class(const char *package, const char *class);
  45
  46 #endif