source/tool.h

   1 #ifndef TOOL_H_
   2 #define TOOL_H_
   3
   4 #include <list>
   5 #include <string>
   6 #include <msp/fs/path.h>
   7
   8 class Architecture;
   9 class Builder;
  10 class BuildInfo;
  11 class Component;
  12 class FileTarget;
  13 class Target;
  14 class Task;
  15
  16 /**
  17 Base class for tools.  Tools are used to turn targets into other targets.
  18 Examples include compilers and linkers.
  19 */
  20 class Tool
  21 {
  22 public:
  23         typedef std::list<Msp::FS::Path> SearchPath;
  24         typedef std::list<std::string> SuffixList;
  25
  26 protected:
  27         Builder &builder;
  28         const Architecture *architecture;
  29         std::string tag;
  30         FileTarget *executable;
  31         SuffixList input_suffixes;
  32         SuffixList aux_suffixes;
  33         SearchPath system_path;
  34         bool prepared;
  35
  36         Tool(Builder &, const std::string &);
  37         Tool(Builder &, const Architecture &, const std::string &);
  38 public:
  39         virtual ~Tool() { }
  40
  41         const std::string &get_tag() const { return tag; }
  42
  43         /** Returns a target for the tool's own executable.  If the tool does not
  44         use an external program, returns null. */
  45         FileTarget *get_executable() const { return executable; }
  46
  47         /// Returns a list of suffixes that can be processed with this tool.
  48         const SuffixList &get_input_suffixes() const { return input_suffixes; }
  49
  50         /** Returns a list of suffixes that are associated with this tool, but can't
  51         be processed directly.  For example C and C++ headers. */
  52         const SuffixList &get_auxiliary_suffixes() const { return aux_suffixes; }
  53
  54         /** Indicates whether the tool can accept a suffix.  If aux is true,
  55         auxiliary suffixes are considered as well */
  56         bool accepts_suffix(const std::string &, bool aux = false) const;
  57
  58         /// Returns the systemwide search path for source files.
  59         const SearchPath &get_system_path() const { return system_path; }
  60
  61         /// Creates a source file appropriate for this tool.
  62         virtual Target *create_source(const Component &, const Msp::FS::Path &) const { return 0; }
  63
  64         /** Creates a package-less source file appropriate for this tool.  This is
  65         called during dependency discovery when no package has created a target for
  66         the file. */
  67         virtual Target *create_source(const Msp::FS::Path &) const { return 0; }
  68
  69         /// Convenience function to create a target from a single source.
  70         Target *create_target(Target &, const std::string & = std::string());
  71
  72         /** Creates a target from sources.  The exact types of accepted sources
  73         depends on the tool.  The optional second argument can be used to select an
  74         alternative target type for tools that can create multiple kinds of targets. */
  75         virtual Target *create_target(const std::list<Target *> &, const std::string & = std::string()) = 0;
  76
  77         /** Creates an install target for a target created by this tool.  Can return
  78         null if the tool does not want to handle installing in a special way. */
  79         virtual Target *create_install(Target &) const { return 0; }
  80
  81         virtual std::string create_build_signature(const BuildInfo &) const { return std::string(); }
  82
  83         void prepare();
  84
  85 protected:
  86         virtual void do_prepare() { }
  87
  88 public:
  89         /** Invokes the tool to build a target.  This should not be called directly;
  90         use Target::build() instead. */
  91         virtual Task *run(const Target &) const = 0;
  92 };
  93
  94 /**
  95 Intermediate base class for tool facets.  For example, a linker may need to
  96 use different commands depending on whether C++ source files are present or
  97 not, but their presence can't be directly determined from the object files.
  98 */
  99 class SubTool: public Tool
 100 {
 101 protected:
 102         Tool &parent;
 103
 104         SubTool(Tool &);
 105 };
 106
 107 #endif