utils/TableGen/TableGenBackend.h

   1 //===- TableGenBackend.h - Base class for TableGen Backends -----*- 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 // The TableGenBackend class is provided as a common interface for all TableGen
  11 // backends.  It provides useful services and an standardized interface.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef TABLEGENBACKEND_H
  16 #define TABLEGENBACKEND_H
  17
  18 #include <string>
  19 #include <iosfwd>
  20
  21 namespace llvm {
  22
  23 class Record;
  24 class RecordKeeper;
  25
  26 struct TableGenBackend {
  27   virtual ~TableGenBackend() {}
  28
  29   // run - All TableGen backends should implement the run method, which should
  30   // be the main entry point.
  31   virtual void run(std::ostream &OS) = 0;
  32
  33
  34 public:   // Useful helper routines...
  35   /// EmitSourceFileHeader - Output a LLVM style file header to the specified
  36   /// ostream.
  37   void EmitSourceFileHeader(const std::string &Desc, std::ostream &OS) const;
  38
  39   /// EmitSourceFileTail - Output an LLVm styelf ile tail to the specified
  40   /// ostream.
  41   void EmitSourceFileTail( std::ostream& OS ) const;
  42
  43   /// getQualifiedName - Return the name of the specified record, with a
  44   /// namespace qualifier if the record contains one.
  45   std::string getQualifiedName(Record *R) const;
  46 };
  47
  48 } // End llvm namespace
  49
  50 #endif