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"
25 namespace support { class FileName; }
31 /// Flags for some format properties
34 /// Set if this format is a document format (as opposed to
35 /// e.g. image formats).
36 /// Some formats are both (e.g. pdf), they have this flag set.
38 /// Set if this format can contain vector graphics.
40 /// This format should appear in the File > Export menu
42 /// This may be a compressed file but doesn't need decompression
46 Format(std::string const & n, std::string const & e, std::string const & p,
47 std::string const & s, std::string const & v, std::string const & ed,
51 /// Is \p ext a valid filename extension for this format?
52 bool hasExtension(std::string const & ext) const;
53 /// Tell whether this format is a child format.
54 /// Child formats inherit settings like the viewer from their parent.
55 bool isChildFormat() const;
56 /// Name fo the parent format
57 std::string const parentFormat() const;
59 std::string const & name() const { return name_; }
61 void setName(std::string const & v) { name_ = v; }
63 std::string const & extension() const
65 return extension_list_.empty() ? empty_string() : extension_list_[0];
68 std::string const & extensions() const { return extensions_; }
70 void setExtensions(std::string const & v);
72 std::string const & prettyname() const { return prettyname_; }
74 void setPrettyname(std::string const & v) { prettyname_ = v; }
76 std::string const & shortcut() const { return shortcut_; }
78 void setShortcut(std::string const & v) { shortcut_ = v; }
80 std::string const & viewer() const { return viewer_; }
82 void setViewer(std::string const & v) { viewer_ = v; }
84 std::string const & editor() const { return editor_; }
86 void setEditor(std::string const & v) { editor_ = v; }
88 bool documentFormat() const { return flags_ & document; }
90 bool vectorFormat() const { return flags_ & vector; }
92 void setFlags(int v) { flags_ = v; }
94 bool inExportMenu() const { return flags_ & export_menu; }
96 bool zippedNative() const { return flags_ & zipped_native; }
98 /// Internal name. Needs to be unique.
100 /// Filename extensions, the first one being the default
101 mutable std::vector<std::string> extension_list_;
102 /// All filename extensions
103 std::string extensions_;
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_.
123 bool operator<(Format const & a, Format const & b);
130 typedef std::vector<Format> FormatList;
132 typedef FormatList::const_iterator const_iterator;
134 Format const & get(FormatList::size_type i) const { return formatlist[i]; }
136 Format & get(FormatList::size_type i) { return formatlist[i]; }
137 /// \returns format named \p name if it exists, otherwise 0
138 Format const * getFormat(std::string const & name) const;
140 * Get the format of \p filename from file contents or, if this
141 * fails, from file extension.
142 * \returns file format if it could be found, otherwise an empty
145 std::string getFormatFromFile(support::FileName const & filename) const;
146 /// Finds a format from a file extension. Returns string() if not found.
147 std::string getFormatFromExtension(std::string const & ext) const;
148 /** Returns true if the file referenced by \p filename is zipped and
149 ** needs to be unzipped for being handled
150 ** @note For natively zipped formats, such as dia/odg, this returns false.
152 bool isZippedFile(support::FileName const & filename) const;
153 /// Set editor and/or viewer to "auto" for formats that can be
154 /// opened by the OS.
157 int getNumber(std::string const & name) const;
159 void add(std::string const & name);
161 void add(std::string const & name, std::string const & extensions,
162 std::string const & prettyname, std::string const & shortcut,
163 std::string const & viewer, std::string const & editor,
166 void erase(std::string const & name);
170 void setViewer(std::string const & name, std::string const & command);
172 void setEditor(std::string const & name, std::string const & command);
173 /// View the given file. Buffer used for DVI's paper orientation.
174 bool view(Buffer const & buffer, support::FileName const & filename,
175 std::string const & format_name) const;
177 bool edit(Buffer const & buffer, support::FileName const & filename,
178 std::string const & format_name) const;
180 docstring const prettyName(std::string const & name) const;
182 std::string const extension(std::string const & name) const;
184 std::string const extensions(std::string const & name) const;
186 const_iterator begin() const { return formatlist.begin(); }
188 const_iterator end() const { return formatlist.end(); }
190 FormatList::size_type size() const { return formatlist.size(); }
193 FormatList formatlist;
194 /// Used to store last timestamp of file and whether it is (was) zipped
196 bool zipped; std::time_t timestamp;
197 ZippedInfo(bool zipped, std::time_t timestamp)
198 : zipped(zipped), timestamp(timestamp) { }
201 mutable std::map<std::string, ZippedInfo> zipped_;
205 std::string flavor2format(OutputParams::FLAVOR flavor);
206 // Not currently used.
207 // OutputParams::FLAVOR format2flavor(std::string fmt);
209 extern Formats formats;
211 extern Formats system_formats;