X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCounters.h;h=4ba0d004846d2f0f8361e10d9286d5f0754b03f4;hb=7800c057884f6a950bb21bce351968f50679f18c;hp=d32f477ea82dd2004cece50b66804c18bd3a99a9;hpb=22dc345e8cd292383be108ec9ca55af4abc58e96;p=lyx.git diff --git a/src/Counters.h b/src/Counters.h index d32f477ea8..4ba0d00484 100644 --- a/src/Counters.h +++ b/src/Counters.h @@ -15,10 +15,11 @@ #ifndef COUNTERS_H #define COUNTERS_H +#include "OutputEnums.h" + #include "support/docstring.h" #include -#include #include @@ -49,12 +50,20 @@ public: void reset(); /// Returns the master counter of this counter. docstring const & master() const; + /// Checks if the master counter is cnt, and if so removes + /// it. This is used when a counter is deleted. + /// \return whether we removed the master. + bool checkAndRemoveMaster(docstring const & cnt); /// Returns a LaTeX-like string to format the counter. /** This is similar to what one gets in LaTeX when using * "\the". The \c in_appendix bool tells whether we * want the version shown in an appendix. */ docstring const & labelString(bool in_appendix) const; + /// Similar, but used for formatted references in XHTML output. + /// E.g., for a section counter it might be "section \thesection" + docstring const & prettyFormat() const { return prettyformat_; } + /// 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". The \c in_appendix @@ -67,6 +76,9 @@ public: private: /// int value_; + /// This is actually one less than the initial value, since the + /// counter is always stepped before being used. + int initial_value_; /// contains master counter name. /** The master counter is the counter that, if stepped * (incremented) zeroes this counter. E.g. "subsection"'s @@ -77,6 +89,8 @@ private: docstring labelstring_; /// The same as labelstring_, but in appendices. docstring labelstringappendix_; + /// Similar, but used for formatted references in XHTML output + docstring prettyformat_; /// Cache of the labelstring with \\the expressions expanded, /// indexed by language mutable StringMap flatlabelstring_; @@ -90,8 +104,11 @@ private: /// Every instantiation is an array of counters of type Counter. class Counters { public: - /// - Counters() : appendix_(false), subfloat_(false) {} + /// NOTE Do not call this in an attempt to clear the counters. + /// That will wipe out all the information we have about them + /// from the document class (e.g., which ones are defined). + /// Instead, call Counters::reset(). + Counters(); /// Add new counter newc having masterc as its master, /// ls as its label, and lsa as its appendix label. void newCounter(docstring const & newc, @@ -111,16 +128,19 @@ public: void addto(docstring const & ctr, int val); /// int value(docstring const & ctr) const; - /// Increment by one counter named by arg, and zeroes slave + /// Reset recursively all the counters that are slaves of the one named by \c ctr. + void resetSlaves(docstring const & ctr); + /// Increment by one counter named by \c ctr, and zeroes slave /// counter(s) for which it is the master. - /// Sub-slaves are not zeroed! That happens at slave's first - /// step 0->1. Seems to be sufficient. - /// \param for_output: whether to track the counters - void step(docstring const & ctr, bool track_counters = false); - /// Reset all counters. + /// \param utype determines whether we track the counters. + void step(docstring const & ctr, UpdateType utype); + /// Reset all counters, and all the internal data structures + /// used for keeping track of their values. void reset(); /// Reset counters matched by match string. void reset(docstring const & match); + /// Remove counter \p cnt. + bool remove(docstring const & cnt); /// Copy counters whose name matches match from the &from to /// the &to array of counters. Empty string matches all. void copy(Counters & from, Counters & to, @@ -136,6 +156,10 @@ public: */ docstring counterLabel(docstring const & format, std::string const & lang) const; + /// returns a formatted version of the counter, using the + /// format given by Counter::prettyFormat(). + docstring prettyCounter(docstring const & cntr, + std::string const & lang) const; /// Are we in appendix? bool appendix() const { return appendix_; } /// Set the state variable indicating whether we are in appendix. @@ -148,6 +172,10 @@ public: bool isSubfloat() const { return subfloat_; } /// Set the state variable indicating whether we are in a subfloat. void isSubfloat(bool s) { subfloat_ = s; } + /// Are we in a longtable? + bool isLongtable() const { return longtable_; } + /// Set the state variable indicating whether we are in a longtable. + void isLongtable(bool s) { longtable_ = s; } /// \name refstepcounter // @{ @@ -155,14 +183,14 @@ public: /// We're trying to track \refstepcounter in LaTeX, more or less. /// Note that this may be empty. docstring currentCounter() const; - /// Called during update labels as we go through various paragraphs, + /// Called during updateBuffer() as we go through various paragraphs, /// to track the layouts as we go through. void setActiveLayout(Layout const & lay); - /// Also for updateLabels(). + /// Also for updateBuffer(). /// Call this when entering things like footnotes, where there is now /// no "last layout" and we want to restore the "last layout" on exit. void clearLastLayout() { layout_stack_.push_back(0); } - /// Call then when existing things like footnotes. + /// Call this when exiting things like footnotes. void restoreLastLayout() { layout_stack_.pop_back(); } /// void saveLastCounter() @@ -201,10 +229,12 @@ private: std::string current_float_; /// Are we in a subfloat? bool subfloat_; + /// Are we in a longtable? + bool longtable_; /// Used to keep track of active counters. - std::deque counter_stack_; + std::vector counter_stack_; /// Same, but for last layout. - std::deque layout_stack_; + std::vector layout_stack_; }; } // namespace lyx