StringMap - This is an unconventional map that is specialized for handling keys that are "strings", which are basically ranges of bytes. More...
#include "llvm/ADT/StringMap.h"
Inherits llvm::StringMapImpl, and llvm::detail::AllocatorHolder< Alloc >.
Inherited by llvm::StringSet< AllocatorTy >.
Public Types | |
| using | MapEntryTy = StringMapEntry< ValueTy > |
| using | key_type = const char * |
| using | mapped_type = ValueTy |
| using | value_type = StringMapEntry< ValueTy > |
| using | size_type = size_t |
| using | const_iterator = StringMapConstIterator< ValueTy > |
| using | iterator = StringMapIterator< ValueTy > |
Public Member Functions | |
| StringMap () | |
| StringMap (unsigned InitialSize) | |
| StringMap (AllocatorTy A) | |
| StringMap (unsigned InitialSize, AllocatorTy A) | |
| StringMap (std::initializer_list< std::pair< StringRef, ValueTy > > List) | |
| StringMap (StringMap &&RHS) | |
| StringMap (const StringMap &RHS) | |
| StringMap & | operator= (StringMap RHS) |
| ~StringMap () | |
| iterator | begin () |
| iterator | end () |
| const_iterator | begin () const |
| const_iterator | end () const |
| iterator_range< StringMapKeyIterator< ValueTy > > | keys () const |
| iterator | find (StringRef Key) |
| const_iterator | find (StringRef Key) const |
| ValueTy | lookup (StringRef Key) const |
| lookup - Return the entry for the specified key, or a default constructed value if no such entry exists. | |
| const ValueTy & | at (StringRef Val) const |
| at - Return the entry for the specified key, or abort if no such entry exists. | |
| ValueTy & | operator[] (StringRef Key) |
Lookup the ValueTy for the Key, or create a default constructed value if the key is not in the map. | |
| bool | contains (StringRef Key) const |
| contains - Return true if the element is in the map, false otherwise. | |
| size_type | count (StringRef Key) const |
| count - Return 1 if the element is in the map, 0 otherwise. | |
| template<typename InputTy > | |
| size_type | count (const StringMapEntry< InputTy > &MapEntry) const |
| bool | operator== (const StringMap &RHS) const |
| equal - check whether both of the containers are equal. | |
| bool | operator!= (const StringMap &RHS) const |
| bool | insert (MapEntryTy *KeyValue) |
| insert - Insert the specified key/value pair into the map. | |
| std::pair< iterator, bool > | insert (std::pair< StringRef, ValueTy > KV) |
| insert - Inserts the specified key/value pair into the map if the key isn't already in the map. | |
| template<typename InputIt > | |
| void | insert (InputIt First, InputIt Last) |
| Inserts elements from range [first, last). | |
| void | insert (std::initializer_list< std::pair< StringRef, ValueTy > > List) |
| Inserts elements from initializer list ilist. | |
| template<typename V > | |
| std::pair< iterator, bool > | insert_or_assign (StringRef Key, V &&Val) |
| Inserts an element or assigns to the current element if the key already exists. | |
| template<typename... ArgsTy> | |
| std::pair< iterator, bool > | try_emplace (StringRef Key, ArgsTy &&...Args) |
| Emplace a new element for the specified key into the map if the key isn't already in the map. | |
| void | clear () |
| void | remove (MapEntryTy *KeyValue) |
| remove - Remove the specified key/value pair from the map, but do not erase it. | |
| void | erase (iterator I) |
| bool | erase (StringRef Key) |
 Public Member Functions inherited from llvm::StringMapImpl | |
| unsigned | getNumBuckets () const |
| unsigned | getNumItems () const |
| bool | empty () const |
| unsigned | size () const |
| void | swap (StringMapImpl &Other) |
Additional Inherited Members | |
| Static Public Member Functions inherited from llvm::StringMapImpl | |
| static StringMapEntryBase * | getTombstoneVal () |
| Static Public Attributes inherited from llvm::StringMapImpl | |
| static constexpr uintptr_t | TombstoneIntVal |
| Protected Member Functions inherited from llvm::StringMapImpl | |
| StringMapImpl (unsigned itemSize) | |
| StringMapImpl (StringMapImpl &&RHS) | |
| StringMapImpl (unsigned InitSize, unsigned ItemSize) | |
| unsigned | RehashTable (unsigned BucketNo=0) |
| RehashTable - Grow the table, redistributing values into the buckets with the appropriate mod-of-hashtable-size. | |
| unsigned | LookupBucketFor (StringRef Key) |
| LookupBucketFor - Look up the bucket that the specified string should end up in. | |
| int | FindKey (StringRef Key) const |
| FindKey - Look up the bucket that contains the specified key. | |
| void | RemoveKey (StringMapEntryBase *V) |
| RemoveKey - Remove the specified StringMapEntry from the table, but do not delete it. | |
| StringMapEntryBase * | RemoveKey (StringRef Key) |
| RemoveKey - Remove the StringMapEntry for the specified key from the table, returning it. | |
| void | init (unsigned Size) |
| Allocate the table with the specified number of buckets and otherwise setup the map as empty. | |
| Protected Attributes inherited from llvm::StringMapImpl | |
| StringMapEntryBase ** | TheTable = nullptr |
| unsigned | NumBuckets = 0 |
| unsigned | NumItems = 0 |
| unsigned | NumTombstones = 0 |
| unsigned | ItemSize |
Detailed Description
class llvm::StringMap< ValueTy, AllocatorTy >
StringMap - This is an unconventional map that is specialized for handling keys that are "strings", which are basically ranges of bytes.
This does some funky memory allocation and hashing things to make it extremely efficient, storing the string data after the value in the map.
Definition at line 110 of file StringMap.h.
Member Typedef Documentation
◆ const_iterator
| using llvm::StringMap< ValueTy, AllocatorTy >::const_iterator = StringMapConstIterator<ValueTy> |
Definition at line 201 of file StringMap.h.
◆ iterator
| using llvm::StringMap< ValueTy, AllocatorTy >::iterator = StringMapIterator<ValueTy> |
Definition at line 202 of file StringMap.h.
◆ key_type
| using llvm::StringMap< ValueTy, AllocatorTy >::key_type = const char * |
Definition at line 196 of file StringMap.h.
◆ MapEntryTy
| using llvm::StringMap< ValueTy, AllocatorTy >::MapEntryTy = StringMapEntry<ValueTy> |
Definition at line 116 of file StringMap.h.
◆ mapped_type
| using llvm::StringMap< ValueTy, AllocatorTy >::mapped_type = ValueTy |
Definition at line 197 of file StringMap.h.
◆ size_type
| using llvm::StringMap< ValueTy, AllocatorTy >::size_type = size_t |
Definition at line 199 of file StringMap.h.
◆ value_type
| using llvm::StringMap< ValueTy, AllocatorTy >::value_type = StringMapEntry<ValueTy> |
Definition at line 198 of file StringMap.h.
Constructor & Destructor Documentation
◆ StringMap() [1/7]
|
inline |
Definition at line 118 of file StringMap.h.
◆ StringMap() [2/7]
|
inlineexplicit |
Definition at line 120 of file StringMap.h.
◆ StringMap() [3/7]
|
inlineexplicit |
Definition at line 123 of file StringMap.h.
◆ StringMap() [4/7]
|
inline |
Definition at line 126 of file StringMap.h.
◆ StringMap() [5/7]
|
inline |
Definition at line 130 of file StringMap.h.
References List, and llvm::size().
◆ StringMap() [6/7]
|
inline |
Definition at line 135 of file StringMap.h.
References llvm::move().
◆ StringMap() [7/7]
|
inline |
Definition at line 138 of file StringMap.h.
◆ ~StringMap()
|
inline |
Definition at line 179 of file StringMap.h.
Member Function Documentation
◆ at()
|
inline |
at - Return the entry for the specified key, or abort if no such entry exists.
Definition at line 243 of file StringMap.h.
References assert(), and llvm::find().
◆ begin() [1/2]
|
inline |
Definition at line 204 of file StringMap.h.
Referenced by llvm::ValueSymbolTable::begin(), llvm::RecordStreamer::begin(), llvm::codeview::DebugStringTableSubsection::begin(), llvm::DCData::begin(), llvm::orc::SymbolStringPool::clearDeadEntries(), llvm::jitlink::LinkGraph::external_symbols(), llvm::ExecutionEngine::getGlobalValueAtAddress(), llvm::LLVMContext::getMDKindNames(), llvm::StringSet< AllocatorTy >::insert(), LookupNearestOption(), and sortOpts().
◆ begin() [2/2]
|
inline |
Definition at line 206 of file StringMap.h.
◆ clear()
|
inline |
◆ contains()
|
inline |
contains - Return true if the element is in the map, false otherwise.
Definition at line 254 of file StringMap.h.
References llvm::find().
Referenced by llvm::jitlink::LinkGraph::addExternalSymbol(), llvm::Logger::hasAnyObservationForContext(), llvm::jitlink::LinkGraph::makeAbsolute(), llvm::jitlink::LinkGraph::makeDefined(), and llvm::jitlink::LinkGraph::removeExternalSymbol().
◆ count() [1/2]
|
inline |
Definition at line 260 of file StringMap.h.
References llvm::count(), and llvm::StringMapEntry< ValueTy >::getKey().
◆ count() [2/2]
|
inline |
count - Return 1 if the element is in the map, 0 otherwise.
Definition at line 257 of file StringMap.h.
References contains().
Referenced by llvm::AArch64Subtarget::AArch64Subtarget(), llvm::jitlink::MachOLinkGraphBuilder::addCustomSectionParser(), llvm::DCData::getSuccessorLabel(), HandlePrefixedOrGroupedOption(), llvm::OffloadEntriesInfoManager::hasDeviceGlobalVarEntryInfo(), llvm::ModuleSummaryIndex::hasExportedFunctions(), llvm::AMDGPU::insertWaveSizeFeature(), llvm::CachedPathResolver::resolve(), and shouldApply().
◆ end() [1/2]
|
inline |
Definition at line 205 of file StringMap.h.
Referenced by llvm::RuntimeDyldImpl::applyExternalSymbolRelocations(), llvm::orc::SymbolStringPool::clearDeadEntries(), llvm::ValueSymbolTable::end(), llvm::RecordStreamer::end(), llvm::codeview::DebugStringTableSubsection::end(), llvm::DCData::end(), llvm::jitlink::LinkGraph::external_symbols(), llvm::RecordStreamer::flushSymverDirectives(), llvm::ExecutionEngine::getAddressToGlobalIfAvailable(), llvm::ReplayInlineAdvisor::getAdviceImpl(), llvm::PerTargetMIParsingState::getBitmaskTargetFlag(), llvm::orc::ExecutorProcessControl::getBootstrapMapValue(), llvm::PerTargetMIParsingState::getDirectTargetFlag(), llvm::ExecutionEngine::getGlobalValueAtAddress(), llvm::codeview::DebugStringTableSubsection::getIdForString(), llvm::LLVMContext::getMDKindNames(), llvm::PerTargetMIParsingState::getMMOTargetFlag(), llvm::ModuleSummaryIndex::getModule(), llvm::ModuleSummaryIndex::getModuleHash(), llvm::SlotTracker::getModulePathSlot(), llvm::LLVMContextImpl::getOperandBundleTagID(), getOptionPred(), llvm::PerTargetMIParsingState::getRegBank(), llvm::PerTargetMIParsingState::getRegClass(), llvm::PerTargetMIParsingState::getRegMask(), llvm::RuntimeDyldMachO::getRelocationValueRef(), llvm::pdb::DbiStreamBuilder::getSourceFileNameIndex(), llvm::PerTargetMIParsingState::getSubRegIndex(), llvm::RuntimeDyldImpl::getSymbol(), llvm::RuntimeDyldImpl::getSymbolLocalAddress(), llvm::RuntimeDyldImpl::getSymbolSectionID(), llvm::PerTargetMIParsingState::getTargetIndex(), llvm::SlotTracker::getTypeIdCompatibleVtableSlot(), llvm::SlotTracker::getTypeIdSlot(), llvm::StringSet< AllocatorTy >::insert(), llvm::dwarflinker_parallel::DWARFLinkerImpl::LinkContext::isClangModuleRef(), LookupNearestOption(), llvm::PerTargetMIParsingState::parseInstrName(), llvm::Annotations::pointsWithPayload(), llvm::Annotations::pointWithPayload(), llvm::RuntimeDyldMachOARM::processRelocationRef(), llvm::RuntimeDyldELF::processRelocationRef(), llvm::Annotations::rangesWithPayload(), llvm::Annotations::rangeWithPayload(), llvm::ImportedFunctionsInliningStatistics::recordInline(), llvm::ExecutionEngineState::RemoveMapping(), and sortOpts().
◆ end() [2/2]
|
inline |
Definition at line 209 of file StringMap.h.
◆ erase() [1/2]
|
inline |
Definition at line 382 of file StringMap.h.
References I.
Referenced by llvm::orc::SymbolStringPool::clearDeadEntries(), llvm::Module::eraseNamedMetadata(), llvm::jitlink::LinkGraph::makeAbsolute(), llvm::jitlink::LinkGraph::makeDefined(), llvm::jitlink::LinkGraph::removeExternalSymbol(), and llvm::ExecutionEngineState::RemoveMapping().
◆ erase() [2/2]
|
inline |
Definition at line 388 of file StringMap.h.
References llvm::erase(), llvm::find(), and I.
◆ find() [1/2]
|
inline |
Definition at line 218 of file StringMap.h.
Referenced by llvm::RuntimeDyldImpl::applyExternalSymbolRelocations(), llvm::RecordStreamer::flushSymverDirectives(), llvm::ExecutionEngine::getAddressToGlobalIfAvailable(), llvm::ReplayInlineAdvisor::getAdviceImpl(), llvm::PerTargetMIParsingState::getBitmaskTargetFlag(), llvm::orc::ExecutorProcessControl::getBootstrapMapValue(), llvm::PerTargetMIParsingState::getDirectTargetFlag(), llvm::codeview::DebugStringTableSubsection::getIdForString(), llvm::PerTargetMIParsingState::getMMOTargetFlag(), llvm::ModuleSummaryIndex::getModule(), llvm::ModuleSummaryIndex::getModuleHash(), llvm::SlotTracker::getModulePathSlot(), llvm::LLVMContextImpl::getOperandBundleTagID(), getOptionPred(), llvm::PerTargetMIParsingState::getRegBank(), llvm::PerTargetMIParsingState::getRegClass(), llvm::PerTargetMIParsingState::getRegMask(), llvm::RuntimeDyldMachO::getRelocationValueRef(), llvm::pdb::DbiStreamBuilder::getSourceFileNameIndex(), llvm::PerTargetMIParsingState::getSubRegIndex(), llvm::DCData::getSuccessorLabel(), llvm::RuntimeDyldImpl::getSymbol(), llvm::RuntimeDyldImpl::getSymbolLocalAddress(), llvm::RuntimeDyldImpl::getSymbolSectionID(), llvm::PerTargetMIParsingState::getTargetIndex(), llvm::SlotTracker::getTypeIdCompatibleVtableSlot(), llvm::SlotTracker::getTypeIdSlot(), HandlePrefixedOrGroupedOption(), llvm::dwarflinker_parallel::DWARFLinkerImpl::LinkContext::isClangModuleRef(), llvm::PerTargetMIParsingState::parseInstrName(), llvm::Annotations::pointsWithPayload(), llvm::Annotations::pointWithPayload(), llvm::RuntimeDyldMachOARM::processRelocationRef(), llvm::RuntimeDyldELF::processRelocationRef(), llvm::Annotations::rangesWithPayload(), llvm::Annotations::rangeWithPayload(), llvm::ImportedFunctionsInliningStatistics::recordInline(), and llvm::ExecutionEngineState::RemoveMapping().
◆ find() [2/2]
|
inline |
Definition at line 225 of file StringMap.h.
◆ insert() [1/4]
|
inline |
Inserts elements from range [first, last).
If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted .
Definition at line 314 of file StringMap.h.
References llvm::Last.
◆ insert() [2/4]
|
inline |
insert - Insert the specified key/value pair into the map.
If the key already exists in the map, return false and ignore the request, otherwise insert it and return true.
Definition at line 287 of file StringMap.h.
References assert(), and llvm::StringMapEntry< ValueTy >::getKey().
Referenced by llvm::jitlink::LinkGraph::addExternalSymbol(), llvm::pdb::DbiStreamBuilder::addModuleSourceFile(), llvm::DCData::addSuccessorLabel(), llvm::CodeViewContext::addToStringTable(), llvm::dwarflinker_parallel::DWARFLinkerImpl::LinkContext::cloneAndEmitDebugFrame(), llvm::MCContext::createELFRelSection(), createIndexMap(), llvm::IRComparer< T >::generateFunctionData(), llvm::NonRelocatableStringpool::getEntry(), llvm::LLVMContext::getMDKindID(), llvm::StringToOffsetTable::GetOrAddStringOffset(), llvm::LLVMContextImpl::getOrInsertBundleTag(), llvm::Module::getOrInsertComdat(), llvm::Module::getUniqueIntrinsicName(), llvm::codeview::DebugStringTableSubsection::insert(), llvm::AMDGPU::insertWaveSizeFeature(), llvm::NonRelocatableStringpool::internString(), llvm::jitlink::LinkGraph::makeExternal(), printMemberHeader(), llvm::dwarflinker_parallel::DWARFLinkerImpl::LinkContext::registerModuleReference(), llvm::CachedPathResolver::resolve(), llvm::RuntimeDyldImpl::resolveExternalSymbols(), llvm::Logger::startObservation(), and llvm::MCDwarfLineTableHeader::tryGetFile().
◆ insert() [3/4]
|
inline |
Inserts elements from initializer list ilist.
If multiple elements in the range have keys that compare equivalent, it is unspecified which element is inserted
Definition at line 322 of file StringMap.h.
References List.
◆ insert() [4/4]
|
inline |
insert - Inserts the specified key/value pair into the map if the key isn't already in the map.
The bool component of the returned pair is true if and only if the insertion takes place, and the iterator component of the pair points to the element with key equivalent to the key of the pair.
Definition at line 307 of file StringMap.h.
◆ insert_or_assign()
|
inline |
Inserts an element or assigns to the current element if the key already exists.
The return type is the same as try_emplace.
Definition at line 329 of file StringMap.h.
◆ keys()
|
inline |
Definition at line 213 of file StringMap.h.
References llvm::make_range().
Referenced by llvm::Annotations::all_points(), llvm::Annotations::all_ranges(), and llvm::InstrProfSymtab::dumpNames().
◆ lookup()
|
inline |
lookup - Return the entry for the specified key, or a default constructed value if no such entry exists.
Definition at line 234 of file StringMap.h.
References llvm::find().
Referenced by llvm::Module::getNamedMetadata(), llvm::OpenMPIRBuilder::getOpenMPDefaultSimdAlign(), llvm::PassRegistry::getPassInfo(), llvm::ValueSymbolTable::lookup(), and llvm::MCContext::lookupSymbol().
◆ operator!=()
|
inline |
Definition at line 282 of file StringMap.h.
References RHS.
◆ operator=()
|
inline |
Definition at line 173 of file StringMap.h.
References RHS, and std::swap().
◆ operator==()
|
inline |
equal - check whether both of the containers are equal.
Definition at line 265 of file StringMap.h.
References RHS, and llvm::size().
◆ operator[]()
|
inline |
Lookup the ValueTy for the Key, or create a default constructed value if the key is not in the map.
Definition at line 251 of file StringMap.h.
◆ remove()
|
inline |
remove - Remove the specified key/value pair from the map, but do not erase it.
This aborts if the key is not in the map.
Definition at line 380 of file StringMap.h.
Referenced by llvm::StructType::setName().
◆ try_emplace()
|
inline |
Emplace a new element for the specified key into the map if the key isn't already in the map.
The bool component of the returned pair is true if and only if the insertion takes place, and the iterator component of the pair points to the element with key equivalent to the key of the pair.
Definition at line 341 of file StringMap.h.
References assert().
Referenced by llvm::StringSet< AllocatorTy >::insert(), and llvm::orc::SymbolStringPool::intern().
The documentation for this class was generated from the following file:
- include/llvm/ADT/StringMap.h
