]> git.lyx.org Git - lyx.git/blobdiff - src/Counters.h
Fix the placement of the cursor when right-clicking on an inset inside a branch inset.
[lyx.git] / src / Counters.h
index 5117ae80b6c79aa1db0c98c6696d3156ba2388a3..a83c5226e211027e9d11c266aaa5edaf7fb7afe4 100644 (file)
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author Jean-Marc Lasgouttes
  * \author John Levon
  * \author Martin Vermeer
 #include "support/docstring.h"
 
 #include <map>
-#include <set>
+#include <vector>
 
 
 namespace lyx {
 
+class Lexer;
+
 /// This represents a single counter.
 class Counter {
 public:
@@ -31,6 +33,8 @@ public:
        ///
        Counter(docstring const & mc, docstring const & ls, 
                docstring const & lsa);
+       /// \return true on success
+       bool read(Lexer & lex);
        ///
        void set(int v);
        ///
@@ -45,14 +49,19 @@ public:
        docstring const & master() const;
        /// Returns a LaTeX-like string to format the counter. 
        /** This is similar to what one gets in LaTeX when using
-        *  "\the<counter>".
+        *  "\the<counter>". The \c in_appendix bool tells whether
+        *  we want the version shown in an appendix.
         */
-       docstring const & labelString() const;
-       /// Returns a LaTeX-like string to format the counter in appendix.
+       docstring const & labelString(bool in_appendix) const;
+       /// Returns a LaTeX-like string to format the counter
        /** This is similar to what one gets in LaTeX when using
-        *  "\the<counter>" in an appendix.
+        *  "\the<counter>". The \c in_appendix bool tells whether
+        *  we want the version shown in an appendix. This version does 
+        * not contain any \\the<counter> expression.
         */
-       docstring const & labelStringAppendix() const;
+       docstring const & flatLabelString(bool in_appendix) const;
+       /// set the \c flatLabelString values.
+       void setFlatLabelStrings(docstring const & fls, docstring const & flsa);
 private:
        ///
        int value_;
@@ -66,6 +75,10 @@ private:
        docstring labelstring_;
        /// The same as labelstring_, but in appendices.
        docstring labelstringappendix_;
+       /// A version of the labelstring with \\the<counter> expressions expanded
+       docstring flatlabelstring_;
+       /// A version of the appendix labelstring with \\the<counter> expressions expanded
+       docstring flatlabelstringappendix_;
 };
 
 
@@ -75,15 +88,17 @@ class Counters {
 public:
        ///
        Counters() : appendix_(false), subfloat_(false) {}
-       /// Add a new counter to array.
-       void newCounter(docstring const & newc);
-       /// Add new counter having oldc as its master and ls as its label.
+       /// 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,
                        docstring const & ls,
                        docstring const & lsa);
        /// Checks whether the given counter exists.
        bool hasCounter(docstring const & c) const;
+       /// reads the counter name
+       /// \return true on success
+       bool read(Lexer & lex, docstring const & name);
        ///
        void set(docstring const & ctr, int val);
        ///
@@ -105,12 +120,11 @@ public:
        void copy(Counters & from, Counters & to,
                  docstring const & match = docstring());
        /// returns the expanded string representation of the counter.
-       docstring theCounter(docstring const & c);
-       /// Replace om format all the LaTeX-like macros that depend on
+       docstring theCounter(docstring const & c) const;
+       /// Replace in \c format all the LaTeX-like macros that depend on
        /// counters.
-       docstring counterLabel(docstring const & format, 
-                              std::set<docstring> * callers = 0);
-       /// Are we in apendix?
+       docstring counterLabel(docstring const & format) const;
+       /// Are we in appendix?
        bool appendix() const { return appendix_; };
        /// Set the state variable indicating whether we are in appendix.
        void appendix(bool a) { appendix_ = a; };
@@ -123,10 +137,10 @@ public:
        /// Set the state variable indicating whether we are in a subfloat.
        void isSubfloat(bool s) { subfloat_ = s; };
 private:
-       /// returns the expanded string representation of the counter
-       /// with recursion protection through callers.
-       docstring theCounter(docstring const & c
-                            std::set<docstring> & callers);
+       /// expands recusrsively any \\the<counter> macro in the
+       /// labelstring of \c counter.
+       docstring flattenLabelString(docstring const & counter, bool in_appendix
+                                    std::vector<docstring> & callers) const;
        /// Returns the value of the counter according to the
        /// numbering scheme numbertype.
        /** Available numbering schemes are arabic (1, 2,...), roman
@@ -134,11 +148,11 @@ private:
         *  B,...) and hebrew.
         */
        docstring labelItem(docstring const & ctr,
-                           docstring const & numbertype);
+                           docstring const & numbertype) const;
        /// Maps counter (layout) names to actual counters.
        typedef std::map<docstring, Counter> CounterList;
        /// Instantiate.
-       CounterList counterList;
+       CounterList counterList_;
        /// Are we in an appendix?
        bool appendix_;
        /// The current enclosing float.