File: global_error_service.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (86 lines) | stat: -rw-r--r-- 3,299 bytes parent folder | download | duplicates (6)
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
// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_UI_GLOBAL_ERROR_GLOBAL_ERROR_SERVICE_H_
#define CHROME_BROWSER_UI_GLOBAL_ERROR_GLOBAL_ERROR_SERVICE_H_

#include <map>
#include <memory>
#include <vector>

#include "base/memory/raw_ptr.h"
#include "base/observer_list.h"
#include "chrome/browser/ui/global_error/global_error_observer.h"
#include "components/keyed_service/core/keyed_service.h"

class GlobalError;

// This service manages a list of errors that are meant to be shown globally.
// If an error applies to an entire profile and not just to a tab then the
// error should be shown using this service. Examples of global errors are:
//   - the previous session crashed for a given profile.
//   - a sync error occurred
class GlobalErrorService : public KeyedService {
 public:
  // Type used to represent the list of currently active errors.
  using GlobalErrorList = std::vector<raw_ptr<GlobalError, VectorExperimental>>;

  // Constructs a GlobalErrorService object.
  GlobalErrorService();

  GlobalErrorService(const GlobalErrorService&) = delete;
  GlobalErrorService& operator=(const GlobalErrorService&) = delete;

  ~GlobalErrorService() override;

  void AddObserver(GlobalErrorObserver* observer);
  void RemoveObserver(GlobalErrorObserver* observer);

  // Adds the given error to the list of global errors and displays it on
  // browser windows. If no browser windows are open then the error is
  // displayed once a browser window is opened.
  void AddGlobalError(std::unique_ptr<GlobalError> error);

  // Hides the given error and removes it from the list of global errors.
  // Ownership is returned to the caller.
  std::unique_ptr<GlobalError> RemoveGlobalError(GlobalError* error);

  // DEPRECATED; DO NOT USE!
  // http://crbug.com/673578
  //
  // These functions allow adding and removing of a GlobalError that is not
  // owned by the GlobalErrorService. In this case, the error's lifetime must
  // exceed that of the GlobalErrorService.
  //
  // Do not add more uses of these functions, and remove existing uses.
  void AddUnownedGlobalError(GlobalError* error);
  void RemoveUnownedGlobalError(GlobalError* error);

  // Gets the error with the given command ID or NULL if no such error exists.
  // This class maintains ownership of the returned error.
  GlobalError* GetGlobalErrorByMenuItemCommandID(int command_id) const;

  // Gets the highest severity error that has a app menu item.
  // Returns NULL if no such error exists.
  GlobalError* GetHighestSeverityGlobalErrorWithAppMenuItem() const;

  // Gets the first error that has a bubble view which hasn't been shown yet.
  // Returns NULL if no such error exists.
  GlobalError* GetFirstGlobalErrorWithBubbleView() const;

  // Gets all errors.
  const GlobalErrorList& errors() { return all_errors_; }

  // Post a notification that a global error has changed and that the error UI
  // should update it self.
  void NotifyErrorsChanged();

 private:
  base::ObserverList<GlobalErrorObserver> observer_list_;

  GlobalErrorList all_errors_;
  std::map<GlobalError*, std::unique_ptr<GlobalError>> owned_errors_;
};

#endif  // CHROME_BROWSER_UI_GLOBAL_ERROR_GLOBAL_ERROR_SERVICE_H_