]>
Commit | Line | Data |
---|---|---|
b67e2c8c | 1 | |
2 | /* | |
262a0e14 | 3 | * $Id$ |
b67e2c8c | 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. | |
26ac0430 | 22 | * |
b67e2c8c | 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. | |
26ac0430 | 27 | * |
b67e2c8c | 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 | ||
d295d770 | 36 | #ifndef SQUID_CONFIGPARSER_H |
37 | #define SQUID_CONFIGPARSER_H | |
38 | ||
582c2af2 | 39 | #include "SquidString.h" |
62e76326 | 40 | |
582c2af2 | 41 | class wordlist; |
abd9dd91 AJ |
42 | /** |
43 | * Limit to how long any given config line may be. | |
44 | * This affects squid.conf and all included files. | |
45 | * | |
46 | * Behaviour when setting larger than 2KB is unknown. | |
47 | * The config parser read mechanism can cope, but the other systems | |
48 | * receiving the data from its buffers on such lines may not. | |
49 | */ | |
50 | #define CONFIG_LINE_LIMIT 2048 | |
51 | ||
52 | /** | |
a9f20260 | 53 | * A configuration file Parser. Instances of this class track |
54 | * parsing state and perform tokenisation. Syntax is currently | |
55 | * taken care of outside this class. | |
9227a6e1 | 56 | * |
57 | * One reason for this class is to allow testing of configuration | |
58 | * using modules without linking cache_cf.o in - because that drags | |
59 | * in all of squid by reference. Instead the tokeniser only is | |
60 | * brought in. | |
a9f20260 | 61 | */ |
62e76326 | 62 | class ConfigParser |
63 | { | |
64 | ||
b67e2c8c | 65 | public: |
a9f20260 | 66 | void destruct(); |
f45dd259 | 67 | static void ParseUShort(unsigned short *var); |
3a69ddf3 | 68 | static void ParseBool(bool *var); |
69 | static void ParseString(char **var); | |
30abd221 | 70 | static void ParseString(String *var); |
f4698e0b CT |
71 | /// Parse an unquoted token (no spaces) or a "quoted string" that |
72 | /// may include spaces. In some contexts, quotes strings may also | |
73 | /// include macros. Quoted strings may escape any character with | |
74 | /// a backslash (\), which is currently only useful for inner | |
75 | /// quotes. TODO: support quoted strings anywhere a token is accepted. | |
76 | static void ParseQuotedString(char **var, bool *wasQuoted = NULL); | |
77 | static void ParseQuotedString(String *var, bool *wasQuoted = NULL); | |
71be37e0 | 78 | static const char *QuoteString(String &var); |
3a69ddf3 | 79 | static void ParseWordList(wordlist **list); |
d295d770 | 80 | static char * strtokFile(); |
b67e2c8c | 81 | }; |
82 | ||
dd9b1081 | 83 | extern int parseConfigFile(const char *file_name); |
62ee09ca | 84 | |
d295d770 | 85 | #endif /* SQUID_CONFIGPARSER_H */ |