yvt/openspades
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update the rules for RefCountedObject

Browse Source
This commit is contained in:
yvt 2019-07-20 12:25:58 +09:00
parent fae85af23d
commit 9038c7e135
No known key found for this signature in database
GPG Key ID: 48F2768FA8D07C92
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Sources/Core/RefCountedObject.h
View File

@ -49,8 +49,19 @@ namespace spades {
* - Use `Handle<T>::New(...)` to consturct an object. * - Use `Handle<T>::New(...)` to consturct an object.
* - Methods receive `T` via a parameter of type `T&` or * - Methods receive `T` via a parameter of type `T&` or
* `stmp::optional<T&>`. They may create and hold a strong reference * `stmp::optional<T&>`. They may create and hold a strong reference
* using `Handle::Handle(T&)`. * using `Handle::Handle(T&)`. Alternatively, they can use `Handle<T>`
* if it is apparent that they store the object as `Handle<T>`.
* - Methods return `T` via a return type `Handle<T>`. * - Methods return `T` via a return type `Handle<T>`.
*
* # AngelScript interop
*
* - A return type `Handle<T>` translates to an AngelScript type signature
* `T@`.
* - Methods must not return `T&` or `stmp::optional<T&>`.
* - A parameter type `stmp::optional<T&>` translates to an AngelScript
* type signature `T@+`.
* - Methods must not have a parameter of type `T&` because AngelScript
* does not have a non-nullable object handle.
*/ */
class RefCountedObject { class RefCountedObject {
std::atomic<int> refCount; std::atomic<int> refCount;