[CI-NO-BUILD] [build] Extend ANSI colour palette to stdout

1. Extended ANSI colour palette to stdout
2. Update echo prints to use ANSI colour palette
3. Includes self-deleting scheduled task to clean build_log.txt
   of colour palette artefacts

Split from PR #1212.

Signed-off-by: benyamin-codez <[email protected]>

Author: benyamin-codez

build/build.bat

@@ -64,6 +64,9 @@ if /I "%ARG%"=="32" set BUILD_ARCH=x86& goto :argloop
 if /I "%ARG%"=="x86" set BUILD_ARCH=x86& goto :argloop
 if /I "%ARG%"=="ARM64" set BUILD_ARCH=ARM64& goto :argloop
 
+rem Enable ANSI palette support
+call :prepare_palette
+
 rem Assume that this is target OS version and split off the tag
 call :split_target_tag "%ARG%"
 
@@ -176,6 +179,7 @@ set TARGET_VS_CONFIG="%TARGET_PROJ_CONFIG% %BUILD_FLAVOR%|%BUILD_ARCH%"
 
 rem We set up the Build Environment and get started...
 echo.
+call :clr_print %_c_Cyn% "Building : %BUILD_FILE%"
 pushd %BUILD_DIR%
 call "%~dp0SetVsEnv.bat" %TARGET_PROJ_CONFIG%
 
@@ -192,53 +196,59 @@ if /I "!TAG!"=="SDV" (
   rem SDV is deprecated from Windows 11 24H2, both in the EWDK and WHCP. Making some allowances...
   rem We only do SDV for Win10 targets.
   if "%TARGET%"=="Win10" (  
-    echo Running SDV for %BUILD_FILE%, configuration %TARGET_VS_CONFIG%
+    call :clr_print %_c_Cyn% "Running Static Driver Verifier build for %BUILD_FILE%."
+    echo Configuration ^: %TARGET_VS_CONFIG%
     call :run_sdv "%TARGET_PROJ_CONFIG% %BUILD_FLAVOR%" %BUILD_ARCH%
     if "%BUILD_FAILED%" EQU "1" (
-      echo Static Driver Verifier BUILD FAILED - Resolve problem and try again.
+      call :clr_print %_c_Red% "Static Driver Verifier BUILD FAILED - Resolve problem and try again."
       goto :build_arch_done
     )
-    echo Static Driver Verifier build for %BUILD_FILE% succeeded.
+    call :clr_print %_c_Grn% "Static Driver Verifier build for %BUILD_FILE% succeeded."
   ) else (
-    echo Skipping SDV for %BUILD_FILE%, configuration %TARGET_VS_CONFIG%. SDV is for WHCP_LEGACY targets ONLY.
+    call :clr_print %_c_Yel% "Skipping Static Driver Verifier for %BUILD_FILE%. SDV if for WHCP_LEGACY targets ONLY."
+    echo Configuration ^: %TARGET_VS_CONFIG%
     echo.
   )
   if exist "%CODEQL_BIN%" (
-    echo Running CodeQL for %BUILD_FILE%, configuration %TARGET_VS_CONFIG%
+    call :clr_print %_c_Cyn% "CodeQL : Performing CodeQL build for %BUILD_FILE%."
+    echo CodeQL ^: Configuration ^= %TARGET_VS_CONFIG%
     call :run_ql "%TARGET_PROJ_CONFIG% %BUILD_FLAVOR%" %BUILD_ARCH%
     if "!CODEQL_FAILED!" EQU "1" (
       set BUILD_FAILED=1
-      echo CodeQL - BUILD FAILED - Resolve problem and try again.
+      call :clr_print %_c_Red% "CodeQL : BUILD FAILED" %_c_Wht% " - Resolve problem and try again."
       goto :build_arch_done
     )
-    echo CodeQL build for %BUILD_FILE% succeeded.
+    call :clr_print %_c_Grn% "CodeQL build for %BUILD_FILE% succeeded."
   ) else (
-      echo CodeQL binary is missing!
+      call :clr_print %_c_Yel% "CodeQL binary is missing!"
       @echo.
   )
   call :run_ca "%TARGET_PROJ_CONFIG% %BUILD_FLAVOR%" %BUILD_ARCH%
   if "!BUILD_FAILED!" EQU "1" (
-    echo Code Analysis BUILD FAILED.
+    call :clr_print %_c_Red% "Code Analysis BUILD FAILED."
     goto :build_arch_done
   )
-  echo Code Analysis build for %BUILD_FILE% succeeded.
+  call :clr_print %_c_Grn% "Code Analysis build for %BUILD_FILE% succeeded."
   echo.
   call :run_dvl "%TARGET_PROJ_CONFIG% %BUILD_FLAVOR%" %BUILD_ARCH%
   if "!BUILD_FAILED!" EQU "1" (
-    echo Driver Verifier Log BUILD FAILED.
+    call :clr_print %_c_Red% "Driver Verifier Log BUILD FAILED."
     goto :build_arch_done
   )
-  echo Driver Verifier Log build for %BUILD_FILE% succeeded.
+  call :clr_print %_c_Grn% "Driver Verifier Log build for %BUILD_FILE% succeeded."
   echo.
 ) else (
   rem Do a build without analysis.
-  echo Building %BUILD_FILE%, configuration %TARGET_VS_CONFIG%, command %BUILD_COMMAND%
+  call :clr_print %_c_Cyn% "Performing No-Analysis build for %BUILD_FILE%."
+  @echo Configuration ^= %TARGET_VS_CONFIG%
+  @echo Command       ^= %BUILD_COMMAND%
+  @echo.
   call :run_build "%TARGET_PROJ_CONFIG% %BUILD_FLAVOR%" %BUILD_ARCH%
   if "!BUILD_FAILED!" EQU "1" (
-    echo NO-ANALYSIS BUILD FAILED.
+    call :clr_print %_c_Red% "NO-ANALYSIS BUILD FAILED."
     goto :build_arch_done
   )
-  echo No-Analysis build for %BUILD_FILE% succeeded.
+  call :clr_print %_c_Grn% "No-Analysis build for %BUILD_FILE% succeeded."
   echo.
 )
 :build_arch_done
@@ -266,29 +276,29 @@ goto :eof
 
 :run_sdv
 if exist sdv (
-  echo "Removing previously created SDV artifacts"
+  call :clr_print %_c_Cyn% "Removing previously created SDV artifacts..."
   rmdir /s /q sdv
   echo.
 )
 
 if "!SDV_FAILED!" NEQ "1" (
-  echo Build - Cleaning for %BUILD_FILE%...
+  call :clr_print %_c_Cyn% "Build: Cleaning for %BUILD_FILE%..."
   msbuild.exe -maxCpuCount %~dp1%BUILD_FILE% /t:clean /p:Configuration="%~1" /P:Platform=%2
   if ERRORLEVEL 1 (
     set SDV_FAILED=1
   )
   echo.
 )
 if "!SDV_FAILED!" NEQ "1" (
-  echo Build - Cleaning SDV for %BUILD_FILE%...
+  call :clr_print %_c_Cyn% "Build: Cleaning SDV for %BUILD_FILE%..."
   msbuild.exe -maxCpuCount %~dp1%BUILD_FILE% /t:sdv /p:inputs="/clean" /p:Configuration="%~1" /P:platform=%2
   if ERRORLEVEL 1 (
     set SDV_FAILED=1
   )
   echo.
 )
 if "!SDV_FAILED!" NEQ "1" (
-  echo Build - Performing SDV checks for %BUILD_FILE%...
+  call :clr_print %_c_Cyn% "Build: Performing SDV checks for %BUILD_FILE%..."
   msbuild.exe -maxCpuCount %~dp1%BUILD_FILE% /t:sdv /p:inputs="/check /devenv" /p:Configuration="%~1" /P:platform=%2
   if ERRORLEVEL 1 (
     set SDV_FAILED=1
@@ -303,7 +313,7 @@ goto :eof
 :run_ql
 
 if exist %~dp1codeql_db (
-  echo CodeQL ^: Removing previously created rules database...
+  call :clr_print %_c_Cyn% "CodeQL : Removing previously created rules database..."
   rmdir /s /q %~dp1codeql_db
 )
 
@@ -326,15 +336,15 @@ IF "%CODEQL_FAILED%" NEQ "1" (
 goto :eof
 
 :run_ca
-echo Performing Code Analysis build of %BUILD_FILE%.
+call :clr_print %_c_Cyn% "Performing Code Analysis build of %BUILD_FILE%."
 msbuild.exe -maxCpuCount %~dp1%BUILD_FILE% /p:Configuration="%~1" /P:Platform=%2 /P:RunCodeAnalysisOnce=True -fileLoggerParameters:LogFile=%~dp1%BUILD_NAME%.CodeAnalysis.log
 if ERRORLEVEL 1 (
   set BUILD_FAILED=1
 )
 goto :eof
 
 :run_dvl
-echo Performing Driver Verfier Log build of %BUILD_FILE%.
+call :clr_print %_c_Cyn% "Performing Driver Verfier Log build of %BUILD_FILE%."
 msbuild.exe -maxCpuCount %~dp1%BUILD_FILE% /t:dvl /p:Configuration="%~1" /P:platform=%2
 IF ERRORLEVEL 1 (
   set BUILD_FAILED=1
@@ -353,5 +363,21 @@ for /f "tokens=1,2 delims=_" %%i in (%BUILD_INFO%) do @(
 )
 goto :eof
 
+:clr_print
+@echo %z_esc%[%~1%~2%z_esc%[%~3%~4%z_esc%[%~5%~6%z_esc%[%~7%~8%z_esc%[0m
+goto :eof
+
+:prepare_palette
+rem Colour mods should work from WIN10_TH2
+rem Get the ANSI ESC character [0x27]
+for /f "tokens=2 usebackq delims=#" %%i in (`"prompt #$H#$E# & echo on & for %%i in (1) do rem"`) do @set z_esc=%%i
+rem Prepare pallette
+set "_c_Red="40;91m""
+set "_c_Grn="40;92m""
+set "_c_Yel="40;93m""
+set "_c_Cyn="40;96m""
+set "_c_Wht="40;37m""
+goto :eof
+
 :fail
 exit /B 1

build/clean_build_log.bat

@@ -0,0 +1,21 @@
+@echo off
+cd /d %~dp0
+cd ..
+if not exist ".\build_log.txt" goto :eof
+setlocal
+Title Clean Build Log
+echo Cleaning Build Log...
+timeout 3 1> nul 2>&1
+for /f "tokens=2 usebackq delims=#" %%i in (`"prompt #$H#$E# & echo on & for %%i in (1) do rem"`) do @set z_esc=%%i
+@PowerShell "(GC .\build_log.txt)|%%{$_ -Replace '%z_esc%\[0m',''}|SC .\build_log.txt"
+@PowerShell "(GC .\build_log.txt)|%%{$_ -Replace '%z_esc%\[40\;91m',''}|SC .\build_log.txt"
+@PowerShell "(GC .\build_log.txt)|%%{$_ -Replace '%z_esc%\[40\;92m',''}|SC .\build_log.txt"
+@PowerShell "(GC .\build_log.txt)|%%{$_ -Replace '%z_esc%\[40\;93m',''}|SC .\build_log.txt"
+@PowerShell "(GC .\build_log.txt)|%%{$_ -Replace '%z_esc%\[40\;96m',''}|SC .\build_log.txt"
+@PowerShell "(GC .\build_log.txt)|%%{$_ -Replace '%z_esc%\[40\;37m',''}|SC .\build_log.txt"
+@PowerShell "(GC .\build_log.txt)|%%{$_ -Replace '%z_esc%\[',''}|SC .\build_log.txt"
+echo Build Log successfully cleaned.
+echo Removing scheduled task...
+schtasks /delete /tn build_log_cleanup /f
+timeout 5
+endlocal

build/prebuild_x86_libs.bat

@@ -33,7 +33,7 @@ if "%VIOSOCK_PREBUILD_X86_LIBS%" EQU "1" (
     rem Check for x86 viosock libraries and build them if needed...
     if not exist "%BUILD_DIR%viosock\lib\x86\%TARGET%%BUILD_FLAVOR%\viosocklib.dll" (
       echo.
-      echo ATTENTION ^: Need to build x86 viosock libraries before building for amd64...
+      call :clr_print %_c_Yel% "ATTENTION : Need to build x86 viosock libraries before building for amd64..."
       setlocal
       set VIRTIO_WIN_NO_ARM=1
       if "%BUILD_FILE%"=="virtio-win.sln" (
@@ -50,11 +50,15 @@ if "%VIOSOCK_PREBUILD_X86_LIBS%" EQU "1" (
       if "%BUILD_FAILED%" EQU "1" (
         exit /B 1
       )
-      echo Successfully built the x86 viosock libraries.
+      call :clr_print %_c_Grn% "Successfully built the x86 viosock libraries."
+      call :clr_print %_c_Cyn% "Continuing with amd64 build..."
       echo.
-      echo Continuing with amd64 build...
       endlocal
     )
   )
 )
 goto :eof
+
+:clr_print
+@echo %z_esc%[%~1%~2%z_esc%[%~3%~4%z_esc%[%~5%~6%z_esc%[%~7%~8%z_esc%[0m
+goto :eof

buildAll.bat

@@ -39,46 +39,47 @@ if errorlevel 1 goto :fail
 call build\build.bat viomem\sys\viomem.vcxproj "Win10_SDV Win11_SDV" %*
 if errorlevel 1 goto :fail
 
-
 :nosdv2022
 
+call :prepare_palette
+
 path %path%;C:\Program Files (x86)\Windows Kits\10\bin\x86\
 for %%D in (pciserial fwcfg Q35) do @(
  call :bld_inf_drvr %%D
 )
 echo.
-echo Processing DVL files to create Windows 10 COMPAT ^(WIN10_RS1 ^/ 1607^) version...
+call :clr_print %_c_Cyn% "Processing DVL files to create Windows 10, version 1607, WIN10_RS1 COMPAT version..."
 for /R %%f in (*.dvl.xml) do @(
   call :process_xml %%f
 )
 if "%found_dvl_xml%"=="" (
-  echo WARNING ^: No DVL files were found.
+  call :clr_print %_c_Yel% "WARNING : No DVL files were found."
 ) else (
-  echo Processing of DVL files is complete.
+  call :clr_print %_c_Cyn% "Processing of DVL files is complete."
 )
 :bld_success
 echo.
-echo BUILD COMPLETED SUCCESSFULLY.
+call :clr_print %_c_Grn% "BUILD COMPLETED SUCCESSFULLY."
 call :leave 0
 goto :eof
 
 :fail
-echo BUILD FAILED.
+call :clr_print %_c_Red% "BUILD FAILED."
 set BUILD_FAILED=
 call :leave 1
 goto :eof
 
 :bld_inf_drvr
 set inf_drv=%~1
 echo.
-echo Building : %inf_drv%%
+call :clr_print %_c_Cyn% "Building : %inf_drv%"
 echo.
 pushd %inf_drv%
 call buildAll.bat
 if not errorlevel==0 (
   goto :fail
 )
-echo Build for %inf_drv% succeeded.
+call :clr_print %_c_Grn% "Build for %inf_drv% succeeded."
 popd
 goto :eof
 
@@ -89,15 +90,38 @@ if not exist "%dvl_file%" (
   call :fudge_xml %1
 ) else (
   rem Here we retain the Windows 10 version 1607, WIN10_RS1, build 14393 COMPAT DVL.
-  echo The file already exists : %dvl_file%
+  call :clr_print %_c_Grn% "The file already exists : %dvl_file%"
 )
 goto :eof
 
 :fudge_xml
 rem Here we create a Windows 10 version 1607, WIN10_RS1, build 14393 COMPAT DVL.
-echo Auto-magically creating : %dvl_file%
+call :clr_print %_c_Yel% "Auto-magically creating : %dvl_file%"
 findstr /v /c:"General.Checksum" "%~1" | findstr /v /c:".Semmle." > "%dvl_file%"
 goto :eof
 
+:clr_print
+echo %z_esc%[%~1%~2%z_esc%[%~3%~4%z_esc%[%~5%~6%z_esc%[%~7%~8%z_esc%[0m
+goto :eof
+
+:prepare_palette
+rem Colour mods should work from WIN10_TH2
+rem Get the ANSI ESC character: 0x27
+for /f "tokens=2 usebackq delims=#" %%i in (`"prompt #$H#$E# & echo on & for %%i in (1) do rem"`) do @(
+  set z_esc=%%i
+)
+rem Prepare pallette
+set "_c_Red="40;91m""
+set "_c_Grn="40;92m""
+set "_c_Yel="40;93m""
+set "_c_Cyn="40;96m""
+set "_c_Wht="40;37m""
+goto :eof
+
 :leave
+if exist ".\build_log.txt" (
+  call schtasks /create /tn build_log_cleanup /tr "%comspec% /c %~dp0build\clean_build_log.bat" /sc ONCE /sd 01/01/1910 /st 00:00 1> nul 2>&1
+  call schtasks /run /tn build_log_cleanup 1> nul 2>&1
+)
+endlocal
 exit /B %1