#define FORMAT_H
#include "support/docstring.h"
+#include "support/trivstring.h"
-#include <vector>
+#include "OutputParams.h"
+#include <vector>
namespace lyx {
/// Some formats are both (e.g. pdf), they have this flag set.
document = 1,
/// Set if this format can contain vector graphics.
- vector = 2
+ vector = 2,
+ /// This format should appear in the File > Export menu
+ export_menu = 4,
+ /// This may be a compressed file but doesn't need decompression
+ zipped_native = 8,
+ /// This format should not appear in a menu at all
+ no_menu = 16
};
///
- 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,
- int);
+ std::string const & m, int);
///
bool dummy() const;
+ /// Is \p ext a valid filename extension for this format?
+ bool hasExtension(std::string const & ext) 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 { return name_; }
+ std::string const name() const { return name_; }
///
void setName(std::string const & v) { name_ = v; }
///
- std::string const & extension() const { return extension_; }
+ std::string const extension() const
+ {
+ return extension_list_.empty() ? empty_string() : extension_list_[0];
+ }
///
- void setExtension(std::string const & v) { extension_ = v; }
+ std::string const extensions() const;
///
- std::string const & prettyname() const { return prettyname_; }
+ void setExtensions(std::string const & v);
///
- void setPrettyname(std::string const & v) { prettyname_ = v; }
+ docstring const prettyname() const { return prettyname_; }
///
- std::string const & shortcut() const { return shortcut_; }
+ void setPrettyname(docstring const & v) { prettyname_ = v; }
+ ///
+ 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_; }
+ ///
+ void setMime(std::string const & m) { mime_ = m; }
+ ///
bool documentFormat() const { return flags_ & document; }
///
bool vectorFormat() const { return flags_ & vector; }
///
void setFlags(int v) { flags_ = v; }
+ ///
+ bool inExportMenu() const { return flags_ & export_menu; }
+ ///
+ bool noMenu() const { return flags_ & no_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_;
- /// Filename extension
- std::string extension_;
+ 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.
* 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
+ * should be added.
+ * This field may be empty, but it must be unique across all formats
+ * if it is set.
+ */
+ trivstring mime_;
///
int flags_;
};
///
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;
/*!
* 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;
+ /** 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.
+ **/
+ bool isZippedFile(support::FileName const & filename) const;
+ /// check for zipped file format
+ static bool isZippedFileFormat(std::string const & format);
+ /// check for PostScript file format
+ static bool isPostScriptFileFormat(std::string const & format);
/// Set editor and/or viewer to "auto" for formats that can be
/// opened by the OS.
void setAutoOpen();
///
void add(std::string const & name);
///
- void add(std::string const & name, std::string const & extension,
- std::string const & prettyname, std::string const & shortcut,
+ void add(std::string const & name, std::string const & extensions,
+ docstring const & prettyname, std::string const & shortcut,
std::string const & viewer, std::string const & editor,
- int flags);
+ std::string const & mime, int flags);
///
void erase(std::string const & name);
///
///
std::string const extension(std::string const & name) const;
///
- const_iterator begin() const { return formatlist.begin(); }
+ std::string const extensions(std::string const & name) const;
///
- const_iterator end() const { return formatlist.end(); }
+ const_iterator begin() const { return formatlist_.begin(); }
///
- FormatList::size_type size() const { return formatlist.size(); }
+ const_iterator end() const { return formatlist_.end(); }
+ ///
+ bool empty() const { return formatlist_.empty(); }
+ ///
+ FormatList::size_type size() const { return formatlist_.size(); }
private:
///
- FormatList formatlist;
+ FormatList formatlist_;
};
-extern Formats formats;
+///
+std::string flavor2format(OutputParams::FLAVOR flavor);
+// Not currently used.
+// OutputParams::FLAVOR format2flavor(std::string fmt);
-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
projects / lyx.git / blobdiff