#
# This file and its contents are supplied under the terms of the
# Common Development and Distribution License ("CDDL"). You may
# only use this file in accordance with the terms of the CDDL.
#
# A full copy of the text of the CDDL should have accompanied this
# source. A copy of the CDDL is also available via the Internet at
# http://www.illumos.org/license/CDDL.
#

#
# Copyright 2020, 2021, 2022, 2023, 2024 David Stes
#


#
# Package Makefile for the "Classic VM" Squeak Smalltalk system
# See http://squeak.org and http://squeakvm.org
#
# squeak uses cmake and a custom configure script (not GNU autoconf)
# in order to build this package, "cmake" must be installed
#
# squeak was built both in 32-bit and 64-bit mode
# but since 2023 version 4.20.6 now only in 64 bit per OpenIndiana request
# OpenIndiana is dropping 32bit libraries so we can't build 32bit any longer
#
# the squeak driver script was/is checking the Smalltalk image (using ckformat),
# and depending on whether the image is 32bit or 64bit,
# it launches the squeak virtual machine 32bit or 64bit for the image
#
# we now (since 4.20.6) try to use the 64bit executable to launch 32bit images
# and for 64bit images simply fail (with an error message)
#
# for 32-bit : ckformat reports 6505
# 6505: a 32-bit V3 image with closure support and float words stored 
# in native platform order
#
# for 64-bit : ckformat reports 68000
# 68000: a 64-bit V3 image with no closure support and 
# no native platform float word order requirement
#
# note that since 4.20.6 the 64bit images (68000) are no longer working
# but this is not much of a problem due to the fact that all images are 6502
# or 6504 (32bit)
#
# squeak places its 64-bit shared object files in
# usr/lib/squeak/<version>-<svnversion>_64bit/  with a _64bit suffix
# which is unfortunately not conforming to the usr/lib/amd64 usage
# and it generates a hard error by pkglint "64-bit object in 32-bit path"
# so we deliver a patch and rename files
# in order to put the 64-bit objects in their usual usr/lib/amd64 location

BUILD_BITS=64
USE_COMMON_TEST_MASTER=no

# there is support for OpenSSL 1.1 and 3.x in the squeak SSL module
# but the SUnit squeak images tests seem to be written for old ssl versions
# this can be set before including shared-macros.mk
USE_OPENSSL10=yes

# the goal is to use libjpeg8-turbo (or any other libjpeg implementation)
# special care for included header files as the struct sizes vary
# we 'fix' the Squeak source code that has an old libjpeg included in source
# this should be fixed upstream in the Squeak sources
# the default OpenIndiana JPEG_IMPLEM at time of writing is libjpeg8-turbo
JPEG_IMPLEM=libjpeg8-turbo

include ../../../../make-rules/shared-macros.mk

# the version is the same as the VMMaker Smalltalk sources
# it cannot be changed here randomly, it must match the VMMaker version

COMPONENT_NAME=		squeak
COMPONENT_VERSION=	4.20.10
COMPONENT_REVISION=	1
COMPONENT_SUMMARY=	The Squeak Virtual Machine
COMPONENT_PROJECT_URL=	http://www.squeak.org
COMPONENT_ARCHIVE_URL=  http://squeakvm.org
COMPONENT_FMRI=		runtime/smalltalk/squeak
COMPONENT_CLASSIFICATION=	Development/Smalltalk
SVN_REPO=		http://squeakvm.org/svn/squeak/trunk/
SVN_REV=                3833
SVN_HASH=  sha256:84f04d012bc7adcb9e617630c47b59ca1f8b8916e3220bca3d1aabef466b489a

# See http://wiki.squeak.org/squeak/933
# See http://wiki.squeak.org/squeak/159
# there's 2 license lines in the manifest, the MIT squeak.license and this one
COMPONENT_LICENSE=      Squeak4
COMPONENT_LICENSE_FILE= squeak4.license

# Squeak has an extensive test framework called SUnit
# it requires a X11 connection (graphical user interface)
# if connection to $DISPLAY fails from "gmake test" the tests will fail
# the tests are ran only on 32bit image for Squeak classical VM
# because inisqueak downloads a 32 bit image (provided by squeak.org)
# for OpenSmalltalk (see cog-spur and stack-spur) 32bit + 64bit
# since version 2023 4.20.6 we use a 64bit executable to run the 32image
# because OpenIndiana stopped shipping 32bit libraries for 32bit executables
COMPONENT_TEST_CMD=	$(COMPONENT_TEST_RESULTS_DIR)/testrunner.sh $(BITS) $(COMPONENT_DIR) $(BUILD_DIR_64)

include $(WS_MAKE_RULES)/common.mk

PKG_OPTIONS += -DBRANCHID="$(BRANCHID)"
PKG_OPTIONS += -DSVN_REV="$(SVN_REV)"

PATH=$(PATH.gnu)

# override gcc_OPT (defaults to -O3) for the moment
# squeak compiles with -O2 or -O3 but
# KernelTests-Chronology with gcc 7.5 version 4.16.7 or 4.19.*
# gcc -O : 438 pass tests
# gcc -O2 : 20 failures 1 errors  #testAsDelay error
# the system compiled with -O3 / -O2 is usable but has Chronology failures

# the example squeak Makefile specifies _FILE_OFFSET_BITS=64
# goal is large file support (as in man lfcompile)
# lfcompile - large file compilation environment for 32-bit applications

gcc_OPT=	-O

# add -D_FILE_OFFSET_BITS=64 to CPPFLAGS but unlike OpenSmalltalk,
# must also add this to CFLAGS because Squeak configure is not using CPPFLAGS
# (see CFLAGS += CPPFLAGS below)
# since 2023 4.20.6 compile 64bit without largefiles flags to open 32bit images
# CPPFLAGS +=     $(CPP_LARGEFILES)

# use libjpeg8 turbo (see Illumos feature request #7391 for libjpeg8-turbo)
# use --link-shared-lib to avoid the Squeak copy of libjpeg
CPPFLAGS +=     $(JPEG_CPPFLAGS)
LDFLAGS  +=     $(JPEG_LDFLAGS)

# include "jpeglib.h" uses incorrect /usr/include/jpeglib.h unless CFLAGS set
# CPPFLAGS seems not respected by Squeak configure while CFLAGS is
CFLAGS   +=     $(CPPFLAGS)

# cleanup the plugin directory
SOURCE_JPEG = $(SOURCE_DIR)/platforms/Cross/plugins/JPEGReadWriter2Plugin

# squeak configure looks for .svn or svnversion file, but
# prep-svn.mk did a svn export and created an unversioned copy of the sources
COMPONENT_PRE_CONFIGURE_ACTION = \
( echo $(SVN_REV) > $(SOURCE_DIR)/platforms/unix/svnversion; \
  find $(SOURCE_JPEG) \
     \! -name JPEGReadWriter2Plugin.h \
     \! -name sqJPEGReadWriter2Plugin.c \
     \! -name Error.c \
     \! -name jinclude.h \
     \! -name jmemdatasrc.c \
     \! -name jmemdatadst.c \
  -exec rm {} \;)

CONFIGURE_SCRIPT= $(SOURCE_DIR)/platforms/unix/cmake/configure
CONFIGURE_OPTIONS +=	--src=$(SOURCE_DIR)/src
CONFIGURE_OPTIONS +=    --link-shared-lib
CONFIGURE_OPTIONS +=    --without-RePlugin
CONFIGURE_OPTIONS +=    --without-Mpeg3Plugin

# in the 64bit case the vm is called squeakvm64 (not squeakvm)
# the plugin directory under usr/lib/squeak has a _64bit suffix
# CONFIGURE_OPTIONS.64+=	--image64
# CONFIGURE_OPTIONS.64+=	--vm-only
# since 2023 4.20.6 we try to avoid CMakeLists.txt SET (SQ_VI_BYTES_PER_WORD 8)
CONFIGURE_OPTIONS.64+=	-Dversionsuffix=_64bit
CONFIGURE_OPTIONS.64+=	-Dscriptsuffix=64

# Makefile install/strip doesn't work
# the squeakvm is called either squeakvm or squeakvm64 in different directories
COMPONENT_POST_INSTALL_ACTION = \
( find $(PROTOUSRLIBDIR)/squeak -name 'squeakvm*' -exec strip {} \; )

#
# target to update the manifests from sample-manifest
#

rebuild-manifests::
	cp manifests/squeak.p5m squeak.p5m
	cp manifests/squeak-vep.p5m squeak-vep.p5m
	cp manifests/squeak-ssl.p5m squeak-ssl.p5m
	cp manifests/squeak-display-X11.p5m squeak-display-X11.p5m
	cp manifests/squeak-nodisplay.p5m squeak-nodisplay.p5m
	cp manifests/sample-manifest.p5m sample-manifest.p5m
	tools/subversion.sh $(SVN_REV) <sample-manifest.p5m >sample.p5m
	tools/classify.pl <sample.p5m
	tools/amd64-p5m.sh
	rm -f sample-manifest.p5m sample.p5m

# disable pkglint until we find solution for 64bit object in 32-bit path error
PKGLINT= /bin/true

REQUIRED_PACKAGES += x11/library/mesa
REQUIRED_PACKAGES += system/library/dbus

# Auto-generated dependencies
REQUIRED_PACKAGES += $(JPEG_IMPLEM_PKG)
REQUIRED_PACKAGES += image/library/libjpeg-turbo
REQUIRED_PACKAGES += library/audio/gstreamer
REQUIRED_PACKAGES += library/audio/pulseaudio
REQUIRED_PACKAGES += library/desktop/cairo
REQUIRED_PACKAGES += library/desktop/pango
REQUIRED_PACKAGES += library/glib2
REQUIRED_PACKAGES += library/libffi
REQUIRED_PACKAGES += library/security/openssl
REQUIRED_PACKAGES += shell/ksh93
REQUIRED_PACKAGES += system/library
REQUIRED_PACKAGES += system/library/freetype-2
REQUIRED_PACKAGES += system/library/libdbus
REQUIRED_PACKAGES += system/library/math
REQUIRED_PACKAGES += x11/library/libx11
REQUIRED_PACKAGES += x11/library/libxext
REQUIRED_PACKAGES += x11/library/libxrender