]> git.lyx.org Git - lyx.git/blobdiff - src/Counters.h
Account for old versions of Pygments
[lyx.git] / src / Counters.h
index 386602a0bc51d0fa51e3088ed0d481f44ec3c1b1..360e297070a3bc256bb6f3325ef5d2388b420d63 100644 (file)
@@ -20,7 +20,6 @@
 #include "support/docstring.h"
 
 #include <map>
-#include <deque>
 #include <vector>
 
 
@@ -51,6 +50,10 @@ 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<counter>". The \c in_appendix bool tells whether we
@@ -73,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
@@ -98,7 +104,10 @@ 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, 
        /// ls as its label, and lsa as its appendix label.
@@ -119,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,
@@ -160,6 +176,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        
        // @{
@@ -174,7 +194,7 @@ public:
        /// 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 this when existing things like footnotes.
+       /// Call this when exiting things like footnotes.
        void restoreLastLayout() { layout_stack_.pop_back(); }
        /// 
        void saveLastCounter()
@@ -213,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<docstring> counter_stack_;
+       std::vector<docstring> counter_stack_;
        /// Same, but for last layout.
-       std::deque<Layout const *> layout_stack_;
+       std::vector<Layout const *> layout_stack_;
 };
 
 } // namespace lyx