4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
15 #include "OutputParams.h"
17 #include "support/strfwd.h"
18 #include "support/trivstring.h"
24 namespace support { class FileName; }
30 /// Flags for some format properties
33 /// Set if this format is a document format (as opposed to
34 /// e.g. image formats).
35 /// Some formats are both (e.g. pdf), they have this flag set.
37 /// Set if this format can contain vector graphics.
39 /// This format should appear in the File > Export menu
41 /// This may be a compressed file but doesn't need decompression
43 /// This format should not appear in a menu at all
47 Format(std::string const & n, std::string const & e, docstring const & p,
48 std::string const & s, std::string const & v, std::string const & ed,
49 std::string const & m, int);
52 /// Is \p ext a valid filename extension for this format?
53 bool hasExtension(std::string const & ext) const;
54 /// Tell whether this format is a child format.
55 /// Child formats inherit settings like the viewer from their parent.
56 bool isChildFormat() const;
57 /// Name fo the parent format
58 std::string const parentFormat() const;
60 std::string const name() const { return name_; }
62 void setName(std::string const & v) { name_ = v; }
64 std::string const extension() const
66 return extension_list_.empty() ? empty_string() : extension_list_[0];
69 std::string const extensions() const;
71 void setExtensions(std::string const & v);
73 docstring const prettyname() const { return prettyname_; }
75 void setPrettyname(docstring const & v) { prettyname_ = v; }
77 std::string const shortcut() const { return shortcut_; }
79 void setShortcut(std::string const & v) { shortcut_ = v; }
81 std::string const viewer() const { return viewer_; }
83 void setViewer(std::string const & v) { viewer_ = v; }
85 std::string const editor() const { return editor_; }
87 void setEditor(std::string const & v) { editor_ = v; }
89 std::string const mime() const { return mime_; }
91 void setMime(std::string const & m) { mime_ = m; }
93 bool documentFormat() const { return flags_ & document; }
95 bool vectorFormat() const { return flags_ & vector; }
97 void setFlags(int v) { flags_ = v; }
99 bool inExportMenu() const { return flags_ & export_menu; }
101 bool noMenu() const { return flags_ & no_menu; }
103 bool zippedNative() const { return flags_ & zipped_native; }
105 static bool formatSorter(Format const * lhs, Format const * rhs);
108 /// Internal name. Needs to be unique.
110 /// Filename extensions, the first one being the default
111 std::vector<std::string> extension_list_;
112 /// Name presented to the user. Needs to be unique.
113 trivdocstring prettyname_;
114 /// Keyboard shortcut for the View and Export menu.
115 trivstring shortcut_;
117 * Viewer for this format. Needs to be in the PATH or an absolute
119 * This format cannot be viewed if \c viewer_ is empty.
120 * If it is \c auto the default viewer of the OS for this format is
124 /// Editor for this format. \sa viewer_.
127 * Full MIME type, e.g. "text/x-tex".
128 * Only types listed by the shared MIME database of freedesktop.org
130 * This field may be empty, but it must be unique across all formats
139 bool operator<(Format const & a, Format const & b);
146 typedef std::vector<Format> FormatList;
148 typedef FormatList::const_iterator const_iterator;
150 Format const & get(FormatList::size_type i) const { return formatlist_[i]; }
152 Format & get(FormatList::size_type i) { return formatlist_[i]; }
153 /// \returns format named \p name if it exists, otherwise 0
154 Format const * getFormat(std::string const & name) const;
155 /// \returns format named \p name if it exists, otherwise 0
156 Format * getFormat(std::string const & name);
158 * Get the format of \p filename from file contents or, if this
159 * fails, from file extension.
160 * \returns file format if it could be found, otherwise an empty
162 * This function is expensive.
164 std::string getFormatFromFile(support::FileName const & filename) const;
165 /// Finds a format from a file extension. Returns string() if not found.
166 std::string getFormatFromExtension(std::string const & ext) const;
167 /** Returns true if the file referenced by \p filename is zipped and
168 ** needs to be unzipped for being handled
169 ** @note For natively zipped formats, such as dia/odg, this returns false.
171 bool isZippedFile(support::FileName const & filename) const;
172 /// check for zipped file format
173 static bool isZippedFileFormat(std::string const & format);
174 /// check for PostScript file format
175 static bool isPostScriptFileFormat(std::string const & format);
176 /// Set editor and/or viewer to "auto" for formats that can be
177 /// opened by the OS.
180 int getNumber(std::string const & name) const;
182 void add(std::string const & name);
184 void add(std::string const & name, std::string const & extensions,
185 docstring const & prettyname, std::string const & shortcut,
186 std::string const & viewer, std::string const & editor,
187 std::string const & mime, int flags);
189 void erase(std::string const & name);
193 void setViewer(std::string const & name, std::string const & command);
195 void setEditor(std::string const & name, std::string const & command);
196 /// View the given file. Buffer used for DVI's paper orientation.
197 bool view(Buffer const & buffer, support::FileName const & filename,
198 std::string const & format_name) const;
200 bool edit(Buffer const & buffer, support::FileName const & filename,
201 std::string const & format_name) const;
203 docstring const prettyName(std::string const & name) const;
205 std::string const extension(std::string const & name) const;
207 std::string const extensions(std::string const & name) const;
209 const_iterator begin() const { return formatlist_.begin(); }
211 const_iterator end() const { return formatlist_.end(); }
213 bool empty() const { return formatlist_.empty(); }
215 FormatList::size_type size() const { return formatlist_.size(); }
218 FormatList formatlist_;
222 std::string flavor2format(OutputParams::FLAVOR flavor);
223 // Not currently used.
224 // OutputParams::FLAVOR format2flavor(std::string fmt);
226 /// The global instance.
227 /// Implementation is in LyX.cpp.
228 extern Formats & theFormats();
230 /// The global copy after reading lyxrc.defaults.
231 /// Implementation is in LyX.cpp.
232 extern Formats & theSystemFormats();