File: unique_widget_ptr.h

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; 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,806; 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 (79 lines) | stat: -rw-r--r-- 2,395 bytes parent folder | download | duplicates (9)
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
// Copyright 2020 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_VIEWS_WIDGET_UNIQUE_WIDGET_PTR_H_
#define UI_VIEWS_WIDGET_UNIQUE_WIDGET_PTR_H_

#include <memory>

#include "base/scoped_observation.h"
#include "ui/views/views_export.h"
#include "ui/views/widget/widget.h"
#include "ui/views/widget/widget_observer.h"

namespace views {

// A weak owning pointer to a Widget.
// This smart pointer acts like a unique_ptr: it ensures the Widget is
// properly closed when it goes out of scope.
// It also acts like a WeakPtr: the Widget may be deleted by its native
// widget and `get()` becomes nullptr when this happens.
// Caller may check the validity of this pointer before dereferencing it if
// the widget lifetime is in doubt.
class VIEWS_EXPORT UniqueWidgetPtr {
 public:
  UniqueWidgetPtr();
  // This class acts like a std::unique_ptr<Widget>, so this constructor is
  // deliberately implicit.
  UniqueWidgetPtr(std::unique_ptr<Widget> widget);  // NOLINT

  // Construct from a subclass instance of Widget. Note that ~Widget() is
  // virtual, so the downcasting is safe. This constructor is deliberately
  // implicit.
  template <class U>
  UniqueWidgetPtr(std::unique_ptr<U> widget) {  // NOLINT
    Init(std::unique_ptr<Widget>(widget.release()));
  }

  UniqueWidgetPtr(UniqueWidgetPtr&&);
  UniqueWidgetPtr& operator=(UniqueWidgetPtr&&);
  ~UniqueWidgetPtr();

  explicit operator bool() const;
  Widget& operator*() const;
  Widget* operator->() const;
  void reset();
  Widget* get() const;

 private:
  class Impl : public WidgetObserver {
   public:
    Impl();
    explicit Impl(std::unique_ptr<Widget> widget);
    Impl(const Impl&) = delete;
    Impl& operator=(const Impl&) = delete;
    ~Impl() override;

    Widget* Get() const;

    // WidgetObserver overrides.
    void OnWidgetDestroying(Widget* widget) override;

   private:
    struct WidgetAutoCloser {
      void operator()(Widget* widget);
    };

    bool received_widget_destruction_signal_ = false;
    base::ScopedObservation<Widget, WidgetObserver> widget_observation_{this};
    std::unique_ptr<Widget, WidgetAutoCloser> widget_closer_;
  };
  void Init(std::unique_ptr<Widget> widget);

  std::unique_ptr<Impl> unique_widget_ptr_impl_;
};

}  // namespace views

#endif  // UI_VIEWS_WIDGET_UNIQUE_WIDGET_PTR_H_