1//===--- Tool.h - Compilation Tools -----------------------------*- 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#ifndef CLANG_DRIVER_TOOL_H_
11#define CLANG_DRIVER_TOOL_H_
12
13#include "clang/Basic/LLVM.h"
14
15namespace clang {
16namespace driver {
17  class ArgList;
18  class Compilation;
19  class InputInfo;
20  class Job;
21  class JobAction;
22  class ToolChain;
23
24  typedef SmallVector<InputInfo, 4> InputInfoList;
25
26/// Tool - Information on a specific compilation tool.
27class Tool {
28  /// The tool name (for debugging).
29  const char *Name;
30
31  /// The human readable name for the tool, for use in diagnostics.
32  const char *ShortName;
33
34  /// The tool chain this tool is a part of.
35  const ToolChain &TheToolChain;
36
37public:
38  Tool(const char *Name, const char *ShortName,
39       const ToolChain &TC);
40
41public:
42  virtual ~Tool();
43
44  const char *getName() const { return Name; }
45
46  const char *getShortName() const { return ShortName; }
47
48  const ToolChain &getToolChain() const { return TheToolChain; }
49
50  virtual bool hasIntegratedAssembler() const { return false; }
51  virtual bool hasIntegratedCPP() const = 0;
52  virtual bool isLinkJob() const { return false; }
53  virtual bool isDsymutilJob() const { return false; }
54
55  /// \brief Does this tool have "good" standardized diagnostics, or should the
56  /// driver add an additional "command failed" diagnostic on failures.
57  virtual bool hasGoodDiagnostics() const { return false; }
58
59  /// ConstructJob - Construct jobs to perform the action \p JA,
60  /// writing to \p Output and with \p Inputs.
61  ///
62  /// \param TCArgs - The argument list for this toolchain, with any
63  /// tool chain specific translations applied.
64  /// \param LinkingOutput - If this output will eventually feed the
65  /// linker, then this is the final output name of the linked image.
66  virtual void ConstructJob(Compilation &C, const JobAction &JA,
67                            const InputInfo &Output,
68                            const InputInfoList &Inputs,
69                            const ArgList &TCArgs,
70                            const char *LinkingOutput) const = 0;
71};
72
73} // end namespace driver
74} // end namespace clang
75
76#endif
77