3 * \file ExternalTemplate.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup Nielsen
8 * \author Angus Leeming
10 * Full author contact details are available in file CREDITS.
13 #ifndef EXTERNALTEMPLATE_H
14 #define EXTERNALTEMPLATE_H
16 #include "ExternalTransforms.h"
18 #include <boost/noncopyable.hpp>
22 namespace support { class FileName; }
36 /// We have to have default commands for safety reasons!
39 void readTemplate(Lexer &);
41 void dumpFormats(std::ostream &) const;
45 Option(std::string const & name_, std::string const & opt_)
46 : name(name_), option(opt_) {}
51 /// What is the name of this template in the LyX format?
53 /// What will the button in the GUI say?
57 /** The format of the input file. Can be "*", in which case we try and
58 * ascertain the format from the contents of the file.
60 std::string inputFormat;
61 /// A file extension regular expression for the file browser
62 std::string fileRegExp;
63 /// Should we do automatic production of the output?
64 bool automaticProduction;
65 /// How should we preview the data in LyX?
66 PreviewMode preview_mode;
67 /// A collection of transforms that we can use to transform the data.
68 std::vector<TransformID> transformIds;
70 /// This is the information needed to support a specific output format
75 void readFormat(Lexer &);
77 /// The text that should be inserted into the exported file
79 /// The filename of the resulting file
80 std::string updateResult;
81 /// The format of this file.
82 std::string updateFormat;
83 /// What features does this external inset require?
84 std::vector<std::string> requirements;
85 /// A collection of preamble snippets identified by name.
86 std::vector<std::string> preambleNames;
87 /// A list of options to the basic command.
88 std::vector<Option> options;
90 /// The factory functions for each supported transformation.
91 std::map<TransformID, TransformStore> command_transformers;
92 std::map<TransformID, TransformStore> option_transformers;
94 typedef std::map<std::string,
95 std::vector<std::string> > FileMap;
96 /// Referenced files for some formats
97 FileMap referencedFiles;
100 typedef std::map<std::string, Format> Formats;
106 * A singleton class that manages the external inset templates
108 class TemplateManager : boost::noncopyable {
110 /// Map from the LyX name of the template to the template structure
111 typedef std::map<std::string, Template> Templates;
112 /** Map from the LyX name of the preamble definition to the preamble
115 typedef std::map<std::string, std::string> PreambleDefs;
117 static TemplateManager & get();
119 Templates const & getTemplates() const;
120 /** return the template by LyX name.
121 * If it isn't found, return 0.
123 Template const * getTemplateByName(std::string const & name) const;
124 /** return the preamble definition by LyX name.
125 * If it isn't found, return an empty std::string.
127 std::string const getPreambleDefByName(std::string const & name) const;
130 void readTemplates(support::FileName const & path);
131 void dumpTemplates(std::ostream &) const;
132 void dumpPreambleDefs(std::ostream &) const;
135 PreambleDefs preambledefs;
138 } // namespace external
141 #endif // EXTERNALTEMPLATE_H