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_LABELFONT,
 602         IL_LABELSTRING,
 603         IL_LATEXNAME,
 604         IL_LATEXPARAM,
 605         IL_LATEXTYPE,
 606         IL_LYXTYPE,
 607         IL_PREAMBLE,
 608         IL_END
 609 };
 610
 611
 612 void TextClass::readInsetLayout(Lexer & lexrc, docstring const & name)
 613 {
 614         keyword_item elementTags[] = {
 615                 { "end", IL_END },
 616                 { "font", IL_FONT },
 617                 { "labelfont", IL_LABELFONT },
 618                 { "labelstring", IL_LABELSTRING },
 619                 { "latexname", IL_LATEXNAME },
 620                 { "latexparam", IL_LATEXPARAM },
 621                 { "latextype", IL_LATEXTYPE },
 622                 { "lyxtype", IL_LYXTYPE },
 623                 { "preamble", IL_PREAMBLE }
 624         };
 625
 626         lexrc.pushTable(elementTags, IL_END);
 627
 628         string lyxtype;
 629         docstring labelstring;
 630         string latextype;
 631         string latexname;
 632         string latexparam;
 633         Font font(Font::ALL_INHERIT);
 634         Font labelfont(Font::ALL_INHERIT);
 635         string preamble;
 636
 637         bool getout = false;
 638         while (!getout && lexrc.isOK()) {
 639                 int le = lexrc.lex();
 640                 switch (le) {
 641                 case Lexer::LEX_UNDEF:
 642                         lexrc.printError("Unknown ClassOption tag `$$Token'");
 643                         continue;
 644                 default: break;
 645                 }
 646                 switch (static_cast<InsetLayoutTags>(le)) {
 647                 case IL_LYXTYPE:
 648                         lexrc.next();
 649                         lyxtype = lexrc.getString();
 650                         break;
 651                 case IL_LATEXTYPE:
 652                         lexrc.next();
 653                         latextype = lexrc.getString();
 654                         break;
 655                 case IL_LABELSTRING:
 656                         lexrc.next();
 657                         labelstring = lexrc.getDocString();
 658                         break;
 659                 case IL_LATEXNAME:
 660                         lexrc.next();
 661                         latexname = lexrc.getString();
 662                         break;
 663                 case IL_LATEXPARAM:
 664                         lexrc.next();
 665                         latexparam = subst(lexrc.getString(), "&quot;", "\"");
 666                         break;
 667                 case IL_LABELFONT:
 668                         labelfont.lyxRead(lexrc);
 669                         labelfont.realize(defaultfont());
 670                         break;
 671                 case IL_FONT:
 672                         font.lyxRead(lexrc);
 673                         font.realize(defaultfont());
 674                         labelfont = font;
 675                         break;
 676                 case IL_PREAMBLE:
 677                         preamble = lexrc.getLongString("EndPreamble");
 678                         break;
 679                 case IL_END:
 680                         getout = true;
 681                         break;
 682                 }
 683         }
 684
 685         //
 686         // Here add element to list if getout == true
 687         if (getout) {
 688                 InsetLayout il;
 689                 il.name = to_ascii(name);
 690                 il.lyxtype = lyxtype;
 691                 il.labelstring = labelstring;
 692                 il.latextype = latextype;
 693                 il.latexname = latexname;
 694                 il.latexparam = latexparam;
 695                 il.font = font;
 696                 il.labelfont = labelfont;
 697                 il.preamble = preamble;
 698                 insetlayoutlist_[name] = il;
 699
 700                 // test name for CS:
 701                 if (il.lyxtype == "charstyle" || il.lyxtype == "custom") {
 702                         charstyles().push_back(il);
 703                 }
 704         }
 705
 706         lexrc.popTable();
 707 }
 708
 709
 710
 711 enum FloatTags {
 712         FT_TYPE = 1,
 713         FT_NAME,
 714         FT_PLACEMENT,
 715         FT_EXT,
 716         FT_WITHIN,
 717         FT_STYLE,
 718         FT_LISTNAME,
 719         FT_BUILTIN,
 720         FT_END
 721 };
 722
 723
 724 void TextClass::readFloat(Lexer & lexrc)
 725 {
 726         keyword_item floatTags[] = {
 727                 { "end", FT_END },
 728                 { "extension", FT_EXT },
 729                 { "guiname", FT_NAME },
 730                 { "latexbuiltin", FT_BUILTIN },
 731                 { "listname", FT_LISTNAME },
 732                 { "numberwithin", FT_WITHIN },
 733                 { "placement", FT_PLACEMENT },
 734                 { "style", FT_STYLE },
 735                 { "type", FT_TYPE }
 736         };
 737
 738         lexrc.pushTable(floatTags, FT_END);
 739
 740         string type;
 741         string placement;
 742         string ext;
 743         string within;
 744         string style;
 745         string name;
 746         string listName;
 747         bool builtin = false;
 748
 749         bool getout = false;
 750         while (!getout && lexrc.isOK()) {
 751                 int le = lexrc.lex();
 752                 switch (le) {
 753                 case Lexer::LEX_UNDEF:
 754                         lexrc.printError("Unknown ClassOption tag `$$Token'");
 755                         continue;
 756                 default: break;
 757                 }
 758                 switch (static_cast<FloatTags>(le)) {
 759                 case FT_TYPE:
 760                         lexrc.next();
 761                         type = lexrc.getString();
 762                         if (floatlist_->typeExist(type)) {
 763                                 Floating const & fl = floatlist_->getType(type);
 764                                 placement = fl.placement();
 765                                 ext = fl.ext();
 766                                 within = fl.within();
 767                                 style = fl.style();
 768                                 name = fl.name();
 769                                 listName = fl.listName();
 770                                 builtin = fl.builtin();
 771                         }
 772                         break;
 773                 case FT_NAME:
 774                         lexrc.next();
 775                         name = lexrc.getString();
 776                         break;
 777                 case FT_PLACEMENT:
 778                         lexrc.next();
 779                         placement = lexrc.getString();
 780                         break;
 781                 case FT_EXT:
 782                         lexrc.next();
 783                         ext = lexrc.getString();
 784                         break;
 785                 case FT_WITHIN:
 786                         lexrc.next();
 787                         within = lexrc.getString();
 788                         if (within == "none")
 789                                 within.erase();
 790                         break;
 791                 case FT_STYLE:
 792                         lexrc.next();
 793                         style = lexrc.getString();
 794                         break;
 795                 case FT_LISTNAME:
 796                         lexrc.next();
 797                         listName = lexrc.getString();
 798                         break;
 799                 case FT_BUILTIN:
 800                         lexrc.next();
 801                         builtin = lexrc.getBool();
 802                         break;
 803                 case FT_END:
 804                         getout = true;
 805                         break;
 806                 }
 807         }
 808
 809         // Here if have a full float if getout == true
 810         if (getout) {
 811                 Floating fl(type, placement, ext, within,
 812                             style, name, listName, builtin);
 813                 floatlist_->newFloat(fl);
 814                 // each float has its own counter
 815                 counters_->newCounter(from_ascii(type), from_ascii(within),
 816                                       docstring(), docstring());
 817         }
 818
 819         lexrc.popTable();
 820 }
 821
 822
 823 enum CounterTags {
 824         CT_NAME = 1,
 825         CT_WITHIN,
 826         CT_LABELSTRING,
 827         CT_LABELSTRING_APPENDIX,
 828         CT_END
 829 };
 830
 831 void TextClass::readCounter(Lexer & lexrc)
 832 {
 833         keyword_item counterTags[] = {
 834                 { "end", CT_END },
 835                 { "labelstring", CT_LABELSTRING },
 836                 { "labelstringappendix", CT_LABELSTRING_APPENDIX },
 837                 { "name", CT_NAME },
 838                 { "within", CT_WITHIN }
 839         };
 840
 841         lexrc.pushTable(counterTags, CT_END);
 842
 843         docstring name;
 844         docstring within;
 845         docstring labelstring;
 846         docstring labelstring_appendix;
 847
 848         bool getout = false;
 849         while (!getout && lexrc.isOK()) {
 850                 int le = lexrc.lex();
 851                 switch (le) {
 852                 case Lexer::LEX_UNDEF:
 853                         lexrc.printError("Unknown ClassOption tag `$$Token'");
 854                         continue;
 855                 default: break;
 856                 }
 857                 switch (static_cast<CounterTags>(le)) {
 858                 case CT_NAME:
 859                         lexrc.next();
 860                         name = lexrc.getDocString();
 861                         if (counters_->hasCounter(name))
 862                                 LYXERR(Debug::TCLASS)
 863                                         << "Reading existing counter "
 864                                         << to_utf8(name) << endl;
 865                         else
 866                                 LYXERR(Debug::TCLASS)
 867                                         << "Reading new counter "
 868                                         << to_utf8(name) << endl;
 869                         break;
 870                 case CT_WITHIN:
 871                         lexrc.next();
 872                         within = lexrc.getDocString();
 873                         if (within == "none")
 874                                 within.erase();
 875                         break;
 876                 case CT_LABELSTRING:
 877                         lexrc.next();
 878                         labelstring = lexrc.getDocString();
 879                         labelstring_appendix = labelstring;
 880                         break;
 881                 case CT_LABELSTRING_APPENDIX:
 882                         lexrc.next();
 883                         labelstring_appendix = lexrc.getDocString();
 884                         break;
 885                 case CT_END:
 886                         getout = true;
 887                         break;
 888                 }
 889         }
 890
 891         // Here if have a full counter if getout == true
 892         if (getout)
 893                 counters_->newCounter(name, within,
 894                                       labelstring, labelstring_appendix);
 895
 896         lexrc.popTable();
 897 }
 898
 899
 900 Font const & TextClass::defaultfont() const
 901 {
 902         return defaultfont_;
 903 }
 904
 905
 906 docstring const & TextClass::leftmargin() const
 907 {
 908         return leftmargin_;
 909 }
 910
 911
 912 docstring const & TextClass::rightmargin() const
 913 {
 914         return rightmargin_;
 915 }
 916
 917
 918 bool TextClass::hasLayout(docstring const & n) const
 919 {
 920         docstring const name = n.empty() ? defaultLayoutName() : n;
 921
 922         return find_if(layoutlist_.begin(), layoutlist_.end(),
 923                        LayoutNamesEqual(name))
 924                 != layoutlist_.end();
 925 }
 926
 927
 928
 929 LayoutPtr const & TextClass::operator[](docstring const & name) const
 930 {
 931         BOOST_ASSERT(!name.empty());
 932
 933         LayoutList::const_iterator cit =
 934                 find_if(layoutlist_.begin(),
 935                         layoutlist_.end(),
 936                         LayoutNamesEqual(name));
 937
 938         if (cit == layoutlist_.end()) {
 939                 lyxerr << "We failed to find the layout '" << to_utf8(name)
 940                        << "' in the layout list. You MUST investigate!"
 941                        << endl;
 942                 for (LayoutList::const_iterator it = layoutlist_.begin();
 943                          it != layoutlist_.end(); ++it)
 944                         lyxerr  << " " << to_utf8(it->get()->name()) << endl;
 945
 946                 // we require the name to exist
 947                 BOOST_ASSERT(false);
 948         }
 949
 950         return (*cit);
 951 }
 952
 953
 954
 955 bool TextClass::delete_layout(docstring const & name)
 956 {
 957         if (name == defaultLayoutName())
 958                 return false;
 959
 960         LayoutList::iterator it =
 961                 remove_if(layoutlist_.begin(), layoutlist_.end(),
 962                           LayoutNamesEqual(name));
 963
 964         LayoutList::iterator end = layoutlist_.end();
 965         bool const ret = (it != end);
 966         layoutlist_.erase(it, end);
 967         return ret;
 968 }
 969
 970
 971 // Load textclass info if not loaded yet
 972 bool TextClass::load(string const & path) const
 973 {
 974         if (loaded_)
 975                 return true;
 976
 977         // Read style-file, provided path is searched before the system ones
 978         FileName layout_file;
 979         if (!path.empty())
 980                 layout_file = FileName(addName(path, name_ + ".layout"));
 981         if (layout_file.empty() || !fs::exists(layout_file.toFilesystemEncoding()))
 982                 layout_file = libFileSearch("layouts", name_, "layout");
 983         loaded_ = const_cast<TextClass*>(this)->read(layout_file) == 0;
 984
 985         if (!loaded_) {
 986                 lyxerr << "Error reading `"
 987                        << to_utf8(makeDisplayPath(layout_file.absFilename()))
 988                        << "'\n(Check `" << name_
 989                        << "')\nCheck your installation and "
 990                         "try Options/Reconfigure..." << endl;
 991         }
 992
 993         return loaded_;
 994 }
 995
 996
 997 FloatList & TextClass::floats()
 998 {
 999         return *floatlist_.get();
1000 }
1001
1002
1003 FloatList const & TextClass::floats() const
1004 {
1005         return *floatlist_.get();
1006 }
1007
1008
1009 Counters & TextClass::counters() const
1010 {
1011         return *counters_.get();
1012 }
1013
1014 InsetLayout const & TextClass::insetlayout(docstring const & name) const
1015 {
1016         docstring n = name;
1017         while (!n.empty()) {
1018                 if (insetlayoutlist_.count(n) > 0)
1019                         return insetlayoutlist_[n];
1020                 docstring::size_type i = n.find(':');
1021                 if (i == string::npos)
1022                         break;
1023                 n = n.substr(0,i);
1024         }
1025         static const InsetLayout empty;
1026         return empty;
1027 }
1028
1029
1030 CharStyles::iterator TextClass::charstyle(string const & s) const
1031 {
1032         CharStyles::iterator cs = charstyles().begin();
1033         CharStyles::iterator csend = charstyles().end();
1034         for (; cs != csend; ++cs) {
1035                 if (cs->name == s)
1036                         return cs;
1037         }
1038         return csend;
1039 }
1040
1041
1042 docstring const & TextClass::defaultLayoutName() const
1043 {
1044         // This really should come from the actual layout... (Lgb)
1045         return defaultlayout_;
1046 }
1047
1048
1049 LayoutPtr const & TextClass::defaultLayout() const
1050 {
1051         return operator[](defaultLayoutName());
1052 }
1053
1054
1055 string const & TextClass::name() const
1056 {
1057         return name_;
1058 }
1059
1060
1061 string const & TextClass::latexname() const
1062 {
1063         const_cast<TextClass*>(this)->load();
1064         return latexname_;
1065 }
1066
1067
1068 string const & TextClass::description() const
1069 {
1070         return description_;
1071 }
1072
1073
1074 string const & TextClass::opt_fontsize() const
1075 {
1076         return opt_fontsize_;
1077 }
1078
1079
1080 string const & TextClass::opt_pagestyle() const
1081 {
1082         return opt_pagestyle_;
1083 }
1084
1085
1086 string const & TextClass::options() const
1087 {
1088         return options_;
1089 }
1090
1091
1092 string const & TextClass::class_header() const
1093 {
1094         return class_header_;
1095 }
1096
1097
1098 string const & TextClass::pagestyle() const
1099 {
1100         return pagestyle_;
1101 }
1102
1103
1104 docstring const & TextClass::preamble() const
1105 {
1106         return preamble_;
1107 }
1108
1109
1110 TextClass::PageSides TextClass::sides() const
1111 {
1112         return sides_;
1113 }
1114
1115
1116 int TextClass::secnumdepth() const
1117 {
1118         return secnumdepth_;
1119 }
1120
1121
1122 int TextClass::tocdepth() const
1123 {
1124         return tocdepth_;
1125 }
1126
1127
1128 OutputType TextClass::outputType() const
1129 {
1130         return outputType_;
1131 }
1132
1133
1134 bool TextClass::provides(string const & p) const
1135 {
1136         return provides_.find(p) != provides_.end();
1137 }
1138
1139
1140 unsigned int TextClass::columns() const
1141 {
1142         return columns_;
1143 }
1144
1145
1146 LYX_TITLE_LATEX_TYPES TextClass::titletype() const
1147 {
1148         return titletype_;
1149 }
1150
1151
1152 string const & TextClass::titlename() const
1153 {
1154         return titlename_;
1155 }
1156
1157
1158 int TextClass::size() const
1159 {
1160         return layoutlist_.size();
1161 }
1162
1163
1164 int TextClass::min_toclevel() const
1165 {
1166         return min_toclevel_;
1167 }
1168
1169
1170 int TextClass::max_toclevel() const
1171 {
1172         return max_toclevel_;
1173 }
1174
1175
1176 bool TextClass::hasTocLevels() const
1177 {
1178         return min_toclevel_ != Layout::NOT_IN_TOC;
1179 }
1180
1181
1182 ostream & operator<<(ostream & os, TextClass::PageSides p)
1183 {
1184         switch (p) {
1185         case TextClass::OneSide:
1186                 os << '1';
1187                 break;
1188         case TextClass::TwoSides:
1189                 os << '2';
1190                 break;
1191         }
1192         return os;
1193 }
1194
1195
1196 } // namespace lyx