blob: 47797ed4c2157d4436cb26e16bb0004eea34de55 (
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
|
/*
* Copyright (c) 2024 Vaughn Nugent
*
* Library: VNLib
* Package: VNLib.Utils
* File: VnDisposeable.cs
*
* VnDisposeable.cs is part of VNLib.Utils which is part of the larger
* VNLib collection of libraries and utilities.
*
* VNLib.Utils is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published
* by the Free Software Foundation, either version 2 of the License,
* or (at your option) any later version.
*
* VNLib.Utils is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with VNLib.Utils. If not, see http://www.gnu.org/licenses/.
*/
using System;
using System.Runtime.CompilerServices;
namespace VNLib.Utils
{
/// <summary>
/// Provides a base class with abstract methods for for disposable objects, with disposed check method
/// </summary>
public abstract class VnDisposeable : IDisposable
{
///<inheritdoc/>
protected bool Disposed { get; private set; }
/// <summary>
/// When overriden in a child class, is responsible for freeing resources
/// </summary>
protected abstract void Free();
/// <summary>
/// Checks if the current object has been disposed. Method will be inlined where possible
/// </summary>
/// <exception cref="ObjectDisposedException"></exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected virtual void Check() => ObjectDisposedException.ThrowIf(Disposed, this);
/// <summary>
/// Sets the internal state to diposed without calling <see cref="Free"/> operation.
/// Usefull if another code-path performs the free operation independant of a dispose opreation.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected void SetDisposedState() => Disposed = true;
///<inheritdoc/>
protected virtual void Dispose(bool disposing)
{
if (!Disposed)
{
if (disposing)
{
//Call free method
Free();
}
Disposed = true;
}
}
//Finalizer is not needed here
///<inheritdoc/>
public void Dispose()
{
// Do not change this code. Put cleanup code in 'Dispose(bool disposing)' method
Dispose(disposing: true);
GC.SuppressFinalize(this);
}
}
}
|
