beachcomber 0.3.1

A centralized daemon that caches shell state (git, battery, hostname, etc.) so every consumer reads from one fast cache instead of independently forking shells
Documentation 
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

# Makefile for libbeachcomber C SDK
#
# Targets:
#   make          — build shared + static libraries
#   make test     — build and run the test suite
#   make install  — install headers and libraries to $(PREFIX)
#   make clean    — remove build artefacts

# ---------------------------------------------------------------------------
# Toolchain
# ---------------------------------------------------------------------------

CC      ?= cc
AR      ?= ar
INSTALL ?= install

CFLAGS  ?= -O2
CFLAGS  += -Wall -Wextra -Wpedantic -std=c99
CFLAGS  += -D_POSIX_C_SOURCE=200809L

VERSION ?= 0.3.1

# ---------------------------------------------------------------------------
# Platform detection
# ---------------------------------------------------------------------------

UNAME := $(shell uname -s)

ifeq ($(UNAME), Darwin)
    SHARED_LIB  := libbeachcomber.dylib
    SHARED_FLAGS := -dynamiclib -install_name @rpath/$(SHARED_LIB)
else
    SHARED_LIB  := libbeachcomber.so
    SHARED_FLAGS := -shared -Wl,-soname,$(SHARED_LIB)
    # Position-independent code required for shared libs on Linux
    CFLAGS      += -fPIC
endif

STATIC_LIB := libbeachcomber.a

# ---------------------------------------------------------------------------
# Sources
# ---------------------------------------------------------------------------

LIB_SRCS := beachcomber.c json.c
LIB_OBJS := $(LIB_SRCS:.c=.o)

TEST_SRC := test_beachcomber.c
TEST_BIN := test_beachcomber

# ---------------------------------------------------------------------------
# Default target: both libraries
# ---------------------------------------------------------------------------

.PHONY: all
all: $(SHARED_LIB) $(STATIC_LIB)

# ---------------------------------------------------------------------------
# Shared library
# ---------------------------------------------------------------------------

$(SHARED_LIB): $(LIB_OBJS)
	$(CC) $(SHARED_FLAGS) -o $@ $^

# ---------------------------------------------------------------------------
# Static library
# ---------------------------------------------------------------------------

$(STATIC_LIB): $(LIB_OBJS)
	$(AR) rcs $@ $^

# ---------------------------------------------------------------------------
# Object files
# ---------------------------------------------------------------------------

%.o: %.c
	$(CC) $(CFLAGS) -c -o $@ $<

# Explicit dependencies
beachcomber.o: beachcomber.c beachcomber.h json.h
json.o:        json.c json.h

# ---------------------------------------------------------------------------
# Test binary
# ---------------------------------------------------------------------------

# Tests link the library sources directly to avoid needing the shared lib
# in the dynamic linker search path during development.
$(TEST_BIN): $(TEST_SRC) $(LIB_SRCS) beachcomber.h json.h
	$(CC) $(CFLAGS) -o $@ $(TEST_SRC) $(LIB_SRCS) -lpthread

.PHONY: test
test: $(TEST_BIN)
	./$(TEST_BIN)

# ---------------------------------------------------------------------------
# Install
# ---------------------------------------------------------------------------

PREFIX      ?= /usr/local
INCDIR      := $(PREFIX)/include
LIBDIR      := $(PREFIX)/lib
PKGCONFIGDIR := $(LIBDIR)/pkgconfig

libbeachcomber.pc: libbeachcomber.pc.in
	sed -e 's|@PREFIX@|$(PREFIX)|g' -e 's|@VERSION@|$(VERSION)|g' $< > $@

.PHONY: install
install: all libbeachcomber.pc
	$(INSTALL) -d $(DESTDIR)$(INCDIR)
	$(INSTALL) -d $(DESTDIR)$(LIBDIR)
	$(INSTALL) -d $(DESTDIR)$(PKGCONFIGDIR)
	$(INSTALL) -m 644 beachcomber.h $(DESTDIR)$(INCDIR)/beachcomber.h
	$(INSTALL) -m 644 json.h $(DESTDIR)$(INCDIR)/json.h
	$(INSTALL) -m 755 $(SHARED_LIB) $(DESTDIR)$(LIBDIR)/$(SHARED_LIB)
	$(INSTALL) -m 644 $(STATIC_LIB) $(DESTDIR)$(LIBDIR)/$(STATIC_LIB)
	$(INSTALL) -m 644 libbeachcomber.pc $(DESTDIR)$(PKGCONFIGDIR)/libbeachcomber.pc

# ---------------------------------------------------------------------------
# Clean
# ---------------------------------------------------------------------------

.PHONY: clean
clean:
	rm -f $(LIB_OBJS) $(SHARED_LIB) $(STATIC_LIB) $(TEST_BIN) libbeachcomber.pc