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