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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
|
/* -*- 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/lang/IllegalArgumentException.hpp>
#include <canvas/canvastoolsdllapi.h>
namespace com::sun::star::geometry
{
struct RealPoint2D;
struct RealSize2D;
struct RealBezierSegment2D;
struct RealRectangle2D;
struct AffineMatrix2D;
struct Matrix2D;
struct IntegerPoint2D;
struct IntegerSize2D;
struct IntegerRectangle2D;
}
namespace com::sun::star::rendering
{
struct RenderState;
struct StrokeAttributes;
struct Texture;
struct ViewState;
struct IntegerBitmapLayout;
struct FontRequest;
}
namespace com::sun::star::uno { template <class E> class Sequence; }
namespace canvas
{
namespace tools
{
// Input checking facilities
// This header provides methods to check all common
// css::rendering::* method input parameters against
// compliance to the API specification.
/** Verify that the given transformation contains valid floating point
values.
@param rMatrix
Matrix to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::geometry::AffineMatrix2D& rMatrix,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos );
/** Verify that the given transformation contains valid floating point
values.
@param rMatrix
Matrix to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::geometry::Matrix2D& rMatrix,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos );
/** Verify that the given point contains valid floating point
values.
@param rPoint
Point to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::geometry::RealPoint2D& rPoint,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos );
/** Verify that the given bezier segment contains valid
floating point values.
@param rSegment
Segment to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::geometry::RealBezierSegment2D& rSegment,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos );
/** Verify that the given rectangle contains valid floating
point values.
@param rRect
Rect to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::geometry::RealRectangle2D& rRect,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos );
/** Basic check for view state validity.
@param viewState
Viewstate to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::rendering::ViewState& viewState,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos );
/** Basic check for render state validity.
@param renderState
Renderstate to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@param nMinColorComponents
Minimal number of color components available in
RenderState::DeviceColor
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::rendering::RenderState& renderState,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos,
sal_Int32 nMinColorComponents=0 );
/** Basic check for stroke attributes validity.
@param strokeAttributes
Attributes to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::rendering::StrokeAttributes& strokeAttributes,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos );
/** Basic check for texture validity.
@param texture
Texture to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::rendering::Texture& texture,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos );
/** Basic check for bitmap layout validity.
@param bitmapLayout
Bitmap layout to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::rendering::IntegerBitmapLayout& bitmapLayout,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos );
/** Basic check for font request validity.
@param fontRequest
Font request to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
CANVASTOOLS_DLLPUBLIC void verifyInput( const css::rendering::FontRequest& fontRequest,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos );
/** Templatized check for uno::Reference validity.
@param rRef
Reference to check against non-NILness
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
template< class Interface > void verifyInput(
const css::uno::Reference< Interface >& rRef,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos )
{
if( !rRef.is() )
{
#if OSL_DEBUG_LEVEL > 0
throw css::lang::IllegalArgumentException(
OUString::createFromAscii(pStr) + ": reference is NULL",
xIf,
nArgPos );
#else
(void)pStr; (void)xIf; (void)nArgPos;
throw css::lang::IllegalArgumentException();
#endif
}
}
/** Templatized check for content-of-sequence validity.
@param rSequence
Sequence of things to check
@param xIf
The interface that should be reported as the one
generating the exception.
@param nArgPos
Argument position on the call site (i.e. the position of
the argument, checked here, on the UNO interface
method. Counting starts at 0).
@throws a lang::IllegalArgumentException, if anything is wrong
*/
template< typename SequenceContent > void verifyInput(
const css::uno::Sequence< SequenceContent >& rSequence,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf,
::sal_Int16 nArgPos )
{
const SequenceContent* pCurr = rSequence.getConstArray();
const SequenceContent* pEnd = pCurr + rSequence.getLength();
while( pCurr != pEnd )
verifyInput( *pCurr++, pStr, xIf, nArgPos );
}
/// Catch-all, to handle cases that DON'T need input checking (i.e. the Integer geometry ones)
template< typename T > void verifyInput( const T& /*rDummy*/,
const char* /*pStr*/,
const css::uno::Reference< css::uno::XInterface >& /*xIf*/,
::sal_Int16 /*nArgPos*/ )
{
}
// TODO(Q2): Employ some template arglist magic here, to avoid
// this duplication of code...
template< typename Arg0 > void verifyArgs( const Arg0& rArg0,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf )
{
verifyInput( rArg0, pStr, xIf, 0 );
}
template< typename Arg0,
typename Arg1 > void verifyArgs( const Arg0& rArg0,
const Arg1& rArg1,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf )
{
verifyInput( rArg0, pStr, xIf, 0 );
verifyInput( rArg1, pStr, xIf, 1 );
}
template< typename Arg0,
typename Arg1,
typename Arg2 > void verifyArgs( const Arg0& rArg0,
const Arg1& rArg1,
const Arg2& rArg2,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf )
{
verifyInput( rArg0, pStr, xIf, 0 );
verifyInput( rArg1, pStr, xIf, 1 );
verifyInput( rArg2, pStr, xIf, 2 );
}
template< typename Arg0,
typename Arg1,
typename Arg2,
typename Arg3 > void verifyArgs( const Arg0& rArg0,
const Arg1& rArg1,
const Arg2& rArg2,
const Arg3& rArg3,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf )
{
verifyInput( rArg0, pStr, xIf, 0 );
verifyInput( rArg1, pStr, xIf, 1 );
verifyInput( rArg2, pStr, xIf, 2 );
verifyInput( rArg3, pStr, xIf, 3 );
}
template< typename Arg0,
typename Arg1,
typename Arg2,
typename Arg3,
typename Arg4 > void verifyArgs( const Arg0& rArg0,
const Arg1& rArg1,
const Arg2& rArg2,
const Arg3& rArg3,
const Arg4& rArg4,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf )
{
verifyInput( rArg0, pStr, xIf, 0 );
verifyInput( rArg1, pStr, xIf, 1 );
verifyInput( rArg2, pStr, xIf, 2 );
verifyInput( rArg3, pStr, xIf, 3 );
verifyInput( rArg4, pStr, xIf, 4 );
}
template< typename Arg0,
typename Arg1,
typename Arg2,
typename Arg3,
typename Arg4,
typename Arg5 > void verifyArgs( const Arg0& rArg0,
const Arg1& rArg1,
const Arg2& rArg2,
const Arg3& rArg3,
const Arg4& rArg4,
const Arg5& rArg5,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf )
{
verifyInput( rArg0, pStr, xIf, 0 );
verifyInput( rArg1, pStr, xIf, 1 );
verifyInput( rArg2, pStr, xIf, 2 );
verifyInput( rArg3, pStr, xIf, 3 );
verifyInput( rArg4, pStr, xIf, 4 );
verifyInput( rArg5, pStr, xIf, 5 );
}
template< typename Arg0,
typename Arg1,
typename Arg2,
typename Arg3,
typename Arg4,
typename Arg5,
typename Arg6 > void verifyArgs( const Arg0& rArg0,
const Arg1& rArg1,
const Arg2& rArg2,
const Arg3& rArg3,
const Arg4& rArg4,
const Arg5& rArg5,
const Arg6& rArg6,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf )
{
verifyInput( rArg0, pStr, xIf, 0 );
verifyInput( rArg1, pStr, xIf, 1 );
verifyInput( rArg2, pStr, xIf, 2 );
verifyInput( rArg3, pStr, xIf, 3 );
verifyInput( rArg4, pStr, xIf, 4 );
verifyInput( rArg5, pStr, xIf, 5 );
verifyInput( rArg6, pStr, xIf, 6 );
}
/** Range checker, which throws css::lang::IllegalArgument exception, when
range is violated
*/
template< typename NumType > inline void verifyRange( NumType arg, NumType lowerBound, NumType upperBound )
{
if( arg < lowerBound ||
arg > upperBound )
{
throw css::lang::IllegalArgumentException();
}
}
/** Range checker, which throws css::lang::IllegalArgument exception, when
range is violated
The checked range is half open, i.e. only bound by the specified value.
@param arg
Arg to check
@param bound
Bound to check against
@param bLowerBound
When true, given bound is the lower bound. When false,
given bound is the upper bound.
*/
template< typename NumType > inline void verifyRange( NumType arg, NumType bound, bool bLowerBound=true )
{
if( (bLowerBound && arg < bound) ||
(!bLowerBound && arg > bound) )
{
throw css::lang::IllegalArgumentException();
}
}
/** Range checker, which throws css::lang::IndexOutOfBounds exception, when
index range is violated
@param rect
Rect to verify
@param size
Given rectangle must be within ((0,0), (size.Width, size.Height))
*/
CANVASTOOLS_DLLPUBLIC void verifyIndexRange( const css::geometry::IntegerRectangle2D& rect,
const css::geometry::IntegerSize2D& size );
/** Range checker, which throws css::lang::IndexOutOfBounds exception, when
index range is violated
@param pos
Position to verify
@param size
Given position must be within ((0,0), (size.Width, size.Height))
*/
CANVASTOOLS_DLLPUBLIC void verifyIndexRange( const css::geometry::IntegerPoint2D& pos,
const css::geometry::IntegerSize2D& size );
/** Range checker, which throws css::lang::IndexOutOfBounds exception, when
the size is negative or null
@param size
Size to verify
*/
CANVASTOOLS_DLLPUBLIC void verifyBitmapSize( const css::geometry::IntegerSize2D& size,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf );
/** Range checker, which throws css::lang::IndexOutOfBounds exception, when
the size is negative or null
@param size
Size to verify
*/
CANVASTOOLS_DLLPUBLIC void verifySpriteSize( const css::geometry::RealSize2D& size,
const char* pStr,
const css::uno::Reference< css::uno::XInterface >& xIf );
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
