TinyPtrVector.h revision bb9dbb7d6b4f39b74b755795e31b219a5518dd77
19d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner//===- llvm/ADT/TinyPtrVector.h - 'Normally tiny' vectors -------*- C++ -*-===// 29d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner// 39d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner// The LLVM Compiler Infrastructure 49d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner// 59d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner// This file is distributed under the University of Illinois Open Source 69d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner// License. See LICENSE.TXT for details. 79d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner// 89d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner//===----------------------------------------------------------------------===// 99d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 109d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner#ifndef LLVM_ADT_TINYPTRVECTOR_H 119d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner#define LLVM_ADT_TINYPTRVECTOR_H 129d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 139d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner#include "llvm/ADT/SmallVector.h" 149d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner#include "llvm/ADT/PointerUnion.h" 159d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 169d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattnernamespace llvm { 179d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 189d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner/// TinyPtrVector - This class is specialized for cases where there are 199d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner/// normally 0 or 1 element in a vector, but is general enough to go beyond that 209d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner/// when required. 219d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner/// 229d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner/// NOTE: This container doesn't allow you to store a null pointer into it. 239d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner/// 249d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattnertemplate <typename EltTy> 259d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattnerclass TinyPtrVector { 269d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattnerpublic: 279d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner typedef llvm::SmallVector<EltTy, 4> VecTy; 289d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner llvm::PointerUnion<EltTy, VecTy*> Val; 299d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 309d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner TinyPtrVector() {} 319d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner TinyPtrVector(const TinyPtrVector &RHS) : Val(RHS.Val) { 329d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner if (VecTy *V = Val.template dyn_cast<VecTy*>()) 339d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner Val = new VecTy(*V); 349d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 359d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner ~TinyPtrVector() { 369d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner if (VecTy *V = Val.template dyn_cast<VecTy*>()) 379d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner delete V; 389d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 399d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 40266451dd95b12323fad9418df9b217918ec7e9e0Chris Lattner // implicit conversion operator to ArrayRef. 41266451dd95b12323fad9418df9b217918ec7e9e0Chris Lattner operator ArrayRef<EltTy>() const { 42266451dd95b12323fad9418df9b217918ec7e9e0Chris Lattner if (Val.isNull()) 43266451dd95b12323fad9418df9b217918ec7e9e0Chris Lattner return ArrayRef<EltTy>(); 44266451dd95b12323fad9418df9b217918ec7e9e0Chris Lattner if (Val.template is<EltTy>()) 45bb9dbb7d6b4f39b74b755795e31b219a5518dd77Eli Friedman return *Val.getAddrOfPtr1(); 46266451dd95b12323fad9418df9b217918ec7e9e0Chris Lattner return *Val.template get<VecTy*>(); 47266451dd95b12323fad9418df9b217918ec7e9e0Chris Lattner } 48266451dd95b12323fad9418df9b217918ec7e9e0Chris Lattner 499d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner bool empty() const { 5022e522e08640be459f237796009cf7666d6d75e7Chris Lattner // This vector can be empty if it contains no element, or if it 5122e522e08640be459f237796009cf7666d6d75e7Chris Lattner // contains a pointer to an empty vector. 529d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner if (Val.isNull()) return true; 539d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner if (VecTy *Vec = Val.template dyn_cast<VecTy*>()) 549d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner return Vec->empty(); 559d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner return false; 569d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 579d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 589d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner unsigned size() const { 599d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner if (empty()) 609d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner return 0; 6122e522e08640be459f237796009cf7666d6d75e7Chris Lattner if (Val.template is<EltTy>()) 629d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner return 1; 6322e522e08640be459f237796009cf7666d6d75e7Chris Lattner return Val.template get<VecTy*>()->size(); 649d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 659d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 66e6f1355c38fb66b0bee35cb4d6ec93f07196d961Benjamin Kramer typedef const EltTy *const_iterator; 67bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis typedef EltTy *iterator; 68bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis 69bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis iterator begin() { 7079976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner if (empty()) 7179976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner return 0; 7279976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner 7379976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner if (Val.template is<EltTy>()) 740db235a2b0ed6ae5c3c870012061906054b6dbc4Argyrios Kyrtzidis return Val.getAddrOfPtr1(); 7579976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner 7679976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner return Val.template get<VecTy *>()->begin(); 7779976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner 7879976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner } 79bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis iterator end() { 8079976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner if (empty()) 8179976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner return 0; 8279976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner 8379976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner if (Val.template is<EltTy>()) 8479976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner return begin() + 1; 8579976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner 8679976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner return Val.template get<VecTy *>()->end(); 8779976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner } 8879976a40728c8baa8cd16de90173fe2c48937e22Chris Lattner 89bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis const_iterator begin() const { 90bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis return (const_iterator)const_cast<TinyPtrVector*>(this)->begin(); 91bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis } 92bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis 93bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis const_iterator end() const { 94bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis return (const_iterator)const_cast<TinyPtrVector*>(this)->end(); 95bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis } 96bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis 979d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner EltTy operator[](unsigned i) const { 989d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner assert(!Val.isNull() && "can't index into an empty vector"); 999d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner if (EltTy V = Val.template dyn_cast<EltTy>()) { 1009d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner assert(i == 0 && "tinyvector index out of range"); 1019d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner return V; 1029d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 1039d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 10422e522e08640be459f237796009cf7666d6d75e7Chris Lattner assert(i < Val.template get<VecTy*>()->size() && 1059d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner "tinyvector index out of range"); 10622e522e08640be459f237796009cf7666d6d75e7Chris Lattner return (*Val.template get<VecTy*>())[i]; 1079d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 1089d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 1099d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner EltTy front() const { 1109d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner assert(!empty() && "vector empty"); 1119d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner if (EltTy V = Val.template dyn_cast<EltTy>()) 1129d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner return V; 1139d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner return Val.template get<VecTy*>()->front(); 1149d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 1159d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 1169d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner void push_back(EltTy NewVal) { 1179d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner assert(NewVal != 0 && "Can't add a null value"); 1189d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 1199d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner // If we have nothing, add something. 1209d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner if (Val.isNull()) { 1219d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner Val = NewVal; 1229d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner return; 1239d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 1249d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 1259d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner // If we have a single value, convert to a vector. 12622e522e08640be459f237796009cf7666d6d75e7Chris Lattner if (EltTy V = Val.template dyn_cast<EltTy>()) { 1279d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner Val = new VecTy(); 1289d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner Val.template get<VecTy*>()->push_back(V); 1299d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 1309d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 1319d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner // Add the new value, we know we have a vector. 1329d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner Val.template get<VecTy*>()->push_back(NewVal); 1339d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 1349d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 1359d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner void clear() { 1369d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner // If we have a single value, convert to empty. 137840635741f132a9a10f052cbf3b21e14bc74835aChris Lattner if (Val.template is<EltTy>()) { 1389d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner Val = (EltTy)0; 1399d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } else if (VecTy *Vec = Val.template dyn_cast<VecTy*>()) { 1409d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner // If we have a vector form, just clear it. 1419d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner Vec->clear(); 1429d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 1439d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner // Otherwise, we're already empty. 1449d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner } 145bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis 146bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis iterator erase(iterator I) { 147bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis // If we have a single value, convert to empty. 148bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis if (Val.template is<EltTy>()) { 149bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis if (I == begin()) 150bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis Val = (EltTy)0; 151bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis } else if (VecTy *Vec = Val.template dyn_cast<VecTy*>()) { 152bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis // multiple items in a vector; just do the erase, there is no 153bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis // benefit to collapsing back to a pointer 154bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis return Vec->erase(I); 155bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis } 156bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis 157bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis return 0; 158bb07f21c76f011d8dde491104ff242af30bfb4abArgyrios Kyrtzidis } 1599d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 1609d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattnerprivate: 1619d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner void operator=(const TinyPtrVector&); // NOT IMPLEMENTED YET. 1629d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner}; 1639d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner} // end namespace llvm 1649d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner 1659d69d4aadd4a58aba5634d5c3d2c2a6d8d284134Chris Lattner#endif 166