4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author Martin Vermeer
12 * Full author contact details are available in file CREDITS.
18 #include "support/docstring.h"
26 /// This represents a single counter.
32 Counter(docstring const & mc, docstring const & ls,
33 docstring const & lsa);
44 /// Returns the master counter of this counter.
45 docstring const & master() const;
46 /// Returns a LaTeX-like string to format the counter.
47 /* This is similar to what one gets in LaTeX when using
50 docstring const & labelString() const;
51 /// Returns a LaTeX-like string to format the counter in appendix.
52 /* This is similar to what one gets in LaTeX when using
53 * "\the<counter>" in an appendix.
55 docstring const & labelStringAppendix() const;
59 /// contains master counter name.
60 /* The master counter is the counter that, if stepped
61 * (incremented) zeroes this counter. E.g. "subsection"'s
62 * master is "section".
65 // Contains a LaTeX-like string to format the counter.
66 docstring labelstring_;
67 // The same as labelstring_, but in appendices.
68 docstring labelstringappendix_;
72 /// This is a class of (La)TeX type counters.
73 /// Every instantiation is an array of counters of type Counter.
76 /// Add a new counter to array.
77 void newCounter(docstring const & newc);
78 /// Add new counter having oldc as its master and ls as its label.
79 void newCounter(docstring const & newc,
80 docstring const & masterc,
82 docstring const & lsa);
83 /// Checks whether the given counter exists.
84 bool hasCounter(docstring const & c) const;
86 void set(docstring const & ctr, int val);
88 void addto(docstring const & ctr, int val);
90 int value(docstring const & ctr) const;
91 /// Increment by one counter named by arg, and zeroes slave
92 /// counter(s) for which it is the master.
93 /* Sub-slaves not zeroed! That happens at slave's first step
94 * 0->1. Seems to be sufficient.
96 void step(docstring const & ctr);
97 /// Reset all counters.
99 /// Reset counters matched by match string.
100 void reset(docstring const & match);
101 /// Copy counters whose name matches match from the &from to
102 /// the &to array of counters. Empty string matches all.
103 void copy(Counters & from, Counters & to,
104 docstring const & match = docstring());
105 /// returns the expanded string representation of the counter.
106 docstring theCounter(docstring const & c);
107 /// Replace om format all the LaTeX-like macros that depend on
109 docstring counterLabel(docstring const & format,
110 std::set<docstring> * callers = 0);
111 /// Are we in apendix?
112 bool appendix() const { return appendix_; };
113 /// Set the state variable indicating whether we are in appendix.
114 void appendix(bool a) { appendix_ = a; };
115 /// Returns the current enclosing float.
116 std::string const & current_float() const { return current_float_; }
117 /// Sets the current enclosing float.
118 void current_float(std::string const & f) { current_float_ = f; }
120 /// returns the expanded string representation of the counter
121 /// with recursion protection through callers.
122 docstring theCounter(docstring const & c,
123 std::set<docstring> & callers);
124 /// Returns the value of the counter according to the
125 /// numbering scheme numbertype.
126 /* Available numbering schemes are arabic (1, 2,...), roman
127 * (i, ii,...), Roman (I, II,...), alph (a, b,...), Alpha (A,
130 docstring labelItem(docstring const & ctr,
131 docstring const & numbertype);
132 /// Maps counter (layout) names to actual counters.
133 typedef std::map<docstring, Counter> CounterList;
135 CounterList counterList;
136 /// Are we in an appendix?
138 /// The current enclosing float.
139 std::string current_float_;