| lparsm_c |
|
Table of contents
Procedure
lparsm_c (Parse a list of items having multiple delimiters)
void lparsm_c ( ConstSpiceChar * list,
ConstSpiceChar * delims,
SpiceInt nmax,
SpiceInt itemln,
SpiceInt * n,
void * items )
AbstractParse a list of items separated by multiple delimiters. Required_ReadingNone. KeywordsCHARACTER LIST PARSING STRING Brief_I/OVARIABLE I/O DESCRIPTION -------- --- -------------------------------------------------- list I List of items delimited by delims. delims I Single characters which delimit items. nmax I Maximum number of items to return. itemln I Length of strings in item array. n O Number of items in the list. items O Items in the list, left justified. Detailed_Input
list is a list of items delimited by any one of the
characters in the string delims. Consecutive delimiters,
and delimiters at the beginning and end of the list, are
considered to delimit empty items. A blank or empty list
is considered to contain a single, empty item. Leading
and trailing blanks in list are ignored.
delims contains the individual characters which delimit
the items in the list. These may be any ASCII
characters, including blanks.
However, by definition, consecutive blanks are NOT
considered to be consecutive delimiters. Nor are
a blank and any other delimiter considered to be
consecutive delimiters.
nmax is the maximum number of items to be returned from the
list. This allows the user to guard against overflow
from a list containing more items than expected.
itemln is the declared length of the strings in the string
array items. This length must include room for the
terminating null character in each string.
Detailed_Output
n is the number of items in the list. `n' may be any number
between one and `nmax'.
items is an array of strings containing the items in the list,
left justified. Any item in the list too long to fit into
an element of `items' is truncated on the right. Empty
(null) or blank items in the input string are mapped to
empty strings on output.
`items' should be declared by the caller as:
SpiceChar items [nmax][itemln]
ParametersNone. Exceptions
1) If the string length of `items' is too short to accommodate
an item, the item will be truncated on the right.
2) If `nmax' is less than one, then `n' will be set to zero, and no
items will be returned. This case is not an error.
3) If the input `list' string is empty, the routine will return a
single, empty output string in `items'. This case is not an error.
4) If any of the `list', `delims' or `list' input string pointers
is null, the error SPICE(NULLPOINTER) is signaled.
5) If any of the `list' or `delims' input strings has zero
length, the error SPICE(EMPTYSTRING) is signaled.
6) If the `items' output string pointer is null, the error
SPICE(NULLPOINTER) is signaled.
7) If the `items' output string has length less than two
characters, the error SPICE(STRINGTOOSHORT) is signaled, since
the output string is too short to contain one character of
output data plus a null terminator.
FilesNone. ParticularsNone. Examples
The numerical results shown for these examples may differ across
platforms. The results depend on the SPICE kernels used as
input, the compiler and supporting libraries, and the machine
specific arithmetic implementation.
1) Parse a character string to retrieve the words contained
within.
Example code begins here.
/.
Program lparsm_ex1
./
#include <stdio.h>
#include "SpiceUsr.h"
int main( )
{
/.
Local constants.
./
#define NMAX 25
#define STRLEN 256
/.
Local variables.
./
SpiceChar * delims;
SpiceChar items [NMAX][STRLEN];
SpiceChar * list;
SpiceInt i;
SpiceInt n;
/.
Define the list of delimited items.
Think of a sentence as a list delimited by a space.
`delims' is assigned to a space.
./
list = "Run and find out.";
delims = " ";
/.
Parse the items from `list'.
./
lparsm_c ( list, delims, NMAX, STRLEN, &n, items );
/.
Output the `items'.
./
for ( i = 0; i < n; i++ )
{
printf( "Item %2d: %s\n", i, items[i] );
}
return ( 0 );
}
When this program was executed on a Mac/Intel/cc/64-bit
platform, the output was:
Item 0: Run
Item 1: and
Item 2: find
Item 3: out.
2) Parse a character string to retrive the items contained
within, when then items are separated by multiple delimiters.
Example code begins here.
/.
Program lparsm_ex2
./
#include <stdio.h>
#include "SpiceUsr.h"
int main( )
{
/.
Local constants.
./
#define NMAX 25
#define STRLEN 256
/.
Local variables.
./
SpiceChar * delims;
SpiceChar items [NMAX][STRLEN];
SpiceChar * list;
SpiceInt i;
SpiceInt n;
/.
Define the list of delimited items.
Think of a sentence as a list delimited by a space.
`delims' is assigned to a space.
./
list = " 1986-187// 13:15:12.184 ";
delims = " ,/-:";
/.
Parse the items from `list'.
./
lparsm_c ( list, delims, NMAX, STRLEN, &n, items );
/.
Output the `items'.
./
for ( i = 0; i < n; i++ )
{
printf( "Item %2d: \"%s\"\n", i, items[i] );
}
return ( 0 );
}
When this program was executed on a Mac/Intel/cc/64-bit
platform, the output was:
Item 0: "1986"
Item 1: "187"
Item 2: ""
Item 3: "13"
Item 4: "15"
Item 5: "12.184"
RestrictionsNone. Literature_ReferencesNone. Author_and_InstitutionN.J. Bachman (JPL) J. Diaz del Rio (ODC Space) I.M. Underwood (JPL) Version
-CSPICE Version 1.1.0, 04-AUG-2021 (JDR)
Changed input argument name "lenout" to "itemln" for consistency
with other routines.
Edited the header to comply with NAIF standard.
Added complete code example.
-CSPICE Version 1.0.0, 18-AUG-2002 (NJB) (IMU)
Index_Entriesparse a list of items |
Fri Dec 31 18:41:09 2021