https://github.com/rdipardo/libmoreinttypes
A minimal library of enhanced integer types for C
https://github.com/rdipardo/libmoreinttypes
c data-types-and-structures
Last synced: about 1 year ago
JSON representation
A minimal library of enhanced integer types for C
- Host: GitHub
- URL: https://github.com/rdipardo/libmoreinttypes
- Owner: rdipardo
- License: bsd-2-clause
- Created: 2020-10-06T08:41:08.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-21T07:57:15.000Z (about 2 years ago)
- Last Synced: 2024-04-22T03:57:25.366Z (about 2 years ago)
- Topics: c, data-types-and-structures
- Language: C
- Homepage: https://rdipardo.github.io/libmoreinttypes
- Size: 178 KB
- Stars: 5
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Description
===========
A minimal library of enhanced integer types for C
Features
--------
- read and write to encapsulated signed/unsigned `const` integers
- parse numeric strings with free functions or by calling through "member" functions
- [polymorphic function macros][]
- use only what you need:
#include <moreinttypes/core.h>
data types*, math and string library
#include <moreinttypes/utils.h>
math and string library only
* Since version 1.5, the following types are provided:
- Byte
- Int16
- Int32
- Int64
- Sbyte
- UInt16
- UInt32
- UInt64
- compiles on Windows, macOS and Linux
- compatible with code targeting ANSI C ([a GNU compiler][iso-c] supporting `-ansi` is required)
**Note**
A compiler supporting the C99 standard is required for building.
- (since version 1.7) compatible with [CPM.cmake]. See [below](#cpm-integration) for a sample configuration.
Examples
--------
**Using function macros (they wrap the "member functions")**
```c
#include
#include //< Make sure this comes last!
Int32 i = integer(122333333);
// access the underlying value . . .
printf("%d\n", i.value);
// "122333333"
// . . . but no direct assignment allowed!
// i.value = 0;
//
// error: assignment of read-only member ‘value’
// i.value = 0;
// ^
// let's set it to the value of a binary string
from_string(i, "10101010", 2);
printf("New value: %d\n", i.value);
// "New value: 170"
// what's that in base-2?
const char* bin_str = as_binary(i);
printf("%s\n", bin_str);
// "1010 1010"
from_string(i, "6", 10);
long double f = factorial(i);
printf("%d! = %.0Lf\n", i.value, f);
// "6! = 720"
```
**Using free functions**
```c
#include
#include
int value = parse_int("10101010", 2);
printf("%d\n", value);
// "170"
char buf[16] = { 0 };
const char* bin_str = binary_string(buf, 170);
printf("%s\n", bin_str);
// "1010 1010"
long double f = factorial_of(6);
printf("6! = %.0Lf\n", f);
// "6! = 720"
```
[CPM][CPM.cmake] integration
-----------------
Add the following to your project's `CMakeLists.txt`:
```cmake
cmake_minimum_required (VERSION 3.14)
# Download the 'get_cpm.cmake' module from https://github.com/cpm-cmake/CPM.cmake/releases/download/v0.39.0/get_cpm.cmake
include (get_cpm.cmake)
project (try-libmoreinttypes)
CPMAddPackage ("gh:rdipardo/libmoreinttypes#1.8.0")
add_executable (main "main.c")
add_library (libmoreinttypes INTERFACE IMPORTED)
target_link_libraries (main PUBLIC moreinttypes)
target_include_directories (main
PUBLIC
"${libmoreinttypes_SOURCE_DIR}/include"
)
set_target_properties (main moreinttypes
PROPERTIES
RUNTIME_OUTPUT_DIRECTORY "${PROJECT_SOURCE_DIR}/bin"
)
```
Building
--------
- **All environments require [cmake](https://cmake.org)**
- (_optional_) [valgrind], to profile memory usage during unit tests
- (_optional_) [pkg-config](https://packages.debian.org/sid/pkg-config), if available for your system
- (_optional_) [doxygen], if you'd like a local copy of [the documentation][]
**Windows** developers can use the [Visual C++ compiler][], edition 2015 or later.
Compiling with the [MinGW][] toolchain or inside the [MSYS2][] environment will work also.
**Linux** devs can use [gcc][] (version 4.9 and up) or [clang][] (version 3.8 and up).
### Build options
Default
-DMOREINTTYPES_BUILD_TESTS=OFF|ON
build and run unit tests
ON
-DMOREINTTYPES_BUILD_EXAMPLES=OFF|ON
build sample programs
OFF
-DMOREINTTYPES_BUILD_STATIC=OFF|ON
build a static library
OFF
-DMOREINTTYPES_ENABLE_UBSAN=OFF|ON
enable the
Undefined Behavior Sanitizer (GCC,Clang only)
OFF
-DMOREINTTYPES_RUN_DEMO=OFF|ON
run a sample program immediately after the build (requires MOREINTTYPES_BUILD_EXAMPLES)
OFF
-DMOREINTTYPES_CHECK_WITH_VALGRIND=OFF|ON
run a memory leak check with
valgrind, if installed
OFF
### Deprecated options (since [1.7.0])
Replaced by...
-DBUILD_STATIC=OFF|ON
-DMOREINTTYPES_BUILD_STATIC
-DENABLE_UBSAN=OFF|ON
-DMOREINTTYPES_ENABLE_UBSAN
-DRUN_DEMO=OFF|ON
-DMOREINTTYPES_RUN_DEMO
-DWITH_VALGRIND=OFF|ON
-DMOREINTTYPES_CHECK_WITH_VALGRIND
The build steps are the same for all environments, with one exception:
- if you're using the **Visual C++ compiler**, start the [Developer Command Prompt][]; all other users can simply log in to their usual shell
- clone the main branch and enter the root directory at the command line: `cd libmoreinttypes`
- make and enter the build directory: `mkdir cmake-build && cd cmake-build`
- run: `cmake .. `, or (to use a certain [makefile generator][]) `cmake .. -G""`
**Note**
It's better to run `cmake .. -G"NMake Makefiles"` when using the Visual C++ compiler.
This will prevent `cmake` from choosing a [Visual Studio Generator][] by default.
- run:
make
or, if using [MinGW][]:
mingw32-make
or, if using [nmake][]:
nmake
Installing
----------
As the admin user, run:
make install
or
mingw32-make install
or
nmake install
API Documentation
-----------------
To build the [the documentation] and serve it at `localhost:8000`, enter the `doxygen` directory and run:
./gendocs
or, on Windows,
.\gendocs
**Note**
Make sure [doxygen] and [python] are installed and visible to your system's `PATH`.
---
**This project took inspiration from the following sources:**
- the [C Object System](https://github.com/CObjectSystem/COS). Like this library, it strives to be compatible with ANSI/C89 while taking advantage of C99 features at compile time
- Schreiner, A.-T. (1993). [Object-oriented programming
with ANSI-C](https://www.cs.rit.edu/~ats/books/ooc.pdf). You can read the full text of this obscure classic for free online
License
-------
Copyright (c) 2020 Robert Di Pardo and Contributors. All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
[CPM.cmake]: https://github.com/cpm-cmake/CPM.cmake/#readme
[Visual C++ compiler]: https://docs.microsoft.com/en-us/cpp/build/vscpp-step-0-installation
[Developer Command Prompt]: https://docs.microsoft.com/en-us/dotnet/framework/tools/developer-command-prompt-for-vs
[MSYS2]: https://cmake.org/cmake/help/latest/generator/MSYS%20Makefiles.html#generator:MSYS%20Makefiles
[MinGW]: https://cmake.org/cmake/help/latest/generator/MinGW%20Makefiles.html
[nmake]: https://docs.microsoft.com/en-us/cpp/build/reference/running-nmake?view=msvc-160
[gcc]: https://gcc.gnu.org
[clang]: https://clang.llvm.org
[valgrind]: https://valgrind.org/downloads
[python]: https://www.python.org/downloads
[doxygen]: https://www.doxygen.nl/index.html
[makefile generator]: https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html#makefile-generators
[Visual Studio Generator]: https://cmake.org/cmake/help/latest/generator/Visual%20Studio%2014%202015.html
[the documentation]: https://rdipardo.github.io/libmoreinttypes
[polymorphic function macros]: https://rdipardo.github.io/libmoreinttypes/d2/d46/group__int__fn__wrappers.html
[1.7.0]: https://github.com/rdipardo/libmoreinttypes/commit/74e48d0
[iso-c]: https://github.com/rdipardo/libmoreinttypes/blob/5355b132ebaeb939843587191859e10d26cd1080/include/moreinttypes/_compat.h