pkgs/c_compiler/lib/src/cbuilder/cbuilder.dart

// Copyright (c) 2023, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'dart:io';

import 'package:logging/logging.dart';
import 'package:meta/meta.dart';
import 'package:native_assets_cli/native_assets_cli.dart';

import 'run_cbuilder.dart';

abstract class Builder {
  Future<void> run({
    required BuildConfig buildConfig,
    required BuildOutput buildOutput,
    required Logger? logger,
  });
}

/// Specification for building an artifact with a C compiler.
class CBuilder implements Builder {
  /// What kind of artifact to build.
  final _CBuilderType _type;

  /// Name of the library or executable to build.
  ///
  /// The filename will be decided by [BuildConfig.target] and
  /// [OS.libraryFileName] or [OS.executableFileName].
  ///
  /// File will be placed in [BuildConfig.outDir].
  final String name;

  /// Asset identifier.
  ///
  /// Used to output the [BuildOutput.assets].
  ///
  /// If omitted, no asset will be added to the build output.
  final String? assetName;

  /// Sources to build the library or executable.
  ///
  /// Resolved against [BuildConfig.packageRoot].
  ///
  /// Used to output the [BuildOutput.dependencies].
  final List<String> sources;

  /// The dart files involved in building this artifact.
  ///
  /// Resolved against [BuildConfig.packageRoot].
  ///
  /// Used to output the [BuildOutput.dependencies].
  final List<String> dartBuildFiles;

  /// TODO(https://github.com/dart-lang/native/issues/54): Move to [BuildConfig]
  /// or hide in public API.
  @visibleForTesting
  final Uri? installName;

  CBuilder.library({
    required this.name,
    required this.assetName,
    this.sources = const [],
    this.dartBuildFiles = const ['build.dart'],
    @visibleForTesting this.installName,
  }) : _type = _CBuilderType.library;

  CBuilder.executable({
    required this.name,
    this.sources = const [],
    this.dartBuildFiles = const ['build.dart'],
  })  : _type = _CBuilderType.executable,
        assetName = null,
        installName = null;

  /// Runs the C Compiler with on this C build spec.
  ///
  /// Completes with an error if the build fails.
  @override
  Future<void> run({
    required BuildConfig buildConfig,
    required BuildOutput buildOutput,
    required Logger? logger,
  }) async {
    final outDir = buildConfig.outDir;
    final packageRoot = buildConfig.packageRoot;
    await Directory.fromUri(outDir).create(recursive: true);
    final linkMode = buildConfig.linkModePreference.preferredLinkMode;
    final libUri =
        outDir.resolve(buildConfig.target.os.libraryFileName(name, linkMode));
    final exeUri =
        outDir.resolve(buildConfig.target.os.executableFileName(name));
    final sources = [
      for (final source in this.sources)
        packageRoot.resolveUri(Uri.file(source)),
    ];
    final dartBuildFiles = [
      for (final source in this.dartBuildFiles) packageRoot.resolve(source),
    ];

    final task = RunCBuilder(
      buildConfig: buildConfig,
      logger: logger,
      sources: sources,
      dynamicLibrary:
          _type == _CBuilderType.library && linkMode == LinkMode.dynamic
              ? libUri
              : null,
      staticLibrary:
          _type == _CBuilderType.library && linkMode == LinkMode.static
              ? libUri
              : null,
      executable: _type == _CBuilderType.executable ? exeUri : null,
      installName: installName,
    );
    await task.run();

    if (assetName != null) {
      buildOutput.assets.add(Asset(
        name: assetName!,
        linkMode: linkMode,
        target: buildConfig.target,
        path: AssetAbsolutePath(libUri),
      ));
    }
    buildOutput.dependencies.dependencies.addAll([
      ...sources,
      ...dartBuildFiles,
    ]);
  }
}

enum _CBuilderType {
  executable,
  library,
}