X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fformat.h;h=9c5c32180f9849b4ad5beb8b6e2422cbab15d77f;hb=969ab85d985485f503790cb13f98a582d4e1cdb5;hp=54e337ff0abd99b6326561dea7095d1f8f92dd3e;hpb=dacd4cea2649ebe32ed386eaa6628e47c68e7b6b;p=lyx.git

diff --git a/src/format.h b/src/format.h
index 54e337ff0a..9c5c32180f 100644
--- a/src/format.h
+++ b/src/format.h
@@ -12,21 +12,39 @@
 #ifndef FORMAT_H
 #define FORMAT_H
 
+#include "support/docstring.h"
+
 #include <vector>
-#include <string>
+
+
+namespace lyx {
+
+namespace support { class FileName; }
 
 class Buffer;
 
 class Format {
 public:
+	/// Flags for some format properties
+	enum Flags {
+		none = 0,
+		/// Set if this format is a document format (as opposed to
+		/// e.g. image formats).
+		/// Some formats are both (e.g. pdf), they have this flag set.
+		document = 1,
+		/// Set if this format can contain vector graphics.
+		vector = 2,
+	};
 	///
 	Format(std::string const & n, std::string const & e, std::string const & p,
-	       std::string const & s, std::string const & v, std::string const & ed);
+	       std::string const & s, std::string const & v, std::string const & ed,
+	       int);
 	///
 	bool dummy() const;
-	///
+	/// Tell whether this format is a child format.
+	/// Child formats inherit settings like the viewer from their parent.
 	bool isChildFormat() const;
-	///
+	/// Name fo the parent format
 	std::string const parentFormat() const;
 	///
 	std::string const & name() const {
@@ -56,23 +74,45 @@ public:
 	std::string const & editor() const {
 		return editor_;
 	}
+	///
+	void setEditor(std::string const & v) {
+		editor_ = v;
+	}
+	///
+	bool documentFormat() const {
+		return flags_ & document;
+	}
+	///
+	bool vectorFormat() const {
+		return flags_ & vector;
+	}
 private:
+	/// Internal name. Needs to be unique.
 	std::string name_;
-	///
+	/// Filename extension
 	std::string extension_;
-	///
+	/// Name presented to the user. Needs to be unique.
 	std::string prettyname_;
-	///
+	/// Keyboard shortcut for the View and Export menu.
 	std::string shortcut_;
-	///
+	/*!
+	 * Viewer for this format. Needs to be in the PATH or an absolute
+	 * filename.
+	 * This format cannot be viewed if \c viewer_ is empty.
+	 * If it is \c auto the default viewer of the OS for this format is
+	 * used.
+	 */
 	std::string viewer_;
-	///
+	/// Editor for this format. \sa viewer_.
 	std::string editor_;
+	///
+	int flags_;
 };
 
 
 bool operator<(Format const & a, Format const & b);
 
+
 ///
 class Formats {
 public:
@@ -92,7 +132,10 @@ public:
 	 * \returns file format if it could be found, otherwise an empty
 	 * string.
 	 */
-	std::string getFormatFromFile(std::string const & filename) const;
+	std::string getFormatFromFile(support::FileName const & filename) const;
+	/// Set editor and/or viewer to "auto" for formats that can be
+	/// opened by the OS.
+	void setAutoOpen();
 	///
 	int getNumber(std::string const & name) const;
 	///
@@ -100,7 +143,8 @@ public:
 	///
 	void add(std::string const & name, std::string const & extension,
 	         std::string const & prettyname, std::string const & shortcut,
-	         std::string const & viewer, std::string const & editor);
+	         std::string const & viewer, std::string const & editor,
+	         int flags);
 	///
 	void erase(std::string const & name);
 	///
@@ -108,27 +152,21 @@ public:
 	///
 	void setViewer(std::string const & name, std::string const & command);
 	///
-	bool view(Buffer const & buffer, std::string const & filename,
+	bool view(Buffer const & buffer, support::FileName const & filename,
 		  std::string const & format_name) const;
 	///
-	bool edit(Buffer const & buffer, std::string const & filename,
+	bool edit(Buffer const & buffer, support::FileName const & filename,
 		  std::string const & format_name) const;
 	///
-	std::string const prettyName(std::string const & name) const;
+	docstring const prettyName(std::string const & name) const;
 	///
 	std::string const extension(std::string const & name) const;
 	///
-	const_iterator begin() const {
-		return formatlist.begin();
-	}
+	const_iterator begin() const { return formatlist.begin(); }
 	///
-	const_iterator end() const {
-		return formatlist.end();
-	}
+	const_iterator end() const { return formatlist.end(); }
 	///
-	FormatList::size_type size() const {
-		return formatlist.size();
-	}
+	FormatList::size_type size() const { return formatlist.size(); }
 private:
 	///
 	FormatList formatlist;
@@ -138,4 +176,7 @@ extern Formats formats;
 
 extern Formats system_formats;
 
+
+} // namespace lyx
+
 #endif //FORMAT_H