libcork documentation

This is the documentation for libcork 0.15.0, last updated Nov 22, 2017.

Introduction

So what is libcork, exactly? It’s a “simple, easily embeddable, cross-platform C library”. It falls roughly into the same category as glib or APR in the C world; the STL, POCO, or QtCore in the C++ world; or the standard libraries of any decent dynamic language.

So if libcork has all of these comparables, why a new library? Well, none of the C++ options are really applicable here. And none of the C options work, because one of the main goals is to have the library be highly modular, and useful in resource-constrained systems. Once we describe some of the design decisions that we’ve made in libcork, you’ll hopefully see how this fits into an interesting niche of its own.

Contents

• Configuring libcork
  • Configuration macros
  • Skipping autodetection
• Library version
  • libcork version
  • Constructing version information
• Symbol visibility
  • Defining a library’s public API
  • Local symbols
• Basic types
  • 128-bit integers
  • Network addresses
  • High-precision timestamps
  • Hash values
  • Unique identifiers
  • Integral types
  • Size macros
  • Embedded structs
• Byte order
  • Endianness detection
  • Byte swapping
• Compiler attributes
• Memory allocation
  • Allocating memory
  • Customizing how libcork allocates
• Error reporting
  • Calling a function that can return an error
  • Writing a function that can return an error
  • Error-checking macros
  • Defining new error codes
  • Builtin errors
• Reference-counted garbage collection
  • Creating a garbage collector
  • Managing garbage-collected objects
  • Writing a new garbage-collected class
• Memory pools
  • Basic interface
  • Initializing and finalizing objects
• Data structures
  • Resizable arrays
  • Bit sets
  • Binary slices
  • Managed binary buffers
  • Resizable binary buffers
  • Stream processing
  • Doubly-linked lists
  • Hash tables
  • Ring buffers
• Command-line programs
  • Overview
  • Leaf commands
  • Command sets
  • Running the commands
  • Help text
  • Option parsing
• Files and directories
  • Paths
  • Lists of paths
  • Standard paths
  • Files
  • Directories
  • Lists of files
  • Directory walking
• Processes
  • Cleanup functions
  • Environment variables
  • Executing another program
• Subprocesses
  • Subprocess objects
  • Creating subprocesses
• Multithreading support
  • Thread IDs
  • Creating threads
  • Atomic operations
  • Executing something once
  • Thread-local storage

Indices and tables

• Index
• Search Page