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         std::list<std::string> problems;
  36
  37         Tool(Builder &, const std::string &);
  38         Tool(Builder &, const Architecture &, const std::string &);
  39 public:
  40         virtual ~Tool() { }
  41
  42         const std::string &get_tag() const { return tag; }
  43
  44         /** Returns the architecture this tool build for.  May return null if the
  45         tool is architecture-agnostic. */
  46         const Architecture *get_architecture() const { return architecture; }
  47
  48         /** Returns a target for the tool's own executable.  If the tool does not
  49         use an external program, returns null. */
  50         FileTarget *get_executable() const { return executable; }
  51
  52         /// Returns a list of suffixes that can be processed with this tool.
  53         const SuffixList &get_input_suffixes() const { return input_suffixes; }
  54
  55         /** Returns a list of suffixes that are associated with this tool, but can't
  56         be processed directly.  For example C and C++ headers. */
  57         const SuffixList &get_auxiliary_suffixes() const { return aux_suffixes; }
  58
  59         /** Indicates whether the tool can accept a suffix.  If aux is true,
  60         auxiliary suffixes are considered as well */
  61         bool accepts_suffix(const std::string &, bool aux = false) const;
  62
  63         /// Returns the systemwide search path for source files.
  64         const SearchPath &get_system_path() const { return system_path; }
  65
  66         /// Creates a source file appropriate for this tool.
  67         virtual Target *create_source(const Component &, const Msp::FS::Path &) const { return 0; }
  68
  69         /** Creates a package-less source file appropriate for this tool.  This is
  70         called during dependency discovery when no package has created a target for
  71         the file. */
  72         virtual Target *create_source(const Msp::FS::Path &) const { return 0; }
  73
  74         /// Convenience function to create a target from a single source.
  75         Target *create_target(Target &, const std::string & = std::string());
  76
  77         /** Creates a target from sources.  The exact types of accepted sources
  78         depends on the tool.  The optional second argument can be used to select an
  79         alternative target type for tools that can create multiple kinds of targets. */
  80         virtual Target *create_target(const std::list<Target *> &, const std::string & = std::string()) = 0;
  81
  82         /** Creates an install target for a target created by this tool.  Can return
  83         null if the tool does not want to handle installing in a special way. */
  84         virtual Target *create_install(Target &) const { return 0; }
  85
  86         virtual std::string create_build_signature(const BuildInfo &) const { return std::string(); }
  87
  88         void prepare();
  89
  90 protected:
  91         virtual void do_prepare() { }
  92
  93         /** Locates an executable for the tool from the VFS.  If it isn't found, a
  94         problem is reported.  If cross is true and the architecture is not native,
  95         a cross prefix is added to the command. */
  96         void set_executable(const std::string &command, bool cross = false);
  97
  98 public:
  99         const std::list<std::string> &get_problems() const { return problems; }
 100
 101         /** Invokes the tool to build a target.  This should not be called directly;
 102         use Target::build() instead. */
 103         virtual Task *run(const Target &) const = 0;
 104 };
 105
 106 /**
 107 Intermediate base class for tool facets.  For example, a linker may need to
 108 use different commands depending on whether C++ source files are present or
 109 not, but their presence can't be directly determined from the object files.
 110 */
 111 class SubTool: public Tool
 112 {
 113 protected:
 114         Tool &parent;
 115
 116         SubTool(Tool &);
 117 };
 118
 119 #endif