module Autoproj
    module Ops
        # Operations related to building packages
        #
        # Note that these do not perform import or osdeps installation. It is
        # assumed that the packages that should be built have been cleanly
        # imported
        class Build
            # The manifest on which we operate
            # @return [Manifest]
            attr_reader :manifest
            # Whether we should update the OS dependencies before building. It
            # controls the behaviour of {rebuild_all} as well as
            # {build_packages}
            attr_predicate :update_os_dependencies?, true

            def initialize(manifest, update_os_dependencies = true)
                @manifest = manifest
                self.update_os_dependencies = update_os_dependencies
            end

            # Triggers a rebuild of all packages
            #
            # It rebuilds (i.e. does a clean + build) of all packages declared
            # in the manifest's layout. It also performs a reinstall of all
            # non-OS-specific managers that support it (e.g. RubyGems) if
            # {update_os_dependencies?} is set to true (the default)
            def rebuild_all
                if update_os_dependencies?
                    # We also reinstall the osdeps that provide the
                    # functionality
                    managers = Autoproj.osdeps.setup_package_handlers
                    managers.each do |mng|
                        if mng.respond_to?(:reinstall)
                            mng.reinstall
                        end
                    end
                end

                packages = manifest.all_layout_packages
                rebuild_packages(packages, packages)
            end

            # Triggers a rebuild of a subset of all packages
            #
            # @param [Array<String>] selected_packages the list of package names
            #   that should be rebuilt
            # @param [Array<String>] all_enabled_packages the list of package names
            #   for which a build should be triggered (usually selected_packages
            #   plus dependencies)
            # @return [void]
            def rebuild_packages(selected_packages, all_enabled_packages)
                selected_packages.each do |pkg_name|
                    Autobuild::Package[pkg_name].prepare_for_rebuild
                end
                build_packages(all_enabled_packages)
            end

            # Triggers a force-build of all packages
            #
            # Unlike a rebuild, a force-build forces the package to go through
            # all build steps (even if they are not needed) but does not clean
            # the current build byproducts beforehand
            #
            def force_build_all
                packages = manifest.all_layout_packages
                rebuild_packages(packages, packages)
            end

            # Triggers a force-build of a subset of all packages
            #
            # Unlike a rebuild, a force-build forces the package to go through
            # all build steps (even if they are not needed) but does not clean
            # the current build byproducts beforehand
            #
            # This method force-builds of all packages declared
            # in the manifest's layout
            #
            # @param [Array<String>] selected_packages the list of package names
            #   that should be rebuilt
            # @param [Array<String>] all_enabled_packages the list of package names
            #   for which a build should be triggered (usually selected_packages
            #   plus dependencies)
            # @return [void]
            def force_build_packages(selected_packages, all_enabled_packages)
                selected_packages.each do |pkg_name|
                    Autobuild::Package[pkg_name].prepare_for_forced_build
                end
                build_packages(all_enabled_packages)
            end

            # Builds the listed packages
            #
            # Only build steps that are actually needed will be performed. See
            # {force_build_packages} and {rebuild_packages} to override this
            #
            # @param [Array<String>] all_enabled_packages the list of package
            #   names of the packages that should be rebuilt
            # @return [void]
            def build_packages(all_enabled_packages)
                Autobuild.do_rebuild = false
                Autobuild.do_forced_build = false
                Autobuild.apply(all_enabled_packages, "autoproj-build", ['build'])
            end
        end
    end
end