-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
+/**
+ * \file lyxlayout.C
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author André Pönitz
*
- * ======================================================
+ * Full author contact details are available in file CREDITS.
*/
#include <config.h>
-#ifdef __GNUG__
-#pragma implementation
-#endif
-
#include "lyxlayout.h"
#include "lyxtextclass.h"
#include "lyxlex.h"
#include "support/lstrings.h"
+using lyx::support::subst;
+using lyx::support::trim;
+
using std::endl;
+using std::string;
+
+/// Special value of toclevel for layouts that to not belong in a TOC
+const int LyXLayout::NOT_IN_TOC = -1000;
// The order of the LayoutTags enum is no more important. [asierra300396]
// Tags indexes.
enum LayoutTags {
- LT_ALIGN = 1,
- LT_ALIGNPOSSIBLE,
- LT_MARGIN,
- LT_BOTTOMSEP,
- LT_COPYSTYLE,
- LT_OBSOLETEDBY,
+ LT_ALIGN = 1,
+ LT_ALIGNPOSSIBLE,
+ LT_MARGIN,
+ LT_BOTTOMSEP,
+ LT_COMMANDDEPTH,
+ LT_COPYSTYLE,
+ LT_DEPENDSON,
+ LT_OBSOLETEDBY,
//LT_EMPTY,
- LT_END,
- //LT_ENVIRONMENT_DEFAULT,
+ LT_END,
+ //LT_ENVIRONMENT_DEFAULT,
//LT_FANCYHDR,
- LT_FILL_BOTTOM,
- LT_FILL_TOP,
+ LT_FILL_BOTTOM,
+ LT_FILL_TOP,
//LT_FIRST_COUNTER,
- LT_FONT,
- LT_FREE_SPACING,
+ LT_FONT,
+ LT_FREE_SPACING,
LT_PASS_THRU,
//LT_HEADINGS,
- LT_ITEMSEP,
- LT_KEEPEMPTY,
- LT_LABEL_BOTTOMSEP,
- LT_LABELFONT,
+ LT_ITEMSEP,
+ LT_KEEPEMPTY,
+ LT_LABEL_BOTTOMSEP,
+ LT_LABELFONT,
LT_TEXTFONT,
- LT_LABELINDENT,
- LT_LABELSEP,
- LT_LABELSTRING,
- LT_LABELSTRING_APPENDIX,
+ LT_LABELINDENT,
+ LT_LABELSEP,
+ LT_LABELSTRING,
+ LT_LABELSTRING_APPENDIX,
+ LT_LABELCOUNTER,
LT_LABELTYPE,
LT_ENDLABELSTRING,
LT_ENDLABELTYPE,
- LT_LATEXNAME,
- LT_LATEXPARAM,
- LT_LATEXTYPE,
- LT_LEFTMARGIN,
- LT_NEED_PROTECT,
- LT_NEWLINE,
- LT_NEXTNOINDENT,
- LT_PARINDENT,
- LT_PARSEP,
- LT_PARSKIP,
+ LT_LATEXNAME,
+ LT_LATEXPARAM,
+ LT_OPTARGS,
+ LT_LATEXTYPE,
+ LT_LATEXHEADER,
+ LT_LATEXFOOTER,
+ LT_LATEXPARAGRAPH,
+ LT_LEFTMARGIN,
+ LT_NEED_PROTECT,
+ LT_NEWLINE,
+ LT_NEXTNOINDENT,
+ LT_PARINDENT,
+ LT_PARSEP,
+ LT_PARSKIP,
//LT_PLAIN,
- LT_PREAMBLE,
- LT_RIGHTMARGIN,
- LT_SPACING,
- LT_TOPSEP,
- LT_INTITLE
+ LT_PREAMBLE,
+ LT_RIGHTMARGIN,
+ LT_SPACING,
+ LT_TOPSEP,
+ LT_TOCLEVEL,
+ LT_INNERTAG,
+ LT_LABELTAG,
+ LT_ITEMTAG,
+ LT_INTITLE // keep this last!
};
/////////////////////
margintype = MARGIN_STATIC;
latextype = LATEX_PARAGRAPH;
intitle = false;
+ optionalargs = 0;
needprotect = false;
keepempty = false;
font = LyXFont(LyXFont::ALL_INHERIT);
newline_allowed = true;
free_spacing = false;
pass_thru = false;
+ is_environment = false;
+ toclevel = NOT_IN_TOC;
+ commanddepth = 0;
}
// Reads a layout definition from file
-bool LyXLayout::Read (LyXLex & lexrc, LyXTextClass const & tclass)
+bool LyXLayout::read(LyXLex & lexrc, LyXTextClass const & tclass)
{
// This table is sorted alphabetically [asierra 30March96]
keyword_item layoutTags[] = {
- { "align", LT_ALIGN },
- { "alignpossible", LT_ALIGNPOSSIBLE },
- { "bottomsep", LT_BOTTOMSEP },
- { "copystyle", LT_COPYSTYLE },
- { "end", LT_END },
- { "endlabelstring", LT_ENDLABELSTRING },
- { "endlabeltype", LT_ENDLABELTYPE },
- { "fill_bottom", LT_FILL_BOTTOM },
- { "fill_top", LT_FILL_TOP },
- { "font", LT_FONT },
- { "freespacing", LT_FREE_SPACING },
- { "intitle", LT_INTITLE },
- { "itemsep", LT_ITEMSEP },
- { "keepempty", LT_KEEPEMPTY },
- { "labelbottomsep", LT_LABEL_BOTTOMSEP },
- { "labelfont", LT_LABELFONT },
- { "labelindent", LT_LABELINDENT },
- { "labelsep", LT_LABELSEP },
- { "labelstring", LT_LABELSTRING },
- { "labelstringappendix", LT_LABELSTRING_APPENDIX },
- { "labeltype", LT_LABELTYPE },
- { "latexname", LT_LATEXNAME },
- { "latexparam", LT_LATEXPARAM },
- { "latextype", LT_LATEXTYPE },
- { "leftmargin", LT_LEFTMARGIN },
- { "margin", LT_MARGIN },
- { "needprotect", LT_NEED_PROTECT },
- { "newline", LT_NEWLINE },
- { "nextnoindent", LT_NEXTNOINDENT },
- { "obsoletedby", LT_OBSOLETEDBY },
- { "parindent", LT_PARINDENT },
- { "parsep", LT_PARSEP },
- { "parskip", LT_PARSKIP },
- { "passthru", LT_PASS_THRU },
- { "preamble", LT_PREAMBLE },
- { "rightmargin", LT_RIGHTMARGIN },
- { "spacing", LT_SPACING },
- { "textfont", LT_TEXTFONT },
- { "topsep", LT_TOPSEP }
+ { "align", LT_ALIGN },
+ { "alignpossible", LT_ALIGNPOSSIBLE },
+ { "bottomsep", LT_BOTTOMSEP },
+ { "commanddepth", LT_COMMANDDEPTH },
+ { "copystyle", LT_COPYSTYLE },
+ { "dependson", LT_DEPENDSON },
+ { "end", LT_END },
+ { "endlabelstring", LT_ENDLABELSTRING },
+ { "endlabeltype", LT_ENDLABELTYPE },
+ { "fill_bottom", LT_FILL_BOTTOM },
+ { "fill_top", LT_FILL_TOP },
+ { "font", LT_FONT },
+ { "freespacing", LT_FREE_SPACING },
+ { "innertag", LT_INNERTAG },
+ { "intitle", LT_INTITLE },
+ { "itemsep", LT_ITEMSEP },
+ { "itemtag", LT_ITEMTAG },
+ { "keepempty", LT_KEEPEMPTY },
+ { "labelbottomsep", LT_LABEL_BOTTOMSEP },
+ { "labelcounter", LT_LABELCOUNTER },
+ { "labelfont", LT_LABELFONT },
+ { "labelindent", LT_LABELINDENT },
+ { "labelsep", LT_LABELSEP },
+ { "labelstring", LT_LABELSTRING },
+ { "labelstringappendix", LT_LABELSTRING_APPENDIX },
+ { "labeltag", LT_LABELTAG },
+ { "labeltype", LT_LABELTYPE },
+ { "latexfooter", LT_LATEXFOOTER },
+ { "latexheader", LT_LATEXHEADER },
+ { "latexname", LT_LATEXNAME },
+ { "latexparagraph", LT_LATEXPARAGRAPH },
+ { "latexparam", LT_LATEXPARAM },
+ { "latextype", LT_LATEXTYPE },
+ { "leftmargin", LT_LEFTMARGIN },
+ { "margin", LT_MARGIN },
+ { "needprotect", LT_NEED_PROTECT },
+ { "newline", LT_NEWLINE },
+ { "nextnoindent", LT_NEXTNOINDENT },
+ { "obsoletedby", LT_OBSOLETEDBY },
+ { "optionalargs", LT_OPTARGS },
+ { "parindent", LT_PARINDENT },
+ { "parsep", LT_PARSEP },
+ { "parskip", LT_PARSKIP },
+ { "passthru", LT_PASS_THRU },
+ { "preamble", LT_PREAMBLE },
+ { "rightmargin", LT_RIGHTMARGIN },
+ { "spacing", LT_SPACING },
+ { "textfont", LT_TEXTFONT },
+ { "toclevel", LT_TOCLEVEL },
+ { "topsep", LT_TOPSEP }
};
bool error = false;
// See comment in lyxrc.C.
switch (le) {
case LyXLex::LEX_FEOF:
- continue;
+ continue;
case LyXLex::LEX_UNDEF: // parse error
lexrc.printError("Unknown layout tag `$$Token'");
error = true;
- continue;
+ continue;
default: break;
}
switch (static_cast<LayoutTags>(le)) {
break;
case LT_COPYSTYLE: // initialize with a known style
- if (lexrc.next()) {
- string const style = lexrc.getString();
-
+ if (lexrc.next()) {
+ string const style = subst(lexrc.getString(),
+ '_', ' ');
+
if (tclass.hasLayout(style)) {
string const tmpname = name_;
- this->operator=(tclass[style]);
+ this->operator=(*tclass[style]);
name_ = tmpname;
} else {
- lyxerr << "Cannot copy unknown style `" << style << "'" << endl;
- LyXTextClass::const_iterator it = tclass.begin();
- LyXTextClass::const_iterator end = tclass.end();
- lyxerr << "All layouts so far:" << endl;
+ lyxerr << "Cannot copy unknown style `"
+ << style << "'\n"
+ << "All layouts so far:"
+ << endl;
+ LyXTextClass::const_iterator it =
+ tclass.begin();
+ LyXTextClass::const_iterator end =
+ tclass.end();
for (; it != end; ++it) {
- lyxerr << it->name() << endl;
+ lyxerr << (*it)->name()
+ << endl;
}
-
+
//lexrc.printError("Cannot copy known "
// "style `$$Token'");
}
break;
case LT_OBSOLETEDBY: // replace with a known style
- if (lexrc.next()) {
+ if (lexrc.next()) {
string const style = lexrc.getString();
-
+
if (tclass.hasLayout(style)) {
string const tmpname = name_;
- this->operator=(tclass[style]);
+ this->operator=(*tclass[style]);
name_ = tmpname;
if (obsoleted_by().empty())
obsoleted_by_ = style;
} else {
- lyxerr << "Cannot replace with unknown style `" << style << "'" << endl;
-
- //lexrc.printError("Cannot replace with"
+ lyxerr << "Cannot replace with unknown style `" << style << '\'' << endl;
+
+ //lexrc.printError("Cannot replace with"
// " unknown style "
// "`$$Token'");
}
}
break;
- case LT_MARGIN: // Margin style definition.
+ case LT_DEPENDSON:
+ if (lexrc.next())
+ depends_on_ = lexrc.getString();
+ break;
+
+ case LT_MARGIN: // margin style definition.
readMargin(lexrc);
break;
- case LT_LATEXTYPE: // Latex style definition.
+ case LT_LATEXTYPE: // LaTeX style definition.
readLatexType(lexrc);
break;
+ case LT_LATEXHEADER: // header for environments
+ lexrc.next();
+ latexheader = lexrc.getString();
+ break;
+
+ case LT_LATEXFOOTER: // footer for environments
+ lexrc.next();
+ latexfooter = lexrc.getString();
+ break;
+
+ case LT_LATEXPARAGRAPH:
+ lexrc.next();
+ latexparagraph = lexrc.getString();
+ break;
+
case LT_INTITLE:
intitle = lexrc.next() && lexrc.getInteger();
break;
-
+
+ case LT_TOCLEVEL:
+ lexrc.next();
+ toclevel = lexrc.getInteger();
+ break;
+
+ case LT_OPTARGS:
+ if (lexrc.next())
+ optionalargs = lexrc.getInteger();
+ break;
+
case LT_NEED_PROTECT:
needprotect = lexrc.next() && lexrc.getInteger();
break;
-
+
case LT_KEEPEMPTY:
keepempty = lexrc.next() && lexrc.getInteger();
break;
nextnoindent = false;
break;
+ case LT_COMMANDDEPTH:
+ lexrc.next();
+ commanddepth = lexrc.getInteger();
+ break;
+
case LT_LATEXNAME:
- if (lexrc.next())
- latexname_ = lexrc.getString();
+ if (lexrc.next())
+ latexname_ = lexrc.getString();
break;
-
+
case LT_LATEXPARAM:
if (lexrc.next())
- latexparam_ = lexrc.getString();
+ latexparam_ = subst(lexrc.getString(), """, "\"");
+ break;
+
+ case LT_INNERTAG:
+ if (lexrc.next())
+ innertag_ = lexrc.getString();
+ break;
+
+ case LT_LABELTAG:
+ if (lexrc.next())
+ labeltag_ = lexrc.getString();
+ break;
+
+ case LT_ITEMTAG:
+ if (lexrc.next())
+ itemtag_ = lexrc.getString();
break;
case LT_PREAMBLE:
case LT_ENDLABELTYPE:
readEndLabelType(lexrc);
break;
-
+
case LT_LEFTMARGIN: // left margin type
- if (lexrc.next())
+ if (lexrc.next())
leftmargin = lexrc.getString();
- break;
+ break;
case LT_RIGHTMARGIN: // right margin type
if (lexrc.next())
case LT_LABELSTRING: // label string definition
if (lexrc.next())
- labelstring_ = lexrc.getString();
+ labelstring_ = trim(lexrc.getString());
break;
case LT_ENDLABELSTRING: // endlabel string definition
if (lexrc.next())
- endlabelstring_ = lexrc.getString();
+ endlabelstring_ = trim(lexrc.getString());
break;
case LT_LABELSTRING_APPENDIX: // label string appendix definition
if (lexrc.next())
- labelstring_appendix_ = lexrc.getString();
+ labelstring_appendix_ = trim(lexrc.getString());
+ break;
+
+ case LT_LABELCOUNTER: // name of counter to use
+ if (lexrc.next())
+ counter = trim(lexrc.getString());
break;
case LT_FREE_SPACING: // Allow for free spacing.
}
}
lexrc.popTable();
+
+ if (labelstring_appendix_.empty())
+ labelstring_appendix_ = labelstring_;
return error;
}
switch (le) {
case LyXLex::LEX_UNDEF:
lexrc.printError("Unknown alignment `$$Token'");
- return;
+ return;
default: break;
};
switch (static_cast<AlignTags>(le)) {
switch (le) {
case LyXLex::LEX_UNDEF:
lexrc.printError("Unknown alignment `$$Token'");
- continue;
+ continue;
default: break;
};
switch (static_cast<AlignTags>(le)) {
LA_CENTERED_TOP_ENVIRONMENT,
LA_STATIC,
LA_SENSITIVE,
- LA_COUNTER_CHAPTER,
- LA_COUNTER_SECTION,
- LA_COUNTER_SUBSECTION,
- LA_COUNTER_SUBSUBSECTION,
- LA_COUNTER_PARAGRAPH,
- LA_COUNTER_SUBPARAGRAPH,
- LA_COUNTER_ENUMI,
- LA_COUNTER_ENUMII,
- LA_COUNTER_ENUMIII,
- LA_COUNTER_ENUMIV,
+ LA_COUNTER,
+ LA_ENUMERATE,
+ LA_ITEMIZE,
LA_BIBLIO
};
keyword_item labelTypeTags[] = {
{ "bibliography", LA_BIBLIO },
{ "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
- { "counter_chapter", LA_COUNTER_CHAPTER },
- { "counter_enumi", LA_COUNTER_ENUMI },
- { "counter_enumii", LA_COUNTER_ENUMII },
- { "counter_enumiii", LA_COUNTER_ENUMIII },
- { "counter_enumiv", LA_COUNTER_ENUMIV },
- { "counter_paragraph", LA_COUNTER_PARAGRAPH },
- { "counter_section", LA_COUNTER_SECTION },
- { "counter_subparagraph", LA_COUNTER_SUBPARAGRAPH },
- { "counter_subsection", LA_COUNTER_SUBSECTION },
- { "counter_subsubsection", LA_COUNTER_SUBSUBSECTION },
+ { "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 }
-};
+ };
pushpophelper pph(lexrc, labelTypeTags, LA_BIBLIO);
int le = lexrc.lex();
switch (le) {
case LyXLex::LEX_UNDEF:
lexrc.printError("Unknown labeltype tag `$$Token'");
- return;
+ return;
default: break;
}
switch (static_cast<LabelTypeTags>(le)) {
case LA_SENSITIVE:
labeltype = LABEL_SENSITIVE;
break;
- case LA_COUNTER_CHAPTER:
- labeltype = LABEL_COUNTER_CHAPTER;
- break;
- case LA_COUNTER_SECTION:
- labeltype = LABEL_COUNTER_SECTION;
- break;
- case LA_COUNTER_SUBSECTION:
- labeltype = LABEL_COUNTER_SUBSECTION;
- break;
- case LA_COUNTER_SUBSUBSECTION:
- labeltype = LABEL_COUNTER_SUBSUBSECTION;
- break;
- case LA_COUNTER_PARAGRAPH:
- labeltype = LABEL_COUNTER_PARAGRAPH;
+ case LA_COUNTER:
+ labeltype = LABEL_COUNTER;
break;
- case LA_COUNTER_SUBPARAGRAPH:
- labeltype = LABEL_COUNTER_SUBPARAGRAPH;
+ case LA_ENUMERATE:
+ labeltype = LABEL_ENUMERATE;
break;
- case LA_COUNTER_ENUMI:
- labeltype = LABEL_COUNTER_ENUMI;
- break;
- case LA_COUNTER_ENUMII:
- labeltype = LABEL_COUNTER_ENUMII;
- break;
- case LA_COUNTER_ENUMIII:
- labeltype = LABEL_COUNTER_ENUMIII;
- break;
- case LA_COUNTER_ENUMIV:
- labeltype = LABEL_COUNTER_ENUMIV;
+ case LA_ITEMIZE:
+ labeltype = LABEL_ITEMIZE;
break;
case LA_BIBLIO:
labeltype = LABEL_BIBLIO;
void LyXLayout::readLatexType(LyXLex & lexrc)
{
keyword_item latexTypeTags[] = {
+ { "bib_environment", LATEX_BIB_ENVIRONMENT },
{ "command", LATEX_COMMAND },
{ "environment", LATEX_ENVIRONMENT },
{ "item_environment", LATEX_ITEM_ENVIRONMENT },
case LATEX_COMMAND:
case LATEX_ENVIRONMENT:
case LATEX_ITEM_ENVIRONMENT:
+ case LATEX_BIB_ENVIRONMENT:
case LATEX_LIST_ENVIRONMENT:
latextype = static_cast<LYX_LATEX_TYPES>(le);
break;
break;
case ST_OTHER:
lexrc.next();
- spacing.set(Spacing::Other, lexrc.getFloat());
+ spacing.set(Spacing::Other, lexrc.getString());
break;
}
}
{
return obsoleted_by_;
}
+
+
+string const & LyXLayout::depends_on() const
+{
+ return depends_on_;
+}