X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FCounters.h;h=360e297070a3bc256bb6f3325ef5d2388b420d63;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=e081ad21bbc8e8939ca2f22aa54309b49c850052;hpb=1f8bf874aad7ce9367568bfd6521f35cbb2cbe66;p=lyx.git diff --git a/src/Counters.h b/src/Counters.h index e081ad21bb..360e297070 100644 --- a/src/Counters.h +++ b/src/Counters.h @@ -15,6 +15,8 @@ #ifndef COUNTERS_H #define COUNTERS_H +#include "OutputEnums.h" + #include "support/docstring.h" #include @@ -23,6 +25,7 @@ namespace lyx { +class Layout; class Lexer; /// This represents a single counter. @@ -47,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 @@ -65,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 @@ -75,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_; @@ -88,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, @@ -109,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 not zeroed! That happens at slave's first step - * 0->1. Seems to be sufficient. - */ - void step(docstring const & ctr); - /// 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, @@ -134,10 +160,14 @@ 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_; }; + bool appendix() const { return appendix_; } /// Set the state variable indicating whether we are in appendix. - void appendix(bool a) { appendix_ = a; }; + 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. @@ -145,9 +175,35 @@ public: /// 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; }; + 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 + // @{ + /// The currently active counter, so far as references go. + /// We're trying to track \refstepcounter in LaTeX, more or less. + /// Note that this may be empty. + docstring currentCounter() const; + /// Called during updateBuffer() as we go through various paragraphs, + /// to track the layouts as we go through. + void setActiveLayout(Layout const & lay); + /// 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 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: - /** expands recusrsively any \\the macro in the + /** expands recursively any \\the macro in the * labelstring of \c counter. The \c lang code is used to * translate the string. */ @@ -162,6 +218,11 @@ private: */ docstring labelItem(docstring const & ctr, docstring const & numbertype) const; + /// Used for managing the counter_stack_. + // @{ + void beginEnvironment(); + void endEnvironment(); + // @} /// Maps counter (layout) names to actual counters. typedef std::map CounterList; /// Instantiate. @@ -172,9 +233,14 @@ 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::vector counter_stack_; + /// Same, but for last layout. + std::vector layout_stack_; }; - } // namespace lyx #endif