/jcl/docs/Experts.html

https://github.com/the-Arioch/jcl · HTML · 163 lines · 161 code · 2 blank · 0 comment · 0 complexity · 686eb19f3a6e63c85be3b8ca8fa54f31 MD5 · raw file 

    

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html lang="en-us">
    3. 

  3. <head>
    4. 

  4.   <title>JEDI Code Library Experts</title>
    5. 

  5.   <meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type">
    6. 

  6.   <link rel="stylesheet" type="text/css" href="styles/default.css">
    7. 

  7.   <meta content="Project JEDI" name="author">
    8. 

  8. </head>
    9. 

  9. 

  10. <body>
    11. 

  11. <hr><br>
    12. 

  12. <h1>JEDI Code Library</h1>
    13. 

  13. <br>
    14. 

  14. <hr><br>
    15. 

  15. <h3>Content of this file</h3>
    16. 

  16. <ul>
    17. 

  17.   <li><a href="#about">About experts</a></li>
    18. 

  18.   <li><a href="#debug">Debug Extension for JclDebug unit</a></li>
    19. 

  19.   <li><a href="#version">Version control expert</a></li>
    20. 

  20.   <li><a href="#xmm">XMM debug window</a></li>
    21. 

  21.   <li><a href="#favorites">Favorite combobox in Open/Save dialogs</a></li>
    22. 

  22. </ul>
    23. 

  23. <hr><br>
    24. 

  24. <h3><a name="about">About experts</a></h3>
    25. 

  25. <p>For Delphi 5, Delphi 6, Delphi 7, C++Builder 5 and C++Builder 6, experts can
    26. 

  26. be installed as design time packages or dll experts. For C#Builder 1 and Delphi 8,
    27. 

  27. experts are installed as dll experts (those products don't load design time
    28. 

  28. packages). For Delphi 2005, Borland Developer Studio 2006, Turbo Delphi Professional and newer tools,
    29. 

  29. experts are installed as design time packages.</p>
    30. 

  30. <h3><a name="debug">Debug Extension for JclDebug unit</a></h3>
    31. 

  31. <p>The <tt>experts\debug </tt>folder contains an IDE expert which
    32. 

  32. assists to insert JCL Debug information into executable files. This can be 
    33. 

  33. useful when use source location routines from JclDebug unit. These routines 
    34. 

  34. need some kind of special information to be able provide source location for 
    35. 

  35. given address in the process. Currently there are four options to get it work:</p>
    36. 

  36. <ol>
    37. 

  37.   <li>Generate and deploy MAP file with your executable file. The file
    38. 

  38. is generated by the linker. It needs to be set in Project|Options
    39. 

  39. dialog -&gt; Linker page, Detailed checkbox.</li>
    40. 

  40.   <li>Generate and deploy JDBG file file with your executable file.
    41. 

  41. This is binary file based on MAP file but its size is typically about
    42. 

  42. 12% of original MAP file. You can generate it by MapToJdbg tool in <tt>jcl\experts\debug\tools</tt>
    43. 

  43. folder. The advantage over MAP file is smaller size and better security
    44. 

  44. of the file content because it is not a plain text file and it also
    45. 

  45. contains a checksum. The IDE expert can automatically create this file
    46. 

  46. when the project is compiled (see below).</li>
    47. 

  47.   <li>Insert JCL Debug info into executable file. The
    48. 

  48. size of added data is similar to JDBG file but it will be inserted
    49. 

  49. directly into the executable file. This is probably best option because
    50. 

  50. it combines small size of included data and no requirement of deploying
    51. 

  51. additional files. The IDE expert can automatically insert these informations
    52. 

  52. when the project is compiled (see below).</li>
    53. 

  53.   <li>Generate Borland TD32 debug symbols. These symbols are stored
    54. 

  54. directly in the executable file but usually adds several megabytes so
    55. 

  55. the file is very large. The advantage is you don't have to deploy any
    56. 

  56. other file and it is easy to generate it by checking Include TD32 debug
    57. 

  57. info in Linker option page.</li>
    58. 

  58. </ol>
    59. 

  59. <p>
    60. 

  60. The IDE expert will add new item to IDE Project menu. The expert behavior can be customized by
    61. 

  61. using the "JCL Debug Expert" item at the end 
    62. 

  62. of the Project menu. This submenu contains three settings to configure the operations that are automatically
    63. 

  63. executed each time the projects are compiled/built. Three distinct operations are possible:
    64. 

  64. <ol>
    65. 

  65.   <li>Automatically create .jdbg file from project MAP file;</li>
    66. 

  66.   <li>Automatically insert JCL Debug info into the executable;</li>
    67. 

  67.   <li>Automatically delete the MAP file after the conversions are done.</li>
    68. 

  68. </ol>
    69. 

  69. For each of these operations, the action can be enabled/disabled either on a project basis or for all projects.
    70. 

  70. The expert outputs a
    71. 

  71. message in the IDE message view to display details about the data being generated.</p>
    72. 

  72. <p>
    73. 

  73. You can generate those debug data for packages and libraries as well 
    74. 

  74. using the expert. Each executable file in the project can use different option
    75. 

  75. from those listed above. It is not necessary to generate any debug data for 
    76. 

  76. Borland runtime packages because the source location code can use names of exported 
    77. 

  77. functions to get procedure or method name. To get line number information for 
    78. 

  78. Borland RTL and VCL/CLX units you have to check Use Debug DCUs checkbox in 
    79. 

  79. Project|Options dialog -&gt; Compiler tab. Unfortunately, it is not 
    80. 

  80. possible to get line number information for Borland runtime packages 
    81. 

  81. because Borland does not provide detailed MAP files for them so you get 
    82. 

  82. procedure or method name only.</p>
    83. 

  83. <p>In case you have more than one data source for an executable file by 
    84. 

  84. an accident the best one is chosen in following order:</p>
    85. 

  85. <ol>
    86. 

  86.   <li>JCL Debug data in the executable file</li>
    87. 

  87.   <li>JDBG file</li>
    88. 

  88.   <li>Borland TD32 symbols</li>
    89. 

  89.   <li>MAP file</li>
    90. 

  90.   <li>DBG and PDB debug informations (for system DLLs)</li>
    91. 

  91.   <li>Library or Borland package export tables</li>
    92. 

  92. </ol>
    93. 

  93. <p>It is also possible to create JCL debug data programmatically from a MAP file
    94. 

  94. by using MakeJclDbg command line tool in jcl\experts\debug\tools folder.
    95. 

  95. This utility can either export data as a separate .jdbg file or insert them in the
    96. 

  96. executable. You can study included makefiles which uses this tool for building
    97. 

  97. delphitools examples.</p>
    98. 

  98. <p>To help using JclDebug exceptional stack tracking in application
    99. 

  99. simple dialog is provided in <tt>jcl\experts\repository\ExceptionDialog\StandardDialogs</tt>folder. The dialog
    100. 

  100. replaces standard dialog displayed by VCL applications when an unhandled
    101. 

  101. exception occurs. It has additional Detailed button showing the stack, list of 
    102. 

  102. loaded modules and other system information. By adding the dialog to the 
    103. 

  103. application exceptional stack tracking code is automatically initialized so you 
    104. 

  104. don't have to care about it. You can also turn on logging to text file by setting 
    105. 

  105. the Tag property of the dialog to '1'. These dialogs are intended to be added to 
    106. 

  106. Object Repository.</p>
    107. 

  107. <p>The repository expert can customize these standard exception dialogs by enabling additional features
    108. 

  108. and by helping their creation by a step by step wizard. The dialogs can be created for any Delphi/C++Builder
    109. 

  109. applications by invoking the File/New... menu.</p>
    110. 

  110. <p><b>Short description of getting the JclDebug functionality in your 
    111. 

  111. project:</b></p>
    112. 

  112. <ol>
    113. 

  113.   <li>Close all running instances of Delphi
    114. 

  114. </li>
    115. 

  115.   <li>Install JCL and IDE experts by the JCL Installer
    116. 

  116. </li>
    117. 

  117.   <li>Run Delphi IDE and open your project
    118. 

  118. </li>
    119. 

  119.   <li>Remove any TApplication.OnException handlers from your project(if any).
    120. 

  120. </li>
    121. 

  121.   <li>Add new Exception Dialog by selecting File | New | Other ... | 
    122. 

  122. Delphi Projects | Delphi Files, Select 'JCL Exception Dialog for XXX' (where XXX is
    123. 

  123. either Delphi or C++Builder depending on your project). A wizard will appear to
    124. 

  124. configure the options for this dialog.
    125. 

  125. </li>
    126. 

  126.   <li>Configure "Project" | "JCL Debug expert" to your needs
    127. 

  127. </li>
    128. 

  128.   <li>Do Project | Build</li>
    129. 

  129. </ol>
    130. 

  130. <hr><br>
    131. 

  131. <h3><a name="version">Version control expert</a></h3>
    132. 

  132. <p>A new expert integrating version control systems in the IDE was added.
    133. 

  133. It provides an integration of TortoiseCVS and TortoiseSVN inside the IDE, items
    134. 

  134. are added in the IDE menu and buttons can be placed in IDE toolbars via the
    135. 

  135. customize dialog, see below.</p>
    136. 

  136. <p>A dialog-box provides configuration options for JCL experts in the Tools menu.</p>
    137. 

  137. <p>It wraps <a href="http://tortoisecvs.sourceforge.net/">TortoiseCVS</a>&nbsp;
    138. 

  138. and&nbsp;<a href="http://tortoisesvn.sourceforge.net/">TortoiseSVN</a>&nbsp;commands in
    139. 

  139. actions that can be placed on IDE toolbars and in IDE menu.</p>
    140. 

  140. <p>This expert requires <a href="http://tortoisecvs.sourceforge.net/">TortoiseCVS</a>&nbsp;
    141. 

  141. or/and&nbsp;<a href="http://tortoisesvn.sourceforge.net/">TortoiseSVN</a>&nbsp;installed on the
    142. 

  142. system to properly work. Please refer to these products documentations for help
    143. 

  143. about using version control systems.</p>
    144. 

  144. <p>The structure of the "JCL Version" menu can be customized in the JCL options
    145. 

  145. dialog (in the "Tools" menu).</p>
    146. 

  146. <hr><br>
    147. 

  147. <h3><a name="xmm">XMM debug window</a></h3>
    148. 

  148. <p>This dialog provides enhancement to the debugger of Delphi and C++Builder regarding
    149. 

  149. XMM registers. These registers were introduced in SSE instructions (and are still
    150. 

  150. used in SSE2, SSE3 and SSSE3 instructions). This dialog can be displayed by clicking
    151. 

  151. on menu View | Debug Windows | SIMD (keyboard shortcut Ctrl+Alt+D).
    152. 

  152. It is divided in to panes following the style of the FPU window: the left pane
    153. 

  153. displays content of registers and the right pane displays MXCSR flags. The format
    154. 

  154. of the registers can be modified from the context. All registers and flags can be
    155. 

  155. modified and changes will be applied to the debugged process.</p>
    156. 

  156. <hr><br>
    157. 

  157. <h3><a name="favorites">Favorite combobox in Open/Save dialogs</a></h3>
    158. 

  158. <p>This expert modifies the IDE Open/Save dialogs and add a combobox to store your
    159. 

  159. favorite directories. Items can be added and deleted using the button at the right
    160. 

  160. of the combobox.</p>
    161. 

  161. </body>
    162. 

  162. </html>
    163.