Scol standard library package  0.3.1
Common and usefull functions for all Scol applications
Classes | Typedefs | Functions | Variables
iteration.pkg File Reference

Scol Iteration Library API. More...

Classes

struct  StdIteration
 

Typedefs

typedef struct mkStdIteration StdIteration
 

Functions

 main ()
 
 STD_IT_FROMBEGIN ()
 
 STD_IT_FROMCURRENT ()
 
 STD_IT_FROMEND ()
 
 std_itadd (it, string)
 
 std_itAdd (oIt, szToAdd)
 Add the substring to a StdIteration object from the current cursor position. The cursor position keeps unchanged. More...
 
 std_itaddfile (it, pf, string)
 
 std_itaddstring (it, s, string)
 
 std_itcheckflagpos (flag)
 
 std_itendpos (it)
 
 std_itGepIncluded (oIt)
 Get if the current defined seperator is included (or not in the return. More...
 
 std_itget (it)
 
 std_itGet (oIt)
 Return the initial object. More...
 
 std_itgetcontent (it, len)
 
std_itgetcontentfile (it, pf)
 
 std_itgetcontentstring (it, szFull)
 
 std_itGetLastLength (oIt)
 Get the last given length for read. More...
 
 std_itGetLength (oIt)
 Get the length of a StdIteration object. More...
 
 std_itgetnext (it)
 
 std_itgetnextchar (it)
 
 std_itgetnextcharfile (it, pf)
 
 std_itgetnextcharstring (it, s)
 
 std_itGetPos (oIt)
 Get the current cursor position of a StdIteration object. More...
 
 std_itGetPosBegin (oIt)
 Get the minimum cursor position. More...
 
 std_itGetPosEnd (oIt)
 Get the maximum cursor position. More...
 
 std_itGetSep (oIt)
 Get the current defined seperator. More...
 
 std_itinit ()
 
 std_itNewFile (chn, pFile)
 Create a new StdIteration object from a File object. More...
 
 std_itNewS (szValue)
 Create a new StdIteration object from a string. More...
 
 std_itNewTab (tab)
 Create a new StdIteration object from a tab (array) object. More...
 
 std_itRead (oIt, iLength)
 Read the subcontent of a StdIteration object from the current cursor position and the given lenght (like the fread C-function). Next, the position will be updated (current position + lenght) More...
 
 std_itReadNext (oIt)
 Read the subcontent of a StdIteration object from the current cursor position to one unit (byte, char or other) (like the fread C-function). Next, the position will be updated (current position + 1) More...
 
 std_itReadSep (oIt)
 Read the subcontent of a StdIteration object from the current cursor position until the next separator found. More...
 
 std_itSepIncluded (oIt, iFlag)
 Set if the separator is included in the return or not. More...
 
 std_itSetCb (oIt, cbfun)
 Set the function called for each iteration. More...
 
 std_itSetCbBegin (oIt, cbfun)
 
 std_itSetCbEnd (oIt, cbfun)
 Set the function called when the ioterator comes to the end. More...
 
 std_itsetposbegin (it, pos)
 
 std_itSetPosBegin (oIt, iPosBegin)
 Set the minimum cursor position. By default it is 0. More...
 
 std_itsetposend (it, pos)
 
 std_itSetPosEnd (oIt, iPosEnd)
 Set themaximum cursor position. By default it is the lenght of the object. More...
 
 std_itSetSep (oIt, iSep)
 Define a separator for a StdIteration object. More...
 
 std_itSetSepFromS (oIt, szSep)
 Define a separator for a StdIteration object. More...
 
 std_itupdatecurpos (it)
 
 std_itupdatepos (it, pos, flag)
 
 std_itUpdatePos (oIt, iPos, iFlag)
 Read the subcontent of a StdIteration tab (array) object from the current cursor position and the given lenght (like the fread C-function). Next, the position will be updated (current position + lenght) More...
 

Variables

set i
 
std_itupdatecurpos it
 
 nil
 
typedef Std_TypIteration
 
 t
 

Detailed Description

Scol Iteration Library API.

Author
Scol team
Version
0.1

Variable Documentation

typedef Std_TypIteration
Initial value:
=
Std_TypIterationI I
| Std_TypIterationF F
| Std_TypIterationS S
| Std_TypIterationFile File
| Std_TypIterationTab tab Std_TypIteration
| Std_TypIterationO
set i
Initial value:
= i+1
)