1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ======================================================
15 #pragma implementation
18 #include "lyxtextclass.h"
22 #include "support/lstrings.h"
23 #include "support/LAssert.h"
24 #include "support/lyxfunctional.h"
25 #include "support/filetools.h"
32 /* ******************************************************************* */
34 LyXTextClass::LyXTextClass(string const & fn, string const & cln,
36 : name_(fn), latexname_(cln), description_(desc)
43 pagestyle_ = "default";
44 maxcounter_ = LABEL_COUNTER_CHAPTER;
45 defaultfont_ = LyXFont(LyXFont::ALL_SANE);
46 opt_fontsize_ = "10|11|12";
47 opt_pagestyle_ = "empty|plain|headings|fancy";
53 bool LyXTextClass::do_readStyle(LyXLex & lexrc, LyXLayout & lay)
55 lyxerr[Debug::TCLASS] << "Reading style " << lay.name() << endl;
56 if (!lay.Read(lexrc, *this)) {
58 lay.resfont = lay.font;
59 #ifndef INHERIT_LANGUAGE
60 lay.resfont.realize(defaultfont());
61 lay.reslabelfont = lay.labelfont;
62 lay.reslabelfont.realize(defaultfont());
64 lay.resfont.realize(defaultfont(), default_language);
65 lay.reslabelfont = lay.labelfont;
66 lay.reslabelfont.realize(defaultfont(), default_language);
68 return false; // no errors
70 lyxerr << "Error parsing style `" << lay.name() << "'" << endl;
97 // Reads a textclass structure from file.
98 bool LyXTextClass::Read(string const & filename, bool merge)
100 keyword_item textClassTags[] = {
101 { "classoptions", TC_CLASSOPTIONS },
102 { "columns", TC_COLUMNS },
103 { "defaultfont", TC_DEFAULTFONT },
104 { "input", TC_INPUT },
105 { "leftmargin", TC_LEFTMARGIN },
106 { "maxcounter", TC_MAXCOUNTER },
107 { "nostyle", TC_NOSTYLE },
108 { "outputtype", TC_OUTPUTTYPE },
109 { "pagestyle", TC_PAGESTYLE },
110 { "preamble", TC_PREAMBLE },
111 { "providesamsmath", TC_PROVIDESAMSMATH },
112 { "providesmakeidx", TC_PROVIDESMAKEIDX },
113 { "providesurl", TC_PROVIDESURL },
114 { "rightmargin", TC_RIGHTMARGIN },
115 { "secnumdepth", TC_SECNUMDEPTH },
116 { "sides", TC_SIDES },
117 { "style", TC_STYLE },
118 { "tocdepth", TC_TOCDEPTH }
122 lyxerr[Debug::TCLASS] << "Reading textclass "
123 << MakeDisplayPath(filename)
126 lyxerr[Debug::TCLASS] << "Reading input file "
127 << MakeDisplayPath(filename)
130 LyXLex lexrc(textClassTags, TC_RIGHTMARGIN);
133 lexrc.setFile(filename);
134 if (!lexrc.isOK()) error = true;
137 while (lexrc.isOK() && !error) {
138 int le = lexrc.lex();
140 case LyXLex::LEX_FEOF:
143 case LyXLex::LEX_UNDEF:
144 lexrc.printError("Unknown TextClass tag `$$Token'");
149 switch (static_cast<TextClassTags>(le)) {
150 case TC_OUTPUTTYPE: // output type definition
151 readOutputType(lexrc);
154 case TC_INPUT: // Include file
156 string tmp = LibFileSearch("layouts",
160 if (Read(tmp, true)) {
161 lexrc.printError("Error reading input"
170 string name = subst(lexrc.getString(),
172 if (hasLayout(name)) {
173 LyXLayout & lay = GetLayout(name);
174 error = do_readStyle(lexrc, lay);
178 if (!(error = do_readStyle(lexrc, lay)))
179 layoutlist.push_back(lay);
183 lexrc.printError("No name given for style: `$$Token'.");
190 string const style = subst(lexrc.getString(),
192 if (!delete_layout(style))
193 lexrc.printError("Cannot delete style"
200 columns_ = lexrc.getInteger();
205 switch (lexrc.getInteger()) {
206 case 1: sides_ = OneSide; break;
207 case 2: sides_ = TwoSides; break;
209 lyxerr << "Impossible number of page"
210 " sides, setting to one."
220 pagestyle_ = strip(lexrc.getString());
224 defaultfont_.lyxRead(lexrc);
225 if (!defaultfont_.resolved()) {
226 lexrc.printError("Warning: defaultfont should "
227 "be fully instantiated!");
228 #ifndef INHERIT_LANGUAGE
229 defaultfont_.realize(LyXFont(LyXFont::ALL_SANE));
231 defaultfont_.realize(LyXFont(LyXFont::ALL_SANE),
238 readMaxCounter(lexrc);
243 secnumdepth_ = lexrc.getInteger();
248 tocdepth_ = lexrc.getInteger();
251 // First step to support options
252 case TC_CLASSOPTIONS:
253 readClassOptions(lexrc);
257 preamble_ = lexrc.getLongString("EndPreamble");
260 case TC_PROVIDESAMSMATH:
261 if (lexrc.next() && lexrc.getInteger())
262 provides_ |= amsmath;
265 case TC_PROVIDESMAKEIDX:
266 if (lexrc.next() && lexrc.getInteger())
267 provides_ |= makeidx;
271 if (lexrc.next() && lexrc.getInteger())
275 case TC_LEFTMARGIN: // left margin type
277 leftmargin_ = lexrc.getString();
280 case TC_RIGHTMARGIN: // right margin type
282 rightmargin_ = lexrc.getString();
287 if (!merge) { // we are at top level here.
288 lyxerr[Debug::TCLASS] << "Finished reading textclass "
289 << MakeDisplayPath(filename)
292 lyxerr[Debug::TCLASS] << "Finished reading input file "
293 << MakeDisplayPath(filename)
300 void LyXTextClass::readOutputType(LyXLex & lexrc)
302 keyword_item outputTypeTags[] = {
303 { "docbook", DOCBOOK },
305 { "linuxdoc", LINUXDOC },
306 { "literate", LITERATE }
309 pushpophelper pph(lexrc, outputTypeTags, LITERATE);
311 int le = lexrc.lex();
313 case LyXLex::LEX_UNDEF:
314 lexrc.printError("Unknown output type `$$Token'");
320 outputType_ = static_cast<OutputType>(le);
323 lyxerr << "Unhandled value " << le
324 << " in LyXTextClass::readOutputType." << endl;
331 enum MaxCounterTags {
332 MC_COUNTER_CHAPTER = 1,
334 MC_COUNTER_SUBSECTION,
335 MC_COUNTER_SUBSUBSECTION,
336 MC_COUNTER_PARAGRAPH,
337 MC_COUNTER_SUBPARAGRAPH,
345 void LyXTextClass::readMaxCounter(LyXLex & lexrc)
347 keyword_item maxCounterTags[] = {
348 {"counter_chapter", MC_COUNTER_CHAPTER },
349 {"counter_enumi", MC_COUNTER_ENUMI },
350 {"counter_enumii", MC_COUNTER_ENUMII },
351 {"counter_enumiii", MC_COUNTER_ENUMIII },
352 {"counter_enumiv", MC_COUNTER_ENUMIV },
353 {"counter_paragraph", MC_COUNTER_PARAGRAPH },
354 {"counter_section", MC_COUNTER_SECTION },
355 {"counter_subparagraph", MC_COUNTER_SUBPARAGRAPH },
356 {"counter_subsection", MC_COUNTER_SUBSECTION },
357 {"counter_subsubsection", MC_COUNTER_SUBSUBSECTION }
360 pushpophelper pph(lexrc, maxCounterTags, MC_COUNTER_ENUMIV);
361 int le = lexrc.lex();
363 case LyXLex::LEX_UNDEF:
364 lexrc.printError("Unknown MaxCounter tag `$$Token'");
368 switch (static_cast<MaxCounterTags>(le)) {
369 case MC_COUNTER_CHAPTER:
370 maxcounter_ = LABEL_COUNTER_CHAPTER;
372 case MC_COUNTER_SECTION:
373 maxcounter_ = LABEL_COUNTER_SECTION;
375 case MC_COUNTER_SUBSECTION:
376 maxcounter_ = LABEL_COUNTER_SUBSECTION;
378 case MC_COUNTER_SUBSUBSECTION:
379 maxcounter_ = LABEL_COUNTER_SUBSUBSECTION;
381 case MC_COUNTER_PARAGRAPH:
382 maxcounter_ = LABEL_COUNTER_PARAGRAPH;
384 case MC_COUNTER_SUBPARAGRAPH:
385 maxcounter_ = LABEL_COUNTER_SUBPARAGRAPH;
387 case MC_COUNTER_ENUMI:
388 maxcounter_ = LABEL_COUNTER_ENUMI;
390 case MC_COUNTER_ENUMII:
391 maxcounter_ = LABEL_COUNTER_ENUMII;
393 case MC_COUNTER_ENUMIII:
394 maxcounter_ = LABEL_COUNTER_ENUMIII;
396 case MC_COUNTER_ENUMIV:
397 maxcounter_ = LABEL_COUNTER_ENUMIV;
403 enum ClassOptionsTags {
411 void LyXTextClass::readClassOptions(LyXLex & lexrc)
413 keyword_item classOptionsTags[] = {
415 {"fontsize", CO_FONTSIZE },
416 {"other", CO_OTHER },
417 {"pagestyle", CO_PAGESTYLE }
420 lexrc.pushTable(classOptionsTags, CO_END);
422 while (!getout && lexrc.isOK()) {
423 int le = lexrc.lex();
425 case LyXLex::LEX_UNDEF:
426 lexrc.printError("Unknown ClassOption tag `$$Token'");
430 switch (static_cast<ClassOptionsTags>(le)) {
433 opt_fontsize_ = strip(lexrc.getString());
437 opt_pagestyle_ = strip(lexrc.getString());
441 options_ = lexrc.getString();
452 LyXFont const & LyXTextClass::defaultfont() const
458 string const & LyXTextClass::leftmargin() const
464 string const & LyXTextClass::rightmargin() const
470 bool LyXTextClass::hasLayout(string const & name) const
472 return find_if(layoutlist.begin(), layoutlist.end(),
473 lyx::compare_memfun(&LyXLayout::name, name))
478 LyXLayout const & LyXTextClass::GetLayout (string const & name) const
480 LayoutList::const_iterator cit =
481 find_if(layoutlist.begin(),
483 lyx::compare_memfun(&LyXLayout::name, name));
484 lyx::Assert(cit != layoutlist.end()); // we require the name to exist
489 LyXLayout & LyXTextClass::GetLayout(string const & name)
491 LayoutList::iterator it =
492 find_if(layoutlist.begin(),
494 lyx::compare_memfun(&LyXLayout::name, name));
495 lyx::Assert(it != layoutlist.end()); // we require the name to exist
500 bool LyXTextClass::delete_layout(string const & name)
502 LayoutList::iterator it =
503 remove_if(layoutlist.begin(), layoutlist.end(),
504 lyx::compare_memfun(&LyXLayout::name, name));
505 LayoutList::iterator end = layoutlist.end();
506 bool const ret = (it != end);
507 layoutlist.erase(it, end);
512 // Load textclass info if not loaded yet
513 void LyXTextClass::load()
518 string const real_file = LibFileSearch("layouts", name_, "layout");
520 if (Read(real_file)) {
521 lyxerr << "Error reading `"
522 << MakeDisplayPath(real_file)
523 << "'\n(Check `" << name_
524 << "')\nCheck your installation and "
525 "try Options/Reconfigure..." << endl;
531 std::ostream & operator<<(std::ostream & os, LyXTextClass::PageSides p)
534 case LyXTextClass::OneSide:
537 case LyXTextClass::TwoSides: