module Autoproj
    # A set of packages that can be referred to by name
    class Metapackage
        # The metapackage name
        attr_reader :name
        # The packages listed in this metapackage
        attr_reader :packages_by_name
        # The normal dependency handling behaviour is to generate an error if a
        # metapackage is selected for the build but some of its dependencies
        # cannot be built. This modifies the behaviour to simply ignore the
        # problematic packages.
        attr_writer :weak_dependencies

        # @return [Boolean] whether the dependencies from this metapackage are
        #   weak or not
        # @see #weak_dependencies
        def weak_dependencies?
            !!@weak_dependencies
        end

        def initialize(name)
            @name = name
            @packages_by_name = Hash.new
            @weak_dependencies = false
        end

        def size
            packages_by_name.size
        end

        # Deprecated, use #each_package instead
        def packages
            Autoproj.warn_deprecated "use #each_package instead"
            each_package.to_a
        end

        # Adds a package to this metapackage
        #
        # @param [Autobuild::Package] pkg
        def add(pkg)
            packages_by_name[pkg.name] = pkg
        end

        # Remove a package from this metapackage
        def remove(pkg)
            pkg = pkg.name if pkg.respond_to?(:name)
            packages_by_name.delete(pkg)
        end

        # Lists the packages contained in this metapackage
        #
        # @yieldparam [Autobuild::Package] pkg
        def each_package(&block)
            packages_by_name.each_value(&block)
        end

        # Tests if the given package is included in this metapackage
        #
        # @param [String,#name] pkg the package or package name
        def include?(pkg)
            pkg = pkg.name unless pkg.respond_to?(:to_str)
            packages_by_name.has_key?(pkg)
        end

        def clear
            packages_by_name.clear
        end

        def delete_if
            packages_by_name.delete_if { |name, package| yield(package) }
        end
    end
end