Add Hashbag, RCU Cache and README

Author: kjellwinblad

.gitignore

@@ -59,4 +59,8 @@ GTAGS
 TAGS
 test.bin
 
-tmp_test.c
+tmp_test.c
+
+*.bin
+tags
+tmp_test_dynarr.c

Makefile

@@ -2,75 +2,106 @@ IDIR = .
 CC = cc
 
 ifdef MODERN_CC
-	EXTRA_C_FLAGS = -g -O03 -std=c99 -pedantic -Wall
+	EXTRA_C_FLAGS = -g -O03 -std=c99 -pedantic -Wall -Wno-unused-function
 endif
 
 ifdef CC_32_BIT
-	EXTRA_C_FLAGS = -m32 -g -O03 -std=c99 -pedantic -Wall
+	EXTRA_C_FLAGS = -m32 -g -O03 -std=c99 -pedantic -Wall -Wno-unused-function
 endif
 
 ifdef ADD_SAN
 	CC = clang
-	EXTRA_C_FLAGS = -std=c99 -Wall -pedantic -g -O00 -fsanitize=address -fno-omit-frame-pointer
-	USE_GC_STRING = -use_gc
+	EXTRA_C_FLAGS = -std=c99 -Wall -pedantic -g -O00 -fsanitize=address -fno-omit-frame-pointer -Wno-unused-function
 endif
 
 ifdef MEM_SAN
 	CC = clang
-	EXTRA_C_FLAGS = -std=c99 -Wall -pedantic -g -O00 -fsanitize=memory -fno-omit-frame-pointer
+	EXTRA_C_FLAGS = -std=c99 -Wall -pedantic -g -O00 -fsanitize=memory -fno-omit-frame-pointer -Wno-unused-function
 endif
 
 ifdef UB_SAN
 	CC = clang
-	EXTRA_C_FLAGS = -std=c99 -Wall -pedantic -g -O00 -fsanitize=undefined -fno-omit-frame-pointer
+	EXTRA_C_FLAGS = -std=c99 -Wall -pedantic -g -O00 -fsanitize=undefined -fno-omit-frame-pointer -Wno-unused-function
 endif
 
-CFLAGS =  -g -O01 -I$(IDIR) $(EXTRA_C_FLAGS)
+CFLAGS =  -g -O00 -I$(IDIR) $(EXTRA_C_FLAGS)
 
 ODIR = .
 LDIR =
 
-DEPS = dynarr.h test_framework.h
+_DEPS = dynarr.h test_framework.h hashbag.h lru.h list.h
 DEPS = $(patsubst %,$(IDIR)/%,$(_DEPS))
 
-_OBJ = test.o
+_OBJ = test_dynarr.o
 OBJ = $(patsubst %,$(ODIR)/%,$(_OBJ))
 C_FILES = $(patsubst %.o,%.c,$(_OBJ))
 
+_OBJ2 = test_hashbag.o
+OBJ2 = $(patsubst %,$(ODIR)/%,$(_OBJ2))
+C_FILES2 = $(patsubst %.o,%.c,$(_OBJ2))
+
+_OBJ3 = test_lru.o
+OBJ3 = $(patsubst %,$(ODIR)/%,$(_OBJ3))
+C_FILES3 = $(patsubst %.o,%.c,$(_OBJ3))
+
+ALL_CFILES = $(C_FILES) $(C_FILES2) $(C_FILES3)
+
+main: test_dynarr.bin test_hashbag.bin test_lru.bin
+	echo OK
+
 $(ODIR)/%.o: %.c $(DEPS)
 	$(CC) -c -o $@ $< $(CFLAGS)
 
-test.bin: $(OBJ)
+test_dynarr.bin: $(OBJ)
 	$(CC) -o $@ $^ $(CFLAGS)
 
+test_hashbag.bin: $(OBJ2)
+	$(CC) -o $@ $^ $(CFLAGS)
+
+test_lru.bin: $(OBJ3)
+	$(CC) -o $@ $^ $(CFLAGS)
 
 .PHONY: clean test run_test_continusly CMakeLists.txt cmake_compile clang_format test_add_san test_ub_san test_mem_san test_sanitizers test_modern_cc test_valgrind test_macro_expanded.bin
 
-test_macro_expanded.bin:
-	gcc -E -C -P test.c > tmp_tmp_test.c
+test_macro_expanded_gen:
+	gcc -E -C -P $(TESTPROG) > tmp_tmp_test.c
 	clang-format tmp_tmp_test.c > tmp_test.c
 	rm tmp_tmp_test.c
-	gcc -g -O01 tmp_test.c
+	gcc -Wall -Wno-unused-function  -g -O01 tmp_test.c
 	valgrind --leak-check=full ./a.out
 
-test: test.bin
-	./test.bin ;\
+test_macro_expanded_dynarr:
+	TESTPROG=test_dynarr.c make test_macro_expanded_gen
+
+test_macro_expanded_hashbag:
+	TESTPROG=test_hashbag.c make test_macro_expanded_gen
+
+test_macro_expanded_lru:
+	TESTPROG=test_lru.c make test_macro_expanded_gen
+
+test: test_dynarr.bin test_hashbag.bin test_lru.bin
+	./test_dynarr.bin && ./test_hashbag.bin && ./test_lru.bin;\
 	RESULT=$$? &&\
 	(exit $$RESULT) &&\
 	printf "\n\n\033[0;32mALL TESTS PASSED!\033[0m\n\n\n" ||\
 	printf "\n\n\033[0;31mTEST FAILED!\033[0m\n\n\n" &&\
 	exit $$RESULT
 
-test_valgrind:
+test_valgrind_gen:
 	make clean && \
 	make EXTRA_C_FLAGS="-g -O01" && \
-	valgrind --undef-value-errors=no ./test.bin ;\
+	valgrind --undef-value-errors=no --leak-check=full $(BIN) ;\
 	RESULT=$$? &&\
 	(exit $$RESULT) &&\
 	printf "\n\n\033[0;32mALL TESTS PASSED!\033[0m\n\n\n" ||\
 	printf "\n\n\033[0;31mTEST FAILED!\033[0m\n\n\n" &&\
 	exit $$RESULT
 
+test_valgrind:
+	BIN=./test_dynarr.bin make test_valgrind_gen
+	BIN=./test_hashbag.bin make test_valgrind_gen
+	BIN=./test_lru.bin make test_valgrind_gen
+
 test_add_san:
 	make clean && \
 	make ADD_SAN=1 test
@@ -100,18 +131,24 @@ test_32_bit:
 test_all:
 	make test_valgrind && \
 	make test_sanitizers && \
-	make test_modern_cc && \
-	make test_32_bit
+	make test_modern_cc
+# make test_32_bit
 
 run_test_continusly:
 	inotifywait -e close_write,moved_to,create -m ./*.c ./*.h | while read -r directory events filename; do gtags ; make test ; done
 
-CMakeLists.txt: $(C_FILES)
+CMakeLists.txt: $(C_FILES) $(C_FILES2) $(C_FILES3) 
 	echo "cmake_minimum_required (VERSION 2.6)" > CMakeLists.txt
-	echo "project (SIMPLE_C_GC)" >> CMakeLists.txt
-	echo "add_executable(cmake.out" >> CMakeLists.txt
+	echo "project (DS)" >> CMakeLists.txt
+	echo "add_executable(dynarr.out" >> CMakeLists.txt
 	echo $(C_FILES) >> CMakeLists.txt
 	echo ")" >> CMakeLists.txt
+	echo "add_executable(hashbag.out" >> CMakeLists.txt
+	echo $(C_FILES2) >> CMakeLists.txt
+	echo ")" >> CMakeLists.txt
+	echo "add_executable(lru.out" >> CMakeLists.txt
+	echo $(C_FILES3> CMakeLists.txt
+	echo ")" >> CMakeLists.txt
 
 
 cmake_compile: CMakeLists.txt
@@ -125,4 +162,4 @@ clang_format:
 	clang-format -style="{BasedOnStyle: LLVM}" -i *.c *.h
 
 clean:
-	rm -f $(ODIR)/*.o *~ core $(IDIR)/*~ test.bin CMakeLists.txt
+	rm -f $(ODIR)/*.o *~ core $(IDIR)/*~ test_dynarr.bin CMakeLists.txt

README.md

@@ -1,2 +1,55 @@
-# c_reusable_data_structures
-Some resusable data structures implemented in C
+# C Reusable Data Structures
+
+This repository contains reusable generic data structures for C.
+The data structures are generated by macros that generate structs
+and functions for a specific type. For example, one can generate
+one dynamic array (`dynarr.h`) holding objects of type int and another
+for holding objects of type double or any other type you like.
+
+## Currently Available Data Structures
+
+The following data structures are currently available in the
+library.
+
+### Dynamic Array (`dynarr.h`)
+  
+See `test_dynarr.c` for how to use the dynamic arrays. Notice that the test
+cases do not cover all available functions yet.
+
+
+### Hash Bag (`hashbag.h`)
+  
+See `test_harhbag.c` for how to use hash bags. The same data structure can be
+used for hash maps and hash sets with some creativity.
+
+
+### LRU Cache (`hashbag.h`)
+  
+See `test_lru.c` for how to use lru caches.
+
+
+# Testing
+
+    make test
+
+To run valgrind tests etc:
+
+    make test_all
+
+# Contribute
+
+Send pull requests to:
+
+https://github.com/kjellwinblad/c_reusable_data_structures
+
+
+# License
+
+Apache License 2.0
+
+See license file for detail.
+
+# Contact
+
+The original author (Kjell Winblad, https://dupwin.se) can be contacted at
+[email protected]