X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCounters.h;h=536dcc17a6a9321b3226e747dbae9c77aed57ac7;hb=62af7ee772f16f154225d2d0b65d77f4376b6001;hp=71ae36e8a6113c979e61619f3544ef54968db8c6;hpb=31fcb5c97eefa15a8729deb48914927e2b58ccf5;p=lyx.git diff --git a/src/Counters.h b/src/Counters.h index 71ae36e8a6..536dcc17a6 100644 --- a/src/Counters.h +++ b/src/Counters.h @@ -20,7 +20,7 @@ #include "support/docstring.h" #include -#include +#include namespace lyx { @@ -34,7 +34,7 @@ public: /// Counter(); /// - Counter(docstring const & mc, docstring const & ls, + Counter(docstring const & mc, docstring const & ls, docstring const & lsa); /// \return true on success bool read(Lexer & lex); @@ -50,7 +50,11 @@ public: void reset(); /// Returns the master counter of this counter. docstring const & master() const; - /// Returns a LaTeX-like string to format the counter. + /// 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. @@ -59,8 +63,8 @@ public: /// 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. + + /// 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 * bool tells whether we want the version shown in an @@ -72,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 @@ -84,10 +91,10 @@ private: docstring labelstringappendix_; /// Similar, but used for formatted references in XHTML output docstring prettyformat_; - /// Cache of the labelstring with \\the expressions expanded, + /// Cache of the labelstring with \\the expressions expanded, /// indexed by language mutable StringMap flatlabelstring_; - /// Cache of the appendix labelstring with \\the expressions expanded, + /// Cache of the appendix labelstring with \\the expressions expanded, /// indexed by language mutable StringMap flatlabelstringappendix_; }; @@ -97,9 +104,12 @@ private: /// Every instantiation is an array of counters of type Counter. class Counters { public: - /// + /// 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, + /// 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, @@ -108,7 +118,7 @@ public: /// 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 + /// \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); @@ -118,16 +128,23 @@ 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 master of counter named by \c ctr. + /// This also resets the counter named by \c ctr. + /// \param utype determines whether we track the counters. + void stepMaster(docstring const & ctr, UpdateType utype); + /// 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 utype determines whether we track the counters. void step(docstring const & ctr, UpdateType utype); - /// Reset all counters. + /// 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, @@ -143,7 +160,7 @@ public: */ docstring counterLabel(docstring const & format, std::string const & lang) const; - /// returns a formatted version of the counter, using the + /// returns a formatted version of the counter, using the /// format given by Counter::prettyFormat(). docstring prettyCounter(docstring const & cntr, std::string const & lang) const; @@ -159,8 +176,12 @@ public: bool isSubfloat() const { return subfloat_; } /// Set the state variable indicating whether we are in a subfloat. void isSubfloat(bool s) { subfloat_ = s; } - - /// \name refstepcounter + /// 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 // @{ /// The currently active counter, so far as references go. /// We're trying to track \refstepcounter in LaTeX, more or less. @@ -175,10 +196,10 @@ public: void clearLastLayout() { layout_stack_.push_back(0); } /// Call this when exiting things like footnotes. void restoreLastLayout() { layout_stack_.pop_back(); } - /// + /// void saveLastCounter() { counter_stack_.push_back(counter_stack_.back()); } - /// + /// void restoreLastCounter() { counter_stack_.pop_back(); } // @} private: @@ -188,7 +209,7 @@ private: */ docstring flattenLabelString(docstring const & counter, bool in_appendix, std::string const &lang, - std::deque & callers) const; + std::vector & callers) const; /// Returns the value of the counter according to the /// numbering scheme numbertype. /** Available numbering schemes are arabic (1, 2,...), roman @@ -212,10 +233,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