roy3

Usage

Overview

Roy is a multipurpose user-space library implementation for some of the common datatypes people use as well as helper functions for dealing with the underlying system.

The goal was a combination of speed, ease of use, and correctness. The license is also very liberal, allowing use in basically any situation.

See rinit(3) on how to initalize the roy library.

Much of the API is implmented using C macros as well as regular function calls.

Linking

To link with the roy code, a shell script, roy-config(1) is included. This utility allows proper linking regardless of installation location.

Data Structures

RList - doublely linked list, rlist(3).

RBuf - string/data buffer, rbuf(3).

RHash - hash table, rhash(3).

RBHash - hash table with rbuf keys, rbhash(3).

RArray - bucketized array implementation, rarray(3).

System Helpers

RFlag - simple integer flag setter/getter, rflag(3).

RChunk - fast memory allocator, rchunk(3).

RBucket - even faster memory allocator with different behavior, rbucket(3).

RMem - memory management, rmem(3).

RDebug - debugging message helper, rdebug(3).

RXp - cross platform encoding/decoding, rxp(3).

RMain - cross platform mainloop (Win32 and UNIX) rmain(3).

RThread - cross platform threading (Win32 and UNIX) rthread(3).

RTherml - THERML markup parser (similar to XML).

Linking

If you use Roy, you should look at roy-config(1) for details on how to properly (and portably) link Roy into your application.

RFOREACH_CLOSE

This macro is used to close the foreach style iterations used in several places within Roy.

For example, this is the way to run down an rlist of entries.

        RLIST_FOREACH (list, entry) {
                /* Code goes here. */
        } RFOREACH_CLOSE;