Debug Info Agent™ exposes public, published, protected and private members of objects in Delphi applications as soon as the application is compiled with debug information. This topic explains how to include debug information into applications created with Borland Delphi v. 7 or Borland Delphi 2005 for Win32. To learn how to prepare applications created with other Delphi versions, see Implementing Debug Info Agent™ Support in Applications.
The Delphi compiler generates debug information in the TD32 format, which is compiled into the application’s binary modules. However, it is possible to extract debug information into separate .tds files using the TestComplete StripTDS utility.
Debug Info Agent™ can work with both formats. However, we recommend that you create external .tds files for release builds of your products. This will decrease the overall size of your application. The TD32 format of debug information can be used for intermediate or special builds.
Below are detailed instructions on changing the project options to use the desired format of debug information.
Note: | Debug Info Agent™ is incompatible with tools that change the debug information format. An example of such a tool is EurekaLog 7. We recommend that you disable EurekaLog when compiling an application aimed for automated testing with TestComplete. Otherwise, you will be unable to access private, protected and public methods and properties of your Delphi applications from tests. |
External Debug Information (TDS Files)
The .tds files are created based on executables and DLLs compiled with TD32 debug information included. To remove debug information from modules and store them in separate .tds files, you can use the StripTDS utility that is shipped with TestComplete.
So, to create .tds files, you should first compile the tested Delphi application with debug information and then process the compiled modules with the StripTDS utility. Below are detailed steps:
-
Change the project settings to compile the application with TD32 debug information:
-
Open your project in Borland Delphi.
-
Select Project | Options from Delphi’s main menu. This will open the Project Options dialog.
-
Switch to the Compiler tabbed page and check the Debug information and Local symbols options in the Debugging group:
Note: It is possible to keep the Local symbols disabled, but in this case the names of some method parameters will not be displayed in the Object Browser panel. -
Switch to the Linker tab and enable the Include TD32 debug info option in the EXE and DLL options group:
-
Press OK to save the changes and close the Project Options dialog.
-
Re-build the application.
-
-
Apply the StripTDS utility to each compiled executable and DLL. For example, to process all EXE and DLL files in the C:\MyApp folder and its subfolders, you can use the following command line:
StripTDS.exe -r -w C:\MyApp\*.exe;C:\MyApp\*.dll
The utility will remove debug information from the executable files and save it to separate .tds files. The utility only works with those sections in the binary file that contain debug information. It does not change the code and data sections, so your module will work as it was designed. For more information about the modifications and command-line arguments of the StripTDS utility, see About StripTDS.
Some notes concerning this approach:
-
The .tds files containing debug information must reside in the same folders that the appropriate modules of the tested application.
-
Even if the application is compiled with the Local symbols option enabled, the names of some method parameters may not be displayed in the Object Browser. If viewing parameter names is important to you (for instance, if you are developing new tests), compile the tested Delphi application with internal TD32 debug information (see below).
-
There is no need to distribute the generated .tds files with your application.
Internal Debug Information (TD32)
To compile your Delphi application with embedded TD32 debug information, follow these steps:
-
Choose Project | Options from the main menu.
-
In the ensuing Project Options dialog, switch to the Compiler tabbed page. Enable the Debug information option in the Debugging group to include debug information:
-
To see the names of method parameters in the Object Browser panel, turn off the Optimization option and enable the Local symbols option. When using Delphi 7.0 or later, also enable the Use Debug DCUs option:
-
Switch to the Linker tab and enable the Include TD32 debug info option in the EXE and DLL options group:
-
It is recommended that you turn off the Build with runtime packages option on the Packages tabbed page:
If this property is checked, Delphi creates Borland package library (.bpl) files when compiling the application. TestComplete cannot access debug information in these files and some controls. If this property is unchecked, all information is included in a single executable and can be accessed by TestComplete. For more information about runtime packeges, see About Runtime Packages.
If, for some reason, you cannot turn off the Build with runtime packages option, TestComplete may not be able to get access to the application's internal methods and properties. To resolve the problem, enable the Read debug information for statically linked libraries project option in TestComplete. -
Once you have completed these steps, click OK to save the changes and close the Project Options dialog.
-
Re-compile the application.
Remember to recompile the release version of your application without TD32 debug information in order to reduce the application size.
See Also
Debug Info Agent™
Debug Info Agent™ Specifics
Testing Delphi Applications - Overview