ACE/apps/gperf/src/Iterator.h

   1 // -*- C++ -*-
   2
   3 /**
   4  * Copyright (C) 1989 Free Software Foundation, Inc.
   5  * written by Douglas C. Schmidt (d.schmidt@vanderbilt.edu)
   6  *
   7  * This file is part of GNU GPERF.
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; either version 2
  12  * of the License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22  */
  23
  24 #ifndef ITERATOR_H
  25 #define ITERATOR_H
  26
  27 #include "ace/config-all.h"
  28
  29 #if !defined (ACE_LACKS_PRAGMA_ONCE)
  30 # pragma once
  31 #endif /* ACE_LACKS_PRAGMA_ONCE */
  32
  33 #include "Options.h"
  34 #include "ace/Copy_Disabled.h"
  35
  36 /**
  37  * Provides an Iterator that expands and decodes a control string
  38  * containing digits and ranges, returning an integer every time the
  39  * generator function is called.
  40  *
  41  * This class is used to decode the user's key position requests.
  42  * For example: "-k 1,2,5-10,$" will return 1, 2, 5, 6, 7, 8, 9,
  43  * 10, and 0 ( representing the abstract ``last character of the
  44  * key'' on successive calls to the member function operator ().
  45  * No errors are handled in these routines, they are passed back
  46  * to the calling routines via a user-supplied Error_Value
  47  */
  48 class Iterator : private ACE_Copy_Disabled
  49 {
  50 public:
  51   Iterator (char *s,
  52             int lo,
  53             int hi,
  54             int word_end,
  55             int bad_val,
  56             int key_end);
  57   int operator () ();
  58
  59 private:
  60   /// A pointer to the string provided by the user.
  61   char *str;
  62
  63   /// Value returned after last key is processed.
  64   int end;
  65
  66   /// A value marking the abstract ``end of word'' (usually '$').
  67   int end_word;
  68
  69   /// Error value returned when input is syntactically erroneous.
  70   int error_value;
  71
  72   /// Greatest possible value, inclusive.
  73   int hi_bound;
  74
  75   /// Smallest possible value, inclusive.
  76   int lo_bound;
  77 };
  78
  79 #endif /* ITERATOR_H */