Tokenizer.h

Go to the documentation of this file.

/*
 * Copyright (C) 1996-2025 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_PARSER_TOKENIZER_H
#define SQUID_SRC_PARSER_TOKENIZER_H
 
#include "base/CharacterSet.h"
#include "sbuf/SBuf.h"
 
namespace Parser
{
 
class Tokenizer
{
public:
    explicit Tokenizer(const SBuf &inBuf) : buf_(inBuf), parsed_(0) {}
 
    SBuf buf() const { return buf_; }
 
    SBuf::size_type parsedSize() const { return parsed_; }
 
    bool atEnd() const { return buf_.isEmpty(); }
 
    const SBuf& remaining() const { return buf_; }
 
    void reset(const SBuf &newBuf) { undoParse(newBuf, 0); }
 
    bool token(SBuf &returnedToken, const CharacterSet &delimiters);
 
    bool prefix(SBuf &returnedToken, const CharacterSet &tokenChars, SBuf::size_type limit = SBuf::npos);
 
    bool suffix(SBuf &returnedToken, const CharacterSet &tokenChars, SBuf::size_type limit = SBuf::npos);
 
    bool skipSuffix(const SBuf &tokenToSkip);
 
    bool skip(const SBuf &tokenToSkip);
 
    bool skip(const char tokenChar);
 
    bool skipOne(const CharacterSet &discardables);
 
    SBuf::size_type skipAll(const CharacterSet &discardables);
 
    void skipRequired(const char *description, const SBuf &tokenToSkip);
 
    bool skipOneTrailing(const CharacterSet &discardables);
 
    SBuf::size_type skipAllTrailing(const CharacterSet &discardables);
 
    bool int64(int64_t &result, int base = 0, bool allowSign = true, SBuf::size_type limit = SBuf::npos);
 
    /*
     * The methods below mimic their counterparts documented above, but they
     * throw on errors, including InsufficientInput. The field description
     * parameter is used for error reporting and debugging.
     */
 
    SBuf prefix(const char *description, const CharacterSet &tokenChars, SBuf::size_type limit = SBuf::npos);
 
    int64_t udec64(const char *description, SBuf::size_type limit = SBuf::npos);
 
protected:
    SBuf consume(const SBuf::size_type n);
    SBuf::size_type success(const SBuf::size_type n);
    SBuf consumeTrailing(const SBuf::size_type n);
    SBuf::size_type successTrailing(const SBuf::size_type n);
 
    void undoParse(const SBuf &newBuf, SBuf::size_type cParsed) { buf_ = newBuf; parsed_ = cParsed; }
 
private:
    SBuf buf_; 
    SBuf::size_type parsed_; 
};
 
} /* namespace Parser */
 
#endif /* SQUID_SRC_PARSER_TOKENIZER_H */