Table of Contents

General stuff

• A: Introduction
• B: Files
• C: Error codes
• D: Definitions for Key File Parameters
• E: Definitions for ISAM Parameters

Functions

• pblCollectionAggregate Aggregates a collection by calling the aggregation function on every element of the collection while running through the collection with an iterator.
• pblCollectionContains Returns true if this collection contains the specified element.
• pblCollectionConvertToArrayList Returns a pblArrayList with a shallow copy of this collection instance.
• pblCollectionConvertToHashSet Returns a pblHashSet with a shallow copy of this collection instance.
• pblCollectionConvertToLinkedList Returns a pblLinkedList with a shallow copy of this collection instance.
• pblCollectionConvertToTreeSet Returns a pblTreeSet with a shallow copy of this collection instance.
• pblCollectionElementCompare Compare two elements of a collection.
• pblCollectionIsCollection Tests if the object is a collection.
• pblCollectionSetCompareFunction Sets an application specific compare function for the elements of the collection.
• pblCollectionStringCompareFunction Compares two '\0' terminated strings.
• pblHeapAddLast Adds the element to the end of the heap without ensuring the heap condition.
• pblHeapClear Removes all of the elements from the heap.
• pblHeapConstruct Constructs a heap using 'bottom-up heap construction'.
• pblHeapEnsureCapacity Increases the capacity of the heap, if necessary.
• pblHeapEnsureCondition Ensures the heap condition of the heap for the element with the given index.
• pblHeapEnsureConditionFirst Ensures the heap condition for the first element.
• pblHeapFree Frees the heap's memory from heap.
• pblHeapGet Returns the element at the specified position in the heap.
• pblHeapGetCapacity Returns the capacity of the heap.
• pblHeapGetFirst Returns but does not remove the element at the top of the heap.
• pblHeapInsert Inserts the element into the heap and maintains the heap condition of the heap.
• pblHeapIsEmpty Tests if the heap has no elements.
• pblHeapIterator Returns an iterator over the elements in the heap.
• pblHeapJoin Joins the two heaps by moving all elements of the 'other' heap.
• pblHeapNew Creates a new heap.
• pblHeapRemoveAt Removes the element at the specified position from the heap, maintaining the heap condition of the heap.
• pblHeapRemoveFirst Removes the biggest element from the heap, maintaining the heap condition of the heap.
• pblHeapRemoveLast Removes the last element from the heap, maintaining the heap condition of the heap.
• pblHeapSetCompareFunction Sets an application specific compare function for the elements of the heap.
• pblHeapSize Returns the number of elements in the heap.
• pblHeapTrimToSize Trims the capacity of the heap to the heap's current size.
• pblHtCreate Create a new hash table.
• pblHtCurrent Get data of current key in hash table.
• pblHtCurrentKey Get key of current item in hash table.
• pblHtDelete Delete a hash table.
• pblHtFirst Get data of first key in hash table.
• pblHtInsert Insert a key / data pair into a hash table.
• pblHtLookup Search for a key in a hash table.
• pblHtNext Get data of next key in hash table.
• pblHtRemove Remove an item from the hash table.
• pblISAMFILE_TestFrame test frame for the ISAM file library
• pblIsamClose close an ISAM file
• pblIsamCommit commit or roll back changes done during a transaction
• pblIsamDelete delete the current record of the ISAM file.
• pblIsamFind find a record in an ISAM file, set the current record
• pblIsamFlush flush an ISAM file
• pblIsamGet get the key and keylen of a record
• pblIsamInsert insert a new record with the given keys and data into the isam file,
• pblIsamInsertArgcArgv insert a new record with the given keys and data into the isam file,
• pblIsamOpen open an ISAM file, creates the file if necessary
• pblIsamReadData read the data of the current record
• pblIsamReadDatalen read the datalen of the current record
• pblIsamReadKey read the key and keylen of the current record
• pblIsamSetCompareFunction set an application specific compare function for a key of an ISAM file
• pblIsamStartTransaction start a transaction on a set of ISAM files
• pblIsamUpdateData update the data of the current record
• pblIsamUpdateKey update a key of the current record of the ISAM file
• pblIteratorAdd Inserts the specified element into the underlying collection.
• pblIteratorFree Frees the memory used by the iterator.
• pblIteratorHasNext Returns true if this iterator has more elements.
• pblIteratorHasPrevious Returns true if this iterator has more elements when traversing the collection in the reverse direction.
• pblIteratorNew Returns an iterator over the elements in this collection in proper sequence.
• pblIteratorNext Returns the next element in the iteration.
• pblIteratorNextIndex Returns the index of the element that would be returned by a subsequent call to next.
• pblIteratorPrevious Returns the previous element in the iteration.
• pblIteratorPreviousIndex Returns the index of the element that would be returned by a subsequent call to previous.
• pblIteratorRemove Removes from the underlying list or tree set the last element returned by the iterator.
• pblIteratorReverseNew Returns a reverse iterator over the elements in this collection in proper sequence.
• pblIteratorSet Replaces in the underlying list the last element returned by next or previous with the specified element.
• pblIteratorSize Returns the number of elements in the underlying collection of the iterator.
• pblKEYFILE_TestFrame test frame for the key file library
• pblKfClose Close a key file
• pblKfCommit Commit or rollback changes done during a transaction.
• pblKfCreate Create a key file with the name specified by path.
• pblKfDelete Delete the current record of the key file.
• pblKfFind Find a record in a key file, set the current record.
• pblKfFlush Flush a key file
• pblKfGetAbs Set the current record to a record with an absolute position index.
• pblKfGetRel Set current record to a record with a relative position index.
• pblKfInit Change the number of cache blocks used per open key file
• pblKfInsert Insert a new record with the given key and data into a key file,
• pblKfOpen Open an existing key file.
• pblKfRead Read the data of the current record of the file.
• pblKfRestorePosition Restore the position of the current record saved by the last previous call to pblKfSavePosition().
• pblKfSavePosition Save the position of the current record for later restore
• pblKfSetCompareFunction Set an application specific compare function for the keys of a key file
• pblKfStartTransaction Start a transaction on a key file
• pblKfUpdate Update the data of the current record
• pblListAdd Appends the specified element to the end of this list.
• pblListAddAll Appends all of the elements in the specified Collection to the end of this list, in the order that they are returned by the specified Collection's Iterator.
• pblListAddAllAt Inserts all of the elements in the specified collection into this list at the specified position.
• pblListAddAt Inserts the specified element at the specified position in this list.
• pblListAddFirst Inserts the given element at the beginning of this list.
• pblListAddLast Appends the given element to the end of this list.
• pblListClear Removes all of the elements from this list.
• pblListClone Returns a shallow copy of this list instance.
• pblListCloneRange Returns a shallow copy from this list of all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive.
• pblListContains Returns true if this list contains the specified element.
• pblListContainsAll Returns a value > 0 if this list contains all of the elements in the specified collection.
• pblListElement Retrieves, but does not remove, the head (first element) of this list.
• pblListEnsureCapacity Increases the capacity of this list instance, if necessary.
• pblListEquals Compares the specified collection with this list for equality.
• pblListFree Free the list's memory from heap.
• pblListGet Returns the element at the specified position in this list.
• pblListGetCapacity Returns the capacity of this list instance.
• pblListGetCompareFunction Gets the application specific compare function for the elements of the list.
• pblListGetFirst Returns the first element in this list.
• pblListGetLast Returns the last element in this list.
• pblListHead Retrieves, but does not remove, the head (first element) of this list.
• pblListIndexOf Searches for the first occurrence of the given argument.
• pblListIsArrayList Tests if the object is an array list.
• pblListIsEmpty Tests if this list has no elements.
• pblListIsLinkedList Tests if the object is a linked list.
• pblListIsList Tests if the object is a list.
• pblListIterator Returns an iterator over the elements in this list in proper sequence.
• pblListLastIndexOf Searches for the last occurrence of the given argument.
• pblListNewArrayList Creates a new array list.
• pblListNewLinkedList Creates a new linked list.
• pblListOffer Adds the specified element as the tail (last element) of this list.
• pblListPeek Retrieves, but does not remove, the head (first element) of this list.
• pblListPoll Retrieves and removes the head (first element) of this list.
• pblListPop Retrieves and removes the tail (last element) of this list.
• pblListPush Pushes the specified element to the end (last element) of this list.
• pblListRemove Retrieves and removes the head (first element) of this list.
• pblListRemoveAll Removes from this list all of its elements that are contained in the specified collection.
• pblListRemoveAt Removes the element at the specified position in this list.
• pblListRemoveElement Removes a single instance of the specified element from this list, if it is present.
• pblListRemoveFirst Removes and returns the first element in this list.
• pblListRemoveLast Removes and returns the last element in this list.
• pblListRemoveRange Removes from this list all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive.
• pblListRetainAll Retains only the elements in this list that are contained in the specified collection.
• pblListReverse Reverses the order of the elements of this list.
• pblListReverseIterator Returns a reverse iterator over the elements in this list in proper sequence.
• pblListSet Replaces the element at the specified position in this list with the specified element.
• pblListSetCompareFunction Sets an application specific compare function for the elements of the list.
• pblListSetFirst Replaces the head (first element) of this list.
• pblListSetLast Replaces the tail (last element) of this list.
• pblListSetSize Sets the size of a list.
• pblListSize Returns the number of elements in this list.
• pblListSort Sorts the elements of the list.
• pblListTail Retrieves, but does not remove, the tail (last element) of this list.
• pblListToArray Returns an array containing all of the elements in this list in the correct order.
• pblListTop Retrieves, but does not remove, the tail (last element) of this list.
• pblListTrimToSize Trims the capacity of this list instance to be the list's current size.
• pblMapAdd Associates the specified value with the specified key in this map.
• pblMapAddStrStr Associates the specified string value with the specified string key in this map.
• pblMapClear Removes all of the mappings from this map.
• pblMapContainsKey Returns true if this map contains a mapping for the specified key.
• pblMapContainsKeyStr Returns true if this map contains a mapping for the specified string key.
• pblMapContainsValue Returns true if this map contains a mapping for the specified value.
• pblMapContainsValueStr Returns true if this map contains a mapping for the specified string value.
• pblMapEntryKey Returns a pointer to the key of the map entry passed.
• pblMapEntryKeyLength Returns the key length of the map entry passed.
• pblMapEntryValue Returns a pointer to the value of the map entry passed.
• pblMapEntryValueLength Returns the value length of the map entry passed.
• pblMapFree Removes all of the mappings from this map and frees the map's memory from heap.
• pblMapGet Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
• pblMapGetStr Returns the value to which the specified string key is mapped, or null if this map contains no mapping for the key.
• pblMapIsEmpty Tests if this map has no elements.
• pblMapIteratorNew Returns an iterator over the map entries in this map in proper sequence.
• pblMapIteratorReverseNew Returns a reverse iterator over the elements in this map in proper sequence.
• pblMapNewHashMap Creates a new hash map.
• pblMapNewTreeMap Creates a new tree map.
• pblMapPut Associates the specified value with the specified key in this map.
• pblMapPutAll Copies all of the mappings from the specified source map to this map.
• pblMapPutStrStr Associates the specified string value with the specified string key in this map.
• pblMapRemove Removes the mapping for this key from this map if it is present.
• pblMapRemoveStr Removes the mapping for this string key from this map if it is present.
• pblMapSize Returns the number of entries in this map.
• pblPriorityQueueAddLast Adds the element with the specified priority to the end of the priority queue without ensuring the heap condition.
• pblPriorityQueueChangePriorityAt Changes the priority of the element at the specified position of the priority queue, maintaining the heap condition of the queue.
• pblPriorityQueueChangePriorityFirst Changes the priority of the first element of the priority queue, maintaining the heap condition of the queue.
• pblPriorityQueueClear Removes all of the elements from the priority queue.
• pblPriorityQueueConstruct Constructs a priority queue using 'bottom-up heap construction'.
• pblPriorityQueueEnsureCapacity Increases the capacity of the priority queue, if necessary.
• pblPriorityQueueFree Frees the priority queue's memory from heap.
• pblPriorityQueueGet Returns the element at the specified position in the priority queue.
• pblPriorityQueueGetCapacity Returns the capacity of the priority queue.
• pblPriorityQueueGetFirst Returns but does not remove the element with the highest priority in the priority queue.
• pblPriorityQueueInsert Inserts the element with the specified priority into the priority queue and maintains the heap condition of the priority queue.
• pblPriorityQueueIsEmpty Tests if the priority queue has no elements.
• pblPriorityQueueIterator Returns an iterator over the elements in the queue.
• pblPriorityQueueJoin Joins the two priority queues by moving all elements of the 'other' queue.
• pblPriorityQueueNew Creates a new priority queue.
• pblPriorityQueueRemoveAt Removes the element at the specified position from the priority queue, maintaining the heap condition of the queue.
• pblPriorityQueueRemoveFirst Removes the element with the highest priority from the priority queue, maintaining the heap condition of the queue.
• pblPriorityQueueRemoveLast Removes the last element from the priority queue, maintaining the heap condition of the queue.
• pblPriorityQueueSize Returns the number of elements in the priority queue.
• pblPriorityQueueTrimToSize Trims the capacity of the queue to the priority queue's current size.
• pblSetAdd Adds the specified element to this set.
• pblSetAddAll Adds all of the elements in the specified Collection to this set.
• pblSetByteBufferHashValue Creates a hash value of a byte buffer and its length.
• pblSetClear Removes all of the elements from this set.
• pblSetClone Returns a shallow copy of this set instance.
• pblSetCloneRange Returns a shallow copy from this set of all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive.
• pblSetContains Returns true if this set contains the specified element.
• pblSetContainsAll Returns a value > 0 if this set contains all of the elements in the specified collection.
• pblSetDefaultHashValue Default hash value function used if no application specific function is specified by the user.
• pblSetDifference Creates a new set containing the difference of the elements of the two sets passed as parameters.
• pblSetElement Retrieves, but does not remove, the head (first element) of this set.
• pblSetEnsureCapacity Increases the capacity of this set instance, if necessary.
• pblSetEquals Compares the specified collection with this set for equality.
• pblSetFree Free the set's memory from heap.
• pblSetGet Returns the element at the specified position in this set.
• pblSetGetCapacity Returns the capacity of this set instance.
• pblSetGetCompareFunction Gets the application specific compare function for the elements of the set.
• pblSetGetElement Returns the element of this set that matches the given element.
• pblSetGetFirst Returns the first element in this set.
• pblSetGetHashValueFunction Gets the application specific hash value function for the elements of the set.
• pblSetGetLast Returns the last element in this set.
• pblSetHead Retrieves, but does not remove, the head (first element) of this set.
• pblSetIndexOf Returns the index of the given argument in the set.
• pblSetIntersection Creates a new set containing the intersection of the elements of the two sets passed as parameters.
• pblSetIsEmpty Tests if this set has no elements.
• pblSetIsHashSet Tests if the object is a hash set.
• pblSetIsSet Tests if the object is a set.
• pblSetIsSubset Returns a value > 0 if the set passed as second parameter is a subset of the set passed as first parameter, ie.
• pblSetIsTreeSet Tests if the object is a tree set.
• pblSetIterator Returns an iterator over the elements in this set.
• pblSetLastIndexOf Returns the index of the given argument in the set.
• pblSetNewHashSet Creates a new hash set.
• pblSetNewTreeSet Creates a new tree set.
• pblSetPeek Retrieves, but does not remove, the head (first element) of this set.
• pblSetPoll Retrieves and removes the head (first element) of this set.
• pblSetPop Retrieves and removes the tail (last element) of this set.
• pblSetRemove Retrieves and removes the head (first element) of this set.
• pblSetRemoveAll Removes from this set all of its elements that are contained in the specified collection.
• pblSetRemoveAt Removes the element at the specified position in this set.
• pblSetRemoveElement Removes the specified element from this set if it is present.
• pblSetRemoveFirst Removes and returns the first element in this set.
• pblSetRemoveLast Removes and returns the last element of this set.
• pblSetReplaceElement Replaces the element of the set that matches the given element with the given element.
• pblSetRetainAll Retains only the elements in this set that are contained in the specified collection.
• pblSetReverseIterator Returns a reverse iterator over the elements in this set.
• pblSetSetCompareFunction Sets an application specific compare function for the elements of the set.
• pblSetSetHashValueFunction Sets an application specific hash value function for the elements of the hash set.
• pblSetSetLoadFactor Sets an application specific load factor for a hash set.
• pblSetSize Returns the number of elements in this set.
• pblSetStringHashValue Creates a hash value of a '\0' terminated string.
• pblSetSymmectricDifference Creates a new set containing all elements of the two sets passed as parameters that are contained in either of the sets but not in both of them.
• pblSetTail Retrieves, but does not remove, the tail (last element) of this set.
• pblSetToArray Returns an array containing all of the elements in this set.
• pblSetTop Retrieves, but does not remove, the tail (last element) of this set.
• pblSetTrimToSize Trims the capacity of this set instance to the set's current size divided by the load factor of the set.
• pblSetUnion Creates a new set containing the union of the elements of both sets passed as parameters.
• pblStringBuilderAppend Appends a variable string defined by the format parameter to the end of the data of the string builder.
• pblStringBuilderAppendN Appends at most n bytes of a variable string defined by the format parameter to the end of the data of the string builder.
• pblStringBuilderAppendStr Appends a '\0' terminated string to the end of the data of the string builder.
• pblStringBuilderAppendStrN Appends at most n bytes of a string to the end of the data of the string builder.
• pblStringBuilderClear Removes all of the elements from the string builder.
• pblStringBuilderFree Frees the string builder's memory from heap.
• pblStringBuilderLength Returns the number of characters in the string builder.
• pblStringBuilderNew Creates a new string builder.
• pblStringBuilderSize Returns the number of elements in the string builder.
• pblStringBuilderToString Converts the string builder's data to a '\0' terminated string.
• pblStringBuilderToString The variable arguments to append
• pbl_BufToLong Read a four byte long from a four byte buffer.
• pbl_BufToShort Read a two byte short from a two byte buffer.
• pbl_LongSize Find out how many bytes a four byte long would use in a buffer.
• pbl_LongToBuf Copy a four byte long to a four byte buffer.
• pbl_LongToVarBuf Copy a four byte long to a variable length buffer.
• pbl_ShortToBuf Copy a two byte short to a two byte buffer.
• pbl_VarBufSize Find out how many bytes a four byte long uses in a buffer.
• pbl_VarBufToLong Read a four byte long from a variable length buffer.
• pbl_malloc Replacement for malloc().
• pbl_malloc0 Replacement for malloc(), initializes the memory to 0.
• pbl_mem2dup Duplicate and concatenate two memory buffers.
• pbl_memcmp Compare two memory buffers, similar to memcmp.
• pbl_memcmplen Find out how many starting bytes of two buffers are equal.
• pbl_memdup Duplicate a buffer, similar to strdup().
• pbl_memlcpy Replacement for memcpy with target length check.
• pbl_strdup Duplicate a string, similar to strdup().

Variables

• pbl_errno Integer value used for returning error codes
• pbl_errstr Character buffer used for returning error strings

Macros

• PBLDATALENGTH Maximum data length of data being stored on index blocks of key files,
• PBLKEYLENGTH The maximum length of a key of the key file component,
• PBL_FREE Make free save against NULL pointers,
• PBL_LIST_ Macros for linear list handling,
• PBL_LIST_APPEND Append an item to the end of a linear list
• PBL_LIST_INSERT Add an item before another item of a linear list
• PBL_LIST_INSERT_AFTER Add an item after another item of a linear list
• PBL_LIST_PUSH Push an item to the beginning of a linear list
• PBL_LIST_UNLINK Remove an item from a linear list
• pblKfFirst Set the current record to the first record of the file
• pblKfLast Set the current record to the last record of the file
• pblKfNext Set the current record to the next record of the file
• pblKfPrev Set the current record to the previous record of the file
• pblKfThis Return the datalen of the current record

Enums, Unions, Structs

• PblPriorityQueueEntry_s The priority queue entry struct.
• PblStringBuilder_s The string builder struct

Typedefs

• PblCollection The generic collection type
• PblHeap The heap
• PblIterator The iterator type
• PblList The generic list type
• PblMap The map type
• PblMapEntry The map entry type
• PblMapKey The map key type
• PblPriorityQueue The priority queue
• PblPriorityQueueEntry The priority queue entry
• PblSet The generic set type
• PblStringBuilder The string builder
• pblHashTable_t The hash table type the pblHt* functions are dealing with.
• pblIsamFile_t The ISAM file type the pblIsam* functions are dealing with.
• pblKeyFile_t The key file type the pblKf* functions are dealing with.

GET PBL:

• See the PBL documentation.
• PBL is hosted on GitHub.
• Download the PBL master from GitHub.
• Take a look at the PBL sources.

• Take a look at Spam Probe, a project that uses PBL.
• PBL is listed as awesome-c framework.