games-emulation/dosbox-x: Add 2024.07.01

Bug: https://bugs.gentoo.org/921909
Signed-off-by: Yuan Liao <liaoyuan@gmail.com>

2 files changed, 216 insertions, 0 deletions

diff --git a/games-emulation/dosbox-x/Manifest b/games-emulation/dosbox-x/Manifest
index c57446ce7..279618515 100644
--- a/games-emulation/dosbox-x/Manifest
+++ b/games-emulation/dosbox-x/Manifest
@@ -1 +1,2 @@
 DIST dosbox-x-v2024.03.01.tar.gz 119593920 BLAKE2B 42c994247e55c1b2d67ed9e1bf90e99ddf9a08476b18ab802757becc0ee6959231d3665e39cfaef02a6b1c234e3faff10597d396d8d30ce01d8123b5107327bc SHA512 0eb835da3fdfd7f1c6160aa1a32a7eff7c38f46184f7cee088e0fb8edf09327f058fd45e7995955a7f335c704ddd69c1627731899a01687563990bb06f4d9cd1
+DIST dosbox-x-v2024.07.01.tar.gz 119702042 BLAKE2B 1c046a54b5a94deef6413592c48be08542c6d9c6d5b437880a354eb9df137fafb5da57d5f99e4bdcd83eea99a7a3550117c8ed66adcbca38aea484b116321068 SHA512 e6a0478be160b115ab09ffe13d7574d604fc7778105171da3591bd4239903cb5766118e0b05d158a89344bbbd1383885aa4fd724dce4601595438634724b2f24
diff --git a/games-emulation/dosbox-x/dosbox-x-2024.07.01.ebuild b/games-emulation/dosbox-x/dosbox-x-2024.07.01.ebuild
new file mode 100644
index 000000000..3a9d16acc
--- /dev/null
+++ b/games-emulation/dosbox-x/dosbox-x-2024.07.01.ebuild
@@ -0,0 +1,215 @@
+# Copyright 2022-2024 Gentoo Authors
+# Distributed under the terms of the GNU General Public License v2
+
+EAPI=8
+
+inherit autotools toolchain-funcs xdg
+
+if [[ "${PV}" == 9999 ]]; then
+	inherit git-r3
+	EGIT_REPO_URI="https://github.com/joncampbell123/dosbox-x.git"
+else
+	SRC_URI="https://github.com/joncampbell123/dosbox-x/archive/dosbox-x-v${PV}.tar.gz"
+	S="${WORKDIR}/${PN}-${PN}-v${PV}"
+	KEYWORDS="~amd64"
+fi
+
+DESCRIPTION="Complete, accurate DOS emulator forked from DOSBox"
+HOMEPAGE="https://dosbox-x.com/"
+
+# Stay consistent with games-emulation/dosbox::gentoo even though source file
+# headers specify the GPL version to be "either version 2 of the License, or
+# (at your option) any later version."  The same header is used in both the
+# DOSBox source tree and the DOSBox-X source tree.
+LICENSE="GPL-2"
+SLOT="0"
+
+IUSE="X debug ffmpeg fluidsynth opengl png slirp truetype"
+# Unit tests are only available in debug builds
+RESTRICT="!debug? ( test )"
+
+BDEPEND="
+	dev-lang/nasm
+	sys-libs/libcap
+"
+
+# Unconditionally pulling in automagically-enabled optional dependencies:
+# - media-libs/alsa-lib
+# - media-libs/sdl2-net
+# - net-libs/libpcap
+#
+# With media-libs/libsdl2[-X,wayland], this package does work on a Wayland
+# desktop, but (at least on GNOME) the program does not launch in a movable
+# and resizable window; whereas with media-libs/libsdl2[X], it does.  Thus,
+# unconditionally require media-libs/libsdl2[X] for better user experience.
+#
+# DOSBox-X works with multiple audio backends of SDL 2 but requires at least
+# one available backend (https://bugs.gentoo.org/901303).  Unconditionally
+# depending on media-libs/libsdl2[alsa] to satisfy this requirement since
+# this ebuild already unconditionally pulls in media-libs/alsa-lib.
+COMMON_DEPEND="
+	media-libs/alsa-lib
+	media-libs/libsdl2[X,alsa,opengl?,sound,threads,video]
+	media-libs/sdl2-net
+	net-libs/libpcap
+	sys-libs/zlib
+	X? (
+		x11-libs/libX11
+		x11-libs/libXrandr
+		x11-libs/libxkbfile
+	)
+	debug? ( sys-libs/ncurses:= )
+	ffmpeg? ( media-video/ffmpeg:= )
+	fluidsynth? ( media-sound/fluidsynth:= )
+	opengl? ( media-libs/libglvnd[X] )
+	png? ( media-libs/libpng:= )
+	slirp? ( net-libs/libslirp )
+	truetype? ( media-libs/freetype )
+"
+
+DEPEND="
+	${COMMON_DEPEND}
+"
+
+# DOSBox-X can still run normally without any of these dependencies --
+# it just cannot show a file dialog.  However, upon the initial launch,
+# DOSBox-X will try to show a file dialog to let the user choose the
+# working directory; without one of these dependencies, the user would
+# see nothing when they launch DOSBox-X for the first time.
+FILE_DIALOG_DEPEND="
+	|| (
+		gnome-extra/zenity
+		kde-apps/kdialog
+		x11-misc/xdialog
+	)
+"
+
+RDEPEND="
+	${COMMON_DEPEND}
+	${FILE_DIALOG_DEPEND}
+"
+
+pkg_pretend() {
+	if use ffmpeg && use !png; then
+		ewarn "Setting the 'ffmpeg' USE flag when the 'png' USE flag is"
+		ewarn "unset does not have any effect.  Unsetting the 'png' USE"
+		ewarn "flag disables the video capture feature, so additional"
+		ewarn "video capture formats enabled by the 'ffmpeg' USE flag"
+		ewarn "will end up being unused."
+	fi
+}
+
+src_prepare() {
+	default
+
+	# https://bugs.gentoo.org/887669
+	# Mask lines touching '-O*', and avoid creating an empty command
+	# list as a result to not break 'if', 'for', or functions
+	sed -i -E -e 's/((C|CXX)FLAGS=.*-O)/: \1/' configure.ac ||
+		die "Failed to stop configure.ac from touching '-O*' compiler flags"
+
+	eautoreconf
+}
+
+src_configure() {
+	local myconf=(
+		# Always use SDL 2, even though the package provides the option to
+		# build with SDL 1.x, because this package is expected to be built
+		# with the bundled, heavily-modified version of SDL 1.x if that
+		# branch is used.  Compiler errors are likely to occur if the
+		# bundled version of SDL 1.x is not used.  Bundled dependencies
+		# should be avoided on Gentoo, so SDL 2 is more preferable.
+		--enable-sdl2
+
+		# Explicitly enable ALSA MIDI support, same as default.  As of
+		# v2022.08.0, even when it is disabled, media-libs/alsa-lib will
+		# still be automagically linked if it is present in the build
+		# environment (presumably for other components of this package),
+		# so the dependency cannot be made optional by disabling this
+		# option.  Plus, disabling this option has no observable effect
+		# on build time, build size, or the program's functionality, as
+		# 'mididevice=alsa' still works with '--disable-alsa-midi'.
+		--enable-alsa-midi
+
+		$(use_enable debug '' heavy)
+
+		$(use_enable X x11)
+		$(use_enable ffmpeg avcodec)
+		$(use_enable fluidsynth libfluidsynth)
+		$(use_enable opengl)
+		$(use_enable png screenshots)
+		$(use_enable slirp libslirp)
+		$(use_enable truetype freetype)
+	)
+
+	econf "${myconf[@]}"
+}
+
+src_compile() {
+	# https://bugs.gentoo.org/856352
+	emake AR="$(tc-getAR)"
+}
+
+src_test() {
+	set -- src/dosbox-x -tests
+	echo "${@}" >&2
+	"${@}" || die "Unit tests failed"
+}
+
+pkg_preinst() {
+	xdg_pkg_preinst
+
+	# Returns whether or not the USE flag specified with the first positional
+	# argument is newly enabled for this installation of the package.
+	newuse() {
+		local flag="${1}"
+
+		# The 'has_version' call tests if any USE flags are newly enabled.
+		# It is to extract information about any existing copy of this
+		# package installed on the system, which is why it should be made
+		# before the new copy of this package just built is merged.
+		use "${flag}" && ! has_version "${CATEGORY}/${PN}[${flag}]"
+	}
+
+	newuse debug && PRINT_NOTES_FOR_DEBUGGER=1
+	newuse fluidsynth && PRINT_NOTES_FOR_FLUIDSYNTH=1
+}
+
+pkg_postinst() {
+	xdg_pkg_postinst
+
+	if [[ "${PRINT_NOTES_FOR_DEBUGGER}" ]]; then
+		elog
+		elog "Note on the Debugger"
+		elog
+		elog "The debugger can only be started when DOSBox-X is launched"
+		elog "from a terminal.  Otherwise, the \"Start DOSBox-X Debugger\""
+		elog "option in the \"Debug\" drop-down menu would be unavailable."
+		elog
+		elog "For more information about the debugger, please consult:"
+		elog "  ${EPREFIX}/usr/share/doc/${PF}/README.debugger*"
+	fi
+
+	if [[ "${PRINT_NOTES_FOR_FLUIDSYNTH}" ]]; then
+		elog
+		elog "Note on FluidSynth"
+		elog
+		elog "To use FluidSynth as the MIDI device for DOSBox-X, a soundfont"
+		elog "is required.  If no existing soundfont is available, a new one"
+		elog "can be installed and configured for DOSBox-X very easily:"
+		elog
+		elog "1. Install the following package:"
+		elog "     media-sound/fluid-soundfont"
+		elog "2. Add the following lines to DOSBox-X's configuration file:"
+		elog "     [midi]"
+		elog "     mididevice=fluidsynth"
+		elog
+		elog "Usually, there is no need to explicitly specify the soundfont"
+		elog "file's path because the package mentioned in step 1 installs"
+		elog "soundfont files to a standard location, allowing them to be"
+		elog "detected and selected automatically."
+		elog
+		elog "For advanced FluidSynth configuration, please consult:"
+		elog "  https://dosbox-x.com/wiki/Guide%3ASetting-up-MIDI-in-DOSBox%E2%80%90X#_fluidsynth"
+	fi
+}