UT_StringSet.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 * 
 * NAME:        UT_StringSet.h
 *
 * COMMENTS:    No UT_API here because there's no lib implementation!
 */

#pragma once

#ifndef __UT_StringSet_h__
#define __UT_StringSet_h__

#include "UT_ArrayStringSet.h" // This is only included to avoid sweeping for it right now.
#include "UT_Set.h"
#include "UT_StringHolder.h"

/// We want methods like find() to take a const UT_StringRef& instead of a
/// const UT_StringHolder& for the following reasons:
/// - This allows a const char* to be passed in without forcing a copy of the string.
/// - A UT_StringRef can be used without converting it to a UT_StringHolder
/// (which hardens the string if necessary).
/// - A UT_StringHolder can still be directly passed in.
#define UT_STRINGREF_WRAPPER(return_type, name, qualifier) \
    inline return_type name(const UT_StringRef &key) qualifier \
    { \
        return Parent::name(UTmakeUnsafeRef(key)); \
    }
/// Specialization of the above macro for methods that return an iterator
/// range, since something like std::pair<iterator, iterator> is interpreted as
/// two arguments when being passed to a macro (due to the comma).
#define UT_STRINGREF_WRAPPER_RANGE(iterator_type, name, qualifier) \
    inline std::pair<iterator_type, iterator_type> \
    name(const UT_StringRef &key) qualifier \
    { \
        return Parent::name(UTmakeUnsafeRef(key)); \
    }

/// UT_StringSet is a simple specialization of a UT_Set that has
/// UT_StringHolder as its key type which allows C strings to be used.
/// If you know that a string will not be destroyed during the set's
/// lifetime, UTmakeUnsafeRef can be used to insert a shallow reference.
class UT_StringSet : public UT_Set<UT_StringHolder>
{
    typedef UT_Set<UT_StringHolder> Parent;

public:
    typedef Parent::const_iterator const_iterator;
    typedef Parent::iterator iterator;
    typedef Parent::size_type size_type;

    UT_StringSet() = default;

    /// Constructs a set from an iterator range.
    template <typename InputIt>
    UT_StringSet(InputIt first, InputIt last) : Parent(first, last) {}

    /// Constructs a set from an initializer list.
    UT_StringSet(std::initializer_list<UT_StringHolder> init) : Parent(init) {}

    iterator erase(const_iterator pos)
    { return Parent::erase(pos); }
    iterator erase(const_iterator first, const_iterator last)
    { return Parent::erase(first, last); }

    UT_STRINGREF_WRAPPER(size_type, count, const)
    UT_STRINGREF_WRAPPER_RANGE(iterator, equal_range, )
    UT_STRINGREF_WRAPPER_RANGE(const_iterator, equal_range, const)
    UT_STRINGREF_WRAPPER(size_type, erase, )
    UT_STRINGREF_WRAPPER(iterator, find, )
    UT_STRINGREF_WRAPPER(const_iterator, find, const)

    bool contains(const UT_StringRef &ref) const
    { return count(ref) > 0; }

    bool contains(const UT_StringSet &src) const
    { for (const_iterator it = src.begin(); it != src.end(); ++it)
        if (!contains(*it))
            return false;
      return true; }

    /// Set-wise boolean operations.
    UT_StringSet &operator|=(const UT_StringSet &src)
    { for (const_iterator it = src.begin(); it != src.end(); ++it)
        insert(*it);
      return *this; }
    UT_StringSet &operator&=(const UT_StringSet &src)
    { UT_StringSet result;
      for (const_iterator it = src.begin(); it != src.end(); ++it)
        if (contains(*it))
            result.insert(*it);
      *this = std::move(result);
      return *this; }
    UT_StringSet &operator-=(const UT_StringSet &src)
    { for (const_iterator it = src.begin(); it != src.end(); ++it)
        erase(*it);
      return *this; }
};

class UT_SortedStringSet : public UT_SortedSet<UT_StringHolder>
{
    typedef UT_SortedSet<UT_StringHolder> Parent;

public:
    typedef Parent::const_iterator const_iterator;
    typedef Parent::iterator iterator;
    typedef Parent::size_type size_type;

    iterator erase(const_iterator pos)
    { return Parent::erase(pos); }
    iterator erase(const_iterator first, const_iterator last)
    { return Parent::erase(first, last); }

    UT_STRINGREF_WRAPPER(size_type, count, const)
    UT_STRINGREF_WRAPPER_RANGE(iterator, equal_range, )
    UT_STRINGREF_WRAPPER_RANGE(const_iterator, equal_range, const)
    UT_STRINGREF_WRAPPER(size_type, erase, )
    UT_STRINGREF_WRAPPER(iterator, find, )
    UT_STRINGREF_WRAPPER(const_iterator, find, const)
    UT_STRINGREF_WRAPPER(iterator, lower_bound, )
    UT_STRINGREF_WRAPPER(const_iterator, lower_bound, const)
    UT_STRINGREF_WRAPPER(iterator, upper_bound, )
    UT_STRINGREF_WRAPPER(const_iterator, upper_bound, const)

    bool contains(const UT_StringRef &ref) const
    { return count(ref) > 0; }

    bool contains(const UT_SortedStringSet &src) const
    { for (const_iterator it = src.begin(); it != src.end(); ++it)
        if (!contains(*it))
            return false;
      return true; }

    /// Set-wise boolean operations.
    UT_SortedStringSet &operator|=(const UT_SortedStringSet &src)
    { for (const_iterator it = src.begin(); it != src.end(); ++it)
        insert(*it);
      return *this; }
    UT_SortedStringSet &operator&=(const UT_SortedStringSet &src)
    { UT_SortedStringSet result;
      for (const_iterator it = src.begin(); it != src.end(); ++it)
        if (contains(*it))
            result.insert(*it);
      *this = std::move(result);
      return *this; }
    UT_SortedStringSet &operator-=(const UT_SortedStringSet &src)
    { for (const_iterator it = src.begin(); it != src.end(); ++it)
        erase(*it);
      return *this; }
};

#undef UT_STRINGREF_WRAPPER
#undef UT_STRINGREF_WRAPPER_RANGE

#endif