File: log_manager.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (111 lines) | stat: -rw-r--r-- 3,766 bytes parent folder | download | duplicates (8)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
// Copyright 2015 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_AUTOFILL_CORE_BROWSER_LOGGING_LOG_MANAGER_H_
#define COMPONENTS_AUTOFILL_CORE_BROWSER_LOGGING_LOG_MANAGER_H_

#include <concepts>
#include <memory>

#include "base/functional/callback.h"
#include "base/types/pass_key.h"
#include "components/autofill/core/browser/logging/log_buffer_submitter.h"
#include "components/autofill/core/common/logging/log_macros.h"

namespace base {
class Value;
}

namespace autofill {

class LogRouter;
class RoutingLogManager;
class BufferingLogManager;

// This interface is used by the password management code to receive and display
// logs about progress of actions like saving a password.
class LogManager {
 public:
  // Returns the production code implementation of LogManager. If |log_router|
  // is null, the manager will do nothing. |notification_callback| will be
  // called every time the activity status of logging changes.
  static std::unique_ptr<RoutingLogManager> Create(
      LogRouter* log_router,
      base::RepeatingClosure notification_callback);

  static std::unique_ptr<BufferingLogManager> CreateBuffering();

  virtual ~LogManager() = default;

  // Returns whether logs recorded via `Log()` will be displayed.
  virtual bool IsLoggingActive() const = 0;

  // This is the preferred way to submitting log entries.
  virtual LogBufferSubmitter Log() = 0;

  // Emits the log entry.
  virtual void ProcessLog(base::Value::Dict node,
                          base::PassKey<LogBufferSubmitter>) = 0;
};

// This LogManager subclass can be connected to a LogRouter, which in turn
// passes logs to LogReceivers.
class RoutingLogManager : public LogManager {
 public:
  // This method is called by a LogRouter, after the LogManager registers with
  // one. If |router_can_be_used| is true, logs can be sent to LogRouter after
  // the return from OnLogRouterAvailabilityChanged and will reach at least one
  // LogReceiver instance. If |router_can_be_used| is false, no logs should be
  // sent to the LogRouter.
  virtual void OnLogRouterAvailabilityChanged(bool router_can_be_used) = 0;

  // The owner of the LogManager can call this to start or end suspending the
  // logging, by setting |suspended| to true or false, respectively.
  virtual void SetSuspended(bool suspended) = 0;
};

// This LogManager subclass stores logs in a buffer, which can eventually be
// flushed to another LogManager. It facilitates logging across in sequences
// outside of the main thread in a thread-safe way.
class BufferingLogManager : public LogManager {
 public:
  // Passes the buffering log since the last Flush() to `destination`.
  virtual void Flush(LogManager& destination) = 0;
};

inline LogBuffer::IsActive IsLoggingActive(LogManager* log_manager) {
  return LogBuffer::IsActive(log_manager && log_manager->IsLoggingActive());
}

namespace internal {

// Traits for LOG_AF() macro for `LogManager*`.
template <std::convertible_to<const LogManager*> T>
struct LoggerTraits<T> {
  static bool active(const LogManager* log_manager) {
    return log_manager && log_manager->IsLoggingActive();
  }

  static LogBufferSubmitter get_stream(LogManager* log_manager) {
    return log_manager->Log();
  }
};

// Traits for LOG_AF() macro for `LogManager&`.
template <std::convertible_to<const LogManager&> T>
struct LoggerTraits<T> {
  static bool active(const LogManager& log_manager) {
    return log_manager.IsLoggingActive();
  }

  static LogBufferSubmitter get_stream(LogManager& log_manager) {
    return log_manager.Log();
  }
};

}  // namespace internal

}  // namespace autofill

#endif  // COMPONENTS_AUTOFILL_CORE_BROWSER_LOGGING_LOG_MANAGER_H_