Skip to content

Proposal: Safe pointers #1043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
filmor merged 9 commits into from
Feb 26, 2020
Merged

Proposal: Safe pointers #1043

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4a84a1e
NewReference type and an example usage
lostmsu Feb 13, 2020
88944a2
BorrowedReference + example, that exposes dangerous pattern
lostmsu Feb 13, 2020
e1ba92c
actually, borrowed refrences can be copied
lostmsu Feb 13, 2020
2d11f82
make BorrowedReference readonly ref struct
lostmsu Feb 13, 2020
dbb3dc5
updated old project file
lostmsu Feb 13, 2020
7304b25
BorrowedReference.Pointer is a private readonly field
lostmsu Feb 13, 2020
2bc218c
drop C# 8.0 requirement
lostmsu Feb 13, 2020
2cf9fc3
renamed NewReference.ToPyObject to MoveToPyObject
lostmsu Feb 23, 2020
6ae63cd
added xmldoc comments to *Reference members
lostmsu Feb 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
make BorrowedReference readonly ref struct
  • Loading branch information
@lostmsu
lostmsu committed Feb 13, 2020
commit 2d11f829c3fcbfafd043ce3f1ca1518445f4ff9b
17 changes: 9 additions & 8 deletions src/runtime/BorrowedReference.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
namespace Python.Runtime
{
using System;
ref struct BorrowedReference
readonly ref struct BorrowedReference
{
public IntPtr Pointer;
public readonly IntPtr Pointer;
public bool IsNull => this.Pointer == IntPtr.Zero;

public PyObject ToPyObject()
Expand All @@ -13,13 +13,14 @@ public PyObject ToPyObject()
Runtime.XIncref(this.Pointer);
return new PyObject(this.Pointer);
}
}

static class BorrowedReferenceExtensions {
[Obsolete("Use overloads, that take BorrowedReference or NewReference")]
public static IntPtr DangerousGetAddress(this in BorrowedReference reference)
=> reference.IsNull() ? throw new NullReferenceException() : reference.Pointer;
public static bool IsNull(this in BorrowedReference reference)
=> reference.Pointer == IntPtr.Zero;
public IntPtr DangerousGetAddress()
Copy link
Copy Markdown
Member

@amos402 amos402 Feb 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use a property named Address can be more fit?
Why I have to be warned if I trying use the raw pointer, seems it doesn't make any sense. Or just don't expose the interface and use explicit operator IntPtr instead.

Copy link
Copy Markdown
Member Author

@lostmsu lostmsu Feb 23, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is modeled after SafeHandle class and its DangerousGetHandle method.
The whole point of introducing these references is to get rid of IntPtrs entirely. It should warn you against converting into IntPtr. Maybe Obsolete part is unnecessary as Dangerous sounds like a warning enough. I will remove Obsolete.

=> this.IsNull ? throw new NullReferenceException() : this.Pointer;

BorrowedReference(IntPtr pointer)
{
this.Pointer = pointer;
}
}
}