src/Parsing.h

   1
   2 /*
   3  * DEBUG: section 03    Configuration File Parsing
   4  * AUTHOR: Harvest Derived
   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
  34 #ifndef SQUID_PARSING_H
  35 #define SQUID_PARSING_H
  36
  37 #include "ip/Address.h"
  38
  39 double xatof(const char *token);
  40 int xatoi(const char *token);
  41 unsigned int xatoui(const char *token, char eov = '\0');
  42 long xatol(const char *token);
  43 int64_t xatoll(const char *token, int base, char eov = '\0');
  44 unsigned short xatos(const char *token);
  45
  46 /**
  47  * Parse a 64-bit integer value.
  48  */
  49 int64_t GetInteger64(void);
  50
  51 /**
  52  * Parses an integer value.
  53  * Uses a method that obeys hexadecimal 0xN syntax needed for certain bitmasks.
  54  * self_destruct() will be called to abort when invalid tokens are encountered.
  55  */
  56 int GetInteger(void);
  57
  58 /**
  59  * Parse a percentage value, e.g., 20%.
  60  * The behavior of this function is similar as GetInteger().
  61  * The difference is that the token might contain '%' as percentage symbol (%),
  62  * and we further check whether the value is in the range of [0, 100]
  63  * For example, 20% and 20 are both valid tokens, while 101%, 101, -1 are invalid.
  64  */
  65 int GetPercentage(void);
  66
  67 unsigned short GetShort(void);
  68
  69 // on success, returns true and sets *p (if any) to the end of the integer
  70 bool StringToInt(const char *str, int &result, const char **p, int base);
  71 bool StringToInt64(const char *str, int64_t &result, const char **p, int base);
  72
  73 /**
  74  * Parse a socket address (host:port), fill the given Ip::Address object
  75  * \retval false     Failure.
  76  * \retval true      Success.
  77  * Destroys token during parse.
  78  */
  79 bool GetHostWithPort(char *token, Ip::Address *ipa);
  80
  81 #endif /* SQUID_PARSING_H */