'Pass' should now not be derived from by clients. Instead, they should derive
[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
20 namespace llvm {
21
22 class Type;
23
24 class FindUsedTypes : public ModulePass {
25   std::set<const Type *> UsedTypes;
26 public:
27   /// getTypes - After the pass has been run, return the set containing all of
28   /// the types used in the module.
29   ///
30   const std::set<const Type *> &getTypes() const { return UsedTypes; }
31
32   /// Print the types found in the module.  If the optional Module parameter is
33   /// passed in, then the types are printed symbolically if possible, using the
34   /// symbol table from the module.
35   ///
36   void print(std::ostream &o, const Module *M) const;
37
38 private:
39   /// IncorporateType - Incorporate one type and all of its subtypes into the
40   /// collection of used types.
41   ///
42   void IncorporateType(const Type *Ty);
43
44   /// IncorporateValue - Incorporate all of the types used by this value.
45   ///
46   void IncorporateValue(const Value *V);
47
48 public:
49   /// run - This incorporates all types used by the specified module
50   bool runOnModule(Module &M);
51
52   /// getAnalysisUsage - We do not modify anything.
53   virtual void getAnalysisUsage(AnalysisUsage &AU) const {
54     AU.setPreservesAll();
55   }
56
57   // stub - dummy function, just ignore it
58   static void stub();
59 };
60
61 // Make sure that any clients of this file link in PostDominators.cpp
62 static IncludeFile
63 FIND_USED_TYPES_INCLUDE_FILE((void*)&FindUsedTypes::stub);
64
65 } // End llvm namespace
66
67 #endif