1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#pragma once
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <com/sun/star/rendering/TextDirection.hpp>
#include <osl/mutex.hxx>
#include <verifyinput.hxx>
namespace com::sun::star::beans { struct PropertyValue; }
namespace com::sun::star::geometry { class XMapping2D; }
namespace com::sun::star::rendering { class XBitmap; }
namespace com::sun::star::rendering { class XCachedPrimitive; }
namespace com::sun::star::rendering { class XCanvasFont; }
namespace com::sun::star::rendering { class XGraphicDevice; }
namespace com::sun::star::rendering { class XPolyPolygon2D; }
namespace com::sun::star::rendering { class XTextLayout; }
namespace com::sun::star::rendering { struct FontInfo; }
namespace com::sun::star::rendering { struct StringContext; }
namespace canvas
{
/** Helper template to handle XCanvas method forwarding to CanvasHelper
Use this helper to handle the XCanvas part of your
implementation. In theory, we could have provided CanvasHelper
and CanvasBase as a single template, but that would duplicate
a lot of code now residing in CanvasHelper only.
This template basically interposes itself between the full
interface you implement (i.e. not restricted to XCanvas. The
problem with UNO partial interface implementation actually is,
that you cannot do it the plain way, since deriving from a
common base subclass always introduces the whole set of pure
virtuals, that your baseclass helper just overridden) and your
implementation class. You then only have to implement the
functionality <em>besides</em> XCanvas.
<pre>
Example:
typedef ::cppu::WeakComponentImplHelper < css::rendering::XSpriteCanvas,
css::lang::XInitialization,
css::lang::XServiceInfo,
css::lang::XServiceName > CanvasBase_Base;
typedef ::canvas::internal::CanvasBase< CanvasBase_Base, CanvasHelper > ExampleCanvas_Base;
class ExampleCanvas : public ExampleCanvas_Base,
public SpriteSurface,
public RepaintTarget
{
};
</pre>
@tpl Base
Base class to use, most probably the
WeakComponentImplHelper template with the appropriate
interfaces. At least XCanvas should be among them (why else
would you use this template, then?). Base class must have an
Base( const Mutex& ) constructor (like the
WeakComponentImplHelper template has). As the very least,
the base class must be derived from uno::XInterface, as some
error reporting mechanisms rely on that.
@tpl CanvasHelper
Canvas helper implementation for the backend in question. This
object will be held as a member of this template class, and
basically gets forwarded all XCanvas API calls. Furthermore,
every time the canvas API semantically changes the content of
the canvas, CanvasHelper::modifying() will get called
(<em>before</em> the actual modification takes place).
@tpl Mutex
Lock strategy to use. Defaults to using the
BaseMutex-provided lock. Every time one of the methods is
entered, an object of type Mutex is created with m_aMutex as
the sole parameter, and destroyed again when the method scope
is left.
@tpl UnambiguousBase
Optional unambiguous base class for XInterface of Base. It's
sometimes necessary to specify this parameter, e.g. if Base
derives from multiple UNO interface (were each provides its
own version of XInterface, making the conversion ambiguous)
*/
template< class Base,
class CanvasHelper,
class Mutex=::osl::MutexGuard,
class UnambiguousBase=css::uno::XInterface > class CanvasBase :
public Base
{
public:
typedef Base BaseType;
typedef Mutex MutexType;
typedef UnambiguousBase UnambiguousBaseType;
/** Create CanvasBase
*/
CanvasBase() :
maCanvasHelper(),
mbSurfaceDirty( true )
{
}
virtual void disposeThis() override
{
MutexType aGuard( BaseType::m_aMutex );
maCanvasHelper.disposing();
// pass on to base class
BaseType::disposeThis();
}
// XCanvas
virtual void SAL_CALL clear() override
{
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
maCanvasHelper.clear();
}
virtual void SAL_CALL drawPoint(const css::geometry::RealPoint2D& aPoint,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState) override
{
tools::verifyArgs(aPoint, viewState, renderState,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
}
virtual void SAL_CALL drawLine(const css::geometry::RealPoint2D& aStartPoint,
const css::geometry::RealPoint2D& aEndPoint,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState) override
{
tools::verifyArgs(aStartPoint, aEndPoint, viewState, renderState,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
maCanvasHelper.drawLine( this, aStartPoint, aEndPoint, viewState, renderState );
}
virtual void SAL_CALL drawBezier( const css::geometry::RealBezierSegment2D& aBezierSegment,
const css::geometry::RealPoint2D& aEndPoint,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState ) override
{
tools::verifyArgs(aBezierSegment, aEndPoint, viewState, renderState,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
maCanvasHelper.drawBezier( this, aBezierSegment, aEndPoint, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
drawPolyPolygon(const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.drawPolyPolygon( this, xPolyPolygon, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
strokePolyPolygon(const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::rendering::StrokeAttributes& strokeAttributes) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, strokeAttributes,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.strokePolyPolygon( this, xPolyPolygon, viewState, renderState, strokeAttributes );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
strokeTexturedPolyPolygon( const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence< css::rendering::Texture >& textures,
const css::rendering::StrokeAttributes& strokeAttributes ) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, strokeAttributes,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.strokeTexturedPolyPolygon( this, xPolyPolygon, viewState, renderState, textures, strokeAttributes );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
strokeTextureMappedPolyPolygon( const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence< css::rendering::Texture >& textures,
const css::uno::Reference< css::geometry::XMapping2D >& xMapping,
const css::rendering::StrokeAttributes& strokeAttributes ) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, textures, xMapping, strokeAttributes,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.strokeTextureMappedPolyPolygon( this, xPolyPolygon, viewState, renderState, textures, xMapping, strokeAttributes );
}
virtual css::uno::Reference< css::rendering::XPolyPolygon2D > SAL_CALL
queryStrokeShapes( const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::rendering::StrokeAttributes& strokeAttributes ) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, strokeAttributes,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.queryStrokeShapes( this, xPolyPolygon, viewState, renderState, strokeAttributes );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
fillPolyPolygon(const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.fillPolyPolygon( this, xPolyPolygon, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
fillTexturedPolyPolygon(const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence< css::rendering::Texture >& textures) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, textures,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.fillTexturedPolyPolygon( this, xPolyPolygon, viewState, renderState, textures );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
fillTextureMappedPolyPolygon( const css::uno::Reference< css::rendering::XPolyPolygon2D >& xPolyPolygon,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
const css::uno::Sequence< css::rendering::Texture >& textures,
const css::uno::Reference< css::geometry::XMapping2D >& xMapping ) override
{
tools::verifyArgs(xPolyPolygon, viewState, renderState, textures, xMapping,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.fillTextureMappedPolyPolygon( this, xPolyPolygon, viewState, renderState, textures, xMapping );
}
virtual css::uno::Reference< css::rendering::XCanvasFont > SAL_CALL
createFont( const css::rendering::FontRequest& fontRequest,
const css::uno::Sequence< css::beans::PropertyValue >& extraFontProperties,
const css::geometry::Matrix2D& fontMatrix ) override
{
tools::verifyArgs(fontRequest,
// dummy, to keep argPos in sync
fontRequest,
fontMatrix,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
return maCanvasHelper.createFont( this, fontRequest, extraFontProperties, fontMatrix );
}
virtual css::uno::Sequence< css::rendering::FontInfo > SAL_CALL
queryAvailableFonts( const css::rendering::FontInfo& aFilter,
const css::uno::Sequence< css::beans::PropertyValue >& aFontProperties ) override
{
tools::verifyArgs(aFilter,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
return maCanvasHelper.queryAvailableFonts( this, aFilter, aFontProperties );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
drawText(const css::rendering::StringContext& text,
const css::uno::Reference< css::rendering::XCanvasFont >& xFont,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState,
sal_Int8 textDirection) override
{
tools::verifyArgs(xFont, viewState, renderState,
__func__,
static_cast< UnambiguousBaseType* >(this));
tools::verifyRange( textDirection,
css::rendering::TextDirection::WEAK_LEFT_TO_RIGHT,
css::rendering::TextDirection::STRONG_RIGHT_TO_LEFT );
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.drawText( this, text, xFont, viewState, renderState, textDirection );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
drawTextLayout(const css::uno::Reference< css::rendering::XTextLayout >& laidOutText,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState) override
{
tools::verifyArgs(laidOutText, viewState, renderState,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.drawTextLayout( this, laidOutText, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
drawBitmap( const css::uno::Reference< css::rendering::XBitmap >& xBitmap,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState ) override
{
tools::verifyArgs(xBitmap, viewState, renderState,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.drawBitmap( this, xBitmap, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XCachedPrimitive > SAL_CALL
drawBitmapModulated( const css::uno::Reference< css::rendering::XBitmap >& xBitmap,
const css::rendering::ViewState& viewState,
const css::rendering::RenderState& renderState ) override
{
tools::verifyArgs(xBitmap, viewState, renderState,
__func__,
static_cast< UnambiguousBaseType* >(this));
MutexType aGuard( BaseType::m_aMutex );
mbSurfaceDirty = true;
return maCanvasHelper.drawBitmapModulated( this, xBitmap, viewState, renderState );
}
virtual css::uno::Reference< css::rendering::XGraphicDevice > SAL_CALL
getDevice() override
{
MutexType aGuard( BaseType::m_aMutex );
return maCanvasHelper.getDevice();
}
protected:
~CanvasBase() {} // we're a ref-counted UNO class. _We_ destroy ourselves.
CanvasHelper maCanvasHelper;
mutable bool mbSurfaceDirty;
private:
CanvasBase( const CanvasBase& ) = delete;
CanvasBase& operator=( const CanvasBase& ) = delete;
};
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
