src/counters.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *           Copyright 1995 Matthias Ettrich
   8  *           Copyright 1995-2001 The LyX Team.
   9  *
  10  *
  11  * ====================================================== */
  12
  13
  14 #ifndef COUNTERS_H
  15 #define COUNTERS_H
  16
  17 #ifdef __GNUG__
  18 #pragma interface
  19 #endif
  20
  21 #include "LString.h"
  22 #include <map>
  23
  24
  25 /// This represents a single counter.
  26 class Counter {
  27 public:
  28         ///
  29         Counter();
  30         ///
  31         void set(int v);
  32         ///
  33         void addto(int v);
  34         ///
  35         int value() const;
  36         ///
  37         void step();
  38         ///
  39         void reset();
  40         /// Returns the master counter of this counter
  41         string master() const;
  42         /// sets the master counter for this counter
  43         void setMaster(string const & m);
  44 private:
  45         ///
  46         int value_;
  47         /// contains master counter name; master counter is the counter
  48         /// that, if stepped (incremented) zeroes this counter. E.g.
  49         /// "subparagraph"'s master is "paragraph".
  50         string master_;
  51 };
  52
  53
  54 /// This is a class of (La)TeX type counters.
  55 /// Every instantiation is an array of counters of type Counter.
  56 class Counters {
  57 public:
  58         ///
  59         Counters();
  60         ///
  61         //~Counters();
  62         /// Add a new counter to array.
  63         void newCounter(string const & newc);
  64         /// Add new counter having oldc as its master.
  65         void newCounter(string const & newc, string const & oldc);
  66         ///
  67         void set(string const & ctr, int val);
  68         ///
  69         void addto(string const & ctr, int val);
  70         ///
  71         int value(string const & ctr) const;
  72         /// Step (increment by one) counter named by arg, and
  73         /// zeroes slave counter(s) for which it is the master.
  74         /// NOTE sub-slaves not zeroed! That happens at slave's
  75         /// first step 0->1. Seems to be sufficient.
  76         void step(string const & ctr);
  77         /// Reset all counters.
  78         void reset();
  79         /// Reset counters matched by match string.
  80         void reset(string const & match);
  81         /// Copy counters whose name matches match from the &from to
  82         /// the &to array of counters. Empty string matches all.
  83         void copy(Counters & from, Counters & to, string const & match = string());
  84         /// A numeric label's single item, like .1 for subsection number in
  85         /// the 2.1.4 subsubsection number label. "first" indicates if this
  86         /// is the first item to be displayed, usually chapter or section.
  87         string labelItem(string const & ctr,
  88                         string const & labeltype,
  89                         string const & langtype = "latin",
  90                         bool first = false);
  91         /// A complete numeric label, like 2.1.4 for a subsubsection.
  92         /// "head" indicates sequence number of first item to be
  93         /// displayed, e.g. 0 for chapter, 1 for section.
  94         string numberLabel(string const & ctr,
  95                         string const & labeltype,
  96                         string const & langtype = "latin",
  97                         int head = 0);
  98 private:
  99         /// Maps counter (layout) names to actual counters.
 100         typedef std::map<string, Counter> CounterList;
 101         /// Instantiate.
 102         CounterList counterList;
 103
 104 };
 105
 106 #endif