luke
/
magic
mirror of https://github.com/RTimothyEdwards/magic.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
magic/scripts/run_magic_gdb.sh.in

48 lines
2.1 KiB
Bash
Raw Permalink Normal View History

build: add run_magic*.sh launchers to run magic from the build tree Four configure-generated launch scripts let you run magic straight from the build directory without `make install`: * run_magic.sh -- GUI magic (Cairo/X11) * run_magicnull.sh -- batch / no-GUI (-dnull) * run_magic_gdb.sh -- magic under gdb * run_magic_valgrind.sh -- magic under valgrind magic resolves its runtime files through a single $CAD_ROOT root ($CAD_ROOT/magic/{sys,tcl}), but in the build tree they are scattered across build/ (generated tech, .magicrc, magic.tcl, tclmagic, execs) and source/ (colormaps, dstyles, glyphs, fonts, tcl scripts). On first run each launcher self-stages ${builddir}/CAD_DIR as a symlink tree in that layout (no copies, always current) via the shared scripts/magic_run_common.sh, exports CAD_ROOT=${builddir}/CAD_DIR, and execs the right binary. This pairs with the preceding commit that made the C launchers honor CAD_ROOT. magic_stage() is idempotent and re-runs on every launch. Most staged entries are files, but the bitmaps entry links a *directory*, so it uses `ln -sfn` (--no-dereference; also accepted by BSD ln): a plain `ln -sf` would, on a second run, dereference the existing symlink-to-directory and drop the new link *inside* the target -- a magic/bitmaps/bitmaps self-loop in the source tree that trips up find/tar/cp -r. Verified: ./run_magicnull.sh self-stages (30 sys + 24 tcl symlinks) and runs -- `tech load scmos` reports 13 planes -- straight from the build dir. gitignore covers the generated scripts and the CAD_DIR tree. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-24 00:06:28 +02:00
#!/usr/bin/env bash
#
build: document run_magic* launchers, template WISH/TCLSH, validate the env Expand each run_magic*.sh header to state its purpose, usage, and the full set of environment overrides. Initialize every knob with ${VAR:-default} so a value inherited from the environment always wins: - CAD_ROOT is now overridable (was hardwired to $builddir/CAD_DIR); point it at a shared/installed tree to skip staging. - WISH/TCLSH default to the wish/tclsh configure detected for this build's Tcl/Tk (@WISH_EXE@/@TCLSH_EXE@, matching --with-tk/--with-tcl), so a build against a non-standard Tcl/Tk automatically uses the correct absolute paths. MAGIC_WISH (what tkcon.tcl uses for the Tk console) defaults from WISH. Add magic_check_env(): on source, sanity-check each value (directory / regular file / executable, as appropriate) and print a non-fatal stderr warning naming the offending variable and whether it came from the environment or the baked default -- to make a bad override easy to diagnose. Empty optional values (e.g. no tclsh configured) and a not-yet-created CAD_ROOT are not flagged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-24 00:49:49 +02:00
# run_magic_gdb.sh -- run magic (GUI) under gdb, straight from the build tree.
build: add run_magic*.sh launchers to run magic from the build tree Four configure-generated launch scripts let you run magic straight from the build directory without `make install`: * run_magic.sh -- GUI magic (Cairo/X11) * run_magicnull.sh -- batch / no-GUI (-dnull) * run_magic_gdb.sh -- magic under gdb * run_magic_valgrind.sh -- magic under valgrind magic resolves its runtime files through a single $CAD_ROOT root ($CAD_ROOT/magic/{sys,tcl}), but in the build tree they are scattered across build/ (generated tech, .magicrc, magic.tcl, tclmagic, execs) and source/ (colormaps, dstyles, glyphs, fonts, tcl scripts). On first run each launcher self-stages ${builddir}/CAD_DIR as a symlink tree in that layout (no copies, always current) via the shared scripts/magic_run_common.sh, exports CAD_ROOT=${builddir}/CAD_DIR, and execs the right binary. This pairs with the preceding commit that made the C launchers honor CAD_ROOT. magic_stage() is idempotent and re-runs on every launch. Most staged entries are files, but the bitmaps entry links a *directory*, so it uses `ln -sfn` (--no-dereference; also accepted by BSD ln): a plain `ln -sf` would, on a second run, dereference the existing symlink-to-directory and drop the new link *inside* the target -- a magic/bitmaps/bitmaps self-loop in the source tree that trips up find/tar/cp -r. Verified: ./run_magicnull.sh self-stages (30 sys + 24 tcl symlinks) and runs -- `tech load scmos` reports 13 planes -- straight from the build dir. gitignore covers the generated scripts and the CAD_DIR tree. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-24 00:06:28 +02:00
# Generated by configure from scripts/run_magic_gdb.sh.in.
#
build: document run_magic* launchers, template WISH/TCLSH, validate the env Expand each run_magic*.sh header to state its purpose, usage, and the full set of environment overrides. Initialize every knob with ${VAR:-default} so a value inherited from the environment always wins: - CAD_ROOT is now overridable (was hardwired to $builddir/CAD_DIR); point it at a shared/installed tree to skip staging. - WISH/TCLSH default to the wish/tclsh configure detected for this build's Tcl/Tk (@WISH_EXE@/@TCLSH_EXE@, matching --with-tk/--with-tcl), so a build against a non-standard Tcl/Tk automatically uses the correct absolute paths. MAGIC_WISH (what tkcon.tcl uses for the Tk console) defaults from WISH. Add magic_check_env(): on source, sanity-check each value (directory / regular file / executable, as appropriate) and print a non-fatal stderr warning naming the offending variable and whether it came from the environment or the baked default -- to make a bad override easy to diagnose. Empty optional values (e.g. no tclsh configured) and a not-yet-created CAD_ROOT are not flagged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-24 00:49:49 +02:00
# PURPOSE
# Debug the just-built magic without `make install`. Stages ${builddir}/CAD_DIR
# (symlinks) on first run, exports CAD_ROOT, then starts gdb on the self-contained
# "magicexec". Symbols come straight from the build tree.
#
# USAGE
build: let run_magic_gdb/valgrind take tool options via a "--" separator The gdb and valgrind launchers previously passed every argument straight to magic, leaving no way to give the tool its own options. Add a "--" split (shared magic_split_args helper): arguments before "--" go to gdb/valgrind, arguments after go to magic; with no "--", all arguments go to magic (the common case). Examples: ./run_magic_gdb.sh -tui -ex run -- -dnull foo.mag ./run_magic_valgrind.sh --tool=callgrind -- foo.mag Also make the tool binary and its default options overridable from the environment: GDB/GDB_OPTS and VALGRIND/VALGRIND_OPTS (valgrind defaults to --leak-check=full --error-exitcode=0), and warn if the tool is not on PATH. Smoke-tested against a live X display: gdb runs magic to a clean exit and valgrind produces a Memcheck report; option routing verified (a bogus flag after "--" is rejected by magic, not gdb), both headless (-dnull) and GUI. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-24 01:06:27 +02:00
# ./run_magic_gdb.sh [gdb-opts...] [-- [magic-args...]]
#
# A "--" separates gdb's own options from magic's:
# ./run_magic_gdb.sh # plain interactive gdb
# ./run_magic_gdb.sh foo.mag # no "--" => all args go to magic
# ./run_magic_gdb.sh -tui -- foo.mag # gdb gets -tui, magic gets foo.mag
# ./run_magic_gdb.sh -ex run -- -dnull # gdb runs immediately; magic -dnull
# With no "--", every argument is passed to magic (the common case).
#
# For batch/no-GUI debugging point it at the null device: ... -- -dnull
build: document run_magic* launchers, template WISH/TCLSH, validate the env Expand each run_magic*.sh header to state its purpose, usage, and the full set of environment overrides. Initialize every knob with ${VAR:-default} so a value inherited from the environment always wins: - CAD_ROOT is now overridable (was hardwired to $builddir/CAD_DIR); point it at a shared/installed tree to skip staging. - WISH/TCLSH default to the wish/tclsh configure detected for this build's Tcl/Tk (@WISH_EXE@/@TCLSH_EXE@, matching --with-tk/--with-tcl), so a build against a non-standard Tcl/Tk automatically uses the correct absolute paths. MAGIC_WISH (what tkcon.tcl uses for the Tk console) defaults from WISH. Add magic_check_env(): on source, sanity-check each value (directory / regular file / executable, as appropriate) and print a non-fatal stderr warning naming the offending variable and whether it came from the environment or the baked default -- to make a bad override easy to diagnose. Empty optional values (e.g. no tclsh configured) and a not-yet-created CAD_ROOT are not flagged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-24 00:49:49 +02:00
#
# ENVIRONMENT OVERRIDES (all optional; each wins over the baked default)
build: let run_magic_gdb/valgrind take tool options via a "--" separator The gdb and valgrind launchers previously passed every argument straight to magic, leaving no way to give the tool its own options. Add a "--" split (shared magic_split_args helper): arguments before "--" go to gdb/valgrind, arguments after go to magic; with no "--", all arguments go to magic (the common case). Examples: ./run_magic_gdb.sh -tui -ex run -- -dnull foo.mag ./run_magic_valgrind.sh --tool=callgrind -- foo.mag Also make the tool binary and its default options overridable from the environment: GDB/GDB_OPTS and VALGRIND/VALGRIND_OPTS (valgrind defaults to --leak-check=full --error-exitcode=0), and warn if the tool is not on PATH. Smoke-tested against a live X display: gdb runs magic to a clean exit and valgrind produces a Memcheck report; option routing verified (a bogus flag after "--" is rejected by magic, not gdb), both headless (-dnull) and GUI. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-24 01:06:27 +02:00
# GDB debugger binary to use (default: gdb on PATH)
# GDB_OPTS default gdb options, prepended before any given on the command line
build: document run_magic* launchers, template WISH/TCLSH, validate the env Expand each run_magic*.sh header to state its purpose, usage, and the full set of environment overrides. Initialize every knob with ${VAR:-default} so a value inherited from the environment always wins: - CAD_ROOT is now overridable (was hardwired to $builddir/CAD_DIR); point it at a shared/installed tree to skip staging. - WISH/TCLSH default to the wish/tclsh configure detected for this build's Tcl/Tk (@WISH_EXE@/@TCLSH_EXE@, matching --with-tk/--with-tcl), so a build against a non-standard Tcl/Tk automatically uses the correct absolute paths. MAGIC_WISH (what tkcon.tcl uses for the Tk console) defaults from WISH. Add magic_check_env(): on source, sanity-check each value (directory / regular file / executable, as appropriate) and print a non-fatal stderr warning naming the offending variable and whether it came from the environment or the baked default -- to make a bad override easy to diagnose. Empty optional values (e.g. no tclsh configured) and a not-yet-created CAD_ROOT are not flagged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-24 00:49:49 +02:00
# CAD_ROOT reuse an alternate runtime tree instead of staging $builddir/CAD_DIR
# MAGIC_WISH wish for the Tk console (default: the configure-matched wish)
# WISH TCLSH wish/tclsh matching this build's Tcl/Tk (--with-tk / --with-tcl)
# MAGIC_BUILDDIR MAGIC_SRCDIR build/source tops (default: baked-in absolutes)
# Inherited values are sanity-checked; problems print as stderr warnings.
# See magic_run_common.sh for the authoritative list and defaults.
build: add run_magic*.sh launchers to run magic from the build tree Four configure-generated launch scripts let you run magic straight from the build directory without `make install`: * run_magic.sh -- GUI magic (Cairo/X11) * run_magicnull.sh -- batch / no-GUI (-dnull) * run_magic_gdb.sh -- magic under gdb * run_magic_valgrind.sh -- magic under valgrind magic resolves its runtime files through a single $CAD_ROOT root ($CAD_ROOT/magic/{sys,tcl}), but in the build tree they are scattered across build/ (generated tech, .magicrc, magic.tcl, tclmagic, execs) and source/ (colormaps, dstyles, glyphs, fonts, tcl scripts). On first run each launcher self-stages ${builddir}/CAD_DIR as a symlink tree in that layout (no copies, always current) via the shared scripts/magic_run_common.sh, exports CAD_ROOT=${builddir}/CAD_DIR, and execs the right binary. This pairs with the preceding commit that made the C launchers honor CAD_ROOT. magic_stage() is idempotent and re-runs on every launch. Most staged entries are files, but the bitmaps entry links a *directory*, so it uses `ln -sfn` (--no-dereference; also accepted by BSD ln): a plain `ln -sf` would, on a second run, dereference the existing symlink-to-directory and drop the new link *inside* the target -- a magic/bitmaps/bitmaps self-loop in the source tree that trips up find/tar/cp -r. Verified: ./run_magicnull.sh self-stages (30 sys + 24 tcl symlinks) and runs -- `tech load scmos` reports 13 planes -- straight from the build dir. gitignore covers the generated scripts and the CAD_DIR tree. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-24 00:06:28 +02:00
set -eu
here="$(cd "$(dirname "$0")" && pwd)"
. "$here/magic_run_common.sh"
build: let run_magic_gdb/valgrind take tool options via a "--" separator The gdb and valgrind launchers previously passed every argument straight to magic, leaving no way to give the tool its own options. Add a "--" split (shared magic_split_args helper): arguments before "--" go to gdb/valgrind, arguments after go to magic; with no "--", all arguments go to magic (the common case). Examples: ./run_magic_gdb.sh -tui -ex run -- -dnull foo.mag ./run_magic_valgrind.sh --tool=callgrind -- foo.mag Also make the tool binary and its default options overridable from the environment: GDB/GDB_OPTS and VALGRIND/VALGRIND_OPTS (valgrind defaults to --leak-check=full --error-exitcode=0), and warn if the tool is not on PATH. Smoke-tested against a live X display: gdb runs magic to a clean exit and valgrind produces a Memcheck report; option routing verified (a bogus flag after "--" is rejected by magic, not gdb), both headless (-dnull) and GUI. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-24 01:06:27 +02:00
GDB="${GDB:-gdb}"
command -v "$GDB" >/dev/null 2>&1 || magic_warn "debugger '$GDB' not found on PATH"
build: add run_magic*.sh launchers to run magic from the build tree Four configure-generated launch scripts let you run magic straight from the build directory without `make install`: * run_magic.sh -- GUI magic (Cairo/X11) * run_magicnull.sh -- batch / no-GUI (-dnull) * run_magic_gdb.sh -- magic under gdb * run_magic_valgrind.sh -- magic under valgrind magic resolves its runtime files through a single $CAD_ROOT root ($CAD_ROOT/magic/{sys,tcl}), but in the build tree they are scattered across build/ (generated tech, .magicrc, magic.tcl, tclmagic, execs) and source/ (colormaps, dstyles, glyphs, fonts, tcl scripts). On first run each launcher self-stages ${builddir}/CAD_DIR as a symlink tree in that layout (no copies, always current) via the shared scripts/magic_run_common.sh, exports CAD_ROOT=${builddir}/CAD_DIR, and execs the right binary. This pairs with the preceding commit that made the C launchers honor CAD_ROOT. magic_stage() is idempotent and re-runs on every launch. Most staged entries are files, but the bitmaps entry links a *directory*, so it uses `ln -sfn` (--no-dereference; also accepted by BSD ln): a plain `ln -sf` would, on a second run, dereference the existing symlink-to-directory and drop the new link *inside* the target -- a magic/bitmaps/bitmaps self-loop in the source tree that trips up find/tar/cp -r. Verified: ./run_magicnull.sh self-stages (30 sys + 24 tcl symlinks) and runs -- `tech load scmos` reports 13 planes -- straight from the build dir. gitignore covers the generated scripts and the CAD_DIR tree. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-24 00:06:28 +02:00
magic_require_built
magic_stage
build: let run_magic_gdb/valgrind take tool options via a "--" separator The gdb and valgrind launchers previously passed every argument straight to magic, leaving no way to give the tool its own options. Add a "--" split (shared magic_split_args helper): arguments before "--" go to gdb/valgrind, arguments after go to magic; with no "--", all arguments go to magic (the common case). Examples: ./run_magic_gdb.sh -tui -ex run -- -dnull foo.mag ./run_magic_valgrind.sh --tool=callgrind -- foo.mag Also make the tool binary and its default options overridable from the environment: GDB/GDB_OPTS and VALGRIND/VALGRIND_OPTS (valgrind defaults to --leak-check=full --error-exitcode=0), and warn if the tool is not on PATH. Smoke-tested against a live X display: gdb runs magic to a clean exit and valgrind produces a Memcheck report; option routing verified (a bogus flag after "--" is rejected by magic, not gdb), both headless (-dnull) and GUI. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-24 01:06:27 +02:00
magic_split_args "$@"
build: add run_magic*.sh launchers to run magic from the build tree Four configure-generated launch scripts let you run magic straight from the build directory without `make install`: * run_magic.sh -- GUI magic (Cairo/X11) * run_magicnull.sh -- batch / no-GUI (-dnull) * run_magic_gdb.sh -- magic under gdb * run_magic_valgrind.sh -- magic under valgrind magic resolves its runtime files through a single $CAD_ROOT root ($CAD_ROOT/magic/{sys,tcl}), but in the build tree they are scattered across build/ (generated tech, .magicrc, magic.tcl, tclmagic, execs) and source/ (colormaps, dstyles, glyphs, fonts, tcl scripts). On first run each launcher self-stages ${builddir}/CAD_DIR as a symlink tree in that layout (no copies, always current) via the shared scripts/magic_run_common.sh, exports CAD_ROOT=${builddir}/CAD_DIR, and execs the right binary. This pairs with the preceding commit that made the C launchers honor CAD_ROOT. magic_stage() is idempotent and re-runs on every launch. Most staged entries are files, but the bitmaps entry links a *directory*, so it uses `ln -sfn` (--no-dereference; also accepted by BSD ln): a plain `ln -sf` would, on a second run, dereference the existing symlink-to-directory and drop the new link *inside* the target -- a magic/bitmaps/bitmaps self-loop in the source tree that trips up find/tar/cp -r. Verified: ./run_magicnull.sh self-stages (30 sys + 24 tcl symlinks) and runs -- `tech load scmos` reports 13 planes -- straight from the build dir. gitignore covers the generated scripts and the CAD_DIR tree. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-24 00:06:28 +02:00
build: let run_magic_gdb/valgrind take tool options via a "--" separator The gdb and valgrind launchers previously passed every argument straight to magic, leaving no way to give the tool its own options. Add a "--" split (shared magic_split_args helper): arguments before "--" go to gdb/valgrind, arguments after go to magic; with no "--", all arguments go to magic (the common case). Examples: ./run_magic_gdb.sh -tui -ex run -- -dnull foo.mag ./run_magic_valgrind.sh --tool=callgrind -- foo.mag Also make the tool binary and its default options overridable from the environment: GDB/GDB_OPTS and VALGRIND/VALGRIND_OPTS (valgrind defaults to --leak-check=full --error-exitcode=0), and warn if the tool is not on PATH. Smoke-tested against a live X display: gdb runs magic to a clean exit and valgrind produces a Memcheck report; option routing verified (a bogus flag after "--" is rejected by magic, not gdb), both headless (-dnull) and GUI. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-07-24 01:06:27 +02:00
# gdb <opts> --args magicexec -- <magic-args>
exec "$GDB" ${GDB_OPTS-} \
${MAGIC_TOOL_OPTS[@]+"${MAGIC_TOOL_OPTS[@]}"} \
--args "$MAGIC_TCL/magicexec" -- \
${MAGIC_ARGS[@]+"${MAGIC_ARGS[@]}"}