kcron/ctunit.h

   1 /***************************************************************************
   2  *   CT Unit of Time Interval Header                                       *
   3  *   --------------------------------------------------------------------  *
   4  *   Copyright (C) 1999, Gary Meyer <gary@meyer.net>                       *
   5  *   --------------------------------------------------------------------  *
   6  *   This program is free software; you can redistribute it and/or modify  *
   7  *   it under the terms of the GNU General Public License as published by  *
   8  *   the Free Software Foundation; either version 2 of the License, or     *
   9  *   (at your option) any later version.                                   *
  10  ***************************************************************************/
  11
  12 #ifndef CTUNIT_H
  13 #define CTUNIT_H
  14
  15 // Do not introduce any Qt or KDE dependencies into the "CT"-prefixed classes.
  16 // I want to be able to reuse these classes with another GUI toolkit. -GM 11/99
  17
  18 #include <string>
  19 #include <iostream>
  20
  21 /**
  22   * A cron table unit parser and tokenizer.
  23   * Parses/tokenizes unit such as "0-3,5,6,10-30/5"
  24   * Also provides default natural language description.
  25   */
  26 template<int min, int max> class CTUnit
  27 {
  28 public:
  29
  30 /**
  31   * Constant indicating short format.
  32   */
  33   static const bool shortFormat = 0;
  34
  35 /**
  36   * Constant indicating long format.
  37   */
  38   static const bool longFormat = 1;
  39
  40 /**
  41   * Initialize including parsing and saving initial image.
  42   */
  43   CTUnit(const std::string &tokStr = "");
  44
  45 /**
  46   * Base initial image as empty and copy enabled intervals.
  47   */
  48   CTUnit(const CTUnit& source);
  49
  50 /**
  51   * Destructor.
  52   */
  53   virtual ~CTUnit();
  54
  55 /**
  56   * Copy enabled intervals.
  57   */
  58   void operator = (const CTUnit<min,max>& unit);
  59
  60 /**
  61   * Returns tokenization to output stream.
  62   */
  63   friend std::ostream& operator << (std::ostream& outStr, const CTUnit<min,max>& unit)
  64   {
  65     if (unit.count() == (max - min + 1))
  66        outStr << "*";
  67     else
  68        outStr << ((const CTUnit<min, max>) unit).tokenize();
  69     return outStr;
  70   }
  71
  72 /**
  73   * Parses unit such as "0-3,5,6,10-30/5".
  74   * And initialize array of enabled intervals.
  75   */
  76   void initialize(const std::string &tokStr = "");
  77
  78 /**
  79   * Parses unit such as "0-3,5,6,10-30/5".
  80   * Does not initialize array of enabled intervals.
  81   */
  82   void parse(std::string tokStr = "");
  83
  84 /**
  85   * Tokenizes unit into string such as
  86   * "0,1,2,3,5,6,10,15,20,25,30".
  87   */
  88   std::string tokenize() const;
  89
  90 /**
  91   * Get default natural language description.
  92   */
  93   virtual std::string describe(const std::string *label) const;
  94
  95 /**
  96   * Lower bound.
  97   */
  98   int begin();
  99
 100 /**
 101   * Upper bound.
 102   */
 103   int end();
 104
 105 /**
 106   * Accessor.
 107   */
 108   bool get(int pos) const;
 109
 110 /**
 111   * Mutator.
 112   */
 113   void set(int pos, bool value);
 114
 115 /**
 116   * Enable.
 117   */
 118   void enable(int pos);
 119
 120 /**
 121   * Disable.
 122   */
 123   void disable(int pos);
 124
 125 /**
 126   * Indicates whether enabled intervals have been modified.
 127   */
 128   bool dirty() const;
 129
 130 /**
 131   * Total count of enabled intervals.
 132   */
 133   int count() const;
 134
 135 /**
 136   * Mark changes as applied.
 137   */
 138   void apply();
 139
 140 /**
 141   * Mark cancel changes and revert to initial or last applied
 142   * image.
 143   */
 144   void cancel();
 145
 146 private:
 147
 148   int fieldToValue(std::string entry) const;
 149   bool isDirty;
 150   bool enabled[max+1];
 151   bool initialEnabled[max+1];
 152   std::string initialTokStr;
 153
 154 };
 155
 156 #include "ctunit.cpp"
 157
 158 #endif // CTUNIT_H