Remove some useless member functions

[builder.git] / source / tool.h

diff --git a/source/tool.h b/source/tool.h
index 4bbbcf5595a8f3603e85901fb5bdb88503cba6f2..294805359e43dc7f2096cfc9650ca7afb5bf1379 100644 (file)
--- a/source/tool.h
+++ b/source/tool.h
@@ -7,6 +7,7 @@
 
 class Architecture;
 class Builder;
+class BuildInfo;
 class Component;
 class FileTarget;
 class Target;
@@ -37,17 +38,50 @@ public:
        virtual ~Tool() { }
 
        const std::string &get_tag() const { return tag; }
+
+       /** Returns a target for the tool's own executable.  If the tool does not
+       use an external program, returns null. */
        // XXX The executable target should be retrieved when first needed
        FileTarget *get_executable() const { return executable; }
+
+       /// Returns a list of suffixes that can be processed with this tool.
        const SuffixList &get_input_suffixes() const { return input_suffixes; }
+
+       /** Returns a list of suffixes that are associated with this tool, but can't
+       be processed directly.  For example C and C++ headers. */
        const SuffixList &get_auxiliary_suffixes() const { return aux_suffixes; }
-       bool accepts_suffix(const std::string &, bool = false) const;
+
+       /** Indicates whether the tool can accept a suffix.  If aux is true,
+       auxiliary suffixes are considered as well */
+       bool accepts_suffix(const std::string &, bool aux = false) const;
+
+       /// Returns the systemwide search path for source files.
        const SearchPath &get_system_path() const { return system_path; }
 
+       /// Creates a source file appropriate for this tool.
        virtual Target *create_source(const Component &, const Msp::FS::Path &) const { return 0; }
+
+       /** Creates a package-less source file appropriate for this tool.  This is
+       called during dependency discovery when no package has created a target for
+       the file. */
        virtual Target *create_source(const Msp::FS::Path &) const { return 0; }
+
+       /// Convenience function to create a target from a single source.
        Target *create_target(Target &, const std::string & = std::string()) const;
+
+       /** Creates a target from sources.  The exact types of accepted sources
+       depends on the tool.  The optional second argument can be used to select an
+       alternative target type for tools that can create multiple kinds of targets. */ 
        virtual Target *create_target(const std::list<Target *> &, const std::string & = std::string()) const = 0;
+
+       /** Creates an install target for a target created by this tool.  Can return
+       null if the tool does not want to handle installing in a special way. */
+       virtual Target *create_install(Target &) const { return 0; }
+
+       virtual std::string create_build_signature(const BuildInfo &) const { return std::string(); }
+
+       /** Invokes the tool to build a target.  This should not be called directly;
+       use Target::build() instead. */
        virtual Task *run(const Target &) const = 0;
 };