Difference between revisions of "Installing Lazarus on macOS"
Edgardager (talk | contribs) |
m (→Building Lazarus development version source: Add link to bigide explanation) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Installing Lazarus on macOS}} | {{Installing Lazarus on macOS}} | ||
| − | + | Installing Lazarus on a Mac is not particularly difficult but it is critical that you do the install in the correct order. Skipping steps will almost certainly end in tears. In brief, here is what you need to do: | |
| − | # | + | # Download and install Xcode (optional depending on your needs - see below for details). |
| − | # | + | # Install the global command line tools for Xcode. |
| − | # | + | # Download and install the Free Pascal Compiler (FPC) binaries package and the FPC source package from the [https://sourceforge.net/projects/lazarus/files/ Lazarus IDE file area] ('''Important''' do this ''before'' you install the Lazarus IDE) |
| − | # | + | # Download and install the Lazarus IDE from the [https://sourceforge.net/projects/lazarus/files/ Lazarus IDE file area] |
| − | # Configure LLDB - | + | # Configure LLDB - the Apple supplied (and signed) debugger from within the Lazarus IDE. |
| − | + | These steps are explained in more detail below. | |
| − | == | + | == Installation == |
| − | + | The detailed instructions assume a recent version of macOS on your Mac, a recent version of Xcode and/or Xcode command line tools from Apple and a recent version of Lazarus. On the [[#Legacy_Information|Legacy Information]] page, you will see older information that may be relevant if you are using older components. You can assist by replacing out of date information, either deleting it, or, if it may help someone working with a legacy project, moving it to the [[Legacy_Information:_Installing_Lazarus_on_Mac|legacy information]] page. | |
| − | + | In general, this is about using both the '''Carbon''' and '''Cocoa''' Widget Sets. While Carbon was once seen as a little more stable, with the release Lazarus 2.0.8 the 64 bit Cocoa Widget Set has now surpassed Carbon and should be considered seriously for any new projects. Carbon was intentionally limited to 32 bits by Apple and you should be aware that it and the ability to run 32 bit executables have been removed completely from macOS 10.15 Catalina and later versions which now only support 64 bit executables using Cocoa. | |
| − | === | + | === Step 1: Download Xcode (optional) === |
| − | Xcode | + | Xcode is a 12GB download which will take up 16GB of disk space. You '''only''' need to download and install the full Xcode development environment '''if''' you need: |
| − | * | + | * the SDKs for '''iOS''', '''iPadOS''', watchOS and tvOS; or |
| − | * | + | * to validate and upload apps to the Mac App Store; or |
| − | * | + | * to [[Notarization for macOS 10.14.5+|notarise]] apps for distribution outside of the Mac App Store. |
| − | Xcode 11.3.1 | + | Xcode 11.3.1 for use on macOS 10.14 Mojave must now be installed by downloading it from [http://developer.apple.com/ Apple Developer Connection] (ADC), which requires free registration. Xcode 12.4.x for use on macOS 10.15 Catalina and later versions can be installed from the [https://apps.apple.com/us/genre/mac-developer-tools/id12002?mt=12 Mac App store]. Note that you must first move any old Xcode versions from the Applications folder into the trash or rename the Xcode app (eg Xcode.app to Xcode_1014.app). You can then select which version of Xcode to use with the command line utility <tt>xcode-select</tt>. Open an Applications > Utilities > Terminal and type <tt>man xcode-select</tt> for this utility's manual page. |
| − | |||
| − | Note | ||
| − | |||
| − | |||
| − | |||
| − | |||
| + | '''Older systems:''' | ||
| + | The Xcode developer tools can be installed from the original macOS installation disks or a newer copy downloaded from the [http://developer.apple.com/ Apple Developer Connection] (ADC), which requires free registration. Download the Xcode file, it will end up in your Downloads directory as a zip file. Click it. It is unarchived into your Downloads directory. You may be happy with it there but maybe not. Other users will see the path to it but be unable to use it. And it is untidy there. So I moved mine and then told xcode-select where it was moved to (in a terminal) - | ||
<syntaxhighlight lang="bash">mv Downloads/Xcode.app /Developer/. | <syntaxhighlight lang="bash">mv Downloads/Xcode.app /Developer/. | ||
sudo xcode-select -s /Developer/Xcode.app/Contents/Developer </syntaxhighlight> | sudo xcode-select -s /Developer/Xcode.app/Contents/Developer </syntaxhighlight> | ||
| + | === Step 2: Xcode Command Line Tools === | ||
| − | + | This is shown here as a separate step because it really is a separate step. Don't confuse these standalone command line tools with the internal Xcode command line tools that the Xcode GUI will tell you are already installed if you installed the full Xcode package in Step 1. FPC cannot use those Xcode internal command line tools without configuration changes (see [[Xcode]] for details). | |
| − | |||
| − | |||
| − | |||
| − | |||
| + | Do the following, it is quick and easy for all macOS versions up to and including Catalina 10.15: | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
| Line 53: | Line 47: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | For Big Sur 11.x and later, you only need to enter the first of the two commands above unless you have also installed the full Xcode package. If you have only installed the command line tools, you should omit entering the ''xcodebuild'' command. | |
| − | |||
| − | |||
| − | + | If you have problems installing the command line tools using this command line method (eg the installer freezes while "finding Software"), you can also download and install the command line tools package by logging in to the [https://developer.apple.com/download/more/?=for%20Xcode Apple Developer Site] and downloading and installing the ''Command Line Tools for Xcode'' disk image. | |
| − | + | === Step 3: FPC binaries and FPC source code === | |
| − | + | {{Note| For Apple Silicon/AArch64/M1 installations, if you are installing FPC 3.2.2 (Lazarus 2.2RCx or 2.2.0 or later) you don't need to compile a native Apple Silicon version of FPC because FPC 3.2.2 for macOS is a universal binary containing both Intel and aarch64 executables. If you are installing a version of FPC earlier than 3.2.2, then please refer to [[macOS_Big_Sur_changes_for_developers#ARM64.2FAArch64.2FApple_Silicon_Support|these instructions]] for building a native Apple Silicon Free Pascal Compiler after installing the 64 bit Intel binary and source packages for FPC.}} | |
| − | + | Download and install the official FPC binaries package and the separate FPC source package from the [https://sourceforge.net/projects/lazarus/files/ Lazarus IDE file area]. | |
| − | + | When you arrive at the Lazarus IDE file area: | |
| − | |||
| − | + | # Choose the correct version of your operating system. The vast majority of Mac users should now choose the 64 bit packages in the Lazarus macOS x86-64 directory. Every Mac computer since late 2006 has been 64 bit capable. The fact that Apple has completely dropped all 32 bit support from macOS 10.15 Catalina (released in October 2019) is another reason to choose the 64 bit packages. | |
| + | # Choose the version of Lazarus you wish to install and you will be presented with the two FPC binary and source packages to download. | ||
| − | + | These installation packages are built by the FPC/Lazarus developers and track formal releases. As these installation packages are not approved by Apple, you need to hold down the Control key, click the package and choose Open and confirm you want to install from an Unknown Developer. | |
| − | |||
| − | + | You might like to try a simple and quick test of FPC at this stage - [[Installing_the_Free_Pascal_Compiler#Testing_the_FPC_Install|Testing FPC installation]]. | |
| − | + | === Step 4: Install the Lazarus IDE === | |
| − | + | It is critical that a compatible Free Pascal Compiler (FPC) and its source must be installed ''before you install'' the Lazarus IDE. | |
| − | + | {{Note| For installation on Apple Silicon/AArch64, please refer to the [[#Lazarus Fixes 2.2|Lazarus Fixes 2.2]] or [[#FPC_development_version|Lazarus development]] instructions to build a native Lazarus IDE. Skip to the building instructions and use the Lazarus Fixes 2.2 source / Lazarus development source download as you wish.}} | |
| + | Download and install the Lazarus IDE from the [https://sourceforge.net/projects/lazarus/files/ Lazarus IDE file area]. When you arrive at that file area, choose the correct version of your operating system. The vast majority of Mac users should now choose the 64 bit packages in the Lazarus macOS x86-64 directory. Every Mac computer since late 2006 has been 64 bit capable. The fact that Apple has completely dropped all 32 bit support from macOS 10.15 Catalina (released in October 2019) is another reason to choose the 64 bit packages. | ||
| − | === | + | === Step 5: Configure the Debugger === |
| − | + | In versions of Lazarus 1.8.4 and earlier, you needed to use <tt>gdb</tt> as a debugger, slow to install and hard to sign. Since Lazarus 2.0.0 you can (and should) use <tt>lldb</tt>, a debugger provided by Apple, no signing required. | |
| − | + | Assuming you have installed what is necessary and started Lazarus, all that remains is configuring the debugger. If you don't do this now, Lazarus will try to use <tt>gdb</tt> and fail. | |
| − | + | * Lazarus version 2.2.0: First, click Lazarus > Preferences > Debugger - Debugger Backend; | |
| − | * Lazarus | + | * Lazarus before version 2.2.0: First, click Tools > Options > Debugger. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| + | Top right of the window now open has a label, "Debugger type and path", you must set both the type and the path. Select the type "LLDB debugger (with fpdebug) (Beta)" and select or type the path <tt>/usr/bin/lldb</tt>. | ||
[[File:Set_Debugger2.png|none]] | [[File:Set_Debugger2.png|none]] | ||
| − | + | If "LLDB debugger (with fpdebug) (Beta)" is not shown in the selection list, see [[#Installing_LazDebuggerFpLLdb|Installing LazDebuggerFpLLdb]] below. The XCode command line tools install <tt>lldb</tt> to the <tt>/usr/bin</tt> directory. Save those settings and you can now try to compile the almost nothing program that Lazarus has kindly provided for you (click the small green triangle near top left). | |
| − | + | Next you see a puzzling question, see image below. Choose a "Debug Format" from one of those offered - | |
[[File:Set_Dwarf.png|none]] | [[File:Set_Dwarf.png|none]] | ||
| − | Martin_fr, | + | Martin_fr, the person who has given us this interface between the Lazarus IDE and <tt>lldb</tt>, suggests you use ''' "dwarf3" '''. Then, you need to enter your password, a macOS cuteness because one application appears to be interfering with another. In this case, that's fine! |
| − | + | When running the debugger from time to time you will be asked for your password to allow debugging. This is for your own safety. | |
| + | ==== Extra Information on using lldb ==== | ||
| − | + | A great deal of information about using lldb appears in [https://forum.lazarus.freepascal.org/index.php/topic,42869.0.html this forum thread]. Here are a few gems, again, from Martin_fr: | |
| − | + | In the unexpected case of problems, it may be worth trying "dwarf with sets" instead of just "dwarf3". | |
| − | + | The "debug info" setting only affects the units directly in your project. However, units in packages may have debug info too. This can be: | |
| − | + | * set per package | |
| − | + | * for many, but not all packages in the menu Tools > Configure "Build Lazarus" | |
| − | * set | ||
| − | * | ||
* Project > Project Options > [[IDE_Window:_Compiler_Options#Additions_and_Overrides|Additions and Overrides]] | * Project > Project Options > [[IDE_Window:_Compiler_Options#Additions_and_Overrides|Additions and Overrides]] | ||
| − | + | If you change settings for a package, you might want to check which package you expect to step into when debugging. Packages you do not step into, do not need debug info. | |
| − | + | If you use a type from a package (such as TForm from LCL) it is enough that your unit (in which you declare the variable / must declare and use a variable to include the type) has debug info. Reducing the number of packages with debug info (including those that default to have debug info), can shorten the debuggers start-up time. | |
| − | + | Also it may be worth comparing (it has not been tested) the debuggers start up time for the same settings, only changing the checkbox "use external debug info". | |
| − | + | This needs to be only set in your project. If set in your project it will affect all packages. (If set in a package it should have no affect.) | |
| + | ==== Installing LazDebuggerFpLLdb ==== | ||
| − | + | If you installed from source and used the [[#What does the bigide make argument do?|<tt>bigide</tt>]] parameter to <tt>make</tt>, then the correct debugger will be installed, as a package, and ready to go. If, however, you installed in another way, it may, or may not be there. | |
| − | + | From the main IDE screen, click Packages->Install/UninstallPackages. Shown is two lists of packages, the list on the left is installed, the list on the right is available to install. Look for LazDebuggerFpLldb (exactly that, there are some similar named but less suitable packages). If it is on the right hand side, click it, press "Install Selection" and then "Save and rebuild IDE". This will take a little time, the IDE will shutdown and restart and all should be well. Now jump back up the page and continue configuring the debugger. | |
| − | + | == Cocoa 64 bit vs Carbon 32 bit == | |
| + | Using the Apple 64 bit Cocoa framework is now undeniably the future on the Mac. The Apple 32 bit Carbon framework, while no longer being developed, works pretty much as expected, but you are advised to try Cocoa first because Apple dropped all support for 32 bit applications and the 32 bit Carbon framework in macOS 10.15 Catalina (October 2019). | ||
| − | + | It is possible to build a Cocoa version of the Lazarus IDE with v2.0.0 and later. It is also possible to build a Carbon version of the Lazarus IDE (unless you are running macOS 10.15 Catalina or later) and use that to generate Cocoa 64 bit binaries. | |
| − | + | To produce Cocoa applications in the Carbon or Cocoa IDE, you need to set the Target to the 64 bit processor and select the Cocoa widgetset: | |
| − | + | * Open your project with Lazarus and from the menu select Project > Project Options | |
| + | * In the "Config and Target" panel set the "Target CPU family" to be "x86_64" (Intel) or "aarch64" (Apple M1) | ||
| + | * In the "Config and Target" panel, if the "Current LCL widgetset" is not set to Cocoa, click "Select another LCL widgetset" which will take you to the "Additions and Overrides" panel where you can click on "Set LCLWidgetType" pulldown and set the value to "Cocoa" | ||
| + | * Make sure under Tools > Options (Lazarus > Preferences in v2.2.0 and later) that "Compiler Executable" is set to "/usr/local/bin/fpc" to get 64 bit applications. | ||
| + | * Now compile your project - and please feed back any problems you experience. | ||
| − | + | == FPC + Lazarus Compatibility Matrix == | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | == | ||
| − | |||
| − | |||
| + | Not every combination of Lazarus and Free Pascal is compatible with every installation of macOS. Please refer to the following table in order to find the correct version for your development environment: | ||
{{Template:Compatibility matrix of Lazarus for Mac}} | {{Template:Compatibility matrix of Lazarus for Mac}} | ||
| − | == | + | == Installing non-release versions of the Lazarus IDE == |
| − | === | + | === Lazarus Fixes 2.2 === |
| − | * [[Lazarus_2.2_fixes_branch| | + | * [[Lazarus_2.2_fixes_branch|Fixes included in fixes_2_2]] |
| − | + | There are a number of reasons why you may be better off using a non-release version of Lazarus, specifically, fixes_2_2. Particularly: | |
| − | * | + | * You almost certainly need to target 64 bit Cocoa, macOS 10.15 Catalina and later do not support 32 bit Carbon at all. |
| − | * | + | * The Cocoa widget set has steadily improved and the lldb debugger interface has rapidly improved, since even v2.0.0. |
| − | * | + | * If your Mac has an Apple M1 Processor, the debugger in fixes_2_2 now works for aarch64. |
| − | * Fixes_2_2 | + | * Fixes_2_2 is a safer and more stable option than the development branch, but still gets the new features much faster than the release version. |
| − | + | Pre-compiled binaries based on fixes_2_2 are not available from SourceForge so we download and build from the source code. A little slow initially but very reliable and a great test of your compiler install ! You will need git which is included in all recent versions of the Xcode command line tools which you should have already installed (see [[#Step_2:_Xcode_Command_Line_Tools|Xcode Command Line Tools]] above). | |
| − | + | About svn or git: The Xcode 11.4 command line tools on macOS 10.15 no longer install svn, only git. You can install subversion via fink, ports or brew. | |
| + | {{Apple Silicon Lazarus Build Notes}} | ||
| − | + | ==== Downloading Lazarus Fixes 2.2 source ==== | |
| − | + | Create a directory for Lazarus and download the current fixes version: | |
| − | |||
| − | |||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
| Line 191: | Line 172: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | Using git: | |
git clone -b fixes_2_2 https://gitlab.com/freepascal.org/lazarus/lazarus.git laz_fixes | git clone -b fixes_2_2 https://gitlab.com/freepascal.org/lazarus/lazarus.git laz_fixes | ||
| − | + | Using svn: | |
svn checkout https://github.com/fpc/Lazarus/branches/fixes_2_2 laz_fixes | svn checkout https://github.com/fpc/Lazarus/branches/fixes_2_2 laz_fixes | ||
| − | + | Depending on your internet connection and server congestion this takes a few seconds or a few minutes. | |
| + | ==== Updating Lazarus Fixes 2.2 source ==== | ||
| − | + | To keep your fixes_2_2 installation up to date is as easy as: | |
| − | + | Using git: | |
| − | |||
| − | |||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
| Line 212: | Line 192: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | Using svn: | |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
| Line 220: | Line 200: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | ==== | + | ==== Building Lazarus Fixes 2.2 source ==== |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
cd laz_fixes | cd laz_fixes | ||
make distclean all LCL_PLATFORM=cocoa CPU_TARGET=x86_64 bigide | make distclean all LCL_PLATFORM=cocoa CPU_TARGET=x86_64 bigide | ||
| − | //- | + | //-wait some time... |
open startlazarus.app --args "--pcp=~/.laz_fixes" | open startlazarus.app --args "--pcp=~/.laz_fixes" | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | * Note | + | * Note I pass a parameter to use a config directory that is based on the name of the actual install directory. It makes some scripting easy. |
| − | * | + | * On older macOS versions supporting 32 bit applications, replace the above make line with "''make LCL_PLATFORM=carbon CPU_TARGET=i386 bigide'' " and set up your project as mentioned in the [[#Cocoa_64_bit_vs_Carbon_32_bit|Carbon and Cocoa]] section below. |
| − | + | You might like to put a small script in your $HOME/bin directory and even set a path to it (very UNIX!) | |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
| Line 242: | Line 222: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | === | + | === Lazarus development version === |
| − | * [[Lazarus_2.4.0_release_notes| | + | * [[Lazarus_2.4.0_release_notes|Lazarus Development Version Notes]] - Note: work in progress |
| − | + | Precompiled binaries based on the development version (was known as "trunk" in SVN; now known as "main" in GIT) of the Lazarus IDE are not available from SourceForge, so here's how to download the development version source using ''svn'' or ''git'' and build the Lazarus IDE. You will need svn (before macOS 10.15 - Catalina) or git (after macOS 10.14 - Mojave) which is included in the standalone Xcode command line tools which you should have already installed (see Xcode Command Line Tools above). | |
| − | {{ | + | {{Apple Silicon Lazarus Build Notes}} |
| − | ==== | + | ==== Downloading Lazarus development version source ==== |
<syntaxhighlight lang="sh"> | <syntaxhighlight lang="sh"> | ||
| Line 258: | Line 238: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | Using git: | |
git clone -b main https://gitlab.com/freepascal.org/lazarus/lazarus.git laz_main | git clone -b main https://gitlab.com/freepascal.org/lazarus/lazarus.git laz_main | ||
| − | + | Using svn: | |
svn checkout --depth files https://github.com/fpc/Lazarus/branches all | svn checkout --depth files https://github.com/fpc/Lazarus/branches all | ||
cd all | cd all | ||
svn update --set-depth infinity main | svn update --set-depth infinity main | ||
| − | + | The above svn invocation is more complex due to a bug in many versions of Subversion. This workaround was the work of Alfred (aka Don Alfredo in the [[Forum]]) who is the wizard behind [[fpcupdeluxe]]. | |
| − | ==== | + | ==== Updating Lazarus development version source ==== |
| − | + | To update your existing Lazarus development version source. | |
| − | + | Using git: | |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
| Line 280: | Line 260: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | Using svn: | |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
| Line 288: | Line 268: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | ==== | + | ==== Building Lazarus development version source ==== |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
make distclean all LCL_PLATFORM=cocoa CPU_TARGET=x86_64 ide | make distclean all LCL_PLATFORM=cocoa CPU_TARGET=x86_64 ide | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | or, | + | or, for the bigger IDE (see [[Installing_Lazarus_on_macOS#What_does_the_bigide_make_argument_do.3F|below]] for an explanation of the bigide make argument): |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
make distclean all LCL_PLATFORM=cocoa CPU_TARGET=x86_64 bigide | make distclean all LCL_PLATFORM=cocoa CPU_TARGET=x86_64 bigide | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | After one of above commands, wait some time and: | |
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
open startlazarus.app --args "--pcp=~/.laz_dev" | open startlazarus.app --args "--pcp=~/.laz_dev" | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | === | + | === What does the bigide make argument do? === |
{{BigIDE}} | {{BigIDE}} | ||
| − | == | + | == Installing non-release versions of FPC == |
{{macOS FPC Source Installation}} | {{macOS FPC Source Installation}} | ||
| − | == | + | == Known issues and solutions == |
| − | === | + | === Lazarus IDE v2.2.0 - rebuilding issue === |
| + | <div class="mw-collapsible mw-collapsed"> | ||
| − | + | Any attempt to rebuild the Lazarus IDE from within itself fails with permission errors because the files and directories are owned by a user with the id of 503 whereas most users will find that their id is 501. The solution is to open an Applications > Utilities> Terminal and: | |
| − | |||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
| Line 323: | Line 303: | ||
sudo chown -R your_username Lazarus | sudo chown -R your_username Lazarus | ||
| − | ==== | + | ==== The following rebuilding errors do not happen on Intel computers ==== |
| − | |||
| − | |||
| + | The next error that occurs is that the resource compiler "fpcres" is not found. The solution is to create a <tt>.fpc.cfg</tt> (note the initial dot) file in your home directory and add these lines to it: | ||
#include /etc/fpc.cfg | #include /etc/fpc.cfg | ||
-FD/usr/local/bin | -FD/usr/local/bin | ||
| − | + | so that "fpcres" can be found where it was installed. | |
| − | + | The next error complains of an unsupported target architecture <tt>-Paarch64</tt>, with the advice to invoke the "fpc" compiler driver instead - except that is what we are doing already. The solution is to go to Lazarus > Preferences > Compiler executable which is set to <tt>/usr/local/bin/fpc</tt> and change that to <tt>/usr/local/lib/fpc/3.2.2/ppca64</tt> instead. | |
| − | + | The IDE will now be successfully rebuilt but will not restart automatically. Trying to then start Lazarus from either the <tt>startlazarus.app</tt> icon or the <tt>lazarus.app</tt> icon in <tt>/Applications/Lazarus</tt> still results in the original Intel lazarus binary being launched. The correct aarch64 binary can be found in <tt>~/.lazarus/bin/aarch64-darwin/lazarus</tt>. So the final solution is to open an Application > Utilities > Terminal and: | |
mv /Applications/Lazarus/lazarus /Applications/Lazarus/lazarus.old | mv /Applications/Lazarus/lazarus /Applications/Lazarus/lazarus.old | ||
mv ~/.lazarus/bin/aarch64-darwin/lazarus /Applications/Lazarus/ | mv ~/.lazarus/bin/aarch64-darwin/lazarus /Applications/Lazarus/ | ||
| − | + | You can then start the IDE with either the <tt>startLazarus.app</tt> or <tt>lazarus.app</tt> icons. When you do restart lazarus, it is worth returning to the Lazarus > Preferences > Compiler executable which is set to <tt>/usr/local/lib/fpc/3.2.2/ppca64</tt> and changing it back to <tt>/usr/local/bin/fpc</tt> so that you can compile both aarch64 and Intel binaries to, for example, make a [[macOS_Big_Sur_changes_for_developers#Creating_a_universal_binary_for_aarch64_and_x86_64|Universal Binary]] which will run on both Intel and aarch64 machines. | |
</div></div> | </div></div> | ||
Revision as of 14:04, 4 March 2023
│ English (en) │ español (es) │ 한국어 (ko) │ русский (ru) │
This article applies to macOS only.
See also: Multiplatform Programming Guide
Installing Lazarus on a Mac is not particularly difficult but it is critical that you do the install in the correct order. Skipping steps will almost certainly end in tears. In brief, here is what you need to do:
- Download and install Xcode (optional depending on your needs - see below for details).
- Install the global command line tools for Xcode.
- Download and install the Free Pascal Compiler (FPC) binaries package and the FPC source package from the Lazarus IDE file area (Important do this before you install the Lazarus IDE)
- Download and install the Lazarus IDE from the Lazarus IDE file area
- Configure LLDB - the Apple supplied (and signed) debugger from within the Lazarus IDE.
These steps are explained in more detail below.
Installation
The detailed instructions assume a recent version of macOS on your Mac, a recent version of Xcode and/or Xcode command line tools from Apple and a recent version of Lazarus. On the Legacy Information page, you will see older information that may be relevant if you are using older components. You can assist by replacing out of date information, either deleting it, or, if it may help someone working with a legacy project, moving it to the legacy information page.
In general, this is about using both the Carbon and Cocoa Widget Sets. While Carbon was once seen as a little more stable, with the release Lazarus 2.0.8 the 64 bit Cocoa Widget Set has now surpassed Carbon and should be considered seriously for any new projects. Carbon was intentionally limited to 32 bits by Apple and you should be aware that it and the ability to run 32 bit executables have been removed completely from macOS 10.15 Catalina and later versions which now only support 64 bit executables using Cocoa.
Step 1: Download Xcode (optional)
Xcode is a 12GB download which will take up 16GB of disk space. You only need to download and install the full Xcode development environment if you need:
- the SDKs for iOS, iPadOS, watchOS and tvOS; or
- to validate and upload apps to the Mac App Store; or
- to notarise apps for distribution outside of the Mac App Store.
Xcode 11.3.1 for use on macOS 10.14 Mojave must now be installed by downloading it from Apple Developer Connection (ADC), which requires free registration. Xcode 12.4.x for use on macOS 10.15 Catalina and later versions can be installed from the Mac App store. Note that you must first move any old Xcode versions from the Applications folder into the trash or rename the Xcode app (eg Xcode.app to Xcode_1014.app). You can then select which version of Xcode to use with the command line utility xcode-select. Open an Applications > Utilities > Terminal and type man xcode-select for this utility's manual page.
Older systems:
The Xcode developer tools can be installed from the original macOS installation disks or a newer copy downloaded from the Apple Developer Connection (ADC), which requires free registration. Download the Xcode file, it will end up in your Downloads directory as a zip file. Click it. It is unarchived into your Downloads directory. You may be happy with it there but maybe not. Other users will see the path to it but be unable to use it. And it is untidy there. So I moved mine and then told xcode-select where it was moved to (in a terminal) -
mv Downloads/Xcode.app /Developer/.
sudo xcode-select -s /Developer/Xcode.app/Contents/Developer
Step 2: Xcode Command Line Tools
This is shown here as a separate step because it really is a separate step. Don't confuse these standalone command line tools with the internal Xcode command line tools that the Xcode GUI will tell you are already installed if you installed the full Xcode package in Step 1. FPC cannot use those Xcode internal command line tools without configuration changes (see Xcode for details).
Do the following, it is quick and easy for all macOS versions up to and including Catalina 10.15:
sudo xcode-select --install
sudo xcodebuild -license accept
For Big Sur 11.x and later, you only need to enter the first of the two commands above unless you have also installed the full Xcode package. If you have only installed the command line tools, you should omit entering the xcodebuild command.
If you have problems installing the command line tools using this command line method (eg the installer freezes while "finding Software"), you can also download and install the command line tools package by logging in to the Apple Developer Site and downloading and installing the Command Line Tools for Xcode disk image.
Step 3: FPC binaries and FPC source code
Note: For Apple Silicon/AArch64/M1 installations, if you are installing FPC 3.2.2 (Lazarus 2.2RCx or 2.2.0 or later) you don't need to compile a native Apple Silicon version of FPC because FPC 3.2.2 for macOS is a universal binary containing both Intel and aarch64 executables. If you are installing a version of FPC earlier than 3.2.2, then please refer to these instructions for building a native Apple Silicon Free Pascal Compiler after installing the 64 bit Intel binary and source packages for FPC.Download and install the official FPC binaries package and the separate FPC source package from the Lazarus IDE file area.
When you arrive at the Lazarus IDE file area:
- Choose the correct version of your operating system. The vast majority of Mac users should now choose the 64 bit packages in the Lazarus macOS x86-64 directory. Every Mac computer since late 2006 has been 64 bit capable. The fact that Apple has completely dropped all 32 bit support from macOS 10.15 Catalina (released in October 2019) is another reason to choose the 64 bit packages.
- Choose the version of Lazarus you wish to install and you will be presented with the two FPC binary and source packages to download.
These installation packages are built by the FPC/Lazarus developers and track formal releases. As these installation packages are not approved by Apple, you need to hold down the Control key, click the package and choose Open and confirm you want to install from an Unknown Developer.
You might like to try a simple and quick test of FPC at this stage - Testing FPC installation.
Step 4: Install the Lazarus IDE
It is critical that a compatible Free Pascal Compiler (FPC) and its source must be installed before you install the Lazarus IDE.
Note: For installation on Apple Silicon/AArch64, please refer to the Lazarus Fixes 2.2 or Lazarus development instructions to build a native Lazarus IDE. Skip to the building instructions and use the Lazarus Fixes 2.2 source / Lazarus development source download as you wish.Download and install the Lazarus IDE from the Lazarus IDE file area. When you arrive at that file area, choose the correct version of your operating system. The vast majority of Mac users should now choose the 64 bit packages in the Lazarus macOS x86-64 directory. Every Mac computer since late 2006 has been 64 bit capable. The fact that Apple has completely dropped all 32 bit support from macOS 10.15 Catalina (released in October 2019) is another reason to choose the 64 bit packages.
Step 5: Configure the Debugger
In versions of Lazarus 1.8.4 and earlier, you needed to use gdb as a debugger, slow to install and hard to sign. Since Lazarus 2.0.0 you can (and should) use lldb, a debugger provided by Apple, no signing required.
Assuming you have installed what is necessary and started Lazarus, all that remains is configuring the debugger. If you don't do this now, Lazarus will try to use gdb and fail.
- Lazarus version 2.2.0: First, click Lazarus > Preferences > Debugger - Debugger Backend;
- Lazarus before version 2.2.0: First, click Tools > Options > Debugger.
Top right of the window now open has a label, "Debugger type and path", you must set both the type and the path. Select the type "LLDB debugger (with fpdebug) (Beta)" and select or type the path /usr/bin/lldb.
If "LLDB debugger (with fpdebug) (Beta)" is not shown in the selection list, see Installing LazDebuggerFpLLdb below. The XCode command line tools install lldb to the /usr/bin directory. Save those settings and you can now try to compile the almost nothing program that Lazarus has kindly provided for you (click the small green triangle near top left).
Next you see a puzzling question, see image below. Choose a "Debug Format" from one of those offered -
Martin_fr, the person who has given us this interface between the Lazarus IDE and lldb, suggests you use "dwarf3" . Then, you need to enter your password, a macOS cuteness because one application appears to be interfering with another. In this case, that's fine!
When running the debugger from time to time you will be asked for your password to allow debugging. This is for your own safety.
Extra Information on using lldb
A great deal of information about using lldb appears in this forum thread. Here are a few gems, again, from Martin_fr:
In the unexpected case of problems, it may be worth trying "dwarf with sets" instead of just "dwarf3".
The "debug info" setting only affects the units directly in your project. However, units in packages may have debug info too. This can be:
- set per package
- for many, but not all packages in the menu Tools > Configure "Build Lazarus"
- Project > Project Options > Additions and Overrides
If you change settings for a package, you might want to check which package you expect to step into when debugging. Packages you do not step into, do not need debug info.
If you use a type from a package (such as TForm from LCL) it is enough that your unit (in which you declare the variable / must declare and use a variable to include the type) has debug info. Reducing the number of packages with debug info (including those that default to have debug info), can shorten the debuggers start-up time.
Also it may be worth comparing (it has not been tested) the debuggers start up time for the same settings, only changing the checkbox "use external debug info".
This needs to be only set in your project. If set in your project it will affect all packages. (If set in a package it should have no affect.)
Installing LazDebuggerFpLLdb
If you installed from source and used the bigide parameter to make, then the correct debugger will be installed, as a package, and ready to go. If, however, you installed in another way, it may, or may not be there.
From the main IDE screen, click Packages->Install/UninstallPackages. Shown is two lists of packages, the list on the left is installed, the list on the right is available to install. Look for LazDebuggerFpLldb (exactly that, there are some similar named but less suitable packages). If it is on the right hand side, click it, press "Install Selection" and then "Save and rebuild IDE". This will take a little time, the IDE will shutdown and restart and all should be well. Now jump back up the page and continue configuring the debugger.
Cocoa 64 bit vs Carbon 32 bit
Using the Apple 64 bit Cocoa framework is now undeniably the future on the Mac. The Apple 32 bit Carbon framework, while no longer being developed, works pretty much as expected, but you are advised to try Cocoa first because Apple dropped all support for 32 bit applications and the 32 bit Carbon framework in macOS 10.15 Catalina (October 2019).
It is possible to build a Cocoa version of the Lazarus IDE with v2.0.0 and later. It is also possible to build a Carbon version of the Lazarus IDE (unless you are running macOS 10.15 Catalina or later) and use that to generate Cocoa 64 bit binaries.
To produce Cocoa applications in the Carbon or Cocoa IDE, you need to set the Target to the 64 bit processor and select the Cocoa widgetset:
- Open your project with Lazarus and from the menu select Project > Project Options
- In the "Config and Target" panel set the "Target CPU family" to be "x86_64" (Intel) or "aarch64" (Apple M1)
- In the "Config and Target" panel, if the "Current LCL widgetset" is not set to Cocoa, click "Select another LCL widgetset" which will take you to the "Additions and Overrides" panel where you can click on "Set LCLWidgetType" pulldown and set the value to "Cocoa"
- Make sure under Tools > Options (Lazarus > Preferences in v2.2.0 and later) that "Compiler Executable" is set to "/usr/local/bin/fpc" to get 64 bit applications.
- Now compile your project - and please feed back any problems you experience.
FPC + Lazarus Compatibility Matrix
Not every combination of Lazarus and Free Pascal is compatible with every installation of macOS. Please refer to the following table in order to find the correct version for your development environment:
| Lazarus 1.8.x | Lazarus 2.0.y | Lazarus 2.0.8 | Lazarus 2.0.10 | Lazarus 2.0.12 | Lazarus 2.2.y | ||
|---|---|---|---|---|---|---|---|
| FPC 3.0.4 | FPC 3.2.0 | FPC 3.2.2 | |||||
| PPC processors | |||||||
| Mac OS X 10.4 (Tiger)‡ | Incompatible | Incompatible | Incompatible | Incompatible | Incompatible | Incompatible | Incompatible |
| Mac OS X 10.5 (Leopard)‡ | Not tested | Not tested | Incompatible | Incompatible | Incompatible | Incompatible | Incompatible |
| Intel processors | |||||||
| Mac OS X 10.4 (Tiger)‡ | Incompatible | Incompatible | Incompatible | Incompatible | Incompatible | Incompatible | Incompatible |
| Mac OS X 10.5 (Leopard) | Not tested | Compatible^ | Not tested | Compatible^**† | Not tested | Not tested | Not tested |
| Mac OS X 10.6 (Snow Leopard) | Compatible | Compatible^^ | Not tested | Not tested | Not tested | Not tested | Not tested |
| Mac OS X 10.7 (Lion) | Compatible | Not tested | Not tested | Not tested | Not tested | Not tested | Not tested |
| OS X 10.8 (Mountain Lion) | Compatible^^ | Compatible | Compatible**# | Compatible**# | Compatible**# | Compatible# | Compatible |
| OS X 10.9 (Mavericks) | Compatible^^ | Compatible | Compatible**† | Compatible**† | Not tested | Not tested | Not tested |
| OS X 10.10 (Yosemite) | Compatible^^ | Compatible | Compatible**† | Compatible**† | Not tested | Not tested | Not tested |
| OS X 10.11 (El Capitan) | Compatible^^ | Compatible | Compatible***† | Compatible† | Compatible† | Compatible† | Comptaible |
| macOS 10.12 (Sierra) | Compatible^^ | Compatible | Compatible***† | Compatible† | Compatible† | Compatible† | Compatible |
| macOS 10.13 (High Sierra) | Not tested | Compatible | Compatible***† | Compatible† | Compatible† | Compatible† | Comptaible |
| macOS 10.14 (Mojave) | Not tested | Compatible | Compatible***† | Compatible† | Compatible† | Compatible† | Compatible |
| macOS 10.15 (Catalina) | Not tested | Compatible | Compatible***† | Compatible† | Compatible† | Compatible† | Compatible |
| macOS 11 (Big Sur) | Not tested | Compatible | Compatible***† | Compatible† | Compatible† | Compatible† | Compatible |
| macOS 12 (Monterey) | Not tested | Not tested | Not tested | Not tested | Not tested | Not tested | Compatible |
| macOS 13 (Ventura) | Not tested | Not tested | Not tested | Not tested | Not tested | Not tested | Compatible |
| macOS 14 (Sonoma) | Not tested | Not tested | Not tested | Not tested | Not tested | Not tested | Compatible |
| Apple Silicon M series processors | |||||||
| macOS 11 (Big Sur) | Not tested | Not tested | Not tested | Compatible†† | Compatible†† | Compatible††† | Compatible* |
| macOS 12 (Monterey) | Not tested | Not tested | Not tested | Compatible†† | Compatible†† | Compatible††† | Compatible* |
| macOS 13 (Ventura) | Not tested | Not tested | Not tested | Compatible†† | Compatible†† | Compatible††† | Compatible* |
| macOS 14 (Sonoma) | Not tested | Not tested | Not tested | Compatible†† | Compatible†† | Compatible††† | Compatible* |
x = 0, 2 or 4; y = 0, 2, 4 or 6
^ Carbon interface compiles - Cocoa does not.
^^ Restrictions apply to debugging with gdb.
* Lazarus 2.2.0 installs universal binaries for FPC 3.2.2, but an Intel Lazarus IDE binary which you can use or recompile the IDE from within itself for a native aarch64 version.
** See Installing Lazarus 2.0.8, 2.0.10 with FPC 3.2.0 for macOS 10.10 and earlier for instructions.
*** See Installing Lazarus 2.0.8 with FPC 3.2.0 for macOS 10.11+ for instructions.
# Cannot run without debugging in the IDE. Can run compiled application outside of the IDE. See Issue #37324. Choose the gdb debugger, change timeout option to false or click through five "timeout" dialogs to run with debugging in the IDE.
† Cannot "run without debugging" in the IDE. Can run compiled application outside of the IDE. See Lazarus IDE - Unable to "run without debugging" for workaround. See Issue #36780.
†† You need to compile a native aarch64 version of FPC 3.3.1 (trunk) and Lazarus 2.0.12 from source to support an Apple Silicon M series processor. Refer to these instructions for FPC and these instructions for the Lazarus IDE.
††† After installing FPC 3.2.2, you need to compile a native aarch64 version of Lazarus from source to support an Apple Silicon M series processor. Refer to these instructions for compiling the Lazarus IDE.
‡ See the legacy version of this compatibility matrix for recommended installs on very old versions of macOS.
Installing non-release versions of the Lazarus IDE
Lazarus Fixes 2.2
There are a number of reasons why you may be better off using a non-release version of Lazarus, specifically, fixes_2_2. Particularly:
- You almost certainly need to target 64 bit Cocoa, macOS 10.15 Catalina and later do not support 32 bit Carbon at all.
- The Cocoa widget set has steadily improved and the lldb debugger interface has rapidly improved, since even v2.0.0.
- If your Mac has an Apple M1 Processor, the debugger in fixes_2_2 now works for aarch64.
- Fixes_2_2 is a safer and more stable option than the development branch, but still gets the new features much faster than the release version.
Pre-compiled binaries based on fixes_2_2 are not available from SourceForge so we download and build from the source code. A little slow initially but very reliable and a great test of your compiler install ! You will need git which is included in all recent versions of the Xcode command line tools which you should have already installed (see Xcode Command Line Tools above).
About svn or git: The Xcode 11.4 command line tools on macOS 10.15 no longer install svn, only git. You can install subversion via fink, ports or brew.
- When working with an Apple Silicon M1 processor Mac ensure you use the FPC 3.2.2 or later as it provides a universal binary with both a native aarch64 and Intel compiler. If you must use an earlier FPC than 3.2.2 see Apple Silicon Support for how to do this. When building the Lazarus IDE, change the CPU_TARGET in the instructions below from x86_64 (Intel 64 bit) to aarch64 (ARM 64 bit - Apple Silicon M1).
Downloading Lazarus Fixes 2.2 source
Create a directory for Lazarus and download the current fixes version:
cd
mkdir -p bin/lazarus
cd bin/lazarus
Using git:
git clone -b fixes_2_2 https://gitlab.com/freepascal.org/lazarus/lazarus.git laz_fixes
Using svn:
svn checkout https://github.com/fpc/Lazarus/branches/fixes_2_2 laz_fixes
Depending on your internet connection and server congestion this takes a few seconds or a few minutes.
Updating Lazarus Fixes 2.2 source
To keep your fixes_2_2 installation up to date is as easy as:
Using git:
cd ~/bin/lazarus/laz_fixes
git clean -f -d
git pull
Using svn:
cd ~/bin/lazarus/laz_fixes
svn clean --remove-unversioned
svn update
Building Lazarus Fixes 2.2 source
cd laz_fixes
make distclean all LCL_PLATFORM=cocoa CPU_TARGET=x86_64 bigide
//-wait some time...
open startlazarus.app --args "--pcp=~/.laz_fixes"
- Note I pass a parameter to use a config directory that is based on the name of the actual install directory. It makes some scripting easy.
- On older macOS versions supporting 32 bit applications, replace the above make line with "make LCL_PLATFORM=carbon CPU_TARGET=i386 bigide " and set up your project as mentioned in the Carbon and Cocoa section below.
You might like to put a small script in your $HOME/bin directory and even set a path to it (very UNIX!)
#!/bin/bash
LAZDIR="laz_fixes"
cd ~/bin/lazarus/"$LAZDIR"
open ~/bin/lazarus/"$LAZDIR"/lazarus.app --args "--pcp=~/.$LAZDIR"
Lazarus development version
- Lazarus Development Version Notes - Note: work in progress
Precompiled binaries based on the development version (was known as "trunk" in SVN; now known as "main" in GIT) of the Lazarus IDE are not available from SourceForge, so here's how to download the development version source using svn or git and build the Lazarus IDE. You will need svn (before macOS 10.15 - Catalina) or git (after macOS 10.14 - Mojave) which is included in the standalone Xcode command line tools which you should have already installed (see Xcode Command Line Tools above).
- When working with an Apple Silicon M1 processor Mac ensure you use the FPC 3.2.2 or later as it provides a universal binary with both a native aarch64 and Intel compiler. If you must use an earlier FPC than 3.2.2 see Apple Silicon Support for how to do this. When building the Lazarus IDE, change the CPU_TARGET in the instructions below from x86_64 (Intel 64 bit) to aarch64 (ARM 64 bit - Apple Silicon M1).
Downloading Lazarus development version source
cd
mkdir -p bin/lazarus
cd bin/lazarus
Using git:
git clone -b main https://gitlab.com/freepascal.org/lazarus/lazarus.git laz_main
Using svn:
svn checkout --depth files https://github.com/fpc/Lazarus/branches all cd all svn update --set-depth infinity main
The above svn invocation is more complex due to a bug in many versions of Subversion. This workaround was the work of Alfred (aka Don Alfredo in the Forum) who is the wizard behind fpcupdeluxe.
Updating Lazarus development version source
To update your existing Lazarus development version source.
Using git:
cd ~/bin/lazarus/laz_main
git clean -f -d
git pull
Using svn:
cd ~/bin/lazarus/laz_trunk
svn cleanup --remove-unversioned
svn update
Building Lazarus development version source
make distclean all LCL_PLATFORM=cocoa CPU_TARGET=x86_64 ide
or, for the bigger IDE (see below for an explanation of the bigide make argument):
make distclean all LCL_PLATFORM=cocoa CPU_TARGET=x86_64 bigide
After one of above commands, wait some time and:
open startlazarus.app --args "--pcp=~/.laz_dev"
What does the bigide make argument do?
The bigide make argument adds a bunch of packages to Lazarus that many find useful and cannot do without. The packages that are added are:
|
|
|
The above list is sourced from the [Lazarus source directory]/IDE/Makefile.fpc and may be subject to change.
Note that if you have not compiled your own Lazarus IDE with the bigide argument, you can install any of these packages yourself using the Lazarus IDE Package > Install/Uninstall Packages... dialog.
Installing non-release versions of FPC
Installing from source
There are two current non-release branches of the Free Pascal Compiler: the development (trunk) branch and the Fixes 3.2 branch which includes additional fixes to the released 3.2.2 version. Developers, and those who like living on the bleeding edge and testing new features and fixes, will choose the development version; more normal users, who wish to use a stable branch with some additional fixes since the latest release version, will choose the Fixes branch. The instructions below cover both these branches.
The source code is kept in a version control system called git:
- macOS 10.5 and higher already contain a command line git client if you have installed the Xcode command line utilities.
- You also need the latest released Free Pascal Compiler version (3.2.2 as of March 2022) installed in order to be able to successfully compile the development (trunk) version.
Note: When building a native aarch64 Free Pascal Compiler (ppca64) for an Apple Silicon M1 processor Mac, change the CPU_TARGET in the instructions below from x86_64 (Intel 64 bit) to aarch64 (ARM 64 bit - Apple Silicon M1) and change any reference to ppcx64 to ppca64FPC development version
- FPC New Features in development
- FPC User Changes in development - may break existing code.
Note that since the development version of FPC (was known as "trunk" in SVN; now known as "main" in GIT) is by definition still under development, some of the features may still change before they end up in a release version.
Create a directory where you would like to put the source (eg fpc_main in your home directory). You don't need to be root to do this. Any normal user can do this. Open an Applications > Utilities > Terminal and do the following:
[]$ git clone -b main https://gitlab.com/freepascal.org/fpc/source.git fpc_main
This will create a directory called fpc_main and download the FPC main source to it.
To subsequently update your local source repository with the latest source changes you can simply do:
[]$ cd
[]$ cd fpc_main
[]$ git clean -f -d
[]$ git pull
To build and install FPC (the highlighted text should be all on one line):
[]$ cd
[]$ cd fpc_main
[]$ make distclean all FPC=/usr/local/lib/fpc/3.2.2/ppcx64 OS_TARGET=darwin CPU_TARGET=x86_64 OPT="-XR/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/"
[]$ sudo make install FPC=$PWD/compiler/ppcx64 OS_TARGET=darwin CPU_TARGET=x86_64
You will also need to update the links for the compiler in /usr/local/bin which will be pointing to the previous FPC version. For example:
[]$ cd /usr/local/bin
[]$ sudo rm ppc386
[]$ sudo rm ppcx64
[]$ sudo ln -s /usr/local/lib/fpc/3.3.1/ppc386
[]$ sudo ln -s /usr/local/lib/fpc/3.3.1/ppcx64
Note that you will need to build a new ppc386 compiler if you want to continue to compile 32 bit applications by replacing these lines (this is not be possible after Xcode 11.3.1 and macOS 10.14.6 Mojave because of Apple's removal of the 32 bit frameworks):
[]$ make clean all FPC=/usr/local/lib/fpc/3.2.2/ppcx64 OS_TARGET=darwin CPU_TARGET=x86_64 OPT="-XR/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/"
[]$ sudo make install FPC=$PWD/compiler/ppcx64 OS_TARGET=darwin CPU_TARGET=x86_64
with these two lines:
[]$ make clean all FPC=/usr/local/lib/fpc/3.2.2/ppc386 OS_TARGET=darwin CPU_TARGET=i386 OPT="-XR/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/"
[]$ sudo make install FPC=$PWD/compiler/ppc386 OS_TARGET=darwin CPU_TARGET=i386
FPC Fixes 3.2
Create a directory where you would like to put the source (eg fpc_fixes32 in your home directory). You don't need to be root to do this. Any normal user can do this. Open an Applications > Utilities > Terminal and do the following:
[]$ git clone -b fixes_3_2 https://gitlab.com/freepascal.org/fpc/source.git fpc_fixes32
This will create a directory called fpc_fixes32 and download the FPC source to it.
To subsequently update your local copy of the repository source with the latest source changes you can simply do:
[]$ cd fpc_fixes32
[]$ git clean -f -d
[]$ git pull
To build and install FPC (the highlighted text should be all on one line):
[]$ cd
[]$ cd fpc_fixes32
[]$ make distclean all FPC=/usr/local/lib/fpc/3.2.2/ppcx64 OS_TARGET=darwin CPU_TARGET=x86_64 OPT="-XR/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/"
[]$ sudo make install FPC=$PWD/compiler/ppcx64 OS_TARGET=darwin CPU_TARGET=x86_64
You will also need to update the links for the compiler in /usr/local/bin which will be pointing to the previous FPC version. For example:
[]$ cd /usr/local/bin
[]$ sudo rm ppc386
[]$ sudo rm ppcx64
[]$ sudo ln -s /usr/local/lib/fpc/fixes-3.2/ppc386
[]$ sudo ln -s /usr/local/lib/fpc/fixes-3.2/ppcx64
Note that you will need to build a new ppc386 compiler if you want to continue to compile 32 bit applications by replacing these lines (this may not be possible after Xcode 11.3.1 and macOS 10.14.6 Mojave because of Apple's removal of the 32 bit frameworks):
[]$ make clean all FPC=/usr/local/lib/fpc/3.2.2/ppc386 OS_TARGET=darwin CPU_TARGET=i386 OPT="-XR/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/"
[]$ sudo make install FPC=$PWD/compiler/ppc386 OS_TARGET=darwin CPU_TARGET=i386
Known issues and solutions
Lazarus IDE v2.2.0 - rebuilding issue
Any attempt to rebuild the Lazarus IDE from within itself fails with permission errors because the files and directories are owned by a user with the id of 503 whereas most users will find that their id is 501. The solution is to open an Applications > Utilities> Terminal and:
cd /Applications sudo chown -R your_username Lazarus
The following rebuilding errors do not happen on Intel computers
The next error that occurs is that the resource compiler "fpcres" is not found. The solution is to create a .fpc.cfg (note the initial dot) file in your home directory and add these lines to it:
#include /etc/fpc.cfg -FD/usr/local/bin
so that "fpcres" can be found where it was installed.
The next error complains of an unsupported target architecture -Paarch64, with the advice to invoke the "fpc" compiler driver instead - except that is what we are doing already. The solution is to go to Lazarus > Preferences > Compiler executable which is set to /usr/local/bin/fpc and change that to /usr/local/lib/fpc/3.2.2/ppca64 instead.
The IDE will now be successfully rebuilt but will not restart automatically. Trying to then start Lazarus from either the startlazarus.app icon or the lazarus.app icon in /Applications/Lazarus still results in the original Intel lazarus binary being launched. The correct aarch64 binary can be found in ~/.lazarus/bin/aarch64-darwin/lazarus. So the final solution is to open an Application > Utilities > Terminal and:
mv /Applications/Lazarus/lazarus /Applications/Lazarus/lazarus.old mv ~/.lazarus/bin/aarch64-darwin/lazarus /Applications/Lazarus/
You can then start the IDE with either the startLazarus.app or lazarus.app icons. When you do restart lazarus, it is worth returning to the Lazarus > Preferences > Compiler executable which is set to /usr/local/lib/fpc/3.2.2/ppca64 and changing it back to /usr/local/bin/fpc so that you can compile both aarch64 and Intel binaries to, for example, make a Universal Binary which will run on both Intel and aarch64 machines.
Lazarus IDE - Unable to "run without debugging"
If you are using the Lazarus IDE 2.0.10 and the Run > Run without debugging menu option fails with a dialog similar to:
then you need to patch the Lazarus 2.0.10 source code (Issue #37324 and Issue #36780). Specifically, patch ../ide/main.pp as below (unpatched lines shown first, patched lines shown second):
7243,7245c7243,7245
< if RunAppBundle
< and FileExistsUTF8(Process.Executable)
< and FileExistsUTF8('/usr/bin/open') then
---
> if RunAppBundle then
> // and FileExistsUTF8(Process.Executable)
> //and FileExistsUTF8('/usr/bin/open') then
and recompile the Lazarus IDE.
Alternatively, you can omit patching the source code and simply recompile Lazarus 2.0.10 with FPC 3.0.4.
A similar patching exercise and recompiling, or simply recompiling with FPC 3.0.4, needs to be done for Lazarus 2.0.8 if it has been compiled with FPC 3.2.0.
Upgrading from Mojave (10.14) to Catalina (10.15)
- Run
sudo xcode-select --install
- To enable Lazarus to locate the crt1.10.5.o file change in /etc/fpc.cfg the -Fl behind "#ifdef cpux86_64" from
-Fl/Applications/Xcode.app/Contents/Developer/Toolchain...
to
-Fl/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX.sdk/usr/lib/
Building the FPC compiler from Mojave (10.14) onwards
- To find the crt1.10.5.o file when building a later Free Pascal Compiler version from source, you need to specify:
OPT="-XR/Library/Developer/CommandLineTools/SDKs/MacOSX.sdk/"
on the make command line because FPC ignores the /etc/fpc.cfg configuration file during builds of itself.
Mac Installation FAQ
- See the Mac Installation FAQ for solutions to other common problems that may arise during (and after) installation of Lazarus and Free Pascal on macOS.
Uninstalling Lazarus and Free Pascal
Refer to Uninstalling Lazarus on macOS for uninstallation options.
Legacy Information
See Legacy Information for details of:
- Installing Lazarus on Mac OS X 10.4 (Tiger), Mac OS X 10.5 (Leopard), OS X 10.8 (Mountain Lion)
- Installing Lazarus 2.0.8, 2.0.10 with FPC 3.2.0 for macOS 10.10 and earlier
- Installing Lazarus 2.0.8 with FPC 3.2.0 for macOS 10.11+
- Installing Lazarus on PowerPC-based Macs
- Old Xcode versions
- Installing the gdb debugger
- Compatibility matrix for Lazarus 1.0.0 through 1.6.4 and FPC 2.6.0 through 3.0.2.
See also
- Xcode.
- Other macOS installation options.
- Installing multiple Lazarus versions.
- Mac Portal for an overview of development for macOS with Lazarus and Free Pascal.
- Mac Installation FAQ for solutions to the most frequent problems that may arise during (and after) installation of Lazarus and Free Pascal on macOS.
External links
- Lazarus daily development version download (Intel x86_64)
- Lazarus + FPC daily development version downloads (M1, ARM64, aarch64)
- GIT Succinctly - Free Ebook (PDF, MOBI, EPUB) from SyncFusion.
