net.sourceforge.lept4j

Class L_Queue

java.lang.Object

com.sun.jna.Structure

net.sourceforge.lept4j.L_Queue

Direct Known Subclasses:

L_Queue.ByReference, L_Queue.ByValue

public class L_Queue
extends com.sun.jna.Structure

queue.h
Expandable pointer queue for arbitrary void* data.
The L_Queue is a fifo that implements a queue of void* pointers.
It can be used to hold a queue of any type of struct.
Internally, it maintains two counters:
nhead: location of head (in ptrs) from the beginning
of the array.
nelem: number of ptr elements stored in the queue.
The element at the head of the queue, which is the next to
be removed, is array[nhead]. The location at the tail of the
queue to which the next element will be added is
array[nhead + nelem].

As items are added to the queue, nelem increases.
As items are removed, nhead increases and nelem decreases.
Any time the tail reaches the end of the allocated array,
all the pointers are shifted to the left, so that the head
is at the beginning of the array.
If the array becomes more than 3/4 full, it doubles in size.
The auxiliary stack can be used in a wrapper for re-using
items popped from the queue. It is not made by default.
For further implementation details, see queue.c.
native declaration : queue.h:29
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java , Rococoa, or JNA.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	L_Queue.ByReference
static class	L_Queue.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
com.sun.jna.ptr.PointerByReference	array ptr array C type : void**
int	nalloc size of allocated ptr array C type : l_int32
int	nelem number of elements stored in the queue C type : l_int32
int	nhead location of head (in ptrs) from the C type : l_int32
L_Stack.ByReference	stack auxiliary stack C type : L_Stack*

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
L_Queue()
L_Queue(int nalloc, int nhead, int nelem, com.sun.jna.ptr.PointerByReference array, L_Stack.ByReference stack)
L_Queue(com.sun.jna.Pointer peer)

Method Summary

Modifier and Type	Method and Description
protected java.util.List<?>	getFieldOrder()

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, read, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setFieldOrder, setStringEncoding, size, sortFields, toArray, toArray, toString, toString, useMemory, useMemory, write, writeField, writeField, writeField

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

nalloc

public int nalloc

size of allocated ptr array
C type : l_int32

nhead

public int nhead

location of head (in ptrs) from the
C type : l_int32

nelem

public int nelem

number of elements stored in the queue
C type : l_int32

array

public com.sun.jna.ptr.PointerByReference array

ptr array
C type : void**

stack

public L_Stack.ByReference stack

auxiliary stack
C type : L_Stack*

Constructor Detail

L_Queue

public L_Queue()

L_Queue

public L_Queue(int nalloc,
               int nhead,
               int nelem,
               com.sun.jna.ptr.PointerByReference array,
               L_Stack.ByReference stack)

Parameters:

nalloc - size of allocated ptr array
C type : l_int32

nhead - location of head (in ptrs) from the
C type : l_int32

nelem - number of elements stored in the queue
C type : l_int32

array - ptr array
C type : void**

stack - auxiliary stack
C type : L_Stack*

L_Queue

public L_Queue(com.sun.jna.Pointer peer)

Method Detail

getFieldOrder

protected java.util.List<?> getFieldOrder()

Specified by:

getFieldOrder in class com.sun.jna.Structure