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