minimal effort implementation of:

[lyx.git] / src / format.h

diff --git a/src/format.h b/src/format.h
index 3751b6d0af2111d127d4ce4e46d860860809681e..1b025a60e8281d68dbfaf9e2c3c51954607534db 100644 (file)
--- a/src/format.h
+++ b/src/format.h
@@ -21,12 +21,14 @@ class Format {
 public:
        ///
        Format(std::string const & n, std::string const & e, std::string const & p,
-              std::string const & s, std::string const & v, std::string const & ed);
+              std::string const & s, std::string const & v, std::string const & ed,
+              bool ex);
        ///
        bool dummy() const;
-       ///
+       /// Tell whether this format is a child format.
+       /// Child formats inherit settings like the viewer from their parent.
        bool isChildFormat() const;
-       ///
+       /// Name fo the parent format
        std::string const parentFormat() const;
        ///
        std::string const & name() const {
@@ -56,18 +58,36 @@ public:
        std::string const & editor() const {
                return editor_;
        }
+       ///
+       void setEditor(std::string const & v) {
+               editor_ = v;
+       }
+       ///
+       bool documentFormat() const {
+               return document_;
+       }
 private:
+       /// Internal name. Needs to be unique.
        std::string name_;
-       ///
+       /// Filename extension
        std::string extension_;
-       ///
+       /// Name presented to the user. Needs to be unique.
        std::string prettyname_;
-       ///
+       /// Keyboard shortcut for the View and Export menu.
        std::string shortcut_;
-       ///
+       /*!
+        * Viewer for this format. Needs to be in the PATH or an absolute
+        * filename.
+        * This format cannot be viewed if \c viewer_ is empty.
+        * If it is \c auto the default viewer of the OS for this format is
+        * used.
+        */
        std::string viewer_;
-       ///
+       /// Editor for this format. \sa viewer_.
        std::string editor_;
+       /// Is this format a document format? (as opposed to e.g. image formats)
+       /// Some formats are both (e.g. pdf), they have this flag set.
+       bool document_;
 };
 
 
@@ -84,8 +104,18 @@ public:
        Format const & get(FormatList::size_type i) const {
                return formatlist[i];
        }
-       ///
+       /// \returns format named \p name if it exists, otherwise 0
        Format const * getFormat(std::string const & name) const;
+       /*!
+        * Get the format of \p filename from file contents or, if this
+        * fails, from file extension.
+        * \returns file format if it could be found, otherwise an empty
+        * string.
+        */
+       std::string getFormatFromFile(std::string const & filename) const;
+       /// Set editor and/or viewer to "auto" for formats that can be
+       /// opened by the OS.
+       void setAutoOpen();
        ///
        int getNumber(std::string const & name) const;
        ///
@@ -93,7 +123,8 @@ public:
        ///
        void add(std::string const & name, std::string const & extension,
                 std::string const & prettyname, std::string const & shortcut,
-                std::string const & viewer, std::string const & editor);
+                std::string const & viewer, std::string const & editor,
+                bool document);
        ///
        void erase(std::string const & name);
        ///