file/import/export formats

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@7 0fc631ac-6414-0410-93d0-97cfa31319b6

src/data/format/formats.hpp

@@ -0,0 +1,78 @@
+//+----------------------------------------------------------------------------+
+//| Description:  Magic Set Editor - Program to make Magic (tm) cards          |
+//| Copyright:    (C) 2001 - 2006 Twan van Laarhoven                           |
+//| License:      GNU General Public License 2 or later (see file COPYING)     |
+//+----------------------------------------------------------------------------+
+
+#ifndef HEADER_DATA_FORMAT_FORMATS
+#define HEADER_DATA_FORMAT_FORMATS
+
+// ----------------------------------------------------------------------------- : Includes
+
+#include <util/prec.hpp>
+#include <util/error.hpp>
+
+class Game;
+DECLARE_POINTER_TYPE(Set);
+
+// ----------------------------------------------------------------------------- : FileFormat
+
+/// A filter for a specific file format
+class FileFormat {
+  public:
+	/// File extension used by this file format
+	virtual String extension() = 0;
+	/// Name of the filter
+	virtual String name() = 0;
+	/// Can it be used for importing sets?
+	virtual bool canImport() = 0;
+	/// Can it be used for exporting sets for a particular game?
+	virtual bool canExport(const Game&) = 0;
+	/// Import using this filter
+	virtual SetP importSet(const String& filename) {
+		throw InternalError(_("Import not supported by this file format"));
+	}
+	/// Export using this filter
+	virtual void exportSet(const Set& set, const String& filename) {
+		throw InternalError(_("Export not supported by this file format"));
+	}
+};
+
+// ----------------------------------------------------------------------------- : Formats
+
+/// Initialize the list of file formats
+/** Must be called before any other methods of this header */
+void initFileFormats();
+
+/// List of supported import formats
+/** Formated as _("All supported (type1,...)|type1,...|name|type|...|All files(*.*)|*.*").
+ *  For use in file selection dialogs.
+ */
+String importFormats();
+
+// List of supported export formats that a set in a specific game can be exported.
+/** Similair format as importFormats, except for _('all supported') and _('all files')
+ */
+String exportFormats(const Game& game);
+
+/// Opens a set with the specified filename.
+/** File format is chosen based on the extension, default is fileFormats[0]
+ *  (which is the MSE2 file filter)
+ *  throws on error, always returns a valid set
+ * 
+ *  NOTE: String parameter must be passed by valueso we get a copy, otherwise
+ *  changing the recent set list could change the filename while we are opening it
+ *  (which would be bad)
+ */
+SetP importSet(String name);
+
+/// Save a set under the specified name.
+/** filterType specifies what format to use for saving, used as index in the list of file formats
+ */
+void exportSet(const Set& set, const String& filename, size_t formatType);
+
+// ----------------------------------------------------------------------------- : Export
+
+
+// ----------------------------------------------------------------------------- : EOF
+#endif