Config.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2023 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_SRC_FORMAT_CONFIG_H
#define SQUID_SRC_FORMAT_CONFIG_H
 
#include "format/Format.h"
#include "SquidString.h"
 
#include <list>
 
class StoreEntry;
 
namespace Format
{
 
class TokenTableEntry;
 
class TokenNamespace
{
public:
    TokenNamespace(const SBuf &nsName, TokenTableEntry const *tSet) : prefix(nsName), tokenSet(tSet) {}
 
    SBuf prefix;
 
    TokenTableEntry const *tokenSet;
};
 
class FmtConfig
{
public:
    void parseFormats();
 
    void dumpFormats(StoreEntry *e, const char *name) {
        formats->dump(e, name);
    }
 
    /* Register a namespace set of tokens to be accepted by the format parser.
     * Multiple arrays can be registered, they will be scanned for
     * in order registered. So care needs to be taken that arrays registered
     * first do not overlap or consume tokens registered later for a namespace.
     */
    void registerTokens(const SBuf &nsName, TokenTableEntry const *tokenArray);
 
    Format *formats;
 
    std::list<TokenNamespace> tokens;
 
#if USE_ADAPTATION
    bool hasAdaptToken;
#endif
 
#if ICAP_CLIENT
    bool hasIcapToken;
#endif
};
 
extern FmtConfig TheConfig;
 
} // namespace Format
 
// Legacy parsing wrappers
#define parse_format(X)  (X)->parseFormats()
#define free_format(X)   do{ delete (*(X)).formats; (*(X)).formats=NULL; }while(false)
#define dump_format(E,N,D) (D).dumpFormats((E),(N))
 
#endif