]> git.lyx.org Git - lyx.git/blobdiff - src/insets/InsetCommandParams.h
Do not check again and again for non existing files
[lyx.git] / src / insets / InsetCommandParams.h
index a5d46785b8ef2c43002fbe1aa2f30a933d06eb79..eb976c28d7ce612ae5372bf2120d8400c0108ccf 100644 (file)
@@ -28,6 +28,7 @@
 namespace lyx {
 
 class Lexer;
+class Buffer;
 
 class ParamInfo {
 public:
@@ -41,9 +42,11 @@ public:
        };
        /// Special handling on output
        enum ParamHandling {
-               HANDLING_NONE,    /// no special handling
-               HANDLING_ESCAPE,  /// escape special characters
-               HANDLING_LATEXIFY /// transform special characters to LaTeX macros
+               HANDLING_NONE = 1,    /// no special handling
+               HANDLING_ESCAPE = 2,  /// escape special characters
+               HANDLING_LATEXIFY = 4, /// transform special characters to LaTeX macros
+               HANDLING_LTRIM = 8, /// trim blanks on the left
+               HANDLING_INDEX_ESCAPE = 16, /// escape makeindex special chars
        };
        ///
        class ParamData {
@@ -51,7 +54,9 @@ public:
        // flag for all commands.
        public:
                ///
-               ParamData(std::string const &, ParamType, ParamHandling = HANDLING_NONE);
+               ParamData(std::string const &, ParamType, ParamHandling = HANDLING_NONE,
+                         bool ignore = false,
+                         docstring default_value = docstring());
                ///
                std::string name() const { return name_; }
                ///
@@ -61,8 +66,12 @@ public:
                /// whether this is an optional LaTeX argument
                bool isOptional() const;
                ///
+               bool ignore() const { return ignore_; }
+               ///
+               docstring const & defaultValue() const { return default_value_; }
+               ///
                bool operator==(ParamData const &) const;
-               /// 
+               ///
                bool operator!=(ParamData const & rhs) const
                        { return !(*this == rhs); }
        private:
@@ -72,11 +81,18 @@ public:
                ParamType type_;
                /// do we need special handling on latex output?
                ParamHandling handling_;
+               ///
+               bool ignore_;
+               ///
+               docstring default_value_;
        };
 
        /// adds a new parameter
+       /// If ignore is true, then the parameter is never saved, and is always
+       /// given the default value.
        void add(std::string const & name, ParamType type,
-                ParamHandling = HANDLING_NONE);
+                ParamHandling = HANDLING_NONE, bool ignore = false,
+                docstring default_value = docstring());
        ///
        bool empty() const { return info_.empty(); }
        ///
@@ -88,7 +104,7 @@ public:
        ///
        const_iterator const end() const { return info_.end(); }
        /// \return true if name corresponds to a parameter of some sort.
-       /// \return false if the parameter does not exist at all of it it 
+       /// \return false if the parameter does not exist at all of it it
        bool hasParam(std::string const & name) const;
        ///
        ParamData const & operator[](std::string const & name) const;
@@ -112,11 +128,14 @@ public:
        std::string insetType() const;
        ///
        InsetCode code() const { return insetCode_; }
-       ///
-       void read(Lexer &);
        /// Parse the command
+       void read(Lexer &);
+       ///
+       void Read(Lexer &, Buffer const *);
        ///
        void write(std::ostream &) const;
+       ///
+       void Write(std::ostream & os, Buffer const * buf) const;
        /// Build the complete LaTeX command
        docstring getCommand(OutputParams const &) const;
        /// Return the command name
@@ -125,7 +144,7 @@ public:
        /// are cleared except those that exist also in the new command.
        /// What matters here is the parameter name, not position.
        void setCmdName(std::string const & n);
-       /// FIXME Would be better removed, but is used in BufferView.cpp in 
+       /// FIXME Would be better removed, but is used in BufferView.cpp in
        /// ways that make removal hard.
        docstring getFirstNonOptParam() const;
        /// get parameter \p name
@@ -142,7 +161,7 @@ public:
        void clear();
        ///
        static bool isCompatibleCommand(InsetCode code, std::string const & s);
-       /// 
+       ///
        ParamInfo const & info() const { return info_; }
        ///
        docstring prepareCommand(OutputParams const & runparams,