fix a compiler warning regarding unused variable

[lyx.git] / src / exporter.h

diff --git a/src/exporter.h b/src/exporter.h
index 985b213dd00219f1e37c3ed5c442ed98681d4122..22c01ef6b9c4eb70885563ec824b4e786bea8116 100644 (file)
--- a/src/exporter.h
+++ b/src/exporter.h
@@ -13,9 +13,16 @@
 #ifndef EXPORTER_H
 #define EXPORTER_H
 
+#include "support/filename.h"
+
+#include <map>
+#include <string>
 #include <vector>
 
 
+namespace lyx {
+
+
 class Buffer;
 class Format;
 
@@ -31,14 +38,67 @@ public:
                    bool put_in_tempdir);
        ///
        static
-       bool Preview(Buffer * buffer, std::string const & format);
+       bool preview(Buffer * buffer, std::string const & format);
        ///
        static
-       bool IsExportable(Buffer const & buffer, std::string const & format);
+       bool isExportable(Buffer const & buffer, std::string const & format);
        ///
        static
        std::vector<Format const *> const
-       GetExportableFormats(Buffer const & buffer, bool only_viewable);
+       getExportableFormats(Buffer const & buffer, bool only_viewable);
        ///
 };
+
+
+class ExportedFile {
+public:
+       ExportedFile(support::FileName const &, std::string const &);
+       /// absolute name of the source file
+       support::FileName sourceName;
+       /// final name that the exported file should get (absolute name or
+       /// relative to the directory of the master document)
+       std::string exportName;
+};
+
+
+bool operator==(ExportedFile const &, ExportedFile const &);
+
+
+class ExportData {
+public:
+       /** add a referenced file for one format.
+        *  No inset should ever write any file outside the tempdir.
+        *  Instead, files that need to be exported have to be registered
+        *  with this method.
+        *  Then the exporter mechanism copies them to the right place, asks
+        *  for confirmation before overwriting existing files etc.
+        * \param format     format that references the given file
+        * \param sourceName source file name. Needs to be absolute
+        * \param exportName resulting file name. Can be either absolute
+        *                   or relative to the exported document.
+        */
+       void addExternalFile(std::string const & format,
+                            support::FileName const & sourceName,
+                            std::string const & exportName);
+       /** add a referenced file for one format.
+        *  The final name is the source file name without path.
+        * \param format     format that references the given file
+        * \param sourceName source file name. Needs to be absolute
+        */
+       void addExternalFile(std::string const & format,
+                            support::FileName const & sourceName);
+       /// get referenced files for \p format
+       std::vector<ExportedFile> const
+       externalFiles(std::string const & format) const;
+private:
+       typedef std::map<std::string, std::vector<ExportedFile> > FileMap;
+       /** Files that are referenced by the export result in the
+        *  different formats.
+        */
+       FileMap externalfiles;
+};
+
+
+} // namespace lyx
+
 #endif