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