Xpace
table_c.h File Reference
#include "base/types.h"
#include "base/c/types_c.h"
#include "base/c/exception_c.h"

Go to the source code of this file.

Classes

struct  Xpace_Table_Sink
 

Typedefs

typedef void * Xpace_Table
 
typedef void * Xpace_Table_Source
 

Enumerations

enum  Xpace_StoreAccess { SA_readWrite, SA_readOnly, SA_bulkWrite }
 

Functions

 XPACE_C_EXPORT (Xpace_Error) Xpace_Table_getColumnConfig(const Xpace_Table
 Get a column's configuration. More...
 
 XPACE_C_EXPORT (void) Xpace_Table_Source_destroy(Xpace_Table_Source)
 destroy a Table Source More...
 

Variables

Xpace_StoreAccess access
 
Xpace_StoreAccess Xpace_Tableresult
 
uint col
 
uint64 row
 Begin a new row, committing this one (if any) More...
 
uint column
 Add a 64-bit int to the row. More...
 
uint boolok
 
const Xpace_Char16name
 Sink callbacks for table data. More...
 
const Xpace_Char16 Xpace_Data_Type type
 
const Xpace_Char16 Xpace_Data_Type uint columnNum
 
const Xpace_Char16 Xpace_Data_Type uint booladded
 
const Xpace_Char16 Xpace_Data_Type uint bool void * callerInfo
 We're finished with this sink. More...
 
uint int64 value
 
uint int64 mantissa
 
uint int64 int decimals
 
uint const Xpace_Char8data
 
uint const Xpace_Char8 size_t len
 
uintcolumns
 
uint uint64 maxRows
 
uint uint64 Xpace_Table_Sinksink
 

Typedef Documentation

typedef void* Xpace_Table

Definition at line 25 of file table_c.h.

typedef void* Xpace_Table_Source

Definition at line 26 of file table_c.h.

Enumeration Type Documentation

Enumerator
SA_readWrite 
SA_readOnly 
SA_bulkWrite 

Definition at line 31 of file table_c.h.

Function Documentation

XPACE_C_EXPORT ( Xpace_Error  )

Get a column's configuration.

Get to the error that cause this one (if any)

Get Table data through a callback, starting from and updating the current position.

get the (raw) contents of a cell from the current row NB only guarenteed to be valid while the row is current

get the (integer) contents of a cell from the current row

get the (String) contents of a cell from the current row

create a read-only cursor into a Table

Parameters
configthe Table's Configuration
accesshow the Table will be opened
Return values
trueif the table is empty
thetable's name
Parameters
colthe column number
Return values
thecolumn's Configuration
thenumber of rows in the table
thenumber of columns in the table
Parameters
rowstart at this row
Return values
theSource
Parameters
rowmove cursor to this row
Return values
trueif successful, false (and don't move) if not
Parameters
columnfrom this column
Return values
the(String) contents of the cell
Parameters
columnfrom this column
okfillin true if successful
Return values
the(integer) contents of the cell
Parameters
columnfrom this column
Return values
the(raw) contents of the cell
Parameters
columns~0-terminated list of columns to get; if 0, get all columns
maxRowsthe maximum number of rows to get
sinkcalled for each cell #param result fillin true iff each call to sink->set() returned true
XPACE_C_EXPORT ( void  )

destroy a Table Source

Variable Documentation

Definition at line 42 of file table_c.h.

uint col

Definition at line 69 of file table_c.h.

Referenced by Xpace::TableSinkToStore::add().

uint64 row

Begin a new row, committing this one (if any)

Parameters
docNumthe new row number
Returns
-1 to stop, 0 to return this row, >0 to skip rows

Definition at line 89 of file table_c.h.

uint column

Add a 64-bit int to the row.

Add DateTime.

Add raw bytes.

Add a String16 to the row.

Add a String8 to the row.

Add a double to the row.

Parameters
column
value
Returns
true to continue
Parameters
column
mantissa
decimals
Returns
true to continue
Parameters
column
datathe String8's contents - NB valid only as long as the row is current
lenthe String8's length
Returns
true to continue
Parameters
column
datathe String16's contents - NB valid only as long as the row is current
lenthe String16's length
Returns
true to continue
Parameters
column
datathe bytes - NB valid only as long as the row is current
lenthe bytes' length
Returns
true to continue
Parameters
column
value- NB valid only as long as the row is current
Returns
true to continue

Definition at line 108 of file table_c.h.

Referenced by Xpace::JavaTableSink::add(), and Xpace::TableSinkToStore::BadCode::BadCode().

uint bool* ok

Definition at line 117 of file table_c.h.

const Xpace_Char16* name

Sink callbacks for table data.

Set a column's name and type

Parameters
namethe name of the column
typethe type of the column
columnNuma proposed column number
Return values
addedtrue iff actually added
Returns
the actual column number to continue, -1 to stop

Definition at line 141 of file table_c.h.

Referenced by Xpace::eval_range(), Xpace::File::getName(), Xpace::WrapImplPointer< T >::operator SharedImplPointer< T, true >(), Xpace::TranslateStringDateTime< LOC, STR >::TranslateStringDateTime(), Xpace::TranslateStringInt< LOC, STR >::TranslateStringInt(), Xpace::TranslateStringIPv4< LOC, STR >::TranslateStringIPv4(), and Xpace::TranslateStringUint< LOC, STR >::TranslateStringUint().

Definition at line 141 of file table_c.h.

uint uint64 Xpace_Table_Sink void * callerInfo

We're finished with this sink.

Definition at line 141 of file table_c.h.

uint int64 mantissa

Definition at line 169 of file table_c.h.

uint int64 int decimals

Definition at line 169 of file table_c.h.

uint* columns

Definition at line 340 of file table_c.h.

Referenced by Xpace::TableSinkToStore::BadCode::BadCode().

uint uint64 maxRows

Definition at line 340 of file table_c.h.


current as of Wed Jun 10 2026 12:00:06