123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165 |
- // Copyright 2022 The Abseil Authors.
- //
- // Licensed under the Apache License, Version 2.0 (the "License");
- // you may not use this file except in compliance with the License.
- // You may obtain a copy of the License at
- //
- // https://www.apache.org/licenses/LICENSE-2.0
- //
- // Unless required by applicable law or agreed to in writing, software
- // distributed under the License is distributed on an "AS IS" BASIS,
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- // See the License for the specific language governing permissions and
- // limitations under the License.
- //
- // -----------------------------------------------------------------------------
- // File: log/globals.h
- // -----------------------------------------------------------------------------
- //
- // This header declares global logging library configuration knobs.
- #ifndef ABSL_LOG_GLOBALS_H_
- #define ABSL_LOG_GLOBALS_H_
- #include "absl/base/attributes.h"
- #include "absl/base/config.h"
- #include "absl/base/log_severity.h"
- #include "absl/strings/string_view.h"
- namespace absl {
- ABSL_NAMESPACE_BEGIN
- //------------------------------------------------------------------------------
- // Minimum Log Level
- //------------------------------------------------------------------------------
- //
- // Messages logged at or above this severity are directed to all registered log
- // sinks or skipped otherwise. This parameter can also be modified using
- // command line flag --minloglevel.
- // See absl/base/log_severity.h for descriptions of severity levels.
- // MinLogLevel()
- //
- // Returns the value of the Minimum Log Level parameter.
- // This function is async-signal-safe.
- ABSL_MUST_USE_RESULT absl::LogSeverityAtLeast MinLogLevel();
- // SetMinLogLevel()
- //
- // Updates the value of Minimum Log Level parameter.
- // This function is async-signal-safe.
- void SetMinLogLevel(absl::LogSeverityAtLeast severity);
- namespace log_internal {
- // ScopedMinLogLevel
- //
- // RAII type used to temporarily update the Min Log Level parameter.
- class ScopedMinLogLevel final {
- public:
- explicit ScopedMinLogLevel(absl::LogSeverityAtLeast severity);
- ScopedMinLogLevel(const ScopedMinLogLevel&) = delete;
- ScopedMinLogLevel& operator=(const ScopedMinLogLevel&) = delete;
- ~ScopedMinLogLevel();
- private:
- absl::LogSeverityAtLeast saved_severity_;
- };
- } // namespace log_internal
- //------------------------------------------------------------------------------
- // Stderr Threshold
- //------------------------------------------------------------------------------
- //
- // Messages logged at or above this level are directed to stderr in
- // addition to other registered log sinks. This parameter can also be modified
- // using command line flag --stderrthreshold.
- // See absl/base/log_severity.h for descriptions of severity levels.
- // StderrThreshold()
- //
- // Returns the value of the Stderr Threshold parameter.
- // This function is async-signal-safe.
- ABSL_MUST_USE_RESULT absl::LogSeverityAtLeast StderrThreshold();
- // SetStderrThreshold()
- //
- // Updates the Stderr Threshold parameter.
- // This function is async-signal-safe.
- void SetStderrThreshold(absl::LogSeverityAtLeast severity);
- inline void SetStderrThreshold(absl::LogSeverity severity) {
- absl::SetStderrThreshold(static_cast<absl::LogSeverityAtLeast>(severity));
- }
- // ScopedStderrThreshold
- //
- // RAII type used to temporarily update the Stderr Threshold parameter.
- class ScopedStderrThreshold final {
- public:
- explicit ScopedStderrThreshold(absl::LogSeverityAtLeast severity);
- ScopedStderrThreshold(const ScopedStderrThreshold&) = delete;
- ScopedStderrThreshold& operator=(const ScopedStderrThreshold&) = delete;
- ~ScopedStderrThreshold();
- private:
- absl::LogSeverityAtLeast saved_severity_;
- };
- //------------------------------------------------------------------------------
- // Log Backtrace At
- //------------------------------------------------------------------------------
- //
- // Users can request backtrace to be logged at specific locations, specified
- // by file and line number.
- // ShouldLogBacktraceAt()
- //
- // Returns true if we should log a backtrace at the specified location.
- namespace log_internal {
- ABSL_MUST_USE_RESULT bool ShouldLogBacktraceAt(absl::string_view file,
- int line);
- } // namespace log_internal
- // SetLogBacktraceLocation()
- //
- // Sets the location the backtrace should be logged at.
- void SetLogBacktraceLocation(absl::string_view file, int line);
- //------------------------------------------------------------------------------
- // Prepend Log Prefix
- //------------------------------------------------------------------------------
- //
- // This option tells the logging library that every logged message
- // should include the prefix (severity, date, time, PID, etc.)
- // ShouldPrependLogPrefix()
- //
- // Returns the value of the Prepend Log Prefix option.
- // This function is async-signal-safe.
- ABSL_MUST_USE_RESULT bool ShouldPrependLogPrefix();
- // EnableLogPrefix()
- //
- // Updates the value of the Prepend Log Prefix option.
- // This function is async-signal-safe.
- void EnableLogPrefix(bool on_off);
- namespace log_internal {
- using LoggingGlobalsListener = void (*)();
- void SetLoggingGlobalsListener(LoggingGlobalsListener l);
- // Internal implementation for the setter routines. These are used
- // to break circular dependencies between flags and globals. Each "Raw"
- // routine corresponds to the non-"Raw" counterpart and used to set the
- // configuration parameter directly without calling back to the listener.
- void RawSetMinLogLevel(absl::LogSeverityAtLeast severity);
- void RawSetStderrThreshold(absl::LogSeverityAtLeast severity);
- void RawEnableLogPrefix(bool on_off);
- } // namespace log_internal
- ABSL_NAMESPACE_END
- } // namespace absl
- #endif // ABSL_LOG_GLOBALS_H_
|