summaryrefslogtreecommitdiff
path: root/apps/gperf/src/Iterator.h
blob: fc150efdc726a2ae40f039feefe2f6c7226cea52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
/* -*- C++ -*- */
// $Id$

/* Copyright (C) 1989 Free Software Foundation, Inc.
   written by Douglas C. Schmidt (schmidt@ics.uci.edu)

This file is part of GNU GPERF.

GNU GPERF is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 1, or (at your option) any
later version.

GNU GPERF is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU GPERF; see the file COPYING.  If not, write to the Free
Software Foundation, 59 Temple Place - Suite 330, Boston, MA
02111-1307, USA.  */

#ifndef ITERATOR_H
#define ITERATOR_H

#include "ace/OS.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

#include "Options.h"

#if defined (ACE_HAS_GPERF)
class Iterator
{
  // = TITLE
  //   Provides an Iterator that expands and decodes a control string
  //   containing digits and ranges, returning an integer every time the
  //   generator function is called.
  //
  // = DESCRIPTION
  //   This class is used to decode the user's key position requests.
  //   For example: "-k 1,2,5-10,$" will return 1, 2, 5, 6, 7, 8, 9,
  //   10, and 0 ( representing the abstract ``last character of the
  //   key'' on successive calls to the member function operator ().
  //   No errors are handled in these routines, they are passed back
  //   to the calling routines via a user-supplied Error_Value */
public:
  Iterator (char *s,
            int lo,
            int hi,
            int word_end,
            int bad_val,
            int key_end);
  int operator () (void);

private:
  char *str;
  // A pointer to the string provided by the user.

  int end;
  // Value returned after last key is processed.

  int end_word;
  // A value marking the abstract ``end of word'' (usually '$').

  int error_value;
  // Error value returned when input is syntactically erroneous.

  int hi_bound;
  // Greatest possible value, inclusive.

  int lo_bound;
  // Smallest possible value, inclusive.
};

#endif /* ACE_HAS_GPERF */
#endif /* ITERATOR_H */