3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Jean-Marc Lasgouttes
10 * Full author contact details are available in file CREDITS.
17 #include "TextClass.h"
21 #include "support/Messages.h"
22 #include "support/debug.h"
23 #include "support/lassert.h"
24 #include "support/lstrings.h"
26 #include <boost/regex.hpp>
29 using namespace lyx::support;
33 /// Special value of toclevel for layouts that to not belong in a TOC
34 const int Layout::NOT_IN_TOC = -1000;
36 // The order of the LayoutTags enum is no more important. [asierra300396]
50 //LT_ENVIRONMENT_DEFAULT,
68 LT_LABELSTRING_APPENDIX,
94 LT_INTITLE // keep this last!
102 margintype = MARGIN_STATIC;
103 latextype = LATEX_PARAGRAPH;
109 labelfont = inherit_font;
111 reslabelfont = sane_font;
112 nextnoindent = false;
117 labelbottomsep = 0.0;
119 align = LYX_ALIGN_BLOCK;
120 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
121 labeltype = LABEL_NO_LABEL;
122 endlabeltype = END_LABEL_NO_LABEL;
123 // Should or should not. That is the question.
124 // spacing.set(Spacing::OneHalf);
127 newline_allowed = true;
128 free_spacing = false;
130 toclevel = NOT_IN_TOC;
135 bool Layout::read(Lexer & lex, TextClass const & tclass)
137 // This table is sorted alphabetically [asierra 30March96]
138 LexerKeyword layoutTags[] = {
139 { "align", LT_ALIGN },
140 { "alignpossible", LT_ALIGNPOSSIBLE },
141 { "bottomsep", LT_BOTTOMSEP },
142 { "category", LT_CATEGORY },
143 { "commanddepth", LT_COMMANDDEPTH },
144 { "copystyle", LT_COPYSTYLE },
145 { "dependson", LT_DEPENDSON },
147 { "endlabelstring", LT_ENDLABELSTRING },
148 { "endlabeltype", LT_ENDLABELTYPE },
149 { "fill_bottom", LT_FILL_BOTTOM },
150 { "fill_top", LT_FILL_TOP },
152 { "freespacing", LT_FREE_SPACING },
153 { "i18npreamble", LT_I18NPREAMBLE },
154 { "innertag", LT_INNERTAG },
155 { "intitle", LT_INTITLE },
156 { "itemsep", LT_ITEMSEP },
157 { "itemtag", LT_ITEMTAG },
158 { "keepempty", LT_KEEPEMPTY },
159 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
160 { "labelcounter", LT_LABELCOUNTER },
161 { "labelfont", LT_LABELFONT },
162 { "labelindent", LT_LABELINDENT },
163 { "labelsep", LT_LABELSEP },
164 { "labelstring", LT_LABELSTRING },
165 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
166 { "labeltag", LT_LABELTAG },
167 { "labeltype", LT_LABELTYPE },
168 { "latexname", LT_LATEXNAME },
169 { "latexparam", LT_LATEXPARAM },
170 { "latextype", LT_LATEXTYPE },
171 { "leftmargin", LT_LEFTMARGIN },
172 { "margin", LT_MARGIN },
173 { "needprotect", LT_NEED_PROTECT },
174 { "newline", LT_NEWLINE },
175 { "nextnoindent", LT_NEXTNOINDENT },
176 { "obsoletedby", LT_OBSOLETEDBY },
177 { "optionalargs", LT_OPTARGS },
178 { "parindent", LT_PARINDENT },
179 { "parsep", LT_PARSEP },
180 { "parskip", LT_PARSKIP },
181 { "passthru", LT_PASS_THRU },
182 { "preamble", LT_PREAMBLE },
183 { "requires", LT_REQUIRES },
184 { "rightmargin", LT_RIGHTMARGIN },
185 { "spacing", LT_SPACING },
186 { "textfont", LT_TEXTFONT },
187 { "toclevel", LT_TOCLEVEL },
188 { "topsep", LT_TOPSEP }
192 bool finished = false;
193 lex.pushTable(layoutTags);
194 // parse style section
195 while (!finished && lex.isOK() && !error) {
197 // See comment in LyXRC.cpp.
199 case Lexer::LEX_FEOF:
202 case Lexer::LEX_UNDEF: // parse error
203 lex.printError("Unknown layout tag `$$Token'");
208 switch (static_cast<LayoutTags>(le)) {
209 case LT_END: // end of structure
217 case LT_COPYSTYLE: { // initialize with a known style
220 style = subst(style, '_', ' ');
222 if (tclass.hasLayout(style)) {
223 docstring const tmpname = name_;
224 this->operator=(tclass[style]);
227 LYXERR0("Cannot copy unknown style `"
229 << "All layouts so far:");
230 DocumentClass::const_iterator lit = tclass.begin();
231 DocumentClass::const_iterator len = tclass.end();
232 for (; lit != len; ++lit)
233 LYXERR0(lit->name());
238 case LT_OBSOLETEDBY: { // replace with a known style
241 style = subst(style, '_', ' ');
243 if (tclass.hasLayout(style)) {
244 docstring const tmpname = name_;
245 this->operator=(tclass[style]);
247 if (obsoleted_by().empty())
248 obsoleted_by_ = style;
250 LYXERR0("Cannot replace with unknown style `"
253 //lex.printError("Cannot replace with"
262 depends_on_ = subst(depends_on_, '_', ' ');
265 case LT_MARGIN: // margin style definition.
269 case LT_LATEXTYPE: // LaTeX style definition.
282 lex >> optionalargs ;
285 case LT_NEED_PROTECT:
294 font = lyxRead(lex, font);
299 font = lyxRead(lex, font);
303 labelfont = lyxRead(lex, labelfont);
306 case LT_NEXTNOINDENT: // Indent next paragraph?
310 case LT_COMMANDDEPTH:
320 latexparam_ = subst(latexparam_, """, "\"");
336 preamble_ = from_utf8(lex.getLongString("EndPreamble"));
339 case LT_I18NPREAMBLE:
340 i18npreamble_ = from_utf8(lex.getLongString("EndI18NPreamble"));
347 case LT_ENDLABELTYPE:
348 readEndLabelType(lex);
351 case LT_LEFTMARGIN: // left margin type
355 case LT_RIGHTMARGIN: // right margin type
359 case LT_LABELINDENT: // label indenting flag
363 case LT_PARINDENT: // paragraph indent. flag
367 case LT_PARSKIP: // paragraph skip size
371 case LT_ITEMSEP: // item separation size
375 case LT_TOPSEP: // top separation size
379 case LT_BOTTOMSEP: // bottom separation size
383 case LT_LABEL_BOTTOMSEP: // label bottom separation size
384 lex >> labelbottomsep;
387 case LT_LABELSEP: // label separator
389 labelsep = subst(labelsep, 'x', ' ');
392 case LT_PARSEP: // par. separation size
396 case LT_FILL_TOP: // fill top flag
400 case LT_FILL_BOTTOM: // fill bottom flag
404 case LT_NEWLINE: // newlines allowed?
405 lex >> newline_allowed;
408 case LT_ALIGN: // paragraph align
411 case LT_ALIGNPOSSIBLE: // paragraph allowed align
412 readAlignPossible(lex);
415 case LT_LABELSTRING: // label string definition
416 // FIXME: this means LT_ENDLABELSTRING may only
417 // occur after LT_LABELSTRING
419 labelstring_ = trim(labelstring_);
420 labelstring_appendix_ = labelstring_;
423 case LT_ENDLABELSTRING: // endlabel string definition
424 lex >> endlabelstring_;
425 endlabelstring_ = trim(endlabelstring_);
428 case LT_LABELSTRING_APPENDIX: // label string appendix definition
429 lex >> labelstring_appendix_;
430 labelstring_appendix_ = trim(labelstring_appendix_);
433 case LT_LABELCOUNTER: // name of counter to use
435 counter = trim(counter);
438 case LT_FREE_SPACING: // Allow for free spacing.
442 case LT_PASS_THRU: // Allow for pass thru.
446 case LT_SPACING: // setspace.sty
452 vector<string> const req =
453 getVectorFromString(lex.getString());
454 requires_.insert(req.begin(), req.end());
474 LexerKeyword alignTags[] = {
475 { "block", AT_BLOCK },
476 { "center", AT_CENTER },
477 { "layout", AT_LAYOUT },
479 { "right", AT_RIGHT }
483 void Layout::readAlign(Lexer & lex)
485 PushPopHelper pph(lex, alignTags);
488 case Lexer::LEX_UNDEF:
489 lex.printError("Unknown alignment `$$Token'");
495 align = LYX_ALIGN_BLOCK;
498 align = LYX_ALIGN_LEFT;
501 align = LYX_ALIGN_RIGHT;
504 align = LYX_ALIGN_CENTER;
507 align = LYX_ALIGN_LAYOUT;
513 void Layout::readAlignPossible(Lexer & lex)
515 lex.pushTable(alignTags);
516 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
517 int lineno = lex.lineNumber();
521 case Lexer::LEX_UNDEF:
522 lex.printError("Unknown alignment `$$Token'");
528 alignpossible |= LYX_ALIGN_BLOCK;
531 alignpossible |= LYX_ALIGN_LEFT;
534 alignpossible |= LYX_ALIGN_RIGHT;
537 alignpossible |= LYX_ALIGN_CENTER;
540 alignpossible |= LYX_ALIGN_LAYOUT;
543 } while (lineno == lex.lineNumber());
548 void Layout::readLabelType(Lexer & lex)
554 LA_CENTERED_TOP_ENVIRONMENT,
564 LexerKeyword labelTypeTags[] = {
565 { "bibliography", LA_BIBLIO },
566 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
567 { "counter", LA_COUNTER },
568 { "enumerate", LA_ENUMERATE },
569 { "itemize", LA_ITEMIZE },
570 { "manual", LA_MANUAL },
571 { "no_label", LA_NO_LABEL },
572 { "sensitive", LA_SENSITIVE },
573 { "static", LA_STATIC },
574 { "top_environment", LA_TOP_ENVIRONMENT }
577 PushPopHelper pph(lex, labelTypeTags);
580 case Lexer::LEX_UNDEF:
581 lex.printError("Unknown labeltype tag `$$Token'");
587 labeltype = LABEL_NO_LABEL;
590 labeltype = LABEL_MANUAL;
592 case LA_TOP_ENVIRONMENT:
593 labeltype = LABEL_TOP_ENVIRONMENT;
595 case LA_CENTERED_TOP_ENVIRONMENT:
596 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
599 labeltype = LABEL_STATIC;
602 labeltype = LABEL_SENSITIVE;
605 labeltype = LABEL_COUNTER;
608 labeltype = LABEL_ENUMERATE;
611 labeltype = LABEL_ITEMIZE;
614 labeltype = LABEL_BIBLIO;
620 void Layout::readEndLabelType(Lexer & lex)
622 static LexerKeyword endlabelTypeTags[] = {
623 { "box", END_LABEL_BOX },
624 { "filled_box", END_LABEL_FILLED_BOX },
625 { "no_label", END_LABEL_NO_LABEL },
626 { "static", END_LABEL_STATIC }
629 PushPopHelper pph(lex, endlabelTypeTags);
632 case Lexer::LEX_UNDEF:
633 lex.printError("Unknown labeltype tag `$$Token'");
635 case END_LABEL_STATIC:
637 case END_LABEL_FILLED_BOX:
638 case END_LABEL_NO_LABEL:
639 endlabeltype = static_cast<EndLabelType>(le);
642 LYXERR0("Unhandled value " << le);
648 void Layout::readMargin(Lexer & lex)
650 LexerKeyword marginTags[] = {
651 { "dynamic", MARGIN_DYNAMIC },
652 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
653 { "manual", MARGIN_MANUAL },
654 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
655 { "static", MARGIN_STATIC }
658 PushPopHelper pph(lex, marginTags);
662 case Lexer::LEX_UNDEF:
663 lex.printError("Unknown margin type tag `$$Token'");
668 case MARGIN_FIRST_DYNAMIC:
669 case MARGIN_RIGHT_ADDRESS_BOX:
670 margintype = static_cast<MarginType>(le);
673 LYXERR0("Unhandled value " << le);
679 void Layout::readLatexType(Lexer & lex)
681 LexerKeyword latexTypeTags[] = {
682 { "bib_environment", LATEX_BIB_ENVIRONMENT },
683 { "command", LATEX_COMMAND },
684 { "environment", LATEX_ENVIRONMENT },
685 { "item_environment", LATEX_ITEM_ENVIRONMENT },
686 { "list_environment", LATEX_LIST_ENVIRONMENT },
687 { "paragraph", LATEX_PARAGRAPH }
690 PushPopHelper pph(lex, latexTypeTags);
693 case Lexer::LEX_UNDEF:
694 lex.printError("Unknown latextype tag `$$Token'");
696 case LATEX_PARAGRAPH:
698 case LATEX_ENVIRONMENT:
699 case LATEX_ITEM_ENVIRONMENT:
700 case LATEX_BIB_ENVIRONMENT:
701 case LATEX_LIST_ENVIRONMENT:
702 latextype = static_cast<LatexType>(le);
705 LYXERR0("Unhandled value " << le);
711 void Layout::readSpacing(Lexer & lex)
714 ST_SPACING_SINGLE = 1,
720 LexerKeyword spacingTags[] = {
721 {"double", ST_SPACING_DOUBLE },
722 {"onehalf", ST_SPACING_ONEHALF },
723 {"other", ST_OTHER },
724 {"single", ST_SPACING_SINGLE }
727 PushPopHelper pph(lex, spacingTags);
730 case Lexer::LEX_UNDEF:
731 lex.printError("Unknown spacing token `$$Token'");
736 case ST_SPACING_SINGLE:
737 spacing.set(Spacing::Single);
739 case ST_SPACING_ONEHALF:
740 spacing.set(Spacing::Onehalf);
742 case ST_SPACING_DOUBLE:
743 spacing.set(Spacing::Double);
747 spacing.set(Spacing::Other, lex.getString());
753 docstring const & Layout::name() const
759 void Layout::setName(docstring const & name)
765 docstring const & Layout::obsoleted_by() const
767 return obsoleted_by_;
771 docstring const & Layout::depends_on() const
777 docstring const Layout::i18npreamble(Language const * lang) const
779 if (i18npreamble_.empty())
780 return i18npreamble_;
781 string preamble = subst(to_utf8(i18npreamble_), "$$lang",
784 // tex2lyx does not have getMessages()
785 LASSERT(false, /**/);
788 // boost::regex is not unicode-safe.
789 // Should use QRegExp or (boost::u32regex, but that requires ICU)
790 static boost::regex const reg("_\\(([^\\)]+)\\)");
792 while (boost::regex_search(preamble, sub, reg)) {
793 string const key = sub.str(1);
796 translated = to_utf8(getMessages(lang->code()).get(key));
798 lyxerr << "Warning: not translating `" << key
799 << "' because it is not pure ASCII." << endl;
802 preamble = subst(preamble, sub.str(), translated);
805 return from_utf8(preamble);
809 bool Layout::operator==(Layout const & rhs) const
811 // This is enough for the applications we actually make,
812 // at least at the moment. But we could check more.
813 return name() == rhs.name()
814 && latexname() == rhs.latexname()
815 && latextype == rhs.latextype;