Difference between revisions of "MacOS/Quartz"

Latest revision as of 17:32, 6 April 2023

Downloads

macOS 11 "Big Sur" or higher

Gnucash-Arm-5.10-1 is now available for download from the GnuCash projects at Sourceforge and Github.

macOS 10.13 "High Sierra" or higher

Gnucash-Intel-5.10-1 is now available for download from the GnuCash projects at Sourceforge and Github.

Alternatives and older versions

• Download: Old Stable release and
• Download: Latest versions for historical operating systems including PowerPC Macs.

Release notes

are included in the disk-image.

For virtually all users it is more appropriate to download the binary rather than to use the procedure described here.

Overview

GnuCash can be built to run more or less natively on macOS -- meaning without X11. Better yet, the build is almost automatic.

This page describes the procedure to build GnuCash with the Quartz environment. You can also use MacPorts: The details are described at MacOS/MacPortsDetail. If you already have MacPorts installed, you should use that procedure, as gtk-osx doesn't work well with a MacPorts installation.

If you want to have a clickable GnuCash.app to put in your Applications folder, this is the solution to use. If you want to be able to easily customize your installation, this is also the solution for you. Don't want all of the extra stuff that MacPorts drags in? Well, this might be a bit better... but GnuCash is notorious for its huge list of dependencies. Want to keep up with the latest work from the Gnome developers? You can set up this solution to get many of its packages directly from source-code-control. That's a double-edged sword, of course, because if a build gets broken, you're pretty well stuck until the developers for that package fix it.

A build will consume about 5 gigabytes of disk space and typically take several hours to run. The initial build, which includes pulling down sources from all dependencies, can take days, depending on how often network errors interrupt the process, and how quickly they are noticed.

This build integrates Gnucash menus with the Mac menubar at the top of the screen. About, Preferences, and Quit are in the "GnuCash" menu (it's named "gnucash-bin" when you run from the command line) in standard Mac style. Standard accelerator keys like Command-Q (quit), Command-S (save), and Command-O (Open) work as well. A patch to Gtk+ allows copy and paste in the register pages.

Support

This procedure depends on the Gnome Gtk-OSX project. Support for that is provided via the gtk-osx-users-list@gnome.org mailing list. Questions, comments, or suggestions about Gnucash should be directed to the appropriate Gnucash mailing list (gnucash-devel for development versions (git master) or gnucash-user for release (3.x, git maint).)

Preliminaries

Read Building Gtk-OSX and scan the jhbuild docs. This procedure is based on both. Note well the warnings about Homebrew, MacPorts, and Fink! Creating a separate user for building and packaging GnuCash is the easiest work-around if you've used any of those systems in your regular userid.

First download gtk-osx-setup.sh by clicking the link or from the command line:

curl -O -L https://gitlab.gnome.org/GNOME/gtk-osx/raw/master/gtk-osx-setup.sh

and run it from the command line. Gtk now requires Python3 to build and Apple provides Python3 only on MacOS 10.15 Catalina, so it will first set up a Python3 virtual environment, then install jhbuild and configure what it needs to run. It will ask if you want to install CPython. You do.

It defaults to installing everything in $HOME/.new_local. If you prefer to install somewhere else, set the environment variables DEVPREFIX and PYTHONUSERBASE to that directory before running gtk-osx-setup.sh. One way to do that is inline with the command, e.g.

DEVPREFIX=$HOME/.jhbuild_root PYTHONUSERBASE=$HOME/.jhbuild_root ./gtk-osx-setup.sh

There are some other directory customizing environment variables, see the list in gtk-osx-setup.sh Default or not, you'll want to add the install location's bin directory to $PATH.

JHBuild is configured to build GnuCash via jhbuildrc-custom. Download this file to your home directory either by clicking the link and moving the downloaded file or from the command line:

curl -O -L https://github.com/gnucash/gnucash-on-osx/raw/master/jhbuildrc-custom

and place it in $HOME/.config--unless you've set something different in $XDG_CONFIG_HOME, in which case put it there.

OS X 10.11 added a security feature called System Integrity Protection or SIP. One "feature" is that it strips linker environment variables (the ones starting with LD_ and DYLD_) from the environment when a "system" program does a fork/exec. For our purposes "system program" means one installed in /bin or /usr/bin, in particular /bin/sh.

The Guile compiler, guiled, is a shell script that as written uses /bin/sh to set the prefix then execs guile to run a compilation script. That fails in the presence of SIP.

One can get around this by disabling SIP, but that's a whole-system change that requires a reboot, and SIP clearly has significant security benefits. Don't do that.

The other workaround is to use a shell that isn't in /bin or /usr/bin. One can just copy /bin/bash to one's user-level bin directory. gtk-osx-setup.sh does that for you, putting it in the install location's bin directory.

PREFIX=/opt/gnucash jhbuild bootstrap-gtk-osx
PREFIX=/opt/gnucash jhbuild build

setup_sdk

With no arguments (the default) setup_sdk() will configure the build for your system. Unless you're building for distribution we recommend that you do this.

setup_sdk("10.6", native, ["i386"])

It is safest to build GnuCash on the earliest macOS version you intend to support.

setup_sdk("10.5", "10.5"["i386"])

Notes

• GnuCash v2.7.x and later use the CMake buildsystem.
• GnuCash v2.7.x and later requires MacOS X 10.9 ("Mavericks") or later.
• GnuCash v3.900 and later requires MacOS 10.13 ("High Sierra") or later because it uses C++17 and the attendant standard library.
• Apple has removed 32-bit runtime support from macOS 10.15, so you'll need to build on an older version of macOS if you want arch='i386'.
• Apple Silicon is first supported in macOS 11. We have never successfully cross-compiled the Gtk stack so you'll probably need an Apple Silicon Mac to build an Apple Silicon native GnuCash. Note that as of October 2022 WebKitGtk isn't able to find its loadable modules so that reports don't render in GnuCash.
• PowerPC similarly requires building on a PowerPC machine.

Make any changes by editing jhbuildrc-custom

Building

Once all of the preliminaries are complete, run:

jhbuild bootstrap-gtk-osx
jhbuild build

Building for Development

Please see Development for general guidelines and lots of helpful links.

If you intend to contribute your work to the GnuCash project please subscribe to the gnucash-devel list and coordinate your work with the core developers before starting.

You'll need to work with the appropriate source code repository rather than the release tarball from the procedure so far. Git provides details on our repository and has some help for developers who aren't yet familiar with the git version control system. Open jhbuildrc-custom in your text editor and find the section

#Select which modules to build. The only difference is which gnucash
#module (and all of the dependencies, see above) get built. "
modules = ["meta-gtk-osx-bootstrap", "meta-gnucash-stable"]
#modules = ["meta-gtk-osx-bootstrap", "gnucash-unstable"]
#modules = ["meta-gtk-osx-bootstrap", "gnucash-git"]
#branches["gnucash-git"] = (None, "maint")

and change it to

#Select which modules to build. The only difference is which gnucash
#module (and all of the dependencies, see above) get built. "
#modules = ["meta-gtk-osx-bootstrap", "meta-gnucash-stable"]
#modules = ["meta-gtk-osx-bootstrap", "gnucash-unstable"]
modules = ["meta-gtk-osx-bootstrap", "gnucash-git"]
branches["gnucash-git"] = (None, "maint")

Note the branches line

It will build the current stable branch; to build the development branch, the one leading to the next major release, change maint to master. You may also want to change the prefix directory in the line above that block.

Command-line builds

Once you have your initial build finished you'll start editing sources (they'll be in $HOME/gnucash-stable/src/gnucash-git unless you changed the prefix in jhbuilrc-custom) and you'll want to build and run the unit tests. Start a jhbuild shell and change directory to the build directory:

jhbuild shell
cd %PREFIX/../build/gnucash-git

From there you can run the usual shell commands like cmake and ninja.

Building with Xcode

It's possible to build GnuCash using Apple's Xcode IDE. To make it work first do a regular build as above to get all of the dependencies set up.

Now create a new build directory and ```cd``` to it but do *not* start a jhbuild shell, just export the following environment variables to simplify the cmake invocation:

export PREFIX=/full/path/to/prefix
export PATH=$PATH:$PREFIX/bin
export SRCROOT=$PREFIX/../src

making any required changes. Be sure to make different build directories for the maint and the master branches.

Now create the xcodeproject with cmake:

cmake -G Xcode -D CMAKE_INSTALL_PREFIX=$PREFIX -D GTEST_ROOT=$SRCROOT/googletest $SRCROOT/gnucash-git

If you're building from a tarball you'll need to change the source directory at the end of the line.

For some newer versions of Xcode cmake seems unable to determine the C compiler and tries to use ```ld```. If you encounter errors during Cmake or building saying that `ld` doesn't accept some option try adding

  -D CMAKE_C_COMPILER=/Applications/Xcode.app/Contents/Developer/Toolchains/Xcodetoolchain.default/usr/bin/clang

to the cmake command line. Adjust the path as needed if the Xcode you're using isn't /Applications/Xcode.app.

Notes

• Because all current branches of GnuCash use C++ features that don't compile on or for earlier versions, GnuCash requires MacOS 10.13 (High Sierra) or later.
• The dependencies for GnuCash have changed from the 2.x releases. The most significant are that major Linux distributions have dropped support for WebKit1Gtk, so we had to enable support for WebKit2Gtk and that in turn requires that GnuCash switch to Gtk3. We've rewritten several modules in C++ and are using GoogleTest for new unit tests and the Boost Libraries for several language extensions. The register has been fixed to no longer use the obsolete libgnomecanvas and the small part of libgoffice that the CSV importer required has been copied into GnuCash sources.

Documentation

The gnucash documentation is online, of course, but if you want a local copy, you can build the modules gnucash-docs or gnucash-docs-git. Just add whichever one you want to your "modules" argument. If you're using gnucash-docs-git you might also want to select the branch by adding a line

branches["gnucash-docs-git"] = (None, "maint")

setting "maint" or "master" as you prefer.

Debugging

To get a debugging build, add the line setup_debug()

jhbuild buildone --force --clean

Running from the commandline

$PREFIX/bin/gnucash

$PREFIX is the path to where you've built gtk; you can fill it in yourself or use jhbuild shell to set it for you.

Making a Bundle

So far so good, but you don't really want to have to open a Terminal window every time you want to use GnuCash, now do you? Of course not. You want a nice icon in your Applications folder (and maybe in the Dock) to click on when you run GnuCash. Here's how to do this:

N.B. This procedure works only with GnuCash built according to the above instructions.

Clone the bundler, cd into the cloned gtk-mac-bundler directory, and make install

Create a directory somewhere convienient (we'll call it gnucash-bundler from now on), cd to it, and download gnucash.bundle, Info.plist, and gnucash.icns into it.

Look through gnucash.bundle and adjust the paths to match your installation.

Documentation

The bundle includes documentation. If you've built it, great, no problem. You need to have it installed for the Help menu items to work. If you didn't build it and you don't want to, then comment out or remove the lines

  <data dest="${bundle}/Contents/Resources/en.lproj/GnuCash Help/">
    ${prefix}/share/gnome/help/gnucash/C/gnucash-manual
  </data>

  <data dest="${bundle}/Contents/Resources/en.lproj/GnuCash Guide/">
    ${prefix}/share/gnome/help/gnucash/C/gnucash-guide/
  </data>

   <data dest="${bundle}/Contents/Resources/de.lproj/GnuCash Help/">
    ${prefix}/share/gnome/help/gnucash/de_DE/gnucash-manual
  </data>

  <data dest="${bundle}/Contents/Resources/de.lproj/GnuCash Guide/">
    ${prefix}/share/gnome/help/gnucash/de_DE/gnucash-guide/
  </data>

  <data dest="${bundle}/Contents/Resources/it.lproj/GnuCash Help/">
    ${prefix}/share/gnome/help/gnucash/it_IT/gnucash-manual
  </data>

  <data dest="${bundle}/Contents/Resources/it.lproj/GnuCash Guide/">
    ${prefix}/share/gnome/help/gnucash/it_IT/gnucash-guide/
  </data>

  <data dest="${bundle}/Contents/Resources/ja.lproj/GnuCash Guide/">
    ${prefix}/share/gnome/help/gnucash/ja_JP/gnucash-guide/
  <data dest="${bundle}/Contents/Resources/pt.lproj/GnuCash Help/">
    ${prefix}/share/doc/gnucash-docs/pt/gnucash-manual/
  </data>

  <data dest="${bundle}/Contents/Resources/pt.lproj/GnuCash Guide/">
    ${prefix}/share/doc/gnucash-docs/pt/gnucash-guide/
  </data>
  
  <data dest="${bundle}/Contents/Resources/ru.lproj/GnuCash Guide/">
    ${prefix}/share/doc/gnucash-docs/ru/gnucash-guide/
  </data>

To comment out XML code, surround it like so:

<!-- stuff to be commented out -->

Note that comments cannot contain "--".

jhbuild shell                 #to set up the environment for the bundler
export PATH=$PREFIX/bin:$PATH #because jhbuild shell doesn't do this for some reason
gtk-mac-bundler gnucash.bundle
exit                          #quit the jhbuild shell

And your bundle should be ready to go. Try GnuCash.app/Contents/MacOS/GnuCash from the command-line so that you can see any error messages. If that works, try open GnuCash.app. If that works, then you can move GnuCash.app to your Applications folder and it's ready to use.

Bundling Oldstable

To bundle GnuCash version 2.6 and earlier you need gnucash-oldstable.bundle, Info-oldstable.plist instead of the corresponding ones listed above as well as gnucash.launcher. Older versions don't have the Portuguese or Russian Guide translations. Otherwise the procedure is the same.

Bundling from a Git Clone

At present there are two active git branches, 'maint' and 'master'. Both use the primary bundling procedure above.

Making a distribution

• Make a clean build including the documentation, making sure that you're not building any libraries with debugging. With all of the dependencies, the package is huge enough without it. Make sure that you're using the latest git masters for gtk-mac-bundler and gnucash-on-osx.
• Edit the version numbers and, if necessary, the copyright dates in Info.plist (or Info-unstable.plist).
• make sure that $APPLICATION_CERT is set correctly with your Apple Developer Program certificate ID. gtk-mac-bundler uses the value of that environment variable to codesign the app bundle.
• Make a bundle as described above. Test it.
• Make a directory named for the version that you're going to distribute and move the new bundle into it.
• Copy the scriptlet "FinanceQuote Update.app" from the previous version .dmg to the new distribution folder.
• Copy AUTHORS, DOCUMENTORS, LICENSE, NEWS, and README from the GnuCash source directory to the distribution folder. Rename each file with a ".txt" suffix so that Finder will recognize it and enable QuickLook.
• Open /Applications/Utilities/Disk Utility.app and select File>New>Disk Image from Folder in the menu. Select your installation directory in the first chooser and name it appropriately in the second (Gnucash-Intel-X.Y-Z.dmg where X.Y is the GnuCash version and Z is the serial number of dmgs for that release, beginning with 1.)
• codesign the dmg with your Apple Developer Program certificate.
• Get the SHA-256 hash of the .dmg with

  shasum -a 256 Gnucash-Intel-X.Y-Z.dmg
  

  and paste the result into the SourceForge README.txt, the Github release notes, the news article in gnucash-htdocs, and the release announcement email.
• Upload both the resulting .dmg to the correct version directory of Gnucash's file manager area on Sourceforge. If this is a stable release, check the "Mac" box on the options panel so that users viewing the project page with a Mac will see the new release in the big green button.
• Upload the .dmg to the release on Github.
• Update the appropriate links on the Gnucash webpage.

Accessibility

Gtk has its own accessibility library, atk. It doesn't use or support the Mac's accessibility functions; in particular, one must use the Orca screen reader. This isn't provided in the application bundle as as far as we know there is no ready-made Mac build of it.

Helping Out

If you can work on one of these items, please pitch in! Some are Gnucash issues, some are issues with the Quartz implementation of Gtk, and some are integration issues. Join the gtk-osx-devel mailing list to coordinate your work with others.

Example: Setting up a Development Environment

Platform

• M1 Mac running macOS Ventura 13.0.1
• Existing user administrator account with homebrew installed

Goal

• Create a new macOS user gnucash
• Install a GnuCash development environment in the gnucash user account
• Insulated the development environment from the homebrew installation
• Build GunCash from git repo

Steps

1. In the existing administrator account, use System Settings > Users & Groups > Add Account... to create the gnucash' administrator account. Then, changing the bash version number as appropriate.

   brew install bash
   cp /opt/homebrew/Cellar/bash/5.2.15/bin/bash /Users/gnucash/Public/Drop\ Box
   chmod +a "user:gnucash deny add_file,search,add_subdirectory,delete_child,readattr,writeattr,writeextattr,readsecurity" /opt/homebrew
   

   • The development environment needs its own copy of bash, but at least in macOS 13, just copying /bin/bash doesn't work
   • The first two commands provide a usable copy of bash to the gnucash user
   • The chmod commands prevent the gnucash user from accessing the homebrew installation
2. Switch to the gnucash and

   cd $HOME
   curl -O -L https://gitlab.gnome.org/GNOME/gtk-osx/raw/master/gtk-osx-setup.sh
   chmod 755 gtk-osx-setup.sh
   ./gtk-osx-setup.sh
   export PATH="$HOME/.new_local/bin:$PATH"
   cp ~/Public/Drop\ Box/bash $HOME/.new_local/bin
   curl -O -L https://github.com/gnucash/gnucash-on-osx/raw/master/jhbuildrc-custom
   mv jhbuildrc-custom .config
   echo 'branches["gnucash-git"] = (None, "master")' >> .config/jhbuildrc-custom
   sed -i '' -Ee 's/= _modules_stable/= _modules_git/' .config/jhbuildrc-custom
   PREFIX=/Users/gnucash/opt/gnucash jhbuild bootstrap-gtk-osx
   PREFIX=/Users/gnucash/opt/gnucash jhbuild build
   

3. As of January 2023, the build failed on xmlsec1 due to a missing dependency in gnutls. The build stopped with a menu of several options. The following patched the issue

   # Open another terminal and edit the following package config file
   nano /Users/gnucash/opt/gnucash/inst/lib/pkgconfig/gnutls.pc  # add -lgcrypt to the Libs line & save
   # Back in the original build terminal, select Go to phase "configure" option
   

4. Install Finance::Quote from source

   PREFIX=/Users/gnucash/opt/gnucash jhbuild shell
   PREFIX=/Users/gnucash/opt/gnucash
   curl -L https://cpanmin.us | perl - App::cpanminus
   export PATH="$PATH:$HOME/perl5/bin"
   cpanm --local-lib=$PREFIX/lib/perl5 local::lib && eval $(perl -I $PREFIX/lib/perl5/lib/perl5 -Mlocal::lib)
   git clone https://github.com/finance-quote/finance-quote.git
   cd finance-quote
   cpanm install Dist::Zilla
   dzil authordeps --missing | cpanm --notest
   dzil listdeps --missing | cpanm --notest
   cpanm install Data::Dumper::Perltidy Smart::Comments
   dzil build
   cpanm Finance-Quote-1.55.tar.gz
   cpanm install JSON::Parse