include/llvm/CompilerDriver/Tool.h

   1 //===--- Tool.h - The LLVM Compiler Driver ----------------------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open
   6 // Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 //  Tool abstract base class - an interface to tool descriptions.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_INCLUDE_COMPILER_DRIVER_TOOL_H
  15 #define LLVM_INCLUDE_COMPILER_DRIVER_TOOL_H
  16
  17 #include "llvm/CompilerDriver/Action.h"
  18
  19 #include "llvm/ADT/IntrusiveRefCntPtr.h"
  20 #include "llvm/ADT/StringSet.h"
  21 #include "llvm/System/Path.h"
  22
  23 #include <vector>
  24
  25 namespace llvmc {
  26
  27   class LanguageMap;
  28   typedef std::vector<llvm::sys::Path> PathVector;
  29   typedef llvm::StringSet<> InputLanguagesSet;
  30
  31   /// Tool - Represents a single tool.
  32   class Tool : public llvm::RefCountedBaseVPTR<Tool> {
  33   public:
  34
  35     virtual ~Tool() {}
  36
  37     virtual Action GenerateAction (const PathVector& inFiles,
  38                                    bool  HasChildren,
  39                                    const llvm::sys::Path& TempDir,
  40                                    const InputLanguagesSet& InLangs,
  41                                    const LanguageMap& LangMap) const = 0;
  42
  43     virtual Action GenerateAction (const llvm::sys::Path& inFile,
  44                                    bool  HasChildren,
  45                                    const llvm::sys::Path& TempDir,
  46                                    const InputLanguagesSet& InLangs,
  47                                    const LanguageMap& LangMap) const = 0;
  48
  49     virtual const char*  Name() const = 0;
  50     virtual const char** InputLanguages() const = 0;
  51     virtual const char*  OutputLanguage() const = 0;
  52
  53     virtual bool IsJoin() const = 0;
  54     virtual bool WorksOnEmpty() const = 0;
  55
  56   protected:
  57     /// OutFileName - Generate the output file name.
  58     llvm::sys::Path OutFilename(const llvm::sys::Path& In,
  59                                 const llvm::sys::Path& TempDir,
  60                                 bool StopCompilation,
  61                                 const char* OutputSuffix) const;
  62   };
  63
  64   /// JoinTool - A Tool that has an associated input file list.
  65   class JoinTool : public Tool {
  66   public:
  67     void AddToJoinList(const llvm::sys::Path& P) { JoinList_.push_back(P); }
  68     void ClearJoinList() { JoinList_.clear(); }
  69     bool JoinListEmpty() const { return JoinList_.empty(); }
  70
  71     Action GenerateAction(bool  HasChildren,
  72                           const llvm::sys::Path& TempDir,
  73                           const InputLanguagesSet& InLangs,
  74                           const LanguageMap& LangMap) const {
  75       return GenerateAction(JoinList_, HasChildren, TempDir, InLangs, LangMap);
  76     }
  77     // We shouldn't shadow base class's version of GenerateAction.
  78     using Tool::GenerateAction;
  79
  80   private:
  81     PathVector JoinList_;
  82   };
  83
  84 }
  85
  86 #endif // LLVM_INCLUDE_COMPILER_DRIVER_TOOL_H