Introduction

This document describes about Coconut Framework produced by Steel Wheels Project. Coconut Framework is basic infrastructure of all the other applications and frameworks.

Copyright

This software is distributed under GNU Lesser General Public License v2.

Target System

OS: Mac OS X
IDE: Xcode
Lang: ANSI-C

SCM Repository

See Git repository on SourceForge.

Specification

This framework contains following item:

Memory manager: The memory manage is used to reduce malloc()/free() operations. In the almost application, there are many same-sized objects are allocated and released dynamically. The manager (called the resource) pools the various size of same-sized objects to re-use them.
Primitive data type & structure: General purpose data type & structure (ex. list) are supported.
Tiny object model: The CNObject data structure is used as the root object for tiny object oriented programming with ANSI-C.

Implementation

CNResource (CNResource.h)

Memory manager

CNLock (CNLock.h)

Mutex lock for multi thread programming

Data type & structure

CNType.h : Define primitive data types
CNFixedString (CNFixedString.h) : Persistent object to present object. The are only one object.
CNBuffer (CNBuffer.h) : Operate variable-size continuous memory data
CNPool (CNPool.h) : Pool to keep variable-size memory data(s)
CNList (CNList.h) : List of pointers
CNArray (CNArray.h) : Variable sized pointer array
CNFixedArray (CNFixedArray.h) : Fixed sized pointer array
CNDictionary (CNDictionary.h) : Dictionary of data. CNFixedString is used as keys.
CNHashTable (CNHashTable.h) : Hash table to keep memory object(s)

Classes

CNObject (CNObject.h) : Super class of tiny object.
CNString (CNString.h) : String operation. It contains list of string element (CNStringElement (CNStringElement.h)).
CNText (CNText.h) : Text buffer to store the multi level sections and plane texts. See also CNTextSection.h, CNTextLine.h, CNTextString.h and CNTextElement.h
CNGraph (CNGraph.h) : The model for the direct-acyclic graph. It contains CNNode (CNNode.h) as the graph node and CNEdge (CNEdge.h) to connect them.

Data structure for objects

CNObjectList (CNObjectList.h) : Single linked list of CNObject
CNObjectArray (CNObjectArray.h) : Variable sized CNObject array
CNFixedObjectArray (CNFixedObjectArray.h) : Fixed sized CNObject array
CNObjectDictionary (CNObjectDictionary.h) : Dictionary to keep CNObject (or it's subclass) as values. And CNFixedString is used as keys.

Misc

CNBase64.h : Define functions to convert binary data into base64 and to convert base64 data into binary.
CNStrUtil.h : Define utility functions to operate string