src/uobject/exportable.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_EXPORTABLE_H_
  20 #define U_OBJECT_EXPORTABLE_H_
  21
  22 #include <stdio.h>
  23 #include <uobject/uobject.h>
  24
  25 #define U_TYPE_OBJECT_EXPORTABLE (u_object_exportable_get_type())
  26 #define U_OBJECT_EXPORTABLE(obj) G_TYPE_CHECK_INSTANCE_CAST(obj, \
  27         U_TYPE_OBJECT_EXPORTABLE, UObjectExportableIface)
  28 #define U_OBJECT_IS_EXPORTABLE(obj) G_TYPE_CHECK_INSTANCE_TYPE(obj, \
  29         U_TYPE_OBJECT_EXPORTABLE)
  30 #define U_OBJECT_EXPORTABLE_GET_INTERFACE(inst) G_TYPE_INSTANCE_GET_INTERFACE \
  31         (inst, U_TYPE_OBJECT_EXPORTABLE, UObjectExportableIface)
  32
  33 typedef struct UObjectExportableIface UObjectExportableIface;
  34
  35 /*
  36  * Interface for UObjects that support exporting to a file.  For example, a
  37  * texture might be saved to disk as a PNG image for editing.
  38  */
  39 struct UObjectExportableIface {
  40         GTypeInterface parent;
  41
  42         int (*export)(UObject *obj, FILE *f);
  43         int (*export_name)(UObject *obj, char *buf, size_t n);
  44 };
  45
  46 GType u_object_exportable_get_type(void);
  47
  48 /*
  49  * Export the object by writing it to the given FILE handle, which must have
  50  * been opened for writing in binary mode.
  51  */
  52 int u_object_export(GObject *obj, FILE *f);
  53
  54 /*
  55  * Get the suggested output filename.  Not more than n-1 characters of the
  56  * filename will be written to buf, and the result is always null terminated.
  57  * Returns the number of characters that would be written if the buffer was
  58  * not bounded.  It is valid to call this function with a NULL buffer and a 0
  59  * size in order to determine how large the buffer needs to be.
  60  */
  61 int u_object_export_name(GObject *obj, char *buf, size_t n);
  62
  63 #endif