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"
24 /// Flags for some format properties
27 /// Set if this format is a document format (as opposed to
28 /// e.g. image formats).
29 /// Some formats are both (e.g. pdf), they have this flag set.
31 /// Set if this format can contain vector graphics.
35 Format(std::string const & n, std::string const & e, std::string const & p,
36 std::string const & s, std::string const & v, std::string const & ed,
40 /// Tell whether this format is a child format.
41 /// Child formats inherit settings like the viewer from their parent.
42 bool isChildFormat() const;
43 /// Name fo the parent format
44 std::string const parentFormat() const;
46 std::string const & name() const {
50 std::string const & extension() const {
54 std::string const & prettyname() const {
58 std::string const & shortcut() const {
62 std::string const & viewer() const {
66 void setViewer(std::string const & v) {
70 std::string const & editor() const {
74 void setEditor(std::string const & v) {
78 bool documentFormat() const {
79 return flags_ & document;
82 bool vectorFormat() const {
83 return flags_ & vector;
86 /// Internal name. Needs to be unique.
88 /// Filename extension
89 std::string extension_;
90 /// Name presented to the user. Needs to be unique.
91 std::string prettyname_;
92 /// Keyboard shortcut for the View and Export menu.
93 std::string shortcut_;
95 * Viewer for this format. Needs to be in the PATH or an absolute
97 * This format cannot be viewed if \c viewer_ is empty.
98 * If it is \c auto the default viewer of the OS for this format is
102 /// Editor for this format. \sa viewer_.
109 bool operator<(Format const & a, Format const & b);
116 typedef std::vector<Format> FormatList;
118 typedef FormatList::const_iterator const_iterator;
120 Format const & get(FormatList::size_type i) const {
121 return formatlist[i];
123 /// \returns format named \p name if it exists, otherwise 0
124 Format const * getFormat(std::string const & name) const;
126 * Get the format of \p filename from file contents or, if this
127 * fails, from file extension.
128 * \returns file format if it could be found, otherwise an empty
131 std::string getFormatFromFile(std::string const & filename) const;
132 /// Set editor and/or viewer to "auto" for formats that can be
133 /// opened by the OS.
136 int getNumber(std::string const & name) const;
138 void add(std::string const & name);
140 void add(std::string const & name, std::string const & extension,
141 std::string const & prettyname, std::string const & shortcut,
142 std::string const & viewer, std::string const & editor,
145 void erase(std::string const & name);
149 void setViewer(std::string const & name, std::string const & command);
151 bool view(Buffer const & buffer, std::string const & filename,
152 std::string const & format_name) const;
154 bool edit(Buffer const & buffer, std::string const & filename,
155 std::string const & format_name) const;
157 lyx::docstring const prettyName(std::string const & name) const;
159 std::string const extension(std::string const & name) const;
161 const_iterator begin() const {
162 return formatlist.begin();
165 const_iterator end() const {
166 return formatlist.end();
169 FormatList::size_type size() const {
170 return formatlist.size();
174 FormatList formatlist;
177 extern Formats formats;
179 extern Formats system_formats;