CharacterSet.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_BASE_CHARACTERSET_H
#define SQUID_SRC_BASE_CHARACTERSET_H
 
#include <initializer_list>
#include <iosfwd>
#include <vector>
 
class CharacterSet
{
public:
    typedef std::vector<uint8_t> Storage;
 
    explicit CharacterSet(const char *label = "anonymous", const char * const chars = "");
 
    CharacterSet(const char *label, unsigned char low, unsigned char high);
 
    CharacterSet(const char *label, std::initializer_list<std::pair<uint8_t,uint8_t>> ranges);
 
    bool isEmpty() const { return chars_.empty(); }
 
    bool operator[](unsigned char c) const {return chars_[static_cast<uint8_t>(c)] != 0;}
 
    CharacterSet & add(const unsigned char c);
 
    CharacterSet & remove(const unsigned char c);
 
    CharacterSet & addRange(unsigned char low, unsigned char high);
 
    CharacterSet &operator +=(const CharacterSet &rhs);
 
    CharacterSet &operator -=(const CharacterSet &rhs);
 
    CharacterSet complement(const char *complementLabel = nullptr) const;
 
    CharacterSet &rename(const char *label) { name = label; return *this; }
 
    bool operator == (const CharacterSet &cs) const { return chars_ == cs.chars_; }
    bool operator != (const CharacterSet &cs) const { return !operator==(cs); }
 
    void printChars(std::ostream &os) const;
 
    const char * name;
 
    // common character sets, RFC 5234
    // A-Za-z
    static const CharacterSet ALPHA;
    // 0-1
    static const CharacterSet BIT;
    // carriage return
    static const CharacterSet CR;
    // controls
    static const CharacterSet CTL;
    // 0-9
    static const CharacterSet DIGIT;
    // double quote
    static const CharacterSet DQUOTE;
    // 0-9aAbBcCdDeEfF
    static const CharacterSet HEXDIG;
    // horizontal tab
    static const CharacterSet HTAB;
    // line feed
    static const CharacterSet LF;
    // white space
    static const CharacterSet SP;
    // visible (printable) characters
    static const CharacterSet VCHAR;
    // <space><tab>
    static const CharacterSet WSP;
 
    // HTTP character sets, RFC 7230
    // ctext
    static const CharacterSet CTEXT;
    // XXX: maybe field-vchar = VCHAR / obs-text
    // any VCHAR except for SPECIAL
    static const CharacterSet TCHAR;
    // special VCHARs
    static const CharacterSet SPECIAL;
    // qdtext
    static const CharacterSet QDTEXT;
    // obs-text
    static const CharacterSet OBSTEXT;
 
    // HTTP character sets, RFC 7232
    // etagc
    static const CharacterSet ETAGC;
 
    // HTTP character sets, RFC 7235
    // token68 (internal characters only, excludes '=' terminator)
    static const CharacterSet TOKEN68C;
 
    static const CharacterSet &RFC3986_UNRESERVED();
 
private:
    Storage chars_;
};
 
CharacterSet
operator+ (CharacterSet lhs, const CharacterSet &rhs);
 
CharacterSet
operator- (CharacterSet lhs, const CharacterSet &rhs);
 
std::ostream&
operator <<(std::ostream &, const CharacterSet &);
 
#endif /* SQUID_SRC_BASE_CHARACTERSET_H */