cosmopolitan/libc
Justine Tunney 1bc3a25505 Improve documentation
The Cosmo API documentation page is pretty good now
https://justine.lol/cosmopolitan/documentation.html
2020-12-27 07:02:35 -08:00
..
alg Improve documentation 2020-12-27 07:02:35 -08:00
bits Improve documentation 2020-12-27 07:02:35 -08:00
calls Improve documentation 2020-12-27 07:02:35 -08:00
crt
crypto Add chibicc 2020-12-06 16:20:21 -08:00
dns Improve documentation 2020-12-27 07:02:35 -08:00
elf Improve documentation 2020-12-27 07:02:35 -08:00
fmt Improve documentation 2020-12-27 07:02:35 -08:00
integral Auto-generate some documentation 2020-12-26 02:09:07 -08:00
intrin Make minor improvements 2020-12-23 23:42:56 -08:00
isystem Fold conv package into fmt 2020-12-09 16:52:00 -08:00
linux Improve documentation 2020-12-27 07:02:35 -08:00
log Improve documentation 2020-12-27 07:02:35 -08:00
math Improve documentation 2020-12-27 07:02:35 -08:00
mem Improve documentation 2020-12-27 07:02:35 -08:00
nexgen32e Improve documentation 2020-12-27 07:02:35 -08:00
nt Improve documentation 2020-12-27 07:02:35 -08:00
ohmyplus
rand Improve documentation 2020-12-27 07:02:35 -08:00
runtime Improve documentation 2020-12-27 07:02:35 -08:00
sock Improve documentation 2020-12-27 07:02:35 -08:00
stdio Improve documentation 2020-12-27 07:02:35 -08:00
str Improve documentation 2020-12-27 07:02:35 -08:00
stubs Make improvements 2020-12-01 03:43:40 -08:00
sysv Improve documentation 2020-12-27 07:02:35 -08:00
testlib Improve documentation 2020-12-27 07:02:35 -08:00
time Improve documentation 2020-12-27 07:02:35 -08:00
tinymath Improve documentation 2020-12-27 07:02:35 -08:00
unicode Improve documentation 2020-12-27 07:02:35 -08:00
x Improve documentation 2020-12-27 07:02:35 -08:00
zipos Improve documentation 2020-12-27 07:02:35 -08:00
README.md
assert.h Add chibicc 2020-12-06 16:20:21 -08:00
complex.h Make improvements 2020-12-01 03:43:40 -08:00
dce.h Auto-generate some documentation 2020-12-26 02:09:07 -08:00
disclaimer.inc
errno.h
inttypes.h
libc.mk Fold conv package into fmt 2020-12-09 16:52:00 -08:00
limits.h
literal.h
mach.h
macho.internal.h
macros-cpp.internal.inc Make minor improvements 2020-12-23 23:42:56 -08:00
macros.h Make minor improvements 2020-12-23 23:42:56 -08:00
macros.internal.inc Make minor improvements 2020-12-23 23:42:56 -08:00
math.h Auto-generate some documentation 2020-12-26 02:09:07 -08:00
notice.inc
notice.internal.h
paths.h
zip.h

README.md

SYNOPSIS

Cosmopolitan Standard Library.

OVERVIEW

This directory defines static archives defining functions, like printf(), mmap(), win32, etc. Please note that the Cosmopolitan build configuration doesn't link any C/C++ library dependencies by default, so you still have the flexibility to choose the one provided by your system. If you'd prefer Cosmopolitan, just add (LIBC) and (CRT) to your linker arguments.

Your library is compromised of many bite-sized static archives. We use the checkdeps tool to guarantee that the contents of the archives are organized in a logical way that's easy to use with or without our makefile infrastructure, since there's no cyclic dependencies.

The Cosmopolitan Library exports only the most stable canonical system calls for all supported operating systems, regardless of which platform is used for compilation. We polyfill many of the APIs, e.g. read(), write() so they work consistently everywhere while other apis, e.g. CreateWindowEx(), might only work on one platform, in which case they become no-op functions on others.

Cosmopolitan polyfill wrappers will usually use the dollar sign naming convention, so they may be bypassed when necessary. This same convention is used when multiple implementations of string library and other performance-critical function are provided to allow Cosmopolitan to go fast on both old and newer computers.

We take an approach to configuration that relies heavily on the compiler's dead code elimination pass (libc/dce.h). Most of the code is written so that, for example, folks not wanting support for OpenBSD can flip a bit in SUPPORT_VECTOR and that code will be omitted from the build. The same is true for builds that are tuned using -march=native which effectively asks the library to not include runtime support hooks for x86 processors older than what you use.

Please note that, unlike Cygwin or MinGW, Cosmopolitan does not achieve broad support by bolting on a POSIX emulation layer. We do nothing more than (in most cases) stateless API translations that get you 90% of the way there in a fast lightweight manner. We therefore can't address some of the subtle differences, such as the nuances of absolute paths on Windows. Our approach could be compared to something more along the lines of, "the Russians just used a pencil to write in space", versus spending millions researching a pen like NASA.