-
-
Notifications
You must be signed in to change notification settings - Fork 701
/
core.d
3060 lines (2609 loc) · 103 KB
/
core.d
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
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Written in the D programming language.
/**
Source: $(PHOBOSSRC std/logger/core.d)
*/
module std.logger.core;
import core.atomic : atomicLoad, atomicOp, atomicStore, MemoryOrder;
import core.sync.mutex : Mutex;
import std.datetime.date : DateTime;
import std.datetime.systime : Clock, SysTime;
import std.range.primitives;
import std.traits;
import std.logger.filelogger;
/** This functions is used at runtime to determine if a `LogLevel` is
active. The same previously defined version statements are used to disable
certain levels. Again the version statements are associated with a compile
unit and can therefore not disable logging in other compile units.
pure bool isLoggingEnabled()(LogLevel ll) @safe nothrow @nogc
*/
bool isLoggingEnabled()(LogLevel ll, LogLevel loggerLL,
LogLevel globalLL, lazy bool condition = true) @safe
{
return ll >= globalLL
&& ll >= loggerLL
&& ll != LogLevel.off
&& globalLL != LogLevel.off
&& loggerLL != LogLevel.off
&& condition;
}
/* This function formates a `SysTime` into an `OutputRange`.
The `SysTime` is formatted similar to
$(LREF std.datatime.DateTime.toISOExtString) except the fractional second part.
The fractional second part is in milliseconds and is always 3 digits.
*/
void systimeToISOString(OutputRange)(OutputRange o, const ref SysTime time)
if (isOutputRange!(OutputRange,string))
{
import std.format.write : formattedWrite;
const auto dt = cast(DateTime) time;
const auto fsec = time.fracSecs.total!"msecs";
formattedWrite(o, "%04d-%02d-%02dT%02d:%02d:%02d.%03d",
dt.year, dt.month, dt.day, dt.hour, dt.minute, dt.second,
fsec);
}
/** This function logs data.
In order for the data to be processed, the `LogLevel` of the log call must
be greater or equal to the `LogLevel` of the `sharedLog` and the
`defaultLogLevel`; additionally the condition passed must be `true`.
Params:
ll = The `LogLevel` used by this log call.
condition = The condition must be `true` for the data to be logged.
args = The data that should be logged.
Example:
--------------------
log(LogLevel.warning, true, "Hello World", 3.1415);
--------------------
*/
void log(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__, string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(const LogLevel ll,
lazy bool condition, lazy A args)
if (args.length != 1)
{
stdThreadLocalLog.log!(line, file, funcName, prettyFuncName, moduleName)
(ll, condition, args);
}
/// Ditto
void log(T, string moduleName = __MODULE__)(const LogLevel ll,
lazy bool condition, lazy T arg, int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__, string prettyFuncName = __PRETTY_FUNCTION__)
{
stdThreadLocalLog.log!(T,moduleName)(ll, condition, arg, line, file, funcName,
prettyFuncName);
}
/** This function logs data.
In order for the data to be processed the `LogLevel` of the log call must
be greater or equal to the `LogLevel` of the `sharedLog`.
Params:
ll = The `LogLevel` used by this log call.
args = The data that should be logged.
Example:
--------------------
log(LogLevel.warning, "Hello World", 3.1415);
--------------------
*/
void log(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__, string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(const LogLevel ll, lazy A args)
if (args.length > 1 && !is(Unqual!(A[0]) : bool))
{
stdThreadLocalLog.log!(line, file, funcName, prettyFuncName, moduleName)
(ll, args);
}
/// Ditto
void log(T, string moduleName = __MODULE__)(const LogLevel ll, lazy T arg,
int line = __LINE__, string file = __FILE__, string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__)
{
stdThreadLocalLog.log!T(ll, arg, line, file, funcName, prettyFuncName,
moduleName);
}
/** This function logs data.
In order for the data to be processed the `LogLevel` of the
`sharedLog` must be greater or equal to the `defaultLogLevel`
add the condition passed must be `true`.
Params:
condition = The condition must be `true` for the data to be logged.
args = The data that should be logged.
Example:
--------------------
log(true, "Hello World", 3.1415);
--------------------
*/
void log(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__, string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy bool condition, lazy A args)
if (args.length != 1)
{
stdThreadLocalLog.log!(line, file, funcName, prettyFuncName, moduleName)
(stdThreadLocalLog.logLevel, condition, args);
}
/// Ditto
void log(T, string moduleName = __MODULE__)(lazy bool condition, lazy T arg,
int line = __LINE__, string file = __FILE__, string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__)
{
stdThreadLocalLog.log!(T,moduleName)(stdThreadLocalLog.logLevel,
condition, arg, line, file, funcName, prettyFuncName);
}
/** This function logs data.
In order for the data to be processed the `LogLevel` of the
`sharedLog` must be greater or equal to the `defaultLogLevel`.
Params:
args = The data that should be logged.
Example:
--------------------
log("Hello World", 3.1415);
--------------------
*/
void log(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__, string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy A args)
if ((args.length > 1 && !is(Unqual!(A[0]) : bool)
&& !is(Unqual!(A[0]) == LogLevel))
|| args.length == 0)
{
stdThreadLocalLog.log!(line, file, funcName,
prettyFuncName, moduleName)(stdThreadLocalLog.logLevel, args);
}
void log(T)(lazy T arg, int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__, string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__)
{
stdThreadLocalLog.log!T(stdThreadLocalLog.logLevel, arg, line, file,
funcName, prettyFuncName, moduleName);
}
/** This function logs data in a `printf`-style manner.
In order for the data to be processed the `LogLevel` of the log call must
be greater or equal to the `LogLevel` of the `sharedLog` and the
`defaultLogLevel` additionally the condition passed must be `true`.
Params:
ll = The `LogLevel` used by this log call.
condition = The condition must be `true` for the data to be logged.
msg = The `printf`-style string.
args = The data that should be logged.
Example:
--------------------
logf(LogLevel.warning, true, "Hello World %f", 3.1415);
--------------------
*/
void logf(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(const LogLevel ll,
lazy bool condition, lazy string msg, lazy A args)
{
stdThreadLocalLog.logf!(line, file, funcName, prettyFuncName, moduleName)
(ll, condition, msg, args);
}
/** This function logs data in a `printf`-style manner.
In order for the data to be processed the `LogLevel` of the log call must
be greater or equal to the `LogLevel` of the `sharedLog` and the
`defaultLogLevel`.
Params:
ll = The `LogLevel` used by this log call.
msg = The `printf`-style string.
args = The data that should be logged.
Example:
--------------------
logf(LogLevel.warning, "Hello World %f", 3.1415);
--------------------
*/
void logf(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__, string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(const LogLevel ll, lazy string msg,
lazy A args)
{
stdThreadLocalLog.logf!(line, file, funcName, prettyFuncName, moduleName)
(ll, msg, args);
}
/** This function logs data in a `printf`-style manner.
In order for the data to be processed the `LogLevel` of the log call must
be greater or equal to the `defaultLogLevel` additionally the condition
passed must be `true`.
Params:
condition = The condition must be `true` for the data to be logged.
msg = The `printf`-style string.
args = The data that should be logged.
Example:
--------------------
logf(true, "Hello World %f", 3.1415);
--------------------
*/
void logf(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__, string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy bool condition,
lazy string msg, lazy A args)
{
stdThreadLocalLog.logf!(line, file, funcName, prettyFuncName, moduleName)
(stdThreadLocalLog.logLevel, condition, msg, args);
}
/** This function logs data in a `printf`-style manner.
In order for the data to be processed the `LogLevel` of the log call must
be greater or equal to the `defaultLogLevel`.
Params:
msg = The `printf`-style string.
args = The data that should be logged.
Example:
--------------------
logf("Hello World %f", 3.1415);
--------------------
*/
void logf(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy string msg, lazy A args)
{
stdThreadLocalLog.logf!(line, file, funcName,prettyFuncName, moduleName)
(stdThreadLocalLog.logLevel, msg, args);
}
/** This template provides the global log functions with the `LogLevel`
is encoded in the function name.
The aliases following this template create the public names of these log
functions.
*/
template defaultLogFunction(LogLevel ll)
{
void defaultLogFunction(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy A args)
if ((args.length > 0 && !is(Unqual!(A[0]) : bool)) || args.length == 0)
{
stdThreadLocalLog.memLogFunctions!(ll).logImpl!(line, file, funcName,
prettyFuncName, moduleName)(args);
}
void defaultLogFunction(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy bool condition, lazy A args)
{
stdThreadLocalLog.memLogFunctions!(ll).logImpl!(line, file, funcName,
prettyFuncName, moduleName)(condition, args);
}
}
/** This function logs data to the `stdThreadLocalLog`, optionally depending
on a condition.
In order for the resulting log message to be logged the `LogLevel` must
be greater or equal than the `LogLevel` of the `stdThreadLocalLog` and
must be greater or equal than the global `LogLevel`.
Additionally the `LogLevel` must be greater or equal than the `LogLevel`
of the `stdSharedLogger`.
If a condition is given, it must evaluate to `true`.
Params:
condition = The condition must be `true` for the data to be logged.
args = The data that should be logged.
Example:
--------------------
trace(1337, "is number");
info(1337, "is number");
error(1337, "is number");
critical(1337, "is number");
fatal(1337, "is number");
trace(true, 1337, "is number");
info(false, 1337, "is number");
error(true, 1337, "is number");
critical(false, 1337, "is number");
fatal(true, 1337, "is number");
--------------------
*/
alias trace = defaultLogFunction!(LogLevel.trace);
/// Ditto
alias info = defaultLogFunction!(LogLevel.info);
/// Ditto
alias warning = defaultLogFunction!(LogLevel.warning);
/// Ditto
alias error = defaultLogFunction!(LogLevel.error);
/// Ditto
alias critical = defaultLogFunction!(LogLevel.critical);
/// Ditto
alias fatal = defaultLogFunction!(LogLevel.fatal);
/** This template provides the global `printf`-style log functions with
the `LogLevel` is encoded in the function name.
The aliases following this template create the public names of the log
functions.
*/
template defaultLogFunctionf(LogLevel ll)
{
void defaultLogFunctionf(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy string msg, lazy A args)
{
stdThreadLocalLog.memLogFunctions!(ll).logImplf!(line, file, funcName,
prettyFuncName, moduleName)(msg, args);
}
void defaultLogFunctionf(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy bool condition,
lazy string msg, lazy A args)
{
stdThreadLocalLog.memLogFunctions!(ll).logImplf!(line, file, funcName,
prettyFuncName, moduleName)(condition, msg, args);
}
}
/** This function logs data to the `sharedLog` in a `printf`-style
manner.
In order for the resulting log message to be logged the `LogLevel` must
be greater or equal than the `LogLevel` of the `sharedLog` and
must be greater or equal than the global `LogLevel`.
Additionally the `LogLevel` must be greater or equal than the `LogLevel`
of the `stdSharedLogger`.
Params:
msg = The `printf`-style string.
args = The data that should be logged.
Example:
--------------------
tracef("is number %d", 1);
infof("is number %d", 2);
errorf("is number %d", 3);
criticalf("is number %d", 4);
fatalf("is number %d", 5);
--------------------
The second version of the function logs data to the `sharedLog` in a $(D
printf)-style manner.
In order for the resulting log message to be logged the `LogLevel` must
be greater or equal than the `LogLevel` of the `sharedLog` and
must be greater or equal than the global `LogLevel`.
Additionally the `LogLevel` must be greater or equal than the `LogLevel`
of the `stdSharedLogger`.
Params:
condition = The condition must be `true` for the data to be logged.
msg = The `printf`-style string.
args = The data that should be logged.
Example:
--------------------
tracef(false, "is number %d", 1);
infof(false, "is number %d", 2);
errorf(true, "is number %d", 3);
criticalf(true, "is number %d", 4);
fatalf(someFunct(), "is number %d", 5);
--------------------
*/
alias tracef = defaultLogFunctionf!(LogLevel.trace);
/// Ditto
alias infof = defaultLogFunctionf!(LogLevel.info);
/// Ditto
alias warningf = defaultLogFunctionf!(LogLevel.warning);
/// Ditto
alias errorf = defaultLogFunctionf!(LogLevel.error);
/// Ditto
alias criticalf = defaultLogFunctionf!(LogLevel.critical);
/// Ditto
alias fatalf = defaultLogFunctionf!(LogLevel.fatal);
private struct MsgRange
{
import std.traits : isSomeString, isSomeChar;
private Logger log;
this(Logger log) @safe
{
this.log = log;
}
void put(T)(T msg) @safe
if (isSomeString!T)
{
log.logMsgPart(msg);
}
void put(dchar elem) @safe
{
import std.utf : encode;
char[4] buffer;
size_t len = encode(buffer, elem);
log.logMsgPart(buffer[0 .. len]);
}
}
private void formatString(A...)(MsgRange oRange, A args)
{
import std.format.write : formattedWrite;
foreach (arg; args)
{
formattedWrite(oRange, "%s", arg);
}
}
@system unittest
{
void dummy() @safe
{
auto tl = new TestLogger();
auto dst = MsgRange(tl);
formatString(dst, "aaa", "bbb");
}
dummy();
}
/**
There are eight usable logging level. These level are $(I all), $(I trace),
$(I info), $(I warning), $(I error), $(I critical), $(I fatal), and $(I off).
If a log function with `LogLevel.fatal` is called the shutdown handler of
that logger is called.
*/
enum LogLevel : ubyte
{
all = 1, /** Lowest possible assignable `LogLevel`. */
trace = 32, /** `LogLevel` for tracing the execution of the program. */
info = 64, /** This level is used to display information about the
program. */
warning = 96, /** warnings about the program should be displayed with this
level. */
error = 128, /** Information about errors should be logged with this
level.*/
critical = 160, /** Messages that inform about critical errors should be
logged with this level. */
fatal = 192, /** Log messages that describe fatal errors should use this
level. */
off = ubyte.max /** Highest possible `LogLevel`. */
}
/** This class is the base of every logger. In order to create a new kind of
logger a deriving class needs to implement the `writeLogMsg` method. By
default this is not thread-safe.
It is also possible to `override` the three methods `beginLogMsg`,
`logMsgPart` and `finishLogMsg` together, this option gives more
flexibility.
*/
abstract class Logger
{
import std.array : appender, Appender;
import std.concurrency : thisTid, Tid;
/** LogEntry is a aggregation combining all information associated
with a log message. This aggregation will be passed to the method
writeLogMsg.
*/
protected struct LogEntry
{
/// the filename the log function was called from
string file;
/// the line number the log function was called from
int line;
/// the name of the function the log function was called from
string funcName;
/// the pretty formatted name of the function the log function was
/// called from
string prettyFuncName;
/// the name of the module the log message is coming from
string moduleName;
/// the `LogLevel` associated with the log message
LogLevel logLevel;
/// thread id of the log message
Tid threadId;
/// the time the message was logged
SysTime timestamp;
/// the message of the log message
string msg;
/// A refernce to the `Logger` used to create this `LogEntry`
Logger logger;
}
/**
Every subclass of `Logger` has to call this constructor from their
constructor. It sets the `LogLevel`, and creates a fatal handler. The fatal
handler will throw an `Error` if a log call is made with level
`LogLevel.fatal`.
Params:
lv = `LogLevel` to use for this `Logger` instance.
*/
this(this This)(LogLevel lv)
{
this.logLevel_ = lv;
this.fatalHandler_ = delegate() {
throw new Error("A fatal log message was logged");
};
this.mutex = new typeof(mutex)();
}
/** A custom logger must implement this method in order to work in a
`MultiLogger` and `ArrayLogger`.
Params:
payload = All information associated with call to log function.
See_Also: beginLogMsg, logMsgPart, finishLogMsg
*/
abstract protected void writeLogMsg(ref LogEntry payload) @safe;
/* The default implementation will use an `std.array.appender`
internally to construct the message string. This means dynamic,
GC memory allocation. A logger can avoid this allocation by
reimplementing `beginLogMsg`, `logMsgPart` and `finishLogMsg`.
`beginLogMsg` is always called first, followed by any number of calls
to `logMsgPart` and one call to `finishLogMsg`.
As an example for such a custom `Logger` compare this:
----------------
class CLogger : Logger
{
override void beginLogMsg(string file, int line, string funcName,
string prettyFuncName, string moduleName, LogLevel logLevel,
Tid threadId, SysTime timestamp)
{
... logic here
}
override void logMsgPart(const(char)[] msg)
{
... logic here
}
override void finishLogMsg()
{
... logic here
}
void writeLogMsg(ref LogEntry payload)
{
this.beginLogMsg(payload.file, payload.line, payload.funcName,
payload.prettyFuncName, payload.moduleName, payload.logLevel,
payload.threadId, payload.timestamp, payload.logger);
this.logMsgPart(payload.msg);
this.finishLogMsg();
}
}
----------------
*/
protected void beginLogMsg(string file, int line, string funcName,
string prettyFuncName, string moduleName, LogLevel logLevel,
Tid threadId, SysTime timestamp, Logger logger)
@safe
{
msgAppender = appender!string();
header = LogEntry(file, line, funcName, prettyFuncName,
moduleName, logLevel, threadId, timestamp, null, logger);
}
/** Logs a part of the log message. */
protected void logMsgPart(scope const(char)[] msg) @safe
{
msgAppender.put(msg);
}
/** Signals that the message has been written and no more calls to
`logMsgPart` follow. */
protected void finishLogMsg() @safe
{
header.msg = msgAppender.data;
this.writeLogMsg(header);
}
/** The `LogLevel` determines if the log call are processed or dropped
by the `Logger`. In order for the log call to be processed the
`LogLevel` of the log call must be greater or equal to the `LogLevel`
of the `logger`.
These two methods set and get the `LogLevel` of the used `Logger`.
Example:
-----------
auto f = new FileLogger(stdout);
f.logLevel = LogLevel.info;
assert(f.logLevel == LogLevel.info);
-----------
*/
@property final LogLevel logLevel() const pure @safe @nogc
{
return trustedLoad(this.logLevel_);
}
/// Ditto
@property final void logLevel(const LogLevel lv) @safe @nogc
{
atomicStore(this.logLevel_, lv);
}
/** This `delegate` is called in case a log message with
`LogLevel.fatal` gets logged.
By default an `Error` will be thrown.
*/
@property final void delegate() fatalHandler() @safe @nogc
{
synchronized (mutex) return this.fatalHandler_;
}
/// Ditto
@property final void fatalHandler(void delegate() @safe fh) @safe @nogc
{
synchronized (mutex) this.fatalHandler_ = fh;
}
/** This method allows forwarding log entries from one logger to another.
`forwardMsg` will ensure proper synchronization and then call
`writeLogMsg`. This is an API for implementing your own loggers and
should not be called by normal user code. A notable difference from other
logging functions is that the `globalLogLevel` wont be evaluated again
since it is assumed that the caller already checked that.
*/
void forwardMsg(ref LogEntry payload) @trusted
{
if (isLoggingEnabled(payload.logLevel, this.logLevel_,
globalLogLevel))
{
this.writeLogMsg(payload);
if (payload.logLevel == LogLevel.fatal)
this.fatalHandler_();
}
}
/** This template provides the log functions for the `Logger` `class`
with the `LogLevel` encoded in the function name.
For further information see the two functions defined inside of this
template.
The aliases following this template create the public names of these log
functions.
*/
template memLogFunctions(LogLevel ll)
{
/** This function logs data to the used `Logger`.
In order for the resulting log message to be logged the `LogLevel`
must be greater or equal than the `LogLevel` of the used `Logger`
and must be greater or equal than the global `LogLevel`.
Params:
args = The data that should be logged.
Example:
--------------------
auto s = new FileLogger(stdout);
s.trace(1337, "is number");
s.info(1337, "is number");
s.error(1337, "is number");
s.critical(1337, "is number");
s.fatal(1337, "is number");
--------------------
*/
void logImpl(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy A args)
if (args.length == 0 || (args.length > 0 && !is(A[0] : bool)))
{
synchronized (mutex)
{
if (isLoggingEnabled(ll, this.logLevel_, globalLogLevel))
{
this.beginLogMsg(file, line, funcName, prettyFuncName,
moduleName, ll, thisTid, Clock.currTime, this);
auto writer = MsgRange(this);
formatString(writer, args);
this.finishLogMsg();
static if (ll == LogLevel.fatal)
this.fatalHandler_();
}
}
}
/** This function logs data to the used `Logger` depending on a
condition.
In order for the resulting log message to be logged the `LogLevel` must
be greater or equal than the `LogLevel` of the used `Logger` and
must be greater or equal than the global `LogLevel` additionally the
condition passed must be `true`.
Params:
condition = The condition must be `true` for the data to be logged.
args = The data that should be logged.
Example:
--------------------
auto s = new FileLogger(stdout);
s.trace(true, 1337, "is number");
s.info(false, 1337, "is number");
s.error(true, 1337, "is number");
s.critical(false, 1337, "is number");
s.fatal(true, 1337, "is number");
--------------------
*/
void logImpl(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy bool condition,
lazy A args)
{
synchronized (mutex)
{
if (isLoggingEnabled(ll, this.logLevel_, globalLogLevel,
condition))
{
this.beginLogMsg(file, line, funcName, prettyFuncName,
moduleName, ll, thisTid, Clock.currTime, this);
auto writer = MsgRange(this);
formatString(writer, args);
this.finishLogMsg();
static if (ll == LogLevel.fatal)
this.fatalHandler_();
}
}
}
/** This function logs data to the used `Logger` in a
`printf`-style manner.
In order for the resulting log message to be logged the `LogLevel`
must be greater or equal than the `LogLevel` of the used `Logger`
and must be greater or equal than the global `LogLevel` additionally
the passed condition must be `true`.
Params:
condition = The condition must be `true` for the data to be logged.
msg = The `printf`-style string.
args = The data that should be logged.
Example:
--------------------
auto s = new FileLogger(stderr);
s.tracef(true, "is number %d", 1);
s.infof(true, "is number %d", 2);
s.errorf(false, "is number %d", 3);
s.criticalf(someFunc(), "is number %d", 4);
s.fatalf(true, "is number %d", 5);
--------------------
*/
void logImplf(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy bool condition,
lazy string msg, lazy A args)
{
synchronized (mutex)
{
import std.format.write : formattedWrite;
if (isLoggingEnabled(ll, this.logLevel_, globalLogLevel,
condition))
{
this.beginLogMsg(file, line, funcName, prettyFuncName,
moduleName, ll, thisTid, Clock.currTime, this);
auto writer = MsgRange(this);
formattedWrite(writer, msg, args);
this.finishLogMsg();
static if (ll == LogLevel.fatal)
this.fatalHandler_();
}
}
}
/** This function logs data to the used `Logger` in a
`printf`-style manner.
In order for the resulting log message to be logged the `LogLevel` must
be greater or equal than the `LogLevel` of the used `Logger` and
must be greater or equal than the global `LogLevel`.
Params:
msg = The `printf`-style string.
args = The data that should be logged.
Example:
--------------------
auto s = new FileLogger(stderr);
s.tracef("is number %d", 1);
s.infof("is number %d", 2);
s.errorf("is number %d", 3);
s.criticalf("is number %d", 4);
s.fatalf("is number %d", 5);
--------------------
*/
void logImplf(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(lazy string msg, lazy A args)
{
synchronized (mutex)
{
import std.format.write : formattedWrite;
if (isLoggingEnabled(ll, this.logLevel_, globalLogLevel))
{
this.beginLogMsg(file, line, funcName, prettyFuncName,
moduleName, ll, thisTid, Clock.currTime, this);
auto writer = MsgRange(this);
formattedWrite(writer, msg, args);
this.finishLogMsg();
static if (ll == LogLevel.fatal)
this.fatalHandler_();
}
}
}
}
/// Ditto
alias trace = memLogFunctions!(LogLevel.trace).logImpl;
/// Ditto
alias tracef = memLogFunctions!(LogLevel.trace).logImplf;
/// Ditto
alias info = memLogFunctions!(LogLevel.info).logImpl;
/// Ditto
alias infof = memLogFunctions!(LogLevel.info).logImplf;
/// Ditto
alias warning = memLogFunctions!(LogLevel.warning).logImpl;
/// Ditto
alias warningf = memLogFunctions!(LogLevel.warning).logImplf;
/// Ditto
alias error = memLogFunctions!(LogLevel.error).logImpl;
/// Ditto
alias errorf = memLogFunctions!(LogLevel.error).logImplf;
/// Ditto
alias critical = memLogFunctions!(LogLevel.critical).logImpl;
/// Ditto
alias criticalf = memLogFunctions!(LogLevel.critical).logImplf;
/// Ditto
alias fatal = memLogFunctions!(LogLevel.fatal).logImpl;
/// Ditto
alias fatalf = memLogFunctions!(LogLevel.fatal).logImplf;
/** This method logs data with the `LogLevel` of the used `Logger`.
This method takes a `bool` as first argument. In order for the
data to be processed the `bool` must be `true` and the `LogLevel`
of the Logger must be greater or equal to the global `LogLevel`.
Params:
args = The data that should be logged.
condition = The condition must be `true` for the data to be logged.
args = The data that is to be logged.
Returns: The logger used by the logging function as reference.
Example:
--------------------
auto l = new StdioLogger();
l.log(1337);
--------------------
*/
void log(int line = __LINE__, string file = __FILE__,
string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__,
string moduleName = __MODULE__, A...)(const LogLevel ll,
lazy bool condition, lazy A args)
if (args.length != 1)
{
synchronized (mutex)
{
if (isLoggingEnabled(ll, this.logLevel_, globalLogLevel, condition))
{
this.beginLogMsg(file, line, funcName, prettyFuncName,
moduleName, ll, thisTid, Clock.currTime, this);
auto writer = MsgRange(this);
formatString(writer, args);
this.finishLogMsg();
if (ll == LogLevel.fatal)
this.fatalHandler_();
}
}
}
/// Ditto
void log(T, string moduleName = __MODULE__)(const LogLevel ll,
lazy bool condition, lazy T args, int line = __LINE__,
string file = __FILE__, string funcName = __FUNCTION__,
string prettyFuncName = __PRETTY_FUNCTION__)
{
synchronized (mutex)
{
if (isLoggingEnabled(ll, this.logLevel_, globalLogLevel, condition))
{
this.beginLogMsg(file, line, funcName, prettyFuncName,
moduleName, ll, thisTid, Clock.currTime, this);
auto writer = MsgRange(this);
formatString(writer, args);
this.finishLogMsg();
if (ll == LogLevel.fatal)
this.fatalHandler_();
}
}
}
/** This function logs data to the used `Logger` with a specific
`LogLevel`.
In order for the resulting log message to be logged the `LogLevel`
must be greater or equal than the `LogLevel` of the used `Logger`
and must be greater or equal than the global `LogLevel`.