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
  27 namespace llvm {
  28
  29   class GCMetadataPrinter;
  30   class raw_ostream;
  31
  32   /// GCMetadataPrinterRegistry - The GC assembly printer registry uses all the
  33   /// defaults from Registry.
  34   typedef Registry<GCMetadataPrinter> GCMetadataPrinterRegistry;
  35
  36   /// GCMetadataPrinter - Emits GC metadata as assembly code.
  37   ///
  38   class GCMetadataPrinter {
  39   public:
  40     typedef GCStrategy::list_type list_type;
  41     typedef GCStrategy::iterator iterator;
  42
  43   private:
  44     GCStrategy *S;
  45
  46     friend class AsmPrinter;
  47
  48   protected:
  49     // May only be subclassed.
  50     GCMetadataPrinter();
  51
  52     // Do not implement.
  53     GCMetadataPrinter(const GCMetadataPrinter &);
  54     GCMetadataPrinter &operator=(const GCMetadataPrinter &);
  55
  56   public:
  57     GCStrategy &getStrategy() { return *S; }
  58     const Module &getModule() const { return S->getModule(); }
  59
  60     /// begin/end - Iterate over the collected function metadata.
  61     iterator begin() { return S->begin(); }
  62     iterator end()   { return S->end();   }
  63
  64     /// beginAssembly/finishAssembly - Emit module metadata as assembly code.
  65     virtual void beginAssembly(raw_ostream &OS, AsmPrinter &AP,
  66                                const MCAsmInfo &TAI);
  67
  68     virtual void finishAssembly(raw_ostream &OS, AsmPrinter &AP,
  69                                 const MCAsmInfo &TAI);
  70
  71     virtual ~GCMetadataPrinter();
  72   };
  73
  74 }
  75
  76 #endif