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,
67 LT_LABELSTRING_APPENDIX,
103 LT_INTITLE // keep this last!
106 /////////////////////
111 margintype = MARGIN_STATIC;
112 latextype = LATEX_PARAGRAPH;
118 labelfont = inherit_font;
120 reslabelfont = sane_font;
121 nextnoindent = false;
126 labelbottomsep = 0.0;
128 align = LYX_ALIGN_BLOCK;
129 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
130 labeltype = LABEL_NO_LABEL;
131 endlabeltype = END_LABEL_NO_LABEL;
132 // Should or should not. That is the question.
133 // spacing.set(Spacing::OneHalf);
136 newline_allowed = true;
137 free_spacing = false;
139 toclevel = NOT_IN_TOC;
144 bool Layout::read(Lexer & lex, TextClass const & tclass)
146 // This table is sorted alphabetically [asierra 30March96]
147 LexerKeyword layoutTags[] = {
148 { "align", LT_ALIGN },
149 { "alignpossible", LT_ALIGNPOSSIBLE },
150 { "babelpreamble", LT_BABELPREAMBLE },
151 { "bottomsep", LT_BOTTOMSEP },
152 { "category", LT_CATEGORY },
153 { "commanddepth", LT_COMMANDDEPTH },
154 { "copystyle", LT_COPYSTYLE },
155 { "dependson", LT_DEPENDSON },
157 { "endlabelstring", LT_ENDLABELSTRING },
158 { "endlabeltype", LT_ENDLABELTYPE },
159 { "fill_bottom", LT_FILL_BOTTOM },
160 { "fill_top", LT_FILL_TOP },
162 { "freespacing", LT_FREE_SPACING },
163 { "htmlattr", LT_HTMLATTR },
164 { "htmlitem", LT_HTMLITEM },
165 { "htmlitemattr", LT_HTMLITEMATTR },
166 { "htmllabel", LT_HTMLLABEL },
167 { "htmllabelattr", LT_HTMLLABELATTR },
168 { "htmlpremable", LT_HTMLPREAMBLE },
169 { "htmlstyle", LT_HTMLSTYLE },
170 { "htmltag", LT_HTMLTAG },
171 { "innertag", LT_INNERTAG },
172 { "intitle", LT_INTITLE },
173 { "itemsep", LT_ITEMSEP },
174 { "itemtag", LT_ITEMTAG },
175 { "keepempty", LT_KEEPEMPTY },
176 { "labelbottomsep", LT_LABEL_BOTTOMSEP },
177 { "labelcounter", LT_LABELCOUNTER },
178 { "labelfont", LT_LABELFONT },
179 { "labelindent", LT_LABELINDENT },
180 { "labelsep", LT_LABELSEP },
181 { "labelstring", LT_LABELSTRING },
182 { "labelstringappendix", LT_LABELSTRING_APPENDIX },
183 { "labeltag", LT_LABELTAG },
184 { "labeltype", LT_LABELTYPE },
185 { "langpreamble", LT_LANGPREAMBLE },
186 { "latexname", LT_LATEXNAME },
187 { "latexparam", LT_LATEXPARAM },
188 { "latextype", LT_LATEXTYPE },
189 { "leftmargin", LT_LEFTMARGIN },
190 { "margin", LT_MARGIN },
191 { "needprotect", LT_NEED_PROTECT },
192 { "newline", LT_NEWLINE },
193 { "nextnoindent", LT_NEXTNOINDENT },
194 { "obsoletedby", LT_OBSOLETEDBY },
195 { "optionalargs", LT_OPTARGS },
196 { "parindent", LT_PARINDENT },
197 { "parsep", LT_PARSEP },
198 { "parskip", LT_PARSKIP },
199 { "passthru", LT_PASS_THRU },
200 { "preamble", LT_PREAMBLE },
201 { "requires", LT_REQUIRES },
202 { "rightmargin", LT_RIGHTMARGIN },
203 { "spacing", LT_SPACING },
204 { "textfont", LT_TEXTFONT },
205 { "toclevel", LT_TOCLEVEL },
206 { "topsep", LT_TOPSEP }
210 bool finished = false;
211 lex.pushTable(layoutTags);
212 // parse style section
213 while (!finished && lex.isOK() && !error) {
215 // See comment in LyXRC.cpp.
217 case Lexer::LEX_FEOF:
220 case Lexer::LEX_UNDEF: // parse error
221 lex.printError("Unknown layout tag `$$Token'");
228 switch (static_cast<LayoutTags>(le)) {
229 case LT_END: // end of structure
237 case LT_COPYSTYLE: { // initialize with a known style
240 style = subst(style, '_', ' ');
242 if (tclass.hasLayout(style)) {
243 docstring const tmpname = name_;
244 this->operator=(tclass[style]);
247 LYXERR0("Cannot copy unknown style `"
249 << "All layouts so far:");
250 DocumentClass::const_iterator lit = tclass.begin();
251 DocumentClass::const_iterator len = tclass.end();
252 for (; lit != len; ++lit)
253 LYXERR0(lit->name());
258 case LT_OBSOLETEDBY: { // replace with a known style
261 style = subst(style, '_', ' ');
263 if (tclass.hasLayout(style)) {
264 docstring const tmpname = name_;
265 this->operator=(tclass[style]);
267 if (obsoleted_by().empty())
268 obsoleted_by_ = style;
270 LYXERR0("Cannot replace with unknown style `"
273 //lex.printError("Cannot replace with"
282 depends_on_ = subst(depends_on_, '_', ' ');
285 case LT_MARGIN: // margin style definition.
289 case LT_LATEXTYPE: // LaTeX style definition.
302 lex >> optionalargs ;
305 case LT_NEED_PROTECT:
314 font = lyxRead(lex, font);
319 font = lyxRead(lex, font);
323 labelfont = lyxRead(lex, labelfont);
326 case LT_NEXTNOINDENT: // Indent next paragraph?
330 case LT_COMMANDDEPTH:
340 latexparam_ = subst(latexparam_, """, "\"");
356 preamble_ = from_utf8(lex.getLongString("EndPreamble"));
359 case LT_LANGPREAMBLE:
360 langpreamble_ = from_utf8(lex.getLongString("EndLangPreamble"));
363 case LT_BABELPREAMBLE:
364 babelpreamble_ = from_utf8(lex.getLongString("EndBabelPreamble"));
371 case LT_ENDLABELTYPE:
372 readEndLabelType(lex);
375 case LT_LEFTMARGIN: // left margin type
379 case LT_RIGHTMARGIN: // right margin type
383 case LT_LABELINDENT: // label indenting flag
387 case LT_PARINDENT: // paragraph indent. flag
391 case LT_PARSKIP: // paragraph skip size
395 case LT_ITEMSEP: // item separation size
399 case LT_TOPSEP: // top separation size
403 case LT_BOTTOMSEP: // bottom separation size
407 case LT_LABEL_BOTTOMSEP: // label bottom separation size
408 lex >> labelbottomsep;
411 case LT_LABELSEP: // label separator
413 labelsep = subst(labelsep, 'x', ' ');
416 case LT_PARSEP: // par. separation size
420 case LT_FILL_TOP: // fill top flag
424 case LT_FILL_BOTTOM: // fill bottom flag
428 case LT_NEWLINE: // newlines allowed?
429 lex >> newline_allowed;
432 case LT_ALIGN: // paragraph align
435 case LT_ALIGNPOSSIBLE: // paragraph allowed align
436 readAlignPossible(lex);
439 case LT_LABELSTRING: // label string definition
440 // FIXME: this means LT_ENDLABELSTRING may only
441 // occur after LT_LABELSTRING
443 labelstring_ = trim(labelstring_);
444 labelstring_appendix_ = labelstring_;
447 case LT_ENDLABELSTRING: // endlabel string definition
448 lex >> endlabelstring_;
449 endlabelstring_ = trim(endlabelstring_);
452 case LT_LABELSTRING_APPENDIX: // label string appendix definition
453 lex >> labelstring_appendix_;
454 labelstring_appendix_ = trim(labelstring_appendix_);
457 case LT_LABELCOUNTER: // name of counter to use
459 counter = trim(counter);
462 case LT_FREE_SPACING: // Allow for free spacing.
466 case LT_PASS_THRU: // Allow for pass thru.
470 case LT_SPACING: // setspace.sty
476 vector<string> const req =
477 getVectorFromString(lex.getString());
478 requires_.insert(req.begin(), req.end());
494 case LT_HTMLITEMATTR:
495 lex >> htmlitemattr_;
502 case LT_HTMLLABELATTR:
503 lex >> htmllabelattr_;
507 htmlstyle_ = from_utf8(lex.getLongString("EndHTMLStyle"));
510 case LT_HTMLPREAMBLE:
511 htmlpreamble_ = from_utf8(lex.getLongString("EndPreamble"));
531 LexerKeyword alignTags[] = {
532 { "block", AT_BLOCK },
533 { "center", AT_CENTER },
534 { "layout", AT_LAYOUT },
536 { "right", AT_RIGHT }
540 void Layout::readAlign(Lexer & lex)
542 PushPopHelper pph(lex, alignTags);
545 case Lexer::LEX_UNDEF:
546 lex.printError("Unknown alignment `$$Token'");
552 align = LYX_ALIGN_BLOCK;
555 align = LYX_ALIGN_LEFT;
558 align = LYX_ALIGN_RIGHT;
561 align = LYX_ALIGN_CENTER;
564 align = LYX_ALIGN_LAYOUT;
570 void Layout::readAlignPossible(Lexer & lex)
572 lex.pushTable(alignTags);
573 alignpossible = LYX_ALIGN_NONE | LYX_ALIGN_LAYOUT;
574 int lineno = lex.lineNumber();
578 case Lexer::LEX_UNDEF:
579 lex.printError("Unknown alignment `$$Token'");
585 alignpossible |= LYX_ALIGN_BLOCK;
588 alignpossible |= LYX_ALIGN_LEFT;
591 alignpossible |= LYX_ALIGN_RIGHT;
594 alignpossible |= LYX_ALIGN_CENTER;
597 alignpossible |= LYX_ALIGN_LAYOUT;
600 } while (lineno == lex.lineNumber());
605 void Layout::readLabelType(Lexer & lex)
611 LA_CENTERED_TOP_ENVIRONMENT,
621 LexerKeyword labelTypeTags[] = {
622 { "bibliography", LA_BIBLIO },
623 { "centered_top_environment", LA_CENTERED_TOP_ENVIRONMENT },
624 { "counter", LA_COUNTER },
625 { "enumerate", LA_ENUMERATE },
626 { "itemize", LA_ITEMIZE },
627 { "manual", LA_MANUAL },
628 { "no_label", LA_NO_LABEL },
629 { "sensitive", LA_SENSITIVE },
630 { "static", LA_STATIC },
631 { "top_environment", LA_TOP_ENVIRONMENT }
634 PushPopHelper pph(lex, labelTypeTags);
637 case Lexer::LEX_UNDEF:
638 lex.printError("Unknown labeltype tag `$$Token'");
644 labeltype = LABEL_NO_LABEL;
647 labeltype = LABEL_MANUAL;
649 case LA_TOP_ENVIRONMENT:
650 labeltype = LABEL_TOP_ENVIRONMENT;
652 case LA_CENTERED_TOP_ENVIRONMENT:
653 labeltype = LABEL_CENTERED_TOP_ENVIRONMENT;
656 labeltype = LABEL_STATIC;
659 labeltype = LABEL_SENSITIVE;
662 labeltype = LABEL_COUNTER;
665 labeltype = LABEL_ENUMERATE;
668 labeltype = LABEL_ITEMIZE;
671 labeltype = LABEL_BIBLIO;
677 void Layout::readEndLabelType(Lexer & lex)
679 static LexerKeyword endlabelTypeTags[] = {
680 { "box", END_LABEL_BOX },
681 { "filled_box", END_LABEL_FILLED_BOX },
682 { "no_label", END_LABEL_NO_LABEL },
683 { "static", END_LABEL_STATIC }
686 PushPopHelper pph(lex, endlabelTypeTags);
689 case Lexer::LEX_UNDEF:
690 lex.printError("Unknown labeltype tag `$$Token'");
692 case END_LABEL_STATIC:
694 case END_LABEL_FILLED_BOX:
695 case END_LABEL_NO_LABEL:
696 endlabeltype = static_cast<EndLabelType>(le);
699 LYXERR0("Unhandled value " << le);
705 void Layout::readMargin(Lexer & lex)
707 LexerKeyword marginTags[] = {
708 { "dynamic", MARGIN_DYNAMIC },
709 { "first_dynamic", MARGIN_FIRST_DYNAMIC },
710 { "manual", MARGIN_MANUAL },
711 { "right_address_box", MARGIN_RIGHT_ADDRESS_BOX },
712 { "static", MARGIN_STATIC }
715 PushPopHelper pph(lex, marginTags);
719 case Lexer::LEX_UNDEF:
720 lex.printError("Unknown margin type tag `$$Token'");
725 case MARGIN_FIRST_DYNAMIC:
726 case MARGIN_RIGHT_ADDRESS_BOX:
727 margintype = static_cast<MarginType>(le);
730 LYXERR0("Unhandled value " << le);
736 void Layout::readLatexType(Lexer & lex)
738 LexerKeyword latexTypeTags[] = {
739 { "bib_environment", LATEX_BIB_ENVIRONMENT },
740 { "command", LATEX_COMMAND },
741 { "environment", LATEX_ENVIRONMENT },
742 { "item_environment", LATEX_ITEM_ENVIRONMENT },
743 { "list_environment", LATEX_LIST_ENVIRONMENT },
744 { "paragraph", LATEX_PARAGRAPH }
747 PushPopHelper pph(lex, latexTypeTags);
750 case Lexer::LEX_UNDEF:
751 lex.printError("Unknown latextype tag `$$Token'");
753 case LATEX_PARAGRAPH:
755 case LATEX_ENVIRONMENT:
756 case LATEX_ITEM_ENVIRONMENT:
757 case LATEX_BIB_ENVIRONMENT:
758 case LATEX_LIST_ENVIRONMENT:
759 latextype = static_cast<LatexType>(le);
762 LYXERR0("Unhandled value " << le);
768 void Layout::readSpacing(Lexer & lex)
771 ST_SPACING_SINGLE = 1,
777 LexerKeyword spacingTags[] = {
778 {"double", ST_SPACING_DOUBLE },
779 {"onehalf", ST_SPACING_ONEHALF },
780 {"other", ST_OTHER },
781 {"single", ST_SPACING_SINGLE }
784 PushPopHelper pph(lex, spacingTags);
787 case Lexer::LEX_UNDEF:
788 lex.printError("Unknown spacing token `$$Token'");
793 case ST_SPACING_SINGLE:
794 spacing.set(Spacing::Single);
796 case ST_SPACING_ONEHALF:
797 spacing.set(Spacing::Onehalf);
799 case ST_SPACING_DOUBLE:
800 spacing.set(Spacing::Double);
804 spacing.set(Spacing::Other, lex.getString());
812 docstring const i18npreamble(Language const * lang, docstring const & templ)
817 string preamble = subst(to_utf8(templ), "$$lang", lang->babel());
820 // tex2lyx does not have getMessages()
821 LASSERT(false, /**/);
824 // boost::regex is not unicode-safe.
825 // Should use QRegExp or (boost::u32regex, but that requires ICU)
826 static boost::regex const reg("_\\(([^\\)]+)\\)");
828 while (boost::regex_search(preamble, sub, reg)) {
829 string const key = sub.str(1);
832 translated = to_utf8(getMessages(lang->code()).get(key));
834 lyxerr << "Warning: not translating `" << key
835 << "' because it is not pure ASCII." << endl;
838 preamble = subst(preamble, sub.str(), translated);
841 return from_utf8(preamble);
847 docstring const Layout::langpreamble(Language const * lang) const
849 return i18npreamble(lang, langpreamble_);
853 docstring const Layout::babelpreamble(Language const * lang) const
855 return i18npreamble(lang, babelpreamble_);
859 bool Layout::operator==(Layout const & rhs) const
861 // This is enough for the applications we actually make,
862 // at least at the moment. But we could check more.
863 return name() == rhs.name()
864 && latexname() == rhs.latexname()
865 && latextype == rhs.latextype;