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 & category() const { return category_; }
 198         ///
 199         std::string const & description() const { return description_; }
 200         ///
 201         std::string const & latexname() const { return latexname_; }
 202         ///
 203         std::string const & prerequisites(std::string const & sep = "\n\t") const;
 204         /// Can be LaTeX, DocBook, etc.
 205         OutputType outputType() const { return outputType_; }
 206         /// Can be latex, docbook ... (the name of a format)
 207         std::string outputFormat() const { return outputFormat_; }
 208         /// Return the non-localised names for the toc types.
 209         std::map<std::string, docstring> const &
 210         outlinerNames() const { return outliner_names_; }
 211
 212 protected:
 213         /// Protect construction
 214         TextClass();
 215         ///
 216         Layout & operator[](docstring const & name);
 217         /** Create an new, very basic layout for this textclass. This is used for
 218             the Plain Layout common to all TextClass objects and also, in
 219             DocumentClass, for the creation of new layouts `on the fly' when
 220             previously unknown layouts are encountered.
 221             \param unknown Set to true if this layout is used to represent an
 222             unknown layout
 223          */
 224         Layout createBasicLayout(docstring const & name, bool unknown = false) const;
 225
 226         ///////////////////////////////////////////////////////////////////
 227         // non-const iterators
 228         ///////////////////////////////////////////////////////////////////
 229         ///
 230         typedef LayoutList::iterator iterator;
 231         ///
 232         iterator begin() { return layoutlist_.begin(); }
 233         ///
 234         iterator end() { return layoutlist_.end(); }
 235
 236         ///////////////////////////////////////////////////////////////////
 237         // members
 238         ///////////////////////////////////////////////////////////////////
 239         /// Paragraph styles used in this layout
 240         /// This variable is mutable because unknown layouts can be added
 241         /// to const textclass.
 242         mutable LayoutList layoutlist_;
 243         /// Layout file name
 244         std::string name_;
 245         /// Class category
 246         std::string category_;
 247         /// document class name
 248         std::string latexname_;
 249         /// document class description
 250         std::string description_;
 251         /// available types of float, eg. figure, algorithm.
 252         mutable FloatList floatlist_;
 253         /// Types of counters, eg. sections, eqns, figures, avail. in document class.
 254         mutable Counters counters_;
 255         /// Has this layout file been loaded yet?
 256         mutable bool loaded_;
 257         /// Is the TeX class available?
 258         bool tex_class_avail_;
 259         /// document class prerequisites
 260         mutable std::string prerequisites_;
 261         /// The possible cite engine types
 262         std::string opt_enginetype_;
 263         /// The cite framework (bibtex, biblatex)
 264         std::string citeframework_;
 265         ///
 266         std::string opt_fontsize_;
 267         ///
 268         std::string opt_pagestyle_;
 269         /// Specific class options
 270         std::string options_;
 271         ///
 272         std::string pagestyle_;
 273         ///
 274         std::string class_header_;
 275         ///
 276         docstring defaultlayout_;
 277         /// name of plain layout
 278         static const docstring plain_layout_;
 279         /// preamble text to support layout styles
 280         docstring preamble_;
 281         /// same, but for HTML output
 282         /// this is output as is to the header
 283         docstring htmlpreamble_;
 284         /// same, but specifically for CSS information
 285         docstring htmlstyles_;
 286         /// the paragraph style to use for TOCs, Bibliography, etc
 287         mutable docstring html_toc_section_;
 288         /// latex packages loaded by document class.
 289         std::set<std::string> provides_;
 290         /// latex packages requested by document class.
 291         std::set<std::string> requires_;
 292         ///
 293         std::map<std::string, std::string> package_options_;
 294         /// default modules wanted by document class
 295         LayoutModuleList default_modules_;
 296         /// modules provided by document class
 297         LayoutModuleList provided_modules_;
 298         /// modules excluded by document class
 299         LayoutModuleList excluded_modules_;
 300         ///
 301         unsigned int columns_;
 302         ///
 303         PageSides sides_;
 304         /// header depth to have numbering
 305         int secnumdepth_;
 306         /// header depth to appear in table of contents
 307         int tocdepth_;
 308         /// Can be LaTeX, DocBook, etc.
 309         OutputType outputType_;
 310         /// Can be latex, docbook ... (the name of a format)
 311         std::string outputFormat_;
 312         /** Base font. The paragraph and layout fonts are resolved against
 313             this font. This has to be fully instantiated. Attributes
 314             FONT_INHERIT, FONT_IGNORE, and FONT_TOGGLE are
 315             extremely illegal.
 316         */
 317         FontInfo defaultfont_;
 318         /// Text that dictates how wide the left margin is on the screen
 319         docstring leftmargin_;
 320         /// Text that dictates how wide the right margin is on the screen
 321         docstring rightmargin_;
 322         /// The type of command used to produce a title
 323         TitleLatexType titletype_;
 324         /// The name of the title command
 325         std::string titlename_;
 326         /// Input layouts available to this layout
 327         InsetLayouts insetlayoutlist_;
 328         /// The minimal TocLevel of sectioning layouts
 329         int min_toclevel_;
 330         /// The maximal TocLevel of sectioning layouts
 331         int max_toclevel_;
 332         /// Citation formatting information
 333         std::map<CiteEngineType, std::map<std::string, std::string> > cite_formats_;
 334         /// Citation macros
 335         std::map<CiteEngineType, std::map<std::string, std::string> > cite_macros_;
 336         /// The default BibTeX bibliography style file
 337         std::map<std::string, std::string> cite_default_biblio_style_;
 338         /// Citation command aliases
 339         std::map<std::string, std::string> cite_command_aliases_;
 340         /// The maximum number of citations before "et al."
 341         size_t maxcitenames_;
 342         /// Whether full author lists are supported
 343         bool cite_full_author_list_;
 344         /// The possible citation styles
 345         std::map<CiteEngineType, std::vector<CitationStyle> > cite_styles_;
 346         ///
 347         std::map<std::string, docstring> outliner_names_;
 348 private:
 349         ///////////////////////////////////////////////////////////////////
 350         // helper routines for reading layout files
 351         ///////////////////////////////////////////////////////////////////
 352         ///
 353         bool deleteLayout(docstring const &);
 354         ///
 355         bool deleteInsetLayout(docstring const &);
 356         ///
 357         bool convertLayoutFormat(support::FileName const &, ReadType);
 358         /// Reads the layout file without running layout2layout.
 359         ReturnValues readWithoutConv(support::FileName const & filename, ReadType rt);
 360         /// \return true for success.
 361         bool readStyle(Lexer &, Layout &) const;
 362         ///
 363         void readOutputType(Lexer &);
 364         ///
 365         void readTitleType(Lexer &);
 366         ///
 367         void readMaxCounter(Lexer &);
 368         ///
 369         void readClassOptions(Lexer &);
 370         ///
 371         void readCharStyle(Lexer &, std::string const &);
 372         ///
 373         bool readFloat(Lexer &);
 374         ///
 375         bool readCiteEngine(Lexer &);
 376         ///
 377         int readCiteEngineType(Lexer &) const;
 378         ///
 379         bool readCiteFormat(Lexer &);
 380         ///
 381         bool readOutlinerName(Lexer &);
 382 };
 383
 384
 385 /// A DocumentClass represents the layout information associated with a
 386 /// Buffer. It is based upon a LayoutFile, but may be modified by loading
 387 /// various Modules.
 388 ///
 389 /// In that regard, DocumentClass objects are "dynamic". But this is really
 390 /// an illusion, since DocumentClass objects are not (currently) changed
 391 /// when, say, a new Module is loaded. Rather, the old DocumentClass is
 392 /// discarded---actually, it will be kept around if something on the cut
 393 /// stack needs it---and a new one is created from scratch.
 394 class DocumentClass : public TextClass {
 395 public:
 396         ///
 397         virtual ~DocumentClass() {}
 398
 399         ///////////////////////////////////////////////////////////////////
 400         // Layout Info
 401         ///////////////////////////////////////////////////////////////////
 402         /// \return true if there is a Layout with latexname lay
 403         bool hasLaTeXLayout(std::string const & lay) const;
 404         /// A DocumentClass nevers count as loaded, since it is dynamic
 405         virtual bool loaded() const { return false; }
 406         /// \return the layout object of an inset given by name. If the name
 407         /// is not found as such, the part after the ':' is stripped off, and
 408         /// searched again. In this way, an error fallback can be provided:
 409         /// An erroneous 'CharStyle:badname' (e.g., after a documentclass switch)
 410         /// will invoke the layout object defined by name = 'CharStyle'.
 411         /// If that doesn't work either, an empty object returns (shouldn't
 412         /// happen).  -- Idea JMarc, comment MV
 413         InsetLayout const & insetLayout(docstring const & name) const;
 414         /// a plain inset layout for use as a default
 415         static InsetLayout const & plainInsetLayout();
 416         /// add a new layout \c name if it does not exist in layoutlist_
 417         /// \return whether we had to add one.
 418         bool addLayoutIfNeeded(docstring const & name) const;
 419         /// Forced layouts in layout file syntax
 420         std::string forcedLayouts() const;
 421
 422         ///////////////////////////////////////////////////////////////////
 423         // accessors
 424         ///////////////////////////////////////////////////////////////////
 425         /// the list of floats defined in the document class
 426         FloatList const & floats() const { return floatlist_; }
 427         ///
 428         Counters & counters() const { return counters_; }
 429         ///
 430         std::string const & opt_enginetype() const { return opt_enginetype_; }
 431         ///
 432         std::string const & citeFramework() const { return citeframework_; }
 433         ///
 434         std::string const & opt_fontsize() const { return opt_fontsize_; }
 435         ///
 436         std::string const & opt_pagestyle() const { return opt_pagestyle_; }
 437         ///
 438         std::string const & options() const { return options_; }
 439         ///
 440         std::string const & class_header() const { return class_header_; }
 441         ///
 442         std::string const & pagestyle() const { return pagestyle_; }
 443         ///
 444         docstring const & preamble() const { return preamble_; }
 445         ///
 446         docstring const & htmlpreamble() const { return htmlpreamble_; }
 447         ///
 448         docstring const & htmlstyles() const { return htmlstyles_; }
 449         /// Looks for the layout of "highest level", other than Part (or other
 450         /// layouts with a negative toc number), for use in constructing TOCs and
 451         /// similar information.
 452         Layout const & getTOCLayout() const;
 453         /// the paragraph style to use for TOCs, Bibliography, etc
 454         /// we will attempt to calculate this if it was not given
 455         Layout const & htmlTOCLayout() const;
 456         /// is this feature already provided by the class?
 457         bool provides(std::string const & p) const;
 458         /// features required by the class?
 459         std::set<std::string> const & requires() const { return requires_; }
 460         /// package options to write to LaTeX file
 461         std::map<std::string, std::string> const & packageOptions() const
 462                 { return package_options_; }
 463         ///
 464         unsigned int columns() const { return columns_; }
 465         ///
 466         PageSides sides() const { return sides_; }
 467         ///
 468         int secnumdepth() const { return secnumdepth_; }
 469         ///
 470         int tocdepth() const { return tocdepth_; }
 471         ///
 472         FontInfo const & defaultfont() const { return defaultfont_; }
 473         /// Text that dictates how wide the left margin is on the screen
 474         docstring const & leftmargin() const { return leftmargin_; }
 475         /// Text that dictates how wide the right margin is on the screen
 476         docstring const & rightmargin() const { return rightmargin_; }
 477         /// The type of command used to produce a title
 478         TitleLatexType titletype() const { return titletype_; }
 479         /// The name of the title command
 480         std::string const & titlename() const { return titlename_; }
 481         ///
 482         int size() const { return layoutlist_.size(); }
 483         /// The minimal TocLevel of sectioning layouts
 484         int min_toclevel() const { return min_toclevel_; }
 485         /// The maximal TocLevel of sectioning layouts
 486         int max_toclevel() const { return max_toclevel_; }
 487         /// returns true if the class has a ToC structure
 488         bool hasTocLevels() const;
 489         ///
 490         std::string const getCiteFormat(CiteEngineType const & type,
 491                 std::string const & entry, bool const punct = true,
 492                 std::string const & fallback = "") const;
 493         ///
 494         std::string const & getCiteMacro(CiteEngineType const & type,
 495                 std::string const & macro) const;
 496         ///
 497         std::vector<std::string> const citeCommands(CiteEngineType const &) const;
 498         ///
 499         std::vector<CitationStyle> const & citeStyles(CiteEngineType const &) const;
 500         ///
 501         std::map<std::string, std::string> const & defaultBiblioStyle() const
 502         { return cite_default_biblio_style_; }
 503         ///
 504         std::map<std::string, std::string> const & citeCommandAliases() const
 505         { return cite_command_aliases_; }
 506         /// The maximum number of citations before "et al."
 507         size_t max_citenames() const { return maxcitenames_; }
 508         ///
 509         bool const & fullAuthorList() const { return cite_full_author_list_; }
 510 protected:
 511         /// Constructs a DocumentClass based upon a LayoutFile.
 512         DocumentClass(LayoutFile const & tc);
 513         /// Needed in tex2lyx
 514         DocumentClass() {}
 515 private:
 516         /// The only way to make a DocumentClass is to call this function.
 517         friend DocumentClassPtr
 518                 getDocumentClass(LayoutFile const &, LayoutModuleList const &,
 519                                  LayoutModuleList const &,
 520                                  bool const clone);
 521 };
 522
 523
 524 /// The only way to make a DocumentClass is to call this function.
 525 /// The shared_ptr is needed because DocumentClass objects can be kept
 526 /// in memory long after their associated Buffer is destroyed, mostly
 527 /// on the CutStack.
 528 DocumentClassPtr getDocumentClass(LayoutFile const & baseClass,
 529                         LayoutModuleList const & modlist,
 530                         LayoutModuleList const & celist,
 531                         bool const clone = false);
 532
 533 /// convert page sides option to text 1 or 2
 534 std::ostream & operator<<(std::ostream & os, PageSides p);
 535
 536 /// current format of layout files
 537 extern int const LAYOUT_FORMAT;
 538 /// layout format for the current lyx file format (usually equal to
 539 /// LAYOUT_FORMAT)
 540 extern int const LYXFILE_LAYOUT_FORMAT;
 541
 542
 543 } // namespace lyx
 544
 545 #endif