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"
16 #include "support/trivstring.h"
18 #include "OutputParams.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
45 Format(std::string const & n, std::string const & e, std::string const & p,
46 std::string const & s, std::string const & v, std::string const & ed,
47 std::string const & m, int);
50 /// Is \p ext a valid filename extension for this format?
51 bool hasExtension(std::string const & ext) const;
52 /// Tell whether this format is a child format.
53 /// Child formats inherit settings like the viewer from their parent.
54 bool isChildFormat() const;
55 /// Name fo the parent format
56 std::string const parentFormat() const;
58 std::string const name() const { return name_; }
60 void setName(std::string const & v) { name_ = v; }
62 std::string const extension() const
64 return extension_list_.empty() ? empty_string() : extension_list_[0];
67 std::string const extensions() const;
69 void setExtensions(std::string const & v);
71 std::string const prettyname() const { return prettyname_; }
73 void setPrettyname(std::string const & v) { prettyname_ = v; }
75 std::string const shortcut() const { return shortcut_; }
77 void setShortcut(std::string const & v) { shortcut_ = v; }
79 std::string const viewer() const { return viewer_; }
81 void setViewer(std::string const & v) { viewer_ = v; }
83 std::string const editor() const { return editor_; }
85 void setEditor(std::string const & v) { editor_ = v; }
87 std::string const mime() const { return mime_; }
89 void setMime(std::string const & m) { mime_ = m; }
91 bool documentFormat() const { return flags_ & document; }
93 bool vectorFormat() const { return flags_ & vector; }
95 void setFlags(int v) { flags_ = v; }
97 bool inExportMenu() const { return flags_ & export_menu; }
99 bool zippedNative() const { return flags_ & zipped_native; }
101 static bool formatSorter(Format const * lhs, Format const * rhs);
104 /// Internal name. Needs to be unique.
106 /// Filename extensions, the first one being the default
107 std::vector<std::string> extension_list_;
108 /// Name presented to the user. Needs to be unique.
109 trivstring prettyname_;
110 /// Keyboard shortcut for the View and Export menu.
111 trivstring shortcut_;
113 * Viewer for this format. Needs to be in the PATH or an absolute
115 * This format cannot be viewed if \c viewer_ is empty.
116 * If it is \c auto the default viewer of the OS for this format is
120 /// Editor for this format. \sa viewer_.
123 * Full MIME type, e.g. "text/x-tex".
124 * Only types listed by the shared MIME database of freedesktop.org
126 * This field may be empty, but it must be unique across all formats
135 bool operator<(Format const & a, Format const & b);
142 typedef std::vector<Format> FormatList;
144 typedef FormatList::const_iterator const_iterator;
146 Format const & get(FormatList::size_type i) const { return formatlist[i]; }
148 Format & get(FormatList::size_type i) { return formatlist[i]; }
149 /// \returns format named \p name if it exists, otherwise 0
150 Format const * getFormat(std::string const & name) const;
152 * Get the format of \p filename from file contents or, if this
153 * fails, from file extension.
154 * \returns file format if it could be found, otherwise an empty
157 std::string getFormatFromFile(support::FileName const & filename) const;
158 /// Finds a format from a file extension. Returns string() if not found.
159 std::string getFormatFromExtension(std::string const & ext) const;
160 /** Returns true if the file referenced by \p filename is zipped and
161 ** needs to be unzipped for being handled
162 ** @note For natively zipped formats, such as dia/odg, this returns false.
164 bool isZippedFile(support::FileName const & filename) const;
165 /// check for zipped file format
166 static bool isZippedFileFormat(std::string const & format);
167 /// check for PostScript file format
168 static bool isPostScriptFileFormat(std::string const & format);
169 /// Set editor and/or viewer to "auto" for formats that can be
170 /// opened by the OS.
173 int getNumber(std::string const & name) const;
175 void add(std::string const & name);
177 void add(std::string const & name, std::string const & extensions,
178 std::string const & prettyname, std::string const & shortcut,
179 std::string const & viewer, std::string const & editor,
180 std::string const & mime, int flags);
182 void erase(std::string const & name);
186 void setViewer(std::string const & name, std::string const & command);
188 void setEditor(std::string const & name, std::string const & command);
189 /// View the given file. Buffer used for DVI's paper orientation.
190 bool view(Buffer const & buffer, support::FileName const & filename,
191 std::string const & format_name) const;
193 bool edit(Buffer const & buffer, support::FileName const & filename,
194 std::string const & format_name) const;
196 docstring const prettyName(std::string const & name) const;
198 std::string const extension(std::string const & name) const;
200 std::string const extensions(std::string const & name) const;
202 const_iterator begin() const { return formatlist.begin(); }
204 const_iterator end() const { return formatlist.end(); }
206 bool empty() const { return formatlist.empty(); }
208 FormatList::size_type size() const { return formatlist.size(); }
211 FormatList formatlist;
215 std::string flavor2format(OutputParams::FLAVOR flavor);
216 // Not currently used.
217 // OutputParams::FLAVOR format2flavor(std::string fmt);
219 extern Formats formats;
221 extern Formats system_formats;