]> git.lyx.org Git - lyx.git/blobdiff - src/Layout.h
inset-split: consider that freeSpacing() doesn't DEPM
[lyx.git] / src / Layout.h
index 6c4b6c01d87c1bd82f60d1ed871d08fae28e5707..dfb5afebda3f2d3ad5abacfccbcba3fe0e9db062 100644 (file)
@@ -58,7 +58,7 @@ public:
        void setUnknown(bool unknown) { unknown_ = unknown; }
        /// Reads a layout definition from file
        /// \return true on success.
-       bool read(Lexer &, TextClass const &);
+       bool read(Lexer &, TextClass const &, bool validating = false);
        ///
        void readAlign(Lexer &);
        ///
@@ -74,7 +74,7 @@ public:
        ///
        void readSpacing(Lexer &);
        ///
-       void readArgument(Lexer &);
+       void readArgument(Lexer &, bool);
        /// Write a layout definition in utf8 encoding
        void write(std::ostream &) const;
        ///
@@ -93,22 +93,29 @@ public:
        struct latexarg {
                docstring labelstring;
                docstring menustring;
-               bool mandatory;
-               bool nodelims;
+               bool mandatory = false;
+               bool nodelims = false;
                docstring ldelim;
                docstring rdelim;
                docstring defaultarg;
                docstring presetarg;
                docstring tooltip;
-               std::string requires;
+               std::string required;
                std::string decoration;
-               FontInfo font;
-               FontInfo labelfont;
-               bool autoinsert;
-               bool insertcotext;
-               ArgPassThru passthru;
+               FontInfo font = inherit_font;
+               FontInfo labelfont = inherit_font;
+               bool autoinsert = false;
+               bool insertcotext = false;
+               bool insertonnewline = false;
+               ArgPassThru passthru = PT_INHERITED;
                docstring pass_thru_chars;
-               bool is_toc_caption;
+               bool is_toc_caption = false;
+               bool free_spacing = false;
+               std::string newlinecmd;
+               docstring docbooktag;
+               docstring docbooktagtype;
+               docstring docbookattr;
+               bool docbookargumentbeforemaintag = false;
        };
        ///
        typedef std::map<std::string, latexarg> LaTeXArgMap;
@@ -150,7 +157,7 @@ public:
        /// this layout for language \p lang
        docstring const babelpreamble() const { return babelpreamble_; }
        ///
-       std::set<std::string> const & requires() const { return requires_; }
+       std::set<std::string> const & required() const { return required_; }
        ///
        std::set<docstring> const & autonests() const { return autonests_; }
        ///
@@ -190,6 +197,60 @@ public:
        ///
        bool htmltitle() const { return htmltitle_; }
        ///
+       std::string const & docbooktag() const;
+       ///
+       std::string const & docbookattr() const;
+       ///
+       std::string const & docbooktagtype() const;
+       ///
+       std::string const & docbookinnertag() const;
+       ///
+       std::string const & docbookinnerattr() const;
+       ///
+       std::string const & docbookinnertagtype() const;
+       ///
+       std::string const & docbookininfo() const;
+       ///
+       bool docbookabstract() const { return docbookabstract_; }
+       ///
+       std::string const & docbookwrappertag() const;
+       ///
+       std::string const & docbookwrapperattr() const;
+       ///
+       std::string const & docbookwrappertagtype() const;
+       ///
+       bool docbookwrappermergewithprevious() const { return docbookwrappermergewithprevious_; }
+       ///
+       std::string const & docbooksectiontag() const;
+       ///
+       bool docbooksection() const { return docbooksection_; }
+       ///
+       std::string const & docbookitemwrappertag() const;
+       ///
+       std::string const & docbookitemwrapperattr() const;
+       ///
+       std::string const & docbookitemwrappertagtype() const;
+       ///
+       std::string const & docbookitemlabeltag() const;
+       ///
+       std::string const & docbookitemlabelattr() const;
+       ///
+       std::string const & docbookitemlabeltagtype() const;
+       ///
+       std::string const & docbookiteminnertag() const;
+       ///
+       std::string const & docbookiteminnerattr() const;
+       ///
+       std::string const & docbookiteminnertagtype() const;
+       ///
+       std::string const & docbookitemtag() const;
+       ///
+       std::string const & docbookitemattr() const;
+       ///
+       std::string const & docbookitemtagtype() const;
+       ///
+       std::string const & docbookforceabstracttag() const;
+       ///
        bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
        ///
        bool isCommand() const { return latextype == LATEX_COMMAND; }
@@ -207,13 +268,13 @@ public:
        bool labelIsInline() const {
                return labeltype == LABEL_STATIC
                        || labeltype == LABEL_SENSITIVE
-                 || labeltype == LABEL_ENUMERATE
+                       || labeltype == LABEL_ENUMERATE
                        || labeltype == LABEL_ITEMIZE;
        }
        bool labelIsAbove() const {
                return labeltype == LABEL_ABOVE
                        || labeltype == LABEL_CENTERED
-                 || labeltype == LABEL_BIBLIO;
+                       || labeltype == LABEL_BIBLIO;
        }
        ///
        bool addToToc() const { return add_to_toc_; }
@@ -332,8 +393,8 @@ public:
        docstring counter;
        /// Resume counter?
        bool resumecounter;
-       /// Step master counter?
-       bool stepmastercounter;
+       /// Step parent counter?
+       bool stepparentcounter;
        /// Prefix to use when creating labels
        docstring refprefix;
        /// Depth of XML command
@@ -362,7 +423,7 @@ public:
 private:
        /// Reads a layout definition from file
        /// \return true on success.
-       bool readIgnoreForcelocal(Lexer &, TextClass const &);
+       bool readIgnoreForcelocal(Lexer &, TextClass const &, bool validating);
        /// generates the default CSS for this layout
        void makeDefaultCSS() const;
        ///
@@ -454,6 +515,64 @@ private:
        bool htmllabelfirst_;
        /// CSS information needed by this layout.
        docstring htmlstyle_;
+       /// DocBook tag corresponding to this layout.
+       mutable std::string docbooktag_;
+       /// Roles to add to docbooktag_, if any (default: none).
+       mutable std::string docbookattr_;
+       /// DocBook tag type corresponding to this layout (block, paragraph, or inline; default: block).
+       mutable std::string docbooktagtype_;
+       /// DocBook inner tag corresponding to this layout.
+       mutable std::string docbookinnertag_;
+       /// Roles to add to docbookinnertag_, if any (default: none).
+       mutable std::string docbookinnerattr_;
+       /// DocBook inner-tag type corresponding to this layout (block, paragraph, or inline; default: block).
+       mutable std::string docbookinnertagtype_;
+       /// DocBook tag corresponding to this item (mainly for lists).
+       mutable std::string docbookitemtag_;
+       /// Roles to add to docbookitemtag_, if any (default: none).
+       mutable std::string docbookitemattr_;
+       /// DocBook tag type corresponding to this item (block, paragraph, or inline; default: block).
+       mutable std::string docbookitemtagtype_;
+       /// DocBook tag corresponding to the wrapper around an item (mainly for lists).
+       mutable std::string docbookitemwrappertag_;
+       /// Roles to add to docbookitemwrappertag_, if any (default: none).
+       mutable std::string docbookitemwrapperattr_;
+       /// DocBook tag type corresponding to the wrapper around an item (block, paragraph, or inline; default: block).
+       mutable std::string docbookitemwrappertagtype_;
+       /// DocBook tag corresponding to this label (mostly for description lists;
+       /// labels in the common sense do not exist with DocBook).
+       mutable std::string docbookitemlabeltag_;
+       /// Roles to add to docbooklabeltag_, if any (default: none).
+       mutable std::string docbookitemlabelattr_;
+       /// DocBook tag corresponding to this label (block, paragraph, or inline; default: block).
+       mutable std::string docbookitemlabeltagtype_;
+       /// DocBook tag to add within the item, around its direct content (mainly for lists).
+       mutable std::string docbookiteminnertag_;
+       /// Roles to add to docbookiteminnertag_, if any (default: none).
+       mutable std::string docbookiteminnerattr_;
+       /// DocBook tag to add within the item, around its direct content (block, paragraph, or inline; default: block).
+       mutable std::string docbookiteminnertagtype_;
+       /// DocBook tag corresponding to this wrapper around the main tag.
+       mutable std::string docbookwrappertag_;
+       /// Roles to add to docbookwrappertag_, if any (default: none).
+       mutable std::string docbookwrapperattr_;
+       /// DocBook tag corresponding to this wrapper around the main tag (block, paragraph, or inline; default: block).
+       mutable std::string docbookwrappertagtype_;
+       /// Whether this wrapper tag may be merged with the previously opened wrapper tag.
+       bool docbookwrappermergewithprevious_;
+       /// Outer tag for this section, only if this layout represent a sectionning item, including chapters
+       /// (default: section).
+       mutable std::string docbooksectiontag_;
+       /// Whether this element should be considered as a section-level element in DocBook.
+       bool docbooksection_;
+       /// Whether this tag must/can/can't go into an <info> tag (default: never, as it only makes sense for metadata).
+       mutable std::string docbookininfo_;
+       /// Wehther this paragraph should be considered as abstract.
+       bool docbookabstract_;
+       /// Whether this element (root or not) does not accept text without a section (i.e. the first text that is met
+       /// in LyX must be considered as the abstract if this is true); this text must be output with the specific tag
+       /// held by this attribute
+       mutable std::string docbookforceabstracttag_;
        /// Should we generate the default CSS for this layout, even if HTMLStyle
        /// has been given? Default is false.
        /// Note that the default CSS is output first, then the user CSS, so it is
@@ -480,7 +599,7 @@ private:
        /// Are adjacent paragraphs handled as one group?
        bool par_group_;
        /// Packages needed for this layout
-       std::set<std::string> requires_;
+       std::set<std::string> required_;
        /// Layouts that are by default nested after this one
        std::set<docstring> autonests_;
        /// Layouts that by auto-nest this one