Debian Codegraph @

src/base/dobject.cpp

raw
1 // SPDX-FileCopyrightText: 2015 - 2022 UnionTech Software Technology Co., Ltd.
2 //
3 // SPDX-License-Identifier: LGPL-3.0-or-later
4
5 #include "dobject.h"
6 #include "base/private/dobject_p.h"
7
8 DCORE_BEGIN_NAMESPACE
9
10 DObjectPrivate::DObjectPrivate(DObject *qq)
11 : q_ptr(qq)
12 {
13
14 }
15
16 DObjectPrivate::~DObjectPrivate()
17 {
18
19 }
20
21 /*!
22 \headerfile <dobject.h>
23 \inmodule dtkcore
24
25 \brief 一些宏的定义.
26 */
27
28 /*!
29 \class Dtk::Core::DObject
30 \inmodule dtkcore
31 \brief deepin-tool-kit 中所有公开类的祖先类.
32
33 通过和 D_DECLARE_PRIVATE 、D_DECLARE_PUBLIC
34 等宏的配合方便派生类中实现 D-Point 结构。虽然 QObject 中已经有了这样的实现结构,但是没有
35 办法在不使用 Qt 私有模块的情况下,在 DTK 库中达到同样的目的。D-Point 结构由“公共接口类”
36 和“私有数据类”两部分组成,在 DTK 中,DObjectPrivate 是所有数据类的祖先类。在这种结构下,
37 只有 DObject 这个基类中定了一个指向于私有数据类的对象指针,派生类中不会也不应该再定义任何
38 成员变量,派生类中需要添加数据成员时,可以继承 DObjectPrivate,将新的成员变量放到私有类中
39
40 例子:
41
42 a.h
43 \code
44 class APrivate;
45 class A : public DObject
46 {
47 D_DECLARE_PRIVATE(A)
48 public:
49 A();
50 int test() const;
51
52 protected:
53 A(APrivate &dd, DObject *parent = nullptr);
54 };
55 \endcode
56 a.cpp
57 \code
58 class APrivate : public DObjectPrivate
59 {
60 public:
61 APrivate(A *qq)
62 : DObjectPrivate(qq)
63 {
64
65 }
66
67 D_DECLARE_PUBLIC(A)
68 // 此处添加数据成员
69 int data;
70 };
71
72 A::A()
73 : DObject(*new APrivate(this))
74 {
75
76 }
77
78 int test() const
79 {
80 D_D(A);
81
82 return d->data;
83 }
84
85 A::A(APrivate &dd, DObject *parent)
86 : DObject(dd, parent)
87 {
88
89 }
90 \endcode
91 一般来讲,DObject 只会用在 DTK 库中定义的类,对于使用 DTK 库的应用程序来说不用关心它的存在
92 \sa {https://wiki.qt.io/D-Pointer/zh}{类的 D-Point 结构}
93 */
94
95 /*!
96 \brief 只有在不需要数据成员的派生类中才会使用
97 \a parent 父类指针
98 */
99 DObject::DObject(DObject * /*parent = nullptr*/)
100 {
101
102 }
103
104 /*!
105 \brief 在派生类中比较常用的构造函数
106 \a dd 私有类对象
107 */
108 DObject::DObject(DObjectPrivate &dd, DObject * /*parent = nullptr*/):
109 d_d_ptr(&dd)
110 {
111
112 }
113
114 DObject::~DObject()
115 {
116
117 }
118
119 /*!
120 \macro D_DECLARE_PRIVATE(Class)
121 \relates Dtk::Core::DObject
122
123 \brief 这个宏一定要放到类的私有区域,它定义了 d_func() 这个函数用于返回私有类的对象,
124 这个对象只应该在类的内部使用,另外将私有类声明为公开类的友元类。
125 \a Class 公开类的类名
126 \sa D_DECLARE_PUBLIC D_D D_DC
127 */
128
129 /*!
130 \macro D_DECLARE_PUBLIC(Class)
131 \relates Dtk::Core::DObject
132
133 \brief 这个宏用于私有类中,它定义了 q_func() 这个函数用于返回公开类的对象,另外将公开类
134 声明为私有类的友元类。
135 \a Class 公开类的类名
136 \sa D_DECLARE_PRIVATE D_Q D_QC
137 */
138
139 /*!
140 \macro D_D(Class)
141 \relates Dtk::Core::DObject
142
143 \brief 这个宏用于公开类中,它定义了一个名字为 d 的变量存储 d_func() 的返回值。用于在公开
144 类中需要访问私有类的数据成员的函数中。
145 \a Class 公开类的类名
146 \sa D_DECLARE_PRIVATE D_DC
147 */
148
149 /*!
150 \macro D_DC(Class)
151 \relates Dtk::Core::DObject
152
153 \brief 同 D_D,用在公开类加了 const 修饰符的成员函数中。
154 \a Class 公开类的类名
155 \sa D_DECLARE_PRIVATE D_D
156 */
157
158 /*!
159 \macro D_Q(Class)
160 \relates Dtk::Core::DObject
161
162 \brief 这个宏用于私有类中,它定义了一个名字为 q 的变量存储 q_func() 的返回值。用于在私有
163 类中需要调用公开类的成员函数时。
164 \a Class 公开类的类名
165 \sa D_DECLARE_PUBLIC D_QC
166 */
167
168 /*!
169 \macro D_QC(Class)
170 \relates Dtk::Core::DObject
171
172 \brief 同 D_Q,用在私有类加了 const 修饰符的成员函数中。
173 \a Class 公开类的类名
174 \sa D_DECLARE_PUBLIC D_Q
175 */
176
177 /*!
178 \macro D_PRIVATE_SLOT(Func)
179 \relates Dtk::Core::DObject
180
181 \brief 同 Q_PRIVATE_SLOT,用在继承了 QObject 的公开类中,在公开类中定一个槽函数,且函数
182 必须在私有类中有实现。用这个方式定义的槽函数无法被直接调用,只能用于 QObject::connect
183 使用 SIGNAL 和 SLOT 的方式连接信号,或者使用 QMetaObject::invokeMethod 调用。
184 一般来讲,这个槽函数应该只在类内部使用,外界不应该通过任何方式来调用它。
185
186 例子:
187
188 a.h
189 \code
190 class APrivate;
191 class A : public DObject
192 {
193 D_DECLARE_PRIVATE(A)
194 public:
195 A();
196
197 protected:
198 A(APrivate &dd, DObject *parent = nullptr);
199
200 private:
201 D_PRIVATE_SLOT(void _q_testSlot() const)
202 };
203 \endcode
204 a.cpp
205 \code
206 class APrivate : public DObjectPrivate
207 {
208 public:
209 D_DECLARE_PUBLIC(A)
210
211 APrivate(A *qq)
212 : DObjectPrivate(qq)
213 {
214 QTimer *timer = new QTimer();
215 QObject::connect(timer, SIGNAL(timeout()), qq, SLOT(_q_testSlot()));
216 timer->start(1000);
217 }
218
219 void _q_testSlot() const
220 {
221 qDebug() << "slot";
222 }
223 };
224
225 A::A()
226 : DObject(*new APrivate(this))
227 {
228
229 }
230
231 A::A(APrivate &dd, DObject *parent)
232 : DObject(dd, parent)
233 {
234
235 }
236
237 \#include "moc_a.cpp"
238 \endcode
239 \a Func 槽函数的完整签名
240 \note 添加或更新私有槽之后需要重新手动调用 qmake
241 \sa D_DECLARE_PUBLIC D_Q
242 */
243
244 DCORE_END_NAMESPACE