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/utility.hpp>
28 /// We have to have default commands for safety reasons!
31 void readTemplate(LyXLex &);
33 void dumpFormats(std::ostream &) const;
37 Option(std::string const & name_, std::string const & opt_)
38 : name(name_), option(opt_) {}
43 /// What is the name of this template in the LyX format?
45 /// What will the button in the GUI say?
49 /** The format of the input file. Can be "*", in which case we try and
50 * ascertain the format from the contents of the file.
52 std::string inputFormat;
53 /// A file extension regular expression for the file browser
54 std::string fileRegExp;
55 /// Should we do automatic production of the output?
56 bool automaticProduction;
57 /// A collection of transforms that we can use to transform the data.
58 std::vector<TransformID> transformIds;
60 /// This is the information needed to support a specific output format
65 void readFormat(LyXLex &);
67 /// The text that should be inserted into the exported file
69 /// The filename of the resulting file
70 std::string updateResult;
71 /// The format of this file.
72 std::string updateFormat;
73 /// What features does this external inset require?
74 std::vector<std::string> requirements;
75 /// A collection of preamble snippets identified by name.
76 std::vector<std::string> preambleNames;
77 /// A list of options to the basic command.
78 std::vector<Option> options;
80 /// The factory functions for each supported transformation.
81 std::map<TransformID, TransformStore> command_transformers;
82 std::map<TransformID, TransformStore> option_transformers;
84 typedef std::map<std::string,
85 std::vector<std::string> > FileMap;
86 /// Referenced files for some formats
87 FileMap referencedFiles;
90 typedef std::map<std::string, Format> Formats;
96 * A singleton class that manages the external inset templates
98 class TemplateManager : boost::noncopyable {
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
105 typedef std::map<std::string, std::string> PreambleDefs;
107 static TemplateManager & get();
109 Templates const & getTemplates() const;
110 /** return the template by LyX name.
111 * If it isn't found, return 0.
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.
117 std::string const getPreambleDefByName(std::string const & name) const;
120 void readTemplates(std::string const & path);
121 void dumpTemplates(std::ostream &) const;
122 void dumpPreambleDefs(std::ostream &) const;
125 PreambleDefs preambledefs;
128 } // namespace external
131 #endif // EXTERNALTEMPLATE_H