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>
24 namespace support { class FileName; }
38 /// We have to have default commands for safety reasons!
41 void readTemplate(Lexer &);
43 void dumpFormats(std::ostream &) const;
47 Option(std::string const & name_, std::string const & opt_)
48 : name(name_), option(opt_) {}
53 /// What is the name of this template in the LyX format?
55 /// What will the button in the GUI say?
59 /** The format of the input file. Can be "*", in which case we try and
60 * ascertain the format from the contents of the file.
62 std::string inputFormat;
63 /// A file extension regular expression for the file browser
64 std::string fileRegExp;
65 /// Should we do automatic production of the output?
66 bool automaticProduction;
67 /// How should we preview the data in LyX?
68 PreviewMode preview_mode;
69 /// A collection of transforms that we can use to transform the data.
70 std::vector<TransformID> transformIds;
72 /// This is the information needed to support a specific output format
77 void readFormat(Lexer &);
79 /// The text that should be inserted into the exported file
81 /// The filename of the resulting file
82 std::string updateResult;
83 /// The format of this file.
84 std::string updateFormat;
85 /// What features does this external inset require?
86 std::vector<std::string> requirements;
87 /// A collection of preamble snippets identified by name.
88 std::vector<std::string> preambleNames;
89 /// A list of options to the basic command.
90 std::vector<Option> options;
92 /// The factory functions for each supported transformation.
93 std::map<TransformID, TransformStore> command_transformers;
94 std::map<TransformID, TransformStore> option_transformers;
96 typedef std::map<std::string,
97 std::vector<std::string> > FileMap;
98 /// Referenced files for some formats
99 FileMap referencedFiles;
102 typedef std::map<std::string, Format> Formats;
108 * A singleton class that manages the external inset templates
110 class TemplateManager {
112 /// Map from the LyX name of the template to the template structure
113 typedef std::map<std::string, Template> Templates;
114 /** Map from the LyX name of the preamble definition to the preamble
117 typedef std::map<std::string, std::string> PreambleDefs;
119 static TemplateManager & get();
121 Templates const & getTemplates() const;
122 /** return the template by LyX name.
123 * If it isn't found, return 0.
125 Template const * getTemplateByName(std::string const & name) const;
126 /** return the preamble definition by LyX name.
127 * If it isn't found, return an empty std::string.
129 std::string const getPreambleDefByName(std::string const & name) const;
133 TemplateManager(TemplateManager const &);
134 void operator=(TemplateManager const &);
136 void readTemplates(support::FileName const & path);
137 void dumpTemplates(std::ostream &) const;
138 void dumpPreambleDefs(std::ostream &) const;
141 PreambleDefs preambledefs;
144 } // namespace external
147 #endif // EXTERNALTEMPLATE_H