src/Format.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Format.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Dekel Tsur
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef FORMAT_H
  13 #define FORMAT_H
  14
  15 #include "support/docstring.h"
  16
  17 #include <vector>
  18
  19
  20 namespace lyx {
  21
  22 namespace support { class FileName; }
  23
  24 class Buffer;
  25
  26 class Format {
  27 public:
  28         /// Flags for some format properties
  29         enum Flags {
  30                 none = 0,
  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.
  34                 document = 1,
  35                 /// Set if this format can contain vector graphics.
  36                 vector = 2,
  37         };
  38         ///
  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,
  41                int);
  42         ///
  43         bool dummy() const;
  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;
  49         ///
  50         std::string const & name() const { return name_; }
  51         ///
  52         void setName(std::string const & v) { name_ = v; }
  53         ///
  54         std::string const & extension() const { return extension_; }
  55         ///
  56         void setExtension(std::string const & v) { extension_ = v; }
  57         ///
  58         std::string const & prettyname() const { return prettyname_; }
  59         ///
  60         void setPrettyname(std::string const & v) { prettyname_ = v; }
  61         ///
  62         std::string const & shortcut() const { return shortcut_; }
  63         ///
  64         void setShortcut(std::string const & v) { shortcut_ = v; }
  65         ///
  66         std::string const & viewer() const { return viewer_; }
  67         ///
  68         void setViewer(std::string const & v) { viewer_ = v; }
  69         ///
  70         std::string const & editor() const { return editor_; }
  71         ///
  72         void setEditor(std::string const & v) { editor_ = v; }
  73         ///
  74         bool documentFormat() const { return flags_ & document; }
  75         ///
  76         bool vectorFormat() const { return flags_ & vector; }
  77         ///
  78         void setFlags(int v) { flags_ = v; }
  79 private:
  80         /// Internal name. Needs to be unique.
  81         std::string name_;
  82         /// Filename extension
  83         std::string extension_;
  84         /// Name presented to the user. Needs to be unique.
  85         std::string prettyname_;
  86         /// Keyboard shortcut for the View and Export menu.
  87         std::string shortcut_;
  88         /*!
  89          * Viewer for this format. Needs to be in the PATH or an absolute
  90          * filename.
  91          * This format cannot be viewed if \c viewer_ is empty.
  92          * If it is \c auto the default viewer of the OS for this format is
  93          * used.
  94          */
  95         std::string viewer_;
  96         /// Editor for this format. \sa viewer_.
  97         std::string editor_;
  98         ///
  99         int flags_;
 100 };
 101
 102
 103 bool operator<(Format const & a, Format const & b);
 104
 105
 106 ///
 107 class Formats {
 108 public:
 109         ///
 110         typedef std::vector<Format> FormatList;
 111         ///
 112         typedef FormatList::const_iterator const_iterator;
 113         ///
 114         Format const & get(FormatList::size_type i) const { return formatlist[i]; }
 115         ///
 116         Format & get(FormatList::size_type i) { return formatlist[i]; }
 117         /// \returns format named \p name if it exists, otherwise 0
 118         Format const * getFormat(std::string const & name) const;
 119         /*!
 120          * Get the format of \p filename from file contents or, if this
 121          * fails, from file extension.
 122          * \returns file format if it could be found, otherwise an empty
 123          * string.
 124          */
 125         std::string getFormatFromFile(support::FileName const & filename) const;
 126         /// Set editor and/or viewer to "auto" for formats that can be
 127         /// opened by the OS.
 128         void setAutoOpen();
 129         ///
 130         int getNumber(std::string const & name) const;
 131         ///
 132         void add(std::string const & name);
 133         ///
 134         void add(std::string const & name, std::string const & extension,
 135                  std::string const & prettyname, std::string const & shortcut,
 136                  std::string const & viewer, std::string const & editor,
 137                  int flags);
 138         ///
 139         void erase(std::string const & name);
 140         ///
 141         void sort();
 142         ///
 143         void setViewer(std::string const & name, std::string const & command);
 144         ///
 145         bool view(Buffer const & buffer, support::FileName const & filename,
 146                   std::string const & format_name) const;
 147         ///
 148         bool edit(Buffer const & buffer, support::FileName const & filename,
 149                   std::string const & format_name) const;
 150         ///
 151         docstring const prettyName(std::string const & name) const;
 152         ///
 153         std::string const extension(std::string const & name) const;
 154         ///
 155         const_iterator begin() const { return formatlist.begin(); }
 156         ///
 157         const_iterator end() const { return formatlist.end(); }
 158         ///
 159         FormatList::size_type size() const { return formatlist.size(); }
 160 private:
 161         ///
 162         FormatList formatlist;
 163 };
 164
 165 extern Formats formats;
 166
 167 extern Formats system_formats;
 168
 169
 170 } // namespace lyx
 171
 172 #endif //FORMAT_H