@micro-os-plus/libs-c

A source library xPack with µOS++ complementary C library functions

These are some files that complement or extend the C library:

• c-syscalls-empty.c define weak empty syscalls to keep the linker happy; redefine those needed for retargeted configurations;
• _sbrk.c allocates block of memory in the free store (the heap) at the end of RAM, up to the stack; must match the definitions in the linker script;
• stdlib/assert.c defines the function to be called when assertions are taken;
• stdlib/atexit.cpp defines a simple registry for functions to be called when the program is terminated; useful for semihosting applications that terminate normally; the size of the static array is MICRO_OS_PLUS_INTEGER_ATEXIT_ARRAY_SIZE, default 3;
• stdlib/exit.c defines the functionality of exit() and abort()
• stdlib/init-fini.c defines weak empty _init() and _fini(), to keep linker happy.

The project is hosted on GitHub as micro-os-plus/libs-c-xpack.

Maintainer info

This page is addressed to developers who plan to include this source library into their own projects.

For maintainer info, please see the README-MAINTAINER file.

Install

As a source library xPacks, the easiest way to add it to a project is via xpm, but it can also be used as any Git project, for example as a submodule.

Prerequisites

A recent xpm, which is a portable Node.js command line application.

For details please follow the instructions in the xPack install page.

xpm

Note: the package will be available from npmjs.com at a later date.

For now, it can be installed from GitHub:

cd my-project
xpm init # Unless a package.json is already present

xpm install github:micro-os-plus/libs-c-xpack

When ready, this package will be available as @micro-os-plus/libs-c from the npmjs.com registry:

cd my-project
xpm init # Unless a package.json is already present

xpm install @micro-os-plus/libs-c@latest

ls -l xpacks/micro-os-plus-libs-c

Git submodule

If, for any reason, xpm is not available, the next recommended solution is to link it as a Git submodule below an xpacks folder.

cd my-project
git init # Unless already a Git project
mkdir -p xpacks

git submodule add https://github.com/micro-os-plus/libs-c-xpack.git \
  xpacks/micro-os-plus-libs-c

Branches

Apart from the unused master branch, there are two active branches:

• xpack, with the latest stable version (default)
• xpack-develop, with the current development version

All development is done in the xpack-develop branch, and contributions via Pull Requests should be directed to this branch.

When new releases are published, the xpack-develop branch is merged into xpack.

Developer info

TBD

Status

The library functions fully functional.

Build & integration info

To include this package in a project, consider the following details.

Include folders

The following folders should be passed to the compiler during the build:

• include

TODO: list the available headers

Source files

The source files to be added to the build are:

TODO

Preprocessor definitions

TBD

Compiler options

• -std=c++20 or higher for C++ sources
• -std=c11 for C sources

C++ Namespaces

TBD

C++ Classes

TBD

Examples

TBD

Known problems

• none

Tests

TBD

Change log - incompatible changes

According to semver rules:

Major version X (X.y.z | X > 0) MUST be incremented if any backwards incompatible changes are introduced to the public API.

The incompatible changes, in reverse chronological order, are:

• TBD

License

The original content is released under the MIT License, with all rights reserved to Liviu Ionescu.