-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMakefile
398 lines (335 loc) · 13.2 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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# **************************************************************************** #
# #
# ::: :::::::: #
# Makefile :+: :+: :+: #
# +:+ +:+ +:+ #
# By: gfragoso <[email protected]> +#+ +:+ +#+ #
# +#+#+#+#+#+ +#+ #
# Created: 2024/05/29 20:35:29 by passunca #+# #+# #
# Updated: 2024/09/17 15:52:33 by gfragoso ### ########.fr #
# #
# **************************************************************************** #
#==============================================================================#
# MAKE CONFIG #
#==============================================================================#
MAKE = make -C
SHELL := bash --rcfile ~/.bashrc
# Default test values
IN_PATH ?= $(SRC_PATH)
ARG =
#==============================================================================#
# NAMES #
#==============================================================================#
NAME = minishell
TESTER = minishell_tester
### Message Vars
_SUCCESS = [$(GRN)SUCCESS$(D)]
_INFO = [$(BLU)INFO$(D)]
_NORM = [$(MAG)Norminette$(D)]
_NORM_SUCCESS = $(GRN)=== OK:$(D)
_NORM_INFO = $(BLU)File no:$(D)
_NORM_ERR = $(RED)=== KO:$(D)
_SEP = =====================
#==============================================================================#
# PATHS #
#==============================================================================#
SRC_PATH = src
INC_PATH = inc
LIBS_PATH = lib
BUILD_PATH = .build
TEMP_PATH = .temp
FILES = 000_main.c
FILES += 010_init.c
FILES += 100_termios.c
FILES += 200_tokenizer.c
FILES += 201_tokenizer_utils.c
FILES += 210_tk_list.c
FILES += 220_tk_expander.c
FILES += 221_tk_expander2.c
FILES += 222_tk_expander_utils.c
FILES += 300_parser.c
FILES += 310_readline.c
FILES += 311_readline_utils.c
FILES += 320_cmd_parser.c
FILES += 321_cmd_parser_utils.c
FILES += 400_signal.c
FILES += 401_signal2.c
FILES += 500_env_get.c
FILES += 510_env_set.c
FILES += 520_append_var.c
FILES += 600_execute.c
FILES += 610_exec_check.c
FILES += 620_exec_one.c
FILES += 630_exec_pipeline.c
FILES += 640_exec_child.c
FILES += 650_exec_cmd.c
FILES += 660_pipes.c
FILES += 670_redir.c
FILES += 700_exit.c
FILES += 710_pwd.c
FILES += 720_cd.c
FILES += 730_env.c
FILES += 740_clear.c
FILES += 750_echo.c
FILES += 760_export.c
FILES += 761_export_status.c
FILES += 770_unset.c
FILES += 780_path_resolver.c
FILES += 781_path_utils.c
FILES += 800_error.c
FILES += 810_error2.c
FILES += 900_free.c
FILES += 910_free2.c
SRC = $(addprefix $(SRC_PATH)/, $(FILES))
OBJS = $(SRC:$(SRC_PATH)/%.c=$(BUILD_PATH)/%.o)
LIBFT_PATH = $(LIBS_PATH)/libft
LIBFT_ARC = $(LIBFT_PATH)/libft.a
TESTER_PATH = $(LIBS_PATH)/minishell_tester
GOOGLETEST_PATH = tests/googletest
BOOST_PATH = tests/boost/
#==============================================================================#
# COMPILER & FLAGS #
#==============================================================================#
CC = cc
CFLAGS = -Wall -Wextra -Werror
DFLAGS = -g
RFLAGS = -lreadline
INC = -I $(INC_PATH)
BUILD ?= all
ASAN_FLAGS = -fsanitize=address
#==============================================================================#
# COMMANDS #
#==============================================================================#
### Core Utils
RM = rm -rf
AR = ar rcs
MKDIR_P = mkdir -p
### Valgrind
VAL_ARGS = --suppressions=readline.supp
VAL_LEAK = --leak-check=full --show-leak-kinds=all --track-fds=yes --track-origins=yes --trace-children=yes
VGDB_ARGS = --vgdb-error=0 $(VAL_LEAK) $(VAL_ARGS)
#==============================================================================#
# RULES #
#==============================================================================#
##@ minishell Compilation Rules 🏗
all: deps $(BUILD_PATH) $(NAME) ## Compile
$(NAME): $(BUILD_PATH) $(LIBFT_ARC) $(OBJS) ## Compile
@echo "$(YEL)Compiling $(MAG)$(NAME)$(YEL) mandatory version$(D)"
$(CC) $(CFLAGS) $(DFLAGS) $(OBJS) $(INC) $(LIBFT_ARC) $(RFLAGS) -o $(NAME)
@echo "[$(_SUCCESS) compiling $(MAG)$(NAME)$(D) $(YEL)🖔$(D)]"
make norm
shell: all
@./minishell
asan: CFLAGS += $(ASAN_FLAGS)
asan: $(BUILD_PATH) $(LIBFT_ARC) $(OBJS) ## Compile with Address Sanitizer
@echo "$(YEL)Compiling $(MAG)$(NAME)$(YEL) with Address Sanitizer$(D)"
$(CC) $(CFLAGS) $(OBJS) $(INC) $(LIBFT_ARC) $(RFLAGS) -o $(NAME)
@echo "[$(_SUCCESS) compiling $(MAG)$(NAME)$(D) with Address Sanitizer $(YEL)🖔$(D)]"
tdebug: DFLAGS += -DTOKENIZER_DEBUG
tdebug: $(BUILD_PATH) $(LIBFT_ARC) $(OBJS) ## Compile with Tokenizer Debug
@echo "$(YEL)Compiling $(MAG)$(NAME)$(YEL) with Address Sanitizer$(D)"
$(CC) $(CFLAGS) $(OBJS) $(INC) $(LIBFT_ARC) $(RFLAGS) -o $(NAME)
@echo "[$(_SUCCESS) compiling $(MAG)$(NAME)$(D) with Tokenizer Debug $(YEL)🖔$(D)]"
deps: ## Download/Update deps
@if test ! -d "$(LIBFT_PATH)"; then make get_libft; \
else echo "$(YEL)[libft]$(D) folder found 🖔"; fi
@echo " $(RED)$(D) [$(GRN)Nothing to be done!$(D)]"
-include $(BUILD_PATH)/%.d
$(BUILD_PATH)/%.o: $(SRC_PATH)/%.c
@echo -n "$(MAG)█$(D)"
$(CC) $(CFLAGS) $(DFLAGS) -MMD -MP -c $< -o $@
$(BUILD_PATH):
$(MKDIR_P) $(BUILD_PATH)
@echo "* $(YEL)Creating $(CYA)$(BUILD_PATH)$(YEL) folder:$(D) $(_SUCCESS)"
$(TEMP_PATH):
$(MKDIR_P) $(TEMP_PATH)
@echo "* $(YEL)Creating $(CYA)$(TEMP_PATH)$(YEL) folder:$(D) $(_SUCCESS)"
$(LIBFT_ARC):
$(MAKE) $(LIBFT_PATH) extra
get_libft:
@echo "* $(CYA)Getting Libft submodule$(D)]"
@if test ! -d "$(LIBFT_PATH)"; then \
git clone [email protected]:PedroZappa/42_libft.git $(LIBFT_PATH); \
echo "* $(GRN)Libft submodule download$(D): $(_SUCCESS)"; \
else \
echo "* $(GRN)Libft submodule already exists 🖔"; \
echo " $(RED)$(D) [$(GRN)Nothing to be done!$(D)]"; \
fi
##@ Norm Rules
norm:
@make --no-print-directory norm_path IN_PATH=$(SRC_PATH)
@make --no-print-directory norm_path IN_PATH=$(INC_PATH)
norm_path: $(TEMP_PATH) ## Run norminette test on source files
@echo "$(CYA)$(_SEP)$(D)"
@printf "${_NORM}: $(YEL)$(IN_PATH)$(D)\n"
@ls $(IN_PATH) | wc -l > $(TEMP_PATH)/norm_ls.txt
@printf "$(_NORM_INFO) $$(cat $(TEMP_PATH)/norm_ls.txt)\n"
@printf "$(_NORM_SUCCESS) "
@norminette $(IN_PATH) | grep -wc "OK" > $(TEMP_PATH)/norm.txt; \
if [ $$? -eq 1 ]; then \
echo "0" > $(TEMP_PATH)/norm.txt; \
fi
@printf "$$(cat $(TEMP_PATH)/norm.txt)\n"
@if ! diff -q $(TEMP_PATH)/norm_ls.txt $(TEMP_PATH)/norm.txt > /dev/null; then \
printf "$(_NORM_ERR) "; \
norminette $(IN_PATH) | grep -v "OK" > $(TEMP_PATH)/norm_err.txt; \
cat $(TEMP_PATH)/norm_err.txt | grep -wc "Error:" > $(TEMP_PATH)/norm_errn.txt; \
printf "$$(cat $(TEMP_PATH)/norm_errn.txt)\n"; \
printf "$$(cat $(TEMP_PATH)/norm_err.txt)\n"; \
else \
printf "[$(YEL)Everything is OK$(D)]\n"; \
fi
@echo "$(CYA)$(_SEP)$(D)"
check_ext_func: all ## Check for external functions
@echo "[$(YEL)Checking for external functions$(D)]"
@echo "$(YEL)$(_SEP)$(D)"
@echo "$(CYA)Reading binary$(D): $(MAG)$(NAME)$(D)"
nm ./$(NAME) | grep "U" | grep -v "__" | tee $(TEMP_PATH)/ext_func.txt
@echo "$(YEL)$(_SEP)$(D)"
TEST_NAME = test
OBJS_TEST = test.o
test: $(BUILD_PATH) $(LIBFT_ARC) $(OBJS_TEST)
@echo "$(YEL)Compiling $(MAG)$(NAME)$(YEL) test version$(D)"
$(CC) $(CFLAGS) $(DFLAGS) $(OBJS_TEST) $(INC) $(LIBFT_ARC) $(RFLAGS) -o $(TEST_NAME)
@echo "[$(_SUCCESS) compiling $(MAG)$(NAME)$(D) $(YEL)🖔$(D)]"
##@ Test Rules 🧪
sync_shell: $(BUILD) ## Test w/ syncshell
tmux set-option remain-on-exit on
@echo "[$(YEL)Testing with syncshell$(D)]"
tmux split-window -h "bash"
tmux setw synchronize-panes on
clear && ./$(NAME)
sync_valgrind: $(BUILD) ## Test bash & minishell w/ valgrind
tmux set-option remain-on-exit on
@echo "[$(YEL)Testing with valgrind$(D)]"
tmux split-window -h "valgrind $(VAL_ARGS) bash"
tmux setw synchronize-panes on
clear && valgrind $(VAL_ARGS) $(VAL_LEAK) ./$(NAME)
cmake: $(BUILD) get_googletest
@cd tests/ && mkdir -p build/ && cd build/ && cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON .. && make
@if test ! -f compile_commands.json; then \
ln -s tests/build/compile_commands.json compile_commands.json; \
fi
ctest: cmake ## Test w/ ctest
@cd tests/build && ctest
tester: $(BUILD) cmake ## Test w/ googletest
./tests/build/$(TESTER)
get_googletest: $(BUILD_PATH) $(BUILD)
@echo "* $(CYA)Getting googletest$(D): $(_INFO)"
@if test ! -d "$(GOOGLETEST_PATH)"; then \
git clone [email protected]:google/googletest.git $(GOOGLETEST_PATH); \
echo "* $(YEL)googletest download$(D): $(_SUCCESS)"; \
else \
echo "* $(YEL)googletest already exists 🖔"; \
echo " $(RED)$(D) [$(GRN)Nothing to be done!$(D)]"; \
fi
##@ Debug Rules
gdb: all $(NAME) $(TEMP_PATH) ## Debug w/ gdb
tmux split-window -h "gdb --tui --args ./$(NAME)"
tmux resize-pane -L 5
# tmux split-window -v "btop"
make get_log
vgdb: all $(NAME) $(TEMP_PATH) ## Debug w/ valgrind (memcheck) & gdb
tmux split-window -h "valgrind $(VGDB_ARGS) --log-file=gdb.txt ./$(NAME) $(ARG)"
make vgdb_cmd
tmux split-window -v "gdb --tui -x $(TEMP_PATH)/gdb_commands.txt $(NAME)"
tmux resize-pane -U 18
# tmux split-window -v "btop"
make get_log
valgrind: all $(NAME) $(TEMP_PATH) ## Debug w/ valgrind (memcheck)
tmux set-option remain-on-exit on
tmux split-window -h "valgrind $(VAL_ARGS) $(VAL_LEAK) ./$(NAME) $(ARG)"
massif: all $(TEMP_PATH) ## Run Valgrind w/ Massif (gather profiling information)
@TIMESTAMP=$(shell date +%Y%m%d%H%M%S); \
if [ -f massif.out.* ]; then \
mv -f massif.out.* $(TEMP_PATH)/massif.out.$$TIMESTAMP; \
fi
@echo " 🔎 [$(YEL)Massif Profiling$(D)]"
valgrind --tool=massif --time-unit=B ./$(NAME) $(ARG)
ms_print massif.out.*
# Learn more about massif and ms_print:
### https://valgrind.org/docs/manual/ms-manual.html
get_log:
touch gdb.txt
@if command -v lnav; then \
lnav gdb.txt; \
else \
tail -f gdb.txt; \
fi
vgdb_cmd: $(NAME) $(TEMP_PATH)
@printf "target remote | vgdb --pid=" > $(TEMP_PATH)/gdb_commands.txt
@printf "$(shell pgrep -f valgrind)" >> $(TEMP_PATH)/gdb_commands.txt
@printf "\n" >> $(TEMP_PATH)/gdb_commands.txt
@cat .vgdbinit >> $(TEMP_PATH)/gdb_commands.txt
##@ Clean-up Rules
clean: ## Remove object files
@echo "*** $(YEL)Removing $(MAG)$(NAME)$(D) and deps $(YEL)object files$(D)"
@if [ -d "$(BUILD_PATH)" ] || [ -d "$(TEMP_PATH)" ]; then \
if [ -d "$(BUILD_PATH)" ]; then \
$(RM) $(BUILD_PATH); \
echo "* $(YEL)Removing $(CYA)$(BUILD_PATH)$(D) folder & files$(D): $(_SUCCESS)"; \
fi; \
if [ -d "$(TEMP_PATH)" ]; then \
$(RM) $(TEMP_PATH); \
echo "* $(YEL)Removing $(CYA)$(TEMP_PATH)$(D) folder & files:$(D) $(_SUCCESS)"; \
fi; \
else \
echo " $(RED)$(D) [$(GRN)Nothing to clean!$(D)]"; \
fi
fclean: clean ## Remove executable and .gdbinit
@if [ -f "$(NAME)" ]; then \
if [ -f "$(NAME)" ]; then \
$(RM) $(NAME); \
$(RM) compile_commands.json; \
echo "* $(YEL)Removing $(CYA)$(NAME)$(D) file: $(_SUCCESS)"; \
fi; \
else \
echo " $(RED)$(D) [$(GRN)Nothing to be fcleaned!$(D)]"; \
fi
libclean: fclean ## Remove libs
$(RM) $(LIBS_PATH)
$(RM) $(GOOGLETEST_PATH)
$(RM) $(BOOST_PATH)
$(RM) tests/build
$(RM) compile_commands.json
@echo "* $(YEL)Removing lib folder & files!$(D) : $(_SUCCESS)"
re: fclean all ## Purge & Recompile
##@ Help
help: ## Display this help page
@awk 'BEGIN {FS = ":.*##"; \
printf "\n=> Usage:\n\tmake $(GRN)<target>$(D)\n"} \
/^[a-zA-Z_0-9-]+:.*?##/ { \
printf "\t$(GRN)%-18s$(D) %s\n", $$1, $$2 } \
/^##@/ { \
printf "\n=> %s\n", substr($$0, 5) } ' Makefile
## Tweaked from source:
### https://www.padok.fr/en/blog/beautiful-makefile-awk
.PHONY: bonus clean fclean re help
#==============================================================================#
# UTILS #
#==============================================================================#
# Colors
#
# Run the following command to get list of available colors
# bash -c 'for c in {0..255}; do tput setaf $c; tput setaf $c | cat -v; echo =$c; done'
#
B = $(shell tput bold)
BLA = $(shell tput setaf 0)
RED = $(shell tput setaf 1)
GRN = $(shell tput setaf 2)
YEL = $(shell tput setaf 3)
BLU = $(shell tput setaf 4)
MAG = $(shell tput setaf 5)
CYA = $(shell tput setaf 6)
WHI = $(shell tput setaf 7)
GRE = $(shell tput setaf 8)
BRED = $(shell tput setaf 9)
BGRN = $(shell tput setaf 10)
BYEL = $(shell tput setaf 11)
BBLU = $(shell tput setaf 12)
BMAG = $(shell tput setaf 13)
BCYA = $(shell tput setaf 14)
BWHI = $(shell tput setaf 15)
D = $(shell tput sgr0)
BEL = $(shell tput bel)
CLR = $(shell tput el 1)