create-c-project-template.sh

create-c-project-template.sh

#!/bin/bash

# Function to create directories
create_directories() {
    mkdir -p $PROJECT_NAME/{source,include,tests,build,docs,cmake}
}

# Function to create a README file
create_readme() {
    cat << EOF > $PROJECT_NAME/README.md
# $PROJECT_NAME

Description of your C library project.

## Build Instructions

\`\`\`bash
mkdir -p build
cd build
cmake ..
make
\`\`\`

## Usage

Instructions on how to use your library.

## Contributing

Guidelines for contributing to your project.

## License

This project is licensed under the MIT License - see the LICENSE file for details.
EOF
}

# Function to create a LICENSE file
create_license() {
    cat << EOF > $PROJECT_NAME/LICENSE
MIT License

Copyright (c) $(date +%Y) $AUTHOR

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
EOF
}

# Function to create a Makefile
generate_makefile() {

    cat << EOF > $PROJECT_NAME/Makefile
# Project variables
PROJECT_NAME = ${PROJECT_NAME}
CC = gcc
INCLUDE_DIR = include
CFLAGS_dev = -Wall -Wextra -Werror -pedantic -I\$(INCLUDE_DIR) -g3
CFLAGS_release = -Wall -Wextra -Werror -pedantic -I\$(INCLUDE_DIR) -O3
LDFLAGS =

# Parse BUILD_TYPE from command line arguments or default to dev
ARGUMENTS := \$(wordlist 2,\$(words \$(MAKECMDGOALS)),\$(MAKECMDGOALS))
BUILD_TYPE := \$(if \$(ARGUMENTS),\$(firstword \$(ARGUMENTS)),dev)

LIB_DIR = library
SRC_DIR = source
OBJ_DIR = build/\$(BUILD_TYPE)
BIN_DIR = \$(OBJ_DIR)/bin
SRC_FILES = \$(wildcard \$(SRC_DIR)/*.c)
OBJ_FILES = \$(patsubst \$(SRC_DIR)/%.c, \$(OBJ_DIR)/%.o, \$(SRC_FILES))
STATIC_LIB = lib\$(PROJECT_NAME).a
STATIC_LIB_FILES = \$(wildcard \$(SRC_DIR)/*.a) # Assuming these are the libraries you want to link
STATIC_LIB_FILES_STRIP_LIB = \$(patsubst \$(SRC_DIR)/lib%.a, \$(OBJ_DIR)/%.a, \$(STATIC_LIB_FILES)) # Strip "lib" prefix from library filenames
TARGET = \$(PROJECT_NAME)

TEST_DIR = tests
TEST_SRC_FILES = \$(wildcard \$(TEST_DIR)/*.c)
TEST_OBJ_FILES = \$(patsubst \$(TEST_DIR)/%.c, \$(OBJ_DIR)/%.o, \$(TEST_SRC_FILES))
TEST_TARGET = test_\$(PROJECT_NAME)

# Default target
.PHONY: all
all: \$(TARGET)

# Build target
\$(TARGET): \$(STATIC_LIB) \$(OBJ_FILES)
	mkdir -p \$(BIN_DIR)
	\$(CC) \$(OBJ_DIR)/main.o -L\$(LIB_DIR) -l\$(PROJECT_NAME) -o \$(BIN_DIR)/\$(TARGET)

# Build static library
\$(STATIC_LIB): \$(filter-out \$(OBJ_DIR)/\$(TARGET).o, \$(OBJ_FILES))
	@echo "Building the library..."
	@mkdir -p \$(LIB_DIR)
	ar rcs \$(LIB_DIR)/\$@ \$^
	@echo "Library built..."

# Object files target
\$(OBJ_DIR)/%.o: \$(SRC_DIR)/%.c
	@mkdir -p \$(OBJ_DIR)
	\$(CC) \$(CFLAGS_\$(BUILD_TYPE)) -c -o \$@ \$<

# Clean target
.PHONY: clean
clean:
	@echo "Cleaning up..."
	rm -rf \$(OBJ_DIR)/*.o \$(BIN_DIR)/\$(TARGET) \$(LIB_DIR)/\$(STATIC_LIB) \$(OBJ_DIR)

# Run target
.PHONY: run
run: all
	@echo "Running \$(BIN_DIR)/\$(TARGET)..."
	
	@if [ ! -f \$(BIN_DIR)/\$(TARGET) ]; then \
	    \$(MAKE) all BUILD_TYPE=\$(BUILD_TYPE); \
	fi
	@\$(call print-binary-input)
	@\$(BIN_DIR)/\$(TARGET)
	@\$(call print-binary-input-end)

# Test target
\$(TEST_TARGET): \$(OBJ_FILES) \$(TEST_OBJ_FILES)
	\$(CC) \$(CFLAGS_\$(BUILD_TYPE)) -o \$@ \$^ \$(LDFLAGS)

\$(OBJ_DIR)/%.o: \$(TEST_DIR)/%.c
	@mkdir -p \$(OBJ_DIR)
	\$(CC) \$(CFLAGS_\$(BUILD_TYPE)) -c -o \$@ \$<

.PHONY: test
test: \$(TEST_TARGET)
	@echo "Running tests..."
	./\$(TEST_TARGET)

define print-binary-input
	echo 
	echo ▄█████▄░██░░░██░████████░█████▄░██░░░██░████████░░░██████░█████▄░▄█████▄░▄██▄▄██▄░░░█████▄░██████░██████▄░▄████▄░█████▄░██░░██
	echo ██░░░██░██░░░██░░░░██░░░░██░░██░██░░░██░░░░██░░░░░░██░░░░░██░░██░██░░░██░██░██░██░░░██░░██░░░██░░░██░░░██░██░░██░██░░██░██░░██
	echo ██░░░██░██░░░██░░░░██░░░░█████▀░██░░░██░░░░██░░░░░░█████░░█████▀░██░░░██░██░██░██░░░█████░░░░██░░░██░░░██░██░░██░█████▀░▀████▀
	echo ██░░░██░██░░░██░░░░██░░░░██░░░░░██░░░██░░░░██░░░░░░██░░░░░██░░██░██░░░██░██░██░██░░░██░░██░░░██░░░██░░░██░██████░██░░██░░░██░░
	echo ▀█████▀░▀█████▀░░░░██░░░░██░░░░░▀█████▀░░░░██░░░░░░██░░░░░██░░██░▀█████▀░██░██░██░░░█████▀░██████░██░░░██░██░░██░██░░██░░░██░░
	echo ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
	echo 
endef

define print-binary-input-end
	echo 
	echo ▄█████░██████▄░██████▄░░░█████▄░██████░██████▄░▄████▄░█████▄░██░░██░░░▄█████▄░██░░░██░████████░█████▄░██░░░██░████████
	echo ██░░░░░██░░░██░██░░░██░░░██░░██░░░██░░░██░░░██░██░░██░██░░██░██░░██░░░██░░░██░██░░░██░░░░██░░░░██░░██░██░░░██░░░░██░░░
	echo █████░░██░░░██░██░░░██░░░█████░░░░██░░░██░░░██░██░░██░█████▀░▀████▀░░░██░░░██░██░░░██░░░░██░░░░█████▀░██░░░██░░░░██░░░
	echo ██░░░░░██░░░██░██░░░██░░░██░░██░░░██░░░██░░░██░██████░██░░██░░░██░░░░░██░░░██░██░░░██░░░░██░░░░██░░░░░██░░░██░░░░██░░░
	echo ▀█████░██░░░██░██████▀░░░█████▀░██████░██░░░██░██░░██░██░░██░░░██░░░░░▀█████▀░▀█████▀░░░░██░░░░██░░░░░▀█████▀░░░░██░░░
	echo ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░
	echo 
endef

# Help target
.PHONY: help
help:
	@echo "Usage: make [target] [BUILD_TYPE=<dev/release>]"
	@echo ""
	@echo "Targets:"
	@echo "  all        Build the main target (default target)."
	@echo "  clean      Clean the build directory and remove compiled files."
	@echo "  run        Build and run the main executable."
	@echo "  test       Compile and run tests."
	@echo "  help       Display this help message."
	@echo ""
	@echo "Options:"
	@echo "  BUILD_TYPE  Specify build type: 'dev' (default) or 'release'."
	@echo ""
	@echo "Generated by ${AUTHOR}"
EOF
}


# Function to create a CMakeLists.txt file
create_cmake() {
    cat << EOF > $PROJECT_NAME/CMakeLists.txt
cmake_minimum_required(VERSION 3.14)

include(cmake/prelude.cmake)

project(
    $PROJECT_NAME
    VERSION 0.1.0
    DESCRIPTION "A simple C library project."
    HOMEPAGE_URL "https://example.com/"
    LANGUAGES C
)

include(cmake/project-is-top-level.cmake)
include(cmake/variables.cmake)

# ---- Declare library ----

add_library(
    $PROJECT_NAME_lib OBJECT
    source/lib.c
)

target_include_directories(
    $PROJECT_NAME_lib ${warning_guard}
    PUBLIC
    "\$<BUILD_INTERFACE:\${PROJECT_SOURCE_DIR}/source>"
)

# ---- Declare executable ----

add_executable($PROJECT_NAME_exe source/main.c)
add_executable($PROJECT_NAME::exe ALIAS $PROJECT_NAME_exe)

set_property(TARGET $PROJECT_NAME_exe PROPERTY OUTPUT_NAME $PROJECT_NAME)

target_link_libraries($PROJECT_NAME_exe PRIVATE $PROJECT_NAME_lib)

# ---- Unity Test Suite ----

add_executable(test_$PROJECT_NAME \${TEST_SRC_FILES})

target_link_libraries(test_$PROJECT_NAME PRIVATE $PROJECT_NAME_lib)

# ---- Install rules ----

if(NOT CMAKE_SKIP_INSTALL_RULES)
  include(cmake/install-rules.cmake)
endif()

# ---- Developer mode ----

if(NOT ${PROJECT_NAME}_DEVELOPER_MODE)
  return()
elseif(NOT PROJECT_IS_TOP_LEVEL)
  message(
      AUTHOR_WARNING
      "Developer mode is intended for developers of $PROJECT_NAME"
  )
endif()

include(cmake/dev-mode.cmake)
EOF
}

# Function to create initial source and header files
create_source_files() {
    cat << EOF > $PROJECT_NAME/source/lib.c
#include <stdio.h>
#include "$PROJECT_NAME.h"

void hello() {
    printf("Hello from $PROJECT_NAME!\\n");
}
EOF

    cat << EOF > $PROJECT_NAME/include/$PROJECT_NAME.h
#ifndef ${PROJECT_NAME^^}_H
#define ${PROJECT_NAME^^}_H

void hello();

#endif /* ${PROJECT_NAME^^}_H */
EOF

    cat << EOF > $PROJECT_NAME/source/main.c
#include "$PROJECT_NAME.h"

int main() {
    hello();
    return 0;
}
EOF

    # Create a sample test file
    cat << EOF > $PROJECT_NAME/tests/test_${PROJECT_NAME}.c
#include <stdio.h>
#include "$PROJECT_NAME.h"
#include "unity.h"

// Mock function declarations, if any

// Unit test function definitions
void test_hello() {
    TEST_ASSERT_EQUAL_STRING("Hello from $PROJECT_NAME!\n", "Hello from $PROJECT_NAME!\n");
}

// Add more unit tests as needed

int main() {
    UNITY_BEGIN();
    RUN_TEST(test_hello);
    // Add more tests here

    return UNITY_END();
}
EOF

    # Create a CMakeLists.txt for tests
    cat << EOF > $PROJECT_NAME/tests/CMakeLists.txt
set(TEST_SRC_FILES
    test_${PROJECT_NAME}.c
)

add_executable(test_${PROJECT_NAME} \${TEST_SRC_FILES})
target_link_libraries(test_${PROJECT_NAME} PRIVATE $PROJECT_NAME_lib)
EOF
}

# Function to initialize a Git repository
initialize_git() {
    cd $PROJECT_NAME
    git init
    echo -e "build/\n*.o\n*.a\n*.so" > .gitignore
    git add .
    git commit -m "Initial commit"
}

# Main script
if [ $# -lt 2 ]; then
    echo "Usage: $0 <project_name> <author>"
    exit 1
fi

PROJECT_NAME=$1
AUTHOR=$2

create_directories
create_readme
create_license
generate_makefile
create_cmake
create_source_files
initialize_git

echo "C library project $PROJECT_NAME has been successfully created."