change BuildExtraConfig to UserConfig, add UserConfig? userConfig to ToolResolver

Author: rainyl

lib/src/builder/build_extra_config.dart

@@ -11,17 +11,17 @@ import 'dart:io';
 import 'package:code_assets/code_assets.dart';
 import 'package:hooks/hooks.dart';
 import 'package:logging/logging.dart';
-import 'package:native_toolchain_cmake/src/builder/build_extra_config.dart';
-import 'package:native_toolchain_cmake/src/utils/env_from_native_config.dart';
 
 import '../native_toolchain/msvc.dart';
 import '../utils/env_from_bat.dart';
+import '../utils/env_from_native_config.dart';
 import '../utils/run_process.dart';
 import 'build_mode.dart';
 import 'builder_args.dart';
 import 'generator.dart';
 import 'log_level.dart';
 import 'run_builder.dart';
+import 'user_config.dart';
 
 /// Specification for building an artifact with a C compiler.
 class CMakeBuilder implements Builder {
@@ -202,11 +202,7 @@ class CMakeBuilder implements Builder {
   ///
   /// Completes with an error if the build fails.
   @override
-  Future<void> run({
-    required BuildInput input,
-    required BuildOutputBuilder output,
-    Logger? logger,
-  }) async {
+  Future<void> run({required BuildInput input, required BuildOutputBuilder output, Logger? logger}) async {
     // do not override user specified output directory if they also set buildLocal to true
     if (outDir == null && buildLocal) {
       final os = input.config.code.targetOS;
@@ -220,6 +216,25 @@ class CMakeBuilder implements Builder {
     }
     await Directory.fromUri(outDir ?? input.outputDirectory).create(recursive: true);
 
+    var userConfig = UserConfig(
+      androidHome: input.userDefines["androidHome"] as String?,
+      cmakeVersion: input.userDefines["cmakeVersion"] as String?,
+      ninjaVersion: input.userDefines["ninjaVersion"] as String?,
+      ndkVersion: input.userDefines["ndkVersion"] as String?,
+      preferAndroidNinja: input.userDefines["preferAndroidNinja"] as bool? ?? false,
+      preferAndroidCmake: input.userDefines["preferAndroidCmake"] as bool? ?? false,
+    );
+
+    // optional host specific build config
+    final envFile = input.userDefines["envFile"] as String?;
+    if (envFile != null) {
+      final userEnvConfig = await getUserEnvConfig(input: input, envFile: envFile);
+      final androidHome = userEnvConfig['ANDROID_HOME'];
+      if (androidHome != null) {
+        userConfig = userConfig.copyWith(androidHome: androidHome);
+      }
+    }
+
     final task = RunCMakeBuilder(
       input: input,
       outputDir: outDir,
@@ -232,6 +247,7 @@ class CMakeBuilder implements Builder {
       targets: targets,
       appleArgs: appleArgs,
       androidArgs: androidArgs,
+      userConfig: userConfig,
       logLevel: logLevel,
     );
 
@@ -247,25 +263,6 @@ class CMakeBuilder implements Builder {
       );
     }
 
-    // tool versions
-    final userDefines = input.userDefines;
-    BuildExtraConfig.cmakeVersion = userDefines["cmakeVersion"] as String?;
-    BuildExtraConfig.ninjaVersion = userDefines["ninjaVersion"] as String?;
-    BuildExtraConfig.ndkVersion = userDefines["ndkVersion"] as String?;
-
-    // optional host specific build config
-    final hostBuildConfigFile = userDefines["hostBuildConfigFile"] as String?;
-    if (hostBuildConfigFile != null) {
-      final hostBuildConfig = await getHostBuildConfig(
-        input: input,
-        hostBuildConfigFile: hostBuildConfigFile,
-      );
-      final androidHome = hostBuildConfig['ANDROID_HOME'];
-      if (androidHome != null) {
-        BuildExtraConfig.androidHome = androidHome;
-      }
-    }
-
     await task.run(environment: envVars);
   }
 
@@ -280,10 +277,7 @@ class CMakeBuilder implements Builder {
     // TODO: patch environment variables for cmake
     // may be error if system drive is not C:
     // https://github.com/dart-lang/native/issues/2077
-    final vars = {
-      "WINDIR": r"C:\WINDOWS",
-      "SYSTEMDRIVE": "C:",
-    };
+    final vars = {"WINDIR": r"C:\WINDOWS", "SYSTEMDRIVE": "C:"};
 
     if (targetOS != OS.windows) return {};
     targetArchitecture ??= Architecture.current;

lib/src/builder/builder.dart

@@ -13,11 +13,11 @@ import 'package:change_case/change_case.dart';
 import 'package:code_assets/code_assets.dart';
 import 'package:hooks/hooks.dart';
 import 'package:logging/logging.dart';
-import 'package:native_toolchain_cmake/src/native_toolchain/ninja.dart';
 import 'package:path/path.dart';
 
 import '../native_toolchain/android_ndk.dart';
 import '../native_toolchain/cmake.dart';
+import '../native_toolchain/ninja.dart';
 import '../native_toolchain/xcode.dart';
 import '../tool/tool_instance.dart';
 import '../utils/package_config_parser.dart';
@@ -26,6 +26,7 @@ import 'build_mode.dart';
 import 'builder_args.dart';
 import 'generator.dart';
 import 'log_level.dart';
+import 'user_config.dart';
 
 class RunCMakeBuilder {
   final HookInput input;
@@ -55,6 +56,9 @@ class RunCMakeBuilder {
   // android ndk
   final AndroidBuilderArgs androidArgs;
 
+  // user defined configs
+  final UserConfig userConfig;
+
   /// log level of CMake
   final LogLevel logLevel;
 
@@ -71,24 +75,19 @@ class RunCMakeBuilder {
     this.targets,
     this.androidArgs = const AndroidBuilderArgs(),
     this.appleArgs = const AppleBuilderArgs(),
+    this.userConfig = const UserConfig(),
     this.logLevel = LogLevel.STATUS,
   }) : outDir = outputDir ?? input.outputDirectory;
 
   Future<Uri> cmakePath() async {
-    final cmakeTools = switch (codeConfig.targetOS) {
-      OS.android => await androidCmake.defaultResolver?.resolve(logger: logger),
-      _ => await cmake.defaultResolver?.resolve(logger: logger),
-    };
+    final cmakeTools = await cmake.defaultResolver?.resolve(logger: logger, userConfig: userConfig);
     final path = cmakeTools?.first.uri;
     assert(path != null);
     return Future.value(path);
   }
 
   Future<Uri> ninjaPath() async {
-    final ninjaTools = switch (codeConfig.targetOS) {
-      OS.android => await androidNinja.defaultResolver?.resolve(logger: logger),
-      _ => await ninja.defaultResolver?.resolve(logger: logger),
-    };
+    final ninjaTools = await ninja.defaultResolver?.resolve(logger: logger, userConfig: userConfig);
     final path = ninjaTools?.first.uri;
     assert(path != null);
     return Future.value(path);
@@ -99,36 +98,37 @@ class RunCMakeBuilder {
   Future<Uri> iosToolchainCmake() async => (await currentPackageRoot()).resolve('cmake/ios.toolchain.cmake');
 
   Future<Uri> androidToolchainCmake() async {
-    final tool = await androidNdk.defaultResolver?.resolve(logger: logger);
+    final tool = await androidNdk.defaultResolver?.resolve(logger: logger, userConfig: userConfig);
     final toolUri = tool?.first.uri.resolve('build/cmake/android.toolchain.cmake');
     assert(toolUri != null);
     return Future.value(toolUri);
   }
 
   Future<Uri> linuxToolchainCmake() async => switch (codeConfig.targetArchitecture) {
-        Architecture.x64 => (await currentPackageRoot()).resolve('cmake/x86_64-linux-gnu.toolchain.cmake'),
-        Architecture.arm64 => (await currentPackageRoot()).resolve('cmake/aarch64-linux-gnu.toolchain.cmake'),
-        Architecture.riscv64 =>
-          (await currentPackageRoot()).resolve('cmake/riscv64-linux-gnu.toolchain.cmake'),
-        _ => throw UnimplementedError('Unsupported architecture: ${codeConfig.targetArchitecture} for Linux'),
-      };
+    Architecture.x64 => (await currentPackageRoot()).resolve('cmake/x86_64-linux-gnu.toolchain.cmake'),
+    Architecture.arm64 => (await currentPackageRoot()).resolve('cmake/aarch64-linux-gnu.toolchain.cmake'),
+    Architecture.riscv64 => (await currentPackageRoot()).resolve('cmake/riscv64-linux-gnu.toolchain.cmake'),
+    _ => throw UnimplementedError('Unsupported architecture: ${codeConfig.targetArchitecture} for Linux'),
+  };
 
   Future<Uri> iosSdk(IOSSdk iosSdk, {required Logger? logger}) async {
     if (iosSdk == IOSSdk.iPhoneOS) {
-      return (await iPhoneOSSdk.defaultResolver!.resolve(logger: logger))
-          .where((i) => i.tool == iPhoneOSSdk)
-          .first
-          .uri;
+      return (await iPhoneOSSdk.defaultResolver!.resolve(
+        logger: logger,
+        userConfig: userConfig,
+      )).where((i) => i.tool == iPhoneOSSdk).first.uri;
     }
     assert(iosSdk == IOSSdk.iPhoneSimulator);
-    return (await iPhoneSimulatorSdk.defaultResolver!.resolve(logger: logger))
-        .where((i) => i.tool == iPhoneSimulatorSdk)
-        .first
-        .uri;
+    return (await iPhoneSimulatorSdk.defaultResolver!.resolve(
+      logger: logger,
+      userConfig: userConfig,
+    )).where((i) => i.tool == iPhoneSimulatorSdk).first.uri;
   }
 
-  Future<Uri> macosSdk({required Logger? logger}) async =>
-      (await macosxSdk.defaultResolver!.resolve(logger: logger)).where((i) => i.tool == macosxSdk).first.uri;
+  Future<Uri> macosSdk({required Logger? logger}) async => (await macosxSdk.defaultResolver!.resolve(
+    logger: logger,
+    userConfig: userConfig,
+  )).where((i) => i.tool == macosxSdk).first.uri;
 
   Uri androidSysroot(ToolInstance compiler) => compiler.uri.resolve('../sysroot/');
 
@@ -312,18 +312,10 @@ class RunCMakeBuilder {
     Architecture.x64: 'x86_64',
   };
 
-  static const macosPlatforms = {
-    Architecture.arm64: 'MAC_ARM64',
-    Architecture.x64: 'MAC',
-  };
+  static const macosPlatforms = {Architecture.arm64: 'MAC_ARM64', Architecture.x64: 'MAC'};
 
   static const iosPlatforms = {
-    Architecture.arm64: {
-      IOSSdk.iPhoneOS: 'OS64',
-      IOSSdk.iPhoneSimulator: 'SIMULATORARM64',
-    },
-    Architecture.x64: {
-      IOSSdk.iPhoneSimulator: 'SIMULATOR64',
-    },
+    Architecture.arm64: {IOSSdk.iPhoneOS: 'OS64', IOSSdk.iPhoneSimulator: 'SIMULATORARM64'},
+    Architecture.x64: {IOSSdk.iPhoneSimulator: 'SIMULATOR64'},
   };
 }

lib/src/builder/run_builder.dart

@@ -0,0 +1,36 @@
+// Copyright (c) 2025, jasaw and rainyl. All rights reserved. Use of this source code is governed by a
+// Apache-2.0 license that can be found in the LICENSE file.
+
+class UserConfig {
+  final String? androidHome;
+  final String? cmakeVersion;
+  final bool preferAndroidCmake;
+  final String? ninjaVersion;
+  final bool preferAndroidNinja;
+  final String? ndkVersion;
+
+  const UserConfig({
+    this.androidHome,
+    this.cmakeVersion,
+    this.preferAndroidCmake = false,
+    this.preferAndroidNinja = false,
+    this.ninjaVersion,
+    this.ndkVersion,
+  });
+
+  UserConfig copyWith({
+    String? androidHome,
+    String? cmakeVersion,
+    bool preferAndroidCmake = false,
+    bool preferAndroidNinja = false,
+    String? ninjaVersion,
+    String? ndkVersion,
+  }) => UserConfig(
+    androidHome: androidHome ?? this.androidHome,
+    cmakeVersion: cmakeVersion ?? this.cmakeVersion,
+    preferAndroidCmake: preferAndroidCmake,
+    preferAndroidNinja: preferAndroidNinja,
+    ninjaVersion: ninjaVersion ?? this.ninjaVersion,
+    ndkVersion: ndkVersion ?? this.ndkVersion,
+  );
+}