src/insets/ExternalTemplate.C

   1 /**
   2  * \file ExternalTemplate.C
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Asger Alstrup Nielsen
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 #include "ExternalTemplate.h"
  14
  15 #include "debug.h"
  16 #include "lyxlex.h"
  17
  18 #include "support/filetools.h"
  19 #include "support/lstrings.h"
  20 #include "support/path.h"
  21 #include "support/path_defines.h"
  22
  23 #include <boost/assert.hpp>
  24
  25 #include <algorithm>
  26
  27 namespace support = lyx::support;
  28
  29 using std::endl;
  30 using std::for_each;
  31
  32 using std::ostream;
  33 using std::vector;
  34
  35
  36 // We have to have dummy default commands for security reasons!
  37
  38 ExternalTemplate::ExternalTemplate()
  39         : inputFormat("*")
  40 {}
  41
  42
  43 ExternalTemplate::FormatTemplate::FormatTemplate()
  44 {}
  45
  46
  47 ExternalTemplateManager::ExternalTemplateManager()
  48 {
  49         // gimp gnuchess gnuplot ical netscape tetris xpaint
  50         readTemplates(support::user_lyxdir());
  51         if (lyxerr.debugging(Debug::EXTERNAL)) {
  52                 dumpPreambleDefs(lyxerr);
  53                 lyxerr << '\n';
  54                 dumpTemplates(lyxerr);
  55         }
  56 }
  57
  58
  59 class dumpPreambleDef {
  60 public:
  61         typedef ExternalTemplateManager::PreambleDefs::value_type value_type;
  62
  63         dumpPreambleDef(ostream & o) : ost(o) {}
  64
  65         void operator()(value_type const & vt) {
  66                 ost << "PreambleDef " << vt.first << '\n'
  67                     << vt.second
  68                     << "PreambleDefEnd" << endl;
  69         }
  70
  71 private:
  72         ostream & ost;
  73 };
  74
  75
  76 class dumpTemplate {
  77 public:
  78         typedef ExternalTemplateManager::Templates::value_type value_type;
  79
  80         dumpTemplate(ostream & o) : ost(o) {}
  81
  82         void operator()(value_type const & vt) {
  83                 ExternalTemplate const & et = vt.second;
  84
  85                 ost << "Template " << et.lyxName << '\n'
  86                     << "\tGuiName " << et.guiName << '\n'
  87                     << "\tHelpText\n"
  88                     << et.helpText
  89                     << "\tHelpTextEnd\n"
  90                     << "\tInputFormat " << et.inputFormat << '\n'
  91                     << "\tFileFilter " << et.fileRegExp << '\n'
  92                     << "\tEditCommand " << et.editCommand << '\n'
  93                     << "\tAutomaticProduction " << et.automaticProduction << '\n';
  94                 et.dumpFormats(ost);
  95                 ost << "TemplateEnd" << endl;
  96
  97         }
  98
  99 private:
 100         ostream & ost;
 101 };
 102
 103 class dumpFormat {
 104 public:
 105         typedef ExternalTemplate::Formats::value_type value_type;
 106
 107         dumpFormat(ostream & o) : ost(o) {}
 108
 109         void operator()(value_type const & vt) const{
 110                 ExternalTemplate::FormatTemplate const & ft = vt.second;
 111                 ost << "\tFormat " << vt.first << '\n'
 112                     << "\t\tProduct " << ft.product << '\n'
 113                     << "\t\tUpdateFormat " << ft.updateFormat << '\n'
 114                     << "\t\tUpdateResult " << ft.updateResult << '\n'
 115                     << "\t\tRequirement " << ft.requirement << '\n';
 116
 117                 if (!ft.preambleNames.empty()) {
 118                         vector<string>::const_iterator it  = ft.preambleNames.begin();
 119                         vector<string>::const_iterator end = ft.preambleNames.end();
 120                         for (; it != end; ++it) {
 121                                 ost << "\t\tPreamble " << *it << '\n';
 122                         }
 123                 }
 124
 125                 ost << "\tFormatEnd\n";
 126         }
 127 private:
 128         ostream & ost;
 129 };
 130
 131
 132 void ExternalTemplate::dumpFormats(ostream & os) const
 133 {
 134         for_each(formats.begin(), formats.end(), dumpFormat(os));
 135 }
 136
 137
 138 void ExternalTemplateManager::dumpPreambleDefs(ostream & os) const
 139 {
 140         for_each(preambledefs.begin(), preambledefs.end(), dumpPreambleDef(os));
 141 }
 142
 143
 144 void ExternalTemplateManager::dumpTemplates(ostream & os) const
 145 {
 146         for_each(templates.begin(), templates.end(), dumpTemplate(os));
 147 }
 148
 149
 150 ExternalTemplateManager & ExternalTemplateManager::get()
 151 {
 152         static ExternalTemplateManager externalTemplateManager;
 153         return externalTemplateManager;
 154 }
 155
 156
 157 ExternalTemplateManager::Templates &
 158 ExternalTemplateManager::getTemplates()
 159 {
 160         return templates;
 161 }
 162
 163
 164 ExternalTemplateManager::Templates const &
 165 ExternalTemplateManager::getTemplates() const
 166 {
 167         return templates;
 168 }
 169
 170
 171 ExternalTemplate const & ExternalTemplateManager::getTemplateByName(string const & name)
 172 {
 173         return templates[name];
 174 }
 175
 176
 177 string const
 178 ExternalTemplateManager::getPreambleDefByName(string const & name) const
 179 {
 180         string const trimmed_name = support::trim(name);
 181         if (trimmed_name.empty())
 182                 return string();
 183
 184         PreambleDefs::const_iterator it = preambledefs.find(trimmed_name);
 185         if (it == preambledefs.end())
 186                 return string();
 187
 188         return it->second;
 189 }
 190
 191
 192 void ExternalTemplateManager::readTemplates(string const & path)
 193 {
 194         support::Path p(path);
 195
 196         enum TemplateTags {
 197                 TM_PREAMBLEDEF = 1,
 198                 TM_PREAMBLEDEF_END,
 199                 TM_TEMPLATE,
 200                 TM_TEMPLATE_END
 201         };
 202
 203         keyword_item templatetags[] = {
 204                 { "preambledef", TM_PREAMBLEDEF },
 205                 { "preambledefend", TM_PREAMBLEDEF_END },
 206                 { "template", TM_TEMPLATE },
 207                 { "templateend", TM_TEMPLATE_END }
 208         };
 209
 210         LyXLex lex(templatetags, TM_TEMPLATE_END);
 211
 212         string filename = support::LibFileSearch("", "external_templates");
 213         if (filename.empty() || !lex.setFile(filename)) {
 214                 lex.printError("ExternalTemplateManager::readTemplates: "
 215                                "No template file");
 216                 return;
 217         }
 218
 219         char const * const preamble_end_tag =
 220                 templatetags[TM_PREAMBLEDEF_END-1].tag;
 221
 222         while (lex.isOK()) {
 223                 switch (lex.lex()) {
 224                 case TM_PREAMBLEDEF: {
 225                         lex.next();
 226                         string const name = lex.getString();
 227                         preambledefs[name] = lex.getLongString(preamble_end_tag);
 228                 }
 229                 break;
 230
 231                 case TM_TEMPLATE: {
 232                         lex.next();
 233                         string const name = lex.getString();
 234                         ExternalTemplate & tmp = templates[name];
 235                         tmp.lyxName = name;
 236                         tmp.readTemplate(lex);
 237                 }
 238                 break;
 239
 240                 case TM_TEMPLATE_END:
 241                         lex.printError("Warning: End outside Template.");
 242                 break;
 243
 244                 case TM_PREAMBLEDEF_END:
 245                         lex.printError("Warning: End outside PreambleDef.");
 246                 break;
 247                 }
 248         }
 249 }
 250
 251
 252 void ExternalTemplate::readTemplate(LyXLex & lex)
 253 {
 254         enum TemplateOptionTags {
 255                 TO_GUINAME = 1,
 256                 TO_HELPTEXT,
 257                 TO_INPUTFORMAT,
 258                 TO_FILTER,
 259                 TO_EDITCMD,
 260                 TO_AUTOMATIC,
 261                 TO_FORMAT,
 262                 TO_END
 263         };
 264
 265         keyword_item templateoptiontags[] = {
 266                 { "automaticproduction", TO_AUTOMATIC },
 267                 { "editcommand", TO_EDITCMD },
 268                 { "filefilter", TO_FILTER },
 269                 { "format", TO_FORMAT },
 270                 { "guiname", TO_GUINAME },
 271                 { "helptext", TO_HELPTEXT },
 272                 { "inputformat", TO_INPUTFORMAT },
 273                 { "templateend", TO_END }
 274         };
 275
 276         pushpophelper pph(lex, templateoptiontags, TO_END);
 277
 278         while (lex.isOK()) {
 279                 switch (lex.lex()) {
 280                 case TO_GUINAME:
 281                         lex.next(true);
 282                         guiName = lex.getString();
 283                         break;
 284
 285                 case TO_HELPTEXT:
 286                         helpText = lex.getLongString("HelpTextEnd");
 287                         break;
 288
 289                 case TO_INPUTFORMAT:
 290                         lex.next(true);
 291                         inputFormat = lex.getString();
 292                         break;
 293
 294                 case TO_FILTER:
 295                         lex.next(true);
 296                         fileRegExp = lex.getString();
 297                         break;
 298
 299                 case TO_EDITCMD:
 300                         lex.next(true);
 301                         editCommand = lex.getString();
 302                         break;
 303
 304                 case TO_AUTOMATIC:
 305                         lex.next();
 306                         automaticProduction = lex.getBool();
 307                         break;
 308
 309                 case TO_FORMAT:
 310                         lex.next(true);
 311                         formats[lex.getString()].readFormat(lex);
 312                         break;
 313
 314                 case TO_END:
 315                         return;
 316
 317                 default:
 318                         lex.printError("ExternalTemplate::readTemplate: "
 319                                        "Wrong tag: $$Token");
 320                         BOOST_ASSERT(false);
 321                         break;
 322                 }
 323         }
 324 }
 325
 326
 327 void ExternalTemplate::FormatTemplate::readFormat(LyXLex & lex)
 328 {
 329         enum FormatTags {
 330                 FO_PRODUCT = 1,
 331                 FO_UPDATEFORMAT,
 332                 FO_UPDATERESULT,
 333                 FO_REQUIREMENT,
 334                 FO_PREAMBLE,
 335                 FO_END
 336         };
 337
 338         keyword_item formattags[] = {
 339                 { "formatend", FO_END },
 340                 { "preamble", FO_PREAMBLE },
 341                 { "product", FO_PRODUCT },
 342                 { "requirement", FO_REQUIREMENT },
 343                 { "updateformat", FO_UPDATEFORMAT },
 344                 { "updateresult", FO_UPDATERESULT }
 345         };
 346
 347         pushpophelper pph(lex, formattags, FO_END);
 348
 349         while (lex.isOK()) {
 350                 switch (lex.lex()) {
 351                 case FO_PRODUCT:
 352                         lex.next(true);
 353                         product = lex.getString();
 354                         break;
 355
 356                 case FO_UPDATEFORMAT:
 357                         lex.next(true);
 358                         updateFormat = lex.getString();
 359                         break;
 360
 361                 case FO_UPDATERESULT:
 362                         lex.next(true);
 363                         updateResult = lex.getString();
 364                         break;
 365
 366                 case FO_REQUIREMENT:
 367                         lex.next(true);
 368                         requirement = lex.getString();
 369                         break;
 370
 371                 case FO_PREAMBLE:
 372                         lex.next(true);
 373                         preambleNames.push_back(lex.getString());
 374                         break;
 375
 376                 case FO_END:
 377                         return;
 378                 }
 379         }
 380 }