Correction: The inset name is citation, not cite

[lyx.git] / src / Counters.h

diff --git a/src/Counters.h b/src/Counters.h
index 3384e564c694a4b688e5cc56295d39dd6fef454d..511c4902c84230c26e2dddf52fb1814f9878b691 100644 (file)
--- a/src/Counters.h
+++ b/src/Counters.h
@@ -20,7 +20,6 @@
 #include "support/docstring.h"
 
 #include <map>
-#include <deque>
 #include <vector>
 
 
@@ -51,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<counter>". 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<counter>". The \c in_appendix
@@ -79,6 +86,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<counter> expressions expanded, 
        /// indexed by language
        mutable StringMap flatlabelstring_;
@@ -92,8 +101,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,
@@ -119,10 +131,13 @@ public:
        /// 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,
@@ -138,6 +153,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.
@@ -157,14 +176,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()
@@ -204,9 +223,9 @@ private:
        /// Are we in a subfloat?
        bool subfloat_;
        /// 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