* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
* \author John Levon
* \author Martin Vermeer
#include "support/docstring.h"
#include <map>
-#include <set>
+#include <vector>
namespace lyx {
+class Lexer;
+
/// This represents a single counter.
class Counter {
public:
///
Counter(docstring const & mc, docstring const & ls,
docstring const & lsa);
+ /// \return true on success
+ bool read(Lexer & lex);
///
void set(int v);
///
/// Returns the master counter of this counter.
docstring const & master() const;
/// Returns a LaTeX-like string to format the counter.
- /* This is similar to what one gets in LaTeX when using
- * "\the<counter>".
+ /** This is similar to what one gets in LaTeX when using
+ * "\the<counter>". The \c in_appendix bool tells whether we
+ * want the version shown in an appendix.
*/
- docstring const & labelString() const;
- /// Returns a LaTeX-like string to format the counter in appendix.
- /* This is similar to what one gets in LaTeX when using
- * "\the<counter>" in an appendix.
+ docstring const & labelString(bool in_appendix) const;
+ /// Returns a map of LaTeX-like strings to format the counter.
+ /** For each language, the string is similar to what one gets
+ * in LaTeX when using "\the<counter>". The \c in_appendix
+ * bool tells whether we want the version shown in an
+ * appendix. This version does not contain any \\the<counter>
+ * expression.
*/
- docstring const & labelStringAppendix() const;
+ typedef std::map<std::string, docstring> StringMap;
+ StringMap & flatLabelStrings(bool in_appendix) const;
private:
///
int value_;
/// contains master counter name.
- /* The master counter is the counter that, if stepped
- * (incremented) zeroes this counter. E.g. "subsection"'s
- * master is "section".
+ /** The master counter is the counter that, if stepped
+ * (incremented) zeroes this counter. E.g. "subsection"'s
+ * master is "section".
*/
docstring master_;
- // Contains a LaTeX-like string to format the counter.
+ /// Contains a LaTeX-like string to format the counter.
docstring labelstring_;
- // The same as labelstring_, but in appendices.
+ /// The same as labelstring_, but in appendices.
docstring labelstringappendix_;
+ /// Cache of the labelstring with \\the<counter> expressions expanded,
+ /// indexed by language
+ mutable StringMap flatlabelstring_;
+ /// Cache of the appendix labelstring with \\the<counter> expressions expanded,
+ /// indexed by language
+ mutable StringMap flatlabelstringappendix_;
};
/// Every instantiation is an array of counters of type Counter.
class Counters {
public:
- /// Add a new counter to array.
- void newCounter(docstring const & newc);
- /// Add new counter having oldc as its master and ls as its label.
+ ///
+ Counters() : appendix_(false), subfloat_(false) {}
+ /// Add new counter newc having masterc as its master,
+ /// ls as its label, and lsa as its appendix label.
void newCounter(docstring const & newc,
docstring const & masterc,
docstring const & ls,
docstring const & lsa);
/// Checks whether the given counter exists.
bool hasCounter(docstring const & c) const;
+ /// reads the counter name
+ /// \param makeNew whether to make a new counter if one
+ /// doesn't already exist
+ /// \return true on success
+ bool read(Lexer & lex, docstring const & name, bool makenew);
///
void set(docstring const & ctr, int val);
///
int value(docstring const & ctr) const;
/// Increment by one counter named by arg, and zeroes slave
/// counter(s) for which it is the master.
- /* Sub-slaves not zeroed! That happens at slave's first step
- * 0->1. Seems to be sufficient.
+ /** Sub-slaves not zeroed! That happens at slave's first step
+ * 0->1. Seems to be sufficient.
*/
void step(docstring const & ctr);
/// Reset all counters.
/// the &to array of counters. Empty string matches all.
void copy(Counters & from, Counters & to,
docstring const & match = docstring());
- /// returns the expanded string representation of the counter.
- docstring theCounter(docstring const & c);
- /// Replace om format all the LaTeX-like macros that depend on
- /// counters.
- docstring counterLabel(docstring const & format,
- std::set<docstring> * callers = 0);
- /// Are we in apendix?
- bool appendix() const { return appendix_; };
+ /** returns the expanded string representation of counter \c
+ * c. The \c lang code is used to translate the string.
+ */
+ docstring theCounter(docstring const & c,
+ std::string const & lang) const;
+ /** Replace in \c format all the LaTeX-like macros that depend
+ * on counters. The \c lang code is used to translate the
+ * string.
+ */
+ docstring counterLabel(docstring const & format,
+ std::string const & lang) const;
+ /// Are we in appendix?
+ bool appendix() const { return appendix_; }
/// Set the state variable indicating whether we are in appendix.
- void appendix(bool a) { appendix_ = a; };
+ void appendix(bool a) { appendix_ = a; }
/// Returns the current enclosing float.
std::string const & current_float() const { return current_float_; }
/// Sets the current enclosing float.
void current_float(std::string const & f) { current_float_ = f; }
+ /// Are we in a subfloat?
+ bool isSubfloat() const { return subfloat_; }
+ /// Set the state variable indicating whether we are in a subfloat.
+ void isSubfloat(bool s) { subfloat_ = s; }
private:
- /// returns the expanded string representation of the counter
- /// with recursion protection through callers.
- docstring theCounter(docstring const & c,
- std::set<docstring> & callers);
+ /** expands recusrsively any \\the<counter> macro in the
+ * labelstring of \c counter. The \c lang code is used to
+ * translate the string.
+ */
+ docstring flattenLabelString(docstring const & counter, bool in_appendix,
+ std::string const &lang,
+ std::vector<docstring> & callers) const;
/// Returns the value of the counter according to the
/// numbering scheme numbertype.
- /* Available numbering schemes are arabic (1, 2,...), roman
- * (i, ii,...), Roman (I, II,...), alph (a, b,...), Alpha (A,
- * B,...) and hebrew.
+ /** Available numbering schemes are arabic (1, 2,...), roman
+ * (i, ii,...), Roman (I, II,...), alph (a, b,...), Alpha (A,
+ * B,...) and hebrew.
*/
docstring labelItem(docstring const & ctr,
- docstring const & numbertype);
+ docstring const & numbertype) const;
/// Maps counter (layout) names to actual counters.
typedef std::map<docstring, Counter> CounterList;
/// Instantiate.
- CounterList counterList;
+ CounterList counterList_;
/// Are we in an appendix?
bool appendix_;
/// The current enclosing float.
std::string current_float_;
+ /// Are we in a subfloat?
+ bool subfloat_;
};
projects / lyx.git / blobdiff