1
//===- llvm/ADT/NullablePtr.h - A pointer that allows null ------*- C++ -*-===//
3
// The LLVM Compiler Infrastructure
5
// This file is distributed under the University of Illinois Open Source
6
// License. See LICENSE.TXT for details.
8
//===----------------------------------------------------------------------===//
10
// This file defines and implements the NullablePtr class.
12
//===----------------------------------------------------------------------===//
14
#ifndef LLVM_ADT_NULLABLE_PTR_H
15
#define LLVM_ADT_NULLABLE_PTR_H
21
/// NullablePtr pointer wrapper - NullablePtr is used for APIs where a
22
/// potentially-null pointer gets passed around that must be explicitly handled
23
/// in lots of places. By putting a wrapper around the null pointer, it makes
24
/// it more likely that the null pointer case will be handled correctly.
29
NullablePtr(T *P = 0) : Ptr(P) {}
31
bool isNull() const { return Ptr == 0; }
32
bool isNonNull() const { return Ptr != 0; }
34
/// get - Return the pointer if it is non-null.
35
const T *get() const {
36
assert(Ptr && "Pointer wasn't checked for null!");
40
/// get - Return the pointer if it is non-null.
42
assert(Ptr && "Pointer wasn't checked for null!");
46
T *getPtrOrNull() { return Ptr; }
47
const T *getPtrOrNull() const { return Ptr; }
50
} // end namespace llvm