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 "support/docstring.h"
17 #include "OutputParams.h"
23 namespace support { class FileName; }
29 /// Flags for some format properties
32 /// Set if this format is a document format (as opposed to
33 /// e.g. image formats).
34 /// Some formats are both (e.g. pdf), they have this flag set.
36 /// Set if this format can contain vector graphics.
38 /// This format should appear in the File > Export menu
40 /// This may be a compressed file but doesn't need decompression
44 Format(std::string const & n, std::string const & e, std::string const & p,
45 std::string const & s, std::string const & v, std::string const & ed,
46 std::string const & m, int);
49 /// Is \p ext a valid filename extension for this format?
50 bool hasExtension(std::string const & ext) const;
51 /// Tell whether this format is a child format.
52 /// Child formats inherit settings like the viewer from their parent.
53 bool isChildFormat() const;
54 /// Name fo the parent format
55 std::string const parentFormat() const;
57 std::string const & name() const { return name_; }
59 void setName(std::string const & v) { name_ = v; }
61 std::string const & extension() const
63 return extension_list_.empty() ? empty_string() : extension_list_[0];
66 std::string const extensions() const;
68 void setExtensions(std::string const & v);
70 std::string const & prettyname() const { return prettyname_; }
72 void setPrettyname(std::string const & v) { prettyname_ = v; }
74 std::string const & shortcut() const { return shortcut_; }
76 void setShortcut(std::string const & v) { shortcut_ = v; }
78 std::string const & viewer() const { return viewer_; }
80 void setViewer(std::string const & v) { viewer_ = v; }
82 std::string const & editor() const { return editor_; }
84 void setEditor(std::string const & v) { editor_ = v; }
86 std::string const & mime() const { return mime_; }
88 void setMime(std::string const & m) { mime_ = m; }
90 bool documentFormat() const { return flags_ & document; }
92 bool vectorFormat() const { return flags_ & vector; }
94 void setFlags(int v) { flags_ = v; }
96 bool inExportMenu() const { return flags_ & export_menu; }
98 bool zippedNative() const { return flags_ & zipped_native; }
100 /// Internal name. Needs to be unique.
102 /// Filename extensions, the first one being the default
103 std::vector<std::string> extension_list_;
104 /// Name presented to the user. Needs to be unique.
105 std::string prettyname_;
106 /// Keyboard shortcut for the View and Export menu.
107 std::string shortcut_;
109 * Viewer for this format. Needs to be in the PATH or an absolute
111 * This format cannot be viewed if \c viewer_ is empty.
112 * If it is \c auto the default viewer of the OS for this format is
116 /// Editor for this format. \sa viewer_.
119 * Full MIME type, e.g. "text/x-tex".
120 * Only types listed by the shared MIME database of freedesktop.org
122 * This field may be empty, but it must be unique across all formats
131 bool operator<(Format const & a, Format const & b);
138 typedef std::vector<Format> FormatList;
140 typedef FormatList::const_iterator const_iterator;
142 Format const & get(FormatList::size_type i) const { return formatlist[i]; }
144 Format & get(FormatList::size_type i) { return formatlist[i]; }
145 /// \returns format named \p name if it exists, otherwise 0
146 Format const * getFormat(std::string const & name) const;
148 * Get the format of \p filename from file contents or, if this
149 * fails, from file extension.
150 * \returns file format if it could be found, otherwise an empty
153 std::string getFormatFromFile(support::FileName const & filename) const;
154 /// Finds a format from a file extension. Returns string() if not found.
155 std::string getFormatFromExtension(std::string const & ext) const;
156 /// Finds a format by pretty name. Returns string() if not found.
157 std::string getFormatFromPrettyName(std::string const & prettyname) const;
158 /** Returns true if the file referenced by \p filename is zipped and
159 ** needs to be unzipped for being handled
160 ** @note For natively zipped formats, such as dia/odg, this returns false.
162 bool isZippedFile(support::FileName const & filename) const;
163 /// check for zipped file format
164 static bool isZippedFileFormat(std::string const & format);
165 /// check for PostScript file format
166 static bool isPostScriptFileFormat(std::string const & format);
167 /// Set editor and/or viewer to "auto" for formats that can be
168 /// opened by the OS.
171 int getNumber(std::string const & name) const;
173 void add(std::string const & name);
175 void add(std::string const & name, std::string const & extensions,
176 std::string const & prettyname, std::string const & shortcut,
177 std::string const & viewer, std::string const & editor,
178 std::string const & mime, int flags);
180 void erase(std::string const & name);
184 void setViewer(std::string const & name, std::string const & command);
186 void setEditor(std::string const & name, std::string const & command);
187 /// View the given file. Buffer used for DVI's paper orientation.
188 bool view(Buffer const & buffer, support::FileName const & filename,
189 std::string const & format_name) const;
191 bool edit(Buffer const & buffer, support::FileName const & filename,
192 std::string const & format_name) const;
194 docstring const prettyName(std::string const & name) const;
196 std::string const extension(std::string const & name) const;
198 std::string const extensions(std::string const & name) const;
200 const_iterator begin() const { return formatlist.begin(); }
202 const_iterator end() const { return formatlist.end(); }
204 bool empty() const { return formatlist.empty(); }
206 FormatList::size_type size() const { return formatlist.size(); }
209 FormatList formatlist;
213 std::string flavor2format(OutputParams::FLAVOR flavor);
214 // Not currently used.
215 // OutputParams::FLAVOR format2flavor(std::string fmt);
217 extern Formats formats;
219 extern Formats system_formats;