https://github.com/geky/oi

OS Interface. A very simple library that closely maps OS specific functions.
https://github.com/geky/oi

Last synced: 1 day ago
JSON representation

OS Interface. A very simple library that closely maps OS specific functions.

• Host: GitHub
• URL: https://github.com/geky/oi
• Owner: geky
• License: other
• Created: 2012-06-02T21:42:08.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-10-07T21:36:11.000Z (about 12 years ago)
• Last Synced: 2024-04-14T18:43:29.006Z (7 months ago)
• Language: C
• Homepage:
• Size: 520 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license.txt

Awesome Lists containing this project

README

        
[OI](http://github.com/geky/oi) - OS Interface

----------------------------------------------

### Overveiw ###

OI is a very tiny and simple library written in C to open up OS specific functions in a light-weight and cross-platform manner. 

It is encouraged that you modify the files so they match your specific needs. If you think your additions are useful, don't hesitate to submit a pull request as any additions is greatly appreciated.

### Organization ###

Each file is designed to be as independent as possible so you can only use the files you need. The beginning of every file has a list of include statements for every file it relies on so you can easily tell which ones you need. It will also have a comment if there is any external linkages that are needed. 

OI starts with oi_os.h, which determines the OS information and is required in every other file. Also oi_types.h defines useful ints and floats of set sizes for use throughout OI.

The actual code is organized into many `oi_call` functions. The oi_call functions return an int indicating any error that occurs, or zero if it is successful. You can get a string explaining the error through the get_error function in oi_err.h. Most errors are very much OS dependent and usually only result from bugs; however, reliable error codes for errors should be taken care of at runtime are defined in oi_err.h and indicated in comments before the function.

Each file usually revolves around a specific datatype which uses the `_t` syntax such as mutex_t. The actual implementation changes on each system, making it difficult to use consistent datatypes. You should not rely on the type at all, but rather depend on the functions that use it.

### Documentation  ###

A full documentation of each part can be found inside the header file associated with that part. It should clarify the use of the file as well as any functions or types defined there.

### Testing ###

OI is trying to implement a standard interface for utilities that are common for applications on modern computers. This isn't C's or C++'s main focus, so most of the implementations of these utilities vary widely from computer to computer. A simple program [test.c](http://github.com/geky/oi/blob/master/test/test.c) is provided for a quick way to confirm OI works on a target platform. However, it is impossible to cover every OS, so if you find an OS where OI breaks, please let us know, or even implement a fix yourself and submit a pull request.

### Example ###

Here is a simple example of using OI:

    #include "oi/thread.h"

    #include 

    

    void prthread(void * s) {

        printf("%s!",(char*)s);

    }

    

    int main() {

        char data[] = "Hello World";

        thread_t thr;

        int err;

        

        err = thread_create(&thr,&prthread,data);

        thread_join(&thr);

    

        return err;

    }