Try to fix compilation on cygwin

[lyx.git] / src / Layout.h

diff --git a/src/Layout.h b/src/Layout.h
index 08c049d8d6ac054140e2005cf49a867091a59696..0f5ebbf86b43a20cd6eb8d8be73c8462406c4987 100644 (file)
--- a/src/Layout.h
+++ b/src/Layout.h
@@ -17,8 +17,10 @@
 #include "FontInfo.h"
 #include "LayoutEnums.h"
 #include "Spacing.h"
+#include "support/debug.h"
 #include "support/docstring.h"
 
+#include <map>
 #include <set>
 #include <string>
 
@@ -72,6 +74,10 @@ public:
        ///
        void readSpacing(Lexer &);
        ///
+       void readArgument(Lexer &);
+       /// Write a layout definition in utf8 encoding
+       void write(std::ostream &) const;
+       ///
        docstring const & name() const { return name_; }
        ///
        void setName(docstring const & n) { name_ = n; }
@@ -82,7 +88,42 @@ public:
        ///
        std::string const & latexname() const { return latexname_; }
        ///
-       void setLatexName(std::string const & n) { latexname_ = n; }
+       std::string const & itemcommand() const { return itemcommand_; }
+       /// The arguments of this layout
+       struct latexarg {
+               docstring labelstring;
+               docstring menustring;
+               bool mandatory;
+               docstring ldelim;
+               docstring rdelim;
+               docstring defaultarg;
+               docstring presetarg;
+               docstring tooltip;
+               std::string requires;
+               std::string decoration;
+               FontInfo font;
+               FontInfo labelfont;
+               bool autoinsert;
+       };
+       ///
+       typedef std::map<std::string, latexarg> LaTeXArgMap;
+       ///
+       LaTeXArgMap const & latexargs() const { return latexargs_; }
+       ///
+       LaTeXArgMap const & postcommandargs() const { return postcommandargs_; }
+       ///
+       LaTeXArgMap const & itemargs() const { return itemargs_; }
+       /// Returns latexargs() + postcommandargs() + itemargs().
+       /// But note that it returns a *copy*, not a reference, so do not do
+       /// anything like:
+       ///   Layout::LaTeXArgMap::iterator it = args().begin();
+       ///   Layout::LaTeXArgMap::iterator en = args().end();
+       /// Those are iterators for different containers.
+       LaTeXArgMap args() const;
+       ///
+       int optArgs() const;
+       ///
+       int requiredArgs() const;
        ///
        docstring const & labelstring(bool in_appendix) const 
        { return in_appendix ? labelstring_appendix_ : labelstring_; }
@@ -103,6 +144,10 @@ public:
        ///
        std::string const & latexparam() const { return latexparam_; }
        ///
+       docstring leftdelim() const { return leftdelim_; }
+       ///
+       docstring rightdelim() const { return rightdelim_; }
+       ///
        std::string const & innertag() const { return innertag_; }
        ///
        std::string const & labeltag() const { return labeltag_; }
@@ -141,6 +186,24 @@ public:
                        || latextype == LATEX_ITEM_ENVIRONMENT
                        || latextype == LATEX_LIST_ENVIRONMENT;
        }
+       /// Is this the kind of layout in which adjacent paragraphs
+       /// are handled as one group?
+       bool isParagraphGroup() const {
+       return latextype == LATEX_ENVIRONMENT
+               || latextype == LATEX_BIB_ENVIRONMENT;
+       }
+       ///
+       bool labelIsInline() const {
+               return labeltype == LABEL_STATIC
+                       || labeltype == LABEL_SENSITIVE
+                 || labeltype == LABEL_ENUMERATE
+                       || labeltype == LABEL_ITEMIZE;
+       }
+       bool labelIsAbove() const {
+               return labeltype == LABEL_ABOVE
+                       || labeltype == LABEL_CENTERED
+                 || labeltype == LABEL_BIBLIO;
+       }
 
        ///
        bool operator==(Layout const &) const;
@@ -217,6 +280,8 @@ public:
        ///
        bool nextnoindent;
        ///
+       ToggleIndentation toggle_indent;
+       ///
        bool free_spacing;
        ///
        bool pass_thru;
@@ -238,15 +303,6 @@ public:
        bool intitle;
        /// Is the content to go in the preamble rather than the body?
        bool inpreamble;
-       /// Number of requried arguments for this command or environment
-       unsigned int reqargs;
-       /// Number of optional arguments for this command or environment
-       /// These MUST come at the beginning, so:
-       ///  \cmd[opt1][opt2]{req1}{here is the text from LyX}
-       /// is fine. But:
-       ///  \cmd[opt1]{req1}[opt2]{here is the text from LyX}
-       /// is not.
-       unsigned int optargs;
        /// Which counter to step
        docstring counter;
        /// Prefix to use when creating labels
@@ -261,9 +317,23 @@ public:
 
        /// Is this spellchecked?
        bool spellcheck;
+       /**
+        * Should this layout definition always be written to the document preamble?
+        * Possible values are:
+        *   0: Do not enforce local layout
+        * >=1: Enforce local layout with version forcelocal
+        *  -1: Enforce local layout with infinite version
+        * On reading, the forced local layout is only used if its version
+        * number is greater than the version number of the same layout in the
+        * document class. Otherwise, it is ignored.
+        */
+       int forcelocal;
 
 
 private:
+       /// Reads a layout definition from file
+       /// \return true on success.
+       bool readIgnoreForcelocal(Lexer &, TextClass const &);
        /// generates the default CSS for this layout
        void makeDefaultCSS() const;
        ///
@@ -302,6 +372,12 @@ private:
        docstring labelstring_appendix_;
        /// LaTeX parameter for environment
        std::string latexparam_;
+       /// Item command in lists
+       std::string itemcommand_;
+       /// Left delimiter of the content
+       docstring leftdelim_;
+       /// Right delimiter of the content
+       docstring rightdelim_;
        /// Internal tag to use (e.g., <title></title> for sect header)
        std::string innertag_;
        /// Internal tag to use (e.g. to surround varentrylist label)
@@ -374,6 +450,12 @@ private:
        docstring babelpreamble_;
        /// Packages needed for this layout
        std::set<std::string> requires_;
+       ///
+       LaTeXArgMap latexargs_;
+       ///
+       LaTeXArgMap postcommandargs_;
+       ///
+       LaTeXArgMap itemargs_;
 };
 
 } // namespace lyx