libft package

Rules to organize files in large projects, and management system

Directory structure

libft follows the File Hierarchy Standard-like structure

• ${LIBFT_PACKAGE_ROOT}/ - the root
  • boot/ - package system
  • sys/ - temporary directory for package system
  • bin/ - executable binaries
  • lib/ - library binaries
  • etc/ - configuration files
  • opt/ - something external
  • home/ - directory for each package
  • tmp/ - temporary directory for each package
  • usr/ - directory for distribute
    • include/ - header files
    • share/ - data files
    • src/ - source files
  • var/
    • cache/ - cache directory for each package
    • log/ - log directory for each package
    • lib/ - persistent data for each package
  • src/ - directory for current source files

Files per package

Every libft package consists of three folders and some files below:

• include/ - header files to distribute
• share/ - other files like test data
• src/ - all source files
• bin.properties - optional, consists of a list of binaries
• lib.properties - optional, consists of a list of libraries
• Makefile - see Makefile rules below

Makefile rules in the package system

All commands provided as Makefile rules

init

initialize dependencies

• check sys/log/current/init_*.log file existence
• if not exist, run make reinit

deinit

remove all generated files

• move sys/log/current/init_*.log to sys/log/old if exist
• remove sys, bin, lib, tmp, usr, var directory

reinit

force re-initialize dependencies

• run make deinit
• create log file sys/log/tmp/init.log
• create empty file sys/tmp/init/packages_done.txt
• create file sys/tmp/init/packages_in_progress.txt as ls -1 home | sort
• loop...
  • ...
• remove sys/tmp/init
• move sys/log/tmp/init.log to sys/log/current/init_(timestamp).log

Makefile rules for each package

libft package must have Makefile in the project root directory with rules below:

• rules derived from the Norm
  • all: build all library/executable final targets
  • clean: remove temporary files
  • fclean: clean + remove result/cache files too
  • re: all after fclean
• additional rules for libft package
  • init: initialize/refresh dependencies
  • test: test self functionality (e.g. unit test)
  • check: check functionality (e.g. acceptance test)
  • install: distribute result files

The rules above requires the environment variable LIBFT_PACKAGE_ROOT

Makefile must be compliant with POSIX makefile for portability

Package manifest

WIP

Name

<first-part> ::= [a-z]
<part> ::= <first-part> | [0-9]
<word>
  ::= <first-part>
    | <word> <part>

Package name

The package name is an underscore-concatenated list of one or more non-empty strings beginning with a lowercase letter consisting of a lowercase letter and a number.

<package-name>
  ::= <word>
    | <package-name> "_" <word>

Files to distribute

For ease of use, naming files is strictly restricted to (package name)[_*].{c,h} or (directory)/(package name)__(directory name)[_*].{c,h}, anything inside another directory is not allowed.

<dist-file-name>
  ::= "(package-name).c"
    | "(package-name).h"
    | "(package-name)__" <dist-file-name-part> ".c"
    | "(package-name)__" <dist-file-name-part> ".h"

<dist-file-name-part>
  ::= ""
    | <dist-file-name-part> "_" <word>

Example: the allowed file names for some_name is:

• some_name.c
• some_name.h
• some_name_types.h
• impl/some_name_impl.c
• impl/some_name_impl_main.c
• impl/fallback/some_name_impl_fallback.c
• impl/fallback/some_name_impl_fallback_main.c