upkg: Add support for controlling which package is acted upon.

[upkg.git] / src / uobject / exportable.h

diff --git a/src/uobject/exportable.h b/src/uobject/exportable.h
index da4c719b97fe136d2a751d5e7d47c717811a68f4..fd6a0d7aa7297c9b4fec26144e987681cb937a15 100644 (file)
--- a/src/uobject/exportable.h
+++ b/src/uobject/exportable.h
@@ -2,9 +2,9 @@
  *  upkg: tool for manipulating Unreal Tournament packages.
  *  Copyright (C) 2009 Nick Bowler
  *
- *  This program is free software; you can redistribute it and/or modify
+ *  This program is free software: you can redistribute it and/or modify
  *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 2 of the License, or
+ *  the Free Software Foundation, either version 3 of the License, or
  *  (at your option) any later version.
  *
  *  This program is distributed in the hope that it will be useful,
@@ -13,12 +13,11 @@
  *  GNU General Public License for more details.
  *
  *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef UOBJECT_EXPORTABLE_H_
-#define UOBJECT_EXPORTABLE_H_
+#ifndef U_OBJECT_EXPORTABLE_H_
+#define U_OBJECT_EXPORTABLE_H_
 
 #include <stdio.h>
 #include <glib-object.h>
@@ -33,6 +32,10 @@
 
 typedef struct UObjectExportable UObjectExportable;
 
+/*
+ * Interface for UObjects that support exporting to a file.  For example, a
+ * texture might be saved to disk as a PNG image for editing.
+ */
 struct UObjectExportable {
        GTypeInterface parent;
 
@@ -42,7 +45,19 @@ struct UObjectExportable {
 
 GType u_object_exportable_get_type(void);
 
+/*
+ * Export the object by writing it to the given FILE handle, which must have
+ * been opened for writing in binary mode.
+ */
 int u_object_export(GObject *obj, FILE *f);
+
+/*
+ * Get the suggested output filename.  Not more than n-1 characters of the
+ * filename will be written to buf, and the result is always null terminated.
+ * Returns the number of characters that would be written if the buffer was
+ * not bounded.  It is valid to call this function with a NULL buffer and a 0
+ * size in order to determine how large the buffer needs to be.
+ */
 int u_object_export_name(GObject *obj, char *buf, size_t n);
 
 #endif