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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
From cb9ff82efd82af8ae26b2aca4183928c74f7ef34 Mon Sep 17 00:00:00 2001
From: Dennis Bonke <admin@dennisbonke.com>
Date: Wed, 20 Dec 2023 16:22:29 +0100
Subject: [PATCH 05/25] libcamera: internal: Document the SharedMemObject class
Document the SharedMemObject class.
Signed-off-by: Dennis Bonke <admin@dennisbonke.com>
Signed-off-by: Hans de Goede <hdegoede@redhat.com>
Tested-by: Bryan O'Donoghue <bryan.odonoghue@linaro.org> # sc8280xp Lenovo x13s
Tested-by: Pavel Machek <pavel@ucw.cz>
---
.../libcamera/internal/shared_mem_object.h | 53 +++++++++++++++++++
1 file changed, 53 insertions(+)
diff --git a/include/libcamera/internal/shared_mem_object.h b/include/libcamera/internal/shared_mem_object.h
index bfb639ee..e862ce48 100644
--- a/include/libcamera/internal/shared_mem_object.h
+++ b/include/libcamera/internal/shared_mem_object.h
@@ -19,10 +19,20 @@
namespace libcamera {
+/**
+ * \class SharedMemObject
+ * \brief Helper class for shared memory allocations.
+ *
+ * Takes a template T which is used to indicate the
+ * data type of the object stored.
+ */
template<class T>
class SharedMemObject
{
public:
+ /**
+ * \brief The size of the object that is going to be stored here.
+ */
static constexpr std::size_t SIZE = sizeof(T);
SharedMemObject()
@@ -30,6 +40,11 @@ public:
{
}
+ /**
+ * \brief Contstructor for the SharedMemObject.
+ * \param[in] name The requested name.
+ * \param[in] args Any additional args.
+ */
template<class... Args>
SharedMemObject(const std::string &name, Args &&...args)
: name_(name), obj_(nullptr)
@@ -57,6 +72,10 @@ public:
obj_ = new (mem) T(std::forward<Args>(args)...);
}
+ /**
+ * \brief Move constructor for SharedMemObject.
+ * \param[in] rhs The object to move.
+ */
SharedMemObject(SharedMemObject<T> &&rhs)
{
this->name_ = std::move(rhs.name_);
@@ -76,6 +95,10 @@ public:
/* Make SharedMemObject non-copyable for now. */
LIBCAMERA_DISABLE_COPY(SharedMemObject)
+ /**
+ * \brief Operator= for SharedMemObject.
+ * \param[in] rhs The SharedMemObject object to take the data from.
+ */
SharedMemObject<T> &operator=(SharedMemObject<T> &&rhs)
{
this->name_ = std::move(rhs.name_);
@@ -85,31 +108,61 @@ public:
return *this;
}
+ /**
+ * \brief Operator-> for SharedMemObject.
+ *
+ * \return the object.
+ */
T *operator->()
{
return obj_;
}
+ /**
+ * \brief Operator-> for SharedMemObject.
+ *
+ * \return the object.
+ */
const T *operator->() const
{
return obj_;
}
+ /**
+ * \brief Operator* for SharedMemObject.
+ *
+ * \return the object.
+ */
T &operator*()
{
return *obj_;
}
+ /**
+ * \brief Operator* for SharedMemObject.
+ *
+ * \return the object.
+ */
const T &operator*() const
{
return *obj_;
}
+ /**
+ * \brief Gets the file descriptor for the underlaying storage file.
+ *
+ * \return the file descriptor.
+ */
const SharedFD &fd() const
{
return fd_;
}
+ /**
+ * \brief Operator bool() for SharedMemObject.
+ *
+ * \return true if the object is not null, false otherwise.
+ */
explicit operator bool() const
{
return !!obj_;
--
2.43.0
|
