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.
39 Format(std::string
const & n
, std::string
const & e
, std::string
const & p
,
40 std::string
const & s
, std::string
const & v
, std::string
const & ed
,
44 /// Tell whether this format is a child format.
45 /// Child formats inherit settings like the viewer from their parent.
46 bool isChildFormat() const;
47 /// Name fo the parent format
48 std::string
const parentFormat() const;
50 std::string
const & name() const {
54 std::string
const & extension() const {
58 std::string
const & prettyname() const {
62 std::string
const & shortcut() const {
66 std::string
const & viewer() const {
70 void setViewer(std::string
const & v
) {
74 std::string
const & editor() const {
78 void setEditor(std::string
const & v
) {
82 bool documentFormat() const {
83 return flags_
& document
;
86 bool vectorFormat() const {
87 return flags_
& vector
;
90 /// Internal name. Needs to be unique.
92 /// Filename extension
93 std::string extension_
;
94 /// Name presented to the user. Needs to be unique.
95 std::string prettyname_
;
96 /// Keyboard shortcut for the View and Export menu.
97 std::string shortcut_
;
99 * Viewer for this format. Needs to be in the PATH or an absolute
101 * This format cannot be viewed if \c viewer_ is empty.
102 * If it is \c auto the default viewer of the OS for this format is
106 /// Editor for this format. \sa viewer_.
113 bool operator<(Format
const & a
, Format
const & b
);
120 typedef std::vector
<Format
> FormatList
;
122 typedef FormatList::const_iterator const_iterator
;
124 Format
const & get(FormatList::size_type i
) const {
125 return formatlist
[i
];
127 /// \returns format named \p name if it exists, otherwise 0
128 Format
const * getFormat(std::string
const & name
) const;
130 * Get the format of \p filename from file contents or, if this
131 * fails, from file extension.
132 * \returns file format if it could be found, otherwise an empty
135 std::string
getFormatFromFile(support::FileName
const & filename
) const;
136 /// Set editor and/or viewer to "auto" for formats that can be
137 /// opened by the OS.
140 int getNumber(std::string
const & name
) const;
142 void add(std::string
const & name
);
144 void add(std::string
const & name
, std::string
const & extension
,
145 std::string
const & prettyname
, std::string
const & shortcut
,
146 std::string
const & viewer
, std::string
const & editor
,
149 void erase(std::string
const & name
);
153 void setViewer(std::string
const & name
, std::string
const & command
);
155 bool view(Buffer
const & buffer
, support::FileName
const & filename
,
156 std::string
const & format_name
) const;
158 bool edit(Buffer
const & buffer
, support::FileName
const & filename
,
159 std::string
const & format_name
) const;
161 docstring
const prettyName(std::string
const & name
) const;
163 std::string
const extension(std::string
const & name
) const;
165 const_iterator
begin() const { return formatlist
.begin(); }
167 const_iterator
end() const { return formatlist
.end(); }
169 FormatList::size_type
size() const { return formatlist
.size(); }
172 FormatList formatlist
;
175 extern Formats formats
;
177 extern Formats system_formats
;