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 <string>
  24 #include <vector>
  25 #include <utility>
  26
  27 namespace llvmc {
  28
  29   class LanguageMap;
  30   typedef std::vector<std::pair<unsigned, std::string> > ArgsVector;
  31   typedef std::vector<llvm::sys::Path> PathVector;
  32   typedef std::vector<std::string> StrVector;
  33   typedef llvm::StringSet<> InputLanguagesSet;
  34
  35   /// Tool - Represents a single tool.
  36   class Tool : public llvm::RefCountedBaseVPTR<Tool> {
  37   public:
  38
  39     virtual ~Tool() {}
  40
  41     virtual Action GenerateAction (const PathVector& inFiles,
  42                                    bool  HasChildren,
  43                                    const llvm::sys::Path& TempDir,
  44                                    const InputLanguagesSet& InLangs,
  45                                    const LanguageMap& LangMap) const = 0;
  46
  47     virtual Action GenerateAction (const llvm::sys::Path& inFile,
  48                                    bool  HasChildren,
  49                                    const llvm::sys::Path& TempDir,
  50                                    const InputLanguagesSet& InLangs,
  51                                    const LanguageMap& LangMap) const = 0;
  52
  53     virtual const char*  Name() const = 0;
  54     virtual const char** InputLanguages() const = 0;
  55     virtual const char*  OutputLanguage() const = 0;
  56
  57     virtual bool IsJoin() const = 0;
  58     virtual bool WorksOnEmpty() const = 0;
  59
  60   protected:
  61     /// OutFileName - Generate the output file name.
  62     llvm::sys::Path OutFilename(const llvm::sys::Path& In,
  63                                 const llvm::sys::Path& TempDir,
  64                                 bool StopCompilation,
  65                                 const char* OutputSuffix) const;
  66
  67     StrVector SortArgs(ArgsVector& Args) const;
  68   };
  69
  70   /// JoinTool - A Tool that has an associated input file list.
  71   class JoinTool : public Tool {
  72   public:
  73     void AddToJoinList(const llvm::sys::Path& P) { JoinList_.push_back(P); }
  74     void ClearJoinList() { JoinList_.clear(); }
  75     bool JoinListEmpty() const { return JoinList_.empty(); }
  76
  77     Action GenerateAction(bool  HasChildren,
  78                           const llvm::sys::Path& TempDir,
  79                           const InputLanguagesSet& InLangs,
  80                           const LanguageMap& LangMap) const {
  81       return GenerateAction(JoinList_, HasChildren, TempDir, InLangs, LangMap);
  82     }
  83     // We shouldn't shadow base class's version of GenerateAction.
  84     using Tool::GenerateAction;
  85
  86   private:
  87     PathVector JoinList_;
  88   };
  89
  90 }
  91
  92 #endif // LLVM_INCLUDE_COMPILER_DRIVER_TOOL_H