annotate foosdk/sdk/pfc/ptrholder.h @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 #pragma once
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3 // ptrholder_t<> : std::unique_ptr<> equivalent
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4 // Obsolete, use std::unique_ptr<> instead
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5 // Warning: release() deletes instead of letting go of ownership, contrary to std::unique_ptr<>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7 namespace pfc {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8 class releaser_delete {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 template<typename T> static void release(T* p_ptr) { delete p_ptr; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12 class releaser_delete_array {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14 template<typename T> static void release(T* p_ptr) { delete[] p_ptr; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 class releaser_free {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 static void release(void* p_ptr) { free(p_ptr); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21 //! Assumes t_freefunc to never throw exceptions.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 template<typename T, typename t_releaser = releaser_delete >
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23 class ptrholder_t {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 typedef ptrholder_t<T, t_releaser> t_self;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 inline ptrholder_t(T* p_ptr) : m_ptr(p_ptr) {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28 inline ptrholder_t() : m_ptr(NULL) {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 inline ~ptrholder_t() { t_releaser::release(m_ptr); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30 inline bool is_valid() const { return m_ptr != NULL; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31 inline bool is_empty() const { return m_ptr == NULL; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 inline T* operator->() const { return m_ptr; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33 inline T* get_ptr() const { return m_ptr; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34 inline void release() { t_releaser::release(replace_null_t(m_ptr));; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35 inline void attach(T* p_ptr) { release(); m_ptr = p_ptr; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36 inline const t_self& operator=(T* p_ptr) { set(p_ptr); return *this; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37 inline T* detach() { return pfc::replace_null_t(m_ptr); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38 inline T& operator*() const { return *m_ptr; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40 inline t_self& operator<<(t_self& p_source) { attach(p_source.detach()); return *this; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
41 inline t_self& operator>>(t_self& p_dest) { p_dest.attach(detach()); return *this; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
42
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
43 //deprecated
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
44 inline void set(T* p_ptr) { attach(p_ptr); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
45
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
46 ptrholder_t(t_self&& other) {m_ptr = other.detach(); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
47 const t_self& operator=(t_self&& other) { attach(other.detach()); return *this; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
48 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
49 ptrholder_t(const t_self&) = delete;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
50 const t_self& operator=(const t_self&) = delete;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
51
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
52 T* m_ptr;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
53 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
54
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
55 //avoid "void&" breakage
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
56 template<typename t_releaser>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
57 class ptrholder_t<void, t_releaser> {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
58 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
59 typedef void T;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
60 typedef ptrholder_t<T, t_releaser> t_self;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
61 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
62 inline ptrholder_t(T* p_ptr) : m_ptr(p_ptr) {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
63 inline ptrholder_t() : m_ptr(NULL) {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
64 inline ~ptrholder_t() { t_releaser::release(m_ptr); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
65 inline bool is_valid() const { return m_ptr != NULL; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
66 inline bool is_empty() const { return m_ptr == NULL; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
67 inline T* operator->() const { return m_ptr; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
68 inline T* get_ptr() const { return m_ptr; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
69 inline void release() { t_releaser::release(replace_null_t(m_ptr));; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
70 inline void attach(T* p_ptr) { release(); m_ptr = p_ptr; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
71 inline const t_self& operator=(T* p_ptr) { set(p_ptr); return *this; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
72 inline T* detach() { return pfc::replace_null_t(m_ptr); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
73
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
74 inline t_self& operator<<(t_self& p_source) { attach(p_source.detach()); return *this; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
75 inline t_self& operator>>(t_self& p_dest) { p_dest.attach(detach()); return *this; }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
76
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
77 //deprecated
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
78 inline void set(T* p_ptr) { attach(p_ptr); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
79 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
80 ptrholder_t(const t_self&) = delete;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
81 const t_self& operator=(const t_self&) = delete;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
82
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
83 T* m_ptr;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
84 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
85
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
86 }