Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Process::Status#to_s for abnormal exits on Windows #15283

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Improve Process::Status#to_s for abnormal exits on Windows #15283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions spec/std/process/status_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ describe Process::Status do

it "on abnormal exit" do
{% if flag?(:win32) %}
assert_prints status_for(:interrupted).to_s, "3221225786"
assert_prints status_for(:interrupted).to_s, "STATUS_CONTROL_C_EXIT"
{% else %}
assert_prints status_for(:interrupted).to_s, "INT"
{% end %}
Expand Down Expand Up @@ -269,7 +269,7 @@ describe Process::Status do

it "on abnormal exit" do
{% if flag?(:win32) %}
assert_prints status_for(:interrupted).inspect, "Process::Status[3221225786]"
assert_prints status_for(:interrupted).inspect, "Process::Status[LibC::STATUS_CONTROL_C_EXIT]"
{% else %}
assert_prints status_for(:interrupted).inspect, "Process::Status[Signal::INT]"
{% end %}
Expand Down
47 changes: 39 additions & 8 deletions src/process/status.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,13 +270,18 @@ class Process::Status

# Prints a textual representation of the process status to *io*.
#
# The result is equivalent to `#to_s`, but prefixed by the type name and
# delimited by square brackets: `Process::Status[0]`, `Process::Status[1]`,
# `Process::Status[Signal::HUP]`.
# The result is similar to `#to_s`, but prefixed by the type name,
# delimited by square brackets, and constants use full paths:
# `Process::Status[0]`, `Process::Status[1]`, `Process::Status[Signal::HUP]`,
# `Process::Status[LibC::STATUS_CONTROL_C_EXIT]`.
def inspect(io : IO) : Nil
io << "Process::Status["
{% if flag?(:win32) %}
@exit_status.to_s(io)
if name = name_for_win32_exit_status
io << "LibC::" << name
else
@exit_status.to_s(io)
end
{% else %}
if normal_exit?
exit_code.inspect(io)
Expand All @@ -287,13 +292,38 @@ class Process::Status
io << "]"
end

private def name_for_win32_exit_status
case @exit_status
# Ignoring LibC::STATUS_SUCCESS here because we prefer its numerical representation `0`
when LibC::STATUS_FATAL_APP_EXIT then "STATUS_FATAL_APP_EXIT"
when LibC::STATUS_DATATYPE_MISALIGNMENT then "STATUS_DATATYPE_MISALIGNMENT"
when LibC::STATUS_BREAKPOINT then "STATUS_BREAKPOINT"
when LibC::STATUS_ACCESS_VIOLATION then "STATUS_ACCESS_VIOLATION"
when LibC::STATUS_ILLEGAL_INSTRUCTION then "STATUS_ILLEGAL_INSTRUCTION"
when LibC::STATUS_FLOAT_DIVIDE_BY_ZERO then "STATUS_FLOAT_DIVIDE_BY_ZERO"
when LibC::STATUS_FLOAT_INEXACT_RESULT then "STATUS_FLOAT_INEXACT_RESULT"
when LibC::STATUS_FLOAT_INVALID_OPERATION then "STATUS_FLOAT_INVALID_OPERATION"
when LibC::STATUS_FLOAT_OVERFLOW then "STATUS_FLOAT_OVERFLOW"
when LibC::STATUS_FLOAT_UNDERFLOW then "STATUS_FLOAT_UNDERFLOW"
when LibC::STATUS_PRIVILEGED_INSTRUCTION then "STATUS_PRIVILEGED_INSTRUCTION"
when LibC::STATUS_STACK_OVERFLOW then "STATUS_STACK_OVERFLOW"
when LibC::STATUS_CANCELLED then "STATUS_CANCELLED"
when LibC::STATUS_CONTROL_C_EXIT then "STATUS_CONTROL_C_EXIT"
end
oprypin marked this conversation as resolved.
Show resolved Hide resolved
end

# Prints a textual representation of the process status to *io*.
#
# A normal exit status prints the numerical value (`0`, `1` etc).
# A normal exit status prints the numerical value (`0`, `1` etc) or a named
# status (e.g. `STATUS_CONTROL_C_EXIT` on Windows).
# A signal exit status prints the name of the `Signal` member (`HUP`, `INT`, etc.).
def to_s(io : IO) : Nil
{% if flag?(:win32) %}
@exit_status.to_s(io)
if name = name_for_win32_exit_status
io << name
else
@exit_status.to_s(io)
end
{% else %}
if normal_exit?
io << exit_code
Expand All @@ -310,11 +340,12 @@ class Process::Status

# Returns a textual representation of the process status.
#
# A normal exit status prints the numerical value (`0`, `1` etc).
# A normal exit status prints the numerical value (`0`, `1` etc) or a named
# status (e.g. `STATUS_CONTROL_C_EXIT` on Windows).
# A signal exit status prints the name of the `Signal` member (`HUP`, `INT`, etc.).
def to_s : String
{% if flag?(:win32) %}
@exit_status.to_s
name_for_win32_exit_status || @exit_status.to_s
{% else %}
if normal_exit?
exit_code.to_s
Expand Down
Loading