Repository navigation
Expand file tree
/
Copy pathLoggerPro.CallbackAppender.pas
More file actions
127 lines (112 loc) · 3.54 KB
/
Copy pathLoggerPro.CallbackAppender.pas
File metadata and controls
127 lines (112 loc) · 3.54 KB
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
// *************************************************************************** }
//
// LoggerPro
//
// Copyright (c) 2010-2026 Daniele Teti
//
// https://github.com/danieleteti/loggerpro
//
// ***************************************************************************
//
// Licensed 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
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// ***************************************************************************
unit LoggerPro.CallbackAppender;
interface
uses
LoggerPro,
System.SysUtils,
System.Classes;
type
{ @abstract(Appender that invokes a callback for each log item)
Useful for:
- Updating UI components (ListView, Memo, etc.) via TThread.Queue
- Custom integrations
- Testing
- Real-time notifications
}
TLoggerProCallbackAppender = class(TLoggerProAppenderBase)
private
FCallback: TLogItemCallback;
FSynchronizeToMainThread: Boolean;
public
{ Creates a callback appender.
@param aCallback The callback to invoke for each log item
@param aSynchronizeToMainThread If true, callback is executed via TThread.Queue (safe for UI updates)
@param aLogItemRenderer Optional custom renderer }
constructor Create(aCallback: TLogItemCallback;
aSynchronizeToMainThread: Boolean = False;
aLogItemRenderer: ILogItemRenderer = nil); reintroduce;
procedure Setup; override;
procedure TearDown; override;
procedure WriteLog(const aLogItem: TLogItem); override;
property SynchronizeToMainThread: Boolean read FSynchronizeToMainThread;
end;
implementation
{ TLoggerProCallbackAppender }
constructor TLoggerProCallbackAppender.Create(aCallback: TLogItemCallback;
aSynchronizeToMainThread: Boolean;
aLogItemRenderer: ILogItemRenderer);
begin
inherited Create(aLogItemRenderer);
FCallback := aCallback;
FSynchronizeToMainThread := aSynchronizeToMainThread;
end;
procedure TLoggerProCallbackAppender.Setup;
begin
inherited;
end;
procedure TLoggerProCallbackAppender.TearDown;
begin
inherited;
end;
procedure TLoggerProCallbackAppender.WriteLog(const aLogItem: TLogItem);
var
lFormattedMessage: string;
lClonedItem: TLogItem;
begin
if not Assigned(FCallback) then
Exit;
lFormattedMessage := FormatLog(aLogItem);
if FSynchronizeToMainThread then
begin
// Clone the item since original will be freed after WriteLog returns.
// Swallow callback exceptions: a buggy callback must not turn the
// appender into "Failing" state, because our default TryToRestart
// returns False forever - which would spin the appender thread on
// Terminated and hang Shutdown indefinitely.
lClonedItem := aLogItem.Clone;
TThread.Queue(nil,
procedure
begin
try
try
FCallback(lClonedItem, lFormattedMessage);
except
// user-supplied callback exception is not our problem
end;
finally
lClonedItem.Free;
end;
end);
end
else
begin
try
FCallback(aLogItem, lFormattedMessage);
except
// see comment above - callback bugs must not poison the appender
end;
end;
end;
end.