Ticket #68705: Portfile

# -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:fenc=utf-8:filetype=tcl:et:sw=4:ts=4:sts=4

# We have an umbrella radar tracking webkit-gtk issues on OS X.  Please relate
# any future issues with this tracker.
# http://bugs.webkit.org/show_bug.cgi?id=126492

PortSystem          1.0
PortGroup           active_variants 1.1
PortGroup           cmake 1.1
PortGroup           legacysupport 1.1

compiler.cxx_standard 2017
cmake.generator     Ninja
# Fix compilation for Angle subproject: platform.h: error: 'TARGET_OS_OSX' is not defined
legacysupport.newest_darwin_requires_legacy 15

name                webkit2-gtk
conflicts           webkit2-gtk-devel
version             2.28.2
revision            9

description         Apple's WebKit2 HTML rendering library for GTK+3
long_description    {*}${description}
maintainers         {devans @dbevans} {mascguy @mascguy}
categories          www gnome
platforms           darwin freebsd
license             LGPL-2+ BSD
homepage            http://webkitgtk.org/
master_sites        http://webkitgtk.org/releases/

use_xz              yes
distname            webkitgtk-${version}

dist_subdir         webkit-gtk

checksums           rmd160  a626f58cf30b6dd1ef8a63c165ce85770c4da675 \
                    sha256  b9d23525cfd8d22c37b5d964a9fe9a8ce7583042a2f8d3922e71e6bbc68c30bd \
                    size    21427772

depends_build-append \
                    port:gperf \
                    port:gtk-doc \
                    port:perl5.34 \
                    port:pkgconfig \
                    port:python27 \
                    port:py27-simplejson

depends_lib-append  port:atk \
                    port:at-spi2-atk \
                    port:bison \
                    path:lib/pkgconfig/cairo.pc:cairo \
                    port:flex \
                    port:fontconfig \
                    port:freetype \
                    port:enchant2 \
                    port:geoclue2 \
                    path:lib/pkgconfig/glib-2.0.pc:glib2 \
                    path:lib/pkgconfig/gobject-introspection-1.0.pc:gobject-introspection \
                    port:gstreamer1 \
                    port:gstreamer1-gst-plugins-bad \
                    port:gstreamer1-gst-plugins-base \
                    port:gstreamer1-gst-plugins-good \
                    path:lib/pkgconfig/gtk+-3.0.pc:gtk3 \
                    path:lib/pkgconfig/harfbuzz-icu.pc:harfbuzz-icu \
                    port:hyphen \
                    path:lib/pkgconfig/icu-uc.pc:icu \
                    path:include/turbojpeg.h:libjpeg-turbo \
                    port:libnotify \
                    port:libpng \
                    port:libsecret \
                    path:lib/pkgconfig/libsoup-2.4.pc:libsoup \
                    port:libxml2 \
                    port:libxslt \
                    port:sqlite3 \
                    port:webp \
                    port:woff2 \
                    port:zlib


# 1. add missing JavaScriptCore include directory used only on Apple webkit builds
# 2. don't copy the ICU includes into the source tree
# 3. add missing WebCore include directory used only on Apple webkit builds
# 4. add a missing Apple-only header found in the WebKit project
# 5. change some int64_t to gint64 to stop typedef errors in gstreamer
patchfiles-append   patch-webkit2gtk-macports.diff

# and a few more for webkit2-gtk-2.27.2
patchfiles-append   patch-webkit2gtk-272-macports.diff

# and a few more for 282
patchfiles-append   patch-webkit2gtk-2282-unprotected-egl-changes.diff

# os log is only available on newer systems.
patchfiles-append   patch-webkit2gtk-2282-os-log-availability.diff

# enable Netscape plugin architecture on macOS
# or can be explicitly disabled with the following addition if preferred
# configure.args-append -DENABLE_NETSCAPE_PLUGIN_API=OFF
patchfiles-append    patch-enable-plugin-architecture-unix.diff

# add a link library to WebCore. I am not sure this is still needed; builds and
# runs without this patch.
patchfiles-append    patch-bundle-link-webcore.diff

# Fix incompatibility with XCode 12:
# https://bugs.webkit.org/show_bug.cgi?id=207871
patchfiles-append    patch-WTF-wtf-getVTablePointer.diff

# Fix build errors due to -WWc++11-narrowing
# https://bugs.webkit.org/show_bug.cgi?id=211193
patchfiles-append    patch-bool_narrowed.diff

# Explicitly specify installed dylib paths to g-ir-compile
# Fixes dlopen errors in apps using webkit2gtk introspection
patchfiles-append    patch-webkit2gtk-specify-installed-dylibs.diff

# Backport https://github.com/WebKit/WebKit/commit/b83958928838b8a997c12a8de06f89377df0a903
patchfiles-append    patch-icu-68-true-false.diff

# API changed with libxml2 2.12+
# https://github.com/WebKit/WebKit/commit/1bad176b2496579d760852c80cff3ad9fb7c3a4b
patchfiles-append    patch-webkit2-gtk-fixes-for-libxml2-2.12.0.diff

# Fix build with Ruby 3.2
# MacPorts ticket https://trac.macports.org/ticket/68705
# Webkit ticket: https://bugs.webkit.org/show_bug.cgi?id=246743
# Commit for Webkit 2.38.0 which fixes it:
# https://github.com/WebKit/WebKit/commit/b7ac5d0ccc7ca3ed6bf4f2d40fde60247ce87d3c
# The following diff is a backport of the above patch to Webkit 2.28.2.
patchfiles-append    patch-deprecated-file-exists-rb32.diff

# Reduce compilation warnings
configure.cppflags-append \
    -Wno-deprecated-declarations

# it is preferred to use the WebKit built in bmalloc if it builds on a given os.
# it has improved security features, but not all systems can build it at present.
configure.args-append \
    -DPORT=GTK \
    -DENABLE_INTROSPECTION=ON \
    -DENABLE_MINIBROWSER=OFF \
    -DENABLE_VIDEO=ON \
    -DUSE_SYSTEM_MALLOC=OFF \
    -DPERL_EXECUTABLE=${prefix}/bin/perl5.34

pre-configure {
    if {![variant_isset quartz] && ![variant_isset x11]} {
        error "Either +x11 or +quartz is required"
    }
}

if {![variant_isset quartz]} {
    default_variants-append +x11
}

# this is nice to have, and should be the default
default_variants-append +minibrowser

variant quartz conflicts x11 {
    require_active_variants path:lib/pkgconfig/gtk+-3.0.pc:gtk3 quartz

    # TODO: restrict this patch to just Big Sur?
    patchfiles-append patch-Source_WebKit_Platform_IPC_Connection.cpp.diff

    configure.args-append \
        -DENABLE_QUARTZ_TARGET=ON \
        -DENABLE_X11_TARGET=OFF \
        -DENABLE_OPENGL=OFF

# OPENGL does not work with +quartz, eg: https://trac.macports.org/ticket/52495
# OPENGL must be explicitly turned off, otherwise GLX is found, but X11 is not, and:
# CMake Error at Source/cmake/OptionsGTK.cmake:280 (message):
#  Either GLX or EGL is needed for ENABLE_OPENGL.

}

variant x11 conflicts quartz {
    require_active_variants path:lib/pkgconfig/gtk+-3.0.pc:gtk3 x11

    configure.args-append \
        -DENABLE_QUARTZ_TARGET=OFF \
        -DENABLE_X11_TARGET=ON \
        -DENABLE_OPENGL=OFF

    depends_lib-append \
        port:mesa \
        port:xorg-libXt
}

variant minibrowser description {Build and install MiniBrowser (for testing)} {
    configure.args-delete   -DENABLE_MINIBROWSER=OFF
    configure.args-append   -DENABLE_MINIBROWSER=ON
    depends_run-append       port:adwaita-icon-theme
}

# see https://trac.macports.org/ticket/56792
# no success at building universal after considerable attempts
# errors out in the javascript interpreter
# muniversal PG does not fix it. disabling the JIT does not fix it
# help wanted, if suitably motivated
universal_variant   no

# Fix builds if ccache happens to be installed when configure.ccache=no
if {![option configure.ccache]} {
    build.env-append        CCACHE_DIR=${workpath}/.ccache
}

# the above code presently builds as-in on 10.13 and up
if {${os.platform} eq "darwin" && ${os.major} <= 16} {

    # build of bmalloc fails up to 10.12 https://trac.macports.org/ticket/59447
    configure.args-replace -DUSE_SYSTEM_MALLOC=OFF -DUSE_SYSTEM_MALLOC=ON
    patchfiles-append       patch-ramsize.diff

    # Source/WTF/wtf/unix/CPUTimeUnix.cpp : add back a previous Darwin compat version
    patchfiles-append       patch-source-wtf-wtf-unix-cputimeunix-cpp-darwin-version-restore.diff

    # some Darwin versions don't have MAP_JIT; only use it if available
    patchfiles-append       patch-source-wtf-wtf-osallocatorposix-cpp-map-jit.diff

    # gl cocoa build continues to fail due to use of API not available on darwin 12 or earlier
    # so gstreamergl is not available at present for darwin 12 or earlier
    # todo clarify further where this is exactly needed
    configure.args-append -DUSE_GSTREAMER_GL=OFF

    # for the webcore/page/crypt code to flow correctly,
    # ENABLE_WEB_CRYPTO has to be ON for 10.10+ and OFF for 10.9 and less
    if {${os.major} <= 13} {
        configure.args-append  -DENABLE_WEB_CRYPTO=OFF
    }
    # disable Apple internal security libraries, available only on new systems
    patchfiles-append       patch-Webcore-page-crypto.diff

    # restrict special process memory kernel calls to 10.9+ that support them
    patchfiles-append       patch-WTF-wtf-spi-darwin-ProcessMemoryFootprint-h.diff

    # the darwin build uses security features that are Apple internal only, but
    # the unix version does not FIXME: sort the ifdefs out
    # https://bugs.webkit.org/show_bug.cgi?id=157554
    patchfiles-append       patch-WTF-wtf-Randomdevice.diff

    # disable veclib on 10.7 and 10.8. There is a definition for
    # class complex<> in the vForce.h header that collides with libc++
    # if anyone has a more elegant fix for this, please volunteer it
    if {${os.major} == 11 || ${os.major} == 12} {
        patchfiles-append       patch-webcore-platform-audio-directconvolver-disable-veclib.diff
    }

    # there is a missing header that manifests on 10.7 and less
    patchfiles-append patch-webkit2gtk-source-javascriptcore-jit-executableallocator-missingfcntl-h-older-systems.diff

    # add dep for newer ruby and spec this for build
    # https://trac.macports.org/ticket/52016
    depends_build-append    port:ruby25
    configure.args-append   -DRUBY_EXECUTABLE=${prefix}/bin/ruby2.5

    # fix missing PRId64 definitions on systems
    # that don't define __STDC_FORMAT_MACROS by default
    # https://bugs.webkit.org/show_bug.cgi?id=156596
    # https://trac.macports.org/ticket/52016
    # also added defn for TARGET_OS_IOS to avoid innumerable warnings
    patchfiles-append patch-snowleopard-cmakelists-stdcformatmacros.diff
    
    # special case: fix build on 10.6 with macports-libstdc++
    # contents of snowmath.h should someday become part of gcc6 cmath
    # TODO: remove this?
    if { ${configure.cxx_stdlib} eq "macports-libstdc++"  && ${os.major} < 11 } {
        configure.cxxflags-append -D_GLIBCXX_USE_C99_MATH_TR1=1
        configure.cxxflags-append -include ${filespath}/snowmath.h
    }
}

notes-append "
If you are porting new software to use webkit2gtk on Apple systems,\
you will likely need to define BUILDING_GTK__ to get the correct\
behaviour from WebKitAvailability.h.
"

livecheck.type      regex
livecheck.url       http://webkitgtk.org/releases/
livecheck.regex     "webkitgtk-(\\d+\\.\\d*\[02468\](?:\\.\\d+)*)"