ffbase is a fast C library which implements base containers & algorithms.

C language doesn't have this functionality by default (contrary to almost all other languages which have their rich standard library out of the box) and ffbase attempts to fill this hole.

ffbase is header-only (.h-only) and doesn't need to be built into .a/.so/.dll before use - you just include .h file and that's all.

Contents:

• Naming
• Features
• Requirements
• Where to use
• How to use
• Configure
• Develop

As there are no namespaces in C, everything here starts with an ff prefix. Then follows the short prefix for the namespace (or a context) and then the name of the function. For example:

• ffstr is a string container
• ffstr_*() are functions which work with it, e.g. ffstr_cmp() compares strings

All components follow this convention.

String/text:

Containers:

JSON:

Atomic:

Other:

• gcc or clang

In C and C++ projects that require fast and small code without unnecessary dependencies.

1. Clone ffbase repo:

    $ git clone https://github.com/stsaz/ffbase
   

2. In your build script:

    -IFFBASE_DIR
   

where FFBASE_DIR is your ffbase/ directory.

3. And then just use the necessary files:

    #include <ffbase/slice.h>
   

To avoid copying the whole ffbase repo into your project while all you need is, for example, "slices", you may just copy a few files to your project directory.

1. Clone ffbase repo and copy the necessary files:

    $ git clone https://github.com/stsaz/ffbase
    $ mkdir YOUR_PROJECT/include/ffbase/
    $ cp ffbase/ffbase/slice.h ffbase/ffbase/base.h  YOUR_PROJECT/include/ffbase/
   

   where YOUR_PROJECT is your project's directory.

2. Then, edit YOUR_PROJECT/include/ffbase/slice.h and remove the dependencies (marked as optional) you don't need, for example:

    #ifndef _FFBASE_BASE_H
    #include <ffbase/base.h>
    #endif
    -#include <ffbase/sort.h> // optional
    +// #include <ffbase/sort.h> // optional
   

   Or you can copy sort.h file too if you need it.

3. In your build script:

    -IYOUR_PROJECT/include
   

4. And then just use the necessary files:

    #include <ffbase/slice.h>
   

Use these preprocessor definitions to enable new functionality or to change the existing logic:

To enable SSE4.2 code use -msse4.2 compiler flag and provide storage for int _ffcpu_features.

• code
• tests
• in-code documentation
• examples in doc/

Header:

/** ffbase: description
Year, Author Name
*/

Unique ID for the optional .h files, so their includers can disable the functionality:

#define _FFBASE_SORT_H

Don't use any standard functions directly, otherwise it will be impossible to substitute the lower level functions. For example, don't use memcpy() - use ffmem_copy() instead. This gives us the ability to easily add functionality such as counting the number of bytes copied per thread, before actually calling memcpy().

cd test
make
./fftest all

on FreeBSD:

gmake

on Linux for Windows:

make OS=windows

To another directory:

mkdir /tmp/ffbase
cd /tmp/ffbase
make -Rrf MYSRC/ffbase/test/Makefile SRCDIR=MYSRC/ffbase
cp -ruv MYSRC/ffbase/test/data /tmp/ffbase
./fftest all

Message:

• + component: message - new feature
• * component: message - change, small improvement
• - component: message - bugfix