src/insets/ExternalTemplate.h

   1 // -*- C++ -*-
   2 /**
   3  * \file ExternalTemplate.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup Nielsen
   8  * \author Angus Leeming
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef EXTERNALTEMPLATE_H
  14 #define EXTERNALTEMPLATE_H
  15
  16 #include "ExternalTransforms.h"
  17
  18 #include <boost/utility.hpp>
  19
  20 #include <iosfwd>
  21 #include <map>
  22 #include <string>
  23 #include <vector>
  24
  25 class LyXLex;
  26
  27 namespace lyx {
  28 namespace external {
  29
  30 struct Template {
  31         /// We have to have default commands for safety reasons!
  32         Template();
  33         ///
  34         void readTemplate(LyXLex &);
  35         ///
  36         void dumpFormats(std::ostream &) const;
  37
  38         struct Option {
  39                 Option(std::string const & name_, std::string const & opt_)
  40                         : name(name_), option(opt_) {}
  41                 std::string name;
  42                 std::string option;
  43         };
  44
  45         /// What is the name of this template in the LyX format?
  46         std::string lyxName;
  47         /// What will the button in the GUI say?
  48         std::string guiName;
  49         /// A short help text
  50         std::string helpText;
  51         /** The format of the input file. Can be "*", in which case we try and
  52          *   ascertain the format from the contents of the file.
  53          */
  54         std::string inputFormat;
  55         /// A file extension regular expression for the file browser
  56         std::string fileRegExp;
  57         /// What command should be executed to edit the file?
  58         std::string editCommand;
  59         /// Should we do automatic production of the output?
  60         bool automaticProduction;
  61         /// A collection of transforms that we can use to transform the data.
  62         std::vector<TransformID> transformIds;
  63
  64         /// This is the information needed to support a specific output format
  65         struct Format {
  66                 Format();
  67                 ///
  68                 void readFormat(LyXLex &);
  69
  70                 /// The text that should be inserted into the exported file
  71                 std::string product;
  72                 /// The filename of the resulting file
  73                 std::string updateResult;
  74                 /// The format of this file.
  75                 std::string updateFormat;
  76                 /// What features does this external inset require?
  77                 std::string requirement;
  78                 /// A collection of preamble snippets identified by name.
  79                 std::vector<std::string> preambleNames;
  80                 /// A list of options to the basic command.
  81                 std::vector<Option> options;
  82
  83                 /// The factory functions for each supported transformation.
  84                 std::map<TransformID, TransformStore> command_transformers;
  85                 std::map<TransformID, TransformStore> option_transformers;
  86         };
  87         ///
  88         typedef std::map<std::string, Format> Formats;
  89         ///
  90         Formats formats;
  91 };
  92
  93 #include "ExternalTransforms.h"
  94
  95 /**
  96  *  A singleton class that manages the external inset templates
  97  */
  98 class TemplateManager : boost::noncopyable {
  99 public:
 100         /// Map from the LyX name of the template to the template structure
 101         typedef std::map<std::string, Template> Templates;
 102         /** Map from the LyX name of the preamble definition to the preamble
 103          *  definition itself.
 104          */
 105         typedef std::map<std::string, std::string> PreambleDefs;
 106
 107         static TemplateManager & get();
 108
 109         Templates const & getTemplates() const;
 110         /** return the template by LyX name.
 111          *  If it isn't found, return 0.
 112          */
 113         Template const * getTemplateByName(std::string const & name) const;
 114         /** return the preamble definition by LyX name.
 115          *  If it isn't found, return an empty std::string.
 116          */
 117         std::string const getPreambleDefByName(std::string const & name) const;
 118 private:
 119         TemplateManager();
 120         void readTemplates(std::string const & path);
 121         void dumpTemplates(std::ostream &) const;
 122         void dumpPreambleDefs(std::ostream &) const;
 123
 124         Templates templates;
 125         PreambleDefs preambledefs;
 126 };
 127
 128 } // namespace external
 129 } // namespace lyx
 130
 131 #endif // EXTERNALTEMPLATE_H