]> git.lyx.org Git - lyx.git/blobdiff - src/BufferParams.h
Run codespell on tex2lyx/, client/, convert/ and graphics/
[lyx.git] / src / BufferParams.h
index bc5c10d194a9c70d9af0b7ed1b8beca8817a7230..84a5e58eab7cb4cd75ba7894270e6e4db846255b 100644 (file)
@@ -136,7 +136,9 @@ public:
        /// NOTE: This does not call makeDocumentClass() to update the local
        /// DocumentClass. That needs to be done manually.
        /// \param classname: the name of the layout file
-       bool setBaseClass(std::string const & classname);
+       /// \param path: non-empty only for local layout files
+       bool setBaseClass(std::string const & classname,
+                         std::string const & path = std::string());
        /// Adds the module information to the baseClass information to
        /// create our local DocumentClass.
        /// NOTE: This should NEVER be called externally unless one immediately goes
@@ -168,8 +170,6 @@ public:
        /// checks to make sure module's requriements are satisfied, that it does
        /// not conflict with already-present modules, isn't already loaded, etc.
        bool layoutModuleCanBeAdded(std::string const & modName) const;
-       /// same, but for citaton modules.
-       bool citationModuleCanBeAdded(std::string const & modName) const;
        ///
        void addRemovedModule(std::string const & modName)
                        { removed_modules_.push_back(modName); }
@@ -214,7 +214,12 @@ public:
        void clearIncludedChildren() { included_children_.clear(); }
 
        /// update aux files of unincluded children (with \includeonly)
-       bool maintain_unincluded_children;
+       enum ChildrenMaintenance {
+               CM_None,
+               CM_Mostly,
+               CM_Strict
+       };
+       ChildrenMaintenance maintain_unincluded_children;
 
        /// returns the main font for the buffer (document)
        Font const getFont() const;
@@ -283,16 +288,26 @@ public:
        bool useNonTeXFonts;
        /// use expert Small Caps
        bool fonts_expert_sc;
-       /// use Old Style Figures
-       bool fonts_old_figures;
+       /// use Old Style Figures (rm)
+       bool fonts_roman_osf;
+       /// use Old Style Figures (sf)
+       bool fonts_sans_osf;
+       /// use Old Style Figures (tt)
+       bool fonts_typewriter_osf;
+       /// the options for the roman font
+       std::string font_roman_opts;
        /// the scale factor of the sf font: [0] for TeX fonts, [1] for non-TeX fonts
        int fonts_sans_scale[2];
        /// the scale factor of the sf font
        int fontsSansScale() const { return fonts_sans_scale[useNonTeXFonts]; }
+       // the options for the sans font
+       std::string font_sans_opts;
        /// the scale factor of the tt font: [0] for TeX fonts, [1] for non-TeX fonts
        int fonts_typewriter_scale[2];
        /// the scale factor of the tt font
        int fontsTypewriterScale() const { return fonts_typewriter_scale[useNonTeXFonts]; }
+       // the options for the typewriter font
+       std::string font_typewriter_opts;
        /// the font used by the CJK command
        std::string fonts_cjk;
        /// use LaTeX microtype package
@@ -324,18 +339,20 @@ public:
         * The encoding of the LyX file is always utf8 and has nothing to
         * do with this setting.
         * The difference between \c auto and \c default is that \c auto also
-        * causes loading of the inputenc package, while \c default does not.
+        * causes loading of the inputenc package and writes a \inputenc{} command
+        * to the file when switching to another encoding, while \c default does not.
         * \c default will not work unless the user takes additional measures
         * (such as using special environments like the CJK environment from
         * CJK.sty).
-        * \c default can be seen as an unspecified 8bit encoding, since LyX
+        * \c default can be seen as an unspecified mix of 8bit encodings, since LyX
         * does not interpret it in any way apart from display on screen.
         */
        std::string inputenc;
        /// The main encoding used by this buffer for LaTeX output.
-       /// Individual pieces of text can use different encodings.
+       /// If the main encoding is \c auto or \c default,
+       /// individual pieces of text can use different encodings.
        /// Output for XeTeX with 8-bit TeX fonts uses ASCII (set at runtime)
-       /// instead of the value returned by this function.
+       /// instead of the value returned by this function (cf. #10600).
        Encoding const & encoding() const;
        ///
        std::string origin;
@@ -352,6 +369,8 @@ public:
        ///
        std::string float_placement;
        ///
+       std::string float_alignment;
+       ///
        unsigned int columns;
        ///
        bool justification;
@@ -362,6 +381,8 @@ public:
        ///
        std::string pagestyle;
        ///
+       std::string tablestyle;
+       ///
        RGBColor backgroundcolor;
        ///
        bool isbackgroundcolor;
@@ -418,7 +439,11 @@ public:
         */
        bool output_changes;
        ///
+       bool change_bars;
+       ///
        bool compressed;
+       ///
+       bool postpone_fragile_content;
 
        /// the author list for the document
        AuthorList & authors();
@@ -450,7 +475,8 @@ public:
                XDVI
        };
        ///
-       std::string paperSizeName(PapersizePurpose purpose) const;
+       std::string paperSizeName(PapersizePurpose purpose,
+                                 std::string const & psize = std::string()) const;
        /// set up if and how babel is called
        std::string babelCall(std::string const & lang_opts, bool const langoptions) const;
        /// return supported drivers for specific packages
@@ -463,21 +489,12 @@ public:
        std::string const loadFonts(LaTeXFeatures & features) const;
 
        /// the cite engine modules
-       LayoutModuleList const & citeEngine() const
-               { return cite_engine_; }
+       std::string const & citeEngine() const { return cite_engine_; }
        /// the type of cite engine (authoryear or numerical)
        CiteEngineType const & citeEngineType() const
                { return cite_engine_type_; }
        /// add the module to the cite engine modules
-       bool addCiteEngine(std::string const &);
-       /// add the modules to the cite engine modules
-       bool addCiteEngine(std::vector<std::string> const &);
-       /// clear the list of cite engine modules
-       void clearCiteEngine() { cite_engine_.clear(); }
-       /// set the cite engine module
-       void setCiteEngine(std::string const &);
-       /// set the cite engine modules
-       void setCiteEngine(std::vector<std::string> const &);
+       void setCiteEngine(std::string const & eng) { cite_engine_ = eng; }
        /// set the cite engine type
        void setCiteEngineType(CiteEngineType const & engine_type)
                { cite_engine_type_ = engine_type; }
@@ -508,6 +525,14 @@ public:
        std::string biblatex_bibstyle;
        /// The biblatex citation style
        std::string biblatex_citestyle;
+       /// Set the bib file encoding (for biblatex)
+       void setBibEncoding(std::string const & s) { bib_encoding = s; }
+       /// Get the bib file encoding (for biblatex)
+       std::string const & bibEncoding() const { return bib_encoding; }
+       /// Set encoding for individual bib file (for biblatex)
+       void setBibFileEncoding(std::string const & file, std::string const & enc);
+       ///
+       std::string const bibFileEncoding(std::string const & file) const;
 
        /// options for pdf output
        PDFOptions & pdfoptions();
@@ -545,12 +570,20 @@ public:
        bool use_refstyle;
        /// use minted? or listings?
        bool use_minted;
+       //output line numbering
+       bool use_lineno;
+       //optional params for lineno package
+       std::string lineno_opts;
 
        /// Return true if language could be set to lang,
        /// otherwise return false and do not change language
        bool setLanguage(std::string const & lang);
        ///
        void invalidateConverterCache() const;
+       /// Copies over some of the settings from \param bp,
+       /// namely the ones need by Advanced F&R. We don't want
+       /// to copy them all, e.g., not the default master.
+       void copyForAdvFR(BufferParams const & bp);
 
 private:
        ///
@@ -575,12 +608,16 @@ private:
        typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
        ///
        mutable DefaultFlavorCache default_flavors_;
-       /// the cite engine modules
-       LayoutModuleList cite_engine_;
+       /// the cite engine
+       std::string cite_engine_;
        /// the type of cite engine (authoryear or numerical)
        CiteEngineType cite_engine_type_;
        /// the default BibTeX style file for the document
        std::string biblio_style;
+       /// The main encoding of the bib files, for Biblatex
+       std::string bib_encoding;
+       /// Individual file encodings, for Biblatex
+       std::map<std::string, std::string> bib_encodings;
        /// Split bibliography?
        bool use_bibtopic;
        ///
@@ -614,7 +651,6 @@ private:
                static void destroy(Impl *);
        };
        support::copied_ptr<Impl, MemoryTraits> pimpl_;
-
 };
 
 } // namespace lyx