2 * \file ExternalTemplate.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup Nielsen
8 * Full author contact details are available in file CREDITS.
13 #include "ExternalTemplate.h"
18 #include "support/filetools.h"
19 #include "support/LAssert.h"
20 #include "support/lstrings.h"
21 #include "support/path.h"
22 #include "support/path_defines.h"
26 namespace support = lyx::support;
34 // We have to have dummy default commands for security reasons!
36 ExternalTemplate::ExternalTemplate()
41 ExternalTemplate::FormatTemplate::FormatTemplate()
45 ExternalTemplateManager::ExternalTemplateManager()
47 // gimp gnuchess gnuplot ical netscape tetris xpaint
48 readTemplates(support::user_lyxdir());
49 if (lyxerr.debugging(Debug::EXTERNAL)) {
50 dumpPreambleDefs(lyxerr);
52 dumpTemplates(lyxerr);
57 class dumpPreambleDef {
59 typedef ExternalTemplateManager::PreambleDefs::value_type value_type;
61 dumpPreambleDef(ostream & o) : ost(o) {}
63 void operator()(value_type const & vt) {
64 ost << "PreambleDef " << vt.first << '\n'
66 << "PreambleDefEnd" << endl;
76 typedef ExternalTemplateManager::Templates::value_type value_type;
78 dumpTemplate(ostream & o) : ost(o) {}
80 void operator()(value_type const & vt) {
81 ExternalTemplate const & et = vt.second;
83 ost << "Template " << et.lyxName << '\n'
84 << "\tGuiName " << et.guiName << '\n'
88 << "\tInputFormat " << et.inputFormat << '\n'
89 << "\tFileFilter " << et.fileRegExp << '\n'
90 << "\tEditCommand " << et.editCommand << '\n'
91 << "\tAutomaticProduction " << et.automaticProduction << '\n';
93 ost << "TemplateEnd" << endl;
103 typedef ExternalTemplate::Formats::value_type value_type;
105 dumpFormat(ostream & o) : ost(o) {}
107 void operator()(value_type const & vt) const{
108 ExternalTemplate::FormatTemplate const & ft = vt.second;
109 ost << "\tFormat " << vt.first << '\n'
110 << "\t\tProduct " << ft.product << '\n'
111 << "\t\tUpdateFormat " << ft.updateFormat << '\n'
112 << "\t\tUpdateResult " << ft.updateResult << '\n'
113 << "\t\tRequirement " << ft.requirement << '\n'
114 << "\t\tPreamble " << ft.preambleName << '\n'
122 void ExternalTemplate::dumpFormats(ostream & os) const
124 for_each(formats.begin(), formats.end(), dumpFormat(os));
128 void ExternalTemplateManager::dumpPreambleDefs(ostream & os) const
130 for_each(preambledefs.begin(), preambledefs.end(), dumpPreambleDef(os));
134 void ExternalTemplateManager::dumpTemplates(ostream & os) const
136 for_each(templates.begin(), templates.end(), dumpTemplate(os));
140 ExternalTemplateManager & ExternalTemplateManager::get()
142 static ExternalTemplateManager externalTemplateManager;
143 return externalTemplateManager;
147 ExternalTemplateManager::Templates &
148 ExternalTemplateManager::getTemplates()
154 ExternalTemplateManager::Templates const &
155 ExternalTemplateManager::getTemplates() const
161 ExternalTemplate const & ExternalTemplateManager::getTemplateByName(string const & name)
163 return templates[name];
168 ExternalTemplateManager::getPreambleDefByName(string const & name) const
170 string const trimmed_name = support::trim(name);
171 if (trimmed_name.empty())
174 PreambleDefs::const_iterator it = preambledefs.find(trimmed_name);
175 if (it == preambledefs.end())
182 void ExternalTemplateManager::readTemplates(string const & path)
184 support::Path p(path);
193 keyword_item templatetags[] = {
194 { "preambledef", TM_PREAMBLEDEF },
195 { "preambledefend", TM_PREAMBLEDEF_END },
196 { "template", TM_TEMPLATE },
197 { "templateend", TM_TEMPLATE_END }
200 LyXLex lex(templatetags, TM_TEMPLATE_END);
202 string filename = support::LibFileSearch("", "external_templates");
203 if (filename.empty() || !lex.setFile(filename)) {
204 lex.printError("ExternalTemplateManager::readTemplates: "
209 char const * const preamble_end_tag =
210 templatetags[TM_PREAMBLEDEF_END-1].tag;
214 case TM_PREAMBLEDEF: {
216 string const name = lex.getString();
217 preambledefs[name] = lex.getLongString(preamble_end_tag);
223 string const name = lex.getString();
224 ExternalTemplate & tmp = templates[name];
226 tmp.readTemplate(lex);
230 case TM_TEMPLATE_END:
231 lex.printError("Warning: End outside Template.");
234 case TM_PREAMBLEDEF_END:
235 lex.printError("Warning: End outside PreambleDef.");
242 void ExternalTemplate::readTemplate(LyXLex & lex)
244 enum TemplateOptionTags {
255 keyword_item templateoptiontags[] = {
256 { "automaticproduction", TO_AUTOMATIC },
257 { "editcommand", TO_EDITCMD },
258 { "filefilter", TO_FILTER },
259 { "format", TO_FORMAT },
260 { "guiname", TO_GUINAME },
261 { "helptext", TO_HELPTEXT },
262 { "inputformat", TO_INPUTFORMAT },
263 { "templateend", TO_END }
266 pushpophelper pph(lex, templateoptiontags, TO_END);
272 guiName = lex.getString();
276 helpText = lex.getLongString("HelpTextEnd");
281 inputFormat = lex.getString();
286 fileRegExp = lex.getString();
291 editCommand = lex.getString();
296 automaticProduction = lex.getBool();
301 formats[lex.getString()].readFormat(lex);
308 lex.printError("ExternalTemplate::readTemplate: "
309 "Wrong tag: $$Token");
310 support::Assert(false);
317 void ExternalTemplate::FormatTemplate::readFormat(LyXLex & lex)
328 keyword_item formattags[] = {
329 { "formatend", FO_END },
330 { "preamble", FO_PREAMBLE },
331 { "product", FO_PRODUCT },
332 { "requirement", FO_REQUIREMENT },
333 { "updateformat", FO_UPDATEFORMAT },
334 { "updateresult", FO_UPDATERESULT }
337 pushpophelper pph(lex, formattags, FO_END);
343 product = lex.getString();
346 case FO_UPDATEFORMAT:
348 updateFormat = lex.getString();
351 case FO_UPDATERESULT:
353 updateResult = lex.getString();
358 requirement = lex.getString();
363 preambleName = lex.getString();