* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
- * \author André Pönitz
+ * \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "Layout.h"
-#include "TextClass.h"
+#include "FontInfo.h"
+#include "Language.h"
#include "Lexer.h"
-#include "Font.h"
+#include "output_xhtml.h"
+#include "TextClass.h"
#include "support/debug.h"
+#include "support/lassert.h"
#include "support/lstrings.h"
+#include "support/Messages.h"
+#include "support/textutils.h"
+
using namespace std;
using namespace lyx::support;
enum LayoutTags {
LT_ALIGN = 1,
LT_ALIGNPOSSIBLE,
+ LT_ARGUMENT,
LT_MARGIN,
LT_BOTTOMSEP,
LT_CATEGORY,
LT_COPYSTYLE,
LT_DEPENDSON,
LT_OBSOLETEDBY,
- //LT_EMPTY,
LT_END,
- //LT_ENVIRONMENT_DEFAULT,
- //LT_FANCYHDR,
- LT_FILL_BOTTOM,
- LT_FILL_TOP,
- //LT_FIRST_COUNTER,
LT_FONT,
LT_FREE_SPACING,
LT_PASS_THRU,
- //LT_HEADINGS,
+ LT_PASS_THRU_CHARS,
+ LT_PARBREAK_IS_NEWLINE,
+ LT_ITEMCOMMAND,
LT_ITEMSEP,
LT_KEEPEMPTY,
LT_LABEL_BOTTOMSEP,
LT_ENDLABELTYPE,
LT_LATEXNAME,
LT_LATEXPARAM,
- LT_OPTARGS,
LT_LATEXTYPE,
- LT_LATEXHEADER,
- LT_LATEXFOOTER,
- LT_LATEXPARAGRAPH,
+ LT_LEFTDELIM,
LT_LEFTMARGIN,
LT_NEED_PROTECT,
LT_NEWLINE,
LT_NEXTNOINDENT,
+ LT_PAR_GROUP,
LT_PARINDENT,
LT_PARSEP,
LT_PARSKIP,
- //LT_PLAIN,
LT_PREAMBLE,
+ LT_LANGPREAMBLE,
+ LT_BABELPREAMBLE,
LT_REQUIRES,
LT_RIGHTMARGIN,
LT_SPACING,
LT_INNERTAG,
LT_LABELTAG,
LT_ITEMTAG,
+ LT_HTMLTAG,
+ LT_HTMLATTR,
+ LT_HTMLITEM,
+ LT_HTMLITEMATTR,
+ LT_HTMLLABEL,
+ LT_HTMLLABELATTR,
+ LT_HTMLLABELFIRST,
+ LT_HTMLPREAMBLE,
+ LT_HTMLSTYLE,
+ LT_HTMLFORCECSS,
+ LT_INPREAMBLE,
+ LT_HTMLTITLE,
+ LT_SPELLCHECK,
+ LT_REFPREFIX,
+ LT_RESETARGS,
+ LT_RESUMECOUNTER,
+ LT_STEPMASTERCOUNTER,
+ LT_RIGHTDELIM,
+ LT_FORCELOCAL,
+ LT_TOGGLE_INDENT,
+ LT_ADDTOTOC,
+ LT_ISTOCCAPTION,
LT_INTITLE // keep this last!
};
/////////////////////
Layout::Layout()
+ : add_to_toc_(false), is_toc_caption_(false)
{
+ unknown_ = false;
margintype = MARGIN_STATIC;
latextype = LATEX_PARAGRAPH;
+ resumecounter = false;
+ stepmastercounter = false;
intitle = false;
- optionalargs = 0;
+ inpreamble = false;
needprotect = false;
keepempty = false;
font = inherit_font;
endlabeltype = END_LABEL_NO_LABEL;
// Should or should not. That is the question.
// spacing.set(Spacing::OneHalf);
- fill_top = false;
- fill_bottom = false;
newline_allowed = true;
free_spacing = false;
pass_thru = false;
+ parbreak_is_newline = false;
toclevel = NOT_IN_TOC;
commanddepth = 0;
+ htmllabelfirst_ = false;
+ htmlforcecss_ = false;
+ htmltitle_ = false;
+ spellcheck = true;
+ forcelocal = 0;
+ itemcommand_ = "item";
+ toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
+ par_group_ = false;
}
bool Layout::read(Lexer & lex, TextClass const & tclass)
+{
+ // If this is an empty layout, or if no force local version is set,
+ // we know that we will not discard the stuff to read
+ if (forcelocal == 0)
+ return readIgnoreForcelocal(lex, tclass);
+ Layout tmp(*this);
+ tmp.forcelocal = 0;
+ bool const ret = tmp.readIgnoreForcelocal(lex, tclass);
+ // Keep the stuff if
+ // - the read version is higher
+ // - both versions are infinity (arbitrary decision)
+ // - the file did not contain any local version (needed for not
+ // skipping user defined local layouts)
+ if (tmp.forcelocal <= 0 || tmp.forcelocal > forcelocal)
+ *this = tmp;
+ return ret;
+}
+
+
+bool Layout::readIgnoreForcelocal(Lexer & lex, TextClass const & tclass)
{
// This table is sorted alphabetically [asierra 30March96]
LexerKeyword layoutTags[] = {
+ { "addtotoc", LT_ADDTOTOC },
{ "align", LT_ALIGN },
{ "alignpossible", LT_ALIGNPOSSIBLE },
+ { "argument", LT_ARGUMENT },
+ { "babelpreamble", LT_BABELPREAMBLE },
{ "bottomsep", LT_BOTTOMSEP },
{ "category", LT_CATEGORY },
{ "commanddepth", LT_COMMANDDEPTH },
{ "end", LT_END },
{ "endlabelstring", LT_ENDLABELSTRING },
{ "endlabeltype", LT_ENDLABELTYPE },
- { "fill_bottom", LT_FILL_BOTTOM },
- { "fill_top", LT_FILL_TOP },
{ "font", LT_FONT },
+ { "forcelocal", LT_FORCELOCAL },
{ "freespacing", LT_FREE_SPACING },
+ { "htmlattr", LT_HTMLATTR },
+ { "htmlforcecss", LT_HTMLFORCECSS },
+ { "htmlitem", LT_HTMLITEM },
+ { "htmlitemattr", LT_HTMLITEMATTR },
+ { "htmllabel", LT_HTMLLABEL },
+ { "htmllabelattr", LT_HTMLLABELATTR },
+ { "htmllabelfirst", LT_HTMLLABELFIRST },
+ { "htmlpreamble", LT_HTMLPREAMBLE },
+ { "htmlstyle", LT_HTMLSTYLE },
+ { "htmltag", LT_HTMLTAG },
+ { "htmltitle", LT_HTMLTITLE },
{ "innertag", LT_INNERTAG },
+ { "inpreamble", LT_INPREAMBLE },
{ "intitle", LT_INTITLE },
+ { "istoccaption", LT_ISTOCCAPTION },
+ { "itemcommand", LT_ITEMCOMMAND },
{ "itemsep", LT_ITEMSEP },
{ "itemtag", LT_ITEMTAG },
{ "keepempty", LT_KEEPEMPTY },
{ "labelstringappendix", LT_LABELSTRING_APPENDIX },
{ "labeltag", LT_LABELTAG },
{ "labeltype", LT_LABELTYPE },
- { "latexfooter", LT_LATEXFOOTER },
- { "latexheader", LT_LATEXHEADER },
+ { "langpreamble", LT_LANGPREAMBLE },
{ "latexname", LT_LATEXNAME },
- { "latexparagraph", LT_LATEXPARAGRAPH },
{ "latexparam", LT_LATEXPARAM },
{ "latextype", LT_LATEXTYPE },
+ { "leftdelim", LT_LEFTDELIM },
{ "leftmargin", LT_LEFTMARGIN },
{ "margin", LT_MARGIN },
{ "needprotect", LT_NEED_PROTECT },
{ "newline", LT_NEWLINE },
{ "nextnoindent", LT_NEXTNOINDENT },
{ "obsoletedby", LT_OBSOLETEDBY },
- { "optionalargs", LT_OPTARGS },
+ { "paragraphgroup", LT_PAR_GROUP },
+ { "parbreakisnewline", LT_PARBREAK_IS_NEWLINE },
{ "parindent", LT_PARINDENT },
{ "parsep", LT_PARSEP },
{ "parskip", LT_PARSKIP },
{ "passthru", LT_PASS_THRU },
+ { "passthruchars", LT_PASS_THRU_CHARS },
{ "preamble", LT_PREAMBLE },
+ { "refprefix", LT_REFPREFIX },
{ "requires", LT_REQUIRES },
+ { "resetargs", LT_RESETARGS },
+ { "resumecounter", LT_RESUMECOUNTER },
+ { "rightdelim", LT_RIGHTDELIM },
{ "rightmargin", LT_RIGHTMARGIN },
{ "spacing", LT_SPACING },
+ { "spellcheck", LT_SPELLCHECK },
+ { "stepmastercounter", LT_STEPMASTERCOUNTER },
{ "textfont", LT_TEXTFONT },
{ "toclevel", LT_TOCLEVEL },
+ { "toggleindent", LT_TOGGLE_INDENT },
{ "topsep", LT_TOPSEP }
};
bool error = false;
bool finished = false;
lex.pushTable(layoutTags);
+
// parse style section
while (!finished && lex.isOK() && !error) {
int le = lex.lex();
case Lexer::LEX_FEOF:
continue;
- case Lexer::LEX_UNDEF: // parse error
+ case Lexer::LEX_UNDEF:
+ // parse error
lex.printError("Unknown layout tag `$$Token'");
error = true;
continue;
- default: break;
+
+ default:
+ break;
}
switch (static_cast<LayoutTags>(le)) {
- case LT_END: // end of structure
+ case LT_END:
finished = true;
break;
lex >> category_;
break;
- case LT_COPYSTYLE: { // initialize with a known style
+ case LT_COPYSTYLE: {
docstring style;
lex >> style;
style = subst(style, '_', ' ');
break;
}
- case LT_OBSOLETEDBY: { // replace with a known style
+ case LT_OBSOLETEDBY: {
docstring style;
lex >> style;
style = subst(style, '_', ' ');
depends_on_ = subst(depends_on_, '_', ' ');
break;
- case LT_MARGIN: // margin style definition.
+ case LT_MARGIN:
readMargin(lex);
break;
- case LT_LATEXTYPE: // LaTeX style definition.
+ case LT_LATEXTYPE:
readLatexType(lex);
break;
- case LT_LATEXHEADER: // header for environments
- lex >> latexheader;
+ case LT_INTITLE:
+ lex >> intitle;
break;
- case LT_LATEXFOOTER: // footer for environments
- lex >> latexfooter;
+ case LT_INPREAMBLE:
+ lex >> inpreamble;
break;
- case LT_LATEXPARAGRAPH:
- lex >> latexparagraph;
+ case LT_TOCLEVEL:
+ lex >> toclevel;
break;
- case LT_INTITLE:
- lex >> intitle;
+ case LT_RESETARGS:
+ bool reset;
+ lex >> reset;
+ if (reset) {
+ latexargs_.clear();
+ itemargs_.clear();
+ postcommandargs_.clear();
+ }
break;
- case LT_TOCLEVEL:
- lex >> toclevel;
+ case LT_RESUMECOUNTER:
+ lex >> resumecounter;
break;
- case LT_OPTARGS:
- lex >> optionalargs ;
+ case LT_STEPMASTERCOUNTER:
+ lex >> stepmastercounter;
+ break;
+
+ case LT_ARGUMENT:
+ readArgument(lex);
break;
case LT_NEED_PROTECT:
labelfont = lyxRead(lex, labelfont);
break;
- case LT_NEXTNOINDENT: // Indent next paragraph?
+ case LT_NEXTNOINDENT:
lex >> nextnoindent;
break;
+ case LT_TOGGLE_INDENT: {
+ string tog;
+ lex >> tog;
+ tog = support::ascii_lowercase(tog);
+ if (tog == "always")
+ toggle_indent = ITOGGLE_ALWAYS;
+ else if (tog == "never")
+ toggle_indent = ITOGGLE_NEVER;
+ else
+ toggle_indent = ITOGGLE_DOCUMENT_DEFAULT;
+ break;
+ }
+
case LT_COMMANDDEPTH:
lex >> commanddepth;
break;
latexparam_ = subst(latexparam_, """, "\"");
break;
+ case LT_LEFTDELIM:
+ lex >> leftdelim_;
+ leftdelim_ = support::subst(leftdelim_, from_ascii("<br/>"),
+ from_ascii("\n"));
+ break;
+
+ case LT_RIGHTDELIM:
+ lex >> rightdelim_;
+ rightdelim_ = support::subst(rightdelim_, from_ascii("<br/>"),
+ from_ascii("\n"));
+ break;
+
case LT_INNERTAG:
lex >> innertag_;
break;
lex >> itemtag_;
break;
+ case LT_ITEMCOMMAND:
+ lex >> itemcommand_;
+ break;
+
case LT_PREAMBLE:
- preamble_ = from_utf8(lex.getLongString("EndPreamble"));
+ preamble_ = lex.getLongString(from_ascii("EndPreamble"));
+ break;
+
+ case LT_LANGPREAMBLE:
+ langpreamble_ = lex.getLongString(from_ascii("EndLangPreamble"));
+ break;
+
+ case LT_BABELPREAMBLE:
+ babelpreamble_ = lex.getLongString(from_ascii("EndBabelPreamble"));
break;
case LT_LABELTYPE:
readEndLabelType(lex);
break;
- case LT_LEFTMARGIN: // left margin type
+ case LT_LEFTMARGIN:
lex >> leftmargin;
break;
- case LT_RIGHTMARGIN: // right margin type
+ case LT_RIGHTMARGIN:
lex >> rightmargin;
break;
- case LT_LABELINDENT: // label indenting flag
+ case LT_LABELINDENT:
lex >> labelindent;
break;
- case LT_PARINDENT: // paragraph indent. flag
+ case LT_PARINDENT:
lex >> parindent;
break;
- case LT_PARSKIP: // paragraph skip size
+ case LT_PARSKIP:
lex >> parskip;
break;
- case LT_ITEMSEP: // item separation size
+ case LT_ITEMSEP:
lex >> itemsep;
break;
- case LT_TOPSEP: // top separation size
+ case LT_TOPSEP:
lex >> topsep;
break;
- case LT_BOTTOMSEP: // bottom separation size
+ case LT_BOTTOMSEP:
lex >> bottomsep;
break;
- case LT_LABEL_BOTTOMSEP: // label bottom separation size
+ case LT_LABEL_BOTTOMSEP:
lex >> labelbottomsep;
break;
- case LT_LABELSEP: // label separator
+ case LT_LABELSEP:
lex >> labelsep;
labelsep = subst(labelsep, 'x', ' ');
break;
- case LT_PARSEP: // par. separation size
+ case LT_PARSEP:
lex >> parsep;
break;
- case LT_FILL_TOP: // fill top flag
- lex >> fill_top;
- break;
-
- case LT_FILL_BOTTOM: // fill bottom flag
- lex >> fill_bottom;
- break;
-
- case LT_NEWLINE: // newlines allowed?
+ case LT_NEWLINE:
lex >> newline_allowed;
break;
- case LT_ALIGN: // paragraph align
+ case LT_ALIGN:
readAlign(lex);
break;
- case LT_ALIGNPOSSIBLE: // paragraph allowed align
+
+ case LT_ALIGNPOSSIBLE:
readAlignPossible(lex);
break;
- case LT_LABELSTRING: // label string definition
- // FIXME: this means LT_ENDLABELSTRING may only
+ case LT_LABELSTRING:
+ // FIXME: this means LT_LABELSTRING_APPENDIX may only
// occur after LT_LABELSTRING
- lex >> labelstring_;
+ lex >> labelstring_;
labelstring_ = trim(labelstring_);
labelstring_appendix_ = labelstring_;
break;
- case LT_ENDLABELSTRING: // endlabel string definition
+ case LT_ENDLABELSTRING:
lex >> endlabelstring_;
endlabelstring_ = trim(endlabelstring_);
break;
- case LT_LABELSTRING_APPENDIX: // label string appendix definition
+ case LT_LABELSTRING_APPENDIX:
lex >> labelstring_appendix_;
labelstring_appendix_ = trim(labelstring_appendix_);
break;
- case LT_LABELCOUNTER: // name of counter to use
+ case LT_LABELCOUNTER:
lex >> counter;
counter = trim(counter);
break;
- case LT_FREE_SPACING: // Allow for free spacing.
+ case LT_PAR_GROUP:
+ lex >> par_group_;
+ break;
+
+ case LT_FREE_SPACING:
lex >> free_spacing;
break;
- case LT_PASS_THRU: // Allow for pass thru.
+ case LT_PASS_THRU:
lex >> pass_thru;
break;
- case LT_SPACING: // setspace.sty
+ case LT_PASS_THRU_CHARS:
+ lex >> pass_thru_chars;
+ break;
+
+ case LT_PARBREAK_IS_NEWLINE:
+ lex >> parbreak_is_newline;
+ break;
+
+ case LT_SPACING:
readSpacing(lex);
break;
- case LT_REQUIRES:
+ case LT_REQUIRES: {
lex.eatLine();
- vector<string> const req =
- getVectorFromString(lex.getString());
+ vector<string> const req =
+ getVectorFromString(lex.getString(true));
requires_.insert(req.begin(), req.end());
break;
+ }
+
+ case LT_REFPREFIX: {
+ docstring arg;
+ lex >> arg;
+ if (arg == "OFF")
+ refprefix.clear();
+ else
+ refprefix = arg;
+ break;
+ }
+
+ case LT_HTMLTAG:
+ lex >> htmltag_;
+ break;
+
+ case LT_HTMLATTR:
+ lex >> htmlattr_;
+ break;
+
+ case LT_HTMLITEM:
+ lex >> htmlitemtag_;
+ break;
+
+ case LT_HTMLITEMATTR:
+ lex >> htmlitemattr_;
+ break;
+
+ case LT_HTMLLABEL:
+ lex >> htmllabeltag_;
+ break;
+
+ case LT_HTMLLABELATTR:
+ lex >> htmllabelattr_;
+ break;
+
+ case LT_HTMLLABELFIRST:
+ lex >> htmllabelfirst_;
+ break;
+
+ case LT_HTMLSTYLE:
+ htmlstyle_ = lex.getLongString(from_ascii("EndHTMLStyle"));
+ break;
+
+ case LT_HTMLFORCECSS:
+ lex >> htmlforcecss_;
+ break;
+
+ case LT_HTMLPREAMBLE:
+ htmlpreamble_ = lex.getLongString(from_ascii("EndPreamble"));
+ break;
+
+ case LT_HTMLTITLE:
+ lex >> htmltitle_;
+ break;
+
+ case LT_SPELLCHECK:
+ lex >> spellcheck;
+ break;
+
+ case LT_FORCELOCAL:
+ lex >> forcelocal;
+ break;
+
+ case LT_ADDTOTOC:
+ lex >> toc_type_;
+ add_to_toc_ = !toc_type_.empty();
+ break;
+
+ case LT_ISTOCCAPTION:
+ lex >> is_toc_caption_;
+ break;
}
}
lex.popTable();
+ // make sure we only have inpreamble = true for commands
+ if (inpreamble && latextype != LATEX_COMMAND && latextype != LATEX_PARAGRAPH) {
+ LYXERR0("InPreamble not permitted except with command and paragraph layouts.");
+ LYXERR0("Layout name: " << name());
+ inpreamble = false;
+ }
- return !error;
+ return finished && !error;
}
enum {
LA_NO_LABEL = 1,
LA_MANUAL,
- LA_TOP_ENVIRONMENT,
- LA_CENTERED_TOP_ENVIRONMENT,
+ LA_ABOVE,
+ LA_CENTERED,
LA_STATIC,
LA_SENSITIVE,
- LA_COUNTER,
LA_ENUMERATE,
LA_ITEMIZE,
LA_BIBLIO
LexerKeyword labelTypeTags[] = {
- { "bibliography", LA_BIBLIO },
- { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
- { "counter", LA_COUNTER },
- { "enumerate", LA_ENUMERATE },
- { "itemize", LA_ITEMIZE },
- { "manual", LA_MANUAL },
- { "no_label", LA_NO_LABEL },
- { "sensitive", LA_SENSITIVE },
- { "static", LA_STATIC },
- { "top_environment", LA_TOP_ENVIRONMENT }
+ { "above", LA_ABOVE },
+ { "bibliography", LA_BIBLIO },
+ { "centered", LA_CENTERED },
+ { "enumerate", LA_ENUMERATE },
+ { "itemize", LA_ITEMIZE },
+ { "manual", LA_MANUAL },
+ { "no_label", LA_NO_LABEL },
+ { "sensitive", LA_SENSITIVE },
+ { "static", LA_STATIC }
};
PushPopHelper pph(lex, labelTypeTags);
case LA_MANUAL:
labeltype = LABEL_MANUAL;
break;
- case LA_TOP_ENVIRONMENT:
- labeltype = LABEL_TOP_ENVIRONMENT;
+ case LA_ABOVE:
+ labeltype = LABEL_ABOVE;
break;
- case LA_CENTERED_TOP_ENVIRONMENT:
- labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
+ case LA_CENTERED:
+ labeltype = LABEL_CENTERED;
break;
case LA_STATIC:
labeltype = LABEL_STATIC;
case LA_SENSITIVE:
labeltype = LABEL_SENSITIVE;
break;
- case LA_COUNTER:
- labeltype = LABEL_COUNTER;
- break;
case LA_ENUMERATE:
labeltype = LABEL_ENUMERATE;
break;
void Layout::readEndLabelType(Lexer & lex)
{
+ // this should be const, but can't be because
+ // of PushPopHelper.
static LexerKeyword endlabelTypeTags[] = {
{ "box", END_LABEL_BOX },
{ "filled_box", END_LABEL_FILLED_BOX },
return;
case LATEX_PARAGRAPH:
case LATEX_COMMAND:
- case LATEX_ENVIRONMENT:
case LATEX_ITEM_ENVIRONMENT:
- case LATEX_BIB_ENVIRONMENT:
case LATEX_LIST_ENVIRONMENT:
latextype = static_cast<LatexType>(le);
break;
+ case LATEX_ENVIRONMENT:
+ case LATEX_BIB_ENVIRONMENT:
+ latextype = static_cast<LatexType>(le);
+ par_group_ = true;
+ break;
default:
LYXERR0("Unhandled value " << le);
break;
}
-docstring const & Layout::name() const
+void Layout::readArgument(Lexer & lex)
{
- return name_;
+ latexarg arg;
+ // writeArgument() makes use of these default values
+ arg.mandatory = false;
+ arg.autoinsert = false;
+ arg.insertcotext = false;
+ bool error = false;
+ bool finished = false;
+ arg.font = inherit_font;
+ arg.labelfont = inherit_font;
+ arg.is_toc_caption = false;
+ arg.passthru = PT_INHERITED;
+ string id;
+ lex >> id;
+ bool const itemarg = prefixIs(id, "item:");
+ bool const postcmd = prefixIs(id, "post:");
+
+ while (!finished && lex.isOK() && !error) {
+ lex.next();
+ string const tok = ascii_lowercase(lex.getString());
+
+ if (tok.empty()) {
+ continue;
+ } else if (tok == "endargument") {
+ finished = true;
+ } else if (tok == "labelstring") {
+ lex.next();
+ arg.labelstring = lex.getDocString();
+ } else if (tok == "menustring") {
+ lex.next();
+ arg.menustring = lex.getDocString();
+ } else if (tok == "mandatory") {
+ lex.next();
+ arg.mandatory = lex.getBool();
+ } else if (tok == "autoinsert") {
+ lex.next();
+ arg.autoinsert = lex.getBool();
+ } else if (tok == "insertcotext") {
+ lex.next();
+ arg.insertcotext = lex.getBool();
+ } else if (tok == "leftdelim") {
+ lex.next();
+ arg.ldelim = lex.getDocString();
+ arg.ldelim = support::subst(arg.ldelim, from_ascii("<br/>"),
+ from_ascii("\n"));
+ } else if (tok == "rightdelim") {
+ lex.next();
+ arg.rdelim = lex.getDocString();
+ arg.rdelim = support::subst(arg.rdelim, from_ascii("<br/>"),
+ from_ascii("\n"));
+ } else if (tok == "defaultarg") {
+ lex.next();
+ arg.defaultarg = lex.getDocString();
+ } else if (tok == "presetarg") {
+ lex.next();
+ arg.presetarg = lex.getDocString();
+ } else if (tok == "tooltip") {
+ lex.next();
+ arg.tooltip = lex.getDocString();
+ } else if (tok == "requires") {
+ lex.next();
+ arg.requires = lex.getString();
+ } else if (tok == "decoration") {
+ lex.next();
+ arg.decoration = lex.getString();
+ } else if (tok == "font") {
+ arg.font = lyxRead(lex, arg.font);
+ } else if (tok == "labelfont") {
+ arg.labelfont = lyxRead(lex, arg.labelfont);
+ } else if (tok == "passthruchars") {
+ lex.next();
+ arg.pass_thru_chars = lex.getDocString();
+ } else if (tok == "passthru") {
+ lex.next();
+ docstring value = lex.getDocString();
+ if (value == "true" || value == "1")
+ arg.passthru = PT_TRUE;
+ else if (value == "false" || value == "0")
+ arg.passthru = PT_FALSE;
+ else
+ arg.passthru = PT_INHERITED;
+ } else if (tok == "istoccaption") {
+ lex.next();
+ arg.is_toc_caption = lex.getBool();
+ } else {
+ lex.printError("Unknown tag");
+ error = true;
+ }
+ }
+ if (arg.labelstring.empty())
+ LYXERR0("Incomplete Argument definition!");
+ else if (itemarg)
+ itemargs_[id] = arg;
+ else if (postcmd)
+ postcommandargs_[id] = arg;
+ else
+ latexargs_[id] = arg;
}
-void Layout::setName(docstring const & name)
+void writeArgument(ostream & os, string const & id, Layout::latexarg const & arg)
{
- name_ = name;
+ os << "\tArgument " << id << '\n';
+ if (!arg.labelstring.empty())
+ os << "\t\tLabelString \"" << to_utf8(arg.labelstring) << "\"\n";
+ if (!arg.menustring.empty())
+ os << "\t\tMenuString \"" << to_utf8(arg.menustring) << "\"\n";
+ if (arg.mandatory)
+ os << "\t\tMandatory " << arg.mandatory << '\n';
+ if (arg.autoinsert)
+ os << "\t\tAutoinsert " << arg.autoinsert << '\n';
+ if (arg.insertcotext)
+ os << "\t\tInsertCotext " << arg.insertcotext << '\n';
+ if (!arg.ldelim.empty())
+ os << "\t\tLeftDelim \""
+ << to_utf8(subst(arg.ldelim, from_ascii("\n"), from_ascii("<br/>")))
+ << "\"\n";
+ if (!arg.rdelim.empty())
+ os << "\t\tRightDelim \""
+ << to_utf8(subst(arg.rdelim, from_ascii("\n"), from_ascii("<br/>")))
+ << "\"\n";
+ if (!arg.defaultarg.empty())
+ os << "\t\tDefaultArg \"" << to_utf8(arg.defaultarg) << "\"\n";
+ if (!arg.presetarg.empty())
+ os << "\t\tPresetArg \"" << to_utf8(arg.presetarg) << "\"\n";
+ if (!arg.tooltip.empty())
+ os << "\t\tToolTip \"" << to_utf8(arg.tooltip) << "\"\n";
+ if (!arg.requires.empty())
+ os << "\t\tRequires \"" << arg.requires << "\"\n";
+ if (!arg.decoration.empty())
+ os << "\t\tDecoration \"" << arg.decoration << "\"\n";
+ if (arg.font != inherit_font)
+ lyxWrite(os, arg.font, "Font", 2);
+ if (arg.labelfont != inherit_font)
+ lyxWrite(os, arg.labelfont, "LabelFont", 2);
+ switch (arg.passthru) {
+ case PT_TRUE:
+ os << "\t\tPassThru true\n";
+ break;
+ case PT_FALSE:
+ os << "\t\tPassThru false\n";
+ break;
+ case PT_INHERITED:
+ os << "\t\tPassThru inherited\n";
+ break;
+ }
+ if (!arg.pass_thru_chars.empty())
+ os << "\t\tPassThruChars \"" << to_utf8(arg.pass_thru_chars) << "\"\n";
+ os << "\tEndArgument\n";
}
-docstring const & Layout::obsoleted_by() const
+void Layout::write(ostream & os) const
{
- return obsoleted_by_;
+ os << "Style \"" << to_utf8(name_) << "\"\n";
+ if (!category_.empty() && obsoleted_by_.empty())
+ os << "\tCategory \"" << to_utf8(category_) << "\"\n";
+ // Can't deduce Copystyle here :-(
+ if (!obsoleted_by_.empty()) {
+ os << "\tObsoletedBy \"" << to_utf8(obsoleted_by_)
+ << "\"\nEnd\n";
+ return;
+ }
+ if (!depends_on_.empty())
+ os << "\tDependsOn " << to_utf8(depends_on_) << '\n';
+ switch (margintype) {
+ case MARGIN_DYNAMIC:
+ os << "\tMargin Dynamic\n";
+ break;
+ case MARGIN_FIRST_DYNAMIC:
+ os << "\tMargin First_Dynamic\n";
+ break;
+ case MARGIN_MANUAL:
+ os << "\tMargin Manual\n";
+ break;
+ case MARGIN_RIGHT_ADDRESS_BOX:
+ os << "\tMargin Right_Address_Box\n";
+ break;
+ case MARGIN_STATIC:
+ os << "\tMargin Static\n";
+ break;
+ }
+ switch (latextype) {
+ case LATEX_BIB_ENVIRONMENT:
+ os << "\tLatexType Bib_Environment\n";
+ break;
+ case LATEX_COMMAND:
+ os << "\tLatexType Command\n";
+ break;
+ case LATEX_ENVIRONMENT:
+ os << "\tLatexType Environment\n";
+ break;
+ case LATEX_ITEM_ENVIRONMENT:
+ os << "\tLatexType Item_Environment\n";
+ break;
+ case LATEX_LIST_ENVIRONMENT:
+ os << "\tLatexType List_Environment\n";
+ break;
+ case LATEX_PARAGRAPH:
+ os << "\tLatexType Paragraph\n";
+ break;
+ }
+ os << "\tInTitle " << intitle << "\n"
+ "\tInPreamble " << inpreamble << "\n"
+ "\tTocLevel " << toclevel << "\n"
+ "\tResumeCounter " << resumecounter << "\n"
+ "\tStepMasterCounter " << stepmastercounter << '\n';
+ // ResetArgs does not make sense here
+ for (LaTeXArgMap::const_iterator it = latexargs_.begin();
+ it != latexargs_.end(); ++it)
+ writeArgument(os, it->first, it->second);
+ for (LaTeXArgMap::const_iterator it = itemargs_.begin();
+ it != itemargs_.end(); ++it)
+ writeArgument(os, it->first, it->second);
+ for (LaTeXArgMap::const_iterator it = postcommandargs_.begin();
+ it != postcommandargs_.end(); ++it)
+ writeArgument(os, it->first, it->second);
+ os << "\tNeedProtect " << needprotect << "\n"
+ "\tKeepEmpty " << keepempty << '\n';
+ if (labelfont == font)
+ lyxWrite(os, font, "Font", 1);
+ else {
+ lyxWrite(os, font, "TextFont", 1);
+ lyxWrite(os, labelfont, "LabelFont", 1);
+ }
+ os << "\tNextNoIndent " << nextnoindent << "\n"
+ "\tCommandDepth " << commanddepth << '\n';
+ if (!latexname_.empty())
+ os << "\tLatexName \"" << latexname_ << "\"\n";
+ if (!latexparam_.empty())
+ os << "\tLatexParam \"" << subst(latexparam_, "\"", """)
+ << "\"\n";
+ if (!leftdelim_.empty())
+ os << "\tLeftDelim "
+ << to_utf8(subst(leftdelim_, from_ascii("\n"), from_ascii("<br/>")))
+ << '\n';
+ if (!rightdelim_.empty())
+ os << "\tRightDelim "
+ << to_utf8(subst(rightdelim_, from_ascii("\n"), from_ascii("<br/>")))
+ << '\n';
+ if (!innertag_.empty())
+ os << "\tInnerTag \"" << innertag_ << "\"\n";
+ if (!labeltag_.empty())
+ os << "\tLabelTag \"" << labeltag_ << "\"\n";
+ if (!itemtag_.empty())
+ os << "\tItemTag \"" << itemtag_ << "\"\n";
+ if (!itemcommand_.empty())
+ os << "\tItemCommand " << itemcommand_ << '\n';
+ if (!preamble_.empty())
+ os << "\tPreamble\n\t"
+ << to_utf8(subst(rtrim(preamble_, "\n"),
+ from_ascii("\n"), from_ascii("\n\t")))
+ << "\n\tEndPreamble\n";
+ if (!langpreamble_.empty())
+ os << "\tLangPreamble\n\t"
+ << to_utf8(subst(rtrim(langpreamble_, "\n"),
+ from_ascii("\n"), from_ascii("\n\t")))
+ << "\n\tEndLangPreamble\n";
+ if (!babelpreamble_.empty())
+ os << "\tBabelPreamble\n\t"
+ << to_utf8(subst(rtrim(babelpreamble_, "\n"),
+ from_ascii("\n"), from_ascii("\n\t")))
+ << "\n\tEndBabelPreamble\n";
+ switch (labeltype) {
+ case LABEL_ABOVE:
+ os << "\tLabelType Above\n";
+ break;
+ case LABEL_BIBLIO:
+ os << "\tLabelType Bibliography\n";
+ break;
+ case LABEL_CENTERED:
+ os << "\tLabelType Centered\n";
+ break;
+ case LABEL_ENUMERATE:
+ os << "\tLabelType Enumerate\n";
+ break;
+ case LABEL_ITEMIZE:
+ os << "\tLabelType Itemize\n";
+ break;
+ case LABEL_MANUAL:
+ os << "\tLabelType Manual\n";
+ break;
+ case LABEL_NO_LABEL:
+ os << "\tLabelType No_Label\n";
+ break;
+ case LABEL_SENSITIVE:
+ os << "\tLabelType Sensitive\n";
+ break;
+ case LABEL_STATIC:
+ os << "\tLabelType Static\n";
+ break;
+ }
+ switch (endlabeltype) {
+ case END_LABEL_BOX:
+ os << "\tEndLabelType Box\n";
+ break;
+ case END_LABEL_FILLED_BOX:
+ os << "\tEndLabelType Filled_Box\n";
+ break;
+ case END_LABEL_NO_LABEL:
+ os << "\tEndLabelType No_Label\n";
+ break;
+ case END_LABEL_STATIC:
+ os << "\tEndLabelType Static\n";
+ break;
+ }
+ os << "\tParagraphGroup \"" << par_group_ << "\"\n";
+ if (!leftmargin.empty())
+ os << "\tLeftMargin \"" << to_utf8(leftmargin) << "\"\n";
+ if (!rightmargin.empty())
+ os << "\tRightMargin \"" << to_utf8(rightmargin) << "\"\n";
+ if (!labelindent.empty())
+ os << "\tLabelIndent " << to_utf8(labelindent) << '\n';
+ if (!parindent.empty())
+ os << "\tParIndent " << to_utf8(parindent) << '\n';
+ os << "\tParSkip " << parskip << "\n"
+ "\tItemSep " << itemsep << "\n"
+ "\tTopSep " << topsep << "\n"
+ "\tBottomSep " << bottomsep << "\n"
+ "\tLabelBottomSep " << labelbottomsep << '\n';
+ if (!labelsep.empty())
+ os << "\tLabelSep " << to_utf8(subst(labelsep, ' ', 'x'))
+ << '\n';
+ os << "\tParSep " << parsep << "\n"
+ "\tNewLine " << newline_allowed << '\n';
+ switch (align) {
+ case LYX_ALIGN_BLOCK:
+ os << "\tAlign Block\n";
+ break;
+ case LYX_ALIGN_CENTER:
+ os << "\tAlign Center\n";
+ break;
+ case LYX_ALIGN_LAYOUT:
+ os << "\tAlign Layout\n";
+ break;
+ case LYX_ALIGN_LEFT:
+ os << "\tAlign Left\n";
+ break;
+ case LYX_ALIGN_RIGHT:
+ os << "\tAlign Right\n";
+ break;
+ case LYX_ALIGN_DECIMAL:
+ case LYX_ALIGN_SPECIAL:
+ case LYX_ALIGN_NONE:
+ break;
+ }
+ if (alignpossible & (LYX_ALIGN_BLOCK | LYX_ALIGN_CENTER |
+ LYX_ALIGN_LAYOUT | LYX_ALIGN_LEFT | LYX_ALIGN_RIGHT)) {
+ bool first = true;
+ os << "\tAlignPossible";
+ if (alignpossible & LYX_ALIGN_BLOCK) {
+ os << " Block";
+ first = false;
+ }
+ if (alignpossible & LYX_ALIGN_CENTER) {
+ if (!first)
+ os << ',';
+ os << " Center";
+ first = false;
+ }
+ if (alignpossible & LYX_ALIGN_LAYOUT) {
+ if (!first)
+ os << ',';
+ os << " Layout";
+ first = false;
+ }
+ if (alignpossible & LYX_ALIGN_LEFT) {
+ if (!first)
+ os << ',';
+ os << " Left";
+ first = false;
+ }
+ if (alignpossible & LYX_ALIGN_RIGHT) {
+ if (!first)
+ os << ',';
+ os << " Right";
+ first = false;
+ }
+ os << '\n';
+ }
+ // LabelString must come before LabelStringAppendix
+ if (!labelstring_.empty())
+ os << "\tLabelString \"" << to_utf8(labelstring_) << "\"\n";
+ if (!endlabelstring_.empty())
+ os << "\tEndLabelString \"" << to_utf8(endlabelstring_) << "\"\n";
+ if (!labelstring_appendix_.empty() && labelstring_appendix_ != labelstring_)
+ os << "\tLabelStringAppendix \""
+ << to_utf8(labelstring_appendix_) << "\"\n";
+ if (!counter.empty())
+ os << "\tLabelCounter \"" << to_utf8(counter) << "\"\n";
+ os << "\tFreeSpacing " << free_spacing << '\n';
+ os << "\tPassThru " << pass_thru << '\n';
+ if (!pass_thru_chars.empty())
+ os << "\tPassThruChars " << to_utf8(pass_thru_chars) << '\n';
+ os << "\tParbreakIsNewline " << parbreak_is_newline << '\n';
+ switch (spacing.getSpace()) {
+ case Spacing::Double:
+ os << "\tSpacing Double\n";
+ break;
+ case Spacing::Onehalf:
+ os << "\tSpacing Onehalf\n";
+ break;
+ case Spacing::Other:
+ os << "\tSpacing Other " << spacing.getValueAsString() << '\n';
+ break;
+ case Spacing::Single:
+ os << "\tSpacing Single\n";
+ break;
+ case Spacing::Default:
+ break;
+ }
+ if (!requires_.empty()) {
+ os << "\tRequires ";
+ for (set<string>::const_iterator it = requires_.begin();
+ it != requires_.end(); ++it) {
+ if (it != requires_.begin())
+ os << ',';
+ os << *it;
+ }
+ os << '\n';
+ }
+ if (refprefix.empty())
+ os << "\tRefPrefix OFF\n";
+ else
+ os << "\tRefPrefix " << to_utf8(refprefix) << '\n';
+ if (!htmltag_.empty())
+ os << "\tHTMLTag " << htmltag_ << '\n';
+ if (!htmlattr_.empty())
+ os << "\tHTMLAttr " << htmlattr_ << '\n';
+ if (!htmlitemtag_.empty())
+ os << "\tHTMLItem " << htmlitemtag_ << '\n';
+ if (!htmlitemattr_.empty())
+ os << "\tHTMLItemAttr " << htmlitemattr_ << '\n';
+ if (!htmllabeltag_.empty())
+ os << "\tHTMLLabel " << htmllabeltag_ << '\n';
+ if (!htmllabelattr_.empty())
+ os << "\tHTMLLabelAttr " << htmllabelattr_ << '\n';
+ os << "\tHTMLLabelFirst " << htmllabelfirst_ << '\n';
+ if (!htmlstyle_.empty())
+ os << "\tHTMLStyle\n"
+ << to_utf8(rtrim(htmlstyle_, "\n"))
+ << "\n\tEndHTMLStyle\n";
+ os << "\tHTMLForceCSS " << htmlforcecss_ << '\n';
+ if (!htmlpreamble_.empty())
+ os << "\tHTMLPreamble\n"
+ << to_utf8(rtrim(htmlpreamble_, "\n"))
+ << "\n\tEndPreamble\n";
+ os << "\tHTMLTitle " << htmltitle_ << "\n"
+ "\tSpellcheck " << spellcheck << "\n"
+ "\tForceLocal " << forcelocal << "\n"
+ "End\n";
}
-docstring const & Layout::depends_on() const
+Layout::LaTeXArgMap Layout::args() const
{
- return depends_on_;
+ LaTeXArgMap args = latexargs_;
+ if (!postcommandargs_.empty())
+ args.insert(postcommandargs_.begin(), postcommandargs_.end());
+ if (!itemargs_.empty())
+ args.insert(itemargs_.begin(), itemargs_.end());
+ return args;
+}
+
+
+int Layout::optArgs() const
+{
+ int nr = 0;
+ LaTeXArgMap::const_iterator it = latexargs_.begin();
+ for (; it != latexargs_.end(); ++it) {
+ if (!(*it).second.mandatory)
+ ++nr;
+ }
+ LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
+ for (; iit != postcommandargs_.end(); ++iit) {
+ if (!(*iit).second.mandatory)
+ ++nr;
+ }
+ return nr;
+}
+
+
+int Layout::requiredArgs() const
+{
+ int nr = 0;
+ LaTeXArgMap::const_iterator it = latexargs_.begin();
+ for (; it != latexargs_.end(); ++it) {
+ if ((*it).second.mandatory)
+ ++nr;
+ }
+ LaTeXArgMap::const_iterator iit = postcommandargs_.begin();
+ for (; iit != postcommandargs_.end(); ++iit) {
+ if (!(*iit).second.mandatory)
+ ++nr;
+ }
+ return nr;
+}
+
+
+string const & Layout::htmltag() const
+{
+ if (htmltag_.empty())
+ htmltag_ = "div";
+ return htmltag_;
+}
+
+
+string const & Layout::htmlattr() const
+{
+ if (htmlattr_.empty())
+ htmlattr_ = "class=\"" + defaultCSSClass() + "\"";
+ return htmlattr_;
+}
+
+
+string const & Layout::htmlitemtag() const
+{
+ if (htmlitemtag_.empty())
+ htmlitemtag_ = "div";
+ return htmlitemtag_;
+}
+
+
+string const & Layout::htmlitemattr() const
+{
+ if (htmlitemattr_.empty())
+ htmlitemattr_ = "class=\"" + defaultCSSItemClass() + "\"";
+ return htmlitemattr_;
+}
+
+
+string const & Layout::htmllabeltag() const
+{
+ if (htmllabeltag_.empty()) {
+ if (labeltype != LABEL_ABOVE &&
+ labeltype != LABEL_CENTERED)
+ htmllabeltag_ = "span";
+ else
+ htmllabeltag_ = "div";
+ }
+ return htmllabeltag_;
+}
+
+
+string const & Layout::htmllabelattr() const
+{
+ if (htmllabelattr_.empty())
+ htmllabelattr_ = "class=\"" + defaultCSSLabelClass() + "\"";
+ return htmllabelattr_;
+}
+
+
+docstring Layout::htmlstyle() const
+{
+ if (!htmlstyle_.empty() && !htmlforcecss_)
+ return htmlstyle_;
+ if (htmldefaultstyle_.empty())
+ makeDefaultCSS();
+ docstring retval = htmldefaultstyle_;
+ if (!htmlstyle_.empty())
+ retval += '\n' + htmlstyle_;
+ return retval;
+}
+
+
+string Layout::defaultCSSClass() const
+{
+ if (!defaultcssclass_.empty())
+ return defaultcssclass_;
+ docstring d;
+ docstring::const_iterator it = name().begin();
+ docstring::const_iterator en = name().end();
+ for (; it != en; ++it) {
+ char_type const c = *it;
+ if (!isAlphaASCII(c)) {
+ if (d.empty())
+ // make sure we don't start with an underscore,
+ // as that sometimes causes problems.
+ d = from_ascii("lyx_");
+ else
+ d += '_';
+ } else if (isLower(c))
+ d += c;
+ else
+ // this is slow, so do it only if necessary
+ d += lowercase(c);
+ }
+ defaultcssclass_ = to_utf8(d);
+ return defaultcssclass_;
+}
+
+
+namespace {
+
+string makeMarginValue(char const * side, double d)
+{
+ ostringstream os;
+ os << "margin-" << side << ": " << d << "ex;\n";
+ return os.str();
+}
+
+}
+
+
+void Layout::makeDefaultCSS() const
+{
+ // this never needs to be redone, since reloading layouts will
+ // wipe out what we did before.
+ if (!htmldefaultstyle_.empty())
+ return;
+
+ // main font
+ htmldefaultstyle_ = font.asCSS();
+
+ // bottom margins
+ string tmp;
+ if (topsep > 0)
+ tmp += makeMarginValue("top", topsep);
+ if (bottomsep > 0)
+ tmp += makeMarginValue("bottom", bottomsep);
+ if (!leftmargin.empty()) {
+ // we can't really do what LyX does with the margin, so
+ // we'll just figure out how many characters it is
+ int const len = leftmargin.length();
+ tmp += makeMarginValue("left", len);
+ }
+ if (!rightmargin.empty()) {
+ int const len = rightmargin.length();
+ tmp += makeMarginValue("right", len);
+ }
+
+ if (!tmp.empty()) {
+ if (!htmldefaultstyle_.empty())
+ htmldefaultstyle_ += from_ascii("\n");
+ htmldefaultstyle_ += from_ascii(tmp);
+ }
+
+ // alignment
+ string where = alignmentToCSS(align);
+ if (!where.empty()) {
+ htmldefaultstyle_ += from_ascii("text-align: " + where + ";\n");
+ }
+
+ // wrap up what we have, if anything
+ if (!htmldefaultstyle_.empty())
+ htmldefaultstyle_ =
+ from_ascii(htmltag() + "." + defaultCSSClass() + " {\n") +
+ htmldefaultstyle_ + from_ascii("\n}\n");
+
+ if (labeltype == LABEL_NO_LABEL || htmllabeltag() == "NONE")
+ return;
+
+ docstring labelCSS;
+
+ // label font
+ if (labelfont != font)
+ labelCSS = labelfont.asCSS() + from_ascii("\n");
+ if (labeltype == LABEL_CENTERED)
+ labelCSS += from_ascii("text-align: center;\n");
+
+ if (!labelCSS.empty())
+ htmldefaultstyle_ +=
+ from_ascii(htmllabeltag() + "." + defaultCSSLabelClass() + " {\n") +
+ labelCSS + from_ascii("\n}\n");
}