src/ConfigParser.h

   1
   2 /*
   3  * $Id: ConfigParser.h,v 1.8 2007/05/29 13:31:36 amosjeffries Exp $
   4  *
   5  *
   6  * SQUID Web Proxy Cache          http://www.squid-cache.org/
   7  * ----------------------------------------------------------
   8  *
   9  *  Squid is the result of efforts by numerous individuals from
  10  *  the Internet community; see the CONTRIBUTORS file for full
  11  *  details.   Many organizations have provided support for Squid's
  12  *  development; see the SPONSORS file for full details.  Squid is
  13  *  Copyrighted (C) 2001 by the Regents of the University of
  14  *  California; see the COPYRIGHT file for full details.  Squid
  15  *  incorporates software developed and/or copyrighted by other
  16  *  sources; see the CREDITS file for full details.
  17  *
  18  *  This program is free software; you can redistribute it and/or modify
  19  *  it under the terms of the GNU General Public License as published by
  20  *  the Free Software Foundation; either version 2 of the License, or
  21  *  (at your option) any later version.
  22  *
  23  *  This program is distributed in the hope that it will be useful,
  24  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  25  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  26  *  GNU General Public License for more details.
  27  *
  28  *  You should have received a copy of the GNU General Public License
  29  *  along with this program; if not, write to the Free Software
  30  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
  31  *
  32  *
  33  * Copyright (c) 2003, Robert Collins <robertc@squid-cache.org>
  34  */
  35
  36 #ifndef SQUID_CONFIGPARSER_H
  37 #define SQUID_CONFIGPARSER_H
  38
  39 #include "squid.h"
  40
  41 /* forward decls */
  42
  43 class CacheManager;
  44
  45 /*
  46  * A configuration file Parser. Instances of this class track
  47  * parsing state and perform tokenisation. Syntax is currently
  48  * taken care of outside this class.
  49  *
  50  * One reason for this class is to allow testing of configuration
  51  * using modules without linking cache_cf.o in - because that drags
  52  * in all of squid by reference. Instead the tokeniser only is
  53  * brought in.
  54  */
  55
  56 class ConfigParser
  57 {
  58
  59 public:
  60     void destruct();
  61     static void ParseUShort(u_short *var);
  62     static void ParseBool(bool *var);
  63     static void ParseString(char **var);
  64     static void ParseString(String *var);
  65     static void ParseWordList(wordlist **list);
  66     static char * strtokFile();
  67 };
  68
  69 extern int parseConfigFile(const char *file_name, CacheManager & manager);
  70
  71 #endif /* SQUID_CONFIGPARSER_H */