#include "FontInfo.h"
#include "LayoutEnums.h"
#include "Spacing.h"
+#include "support/debug.h"
#include "support/docstring.h"
+#include <map>
#include <set>
#include <string>
namespace lyx {
-class Language;
class Lexer;
class TextClass;
///
void readSpacing(Lexer &);
///
- docstring const & name() const { return name_; };
+ 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; }
///
///
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_; }
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) 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) const;
+ docstring const babelpreamble() const { return babelpreamble_; }
///
std::set<std::string> const & requires() const { return requires_; }
///
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 { return htmltag_; }
+ std::string const & htmltag() const;
///
- std::string const & htmlattr() const { return htmlattr_; }
+ std::string const & htmlattr() const;
///
- std::string const & htmlitem() const { return htmlitem_; }
+ std::string const & htmlitemtag() const;
///
- std::string const & htmlitemattr() const { return htmlitemattr_; }
+ std::string const & htmlitemattr() const;
///
- std::string const & htmllabel() const { return htmllabel_; }
+ std::string const & htmllabeltag() const;
///
- std::string const & htmllabelattr() const { return htmllabelattr_; }
+ std::string const & htmllabelattr() const;
+ ///
+ std::string defaultCSSClass() const;
///
bool htmllabelfirst() const { return htmllabelfirst_; }
///
- docstring const & htmlstyle() const { return htmlstyle_; }
+ docstring htmlstyle() const;
///
docstring const & htmlpreamble() const { return htmlpreamble_; }
///
+ bool htmltitle() const { return htmltitle_; }
+ ///
bool isParagraph() const { return latextype == LATEX_PARAGRAPH; }
///
bool isCommand() const { return latextype == LATEX_COMMAND; }
|| 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;
///
MarginType margintype;
///
- bool fill_top;
- ///
- bool fill_bottom;
- ///
bool newline_allowed;
///
bool nextnoindent;
bool free_spacing;
///
bool pass_thru;
+ ///
+ bool parbreak_is_newline;
/// show this in toc
int toclevel;
/// special value of toclevel for non-section layouts
LatexType latextype;
/// Does this object belong in the title part of the document?
bool intitle;
- /// Does this layout allow for an optional parameter?
- int optionalargs;
+ /// Is the content to go in the preamble rather than the body?
+ bool inpreamble;
/// Which counter to step
docstring counter;
+ /// Prefix to use when creating labels
+ docstring refprefix;
/// Depth of XML command
int commanddepth;
/// until it has proper support for the caption inset (JMarc)
static Layout * forCaption();
+ /// 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_;
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)
std::string labeltag_;
/// Internal tag to surround the item text in a list.
std::string itemtag_;
- /// Tag for HTML output, e.g., h2.
- std::string htmltag_;
- /// Additional attributes for inclusion with the start tag,
- /// e.g.: class='section'.
- std::string htmlattr_;
+ /// 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,
+ /// 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".
+ mutable std::string htmltag_;
+ /// Additional attributes for inclusion with the start tag. Defaults
+ /// to: class="layoutname".
+ 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
- /// in "p" tags.
- std::string htmlitem_;
- /// Attributes for htmlitem_
- std::string htmlitemattr_;
+ /// in "p" tags. Default is "div".
+ /// Note that when I said "environment", I meant it: This has no
+ /// effect for LATEX_PARAGRAPH type layouts.
+ mutable std::string htmlitemtag_;
+ /// Attributes for htmlitemtag_. Default is: class="layoutname_item".
+ 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
- /// sections (in that case, it might be: span).
- std::string htmllabel_;
- /// Attributes for the label.
- std::string htmllabelattr_;
+ /// sections. Defaults to "span".
+ /// If set to "NONE", this suppresses the printing of the label.
+ mutable std::string htmllabeltag_;
+ /// Attributes for the label. Defaults to: class="layoutname_label".
+ mutable std::string htmllabelattr_;
/// Whether to put the label before the item, or within the item.
/// I.e., do we have (true):
/// <label>...</label><item>...</item>
bool htmllabelfirst_;
/// CSS information needed by this layout.
docstring htmlstyle_;
+ /// 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
+ /// possible to override what one does not want.
+ bool htmlforcecss_;
+ /// A cache for the default style info so generated.
+ mutable docstring htmldefaultstyle_;
/// Any other info for the HTML header.
docstring htmlpreamble_;
+ /// Whether this is the <title> paragraph.
+ bool htmltitle_;
+ /// calculating this is expensive, so we cache it.
+ mutable std::string defaultcssclass_;
/// This is the `category' for this layout. The following are
/// recommended basic categories: FrontMatter, BackMatter, MainText,
/// Section, Starred, List, Theorem.
docstring babelpreamble_;
/// Packages needed for this layout
std::set<std::string> requires_;
+ ///
+ LaTeXArgMap latexargs_;
+ ///
+ LaTeXArgMap postcommandargs_;
+ ///
+ LaTeXArgMap itemargs_;
};
} // namespace lyx