src/TextClass.cpp

   1 /**
   2  * \file TextClass.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Jean-Marc Lasgouttes
   8  * \author Angus Leeming
   9  * \author John Levon
  10  * \author André Pönitz
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #include <config.h>
  16
  17 #include "TextClass.h"
  18 #include "debug.h"
  19 #include "Lexer.h"
  20 #include "Counters.h"
  21 #include "gettext.h"
  22 #include "Floating.h"
  23 #include "FloatList.h"
  24
  25 #include "frontends/alert.h"
  26
  27 #include "support/lstrings.h"
  28 #include "support/lyxlib.h"
  29 #include "support/filetools.h"
  30 #include "support/os.h"
  31
  32 #include <boost/filesystem/operations.hpp>
  33 namespace fs = boost::filesystem;
  34
  35 #include <sstream>
  36
  37
  38 namespace lyx {
  39
  40 using support::FileName;
  41 using support::libFileSearch;
  42 using support::makeDisplayPath;
  43 using support::quoteName;
  44 using support::rtrim;
  45 using support::subst;
  46 using support::addName;
  47
  48 using std::endl;
  49 using std::find_if;
  50 using std::remove_if;
  51 using std::string;
  52 using std::ostream;
  53
  54
  55 namespace {
  56
  57 class LayoutNamesEqual : public std::unary_function<LayoutPtr, bool> {
  58 public:
  59         LayoutNamesEqual(docstring const & name)
  60                 : name_(name)
  61         {}
  62         bool operator()(LayoutPtr const & c) const
  63         {
  64                 return c->name() == name_;
  65         }
  66 private:
  67         docstring name_;
  68 };
  69
  70
  71 int const FORMAT = 5;
  72
  73
  74 bool layout2layout(FileName const & filename, FileName const & tempfile)
  75 {
  76         FileName const script = libFileSearch("scripts", "layout2layout.py");
  77         if (script.empty()) {
  78                 lyxerr << "Could not find layout conversion "
  79                           "script layout2layout.py." << endl;
  80                 return false;
  81         }
  82
  83         std::ostringstream command;
  84         command << support::os::python() << ' ' << quoteName(script.toFilesystemEncoding())
  85                 << ' ' << quoteName(filename.toFilesystemEncoding())
  86                 << ' ' << quoteName(tempfile.toFilesystemEncoding());
  87         string const command_str = command.str();
  88
  89         LYXERR(Debug::TCLASS) << "Running `" << command_str << '\'' << endl;
  90
  91         support::cmd_ret const ret =
  92                 support::runCommand(command_str);
  93         if (ret.first != 0) {
  94                 lyxerr << "Could not run layout conversion "
  95                           "script layout2layout.py." << endl;
  96                 return false;
  97         }
  98         return true;
  99 }
 100
 101 } // namespace anon
 102
 103
 104 TextClass::TextClass(string const & fn, string const & cln,
 105                            string const & desc, bool texClassAvail )
 106         : name_(fn), latexname_(cln), description_(desc),
 107           floatlist_(new FloatList), counters_(new Counters),
 108           texClassAvail_(texClassAvail)
 109 {
 110         outputType_ = LATEX;
 111         columns_ = 1;
 112         sides_ = OneSide;
 113         secnumdepth_ = 3;
 114         tocdepth_ = 3;
 115         pagestyle_ = "default";
 116         defaultfont_ = Font(Font::ALL_SANE);
 117         opt_fontsize_ = "10|11|12";
 118         opt_pagestyle_ = "empty|plain|headings|fancy";
 119         titletype_ = TITLE_COMMAND_AFTER;
 120         titlename_ = "maketitle";
 121         loaded_ = false;
 122 }
 123
 124
 125 bool TextClass::isTeXClassAvailable() const
 126 {
 127         return texClassAvail_;
 128 }
 129
 130
 131 bool TextClass::do_readStyle(Lexer & lexrc, Layout & lay)
 132 {
 133         LYXERR(Debug::TCLASS) << "Reading style " << to_utf8(lay.name()) << endl;
 134         if (!lay.read(lexrc, *this)) {
 135                 // Resolve fonts
 136                 lay.resfont = lay.font;
 137                 lay.resfont.realize(defaultfont());
 138                 lay.reslabelfont = lay.labelfont;
 139                 lay.reslabelfont.realize(defaultfont());
 140                 return false; // no errors
 141         }
 142         lyxerr << "Error parsing style `" << to_utf8(lay.name()) << '\'' << endl;
 143         return true;
 144 }
 145
 146
 147 enum TextClassTags {
 148         TC_OUTPUTTYPE = 1,
 149         TC_INPUT,
 150         TC_STYLE,
 151         TC_DEFAULTSTYLE,
 152         TC_INSETLAYOUT,
 153         TC_ENVIRONMENT,
 154         TC_NOSTYLE,
 155         TC_COLUMNS,
 156         TC_SIDES,
 157         TC_PAGESTYLE,
 158         TC_DEFAULTFONT,
 159         TC_SECNUMDEPTH,
 160         TC_TOCDEPTH,
 161         TC_CLASSOPTIONS,
 162         TC_PREAMBLE,
 163         TC_PROVIDES,
 164         TC_LEFTMARGIN,
 165         TC_RIGHTMARGIN,
 166         TC_FLOAT,
 167         TC_COUNTER,
 168         TC_NOFLOAT,
 169         TC_TITLELATEXNAME,
 170         TC_TITLELATEXTYPE,
 171         TC_FORMAT
 172 };
 173
 174
 175 // Reads a textclass structure from file.
 176 bool TextClass::read(FileName const & filename, bool merge)
 177 {
 178         if (!support::isFileReadable(filename)) {
 179                 lyxerr << "Cannot read layout file `" << filename << "'."
 180                        << endl;
 181                 return true;
 182         }
 183
 184         keyword_item textClassTags[] = {
 185                 { "classoptions",    TC_CLASSOPTIONS },
 186                 { "columns",         TC_COLUMNS },
 187                 { "counter",         TC_COUNTER },
 188                 { "defaultfont",     TC_DEFAULTFONT },
 189                 { "defaultstyle",    TC_DEFAULTSTYLE },
 190                 { "environment",     TC_ENVIRONMENT },
 191                 { "float",           TC_FLOAT },
 192                 { "format",          TC_FORMAT },
 193                 { "input",           TC_INPUT },
 194                 { "insetlayout",     TC_INSETLAYOUT },
 195                 { "leftmargin",      TC_LEFTMARGIN },
 196                 { "nofloat",         TC_NOFLOAT },
 197                 { "nostyle",         TC_NOSTYLE },
 198                 { "outputtype",      TC_OUTPUTTYPE },
 199                 { "pagestyle",       TC_PAGESTYLE },
 200                 { "preamble",        TC_PREAMBLE },
 201                 { "provides",        TC_PROVIDES },
 202                 { "rightmargin",     TC_RIGHTMARGIN },
 203                 { "secnumdepth",     TC_SECNUMDEPTH },
 204                 { "sides",           TC_SIDES },
 205                 { "style",           TC_STYLE },
 206                 { "titlelatexname",  TC_TITLELATEXNAME },
 207                 { "titlelatextype",  TC_TITLELATEXTYPE },
 208                 { "tocdepth",        TC_TOCDEPTH }
 209         };
 210
 211         if (!merge)
 212                 LYXERR(Debug::TCLASS) << "Reading textclass "
 213                                       << to_utf8(makeDisplayPath(filename.absFilename()))
 214                                       << endl;
 215         else
 216                 LYXERR(Debug::TCLASS) << "Reading input file "
 217                                       << to_utf8(makeDisplayPath(filename.absFilename()))
 218                                       << endl;
 219
 220         Lexer lexrc(textClassTags,
 221                 sizeof(textClassTags) / sizeof(textClassTags[0]));
 222
 223         lexrc.setFile(filename);
 224         bool error = !lexrc.isOK();
 225
 226         // Format of files before the 'Format' tag was introduced
 227         int format = 1;
 228
 229         // parsing
 230         while (lexrc.isOK() && !error) {
 231                 int le = lexrc.lex();
 232
 233                 switch (le) {
 234                 case Lexer::LEX_FEOF:
 235                         continue;
 236
 237                 case Lexer::LEX_UNDEF:
 238                         lexrc.printError("Unknown TextClass tag `$$Token'");
 239                         error = true;
 240                         continue;
 241
 242                 default:
 243                         break;
 244                 }
 245
 246                 switch (static_cast<TextClassTags>(le)) {
 247
 248                 case TC_FORMAT:
 249                         if (lexrc.next())
 250                                 format = lexrc.getInteger();
 251                         break;
 252
 253                 case TC_OUTPUTTYPE:   // output type definition
 254                         readOutputType(lexrc);
 255                         break;
 256
 257                 case TC_INPUT: // Include file
 258                         if (lexrc.next()) {
 259                                 string const inc = lexrc.getString();
 260                                 FileName tmp = libFileSearch("layouts", inc,
 261                                                             "layout");
 262
 263                                 if (tmp.empty()) {
 264                                         lexrc.printError("Could not find input"
 265                                                          "file: " + inc);
 266                                         error = true;
 267                                 } else if (read(tmp, true)) {
 268                                         lexrc.printError("Error reading input"
 269                                                          "file: " + tmp.absFilename());
 270                                         error = true;
 271                                 }
 272                         }
 273                         break;
 274
 275                 case TC_DEFAULTSTYLE:
 276                         if (lexrc.next()) {
 277                                 docstring const name = from_utf8(subst(lexrc.getString(),
 278                                                           '_', ' '));
 279                                 defaultlayout_ = name;
 280                         }
 281                         break;
 282
 283                 case TC_ENVIRONMENT:
 284                 case TC_STYLE:
 285                         if (lexrc.next()) {
 286                                 docstring const name = from_utf8(subst(lexrc.getString(),
 287                                                     '_', ' '));
 288                                 if (name.empty()) {
 289                                         string s = "Could not read name for style: `$$Token' "
 290                                                 + lexrc.getString() + " is probably not valid UTF-8!";
 291                                         lexrc.printError(s.c_str());
 292                                         Layout lay;
 293                                         error = do_readStyle(lexrc, lay);
 294                                 } else if (hasLayout(name)) {
 295                                         Layout * lay = operator[](name).get();
 296                                         error = do_readStyle(lexrc, *lay);
 297                                 } else {
 298                                         Layout lay;
 299                                         lay.setName(name);
 300                                         if (le == TC_ENVIRONMENT)
 301                                                 lay.is_environment = true;
 302                                         error = do_readStyle(lexrc, lay);
 303                                         if (!error)
 304                                                 layoutlist_.push_back(
 305                                                         boost::shared_ptr<Layout>(new Layout(lay))
 306                                                         );
 307
 308                                         if (defaultlayout_.empty()) {
 309                                                 // We do not have a default
 310                                                 // layout yet, so we choose
 311                                                 // the first layout we
 312                                                 // encounter.
 313                                                 defaultlayout_ = name;
 314                                         }
 315                                 }
 316                         }
 317                         else {
 318                                 lexrc.printError("No name given for style: `$$Token'.");
 319                                 error = true;
 320                         }
 321                         break;
 322
 323                 case TC_NOSTYLE:
 324                         if (lexrc.next()) {
 325                                 docstring const style = from_utf8(subst(lexrc.getString(),
 326                                                      '_', ' '));
 327                                 if (!delete_layout(style))
 328                                         lyxerr << "Cannot delete style `"
 329                                                << to_utf8(style) << '\'' << endl;
 330 //                                      lexrc.printError("Cannot delete style"
 331 //                                                       " `$$Token'");
 332                         }
 333                         break;
 334
 335                 case TC_COLUMNS:
 336                         if (lexrc.next())
 337                                 columns_ = lexrc.getInteger();
 338                         break;
 339
 340                 case TC_SIDES:
 341                         if (lexrc.next()) {
 342                                 switch (lexrc.getInteger()) {
 343                                 case 1: sides_ = OneSide; break;
 344                                 case 2: sides_ = TwoSides; break;
 345                                 default:
 346                                         lyxerr << "Impossible number of page"
 347                                                 " sides, setting to one."
 348                                                << endl;
 349                                         sides_ = OneSide;
 350                                         break;
 351                                 }
 352                         }
 353                         break;
 354
 355                 case TC_PAGESTYLE:
 356                         lexrc.next();
 357                         pagestyle_ = rtrim(lexrc.getString());
 358                         break;
 359
 360                 case TC_DEFAULTFONT:
 361                         defaultfont_.lyxRead(lexrc);
 362                         if (!defaultfont_.resolved()) {
 363                                 lexrc.printError("Warning: defaultfont should "
 364                                                  "be fully instantiated!");
 365                                 defaultfont_.realize(Font(Font::ALL_SANE));
 366                         }
 367                         break;
 368
 369                 case TC_SECNUMDEPTH:
 370                         lexrc.next();
 371                         secnumdepth_ = lexrc.getInteger();
 372                         break;
 373
 374                 case TC_TOCDEPTH:
 375                         lexrc.next();
 376                         tocdepth_ = lexrc.getInteger();
 377                         break;
 378
 379                         // First step to support options
 380                 case TC_CLASSOPTIONS:
 381                         readClassOptions(lexrc);
 382                         break;
 383
 384                 case TC_PREAMBLE:
 385                         preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
 386                         break;
 387
 388                 case TC_PROVIDES: {
 389                         lexrc.next();
 390                         string const feature = lexrc.getString();
 391                         lexrc.next();
 392                         if (lexrc.getInteger())
 393                                 provides_.insert(feature);
 394                         else
 395                                 provides_.erase(feature);
 396                         break;
 397                 }
 398
 399                 case TC_LEFTMARGIN:     // left margin type
 400                         if (lexrc.next())
 401                                 leftmargin_ = lexrc.getDocString();
 402                         break;
 403
 404                 case TC_RIGHTMARGIN:    // right margin type
 405                         if (lexrc.next())
 406                                 rightmargin_ = lexrc.getDocString();
 407                         break;
 408                 case TC_INSETLAYOUT:
 409                         if (lexrc.next()) {
 410                                 docstring const name = subst(lexrc.getDocString(), '_', ' ');
 411                                 readInsetLayout(lexrc, name);
 412                         }
 413                         break;
 414                 case TC_FLOAT:
 415                         readFloat(lexrc);
 416                         break;
 417                 case TC_COUNTER:
 418                         readCounter(lexrc);
 419                         break;
 420                 case TC_TITLELATEXTYPE:
 421                         readTitleType(lexrc);
 422                         break;
 423                 case TC_TITLELATEXNAME:
 424                         if (lexrc.next())
 425                                 titlename_ = lexrc.getString();
 426                         break;
 427                 case TC_NOFLOAT:
 428                         if (lexrc.next()) {
 429                                 string const nofloat = lexrc.getString();
 430                                 floatlist_->erase(nofloat);
 431                         }
 432                         break;
 433                 }
 434                 if (format != FORMAT)
 435                         break;
 436         }
 437
 438         if (format != FORMAT) {
 439                 LYXERR(Debug::TCLASS) << "Converting layout file from format "
 440                                       << format << " to " << FORMAT << endl;
 441                 FileName const tempfile(support::tempName());
 442                 error = !layout2layout(filename, tempfile);
 443                 if (!error)
 444                         error = read(tempfile, merge);
 445                 support::unlink(tempfile);
 446                 return error;
 447         }
 448
 449         if (!merge) { // we are at top level here.
 450                 LYXERR(Debug::TCLASS) << "Finished reading textclass "
 451                                       << to_utf8(makeDisplayPath(filename.absFilename()))
 452                                       << endl;
 453                 if (defaultlayout_.empty()) {
 454                         lyxerr << "Error: Textclass '" << name_
 455                                << "' is missing a defaultstyle." << endl;
 456                         error = true;
 457                 }
 458
 459                 min_toclevel_ = Layout::NOT_IN_TOC;
 460                 max_toclevel_ = Layout::NOT_IN_TOC;
 461                 const_iterator cit = begin();
 462                 const_iterator the_end = end();
 463                 for ( ; cit != the_end ; ++cit) {
 464                         int const toclevel = (*cit)->toclevel;
 465                         if (toclevel != Layout::NOT_IN_TOC) {
 466                                 if (min_toclevel_ == Layout::NOT_IN_TOC)
 467                                         min_toclevel_ = toclevel;
 468                                 else
 469                                         min_toclevel_ = std::min(min_toclevel_,
 470                                                          toclevel);
 471                                 max_toclevel_ = std::max(max_toclevel_,
 472                                                          toclevel);
 473                         }
 474                 }
 475                 LYXERR(Debug::TCLASS)
 476                         << "Minimum TocLevel is " << min_toclevel_
 477                         << ", maximum is " << max_toclevel_ <<endl;
 478
 479         } else
 480                 LYXERR(Debug::TCLASS) << "Finished reading input file "
 481                                       << to_utf8(makeDisplayPath(filename.absFilename()))
 482                                       << endl;
 483
 484         return error;
 485 }
 486
 487
 488 void TextClass::readTitleType(Lexer & lexrc)
 489 {
 490         keyword_item titleTypeTags[] = {
 491                 { "commandafter", TITLE_COMMAND_AFTER },
 492                 { "environment", TITLE_ENVIRONMENT }
 493         };
 494
 495         PushPopHelper pph(lexrc, titleTypeTags, TITLE_ENVIRONMENT);
 496
 497         int le = lexrc.lex();
 498         switch (le) {
 499         case Lexer::LEX_UNDEF:
 500                 lexrc.printError("Unknown output type `$$Token'");
 501                 return;
 502         case TITLE_COMMAND_AFTER:
 503         case TITLE_ENVIRONMENT:
 504                 titletype_ = static_cast<LYX_TITLE_LATEX_TYPES>(le);
 505                 break;
 506         default:
 507                 lyxerr << "Unhandled value " << le
 508                        << " in TextClass::readTitleType." << endl;
 509
 510                 break;
 511         }
 512 }
 513
 514
 515 void TextClass::readOutputType(Lexer & lexrc)
 516 {
 517         keyword_item outputTypeTags[] = {
 518                 { "docbook", DOCBOOK },
 519                 { "latex", LATEX },
 520                 { "literate", LITERATE }
 521         };
 522
 523         PushPopHelper pph(lexrc, outputTypeTags, LITERATE);
 524
 525         int le = lexrc.lex();
 526         switch (le) {
 527         case Lexer::LEX_UNDEF:
 528                 lexrc.printError("Unknown output type `$$Token'");
 529                 return;
 530         case LATEX:
 531         case DOCBOOK:
 532         case LITERATE:
 533                 outputType_ = static_cast<OutputType>(le);
 534                 break;
 535         default:
 536                 lyxerr << "Unhandled value " << le
 537                        << " in TextClass::readOutputType." << endl;
 538
 539                 break;
 540         }
 541 }
 542
 543
 544 enum ClassOptionsTags {
 545         CO_FONTSIZE = 1,
 546         CO_PAGESTYLE,
 547         CO_OTHER,
 548         CO_HEADER,
 549         CO_END
 550 };
 551
 552
 553 void TextClass::readClassOptions(Lexer & lexrc)
 554 {
 555         keyword_item classOptionsTags[] = {
 556                 {"end", CO_END },
 557                 {"fontsize", CO_FONTSIZE },
 558                 {"header", CO_HEADER },
 559                 {"other", CO_OTHER },
 560                 {"pagestyle", CO_PAGESTYLE }
 561         };
 562
 563         lexrc.pushTable(classOptionsTags, CO_END);
 564         bool getout = false;
 565         while (!getout && lexrc.isOK()) {
 566                 int le = lexrc.lex();
 567                 switch (le) {
 568                 case Lexer::LEX_UNDEF:
 569                         lexrc.printError("Unknown ClassOption tag `$$Token'");
 570                         continue;
 571                 default: break;
 572                 }
 573                 switch (static_cast<ClassOptionsTags>(le)) {
 574                 case CO_FONTSIZE:
 575                         lexrc.next();
 576                         opt_fontsize_ = rtrim(lexrc.getString());
 577                         break;
 578                 case CO_PAGESTYLE:
 579                         lexrc.next();
 580                         opt_pagestyle_ = rtrim(lexrc.getString());
 581                         break;
 582                 case CO_OTHER:
 583                         lexrc.next();
 584                         options_ = lexrc.getString();
 585                         break;
 586                 case CO_HEADER:
 587                         lexrc.next();
 588                         class_header_ = subst(lexrc.getString(), "&quot;", "\"");
 589                         break;
 590                 case CO_END:
 591                         getout = true;
 592                         break;
 593                 }
 594         }
 595         lexrc.popTable();
 596 }
 597
 598
 599 enum InsetLayoutTags {
 600         IL_FONT = 1,
 601         IL_DECORATION,
 602         IL_LABELFONT,
 603         IL_LABELSTRING,
 604         IL_LATEXNAME,
 605         IL_LATEXPARAM,
 606         IL_LATEXTYPE,
 607         IL_LYXTYPE,
 608         IL_PREAMBLE,
 609         IL_END
 610 };
 611
 612
 613 void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
 614 {
 615         keyword_item elementTags[] = {
 616                 { "decoration", IL_DECORATION },
 617                 { "end", IL_END },
 618                 { "font", IL_FONT },
 619                 { "labelfont", IL_LABELFONT },
 620                 { "labelstring", IL_LABELSTRING },
 621                 { "latexname", IL_LATEXNAME },
 622                 { "latexparam", IL_LATEXPARAM },
 623                 { "latextype", IL_LATEXTYPE },
 624                 { "lyxtype", IL_LYXTYPE },
 625                 { "preamble", IL_PREAMBLE }
 626         };
 627
 628         lexrc.pushTable(elementTags, IL_END);
 629
 630         string lyxtype;
 631         docstring labelstring;
 632         string latextype;
 633         string decoration;
 634         string latexname;
 635         string latexparam;
 636         Font font(Font::ALL_INHERIT);
 637         Font labelfont(Font::ALL_INHERIT);
 638         string preamble;
 639
 640         bool getout = false;
 641         while (!getout && lexrc.isOK()) {
 642                 int le = lexrc.lex();
 643                 switch (le) {
 644                 case Lexer::LEX_UNDEF:
 645                         lexrc.printError("Unknown ClassOption tag `$$Token'");
 646                         continue;
 647                 default: break;
 648                 }
 649                 switch (static_cast<InsetLayoutTags>(le)) {
 650                 case IL_LYXTYPE:
 651                         lexrc.next();
 652                         lyxtype = lexrc.getString();
 653                         break;
 654                 case IL_LATEXTYPE:
 655                         lexrc.next();
 656                         latextype = lexrc.getString();
 657                         break;
 658                 case IL_LABELSTRING:
 659                         lexrc.next();
 660                         labelstring = lexrc.getDocString();
 661                         break;
 662                 case IL_DECORATION:
 663                         lexrc.next();
 664                         decoration = lexrc.getString();
 665                         break;
 666                 case IL_LATEXNAME:
 667                         lexrc.next();
 668                         latexname = lexrc.getString();
 669                         break;
 670                 case IL_LATEXPARAM:
 671                         lexrc.next();
 672                         latexparam = subst(lexrc.getString(), "&quot;", "\"");
 673                         break;
 674                 case IL_LABELFONT:
 675                         labelfont.lyxRead(lexrc);
 676                         labelfont.realize(defaultfont());
 677                         break;
 678                 case IL_FONT:
 679                         font.lyxRead(lexrc);
 680                         font.realize(defaultfont());
 681                         labelfont = font;
 682                         break;
 683                 case IL_PREAMBLE:
 684                         preamble = lexrc.getLongString("EndPreamble");
 685                         break;
 686                 case IL_END:
 687                         getout = true;
 688                         break;
 689                 }
 690         }
 691
 692         //
 693         // Here add element to list if getout == true
 694         if (getout) {
 695                 InsetLayout il;
 696                 il.name = to_ascii(name);
 697                 il.lyxtype = lyxtype;
 698                 il.labelstring = labelstring;
 699                 il.decoration = decoration;
 700                 il.latextype = latextype;
 701                 il.latexname = latexname;
 702                 il.latexparam = latexparam;
 703                 il.font = font;
 704                 il.labelfont = labelfont;
 705                 il.preamble = preamble;
 706                 insetlayoutlist_[name] = il;
 707
 708                 // test name for CS:
 709                 if (il.lyxtype == "charstyle" || il.lyxtype == "custom") {
 710                         charstyles().push_back(il);
 711                 }
 712         }
 713
 714         lexrc.popTable();
 715 }
 716
 717
 718
 719 enum FloatTags {
 720         FT_TYPE = 1,
 721         FT_NAME,
 722         FT_PLACEMENT,
 723         FT_EXT,
 724         FT_WITHIN,
 725         FT_STYLE,
 726         FT_LISTNAME,
 727         FT_BUILTIN,
 728         FT_END
 729 };
 730
 731
 732 void TextClass::readFloat(Lexer & lexrc)
 733 {
 734         keyword_item floatTags[] = {
 735                 { "end", FT_END },
 736                 { "extension", FT_EXT },
 737                 { "guiname", FT_NAME },
 738                 { "latexbuiltin", FT_BUILTIN },
 739                 { "listname", FT_LISTNAME },
 740                 { "numberwithin", FT_WITHIN },
 741                 { "placement", FT_PLACEMENT },
 742                 { "style", FT_STYLE },
 743                 { "type", FT_TYPE }
 744         };
 745
 746         lexrc.pushTable(floatTags, FT_END);
 747
 748         string type;
 749         string placement;
 750         string ext;
 751         string within;
 752         string style;
 753         string name;
 754         string listName;
 755         bool builtin = false;
 756
 757         bool getout = false;
 758         while (!getout && lexrc.isOK()) {
 759                 int le = lexrc.lex();
 760                 switch (le) {
 761                 case Lexer::LEX_UNDEF:
 762                         lexrc.printError("Unknown ClassOption tag `$$Token'");
 763                         continue;
 764                 default: break;
 765                 }
 766                 switch (static_cast<FloatTags>(le)) {
 767                 case FT_TYPE:
 768                         lexrc.next();
 769                         type = lexrc.getString();
 770                         if (floatlist_->typeExist(type)) {
 771                                 Floating const & fl = floatlist_->getType(type);
 772                                 placement = fl.placement();
 773                                 ext = fl.ext();
 774                                 within = fl.within();
 775                                 style = fl.style();
 776                                 name = fl.name();
 777                                 listName = fl.listName();
 778                                 builtin = fl.builtin();
 779                         }
 780                         break;
 781                 case FT_NAME:
 782                         lexrc.next();
 783                         name = lexrc.getString();
 784                         break;
 785                 case FT_PLACEMENT:
 786                         lexrc.next();
 787                         placement = lexrc.getString();
 788                         break;
 789                 case FT_EXT:
 790                         lexrc.next();
 791                         ext = lexrc.getString();
 792                         break;
 793                 case FT_WITHIN:
 794                         lexrc.next();
 795                         within = lexrc.getString();
 796                         if (within == "none")
 797                                 within.erase();
 798                         break;
 799                 case FT_STYLE:
 800                         lexrc.next();
 801                         style = lexrc.getString();
 802                         break;
 803                 case FT_LISTNAME:
 804                         lexrc.next();
 805                         listName = lexrc.getString();
 806                         break;
 807                 case FT_BUILTIN:
 808                         lexrc.next();
 809                         builtin = lexrc.getBool();
 810                         break;
 811                 case FT_END:
 812                         getout = true;
 813                         break;
 814                 }
 815         }
 816
 817         // Here if have a full float if getout == true
 818         if (getout) {
 819                 Floating fl(type, placement, ext, within,
 820                             style, name, listName, builtin);
 821                 floatlist_->newFloat(fl);
 822                 // each float has its own counter
 823                 counters_->newCounter(from_ascii(type), from_ascii(within),
 824                                       docstring(), docstring());
 825         }
 826
 827         lexrc.popTable();
 828 }
 829
 830
 831 enum CounterTags {
 832         CT_NAME = 1,
 833         CT_WITHIN,
 834         CT_LABELSTRING,
 835         CT_LABELSTRING_APPENDIX,
 836         CT_END
 837 };
 838
 839 void TextClass::readCounter(Lexer & lexrc)
 840 {
 841         keyword_item counterTags[] = {
 842                 { "end", CT_END },
 843                 { "labelstring", CT_LABELSTRING },
 844                 { "labelstringappendix", CT_LABELSTRING_APPENDIX },
 845                 { "name", CT_NAME },
 846                 { "within", CT_WITHIN }
 847         };
 848
 849         lexrc.pushTable(counterTags, CT_END);
 850
 851         docstring name;
 852         docstring within;
 853         docstring labelstring;
 854         docstring labelstring_appendix;
 855
 856         bool getout = false;
 857         while (!getout && lexrc.isOK()) {
 858                 int le = lexrc.lex();
 859                 switch (le) {
 860                 case Lexer::LEX_UNDEF:
 861                         lexrc.printError("Unknown ClassOption tag `$$Token'");
 862                         continue;
 863                 default: break;
 864                 }
 865                 switch (static_cast<CounterTags>(le)) {
 866                 case CT_NAME:
 867                         lexrc.next();
 868                         name = lexrc.getDocString();
 869                         if (counters_->hasCounter(name))
 870                                 LYXERR(Debug::TCLASS)
 871                                         << "Reading existing counter "
 872                                         << to_utf8(name) << endl;
 873                         else
 874                                 LYXERR(Debug::TCLASS)
 875                                         << "Reading new counter "
 876                                         << to_utf8(name) << endl;
 877                         break;
 878                 case CT_WITHIN:
 879                         lexrc.next();
 880                         within = lexrc.getDocString();
 881                         if (within == "none")
 882                                 within.erase();
 883                         break;
 884                 case CT_LABELSTRING:
 885                         lexrc.next();
 886                         labelstring = lexrc.getDocString();
 887                         labelstring_appendix = labelstring;
 888                         break;
 889                 case CT_LABELSTRING_APPENDIX:
 890                         lexrc.next();
 891                         labelstring_appendix = lexrc.getDocString();
 892                         break;
 893                 case CT_END:
 894                         getout = true;
 895                         break;
 896                 }
 897         }
 898
 899         // Here if have a full counter if getout == true
 900         if (getout)
 901                 counters_->newCounter(name, within,
 902                                       labelstring, labelstring_appendix);
 903
 904         lexrc.popTable();
 905 }
 906
 907
 908 Font const & TextClass::defaultfont() const
 909 {
 910         return defaultfont_;
 911 }
 912
 913
 914 docstring const & TextClass::leftmargin() const
 915 {
 916         return leftmargin_;
 917 }
 918
 919
 920 docstring const & TextClass::rightmargin() const
 921 {
 922         return rightmargin_;
 923 }
 924
 925
 926 bool TextClass::hasLayout(docstring const & n) const
 927 {
 928         docstring const name = n.empty() ? defaultLayoutName() : n;
 929
 930         return find_if(layoutlist_.begin(), layoutlist_.end(),
 931                        LayoutNamesEqual(name))
 932                 != layoutlist_.end();
 933 }
 934
 935
 936
 937 LayoutPtr const & TextClass::operator[](docstring const & name) const
 938 {
 939         BOOST_ASSERT(!name.empty());
 940
 941         LayoutList::const_iterator cit =
 942                 find_if(layoutlist_.begin(),
 943                         layoutlist_.end(),
 944                         LayoutNamesEqual(name));
 945
 946         if (cit == layoutlist_.end()) {
 947                 lyxerr << "We failed to find the layout '" << to_utf8(name)
 948                        << "' in the layout list. You MUST investigate!"
 949                        << endl;
 950                 for (LayoutList::const_iterator it = layoutlist_.begin();
 951                          it != layoutlist_.end(); ++it)
 952                         lyxerr  << " " << to_utf8(it->get()->name()) << endl;
 953
 954                 // we require the name to exist
 955                 BOOST_ASSERT(false);
 956         }
 957
 958         return (*cit);
 959 }
 960
 961
 962
 963 bool TextClass::delete_layout(docstring const & name)
 964 {
 965         if (name == defaultLayoutName())
 966                 return false;
 967
 968         LayoutList::iterator it =
 969                 remove_if(layoutlist_.begin(), layoutlist_.end(),
 970                           LayoutNamesEqual(name));
 971
 972         LayoutList::iterator end = layoutlist_.end();
 973         bool const ret = (it != end);
 974         layoutlist_.erase(it, end);
 975         return ret;
 976 }
 977
 978
 979 // Load textclass info if not loaded yet
 980 bool TextClass::load(string const & path) const
 981 {
 982         if (loaded_)
 983                 return true;
 984
 985         // Read style-file, provided path is searched before the system ones
 986         FileName layout_file;
 987         if (!path.empty())
 988                 layout_file = FileName(addName(path, name_ + ".layout"));
 989         if (layout_file.empty() || !fs::exists(layout_file.toFilesystemEncoding()))
 990                 layout_file = libFileSearch("layouts", name_, "layout");
 991         loaded_ = const_cast<TextClass*>(this)->read(layout_file) == 0;
 992
 993         if (!loaded_) {
 994                 lyxerr << "Error reading `"
 995                        << to_utf8(makeDisplayPath(layout_file.absFilename()))
 996                        << "'\n(Check `" << name_
 997                        << "')\nCheck your installation and "
 998                         "try Options/Reconfigure..." << endl;
 999         }
1000
1001         return loaded_;
1002 }
1003
1004
1005 FloatList & TextClass::floats()
1006 {
1007         return *floatlist_.get();
1008 }
1009
1010
1011 FloatList const & TextClass::floats() const
1012 {
1013         return *floatlist_.get();
1014 }
1015
1016
1017 Counters & TextClass::counters() const
1018 {
1019         return *counters_.get();
1020 }
1021
1022 InsetLayout const & TextClass::insetlayout(docstring const & name) const
1023 {
1024         docstring n = name;
1025         while (!n.empty()) {
1026                 if (insetlayoutlist_.count(n) > 0)
1027                         return insetlayoutlist_[n];
1028                 docstring::size_type i = n.find(':');
1029                 if (i == string::npos)
1030                         break;
1031                 n = n.substr(0,i);
1032         }
1033         static const InsetLayout empty;
1034         return empty;
1035 }
1036
1037
1038 CharStyles::iterator TextClass::charstyle(string const & s) const
1039 {
1040         CharStyles::iterator cs = charstyles().begin();
1041         CharStyles::iterator csend = charstyles().end();
1042         for (; cs != csend; ++cs) {
1043                 if (cs->name == s)
1044                         return cs;
1045         }
1046         return csend;
1047 }
1048
1049
1050 docstring const & TextClass::defaultLayoutName() const
1051 {
1052         // This really should come from the actual layout... (Lgb)
1053         return defaultlayout_;
1054 }
1055
1056
1057 LayoutPtr const & TextClass::defaultLayout() const
1058 {
1059         return operator[](defaultLayoutName());
1060 }
1061
1062
1063 string const & TextClass::name() const
1064 {
1065         return name_;
1066 }
1067
1068
1069 string const & TextClass::latexname() const
1070 {
1071         const_cast<TextClass*>(this)->load();
1072         return latexname_;
1073 }
1074
1075
1076 string const & TextClass::description() const
1077 {
1078         return description_;
1079 }
1080
1081
1082 string const & TextClass::opt_fontsize() const
1083 {
1084         return opt_fontsize_;
1085 }
1086
1087
1088 string const & TextClass::opt_pagestyle() const
1089 {
1090         return opt_pagestyle_;
1091 }
1092
1093
1094 string const & TextClass::options() const
1095 {
1096         return options_;
1097 }
1098
1099
1100 string const & TextClass::class_header() const
1101 {
1102         return class_header_;
1103 }
1104
1105
1106 string const & TextClass::pagestyle() const
1107 {
1108         return pagestyle_;
1109 }
1110
1111
1112 docstring const & TextClass::preamble() const
1113 {
1114         return preamble_;
1115 }
1116
1117
1118 TextClass::PageSides TextClass::sides() const
1119 {
1120         return sides_;
1121 }
1122
1123
1124 int TextClass::secnumdepth() const
1125 {
1126         return secnumdepth_;
1127 }
1128
1129
1130 int TextClass::tocdepth() const
1131 {
1132         return tocdepth_;
1133 }
1134
1135
1136 OutputType TextClass::outputType() const
1137 {
1138         return outputType_;
1139 }
1140
1141
1142 bool TextClass::provides(string const & p) const
1143 {
1144         return provides_.find(p) != provides_.end();
1145 }
1146
1147
1148 unsigned int TextClass::columns() const
1149 {
1150         return columns_;
1151 }
1152
1153
1154 LYX_TITLE_LATEX_TYPES TextClass::titletype() const
1155 {
1156         return titletype_;
1157 }
1158
1159
1160 string const & TextClass::titlename() const
1161 {
1162         return titlename_;
1163 }
1164
1165
1166 int TextClass::size() const
1167 {
1168         return layoutlist_.size();
1169 }
1170
1171
1172 int TextClass::min_toclevel() const
1173 {
1174         return min_toclevel_;
1175 }
1176
1177
1178 int TextClass::max_toclevel() const
1179 {
1180         return max_toclevel_;
1181 }
1182
1183
1184 bool TextClass::hasTocLevels() const
1185 {
1186         return min_toclevel_ != Layout::NOT_IN_TOC;
1187 }
1188
1189
1190 ostream & operator<<(ostream & os, TextClass::PageSides p)
1191 {
1192         switch (p) {
1193         case TextClass::OneSide:
1194                 os << '1';
1195                 break;
1196         case TextClass::TwoSides:
1197                 os << '2';
1198                 break;
1199         }
1200         return os;
1201 }
1202
1203
1204 } // namespace lyx