Makefile

[詳解]

# **************************************************************************** #
#                                                                              #
#                                                         :::      ::::::::    #
#    Makefile                                           :+:      :+:    :+:    #
#                                                     +:+ +:+         +:+      #
#    By: kamitsui <kamitsui@student.42tokyo.jp>     +#+  +:+       +#+         #
#                                                 +#+#+#+#+#+   +#+            #
#    Created: 2025/05/29 22:58:19 by kamitsui          #+#    #+#              #
#    Updated: 2025/06/03 01:42:13 by kamitsui         ###   ########.fr        #
#                                                                              #
# **************************************************************************** #
 
#******************************************************************************#
# @file ex03/Makefile                                                          #
# @brief Build system for C++ Module 04 Exercise 03: "Interface & Recap".      #
#                                                                              #
# This Makefile orchestrates the compilation, linking, and management          #
# of all source files for Exercise 03. It's designed to automate the           #
# build process, manage object and dependency files, and provide               #
# convenient targets for cleaning, rebuilding, and running tests.              #
#                                                                              #
# @note This Makefile incorporates advanced features like automatic            #
# dependency generation (`-MMD -MP`) and integration with an external          #
# C++ module tester repository.                                                #
#                                                                              #
# @section features Features                                                   #
# - **Automated Compilation:** Compiles all `.cpp` files into object files.    #
# - **Automatic Dependency Generation:** Generates `.d` files to ensure correct recompilation. #
# - **Standard Targets:** Provides `all`, `clean`, `fclean`, `re`.             #
# - **Test Integration:** Includes a `test` target to interact with an external module tester. #
# - **Output Management:** Creates `objs` and `.deps` directories.             #
# - **User Prompts:** Uses `ASK_AND_EXECUTE_ON_YES` for interactive commands.  #
# @section usage Usage                                                         #
# - `make`: Builds the main executable (`a.out`).                              #
# - `make clean`: Removes object and dependency files.                         #
# - `make fclean`: Removes object, dependency, and the executable.             #
# - `make re`: Cleans and then rebuilds the project.                           #
# - `make test`: Clones (if not present) and runs the associated test from the `cpp_module_tester` repository. #
#******************************************************************************#
 
# Directories
OBJ_DIR = objs
DEP_DIR = .deps
 
# Source files
SRCS = \
       main.cpp \
       AMateria.cpp \
       Character.cpp \
       Cure.cpp Ice.cpp MateriaSource.cpp \
       DroppedMateriaManager.cpp Logger.cpp
 
#vpath %.cpp ./
 
# Object files and dependency files
OBJS = $(addprefix $(OBJ_DIR)/, $(SRCS:.cpp=.o))
DEPS = $(addprefix $(DEP_DIR)/, $(SRCS:.cpp=.d))
 
# Build target
NAME = a.out
 
vpath %.cpp ./
 
# Compiler
CXX = c++
CXXFLAGS = -Wall -Wextra -Werror -std=c++98
CF_DEP = -MMD -MP -MF $(@:$(OBJ_DIR)/%.o=$(DEP_DIR)/%.d)
 
# Rules for building object files
$(OBJ_DIR)/%.o: %.cpp
    $(CXX) $(CXXFLAGS) $(CF_DEP) -c $< -o $@
 
# Default target
all: directories $(NAME)
.PHONY: all
 
# Make Directories
directories:
    @mkdir -p $(OBJ_DIR)
    @mkdir -p $(DEP_DIR)
.PHONY: directories
 
# Build Target
$(NAME): $(OBJS)
    $(CXX) $(CXXFLAGS) $(OBJS) -o $(NAME)
    $(call ASCII_ART,$(NAME))
 
# REPOSITORY for Test
TEST_ROOT = ../../cpp_module_tester
TEST_DIR = $(TEST_ROOT)/cpp04
URL_TEST_CPP = "https://github.com/kamitsui/cpp_module_tester.git"
TEST_TARGET = $(TEST_DIR)/ex03_app
EX_NUM = ex03
 
# Test
test:
    @echo "No support!"
#ifeq ($(shell test -d $(TEST_DIR) && echo exist),)
#   @echo "Please clone the test repository"
#   $(call ASK_AND_EXECUTE_ON_YES, git clone $(URL_TEST_CPP) $(TEST_ROOT))
#endif
#   $(call ASK_AND_EXECUTE_ON_YES, make -C $(TEST_DIR) $(EX_NUM))
.PHONY: test
 
# More Test : Enable Logger
debug: fclean
    make WITH_DEBUG=1
.PHONY: debug
 
# DEBUG_MODE
ifdef WITH_DEBUG
CXXFLAGS += -D DEBUG_MODE
endif
 
# Rule for removing object & dependency files
clean:
    rm -rf $(OBJ_DIR) $(DEP_DIR) $(TEST_DIR)/objs $(TEST_DIR)/.deps
.PHONY: clean
 
# Rule for removing Target & others
fclean: clean
    rm -f $(NAME) $(TEST_TARGET)
.PHONY: fclean
 
# Rule for Clean & Build Target
re: fclean all
.PHONY: re
 
# Enable dependency file
-include $(DEPS)
 
# ASCII Art : Display Tips the way to use.
define ASCII_ART
    @echo " _____________________________________________"
    @echo "< Usage :                                     >"
    @echo "<  $$ ./a.out                                  >"
    @echo "<                                             >"
    @echo "< Debug :                                     >"
    @echo "<  $$ make debug                               >"
    @echo "<  $$ ./a.out                                  >"
    @echo "<                                             >"
    @echo "< Test Case :                                 >"
    @echo "<  $$ make test                                >"
    @echo "----------------------------------------------"
    @echo "       \   ^__^"
    @echo "        \  (oo)\_______"
    @echo "           (__)\       )\\/\\"
    @echo "               ||----w |"
    @echo "               ||     ||\n"
endef
 
# Ask and Exit on No
define ASK_AND_EXECUTE_ON_YES
    @echo "Execute? $(1) (y/n)"
    @read -r answer; \
    case "$$answer" in \
        [yY]) \
            echo $(1); \
            $(1); \
            ;; \
        *) \
            echo "Skip ..."; \
            ;; \
    esac
endef
 
# Makefile Option : Disable '--print-directory'
MAKEFLAGS += --no-print-directory