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"
22 namespace support { class FileName; }
28 /// Flags for some format properties
31 /// Set if this format is a document format (as opposed to
32 /// e.g. image formats).
33 /// Some formats are both (e.g. pdf), they have this flag set.
35 /// Set if this format can contain vector graphics.
37 /// This format should appear in the File > Export menu
41 Format(std::string const & n, std::string const & e, std::string const & p,
42 std::string const & s, std::string const & v, std::string const & ed,
46 /// Tell whether this format is a child format.
47 /// Child formats inherit settings like the viewer from their parent.
48 bool isChildFormat() const;
49 /// Name fo the parent format
50 std::string const parentFormat() const;
52 std::string const & name() const { return name_; }
54 void setName(std::string const & v) { name_ = v; }
56 std::string const & extension() const { return extension_; }
58 void setExtension(std::string const & v) { extension_ = v; }
60 std::string const & prettyname() const { return prettyname_; }
62 void setPrettyname(std::string const & v) { prettyname_ = v; }
64 std::string const & shortcut() const { return shortcut_; }
66 void setShortcut(std::string const & v) { shortcut_ = v; }
68 std::string const & viewer() const { return viewer_; }
70 void setViewer(std::string const & v) { viewer_ = v; }
72 std::string const & editor() const { return editor_; }
74 void setEditor(std::string const & v) { editor_ = v; }
76 bool documentFormat() const { return flags_ & document; }
78 bool vectorFormat() const { return flags_ & vector; }
80 void setFlags(int v) { flags_ = v; }
82 bool inExportMenu() const { return flags_ & export_menu; }
84 /// Internal name. Needs to be unique.
86 /// Filename extension
87 std::string extension_;
88 /// Name presented to the user. Needs to be unique.
89 std::string prettyname_;
90 /// Keyboard shortcut for the View and Export menu.
91 std::string shortcut_;
93 * Viewer for this format. Needs to be in the PATH or an absolute
95 * This format cannot be viewed if \c viewer_ is empty.
96 * If it is \c auto the default viewer of the OS for this format is
100 /// Editor for this format. \sa viewer_.
107 bool operator<(Format const & a, Format const & b);
114 typedef std::vector<Format> FormatList;
116 typedef FormatList::const_iterator const_iterator;
118 Format const & get(FormatList::size_type i) const { return formatlist[i]; }
120 Format & get(FormatList::size_type i) { return formatlist[i]; }
121 /// \returns format named \p name if it exists, otherwise 0
122 Format const * getFormat(std::string const & name) const;
124 * Get the format of \p filename from file contents or, if this
125 * fails, from file extension.
126 * \returns file format if it could be found, otherwise an empty
129 std::string getFormatFromFile(support::FileName const & filename) const;
130 /// Set editor and/or viewer to "auto" for formats that can be
131 /// opened by the OS.
134 int getNumber(std::string const & name) const;
136 void add(std::string const & name);
138 void add(std::string const & name, std::string const & extension,
139 std::string const & prettyname, std::string const & shortcut,
140 std::string const & viewer, std::string const & editor,
143 void erase(std::string const & name);
147 void setViewer(std::string const & name, std::string const & command);
149 void setEditor(std::string const & name, std::string const & command);
150 /// View the given file. Buffer used for DVI's paper orientation.
151 bool view(Buffer const & buffer, support::FileName const & filename,
152 std::string const & format_name) const;
154 bool edit(Buffer const & buffer, support::FileName const & filename,
155 std::string const & format_name) const;
157 docstring const prettyName(std::string const & name) const;
159 std::string const extension(std::string const & name) const;
161 const_iterator begin() const { return formatlist.begin(); }
163 const_iterator end() const { return formatlist.end(); }
165 FormatList::size_type size() const { return formatlist.size(); }
168 FormatList formatlist;
171 extern Formats formats;
173 extern Formats system_formats;