XRepoTasks.cs

using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Linq;
using System.Threading.Tasks;
using Nuke.Cola.Tooling;
using Nuke.Cola.Vcpkg;
using Nuke.Common;
using Nuke.Common.IO;
using Nuke.Common.Tooling;
using Nuke.Common.Utilities;
using Serilog;
 
namespace Nuke.Cola.Tooling;
 
/// <summary>
/// XRepo is a meta package manager for C/C++ built on top of XMake
/// </summary>
public static class XRepoTasks
{
    /// <summary>
    /// Get XRepo or an error if downloading it has failed.
    /// </summary>
    public static ValueOrError<Tool> EnsureXRepo => XMakeTasks.EnsureXMake
        .Transform(t => t.With("lua private.xrepo"));
    
    /// <summary>
    /// Get XRepo. It throws an exception if downloading it has failed.
    /// </summary>
    public static Tool XRepo => EnsureXRepo.Get();
 
    private static void EnsureSupportedPackageManagers(ref Tool xrepo, string package)
    {
        if (package.Contains("vcpkg::"))
        {
            VcpkgTasks.EnsureVcpkg.Get($"VCPKG is needed for package(s) {package} but it couldn't be installed");
            if (VcpkgTasks.VcpkgPathInProject.DirectoryExists())
            {
                xrepo = xrepo.WithEnvVar("VCPKG_ROOT", VcpkgTasks.VcpkgPathInProject);
            }
        }
        else if (package.Contains("conan::"))
            ToolCola.Use("conan", () => PythonTasks.Pip("install conan"))
                .Get($"Conan is needed for package(s) {package} but it couldn't be installed");
    }
 
    /// <summary>
    /// Install a package using xrepo. Using this function also ensures setting up conan or VCPKG if
    /// they're referenced in the package specification
    /// </summary>
    /// <param name="package">
    /// package specification including third-party manager identifier (e.g.: conan::),
    /// version syntax (depending on the selected manager), and other extensions (e.g. vcpkg::boost[core])
    /// <br />
    /// See https://xmake.io/#/package/remote_package?id=install-third-party-packages
    /// See https://xrepo.xmake.io/#/?id=installation-package
    /// </param>
    /// <param name="options">
    /// Extra options configuring the package. It should be comma separated key=value pairs.
    /// </param>
    /// <param name="extraArgs">
    /// Extra arguments provided through command line before package specification.
    /// </param>
    /// <returns></returns>
    public static Tool Install(string package, string options = "", string extraArgs = "")
    {
        var xrepo = XRepo.With($"install -v -y {options.PrependNonEmpty("-f "):nq} {extraArgs:nq} {package}");
        EnsureSupportedPackageManagers(ref xrepo, package);
        return xrepo;
    }
 
    /// <summary>
    /// Fetch a package info installed via xrepo. Using this function also ensures setting up conan
    /// or VCPKG if they're referenced in the package specification
    /// </summary>
    /// <param name="package">
    /// package specification including third-party manager identifier (e.g.: conan::),
    /// version syntax (depending on the selected manager), and other extensions (e.g. vcpkg::boost[core])
    /// <br />
    /// See https://xmake.io/#/package/remote_package?id=install-third-party-packages
    /// See https://xrepo.xmake.io/#/?id=installation-package
    /// </param>
    /// <param name="options">
    /// Extra options configuring the package. It should be comma separated key=value pairs. It is
    /// important to provide the same options here as provided in install to get accurate information
    /// from the package (like dependencies, linking methods, etc)
    /// </param>
    /// <param name="extraArgs">
    /// Extra arguments provided through command line before package specification.
    /// </param>
    /// <returns></returns>
    public static Tool Info(string package, string options = "", string extraArgs = "")
    {
        var xrepo = XRepo.With($"info -y {options.PrependNonEmpty("-f "):nq} {extraArgs:nq} {package}");
        EnsureSupportedPackageManagers(ref xrepo, package);
        return xrepo;
    }
 
    /// <summary>
    /// Parse the Tool output of XRepoTasks.Info into structured data.
    /// </summary>
    public static XRepoItem ParseXRepoInfo(this IEnumerable<Output> output)
        => XRepoItem.Parse(output.RemoveAnsiEscape());
}