LLVM.h | Explore in Territory

//===--- LLVM.h - Import various common LLVM datatypes ----------*- 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
/// Forward-declares and imports various common LLVM datatypes that
/// clang wants to use unqualified.
///
//===----------------------------------------------------------------------===//

#ifndef LLVM_CLANG_BASIC_LLVM_H
#define LLVM_CLANG_BASIC_LLVM_H

// Do not proliferate #includes here, require clients to #include their
// dependencies.
// Casting.h has complex templates that cannot be easily forward declared.
#include "llvm/Support/Casting.h"
// Add this header as a workaround to prevent `too few template arguments for
// class template 'SmallVector'` building error with build compilers like XL.
#include "llvm/ADT/SmallVector.h"

namespace llvm {
  // ADT's.
  class StringRef;
  class Twine;
  class VersionTuple;
  template<typename T> class ArrayRef;
  template<typename T> class MutableArrayRef;
  template<typename T> class OwningArrayRef;
  template<unsigned InternalLen> class SmallString;
  template<typename T, unsigned N> class SmallVector;
  template<typename T> class SmallVectorImpl;
  template <class T> class Expected;

  template<typename T>
  struct SaveAndRestore;

  // Reference counting.
  template <typename T> class IntrusiveRefCntPtr;
  template <typename T> struct IntrusiveRefCntPtrInfo;
  template <class Derived> class RefCountedBase;

  class raw_ostream;
  class raw_pwrite_stream;
  // TODO: DenseMap, ...
}


namespace clang {
  // Casting operators.
  isa;
  isa_and_nonnull;
  isa_and_present;
  cast;
  dyn_cast;
  dyn_cast_or_null;
  dyn_cast_if_present;
  cast_or_null;
  cast_if_present;

  // ADT's.
  ArrayRef;
  MutableArrayRef;
  OwningArrayRef;
  SaveAndRestore;
  SmallString;
  SmallVector;
  SmallVectorImpl;
  StringRef;
  Twine;
  VersionTuple;

  // Error handling.
  Expected;

  // Reference counting.
  IntrusiveRefCntPtr;
  IntrusiveRefCntPtrInfo;
  RefCountedBase;

  raw_ostream;
  raw_pwrite_stream;
} // end namespace clang.

#endif
llvm/clang/include/clang/Basic/LLVM.h
