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         /// Default page size
 280         std::string pagesize_;
 281         ///
 282         std::string pagestyle_;
 283         ///
 284         std::string tablestyle_;
 285         ///
 286         std::string class_header_;
 287         ///
 288         docstring defaultlayout_;
 289         /// name of plain layout
 290         static const docstring plain_layout_;
 291         /// preamble text to support layout styles
 292         docstring preamble_;
 293         /// same, but for HTML output
 294         /// this is output as is to the header
 295         docstring htmlpreamble_;
 296         /// same, but specifically for CSS information
 297         docstring htmlstyles_;
 298         /// the paragraph style to use for TOCs, Bibliography, etc
 299         mutable docstring html_toc_section_;
 300         /// latex packages loaded by document class.
 301         std::set<std::string> provides_;
 302         /// latex packages requested by document class.
 303         std::set<std::string> requires_;
 304         ///
 305         std::map<std::string, std::string> package_options_;
 306         /// default modules wanted by document class
 307         LayoutModuleList default_modules_;
 308         /// modules provided by document class
 309         LayoutModuleList provided_modules_;
 310         /// modules excluded by document class
 311         LayoutModuleList excluded_modules_;
 312         ///
 313         unsigned int columns_;
 314         ///
 315         PageSides sides_;
 316         /// header depth to have numbering
 317         int secnumdepth_;
 318         /// header depth to appear in table of contents
 319         int tocdepth_;
 320         /// Can be LaTeX, DocBook, etc.
 321         OutputType outputType_;
 322         /// Can be latex, docbook ... (the name of a format)
 323         std::string outputFormat_;
 324         /// Does this class redefine the output format?
 325         bool has_output_format_;
 326         /** Base font. The paragraph and layout fonts are resolved against
 327             this font. This has to be fully instantiated. Attributes
 328             FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
 329             extremely illegal.
 330         */
 331         FontInfo defaultfont_;
 332         /// Text that dictates how wide the left margin is on the screen
 333         docstring leftmargin_;
 334         /// Text that dictates how wide the right margin is on the screen
 335         docstring rightmargin_;
 336         /// The type of command used to produce a title
 337         TitleLatexType titletype_;
 338         /// The name of the title command
 339         std::string titlename_;
 340         /// Input layouts available to this layout
 341         InsetLayouts insetlayoutlist_;
 342         /// The minimal TocLevel of sectioning layouts
 343         int min_toclevel_;
 344         /// The maximal TocLevel of sectioning layouts
 345         int max_toclevel_;
 346         /// Citation formatting information
 347         std::map<CiteEngineType, std::map<std::string, std::string> > cite_formats_;
 348         /// Citation macros
 349         std::map<CiteEngineType, std::map<std::string, std::string> > cite_macros_;
 350         /// The default BibTeX bibliography style file
 351         std::map<std::string, std::string> cite_default_biblio_style_;
 352         /// Citation command aliases
 353         std::map<std::string, std::string> cite_command_aliases_;
 354         /// The maximum number of citations before "et al."
 355         size_t maxcitenames_;
 356         /// Whether full author lists are supported
 357         bool cite_full_author_list_;
 358         /// The possible citation styles
 359         std::map<CiteEngineType, std::vector<CitationStyle> > cite_styles_;
 360         /// Class-added citation styles
 361         std::map<CiteEngineType, std::vector<CitationStyle> > class_cite_styles_;
 362         ///
 363         std::map<std::string, docstring> outliner_names_;
 364         /// Does this class put the bibliography to toc by itself?
 365         bool bibintoc_;
 366 private:
 367         ///////////////////////////////////////////////////////////////////
 368         // helper routines for reading layout files
 369         ///////////////////////////////////////////////////////////////////
 370         ///
 371         bool deleteLayout(docstring const &);
 372         ///
 373         bool deleteInsetLayout(docstring const &);
 374         ///
 375         bool convertLayoutFormat(support::FileName const &, ReadType);
 376         /// Reads the layout file without running layout2layout.
 377         ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
 378         /// \return true for success.
 379         bool readStyle(Lexer &, Layout &) const;
 380         ///
 381         void readOutputType(Lexer &);
 382         ///
 383         void readTitleType(Lexer &);
 384         ///
 385         void readMaxCounter(Lexer &);
 386         ///
 387         void readClassOptions(Lexer &);
 388         ///
 389         void readCharStyle(Lexer &, std::string const &);
 390         ///
 391         bool readFloat(Lexer &);
 392         ///
 393         std::vector<CitationStyle> const & getCiteStyles(CiteEngineType const &) const;
 394         ///
 395         bool readCiteEngine(Lexer &, ReadType, bool const add = false);
 396         ///
 397         int readCiteEngineType(Lexer &) const;
 398         ///
 399         bool readCiteFormat(Lexer &, ReadType);
 400         ///
 401         bool readOutlinerName(Lexer &);
 402 };
 403
 404
 405 /// A DocumentClass represents the layout information associated with a
 406 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
 407 /// various Modules.
 408 ///
 409 /// In that regard, DocumentClass objects are "dynamic". But this is really
 410 /// an illusion, since DocumentClass objects are not (currently) changed
 411 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
 412 /// discarded---actually, it will be kept around if something on the cut
 413 /// stack needs it---and a new one is created from scratch.
 414 class DocumentClass : public TextClass {
 415 public:
 416         ///
 417         virtual ~DocumentClass() {}
 418
 419         ///////////////////////////////////////////////////////////////////
 420         // Layout Info
 421         ///////////////////////////////////////////////////////////////////
 422         /// \return true if there is a Layout with latexname lay
 423         bool hasLaTeXLayout(std::string const & lay) const;
 424         /// A DocumentClass nevers count as loaded, since it is dynamic
 425         virtual bool loaded() const { return false; }
 426         /// \return the layout object of an inset given by name. If the name
 427         /// is not found as such, the part after the ':' is stripped off, and
 428         /// searched again. In this way, an error fallback can be provided:
 429         /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
 430         /// will invoke the layout object defined by name = 'CharStyle'.
 431         /// If that doesn't work either, an empty object returns (shouldn't
 432         /// happen).  -- Idea JMarc, comment MV
 433         InsetLayout const & insetLayout(docstring const & name) const;
 434         /// a plain inset layout for use as a default
 435         static InsetLayout const & plainInsetLayout();
 436         /// add a new layout \c name if it does not exist in layoutlist_
 437         /// \return whether we had to add one.
 438         bool addLayoutIfNeeded(docstring const & name) const;
 439         /// Forced layouts in layout file syntax
 440         std::string forcedLayouts() const;
 441
 442         ///////////////////////////////////////////////////////////////////
 443         // accessors
 444         ///////////////////////////////////////////////////////////////////
 445         /// the list of floats defined in the document class
 446         FloatList const & floats() const { return floatlist_; }
 447         ///
 448         Counters & counters() const { return counters_; }
 449         ///
 450         std::string const & opt_enginetype() const { return opt_enginetype_; }
 451         ///
 452         std::string const & citeFramework() const { return citeframework_; }
 453         ///
 454         std::string const & opt_fontsize() const { return opt_fontsize_; }
 455         ///
 456         std::string const & opt_pagesize() const { return opt_pagesize_; }
 457         ///
 458         std::string const & opt_pagestyle() const { return opt_pagestyle_; }
 459         ///
 460         std::string const & options() const { return options_; }
 461         ///
 462         std::string const & class_header() const { return class_header_; }
 463         ///
 464         std::string const & pagesize() const { return pagesize_; }
 465         ///
 466         std::string const & pagestyle() const { return pagestyle_; }
 467         ///
 468         std::string const & tablestyle() const { return tablestyle_; }
 469         ///
 470         docstring const & preamble() const { return preamble_; }
 471         ///
 472         docstring const & htmlpreamble() const { return htmlpreamble_; }
 473         ///
 474         docstring const & htmlstyles() const { return htmlstyles_; }
 475         /// Looks for the layout of "highest level", other than Part (or other
 476         /// layouts with a negative toc number), for use in constructing TOCs and
 477         /// similar information.
 478         Layout const & getTOCLayout() const;
 479         /// the paragraph style to use for TOCs, Bibliography, etc
 480         /// we will attempt to calculate this if it was not given
 481         Layout const & htmlTOCLayout() const;
 482         /// is this feature already provided by the class?
 483         bool provides(std::string const & p) const;
 484         /// features required by the class?
 485         std::set<std::string> const & requires() const { return requires_; }
 486         /// package options to write to LaTeX file
 487         std::map<std::string, std::string> const & packageOptions() const
 488                 { return package_options_; }
 489         ///
 490         unsigned int columns() const { return columns_; }
 491         ///
 492         PageSides sides() const { return sides_; }
 493         ///
 494         int secnumdepth() const { return secnumdepth_; }
 495         ///
 496         int tocdepth() const { return tocdepth_; }
 497         ///
 498         FontInfo const & defaultfont() const { return defaultfont_; }
 499         /// Text that dictates how wide the left margin is on the screen
 500         docstring const & leftmargin() const { return leftmargin_; }
 501         /// Text that dictates how wide the right margin is on the screen
 502         docstring const & rightmargin() const { return rightmargin_; }
 503         /// The type of command used to produce a title
 504         TitleLatexType titletype() const { return titletype_; }
 505         /// The name of the title command
 506         std::string const & titlename() const { return titlename_; }
 507         ///
 508         int size() const { return layoutlist_.size(); }
 509         /// The minimal TocLevel of sectioning layouts
 510         int min_toclevel() const { return min_toclevel_; }
 511         /// The maximal TocLevel of sectioning layouts
 512         int max_toclevel() const { return max_toclevel_; }
 513         /// returns true if the class has a ToC structure
 514         bool hasTocLevels() const;
 515         ///
 516         std::string const getCiteFormat(CiteEngineType const & type,
 517                 std::string const & entry, bool const punct = true,
 518                 std::string const & fallback = "") const;
 519         ///
 520         std::string const & getCiteMacro(CiteEngineType const & type,
 521                 std::string const & macro) const;
 522         ///
 523         std::vector<std::string> const citeCommands(CiteEngineType const &) const;
 524         ///
 525         std::vector<CitationStyle> const & citeStyles(CiteEngineType const &) const;
 526         ///
 527         std::map<std::string, std::string> const & defaultBiblioStyle() const
 528         { return cite_default_biblio_style_; }
 529         ///
 530         std::map<std::string, std::string> const & citeCommandAliases() const
 531         { return cite_command_aliases_; }
 532         /// The maximum number of citations before "et al."
 533         size_t max_citenames() const { return maxcitenames_; }
 534         ///
 535         bool const & fullAuthorList() const { return cite_full_author_list_; }
 536         ///
 537         bool const & bibInToc() const { return bibintoc_; }
 538 protected:
 539         /// Constructs a DocumentClass based upon a LayoutFile.
 540         DocumentClass(LayoutFile const & tc);
 541         /// Needed in tex2lyx
 542         DocumentClass() {}
 543 private:
 544         /// The only way to make a DocumentClass is to call this function.
 545         friend DocumentClassPtr
 546                 getDocumentClass(LayoutFile const &, LayoutModuleList const &,
 547                                  std::string const &,
 548                                  bool const clone);
 549 };
 550
 551
 552 /// The only way to make a DocumentClass is to call this function.
 553 /// The shared_ptr is needed because DocumentClass objects can be kept
 554 /// in memory long after their associated Buffer is destroyed, mostly
 555 /// on the CutStack.
 556 DocumentClassPtr getDocumentClass(LayoutFile const & baseClass,
 557                         LayoutModuleList const & modlist,
 558                         std::string const & cengine = std::string(),
 559                         bool const clone = false);
 560
 561 /// convert page sides option to text 1 or 2
 562 std::ostream & operator<<(std::ostream & os, PageSides p);
 563
 564 /// current format of layout files
 565 extern int const LAYOUT_FORMAT;
 566 /// layout format for the current lyx file format (usually equal to
 567 /// LAYOUT_FORMAT)
 568 extern int const LYXFILE_LAYOUT_FORMAT;
 569
 570
 571 } // namespace lyx
 572
 573 #endif