X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCounters.h;h=28e7b686322791d3236f7b056c50a0893965d744;hb=d8ab0622c5354ae2d181e9eae56764211285706c;hp=0020a7bb5a8f29ce6f55077ead1b410c92bcacc2;hpb=ff2a74b41d4807361a93f124e717697d081680fb;p=lyx.git diff --git a/src/Counters.h b/src/Counters.h index 0020a7bb5a..28e7b68632 100644 --- a/src/Counters.h +++ b/src/Counters.h @@ -18,6 +18,7 @@ #include "support/docstring.h" #include +#include namespace lyx { @@ -28,6 +29,9 @@ public: /// Counter(); /// + Counter(docstring const & mc, docstring const & ls, + docstring const & lsa); + /// void set(int v); /// void addto(int v); @@ -37,17 +41,31 @@ public: void step(); /// void reset(); - /// Returns the master counter of this counter + /// Returns the master counter of this counter. docstring const & master() const; - /// sets the master counter for this counter - void setMaster(docstring const & m); + /// Returns a LaTeX-like string to format the counter. + /* This is similar to what one gets in LaTeX when using + * "\the". + */ + 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" in an appendix. + */ + docstring const & labelStringAppendix() const; private: /// int value_; - /// contains master counter name; master counter is the counter - /// that, if stepped (incremented) zeroes this counter. E.g. - /// "subparagraph"'s master is "paragraph". + /// contains master counter name. + /* 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. + docstring labelstring_; + // The same as labelstring_, but in appendices. + docstring labelstringappendix_; }; @@ -55,12 +73,16 @@ private: /// Every instantiation is an array of counters of type Counter. class Counters { public: + /// + Counters() : appendix_(false), subfloat_(false) {} /// Add a new counter to array. void newCounter(docstring const & newc); - /// Add new counter having oldc as its master. + /// Add new counter having oldc as its master and ls as its label. void newCounter(docstring const & newc, - docstring const & oldc); - /// + docstring const & masterc, + docstring const & ls, + docstring const & lsa); + /// Checks whether the given counter exists. bool hasCounter(docstring const & c) const; /// void set(docstring const & ctr, int val); @@ -68,10 +90,11 @@ public: void addto(docstring const & ctr, int val); /// int value(docstring const & ctr) const; - /// Step (increment by one) counter named by arg, and - /// zeroes slave counter(s) for which it is the master. - /// NOTE sub-slaves not zeroed! That happens at slave's - /// first step 0->1. Seems to be sufficient. + /// 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. + */ void step(docstring const & ctr); /// Reset all counters. void reset(); @@ -81,30 +104,47 @@ public: /// the &to array of counters. Empty string matches all. void copy(Counters & from, Counters & to, docstring const & match = docstring()); - /// A complete expanded label, like 2.1.4 for a subsubsection - /// according to the given format - docstring counterLabel(docstring const & format); - /// + /// 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 * callers = 0); + /// Are we in apendix? bool appendix() const { return appendix_; }; - /// + /// Set the state variable indicating whether we are in appendix. 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: - /// A counter label's single item, 1 for subsection number in - /// the 2.1.4 subsubsection number label. + /// returns the expanded string representation of the counter + /// with recursion protection through callers. + docstring theCounter(docstring const & c, + std::set & callers); + /// 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. + */ docstring labelItem(docstring const & ctr, - docstring const & numbertype); + docstring const & numbertype); /// Maps counter (layout) names to actual counters. typedef std::map CounterList; /// Instantiate. CounterList counterList; - /// + /// Are we in an appendix? bool appendix_; - /// + /// The current enclosing float. std::string current_float_; + /// Are we in a subfloat? + bool subfloat_; };