Source Format Enforcement (#763)

[thirdparty/squid.git] / src / Parsing.h

diff --git a/src/Parsing.h b/src/Parsing.h
index 91613bad54ef26b4a2919308d4c98c18810fabdd..9967b3d69baedce1e588e9e82fc3a3b03c365a4e 100644 (file)
--- a/src/Parsing.h
+++ b/src/Parsing.h
@@ -1,51 +1,63 @@
-
 /*
- * $Id: Parsing.h,v 1.3 2006/10/08 13:10:34 serassio Exp $
- *
- * DEBUG: section 3     Configuration File Parsing
- * AUTHOR: Harvest Derived
- *
- * SQUID Web Proxy Cache          http://www.squid-cache.org/
- * ----------------------------------------------------------
- *
- *  Squid is the result of efforts by numerous individuals from
- *  the Internet community; see the CONTRIBUTORS file for full
- *  details.   Many organizations have provided support for Squid's
- *  development; see the SPONSORS file for full details.  Squid is
- *  Copyrighted (C) 2001 by the Regents of the University of
- *  California; see the COPYRIGHT file for full details.  Squid
- *  incorporates software developed and/or copyrighted by other
- *  sources; see the CREDITS file for full details.
- *
- *  This program 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 2 of the License, or
- *  (at your option) any later version.
- *  
- *  This program 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 this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.
+ * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
  *
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
  */
 
+/* DEBUG: section 03    Configuration File Parsing */
+
 #ifndef SQUID_PARSING_H
 #define SQUID_PARSING_H
 
-#include "squid.h"
+#include "ip/Address.h"
+
+double xatof(const char *token);
+int xatoi(const char *token);
+unsigned int xatoui(const char *token, char eov = '\0');
+long xatol(const char *token);
+int64_t xatoll(const char *token, int base, char eov = '\0');
+unsigned short xatos(const char *token);
+
+/**
+ * Parse a 64-bit integer value.
+ */
+int64_t GetInteger64(void);
+
+/**
+ * Parses an integer value.
+ * Uses a method that obeys hexadecimal 0xN syntax needed for certain bitmasks.
+ * self_destruct() will be called to abort when invalid tokens are encountered.
+ */
+int GetInteger(void);
 
-extern double xatof(const char *token);
-extern int xatoi(const char *token);
-extern long xatol(const char *token);
-extern unsigned short xatos(const char *token);
-extern int GetInteger(void);
-extern u_short GetShort(void);
+/**
+ * Parse a percentage value, e.g., 20%.
+ * The behavior of this function is similar as GetInteger().
+ * The difference is that the token might contain '%' as percentage symbol (%),
+ * and we may further check whether the value is in the range of [0, 100].
+ * For example, 20% and 20 are both valid tokens, while 101%, 101, -1 are invalid.
+ *
+ * \param limit whether to check the value is within 0-100% limit
+ *
+ * \return the percentage as a decimal number. ie 100% = 1.00, 50% = 0.5
+ */
+double GetPercentage(bool limit = true);
+
+unsigned short GetShort(void);
 
 // on success, returns true and sets *p (if any) to the end of the integer
-extern bool StringToInt(const char *str, int &result, const char **p, int base);
+bool StringToInt(const char *str, int &result, const char **p, int base);
+bool StringToInt64(const char *str, int64_t &result, const char **p, int base);
+
+/**
+ * Parse a socket address (host:port), fill the given Ip::Address object
+ * \retval false     Failure.
+ * \retval true      Success.
+ * Destroys token during parse.
+ */
+bool GetHostWithPort(char *token, Ip::Address *ipa);
 
 #endif /* SQUID_PARSING_H */
+