Initial Commit
This commit is contained in:
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) [year] [fullname]
|
||||
|
||||
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.
|
||||
76
Makefile
Normal file
76
Makefile
Normal file
@@ -0,0 +1,76 @@
|
||||
# Compiler Flags
|
||||
CC := gcc
|
||||
CFLAGS := -g -Wall -Wextra -Werror -pedantic -fsanitize=address,undefined -fno-omit-frame-pointer
|
||||
|
||||
# Directory variables
|
||||
LIBDIR := lib
|
||||
OBJ := obj
|
||||
INC := include
|
||||
SRC := src
|
||||
TEST := tests
|
||||
|
||||
# Filepath Pattern Matching
|
||||
LIB := $(LIBDIR)/lib.a
|
||||
SRCS := $(wildcard $(SRC)/*.c)
|
||||
OBJS := $(patsubst $(SRC)/%.c, $(OBJ)/%.o, $(SRCS))
|
||||
TESTS := $(wildcard $(TEST)/*.c)
|
||||
TESTBINS := $(patsubst $(TEST)/%.c, $(TEST)/bin/%, $(TESTS))
|
||||
|
||||
# Commands must be labeled PHONY
|
||||
.PHONY: all release clean test
|
||||
|
||||
# Compiler Release Flags
|
||||
release: CFLAGS := -Wall -Wextra -Werror -pedantic -fsanitize=address,undefined -fno-omit-frame-pointer -O2 -DNDEBUG
|
||||
release: clean $(LIB)
|
||||
|
||||
# Target for compilation.
|
||||
all: $(LIB)
|
||||
|
||||
# Target / Dependencies
|
||||
$(LIB): $(OBJS) | $(LIBDIR)
|
||||
$(RM) $(LIB)
|
||||
ar -cvrs $@ $^
|
||||
|
||||
$(OBJ)/%.o: $(SRC)/%.c $(SRC)/%.h | $(OBJ)
|
||||
$(CC) $(CFLAGS) -c $< -o $@
|
||||
|
||||
$(OBJ)/%.o: $(SRC)/%.c | $(OBJ)
|
||||
$(CC) $(CFLAGS) -c $< -o $@
|
||||
|
||||
$(TEST)/bin/%: $(TEST)/%.c $(LIB) | $(TEST)/bin
|
||||
$(CC) $(CFLAGS) $< $(LIB) -o $@
|
||||
|
||||
# Make directories if none.
|
||||
$(LIBDIR):
|
||||
mkdir $@
|
||||
|
||||
$(INC):
|
||||
mkdir $@
|
||||
|
||||
$(OBJ):
|
||||
mkdir $@
|
||||
|
||||
$(TEST)/bin:
|
||||
mkdir $@
|
||||
|
||||
# Run the tests in the bin folder and track results
|
||||
test: $(LIB) $(TEST)/bin $(TESTBINS)
|
||||
@SUCCESS_COUNT=0; FAILURE_COUNT=0; \
|
||||
for test in $(TESTBINS); do \
|
||||
./$$test; \
|
||||
EXIT_CODE=$$?; \
|
||||
TEST_NAME=$(notdir $$test); \
|
||||
if [ $$EXIT_CODE -eq 0 ]; then \
|
||||
echo "\033[0;32m$$TEST_NAME: EXIT CODE: $$EXIT_CODE (SUCCESS)\033[0m"; \
|
||||
SUCCESS_COUNT=$$((SUCCESS_COUNT + 1)); \
|
||||
else \
|
||||
echo "\033[0;31m$$TEST_NAME: EXIT CODE: $$EXIT_CODE (FAILURE)\033[0m"; \
|
||||
FAILURE_COUNT=$$((FAILURE_COUNT + 1)); \
|
||||
fi; \
|
||||
done; \
|
||||
echo "\n\nTests completed"; \
|
||||
echo "SUCCESS: $$SUCCESS_COUNT"; \
|
||||
echo "FAILURE: $$FAILURE_COUNT";
|
||||
|
||||
clean:
|
||||
$(RM) -r $(LIBDIR) $(OBJ) $(TEST)/bin/
|
||||
57
README.md
Normal file
57
README.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# ci2
|
||||
|
||||
## Description
|
||||
Inspired by the [book](https://github.com/drh/cii), and others, this is my
|
||||
personal C codebase. I wanted to improve my C and DSA knowledge, and make some
|
||||
useful tools since C doesn't have many language features. This is meant to be
|
||||
opinionated, and not necessarily modular. It's not meant to be the best way,
|
||||
but I hope to improve it overtime.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Features](#features)
|
||||
- [Usage](#usage)
|
||||
- [Credits / Resources](#credits--resources)
|
||||
- [License](#license)
|
||||
|
||||
## Features / TODOS
|
||||
Plan to follow CII book and modify it to my style and use C99.
|
||||
|
||||
- [ ] Exceptions
|
||||
- [ ] Memory Allocator
|
||||
- [ ] Arena Allocator
|
||||
- [ ] String Views
|
||||
- [ ] Atoms / Quarks
|
||||
- [ ] Linked List
|
||||
- [ ] Stacks
|
||||
- [ ] Queues
|
||||
- [ ] Vectors / Dynamic Arrays
|
||||
- [ ] CLI Parsing
|
||||
- [ ] Opening A Window
|
||||
|
||||
Once these are implemented. The focus will then shift to make our code cross
|
||||
platform, along with a simple build process.
|
||||
|
||||
|
||||
## Usage
|
||||
`make` to build.
|
||||
|
||||
`make test` to build and run tests.
|
||||
|
||||
## Credits / Resources
|
||||
[Tom Preston-Werner README Driven Development](https://tom.preston-werner.com/2010/08/23/readme-driven-development)<br>
|
||||
[Make a README](https://www.makeareadme.com/)<br>
|
||||
[Choose a LICENSE](https://choosealicense.com/)<br>
|
||||
[C Interfaces and Implementations](https://github.com/drh/cii)<br>
|
||||
[Sean Barrett - Advice for Writing Small Programs in C](https://www.youtube.com/watch?v=eAhWIO1Ra6M)<br>
|
||||
[Eskil Steenberg - How I Program C](https://www.youtube.com/watch?v=443UNeGrFoM)<br>
|
||||
[Handmade Hero](https://www.youtube.com/playlist?list=PLnuhp3Xd9PYTt6svyQPyRO_AAuMWGxPzU)<br>
|
||||
[Mr. 4th Programming](https://www.youtube.com/playlist?list=PLT6InxK-XQvNKTyLXk6H6KKy12UYS_KDL)<br>
|
||||
[Chris Wellons](https://nullprogram.com/)<br>
|
||||
[Ginger Bill](https://www.gingerbill.org/)<br>
|
||||
[Tsoding Daily](https://www.youtube.com/@TsodingDaily)<br>
|
||||
[Jacob Sorber](https://www.youtube.com/channel/UCwd5VFu4KoJNjkWJZMFJGHQ)<br>
|
||||
|
||||
## License
|
||||
This project is licensed under MIT - see the [LICENSE](LICENSE) file for details.
|
||||
BIN
include/.ci2.h.swp
Normal file
BIN
include/.ci2.h.swp
Normal file
Binary file not shown.
1
src/linux_ci2.c
Normal file
1
src/linux_ci2.c
Normal file
@@ -0,0 +1 @@
|
||||
#include "../include/ci2.h"
|
||||
9
src/win32_ci2.cpp
Normal file
9
src/win32_ci2.cpp
Normal file
@@ -0,0 +1,9 @@
|
||||
#include <windows.h>
|
||||
|
||||
int CALLBACK WinMain( HINSTANCE hInstance,
|
||||
HINSTANCE hPrevInstance, // Legacy
|
||||
PWSTR pCmdLine, // Command Line
|
||||
int nCmdShow ) // Window Size
|
||||
{
|
||||
return 0;
|
||||
}
|
||||
Reference in New Issue
Block a user