Added LLVM copyright header (for lack of a better term).
[oota-llvm.git] / include / llvm / Analysis / FindUsedTypes.h
1 //===- llvm/Analysis/FindUsedTypes.h - Find all Types in use ----*- C++ -*-===//
2 // 
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 // 
8 //===----------------------------------------------------------------------===//
9 //
10 // This pass is used to seek out all of the types in use by the program.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #ifndef LLVM_ANALYSIS_FINDUSEDTYPES_H
15 #define LLVM_ANALYSIS_FINDUSEDTYPES_H
16
17 #include "llvm/Pass.h"
18 #include <set>
19 class SymbolTable;
20 class Type;
21
22 class FindUsedTypes : public Pass {
23   std::set<const Type *> UsedTypes;
24 public:
25   /// getTypes - After the pass has been run, return the set containing all of
26   /// the types used in the module.
27   ///
28   const std::set<const Type *> &getTypes() const { return UsedTypes; }
29
30   /// Print the types found in the module.  If the optional Module parameter is
31   /// passed in, then the types are printed symbolically if possible, using the
32   /// symbol table from the module.
33   ///
34   void print(std::ostream &o, const Module *M) const;
35
36 private:
37   /// IncorporateType - Incorporate one type and all of its subtypes into the
38   /// collection of used types.
39   ///
40   void IncorporateType(const Type *Ty);
41
42 public:
43   /// run - This incorporates all types used by the specified module
44   bool run(Module &M);
45
46   /// getAnalysisUsage - We do not modify anything.
47   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
48     AU.setPreservesAll();
49   }
50
51   // stub - dummy function, just ignore it
52   static void stub();
53 };
54
55 // Make sure that any clients of this file link in PostDominators.cpp
56 static IncludeFile
57 FIND_USED_TYPES_INCLUDE_FILE((void*)&FindUsedTypes::stub);
58
59 #endif