Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/rswinkle/c_utils

utility functions and libraries, for lists, queue's, strings, file I/O and general utilities, and vectors in the form of CVector (which has it's own repo).
https://github.com/rswinkle/c_utils

c cpp cvector list queue string utilities utility-library vector

Last synced: 5 days ago
JSON representation

utility functions and libraries, for lists, queue's, strings, file I/O and general utilities, and vectors in the form of CVector (which has it's own repo).

Awesome Lists containing this project

README 

          

C_UTILS

=======

This started out as just 1 small library  but now includes 5 separate,

independent libraries.  This is because I now view this project as a

growing collection of any broadly useful C libraries I'm likely to

use/need in any C project.  So this is kind of like my version of

Sean Barret's [stb project](https://github.com/nothings/stb) but

specifically his stb.h, full of general useful C code.  Of course

mine is nowhere near as unified/consistent/well designed or

comprehensive but oh well.



### c_utils

What this repository started out as, made up of c_utils.c/h and basic_types.h,

this includes utilities for reading/writing to/from files and strings,

splitting, trimming, and slicing strings as well as other misc. useful

C functions.



### rsw_cstr

This is a string library modeled after CVector (It actually started

as a generated vector_char).  It has many more functions than CVector, most taken/modeled

after C++ std::string, including find, replace, substr etc.  It also has it's own functions

for file reading/writing, splitting, trimming, slicing etc.



### clist

Currently just a header file based closely on the Linux kernel's

intrusive doubly linked list type and functions/macros.  I've added

a couple functions and will add more.  I also plan to make a deque

on top of this eventually.



### CQueue

This is the all in one, cqueue.h file from [CQueue](http://github.com/rswinkle/CQueue)



### CVector

This is the all in one, cvector.h file from [CVector](http://github.com/rswinkle/CVector)



They are all written in clean C, ie they compile as C++.  This repository's

premake only builds and sort of tests c_utils but CQueue and CVector (and thus rsw_cstr

indirectly) have their own tests in their respective repos.



#### Note on the difference between c_utils and rsw_cstr

The main difference between the 2 libraries is that c_utils is very general and has many

functions that are not I/O related and while all of it's I/O, and manipulation functions work on

regular strings, they use the c_array type and can be used to read binary data and manipulate

an array of types other than char.  On the other hand, rsw_cstr's are resizable strings like

std::string, guaranteed to be null terminated (actually c_array functions null terminate too

just so that you can use them to, for example read in a string and immediately print it).



A good comparison is the split functions of the 2 libraries.  The c_utils version returns

an array of c_arrays which point into the original string you're splitting.  In other words, they aren't

allocated, they aren't NULL terminated (though it'd be easy to NULL terminate) and you can't

resize them.  The rsw_cstr version returns an array of of cstrs which you can immediately

manipulate individually, erasing, extending, printing, whatever.  Both methods are shown in main.c.



Usage

=====

To actually use the libraries just copy the appropriate c/h file(s) to your project.

To get a general idea of how to use the libraries and see it in action and how it should

behave, look at the tests in main.c or in the separate repos for CVector and CQueue.



Documentation

=============

There is some sparse documentation in the comments but it's mostly self

documenting, implementing common functions/interfaces.



LICENSE

=======

All 5 libraries are licensed under the MIT license



Copyright (c) 2013-2020 Robert Winkler



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.