summaryrefslogtreecommitdiff
path: root/scripts/build-emacs.sh
blob: 6750adceb58c72ecec64450e4f48e0ea753c2250 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
#!/usr/bin/env bash
# Craig Jennings <c@cjennings.net>
# Build & install Emacs from source
# safe, user-local, fast, versioned.

set -Eeuo pipefail
IFS=$'\n\t'

#  ------------------------ Config (overwrite via ENV) -----------------------

SRC_DIR="${SRC_DIR:-$HOME/code/emacs-src}"
EMACS_REPO="${EMACS_REPO:-https://git.savannah.gnu.org/git/emacs.git}"
CHECKOUT_REF="${CHECKOUT_REF:-emacs-30.2}"
PREFIX_BASE="${PREFIX_BASE:-$HOME/.local/src/emacs}"

# Add DEBUG_BUILD flag
DEBUG_BUILD="${DEBUG_BUILD:-1}"
if [[ "$DEBUG_BUILD" == "1" ]]; then
	PREFIX="${PREFIX:-$PREFIX_BASE/${CHECKOUT_REF}-debug}"
	CFLAGS="${CFLAGS:--O0 -g}"
	ENABLE_CHECKING="${ENABLE_CHECKING:-yes,glyphs}"
	ENABLE_NATIVE="${ENABLE_NATIVE:-0}"  # Disable native comp for debug
else
	PREFIX="${PREFIX:-$PREFIX_BASE/${CHECKOUT_REF}}"
	CFLAGS="${CFLAGS:--O2 -g}"
	ENABLE_CHECKING="${ENABLE_CHECKING:-no}"
	ENABLE_NATIVE="${ENABLE_NATIVE:-1}"
fi

LOG_DIR="${LOG_DIR:-$HOME/}"
WITH_PGTK="${WITH_PGTK:-0}"
JOBS="${JOBS:-auto}"
EXTRA_CONFIG="${EXTRA_CONFIG:-}"

#  --------------------------------- Preflight ---------------------------------

umask 022
mkdir -p "$LOG_DIR" "$PREFIX_BASE" "$HOME/.local/bin"
: "${LOGFILE:=$LOG_DIR/emacs-build-$(date +%Y%m%d-%H%M%S)-${CHECKOUT_REF}${DEBUG_BUILD:+-debug}.log}"

say() { printf '>>> %s\n' "$*" | tee -a "$LOGFILE" ; }
run() {
	say "+ $*"
	if ! eval "$@" >>"$LOGFILE" 2>&1; then
		echo "ERROR: Command failed: $*" >&2
		echo "Last 20 lines of output:" >&2
		tail -n 20 "$LOGFILE" >&2
		return 1
	fi
}

on_err(){
	ec=$?
	echo "ERROR [$ec] - Full log at: $LOGFILE" >&2
	echo "Last 100 lines of log:" >&2
	tail -n 100 "$LOGFILE" >&2 || true
	exit "$ec"
}

trap on_err ERR

#  -------------------------- Arch Linux Dependencies --------------------------

if [[ -r /etc/os-release ]]; then
  . /etc/os-release
fi

if [[ "${ID:-}" == "arch" || "${ID_LIKE:-}" == *arch* ]]; then
  say "Arch Linux detected; checking required build/runtime packages"

  # Base packages needed for the requested configure flags
  pkgs=(jansson tree-sitter imagemagick mailutils harfbuzz cairo gnutls libxml2 texinfo gtk3)

  # Only if native-compilation is enabled
  if [[ "${ENABLE_NATIVE:-1}" == "1" ]]; then
	pkgs+=(libgccjit)
  fi

  # List packages that are not installed
  missing="$(pacman -T "${pkgs[@]}" || true)"

  if [[ -z "$missing" ]]; then
	say "All required packages are already installed."
  else
	say "Missing packages: $missing"
	if command -v sudo >/dev/null 2>&1 && sudo -n true 2>/dev/null; then
	  run "sudo -n pacman -Sy --needed --noconfirm $missing"
	else
	  say "sudo (passwordless) not available; please install missing packages manually:"
	  echo "  sudo pacman -Sy --needed $missing"
	  exit 70
	fi
  fi
else
  say "Non-Arch system detected; skipping Arch-specific dependency check."
fi

#  ----------------------------- Clone And Update ----------------------------

if [[ -d "$SRC_DIR/.git" ]]; then
  run "git -C '$SRC_DIR' fetch --tags --prune"
else
  mkdir -p "$(dirname "$SRC_DIR")"
  run "git clone --origin origin '$EMACS_REPO' '$SRC_DIR'"
fi

run "git -C '$SRC_DIR' reset --hard HEAD"
run "git -C '$SRC_DIR' clean -fdx"
run "git -C '$SRC_DIR' checkout -f '$CHECKOUT_REF'"
run "git -C '$SRC_DIR' submodule update --init --recursive || true"

#  ---------------------------------- Autogen ----------------------------------

if [[ -x "$SRC_DIR/autogen.sh" ]]; then
  run "cd '$SRC_DIR' && ./autogen.sh"
fi

#  ------------------------------ Configure Flags ------------------------------

conf_flags=(
  "--prefix=${PREFIX}"
  "--with-json"
  "--with-modules"
)

# Add debug-specific flags
if [[ "$DEBUG_BUILD" == "1" ]]; then
  say "Building DEBUG version with symbols and checking"
  conf_flags+=(
	"--enable-checking=${ENABLE_CHECKING}"
	"--enable-check-lisp-object-type"
	# Note the quotes around the entire CFLAGS assignment:
	"CFLAGS=${CFLAGS}"  # This keeps it as a single argument
  )
fi

# Wayland/X choice
if [[ "$WITH_PGTK" == "auto" ]]; then
  if [[ -n "${WAYLAND_DISPLAY:-}" ]]; then WITH_PGTK="yes"; else WITH_PGTK="no"; fi
fi
if [[ "$WITH_PGTK" == "yes" ]]; then
  conf_flags+=("--with-pgtk")
else
  conf_flags+=("--with-x-toolkit=gtk3")
fi

# Native-compilation
if [[ "$ENABLE_NATIVE" == "1" ]]; then
  conf_flags+=("--with-native-compilation=yes")
else
  conf_flags+=("--with-native-compilation=no")
fi

# Useful extras
conf_flags+=(
  "--with-cairo"
  "--with-harfbuzz"
  "--with-tree-sitter"
  "--with-imagemagick"
  "--with-mailutils"
)

# Optional extra flags from env
if [[ -n "$EXTRA_CONFIG" ]]; then
  conf_flags+=($EXTRA_CONFIG)
fi

#  ----------------------------- Build And Install -----------------------------

mkdir -p "$PREFIX"

# Temporarily change IFS to space for configure argument expansion
old_ifs="$IFS"
IFS=' '
cd "$SRC_DIR"
"./configure" "${conf_flags[@]}"
IFS="$old_ifs"

if [[ "$JOBS" == "auto" ]]; then
  if command -v nproc >/dev/null 2>&1; then JOBS=$(nproc); else JOBS=4; fi
fi
run "cd '$SRC_DIR' && make -j$JOBS"

# Build documentation (info files)
say "...building info files"
(
  cd "$SRC_DIR"
  run "make info"
)

run "cd '$SRC_DIR' && make install"
run "cd '$SRC_DIR' && make install-info"

#  --------------------------------- Symlinks --------------------------------

if [[ "$DEBUG_BUILD" == "1" ]]; then
	run "ln -sfn '$PREFIX' '$PREFIX_BASE/emacs-debug'"
	# Create debug-specific symlinks
	for exe in emacs emacsclient; do
		target="$PREFIX/bin/$exe"
		link="$HOME/.local/bin/${exe}-debug"
		if [[ -x "$target" ]]; then
			run "rm -f '$link'"
			run "ln -s '$target' '$link'"
		fi
	done
	say "Debug build available as 'emacs-debug' and 'emacsclient-debug'"
else
	run "ln -sfn '$PREFIX' '$PREFIX_BASE/emacs-current'"
	for exe in emacs emacsclient; do
		target="$PREFIX/bin/$exe"
		link="$HOME/.local/bin/$exe"
		if [[ -x "$target" ]]; then
			run "rm -f '$link'"
			run "ln -s '$target' '$link'"
		fi
	done
fi

#  ---------------------------------- Wrap Up ----------------------------------

command -v emacs >/dev/null && emacs --version | head -n1 || true
command -v emacsclient >/dev/null && emacsclient --version | head -n1 || true

#  ----------------------------- Show Build Features ----------------------------

say "Launching Emacs to display version and build features..."
"$HOME/.local/bin/emacs" -Q --batch --eval '
(progn
  (princ (format "Emacs version: %s\n" emacs-version))
  (princ (format "Build configuration:\n"))
  (princ (format "  Native compilation: %s\n"
				 (if (and (fboundp (quote native-comp-available-p))
						  (native-comp-available-p))
					 "yes" "no")))
  (princ (format "  PGTK: %s\n" (if (featurep (quote pgtk)) "yes" "no")))
  (princ (format "  Tree-sitter: %s\n"
				 (if (fboundp (quote treesit-available-p)) "yes" "no")))
  (princ (format "  JSON: %s\n" (if (fboundp (quote json-parse-string)) "yes" "no")))
  (princ (format "  ImageMagick: %s\n" (if (image-type-available-p (quote imagemagick)) "yes" "no")))
  (princ (format "  Cairo: %s\n" (if (featurep (quote cairo)) "yes" "no")))
  (princ (format "\nFull system configuration:\n%s\n" system-configuration))
  (princ (format "\nConfigured features:\n%s\n" system-configuration-features)))
' 2>&1 | tee -a "$LOGFILE"

echo "Done. See $LOGFILE"