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"
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
43 Format(std::string const & n, std::string const & e, std::string const & p,
44 std::string const & s, std::string const & v, std::string const & ed,
48 /// Tell whether this format is a child format.
49 /// Child formats inherit settings like the viewer from their parent.
50 bool isChildFormat() const;
51 /// Name fo the parent format
52 std::string const parentFormat() const;
54 std::string const & name() const { return name_; }
56 void setName(std::string const & v) { name_ = v; }
58 std::string const & extension() const { return extension_; }
60 void setExtension(std::string const & v) { extension_ = v; }
62 std::string const & prettyname() const { return prettyname_; }
64 void setPrettyname(std::string const & v) { prettyname_ = v; }
66 std::string const & shortcut() const { return shortcut_; }
68 void setShortcut(std::string const & v) { shortcut_ = v; }
70 std::string const & viewer() const { return viewer_; }
72 void setViewer(std::string const & v) { viewer_ = v; }
74 std::string const & editor() const { return editor_; }
76 void setEditor(std::string const & v) { editor_ = v; }
78 bool documentFormat() const { return flags_ & document; }
80 bool vectorFormat() const { return flags_ & vector; }
82 void setFlags(int v) { flags_ = v; }
84 bool inExportMenu() const { return flags_ & export_menu; }
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 { return formatlist[i]; }
122 Format & get(FormatList::size_type i) { 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(support::FileName 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 void setEditor(std::string const & name, std::string const & command);
152 /// View the given file. Buffer used for DVI's paper orientation.
153 bool view(Buffer const & buffer, support::FileName const & filename,
154 std::string const & format_name) const;
156 bool edit(Buffer const & buffer, support::FileName const & filename,
157 std::string const & format_name) const;
159 docstring const prettyName(std::string const & name) const;
161 std::string const extension(std::string const & name) const;
163 const_iterator begin() const { return formatlist.begin(); }
165 const_iterator end() const { return formatlist.end(); }
167 FormatList::size_type size() const { return formatlist.size(); }
170 FormatList formatlist;
174 std::string flavor2format(OutputParams::FLAVOR flavor);
175 // Not currently used.
176 // OutputParams::FLAVOR format2flavor(std::string fmt);
178 extern Formats formats;
180 extern Formats system_formats;