LMD LogTools tutorial - Revision history

Rafael at 23:36, 28 March 2018

2018-03-28T23:36:28Z

Fduch at 12:32, 18 August 2017

2017-08-18T12:32:47Z

Fduch at 12:31, 18 August 2017

2017-08-18T12:31:03Z

Fduch: /* Creating custom sessions */

2011-03-11T18:09:39Z

‎Creating custom sessions

Fduch: /* Creating custom sessions */

2011-03-11T18:07:32Z

‎Creating custom sessions

Fduch: /* Creating custom sessions */

2011-03-11T18:06:52Z

‎Creating custom sessions

Fduch: /* Basic Usage */

2011-03-11T18:06:28Z

‎Basic Usage

Fduch: /* Creating Viewer plugin for AnyLogger console
*/

2009-10-20T18:31:26Z

‎Creating Viewer plugin for AnyLogger console<br>

Fduch: /* Basic Usage */

2009-10-20T18:30:37Z

‎Basic Usage

Fduch: /* First Example */

2009-10-20T18:29:10Z

‎First Example

@@ Line 116: / Line 116: @@
    {$ifdef DEBUG}
    LMDLog.AllowLogLevel := LogAll;
-   LMDLog.AllowLogLevel := LogAll;
+   LMDLog.DefaultLogLevel := LogAll;
    {$ELSE}
    LMDLog.AllowLogLevel := LogFatal;

@@ Line 253: / Line 253: @@
      procedure SetFormData(AData: Pointer);
    end;
-</delphi> <br> This interface is needed to fill form with you custom data. AnyLogger Console call SetFormData method with TLMDLogMessage instance as parameter. Here is example of such form:<br>
+</syntaxhighlight>
-<delphi>
+This interface is needed to fill form with you custom data. AnyLogger Console call SetFormData method with TLMDLogMessage instance as parameter. Here is example of such form:
 ...
 type

@@ Line 14: / Line 14: @@
 In this section we will write traditional in programmer's community example - 'Hello, World!' sample program. Firstly, we create new Delphi Console Application (File->New->Other...->Delphi Projects->Console Application). Then replace content of new project by below code:
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 program HelloAnyLoggerWorld;
@@ Line 31: / Line 31: @@
    end;
 end.
-</pre>
+</syntaxhighlight>
 Second, we need to run AnyLogger console.After that compile and run HelloAnyLoggerWorld project. If everything is installed correctly you should see in AnyLogger console 'First message'='Hello, World!' line.
@@ Line 42: / Line 42: @@
 To start use LogTools in your application you should add LMDLogMessage.pas unit to uses section of your unit, then you'll be able to use LMDLog instance of TLMDLogSession class.
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 uses
    ..., LMDLogMessage, ...;
@@ Line 49: / Line 49: @@
    LMDLog.SendString('Test', 'Hello, World!');
 ...
-</pre>
+</syntaxhighlight>
 <br>
@@ Line 55: / Line 55: @@
 TLMDLogSession class has methods to send some info into main log - TLMDLogSession.Send*, to watch data in Watch area - TLMDLogSession.Watch* (main different with Send* function that Watch* has just changed value of watched variables, but not add new record)
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 uses
    ..., LMDLogMessage, ...;
@@ Line 63: / Line 63: @@
      LMDLog.WatchInteger('i', i);
 ...
-</pre>
+</syntaxhighlight>
 To logging flow of application, below methods available: TLMDLogSession.Enter*, TLMDLogSession.Leave*. Sample:
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 uses
    ..., LMDLogMessage, ...;
@@ Line 83: / Line 83: @@
 end;
 ...
-</pre>
+</syntaxhighlight>
 and methods that help to trace of application
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 uses
    ..., LMDLogMessage, ...;
@@ Line 103: / Line 103: @@
    end;
 ...
-</pre>
+</syntaxhighlight>
 <br> To control log storage TLMDLogSession has next methods - TLMDLogSession.ClearLog, TLMDLogSession.ClearWatch and TLMDLogSession.ClearCallStack
@@ Line 109: / Line 109: @@
 <br> TLMDLogSession allow you to control level of you logging messages. It has two properties for it - TLMDLogSession.AllowLogLevel - set minimum log level for messages, TLMDLogSession.DefaultLogLevel - set default log level for messages where level is not set as parameter.
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 uses
    ..., LMDLogMessage, ...;
@@ Line 134: / Line 134: @@
    end;
 ...
-</pre> Logging for 'a' and 'i' will be turned off when DEBUG undefined, but 'Error' will be sent to log in any case.
+</syntaxhighlight> Logging for 'a' and 'i' will be turned off when DEBUG undefined, but 'Error' will be sent to log in any case.
 == Creating custom sessions ==
@@ Line 140: / Line 140: @@
 Custom sessions can be creating by using LMDLogManager.AddSession() method. Via it   custom transport, name etc. can be specified. example:
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 MyLog := LMDLogManage.AddSession('SessionName|lmd_db_session|lmd_wmcopydata_log|WindowClass=TLMDLogHelperWindow;WindowName=LMDLogHelper');
-</pre>
+</syntaxhighlight>
 Then you can use it:
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
    MyLog.SendString('name', 'value');
-</pre>
+</syntaxhighlight>
 or
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
    LMDLogManager.Sessions['SessionName'].SendString('name', 'value');
-</pre>
+</syntaxhighlight>
 Aboyut this string - 'SessionName|lmd_db_session|lmd_wmcopydata_log|WindowClass=TLMDLogHelperWindow;WindowName=LMDLogHelper'
@@ Line 177: / Line 177: @@
 To create such plugin you will need LMD Plugins package and uCreatePlugin.pas unit.<br>
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 unit uCreatePlugin;
@@ Line 241: / Line 241: @@
 end.
-</pre>
+</syntaxhighlight>
 uCreatePlugin.pas create TLMDPlugin instance and init with three plugin method "GetSubTypesCount" - returns count of lmdlog message subtypes that will showed by this plugins. Next method is "GetSubTypeName" - returns name of subtype by it's index (0..GetSubTypesCount - 1). "GetSubType" method returns GUID that identificate subtype. And the last method is "GetSubTypeIconIndex" - it returns iconindex to show icon in AnyLogger console by subtype GUID.<br>
@@ Line 247: / Line 247: @@
 So, uCreatePlugin.pas do above basic steps for you. Next, you need to create form with interface ILMDFormWithData, which described in LMDPluginManager unit from [[LMD Plugins]] package.
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 { **************************** ILMDFormWithData **************************** }
    ILMDFormWithData = interface(IInterface)
@@ Line 279: / Line 279: @@
 end;
 ...
-</pre>
+</syntaxhighlight>
 Next step is creating child class for TLMDActionExecutor from uCreatePlugin.pas and override handlers of plugin methods. Example:<br/>
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 unit intfTextView;
@@ Line 331: / Line 331: @@
 end.
-</pre>
+</syntaxhighlight>
 And final step is create Dll project with export function GetLMDPlugin (see [[LMD Plguins]] for details). <br>
-<pre class="brush:delphi">
+<syntaxhighlight lang="delphi">
 library TextView;
@@ Line 384: / Line 384: @@
    DllProc := @DllMain;
 end.
-</pre>
+</syntaxhighlight>
 <br>
 Compile it and copy result dll file to Viewers folder in AnyLogger console installation path.

@@ Line 137: / Line 137: @@
 == Creating custom sessions ==
-About this part of you question:
+Custom sessions can be creating by using LMDLogManager.AddSession() method. Via it   custom transport, name etc. can be specified. example:
 <pre class="brush:delphi">

@@ Line 159: / Line 159: @@
 Aboyut this string - 'SessionName|lmd_db_session|lmd_wmcopydata_log|WindowClass=TLMDLogHelperWindow;WindowName=LMDLogHelper'
-* SessionName - it's exactly what is it - session name. You can name it as you wish. Except "Root" - this name is reserved for session which stored in LMDLog
+* '''SessionName''' - it's exactly what is it - session name. You can name it as you wish. Except "Root" - this name is reserved for session which stored in LMDLog
-* lmd_db_session - type of session that you want to create. Currently library contains two session classes - TLMDLogSession (lmd_db_session) and TLMDLogDBSession (lmd_db_session). 'lmd_db_session' and 'lmd_db_session' are specified in GetName method of session. If you will extend TLMDLogCustomSession to logging you custom data then you have to override this method and specify you own unique name
+* '''lmd_db_session''' - type of session that you want to create. Currently library contains two session classes - TLMDLogSession (lmd_db_session) and TLMDLogDBSession (lmd_db_session). 'lmd_db_session' and 'lmd_db_session' are specified in GetName method of session. If you will extend TLMDLogCustomSession to logging you custom data then you have to override this method and specify you own unique name
-* lmd_wmcopydata_log - type of transport that you want to create. each new transport have to override GetName method of TLMDLogCustomTransport and return it's own unique name.
+* '''lmd_wmcopydata_log''' - type of transport that you want to create. each new transport have to override GetName method of TLMDLogCustomTransport and return it's own unique name.
-* WindowClass=TLMDLogHelperWindow and WindowName=LMDLogHelper - are transport parameters - can be different for different transports.
+* '''WindowClass=TLMDLogHelperWindow''' and '''WindowName=LMDLogHelper''' - are transport parameters - can be different for different transports.
 = AnyLogger console application<br> =

LMD LogTools tutorial - Revision history

Rafael at 23:36, 28 March 2018

Fduch at 12:32, 18 August 2017

Fduch at 12:31, 18 August 2017

Fduch: /* Creating custom sessions */

Fduch: /* Creating custom sessions */

Fduch: /* Creating custom sessions */

Fduch: /* Basic Usage */

Fduch: /* Creating Viewer plugin for AnyLogger console */

Fduch: /* Basic Usage */

Fduch: /* First Example */

Fduch: /* Creating Viewer plugin for AnyLogger console
*/