TableGenBackend.h revision 2d24e2a396a1d211baaeedf32148a3b657240170 
1//===- llvm/TableGen/TableGenBackend.h - Backend base class -----*- 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 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 LLVM_TABLEGEN_TABLEGENBACKEND_H
16#define LLVM_TABLEGEN_TABLEGENBACKEND_H
17
18#include "llvm/Support/raw_ostream.h"
19#include <string>
20
21namespace llvm {
22
23class Record;
24class RecordKeeper;
25
26struct TableGenBackend {
27  virtual void anchor();
28  virtual ~TableGenBackend() {}
29
30  // run - All TableGen backends should implement the run method, which should
31  // be the main entry point.
32  virtual void run(raw_ostream &OS) = 0;
33
34
35public:   // Useful helper routines...
36  /// EmitSourceFileHeader - Output a LLVM style file header to the specified
37  /// ostream.
38  void EmitSourceFileHeader(const std::string &Desc, raw_ostream &OS) const;
39
40};
41
42} // End llvm namespace
43
44#endif
45