summaryrefslogtreecommitdiffstats
path: root/dom/fs/shared/FileSystemHelpers.h
blob: 26a820f343ee36aaef6fb0f02108c0b84e483a51 (plain)
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef DOM_FS_SHARED_FILESYSTEMHELPERS_H_
#define DOM_FS_SHARED_FILESYSTEMHELPERS_H_

#include "FileSystemTypes.h"
#include "mozilla/RefPtr.h"

namespace mozilla::dom::fs {

// XXX Consider moving this class template to MFBT.

// A wrapper class template on top of the RefPtr. The RefPtr provides us the
// automatic reference counting of objects with AddRef() and Release() methods.
// `Registered` provides automatic registration counting of objects with
// Register() and Unregister() methods. Registration counting works similarly
// as reference counting, but objects are not deleted when the number of
// registrations drops to zero (that's managed by reference counting). Instead,
// an object can trigger an asynchronous close operation which still needs to
// hold and use the referenced object. Example:
//
// using BoolPromise = MozPromise<bool, nsresult, false>;
//
// class MyObject {
//  public:
//   NS_INLINE_DECL_REFCOUNTING(MyObject)
//
//   void Register() {
//     mRegCnt++;
//   }
//
//   void Unregister() {
//     mRegCnt--;
//     if (mRegCnt == 0) {
//       BeginClose();
//     }
//   }
//
//  private:
//   RefPtr<BoolPromise> BeginClose() {
//     return InvokeAsync(mIOTaskQueue, __func__,
//                []() {
//                  return BoolPromise::CreateAndResolve(true, __func__);
//                })
//         ->Then(GetCurrentSerialEventTarget(), __func__,
//                [self = RefPtr<MyObject>(this)](
//                    const BoolPromise::ResolveOrRejectValue&) {
//                  return self->mIOTaskQueue->BeginShutdown();
//                })
//         ->Then(GetCurrentSerialEventTarget(), __func__,
//                [self = RefPtr<MyObject>(this)](
//                    const ShutdownPromise::ResolveOrRejectValue&) {
//                  return BoolPromise::CreateAndResolve(true, __func__);
//                });
//   }
//
//   RefPtr<TaskQueue> mIOTaskQueue;
//   uint32_t mRegCnt = 0;
// };

template <class T>
class Registered {
 private:
  RefPtr<T> mObject;

 public:
  ~Registered() {
    if (mObject) {
      mObject->Unregister();
    }
  }

  Registered() = default;

  Registered(const Registered& aOther) : mObject(aOther.mObject) {
    mObject->Register();
  }

  Registered(Registered&& aOther) noexcept = default;

  MOZ_IMPLICIT Registered(RefPtr<T> aObject) : mObject(std::move(aObject)) {
    if (mObject) {
      mObject->Register();
    }
  }

  Registered<T>& operator=(decltype(nullptr)) {
    RefPtr<T> oldObject = std::move(mObject);
    mObject = nullptr;
    if (oldObject) {
      oldObject->Unregister();
    }
    return *this;
  }

  Registered<T>& operator=(const Registered<T>& aRhs) {
    if (aRhs.mObject) {
      aRhs.mObject->Register();
    }
    RefPtr<T> oldObject = std::move(mObject);
    mObject = aRhs.mObject;
    if (oldObject) {
      oldObject->Unregister();
    }
    return *this;
  }

  Registered<T>& operator=(Registered<T>&& aRhs) noexcept {
    RefPtr<T> oldObject = std::move(mObject);
    mObject = std::move(aRhs.mObject);
    aRhs.mObject = nullptr;
    if (oldObject) {
      oldObject->Unregister();
    }
    return *this;
  }

  const RefPtr<T>& inspect() const { return mObject; }

  RefPtr<T> unwrap() {
    RefPtr<T> oldObject = std::move(mObject);
    mObject = nullptr;
    if (oldObject) {
      oldObject->Unregister();
    }
    return oldObject;
  }

  T* get() const { return mObject; }

  operator T*() const& { return get(); }

  T* operator->() const { return get(); }
};

// Spec says valid names don't include (os-dependent) path separators,
// and is not equal to a dot . or two dots ..
// We want to use the same validator from both child and parent.
bool IsValidName(const fs::Name& aName);

}  // namespace mozilla::dom::fs

#endif  // DOM_FS_SHARED_FILESYSTEMHELPERS_H_