Skip to content

Commit 5ec5017

Browse files
smilesa-maurice
authored andcommitted
Move C++ SDK and Realtime Database logging APIs to public headers.
API review: https://docs.google.com/document/d/1MvRtzoIccB1Vm8_x4pvWhI2yNrbwozS28yFITtQNVXk/edit# PiperOrigin-RevId: 252675402
1 parent e7ceffd commit 5ec5017

File tree

5 files changed

+51
-6
lines changed

5 files changed

+51
-6
lines changed

app/src/include/firebase/log.h

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,20 @@ enum LogLevel {
4242
kLogLevelAssert,
4343
};
4444

45+
#if defined(INTERNAL_EXPERIMENTAL) || defined(SWIG)
46+
/// @brief Sets the logging verbosity.
47+
/// All log messages at or above the specific log level.
48+
///
49+
/// @param[in] log_level Log level to display, by default this is set to
50+
/// kLogLevelInfo.
51+
void SetLogLevel(LogLevel level);
52+
53+
/// @brief Gets the logging verbosity.
54+
///
55+
/// @return Get the currently configured logging verbosity.
56+
LogLevel GetLogLevel();
57+
#endif // defined(INTERNAL_EXPERIMENTAL) || defined(SWIG)
58+
4559
/// @endcond
4660

4761
// NOLINTNEXTLINE - allow namespace overridden

app/src/log.cc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,16 +141,22 @@ static void LogMessageWithCallbackV(LogLevel log_level, const char* format,
141141
va_copy(log_to_file_args, args);
142142
LogToFile(log_level, format, log_to_file_args);
143143
#endif // FIREBASE_LOG_TO_FILE
144-
if (log_level < LogGetLevel()) return;
144+
if (log_level < GetLogLevel()) return;
145145

146146
static char log_buffer[512] = {0};
147147
vsnprintf(log_buffer, sizeof(log_buffer) - 1, format, args);
148148
g_log_callback(log_level, log_buffer, g_log_callback_data);
149149
}
150150

151-
void LogSetLevel(LogLevel level) { g_log_level = level; }
151+
void SetLogLevel(LogLevel level) {
152+
g_log_level = level;
153+
}
154+
155+
LogLevel GetLogLevel() { return g_log_level; }
156+
157+
void LogSetLevel(LogLevel level) { SetLogLevel(level); }
152158

153-
LogLevel LogGetLevel() { return g_log_level; }
159+
LogLevel LogGetLevel() { return GetLogLevel(); }
154160

155161
// Log a debug message to the system log.
156162
void LogDebug(const char* format, ...) {

app/src/log.h

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919

2020
#include <stdarg.h>
2121

22-
#include "firebase/log.h"
22+
#include "app/src/include/firebase/internal/common.h"
23+
#include "app/src/include/firebase/log.h"
2324

2425
#if !defined(FIREBASE_NAMESPACE)
2526
#define FIREBASE_NAMESPACE firebase
@@ -30,9 +31,13 @@ namespace FIREBASE_NAMESPACE {
3031
// Common log methods.
3132

3233
// All messages at or above the specified log level value are displayed.
33-
void LogSetLevel(LogLevel level);
34+
void SetLogLevel(LogLevel level);
3435
// Get the currently set log level.
35-
LogLevel LogGetLevel();
36+
LogLevel GetLogLevel();
37+
// Use firebase::SetLogLevel() instead.
38+
FIREBASE_DEPRECATED void LogSetLevel(LogLevel level);
39+
// Use firebase::GetLogLevel() instead.
40+
FIREBASE_DEPRECATED LogLevel LogGetLevel();
3641
// Log a debug message to the system log.
3742
void LogDebug(const char* format, ...);
3843
// Log an info message to the system log.

database/src/common/database.cc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,5 +195,12 @@ void Database::set_persistence_enabled(bool enabled) {
195195
if (internal_) internal_->SetPersistenceEnabled(enabled);
196196
}
197197

198+
#if defined(INTERNAL_EXPERIMENTAL) || defined(SWIG)
199+
void Database::set_log_level(LogLevel level) {
200+
}
201+
202+
LogLevel Database::log_level() const { return kLogLevelInfo; }
203+
#endif // defined(INTERNAL_EXPERIMENTAL) || defined(SWIG)
204+
198205
} // namespace database
199206
} // namespace firebase

database/src/include/firebase/database.h

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
#define FIREBASE_DATABASE_CLIENT_CPP_SRC_INCLUDE_FIREBASE_DATABASE_H_
1717

1818
#include "firebase/app.h"
19+
#include "firebase/log.h"
1920
#include "firebase/internal/common.h"
2021
#include "firebase/database/common.h"
2122
#include "firebase/database/data_snapshot.h"
@@ -162,6 +163,18 @@ class Database {
162163
/// (disk) storage, or false to discard pending writes when the app exists.
163164
void set_persistence_enabled(bool enabled);
164165

166+
#if defined(INTERNAL_EXPERIMENTAL) || defined(SWIG)
167+
/// Set the log verbosity of this object.
168+
///
169+
/// @param[in] log_level Log level, by default this is set to kLogLevelInfo.
170+
void set_log_level(LogLevel log_level);
171+
172+
/// Get the log verbosity of this object.
173+
///
174+
/// @return Get the currently configured logging verbosity.
175+
LogLevel log_level() const;
176+
#endif // defined(INTERNAL_EXPERIMENTAL) || defined(SWIG)
177+
165178
private:
166179
friend Database* GetDatabaseInstance(::firebase::App* app, const char* url,
167180
InitResult* init_result_out);

0 commit comments

Comments
 (0)