feat: open viewer popup showing compilation errors when compilation fails

Author: xeluxee

README.md

@@ -256,6 +256,7 @@ require('competitest').setup {
 			height = 0.5,
 			show_nu = true,
 			show_rnu = false,
+			open_when_compilation_fails = true,
 		},
 	},
 	popup_ui = {
@@ -370,6 +371,7 @@ require('competitest').setup {
 		- `height`: a value from 0 to 1, representing the ratio between viewer window height and Neovim height
 		- `show_nu`: whether to show line numbers or not in viewer window
 		- `show_rnu`: whether to show relative line numbers or not in viewer window
+		- `open_when_compilation_fails`: open viewer popup showing compilation errors when compilation fails
 - `popup_ui`: settings related to testcase runner popup interface
 	- `total_width`: a value from 0 to 1, representing the ratio between total interface width and Neovim width
 	- `total_height`: a value from 0 to 1, representing the ratio between total interface height and Neovim height

lua/competitest/config.lua

@@ -25,6 +25,7 @@
 ---@field height number ratio between viewer popup height and Neovim height (between 0 and 1)
 ---@field show_nu boolean show lines number
 ---@field show_rnu boolean show lines relative number
+---@field open_when_compilation_fails boolean open viewer popup showing compilation errors when compilation fails
 
 ---Runner UI options
 ---@class (exact) competitest.Config.runner_ui
@@ -150,6 +151,7 @@ local default_config = {
 			height = 0.5,
 			show_nu = true,
 			show_rnu = false,
+			open_when_compilation_fails = true,
 		},
 	},
 	popup_ui = {

lua/competitest/runner.lua

@@ -1,8 +1,6 @@
 local api = vim.api
 local luv = vim.uv and vim.uv or vim.loop
-local config = require("competitest.config")
 local utils = require("competitest.utils")
-local ui = require("competitest.runner_ui")
 
 ---System command with arguments
 ---@class (exact) competitest.SystemCommand
@@ -11,7 +9,6 @@ local ui = require("competitest.runner_ui")
 
 ---Running testcase process status
 ---@class (exact) competitest.TCRunner.testcase_status.process
----@field cmd competitest.SystemCommand
 ---@field stdin uv.uv_pipe_t
 ---@field stdout uv.uv_pipe_t
 ---@field stderr uv.uv_pipe_t
@@ -25,7 +22,7 @@ local ui = require("competitest.runner_ui")
 ---@field expout string[]? expected output lines
 ---@field stdout string[] stdout lines
 ---@field stderr string[] stderr lines
----@field tcnum integer | string testcase number or identifier
+---@field tcnum integer | "Compile" testcase number or identifier
 ---@field status "" | "RUNNING" | "TIMEOUT" | "KILLED" | "SIG x" | "RET x" | "FAILED" | "CORRECT" | "WRONG" | "DONE"
 ---@field hlgroup string testcase status highlight group
 ---@field timelimit integer? maximum execution time in milliseconds, or `nil` if there's no time limit
@@ -48,7 +45,7 @@ local ui = require("competitest.runner_ui")
 ---@field tcdata table<integer, competitest.TCRunner.testcase_status> testcases status, data and results
 ---@field private compile boolean whether compilation is needed in the current run or not
 ---@field private next_tc integer index of next unprocessed testcase to run
----@field restore_winid integer? bring the cursor to the given window when testcases runner UI is closed
+---@field ui_restore_winid integer? bring the cursor to the given window when testcases runner UI is closed
 ---@field private ui competitest.RunnerUI?
 local TCRunner = {}
 TCRunner.__index = TCRunner ---@diagnostic disable-line: inject-field
@@ -81,7 +78,7 @@ function TCRunner:new(bufnr)
 		return { exec = exec, args = args }
 	end
 
-	local buf_cfg = config.get_buffer_config(bufnr)
+	local buf_cfg = require("competitest.config").get_buffer_config(bufnr)
 	local compile_command = nil
 	if buf_cfg.compile_command[filetype] then
 		compile_command = eval_command(buf_cfg.compile_command[filetype])
@@ -228,7 +225,6 @@ function TCRunner:execute_testcase(tcindex, cmd, dir, callback)
 	---@type competitest.TCRunner.testcase_status.process
 	---@diagnostic disable-next-line: missing-fields
 	local process = {
-		cmd = cmd,
 		stdin = assert(luv.new_pipe(false), "CompetiTest.nvim: TCRunner:execute_testcase: process stdin pipe creation failed"),
 		stdout = assert(luv.new_pipe(false), "CompetiTest.nvim: TCRunner:execute_testcase: process stdout pipe creation failed"),
 		stderr = assert(luv.new_pipe(false), "CompetiTest.nvim: TCRunner:execute_testcase: process stderr pipe creation failed"),
@@ -237,8 +233,8 @@ function TCRunner:execute_testcase(tcindex, cmd, dir, callback)
 
 	utils.create_directory(dir)
 	---@diagnostic disable-next-line: missing-fields
-	process.handle, process.pid = luv.spawn(process.cmd.exec, {
-		args = process.cmd.args,
+	process.handle, process.pid = luv.spawn(cmd.exec, {
+		args = cmd.args,
 		cwd = dir,
 		stdio = { process.stdin, process.stdout, process.stderr },
 	}, function(code, signal)
@@ -279,7 +275,7 @@ function TCRunner:execute_testcase(tcindex, cmd, dir, callback)
 		end
 	end)
 	if not process.handle then
-		utils.notify("TCRunner:execute_testcase: failed to spawn process using '" .. process.cmd.exec .. "' (" .. process.pid .. ").")
+		utils.notify("TCRunner:execute_testcase: failed to spawn process using '" .. cmd.exec .. "' (" .. process.pid .. ").")
 		tc.status = "FAILED"
 		tc.hlgroup = "CompetiTestWarning"
 		tc.time = -1
@@ -358,6 +354,8 @@ function TCRunner:execute_testcase(tcindex, cmd, dir, callback)
 	tc.hlgroup = "CompetiTestRunning"
 	tc.running = true
 	tc.killed = false
+	tc.exit_code = nil
+	tc.exit_signal = nil
 	self:update_ui(true)
 end
 
@@ -392,7 +390,7 @@ function TCRunner:show_ui()
 		return
 	end
 	if not self.ui then
-		self.ui = ui:new(self)
+		self.ui = require("competitest.runner_ui"):new(self)
 	end
 	self.ui:show_ui()
 	self.ui:update_ui()
@@ -401,7 +399,7 @@ end
 ---Set or update `restore_winid`
 ---@param restore_winid integer bring the cursor to the given window after runner is closed
 function TCRunner:set_restore_winid(restore_winid)
-	self.restore_winid = restore_winid
+	self.ui_restore_winid = restore_winid
 	if self.ui then
 		self.ui.restore_winid = restore_winid
 	end

lua/competitest/runner_ui/init.lua

@@ -58,6 +58,7 @@ local utils = require("competitest.utils")
 ---@field private windows competitest.RunnerUI.windows_table
 ---@field private interface competitest.RunnerUI.interface
 ---@field private make_viewer_visible boolean one-time request for `self:update_ui()` to open viewer after updating details
+---@field private latest_compilation_timestamp integer? latest failed compilation process start timestamp, used to decide whether to automatically show compilation errors in viewer popup or not
 local RunnerUI = {}
 RunnerUI.__index = RunnerUI ---@diagnostic disable-line: inject-field
 
@@ -85,7 +86,7 @@ function RunnerUI:new(runner)
 		viewer_visible = false,
 		viewer_content = nil,
 		diff_view = runner.config.view_output_diff,
-		restore_winid = runner.restore_winid,
+		restore_winid = runner.ui_restore_winid,
 		update_details = false,
 		update_windows = false,
 		update_testcase = nil,
@@ -432,8 +433,29 @@ function RunnerUI:update_ui()
 
 			for tcindex, data in ipairs(self.runner.tcdata) do
 				local l = { header = "TC " .. data.tcnum, status = data.status, time = "" }
-				if type(data.tcnum) == "string" then
+				if data.tcnum == "Compile" then
 					l.header = data.tcnum
+					-- open viewer popup showing compilation errors when compilation fails
+					if
+						self.runner.config.runner_ui.viewer.open_when_compilation_fails
+						and not data.killed
+						and data.exit_code
+						and data.exit_code ~= 0
+						and data.process.starting_time ~= self.latest_compilation_timestamp
+					then
+						if api.nvim_win_get_cursor(self.windows.tc.winid)[1] == 1 then
+							self.update_testcase = 1
+							self.viewer_content = "se"
+							self.make_viewer_visible = true
+							self.latest_compilation_timestamp = data.process.starting_time
+						else
+							-- move cursor to "Compile" line if not already there, then self:update_ui() will be triggered by CursorMoved event
+							self.update_testcase = nil
+							self.update_windows = true
+							api.nvim_win_set_cursor(self.windows.tc.winid, { 1, 0 })
+							return
+						end
+					end
 				end
 				if data.time and data.time ~= -1 then
 					l.time = string.format("%.3f seconds", data.time / 1000)