buildtool: functionalize, use incremental build

Author: scivision

.github/workflows/ci-nojvm.yml

@@ -34,4 +34,8 @@ jobs:
 
     - uses: ./.github/workflows/composite-install-matlab
 
+    - name: Fortran FC
+      if: runner.os == 'macOS'
+      run: echo "FC=gfortran-14" >> $GITHUB_ENV
+
     - uses: ./.github/workflows/composite-buildtool

buildfile.m

@@ -23,11 +23,6 @@
   plan("clean") = matlab.buildtool.tasks.CleanTask;
 end
 
-plan("build_c") = matlab.buildtool.Task(Actions=@subprocess_build_c);
-plan("build_cpp") = matlab.buildtool.Task(Actions=@subprocess_build_cpp);
-plan("build_fortran") = matlab.buildtool.Task(Actions=@subprocess_build_fortran);
-plan("test").Dependencies = ["build_c", "build_cpp", "build_fortran"];
-
 if ~isMATLABReleaseOlderThan("R2024a")
   plan("check") = matlab.buildtool.tasks.CodeIssuesTask(pkg_name, IncludeSubfolders=true, ...
     WarningThreshold=0, Results="CodeIssues.sarif");
@@ -42,6 +37,19 @@
   % dummy task to allow "buildtool mex" to build all MEX targets
   plan("mex") = matlab.buildtool.Task();
   mex_deps = string.empty;
+else
+  td = plan.RootFolder + "/test";
+
+  plan("exe:c") = matlab.buildtool.Task(Inputs=td+"/stdout_stderr_c.c", ...
+    Outputs=td+"/stdout_stderr_c.exe", Actions=@build_exe);
+
+  plan("exe:cpp") = matlab.buildtool.Task(Inputs=td+"/stdin_cpp.cpp",...
+    Outputs=td+"/stdin_cpp.exe", Actions=@build_exe);
+
+  plan("exe:fortran") = matlab.buildtool.Task(Inputs=[td + "/stdout_stderr_fortran.f90", td + "/stdin_fortran.f90"],...
+    Outputs=[td+"/stdout_stderr_fortran.exe", td+"/stdin_fortran.exe"], Actions=@build_exe);
+
+  plan("test").Dependencies = "exe";
 end
 
 for s = get_mex_sources()
@@ -51,11 +59,8 @@
   % name of MEX target function is name of first source file
   if isMATLABReleaseOlderThan("R2024b")
     mex_name = "mex_" + name;
-    % specifying .Inputs and .Outputs enables incremental builds
-    % https://www.mathworks.com/help/matlab/matlab_prog/improve-performance-with-incremental-builds.html
-    plan(mex_name) = matlab.buildtool.Task(Actions=@(context) legacy_mex(context, compiler_opt, linker_opt));
-    plan(mex_name).Inputs = src;
-    plan(mex_name).Outputs = fullfile(bindir, name + "." + mexext());
+    plan(mex_name) = matlab.buildtool.Task(Inputs=src, Outputs=fullfile(bindir, name + "." + mexext()), ...
+      Actions=@(context) legacy_mex(context, compiler_opt, linker_opt));
     mex_deps(end+1) = mex_name; %#ok<AGROW>
   else
     plan("mex:" + name) = matlab.buildtool.tasks.MexTask(src, bindir, ...
@@ -96,112 +101,89 @@ function publishTask(context)
 end
 
 
-function subprocess_build_c(context)
+function build_exe(context)
 
-td = context.Plan.RootFolder + "/test";
-src = td + "/stdout_stderr_c.c";
+for i = 1:length(context.Task.Inputs)
+  src = context.Task.Inputs(i);
+  exe = context.Task.Outputs(i).paths;
+  exe = exe(1);
 
-for s = src
-  [~, n] = fileparts(s);
-  exe = fullfile(td, n + ".exe");
-  if stdlib.get_modtime(s) < stdlib.get_modtime(exe)
-    continue
+  [~,~,ext] = fileparts(src.paths);
+  switch ext
+    case ".c", lang = "c";
+    case ".cpp", lang = "c++";
+    case ".f90", lang = "fortran";
+    otherwise, error("unknown code suffix " + ext)
   end
 
-  cmd = get_build_cmd("c++", s);
-  if isempty(cmd), return, end
-  cmd = cmd + exe;
-  disp(cmd)
-  [r, m] = system(cmd);
-  if r ~= 0
-    disp("failed to build TestSubprocess " + exe + " " + m)
-  end
-end
+  [comp, shell, outFlag] = get_build_cmd(lang);
+  if isempty(comp), return, end
 
-end
-
-
-function subprocess_build_cpp(context)
-
-td = context.Plan.RootFolder + "/test";
-src = [td + "/sleep.cpp", td + "/stdin_cpp.cpp"];
-
-for s = src
-  [~, n] = fileparts(s);
-  exe = fullfile(td, n + ".exe");
-  if stdlib.get_modtime(s) < stdlib.get_modtime(exe)
-    continue
+  cmd = join([comp, src.paths, outFlag + exe]);
+  if ~isempty(shell)
+    cmd = join([shell, "&&", cmd]);
   end
 
-  cmd = get_build_cmd("c++", s);
-  if isempty(cmd), return, end
-  cmd = cmd + exe;
   disp(cmd)
-  [r, m] = system(cmd);
-  if r ~= 0
-    disp("failed to build TestSubprocess " + exe + " " + m)
-  end
+  system(cmd);
 end
 
 end
 
 
-function subprocess_build_fortran(context)
+function [comp, shell] = get_compiler(lang)
 
-td = context.Plan.RootFolder + "/test";
-src = [td + "/stdout_stderr_fortran.f90", td + "/stdin_fortran.f90"];
+lang = lower(lang);
 
-for s = src
-  [~, n] = fileparts(s);
-  exe = fullfile(td, n + ".exe");
-  if stdlib.get_modtime(s) < stdlib.get_modtime(exe)
-    continue
+co = mex.getCompilerConfigurations(lang);
+
+if isempty(co)
+  switch lang
+    case "fortran"
+      comp = getenv("FC");
+      if isempty(comp)
+        error("set FC environment variable to the Fortran compiler path, or do 'mex -setup fortran'")
+      end
+    case "c++"
+      comp = getenv("CXX");
+      if isempty(comp)
+        error("set CXX environment variable to the C++ compiler path, or do 'mex -setup c++")
+      end
+    case "c"
+      comp = getenv("CC");
+      if isempty(comp)
+        error("set CC environment variable to the C compiler path, or do 'mex -setup c'")
+      end
+    otherwise, error("language not known " + lang)
   end
+else
+  comp = co.Details.CompilerExecutable;
+  disp(lang + " compiler: " + co.Name + " " + co.Version + " " + comp)
+end
 
-  cmd = get_build_cmd("Fortran", s);
-  if isempty(cmd), return, end
-  cmd = cmd + exe;
-  disp(cmd)
-  [r, m] = system(cmd);
-  if r ~= 0
-    disp("failed to build TestSubprocess " + exe + " " + m)
+
+shell = string.empty;
+if ispc
+  disp("Shell: " + co.Details.CommandLineShell)
+  if contains(co.Name, "Visual Studio")
+    shell = join([strcat('"',string(co.Details.CommandLineShell),'"'), ...
+                co.Details.CommandLineShellArg], " ");
   end
 end
 
 end
 
 
-function cmd = get_build_cmd(lang, src)
+function [comp, shell, outFlag] = get_build_cmd(lang)
 
-cmd = string.empty;
+outFlag = "-o";
 
-co = mex.getCompilerConfigurations(lang);
-if isempty(co)
-  if lang == "Fortran"
-    fc = getenv("FC");
-    if isempty(fc)
-      disp("set FC environment variable to the Fortran compiler executable, or do 'mex -setup fortran' to configure the Fortran compiler")
-    end
-  end
-  disp(lang + " compiler not found")
-  return
-else
-  comp = co.Details.CompilerExecutable;
-end
+[comp, shell] = get_compiler(lang);
 
-outFlag = "-o";
-shell = string.empty;
-msvcLike = ispc && (contains(co.Name, "Visual Studio"));
-if msvcLike
-  shell = join([strcat('"',string(co.Details.CommandLineShell),'"'), ...
-                co.Details.CommandLineShellArg], " ");
+if ~isempty(shell)
   outFlag = "/Fo" + tempdir + " /link /out:";
 end
 
-cmd = join([comp, src, outFlag]);
-if ~isempty(shell)
-  cmd = join([shell, "&&", cmd]);
-end
 
 end