#ifndef BUFFERPARAMS_H
#define BUFFERPARAMS_H
-#include "TextClass.h"
+#include "Font.h"
+#include "Citation.h"
#include "paper.h"
#include "insets/InsetQuotes.h"
#include "support/copied_ptr.h"
-#include "support/types.h"
-
-#include "frontends/controllers/frontend_helpers.h"
+#include <set>
#include <vector>
-
namespace lyx {
+namespace support { class FileName; }
+
class AuthorList;
class BranchList;
class Bullet;
+class DocumentClass;
class Encoding;
-class Lexer;
+class Language;
class LatexFeatures;
+class LayoutFile;
+class LayoutFileIndex;
+class Lexer;
+class PDFOptions;
class Spacing;
class TexRow;
class VSpace;
-class Language;
-
/** Buffer parameters.
- * This class contains all the parameters for this a buffer uses. Some
+ * This class contains all the parameters for this buffer's use. Some
* work needs to be done on this class to make it nice. Now everything
* is in public.
*/
class BufferParams {
public:
///
- enum PARSEP {
+ typedef std::vector<std::string> LayoutModuleList;
+ ///
+ enum ParagraphSeparation {
///
- PARSEP_INDENT,
+ ParagraphIndentSeparation,
///
- PARSEP_SKIP
+ ParagraphSkipSeparation
};
///
BufferParams();
- ~BufferParams();
/// get l10n translated to the buffers language
- docstring const B_(std::string const & l10n) const;
+ docstring B_(std::string const & l10n) const;
/// read a header token, if unrecognised, return it or an unknown class name
- std::string const readToken(Lexer & lex, std::string const & token);
+ std::string readToken(Lexer & lex,
+ std::string const & token, ///< token to read.
+ support::FileName const & filepath);
///
void writeFile(std::ostream &) const;
+ /// check what features are implied by the buffer parameters.
+ void validate(LaTeXFeatures &) const;
+
/** \returns true if the babel package is used (interogates
* the BufferParams and a LyXRC variable).
* This returned value can then be passed to the insets...
///
void useClassDefaults();
-
///
bool hasClassDefaults() const;
///
VSpace const & getDefSkip() const;
-
///
void setDefSkip(VSpace const & vs);
- /** Wether paragraphs are separated by using a indent like in
+ /** Whether paragraphs are separated by using a indent like in
* articles or by using a little skip like in letters.
*/
- PARSEP paragraph_separation;
+ ParagraphSeparation paragraph_separation;
///
- InsetQuotes::quote_language quotes_language;
+ InsetQuotes::QuoteLanguage quotes_language;
///
- InsetQuotes::quote_times quotes_times;
+ InsetQuotes::QuoteTimes quotes_times;
///
std::string fontsize;
- ///
- textclass_type textclass;
- ///
- TextClass const & getTextClass() const;
+ ///Get the LayoutFile this document is using.
+ LayoutFile const * baseClass() const;
+ ///
+ LayoutFileIndex const & baseClassID() const;
+ /// Set the LyX layout file this document is using.
+ /// NOTE: This does not call makeDocumentClass() to update the local
+ /// DocumentClass. That needs to be done manually.
+ /// \param filename the name of the layout file
+ bool setBaseClass(std::string const & classname);
+ /// Adds the module information to the baseClass information to
+ /// create our local DocumentClass.
+ void makeDocumentClass();
+ /// Returns the DocumentClass currently in use: the BaseClass as modified
+ /// by modules.
+ DocumentClass const & documentClass() const;
+ /// \return A pointer to the DocumentClass currently in use: the BaseClass
+ /// as modified by modules.
+ DocumentClass const * documentClassPtr() const;
+ /// This bypasses the baseClass and sets the textClass directly.
+ /// Should be called with care and would be better not being here,
+ /// but it seems to be needed by CutAndPaste::putClipboard().
+ void setDocumentClass(DocumentClass const * const);
+ /// List of modules in use
+ LayoutModuleList const & getModules() const { return layoutModules_; }
+ /// List of default modules the user has removed
+ std::set<std::string> const & getRemovedModules() const
+ { return removedModules_; }
+ ///
+ /// Add a module to the list of modules in use.
+ /// Returns true if module was successfully added.
+ /// The makeClass variable signals whether to call makeDocumentClass. This
+ /// need not be done if we know this isn't the final time through, or if
+ /// the BufferParams do not represent the parameters for an actual buffer
+ /// (as in GuiDocument).
+ bool addLayoutModule(std::string const & modName);
+ ///
+ void addRemovedModule(std::string const & modName)
+ { removedModules_.insert(modName); }
+ /// Clear the list
+ void clearLayoutModules() { layoutModules_.clear(); }
+ /// Clear the removed module list
+ void clearRemovedModules() { removedModules_.clear(); }
/// returns the main font for the buffer (document)
Font const getFont() const;
std::string headsep;
///
std::string footskip;
+ ///
+ std::string columnsep;
/* some LaTeX options */
/// The graphics driver
int fontsSansScale;
/// the scale factor of the tt font
int fontsTypewriterScale;
+ /// the font used by the CJK command
+ std::string fontsCJK;
///
Spacing & spacing();
Spacing const & spacing() const;
///
std::string preamble;
///
+ std::string local_layout;
+ ///
std::string options;
+ /// use the class options defined in the layout?
+ bool use_default_options;
+ ///
+ std::string master;
///
std::string float_placement;
///
unsigned int columns;
+ /// parameters for the listings package
+ std::string listings_params;
///
- TextClass::PageSides sides;
+ PageSides sides;
///
std::string pagestyle;
/// \param index should lie in the range 0 <= \c index <= 3.
/// \param index should lie in the range 0 <= \c index <= 3.
Bullet & user_defined_bullet(size_type index);
Bullet const & user_defined_bullet(size_type index) const;
- ///
- void readPreamble(Lexer &);
- ///
- void readLanguage(Lexer &);
- ///
- void readGraphicsDriver(Lexer &);
- ///
- void readBullets(Lexer &);
- ///
- void readBulletsLaTeX(Lexer &);
/// Whether to load a package such as amsmath or esint.
/// The enum values must not be changed (file format!)
bool use_bibtopic;
/// revision tracking for this buffer ?
bool trackChanges;
- /** This param decides whether change tracking marks should be output
- * (using the dvipost package) or if the current "state" of the
- * document should be output instead. Since dvipost needs dvi
- * specials, it only works with dvi/ps output (the param will be
- * ignored with other output flavors and disabled when dvipost is
- * not installed).
+ /** This param decides whether change tracking marks should be used
+ * in output (irrespective of how these marks are actually defined;
+ * for instance, they may differ for DVI and PDF generation)
*/
bool outputChanges;
- /// Time ago we agreed that this was a buffer property [ale990407]
- std::string parentname;
///
bool compressed;
std::vector<unsigned int> author_map;
///
std::string const dvips_options() const;
+ /** The return value of paperSizeName() depends on the
+ * purpose for which the paper size is needed, since they
+ * support different subsets of paper sizes.
+ */
+ enum PapersizePurpose {
+ ///
+ DVIPS,
+ ///
+ DVIPDFM,
+ ///
+ XDVI
+ };
///
- std::string const paperSizeName() const;
- /// set up if and how babel is called
- std::string const babelCall(std::string const & lang_opts) const;
+ std::string paperSizeName(PapersizePurpose purpose) const;
+ /// handle inputenc etc.
+ void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features,
+ TexRow & texrow) const;
/// set up the document fonts
std::string const loadFonts(std::string const & rm,
std::string const & sf, std::string const & tt,
bool const & sc, bool const & osf,
int const & sfscale, int const & ttscale) const;
- /// path of the current buffer
- std::string filepath;
- /// get the appropriate cite engine (natbib handling)
- biblio::CiteEngine getEngine() const;
+ /// get the appropriate cite engine (natbib handling)
+ CiteEngine citeEngine() const;
///
- void setCiteEngine(biblio::CiteEngine const);
+ void setCiteEngine(CiteEngine const);
+
+ /// options for pdf output
+ PDFOptions & pdfoptions();
+ PDFOptions const & pdfoptions() const;
private:
+ ///
+ void readPreamble(Lexer &);
+ ///
+ void readLocalLayout(Lexer &);
+ ///
+ void readLanguage(Lexer &);
+ ///
+ void readGraphicsDriver(Lexer &);
+ ///
+ void readBullets(Lexer &);
+ ///
+ void readBulletsLaTeX(Lexer &);
+ ///
+ void readModules(Lexer &);
+ ///
+ void readRemovedModules(Lexer &);
+
+ /// for use with natbib
+ CiteEngine cite_engine_;
+ ///
+ DocumentClass * doc_class_;
+ ///
+ LayoutModuleList layoutModules_;
+ /// this is for modules that are required by the document class but that
+ /// the user has chosen not to use
+ std::set<std::string> removedModules_;
+
/** Use the Pimpl idiom to hide those member variables that would otherwise
* drag in other header files.
*/
};
support::copied_ptr<Impl, MemoryTraits> pimpl_;
- ///
- biblio::CiteEngine cite_engine_;
};
} // namespace lyx
projects / lyx.git / blobdiff