Cocoa Debugging: what changed
Revision 2 to 3. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | *(macOS only)* | |
| 2 | 2 | ||
| 3 | 3 | Having problems running a project compiled for Cocoa? Here are steps to try | |
| 4 | 4 | ||
| 5 | 5 | ## Run from Terminal | |
| 6 | 6 | ||
| 7 | 7 | - open up a Terminal (Applications -\> Utilities -\> Terminal). | |
| 8 | 8 | - cd to your project directory | |
| 9 | 9 | - cd to the bundle (a bundle is a specially structured directory where binary resides. The bundle directory extension is ".app" ) | |
| 10 | 10 | ||
| 11 | - | ||
| 11 | + | ```text | |
| 12 | 12 | cd project1.app/Contents/MacOS | |
| 13 | 13 | ``` | |
| 14 | 14 | ||
| 15 | 15 | (for your project "project1.app" needs to be changed to your project's name) | |
| 16 | 16 | ||
| 17 | 17 | - run the project | |
| 18 | 18 | ||
| 19 | - | ||
| 19 | + | ```text | |
| 20 | 20 | ./project1 | |
| 21 | 21 | ``` | |
| 22 | 22 | ||
| 23 | 23 | See the output! The output might suggest what's going on. Any OS or error warning messages should be shown. | |
| 24 | 24 | ||
| 25 | 25 | ### Console App | |
| 26 | 26 | ||
| 27 | 27 | The log entries could also be acquired from Console utillity. | |
| 28 | 28 | ||
| 29 | 29 | ## Run with lldb debugger | |
| 30 | 30 | ||
| 31 | 31 | Repeat the same steps as in "Run from Terminal", but run the program as | |
| 32 | 32 | ||
| 33 | - | ||
| 33 | + | ```text | |
| 34 | 34 | lldb project1 | |
| 35 | 35 | ``` | |
| 36 | 36 | ||
| 37 | 37 | (loading of lldb requires admin rights, and well as takes some time) once loaded enter command | |
| 38 | 38 | ||
| 39 | - | ||
| 39 | + | ```text | |
| 40 | 40 | r | |
| 41 | 41 | ``` | |
| 42 | 42 | ||
| 43 | 43 | and wait for it to stop or catch the application crash. See more [[lldb|here]] | |
| 44 | 44 | ||
| 45 | 45 | ## Troubleshooting | |
| 46 | 46 | ||
| 47 | 47 | - if a project can compile and run for Carbon, yet it cannot do the same for Cocoa, then the issue is likely with Cocoa widgetset. Creating a minimal sample project is suggested | |
| 48 | 48 | - if a project runs but does nothing and provides a constant CPU load (i.e. 99%, 50% or 25%, depending on the number of cores), then there's an endless loop triggered by some code. | |
| 49 | 49 | ||
| 50 | 50 | ## Creating a Minimal Sample Project | |
| 51 | 51 | ||
| 52 | 52 | It's likely you would encounter a problem when working with a big production project. | |
| 53 | 53 | ||
| 54 | 54 | It's likely you might have some closed-source code that you're not allowed to share. | |
| 55 | 55 | ||
| 56 | 56 | It's preferred to have a simple project demonstrating the problem. "Simple" meaning: | |
| 57 | 57 | ||
| 58 | 58 | - it's small in size one (or two) forms only. | |
| 59 | 59 | - minimal set of controls | |
| 60 | 60 | - NO external package dependencies (packages supplied with Lazarus are ok) | |
| 61 | 61 | ||
| 62 | 62 | In order to get a simple project from the big production project you can do the following: | |
| 63 | 63 | ||
| 64 | 64 | - copy the project stand-alone (not to harm the existing code base) | |
| 65 | 65 | - remove (delete) pieces that are not related to the bug | |
| 66 | 66 | ||
| 67 | 67 | :* (i.e. if you're having problems with placement of a control, you might want to remove main menu, TActions, if any) | |
| 68 | 68 | ||
| 69 | 69 | :* remove bigger pieces first (it might be much easier than you think) | |
| 70 | 70 | ||
| 71 | 71 | - after each piece is removed, run the project, to make sure you're still getting the error. | |
| 72 | 72 | - keep removing code (and reference to any other external dependencie) until you reach the point that you cannot remove anything without affecting the bug. | |
| 73 | 73 | ||
| 74 | 74 | At this point you should have small enough project to demonstrate the problem and [[How do I create a bug report|bug report it]]. | |
| 75 | 75 | ||
| 76 | 76 | ## See also | |
| 77 | 77 | ||
| 78 | 78 | - [[How do I create a bug report]] | |
| 79 | 79 | - [[lldb]] | |
| 80 | 80 | - [[Cocoa Interface]] | |
| 81 | 81 | - [Apple: Appendix A: LLDB for GDB Users – Command Summary](https://developer.apple.com/library/archive/documentation/General/Conceptual/lldb-guide/chapters/A3-GDB-Summary.html) | |
| 82 | 82 | ||
| 83 | 83 | --- | |
| 84 | 84 | *From the Free Pascal wiki, page "Cocoa Debugging", as it stood on 2020-08-06 after a change by Trev, 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).* | |
| 85 | 85 | Category: Cocoa | |
| 86 | 86 | Category: Debugging | |
| 87 | 87 | Category: macOS |