Initial commit

Author: doczy

.gitignore

@@ -0,0 +1,6 @@
+.csv
+*~*
+.so
+.o
+.a
+.swp

LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Jan Doczy
+
+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.
+

Makefile

@@ -0,0 +1,62 @@
+# simle makefile used to build csv dynamic | static library
+
+##include Config.mk
+ifeq ($(CC),)
+	CC=gcc
+endif
+ifeq ($(AR),)
+	AR=ar
+endif
+
+CC_FILES = csv.c
+SHARED_DIR = ./shared
+STATIC_DIR = ./static
+TEST_DIR = ./test
+SHARED_OBJ := $(CC_FILES:%.c=$(SHARED_DIR)/%.o) 
+STATIC_OBJ := $(CC_FILES:%.c=$(STATIC_DIR)/%.o) 
+SHARED_LIB := $(SHARED_DIR)/csv.so 
+STATIC_LIB := $(STATIC_DIR)/csv.a
+TEST_BIN := $(TEST_DIR)/test
+CFLAGS= -O3 -Wall -ansi -pedantic -g
+DEFINES = -D_FILE_OFFSET_BITS=64
+
+# make both, shared and static + test
+all: make_outdir $(SHARED_LIB) $(STATIC_LIB) $(TEST_BIN) runtest
+shared: make_outdir $(SHARED_LIB)
+static: make_outdir $(STATIC_LIB)
+
+make_outdir:
+	$(shell mkdir -p $(SHARED_DIR) $(STATIC_DIR))
+
+# shared library target
+$(SHARED_LIB): CFLAGS += -fPIC
+$(SHARED_LIB): $(SHARED_OBJ)
+	$(CC) $^ -shared -o $@ 
+
+$(STATIC_LIB): $(STATIC_OBJ)
+	$(AR) rcs $@ $^
+
+# compile test binary
+$(TEST_BIN): CFLAGS=-O3 -Wall -pedantic
+$(TEST_BIN): test.c
+	$(CC) $(CFLAGS) $^ $(STATIC_LIB) -lrt -o $@
+
+# all shared objs pass 
+$(SHARED_DIR)/%.o: %.c
+	$(CC) $^ $(CFLAGS) -c -o $@
+
+# all static
+$(STATIC_DIR)/%.o: %.c
+	$(CC) $^ $(CFLAGS) -c -o $@
+
+# runtests
+runtest:
+	./test/runtest.sh
+
+
+# try clean both static and dynamic
+clean:
+	rm -fR $(SHARED_DIR)
+	rm -fR $(STATIC_DIR)
+	rm -f $(TEST_BIN) $(TEST_DIR)/*.csv
+

README.md

@@ -0,0 +1,87 @@
+# Simple and fast CSV reader written in C
+
+## Description
+Simple and fast library for fast reading of large CSV files using memory-mapped files.
+Purpose of this project was to create fast CSV (comma separated values) reader implementation in C with very simple interface using memory-mapped files.
+
+## Features
+* Simple C interface
+* Very large CSV file support - GBs, TBs
+* Using memory mapped files
+* Supports UNIX and Windows platforms
+* UTF-8 support
+* Supports both Windows CRLF "\r\n" and Unix LF "\n" sequences
+* Supports newlines "\n" in CSV columns
+* Spaces are preserved (e.g "one, two" -> {"one", " two"})
+
+## How to compile
+You can add ```csv.c``` file to your project or you can use Makefile provided.
+To compile csv library on Linux with GNU Make:
+
+* run ```make all``` from project root to compile all targets and test application
+
+## How to use (trivial example)
+Error handing ommited for brevity
+
+```C++
+char* row;
+int cols = 0;
+CsvHandle handle = CsvOpen("csvfile.csv");
+
+while (row = CsvReadNextRow(handle))
+{
+    /* row = CSV row string */
+    const char* col;
+    while (col = CsvReadNextCol(row, handle))
+        cols++;  /* col = CSV col string */
+}
+
+printf("Number of cols %i", cols);
+```
+
+## Public API functions
+
+If you want to read classic CSV files, you can follow this pipeline:
+1. ```CsvOpen()``` to open CSV file
+2. ```CsvReadNextRow()``` to read single CSV line
+3. ```CsvReadNextCol()``` to read single CSV column
+4. ```CsvClose()``` to close opened CSV handle
+
+### ```CsvOpen(const char* filepath)```
+Opens a CSV file.
+#### Paramters:
+* filepath, (```const char*```): path to a CSV file
+#### Return value:
+```CsvHandle```: handle to a CSV file on success, NULL otherwise
+
+### ```CsvOpen2(const char* filepath, char delim, char quote, char escape)```
+Opens a CSV file. You can specify custom CSV delimeter, quote and escape char.
+#### Parameters:
+* filepath, (```const char*```): path to a CSV file
+* delim (```char```): custom CSV delimeter ASCII character (default ',')
+* quote (```char```): custom CSV quote ASCII character (default '"')
+* escape (```char```): custom CSV escape ASCII character (default '\\')
+#### Return value:
+```CsvHandle```: handle to a CSV file on success, NULL otherwise
+
+### ```CsvClose(CsvHandle handle)```
+Releases all resources allocated.
+#### Parameters:
+* handle (```CsvHandle```): handle opened by CsvOpen() or CsvOpen2()
+
+### ```CsvReadNextRow(CsvHandle handle)```
+Returns pointer to new line (UTF-8 zero terminated string) or NULL.
+#### Parameters:
+* handle (```CsvHandle```): handle opened by CsvOpen() or CsvOpen2()
+#### Return value:
+```char*```: zero terminated string on success, NULL on EOF or error.
+
+### ```CsvReadNextCol(CsvHandle handle, char* row)```
+Returns pointer to column (UTF-8 zero terminated string) or NULL
+#### Parameters:
+* handle (```CsvHandle```): handle opened by CsvOpen() or CsvOpen2()
+#### Return value
+```const char*```: zero terminated string on success, NULL on EOL or error.
+
+## License
+MIT (see LICENSE.txt)