libsyd 3.6.0

Rust-based C library for syd interaction via /dev/syd
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
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

# libsyd: syd /dev/syd interface implementation
# Makefile: Makefile for libsyd
#
# Copyright (c) 2023, 2024 Ali Polatel <alip@chesswob.org>
#
# SPDX-License-Identifier: GPL-3.0

# Package name and version
PACKAGE= syd
VERSION= 3.0.0-alpha.6

# Build profile
PROFILE?= release

# Installation directories
PREFIX = /usr/local
LIB_DIR = $(PREFIX)/lib
MAN_DIR = $(PREFIX)/share/man/man3
INCLUDE_DIR = $(PREFIX)/include

# Cargo and Installer
CARGO?= cargo
INSTALL?= install

# Cargo flags
CARGOFLAGS?= -j$(shell nproc)

# Perl
PERL?= perl
PLSITE?= $(shell $(PERL) -MConfig -e 'print $$Config{installsitelib}')
MANDOC?= mandoc

# Python
PYTHON?= python3
PYSITE?= $(shell $(PYTHON) -c "import site; print(site.getsitepackages()[-1])")

# Source files
SRC=\
    src/lib.rs \
    Cargo.toml

# Library Names
ifeq ($(PROFILE), debug)
	LIB_STATIC= ./target/debug/deps/lib$(PACKAGE).a
	LIB_SHARED= ./target/debug/deps/lib$(PACKAGE).so
else
	LIB_STATIC= ./target/release/deps/lib$(PACKAGE).a
	LIB_SHARED= ./target/release/deps/lib$(PACKAGE).so
endif

# Default target
all: $(LIB_SHARED) $(LIB_STATIC) syd.h

# Publish targets
PUTFLAGS= -c $(HOME)/.s3cfg.site
PUTFLAGS_HTML= $(PUTFLAGS) \
	       --no-guess-mime-type \
	       --default-mime-type=text/html

publish: upload
	$(CARGO) publish --no-verify
upload: doc godoc pldoc pydoc rbdoc
	s3cmd put $(PUTFLAGS_HTML) -P doc/syd/*.html s3://libsyd.exherbolinux.org/
	s3cmd put $(PUTFLAGS_HTML) -P doc/auto/pl.html s3://plsyd.exherbolinux.org/index.html
	s3cmd put $(PUTFLAGS_HTML) -P doc/auto/syd.html s3://pysyd.exherbolinux.org/index.html
	s3cmd put $(PUTFLAGS) -P \
		--no-guess-mime-type \
		--default-mime-type=text/css \
		doc/auto/go/_/css/main.css s3://gosyd.exherbolinux.org/main.css
	s3cmd put $(PUTFLAGS) -P \
		--no-guess-mime-type \
		--default-mime-type=text/javascript \
		doc/auto/go/_/js/permalink.js s3://gosyd.exherbolinux.org/permalink.jss
	sed \
		-e 's|../../../../../_/css/main.css|./main.css|' \
		-e 's|../../../../../_/js/permalink.js|./permalink.js|' \
		< 'doc/auto/go/git.sr.ht/~alip/syd/lib/src/index.html' \
		> 'doc/auto/go.html'
	s3cmd put $(PUTFLAGS_HTML) -P doc/auto/go.html s3://gosyd.exherbolinux.org/index.html
	s3cmd put $(PUTFLAGS_HTML) -P doc/auto/ruby/index.html s3://rbsyd.exherbolinux.org/index.html

# Documentation targets
doc: syd.h
	gyosu -o doc/syd syd.h
godoc: src/syd.go
	mkdir -m700 -p doc/auto
	rm -rf doc/auto/go
	bash -c "pushd src; exec doc2go ./..."
	mv src/_site doc/auto/go
pldoc: src/syd.pm
	mkdir -m700 -p doc/auto
	bash -c "pushd src && pod2man -u --errors=none syd.pm > ../doc/auto/syd.pm.3"
	$(MANDOC) -Thtml < doc/auto/syd.pm.3 > doc/auto/pl.html
pydoc: $(LIB_SHARED) src/syd.py
	env LD_LIBRARY_PATH=./target/release pdoc -d markdown --output-directory doc/auto src/syd.py
rbdoc: src/syd.rb
	mkdir -m700 -p doc/auto
	rm -rf doc/auto/ruby
	bash -c 'pushd src && yard doc --title "rbsyd: Ruby FFI bindings of libsyd, the syd API C Library" --hide-api private --one-file ./syd.rb'
	mv src/doc doc/auto/ruby

# QA targets
fmt:
	$(CARGO) fmt || true
	black src/syd.py || true
	perltidy -b src/syd.pm src/syd.pl || true
	astyle examples/c/*.c || true
	sh -c "cd src; exec go fmt -x ." || true
	sh -c "cd examples/go; exec go fmt -x ." || true
	rubocop --config ./.rubocop.yml --autocorrect-all src/*.rb examples/ruby/*.rb || true
lint:
	$(CARGO) deny check
	$(CARGO) acl -n || true
	$(CARGO) clippy $(CARGOFLAGS)
	pylint src/syd.py || true
	rubocop --config ./.rubocop.yml --autocorrect-all src/syd.rb || true

# Install and Uninstall Targets
install:
	$(INSTALL) -d $(LIB_DIR)
	$(INSTALL) -m 644 $(LIB_STATIC) $(LIB_DIR)
	$(INSTALL) -m 755 $(LIB_SHARED) $(LIB_DIR)
	$(INSTALL) -d $(INCLUDE_DIR)
	$(INSTALL) -m 644 syd.h $(INCLUDE_DIR)
	$(INSTALL) -d $(MAN_DIR)
	$(INSTALL) -m 644 doc/man/man3/syd.h.3 $(MAN_DIR)
	$(INSTALL) -d $(PLSITE)
	$(INSTALL) -m 755 src/syd.pm $(PLSITE)
	$(INSTALL) -d $(PYSITE)
	$(INSTALL) -m 755 src/syd.py $(PYSITE)
uninstall:
	rm -f $(LIB_DIR)/libsyd.a
	rm -f $(LIB_DIR)/libsyd.so
	rm -f $(INCLUDE_DIR)/syd.h
	rm -f $(MAN_DIR)/syd.h.3
	rm -f $(PLSITE)/syd.pm
	rm -f $(PYSITE)/syd.py

# Check target
check: test

test: $(LIB_SHARED)
	$(CARGO) test --profile=$(PROFILE) $(CARGOFLAGS)

# Clean Target
clean:
	$(CARGO) clean

syd.h: $(SRC) cbindgen.toml
	cbindgen -c cbindgen.toml -o syd.h .
$(LIB_SHARED): $(SRC)
	$(CARGO) build --profile=$(PROFILE) $(CARGOFLAGS)
$(LIB_STATIC): $(SRC)
	$(CARGO) build --profile=$(PROFILE) $(CARGOFLAGS)

# Phony Targets
.PHONY: all clean check doc godoc pldoc pydoc rbdoc test install uninstall publish fmt lint