-
Notifications
You must be signed in to change notification settings - Fork 1
/
Makefile
225 lines (197 loc) · 5.47 KB
/
Makefile
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
PROJECT=yace
AUX_PATH=auxi
ifeq ($(PLATFORM_ID),Windows)
else
PLATFORM_ID = $$( uname -s )
endif
PLATFORM = $$( \
case $(PLATFORM_ID) in \
( Linux | FreeBSD | OpenBSD | NetBSD | Windows | Darwin ) echo $(PLATFORM_ID) ;; \
( * ) echo Unrecognized ;; \
esac)
define default-help
# invoke: 'make uninstall', 'make install'
endef
.PHONY: default
default: help
define all-help
# Do all: clean uninstall build install
endef
.PHONY: all
all: deps uninstall clean build install emit docs
define deps-help
# Install dependencies; this will install deps. via PyPI/pipx and system package-manager
#
# This assumes that you are running as a 'sudo' capable user on Ubuntu/Debian
endef
.PHONY: deps
deps:
if [ "${PLATFORM_ID}" == "Darwin" ]; then ./$(AUX_PATH)/pkgs/macos.sh; else sudo ./$(AUX_PATH)/pkgs/ubuntu.sh; fi
./$(AUX_PATH)/pkgs/python.sh
define docker-help
# drop into a docker instance with the repository bind-mounted at /tmp/yace
endef
.PHONY: docker
docker:
@echo "## ${PROJECT}: docker"
@docker run -it -w /tmp/${PROJECT} --mount type=bind,source="$(shell pwd)",target=/tmp/${PROJECT} debian:bookworm bash
@echo "## ${PROJECT}: docker [DONE]"
define build-help
# Build the package (source distribution package)
endef
.PHONY: build
build:
@echo "## ${PROJECT}: make build-sdist"
@python3 setup.py sdist
@echo "## ${PROJECT}: make build-sdist [DONE]"
define install-help
# install using pipx
endef
.PHONY: install
install:
@echo "## ${PROJECT}: make install"
@pipx install dist/*.tar.gz
@echo "## ${PROJECT}: make install [DONE]"
define uninstall-help
# uninstall via pipx
endef
.PHONY: uninstall
uninstall:
@echo "## ${PROJECT}: make uninstall"
@pipx uninstall ${PROJECT} || echo "Cannot uninstall => That is OK"
@echo "## ${PROJECT}: make uninstall [DONE]"
define clean-help
# clean build artifacts (build, dist, output)
endef
.PHONY: clean
clean:
rm -r build || true
rm -r dist || true
rm -r output || true
define emit-xnvme-help
# Emit code using the xNVMe interface model
endef
.PHONY: emit-xnvme
emit-xnvme:
yace models/xnvme.yaml --emit capi ctypes -l --output output/xnvme
define emit-nvme-help
# Emit code using the NVMe interface model
endef
.PHONY: emit-nvme
emit-nvme:
yace models/nvme.yaml --emit capi ctypes -l --output output/nvme
define emit-example-help
# Emit code using the example interface model
endef
.PHONY: emit-example
emit-example:
yace models/example.yaml --emit capi ctypes -l --output output/example
define emit-help
# Emit code for all examples
endef
.PHONY: emit
emit: emit-example emit-xnvme emit-nvme
define coverage-help
# Run emitter with coverage
endef
.PHONY: coverage
coverage:
coverage erase
coverage run -a --omit "*ctypes_sugar.py" --source=yace -m yace models/example.yaml --emit capi
coverage run -a --omit "*ctypes_sugar.py" --source=yace -m yace models/example.yaml --format
coverage run -a --omit "*ctypes_sugar.py" --source=yace -m yace models/example.yaml --lint
coverage run -a --omit "*ctypes_sugar.py" --source=yace -m yace tests/parsing/foo.h --c-to-yace
coverage run -a --omit "*ctypes_sugar.py" --source=yace -m pytest -v tests || true
coverage report
coverage html
coverage lcov
define view-help
# Inspect generated code
endef
.PHONY: view
view:
less output/*
define release-build-help
# Produce Python distribution (sdist, bdist_wheel)
endef
.PHONY: release-build
release-build:
python setup.py sdist
python setup.py bdist_wheel
define release-upload-help
# Upload Python distribution (sdist, bdist_wheel)
endef
.PHONY: release-upload
release-upload:
twine upload dist/*
define release-upload-help
# Produce + Upload Python distribution (sdist, bdist_wheel)
endef
.PHONY: release
release: clean release-build release-upload
@echo -n "# rel: "; date
define docs-build-prep-help
# Install Sphinx Doc. in a pipx-venv along with jinja2, pygments-ansi-color, and sphinxcontrib-gtagjs
endef
.PHONY: docs-build-prep
docs-build-prep:
pipx install sphinx
pipx inject sphinx jinja2
pipx inject sphinx pygments-ansi-color
pipx inject sphinx sphinxcontrib-gtagjs
pipx inject sphinx furo
pipx inject sphinx dist/*.tar.gz
define docs-build-help
# generate documentation
endef
.PHONY: docs-build
docs-build:
$(shell pipx environment -v PIPX_LOCAL_VENVS)/sphinx/bin/python ./$(AUX_PATH)/gen_entity_index.py > docs/source/idl/list.rst
cd docs && rm -rf build
cd docs/source/install && kmdo .
cd docs/source/usage && kmdo .
cd docs/source/targets/capi && kmdo .
cd docs/source/idl && kmdo .
cd docs/source/codebase && kmdo .
cd docs && make html
define docs-view-help
# open the HTML version documentation
endef
.PHONY: docs-view
docs-view:
open docs/build/html/index.html
define docs-help
# generate documentation and open the HTML
endef
.PHONY: docs
docs: docs-build-prep docs-build
define format-help
# run code format (style, code-conventions and language-integrity) on staged changes
endef
.PHONY: format
format:
@echo "## ${PROJECT}: format"
@pre-commit run
@echo "## ${PROJECT}: format [DONE]"
define format-all-help
# run code format (style, code-conventions and language-integrity) on all files
endef
.PHONY: format-all
format-all:
@echo "## ${PROJECT}: format-all"
@pre-commit run --all-files
@echo "## ${PROJECT}: format-all [DONE]"
define bump-help
# run code format (style, code-conventions and language-integrity) on all files
endef
.PHONY: bump
bump:
@echo "## ${PROJECT}: bump"
@./$(AUX_PATH)/bump.py
@echo "## ${PROJECT}: bump [DONE]"
define help-help
# Print the description of every target
endef
.PHONY: help
help:
@./$(AUX_PATH)/mkhelp.py --repos .