src/TextClass.h

   1 // -*- C++ -*-
   2 /**
   3  * \file TextClass.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * Full author contact details are available in file CREDITS.
   8  */
   9
  10 #ifndef TEXTCLASS_H
  11 #define TEXTCLASS_H
  12
  13 #include "Citation.h"
  14 #include "Counters.h"
  15 #include "DocumentClassPtr.h"
  16 #include "FloatList.h"
  17 #include "FontInfo.h"
  18 #include "Layout.h"
  19 #include "LayoutEnums.h"
  20 #include "LayoutModuleList.h"
  21
  22 #include "insets/InsetLayout.h"
  23
  24 #include "support/docstring.h"
  25 #include "support/types.h"
  26
  27 #include <list>
  28 #include <map>
  29 #include <set>
  30 #include <string>
  31 #include <vector>
  32
  33 #ifdef ERROR
  34 #undef ERROR
  35 #endif
  36
  37 namespace lyx {
  38
  39 namespace support { class FileName; }
  40
  41 class Counters;
  42 class FloatList;
  43 class Layout;
  44 class LayoutFile;
  45 class Lexer;
  46
  47 /// Based upon ideas in boost::noncopyable, inheriting from this
  48 /// class effectively makes the copy constructor protected but the
  49 /// assignment constructor private.
  50 class ProtectCopy
  51 {
  52 protected:
  53         ProtectCopy() {}
  54         ~ProtectCopy() {}
  55         ProtectCopy(const ProtectCopy &) {}
  56 private:
  57         const ProtectCopy & operator=(const ProtectCopy &);
  58 };
  59
  60
  61 /// A TextClass represents a collection of layout information: At the
  62 /// moment, this includes Layout's and InsetLayout's.
  63 ///
  64 /// There are two major subclasses of TextClass: LayoutFile and
  65 /// DocumentClass. These subclasses are what are actually used in LyX.
  66 /// Simple TextClass objects are not directly constructed in the main
  67 /// LyX code---the constructor is protected. (That said, in tex2lyx
  68 /// there are what amount to simple TextClass objects.)
  69 ///
  70 /// A LayoutFile (see LayoutFile.{h,cpp}) represents a *.layout file.
  71 /// These are generally static objects---though they can be reloaded
  72 /// from disk via LFUN_LAYOUT_RELOAD, so one should not assume that
  73 /// they will never change.
  74 ///
  75 /// A DocumentClass (see below) represents the layout information that
  76 /// is associated with a given Buffer. These are static, in the sense
  77 /// that they will not themselves change, but which DocumentClass is
  78 /// associated with a Buffer can change, as modules are loaded and
  79 /// unloaded, for example.
  80 ///
  81 class TextClass : protected ProtectCopy {
  82 public:
  83         ///
  84         virtual ~TextClass() {}
  85         ///////////////////////////////////////////////////////////////////
  86         // typedefs
  87         ///////////////////////////////////////////////////////////////////
  88         // NOTE Do NOT try to make this a container of Layout pointers, e.g.,
  89         // std::list<Layout *>. This will lead to problems. The reason is
  90         // that DocumentClass objects are generally created by copying a
  91         // LayoutFile, which serves as a base for the DocumentClass. If the
  92         // LayoutList is a container of pointers, then every DocumentClass
  93         // that derives from a given LayoutFile (e.g., article) will SHARE
  94         // a basic set of layouts. So if one Buffer were to modify a layout
  95         // (say, Standard), that would modify that layout for EVERY Buffer
  96         // that was based upon the same DocumentClass.
  97         //
  98         // NOTE: Layout pointers are directly assigned to paragraphs so a
  99         // container that does not invalidate these pointers after insertion
 100         // is needed.
 101         /// The individual paragraph layouts comprising the document class
 102         typedef std::list<Layout> LayoutList;
 103         /// The inset layouts available to this class
 104         typedef std::map<docstring, InsetLayout> InsetLayouts;
 105         ///
 106         typedef LayoutList::const_iterator const_iterator;
 107
 108         ///////////////////////////////////////////////////////////////////
 109         // Iterators
 110         ///////////////////////////////////////////////////////////////////
 111         ///
 112         const_iterator begin() const { return layoutlist_.begin(); }
 113         ///
 114         const_iterator end() const { return layoutlist_.end(); }
 115
 116
 117         ///////////////////////////////////////////////////////////////////
 118         // Layout Info
 119         ///////////////////////////////////////////////////////////////////
 120         ///
 121         Layout const & defaultLayout() const;
 122         ///
 123         docstring const & defaultLayoutName() const;
 124         ///
 125         bool isDefaultLayout(Layout const &) const;
 126         ///
 127         bool isPlainLayout(Layout const &) const;
 128         /// returns a special layout for use when we don't really want one,
 129         /// e.g., in table cells
 130         Layout const & plainLayout() const
 131                         { return operator[](plain_layout_); }
 132         /// the name of the plain layout
 133         docstring const & plainLayoutName() const
 134                         { return plain_layout_; }
 135         /// Enumerate the paragraph styles.
 136         size_t layoutCount() const { return layoutlist_.size(); }
 137         ///
 138         bool hasLayout(docstring const & name) const;
 139         ///
 140         bool hasInsetLayout(docstring const & name) const;
 141         ///
 142         Layout const & operator[](docstring const & vname) const;
 143         /// Inset layouts of this doc class
 144         InsetLayouts const & insetLayouts() const { return insetlayoutlist_; }
 145
 146         ///////////////////////////////////////////////////////////////////
 147         // reading routines
 148         ///////////////////////////////////////////////////////////////////
 149         /// Enum used with TextClass::read
 150         enum ReadType {
 151                 BASECLASS, //>This is a base class, i.e., top-level layout file
 152                 MERGE, //>This is a file included in a layout file
 153                 MODULE, //>This is a layout module
 154                 CITE_ENGINE, //>This is a cite engine
 155                 VALIDATION //>We're just validating
 156         };
 157         /// return values for read()
 158         enum ReturnValues {
 159                 OK,
 160                 OK_OLDFORMAT,
 161                 ERROR,
 162                 FORMAT_MISMATCH
 163         };
 164
 165         /// Performs the read of the layout file.
 166         /// \return true on success.
 167         // FIXME Should return ReturnValues....
 168         bool read(support::FileName const & filename, ReadType rt = BASECLASS);
 169         ///
 170         ReturnValues read(std::string const & str, ReadType rt = MODULE);
 171         ///
 172         ReturnValues read(Lexer & lex, ReadType rt = BASECLASS);
 173         /// validates the layout information passed in str
 174         static ReturnValues validate(std::string const & str);
 175         /// \return the conversion of \param str to the latest layout format
 176         /// compatible with the lyx format.
 177         static std::string convert(std::string const & str);
 178
 179         ///////////////////////////////////////////////////////////////////
 180         // loading
 181         ///////////////////////////////////////////////////////////////////
 182         /// Sees to it the textclass structure has been loaded
 183         /// This function will search for $classname.layout in default directories
 184         /// and an optional path, but if path points to a file, it will be loaded
 185         /// directly.
 186         bool load(std::string const & path = std::string()) const;
 187         /// Has this layout file been loaded yet?
 188         /// Overridden by DocumentClass
 189         virtual bool loaded() const { return loaded_; }
 190
 191         ///////////////////////////////////////////////////////////////////
 192         // accessors
 193         ///////////////////////////////////////////////////////////////////
 194         ///
 195         std::string const & name() const { return name_; }
 196         ///
 197         std::string const & path() const { return path_; }
 198         ///
 199         std::string const & category() const { return category_; }
 200         ///
 201         std::string const & description() const { return description_; }
 202         ///
 203         std::string const & latexname() const { return latexname_; }
 204         ///
 205         std::string const & prerequisites(std::string const & sep = "\n\t") const;
 206         /// Can be LaTeX, DocBook, etc.
 207         OutputType outputType() const { return outputType_; }
 208         /// Can be latex, docbook ... (the name of a format)
 209         std::string outputFormat() const { return outputFormat_; }
 210         /// Does this class redefine the output format?
 211         bool hasOutputFormat() const { return has_output_format_; }
 212         /// Return the non-localised names for the toc types.
 213         std::map<std::string, docstring> const &
 214         outlinerNames() const { return outliner_names_; }
 215
 216 protected:
 217         /// Protect construction
 218         TextClass();
 219         ///
 220         Layout & operator[](docstring const & name);
 221         /** Create an new, very basic layout for this textclass. This is used for
 222             the Plain Layout common to all TextClass objects and also, in
 223             DocumentClass, for the creation of new layouts `on the fly' when
 224             previously unknown layouts are encountered.
 225             \param unknown Set to true if this layout is used to represent an
 226             unknown layout
 227          */
 228         Layout createBasicLayout(docstring const & name, bool unknown = false) const;
 229
 230         ///////////////////////////////////////////////////////////////////
 231         // non-const iterators
 232         ///////////////////////////////////////////////////////////////////
 233         ///
 234         typedef LayoutList::iterator iterator;
 235         ///
 236         iterator begin() { return layoutlist_.begin(); }
 237         ///
 238         iterator end() { return layoutlist_.end(); }
 239
 240         ///////////////////////////////////////////////////////////////////
 241         // members
 242         ///////////////////////////////////////////////////////////////////
 243         /// Paragraph styles used in this layout
 244         /// This variable is mutable because unknown layouts can be added
 245         /// to const textclass.
 246         mutable LayoutList layoutlist_;
 247         /// Layout file name
 248         std::string name_;
 249         /// Layout file path (empty for system layout files)
 250         std::string path_;
 251         /// Class category
 252         std::string category_;
 253         /// document class name
 254         std::string latexname_;
 255         /// document class description
 256         std::string description_;
 257         /// available types of float, eg. figure, algorithm.
 258         mutable FloatList floatlist_;
 259         /// Types of counters, eg. sections, eqns, figures, avail. in document class.
 260         mutable Counters counters_;
 261         /// Has this layout file been loaded yet?
 262         mutable bool loaded_;
 263         /// Is the TeX class available?
 264         bool tex_class_avail_;
 265         /// document class prerequisites
 266         mutable std::string prerequisites_;
 267         /// The possible cite engine types
 268         std::string opt_enginetype_;
 269         /// The cite framework (bibtex, biblatex)
 270         std::string citeframework_;
 271         ///
 272         std::string opt_fontsize_;
 273         ///
 274         std::string opt_pagesize_;
 275         ///
 276         std::string opt_pagestyle_;
 277         /// Specific class options
 278         std::string options_;
 279         /// Format of the fontsize option
 280         std::string fontsize_format_;
 281         /// Default page size
 282         std::string pagesize_;
 283         /// Format of the papersize option
 284         std::string pagesize_format_;
 285         ///
 286         std::string pagestyle_;
 287         ///
 288         std::string tablestyle_;
 289         ///
 290         std::string class_header_;
 291         ///
 292         docstring defaultlayout_;
 293         /// name of plain layout
 294         static const docstring plain_layout_;
 295         /// preamble text to support layout styles
 296         docstring preamble_;
 297         /// same, but for HTML output
 298         /// this is output as is to the header
 299         docstring htmlpreamble_;
 300         /// same, but specifically for CSS information
 301         docstring htmlstyles_;
 302         /// the paragraph style to use for TOCs, Bibliography, etc
 303         mutable docstring html_toc_section_;
 304         /// latex packages loaded by document class.
 305         std::set<std::string> provides_;
 306         /// latex packages requested by document class.
 307         std::set<std::string> requires_;
 308         ///
 309         std::map<std::string, std::string> package_options_;
 310         /// default modules wanted by document class
 311         LayoutModuleList default_modules_;
 312         /// modules provided by document class
 313         LayoutModuleList provided_modules_;
 314         /// modules excluded by document class
 315         LayoutModuleList excluded_modules_;
 316         ///
 317         unsigned int columns_;
 318         ///
 319         PageSides sides_;
 320         /// header depth to have numbering
 321         int secnumdepth_;
 322         /// header depth to appear in table of contents
 323         int tocdepth_;
 324         /// Can be LaTeX, DocBook, etc.
 325         OutputType outputType_;
 326         /// Can be latex, docbook ... (the name of a format)
 327         std::string outputFormat_;
 328         /// Does this class redefine the output format?
 329         bool has_output_format_;
 330         /** Base font. The paragraph and layout fonts are resolved against
 331             this font. This has to be fully instantiated. Attributes
 332             FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
 333             extremely illegal.
 334         */
 335         FontInfo defaultfont_;
 336         /// Text that dictates how wide the left margin is on the screen
 337         docstring leftmargin_;
 338         /// Text that dictates how wide the right margin is on the screen
 339         docstring rightmargin_;
 340         /// The type of command used to produce a title
 341         TitleLatexType titletype_;
 342         /// The name of the title command
 343         std::string titlename_;
 344         /// Input layouts available to this layout
 345         InsetLayouts insetlayoutlist_;
 346         /// The minimal TocLevel of sectioning layouts
 347         int min_toclevel_;
 348         /// The maximal TocLevel of sectioning layouts
 349         int max_toclevel_;
 350         /// Citation formatting information
 351         std::map<CiteEngineType, std::map<std::string, std::string> > cite_formats_;
 352         /// Citation macros
 353         std::map<CiteEngineType, std::map<std::string, std::string> > cite_macros_;
 354         /// The default BibTeX bibliography style file
 355         std::map<std::string, std::string> cite_default_biblio_style_;
 356         /// Citation command aliases
 357         std::map<std::string, std::string> cite_command_aliases_;
 358         /// The maximum number of citations before "et al."
 359         size_t maxcitenames_;
 360         /// Whether full author lists are supported
 361         bool cite_full_author_list_;
 362         /// The possible citation styles
 363         std::map<CiteEngineType, std::vector<CitationStyle> > cite_styles_;
 364         /// Class-added citation styles
 365         std::map<CiteEngineType, std::vector<CitationStyle> > class_cite_styles_;
 366         ///
 367         std::map<std::string, docstring> outliner_names_;
 368         /// Does this class put the bibliography to toc by itself?
 369         bool bibintoc_;
 370 private:
 371         ///////////////////////////////////////////////////////////////////
 372         // helper routines for reading layout files
 373         ///////////////////////////////////////////////////////////////////
 374         ///
 375         bool deleteLayout(docstring const &);
 376         ///
 377         bool deleteInsetLayout(docstring const &);
 378         ///
 379         bool convertLayoutFormat(support::FileName const &, ReadType);
 380         /// Reads the layout file without running layout2layout.
 381         ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
 382         /// \return true for success.
 383         bool readStyle(Lexer &, Layout &) const;
 384         ///
 385         void readOutputType(Lexer &);
 386         ///
 387         void readTitleType(Lexer &);
 388         ///
 389         void readMaxCounter(Lexer &);
 390         ///
 391         void readClassOptions(Lexer &);
 392         ///
 393         void readCharStyle(Lexer &, std::string const &);
 394         ///
 395         bool readFloat(Lexer &);
 396         ///
 397         std::vector<CitationStyle> const & getCiteStyles(CiteEngineType const &) const;
 398         ///
 399         bool readCiteEngine(Lexer &, ReadType, bool const add = false);
 400         ///
 401         int readCiteEngineType(Lexer &) const;
 402         ///
 403         bool readCiteFormat(Lexer &, ReadType);
 404         ///
 405         bool readOutlinerName(Lexer &);
 406 };
 407
 408
 409 /// A DocumentClass represents the layout information associated with a
 410 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
 411 /// various Modules.
 412 ///
 413 /// In that regard, DocumentClass objects are "dynamic". But this is really
 414 /// an illusion, since DocumentClass objects are not (currently) changed
 415 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
 416 /// discarded---actually, it will be kept around if something on the cut
 417 /// stack needs it---and a new one is created from scratch.
 418 class DocumentClass : public TextClass {
 419 public:
 420         ///
 421         virtual ~DocumentClass() {}
 422
 423         ///////////////////////////////////////////////////////////////////
 424         // Layout Info
 425         ///////////////////////////////////////////////////////////////////
 426         /// \return true if there is a Layout with latexname lay
 427         bool hasLaTeXLayout(std::string const & lay) const;
 428         /// A DocumentClass nevers count as loaded, since it is dynamic
 429         virtual bool loaded() const { return false; }
 430         /// \return the layout object of an inset given by name. If the name
 431         /// is not found as such, the part after the ':' is stripped off, and
 432         /// searched again. In this way, an error fallback can be provided:
 433         /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
 434         /// will invoke the layout object defined by name = 'CharStyle'.
 435         /// If that doesn't work either, an empty object returns (shouldn't
 436         /// happen).  -- Idea JMarc, comment MV
 437         InsetLayout const & insetLayout(docstring const & name) const;
 438         /// a plain inset layout for use as a default
 439         static InsetLayout const & plainInsetLayout();
 440         /// add a new layout \c name if it does not exist in layoutlist_
 441         /// \return whether we had to add one.
 442         bool addLayoutIfNeeded(docstring const & name) const;
 443         /// Forced layouts in layout file syntax
 444         std::string forcedLayouts() const;
 445
 446         ///////////////////////////////////////////////////////////////////
 447         // accessors
 448         ///////////////////////////////////////////////////////////////////
 449         /// the list of floats defined in the document class
 450         FloatList const & floats() const { return floatlist_; }
 451         ///
 452         Counters & counters() const { return counters_; }
 453         ///
 454         std::string const & opt_enginetype() const { return opt_enginetype_; }
 455         ///
 456         std::string const & citeFramework() const { return citeframework_; }
 457         ///
 458         std::string const & opt_fontsize() const { return opt_fontsize_; }
 459         ///
 460         std::string const & opt_pagesize() const { return opt_pagesize_; }
 461         ///
 462         std::string const & opt_pagestyle() const { return opt_pagestyle_; }
 463         ///
 464         std::string const & options() const { return options_; }
 465         ///
 466         std::string const & class_header() const { return class_header_; }
 467         ///
 468         std::string const & fontsizeformat() const { return fontsize_format_; }
 469         ///
 470         std::string const & pagesize() const { return pagesize_; }
 471         ///
 472         std::string const & pagesizeformat() const { return pagesize_format_; }
 473         ///
 474         std::string const & pagestyle() const { return pagestyle_; }
 475         ///
 476         std::string const & tablestyle() const { return tablestyle_; }
 477         ///
 478         docstring const & preamble() const { return preamble_; }
 479         ///
 480         docstring const & htmlpreamble() const { return htmlpreamble_; }
 481         ///
 482         docstring const & htmlstyles() const { return htmlstyles_; }
 483         /// Looks for the layout of "highest level", other than Part (or other
 484         /// layouts with a negative toc number), for use in constructing TOCs and
 485         /// similar information.
 486         Layout const & getTOCLayout() const;
 487         /// the paragraph style to use for TOCs, Bibliography, etc
 488         /// we will attempt to calculate this if it was not given
 489         Layout const & htmlTOCLayout() const;
 490         /// is this feature already provided by the class?
 491         bool provides(std::string const & p) const;
 492         /// features required by the class?
 493         std::set<std::string> const & required() const { return requires_; }
 494         /// package options to write to LaTeX file
 495         std::map<std::string, std::string> const & packageOptions() const
 496                 { return package_options_; }
 497         ///
 498         unsigned int columns() const { return columns_; }
 499         ///
 500         PageSides sides() const { return sides_; }
 501         ///
 502         int secnumdepth() const { return secnumdepth_; }
 503         ///
 504         int tocdepth() const { return tocdepth_; }
 505         ///
 506         FontInfo const & defaultfont() const { return defaultfont_; }
 507         /// Text that dictates how wide the left margin is on the screen
 508         docstring const & leftmargin() const { return leftmargin_; }
 509         /// Text that dictates how wide the right margin is on the screen
 510         docstring const & rightmargin() const { return rightmargin_; }
 511         /// The type of command used to produce a title
 512         TitleLatexType titletype() const { return titletype_; }
 513         /// The name of the title command
 514         std::string const & titlename() const { return titlename_; }
 515         ///
 516         int size() const { return layoutlist_.size(); }
 517         /// The minimal TocLevel of sectioning layouts
 518         int min_toclevel() const { return min_toclevel_; }
 519         /// The maximal TocLevel of sectioning layouts
 520         int max_toclevel() const { return max_toclevel_; }
 521         /// returns true if the class has a ToC structure
 522         bool hasTocLevels() const;
 523         ///
 524         std::string const getCiteFormat(CiteEngineType const & type,
 525                 std::string const & entry, bool const punct = true,
 526                 std::string const & fallback = "") const;
 527         ///
 528         std::string const & getCiteMacro(CiteEngineType const & type,
 529                 std::string const & macro) const;
 530         ///
 531         std::vector<std::string> const citeCommands(CiteEngineType const &) const;
 532         ///
 533         std::vector<CitationStyle> const & citeStyles(CiteEngineType const &) const;
 534         ///
 535         std::map<std::string, std::string> const & defaultBiblioStyle() const
 536         { return cite_default_biblio_style_; }
 537         ///
 538         std::map<std::string, std::string> const & citeCommandAliases() const
 539         { return cite_command_aliases_; }
 540         /// The maximum number of citations before "et al."
 541         size_t max_citenames() const { return maxcitenames_; }
 542         ///
 543         bool const & fullAuthorList() const { return cite_full_author_list_; }
 544         ///
 545         bool const & bibInToc() const { return bibintoc_; }
 546 protected:
 547         /// Constructs a DocumentClass based upon a LayoutFile.
 548         DocumentClass(LayoutFile const & tc);
 549         /// Needed in tex2lyx
 550         DocumentClass() {}
 551 private:
 552         /// The only way to make a DocumentClass is to call this function.
 553         friend DocumentClassPtr
 554                 getDocumentClass(LayoutFile const &, LayoutModuleList const &,
 555                                  std::string const &,
 556                                  bool const clone);
 557 };
 558
 559
 560 /// The only way to make a DocumentClass is to call this function.
 561 /// The shared_ptr is needed because DocumentClass objects can be kept
 562 /// in memory long after their associated Buffer is destroyed, mostly
 563 /// on the CutStack.
 564 DocumentClassPtr getDocumentClass(LayoutFile const & baseClass,
 565                         LayoutModuleList const & modlist,
 566                         std::string const & cengine = std::string(),
 567                         bool const clone = false);
 568
 569 /// convert page sides option to text 1 or 2
 570 std::ostream & operator<<(std::ostream & os, PageSides p);
 571
 572 /// current format of layout files
 573 extern int const LAYOUT_FORMAT;
 574 /// layout format for the current lyx file format (usually equal to
 575 /// LAYOUT_FORMAT)
 576 extern int const LYXFILE_LAYOUT_FORMAT;
 577
 578
 579 } // namespace lyx
 580
 581 #endif