-
Notifications
You must be signed in to change notification settings - Fork 12
/
ColumbusCommons.pas
461 lines (382 loc) · 11.8 KB
/
ColumbusCommons.pas
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
unit ColumbusCommons;
interface
uses
DB, Classes, Dialogs, SysUtils, ColumbusUIListenerInterface;
type
IColumbusObserver = interface
['{1DC9E7EF-4538-464A-A23E-112F54DAF88E}']
procedure UpdateObserver(const Sender: TObject; const ModuleName: String);
end;
IColumbusService = interface
['{9B2456CB-63FD-468A-99B3-55B8C2EFBDBB}']
procedure ExecService(var aHandled: Boolean; const aServiceCode: Integer; aParams: array of const; var aResult: Variant);
end;
EColumbusException = class(Exception)
end;
TColumbusSubject = class(TComponent)
private
FObservers: TInterfaceList;
FServices: TInterfaceList;
FUIListener: IColumbusUIListener;
function GetUIListener: IColumbusUIListener;
procedure SetUIListener(const Value: IColumbusUIListener);
protected
procedure NotifyObservers;
procedure ExecService(const aServiceCode: Integer; aParams: array of const; var aResult: Variant);
public
constructor Create(AOwner: TComponent); reintroduce; virtual;
destructor Destroy; override;
function GetModuleName: String; virtual;
procedure RegisterObserver(aObserver: IColumbusObserver);
procedure UnRegisterObserver(aObserver: IColumbusObserver);
procedure RegisterService(aService: IColumbusService);
procedure UnRegisterService(aService: IColumbusService);
property UIListener: IColumbusUIListener read GetUIListener write SetUIListener;
end;
TCustomColumbusModule = class(TColumbusSubject)
private
FDataSet: TDataSet;
FDataSetOwner: TComponent;
FListener: IColumbusUIListener;
{$IF CompilerVersion >= 20}
FBookmark: TArray<Byte>;
{$ELSE}
FBookmark: String;
{$IFEND}
procedure HookEvents(aDataSet: TDataSet);
procedure UnHookScrollEvents(aDataSet: TDataSet);
procedure HookScrollEvents(aDataSet: TDataSet);
function GetModuleByName(const aModuleName: String): TCustomColumbusModule;
procedure OnNewRecord(aDataSet: TDataSet); overload;
procedure BeforePost(aDataSet: TDataSet); overload;
procedure BeforeDelete(aDataSet: TDataSet); overload;
procedure BeforeEdit(aDataSet: TDataSet); overload;
procedure BeforeInsert(aDataSet: TDataSet); overload;
procedure AfterOpen(aDataSet: TDataSet); overload;
procedure AfterPost(aDataSet: TDataSet); overload;
procedure AfterDelete(aDataSet: TDataSet); overload;
procedure AfterScroll(aDataSet: TDataSet); overload;
procedure AfterRefresh(aDataSet: TDataSet); overload;
procedure OnCalcFields(aDataSet: TDataSet); overload;
procedure OnEditError(DataSet: TDataSet; E: EDatabaseError; var Action: TDataAction); overload;
protected
procedure FreezeDataset(aDisableScrollEvents: Boolean = False);
procedure UnFreezeDataset;
procedure OnNewRecord; overload; virtual;
procedure BeforePost; overload; virtual;
procedure BeforeDelete; overload; virtual;
procedure BeforeEdit; overload; virtual;
procedure BeforeInsert; overload; virtual;
procedure AfterOpen; overload; virtual;
procedure AfterPost; overload; virtual;
procedure AfterDelete; overload; virtual;
procedure AfterScroll; overload; virtual;
procedure AfterRefresh; overload; virtual;
procedure OnCalcFields; overload; virtual;
procedure OnEditError(E: EDatabaseError; var Action: TDataAction); overload; virtual;
property DataSetOwner: TComponent read FDataSetOwner;
property Modules[const Index: String]: TCustomColumbusModule read GetModuleByName;
public
constructor Create(aDataSet: TDataSet; aListener: IColumbusUIListener = nil); reintroduce; virtual;
destructor Destroy; override;
procedure SafePost; virtual;
procedure SafeEdit; virtual;
property DataSet: TDataSet read FDataSet;
end;
{$IF CompilerVersion >= 20}
TColumbusMockObserver = class(TInterfacedObject, IColumbusObserver)
protected
FProc: TProc<TObject,String>;
public
constructor Create(Proc: TProc<TObject,String>);
procedure UpdateObserver(const Sender: TObject; const ModuleName: string);
end;
{$IFEND}
var
ColumbusDefaultUIListener: TInterfacedClass = nil;
implementation
uses
{$IF CompilerVersion >= 20}
System.UITypes,
{$IFEND}
ColumbusModulesLocator;
{ TCustomColumbusModule }
{$REGION 'Events to methods'}
procedure TCustomColumbusModule.AfterDelete(aDataSet: TDataSet);
begin
AfterDelete;
end;
procedure TCustomColumbusModule.AfterOpen(aDataSet: TDataSet);
begin
AfterOpen;
end;
procedure TCustomColumbusModule.AfterPost(aDataSet: TDataSet);
begin
AfterPost;
end;
procedure TCustomColumbusModule.AfterScroll(aDataSet: TDataSet);
begin
AfterScroll;
end;
procedure TCustomColumbusModule.AfterRefresh(aDataSet: TDataSet);
begin
AfterRefresh;
end;
procedure TCustomColumbusModule.BeforeDelete(aDataSet: TDataSet);
begin
BeforeDelete;
end;
procedure TCustomColumbusModule.BeforeEdit(aDataSet: TDataSet);
begin
BeforeEdit;
end;
procedure TCustomColumbusModule.BeforeInsert(aDataSet: TDataSet);
begin
BeforeInsert;
end;
procedure TCustomColumbusModule.BeforePost(aDataSet: TDataSet);
begin
BeforePost;
end;
procedure TCustomColumbusModule.OnCalcFields(aDataSet: TDataSet);
begin
OnCalcFields;
end;
procedure TCustomColumbusModule.OnNewRecord(aDataSet: TDataSet);
begin
OnNewRecord;
end;
procedure TCustomColumbusModule.OnEditError(DataSet: TDataSet;
E: EDatabaseError; var Action: TDataAction);
begin
OnEditError(E, Action);
end;
{$ENDREGION}
constructor TCustomColumbusModule.Create(aDataSet: TDataSet; aListener: IColumbusUIListener);
begin
inherited Create(aDataSet);
FDataSet := aDataSet;
FListener := aListener;
FDataSetOwner := aDataSet.Owner;
RegisterColumbusModule(DataSetOwner, Self);
HookEvents(aDataSet);
end;
destructor TCustomColumbusModule.Destroy;
begin
UnRegisterColumbusModule(DataSetOwner, Self);
inherited;
end;
procedure TCustomColumbusModule.FreezeDataset(aDisableScrollEvents: Boolean);
begin
FBookmark := DataSet.Bookmark;
DataSet.DisableControls;
if aDisableScrollEvents then
UnHookScrollEvents(FDataSet);
end;
function TCustomColumbusModule.GetModuleByName(
const aModuleName: String): TCustomColumbusModule;
begin
Result := GetColumbusModule(DataSetOwner, aModuleName);
end;
function TColumbusSubject.GetModuleName: String;
begin
Result := ClassName;
end;
procedure TCustomColumbusModule.HookEvents(aDataSet: TDataSet);
begin
Assert(not Assigned(aDataSet.BeforePost), 'BeforePost is set on ' + aDataSet.name);
aDataSet.BeforePost := BeforePost;
Assert(not Assigned(aDataSet.BeforeDelete), 'BeforeDelete is set on ' + aDataSet.name);
aDataSet.BeforeDelete := BeforeDelete;
Assert(not Assigned(aDataSet.BeforeEdit), 'BeforeEdit is set on ' + aDataSet.name);
aDataSet.BeforeEdit := BeforeEdit;
Assert(not Assigned(aDataSet.BeforeInsert), 'BeforeInsert is set on ' + aDataSet.name);
aDataSet.BeforeInsert := BeforeInsert;
Assert(not Assigned(aDataSet.AfterOpen), 'AfterOpen is set on ' + aDataSet.name);
aDataSet.AfterOpen := AfterOpen;
Assert(not Assigned(aDataSet.AfterPost), 'AfterPost is set on ' + aDataSet.name);
aDataSet.AfterPost := AfterPost;
Assert(not Assigned(aDataSet.AfterDelete), 'AfterDelete is set on ' + aDataSet.name);
aDataSet.AfterDelete := AfterDelete;
Assert(not Assigned(aDataSet.OnCalcFields), 'OnCalcFields is set on ' + aDataSet.name);
aDataSet.OnCalcFields := OnCalcFields;
Assert(not Assigned(aDataSet.OnNewRecord), 'OnNewRecord is set on ' + aDataSet.name);
aDataSet.OnNewRecord := OnNewRecord;
Assert(not Assigned(aDataSet.OnEditError), 'OnEditError is set on ' + aDataSet.name);
aDataSet.OnEditError := OnEditError;
// All scroll events
Assert(not Assigned(aDataSet.AfterScroll), 'AfterScroll is set on ' + aDataSet.name);
Assert(not Assigned(aDataSet.AfterRefresh), 'AfterRefresh is set on ' + aDataSet.name);
HookScrollEvents(aDataSet);
end;
procedure TCustomColumbusModule.HookScrollEvents(aDataSet: TDataSet);
begin
aDataSet.AfterScroll := AfterScroll;
aDataSet.AfterRefresh := AfterRefresh;
end;
procedure TCustomColumbusModule.SafeEdit;
begin
if DataSet.State in [dsBrowse] then
DataSet.Edit;
end;
procedure TCustomColumbusModule.SafePost;
begin
if DataSet.State in [dsInsert, dsEdit] then
DataSet.Post;
end;
procedure TCustomColumbusModule.UnFreezeDataset;
begin
DataSet.Bookmark := FBookmark;
HookScrollEvents(FDataSet);
DataSet.EnableControls;
end;
procedure TCustomColumbusModule.UnHookScrollEvents(aDataSet: TDataSet);
begin
aDataSet.AfterScroll := nil;
aDataSet.AfterRefresh := nil;
end;
{ TColumbusSubject }
constructor TColumbusSubject.Create(AOwner: TComponent);
begin
inherited;
FObservers := TInterfaceList.Create;
FServices := TInterfaceList.Create;
FUIListener := nil;
end;
destructor TColumbusSubject.Destroy;
begin
FObservers.Free;
FServices.Free;
inherited;
end;
procedure TColumbusSubject.ExecService(const aServiceCode: Integer;
aParams: array of const; var aResult: Variant);
var
I: Integer;
lResult: Variant;
lHandled: Boolean;
begin
lHandled := False;
for I := 0 to FServices.Count - 1 do
begin
IColumbusService(FServices[I]).ExecService(lHandled, aServiceCode, aParams, lResult);
if lHandled then
begin
aResult := lResult;
Break;
end;
end;
if not lHandled then
raise EColumbusException.CreateFmt('No service for ServiceCode = %d', [aServiceCode]);
end;
function TColumbusSubject.GetUIListener: IColumbusUIListener;
begin
if FUIListener = nil then
begin
if ColumbusDefaultUIListener = nil then
begin
raise EColumbusException.Create('No UIListener nor ColumbusDefaultUIListener is set');
end;
FUIListener := ColumbusDefaultUIListener.Create as IColumbusUIListener;
end;
Result := FUIListener;
end;
procedure TColumbusSubject.NotifyObservers;
var
I: Integer;
begin
for I := 0 to FObservers.Count - 1 do
begin
IColumbusObserver(FObservers[I]).UpdateObserver(Self, GetModuleName);
end;
end;
procedure TColumbusSubject.RegisterObserver(aObserver: IColumbusObserver);
var
lOut: IColumbusUIListener;
begin
FObservers.Add(aObserver);
if (FUIListener = nil) and Supports(aObserver, IColumbusUIListener, lOut) then
begin
UIListener := lOut;
end;
end;
procedure TColumbusSubject.RegisterService(aService: IColumbusService);
begin
FServices.Add(aService);
end;
procedure TColumbusSubject.SetUIListener(const Value: IColumbusUIListener);
begin
FUIListener := Value;
end;
procedure TColumbusSubject.UnRegisterObserver(aObserver: IColumbusObserver);
begin
FObservers.Remove(aObserver);
end;
procedure TColumbusSubject.UnRegisterService(aService: IColumbusService);
begin
FServices.Remove(aService);
end;
{$REGION 'Virtual Methods'}
procedure TCustomColumbusModule.AfterDelete;
begin
// do nothing
end;
procedure TCustomColumbusModule.AfterOpen;
begin
// do nothing
end;
procedure TCustomColumbusModule.AfterPost;
begin
// do nothing
end;
procedure TCustomColumbusModule.AfterRefresh;
begin
// do nothing
end;
procedure TCustomColumbusModule.AfterScroll;
begin
// do nothing
end;
procedure TCustomColumbusModule.BeforeDelete;
begin
// do nothing
end;
procedure TCustomColumbusModule.BeforeEdit;
begin
// do nothing
end;
procedure TCustomColumbusModule.BeforeInsert;
begin
// do nothing
end;
procedure TCustomColumbusModule.OnNewRecord;
begin
// do nothing
end;
procedure TCustomColumbusModule.OnCalcFields;
begin
// do nothing
end;
procedure TCustomColumbusModule.BeforePost;
begin
// do nothing
end;
procedure TCustomColumbusModule.OnEditError(E: EDatabaseError; var Action: TDataAction);
begin
// do nothing
end;
{$ENDREGION}
{$IF CompilerVersion >= 20}
{ TColumbusMockObserver }
constructor TColumbusMockObserver.Create(Proc: TProc<TObject,String>);
begin
inherited Create;
FProc := Proc;
end;
procedure TColumbusMockObserver.UpdateObserver(const Sender: TObject;
const ModuleName: string);
begin
FProc(Sender, ModuleName);
end;
{$IFEND}
end.