include/llvm/CodeGen/GCMetadataPrinter.h

   1 //===-- llvm/CodeGen/GCMetadataPrinter.h - Prints asm GC tables -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // The abstract base class GCMetadataPrinter supports writing GC metadata tables
  11 // as assembly code. This is a separate class from GCStrategy in order to allow
  12 // users of the LLVM JIT to avoid linking with the AsmWriter.
  13 //
  14 // Subclasses of GCMetadataPrinter must be registered using the
  15 // GCMetadataPrinterRegistry. This is separate from the GCStrategy itself
  16 // because these subclasses are logically plugins for the AsmWriter.
  17 //
  18 //===----------------------------------------------------------------------===//
  19
  20 #ifndef LLVM_CODEGEN_GCMETADATAPRINTER_H
  21 #define LLVM_CODEGEN_GCMETADATAPRINTER_H
  22
  23 #include "llvm/CodeGen/GCMetadata.h"
  24 #include "llvm/CodeGen/GCStrategy.h"
  25 #include "llvm/Support/Registry.h"
  26 #include <iosfwd>
  27 #include <string>
  28
  29 namespace llvm {
  30
  31   class GCMetadataPrinter;
  32   class raw_ostream;
  33
  34   /// GCMetadataPrinterRegistry - The GC assembly printer registry uses all the
  35   /// defaults from Registry.
  36   typedef Registry<GCMetadataPrinter> GCMetadataPrinterRegistry;
  37
  38   /// GCMetadataPrinter - Emits GC metadata as assembly code.
  39   ///
  40   class GCMetadataPrinter {
  41   public:
  42     typedef GCStrategy::list_type list_type;
  43     typedef GCStrategy::iterator iterator;
  44
  45   private:
  46     GCStrategy *S;
  47
  48     friend class AsmPrinter;
  49
  50   protected:
  51     // May only be subclassed.
  52     GCMetadataPrinter();
  53
  54     // Do not implement.
  55     GCMetadataPrinter(const GCMetadataPrinter &);
  56     GCMetadataPrinter &operator=(const GCMetadataPrinter &);
  57
  58   public:
  59     GCStrategy &getStrategy() { return *S; }
  60     const Module &getModule() const { return S->getModule(); }
  61
  62     /// begin/end - Iterate over the collected function metadata.
  63     iterator begin() { return S->begin(); }
  64     iterator end()   { return S->end();   }
  65
  66     /// beginAssembly/finishAssembly - Emit module metadata as assembly code.
  67     virtual void beginAssembly(raw_ostream &OS, AsmPrinter &AP,
  68                                const TargetAsmInfo &TAI);
  69
  70     virtual void finishAssembly(raw_ostream &OS, AsmPrinter &AP,
  71                                 const TargetAsmInfo &TAI);
  72
  73     virtual ~GCMetadataPrinter();
  74   };
  75
  76 }
  77
  78 #endif