Fix extra carriage returns in piped ANSI output on Windows#3442
Open
LowLevelLore wants to merge 10 commits intogabime:v1.xfrom
Open
Fix extra carriage returns in piped ANSI output on Windows#3442LowLevelLore wants to merge 10 commits intogabime:v1.xfrom
LowLevelLore wants to merge 10 commits intogabime:v1.xfrom
Conversation
Now lets test on windows
Added default value to argument
Changed improper misplaced includes.
Contributor
Author
|
@gabime any updates / recommendations on this ? |
Contributor
Author
|
@gabime Any progress here ? |
Owner
|
The ansicolor sink was never designed for windows. Why not use the wincolor sink |
|
New terminal on windows can be set to understand ANSI escape code. https://learn.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences |
gabime
requested changes
Nov 15, 2025
| # Static/Shared library | ||
| # --------------------------------------------------------------------------------------- | ||
| set(SPDLOG_SRCS src/spdlog.cpp src/stdout_sinks.cpp src/color_sinks.cpp src/file_sinks.cpp src/async.cpp src/cfg.cpp) | ||
| list(APPEND SPDLOG_SRCS include/spdlog/sinks/ansicolor_sink-inl.h) |
Owner
There was a problem hiding this comment.
Should be included in https://github.com/gabime/spdlog/blob/v1.x/src/stdout_sinks.cpp instead
| #ifdef _WIN32 | ||
| DWORD bytes_written = 0; | ||
| HANDLE h = reinterpret_cast<HANDLE>(_get_osfhandle(_fileno(target_file_))); | ||
| WriteFile(h, formatted.data() + start, static_cast<DWORD>(end - start), &bytes_written, |
Owner
There was a problem hiding this comment.
_get_osfhandle shoild be called only once at construction time and store the result in a class member
| #include <spdlog/details/os.h> | ||
| #include <spdlog/pattern_formatter.h> | ||
|
|
||
| #if defined(_WIN32) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR fixes incorrect line endings in ANSI-colored output when redirected or piped on Windows terminals. A possible fix for #3138.
Problem
When using
fwrite()on Windows, the CRT applies text-mode translation, converting\nto\r\n. This results in an extra carriage return (\r) being injected, especially noticeable when ANSI-colored output is redirected or piped.Solution
On Windows, replace
fwrite()with a direct call toWriteFile()using the native file handle obtained from_get_osfhandle(_fileno(...)). This bypasses the CRT entirely, ensuring output is written exactly as intended, without automatic newline translation.Code Change
CMake
Also included ansicolor_sink-inl.h explicitly in the build to avoid linking issues (when linking to static library).