X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLayout.h;h=7991cb193ef8ddbc2245e2ad9ce1a43e858b7670;hb=f63de41c4c2180705b44c3444718d7f35df89b8a;hp=f266efcd89333d1ee14a1a053edee7898724509e;hpb=33c5f6d6280ad9e2f85ee7c26d207e110250ee08;p=lyx.git diff --git a/src/Layout.h b/src/Layout.h index f266efcd89..7991cb193e 100644 --- a/src/Layout.h +++ b/src/Layout.h @@ -17,14 +17,15 @@ #include "FontInfo.h" #include "LayoutEnums.h" #include "Spacing.h" +#include "support/debug.h" #include "support/docstring.h" +#include #include #include namespace lyx { -class Language; class Lexer; class TextClass; @@ -73,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; } @@ -83,9 +88,51 @@ public: /// std::string const & latexname() const { return latexname_; } /// - void setLatexName(std::string const & n) { latexname_ = n; } - /// - docstring const & labelstring(bool in_appendix) const + 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; + bool insertcotext; + ArgPassThru passthru; + docstring pass_thru_chars; + bool is_toc_caption; + }; + /// + typedef std::map LaTeXArgMap; + /// + LaTeXArgMap const & latexargs() const { return latexargs_; } + /// + LaTeXArgMap const & postcommandargs() const { return postcommandargs_; } + /// + LaTeXArgMap const & itemargs() const { return itemargs_; } + /// Returns true is the layout has arguments. If false, then an + /// InsetArgument in this layout stands for the parent InsetText. + bool hasArgs() const; + /// 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_; } /// docstring const & endlabelstring() const { return endlabelstring_; } @@ -95,39 +142,47 @@ public: docstring const & preamble() const { return preamble_; } /// Get language dependent macro definitions needed for this layout /// for language \p lang - docstring const langpreamble(Language const * lang, bool const polyglossia) const; + docstring const langpreamble() const { return langpreamble_; } /// Get language and babel dependent macro definitions needed for /// this layout for language \p lang - docstring const babelpreamble(Language const * lang, Language const * buflang, bool const polyglossia) const; + docstring const babelpreamble() const { return babelpreamble_; } /// std::set const & requires() const { return requires_; } /// + std::set const & autonests() const { return autonests_; } + /// + std::set const & isAutonestedBy() const { return autonested_by_; } + /// 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_; } /// std::string const & itemtag() const { return itemtag_; } - /// + /// std::string const & htmltag() const; - /// + /// std::string const & htmlattr() const; - /// + /// std::string const & htmlitemtag() const; - /// + /// std::string const & htmlitemattr() const; - /// + /// std::string const & htmllabeltag() const; - /// + /// std::string const & htmllabelattr() const; /// std::string defaultCSSClass() const; /// bool htmllabelfirst() const { return htmllabelfirst_; } - /// + /// docstring htmlstyle() const; - /// + /// docstring const & htmlpreamble() const { return htmlpreamble_; } /// bool htmltitle() const { return htmltitle_; } @@ -142,11 +197,32 @@ 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 par_group_; } + /// + 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 addToToc() const { return add_to_toc_; } + /// + std::string tocType() const { return toc_type_; } + /// + bool isTocCaption() const { return is_toc_caption_; } /// bool operator==(Layout const &) const; /// - bool operator!=(Layout const & rhs) const + bool operator!=(Layout const & rhs) const { return !(*this == rhs); } //////////////////////////////////////////////////////////////// @@ -218,9 +294,13 @@ public: /// bool nextnoindent; /// + ToggleIndentation toggle_indent; + /// bool free_spacing; /// bool pass_thru; + /// Individual chars to be passed verbatim + docstring pass_thru_chars; /// bool parbreak_is_newline; /// show this in toc @@ -231,6 +311,9 @@ public: /** true when the fragile commands in the paragraph need to be \protect'ed. */ bool needprotect; + /** true when the verbatim stuff of this layout needs to be + \cprotect'ed. */ + bool needcprotect; /// true when empty paragraphs should be kept. bool keepempty; /// Type of LaTeX object @@ -239,17 +322,12 @@ 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; + /// Resume counter? + bool resumecounter; + /// Step master counter? + bool stepmastercounter; /// Prefix to use when creating labels docstring refprefix; /// Depth of XML command @@ -262,16 +340,30 @@ 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; /// std::string defaultCSSItemClass() const { return defaultCSSClass() + "_item"; } /// std::string defaultCSSLabelClass() const { return defaultCSSClass() + "_label"; } - + /// Name of the layout/paragraph environment docstring name_; @@ -303,6 +395,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., for sect header) std::string innertag_; /// Internal tag to use (e.g. to surround varentrylist label) @@ -310,13 +408,13 @@ private: /// Internal tag to surround the item text in a list. std::string itemtag_; /// The interpretation of this tag varies depending upon the latextype. - /// In an environment, it is the tag enclosing all content for this set of - /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize, + /// In an environment, it is the tag enclosing all content for this set of + /// paragraphs. So for quote, e.g,. it would be: blockquote. For itemize, /// it would be: ul. (You get the idea.) /// /// For a command, it is the tag enclosing the content of the command. /// So, for section, it might be: h2. - /// + /// /// For the paragraph type, it is the tag that will enclose each paragraph. /// /// Defaults to "div". @@ -326,7 +424,7 @@ private: mutable std::string htmlattr_; /// Tag for individual paragraphs in an environment. In lists, this /// would be something like "li". But it also needs to be set for - /// quotation, e.g., since the paragraphs in a quote need to be + /// quotation, e.g., since the paragraphs in a quote need to be /// in "p" tags. Default is "div". /// Note that when I said "environment", I meant it: This has no /// effect for LATEX_PARAGRAPH type layouts. @@ -335,7 +433,7 @@ private: mutable std::string htmlitemattr_; /// Tag for labels, of whatever sort. One use for this is in setting /// descriptions, in which case it would be: dt. Another use is to - /// customize the display of, say, the auto-generated label for + /// customize the display of, say, the auto-generated label for /// sections. Defaults to "span". /// If set to "NONE", this suppresses the printing of the label. mutable std::string htmllabeltag_; @@ -365,7 +463,7 @@ private: mutable std::string defaultcssclass_; /// This is the `category' for this layout. The following are /// recommended basic categories: FrontMatter, BackMatter, MainText, - /// Section, Starred, List, Theorem. + /// Sectioning, Starred, List, Reasoning. docstring category_; /// Macro definitions needed for this layout docstring preamble_; @@ -373,10 +471,29 @@ private: docstring langpreamble_; /// Language and babel dependent macro definitions needed for this layout docstring babelpreamble_; + /// Are adjacent paragraphs handled as one group? + bool par_group_; /// Packages needed for this layout std::set requires_; + /// Layouts that are by default nested after this one + std::set autonests_; + /// Layouts that by auto-nest this one + std::set autonested_by_; + /// + LaTeXArgMap latexargs_; + /// + LaTeXArgMap postcommandargs_; + /// + LaTeXArgMap itemargs_; + /// + bool add_to_toc_; + /// + std::string toc_type_; + /// + bool is_toc_caption_; }; + } // namespace lyx #endif