Commit 25a3114

nsxiv25a3114

Rework the build system (#19)

* Added simple configure script

Added simple script to autodetect if optional dependencies are installed
and enable/disable them as needed. Note this solution uses the compiler
directly instead of an external program like pkgconfig so it doesn't
require any extra dependencies. It is intended to work with any
arbitrary compiler; it has been tested with tcc and gcc.

There are some "breaking" changes hidden here
- HAVE_GIFLIB was renamed to HAVE_LIBGIF to match HAVE_LIBEXIF
- Simply typing `make` will no longer try to build with optional
  dependencies

* use implicit RM variable

* General clean-up in configure

- Use printf instead of echo
- Format style

* honor env PREFIX, use LDLIBS

* Revert "General clean-up in configure"

This reverts commit 8683c179dbf273a330f9a224a4d481a7bea42c5f.

* honor env LDFLAGS if set

* Don't set OPTIONAL_LIBS in configure

* make OBJ all caps

* follow suckless style build system

- remove configure script.
- HAVE_LIBGIF and HAVE_LIBEXIF defaults back to 1
- unload several varibales onto config.mk
- make version all-caps
- add -O2 optimization
- use CPPFLAGS for includes and defines

* Revert "follow suckless style build system"

This reverts commit 8bf75b1f68d72df349edba8d998d4659dd956dd8.

* Generate config.mk from make

* Inlined configure in Makefile

* update docs

* cleanups

- changes to config.mk should trigger a rebuild
- remove potentially confusing variables form Makefile

* Use install instead of mkdir/cp/chmod when sensible

* fixup! Inlined configure in Makefile

* Don't generate config.mk on rm -f *.o sxiv

* update docs and cleanups

- make config.mk silent
- mention editing config.mk in README

* fallback to 0 if user edits config.mk in unexpected way

* add comment on config.mk

* remove invalid comment

configure script is removed

* slight restructure

- make version all caps
- restructure variables that users may want to edit to top
- use CPPFLAGS for defines
- add some comments
- remove needless echos since we have verbose output now

* add echos back

Author: TAAPArthur
Date: 2021-09-14 07:42 -0700
Committer: Berke Kocaoğlu · 2021-09-16 22:55 +0300
Parent: cca7834
Commit: 25a31147093e249be997da9b42da6901496fdf52

+66 −48

4 files changed

Browse files Patch

−Context 3+

M .gitignore +1 −0
M Makefile +50 −42
M README.md +11 −2
M image.c +4 −4

M .gitignore View

M Makefile View

M README.md View

M image.c View

		@@ -1,82 +1,90 @@
1		−	version = 26
	1	+	# Include configure options
	2	+	ifneq (clean,$(filter clean,$(MAKECMDGOALS)))
	3	+	-include config.mk
	4	+	endif
2	5
3		−	srcdir = .
4		−	VPATH = $(srcdir)
	6	+	# sxiv version
	7	+	VERSION = 26
5	8
6		−	PREFIX = /usr/local
	9	+	# PREFIX for install
	10	+	PREFIX ?= /usr/local
7	11		MANPREFIX = $(PREFIX)/share/man
8	12
9	13		# autoreload backend: inotify/nop
10	14		AUTORELOAD = inotify
11	15
12		−	# enable features requiring giflib (-lgif)
13		−	HAVE_GIFLIB = 1
14		−
15		−	# enable features requiring libexif (-lexif)
16		−	HAVE_LIBEXIF = 1
17		−
18		−	cflags = -std=c99 -Wall -pedantic $(CFLAGS)
19		−	cppflags = -I. $(CPPFLAGS) -D_XOPEN_SOURCE=700 \
20		−	-DHAVE_GIFLIB=$(HAVE_GIFLIB) -DHAVE_LIBEXIF=$(HAVE_LIBEXIF) \
	16	+	# CFLAGS, any optimization flags goes here
	17	+	CFLAGS ?= -std=c99 -Wall -pedantic
	18	+
	19	+	ifeq ($(HAVE_LIBEXIF), 1)
	20	+	OPTIONAL_LIBS += -lexif
	21	+	else
	22	+	HAVE_LIBEXIF = 0
	23	+	endif
	24	+	ifeq ($(HAVE_LIBGIF), 1)
	25	+	OPTIONAL_LIBS += -lgif
	26	+	else
	27	+	HAVE_LIBGIF = 0
	28	+	endif
	29	+
	30	+	CPPFLAGS = -D_XOPEN_SOURCE=700 \
	31	+	-DHAVE_LIBGIF=$(HAVE_LIBGIF) -DHAVE_LIBEXIF=$(HAVE_LIBEXIF) \
21	32		-I/usr/include/freetype2 -I$(PREFIX)/include/freetype2
22	33
23		−	lib_exif_0 =
24		−	lib_exif_1 = -lexif
25		−	lib_gif_0 =
26		−	lib_gif_1 = -lgif
27		−	ldlibs = $(LDLIBS) -lImlib2 -lX11 -lXft -lfontconfig \
28		−	$(lib_exif_$(HAVE_LIBEXIF)) $(lib_gif_$(HAVE_GIFLIB))
	34	+	LDLIBS = -lImlib2 -lX11 -lXft -lfontconfig $(OPTIONAL_LIBS)
29	35
30		−	objs = autoreload_$(AUTORELOAD).o commands.o image.o main.o options.o \
	36	+	OBJS = autoreload_$(AUTORELOAD).o commands.o image.o main.o options.o \
31	37		thumbs.o util.o window.o
32	38
33		−	all: sxiv
34		−
35	39		.PHONY: all clean install uninstall
36	40		.SUFFIXES:
37	41		.SUFFIXES: .c .o
38		−	$(V).SILENT:
39	42
40		−	sxiv: $(objs)
	43	+	all: sxiv
	44	+
	45	+	sxiv: $(OBJS)
41	46		@echo "LINK $@"
42		−	$(CC) $(LDFLAGS) -o $@ $(objs) $(ldlibs)
	47	+	$(CC) $(LDFLAGS) -o $@ $^ $(LDLIBS)
43	48
44		−	$(objs): Makefile sxiv.h commands.lst config.h
	49	+	.c.o:
	50	+	@echo "CC $@"
	51	+	$(CC) $(CFLAGS) $(CPPFLAGS) -c -o $@ $<
	52	+
	53	+	$(OBJS): Makefile sxiv.h commands.lst config.h config.mk
45	54		options.o: version.h
46	55		window.o: icon/data.h
47	56
48		−	.c.o:
49		−	@echo "CC $@"
50		−	$(CC) $(cflags) $(cppflags) -c -o $@ $<
	57	+	config.mk:
	58	+	@echo "GEN $@"
	59	+	@echo "# 0 = disable, 1 = enable" > config.mk
	60	+	@for lib in exif gif; do \
	61	+	if echo "int main(){}" \| $(CC) "-l$$lib" -o /dev/null -x c - 2>/dev/null ; then \
	62	+	echo "HAVE_LIB$$lib=1" \| tr '[:lower:]' '[:upper:]' >> config.mk ; \
	63	+	fi \
	64	+	done
51	65
52	66		config.h:
53	67		@echo "GEN $@"
54		−	cp $(srcdir)/config.def.h $@
	68	+	cp config.def.h $@
55	69
56	70		version.h: Makefile .git/index
57	71		@echo "GEN $@"
58		−	v="$$(cd $(srcdir); git describe 2>/dev/null)"; \
59		−	echo "#define VERSION \"$${v:-$(version)}\"" >$@
60		−
61		−	.git/index:
	72	+	v="$$(git describe 2>/dev/null)"; \
	73	+	echo "#define VERSION \"$${v:-$(VERSION)}\"" >$@
62	74
63	75		clean:
64		−	rm -f *.o sxiv
	76	+	$(RM) *.o sxiv
65	77
66	78		install: all
67	79		@echo "INSTALL bin/sxiv"
68		−	mkdir -p $(DESTDIR)$(PREFIX)/bin
69		−	cp sxiv $(DESTDIR)$(PREFIX)/bin/
70		−	chmod 755 $(DESTDIR)$(PREFIX)/bin/sxiv
	80	+	install -Dt $(DESTDIR)$(PREFIX)/bin sxiv
71	81		@echo "INSTALL sxiv.1"
72	82		mkdir -p $(DESTDIR)$(MANPREFIX)/man1
73		−	sed "s!PREFIX!$(PREFIX)!g; s!VERSION!$(version)!g" sxiv.1 \
	83	+	sed "s!PREFIX!$(PREFIX)!g; s!VERSION!$(VERSION)!g" sxiv.1 \
74	84		>$(DESTDIR)$(MANPREFIX)/man1/sxiv.1
75	85		chmod 644 $(DESTDIR)$(MANPREFIX)/man1/sxiv.1
76	86		@echo "INSTALL share/sxiv/"
77		−	mkdir -p $(DESTDIR)$(PREFIX)/share/sxiv/exec
78		−	cp exec/* $(DESTDIR)$(PREFIX)/share/sxiv/exec/
79		−	chmod 755 $(DESTDIR)$(PREFIX)/share/sxiv/exec/*
	87	+	install -Dt $(DESTDIR)$(PREFIX)/share/sxiv/exec exec/*
80	88
81	89		uninstall:
82	90		@echo "REMOVE bin/sxiv"

		@@ -42,8 +42,8 @@ sxiv requires the following software to be installed:
42	42		* Xft
43	43		* freetype2
44	44		* fontconfig
45		−	* giflib (optional, disabled with `HAVE_GIFLIB=0`)
46		−	* libexif (optional, disabled with `HAVE_LIBEXIF=0`)
	45	+	* giflib (optional, automatically enabled if installed)
	46	+	* libexif (optional, automatically enabled if installed)
47	47
48	48		Please make sure to install the corresponding development packages in case that
49	49		you want to build sxiv on a distribution with separate runtime and development
		@@ -62,6 +62,15 @@ Please note, that the latter one requires root privileges.
62	62		By default, sxiv is installed using the prefix "/usr/local", so the full path
63	63		of the executable will be "/usr/local/bin/sxiv".
64	64
	65	+	Running make will automatically detect if libexif and libgif are available and
	66	+	enable them if so. CLI arguments will override any automatic detection.
	67	+	For example:
	68	+
	69	+	$ make HAVE_LIBGIF=0
	70	+
	71	+	will always disable libgif.
	72	+	Alternatively, they can be disabled via editing `config.mk`.
	73	+
65	74		You can install sxiv into a directory of your choice by changing the second
66	75		command to:
67	76

		@@ -31,7 +31,7 @@
31	31		#include <libexif/exif-data.h>
32	32		#endif
33	33
34		−	#if HAVE_GIFLIB
	34	+	#if HAVE_LIBGIF
35	35		#include <gif_lib.h>
36	36		enum { DEF_GIF_DELAY = 75 };
37	37		#endif
		@@ -115,7 +115,7 @@ void exif_auto_orientate(const fileinfo_t *file)
115	115		}
116	116		#endif
117	117
118		−	#if HAVE_GIFLIB
	118	+	#if HAVE_LIBGIF
119	119		bool img_load_gif(img_t img, const fileinfo_t file)
120	120		{
121	121		GifFileType *gif;
		@@ -295,7 +295,7 @@ bool img_load_gif(img_t img, const fileinfo_t file)
295	295
296	296		return !err;
297	297		}
298		−	#endif /* HAVE_GIFLIB */
	298	+	#endif /* HAVE_LIBGIF */
299	299
300	300		Imlib_Image img_open(const fileinfo_t *file)
301	301		{
		@@ -333,7 +333,7 @@ bool img_load(img_t img, const fileinfo_t file)
333	333		#endif
334	334
335	335		if ((fmt = imlib_image_format()) != NULL) {
336		−	#if HAVE_GIFLIB
	336	+	#if HAVE_LIBGIF
337	337		if (STREQ(fmt, "gif"))
338	338		img_load_gif(img, file);
339	339		#endif

nsxiv/25a3114

Rework the build system (#19)

nsxiv25a3114