Added documentation for prepush and postpop.
[ragel.git] / common / pcheck.h
blob0b836a52f2f509485586350638ae55a1b30ec05d
1 /*
2 * Copyright 2001, 2002 Adrian Thurston <thurston@cs.queensu.ca>
3 */
5 /* This file is part of Ragel.
7 * Ragel is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * Ragel is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Ragel; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #ifndef _PCHECK_H
23 #define _PCHECK_H
25 class ParamCheck
27 public:
28 ParamCheck(char *paramSpec, int argc, char **argv);
30 bool check();
32 char *parameterArg; /* The argument to the parameter. */
33 char parameter; /* The parameter matched. */
34 enum { match, invalid, noparam } state;
36 char *argOffset; /* If we are reading params inside an
37 * arg this points to the offset. */
39 char *curArg; /* Pointer to the current arg. */
40 int iCurArg; /* Index to the current arg. */
42 private:
43 char *paramSpec; /* Parameter spec supplied by the coder. */
44 int argc; /* Arguement data from the command line. */
45 char **argv;
49 #endif /* _PCHECK_H */