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 = 8;
  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                 lyxerr << "Unable to convert " << filename <<
 265                         " to format " << FORMAT << std::endl;
 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                                 //FIXME Should we also eat the style here? viz:
 402                                 //Layout layout;
 403                                 //readStyle(lexrc, layout);
 404                                 //as above...
 405                                 lexrc.printError("No name given for style: `$$Token'.");
 406                                 error = true;
 407                         }
 408                         break;
 409
 410                 case TC_NOSTYLE:
 411                         if (lexrc.next()) {
 412                                 docstring const style = from_utf8(subst(lexrc.getString(),
 413                                                      '_', ' '));
 414                                 if (!deleteLayout(style))
 415                                         lyxerr << "Cannot delete style `"
 416                                                << to_utf8(style) << '\'' << endl;
 417                         }
 418                         break;
 419
 420                 case TC_COLUMNS:
 421                         if (lexrc.next())
 422                                 columns_ = lexrc.getInteger();
 423                         break;
 424
 425                 case TC_SIDES:
 426                         if (lexrc.next()) {
 427                                 switch (lexrc.getInteger()) {
 428                                 case 1: sides_ = OneSide; break;
 429                                 case 2: sides_ = TwoSides; break;
 430                                 default:
 431                                         lyxerr << "Impossible number of page"
 432                                                 " sides, setting to one."
 433                                                << endl;
 434                                         sides_ = OneSide;
 435                                         break;
 436                                 }
 437                         }
 438                         break;
 439
 440                 case TC_PAGESTYLE:
 441                         lexrc.next();
 442                         pagestyle_ = rtrim(lexrc.getString());
 443                         break;
 444
 445                 case TC_DEFAULTFONT:
 446                         defaultfont_ = lyxRead(lexrc);
 447                         if (!defaultfont_.resolved()) {
 448                                 lexrc.printError("Warning: defaultfont should "
 449                                                  "be fully instantiated!");
 450                                 defaultfont_.realize(sane_font);
 451                         }
 452                         break;
 453
 454                 case TC_SECNUMDEPTH:
 455                         lexrc.next();
 456                         secnumdepth_ = lexrc.getInteger();
 457                         break;
 458
 459                 case TC_TOCDEPTH:
 460                         lexrc.next();
 461                         tocdepth_ = lexrc.getInteger();
 462                         break;
 463
 464                 // First step to support options
 465                 case TC_CLASSOPTIONS:
 466                         readClassOptions(lexrc);
 467                         break;
 468
 469                 case TC_PREAMBLE:
 470                         preamble_ = from_utf8(lexrc.getLongString("EndPreamble"));
 471                         break;
 472
 473                 case TC_ADDTOPREAMBLE:
 474                         preamble_ += from_utf8(lexrc.getLongString("EndPreamble"));
 475                         break;
 476
 477                 case TC_PROVIDES: {
 478                         lexrc.next();
 479                         string const feature = lexrc.getString();
 480                         lexrc.next();
 481                         if (lexrc.getInteger())
 482                                 provides_.insert(feature);
 483                         else
 484                                 provides_.erase(feature);
 485                         break;
 486                 }
 487
 488                 case TC_REQUIRES: {
 489                         lexrc.eatLine();
 490                         vector<string> const req
 491                                 = getVectorFromString(lexrc.getString());
 492                         requires_.insert(req.begin(), req.end());
 493                         break;
 494                 }
 495
 496                 case TC_USEMODULE: {
 497                         lexrc.next();
 498                         string const module = lexrc.getString();
 499                         usemod_.insert(module);
 500                         break;
 501                 }
 502
 503                 case TC_LEFTMARGIN:     // left margin type
 504                         if (lexrc.next())
 505                                 leftmargin_ = lexrc.getDocString();
 506                         break;
 507
 508                 case TC_RIGHTMARGIN:    // right margin type
 509                         if (lexrc.next())
 510                                 rightmargin_ = lexrc.getDocString();
 511                         break;
 512
 513                 case TC_INSETLAYOUT:
 514                         if (lexrc.next()) {
 515                                 InsetLayout il;
 516                                 if (il.read(lexrc, *this))
 517                                         insetlayoutlist_[il.name()] = il;
 518                                 // else there was an error, so forget it
 519                         }
 520                         break;
 521
 522                 case TC_FLOAT:
 523                         readFloat(lexrc);
 524                         break;
 525
 526                 case TC_COUNTER:
 527                         readCounter(lexrc);
 528                         break;
 529
 530                 case TC_TITLELATEXTYPE:
 531                         readTitleType(lexrc);
 532                         break;
 533
 534                 case TC_TITLELATEXNAME:
 535                         if (lexrc.next())
 536                                 titlename_ = lexrc.getString();
 537                         break;
 538
 539                 case TC_NOFLOAT:
 540                         if (lexrc.next()) {
 541                                 string const nofloat = lexrc.getString();
 542                                 floatlist_.erase(nofloat);
 543                         }
 544                         break;
 545                 }
 546
 547                 //Note that this is triggered the first time through the loop unless
 548                 //we hit a format tag.
 549                 if (format != FORMAT)
 550                         break;
 551         }
 552
 553         if (format != FORMAT)
 554                 return FORMAT_MISMATCH;
 555
 556         if (rt != BASECLASS)
 557                 return (error ? ERROR : OK);
 558
 559         if (defaultlayout_.empty()) {
 560                 LYXERR0("Error: Textclass '" << name_
 561                                                 << "' is missing a defaultstyle.");
 562                 error = true;
 563         }
 564
 565         // Try to erase "stdinsets" from the provides_ set.
 566         // The
 567         //   Provides stdinsets 1
 568         // declaration simply tells us that the standard insets have been
 569         // defined. (It's found in stdinsets.inc but could also be used in
 570         // user-defined files.) There isn't really any such package. So we
 571         // might as well go ahead and erase it.
 572         // If we do not succeed, then it was not there, which means that
 573         // the textclass did not provide the definitions of the standard
 574         // insets. So we need to try to load them.
 575         int erased = provides_.erase("stdinsets");
 576         if (!erased) {
 577                 FileName tmp = libFileSearch("layouts", "stdinsets.inc");
 578
 579                 if (tmp.empty()) {
 580                         throw ExceptionMessage(WarningException, _("Missing File"),
 581                                 _("Could not find stdinsets.inc! This may lead to data loss!"));
 582                         error = true;
 583                 } else if (!read(tmp, MERGE)) {
 584                         throw ExceptionMessage(WarningException, _("Corrupt File"),
 585                                 _("Could not read stdinsets.inc! This may lead to data loss!"));
 586                         error = true;
 587                 }
 588         }
 589
 590         min_toclevel_ = Layout::NOT_IN_TOC;
 591         max_toclevel_ = Layout::NOT_IN_TOC;
 592         const_iterator lit = begin();
 593         const_iterator len = end();
 594         for (; lit != len; ++lit) {
 595                 int const toclevel = lit->toclevel;
 596                 if (toclevel != Layout::NOT_IN_TOC) {
 597                         if (min_toclevel_ == Layout::NOT_IN_TOC)
 598                                 min_toclevel_ = toclevel;
 599                         else
 600                                 min_toclevel_ = min(min_toclevel_, toclevel);
 601                         max_toclevel_ = max(max_toclevel_, toclevel);
 602                 }
 603         }
 604         LYXERR(Debug::TCLASS, "Minimum TocLevel is " << min_toclevel_
 605                 << ", maximum is " << max_toclevel_);
 606
 607         return (error ? ERROR : OK);
 608 }
 609
 610
 611 void TextClass::readTitleType(Lexer & lexrc)
 612 {
 613         LexerKeyword titleTypeTags[] = {
 614                 { "commandafter", TITLE_COMMAND_AFTER },
 615                 { "environment",  TITLE_ENVIRONMENT }
 616         };
 617
 618         PushPopHelper pph(lexrc, titleTypeTags);
 619
 620         int le = lexrc.lex();
 621         switch (le) {
 622         case Lexer::LEX_UNDEF:
 623                 lexrc.printError("Unknown output type `$$Token'");
 624                 break;
 625         case TITLE_COMMAND_AFTER:
 626         case TITLE_ENVIRONMENT:
 627                 titletype_ = static_cast<TitleLatexType>(le);
 628                 break;
 629         default:
 630                 LYXERR0("Unhandled value " << le << " in TextClass::readTitleType.");
 631                 break;
 632         }
 633 }
 634
 635
 636 void TextClass::readOutputType(Lexer & lexrc)
 637 {
 638         LexerKeyword outputTypeTags[] = {
 639                 { "docbook",  DOCBOOK },
 640                 { "latex",    LATEX },
 641                 { "literate", LITERATE }
 642         };
 643
 644         PushPopHelper pph(lexrc, outputTypeTags);
 645
 646         int le = lexrc.lex();
 647         switch (le) {
 648         case Lexer::LEX_UNDEF:
 649                 lexrc.printError("Unknown output type `$$Token'");
 650                 return;
 651         case LATEX:
 652         case DOCBOOK:
 653         case LITERATE:
 654                 outputType_ = static_cast<OutputType>(le);
 655                 break;
 656         default:
 657                 LYXERR0("Unhandled value " << le);
 658                 break;
 659         }
 660 }
 661
 662
 663 void TextClass::readClassOptions(Lexer & lexrc)
 664 {
 665         enum {
 666                 CO_FONTSIZE = 1,
 667                 CO_PAGESTYLE,
 668                 CO_OTHER,
 669                 CO_HEADER,
 670                 CO_END
 671         };
 672
 673         LexerKeyword classOptionsTags[] = {
 674                 {"end",       CO_END },
 675                 {"fontsize",  CO_FONTSIZE },
 676                 {"header",    CO_HEADER },
 677                 {"other",     CO_OTHER },
 678                 {"pagestyle", CO_PAGESTYLE }
 679         };
 680
 681         lexrc.pushTable(classOptionsTags);
 682         bool getout = false;
 683         while (!getout && lexrc.isOK()) {
 684                 int le = lexrc.lex();
 685                 switch (le) {
 686                 case Lexer::LEX_UNDEF:
 687                         lexrc.printError("Unknown ClassOption tag `$$Token'");
 688                         continue;
 689                 default: break;
 690                 }
 691                 switch (le) {
 692                 case CO_FONTSIZE:
 693                         lexrc.next();
 694                         opt_fontsize_ = rtrim(lexrc.getString());
 695                         break;
 696                 case CO_PAGESTYLE:
 697                         lexrc.next();
 698                         opt_pagestyle_ = rtrim(lexrc.getString());
 699                         break;
 700                 case CO_OTHER:
 701                         lexrc.next();
 702                         options_ = lexrc.getString();
 703                         break;
 704                 case CO_HEADER:
 705                         lexrc.next();
 706                         class_header_ = subst(lexrc.getString(), "&quot;", "\"");
 707                         break;
 708                 case CO_END:
 709                         getout = true;
 710                         break;
 711                 }
 712         }
 713         lexrc.popTable();
 714 }
 715
 716
 717 void TextClass::readFloat(Lexer & lexrc)
 718 {
 719         enum {
 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         LexerKeyword floatTags[] = {
 732                 { "end", FT_END },
 733                 { "extension", FT_EXT },
 734                 { "guiname", FT_NAME },
 735                 { "latexbuiltin", FT_BUILTIN },
 736                 { "listname", FT_LISTNAME },
 737                 { "numberwithin", FT_WITHIN },
 738                 { "placement", FT_PLACEMENT },
 739                 { "style", FT_STYLE },
 740                 { "type", FT_TYPE }
 741         };
 742
 743         lexrc.pushTable(floatTags);
 744
 745         string type;
 746         string placement;
 747         string ext;
 748         string within;
 749         string style;
 750         string name;
 751         string listName;
 752         bool builtin = false;
 753
 754         bool getout = false;
 755         while (!getout && lexrc.isOK()) {
 756                 int le = lexrc.lex();
 757                 switch (le) {
 758                 case Lexer::LEX_UNDEF:
 759                         lexrc.printError("Unknown float tag `$$Token'");
 760                         continue;
 761                 default: break;
 762                 }
 763                 switch (le) {
 764                 case FT_TYPE:
 765                         lexrc.next();
 766                         type = lexrc.getString();
 767                         if (floatlist_.typeExist(type)) {
 768                                 Floating const & fl = floatlist_.getType(type);
 769                                 placement = fl.placement();
 770                                 ext = fl.ext();
 771                                 within = fl.within();
 772                                 style = fl.style();
 773                                 name = fl.name();
 774                                 listName = fl.listName();
 775                                 builtin = fl.builtin();
 776                         }
 777                         break;
 778                 case FT_NAME:
 779                         lexrc.next();
 780                         name = lexrc.getString();
 781                         break;
 782                 case FT_PLACEMENT:
 783                         lexrc.next();
 784                         placement = lexrc.getString();
 785                         break;
 786                 case FT_EXT:
 787                         lexrc.next();
 788                         ext = lexrc.getString();
 789                         break;
 790                 case FT_WITHIN:
 791                         lexrc.next();
 792                         within = lexrc.getString();
 793                         if (within == "none")
 794                                 within.erase();
 795                         break;
 796                 case FT_STYLE:
 797                         lexrc.next();
 798                         style = lexrc.getString();
 799                         break;
 800                 case FT_LISTNAME:
 801                         lexrc.next();
 802                         listName = lexrc.getString();
 803                         break;
 804                 case FT_BUILTIN:
 805                         lexrc.next();
 806                         builtin = lexrc.getBool();
 807                         break;
 808                 case FT_END:
 809                         getout = true;
 810                         break;
 811                 }
 812         }
 813
 814         // Here if have a full float if getout == true
 815         if (getout) {
 816                 Floating fl(type, placement, ext, within,
 817                             style, name, listName, builtin);
 818                 floatlist_.newFloat(fl);
 819                 // each float has its own counter
 820                 counters_.newCounter(from_ascii(type), from_ascii(within),
 821                                       docstring(), docstring());
 822                 // also define sub-float counters
 823                 docstring const subtype = "sub-" + from_ascii(type);
 824                 counters_.newCounter(subtype, from_ascii(type),
 825                                       "\\alph{" + subtype + "}", docstring());
 826         }
 827
 828         lexrc.popTable();
 829 }
 830
 831
 832 void TextClass::readCounter(Lexer & lexrc)
 833 {
 834         enum {
 835                 CT_NAME = 1,
 836                 CT_WITHIN,
 837                 CT_LABELSTRING,
 838                 CT_LABELSTRING_APPENDIX,
 839                 CT_END
 840         };
 841
 842         LexerKeyword counterTags[] = {
 843                 { "end", CT_END },
 844                 { "labelstring", CT_LABELSTRING },
 845                 { "labelstringappendix", CT_LABELSTRING_APPENDIX },
 846                 { "name", CT_NAME },
 847                 { "within", CT_WITHIN }
 848         };
 849
 850         lexrc.pushTable(counterTags);
 851
 852         docstring name;
 853         docstring within;
 854         docstring labelstring;
 855         docstring labelstring_appendix;
 856
 857         bool getout = false;
 858         while (!getout && lexrc.isOK()) {
 859                 int le = lexrc.lex();
 860                 switch (le) {
 861                 case Lexer::LEX_UNDEF:
 862                         lexrc.printError("Unknown counter tag `$$Token'");
 863                         continue;
 864                 default: break;
 865                 }
 866                 switch (le) {
 867                 case CT_NAME:
 868                         lexrc.next();
 869                         name = lexrc.getDocString();
 870                         if (counters_.hasCounter(name))
 871                                 LYXERR(Debug::TCLASS, "Reading existing counter " << to_utf8(name));
 872                         else
 873                                 LYXERR(Debug::TCLASS, "Reading new counter " << to_utf8(name));
 874                         break;
 875                 case CT_WITHIN:
 876                         lexrc.next();
 877                         within = lexrc.getDocString();
 878                         if (within == "none")
 879                                 within.erase();
 880                         break;
 881                 case CT_LABELSTRING:
 882                         lexrc.next();
 883                         labelstring = lexrc.getDocString();
 884                         labelstring_appendix = labelstring;
 885                         break;
 886                 case CT_LABELSTRING_APPENDIX:
 887                         lexrc.next();
 888                         labelstring_appendix = lexrc.getDocString();
 889                         break;
 890                 case CT_END:
 891                         getout = true;
 892                         break;
 893                 }
 894         }
 895
 896         // Here if have a full counter if getout == true
 897         if (getout)
 898                 counters_.newCounter(name, within,
 899                                       labelstring, labelstring_appendix);
 900
 901         lexrc.popTable();
 902 }
 903
 904
 905 bool TextClass::hasLayout(docstring const & n) const
 906 {
 907         docstring const name = n.empty() ? defaultLayoutName() : n;
 908
 909         return find_if(layoutlist_.begin(), layoutlist_.end(),
 910                        LayoutNamesEqual(name))
 911                 != layoutlist_.end();
 912 }
 913
 914
 915 Layout const & TextClass::operator[](docstring const & name) const
 916 {
 917         LASSERT(!name.empty(), /**/);
 918
 919         const_iterator it =
 920                 find_if(begin(), end(), LayoutNamesEqual(name));
 921
 922         if (it == end()) {
 923                 lyxerr << "We failed to find the layout '" << to_utf8(name)
 924                        << "' in the layout list. You MUST investigate!"
 925                        << endl;
 926                 for (const_iterator cit = begin(); cit != end(); ++cit)
 927                         lyxerr  << " " << to_utf8(cit->name()) << endl;
 928
 929                 // we require the name to exist
 930                 LASSERT(false, /**/);
 931         }
 932
 933         return *it;
 934 }
 935
 936
 937 Layout & TextClass::operator[](docstring const & name)
 938 {
 939         LASSERT(!name.empty(), /**/);
 940
 941         iterator it = find_if(begin(), end(), LayoutNamesEqual(name));
 942
 943         if (it == end()) {
 944                 LYXERR0("We failed to find the layout '" << to_utf8(name)
 945                        << "' in the layout list. You MUST investigate!");
 946                 for (const_iterator cit = begin(); cit != end(); ++cit)
 947                         LYXERR0(" " << to_utf8(cit->name()));
 948
 949                 // we require the name to exist
 950                 LASSERT(false, /**/);
 951         }
 952
 953         return *it;
 954 }
 955
 956
 957 bool TextClass::deleteLayout(docstring const & name)
 958 {
 959         if (name == defaultLayoutName() || name == plainLayoutName())
 960                 return false;
 961
 962         LayoutList::iterator it =
 963                 remove_if(layoutlist_.begin(), layoutlist_.end(),
 964                           LayoutNamesEqual(name));
 965
 966         LayoutList::iterator end = layoutlist_.end();
 967         bool const ret = (it != end);
 968         layoutlist_.erase(it, end);
 969         return ret;
 970 }
 971
 972
 973 // Load textclass info if not loaded yet
 974 bool TextClass::load(string const & path) const
 975 {
 976         if (loaded_)
 977                 return true;
 978
 979         // Read style-file, provided path is searched before the system ones
 980         // If path is a file, it is loaded directly.
 981         FileName layout_file(path);
 982         if (!path.empty() && !layout_file.isReadableFile())
 983                 layout_file = FileName(addName(path, name_ + ".layout"));
 984         if (layout_file.empty() || !layout_file.exists())
 985                 layout_file = libFileSearch("layouts", name_, "layout");
 986         loaded_ = const_cast<TextClass*>(this)->read(layout_file);
 987
 988         if (!loaded_) {
 989                 lyxerr << "Error reading `"
 990                        << to_utf8(makeDisplayPath(layout_file.absFilename()))
 991                        << "'\n(Check `" << name_
 992                        << "')\nCheck your installation and "
 993                         "try Options/Reconfigure..." << endl;
 994         }
 995
 996         return loaded_;
 997 }
 998
 999
1000 void DocumentClass::addLayoutIfNeeded(docstring const & n) const
1001 {
1002         if (!hasLayout(n))
1003                 layoutlist_.push_back(createBasicLayout(n, true));
1004 }
1005
1006
1007 InsetLayout const & DocumentClass::insetLayout(docstring const & name) const
1008 {
1009         // FIXME The fix for the InsetLayout part of 4812 would be here:
1010         // Add the InsetLayout to the document class if it is not found.
1011         docstring n = name;
1012         InsetLayouts::const_iterator cen = insetlayoutlist_.end();
1013         while (!n.empty()) {
1014                 InsetLayouts::const_iterator cit = insetlayoutlist_.lower_bound(n);
1015                 if (cit != cen && cit->first == n)
1016                         return cit->second;
1017                 size_t i = n.find(':');
1018                 if (i == string::npos)
1019                         break;
1020                 n = n.substr(0,i);
1021         }
1022         return plain_insetlayout_;
1023 }
1024
1025
1026 docstring const & TextClass::defaultLayoutName() const
1027 {
1028         // This really should come from the actual layout... (Lgb)
1029         return defaultlayout_;
1030 }
1031
1032
1033 Layout const & TextClass::defaultLayout() const
1034 {
1035         return operator[](defaultLayoutName());
1036 }
1037
1038
1039 bool TextClass::isDefaultLayout(Layout const & layout) const
1040 {
1041         return layout.name() == defaultLayoutName();
1042 }
1043
1044
1045 bool TextClass::isPlainLayout(Layout const & layout) const
1046 {
1047         return layout.name() == plainLayoutName();
1048 }
1049
1050
1051 Layout TextClass::createBasicLayout(docstring const & name, bool unknown) const
1052 {
1053         static Layout * defaultLayout = NULL;
1054
1055         if (defaultLayout) {
1056                 defaultLayout->setUnknown(unknown);
1057                 defaultLayout->setName(name);
1058                 return *defaultLayout;
1059         }
1060
1061         static char const * s = "Margin Static\n"
1062                         "LatexType Paragraph\n"
1063                         "LatexName dummy\n"
1064                         "Align Block\n"
1065                         "AlignPossible Left, Right, Center\n"
1066                         "LabelType No_Label\n"
1067                         "End";
1068         istringstream ss(s);
1069         Lexer lex(textClassTags);
1070         lex.setStream(ss);
1071         defaultLayout = new Layout;
1072         defaultLayout->setUnknown(unknown);
1073         defaultLayout->setName(name);
1074         if (!readStyle(lex, *defaultLayout)) {
1075                 // The only way this happens is because the hardcoded layout above
1076                 // is wrong.
1077                 LASSERT(false, /**/);
1078         };
1079         return *defaultLayout;
1080 }
1081
1082 /////////////////////////////////////////////////////////////////////////
1083 //
1084 // DocumentClassBundle
1085 //
1086 /////////////////////////////////////////////////////////////////////////
1087
1088 DocumentClassBundle::~DocumentClassBundle()
1089 {
1090         for (size_t i = 0; i != documentClasses_.size(); ++i)
1091                 delete documentClasses_[i];
1092         documentClasses_.clear();
1093 }
1094
1095 DocumentClass & DocumentClassBundle::newClass(LayoutFile const & baseClass)
1096 {
1097         DocumentClass * dc = new DocumentClass(baseClass);
1098         documentClasses_.push_back(dc);
1099         return *documentClasses_.back();
1100 }
1101
1102
1103 DocumentClassBundle & DocumentClassBundle::get()
1104 {
1105         static DocumentClassBundle singleton;
1106         return singleton;
1107 }
1108
1109
1110 /////////////////////////////////////////////////////////////////////////
1111 //
1112 // DocumentClass
1113 //
1114 /////////////////////////////////////////////////////////////////////////
1115
1116 DocumentClass::DocumentClass(LayoutFile const & tc)
1117         : TextClass(tc)
1118 {}
1119
1120
1121 bool DocumentClass::hasLaTeXLayout(std::string const & lay) const
1122 {
1123         LayoutList::const_iterator it  = layoutlist_.begin();
1124         LayoutList::const_iterator end = layoutlist_.end();
1125         for (; it != end; ++it)
1126                 if (it->latexname() == lay)
1127                         return true;
1128         return false;
1129 }
1130
1131
1132 bool DocumentClass::provides(string const & p) const
1133 {
1134         return provides_.find(p) != provides_.end();
1135 }
1136
1137
1138 bool DocumentClass::hasTocLevels() const
1139 {
1140         return min_toclevel_ != Layout::NOT_IN_TOC;
1141 }
1142
1143
1144 /////////////////////////////////////////////////////////////////////////
1145 //
1146 // PageSides
1147 //
1148 /////////////////////////////////////////////////////////////////////////
1149
1150 ostream & operator<<(ostream & os, PageSides p)
1151 {
1152         switch (p) {
1153         case OneSide:
1154                 os << '1';
1155                 break;
1156         case TwoSides:
1157                 os << '2';
1158                 break;
1159         }
1160         return os;
1161 }
1162
1163
1164 } // namespace lyx