wyvrnpm 2.10.2 → 2.12.2

package/src/toolchain/index.js

@@ -1,212 +1,212 @@
-'use strict';
-
-const fs   = require('fs');
-const path = require('path');
-
-const { generateDepsCmake }     = require('./deps');
-const { generateCMakePresets } = require('./presets');
-
-/**
- * Absolute path to the bundled `cmake/` directory shipped inside the
- * wyvrnpm npm package. Returned in CMake-friendly form (forward slashes).
- *
- * @returns {string}
- */
-function getBundledCmakeDir() {
-  const dir = path.resolve(__dirname, '..', '..', 'cmake');
-  return dir.replace(/\\/g, '/');
-}
-
-// Arch bit-width mapping. Kept exhaustive against `ARCH_MAP` in profile.js
-// so any arch a profile can hold has a deterministic "32"/"64" suffix.
-// Unknown arch strings fall back to an empty suffix — the consumer's
-// CMakeLists should then use another discriminator (e.g. profile hash).
-const ARCH_BIT_SUFFIX = {
-  x86_64:  '64',
-  x86:     '32',
-  armv8:   '64',
-  armv7:   '32',
-  ppc64le: '64',
-  s390x:   '64',
-  mips:    '32',
-  mipsel:  '32',
-};
-
-/**
- * Map a profile `arch` value to the canonical "64" / "32" suffix that
- * `WYVRN_ARCH_SUFFIX` exposes to consumer CMakeLists. Empty string for
- * unknown arches — callers can pattern-match on that to fall back.
- *
- * @param {string|null|undefined} arch
- * @returns {string}
- */
-function archToBitSuffix(arch) {
-  if (!arch) return '';
-  return ARCH_BIT_SUFFIX[arch] ?? '';
-}
-
-// Visual Studio generator `-A <platform>` mapping. VS defaults to x64
-// when `-A` is unspecified — which silently wins against a 32-bit profile
-// and causes consumer-side `find_package()` to reject 32-bit artefacts
-// with "The version found is not compatible" (a CMake pointer-size check,
-// not a version-number check). Auto-emitting `-A` keeps VS + x86 honest.
-const ARCH_VS_PLATFORM = {
-  x86_64: 'x64',
-  x86:    'Win32',
-  armv8:  'ARM64',
-  armv7:  'ARM',
-};
-
-/**
- * Map a profile arch to the Visual Studio generator's `-A <platform>` value.
- * Returns null for arches that don't map to a known VS platform — callers
- * should skip `-A` in that case and let the user pass one explicitly.
- *
- * @param {string|null|undefined} arch
- * @returns {string|null}
- */
-function archToVsPlatform(arch) {
-  if (!arch) return null;
-  return ARCH_VS_PLATFORM[arch] ?? null;
-}
-
-/**
- * True when the generator name identifies a Visual Studio generator (e.g.
- * "Visual Studio 17 2022"). VS generators require `-A <platform>` /
- * `architecture` in the preset; everyone else (Ninja, Make, Xcode, …)
- * ignores it.
- *
- * @param {string|null|undefined} name
- * @returns {boolean}
- */
-function isVisualStudioGenerator(name) {
-  if (!name) return false;
-  return /^Visual Studio \d/.test(name);
-}
-
-/**
- * Substitute `{{KEY}}` placeholders in a template string.
- *
- * @param {string} template
- * @param {Record<string, string>} values
- * @returns {string}
- */
-function renderTemplate(template, values) {
-  return template.replace(/\{\{(\w+)\}\}/g, (match, key) => {
-    if (Object.prototype.hasOwnProperty.call(values, key)) {
-      return values[key];
-    }
-    throw new Error(`Toolchain template has no value for placeholder {{${key}}}`);
-  });
-}
-
-/**
- * Produce the toolchain template's placeholder substitutions.
- *
- * @param {object} args
- * @param {import('../profile').WyvrnProfile} args.profile
- * @param {string} args.profileName
- * @param {string} args.profileHash
- * @param {string[]} args.packageNames
- * @returns {Record<string, string>}
- */
-function buildPlaceholders({ profile, profileName, profileHash, packageNames }) {
-  const prefixPathEntries = packageNames
-    .map((name) => `    "\${CMAKE_CURRENT_LIST_DIR}/${name}"`)
-    .join('\n');
-
-  return {
-    GENERATED_AT:             new Date().toISOString(),
-    PROFILE_NAME:             profileName,
-    PROFILE_HASH:             profileHash,
-    PROFILE_OS:               profile.os ?? '',
-    PROFILE_ARCH:             profile.arch ?? '',
-    PROFILE_ARCH_SUFFIX:      archToBitSuffix(profile.arch),
-    PROFILE_COMPILER:         profile.compiler ?? '',
-    PROFILE_COMPILER_VERSION: profile['compiler.version'] ?? '',
-    PROFILE_CPPSTD:           profile['compiler.cppstd'] ?? '20',
-    PROFILE_RUNTIME:          profile['compiler.runtime'] ?? '',
-    WYVRNPM_CMAKE_DIR:        getBundledCmakeDir(),
-    PREFIX_PATH_ENTRIES:      prefixPathEntries || '    # (no dependencies)',
-  };
-}
-
-/**
- * Generate the three toolchain artefacts under `destDir`:
- *   - wyvrn_toolchain.cmake
- *   - wyvrn_deps.cmake
- *   - wyvrn_profile.json
- *
- * ───────────────────────────────────────────────────────────────────────────
- * CONTRACT (PLAN-CMAKE-TOOLCHAIN Phase F ↔ PLAN-BUILD-MISSING Phase 3)
- * ───────────────────────────────────────────────────────────────────────────
- * This function is the **single source of truth** for translating a build
- * profile into a CMake configuration. Two callers exist:
- *
- *   1. `install`              — writes the toolchain into a consumer project's
- *                               `wyvrn_internal/`, so `cmake --preset` picks it
- *                               up at configure time.
- *   2. `buildFromSource`      — (not yet implemented; PLAN-BUILD-MISSING §3)
- *                               writes the toolchain into a scratch build dir
- *                               when we source-build a package via
- *                               `--build=missing`. The package is compiled
- *                               with THIS function's output, guaranteeing the
- *                               resulting binary's profile → flag mapping is
- *                               bit-for-bit identical to what a consumer sees.
- *
- * Do NOT replicate this mapping elsewhere. If PLAN-BUILD-MISSING §3 finds it
- * needs additional behaviour (e.g. extra CMake cache variables), extend this
- * function — do not branch.
- *
- * Callers choose `destDir` and `packageNames`:
- *   - `destDir`      — any directory; in source-build, points at the scratch
- *                      `wyvrn_internal/` co-located with the cloned source.
- *   - `packageNames` — in `install`, the consumer's resolved deps; in
- *                      source-build, the *package's own* resolved deps.
- *
- * Profile arguments (`profile`, `profileName`, `profileHash`) are always the
- * active consumer profile — source-build still uses the consumer's profile,
- * not the package's. That is the whole point of the source-build path.
- * ───────────────────────────────────────────────────────────────────────────
- *
- * @param {object} args
- * @param {string} args.destDir         Where to write the three files.
- * @param {import('../profile').WyvrnProfile} args.profile
- * @param {string} args.profileName
- * @param {string} args.profileHash
- * @param {string[]} args.packageNames  Resolved dep names in topological order.
- * @returns {{ toolchain: string, deps: string, profile: string }}
- *          Absolute paths of the three files written.
- */
-function generateToolchain({ destDir, profile, profileName, profileHash, packageNames }) {
-  fs.mkdirSync(destDir, { recursive: true });
-
-  const templatePath = path.join(__dirname, 'template.cmake');
-  const template     = fs.readFileSync(templatePath, 'utf8');
-  const placeholders = buildPlaceholders({ profile, profileName, profileHash, packageNames });
-  const toolchainContent = renderTemplate(template, placeholders);
-  const depsContent      = generateDepsCmake({ packageNames, profileHash });
-  const profileContent   = JSON.stringify({ name: profileName, hash: profileHash, ...profile }, null, 2) + '\n';
-
-  const toolchainPath = path.join(destDir, 'wyvrn_toolchain.cmake');
-  const depsPath      = path.join(destDir, 'wyvrn_deps.cmake');
-  const profilePath   = path.join(destDir, 'wyvrn_profile.json');
-
-  fs.writeFileSync(toolchainPath, toolchainContent, 'utf8');
-  fs.writeFileSync(depsPath,      depsContent,      'utf8');
-  fs.writeFileSync(profilePath,   profileContent,   'utf8');
-
-  return { toolchain: toolchainPath, deps: depsPath, profile: profilePath };
-}
-
-module.exports = {
-  generateToolchain,
-  generateCMakePresets,
-  getBundledCmakeDir,
-  archToVsPlatform,
-  isVisualStudioGenerator,
-  // Exported for tests
-  archToBitSuffix,
-  buildPlaceholders,
-  renderTemplate,
-};
+'use strict';
+
+const fs   = require('fs');
+const path = require('path');
+
+const { generateDepsCmake }     = require('./deps');
+const { generateCMakePresets } = require('./presets');
+
+/**
+ * Absolute path to the bundled `cmake/` directory shipped inside the
+ * wyvrnpm npm package. Returned in CMake-friendly form (forward slashes).
+ *
+ * @returns {string}
+ */
+function getBundledCmakeDir() {
+  const dir = path.resolve(__dirname, '..', '..', 'cmake');
+  return dir.replace(/\\/g, '/');
+}
+
+// Arch bit-width mapping. Kept exhaustive against `ARCH_MAP` in profile.js
+// so any arch a profile can hold has a deterministic "32"/"64" suffix.
+// Unknown arch strings fall back to an empty suffix — the consumer's
+// CMakeLists should then use another discriminator (e.g. profile hash).
+const ARCH_BIT_SUFFIX = {
+  x86_64:  '64',
+  x86:     '32',
+  armv8:   '64',
+  armv7:   '32',
+  ppc64le: '64',
+  s390x:   '64',
+  mips:    '32',
+  mipsel:  '32',
+};
+
+/**
+ * Map a profile `arch` value to the canonical "64" / "32" suffix that
+ * `WYVRN_ARCH_SUFFIX` exposes to consumer CMakeLists. Empty string for
+ * unknown arches — callers can pattern-match on that to fall back.
+ *
+ * @param {string|null|undefined} arch
+ * @returns {string}
+ */
+function archToBitSuffix(arch) {
+  if (!arch) return '';
+  return ARCH_BIT_SUFFIX[arch] ?? '';
+}
+
+// Visual Studio generator `-A <platform>` mapping. VS defaults to x64
+// when `-A` is unspecified — which silently wins against a 32-bit profile
+// and causes consumer-side `find_package()` to reject 32-bit artefacts
+// with "The version found is not compatible" (a CMake pointer-size check,
+// not a version-number check). Auto-emitting `-A` keeps VS + x86 honest.
+const ARCH_VS_PLATFORM = {
+  x86_64: 'x64',
+  x86:    'Win32',
+  armv8:  'ARM64',
+  armv7:  'ARM',
+};
+
+/**
+ * Map a profile arch to the Visual Studio generator's `-A <platform>` value.
+ * Returns null for arches that don't map to a known VS platform — callers
+ * should skip `-A` in that case and let the user pass one explicitly.
+ *
+ * @param {string|null|undefined} arch
+ * @returns {string|null}
+ */
+function archToVsPlatform(arch) {
+  if (!arch) return null;
+  return ARCH_VS_PLATFORM[arch] ?? null;
+}
+
+/**
+ * True when the generator name identifies a Visual Studio generator (e.g.
+ * "Visual Studio 17 2022"). VS generators require `-A <platform>` /
+ * `architecture` in the preset; everyone else (Ninja, Make, Xcode, …)
+ * ignores it.
+ *
+ * @param {string|null|undefined} name
+ * @returns {boolean}
+ */
+function isVisualStudioGenerator(name) {
+  if (!name) return false;
+  return /^Visual Studio \d/.test(name);
+}
+
+/**
+ * Substitute `{{KEY}}` placeholders in a template string.
+ *
+ * @param {string} template
+ * @param {Record<string, string>} values
+ * @returns {string}
+ */
+function renderTemplate(template, values) {
+  return template.replace(/\{\{(\w+)\}\}/g, (match, key) => {
+    if (Object.prototype.hasOwnProperty.call(values, key)) {
+      return values[key];
+    }
+    throw new Error(`Toolchain template has no value for placeholder {{${key}}}`);
+  });
+}
+
+/**
+ * Produce the toolchain template's placeholder substitutions.
+ *
+ * @param {object} args
+ * @param {import('../profile').WyvrnProfile} args.profile
+ * @param {string} args.profileName
+ * @param {string} args.profileHash
+ * @param {string[]} args.packageNames
+ * @returns {Record<string, string>}
+ */
+function buildPlaceholders({ profile, profileName, profileHash, packageNames }) {
+  const prefixPathEntries = packageNames
+    .map((name) => `    "\${CMAKE_CURRENT_LIST_DIR}/${name}"`)
+    .join('\n');
+
+  return {
+    GENERATED_AT:             new Date().toISOString(),
+    PROFILE_NAME:             profileName,
+    PROFILE_HASH:             profileHash,
+    PROFILE_OS:               profile.os ?? '',
+    PROFILE_ARCH:             profile.arch ?? '',
+    PROFILE_ARCH_SUFFIX:      archToBitSuffix(profile.arch),
+    PROFILE_COMPILER:         profile.compiler ?? '',
+    PROFILE_COMPILER_VERSION: profile['compiler.version'] ?? '',
+    PROFILE_CPPSTD:           profile['compiler.cppstd'] ?? '20',
+    PROFILE_RUNTIME:          profile['compiler.runtime'] ?? '',
+    WYVRNPM_CMAKE_DIR:        getBundledCmakeDir(),
+    PREFIX_PATH_ENTRIES:      prefixPathEntries || '    # (no dependencies)',
+  };
+}
+
+/**
+ * Generate the three toolchain artefacts under `destDir`:
+ *   - wyvrn_toolchain.cmake
+ *   - wyvrn_deps.cmake
+ *   - wyvrn_profile.json
+ *
+ * ───────────────────────────────────────────────────────────────────────────
+ * CONTRACT (PLAN-CMAKE-TOOLCHAIN Phase F ↔ PLAN-BUILD-MISSING Phase 3)
+ * ───────────────────────────────────────────────────────────────────────────
+ * This function is the **single source of truth** for translating a build
+ * profile into a CMake configuration. Two callers exist:
+ *
+ *   1. `install`              — writes the toolchain into a consumer project's
+ *                               `wyvrn_internal/`, so `cmake --preset` picks it
+ *                               up at configure time.
+ *   2. `buildFromSource`      — (not yet implemented; PLAN-BUILD-MISSING §3)
+ *                               writes the toolchain into a scratch build dir
+ *                               when we source-build a package via
+ *                               `--build=missing`. The package is compiled
+ *                               with THIS function's output, guaranteeing the
+ *                               resulting binary's profile → flag mapping is
+ *                               bit-for-bit identical to what a consumer sees.
+ *
+ * Do NOT replicate this mapping elsewhere. If PLAN-BUILD-MISSING §3 finds it
+ * needs additional behaviour (e.g. extra CMake cache variables), extend this
+ * function — do not branch.
+ *
+ * Callers choose `destDir` and `packageNames`:
+ *   - `destDir`      — any directory; in source-build, points at the scratch
+ *                      `wyvrn_internal/` co-located with the cloned source.
+ *   - `packageNames` — in `install`, the consumer's resolved deps; in
+ *                      source-build, the *package's own* resolved deps.
+ *
+ * Profile arguments (`profile`, `profileName`, `profileHash`) are always the
+ * active consumer profile — source-build still uses the consumer's profile,
+ * not the package's. That is the whole point of the source-build path.
+ * ───────────────────────────────────────────────────────────────────────────
+ *
+ * @param {object} args
+ * @param {string} args.destDir         Where to write the three files.
+ * @param {import('../profile').WyvrnProfile} args.profile
+ * @param {string} args.profileName
+ * @param {string} args.profileHash
+ * @param {string[]} args.packageNames  Resolved dep names in topological order.
+ * @returns {{ toolchain: string, deps: string, profile: string }}
+ *          Absolute paths of the three files written.
+ */
+function generateToolchain({ destDir, profile, profileName, profileHash, packageNames }) {
+  fs.mkdirSync(destDir, { recursive: true });
+
+  const templatePath = path.join(__dirname, 'template.cmake');
+  const template     = fs.readFileSync(templatePath, 'utf8');
+  const placeholders = buildPlaceholders({ profile, profileName, profileHash, packageNames });
+  const toolchainContent = renderTemplate(template, placeholders);
+  const depsContent      = generateDepsCmake({ packageNames, profileHash });
+  const profileContent   = JSON.stringify({ name: profileName, hash: profileHash, ...profile }, null, 2) + '\n';
+
+  const toolchainPath = path.join(destDir, 'wyvrn_toolchain.cmake');
+  const depsPath      = path.join(destDir, 'wyvrn_deps.cmake');
+  const profilePath   = path.join(destDir, 'wyvrn_profile.json');
+
+  fs.writeFileSync(toolchainPath, toolchainContent, 'utf8');
+  fs.writeFileSync(depsPath,      depsContent,      'utf8');
+  fs.writeFileSync(profilePath,   profileContent,   'utf8');
+
+  return { toolchain: toolchainPath, deps: depsPath, profile: profilePath };
+}
+
+module.exports = {
+  generateToolchain,
+  generateCMakePresets,
+  getBundledCmakeDir,
+  archToVsPlatform,
+  isVisualStudioGenerator,
+  // Exported for tests
+  archToBitSuffix,
+  buildPlaceholders,
+  renderTemplate,
+};