src/insets/ExternalTemplate.h

   1 // -*- C++ -*-
   2 /* This file is part of*
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995 Matthias Ettrich
   8  *           Copyright 1995-2001 The LyX Team.
   9  *
  10  * ====================================================== */
  11
  12 #ifndef EXTERNALTEMPLATE_H
  13 #define EXTERNALTEMPLATE_H
  14
  15 #ifdef __GNUG__
  16 #pragma interface
  17 #endif
  18
  19 #include <iosfwd>
  20 #include <map>
  21 #include "LString.h"
  22 #include <boost/utility.hpp>
  23
  24 class LyXLex;
  25
  26 ///
  27 struct ExternalTemplate {
  28         /// What is the name of this template in the LyX format?
  29         string lyxName;
  30         /// What will the button in the GUI say?
  31         string guiName;
  32         /// A short help text
  33         string helpText;
  34         /// A file extension regular expression for the file browser
  35         string fileRegExp;
  36         /// What command should be executed to view the file?
  37         string viewCommand;
  38         /// What command should be executed to edit the file?
  39         string editCommand;
  40         /// Should we do automatic production of the output?
  41         bool automaticProduction;
  42         /// This is the information needed to support a specific output format
  43         struct FormatTemplate {
  44                 /// The text that should be inserted into the exported file
  45                 string product;
  46                 /// The shell command to produce a resulting file
  47                 string updateCommand;
  48                 /// What features does this external inset require?
  49                 string requirement;
  50                 /// What should be inserted into the preamble
  51                 string preamble;
  52                 ///
  53                 void readFormat(LyXLex &);
  54                 /// This constructor has to default a command for safety reasons!
  55                 FormatTemplate();
  56         };
  57         ///
  58         void readTemplate(LyXLex &);
  59         ///
  60         typedef std::map<string, FormatTemplate> Formats;
  61         ///
  62         Formats formats;
  63         ///
  64         void dumpFormats(std::ostream &) const;
  65
  66         /// We have to have default commands for safety reasons!
  67         ExternalTemplate();
  68
  69 };
  70
  71
  72 /**
  73    A singleton class that manages the external inset templates
  74 */
  75 class ExternalTemplateManager : boost::noncopyable {
  76 public:
  77         /// Map from the LyX name of the template to the template structure
  78         typedef std::map<string, ExternalTemplate> Templates;
  79
  80         static ExternalTemplateManager & get();
  81         Templates & getTemplates();
  82         Templates const & getTemplates() const;
  83         /// return the template by LyX name
  84         ExternalTemplate const & getTemplateByName(const string & name);
  85 private:
  86         ExternalTemplateManager();
  87         void readTemplates(string const & path);
  88         void dumpTemplates() const;
  89         Templates templates;
  90 };
  91
  92 #endif