IDE Window: Call Stack: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | ## Navigation | |
| 2 | 2 | ||
| 3 | 3 | [[Main menu|Main Menu]] \> [[Main menu|View]] \> Debug Windows \> Call Stack | |
| 4 | 4 | ||
| 5 | 5 | ## Important | |
| 6 | 6 | ||
| 7 | 7 | You must [[Debugger Setup|setup the debugger]] and start the project to debug it. Only then this window will be useful. | |
| 8 | 8 | ||
| 9 | 9 | The output shown on this page is based on the GNU debugger (GDB) which is currently the only debugger Lazarus supports. Its output looks at times like C, not Pascal. Other debuggers may show a more Pascal-like style. | |
| 10 | 10 | ||
| 11 | 11 | ## Dialog | |
| 12 | 12 | ||
| 13 | 13 |  | |
| 14 | 14 | ||
| 15 | 15 | ### What is the call stack? | |
| 16 | 16 | ||
| 17 | 17 | The call stack is the stack of function calls. The top line is the current function, the lowest line is the main program. | |
| 18 | 18 | ||
| 19 | 19 | ### Source column | |
| 20 | 20 | ||
| 21 | 21 | This column lists the filename of the source file. This information is retrieved from the debug information contained in the executable (or from an external GDB symbol file if you have selected that option). Only those parts of the program explicitly compiled with debug information contain this information. | |
| 22 | 22 | ||
| 23 | 23 | ### Line column | |
| 24 | 24 | ||
| 25 | 25 | If the position contains debug information, the source line number will be shown, otherwise only the address pointer in the executable is shown. This line is where the next function was called. | |
| 26 | 26 | ||
| 27 | 27 | **Note**: The line numbering is the numbering at the time the project was last compiled with debug information. If you have subsequently inserted or deleted lines, the numbering will appear to be incorrect. | |
| 28 | 28 | ||
| 29 | 29 | ### Function column | |
| 30 | 30 | ||
| 31 | 31 | The mangled name of the procedure or function. The compiler converts Pascal identifiers into names which the gnu tools (designed for C code) can use. For example: | |
| 32 | 32 | ||
| 33 | - | ||
| 33 | + | ```text | |
| 34 | + | TAPPLICATION__CREATEFORM(0x81fb738, void, (^TAPPLICATION) 0xb7cd0014) | |
| 35 | + | ``` | |
| 34 | 36 | ||
| 35 | 37 | This means: | |
| 36 | 38 | ||
| 37 | 39 | - The mangled function name is TAPPLICATION__CREATEFORM, which is the TApplication.CreateForm procedure of the LCL unit forms.pp. Because Pascal is case insensitive and the gnu tools are case sensitive, FPC converts the name to uppercase. Because the gnu tools don't know about classes and objects, the *class.method* is converted to a global function name. | |
| 38 | 40 | - The parameter list depends on the platform and the calling convention. That means the parameter list may be reversed, starting with the rightmost parameter. This is the case in the above example. | |
| 39 | 41 | - The 'Self' parameter is implicit, meaning that you don't write it in the Pascal source, because FPC creates it automatically. This is always the first parameter emitted by the compiler (though invisible in the Pascal source code). Because of the reversed parameter order, Self is shown here as the last parameter. It is of type ^TAPPLICATION and its hexadecimal value is 0xb7cd0014. | |
| 40 | 42 | - The next parameter in Pascal is 'var Reference', which has no type. Therefore it is 'void'. | |
| 41 | 43 | - The last parameter in Pascal is 'InstanceClass: TComponentClass'. Gnu sees this parameter simply as a pointer with the hexadecimal value 0x81fb738. | |
| 42 | 44 | ||
| 43 | 45 | ### Tricks | |
| 44 | 46 | ||
| 45 | 47 | Double click on an item to jump to the source. | |
| 46 | 48 | ||
| 47 | 49 | ## Toolbar | |
| 48 | 50 | ||
| 49 | 51 | On/Off | |
| 50 | 52 | Enable/Disable updates. Freezes the current content. | |
| 51 | 53 | ||
| 52 | 54 | View Source | |
| 53 | 55 | Jump to selected location in source editor. | |
| 54 | 56 | ||
| 55 | 57 | Current | |
| 56 | 58 | Set the selected frame as source for locals, watches, ... | |
| 57 | 59 | ||
| 58 | 60 | Max \## | |
| 59 | 61 | Set the amount of frames shown in the list | |
| 60 | 62 | ||
| 61 | 63 | More | |
| 62 | 64 | Increases the amount of frames shown in the list | |
| 63 | 65 | ||
| 64 | 66 | Top | |
| 65 | 67 | Set the first shown index to 0 | |
| 66 | 68 | ||
| 67 | 69 | Bottom | |
| 68 | 70 | Set the first shown index, so that the bottom of the stack is visible.\ | |
| 69 | 71 | E.g. if you show "Max 10" lines, and your app has 55 frames (from the main entry point to the current location), then the window will show frames from index 45 to 54 (54 is the 55th frame - zero based) | |
| 70 | 72 | ||
| 71 | 73 | Edit & Goto selected source line | |
| 72 | 74 | ||
| 73 | 75 | Show the entered index as first frame in the list.\ | |
| 74 | 76 | (source line =\> index) | |
| 75 | 77 | ||
| 76 | 78 | Copy all | |
| 77 | 79 | copy to clipboard | |
| 78 | 80 | ||
| 79 | 81 | ## Popup menu | |
| 80 | 82 | ||
| 81 | 83 |  | |
| 82 | 84 | ||
| 83 | 85 | ### Show | |
| 84 | 86 | ||
| 85 | 87 | Jump to the current item's source code position. | |
| 86 | 88 | ||
| 87 | 89 | ### Set as current | |
| 88 | 90 | ||
| 89 | 91 | Set the selected entry as the current stack frame. Local variables only exist within their own local stack frame. By setting the current frame, you can watch the values of variables in the (local) context of the procedure you have selected. | |
| 90 | 92 | ||
| 91 | 93 | ### Copy all | |
| 92 | 94 | ||
| 93 | 95 | Copy the call stack to the clipboard. | |
| 94 | 96 | ||
| 95 | 97 | --- | |
| 96 | 98 | *From the Free Pascal wiki, page "IDE Window: Call Stack", as it stood on 2022-09-10 after a change by Martin, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* |