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; }
30 /// We have to have default commands for safety reasons!
33 void readTemplate(Lexer &);
35 void dumpFormats(std::ostream &) const;
39 Option(std::string const & name_, std::string const & opt_)
40 : name(name_), option(opt_) {}
45 /// What is the name of this template in the LyX format?
47 /// What will the button in the GUI say?
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.
54 std::string inputFormat;
55 /// A file extension regular expression for the file browser
56 std::string fileRegExp;
57 /// Should we do automatic production of the output?
58 bool automaticProduction;
59 /// A collection of transforms that we can use to transform the data.
60 std::vector<TransformID> transformIds;
62 /// This is the information needed to support a specific output format
67 void readFormat(Lexer &);
69 /// The text that should be inserted into the exported file
71 /// The filename of the resulting file
72 std::string updateResult;
73 /// The format of this file.
74 std::string updateFormat;
75 /// What features does this external inset require?
76 std::vector<std::string> requirements;
77 /// A collection of preamble snippets identified by name.
78 std::vector<std::string> preambleNames;
79 /// A list of options to the basic command.
80 std::vector<Option> options;
82 /// The factory functions for each supported transformation.
83 std::map<TransformID, TransformStore> command_transformers;
84 std::map<TransformID, TransformStore> option_transformers;
86 typedef std::map<std::string,
87 std::vector<std::string> > FileMap;
88 /// Referenced files for some formats
89 FileMap referencedFiles;
92 typedef std::map<std::string, Format> Formats;
98 * A singleton class that manages the external inset templates
100 class TemplateManager : boost::noncopyable {
102 /// Map from the LyX name of the template to the template structure
103 typedef std::map<std::string, Template> Templates;
104 /** Map from the LyX name of the preamble definition to the preamble
107 typedef std::map<std::string, std::string> PreambleDefs;
109 static TemplateManager & get();
111 Templates const & getTemplates() const;
112 /** return the template by LyX name.
113 * If it isn't found, return 0.
115 Template const * getTemplateByName(std::string const & name) const;
116 /** return the preamble definition by LyX name.
117 * If it isn't found, return an empty std::string.
119 std::string const getPreambleDefByName(std::string const & name) const;
122 void readTemplates(support::FileName const & path);
123 void dumpTemplates(std::ostream &) const;
124 void dumpPreambleDefs(std::ostream &) const;
127 PreambleDefs preambledefs;
130 } // namespace external
133 #endif // EXTERNALTEMPLATE_H