]> git.lyx.org Git - features.git/blobdiff - src/insets/ExternalTemplate.h
Replace LString.h with support/std_string.h,
[features.git] / src / insets / ExternalTemplate.h
index d289e7f6564284e1fdd6c31764b0930eb40f50b1..5b6ddf0529386dadc981d78c1ceea33dfebaafb5 100644 (file)
@@ -1,24 +1,21 @@
 // -*- C++ -*-
-/* This file is part of*
- * ====================================================== 
+/**
+ * \file ExternalTemplate.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
- *      
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2001 The LyX Team.
+ * \author Asger Alstrup Nielsen
  *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS.
+ */
 
 #ifndef EXTERNALTEMPLATE_H
 #define EXTERNALTEMPLATE_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
 
 #include <iosfwd>
 #include <map>
-#include "LString.h"
+#include "support/std_string.h"
 #include <boost/utility.hpp>
 
 class LyXLex;
@@ -31,10 +28,12 @@ struct ExternalTemplate {
        string guiName;
        /// A short help text
        string helpText;
+       /** The format of the input file. Can be "*", in which case we try and
+           ascertain the format from the contents of the file.
+       */
+       string inputFormat;
        /// A file extension regular expression for the file browser
        string fileRegExp;
-       /// What command should be executed to view the file?
-       string viewCommand;
        /// What command should be executed to edit the file?
        string editCommand;
        /// Should we do automatic production of the output?
@@ -43,12 +42,14 @@ struct ExternalTemplate {
        struct FormatTemplate {
                /// The text that should be inserted into the exported file
                string product;
-               /// The shell command to produce a resulting file
-               string updateCommand;
+               /// The filename of the resulting file
+               string updateResult;
+               /// The format of this file.
+               string updateFormat;
                /// What features does this external inset require?
                string requirement;
-               /// What should be inserted into the preamble
-               string preamble;
+               /// Identify the preamble snippet using \c preambleName.
+               string preambleName;
                ///
                void readFormat(LyXLex &);
                /// This constructor has to default a command for safety reasons!
@@ -62,10 +63,9 @@ struct ExternalTemplate {
        Formats formats;
        ///
        void dumpFormats(std::ostream &) const;
-       
+
        /// We have to have default commands for safety reasons!
        ExternalTemplate();
-               
 };
 
 
@@ -76,17 +76,25 @@ class ExternalTemplateManager : boost::noncopyable {
 public:
        /// Map from the LyX name of the template to the template structure
        typedef std::map<string, ExternalTemplate> Templates;
+       /** Map from the LyX name of the preamble definition to the preamble
+        *  definition itself.
+        */
+       typedef std::map<string, string> PreambleDefs;
 
        static ExternalTemplateManager & get();
        Templates & getTemplates();
        Templates const & getTemplates() const;
-       /// return the template by LyX name 
-       ExternalTemplate const & getTemplateByName(const string & name);
+       /// return the template by LyX name
+       ExternalTemplate const & getTemplateByName(string const & name);
+       string const getPreambleDefByName(string const & name) const;
 private:
        ExternalTemplateManager();
        void readTemplates(string const & path);
-       void dumpTemplates() const;
+       void dumpTemplates(std::ostream &) const;
+       void dumpPreambleDefs(std::ostream &) const;
+
        Templates templates;
+       PreambleDefs preambledefs;
 };
 
 #endif