wordlist.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_WORDLIST_H
#define SQUID_SRC_WORDLIST_H
 
#include "globals.h"
#include "sbuf/List.h"
 
#include <iterator>
 
class wordlist;
 
class WordlistIterator
{
public:
    using value_type = const char *;
 
    explicit WordlistIterator(const wordlist * const wl): w(wl) {}
 
    auto operator ==(const WordlistIterator &rhs) const { return this->w == rhs.w; }
    auto operator !=(const WordlistIterator &rhs) const { return this->w != rhs.w; }
 
    inline value_type operator *() const;
    inline WordlistIterator &operator++();
 
private:
    const wordlist *w;
};
 
class wordlist
{
    MEMPROXY_CLASS(wordlist);
    friend char *wordlistChopHead(wordlist **);
 
public:
    using const_iterator = WordlistIterator;
 
    wordlist() : key(nullptr), next(nullptr) {}
    // create a new wordlist node, with a copy of k as key
    explicit wordlist(const char *k) : key(xstrdup(k)), next(nullptr) {}
 
    wordlist(const wordlist &) = delete;
    wordlist &operator=(const wordlist &) = delete;
 
    auto begin() const { return const_iterator(this); }
    auto end() const { return const_iterator(nullptr); }
 
    char *key;
    wordlist *next;
 
private:
    // does not free data members.
    ~wordlist() = default;
};
 
class MemBuf;
 
const char *wordlistAdd(wordlist **, const char *);
 
void wordlistCat(const wordlist *, MemBuf *);
 
void wordlistDestroy(wordlist **);
 
char *wordlistChopHead(wordlist **);
 
inline WordlistIterator &
WordlistIterator::operator++()
{
    w = w->next;
    return *this;
}
 
inline WordlistIterator::value_type
WordlistIterator::operator*() const
{
    return w->key;
}
 
#endif /* SQUID_SRC_WORDLIST_H */