Pattern-based formatter #12
Conversation
This commit implements the following built-in patterns: - Full pattern; - Log level pattern and short log level pattern; - Source location pattern, source path pattern, source basename pattern, source line pattern, and source column pattern; - Logger name pattern; - Payload pattern; - Process ID pattern; - Thread ID pattern. Future commits will contain patterns relative to the formatting of date and time.
This commit seperates the old LocalTimeCacher originally implemented in the full formatter to a new Cacher util that is more general and reusable.
This commit adds the following built-in patterns: - Abbreviated month name pattern; - Month name pattern; - Abbreviated weekday name pattern; - Weekday name pattern.
This commit contains the following new built-in patterns: - Milliseconds pattern; - Microseconds pattern; - Nanoseconds pattern.
This commit addes the formatted strings of the following date time parts as new fields into the local time cacher: year, month, day, hour, minute, and second.
This commit contains the following new built-in pattern implementations: - Full date time; - Short year; - Year; - Month; - Day; - Hour; - Minute; - Second. This commit also contains some refactors.
This commit contains implementations for the following two built-in patterns: - Time; - Short time.
This commit contains the following implementations of three new built-in patterns: - Hour in 12-hour format; - Time in 12-hour format; - UTC timezone offset.
The previous merge (`39d45fc`) from 'main' branch discarded some changes, so we need to restore them. We created a new branch 'pattern-formatter-fix-merge' from the last commit (`c8ecffb`) of the previous merge. In this commit we merge 'main' branch into the new branch to restore the discarded changes, then in the next commit we will merge the changes after the previous merge into the new branch, and finally, we merge the new branch into the current branch to complete the fix. In this commit, `winapi` dependency is no longer optional.
See the description of the last commit.
The overall workflow of the pattern! procedural macro:
1. Parsing the macro input token stream into:
- An AST representing the internal structure of the pattern template string.
The spdlog_macros::parse::PatternTemplate struct represents a node within
the AST tree;
- A mapping that associates custom pattern formatters with their names.
The spdlog_macros::parse::CustomPatternMapping struct holds the mapping.
The spdlog_macros::parse::Pattern struct represents the parsed artifacts.
2. Synthesising the parsed artifacts into an expression that evaluates to a
pattern formatter. The expression will be a tuple expression.
The synthesising step is almost done. I'm still working on parsing the pattern
template string into the AST representation. Other parts of the parsing step
are almost done.
- Rename some full names. - Remove single character abbreviations. - Replace hyphens in names with underscores.
Allow only identifier instead of literal string, and must start with a `$`.
SpriteOvO
force-pushed
the
pattern-formatter
branch
2 times, most recently
from
1f7fa92
to
0cafb39
Compare
|
Looks like all problems from the first round of review have been solved! 🎉 There should be only one final question left, and I've been thinking about it. I'd like to try to split the current The motivations:
Simply put, this split just adds a wrapper to the existing @Lancern What is your opinion? :) |
I'd argue that this actually limits the ability to combine different patterns. An important usage is that, users can use built-in patterns as building blocks for their own patterns; and again, these user-crafted patterns can also be used as building blocks for even larger patterns. If
Patterns can be freely combined does not mean patterns are combinations. A single placeholder as a pattern can also be useful; for instance, |
|
Yeah, you're right, I'll drop that idea. I'll do some more checking and cleanup, and if there are no more issues this PR should be merged in the next few days. |
Co-Authored-By: Sirui Mu <msrlancern@gmail.com>
SpriteOvO
force-pushed
the
pattern-formatter
branch
from
0cafb39
to
98fa9dc
Compare
- Improve built-in patterns table alignment. - Patterns related to source location require that feature `source-location` is enabled, otherwise the output is empty. - Users are no longer allowed to create patterns manually.
SpriteOvO
force-pushed
the
pattern-formatter
branch
from
980771c
to
89d6606
Compare
This PR introduces pattern-based formatters.
Related issue: #10