From 0ea618a03f7a8f09a1ae283b1f5c88be6df96dd2 Mon Sep 17 00:00:00 2001 From: juha Date: Sun, 12 Jan 2020 18:07:45 +0000 Subject: [PATCH] Docs: New documentation file laztracer.xml for LazUtils. Issue #36560, patch from Don Siders. git-svn-id: trunk@62535 - --- .gitattributes | 1 + docs/xml/lazutils/laztracer.xml | 187 ++++++++++++++++++++++++++++++++ 2 files changed, 188 insertions(+) create mode 100644 docs/xml/lazutils/laztracer.xml diff --git a/.gitattributes b/.gitattributes index 3b069e52e1..94addb7598 100644 --- a/.gitattributes +++ b/.gitattributes @@ -6241,6 +6241,7 @@ docs/xml/lazutils/lazloggerprofiling.xml svneol=native#text/plain docs/xml/lazutils/lazmethodlist.xml svneol=native#text/plain docs/xml/lazutils/lazstringutils.xml svneol=native#text/plain docs/xml/lazutils/lazsysutils.xml svneol=native#text/plain +docs/xml/lazutils/laztracer.xml -text svneol=native#text/plain docs/xml/lazutils/lazunicode.xml svneol=native#text/plain docs/xml/lazutils/lazutf16.xml svneol=native#text/plain docs/xml/lazutils/lazutf8.xml svneol=native#text/plain diff --git a/docs/xml/lazutils/laztracer.xml b/docs/xml/lazutils/laztracer.xml new file mode 100644 index 0000000000..0c9fae2d24 --- /dev/null +++ b/docs/xml/lazutils/laztracer.xml @@ -0,0 +1,187 @@ + + + + + + + + + + + + + + + + Array type used for Pointers to code addresses + +

+ TStackTracePointers is an Array type which contains Pointers to code addresses. TStackTracePointers is the type passed as an argument to the GetStackTracePointers and StackTraceAsString routines. It is also the type used to implement the CreationStack and DestructionStack members in TDebugLCLItemInfo. +

+ + + + + + + + + + + + Record type used to store a pointer to a code address and its additional information + + + + + + + + + Pointer to the address for a source code symbol + + + Contains additional information about the code address and its origin + + + + Pointer to a TLineInfoCacheItem type + +

+ Used in the implementation of the GetLineInfo routine. +

+ + + + + + + + Raises an exception in the GDB debugger + +

+ RaiseGDBException is a procedure used to raise an exception in the GDB debugger. Normally, GDB does not catch FPC Exception objects. This procedure raises a standard "Division By Zero" exception, which IS caught by GDB. This allows a program to be stopped in the debugger without extra GDB configuration. +

+ + Please note: For the Amiga platform, Division by Zero errors are not catchable. The program will simply crash. + +

+ Msg contains the value used as the message in the exception. +

+ + + + + Value for the message in the exception + + + + Raises an exception that is caught and handled in an application + +

+ RaiseAndCatchException is a procedure used to generate an Exception that is caught and handled by an application. +

+ + Please note: For the Amiga platform, Division by Zero errors are not catchable. The program will simply crash. + + + + + + + Retrieves backtrace information for code addresses + +

+ GetStackTrace is a String function used to retrieve backtrace information for code addresses in a string format. +

+

+ Calls GetLineInfo to get information for the code addresses, using the value in UseCache as an argument. UseCache indicates if cached line information from an internal AVL tree can be used in the routine. When UseCache contains False, the BackTraceStrFunc in lclproc.pas is called to get the line information for each of the backtrace addresses. +

+ + + + + + + + String with information about backtrace addresses + + + Indicates if cached line information can be used in the routine + + + + Retrieve the addresses and information for a code address and its callers + +

+ GetStackTracePointers is a procedure used to retrieve the addresses and information for a code address and its callers. +

+

+ AStack is the array where pointers to code addresses for calling routines are stored. +

+ + + + + + + Array where pointers to code addresses are stored + + + + Gets a string with backtrace information for the specified call stack + +

+ StackTraceAsString is a String function used to get backtrace information for the code addresses specified in AStack. The return value contains lines with the values from GetLineInfo for each of the code addresses. +

+

+ UseCache indicates if cached line information from an internal AVL tree can be used in the routine. It is passed as an argument in calls to the GetLineInfo routine. +

+ + + + + + + + String with backtrace information for the call stack + + + Array of pointers to code addresses examined in the routine + + + Indicates if cached line information can be used in the routine + + + + Gets information about the specified code address + +

+ GetLineInfo is a String function used to get information about the code address specified in Addr. +

+

+ UseCache indicates if cached line information from an internal AVL tree can be used in the routine. When UseCache contains False, the BackTraceStrFunc in lclproc.pas is called to get the line information for each of the backtrace addresses. +

+ + + + + + + String with information about the code address + + + The code address examined in the routine + + + Indicates if locally cached line information can be used in the routine + + + + + +