ConfigParser.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2019 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.
 */

#ifndef SQUID_CONFIGPARSER_H
#define SQUID_CONFIGPARSER_H

#include "SquidString.h"
#include "sbuf/forward.h"

#include <queue>
#include <stack>
#include <string>

class wordlist;

#define CONFIG_LINE_LIMIT   2048

class ConfigParser
{

public:
    enum TokenType {SimpleToken, QuotedToken, FunctionParameters};

    void destruct();
    static void ParseUShort(unsigned short *var);
    static void ParseBool(bool *var);
    static const char *QuoteString(const String &var);
    static void ParseWordList(wordlist **list);

    static char * strtokFile();

    static char *NextToken();

    static char *RegexStrtokFile();

    static char *RegexPattern();

    static char *NextQuotedToken();

    static bool LastTokenWasQuoted() {return (LastTokenType == ConfigParser::QuotedToken);}

    static char *NextQuotedOrToEol();

    static bool NextKvPair(char * &key, char * &value);

    static char *PeekAtToken();

    static void TokenPutBack(const char *token);

    static void SetCfgLine(char *line);

    static void EnableMacros() {AllowMacros_ = true;}

    static void DisableMacros() {AllowMacros_ = false;}

    static SBuf CurrentLocation();

    static bool RecognizeQuotedValues;

    static bool StrictMode;

protected:
    class CfgFile
    {
    public:
        CfgFile(): wordFile(NULL), parsePos(NULL), lineNo(0) { parseBuffer[0] = '\0';}
        ~CfgFile();
        bool isOpen() {return wordFile != NULL;}

        bool startParse(char *path);

        char *parse(TokenType &type);

    private:
        bool getFileLine();   

        char *nextElement(TokenType &type);
        FILE *wordFile; 
        char parseBuffer[CONFIG_LINE_LIMIT]; 
        const char *parsePos; 
    public:
        std::string filePath; 
        std::string currentLine; 
        int lineNo; 
    };

    static char *Undo();

    static char *UnQuote(const char *token, const char **next = NULL);

    static char *TokenParse(const char * &nextToken, TokenType &type);

    static char *NextElement(TokenType &type);
    static std::stack<CfgFile *> CfgFiles; 
    static TokenType LastTokenType; 
    static const char *CfgLine; 
    static const char *CfgPos; 
    static std::queue<char *> CfgLineTokens_; 
    static std::queue<std::string> Undo_; 
    static bool AllowMacros_;
    static bool ParseQuotedOrToEol_; 
    static bool RecognizeQuotedPair_; 
    static bool PreviewMode_; 
    static bool ParseKvPair_; 
    static enum ParsingStates {atParseKey, atParseValue} KvPairState_; 
};

int parseConfigFile(const char *file_name);

#endif /* SQUID_CONFIGPARSER_H */