View on GitHub

z_

An Easy-to-use Framework for the C Language.

z_

Core Language Module with datatypes, memory tracker, and _more_.

About

This library provides Core Functionality built upon the C language. Inspired and taken from Modern Languages such as Python, Rust etc.

Sub-Modules

List of sub-modules of provided by the library.

Pre-Processing Modules (PreP)

Meta-programming using C-preprocessor. Explore Source

Helper function for preprocessor macros, not used directly

Prelude

Stuff that is probably needed everywhere.

Getting Started

z_ is made with modularity in mind so many parts of it are as self-isolated as they can, it doesn’t even include standard library except stddef.h, stdint.h and stdbool.h for type declaration but they still require the bare minimum base for to be working properly such as, z_/arr.h can be included in itself but it still require base.h of types for z__u32 and mem.h for memory allocation definitions.

Therefore, You need to explicitly include the <stdlib.h>, <string.h>.

Installing

Method 1: Local Integration

Inorder to integrated z_ in your project only

git clone --depth=1 git://github.com/zakarouf/z_.git
sh build.sh lib

Will result a library libz_.a created in the ./build/lib and headers at ./build/include as z_ directory.

Copy the z_ folder onto your include directory. And copy the libz_.a to the lib directory and link it against the executable and we are good to go.

#include <z_/z_.h>

Method 2: Global Installation

Run the build.sh script, with the following parameters 

sh build.sh install lib

By Default, the path for Headers is usr/local/include/z_ and for library it is libz_.a, you can change it by editing the build.sh file itself, LIB_DIR and INCLUDE_DIR to be specfic.

Config

Inside the source directory config_{MODULE}.h that can be modified by the user in-order to change the behaviour, include, exclude the fuctionality of that sub-library.

{MODULE} is the name of the Module i.e. config_imp.h, config_prep.h etc.

Such as inside of src/lib/_config_types.h

#define Z___TYPE_CONFIG__USE_TYPE_LINKEDLIST

This particular config tells to include the Linked List type and its functionaity at core; when z_.h is included, and if we comment out it

//#define Z___TYPE_CONFIG__USE_TYPE_LINKEDLIST

error1

Will result in a error This forces to you to include linked list type manually.

#include <z_/types/llist.h>

Now this will work as it should.

Using Library

z_ is now uses stb-style header impletation macro without compiling a .a library to link to. Define Z__IMPLEMENTATION in any one of the source file before including the header. I would recommended creating a seperate empty source file with all the impletation defined.

#define Z__IMPLEMENTATION
#include <z_/time.h>

Adding Syntax Highlighting (Vim & NeoVim)

Additional syntax Highlighting for types and such are include in the extra/c.vim.

To add it into your project, either copy the contents of the c.vim file or put c.vim into your after/syntax folder, such as ~/.config/vim/after/syntax/ directory. This will load on top of your syntax highlighting for every .c file.

Documentation

FAQs

Why did I create this library? || History behind z_.

z_ had a humble beginning as a single header for defining primitive types in ztorg project.
Later on I added more quality of life stuff such as Type-Generic Dyanmic Arrays etc. It was then I decided to move its development to a separate repo with more than just a “Data Type Library”. I wanted to created a core, standard-library that I can just use anywhere as a starting point.

Os & Compiler Support?

Linux and MacOS is fully supported while, with Windows your mileage might vary.

As for Compiler GCC or Clang is recommended.

Why heavy use of macros?

Bloat. Creating such library that I can use anywhere, I wanted to have as less bloated binary wise as posible, while also having to combat the non-type generic nature of the C language.
If by any case, I dont want use a bare macro. I would wrap it up inside of a function.

#define my_macro_function(a, b) { ... }

void my_function(int a, int b)
{
    my_macro_function(a, b);
}

Who is this for?

Me. Or you if you stumble upon my stuff and found it cool. But as of writing, I created this for myself. This repo is so I can easily maintain and access the code and or share it with my friends. I am not a good Programmer by a long shot, I just like when my computer goes beep-boop.

Credit & References

It takes many features from other libraries and projects. Whilst also some Reffrences and books.

Types

Sum Types :: z__Enum

Hirrolot’s Datatype99. For my own implementation of Sum Types. The actual impletation is dis-similar to them. My implementation of z__Enum is no where near as elegant as Datatype99.

Misc

Awesome C Preprocessor Helped to study on the C’s magical Preprocessor.

Previews & Example

Sum of an Integer Array
Intializing an Array of Functions in a single line
Sum of Binary tree using Enum
Web Event with Enums
Fill Up an array of Vector2 with OpenMP
Creating a Map with Pthread

See Also

Ending Note

This library is not perfect and I know there are many others like it, but this one is mine <3.