StringSet.h

Go to the documentation of this file.

//===- StringSet.h - An efficient set built on StringMap --------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
///
/// \file
///  StringSet - A set-like wrapper for the StringMap.
///
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_ADT_STRINGSET_H
#define LLVM_ADT_STRINGSET_H
 
#include "llvm/ADT/ADL.h"
#include "llvm/ADT/STLForwardCompat.h"
#include "llvm/ADT/StringMap.h"
#include "llvm/Support/Compiler.h"
 
namespace llvm {
 
/// StringSet - A wrapper for StringMap that provides set-like functionality.
template <class AllocatorTy = MallocAllocator>
class LLVM_ATTRIBUTE_WARN_UNUSED StringSet
    : public StringMap<EmptyStringSetTag, AllocatorTy> {
  using Base = StringMap<EmptyStringSetTag, AllocatorTy>;
 
public:
  StringSet() = default;
  StringSet(std::initializer_list<StringRef> initializer) {
    for (StringRef str : initializer)
      insert(str);
  }
  template <typename Range> StringSet(llvm::from_range_t, Range &&R) {
    insert(adl_begin(R), adl_end(R));
  }
  explicit StringSet(AllocatorTy a) : Base(a) {}
 
  std::pair<typename Base::iterator, bool> insert(StringRef key) {
    return Base::try_emplace(key);
  }
 
  template <typename InputIt>
  void insert(InputIt begin, InputIt end) {
    for (auto it = begin; it != end; ++it)
      insert(*it);
  }
 
  template <typename Range> void insert_range(Range &&R) {
    insert(adl_begin(R), adl_end(R));
  }
 
  template <typename ValueTy>
  std::pair<typename Base::iterator, bool>
  insert(const StringMapEntry<ValueTy> &mapEntry) {
    return insert(mapEntry.getKey());
  }
 
  /// Check if the set contains the given \c key.
  [[nodiscard]] bool contains(StringRef key) const {
    return Base::contains(key);
  }
};
 
} // end namespace llvm
 
#endif // LLVM_ADT_STRINGSET_H