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
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
|
/* -*- 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 .
*/
#ifndef COMPHELPER_LOGGING_HXX
#define COMPHELPER_LOGGING_HXX
#include <comphelper/comphelperdllapi.h>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/logging/XLogHandler.hpp>
#include <com/sun/star/logging/LogLevel.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/optional.hpp>
//........................................................................
namespace comphelper
{
//........................................................................
//====================================================================
//= string conversions, employed by the templatized log* members of
//= EventLogger
//====================================================================
namespace log { namespace convert
{
inline const OUString& convertLogArgToString( const OUString& _rValue )
{
return _rValue;
}
inline OUString convertLogArgToString( const sal_Char* _pAsciiValue )
{
return OUString::createFromAscii( _pAsciiValue );
}
inline OUString convertLogArgToString( double _nValue ) { return OUString::valueOf( _nValue ); }
inline OUString convertLogArgToString( float _nValue ) { return OUString::valueOf( _nValue ); }
inline OUString convertLogArgToString( sal_Int64 _nValue ) { return OUString::valueOf( _nValue ); }
inline OUString convertLogArgToString( sal_Int32 _nValue ) { return OUString::valueOf( _nValue ); }
inline OUString convertLogArgToString( sal_Int16 _nValue ) { return OUString::valueOf( (sal_Int32)_nValue ); }
inline OUString convertLogArgToString( sal_Unicode _nValue ) { return OUString::valueOf( _nValue ); }
inline OUString convertLogArgToString( sal_Bool _nValue ) { return OUString::valueOf( _nValue ); }
} } // namespace log::convert
//====================================================================
//= EventLogger
//====================================================================
class EventLogger_Impl;
typedef ::boost::optional< OUString > OptionalString;
/** encapsulates an com::sun::star::logging::XLogger
The class silences several (unlikely) errors which could potentially happen
when working with a logger. Additionally, it provides some convenience methods
for logging events.
You can use this class as follows
<pre>
EventLogger aLogger( xContext, sLoggerName );
....
aLogger.log( LogLevel::SEVERE, sSomeMessage );
aLogger.logp( LogLevel::CONFIG, "MyClass", "MyMethod", sSomeMessage, SomeParameter1, SomeParameter2, SomeParameter3 );
</pre>
The <code>log</code> and <code>logp</code> calls support up to 6 parameters, which can be of
arbitrary type. For every parameter, there must exist a function <code>convertLogArgToString</code>
which takes an argument of the respective type, and returns a string.
After a parameter has been converted to a string using the above mentioned
<code>convertLogArgToString</code> function, a placeholder $1$ (resp. $2$ resp. $4$ ...)
in the message will be replaced with this string, and the resulting message will be logged.
*/
class COMPHELPER_DLLPUBLIC EventLogger
{
protected:
::boost::shared_ptr< EventLogger_Impl > m_pImpl;
public:
/** creates an <code>EventLogger</code> instance working with a css.logging.XLogger
instance given by ASCII name.
@param _rxContext
the component context to create services
@param _rLoggerName
the ASCII name of the logger to create.
*/
EventLogger(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
const sal_Char* _pAsciiLoggerName
);
~EventLogger();
public:
/// determines whether an event with the given level would be logged
bool isLoggable( const sal_Int32 _nLogLevel ) const;
//----------------------------------------------------------------
//- XLogger::log equivalents/wrappers
//- string messages
/// logs a given message, without any arguments, or source class/method names
bool log( const sal_Int32 _nLogLevel, const OUString& _rMessage ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, _rMessage );
return false;
}
/** logs a given message, replacing a placeholder in the message with an argument
The function takes, additionally to the log level and the message, an arbitrary
argument. This argument is converted to a string using an overloaded function
named <code>convertLogArgToString</code>. Then, a placeholder "$1$"
is searched in the message string, and replaced with the argument string.
*/
template< typename ARGTYPE1 >
bool log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ) );
return false;
}
/// logs a given message, replacing 2 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2 >
bool log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ) );
return false;
}
/// logs a given message, replacing 3 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3 >
bool log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ) );
return false;
}
/// logs a given message, replacing 4 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4 >
bool log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ) );
return false;
}
/// logs a given message, replacing 5 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5 >
bool log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ) );
return false;
}
/// logs a given message, replacing 6 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5, typename ARGTYPE6 >
bool log( const sal_Int32 _nLogLevel, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5, ARGTYPE6 _argument6 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ),
OptionalString( log::convert::convertLogArgToString( _argument6 ) ) );
return false;
}
//----------------------------------------------------------------
//- XLogger::log equivalents/wrappers
//- ASCII messages
/// logs a given message, without any arguments, or source class/method names
bool log( const sal_Int32 _nLogLevel, const sal_Char* _pMessage ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, OUString::createFromAscii( _pMessage ) );
return false;
}
/** logs a given message, replacing a placeholder in the message with an argument
The function takes, additionally to the log level and the message, an arbitrary
argument. This argument is converted to a string using an overloaded function
named <code>convertLogArgToString</code>. Then, a placeholder "$1$"
is searched in the message string, and replaced with the argument string.
*/
template< typename ARGTYPE1 >
bool log( const sal_Int32 _nLogLevel, const sal_Char* _pMessage, ARGTYPE1 _argument1 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, OUString::createFromAscii( _pMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ) );
return false;
}
/// logs a given message, replacing 2 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2 >
bool log( const sal_Int32 _nLogLevel, const sal_Char* _pMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, OUString::createFromAscii( _pMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ) );
return false;
}
/// logs a given message, replacing 3 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3 >
bool log( const sal_Int32 _nLogLevel, const sal_Char* _pMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, OUString::createFromAscii( _pMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ) );
return false;
}
/// logs a given message, replacing 4 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4 >
bool log( const sal_Int32 _nLogLevel, const sal_Char* _pMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, OUString::createFromAscii( _pMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ) );
return false;
}
/// logs a given message, replacing 5 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5 >
bool log( const sal_Int32 _nLogLevel, const sal_Char* _pMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, OUString::createFromAscii( _pMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ) );
return false;
}
/// logs a given message, replacing 6 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5, typename ARGTYPE6 >
bool log( const sal_Int32 _nLogLevel, const sal_Char* _pMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5, ARGTYPE6 _argument6 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, OUString::createFromAscii( _pMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ),
OptionalString( log::convert::convertLogArgToString( _argument6 ) ) );
return false;
}
//----------------------------------------------------------------
//- XLogger::logp equivalents/wrappers
//- string messages
/// logs a given message, without any arguments, or source class/method names
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const OUString& _rMessage ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, _rMessage );
return false;
}
/** logs a given message, replacing a placeholder in the message with an argument
The function takes, additionally to the logp level and the message, an arbitrary
argument. This argument is converted to a string using an overloaded function
named <code>convertLogArgToString</code>. Then, a placeholder "$1$"
is searched in the message string, and replaced with the argument string.
*/
template< typename ARGTYPE1 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ) );
return false;
}
/// logs a given message, replacing 2 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ) );
return false;
}
/// logs a given message, replacing 3 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ) );
return false;
}
/// logs a given message, replacing 4 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ) );
return false;
}
/// logs a given message, replacing 5 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ) );
return false;
}
/// logs a given message, replacing 6 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5, typename ARGTYPE6 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const OUString& _rMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5, ARGTYPE6 _argument6 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, _rMessage,
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ),
OptionalString( log::convert::convertLogArgToString( _argument6 ) ) );
return false;
}
//----------------------------------------------------------------
//- XLogger::logp equivalents/wrappers
//- ASCII messages
/// logs a given ASCII message, without any arguments, or source class/method names
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Char* _pAsciiMessage ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, OUString::createFromAscii( _pAsciiMessage ) );
return false;
}
/** logs a given ASCII message, replacing a placeholder in the message with an argument
The function takes, additionally to the logp level and the message, an arbitrary
argument. This argument is converted to a string using an overloaded function
named <code>convertLogArgToString</code>. Then, a placeholder "$1$"
is searched in the message string, and replaced with the argument string.
*/
template< typename ARGTYPE1 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Char* _pAsciiMessage, ARGTYPE1 _argument1 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, OUString::createFromAscii( _pAsciiMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ) );
return false;
}
/// logs a given ASCII message, replacing 2 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Char* _pAsciiMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, OUString::createFromAscii( _pAsciiMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ) );
return false;
}
/// logs a given ASCII message, replacing 3 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Char* _pAsciiMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, OUString::createFromAscii( _pAsciiMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ) );
return false;
}
/// logs a given ASCII message, replacing 4 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Char* _pAsciiMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, OUString::createFromAscii( _pAsciiMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ) );
return false;
}
/// logs a given ASCII message, replacing 5 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Char* _pAsciiMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, OUString::createFromAscii( _pAsciiMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ) );
return false;
}
/// logs a given ASCII message, replacing 6 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5, typename ARGTYPE6 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Char* _pAsciiMessage, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5, ARGTYPE6 _argument6 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, OUString::createFromAscii( _pAsciiMessage ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ),
OptionalString( log::convert::convertLogArgToString( _argument6 ) ) );
return false;
}
protected:
bool impl_log(
const sal_Int32 _nLogLevel,
const sal_Char* _pSourceClass,
const sal_Char* _pSourceMethod,
const OUString& _rMessage,
const OptionalString& _rArgument1 = OptionalString(),
const OptionalString& _rArgument2 = OptionalString(),
const OptionalString& _rArgument3 = OptionalString(),
const OptionalString& _rArgument4 = OptionalString(),
const OptionalString& _rArgument5 = OptionalString(),
const OptionalString& _rArgument6 = OptionalString()
) const;
};
//====================================================================
//= ResourceBasedEventLogger
//====================================================================
struct ResourceBasedEventLogger_Data;
/** extends the EventLogger class with functionality to load log messages from
a resource bundle.
*/
class COMPHELPER_DLLPUBLIC ResourceBasedEventLogger : public EventLogger
{
private:
::boost::shared_ptr< ResourceBasedEventLogger_Data > m_pData;
public:
/** creates a resource based event logger
@param _rxContext
the component context for creating new components
@param _pResourceBundleBaseName
the ASCII base name of the resource bundle to use. Will be used
in conjunction with XResourceBundleLoader::loadResource.
@param _pAsciiLoggerName
the ASCII name of the logger to work with. If NULL, the office-wide
default logger will be used.
*/
ResourceBasedEventLogger(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext,
const sal_Char* _pResourceBundleBaseName,
const sal_Char* _pAsciiLoggerName = NULL
);
//----------------------------------------------------------------
//- XLogger::log equivalents/wrappers
//- resource IDs
/// logs a given message, without any arguments, or source class/method names
bool log( const sal_Int32 _nLogLevel, const sal_Int32 _nMessageResID ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, impl_loadStringMessage_nothrow( _nMessageResID ) );
return false;
}
/** logs a given message, replacing a placeholder in the message with an argument
The function takes, additionally to the log level and the message, an arbitrary
argument. This argument is converted to a string using an overloaded function
named <code>convertLogArgToString</code>. Then, a placeholder "$1$"
is searched in the message string, and replaced with the argument string.
*/
template< typename ARGTYPE1 >
bool log( const sal_Int32 _nLogLevel, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ) );
return false;
}
/// logs a given message, replacing 2 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2 >
bool log( const sal_Int32 _nLogLevel, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1, ARGTYPE2 _argument2 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ) );
return false;
}
/// logs a given message, replacing 3 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3 >
bool log( const sal_Int32 _nLogLevel, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ) );
return false;
}
/// logs a given message, replacing 4 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4 >
bool log( const sal_Int32 _nLogLevel, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ) );
return false;
}
/// logs a given message, replacing 5 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5 >
bool log( const sal_Int32 _nLogLevel, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ) );
return false;
}
/// logs a given message, replacing 6 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5, typename ARGTYPE6 >
bool log( const sal_Int32 _nLogLevel, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5, ARGTYPE6 _argument6 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, NULL, NULL, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ),
OptionalString( log::convert::convertLogArgToString( _argument6 ) ) );
return false;
}
//----------------------------------------------------------------
//- XLogger::logp equivalents/wrappers
//- resource IDs
/// logs a given ASCII message, without any arguments, or source class/method names
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Int32 _nMessageResID ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, impl_loadStringMessage_nothrow( _nMessageResID ) );
return false;
}
/** logs a given ASCII message, replacing a placeholder in the message with an argument
*/
template< typename ARGTYPE1 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ) );
return false;
}
/// logs a given ASCII message, replacing 2 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1, ARGTYPE2 _argument2 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ) );
return false;
}
/// logs a given ASCII message, replacing 3 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ) );
return false;
}
/// logs a given ASCII message, replacing 4 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ) );
return false;
}
/// logs a given ASCII message, replacing 5 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ) );
return false;
}
/// logs a given ASCII message, replacing 6 placeholders in the message with respective values
template< typename ARGTYPE1, typename ARGTYPE2, typename ARGTYPE3, typename ARGTYPE4, typename ARGTYPE5, typename ARGTYPE6 >
bool logp( const sal_Int32 _nLogLevel, const sal_Char* _pSourceClass, const sal_Char* _pSourceMethod, const sal_Int32 _nMessageResID, ARGTYPE1 _argument1, ARGTYPE2 _argument2, ARGTYPE3 _argument3, ARGTYPE4 _argument4, ARGTYPE5 _argument5, ARGTYPE6 _argument6 ) const
{
if ( isLoggable( _nLogLevel ) )
return impl_log( _nLogLevel, _pSourceClass, _pSourceMethod, impl_loadStringMessage_nothrow( _nMessageResID ),
OptionalString( log::convert::convertLogArgToString( _argument1 ) ),
OptionalString( log::convert::convertLogArgToString( _argument2 ) ),
OptionalString( log::convert::convertLogArgToString( _argument3 ) ),
OptionalString( log::convert::convertLogArgToString( _argument4 ) ),
OptionalString( log::convert::convertLogArgToString( _argument5 ) ),
OptionalString( log::convert::convertLogArgToString( _argument6 ) ) );
return false;
}
private:
OUString impl_loadStringMessage_nothrow( const sal_Int32 _nMessageResID ) const;
};
//........................................................................
} // namespace comphelper
//........................................................................
#endif // COMPHELPER_LOGGING_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
