Make JLogMessage consistent with JStreamLog #390
Merged
Conversation
This file contains 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
JLogMessage flushes its output when it receives an End{} token. This is the worst of all worlds because it
1. Prevents us from appending metadata on each line of a multiline message like JStreamLog
2. Prevents us from being able to use it with output-agnostic methods like `void PrintUsefulOutput(std::ostream&)`
3. Ties us to always using C++ stream operators
4. Doesn't let us use C++ stream manipulators
5. Can't be used as a replacement for `jout` and `_DBG_`, which use std::endl and _don't_ have an end-of-message token
The replacement extends `std::stringstream` instead of wrapping it. It flushes on destruction, and users may optionally trigger a flush by streaming in a special flush token. This solves the problems listed above and should be sufficient to replace the existing JLogMessage, jout, jerr, _DBG_, and JStreamLog.
This is for the sake of having exactly one way of doing things. Flush complicates the semantics and implementation of JLogMessage without adding any needed functionality. Furthermore it is conceptually confused since a std::stringstream already has a flush() method which does not do what Flush() does. The pared-down JLogMessage is easy to explain as "std::ostringstream with a logger-specific line prefix and RAII for printing its contents to the log".
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.
jout,jerr, and_DBG_can now use JLogMessage under the hood.