feat: Add macOS support with platform-specific implementations

.github/workflows/test.yml

@@ -24,12 +24,12 @@ jobs:
             sudo: 'sudo '
 
     name: Linux ${{ matrix.volume }}${{ matrix.asroot.name }}
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v3
       - run: sudo apt-get install -y libparted-dev libudev-dev
-      - run: make all extra
+      - run: make all extra BIN_DIR=.
 
       - if: matrix.volume == 'relative-path'
         run: mkdir relative-path
@@ -66,12 +66,12 @@ jobs:
             sudo: 'sudo '
 
     name: MacOS ${{ matrix.volume }}${{ matrix.asroot.name }}
-    runs-on: macos-12
+    runs-on: macos-latest
 
     steps:
       - uses: actions/checkout@v3
       - run: brew install argp-standalone
-      - run: make
+      - run: make all extra BIN_DIR=.
 
       - if: matrix.volume == 'relative-path'
         run: mkdir relative-path
@@ -88,6 +88,13 @@ jobs:
       - run: ./f3read --help
       - run: ${{ matrix.asroot.sudo }}./f3read -s 2 -e 4 -r 50000 ${{ matrix.volume }}
 
+      - name: Run F3Fix tests
+        if: matrix.volume == '.'
+        run: |
+          brew install gawk
+          chmod +x tests/test-macos-f3fix.sh
+          ./tests/test-macos-f3fix.sh
+
   Cygwin:
     strategy:
       fail-fast: false
@@ -103,7 +110,7 @@ jobs:
             windows: 'C:\cygwin'
 
     name: Cygwin ${{ matrix.volume.cygwin }}
-    runs-on: windows-2022
+    runs-on: windows-latest
 
     steps:
       - uses: actions/checkout@v3
@@ -112,7 +119,7 @@ jobs:
         with:
           packages: gcc-core libargp-devel make
 
-      - run: "$Env:LDFLAGS = '-Wl,--stack,4000000'; make"
+      - run: "$Env:LDFLAGS = '-Wl,--stack,4000000 -largp'; make BIN_DIR=."
 
       - if: matrix.volume.windows == 'relative-path'
         run: New-Item -ItemType Directory -Path relative-path

.gitignore

@@ -5,4 +5,5 @@ cscope.out
 *.o
 *~
 
-doc/_build
+doc/_build
+bin/

Makefile

@@ -1,65 +1,162 @@
+# --- Basic Configuration ---
 CC ?= gcc
-CFLAGS += -std=c99 -Wall -Wextra -pedantic -MMD -ggdb
+CFLAGS += -std=c99 -Wall -Wextra -pedantic
+CFLAGS += -Iinclude  # headers include directory
+CFLAGS += -ggdb  # keep debug symbols
+CFLAGS += -ffunction-sections -fdata-sections  # strip dead code
 
+# --- Target Definitions ---
 TARGETS = f3write f3read
 EXTRA_TARGETS = f3probe f3brew f3fix
 
+# --- Installation Paths and Tools ---
 PREFIX = /usr/local
 INSTALL = install
 LN = ln
 
-ifndef OS
-	OS = $(shell uname -s)
+# --- OS Detection ---
+OS ?= $(shell uname -s)
+ifeq ($(OS),Linux)
+    PLATFORM := linux
+else ifeq ($(OS),Darwin)
+    PLATFORM := darwin
+    # Check Xcode command line tools
+    ifeq (,$(shell xcode-select -p))
+        $(error Xcode command line tools are not installed)
+    endif
+else
+    $(warning Unknown OS '$(OS)', defaulting to Linux)
+    PLATFORM := linux
 endif
-ifneq ($(OS), Linux)
-	ARGP = /usr/local
-	ifeq ($(OS), Darwin)
-		ifneq ($(shell command -v brew),)
-			ARGP = $(shell brew --prefix)
-		endif
-	endif
-	CFLAGS += -I$(ARGP)/include
-	LDFLAGS += -L$(ARGP)/lib -largp
+
+# --- Platform-Specific Flags and Libraries Definitions ---
+PLATFORM_CFLAGS =
+PLATFORM_LDFLAGS =
+
+# Target specific libraries and flags
+COMMON_LIBS = -lm
+F3WRITE_LIBS = $(COMMON_LIBS)
+F3READ_LIBS = $(COMMON_LIBS)
+F3PROBE_LIBS = $(COMMON_LIBS)
+F3BREW_LIBS = $(COMMON_LIBS)
+F3FIX_LIBS = $(COMMON_LIBS)
+
+ifeq ($(PLATFORM), linux)
+    PLATFORM_DIR = linux
+    PLATFORM_CFLAGS += -D_GNU_SOURCE -D_FILE_OFFSET_BITS=64
+    PLATFORM_LDFLAGS += -Wl,--gc-sections # strip dead code
+    F3PROBE_LIBS += -ludev
+    F3BREW_LIBS += -ludev
+    F3FIX_LIBS += -ludev -lparted
+endif
+ifeq ($(PLATFORM), darwin)
+    PLATFORM_DIR = darwin
+    ifneq ($(shell command -v brew),)
+        ARGP_PREFIX := $(shell brew --prefix)
+    else
+        ARGP_PREFIX := /usr/local
+    endif
+    PLATFORM_CFLAGS += -D_DARWIN_C_SOURCE
+    PLATFORM_CFLAGS += -I$(ARGP_PREFIX)/include
+    PLATFORM_LDFLAGS += -L$(ARGP_PREFIX)/lib -largp
+    PLATFORM_LDFLAGS += -Wl,-dead_strip # strip dead code
+    PLATFORM_LDFLAGS += -framework DiskArbitration -framework CoreFoundation
 endif
 
-all: $(TARGETS)
-extra: $(EXTRA_TARGETS)
+CFLAGS += $(PLATFORM_CFLAGS)
+LDFLAGS += $(PLATFORM_LDFLAGS)
 
-docker:
-	docker build -f Dockerfile -t f3:latest .
+# --- Output Directory Setup ---
+BUILD_DIR := build
+BIN_DIR := $(BUILD_DIR)/bin
+OBJ_DIR := $(BUILD_DIR)/obj
+
+BIN_TARGETS := $(addprefix $(BIN_DIR)/,$(TARGETS))
+BIN_EXTRAS := $(addprefix $(BIN_DIR)/,$(EXTRA_TARGETS))
+
+# Source directories and automatic search rules
+SRC_DIRS = src/f3 src/f3-extra
+vpath %.c $(SRC_DIRS)
+
+# Find source files relative to source root and map them to object paths in OBJ_DIR
+TARGET_SRCS := $(wildcard $(addsuffix /*.c, $(SRC_DIRS)))
+TARGET_OBJS := $(patsubst src/%.c,$(OBJ_DIR)/%.o,$(TARGET_SRCS))
+
+# Reusable object lists
+F3_LIB_OBJS := $(patsubst src/%.c,$(OBJ_DIR)/%.o,$(wildcard src/f3/lib/*.c))
+F3_EXTRA_LIB_OBJS := $(patsubst src/%.c,$(OBJ_DIR)/%.o,$(wildcard src/f3-extra/lib/*.c))
+
+# Platform-specific object lists
+PLATFORM_OBJS := $(patsubst src/%.c,$(OBJ_DIR)/%.o,$(wildcard src/platform/$(PLATFORM_DIR)/*.c))
+PLATFORM_COMPAT_OBJS := $(patsubst src/%.c,$(OBJ_DIR)/%.o,$(wildcard src/platform/$(PLATFORM_DIR)/platform_compat.c))
+PLATFORM_PARTITION_OBJS := $(patsubst src/%.c,$(OBJ_DIR)/%.o,src/platform/$(PLATFORM_DIR)/partition/partition.c)
+
+ALL_OBJS := $(TARGET_OBJS) $(F3_LIB_OBJS) $(F3_EXTRA_LIB_OBJS) $(PLATFORM_OBJS) $(PLATFORM_PARTITION_OBJS)
+
+# --- Dependency Inclusion ---
+DEPFLAGS = -MMD -MT $@ -MP -MF $(@:.o=.d)
+ALL_DEPS := $(ALL_OBJS:.o=.d)
+-include $(ALL_DEPS)
+
+# --- Pattern Rule for Compilation ---
+$(OBJ_DIR)/%.o: src/%.c | $(OBJ_DIR)
+	@mkdir -p $(@D)
+	$(CC) $(CFLAGS) $(DEPFLAGS) -c $< -o $@
+
+# --- Main Build Targets ---
+all: $(BIN_TARGETS)
+extra: $(BIN_EXTRAS)
+
+# --- Directory Targets ---
+$(BUILD_DIR): ; @mkdir -p $@
+$(BIN_DIR): | $(BUILD_DIR) ; @mkdir -p $@
+$(OBJ_DIR): | $(BUILD_DIR) ; @mkdir -p $@
+
+# --- Binary Linking Rules ---
+$(BIN_DIR)/f3write: $(OBJ_DIR)/f3/f3write.o $(F3_LIB_OBJS) $(PLATFORM_COMPAT_OBJS) | $(BIN_DIR)
+	$(CC) -o $@ $^ $(LDFLAGS) $(F3WRITE_LIBS)
 
+$(BIN_DIR)/f3read: $(OBJ_DIR)/f3/f3read.o $(F3_LIB_OBJS) $(PLATFORM_COMPAT_OBJS) | $(BIN_DIR)
+	$(CC) -o $@ $^ $(LDFLAGS) $(F3READ_LIBS)
+
+$(BIN_DIR)/f3probe: $(OBJ_DIR)/f3-extra/f3probe.o $(F3_EXTRA_LIB_OBJS) $(PLATFORM_OBJS) | $(BIN_DIR)
+	$(CC) -o $@ $^ $(LDFLAGS) $(F3PROBE_LIBS)
+
+$(BIN_DIR)/f3brew: $(OBJ_DIR)/f3-extra/f3brew.o $(F3_EXTRA_LIB_OBJS) $(PLATFORM_OBJS) | $(BIN_DIR)
+	$(CC) -o $@ $^ $(LDFLAGS) $(F3BREW_LIBS)
+
+$(BIN_DIR)/f3fix: $(OBJ_DIR)/f3-extra/f3fix.o $(F3_EXTRA_LIB_OBJS) $(PLATFORM_OBJS) $(PLATFORM_PARTITION_OBJS) | $(BIN_DIR)
+	$(CC) -o $@ $^ $(LDFLAGS) $(F3FIX_LIBS)
+
+# --- Installation Targets ---
 install: all
+	@echo "Installing binaries from $(BIN_DIR) to $(DESTDIR)$(PREFIX)/bin"
 	$(INSTALL) -d $(DESTDIR)$(PREFIX)/bin
-	$(INSTALL) -m755 $(TARGETS) $(DESTDIR)$(PREFIX)/bin
+	$(INSTALL) -m755 $(BIN_TARGETS) $(DESTDIR)$(PREFIX)/bin
+	@echo "Installing man pages to $(DESTDIR)$(PREFIX)/share/man/man1"
 	$(INSTALL) -d $(DESTDIR)$(PREFIX)/share/man/man1
 	$(INSTALL) -m644 f3read.1 $(DESTDIR)$(PREFIX)/share/man/man1
 	$(LN) -sf f3read.1 $(DESTDIR)$(PREFIX)/share/man/man1/f3write.1
 
 install-extra: extra
+	@echo "Installing extra binaries from $(BIN_DIR) to $(DESTDIR)$(PREFIX)/bin"
 	$(INSTALL) -d $(DESTDIR)$(PREFIX)/bin
-	$(INSTALL) -m755 $(EXTRA_TARGETS) $(DESTDIR)$(PREFIX)/bin
-
-f3write: utils.o libflow.o f3write.o
-	$(CC) -o $@ $^ $(LDFLAGS) -lm
-
-f3read: utils.o libflow.o f3read.o
-	$(CC) -o $@ $^ $(LDFLAGS) -lm
-
-f3probe: libutils.o libdevs.o libprobe.o f3probe.o
-	$(CC) -o $@ $^ $(LDFLAGS) -lm -ludev
+	$(INSTALL) -m755 $(BIN_EXTRAS) $(DESTDIR)$(PREFIX)/bin
 
-f3brew: libutils.o libdevs.o f3brew.o
-	$(CC) -o $@ $^ $(LDFLAGS) -lm -ludev
-
-f3fix: libutils.o f3fix.o
-	$(CC) -o $@ $^ $(LDFLAGS) -lparted
-
--include *.d
+# --- Development Helper Targets ---
+cscope:
+	cscope -b src/**/*.c include/**/*.h
 
-PHONY: cscope clean
+cppcheck:
+	cppcheck --enable=all --suppress=missingIncludeSystem \
+	  -Iinclude -Iinclude/devices src include
 
-cscope:
-	cscope -b *.c *.h
+docker:
+	docker build -f Dockerfile -t f3:latest .
 
+# --- Cleanup and Maintenance Targets ---
 clean:
-	rm -f *.o *.d cscope.out $(TARGETS) $(EXTRA_TARGETS)
+	@rm -rf $(BUILD_DIR)
+	@rm -f cscope.out
+
+.PHONY: all extra docker install install-extra cscope cppcheck clean