]> git.lyx.org Git - lyx.git/blobdiff - src/Format.h
Account for old versions of Pygments
[lyx.git] / src / Format.h
index 9d91ae1442f7edaa380c30461d4d6b3c885196e1..cc383c02497820d8a127b56a29afcf79c607abe9 100644 (file)
@@ -13,6 +13,7 @@
 #define FORMAT_H
 
 #include "support/docstring.h"
+#include "support/trivstring.h"
 
 #include "OutputParams.h"
 
@@ -41,7 +42,7 @@ public:
                zipped_native = 8
        };
        ///
-       Format(std::string const & n, std::string const & e, std::string const & p,
+       Format(std::string const & n, std::string const & e, docstring const & p,
               std::string const & s, std::string const & v, std::string const & ed,
               std::string const & m, int);
        ///
@@ -54,11 +55,11 @@ public:
        /// Name fo the parent format
        std::string const parentFormat() const;
        ///
-       std::string const name() const { return name_; }
+       std::string const name() const { return name_; }
        ///
        void setName(std::string const & v) { name_ = v; }
        ///
-       std::string const extension() const
+       std::string const extension() const
        {
                return extension_list_.empty() ? empty_string() : extension_list_[0];
        }
@@ -67,23 +68,23 @@ public:
        ///
        void setExtensions(std::string const & v);
        ///
-       std::string const & prettyname() const { return prettyname_; }
+       docstring const prettyname() const { return prettyname_; }
        ///
-       void setPrettyname(std::string const & v) { prettyname_ = v; }
+       void setPrettyname(docstring const & v) { prettyname_ = v; }
        ///
-       std::string const shortcut() const { return shortcut_; }
+       std::string const shortcut() const { return shortcut_; }
        ///
        void setShortcut(std::string const & v) { shortcut_ = v; }
        ///
-       std::string const viewer() const { return viewer_; }
+       std::string const viewer() const { return viewer_; }
        ///
        void setViewer(std::string const & v) { viewer_ = v; }
        ///
-       std::string const editor() const { return editor_; }
+       std::string const editor() const { return editor_; }
        ///
        void setEditor(std::string const & v) { editor_ = v; }
        ///
-       std::string const mime() const { return mime_; }
+       std::string const mime() const { return mime_; }
        ///
        void setMime(std::string const & m) { mime_ = m; }
        ///
@@ -96,15 +97,18 @@ public:
        bool inExportMenu() const { return flags_ & export_menu; }
        ///
        bool zippedNative() const { return flags_ & zipped_native; }
+       ///
+       static bool formatSorter(Format const * lhs, Format const * rhs);
+
 private:
        /// Internal name. Needs to be unique.
-       std::string name_;
+       trivstring name_;
        /// Filename extensions, the first one being the default
        std::vector<std::string> extension_list_;
        /// Name presented to the user. Needs to be unique.
-       std::string prettyname_;
+       trivdocstring prettyname_;
        /// Keyboard shortcut for the View and Export menu.
-       std::string shortcut_;
+       trivstring shortcut_;
        /*!
         * Viewer for this format. Needs to be in the PATH or an absolute
         * filename.
@@ -112,9 +116,9 @@ private:
         * If it is \c auto the default viewer of the OS for this format is
         * used.
         */
-       std::string viewer_;
+       trivstring viewer_;
        /// Editor for this format. \sa viewer_.
-       std::string editor_;
+       trivstring editor_;
        /*!
         * Full MIME type, e.g. "text/x-tex".
         * Only types listed by the shared MIME database of freedesktop.org
@@ -122,7 +126,7 @@ private:
         * This field may be empty, but it must be unique across all formats
         * if it is set.
         */
-       std::string mime_;
+       trivstring mime_;
        ///
        int flags_;
 };
@@ -139,9 +143,9 @@ public:
        ///
        typedef FormatList::const_iterator const_iterator;
        ///
-       Format const & get(FormatList::size_type i) const { return formatlist[i]; }
+       Format const & get(FormatList::size_type i) const { return formatlist_[i]; }
        ///
-       Format & get(FormatList::size_type i) { return formatlist[i]; }
+       Format & get(FormatList::size_type i) { return formatlist_[i]; }
        /// \returns format named \p name if it exists, otherwise 0
        Format const * getFormat(std::string const & name) const;
        /*!
@@ -149,12 +153,11 @@ public:
         * fails, from file extension.
         * \returns file format if it could be found, otherwise an empty
         * string.
+        * This function is expensive.
         */
        std::string getFormatFromFile(support::FileName const & filename) const;
        /// Finds a format from a file extension. Returns string() if not found.
        std::string getFormatFromExtension(std::string const & ext) const;
-       /// Finds a format by pretty name. Returns string() if not found.
-       std::string getFormatFromPrettyName(std::string const & prettyname) const;
        /** Returns true if the file referenced by \p filename is zipped and
         ** needs to be unzipped for being handled
         ** @note For natively zipped formats, such as dia/odg, this returns false.
@@ -173,7 +176,7 @@ public:
        void add(std::string const & name);
        ///
        void add(std::string const & name, std::string const & extensions,
-                std::string const & prettyname, std::string const & shortcut,
+                docstring const & prettyname, std::string const & shortcut,
                 std::string const & viewer, std::string const & editor,
                 std::string const & mime, int flags);
        ///
@@ -197,14 +200,16 @@ public:
        ///
        std::string const extensions(std::string const & name) const;
        ///
-       const_iterator begin() const { return formatlist.begin(); }
+       const_iterator begin() const { return formatlist_.begin(); }
        ///
-       const_iterator end() const { return formatlist.end(); }
+       const_iterator end() const { return formatlist_.end(); }
        ///
-       FormatList::size_type size() const { return formatlist.size(); }
+       bool empty() const { return formatlist_.empty(); }
+       ///
+       FormatList::size_type size() const { return formatlist_.size(); }
 private:
        ///
-       FormatList formatlist;
+       FormatList formatlist_;
 };
 
 ///
@@ -212,10 +217,13 @@ std::string flavor2format(OutputParams::FLAVOR flavor);
 // Not currently used.
 // OutputParams::FLAVOR format2flavor(std::string fmt);
 
-extern Formats formats;
-
-extern Formats system_formats;
+/// The global instance.
+/// Implementation is in LyX.cpp.
+extern Formats & theFormats();
 
+/// The global copy after reading lyxrc.defaults.
+/// Implementation is in LyX.cpp.
+extern Formats & theSystemFormats();
 
 } // namespace lyx