This repository was archived by the owner on Jul 22, 2023. It is now read-only.
forked from pythonnet/pythonnet
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNewReference.cs
More file actions
74 lines (66 loc) · 2.48 KB
/
NewReference.cs
File metadata and controls
74 lines (66 loc) · 2.48 KB
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
namespace Python.Runtime
{
using System;
using System.Diagnostics.Contracts;
/// <summary>
/// Represents a reference to a Python object, that is tracked by Python's reference counting.
/// </summary>
[NonCopyable]
ref struct NewReference
{
IntPtr pointer;
[Pure]
public static implicit operator BorrowedReference(in NewReference reference)
=> new BorrowedReference(reference.pointer);
/// <summary>
/// Returns <see cref="PyObject"/> wrapper around this reference, which now owns
/// the pointer. Sets the original reference to <c>null</c>, as it no longer owns it.
/// </summary>
public PyObject MoveToPyObject()
{
if (this.IsNull()) throw new NullReferenceException();
var result = new PyObject(this.pointer);
this.pointer = IntPtr.Zero;
return result;
}
/// <summary>
/// Removes this reference to a Python object, and sets it to <c>null</c>.
/// </summary>
public void Dispose()
{
if (this.IsNull())
{
return;
}
Runtime.XDecref(pointer);
pointer = IntPtr.Zero;
}
/// <summary>
/// Creates <see cref="NewReference"/> from a raw pointer
/// </summary>
[Pure]
public static NewReference DangerousFromPointer(IntPtr pointer)
=> new NewReference {pointer = pointer};
[Pure]
internal static IntPtr DangerousGetAddress(in NewReference reference)
=> IsNull(reference) ? throw new NullReferenceException() : reference.pointer;
[Pure]
internal static bool IsNull(in NewReference reference)
=> reference.pointer == IntPtr.Zero;
}
/// <summary>
/// These members can not be directly in <see cref="NewReference"/> type,
/// because <c>this</c> is always passed by value, which we need to avoid.
/// (note <code>this in NewReference</code> vs the usual <code>this NewReference</code>)
/// </summary>
static class NewReferenceExtensions
{
/// <summary>Gets a raw pointer to the Python object</summary>
[Pure]
public static IntPtr DangerousGetAddress(this in NewReference reference)
=> NewReference.DangerousGetAddress(reference);
[Pure]
public static bool IsNull(this in NewReference reference)
=> NewReference.IsNull(reference);
}
}