buildSrc/src/main/java/cc/squirreljme/plugin/general/cmake/CMakeUtils.java

   1 // -*- Mode: Java; indent-tabs-mode: t; tab-width: 4 -*-
   2 // ---------------------------------------------------------------------------
   3 // Multi-Phasic Applications: SquirrelJME
   4 //     Copyright (C) Stephanie Gawroriski <xer@multiphasicapps.net>
   5 // ---------------------------------------------------------------------------
   6 // SquirrelJME is under the Mozilla Public License Version 2.0.
   7 // See license.mkd for licensing and copyright information.
   8 // ---------------------------------------------------------------------------
   9
  10 package cc.squirreljme.plugin.general.cmake;
  11
  12 import cc.squirreljme.plugin.util.PathUtils;
  13 import java.io.IOException;
  14 import java.nio.file.Files;
  15 import java.nio.file.Path;
  16 import java.nio.file.Paths;
  17 import java.util.ArrayList;
  18 import java.util.Arrays;
  19 import java.util.List;
  20 import java.util.concurrent.TimeUnit;
  21 import org.gradle.api.logging.LogLevel;
  22 import org.gradle.api.logging.Logger;
  23 import org.gradle.internal.os.OperatingSystem;
  24
  25 /**
  26  * Utilities for CMake.
  27  *
  28  * @since 2024/03/15
  29  */
  30 public final class CMakeUtils
  31 {
  32         /**
  33          * Not used.
  34          *
  35          * @since 2024/03/15
  36          */
  37         private CMakeUtils()
  38         {
  39         }
  40
  41         /**
  42          * Returns the path where CMake is available.
  43          *
  44          * @return The CMake path.
  45          * @since 2024/03/15
  46          */
  47         public static Path cmakeExePath()
  48         {
  49                 // Standard executable?
  50                 Path cmakePath = PathUtils.findPath("cmake");
  51
  52                 // Windows executable?
  53                 if (cmakePath == null)
  54                         cmakePath = PathUtils.findPath("cmake.exe");
  55
  56                 // Standard installation on Windows?
  57                 if (OperatingSystem.current() == OperatingSystem.WINDOWS)
  58                 {
  59                         String programFiles = System.getenv("PROGRAMFILES");
  60                         if (programFiles != null)
  61                         {
  62                                 Path maybe = Paths.get(programFiles).resolve("CMake")
  63                                         .resolve("bin").resolve("cmake.exe");
  64                                 if (Files.exists(maybe))
  65                                         return maybe;
  66                         }
  67                 }
  68
  69                 return cmakePath;
  70         }
  71
  72         /**
  73          * Executes a CMake task.
  74          *
  75          * @param __logger The logger to use.
  76          * @param __logName The name of the log.
  77          * @param __cmakeBuild The CMake build directory.
  78          * @param __args CMake arguments.
  79          * @throws IOException On read/write or execution errors.
  80          * @since 2024/03/15
  81          */
  82         public static void cmakeExecute(Logger __logger, String __logName,
  83                 Path __cmakeBuild, String... __args)
  84                 throws IOException
  85         {
  86                 // Need CMake
  87                 Path cmakePath = CMakeUtils.cmakeExePath();
  88                 if (cmakePath == null)
  89                         throw new RuntimeException("CMake not found.");
  90
  91                 // Determine run arguments
  92                 List<String> args = new ArrayList<>();
  93                 args.add(cmakePath.toAbsolutePath().toString());
  94                 args.addAll(Arrays.asList(__args));
  95
  96                 // Set executable process
  97                 ProcessBuilder procBuilder = new ProcessBuilder();
  98                 procBuilder.command(args);
  99
 100                 // Output log files
 101                 Path outLog = __cmakeBuild.resolve(__logName + ".out");
 102                 Path errLog = __cmakeBuild.resolve(__logName + ".err");
 103
 104                 // Log the output somewhere
 105                 procBuilder.redirectOutput(outLog.toFile());
 106                 procBuilder.redirectError(errLog.toFile());
 107
 108                 // Start the process
 109                 Process proc = procBuilder.start();
 110
 111                 // Wait for it to complete
 112                 try
 113                 {
 114                         if (!proc.waitFor(5, TimeUnit.MINUTES) ||
 115                                 proc.exitValue() != 0)
 116                                 throw new RuntimeException(String.format(
 117                                         "CMake failed to %s...", __logName));
 118                 }
 119                 catch (InterruptedException __e)
 120                 {
 121                         throw new RuntimeException("CMake timed out!", __e);
 122                 }
 123                 finally
 124                 {
 125                         CMakeUtils.dumpLog(__logger,
 126                                 LogLevel.LIFECYCLE, outLog);
 127                         CMakeUtils.dumpLog(__logger,
 128                                 LogLevel.ERROR, errLog);
 129                 }
 130         }
 131
 132         /**
 133          * Dumps log to the output.
 134          *
 135          * @param __logger The logger to output to.
 136          * @param __level The log level.
 137          * @param __pathy The output path.
 138          * @since 2024/03/15
 139          */
 140         public static void dumpLog(Logger __logger, LogLevel __level, Path __pathy)
 141         {
 142                 try
 143                 {
 144                         for (String ln : Files.readAllLines(__pathy))
 145                                 __logger.log(__level, ln);
 146                 }
 147                 catch (Throwable e)
 148                 {
 149                         e.printStackTrace();
 150                 }
 151         }
 152 }