Merge pull request #165 from hugoholgersson/mac_os_port

Port of Diffuse to macOS

Author: MightyCreak

.markdownlint.json

@@ -0,0 +1,6 @@
+{
+    "default": true,
+    "no-duplicate-heading": false,
+    "no-inline-html": false,
+    "no-emphasis-as-heading": false
+}

data/icons/diffuse.icns

@@ -11,3 +11,7 @@ install_data(
   join_paths(symbolic_dir, ('@[email protected]').format(application_id)),
   install_dir: join_paths(get_option('datadir'), 'icons', symbolic_dir)
 )
+
+if build_machine.system() == 'darwin'
+  install_data('diffuse.icns', install_dir: '/Applications/Diffuse.app/Contents/Resources')
+endif

data/icons/meson.build

@@ -1,34 +1,36 @@
 pkgdatadir = join_paths(get_option('prefix'), get_option('datadir'), meson.project_name())
 
-desktop_file = i18n.merge_file(
-  input: 'io.github.mightycreak.Diffuse.desktop.in',
-  output: 'io.github.mightycreak.Diffuse.desktop',
-  type: 'desktop',
-  po_dir: '../po',
-  install: true,
-  install_dir: join_paths(get_option('datadir'), 'applications')
-)
-
-desktop_utils = find_program('desktop-file-validate', required: false)
-if desktop_utils.found()
-  test('Validate desktop file', desktop_utils,
-    args: [desktop_file]
+if build_machine.system() == 'linux'
+  desktop_file = i18n.merge_file(
+    input: 'io.github.mightycreak.Diffuse.desktop.in',
+    output: 'io.github.mightycreak.Diffuse.desktop',
+    type: 'desktop',
+    po_dir: '../po',
+    install: true,
+    install_dir: join_paths(get_option('datadir'), 'applications')
   )
-endif
 
-appstream_file = i18n.merge_file(
-  input: 'io.github.mightycreak.Diffuse.appdata.xml.in',
-  output: 'io.github.mightycreak.Diffuse.appdata.xml',
-  po_dir: '../po',
-  install: true,
-  install_dir: join_paths(get_option('datadir'), 'appdata')
-)
-
-appstream_util = find_program('appstream-util', required: false)
-if appstream_util.found()
-  test('Validate appstream file', appstream_util,
-    args: ['validate', appstream_file]
+  desktop_utils = find_program('desktop-file-validate', required: false)
+  if desktop_utils.found()
+    test('Validate desktop file', desktop_utils,
+      args: [desktop_file]
+    )
+  endif
+
+  appstream_file = i18n.merge_file(
+    input: 'io.github.mightycreak.Diffuse.appdata.xml.in',
+    output: 'io.github.mightycreak.Diffuse.appdata.xml',
+    po_dir: '../po',
+    install: true,
+    install_dir: join_paths(get_option('datadir'), 'appdata')
   )
+
+  appstream_util = find_program('appstream-util', required: false)
+  if appstream_util.found()
+    test('Validate appstream file', appstream_util,
+      args: ['validate', appstream_file]
+    )
+  endif
 endif
 
 # Diffuse config file

data/meson.build

@@ -8,13 +8,14 @@ Diffuse depends on these projects:
 * PyPi
 * Cairo and GObject Introspection development headers
 * Meson
-* Flatpak and Flatpak builder
+* Flatpak and Flatpak builder (Linux only)
 
-### Install the distribution dependencies
+## Install the dependencies
 
-It's a bit difficult to get the command lines for all the distributions and
-their releases, but it should be enough to find the packages on other
-distributions.
+### Install the system dependencies
+
+It's a bit difficult to get the command lines for all the systems, but these
+examples should be enough to find the packages on most systems.
 
 <details>
     <summary>Debian/Ubuntu</summary>
@@ -32,7 +33,19 @@ _Note: Tested on Debian 11 (Buster) and Ubuntu 20.04 (Focal)_
 sudo dnf install python-pip cairo-devel cairo-gobject-devel meson flatpak flatpak-builder
 ```
 
-_Note: Tested on Fedora 34_
+_Note: Tested on Fedora 36_
+</details>
+
+<details>
+    <summary>Mac OS</summary>
+
+On Mac, all dependencies can be installed using [Homebrew](https://docs.brew.sh/):
+
+```sh
+brew install meson python3 py3cairo pygobject3 gtk+3 librsvg
+```
+
+_Note: Tested on macOS 12.5 (Monterey)_
 </details>
 
 ### Install the project dependencies
@@ -49,34 +62,42 @@ For developer tools, run this one instead (it includes requirements.txt):
 pip install -r requirements.dev.txt
 ```
 
-## Setup on Linux
+## Setup
+
+### Setup on Linux using Flatpak
 
-### Build, test and install using Flatpak
+#### Build, test and install
 
-To install Diffuse locally:
+To build, test and install Diffuse locally:
 
 ```sh
 flatpak install runtime/org.gnome.Sdk/$(uname -p)/42
 flatpak-builder --user --install build-flatpak io.github.mightycreak.Diffuse.yml
 ```
 
+#### Run
+
 To run Diffuse through Flatpak:
 
 ```sh
 flatpak run io.github.mightycreak.Diffuse
 ```
 
+#### Uninstall
+
 To uninstall Diffuse:
 
 ```sh
 flatpak remove io.github.mightycreak.Diffuse
 ```
 
-### Build, test and install using Meson
+### Setup on Linux using Meson
+
+#### Build and test
 
-Diffuse build system is meson.
+Diffuse is using Meson as its build system.
 
-To compile and test Diffuse:
+To build and test Diffuse:
 
 ```sh
 meson setup build
@@ -85,36 +106,81 @@ meson compile
 meson test
 ```
 
+#### Install on system and run
+
 To install Diffuse on your system (e.g. `/usr/local/`):
 
 ```sh
 meson install # requires admin privileges
+```
+
+To run Diffuse:
 
-# Run Diffuse
+```sh
 diffuse
 ```
 
-To install Diffuse on a custom directory (e.g. `~/bin/diffuse`):
+#### Install in a custom directory and run
+
+Meson allows to change the default installation directories, see
+[command-line documentation](https://mesonbuild.com/Commands.html#configure).
+
+To install Diffuse in a custom directory (e.g. `~/bin/diffuse`):
 
 ```sh
 meson install --destdir ~/bin/diffuse
+```
 
-# Run Diffuse
+To run Diffuse:
+
+```sh
+export PYTHONPATH=$HOME/bin/diffuse/usr/local/share/diffuse
 cd ~/bin/diffuse/usr/local/bin
-PYTHONPATH=$HOME/bin/diffuse/usr/local/share/diffuse ./diffuse
+./diffuse
 ```
 
-To uninstall diffuse afterwards:
+#### Uninstall
+
+To uninstall Diffuse afterwards:
 
 ```sh
 sudo ninja uninstall -C build
 sudo rm -v /usr/local/share/locale/*/LC_MESSAGES/diffuse.mo
 ```
 
-Meson allows to change the default installation directories, see
-[command-line documentation](https://mesonbuild.com/Commands.html#configure).
+### Setup on Mac OS
+
+#### Build and test
+
+Diffuse is using Meson as its build system.
+
+To build and test Diffuse:
+
+```sh
+meson setup build
+cd build
+meson compile
+meson test
+```
+
+#### Install on system and run
+
+To install Diffuse on your system (e.g. `/usr/local/`):
+
+```sh
+meson install # requires admin privileges
+```
+
+To run Diffuse:
+
+```sh
+diffuse
+```
+
+_Note: The `diffuse` command can be used to launch Diffuse as a native Mac app_
+_that is installed into `/Applications/Diffuse.app`._
 
-## Setup on Windows
+### Setup on Windows (deprecated)
 
 _Note:_ The Windows port is not maintained and would need some love.
 Contributions are very welcome! 😉

docs/developers/developers-setup.md

@@ -19,16 +19,16 @@ few manual steps.
    - data/usr/share/gnome/help/diffuse/*/diffuse.xml
    - data/usr/share/omf/diffuse/diffuse-*.omf
    - utils/book2manual.xsl
-3. Update CHANGELOG.md
+4. Update CHANGELOG.md
    - Add new line under `## Unreleased` following this syntax: `## x.y.z - YYYY-MM-DD`
    - Copy the content of the changes for this release
-4. Update AppData release notes in data/io.github.mightycreak.Diffuse.appdata.xml.in:
+5. Update AppData release notes in data/io.github.mightycreak.Diffuse.appdata.xml.in:
    - Create a new `<release>` tag under `<releases>`, fill the `version` and
      `date` attributes
    - Create a new `<description>` tag under the new `<release>` tag
    - Add one paragraph to sum the release in one sentence (e.g. highlights, ...)
    - Paste the changes from the changelog and adapt it to HTML
-5. Create new branch and PR
+6. Create new branch and PR
 
 ## Create new release on GitHub
 

docs/developers/release-process.md

@@ -70,6 +70,7 @@ Use `update-translations.py` to validate one or more PO files.
 Here is an example with `ja.po` and `ko.po`:
 
 Command-line:
+
 ```sh
 ./update-translations.py --check-only ja.po ko.po
 ```
@@ -99,8 +100,10 @@ POSIX platforms. The conversion tools insert some English text that gets
 localized using search and replace. Manually add new search and replace rules
 to these files:
 
-    ../windows-installer/translations.txt
-    ../utils/translations.txt
+```text
+../windows-installer/translations.txt
+../utils/translations.txt
+```
 
 The format of each line is: \<language id\>:\<English text\>:\<localised text\>
 

docs/translators.md

@@ -22,3 +22,12 @@ The Diffuse package statuses for every distributions can been seen on
 
 Huge thanks to [@bongochong](https://github.com/bongochong) for maintaining the
 Diffuse package on Fedora.
+
+## Integrate with Git
+
+Diffuse is compatible with `git difftool` command-line. To use Diffuse as Git
+diff tool, run:
+
+```sh
+git config --global diff.tool diffuse
+```

docs/users.md

@@ -10,4 +10,6 @@ subdir('data')
 subdir('src')
 subdir('po')
 
-meson.add_install_script('build-aux/meson/postinstall.py')
+if build_machine.system() == 'linux'
+  meson.add_install_script('build-aux/meson/postinstall.py')
+endif

meson.build

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>CFBundleDevelopmentRegion</key>
+    <string>English</string>
+    <key>CFBundleExecutable</key>
+    <string>mac_launcher.sh</string>
+    <key>CFBundleIconFile</key>
+    <string>diffuse.icns</string>
+    <key>CFBundleIdentifier</key>
+    <string>io.github.mightycreak.Diffuse</string>
+    <key>CFBundleName</key>
+    <string>Diffuse</string>
+    <key>CFBundleShortVersionString</key>
+    <string>@VERSION@</string>
+    <key>CFBundlePackageType</key>
+    <string>APPL</string>
+    <key>NSAppleScriptEnabled</key>
+    <string>NO</string>
+</dict>
+</plist>