summaryrefslogtreecommitdiff
path: root/src/common/logging/text_formatter.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/common/logging/text_formatter.h')
-rw-r--r--src/common/logging/text_formatter.h41
1 files changed, 41 insertions, 0 deletions
diff --git a/src/common/logging/text_formatter.h b/src/common/logging/text_formatter.h
new file mode 100644
index 000000000..2f05794f0
--- /dev/null
+++ b/src/common/logging/text_formatter.h
@@ -0,0 +1,41 @@
1// Copyright 2014 Citra Emulator Project
2// Licensed under GPLv2 or any later version
3// Refer to the license.txt file included.
4
5#pragma once
6
7#include <cstddef>
8#include <memory>
9
10namespace Log {
11
12class Logger;
13struct Entry;
14class Filter;
15
16/**
17 * Attempts to trim an arbitrary prefix from `path`, leaving only the part starting at `root`. It's
18 * intended to be used to strip a system-specific build directory from the `__FILE__` macro,
19 * leaving only the path relative to the sources root.
20 *
21 * @param path The input file path as a null-terminated string
22 * @param root The name of the root source directory as a null-terminated string. Path up to and
23 * including the last occurence of this name will be stripped
24 * @return A pointer to the same string passed as `path`, but starting at the trimmed portion
25 */
26const char* TrimSourcePath(const char* path, const char* root = "src");
27
28/// Formats a log entry into the provided text buffer.
29void FormatLogMessage(const Entry& entry, char* out_text, size_t text_len);
30/// Formats and prints a log entry to stderr.
31void PrintMessage(const Entry& entry);
32/// Prints the same message as `PrintMessage`, but colored acoording to the severity level.
33void PrintColoredMessage(const Entry& entry);
34
35/**
36 * Logging loop that repeatedly reads messages from the provided logger and prints them to the
37 * console. It is the baseline barebones log outputter.
38 */
39void TextLoggingLoop(std::shared_ptr<Logger> logger, const Filter* filter);
40
41}