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"
34 /* ******************************************************************* */
36 LyXTextClass::LyXTextClass(string const & fn, string const & cln,
38 : name_(fn), latexname_(cln), description_(desc)
45 pagestyle_ = "default";
46 maxcounter_ = LABEL_COUNTER_CHAPTER;
47 defaultfont_ = LyXFont(LyXFont::ALL_SANE);
48 opt_fontsize_ = "10|11|12";
49 opt_pagestyle_ = "empty|plain|headings|fancy";
55 bool LyXTextClass::do_readStyle(LyXLex & lexrc, LyXLayout & lay)
57 lyxerr[Debug::TCLASS] << "Reading style " << lay.name() << endl;
58 if (!lay.Read(lexrc, *this)) {
60 lay.resfont = lay.font;
61 #ifndef INHERIT_LANGUAGE
62 lay.resfont.realize(defaultfont());
63 lay.reslabelfont = lay.labelfont;
64 lay.reslabelfont.realize(defaultfont());
66 lay.resfont.realize(defaultfont(), default_language);
67 lay.reslabelfont = lay.labelfont;
68 lay.reslabelfont.realize(defaultfont(), default_language);
70 return false; // no errors
72 lyxerr << "Error parsing style `" << lay.name() << "'" << endl;
99 // Reads a textclass structure from file.
100 bool LyXTextClass::Read(string const & filename, bool merge)
102 keyword_item textClassTags[] = {
103 { "classoptions", TC_CLASSOPTIONS },
104 { "columns", TC_COLUMNS },
105 { "defaultfont", TC_DEFAULTFONT },
106 { "input", TC_INPUT },
107 { "leftmargin", TC_LEFTMARGIN },
108 { "maxcounter", TC_MAXCOUNTER },
109 { "nostyle", TC_NOSTYLE },
110 { "outputtype", TC_OUTPUTTYPE },
111 { "pagestyle", TC_PAGESTYLE },
112 { "preamble", TC_PREAMBLE },
113 { "providesamsmath", TC_PROVIDESAMSMATH },
114 { "providesmakeidx", TC_PROVIDESMAKEIDX },
115 { "providesurl", TC_PROVIDESURL },
116 { "rightmargin", TC_RIGHTMARGIN },
117 { "secnumdepth", TC_SECNUMDEPTH },
118 { "sides", TC_SIDES },
119 { "style", TC_STYLE },
120 { "tocdepth", TC_TOCDEPTH }
124 lyxerr[Debug::TCLASS] << "Reading textclass "
125 << MakeDisplayPath(filename)
128 lyxerr[Debug::TCLASS] << "Reading input file "
129 << MakeDisplayPath(filename)
132 LyXLex lexrc(textClassTags, TC_RIGHTMARGIN);
135 lexrc.setFile(filename);
136 if (!lexrc.isOK()) error = true;
139 while (lexrc.isOK() && !error) {
140 int le = lexrc.lex();
142 case LyXLex::LEX_FEOF:
145 case LyXLex::LEX_UNDEF:
146 lexrc.printError("Unknown TextClass tag `$$Token'");
151 switch (static_cast<TextClassTags>(le)) {
152 case TC_OUTPUTTYPE: // output type definition
153 readOutputType(lexrc);
156 case TC_INPUT: // Include file
158 string tmp = LibFileSearch("layouts",
162 if (Read(tmp, true)) {
163 lexrc.printError("Error reading input"
172 string name = subst(lexrc.getString(),
174 if (hasLayout(name)) {
175 LyXLayout & lay = GetLayout(name);
176 error = do_readStyle(lexrc, lay);
180 if (!(error = do_readStyle(lexrc, lay)))
181 layoutlist.push_back(lay);
185 lexrc.printError("No name given for style: `$$Token'.");
192 string const style = subst(lexrc.getString(),
194 if (!delete_layout(style))
195 lexrc.printError("Cannot delete style"
202 columns_ = lexrc.getInteger();
207 switch (lexrc.getInteger()) {
208 case 1: sides_ = OneSide; break;
209 case 2: sides_ = TwoSides; break;
211 lyxerr << "Impossible number of page"
212 " sides, setting to one."
222 pagestyle_ = strip(lexrc.getString());
226 defaultfont_.lyxRead(lexrc);
227 if (!defaultfont_.resolved()) {
228 lexrc.printError("Warning: defaultfont should "
229 "be fully instantiated!");
230 #ifndef INHERIT_LANGUAGE
231 defaultfont_.realize(LyXFont(LyXFont::ALL_SANE));
233 defaultfont_.realize(LyXFont(LyXFont::ALL_SANE),
240 readMaxCounter(lexrc);
245 secnumdepth_ = lexrc.getInteger();
250 tocdepth_ = lexrc.getInteger();
253 // First step to support options
254 case TC_CLASSOPTIONS:
255 readClassOptions(lexrc);
259 preamble_ = lexrc.getLongString("EndPreamble");
262 case TC_PROVIDESAMSMATH:
263 if (lexrc.next() && lexrc.getInteger())
264 provides_ |= amsmath;
267 case TC_PROVIDESMAKEIDX:
268 if (lexrc.next() && lexrc.getInteger())
269 provides_ |= makeidx;
273 if (lexrc.next() && lexrc.getInteger())
277 case TC_LEFTMARGIN: // left margin type
279 leftmargin_ = lexrc.getString();
282 case TC_RIGHTMARGIN: // right margin type
284 rightmargin_ = lexrc.getString();
289 if (!merge) { // we are at top level here.
290 lyxerr[Debug::TCLASS] << "Finished reading textclass "
291 << MakeDisplayPath(filename)
294 lyxerr[Debug::TCLASS] << "Finished reading input file "
295 << MakeDisplayPath(filename)
302 void LyXTextClass::readOutputType(LyXLex & lexrc)
304 keyword_item outputTypeTags[] = {
305 { "docbook", DOCBOOK },
307 { "linuxdoc", LINUXDOC },
308 { "literate", LITERATE }
311 pushpophelper pph(lexrc, outputTypeTags, LITERATE);
313 int le = lexrc.lex();
315 case LyXLex::LEX_UNDEF:
316 lexrc.printError("Unknown output type `$$Token'");
322 outputType_ = static_cast<OutputType>(le);
325 lyxerr << "Unhandled value " << le
326 << " in LyXTextClass::readOutputType." << endl;
333 enum MaxCounterTags {
334 MC_COUNTER_CHAPTER = 1,
336 MC_COUNTER_SUBSECTION,
337 MC_COUNTER_SUBSUBSECTION,
338 MC_COUNTER_PARAGRAPH,
339 MC_COUNTER_SUBPARAGRAPH,
347 void LyXTextClass::readMaxCounter(LyXLex & lexrc)
349 keyword_item maxCounterTags[] = {
350 {"counter_chapter", MC_COUNTER_CHAPTER },
351 {"counter_enumi", MC_COUNTER_ENUMI },
352 {"counter_enumii", MC_COUNTER_ENUMII },
353 {"counter_enumiii", MC_COUNTER_ENUMIII },
354 {"counter_enumiv", MC_COUNTER_ENUMIV },
355 {"counter_paragraph", MC_COUNTER_PARAGRAPH },
356 {"counter_section", MC_COUNTER_SECTION },
357 {"counter_subparagraph", MC_COUNTER_SUBPARAGRAPH },
358 {"counter_subsection", MC_COUNTER_SUBSECTION },
359 {"counter_subsubsection", MC_COUNTER_SUBSUBSECTION }
362 pushpophelper pph(lexrc, maxCounterTags, MC_COUNTER_ENUMIV);
363 int le = lexrc.lex();
365 case LyXLex::LEX_UNDEF:
366 lexrc.printError("Unknown MaxCounter tag `$$Token'");
370 switch (static_cast<MaxCounterTags>(le)) {
371 case MC_COUNTER_CHAPTER:
372 maxcounter_ = LABEL_COUNTER_CHAPTER;
374 case MC_COUNTER_SECTION:
375 maxcounter_ = LABEL_COUNTER_SECTION;
377 case MC_COUNTER_SUBSECTION:
378 maxcounter_ = LABEL_COUNTER_SUBSECTION;
380 case MC_COUNTER_SUBSUBSECTION:
381 maxcounter_ = LABEL_COUNTER_SUBSUBSECTION;
383 case MC_COUNTER_PARAGRAPH:
384 maxcounter_ = LABEL_COUNTER_PARAGRAPH;
386 case MC_COUNTER_SUBPARAGRAPH:
387 maxcounter_ = LABEL_COUNTER_SUBPARAGRAPH;
389 case MC_COUNTER_ENUMI:
390 maxcounter_ = LABEL_COUNTER_ENUMI;
392 case MC_COUNTER_ENUMII:
393 maxcounter_ = LABEL_COUNTER_ENUMII;
395 case MC_COUNTER_ENUMIII:
396 maxcounter_ = LABEL_COUNTER_ENUMIII;
398 case MC_COUNTER_ENUMIV:
399 maxcounter_ = LABEL_COUNTER_ENUMIV;
405 enum ClassOptionsTags {
413 void LyXTextClass::readClassOptions(LyXLex & lexrc)
415 keyword_item classOptionsTags[] = {
417 {"fontsize", CO_FONTSIZE },
418 {"other", CO_OTHER },
419 {"pagestyle", CO_PAGESTYLE }
422 lexrc.pushTable(classOptionsTags, CO_END);
424 while (!getout && lexrc.isOK()) {
425 int le = lexrc.lex();
427 case LyXLex::LEX_UNDEF:
428 lexrc.printError("Unknown ClassOption tag `$$Token'");
432 switch (static_cast<ClassOptionsTags>(le)) {
435 opt_fontsize_ = strip(lexrc.getString());
439 opt_pagestyle_ = strip(lexrc.getString());
443 options_ = lexrc.getString();
454 LyXFont const & LyXTextClass::defaultfont() const
460 string const & LyXTextClass::leftmargin() const
466 string const & LyXTextClass::rightmargin() const
472 bool LyXTextClass::hasLayout(string const & name) const
474 return find_if(layoutlist.begin(), layoutlist.end(),
475 lyx::compare_memfun(&LyXLayout::name, name))
480 LyXLayout const & LyXTextClass::GetLayout (string const & name) const
482 LayoutList::const_iterator cit =
483 find_if(layoutlist.begin(),
485 lyx::compare_memfun(&LyXLayout::name, name));
486 lyx::Assert(cit != layoutlist.end()); // we require the name to exist
491 LyXLayout & LyXTextClass::GetLayout(string const & name)
493 LayoutList::iterator it =
494 find_if(layoutlist.begin(),
496 lyx::compare_memfun(&LyXLayout::name, name));
497 lyx::Assert(it != layoutlist.end()); // we require the name to exist
502 bool LyXTextClass::delete_layout(string const & name)
504 LayoutList::iterator it =
505 remove_if(layoutlist.begin(), layoutlist.end(),
506 lyx::compare_memfun(&LyXLayout::name, name));
507 LayoutList::iterator end = layoutlist.end();
508 bool const ret = (it != end);
509 layoutlist.erase(it, end);
514 // Load textclass info if not loaded yet
515 void LyXTextClass::load()
520 string const real_file = LibFileSearch("layouts", name_, "layout");
522 if (Read(real_file)) {
523 lyxerr << "Error reading `"
524 << MakeDisplayPath(real_file)
525 << "'\n(Check `" << name_
526 << "')\nCheck your installation and "
527 "try Options/Reconfigure..." << endl;
533 std::ostream & operator<<(std::ostream & os, LyXTextClass::PageSides p)
536 case LyXTextClass::OneSide:
539 case LyXTextClass::TwoSides: