1
=== modified file 'CTestCustom.cmake.in'
2
--- CTestCustom.cmake.in	2014-07-25 05:54:44 +0000
3
+++ CTestCustom.cmake.in	2015-02-27 03:36:41 +0000
4
@@ -12,8 +12,14 @@
5
12
    stand-alone-unity-scopes-headers
12
    stand-alone-unity-scopes-headers
6
13
    stand-alone-unity-scopes-internal-headers
13
    stand-alone-unity-scopes-internal-headers
7
14
    stand-alone-unity-scopes-testing-headers
14
    stand-alone-unity-scopes-testing-headers
8
15
    stand-alone-unity-scopes-utility-headers
9
16
    stand-alone-unity-scopes-utility-internal-headers
10
17
    stand-alone-unity-scopes-qt-headers
11
18
    stand-alone-unity-scopes-qt-internal-headers
12
15
    clean-public-unity-scopes-headers
19
    clean-public-unity-scopes-headers
13
16
    clean-public-unity-scopes-testing-headers
20
    clean-public-unity-scopes-testing-headers
14
21
    clean-public-unity-scopes-utility-headers
15
22
    clean-public-unity-scopes-qt-headers
16
17
    IsolatedScopeBenchmark                      # Runs too slowly and crashes valgrind 3.10.0 with g++-4.9
23
    IsolatedScopeBenchmark                      # Runs too slowly and crashes valgrind 3.10.0 with g++-4.9
17
18
    copyright
24
    copyright
18
19
    whitespace)
25
    whitespace)
19
20
26
20
=== modified file 'HACKING'
21
--- HACKING	2015-01-27 09:38:24 +0000
22
+++ HACKING	2015-02-27 03:36:41 +0000
23
@@ -49,6 +49,31 @@
24
49
49
25
50
    $ make valgrind
50
    $ make valgrind
26
51
51
27
52
It doesn't make sense for some tests to run them with valgrind. For
28
53
example, the header compilation tests don't need valgrind because
29
54
we'd just be testing that Python doesn't leak. There are also some
30
55
tests that run too slow and time out under valgrind and, occasionally,
31
56
valgrind crashes for a particular test.
32
57
33
58
There are two ways to suppress tests:
34
59
35
60
You can add a test name to CTestCustom.cmake.in to suppress that
36
61
test completely. That makes sense for the header compilation tests,
37
62
for example.
38
63
39
64
If a specific test case in a test program causes a valgrind problem,
40
65
you can selectively disable a section of code like this:
41
66
42
67
    #include <valgrind/valgrind.h>
43
68
44
69
    if (!RUNNING_ON_VALGRIND)
45
70
    {
46
71
        // Code here crashes valgrind...
47
72
    }
48
73
49
74
That way, the test will still be run as part of the normal "make test"
50
75
target, but will be ommitted when running "make valgrind".
51
76
52
52
Coverage
77
Coverage
53
53
--------
78
--------
54
54
79
55
@@ -143,6 +168,17 @@
56
143
168
57
144
    $ TSAN_OPTIONS="suppressions=../tsan-suppress" make test
169
    $ TSAN_OPTIONS="suppressions=../tsan-suppress" make test
58
145
170
59
171
If a test runs too slowly under address sanitizer, you can
60
172
hide a section of code from address sanitzer with:
61
173
62
174
#if defined(__has_feature)
63
175
    #if !__has_feature(address_sanitizer)
64
176
65
177
    // Code here takes forever under address sanitizer...
66
178
67
179
    #endif
68
180
#endif
69
181
70
146
Updating symbols file
182
Updating symbols file
71
147
---------------------
183
---------------------
72
148
184
73
149
185
74
=== modified file 'debian/libunity-scopes-qt.symbols'
75
--- debian/libunity-scopes-qt.symbols	2015-02-27 03:36:41 +0000
76
+++ debian/libunity-scopes-qt.symbols	2015-02-27 03:36:41 +0000
77
@@ -191,7 +191,6 @@
78
191
 (c++)"unity::scopes::qt::QResult::operator=(unity::scopes::qt::QResult&&)@Base" 0.6.13+15.04.20150205.1
191
 (c++)"unity::scopes::qt::QResult::operator=(unity::scopes::qt::QResult&&)@Base" 0.6.13+15.04.20150205.1
79
192
 (c++)"unity::scopes::qt::QResult::operator=(unity::scopes::qt::QResult const&)@Base" 0.6.13+15.04.20150205.1
192
 (c++)"unity::scopes::qt::QResult::operator=(unity::scopes::qt::QResult const&)@Base" 0.6.13+15.04.20150205.1
80
193
 (c++)"unity::scopes::qt::QResult::~QResult()@Base" 0.6.13+15.04.20150205.1
193
 (c++)"unity::scopes::qt::QResult::~QResult()@Base" 0.6.13+15.04.20150205.1
81
194
 (c++)"unity::scopes::qt::QResult::QResult()@Base" 0.6.13+15.04.20150205.1
82
195
 (c++)"unity::scopes::qt::QResult::QResult(QMap<QString, QVariant> const&)@Base" 0.6.13+15.04.20150205.1
194
 (c++)"unity::scopes::qt::QResult::QResult(QMap<QString, QVariant> const&)@Base" 0.6.13+15.04.20150205.1
83
196
 (c++)"unity::scopes::qt::QResult::QResult(unity::scopes::qt::internal::QResultImpl*)@Base" 0.6.13+15.04.20150205.1
195
 (c++)"unity::scopes::qt::QResult::QResult(unity::scopes::qt::internal::QResultImpl*)@Base" 0.6.13+15.04.20150205.1
84
197
 (c++)"unity::scopes::qt::QResult::QResult(unity::scopes::qt::QResult&&)@Base" 0.6.13+15.04.20150205.1
196
 (c++)"unity::scopes::qt::QResult::QResult(unity::scopes::qt::QResult&&)@Base" 0.6.13+15.04.20150205.1
85
198
197
86
=== modified file 'include/unity/scopes/ScopeBase.h'
87
--- include/unity/scopes/ScopeBase.h	2015-01-26 08:10:59 +0000
88
+++ include/unity/scopes/ScopeBase.h	2015-02-27 03:36:41 +0000
89
@@ -104,8 +104,7 @@
90
104
 - a create function that must return a pointer to the derived instance
104
 - a create function that must return a pointer to the derived instance
91
105
 - a destroy function that is passed the pointer returned by the create function
105
 - a destroy function that is passed the pointer returned by the create function
92
106
106
95
107
Typically, the create and destroy functions will simply call `new` and `delete`, respectively. (However,
107
Typically, the create and destroy functions will simply call `new` and `delete`, respectively.
94
108
there is no requirement that the derived class instance must be heap-allocated.)
96
109
If the create function throws an exception, the destroy function will not be called. If the create function returns
108
If the create function throws an exception, the destroy function will not be called. If the create function returns
97
110
NULL, the destroy function _will_ be called with NULL as its argument.
109
NULL, the destroy function _will_ be called with NULL as its argument.
98
111
110
99
@@ -116,13 +115,13 @@
100
116
unity::scopes::ScopeBase*
115
unity::scopes::ScopeBase*
101
117
UNITY_SCOPE_CREATE_FUNCTION()
116
UNITY_SCOPE_CREATE_FUNCTION()
102
118
{
117
{
104
119
    return new MyScope; // Example only, heap-allocation is not mandatory
118
    return new MyScope;
105
120
}
119
}
106
121
120
107
122
void
121
void
108
123
UNITY_SCOPE_DESTROY_FUNCTION(unity::scopes::ScopeBase* scope)
122
UNITY_SCOPE_DESTROY_FUNCTION(unity::scopes::ScopeBase* scope)
109
124
{
123
{
111
125
    delete scope;       // Example only, heap-allocation is not mandatory
124
    delete scope;
112
126
}
125
}
113
127
~~~
126
~~~
114
128
127
115
@@ -376,8 +375,7 @@
116
376
/**
375
/**
117
377
\brief The function called by the scopes run time to initialize the scope.
376
\brief The function called by the scopes run time to initialize the scope.
118
378
It must return a pointer to an instance derived from `ScopeBase`. The returned
377
It must return a pointer to an instance derived from `ScopeBase`. The returned
121
379
instance need not be heap-allocated, but must remain in scope until the
378
instance must remain in scope until the destroy function is called by the scopes run time.
120
380
destroy function is called by the scopes run time.
122
381
379
123
382
If this function throws an exception, the destroy function will _not_ be called. If this function returns NULL,
380
If this function throws an exception, the destroy function will _not_ be called. If this function returns NULL,
124
383
the destroy function _will_ be called with NULL as its argument.
381
the destroy function _will_ be called with NULL as its argument.
125
384
382
126
=== modified file 'include/unity/scopes/qt/QActionMetadata.h'
127
--- include/unity/scopes/qt/QActionMetadata.h	2015-02-27 03:36:41 +0000
128
+++ include/unity/scopes/qt/QActionMetadata.h	2015-02-27 03:36:41 +0000
129
@@ -140,7 +140,6 @@
130
140
    QActionMetadata(internal::QActionMetadataImpl* impl);
140
    QActionMetadata(internal::QActionMetadataImpl* impl);
131
141
141
132
142
    std::unique_ptr<internal::QActionMetadataImpl> p;
142
    std::unique_ptr<internal::QActionMetadataImpl> p;
133
143
    friend class internal::QActionMetadataImpl;
134
144
    friend class internal::QPreviewQueryBaseImpl;
143
    friend class internal::QPreviewQueryBaseImpl;
135
145
    friend class QPreviewQueryBaseAPI;
144
    friend class QPreviewQueryBaseAPI;
136
146
    /// @endcond
145
    /// @endcond
137
147
146
138
=== modified file 'include/unity/scopes/qt/QPreviewQueryBase.h'
139
--- include/unity/scopes/qt/QPreviewQueryBase.h	2015-02-27 03:36:41 +0000
140
+++ include/unity/scopes/qt/QPreviewQueryBase.h	2015-02-27 03:36:41 +0000
141
@@ -128,7 +128,6 @@
142
128
    void init(QPreviewQueryBaseAPI* query_api);
128
    void init(QPreviewQueryBaseAPI* query_api);
143
129
129
144
130
    std::unique_ptr<internal::QPreviewQueryBaseImpl> p;
130
    std::unique_ptr<internal::QPreviewQueryBaseImpl> p;
145
131
    friend class internal::QPreviewQueryBaseImpl;
146
132
    friend class QPreviewQueryBaseAPI;
131
    friend class QPreviewQueryBaseAPI;
147
133
    /// @endcond
132
    /// @endcond
148
134
};
133
};
149
135
134
150
=== modified file 'include/unity/scopes/qt/QPreviewReply.h'
151
--- include/unity/scopes/qt/QPreviewReply.h	2015-02-27 03:36:41 +0000
152
+++ include/unity/scopes/qt/QPreviewReply.h	2015-02-27 03:36:41 +0000
153
@@ -98,7 +98,6 @@
154
98
98
155
99
private:
99
private:
156
100
    std::unique_ptr<internal::QPreviewReplyImpl> p;
100
    std::unique_ptr<internal::QPreviewReplyImpl> p;
157
101
    friend class internal::QPreviewReplyImpl;
158
102
    friend class QPreviewQueryBaseAPI;
101
    friend class QPreviewQueryBaseAPI;
159
103
    /// @endcond
102
    /// @endcond
160
104
};
103
};
161
105
104
162
=== modified file 'include/unity/scopes/qt/QResult.h'
163
--- include/unity/scopes/qt/QResult.h	2015-02-27 03:36:41 +0000
164
+++ include/unity/scopes/qt/QResult.h	2015-02-27 03:36:41 +0000
165
@@ -67,7 +67,6 @@
166
67
    UNITY_DEFINES_PTRS(QResult);
67
    UNITY_DEFINES_PTRS(QResult);
167
68
    /// @endcond
68
    /// @endcond
168
69
69
169
70
    QResult();
170
71
    /**@name Copy and assignment
70
    /**@name Copy and assignment
171
72
    Copy and assignment (move and non-move versions) have the usual value semantics.
71
    Copy and assignment (move and non-move versions) have the usual value semantics.
172
73
    */
72
    */
173
74
73
174
=== modified file 'include/unity/scopes/qt/QScopeBase.h'
175
--- include/unity/scopes/qt/QScopeBase.h	2015-02-27 03:36:41 +0000
176
+++ include/unity/scopes/qt/QScopeBase.h	2015-02-27 03:36:41 +0000
177
@@ -54,7 +54,7 @@
178
54
\brief Base class for a scope implementation.
54
\brief Base class for a scope implementation.
179
55
55
180
56
Scopes are accessed by the scopes run time as a shared library (one library per scope).
56
Scopes are accessed by the scopes run time as a shared library (one library per scope).
182
57
Each scope must implement a class that derives from ScopeBase, for example:
57
Each scope must implement a class that derives from QScopeBase, for example:
183
58
58
184
59
~~~
59
~~~
185
60
#include <unity/scopes/qt/QScopeBase.h>
60
#include <unity/scopes/qt/QScopeBase.h>
186
@@ -65,9 +65,8 @@
187
65
    MyScope();
65
    MyScope();
188
66
    virtual ~MyScope();
66
    virtual ~MyScope();
189
67
67
191
68
    virtual void start(QString const& scope_id);   // Optional
68
    virtual void start(QString const& scope_id);       // Optional
192
69
    virtual void stop();                               // Optional
69
    virtual void stop();                               // Optional
193
70
    virtual void run();                                // Optional
194
71
    // ...
70
    // ...
195
72
};
71
};
196
73
~~~
72
~~~
197
@@ -76,8 +75,6 @@
198
76
 - a create function that must return a pointer to the derived instance
75
 - a create function that must return a pointer to the derived instance
199
77
 - a destroy function that is passed the pointer returned by the create function
76
 - a destroy function that is passed the pointer returned by the create function
200
78
77
201
79
Typically, the create and destroy functions will simply call `new` and `delete`, respectively. (However,
202
80
there is no requirement that the derived class instance must be heap-allocated.)
203
81
If the create function throws an exception, the destroy function will not be called. If the create function returns
78
If the create function throws an exception, the destroy function will not be called. If the create function returns
204
82
NULL, the destroy function _will_ be called with NULL as its argument.
79
NULL, the destroy function _will_ be called with NULL as its argument.
205
83
80
206
@@ -86,8 +83,9 @@
207
86
83
208
87
~~~
84
~~~
209
88
85
212
89
// You must provide a function that creates your own scope
86
// You must provide a function that creates your scope on the heap and
213
90
// That function must have no parameters and return a pointer to QScopeBase
87
// pass this function to the QScopeBaseAPI constructor.
214
88
215
91
unity::scopes::qt::QScopeBase *create_my_scope()
89
unity::scopes::qt::QScopeBase *create_my_scope()
216
92
{
90
{
217
93
    return new MyScope();
91
    return new MyScope();
218
@@ -96,23 +94,23 @@
219
96
unity::scopes::ScopeBase*
94
unity::scopes::ScopeBase*
220
97
UNITY_SCOPE_CREATE_FUNCTION()
95
UNITY_SCOPE_CREATE_FUNCTION()
221
98
{
96
{
224
99
    // Initialize scope. This line is mandatory, you should pass your creation scope function to
97
    // You must return a dynamically allocated QScopeBaseAPI instance here.
225
100
    // the class QScopeBaseAPI, which will instantiate your class in the correct Qt Thread.
98
    // In turn, that instance calls your creation function to instantiate
226
99
    // your scope in the correct Qt thread.
227
101
    return new QScopeBaseAPI(create_my_scope);
100
    return new QScopeBaseAPI(create_my_scope);
228
102
}
101
}
229
103
102
230
103
// The runtime, once it has stopped your scope, calls the destroy function.
231
104
232
104
void
105
void
233
105
UNITY_SCOPE_DESTROY_FUNCTION(unity::scopes::ScopeBase* scope)
106
UNITY_SCOPE_DESTROY_FUNCTION(unity::scopes::ScopeBase* scope)
234
106
{
107
{
235
108
    delete scope;
236
107
}
109
}
237
108
~~~
110
~~~
238
109
111
239
110
After the scopes run time has obtained a pointer to the class instance from the create function, it calls start(),
112
After the scopes run time has obtained a pointer to the class instance from the create function, it calls start(),
245
111
which allows the scope to initialize itself. This is followed by a call to run().
113
which allows the scope to initialize itself.
241
112
All calls to the methods of this class will be done from the main QThread.
242
113
243
114
The scope implementation, if it does not return from run(), is expected to return from run() in response to a
244
115
call to stop() in a timely manner.
246
116
*/
114
*/
247
117
class QScopeBase : public QObject
115
class QScopeBase : public QObject
248
118
{
116
{
249
@@ -149,7 +147,6 @@
250
149
147
251
150
private:
148
private:
252
151
    std::unique_ptr<internal::QScopeBaseImpl> p;
149
    std::unique_ptr<internal::QScopeBaseImpl> p;
253
152
    friend class internal::QScopeBaseImpl;
254
153
};
150
};
255
154
151
256
155
}  // namespace qt
152
}  // namespace qt
257
156
153
258
=== modified file 'include/unity/scopes/qt/QScopeBaseAPI.h'
259
--- include/unity/scopes/qt/QScopeBaseAPI.h	2015-02-27 03:36:41 +0000
260
+++ include/unity/scopes/qt/QScopeBaseAPI.h	2015-02-27 03:36:41 +0000
261
@@ -52,10 +52,6 @@
262
52
/**
52
/**
263
53
 * Defines the lifecycle of scope plugin, and acts as a factory
53
 * Defines the lifecycle of scope plugin, and acts as a factory
264
54
 * for Query and Preview objects.
54
 * for Query and Preview objects.
265
55
 *
266
56
 * Note that the #preview and #search methods are each called on
267
57
 * different threads, so some form of interlocking is required
268
58
 * if shared data structures are used.
269
59
 */
55
 */
270
60
class QScopeBaseAPI : public unity::scopes::ScopeBase
56
class QScopeBaseAPI : public unity::scopes::ScopeBase
271
61
{
57
{
272
@@ -109,7 +105,6 @@
273
109
private:
105
private:
274
110
    /// @cond
106
    /// @cond
275
111
    std::unique_ptr<internal::QScopeBaseAPIImpl> p;
107
    std::unique_ptr<internal::QScopeBaseAPIImpl> p;
276
112
    friend class internal::QScopeBaseAPIImpl;
277
113
    /// @endcond
108
    /// @endcond
278
114
};
109
};
279
115
110
280
116
111
281
=== modified file 'include/unity/scopes/qt/QSearchMetadata.h'
282
--- include/unity/scopes/qt/QSearchMetadata.h	2015-02-27 03:36:41 +0000
283
+++ include/unity/scopes/qt/QSearchMetadata.h	2015-02-27 03:36:41 +0000
284
@@ -164,7 +164,6 @@
285
164
private:
164
private:
286
165
    /// @cond
165
    /// @cond
287
166
    std::unique_ptr<internal::QSearchMetadataImpl> p;
166
    std::unique_ptr<internal::QSearchMetadataImpl> p;
288
167
    friend class internal::QSearchMetadataImpl;
289
168
    /// @endcond
167
    /// @endcond
290
169
};
168
};
291
170
169
292
171
170
293
=== modified file 'include/unity/scopes/qt/QSearchQueryBase.h'
294
--- include/unity/scopes/qt/QSearchQueryBase.h	2015-02-27 03:36:41 +0000
295
+++ include/unity/scopes/qt/QSearchQueryBase.h	2015-02-27 03:36:41 +0000
296
@@ -156,7 +156,6 @@
297
156
    void init(QSearchQueryBaseAPI* query_api);
156
    void init(QSearchQueryBaseAPI* query_api);
298
157
157
299
158
    std::unique_ptr<internal::QSearchQueryBaseImpl> p;
158
    std::unique_ptr<internal::QSearchQueryBaseImpl> p;
300
159
    friend class internal::QSearchQueryBaseImpl;
301
160
    friend class QSearchQueryBaseAPI;
159
    friend class QSearchQueryBaseAPI;
302
161
    ///@endcond
160
    ///@endcond
303
162
};
161
};
304
163
162
305
=== modified file 'include/unity/scopes/qt/QSearchReply.h'
306
--- include/unity/scopes/qt/QSearchReply.h	2015-02-27 03:36:41 +0000
307
+++ include/unity/scopes/qt/QSearchReply.h	2015-02-27 03:36:41 +0000
308
@@ -157,7 +157,6 @@
309
157
    QSearchReply(unity::scopes::SearchReplyProxy& reply, QObject* parent = 0);
157
    QSearchReply(unity::scopes::SearchReplyProxy& reply, QObject* parent = 0);
310
158
158
311
159
    std::unique_ptr<internal::QSearchReplyImpl> p;
159
    std::unique_ptr<internal::QSearchReplyImpl> p;
312
160
    friend class internal::QSearchReplyImpl;
313
161
    friend class QSearchQueryBaseAPI;
160
    friend class QSearchQueryBaseAPI;
314
162
};
161
};
315
163
162
316
164
163
317
=== modified file 'include/unity/scopes/qt/internal/QActionMetadataImpl.h'
318
--- include/unity/scopes/qt/internal/QActionMetadataImpl.h	2015-02-06 00:12:18 +0000
319
+++ include/unity/scopes/qt/internal/QActionMetadataImpl.h	2015-02-27 03:36:41 +0000
320
@@ -43,92 +43,26 @@
321
43
43
322
44
class QPreviewQueryBaseImpl;
44
class QPreviewQueryBaseImpl;
323
45
45
324
46
/**
325
47
\brief Metadata passed to scopes for preview and activation.
326
48
\see unity::scopes::ScopeBase::preview, unity::scopes::ScopeBase::activate, unity::scopes::ScopeBase::perform_action
327
49
*/
328
50
class QActionMetadataImpl
46
class QActionMetadataImpl
329
51
{
47
{
330
52
public:
48
public:
331
53
    /// @cond
332
54
    UNITY_DEFINES_PTRS(QActionMetadataImpl);
49
    UNITY_DEFINES_PTRS(QActionMetadataImpl);
333
55
50
334
51
    QActionMetadataImpl(QString const& locale, QString const& form_factor);
335
56
    ~QActionMetadataImpl();
52
    ~QActionMetadataImpl();
361
57
    /// @endcond
53
337
58
338
59
    /**
339
60
    \brief Create ActionMetadata with the given locale and form factor.
340
61
    \param locale locale string, eg. en_EN
341
62
    \param form_factor form factor name, e.g. phone, desktop, phone-version etc.
342
63
    */
343
64
    QActionMetadataImpl(QString const& locale, QString const& form_factor);
344
65
345
66
    /**
346
67
     \brief Attach arbitrary data to this ActionMetadata.
347
68
     \param data The data value to attach.
348
69
     */
349
70
    void set_scope_data(QVariant const& data);
350
71
351
72
    /**
352
73
     \brief Get data attached to this ActionMetadata.
353
74
     \return The attached data, or QVariant::null.
354
75
     */
355
76
    QVariant scope_data() const;
356
77
357
78
    /**@name Copy and assignment
358
79
    Copy and assignment operators (move and non-move versions) have the usual value semantics.
359
80
    */
360
81
    //{@
362
82
    QActionMetadataImpl(QActionMetadataImpl const& other);
54
    QActionMetadataImpl(QActionMetadataImpl const& other);
363
83
    QActionMetadataImpl(QActionMetadataImpl&&);
55
    QActionMetadataImpl(QActionMetadataImpl&&);
364
84
56
365
85
    QActionMetadataImpl& operator=(QActionMetadataImpl const& other);
57
    QActionMetadataImpl& operator=(QActionMetadataImpl const& other);
366
86
    QActionMetadataImpl& operator=(QActionMetadataImpl&&);
58
    QActionMetadataImpl& operator=(QActionMetadataImpl&&);
375
87
    //@}
59
376
88
60
    void set_scope_data(QVariant const& data);
377
89
    /**
61
    QVariant scope_data() const;
370
90
    \brief Sets a hint.
371
91
372
92
    \param key The name of the hint.
373
93
    \param value Hint value
374
94
    */
378
95
    void set_hint(QString const& key, QVariant const& value);
62
    void set_hint(QString const& key, QVariant const& value);
379
96
380
97
    /**
381
98
    \brief Get all hints.
382
99
383
100
    \return Hints dictionary.
384
101
    \throws unity::NotFoundException if no hints are available.
385
102
    */
386
103
    QVariantMap hints() const;
63
    QVariantMap hints() const;
387
104
388
105
    /**
389
106
    \brief Check if this SearchMetadata has a hint.
390
107
    \param key The hint name.
391
108
    \return True if the hint is set.QScopeVariant
392
109
    */
393
110
    bool contains_hint(QString const& key) const;
64
    bool contains_hint(QString const& key) const;
394
111
395
112
    /**
396
113
    \brief Returns a reference to a hint.
397
114
398
115
    This method can be used to read or set hints. Setting a value of an existing hint overwrites
399
116
    its previous value.
400
117
    Referencing a non-existing hint automatically creates it with a default value of QVariant::Type::Null.
401
118
    \param key The name of the hint.
402
119
    \return A reference to the hint.
403
120
    */
404
121
    QScopeVariant& operator[](QString const& key);
65
    QScopeVariant& operator[](QString const& key);
405
122
406
123
    /**
407
124
    \brief Returns a const reference to a hint.
408
125
409
126
    This method can be used for read-only access to hints.
410
127
    Referencing a non-existing hint throws unity::InvalidArgumentException.
411
128
    \param key The name of the hint.
412
129
    \return A const reference to the hint.
413
130
    \throws unity::NotFoundException if no hint with the given name exists.
414
131
    */
415
132
    QVariant const& value(QString const& key) const;
66
    QVariant const& value(QString const& key) const;
416
133
67
417
134
private:
68
private:
418
135
69
419
=== modified file 'include/unity/scopes/qt/internal/QCategorisedResultImpl.h'
420
--- include/unity/scopes/qt/internal/QCategorisedResultImpl.h	2015-01-20 13:59:36 +0000
421
+++ include/unity/scopes/qt/internal/QCategorisedResultImpl.h	2015-02-27 03:36:41 +0000
422
@@ -48,37 +48,16 @@
423
48
class QCategorisedResultImpl : public QResultImpl
48
class QCategorisedResultImpl : public QResultImpl
424
49
{
49
{
425
50
public:
50
public:
426
51
    /// @cond
427
52
    UNITY_DEFINES_PTRS(QCategorisedResultImpl);
51
    UNITY_DEFINES_PTRS(QCategorisedResultImpl);
434
53
    /// @endcond
52
429
54
    /**
430
55
    \brief Creates a CategorisedResult with given category,
431
56
    with all base attributes initially empty.
432
57
    \param category The category for the result.
433
58
    */
435
59
    explicit QCategorisedResultImpl(QCategory::SCPtr category);
53
    explicit QCategorisedResultImpl(QCategory::SCPtr category);
436
60
54
437
61
    /**@name Copy and assignment
438
62
    Copy and assignment operators (move and non-move versions) have the usual value semantics.
439
63
    */
440
64
    //{@
441
65
    QCategorisedResultImpl(QCategorisedResultImpl const& other);
55
    QCategorisedResultImpl(QCategorisedResultImpl const& other);
442
66
    QCategorisedResultImpl& operator=(QCategorisedResultImpl const& other);
56
    QCategorisedResultImpl& operator=(QCategorisedResultImpl const& other);
443
67
    QCategorisedResultImpl(QCategorisedResultImpl&&);
57
    QCategorisedResultImpl(QCategorisedResultImpl&&);
444
68
    QCategorisedResultImpl& operator=(QCategorisedResultImpl&&);
58
    QCategorisedResultImpl& operator=(QCategorisedResultImpl&&);
445
69
    //@}
446
70
59
447
71
    /**
448
72
    \brief Updates the category of this result.
449
73
    \param category The category for the result.
450
74
    */
451
75
    void set_category(QCategory::SCPtr category);
60
    void set_category(QCategory::SCPtr category);
452
76
453
77
    /**
454
78
    \brief Return category of this result.
455
79
    Get the category instance this result belongs to.
456
80
    \return The category instance.
457
81
    */
458
82
    QCategory::SCPtr category() const;
61
    QCategory::SCPtr category() const;
459
83
62
460
84
private:
63
private:
461
85
64
462
=== modified file 'include/unity/scopes/qt/internal/QCategoryImpl.h'
463
--- include/unity/scopes/qt/internal/QCategoryImpl.h	2015-02-06 00:12:18 +0000
464
+++ include/unity/scopes/qt/internal/QCategoryImpl.h	2015-02-27 03:36:41 +0000
465
@@ -47,46 +47,19 @@
466
47
class QCategoryImpl
47
class QCategoryImpl
467
48
{
48
{
468
49
public:
49
public:
469
50
    /// @cond
470
51
    NONCOPYABLE(QCategoryImpl);
50
    NONCOPYABLE(QCategoryImpl);
471
52
    UNITY_DEFINES_PTRS(QCategoryImpl);
51
    UNITY_DEFINES_PTRS(QCategoryImpl);
472
53
52
473
54
    QCategoryImpl(unity::scopes::Category::SCPtr category);
53
    QCategoryImpl(unity::scopes::Category::SCPtr category);
474
55
54
475
56
    virtual ~QCategoryImpl();
55
    virtual ~QCategoryImpl();
476
57
    /// @endcond
477
58
56
478
59
    /**
479
60
     \brief Get identifier of this Category
480
61
     \return The category identifier.
481
62
    */
482
63
    QString id() const;
57
    QString id() const;
483
64
484
65
    /**
485
66
     \brief Get title of this Category
486
67
     \return The category title.
487
68
    */
488
69
    QString title() const;
58
    QString title() const;
489
70
490
71
    /**
491
72
     \brief Get icon of this Category
492
73
     \return The category icon.
493
74
    */
494
75
    QString icon() const;
59
    QString icon() const;
495
76
496
77
    /**
497
78
     \brief Query to perform when this category is expanded
498
79
     \return The expansion query or nullptr.
499
80
    */
500
81
    CannedQuery::SCPtr query() const;
60
    CannedQuery::SCPtr query() const;
501
82
502
83
    /**
503
84
     \brief Get renderer template of this Category
504
85
     \return The category renderer template.
505
86
     */
506
87
    CategoryRenderer const& renderer_template() const;
61
    CategoryRenderer const& renderer_template() const;
507
88
62
508
89
    // @cond
509
90
    QVariantMap serialize() const;
63
    QVariantMap serialize() const;
510
91
64
511
92
    static std::shared_ptr<QCategory> create(unity::scopes::Category::SCPtr category);
65
    static std::shared_ptr<QCategory> create(unity::scopes::Category::SCPtr category);
512
93
66
513
=== modified file 'include/unity/scopes/qt/internal/QColumnLayoutImpl.h'
514
--- include/unity/scopes/qt/internal/QColumnLayoutImpl.h	2015-02-06 00:12:18 +0000
515
+++ include/unity/scopes/qt/internal/QColumnLayoutImpl.h	2015-02-27 03:36:41 +0000
516
@@ -46,65 +46,22 @@
517
46
class QColumnLayoutImpl
46
class QColumnLayoutImpl
518
47
{
47
{
519
48
public:
48
public:
520
49
    /// @cond
521
50
    UNITY_DEFINES_PTRS(QColumnLayoutImpl);
49
    UNITY_DEFINES_PTRS(QColumnLayoutImpl);
522
51
    /// @endcond
523
52
50
524
53
    /**
525
54
    \brief Creates a layout definition that expects num_of_columns columns to be added with ColumnLayout::add_column.
526
55
    \param num_of_columns The number of columns for the layout.
527
56
    \throws unity::InvalidArgumentException for an invalid number of columns.
528
57
    */
529
58
    explicit QColumnLayoutImpl(int num_of_columns);
51
    explicit QColumnLayoutImpl(int num_of_columns);
530
52
    ~QColumnLayoutImpl();
531
59
53
532
60
    /**@name Copy and assignment
533
61
    Copy and assignment operators (move and non-move versions) have the usual value semantics.
534
62
    */
535
63
    //{@
536
64
    QColumnLayoutImpl(QColumnLayoutImpl const& other);
54
    QColumnLayoutImpl(QColumnLayoutImpl const& other);
537
65
    QColumnLayoutImpl(QColumnLayoutImpl&&);
55
    QColumnLayoutImpl(QColumnLayoutImpl&&);
538
66
    QColumnLayoutImpl& operator=(QColumnLayoutImpl const& other);
56
    QColumnLayoutImpl& operator=(QColumnLayoutImpl const& other);
539
67
    QColumnLayoutImpl& operator=(QColumnLayoutImpl&&);
57
    QColumnLayoutImpl& operator=(QColumnLayoutImpl&&);
555
68
    //@}
58
541
69
542
70
    /// @cond
543
71
    ~QColumnLayoutImpl();
544
72
    /// @endcond
545
73
546
74
    /**
547
75
    \brief Adds a new column and assigns widgets to it.
548
76
549
77
    ColumnLayout expects exactly the number of columns passed to the constructor to be created with the
550
78
    add_column method.
551
79
    \throws unity::LogicException if an attempt is made to add more columns than specified in the constructor.
552
80
    \throws unity::LogicException from \link unity::scopes::PreviewReply::register_layout\endlink if a layout
553
81
    has fewer columns than specified in the constructor.
554
82
    */
556
83
    void add_column(QVector<QString> widget_ids);
59
    void add_column(QVector<QString> widget_ids);
557
84
558
85
    /**
559
86
    \brief Get the current number of columns in this layout.
560
87
    \return The number of columns added with add_column().
561
88
    */
562
89
    int size() const noexcept;
60
    int size() const noexcept;
563
90
564
91
    /**
565
92
    \brief Get the number of columns expected by this layout as specified in the constructor.
566
93
    \return The number of columns expected by this layout.
567
94
    */
568
95
    int number_of_columns() const noexcept;
61
    int number_of_columns() const noexcept;
569
96
570
97
    /**
571
98
    \brief Retrieve the list of widgets for given column.
572
99
    \param index The index of a column.
573
100
    \return The widget identifiers for the given column index.
574
101
    \throws unity::InvalidArgumentException if the index is invalid.
575
102
    */
576
103
    QVector<QString> column(int index) const;
62
    QVector<QString> column(int index) const;
577
104
63
578
105
    /// @cond
579
106
    QVariantMap serialize() const;
64
    QVariantMap serialize() const;
580
107
    /// @endcond
581
108
65
582
109
    // added for testing purposes
66
    // added for testing purposes
583
110
    static unity::scopes::qt::QColumnLayout create(QColumnLayoutImpl* internal);
67
    static unity::scopes::qt::QColumnLayout create(QColumnLayoutImpl* internal);
584
111
68
585
=== modified file 'include/unity/scopes/qt/internal/QPreviewQueryBaseImpl.h'
586
--- include/unity/scopes/qt/internal/QPreviewQueryBaseImpl.h	2015-01-20 13:59:36 +0000
587
+++ include/unity/scopes/qt/internal/QPreviewQueryBaseImpl.h	2015-02-27 03:36:41 +0000
588
@@ -46,26 +46,13 @@
589
46
class QPreviewQueryBaseImpl
46
class QPreviewQueryBaseImpl
590
47
{
47
{
591
48
public:
48
public:
592
49
    /// @cond
593
50
    NONCOPYABLE(QPreviewQueryBaseImpl);
49
    NONCOPYABLE(QPreviewQueryBaseImpl);
594
51
    UNITY_DEFINES_PTRS(QPreviewQueryBaseImpl);
50
    UNITY_DEFINES_PTRS(QPreviewQueryBaseImpl);
595
52
    /// @endcond
596
53
51
597
54
    QPreviewQueryBaseImpl();
52
    QPreviewQueryBaseImpl();
598
55
    ~QPreviewQueryBaseImpl() = default;
53
    ~QPreviewQueryBaseImpl() = default;
599
56
54
600
57
    /**
601
58
     \brief Get result for this preview request.
602
59
     \throws unity::LogicException if result was not initialized (the default ctor was used).
603
60
     \return result
604
61
     */
605
62
    QResult result() const;
55
    QResult result() const;
606
63
607
64
    /**
608
65
     \brief Get metadata for this preview request.
609
66
     \return search metadata
610
67
     \throws unity::LogicException if preview metadata was not initialized (the default ctor was used).
611
68
    */
612
69
    QActionMetadata action_metadata() const;
56
    QActionMetadata action_metadata() const;
613
70
57
614
71
protected:
58
protected:
615
72
59
616
=== modified file 'include/unity/scopes/qt/internal/QPreviewReplyImpl.h'
617
--- include/unity/scopes/qt/internal/QPreviewReplyImpl.h	2015-02-06 00:12:18 +0000
618
+++ include/unity/scopes/qt/internal/QPreviewReplyImpl.h	2015-02-27 03:36:41 +0000
619
@@ -48,49 +48,20 @@
620
48
namespace internal
48
namespace internal
621
49
{
49
{
622
50
50
623
51
/**
624
52
\brief Allows the results of a preview to be sent to the preview requester.
625
53
*/
626
54
627
55
class QPreviewReplyImpl
51
class QPreviewReplyImpl
628
56
{
52
{
629
57
public:
53
public:
630
58
    /// @cond
631
59
    NONCOPYABLE(QPreviewReplyImpl);
54
    NONCOPYABLE(QPreviewReplyImpl);
632
60
    UNITY_DEFINES_PTRS(QPreviewReplyImpl);
55
    UNITY_DEFINES_PTRS(QPreviewReplyImpl);
642
61
    /// @endcond
56
643
62
    /**
57
    virtual ~QPreviewReplyImpl();
644
63
    \brief Registers a list of column layouts for the current preview.
58
636
64
637
65
    Layouts must be registered before pushing a unity::scopes::PreviewWidgetList, and must be
638
66
    registered only once.
639
67
    \return True if the query is still alive, false if the query failed or was cancelled.
640
68
    \throws unity::LogicException register_layout() is called more than once.
641
69
    */
645
70
    bool register_layout(QColumnLayoutList const& layouts);
59
    bool register_layout(QColumnLayoutList const& layouts);
646
71
647
72
    /**
648
73
    \brief Sends widget definitions to the sender of the preview query.
649
74
650
75
    This method can be called mutiple times to send widgets in stages.
651
76
    \return True if the query is still alive, false if the query failed or was cancelled.
652
77
    */
653
78
    bool push(QPreviewWidgetList const& widget_list);
60
    bool push(QPreviewWidgetList const& widget_list);
654
79
655
80
    /**
656
81
    \brief Sends data for a preview widget attribute.
657
82
    \return True if the query is still alive, false if the query failed or was cancelled.
658
83
    */
659
84
    bool push(QString const& key, QVariant const& value);
61
    bool push(QString const& key, QVariant const& value);
660
85
62
661
86
    /// @cond
662
87
    virtual ~QPreviewReplyImpl();
663
88
    /// @endcond
664
89
665
90
protected:
63
protected:
666
91
    /// @cond
667
92
    QPreviewReplyImpl(unity::scopes::PreviewReplyProxy& reply);
64
    QPreviewReplyImpl(unity::scopes::PreviewReplyProxy& reply);
668
93
    /// @endcond
669
94
65
670
95
private:
66
private:
671
96
    PreviewReplyProxy api_reply_;
67
    PreviewReplyProxy api_reply_;
672
97
68
673
=== modified file 'include/unity/scopes/qt/internal/QPreviewWidgetImpl.h'
674
--- include/unity/scopes/qt/internal/QPreviewWidgetImpl.h	2015-02-06 00:12:18 +0000
675
+++ include/unity/scopes/qt/internal/QPreviewWidgetImpl.h	2015-02-27 03:36:41 +0000
676
@@ -39,9 +39,6 @@
677
39
39
678
40
class QPreviewWidget;
40
class QPreviewWidget;
679
41
41
680
42
/*! \typedef QPreviewWidgetList
681
43
\brief List of preview widgets (see unity::scopes::qt::QPreviewWidget)
682
44
*/
683
45
typedef QList<QPreviewWidget> QPreviewWidgetList;
42
typedef QList<QPreviewWidget> QPreviewWidgetList;
684
46
43
685
47
namespace internal
44
namespace internal
686
@@ -52,135 +49,29 @@
687
52
class QPreviewWidgetImpl
49
class QPreviewWidgetImpl
688
53
{
50
{
689
54
public:
51
public:
690
55
    /// @cond
691
56
    UNITY_DEFINES_PTRS(QPreviewWidgetImpl);
52
    UNITY_DEFINES_PTRS(QPreviewWidgetImpl);
692
57
    /// @endcond
693
58
53
694
59
    /**
695
60
    \brief Create an empty widget definition with a specific id and type.
696
61
    \param id The unique widget identifier.
697
62
    \param widget_type The type of the widget.
698
63
    */
699
64
    QPreviewWidgetImpl(QString const& id, QString const& widget_type);
54
    QPreviewWidgetImpl(QString const& id, QString const& widget_type);
700
65
701
66
    /**
702
67
    \brief Create a widget from a JSON definition.
703
68
704
69
    The JSON definition must be a dictionary that includes widget "id" and all the values of attributes required by
705
70
    desired
706
71
    \link previewwidgets widget type\endlink. For example, a definition of image widget may look as follows:
707
72
    \code{.cpp}
708
73
    PreviewWidget img(R"({"id": "img", "type": "image", "source": "http://imageuri"})");
709
74
    \endcode
710
75
711
76
    For cases where attribute mappings are to be used instead of direct values, they need to be enclosed in the
712
77
    "components" dictionary, e.g.
713
78
    \code{.cpp}
714
79
    PreviewWidget img(R"({"id": "img", "type": "image", "components": { "source": "screenshot-url" } })");
715
80
    \endcode
716
81
    (this example assumes "screenshot-url" value is either available in the result object that's being previewed, or it
717
82
    will be pushed with
718
83
    unity::scopes::PreviewReply::push() method)
719
84
720
85
    \note It is recommended to create widgets via unity::scopes::PreviewWidget(QString const&, QString const&)
721
86
    constructor
722
87
    and unity::scopes::PreviewWidget::add_attribute_value() / unity::scopes::PreviewWidget::add_attribute_mapping()
723
88
    methods,
724
89
    rather than via JSON definition.
725
90
726
91
    \param definition The JSON definition.
727
92
    */
728
93
    QPreviewWidgetImpl(QString const& definition);
55
    QPreviewWidgetImpl(QString const& definition);
729
56
    virtual ~QPreviewWidgetImpl();
730
94
57
731
95
    /**@name Copy and assignment
732
96
    Copy and assignment operators (move and non-move versions) have the usual value semantics.
733
97
    */
734
98
    //{@
735
99
    QPreviewWidgetImpl(QPreviewWidgetImpl const& other);
58
    QPreviewWidgetImpl(QPreviewWidgetImpl const& other);
736
100
    QPreviewWidgetImpl(QPreviewWidgetImpl&& other);
59
    QPreviewWidgetImpl(QPreviewWidgetImpl&& other);
737
101
    virtual ~QPreviewWidgetImpl();
738
102
60
739
103
    QPreviewWidgetImpl& operator=(QPreviewWidgetImpl const& other);
61
    QPreviewWidgetImpl& operator=(QPreviewWidgetImpl const& other);
740
104
    QPreviewWidgetImpl& operator=(QPreviewWidgetImpl&& other);
62
    QPreviewWidgetImpl& operator=(QPreviewWidgetImpl&& other);
741
105
    //@}
742
106
63
743
107
    /**
744
108
    \brief Adds an attribute definition and its value.
745
109
    \param key The name of the attribute.
746
110
    \param value The value of the attribute.
747
111
    */
748
112
    void add_attribute_value(QString const& key, QVariant const& value);
64
    void add_attribute_value(QString const& key, QVariant const& value);
749
113
750
114
    /**
751
115
    \brief Adds an attribute definition using a component mapping.
752
116
753
117
    If an attribute value is either not known, or the value is already present
754
118
    in a result field, this method creates a mapping between the attribute
755
119
    name and given the field name.
756
120
757
121
    If an attribute value is not known, the scope is expected to push the attribute value using
758
122
    unity::scopes::PreviewReply::push(); otherwise, the value is automatically
759
123
    mapped from the result.
760
124
    */
761
125
    void add_attribute_mapping(QString const& key, QString const& field_name);
65
    void add_attribute_mapping(QString const& key, QString const& field_name);
762
126
763
127
    /**
764
128
      \brief Adds a widget into expandable widget.
765
129
766
130
      Adds a widget into this widget, which needs to be of 'expandable' type. This method throws
767
131
      if adding a widget into any other widget type. Also, adding an 'expandable' widget into
768
132
      another 'expandable' is not allowed.
769
133
770
134
      \throws unity::LogicException if type of this widget is other than 'expandable', or when
771
135
      adding 'expandable' to 'expandable'.
772
136
    */
773
137
    void add_widget(QPreviewWidget const& widget);
66
    void add_widget(QPreviewWidget const& widget);
774
138
775
139
    /**
776
140
    \brief Get the identifier of this widget.
777
141
    \return The widget identifier.
778
142
    */
779
143
    QString id() const;
67
    QString id() const;
780
144
781
145
    /**
782
146
    \brief Get type name of this widget.
783
147
    \return The widget type.
784
148
    */
785
149
    QString widget_type() const;
68
    QString widget_type() const;
786
150
787
151
    /**
788
152
    \brief Get the components of this widget.
789
153
790
154
    The returned map is a dictionary of (key, field name) pairs, as defined by calls to add_attribute_mapping().
791
155
    \return The components map.
792
156
    */
793
157
    QMap<QString, QString> attribute_mappings() const;
69
    QMap<QString, QString> attribute_mappings() const;
794
158
795
159
    /**
796
160
    \brief Get the attributes of this widget.
797
161
798
162
    The returned map is a dictionary of (key, value) pairs, as defined by calls to add_attribute_value().
799
163
    \return The attribute map.
800
164
    */
801
165
    QVariantMap attribute_values() const;
70
    QVariantMap attribute_values() const;
802
166
803
167
    /**
804
168
    \brief Get widgets of 'expandable' widget.
805
169
806
170
    Returns the list of widget attached to this widget, which must be of 'expandable' type. This list is
807
171
    always empty for other widget types.
808
172
    */
809
173
    QPreviewWidgetList widgets() const;
71
    QPreviewWidgetList widgets() const;
810
174
811
175
    /**
812
176
    \brief Get a JSON representation of this widget.
813
177
    \return The JSON string.
814
178
    */
815
179
    QString data() const;
72
    QString data() const;
816
180
73
817
181
    /// @cond
818
182
    QVariantMap serialize() const;
74
    QVariantMap serialize() const;
819
183
    /// @endcond
820
184
75
821
185
private:
76
private:
822
186
    std::unique_ptr<PreviewWidget> api_widget_;
77
    std::unique_ptr<PreviewWidget> api_widget_;
823
187
78
824
=== modified file 'include/unity/scopes/qt/internal/QResultImpl.h'
825
--- include/unity/scopes/qt/internal/QResultImpl.h	2015-02-06 00:12:18 +0000
826
+++ include/unity/scopes/qt/internal/QResultImpl.h	2015-02-27 03:36:41 +0000
827
@@ -54,192 +54,37 @@
828
54
class QResultImpl
54
class QResultImpl
829
55
{
55
{
830
56
public:
56
public:
831
57
    /// @cond
832
58
    UNITY_DEFINES_PTRS(QResultImpl);
57
    UNITY_DEFINES_PTRS(QResultImpl);
833
59
    /// @endcond
834
60
58
835
61
    /**@name Copy and assignment
836
62
    Copy and assignment (move and non-move versions) have the usual value semantics.
837
63
    */
838
64
    //{@
839
65
    QResultImpl(unity::scopes::Result const& other);
59
    QResultImpl(unity::scopes::Result const& other);
840
66
    QResultImpl(QResultImpl const& other);
60
    QResultImpl(QResultImpl const& other);
841
67
61
842
68
    QResultImpl& operator=(QResultImpl const& other);
62
    QResultImpl& operator=(QResultImpl const& other);
843
69
    QResultImpl& operator=(QResultImpl&&);
63
    QResultImpl& operator=(QResultImpl&&);
844
70
    //@}
845
71
64
846
72
    /**
847
73
    Destructor.
848
74
    */
849
75
    virtual ~QResultImpl();
65
    virtual ~QResultImpl();
850
76
66
851
77
    /**
852
78
    \brief Stores a Result inside this Result instance.
853
79
854
80
    This method is meant to be used by aggregator scopes which want to modify results they receive, but want
855
81
    to keep a copy of the original result so that they can be correctly handled by the original scopes
856
82
    who created them when it comes to activation or previews.
857
83
    Scopes middleware will automatically pass the correct inner stored result to the activation or preview request
858
84
    handler
859
85
    of a scope which created it.
860
86
    \param other The original result to store within this result.
861
87
    \param intercept_activation True if this scope should receive activation and preview requests.
862
88
    */
863
89
    void store(QResult const& other, bool intercept_activation = false);
67
    void store(QResult const& other, bool intercept_activation = false);
864
90
865
91
    /**
866
92
    \brief Check if this Result instance has a stored result.
867
93
    \return True if there is a stored result
868
94
     */
869
95
    bool has_stored_result() const;
68
    bool has_stored_result() const;
870
96
871
97
    /**
872
98
    \brief Get a stored result.
873
99
    \return stored result
874
100
    \throws unity::InvalidArgumentException if no result was stored in this Result instance.
875
101
    */
876
102
    QResult retrieve() const;
69
    QResult retrieve() const;
877
103
878
104
    /**
879
105
    \brief Set the "uri" attribute of this result.
880
106
    */
881
107
    void set_uri(QString const& uri);
70
    void set_uri(QString const& uri);
882
108
883
109
    /**
884
110
    \brief Set the "title" attribute of this result.
885
111
886
112
    Equivalent to calling `result["title"] = title;`
887
113
    */
888
114
    void set_title(QString const& title);
71
    void set_title(QString const& title);
889
115
    /**
890
116
    \brief Set the "art" attribute of this result.
891
117
892
118
    Equivalent to calling `result["art"] = image;`
893
119
    */
894
120
    void set_art(QString const& image);
72
    void set_art(QString const& image);
895
121
896
122
    /**
897
123
    \brief Set the "dnd_uri" attribute of this result.
898
124
899
125
    Equivalent to calling `result["dnd_uri"] = dnd_uri;`
900
126
    */
901
127
    void set_dnd_uri(QString const& dnd_uri);
73
    void set_dnd_uri(QString const& dnd_uri);
902
128
903
129
    /**
904
130
    \brief Indicates to the receiver that this scope should intercept activation requests for this result.
905
131
906
132
    By default, a scope receives preview requests for the results it creates, but does not receive activation
907
133
    requests (they are handled directly by the shell).
908
134
    Intercepting activation implies intercepting preview requests as well; this is important for scopes that
909
135
    forward results from other scopes and call set_intercept_activation() on these scopes.
910
136
    A scope that sets intercept activation flag for a result should re-implement ScopeBase::activate()
911
137
    and provide an implementation of ActivationQueryBase that handles the actual activation.
912
138
    If not called, the result will be activated directly by the Unity shell whithout involving the scope,
913
139
    assuming an appropriate URI schema handler is present on the system.
914
140
    */
915
141
    void set_intercept_activation();
74
    void set_intercept_activation();
916
142
917
143
    /**
918
144
    \brief Check if this result should be activated directly by the shell
919
145
           because the scope doesn't handle activation of this result.
920
146
    \return True if this result needs to be activated directly.
921
147
    */
922
148
    bool direct_activation() const;
75
    bool direct_activation() const;
923
149
924
150
    /**
925
151
    \brief Get the proxy of a scope that handles activation and preview of this result.
926
152
927
153
    The proxy is available only when receiving this result from a scope, otherwise
928
154
    this method throws LogicException. Activation requests should be sent to a scope
929
155
    returned by this method only if direct_activation() is false.
930
156
    \return The scope proxy.
931
157
    */
932
158
    ScopeProxy target_scope_proxy() const;
76
    ScopeProxy target_scope_proxy() const;
933
159
934
160
    /**
935
161
    \brief Returns reference of a Result attribute.
936
162
937
163
    This method can be used to read or initialize both standard ("uri", "title", "art", "dnd_uri")
938
164
    and custom metadata attributes. Referencing a non-existing attribute automatically creates
939
165
    it with a default value of Variant::Type::Null.
940
166
    \param key The name of the attribute.
941
167
    \return A reference to the attribute.
942
168
    \throws unity::Invalidargument if no attribute with the given name exists.
943
169
    */
944
170
    QVariant& operator[](QString const& key);
77
    QVariant& operator[](QString const& key);
945
171
946
172
    /**
947
173
    \brief Returns a const reference to a Result attribute.
948
174
949
175
    This method can be used for read-only access to both standard ("uri", "title", "art", "dnd_uri")
950
176
    and custom metadata attributes. Referencing a non-existing attribute throws unity::InvalidArgumentException.
951
177
    \param key The name of the attribute.
952
178
    \return A const reference to the attribute.
953
179
    \throws unity::Invalidargument if no attribute with the given name exists.
954
180
    */
955
181
    QVariant const& operator[](QString const& key) const;
78
    QVariant const& operator[](QString const& key) const;
956
182
957
183
    /**
958
184
    \brief Get the "uri" property of this Result.
959
185
960
186
    This method returns an empty string if this attribute is not of type Variant::Type::String (e.g. it was set with
961
187
    operator[]).
962
188
    \return The value of "uri" or the empty string.
963
189
     */
964
190
    QString uri() const noexcept;
79
    QString uri() const noexcept;
965
191
966
192
    /**
967
193
    \brief Get the "title" property of this Result.
968
194
969
195
    This method returns an empty string if this attribute is not of type Variant::Type::String (e.g. it was set with
970
196
    operator[]).
971
197
    \return The value of "title" or the empty string.
972
198
    */
973
199
    QString title() const noexcept;
80
    QString title() const noexcept;
974
200
975
201
    /**
976
202
    \brief Get the "art" property of this Result.
977
203
978
204
    This method returns an empty string if this attribute is not of type Variant::Type::String (e.g. it was set with
979
205
    operator[]).
980
206
    \return The value of "art" or the empty string.
981
207
    */
982
208
    QString art() const noexcept;
81
    QString art() const noexcept;
983
209
984
210
    /**
985
211
    \brief Get the "dnd_uri" property of this Result.
986
212
987
213
    This method returns an empty string if this attribute is not of type Variant::Type::String type (e.g. it was set
988
214
    with operator[]).
989
215
    \return The value of "dnd_uri" or the empty string.
990
216
    */
991
217
    QString dnd_uri() const noexcept;
82
    QString dnd_uri() const noexcept;
992
218
993
219
    /**
994
220
    \brief Check if this Result has an attribute.
995
221
    \param key The attribute name.
996
222
    \return True if the attribute is set.
997
223
    */
998
224
    bool contains(QString const& key) const;
83
    bool contains(QString const& key) const;
999
225
1000
226
    /**
1001
227
    \brief Get the value of an attribute.
1002
228
1003
229
    \param key The attribute name.
1004
230
    \return The attribute value.
1005
231
    \throws unity::InvalidArgumentException if given attribute hasn't been set.
1006
232
    */
1007
233
    QVariant const& value(QString const& key) const;
84
    QVariant const& value(QString const& key) const;
1008
234
1009
235
    /**
1010
236
    \brief Returns a dictionary of all attributes of this Result instance.
1011
237
    \return All base attributes and custom attributes set with add_metadata().
1012
238
    */
1013
239
    QVariantMap serialize() const;
85
    QVariantMap serialize() const;
1014
240
86
1015
241
protected:
87
protected:
1016
242
    /// @cond
1017
243
    explicit QResultImpl(const QVariantMap& variant_map);
88
    explicit QResultImpl(const QVariantMap& variant_map);
1018
244
    explicit QResultImpl(internal::QResultImpl* impl);
89
    explicit QResultImpl(internal::QResultImpl* impl);
1019
245
    explicit QResultImpl(unity::scopes::Result* api_result);
90
    explicit QResultImpl(unity::scopes::Result* api_result);
1020
246
91
1021
=== modified file 'include/unity/scopes/qt/internal/QScopeBaseAPIImpl.h'
1022
--- include/unity/scopes/qt/internal/QScopeBaseAPIImpl.h	2015-02-27 03:36:41 +0000
1023
+++ include/unity/scopes/qt/internal/QScopeBaseAPIImpl.h	2015-02-27 03:36:41 +0000
1024
@@ -52,62 +52,29 @@
1025
52
{
52
{
1026
53
    Q_OBJECT
53
    Q_OBJECT
1027
54
public:
54
public:
1028
55
    /// @cond
1029
56
    using FactoryFunc = std::function<QScopeBase*()>;
55
    using FactoryFunc = std::function<QScopeBase*()>;
1030
57
56
1031
58
    NONCOPYABLE(QScopeBaseAPIImpl);
57
    NONCOPYABLE(QScopeBaseAPIImpl);
1032
59
    UNITY_DEFINES_PTRS(QScopeBaseAPIImpl);
58
    UNITY_DEFINES_PTRS(QScopeBaseAPIImpl);
1033
60
59
1036
61
    QScopeBaseAPIImpl(QScopeBase& qtscope, QObject* parent = 0);
60
    QScopeBaseAPIImpl(FactoryFunc const& creator);
1035
62
    QScopeBaseAPIImpl(FactoryFunc const& creator, QObject* parent = 0);
1037
63
    virtual ~QScopeBaseAPIImpl();
61
    virtual ~QScopeBaseAPIImpl();
1038
64
62
1039
65
    bool event(QEvent* e) override;
63
    bool event(QEvent* e) override;
1040
66
    /// @endcond
1041
67
1042
68
    /**
1043
69
    \brief Called by the scopes run time after the create function completes.
1044
70
1045
71
    If start() throws an exception, stop() will _not_ be called.
1046
72
1047
73
    The call to start() is made by the same thread that calls the create function.
1048
74
1049
75
    \param scope_id The name of the scope as defined by the scope's configuration file.
1050
76
    */
1051
77
    void start(std::string const& scope_id);
64
    void start(std::string const& scope_id);
1052
78
1053
79
    /**
1054
80
    \brief Called by the scopes run time when the scope should shut down.
1055
81
1056
82
    A scope should deallocate as many resources as possible when stop() is called, for example,
1057
83
    deallocate any caches and close network connections. In addition, if the scope implements run()
1058
84
    and did not return from run(), it must return from run() in response to the call to stop().
1059
85
1060
86
    Exceptions from stop() are ignored.
1061
87
1062
88
    The call to stop() is made by the same thread that calls the create function and start().
1063
89
    */
1064
90
    void stop();
65
    void stop();
1065
91
1066
92
    /**
1067
93
     * Called each time a new preview is requested
1068
94
     */
1069
95
    unity::scopes::PreviewQueryBase::UPtr preview(const unity::scopes::Result&, const unity::scopes::ActionMetadata&);
66
    unity::scopes::PreviewQueryBase::UPtr preview(const unity::scopes::Result&, const unity::scopes::ActionMetadata&);
1070
96
1071
97
    /**
1072
98
     * Called each time a new query is requested
1073
99
     */
1074
100
    unity::scopes::SearchQueryBase::UPtr search(unity::scopes::CannedQuery const& q,
67
    unity::scopes::SearchQueryBase::UPtr search(unity::scopes::CannedQuery const& q,
1075
101
                                                unity::scopes::SearchMetadata const&);
68
                                                unity::scopes::SearchMetadata const&);
1076
102
69
1077
103
protected:
70
protected:
1079
104
    void startQtThread();
71
    void start_qt_thread();
1080
105
72
1081
106
    std::shared_ptr<QCoreApplication> qtapp_;
73
    std::shared_ptr<QCoreApplication> qtapp_;
1082
107
    std::unique_ptr<std::thread> qtthread_;
74
    std::unique_ptr<std::thread> qtthread_;
1083
108
    std::atomic<bool> qtapp_ready_;
75
    std::atomic<bool> qtapp_ready_;
1086
109
76
    std::atomic<bool> qtapp_stopped_;
1087
110
    QScopeBase* qtscope_impl_;
77
    std::unique_ptr<QScopeBase> qtscope_impl_;
1088
111
78
1089
112
    FactoryFunc qtscope_creator_;
79
    FactoryFunc qtscope_creator_;
1090
113
};
80
};
1091
114
81
1092
=== modified file 'include/unity/scopes/qt/internal/QScopeBaseImpl.h'
1093
--- include/unity/scopes/qt/internal/QScopeBaseImpl.h	2015-01-20 13:59:36 +0000
1094
+++ include/unity/scopes/qt/internal/QScopeBaseImpl.h	2015-02-27 03:36:41 +0000
1095
@@ -38,21 +38,13 @@
1096
38
class QScopeBaseImpl
38
class QScopeBaseImpl
1097
39
{
39
{
1098
40
public:
40
public:
1099
41
    /// @cond
1100
42
    NONCOPYABLE(QScopeBaseImpl);
41
    NONCOPYABLE(QScopeBaseImpl);
1101
43
    UNITY_DEFINES_PTRS(QScopeBaseImpl);
42
    UNITY_DEFINES_PTRS(QScopeBaseImpl);
1102
44
43
1103
45
    QScopeBaseImpl() = default;
44
    QScopeBaseImpl() = default;
1104
46
    virtual ~QScopeBaseImpl() = default;
45
    virtual ~QScopeBaseImpl() = default;
1109
47
    /// @endcond
46
1106
48
    /**
1107
49
     * Called once at startup
1108
50
     */
1110
51
    virtual void start(std::string const&);
47
    virtual void start(std::string const&);
1111
52
1112
53
    /**
1113
54
     * Called at shutdown
1114
55
     */
1115
56
    virtual void stop();
48
    virtual void stop();
1116
57
};
49
};
1117
58
50
1118
59
51
1119
=== modified file 'include/unity/scopes/qt/internal/QScopeVariant.h'
1120
--- include/unity/scopes/qt/internal/QScopeVariant.h	2015-02-06 00:12:18 +0000
1121
+++ include/unity/scopes/qt/internal/QScopeVariant.h	2015-02-27 03:36:41 +0000
1122
@@ -45,7 +45,6 @@
1123
45
class QScopeVariant : public QVariant
45
class QScopeVariant : public QVariant
1124
46
{
46
{
1125
47
public:
47
public:
1126
48
    //    explicit QScopeVariant() noexcept;
1127
49
    virtual ~QScopeVariant();
48
    virtual ~QScopeVariant();
1128
50
49
1129
51
    QScopeVariant(QScopeVariant const& other);
50
    QScopeVariant(QScopeVariant const& other);
1130
@@ -65,9 +64,6 @@
1131
65
    std::string get_string() const;
64
    std::string get_string() const;
1132
66
65
1133
67
private:
66
private:
1134
68
    /**
1135
69
    \brief Creates a Variant instance that stores the supplied integer.
1136
70
    */
1137
71
    explicit QScopeVariant(Variant* val) noexcept;
67
    explicit QScopeVariant(Variant* val) noexcept;
1138
72
68
1139
73
    void setInternalVariant(Variant* val);
69
    void setInternalVariant(Variant* val);
1140
74
70
1141
=== modified file 'include/unity/scopes/qt/internal/QSearchMetadataImpl.h'
1142
--- include/unity/scopes/qt/internal/QSearchMetadataImpl.h	2015-02-06 00:12:18 +0000
1143
+++ include/unity/scopes/qt/internal/QSearchMetadataImpl.h	2015-02-27 03:36:41 +0000
1144
@@ -45,114 +45,27 @@
1145
45
class QSearchMetadataImpl
45
class QSearchMetadataImpl
1146
46
{
46
{
1147
47
public:
47
public:
1148
48
    /// @cond
1149
49
    UNITY_DEFINES_PTRS(QSearchMetadataImpl);
48
    UNITY_DEFINES_PTRS(QSearchMetadataImpl);
1150
50
    /// @endcond
1151
51
49
1152
52
    /**
1153
53
    \brief Create SearchMetadata with the given locale and form factor.
1154
54
    \param locale locale string, eg. en_EN
1155
55
    \param form_factor form factor name, e.g. phone, desktop, phone-version etc.
1156
56
    */
1157
57
    QSearchMetadataImpl(QString const& locale, QString const& form_factor);
50
    QSearchMetadataImpl(QString const& locale, QString const& form_factor);
1158
58
1159
59
    /**
1160
60
    \brief Create SearchMetadata with the given cardinality, locale, and form factor.
1161
61
    \param cardinality maximum number of search results
1162
62
    \param locale locale string, eg. en_EN
1163
63
    \param form_factor form factor name, e.g. phone, desktop, phone-version etc.
1164
64
    */
1165
65
    QSearchMetadataImpl(int cardinality, QString const& locale, QString const& form_factor);
51
    QSearchMetadataImpl(int cardinality, QString const& locale, QString const& form_factor);
1166
52
    ~QSearchMetadataImpl();
1167
66
53
1168
67
    /**@name Copy and assignment
1169
68
    Copy and assignment operators (move and non-move versions) have the usual value semantics.
1170
69
    */
1171
70
    //{@
1172
71
    QSearchMetadataImpl(QSearchMetadataImpl const& other);
54
    QSearchMetadataImpl(QSearchMetadataImpl const& other);
1173
72
    QSearchMetadataImpl(QSearchMetadataImpl&&);
55
    QSearchMetadataImpl(QSearchMetadataImpl&&);
1174
73
56
1175
74
    QSearchMetadataImpl& operator=(QSearchMetadataImpl const& other);
57
    QSearchMetadataImpl& operator=(QSearchMetadataImpl const& other);
1176
75
    QSearchMetadataImpl& operator=(QSearchMetadataImpl&&);
58
    QSearchMetadataImpl& operator=(QSearchMetadataImpl&&);
1187
76
    //@}
59
1178
77
1179
78
    /// @cond
1180
79
    ~QSearchMetadataImpl();
1181
80
    /// @endcond
1182
81
1183
82
    /**
1184
83
    \brief Set cardinality.
1185
84
    \param cardinality The maximum number of search results.
1186
85
    */
1188
86
    void set_cardinality(int cardinality);
60
    void set_cardinality(int cardinality);
1189
87
1190
88
    /**
1191
89
    \brief Get cardinality.
1192
90
    \return The maxmium number of search results, or 0 for no limit.
1193
91
    */
1194
92
    int cardinality() const;
61
    int cardinality() const;
1195
93
1196
94
    /**
1197
95
    \brief Set location.
1198
96
    \param location Location data.
1199
97
    */
1200
98
    void set_location(Location const& location);
62
    void set_location(Location const& location);
1201
99
1202
100
    /**
1203
101
    \brief Get location.
1204
102
    \return Location data representing the current location, including attributes such as city and country.
1205
103
    \throws unity::NotFoundException if no location data is available.
1206
104
    */
1207
105
    Location location() const;
63
    Location location() const;
1208
106
1209
107
    /**
1210
108
    \brief Does the SearchMetadata have a location.
1211
109
    \return True if there is a location property.
1212
110
    */
1213
111
    bool has_location() const;
64
    bool has_location() const;
1214
112
1215
113
    /**
1216
114
    \brief Sets a hint.
1217
115
1218
116
    \param key The name of the hint.
1219
117
    \param value Hint value
1220
118
    */
1221
119
    void set_hint(QString const& key, QVariant const& value);
65
    void set_hint(QString const& key, QVariant const& value);
1222
120
1223
121
    /**
1224
122
    \brief Get all hints.
1225
123
1226
124
    \return Hints dictionary.
1227
125
    \throws unity::NotFoundException if no hints are available.
1228
126
    */
1229
127
    QVariantMap hints() const;
66
    QVariantMap hints() const;
1230
128
1231
129
    /**
1232
130
    \brief Check if this SearchMetadata has a hint.
1233
131
    \param key The hint name.
1234
132
    \return True if the hint is set.
1235
133
    */
1236
134
    bool contains_hint(QString const& key) const;
67
    bool contains_hint(QString const& key) const;
1237
135
1238
136
    /**
1239
137
    \brief Returns a reference to a hint.
1240
138
1241
139
    This method can be used to read or set hints. Setting a value of an existing hint overwrites
1242
140
    its previous value.
1243
141
    Referencing a non-existing hint automatically creates it with a default value of Variant::Type::Null.
1244
142
    \param key The name of the hint.
1245
143
    \return A reference to the hint.
1246
144
    */
1247
145
    QScopeVariant& operator[](QString const& key);
68
    QScopeVariant& operator[](QString const& key);
1248
146
1249
147
    /**
1250
148
    \brief Returns a const reference to a hint.
1251
149
1252
150
    This method can be used for read-only access to hints.
1253
151
    Referencing a non-existing hint throws unity::InvalidArgumentException.
1254
152
    \param key The name of the hint.
1255
153
    \return A const reference to the hint.
1256
154
    \throws unity::NotFoundException if no hint with the given name exists.
1257
155
    */
1258
156
    QVariant const& value(QString const& key) const;
69
    QVariant const& value(QString const& key) const;
1259
157
70
1260
158
private:
71
private:
1261
159
72
1262
=== modified file 'include/unity/scopes/qt/internal/QSearchQueryBaseImpl.h'
1263
--- include/unity/scopes/qt/internal/QSearchQueryBaseImpl.h	2015-02-02 07:46:12 +0000
1264
+++ include/unity/scopes/qt/internal/QSearchQueryBaseImpl.h	2015-02-27 03:36:41 +0000
1265
@@ -50,41 +50,15 @@
1266
50
    friend QSearchQueryBase;
50
    friend QSearchQueryBase;
1267
51
51
1268
52
public:
52
public:
1269
53
    /// @cond
1270
54
    NONCOPYABLE(QSearchQueryBaseImpl);
53
    NONCOPYABLE(QSearchQueryBaseImpl);
1271
55
    UNITY_DEFINES_PTRS(QSearchQueryBaseImpl);
54
    UNITY_DEFINES_PTRS(QSearchQueryBaseImpl);
1272
56
    /// @endcond
1273
57
55
1274
58
    QSearchQueryBaseImpl();
56
    QSearchQueryBaseImpl();
1275
59
    ~QSearchQueryBaseImpl() = default;
57
    ~QSearchQueryBaseImpl() = default;
1276
60
58
1277
61
    /**
1278
62
     \brief Get a canned query for this search request.
1279
63
1280
64
     \return The canned query.
1281
65
     \throws unity::LogicException if the canned query was not initialized (was default-constructed).
1282
66
     */
1283
67
    QCannedQuery query() const;
59
    QCannedQuery query() const;
1284
68
1285
69
    /**
1286
70
     \brief Get metadata for this search request.
1287
71
     \return The search metadata.
1288
72
     \throws unity::LogicException if search metadata was not initialized (was default-constructed).
1289
73
    */
1290
74
    unity::scopes::SearchMetadata search_metadata() const;
60
    unity::scopes::SearchMetadata search_metadata() const;
1291
75
61
1292
76
    /** @name Subquery methods
1293
77
    The subsearch() methods are for use by aggregating scopes.
1294
78
    When an aggregator passes a query to its child scopes, it should
1295
79
    use subsearch() instead of the normal Scope::search()
1296
80
    that would be called by a client. subsearch() takes care
1297
81
    of automatically forwarding query cancellation to child scopes.
1298
82
    This means that there is no need for an aggregating scope to
1299
83
    explicitly forward cancellation to child scopes
1300
84
    when its QueryBase::cancelled() method is called by the scopes
1301
85
    run time.
1302
86
    */
1303
87
    //{@
1304
88
    QueryCtrlProxy subsearch(ScopeProxy const& scope,
62
    QueryCtrlProxy subsearch(ScopeProxy const& scope,
1305
89
                             std::string const& query_string,
63
                             std::string const& query_string,
1306
90
                             SearchListenerBase::SPtr const& reply);
64
                             SearchListenerBase::SPtr const& reply);
1307
91
65
1308
=== modified file 'include/unity/scopes/qt/internal/QSearchReplyImpl.h'
1309
--- include/unity/scopes/qt/internal/QSearchReplyImpl.h	2015-02-02 07:46:12 +0000
1310
+++ include/unity/scopes/qt/internal/QSearchReplyImpl.h	2015-02-27 03:36:41 +0000
1311
@@ -52,96 +52,17 @@
1312
52
    friend class unity::scopes::qt::QSearchReply;
52
    friend class unity::scopes::qt::QSearchReply;
1313
53
53
1314
54
public:
54
public:
1315
55
    /// @cond
1316
56
    NONCOPYABLE(QSearchReplyImpl);
55
    NONCOPYABLE(QSearchReplyImpl);
1317
57
    UNITY_DEFINES_PTRS(QSearchReplyImpl);
56
    UNITY_DEFINES_PTRS(QSearchReplyImpl);
1322
58
    /// @endcond
57
1319
59
    /**
1320
60
    \brief Destroys a QSearchReplyImpl.
1321
61
    */
1323
62
    virtual ~QSearchReplyImpl();
58
    virtual ~QSearchReplyImpl();
1324
63
1325
64
    /**
1326
65
     \brief Register departments for the current search reply and provide the current department.
1327
66
1328
67
     Departments are optional. If scope supports departments, it is expected to register departments on every search as
1329
68
     follows:
1330
69
1331
70
      <ul>
1332
71
      <li>create a Department node for current department and attach to it a list of its subdepartments (unless current
1333
72
     department is a leaf department) using
1334
73
      unity::scopes::Department::set_subdepartments() method. For every subdepartment on the list set
1335
74
     "has_subdepartments" flag if applicable.
1336
75
      <li>provide an alternate label for current department with unity::scopes::Department::set_alternate_label().
1337
76
      <li>create a Department node for parent of current department (if applicable - not when in root department), and
1338
77
     attach current Department node to it with
1339
78
      unity::scopes::Department::set_subdepartments() method.
1340
79
      <li>register the parent department with unity::scopes::SearchReply::register_departments().
1341
80
      </ul>
1342
81
1343
82
     For example, assuming the user is visiting a "History" department in "Books", and "History" has sub-departments
1344
83
     such as "World War Two" and "Ancient", the code
1345
84
     that registers departments for current search in "History" may look like this:
1346
85
     \code{.cpp}
1347
86
     unity::scopes::Department::SPtr books = move(unity::scopes::Department::create("books", query, "Books")); // the
1348
87
     parent of "History"
1349
88
     unity::scopes::Department::SPtr history = move(unity::scopes::Department::create("history", query, "History"));
1350
89
     unity::scopes::DepartmentList history_depts({
1351
90
                                                 move(unity::scopes::Department::create("ww2", query, "World War Two")),
1352
91
                                                 move(unity::scopes::Department::create("ancient", query, "Ancient"))});
1353
92
     history->set_subdepartments(history_depts);
1354
93
     books->set_subdepartments({history});
1355
94
     reply->register_departments(books);
1356
95
     \endcode
1357
96
1358
97
     Current department should be the department returned by unity::scopes::CannedQuery::department_id(). Empty
1359
98
     department id denotes
1360
99
     the root deparment.
1361
100
1362
101
     \param parent The parent department of current department, or current one if visiting root department.
1363
102
     \throws unity::LogicException if departments are invalid (nullptr passed, current department not present in the
1364
103
     parent's tree, duplicated department ids present in the tree).
1365
104
     */
1366
105
    virtual void register_departments(QDepartment::SCPtr const& parent);
59
    virtual void register_departments(QDepartment::SCPtr const& parent);
1367
106
1368
107
    /**
1369
108
    \brief Register new category and send it to the source of the query.
1370
109
1371
110
    \param id The identifier of the category
1372
111
    \param title The title of the category
1373
112
    \param icon The icon of the category
1374
113
    \param renderer_template The renderer template to be used for results in this category
1375
114
1376
115
    \return The category instance
1377
116
    \throws unity::scopes::InvalidArgumentException if category with that id has already been registered.
1378
117
    */
1379
118
    QCategory::SCPtr register_category(
60
    QCategory::SCPtr register_category(
1380
119
        QString const& id,
61
        QString const& id,
1381
120
        QString const& title,
62
        QString const& title,
1382
121
        QString const& icon,
63
        QString const& icon,
1383
122
        unity::scopes::CategoryRenderer const& renderer_template = unity::scopes::CategoryRenderer());
64
        unity::scopes::CategoryRenderer const& renderer_template = unity::scopes::CategoryRenderer());
1384
123
1385
124
    /**
1386
125
    \brief Sends a single result to the source of a query.
1387
126
1388
127
    Any calls to push() after finished() was called are ignored.
1389
128
    \return The return value is true if the result was accepted, false otherwise.
1390
129
    A false return value can be due to finished() having been called earlier,
1391
130
    or the client that sent the query having cancelled that query. The return
1392
131
    value is false also if the query has a cardinality limit and is reached
1393
132
    or exceeded. (The return value is false for the last valid push and
1394
133
    subsequent pushes.)
1395
134
    */
1396
135
    bool push(QCategorisedResult const& result);
65
    bool push(QCategorisedResult const& result);
1397
136
1398
137
    /**
1399
138
    \brief Informs the source of a query that the query was terminated due to an error.
1400
139
1401
140
    Multiple calls to error() and calls to finished() after error() was called are ignored.
1402
141
    \param ex An exception_ptr indicating the cause of the error. If ex is a `std::exception`,
1403
142
              the return value of `what()` is made available to the query source. Otherwise,
1404
143
              the query source receives `"unknown exception"`.
1405
144
    */
1406
145
    void error(std::exception_ptr ex);
66
    void error(std::exception_ptr ex);
1407
146
67
1408
147
protected:
68
protected:
1409
148
69
1410
=== modified file 'include/unity/scopes/qt/internal/QUtils.h'
1411
--- include/unity/scopes/qt/internal/QUtils.h	2015-02-27 03:36:41 +0000
1412
+++ include/unity/scopes/qt/internal/QUtils.h	2015-02-27 03:36:41 +0000
1413
@@ -18,10 +18,6 @@
1414
18
18
1415
19
#pragma once
19
#pragma once
1416
20
20
1417
21
#ifndef _ENABLE_QT_EXPERIMENTAL_
1418
22
#error You should define _ENABLE_QT_EXPERIMENTAL_ in order to use this experimental header file.
1419
23
#endif
1420
24
1421
25
#pragma GCC diagnostic push
21
#pragma GCC diagnostic push
1422
26
#pragma GCC diagnostic ignored "-Wctor-dtor-privacy"
22
#pragma GCC diagnostic ignored "-Wctor-dtor-privacy"
1423
27
#include <QtCore/QVariant>
23
#include <QtCore/QVariant>
1424
28
24
1425
=== modified file 'src/scopes/qt/QActionMetadata.cpp'
1426
--- src/scopes/qt/QActionMetadata.cpp	2015-01-26 15:25:30 +0000
1427
+++ src/scopes/qt/QActionMetadata.cpp	2015-02-27 03:36:41 +0000
1428
@@ -32,7 +32,7 @@
1429
32
}
32
}
1430
33
33
1431
34
QActionMetadata::QActionMetadata(internal::QActionMetadataImpl* impl)
34
QActionMetadata::QActionMetadata(internal::QActionMetadataImpl* impl)
1433
35
    : p(new internal::QActionMetadataImpl(*impl))
35
    : p(impl)
1434
36
{
36
{
1435
37
}
37
}
1436
38
38
1437
39
39
1438
=== modified file 'src/scopes/qt/QPreviewWidget.cpp'
1439
--- src/scopes/qt/QPreviewWidget.cpp	2015-01-20 14:14:26 +0000
1440
+++ src/scopes/qt/QPreviewWidget.cpp	2015-02-27 03:36:41 +0000
1441
@@ -104,7 +104,7 @@
1442
104
}
104
}
1443
105
105
1444
106
QPreviewWidget::QPreviewWidget(internal::QPreviewWidgetImpl* widget)
106
QPreviewWidget::QPreviewWidget(internal::QPreviewWidgetImpl* widget)
1446
107
    : p(new internal::QPreviewWidgetImpl(*widget))
107
    : p(widget)
1447
108
{
108
{
1448
109
}
109
}
1449
110
/// @endcond
110
/// @endcond
1450
111
111
1451
=== modified file 'src/scopes/qt/QResult.cpp'
1452
--- src/scopes/qt/QResult.cpp	2015-02-27 03:36:41 +0000
1453
+++ src/scopes/qt/QResult.cpp	2015-02-27 03:36:41 +0000
1454
@@ -24,11 +24,6 @@
1455
24
using namespace unity::scopes::qt;
24
using namespace unity::scopes::qt;
1456
25
25
1457
26
/// @cond
26
/// @cond
1458
27
QResult::QResult()
1459
28
    : p(new internal::QResultImpl(QVariantMap()))
1460
29
{
1461
30
}
1462
31
1463
32
QResult::QResult(internal::QResultImpl* impl)
27
QResult::QResult(internal::QResultImpl* impl)
1464
33
    : p(impl)
28
    : p(impl)
1465
34
{
29
{
1466
@@ -123,7 +118,7 @@
1467
123
118
1468
124
QVariant const& QResult::operator[](QString const& key) const
119
QVariant const& QResult::operator[](QString const& key) const
1469
125
{
120
{
1471
126
    return p->value(key);
121
    return (*static_cast<internal::QResultImpl const*>(p.get()))[key];
1472
127
}
122
}
1473
128
123
1474
129
QString QResult::uri() const noexcept
124
QString QResult::uri() const noexcept
1475
130
125
1476
=== modified file 'src/scopes/qt/internal/QResultImpl.cpp'
1477
--- src/scopes/qt/internal/QResultImpl.cpp	2015-02-27 03:36:41 +0000
1478
+++ src/scopes/qt/internal/QResultImpl.cpp	2015-02-27 03:36:41 +0000
1479
@@ -28,61 +28,19 @@
1480
28
using namespace unity::scopes::qt;
28
using namespace unity::scopes::qt;
1481
29
using namespace unity::scopes::qt::internal;
29
using namespace unity::scopes::qt::internal;
1482
30
30
1493
31
namespace unity
31
namespace
1484
32
{
1485
33
1486
34
namespace scopes
1487
35
{
1488
36
1489
37
namespace qt
1490
38
{
1491
39
1492
40
namespace internal
1494
41
{
32
{
1495
42
33
1496
43
class APIResult : public Result
34
class APIResult : public Result
1497
44
{
35
{
1498
45
public:
36
public:
1499
46
    APIResult(APIResult const& other)
1500
47
        : Result(other){};
1501
48
1502
49
    APIResult(APIResult&&) = default;
1503
50
1504
51
    APIResult& operator=(APIResult const& other)
1505
52
    {
1506
53
        if (this != &other)
1507
54
        {
1508
55
            *this = other;
1509
56
        }
1510
57
        return *this;
1511
58
    }
1512
59
1513
60
    APIResult& operator=(APIResult&&) = default;
1514
61
1515
62
    APIResult(const QVariantMap& variant_map)
37
    APIResult(const QVariantMap& variant_map)
1519
63
        : Result(qvariantmap_to_variantmap(variant_map)){};
38
        : Result(qvariantmap_to_variantmap(variant_map))
1517
64
1518
65
    static VariantMap getValidEmptyMap()
1520
66
    {
39
    {
1521
67
        VariantMap retMap;
1522
68
        VariantMap emptyMap;
1523
69
        VariantMap attrsMap;
1524
70
1525
71
        attrsMap["uri"] = Variant(std::string());
1526
72
        retMap["internal"] = emptyMap;
1527
73
        retMap["attrs"] = attrsMap;
1528
74
1529
75
        return retMap;
1530
76
    }
40
    }
1531
77
};
41
};
1532
78
42
1540
79
}  // namespace internal
43
}  // namespace
1534
80
1535
81
}  // namespace qt
1536
82
1537
83
}  // namespace scopes
1538
84
1539
85
}  // namespace unity
1541
86
44
1542
87
QResultImpl::QResultImpl(unity::scopes::Result* api_result)
45
QResultImpl::QResultImpl(unity::scopes::Result* api_result)
1543
88
    : api_result_(api_result)
46
    : api_result_(api_result)
1544
@@ -95,8 +53,9 @@
1545
95
}
53
}
1546
96
54
1547
97
QResultImpl::QResultImpl(internal::QResultImpl* impl)
55
QResultImpl::QResultImpl(internal::QResultImpl* impl)
1548
98
    : api_result_(impl->api_result_.get())
1549
99
{
56
{
1550
57
    impl->sync_values();
1551
58
    api_result_.reset(new Result(*(impl->api_result_)));
1552
100
}
59
}
1553
101
60
1554
102
QResultImpl::QResultImpl(QResultImpl const& other)
61
QResultImpl::QResultImpl(QResultImpl const& other)
1555
103
62
1556
=== modified file 'src/scopes/qt/internal/QScopeBaseAPIImpl.cpp'
1557
--- src/scopes/qt/internal/QScopeBaseAPIImpl.cpp	2015-02-27 03:36:41 +0000
1558
+++ src/scopes/qt/internal/QScopeBaseAPIImpl.cpp	2015-02-27 03:36:41 +0000
1559
@@ -78,16 +78,10 @@
1560
78
78
1561
79
}  // namespace unity
79
}  // namespace unity
1562
80
80
1573
81
QScopeBaseAPIImpl::QScopeBaseAPIImpl(QScopeBase& qtscope, QObject* parent)
81
QScopeBaseAPIImpl::QScopeBaseAPIImpl(FactoryFunc const& creator)
1574
82
    : QObject(parent)
82
    : QObject(nullptr)
1575
83
    , qtapp_ready_(false)
83
    , qtapp_ready_(false)
1576
84
    , qtscope_impl_(&qtscope)
84
    , qtapp_stopped_(false)
1567
85
{
1568
86
}
1569
87
1570
88
QScopeBaseAPIImpl::QScopeBaseAPIImpl(FactoryFunc const& creator, QObject* parent)
1571
89
    : QObject(parent)
1572
90
    , qtapp_ready_(false)
1577
91
    , qtscope_impl_(nullptr)
85
    , qtscope_impl_(nullptr)
1578
92
    , qtscope_creator_(creator)
86
    , qtscope_creator_(creator)
1579
93
{
87
{
1580
@@ -109,11 +103,8 @@
1581
109
        case Start:
103
        case Start:
1582
110
            // create the client's scope in the
104
            // create the client's scope in the
1583
111
            // Qt main thread
105
            // Qt main thread
1589
112
            if (!qtscope_impl_)
106
            qtscope_impl_.reset(qtscope_creator_());
1590
113
            {
107
            assert(qtscope_impl_);
1586
114
                qtscope_impl_ = qtscope_creator_();
1587
115
                assert(qtscope_impl_);
1588
116
            }
1591
117
            // Move the user's scope to the Qt main thread
108
            // Move the user's scope to the Qt main thread
1592
118
            qtscope_impl_->moveToThread(qtapp_->thread());
109
            qtscope_impl_->moveToThread(qtapp_->thread());
1593
119
110
1594
@@ -132,15 +123,14 @@
1595
132
    return true;
123
    return true;
1596
133
}
124
}
1597
134
125
1599
135
void QScopeBaseAPIImpl::start(std::string const& scope_id)
126
void QScopeBaseAPIImpl::start(string const& scope_id)
1600
136
{
127
{
1601
137
    // start the QT thread
128
    // start the QT thread
1602
138
    // TODO change to make_unique when using C++14
129
    // TODO change to make_unique when using C++14
1604
139
    qtthread_ = std::unique_ptr<std::thread>(new std::thread(&QScopeBaseAPIImpl::startQtThread, this));
130
    qtthread_ = unique_ptr<std::thread>(new std::thread(&QScopeBaseAPIImpl::start_qt_thread, this));
1605
140
    while (!qtapp_ready_)
131
    while (!qtapp_ready_)
1606
141
    {
132
    {
1609
142
        std::chrono::milliseconds dura(10);
133
        this_thread::sleep_for(chrono::milliseconds(10));
1608
143
        std::this_thread::sleep_for(dura);
1610
144
    }
134
    }
1611
145
135
1612
146
    // Move this class to the Qt main thread
136
    // Move this class to the Qt main thread
1613
@@ -153,7 +143,7 @@
1614
153
143
1615
154
void QScopeBaseAPIImpl::stop()
144
void QScopeBaseAPIImpl::stop()
1616
155
{
145
{
1618
156
    // Post event to initialize the object in the Qt thread
146
    // Post event to stop the object in the Qt thread
1619
157
    qtapp_->postEvent(this, new StopEvent());
147
    qtapp_->postEvent(this, new StopEvent());
1620
158
}
148
}
1621
159
149
1622
@@ -176,16 +166,17 @@
1623
176
    return sc::SearchQueryBase::UPtr(query_api);
166
    return sc::SearchQueryBase::UPtr(query_api);
1624
177
}
167
}
1625
178
168
1627
179
void QScopeBaseAPIImpl::startQtThread()
169
void QScopeBaseAPIImpl::start_qt_thread()
1628
180
{
170
{
1629
181
    if (!QCoreApplication::instance())
171
    if (!QCoreApplication::instance())
1630
182
    {
172
    {
1631
183
        int argc = 0;
173
        int argc = 0;
1632
184
        char* argv = NULL;
174
        char* argv = NULL;
1634
185
        qtapp_ = std::make_shared<QCoreApplication>(argc, &argv);
175
        qtapp_ = make_shared<QCoreApplication>(argc, &argv);
1635
186
        qtapp_ready_ = true;
176
        qtapp_ready_ = true;
1636
187
        qtapp_->exec();
177
        qtapp_->exec();
1637
188
        // delete QtCoreApplication in the same thread it was created
178
        // delete QtCoreApplication in the same thread it was created
1638
189
        qtapp_.reset();
179
        qtapp_.reset();
1639
180
        qtapp_stopped_ = true;
1640
190
    }
181
    }
1641
191
}
182
}
1642
192
183
1643
=== modified file 'test/gtest/scopes/qt/qt-bindings/CMakeLists.txt'
1644
--- test/gtest/scopes/qt/qt-bindings/CMakeLists.txt	2015-02-27 03:36:41 +0000
1645
+++ test/gtest/scopes/qt/qt-bindings/CMakeLists.txt	2015-02-27 03:36:41 +0000
1646
@@ -222,3 +222,22 @@
1647
222
qt5_use_modules(QScopeCreation_test Core)
222
qt5_use_modules(QScopeCreation_test Core)
1648
223
223
1649
224
add_test(QScopeCreation QScopeCreation_test)
224
add_test(QScopeCreation QScopeCreation_test)
1650
225
1651
226
###################################################
1652
227
1653
228
add_executable(
1654
229
  QPreviewWidget_test
1655
230
  QPreviewWidget_test.cpp)
1656
231
1657
232
target_link_libraries(
1658
233
    QPreviewWidget_test
1659
234
    ${LIBGTEST}
1660
235
    ${TESTLIBS_QT}
1661
236
    ${TESTLIBS})
1662
237
1663
238
find_package(Qt5Core REQUIRED)
1664
239
include_directories(${Qt5Core_INCLUDE_DIRS})
1665
240
1666
241
qt5_use_modules(QPreviewWidget_test Core)
1667
242
1668
243
add_test(QPreviewWidget QPreviewWidget_test)
1669
225
244
1670
=== modified file 'test/gtest/scopes/qt/qt-bindings/QCategorisedResult_test.cpp'
1671
--- test/gtest/scopes/qt/qt-bindings/QCategorisedResult_test.cpp	2015-02-27 03:36:41 +0000
1672
+++ test/gtest/scopes/qt/qt-bindings/QCategorisedResult_test.cpp	2015-02-27 03:36:41 +0000
1673
@@ -23,11 +23,15 @@
1674
23
23
1675
24
#include <unity/scopes/qt/internal/QCategorisedResultImpl.h>
24
#include <unity/scopes/qt/internal/QCategorisedResultImpl.h>
1676
25
#include <unity/scopes/qt/internal/QCategoryImpl.h>
25
#include <unity/scopes/qt/internal/QCategoryImpl.h>
1677
26
#include <unity/scopes/qt/internal/QUtils.h>
1678
26
27
1679
28
#include <unity/scopes/CategorisedResult.h>
1680
27
#include <unity/scopes/Category.h>
29
#include <unity/scopes/Category.h>
1681
28
#include <unity/scopes/CategoryRenderer.h>
30
#include <unity/scopes/CategoryRenderer.h>
1682
29
#include <unity/scopes/internal/CategoryRegistry.h>
31
#include <unity/scopes/internal/CategoryRegistry.h>
1683
30
32
1684
33
#include <unity/UnityExceptions.h>
1685
34
1686
31
using namespace unity::scopes;
35
using namespace unity::scopes;
1687
32
using namespace unity::scopes::internal;
36
using namespace unity::scopes::internal;
1688
33
using namespace unity::scopes::qt;
37
using namespace unity::scopes::qt;
1689
@@ -106,3 +110,115 @@
1690
106
        EXPECT_EQ("2", ri1.category()->id());
110
        EXPECT_EQ("2", ri1.category()->id());
1691
107
    }
111
    }
1692
108
}
112
}
1693
113
1694
114
// Tests for QResult base class
1695
115
1696
116
TEST(QCategorisedResult, QResult)
1697
117
{
1698
118
    std::shared_ptr<QCategory const> out_cat = QCategorisedResult_test::create_category("1");
1699
119
    std::shared_ptr<QCategory const> in_cat = QCategorisedResult_test::create_category("2");
1700
120
1701
121
    QCategorisedResult out_result(out_cat);
1702
122
    out_result.set_uri("test_uri1");
1703
123
    out_result.set_title("title1");
1704
124
    out_result.set_art("art1");
1705
125
    out_result.set_dnd_uri("dnd_uri1");
1706
126
    out_result["key"] = "value";
1707
127
    EXPECT_EQ("test_uri1", out_result.uri());
1708
128
    EXPECT_EQ("title1", out_result.title());
1709
129
    EXPECT_EQ("art1", out_result.art());
1710
130
    EXPECT_EQ("dnd_uri1", out_result.dnd_uri());
1711
131
    EXPECT_TRUE(out_result.contains("key"));
1712
132
    EXPECT_EQ("value", out_result.value("key"));
1713
133
    try
1714
134
    {
1715
135
        out_result.target_scope_proxy();
1716
136
        FAIL();
1717
137
    }
1718
138
    catch (unity::LogicException const& e)
1719
139
    {
1720
140
        EXPECT_STREQ("unity::LogicException: Result::target_scope_proxy(): undefined target scope", e.what());
1721
141
    }
1722
142
1723
143
    EXPECT_TRUE(out_result.direct_activation());
1724
144
    out_result.set_intercept_activation();
1725
145
    EXPECT_FALSE(out_result.direct_activation());
1726
146
1727
147
    // TODO: No way to get JSON from Qvariant at the moment.
1728
148
    std::string json = Variant(qt::internal::qvariantmap_to_variantmap(out_result.serialize())).serialize_json();
1729
149
    std::string expected = std::string(R"({"attrs":{"art":"art1","dnd_uri":"dnd_uri1","key":"value","title":"title1","uri":"test_uri1"},"internal":{"cat_id":"1","flags":1}})") + "\n";
1730
150
    EXPECT_EQ(expected, json);
1731
151
1732
152
    QCategorisedResult in_result(in_cat);
1733
153
    in_result.set_uri("test_uri2");
1734
154
    in_result.set_title("title2");
1735
155
1736
156
    EXPECT_FALSE(out_result.has_stored_result());
1737
157
    out_result.store(in_result);
1738
158
    EXPECT_TRUE(out_result.has_stored_result());
1739
159
1740
160
    QResult r = out_result.retrieve();
1741
161
    EXPECT_EQ(in_result.uri(), r.uri());  // TODO: Can't use in_result == r here because retrive() slices the class :-(
1742
162
                                          //       That's a flaw in the underlying API
1743
163
    QResult const qvc(out_result);
1744
164
    EXPECT_EQ("value", qvc["key"]);
1745
165
1746
166
    // Copy and assignment
1747
167
1748
168
    {
1749
169
        QResult c(out_result);
1750
170
        EXPECT_EQ("title1", c.title());
1751
171
    }
1752
172
1753
173
    {
1754
174
        QResult c(out_result);
1755
175
        c = in_result;
1756
176
        EXPECT_EQ("title2", c.title());
1757
177
        c = c;
1758
178
        EXPECT_EQ("title2", c.title());
1759
179
    }
1760
180
1761
181
    {
1762
182
        CategoryRegistry reg;
1763
183
        CategoryRenderer rdr;
1764
184
        auto cat = reg.register_category("1", "title", "icon", nullptr, rdr);
1765
185
        CategorisedResult result(cat);
1766
186
        result.set_title("t");
1767
187
1768
188
        // QResult construction from Result is protected.
1769
189
        struct Tester : public QResult
1770
190
        {
1771
191
            Tester(Result const& result)
1772
192
                : QResult(result)
1773
193
            {
1774
194
            }
1775
195
        };
1776
196
1777
197
        Tester t(result);
1778
198
        EXPECT_EQ("t", t.title());
1779
199
1780
200
        // QResultImpl construction from QResultImpl* is protected.
1781
201
        struct ImplTester : public qt::internal::QResultImpl
1782
202
        {
1783
203
            ImplTester(QResultImpl* qri)
1784
204
                : QResultImpl(qri)
1785
205
            {
1786
206
            }
1787
207
1788
208
            ImplTester(Result const& r)
1789
209
                : QResultImpl(r)
1790
210
            {
1791
211
                EXPECT_EQ("t", r.title());
1792
212
                qt::internal::QResultImpl* qrip = new QResultImpl(r);
1793
213
                EXPECT_EQ("t", qrip->title());
1794
214
1795
215
                // This is the real test to see that this constructor works
1796
216
                ImplTester copy(qrip);
1797
217
                EXPECT_EQ("t", copy.title());
1798
218
                delete qrip;
1799
219
            }
1800
220
        };
1801
221
1802
222
        ImplTester it(result);
1803
223
    }
1804
224
}
1805
109
225
1806
=== modified file 'test/gtest/scopes/qt/qt-bindings/QMockScope.h'
1807
--- test/gtest/scopes/qt/qt-bindings/QMockScope.h	2015-02-27 03:36:41 +0000
1808
+++ test/gtest/scopes/qt/qt-bindings/QMockScope.h	2015-02-27 03:36:41 +0000
1809
@@ -24,16 +24,19 @@
1810
24
24
1811
25
#include <QtCore/QThread>
25
#include <QtCore/QThread>
1812
26
26
1813
27
#include <mutex>
1814
28
1815
27
class QScopeMock : public QScope
29
class QScopeMock : public QScope
1816
28
{
30
{
1817
29
public:
31
public:
1818
30
    QScopeMock()
32
    QScopeMock()
1819
31
        : QScope()
33
        : QScope()
1821
32
        , qt_thread(nullptr){};
34
        , qt_thread_(nullptr){};
1822
33
35
1824
34
    void setQtThread(QThread* thread)
36
    void set_qt_thread(QThread* thread)
1825
35
    {
37
    {
1827
36
        qt_thread = thread;
38
        std::lock_guard<std::mutex> lock(mutex_);
1828
39
        qt_thread_ = thread;
1829
37
    }
40
    }
1830
38
41
1831
39
    MOCK_METHOD1(start, void(QString const&));
42
    MOCK_METHOD1(start, void(QString const&));
1832
@@ -41,17 +44,20 @@
1833
41
    virtual unity::scopes::qt::QPreviewQueryBase::UPtr preview(const unity::scopes::qt::QResult&,
44
    virtual unity::scopes::qt::QPreviewQueryBase::UPtr preview(const unity::scopes::qt::QResult&,
1834
42
                                                               const unity::scopes::qt::QActionMetadata&) override
45
                                                               const unity::scopes::qt::QActionMetadata&) override
1835
43
    {
46
    {
1837
44
        EXPECT_EQ(QThread::currentThread(), qt_thread);
47
        std::lock_guard<std::mutex> lock(mutex_);
1838
48
        EXPECT_EQ(QThread::currentThread(), qt_thread_);
1839
45
        return unity::scopes::qt::QPreviewQueryBase::UPtr(new QPreview());
49
        return unity::scopes::qt::QPreviewQueryBase::UPtr(new QPreview());
1840
46
    }
50
    }
1841
47
51
1842
48
    virtual unity::scopes::qt::QSearchQueryBase::UPtr search(unity::scopes::CannedQuery const&,
52
    virtual unity::scopes::qt::QSearchQueryBase::UPtr search(unity::scopes::CannedQuery const&,
1843
49
                                                             unity::scopes::SearchMetadata const&) override
53
                                                             unity::scopes::SearchMetadata const&) override
1844
50
    {
54
    {
1846
51
        EXPECT_EQ(QThread::currentThread(), qt_thread);
55
        std::lock_guard<std::mutex> lock(mutex_);
1847
56
        EXPECT_EQ(QThread::currentThread(), qt_thread_);
1848
52
        return unity::scopes::qt::QSearchQueryBase::UPtr(new QQuery());
57
        return unity::scopes::qt::QSearchQueryBase::UPtr(new QQuery());
1849
53
    }
58
    }
1850
54
59
1851
55
protected:
60
protected:
1853
56
    QThread* qt_thread;
61
    QThread* qt_thread_;
1854
62
    std::mutex mutex_;
1855
57
};
63
};
1856
58
64
1857
=== modified file 'test/gtest/scopes/qt/qt-bindings/QPreviewQueryBaseAPI_test.cpp'
1858
--- test/gtest/scopes/qt/qt-bindings/QPreviewQueryBaseAPI_test.cpp	2015-02-27 03:36:41 +0000
1859
+++ test/gtest/scopes/qt/qt-bindings/QPreviewQueryBaseAPI_test.cpp	2015-02-27 03:36:41 +0000
1860
@@ -138,10 +138,10 @@
1861
138
{
138
{
1862
139
    QScope scope;
139
    QScope scope;
1863
140
140
1866
141
    unity::scopes::internal::ResultImpl* resultImpl = new unity::scopes::internal::ResultImpl();
141
    unity::scopes::internal::ResultImpl resultImpl;
1867
142
    resultImpl->set_uri("test_uri");
142
    resultImpl.set_uri("test_uri");
1868
143
143
1870
144
    unity::scopes::Result result = unity::scopes::internal::ResultImpl::create_result(resultImpl->serialize());
144
    unity::scopes::Result result = unity::scopes::internal::ResultImpl::create_result(resultImpl.serialize());
1871
145
145
1872
146
    unity::scopes::CannedQuery query("scopeA", "query", "department");
146
    unity::scopes::CannedQuery query("scopeA", "query", "department");
1873
147
    unity::scopes::ActionMetadata metadata("en", "phone");
147
    unity::scopes::ActionMetadata metadata("en", "phone");
1874
148
148
1875
=== added file 'test/gtest/scopes/qt/qt-bindings/QPreviewWidget_test.cpp'
1876
--- test/gtest/scopes/qt/qt-bindings/QPreviewWidget_test.cpp	1970-01-01 00:00:00 +0000
1877
+++ test/gtest/scopes/qt/qt-bindings/QPreviewWidget_test.cpp	2015-02-27 03:36:41 +0000
1878
@@ -0,0 +1,117 @@
1879
1
/*
1880
2
 * Copyright (C) 2015 Canonical Ltd
1881
3
 *
1882
4
 * This program is free software: you can redistribute it and/or modify
1883
5
 * it under the terms of the GNU Lesser General Public License version 3 as
1884
6
 * published by the Free Software Foundation.
1885
7
 *
1886
8
 * This program is distributed in the hope that it will be useful,
1887
9
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
1888
10
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1889
11
 * GNU Lesser General Public License for more details.
1890
12
 *
1891
13
 * You should have received a copy of the GNU Lesser General Public License
1892
14
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
1893
15
 *
1894
16
 * Authored by: Michi Henning <michi.henning@canonical.com>
1895
17
 */
1896
18
1897
19
#include <gtest/gtest.h>
1898
20
1899
21
#include <unity/scopes/qt/QPreviewWidget.h>
1900
22
#include <unity/scopes/qt/internal/QPreviewWidgetImpl.h>
1901
23
1902
24
using namespace unity::scopes::qt;
1903
25
1904
26
TEST(QPreviewWidget, bindings)
1905
27
{
1906
28
    {
1907
29
        QPreviewWidget qpw("id", "video");
1908
30
1909
31
        EXPECT_EQ("id", qpw.id());
1910
32
        EXPECT_EQ("video", qpw.widget_type());
1911
33
    }
1912
34
1913
35
    {
1914
36
        QPreviewWidget qpw(R"({"id": "img", "type": "image", "components": { "source": "screenshot-url" } })");
1915
37
1916
38
        EXPECT_EQ("img", qpw.id());
1917
39
        EXPECT_EQ("image", qpw.widget_type());
1918
40
1919
41
        auto am = qpw.attribute_mappings();
1920
42
        ASSERT_EQ(1, am.size());
1921
43
        EXPECT_EQ("screenshot-url", am.value("source"));
1922
44
1923
45
        auto av = qpw.attribute_values();
1924
46
        ASSERT_EQ(0, av.size());
1925
47
1926
48
        auto widgets = qpw.widgets();
1927
49
        ASSERT_EQ(0, widgets.size());
1928
50
1929
51
        QPreviewWidget qpw2(qpw);
1930
52
1931
53
        EXPECT_EQ("img", qpw2.id());
1932
54
        EXPECT_EQ("image", qpw2.widget_type());
1933
55
1934
56
        QPreviewWidget qpw3("xxx", "audio");
1935
57
        qpw3 = qpw2;
1936
58
        EXPECT_EQ("img", qpw3.id());
1937
59
        EXPECT_EQ("image", qpw3.widget_type());
1938
60
1939
61
        qpw3 = qpw3;
1940
62
        EXPECT_EQ("img", qpw3.id());
1941
63
        EXPECT_EQ("image", qpw3.widget_type());
1942
64
1943
65
        QPreviewWidget parent_widget("parent", "expandable");
1944
66
        parent_widget.add_widget(qpw);
1945
67
        widgets = parent_widget.widgets();
1946
68
        ASSERT_EQ(1, widgets.size());
1947
69
        EXPECT_EQ("img", widgets.at(0).id());
1948
70
1949
71
        qpw.add_attribute_value("key", "value");
1950
72
        av = qpw.attribute_values();
1951
73
        ASSERT_EQ(1, av.size());
1952
74
        EXPECT_EQ("value", av.value("key"));
1953
75
1954
76
        qpw.add_attribute_mapping("attr", "field");
1955
77
        am = qpw.attribute_mappings();
1956
78
        ASSERT_EQ(2, am.size());
1957
79
        EXPECT_EQ("field", am.value("attr"));
1958
80
    }
1959
81
1960
82
    {
1961
83
        QString data = R"({"components":{"source":"screenshot-url"},"id":"img","key":"value","type":"image"})";
1962
84
        QPreviewWidget qpw(data);
1963
85
        EXPECT_EQ(data + "\n", qpw.data());  // Underlying scopes API appends a newline
1964
86
1965
87
        auto vm = qpw.serialize();
1966
88
        ASSERT_EQ(4, vm.size());
1967
89
        EXPECT_EQ("img", vm.value("id"));
1968
90
        EXPECT_EQ("image", vm.value("type"));
1969
91
        auto attrs = vm.value("attributes").toMap();
1970
92
        ASSERT_EQ(1, attrs.size());
1971
93
        EXPECT_EQ("value", attrs.value("key").toString());
1972
94
        auto components = vm.value("components").toMap();
1973
95
        ASSERT_EQ(1, components.size());
1974
96
        EXPECT_EQ("screenshot-url", components.value("source").toString());
1975
97
    }
1976
98
1977
99
    {
1978
100
        internal::QPreviewWidgetImpl i("id", "audio");
1979
101
        EXPECT_EQ("id", i.id());
1980
102
        EXPECT_EQ("audio", i.widget_type());
1981
103
1982
104
        internal::QPreviewWidgetImpl i2(i);
1983
105
        EXPECT_EQ("id", i2.id());
1984
106
        EXPECT_EQ("audio", i2.widget_type());
1985
107
1986
108
        internal::QPreviewWidgetImpl i3("xxx", "video");
1987
109
        i = i3;
1988
110
        EXPECT_EQ("xxx", i.id());
1989
111
        EXPECT_EQ("video", i.widget_type());
1990
112
1991
113
        i = i;
1992
114
        EXPECT_EQ("xxx", i.id());
1993
115
        EXPECT_EQ("video", i.widget_type());
1994
116
    }
1995
117
}
1996
0
118
1997
=== modified file 'test/gtest/scopes/qt/qt-bindings/QScopeBaseAPIImpl_test.cpp'
1998
--- test/gtest/scopes/qt/qt-bindings/QScopeBaseAPIImpl_test.cpp	2015-02-27 03:36:41 +0000
1999
+++ test/gtest/scopes/qt/qt-bindings/QScopeBaseAPIImpl_test.cpp	2015-02-27 03:36:41 +0000
2000
@@ -35,33 +35,33 @@
2001
35
35
2002
36
TEST(TestSetup, bindings)
36
TEST(TestSetup, bindings)
2003
37
{
37
{
2005
38
    QScopeMock scope;
38
    QScopeMock* scope = new QScopeMock;
2006
39
39
2007
40
    // construct the QSearchQueryBaseAPIMock
40
    // construct the QSearchQueryBaseAPIMock
2009
41
    QScopeBaseAPIMock api_scope(scope);
41
    QScopeBaseAPIMock api_scope([scope]{ return scope; });
2010
42
42
2011
43
    // verify that the event method is called for start event
43
    // verify that the event method is called for start event
2013
44
    EXPECT_CALL(scope, start(_)).Times(Exactly(1));
44
    EXPECT_CALL(*scope, start(_)).Times(Exactly(1));
2014
45
    api_scope.start("test_scope");
45
    api_scope.start("test_scope");
2015
46
46
2018
47
    QThread* qt_thread = api_scope.getQtAppThread();
47
    QThread* qt_thread = api_scope.get_qt_app_thread();
2019
48
    scope.setQtThread(qt_thread);
48
    scope->set_qt_thread(qt_thread);
2020
49
49
2022
50
    auto CheckThread = [qt_thread]() -> void
50
    auto check_thread = [qt_thread]() -> void
2023
51
    {
51
    {
2024
52
        EXPECT_EQ(qt_thread, QThread::currentThread());
52
        EXPECT_EQ(qt_thread, QThread::currentThread());
2025
53
    };
53
    };
2026
54
54
2029
55
    unity::scopes::internal::ResultImpl* resultImpl = new unity::scopes::internal::ResultImpl();
55
    unity::scopes::internal::ResultImpl resultImpl;
2030
56
    resultImpl->set_uri("test_uri");
56
    resultImpl.set_uri("test_uri");
2031
57
57
2033
58
    unity::scopes::Result result = unity::scopes::internal::ResultImpl::create_result(resultImpl->serialize());
58
    unity::scopes::Result result = unity::scopes::internal::ResultImpl::create_result(resultImpl.serialize());
2034
59
59
2035
60
    unity::scopes::CannedQuery query("scopeA", "query", "department");
60
    unity::scopes::CannedQuery query("scopeA", "query", "department");
2036
61
    unity::scopes::ActionMetadata action_metadata("en", "phone");
61
    unity::scopes::ActionMetadata action_metadata("en", "phone");
2037
62
62
2038
63
    // verify that the event method is called for stop event and
63
    // verify that the event method is called for stop event and
2039
64
    // that the thread is the Qt thread
64
    // that the thread is the Qt thread
2041
65
    EXPECT_CALL(scope, stop()).Times(Exactly(1)).WillOnce(Invoke(CheckThread));
65
    EXPECT_CALL(*scope, stop()).Times(Exactly(1)).WillOnce(Invoke(check_thread));
2042
66
    api_scope.stop();
66
    api_scope.stop();
2043
67
}
67
}
2044
68
68
2045
=== modified file 'test/gtest/scopes/qt/qt-bindings/QScopeBaseAPIMock.h'
2046
--- test/gtest/scopes/qt/qt-bindings/QScopeBaseAPIMock.h	2015-02-27 03:36:41 +0000
2047
+++ test/gtest/scopes/qt/qt-bindings/QScopeBaseAPIMock.h	2015-02-27 03:36:41 +0000
2048
@@ -29,14 +29,14 @@
2049
29
class QScopeBaseAPIMock : public unity::scopes::qt::internal::QScopeBaseAPIImpl
29
class QScopeBaseAPIMock : public unity::scopes::qt::internal::QScopeBaseAPIImpl
2050
30
{
30
{
2051
31
public:
31
public:
2054
32
    QScopeBaseAPIMock(unity::scopes::qt::QScopeBase& qtscope, QObject* parent = 0)
32
    QScopeBaseAPIMock(QScopeBaseAPIImpl::FactoryFunc const& creator)
2055
33
        : unity::scopes::qt::internal::QScopeBaseAPIImpl(qtscope, parent)
33
        : unity::scopes::qt::internal::QScopeBaseAPIImpl(creator)
2056
34
    {
34
    {
2057
35
    }
35
    }
2058
36
36
2059
37
    virtual ~QScopeBaseAPIMock() = default;
37
    virtual ~QScopeBaseAPIMock() = default;
2060
38
38
2062
39
    QThread* getQtAppThread()
39
    QThread* get_qt_app_thread()
2063
40
    {
40
    {
2064
41
        return qtapp_->thread();
41
        return qtapp_->thread();
2065
42
    }
42
    }
2066
43
43
2067
=== modified file 'test/gtest/scopes/qt/qt-bindings/QScopeCreation_test.cpp'
2068
--- test/gtest/scopes/qt/qt-bindings/QScopeCreation_test.cpp	2015-02-27 03:36:41 +0000
2069
+++ test/gtest/scopes/qt/qt-bindings/QScopeCreation_test.cpp	2015-02-27 03:36:41 +0000
2070
@@ -43,8 +43,8 @@
2071
43
class QScopeBaseAPIImplTest : public QScopeBaseAPIImpl
43
class QScopeBaseAPIImplTest : public QScopeBaseAPIImpl
2072
44
{
44
{
2073
45
public:
45
public:
2076
46
    QScopeBaseAPIImplTest(FactoryFunc const& creator, QObject* parent = 0)
46
    QScopeBaseAPIImplTest(FactoryFunc const& creator)
2077
47
        : QScopeBaseAPIImpl(creator, parent)
47
        : QScopeBaseAPIImpl(creator)
2078
48
    {
48
    {
2079
49
    }
49
    }
2080
50
50
2081
@@ -52,6 +52,11 @@
2082
52
    {
52
    {
2083
53
        return qtapp_->thread();
53
        return qtapp_->thread();
2084
54
    }
54
    }
2085
55
2086
56
    bool qtapp_stopped()
2087
57
    {
2088
58
        return qtapp_stopped_;
2089
59
    }
2090
55
};
60
};
2091
56
61
2092
57
QScopeBase* create_my_scope()
62
QScopeBase* create_my_scope()
2093
@@ -85,4 +90,9 @@
2094
85
90
2095
86
    // stop the Qt application
91
    // stop the Qt application
2096
87
    impl.stop();
92
    impl.stop();
2097
93
2098
94
    while (!impl.qtapp_stopped())
2099
95
    {
2100
96
        std::this_thread::sleep_for(std::chrono::milliseconds(10));
2101
97
    }
2102
88
}
98
}
2103
89
99
2104
=== modified file 'test/headers/CMakeLists.txt'
2105
--- test/headers/CMakeLists.txt	2015-02-05 14:57:01 +0000
2106
+++ test/headers/CMakeLists.txt	2015-02-27 03:36:41 +0000
2107
@@ -5,7 +5,7 @@
2108
5
set(root_inc_dir ${CMAKE_SOURCE_DIR}/include)
5
set(root_inc_dir ${CMAKE_SOURCE_DIR}/include)
2109
6
6
2110
7
set(subdirs
7
set(subdirs
2112
8
    unity/scopes/
8
    unity/scopes
2113
9
    unity/scopes/qt
9
    unity/scopes/qt
2114
10
    unity/scopes/testing
10
    unity/scopes/testing
2115
11
    unity/scopes/utility
11
    unity/scopes/utility
2116
@@ -56,4 +56,4 @@
2117
56
56
2118
57
add_test(cleanincludes ${CMAKE_CURRENT_SOURCE_DIR}/includechecker.py ${CMAKE_SOURCE_DIR}/include)
57
add_test(cleanincludes ${CMAKE_CURRENT_SOURCE_DIR}/includechecker.py ${CMAKE_SOURCE_DIR}/include)
2119
58
add_test(noglobalincludes ${CMAKE_CURRENT_SOURCE_DIR}/check_global_usage.py
58
add_test(noglobalincludes ${CMAKE_CURRENT_SOURCE_DIR}/check_global_usage.py
2121
59
${CMAKE_SOURCE_DIR}/include ${CMAKE_BINARY_DIR}/include)
59
         ${CMAKE_SOURCE_DIR}/include ${CMAKE_BINARY_DIR}/include)
Status:	Merged
Approved by:	Paweł Stołowski on 2015-02-27
Approved revision:	340
Merged at revision:	562
Proposed branch:	lp:~michihenning/unity-scopes-api/qt-coverage-2
Merge into:	lp:unity-scopes-api/devel
Prerequisite:	lp:~michihenning/unity-scopes-api/qt-coverage
Diff against target:	2121 lines (+393/-860) (has conflicts) 42 files modified CTestCustom.cmake.in (+6/-0) HACKING (+36/-0) debian/libunity-scopes-qt.symbols (+0/-1) include/unity/scopes/ScopeBase.h (+4/-6) include/unity/scopes/qt/QActionMetadata.h (+0/-1) include/unity/scopes/qt/QPreviewQueryBase.h (+0/-1) include/unity/scopes/qt/QPreviewReply.h (+0/-1) include/unity/scopes/qt/QResult.h (+0/-1) include/unity/scopes/qt/QScopeBase.h (+12/-15) include/unity/scopes/qt/QScopeBaseAPI.h (+0/-5) include/unity/scopes/qt/QSearchMetadata.h (+0/-1) include/unity/scopes/qt/QSearchQueryBase.h (+0/-1) include/unity/scopes/qt/QSearchReply.h (+0/-1) include/unity/scopes/qt/internal/QActionMetadataImpl.h (+5/-71) include/unity/scopes/qt/internal/QCategorisedResultImpl.h (+1/-22) include/unity/scopes/qt/internal/QCategoryImpl.h (+0/-27) include/unity/scopes/qt/internal/QColumnLayoutImpl.h (+2/-45) include/unity/scopes/qt/internal/QPreviewQueryBaseImpl.h (+0/-13) include/unity/scopes/qt/internal/QPreviewReplyImpl.h (+3/-32) include/unity/scopes/qt/internal/QPreviewWidgetImpl.h (+1/-110) include/unity/scopes/qt/internal/QResultImpl.h (+0/-155) include/unity/scopes/qt/internal/QScopeBaseAPIImpl.h (+4/-37) include/unity/scopes/qt/internal/QScopeBaseImpl.h (+1/-9) include/unity/scopes/qt/internal/QScopeVariant.h (+0/-4) include/unity/scopes/qt/internal/QSearchMetadataImpl.h (+2/-89) include/unity/scopes/qt/internal/QSearchQueryBaseImpl.h (+0/-26) include/unity/scopes/qt/internal/QSearchReplyImpl.h (+1/-80) include/unity/scopes/qt/internal/QUtils.h (+0/-4) src/scopes/qt/QActionMetadata.cpp (+1/-1) src/scopes/qt/QPreviewWidget.cpp (+1/-1) src/scopes/qt/QResult.cpp (+1/-6) src/scopes/qt/internal/QResultImpl.cpp (+5/-46) src/scopes/qt/internal/QScopeBaseAPIImpl.cpp (+13/-22) test/gtest/scopes/qt/qt-bindings/CMakeLists.txt (+19/-0) test/gtest/scopes/qt/qt-bindings/QCategorisedResult_test.cpp (+116/-0) test/gtest/scopes/qt/qt-bindings/QMockScope.h (+12/-6) test/gtest/scopes/qt/qt-bindings/QPreviewQueryBaseAPI_test.cpp (+3/-3) test/gtest/scopes/qt/qt-bindings/QPreviewWidget_test.cpp (+117/-0) test/gtest/scopes/qt/qt-bindings/QScopeBaseAPIImpl_test.cpp (+10/-10) test/gtest/scopes/qt/qt-bindings/QScopeBaseAPIMock.h (+3/-3) test/gtest/scopes/qt/qt-bindings/QScopeCreation_test.cpp (+12/-2) test/headers/CMakeLists.txt (+2/-2) Text conflict in debian/changelog
To merge this branch:	bzr merge lp:~michihenning/unity-scopes-api/qt-coverage-2
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
PS Jenkins bot (community)	continuous-integration	2015-02-27	Approve on 2015-03-02
Paweł Stołowski (community)		2015-02-27	Approve on 2015-02-27
Review via email: mp+251200@code.launchpad.net