lftp  4.4.6
About: lftp is a command line ftp client (FTP, HTTP, ssl support, background transfer, reget, reput, ...)
  Fossies Dox: lftp-4.4.6.tar.gz  ("inofficial" and yet experimental doxygen-generated source code documentation)  

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups
StaticStrings

Functions

TRIO_STRING_PUBLIC char
*trio_create 
TRIO_ARGS1 ((size), size_t size)
 
TRIO_STRING_PUBLIC void
trio_destroy 
TRIO_ARGS1 ((string), char *string)
 
TRIO_STRING_PUBLIC size_t
trio_length 
TRIO_ARGS1 ((string), TRIO_CONST char *string)
 
TRIO_STRING_PUBLIC int trio_append TRIO_ARGS2 ((target, source), char *target, TRIO_CONST char *source)
 
TRIO_STRING_PUBLIC int
trio_append_max 
TRIO_ARGS3 ((target, max, source), char *target, size_t max, TRIO_CONST char *source)
 
TRIO_STRING_PUBLIC int
trio_contains 
TRIO_ARGS2 ((string, substring), TRIO_CONST char *string, TRIO_CONST char *substring)
 
TRIO_STRING_PRIVATE char
*TrioDuplicateMax 
TRIO_ARGS2 ((source, size), TRIO_CONST char *source, size_t size)
 
TRIO_STRING_PUBLIC char
*trio_duplicate 
TRIO_ARGS1 ((source), TRIO_CONST char *source)
 
TRIO_STRING_PUBLIC char
*trio_duplicate_max 
TRIO_ARGS2 ((source, max), TRIO_CONST char *source, size_t max)
 
TRIO_STRING_PUBLIC int trio_equal TRIO_ARGS2 ((first, second), TRIO_CONST char *first, TRIO_CONST char *second)
 
TRIO_STRING_PUBLIC int
trio_equal_case_max 
TRIO_ARGS3 ((first, max, second), TRIO_CONST char *first, size_t max, TRIO_CONST char *second)
 
TRIO_STRING_PUBLIC TRIO_CONST
char *trio_error 
TRIO_ARGS1 ((error_number), int error_number)
 
TRIO_STRING_PUBLIC size_t
trio_format_date_max 
TRIO_ARGS4 ((target, max, format, datetime), char *target, size_t max, TRIO_CONST char *format, TRIO_CONST struct tm *datetime)
 
TRIO_STRING_PUBLIC unsigned
long trio_hash 
TRIO_ARGS2 ((string, type), TRIO_CONST char *string, int type)
 
TRIO_STRING_PUBLIC char *trio_index TRIO_ARGS2 ((string, character), TRIO_CONST char *string, int character)
 
TRIO_STRING_PUBLIC int trio_lower TRIO_ARGS1 ((target), char *target)
 
TRIO_STRING_PUBLIC int trio_match TRIO_ARGS2 ((string, pattern), TRIO_CONST char *string, TRIO_CONST char *pattern)
 
TRIO_STRING_PUBLIC size_t
trio_span_function 
TRIO_ARGS3 ((target, source, Function), char *target, TRIO_CONST char *source, int(*Function) TRIO_PROTO((int)))
 
TRIO_STRING_PUBLIC char
*trio_substring_max 
TRIO_ARGS3 ((string, max, substring), TRIO_CONST char *string, size_t max, TRIO_CONST char *substring)
 
TRIO_STRING_PUBLIC char
*trio_tokenize 
TRIO_ARGS2 ((string, delimiters), char *string, TRIO_CONST char *delimiters)
 
TRIO_STRING_PUBLIC
trio_long_double_t
trio_to_long_double 
TRIO_ARGS2 ((source, endp), TRIO_CONST char *source, char **endp)
 
TRIO_STRING_PUBLIC long
trio_to_long 
TRIO_ARGS3 ((string, endp, base), TRIO_CONST char *string, char **endp, int base)
 

Detailed Description

Function Documentation

TRIO_STRING_PUBLIC char* trio_create TRIO_ARGS1 ( (size)  ,
size_t  size 
)

Create new string.

Parameters
sizeSize of new string.
Returns
Pointer to string, or NULL if allocation failed.

Definition at line 113 of file triostr.c.

References TRIO_MALLOC.

TRIO_STRING_PUBLIC void trio_destroy TRIO_ARGS1 ( (string)  ,
char *  string 
)

Destroy string.

Parameters
stringString to be freed.

Definition at line 127 of file triostr.c.

References TRIO_FREE.

TRIO_STRING_PUBLIC size_t trio_length TRIO_ARGS1 ( (string)  ,
TRIO_CONST char *  string 
)

Count the number of characters in a string.

Parameters
stringString to measure.
Returns
Number of characters in .

Definition at line 145 of file triostr.c.

TRIO_STRING_PUBLIC char* trio_duplicate TRIO_ARGS1 ( (source)  ,
TRIO_CONST char *  source 
)

Duplicate source.

Parameters
sourceSource string.
Returns
A copy of the source string.
Postcondition
target will be zero terminated.

Definition at line 334 of file triostr.c.

TRIO_STRING_PUBLIC TRIO_CONST char* trio_error TRIO_ARGS1 ( (error_number)  ,
int  error_number 
)

Provide a textual description of an error code (errno).

Parameters
error_numberError number.
Returns
Textual description of error_number.

Definition at line 544 of file triostr.c.

References strerror().

TRIO_STRING_PUBLIC int trio_upper TRIO_ARGS1 ( (target)  ,
char *  target 
)

Convert the alphabetic letters in the string to lower-case.

Parameters
targetString to be converted.
Returns
Number of processed characters (converted or not).

Convert the alphabetic letters in the string to upper-case.

Parameters
targetThe string to be converted.
Returns
The number of processed characters (converted or not).

Definition at line 677 of file triostr.c.

TRIO_STRING_PUBLIC int trio_copy TRIO_ARGS2 ( (target, source)  ,
char *  target,
TRIO_CONST char *  source 
)

Append source at the end of target.

Parameters
targetTarget string.
sourceSource string.
Returns
Boolean value indicating success or failure.
Precondition
target must point to a memory chunk with sufficient room to contain the target string and source string.
No boundary checking is performed, so insufficient memory will result in a buffer overrun.
Postcondition
target will be zero terminated.

Copy source to target.

Parameters
targetTarget string.
sourceSource string.
Returns
Boolean value indicating success or failure.
Precondition
target must point to a memory chunk with sufficient room to contain the source string.
No boundary checking is performed, so insufficient memory will result in a buffer overrun.
Postcondition
target will be zero terminated.

Definition at line 168 of file triostr.c.

References NULL.

TRIO_STRING_PUBLIC char *trio_substring TRIO_ARGS2 ( (string, substring)  ,
TRIO_CONST char *  string,
TRIO_CONST char *  substring 
)

Determine if a string contains a substring.

Parameters
stringString to be searched.
substringString to be found.
Returns
Boolean value indicating success or failure.

Search for a substring in a string.

Parameters
stringString to be searched.
substringString to be found.
Returns
Pointer to first occurrence of substring in string, or NULL if no match was found.

Definition at line 228 of file triostr.c.

References strstr().

TRIO_STRING_PRIVATE char* TrioDuplicateMax TRIO_ARGS2 ( (source, size)  ,
TRIO_CONST char *  source,
size_t  size 
)

Definition at line 305 of file triostr.c.

TRIO_STRING_PUBLIC char* trio_duplicate_max TRIO_ARGS2 ( (source, max)  ,
TRIO_CONST char *  source,
size_t  max 
)

Duplicate at most max characters of source.

Parameters
sourceSource string.
maxMaximum number of characters to duplicate.
Returns
A copy of the source string.
Postcondition
target will be zero terminated.

Definition at line 352 of file triostr.c.

TRIO_STRING_PUBLIC int trio_equal_locale TRIO_ARGS2 ( (first, second)  ,
TRIO_CONST char *  first,
TRIO_CONST char *  second 
)

Compare if two strings are equal.

Parameters
firstFirst string.
secondSecond string.
Returns
Boolean indicating whether the two strings are equal or not.

Case-insensitive comparison.

Compare if two strings are equal.

Parameters
firstFirst string.
secondSecond string.
Returns
Boolean indicating whether the two strings are equal or not.

Case-sensitive comparison.

Compare if two strings are equal.

Parameters
firstFirst string.
secondSecond string.
Returns
Boolean indicating whether the two strings are equal or not.

Collating characters are considered equal.

Definition at line 382 of file triostr.c.

References FALSE, NIL, NULL, and strcasecmp().

TRIO_STRING_PUBLIC unsigned long trio_hash TRIO_ARGS2 ( (string, type)  ,
TRIO_CONST char *  string,
int  type 
)

Calculate a hash value for a string.

Parameters
stringString to be calculated on.
typeHash function.
Returns
Calculated hash value.

type can be one of the following

  • TRIO_HASH_PLAIN Plain hash function.

Definition at line 599 of file triostr.c.

References FALSE, NIL, and TRIO_HASH_PLAIN.

TRIO_STRING_PUBLIC char *trio_index_last TRIO_ARGS2 ( (string, character)  ,
TRIO_CONST char *  string,
int  character 
)

Find first occurrence of a character in a string.

Parameters
stringString to be searched.
characterCharacter to be found.
Apointer to the found character, or NULL if character was not found.

Find last occurrence of a character in a string.

Parameters
stringString to be searched.
characterCharacter to be found.
Apointer to the found character, or NULL if character was not found.

Definition at line 636 of file triostr.c.

References strchr.

TRIO_STRING_PUBLIC int trio_match_case TRIO_ARGS2 ( (string, pattern)  ,
TRIO_CONST char *  string,
TRIO_CONST char *  pattern 
)

Compare two strings using wildcards.

Parameters
stringString to be searched.
patternPattern, including wildcards, to search for.
Returns
Boolean value indicating success or failure.

Case-insensitive comparison.

The following wildcards can be used

  • * Match any number of characters.
  • ? Match a single character.

Compare two strings using wildcards.

Parameters
stringString to be searched.
patternPattern, including wildcards, to search for.
Returns
Boolean value indicating success or failure.

Case-sensitive comparison.

The following wildcards can be used

  • * Match any number of characters.
  • ? Match a single character.

Definition at line 703 of file triostr.c.

References FALSE, NIL, and TRUE.

TRIO_STRING_PUBLIC char* trio_tokenize TRIO_ARGS2 ( (string, delimiters)  ,
char *  string,
TRIO_CONST char *  delimiters 
)

Tokenize string.

Parameters
stringString to be tokenized.
tokensString containing list of delimiting characters.
Returns
Start of new token.
Warning
string will be destroyed.

Definition at line 901 of file triostr.c.

TRIO_STRING_PUBLIC float trio_to_float TRIO_ARGS2 ( (source, endp)  ,
TRIO_CONST char *  source,
char **  endp 
)

Convert string to floating-point number.

Parameters
sourceString to be converted.
endpPointer to end of the converted string.
Returns
A floating-point number.

The following Extended Backus-Naur form is used

double        ::= [ <sign> ]
                  ( <number> |
                    <number> <decimal_point> <number> |
                    <decimal_point> <number> )
                  [ <exponential> [ <sign> ] <number> ]
number        ::= 1*( <digit> )
digit         ::= ( '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' )
exponential   ::= ( 'e' | 'E' )
sign          ::= ( '-' | '+' )
decimal_point ::= '.'

Convert string to floating-point number.

Parameters
sourceString to be converted.
endpPointer to end of the converted string.
Returns
A floating-point number.

See trio_to_long_double.

Definition at line 936 of file triostr.c.

References FALSE, and TRIO_MICROSOFT.

TRIO_STRING_PUBLIC int trio_copy_max TRIO_ARGS3 ( (target, max, source)  ,
char *  target,
size_t  max,
TRIO_CONST char *  source 
)

Append at most max characters from source to target.

Parameters
targetTarget string.
maxMaximum number of characters to append.
sourceSource string.
Returns
Boolean value indicating success or failure.
Precondition
target must point to a memory chuck with sufficient room to contain the target string and the source string (at most max characters).
No boundary checking is performed, so insufficient memory will result in a buffer overrun.
Postcondition
target will be zero terminated.

Copy at most max characters from source to target.

Parameters
targetTarget string.
maxMaximum number of characters to append.
sourceSource string.
Returns
Boolean value indicating success or failure.
Precondition
target must point to a memory chunk with sufficient room to contain the source string (at most max characters).
No boundary checking is performed, so insufficient memory will result in a buffer overrun.
Postcondition
target will be zero terminated.

Definition at line 197 of file triostr.c.

References TRUE.

TRIO_STRING_PUBLIC int trio_equal_max TRIO_ARGS3 ( (first, max, second)  ,
TRIO_CONST char *  first,
size_t  max,
TRIO_CONST char *  second 
)

Compare if two strings up until the first max characters are equal.

Parameters
firstFirst string.
maxMaximum number of characters to compare.
secondSecond string.
Returns
Boolean indicating whether the two strings are equal or not.

Case-sensitive comparison.

Compare if two strings up until the first max characters are equal.

Parameters
firstFirst string.
maxMaximum number of characters to compare.
secondSecond string.
Returns
Boolean indicating whether the two strings are equal or not.

Case-insensitive comparison.

Definition at line 449 of file triostr.c.

References FALSE, and NULL.

TRIO_STRING_PUBLIC size_t trio_span_function TRIO_ARGS3 ( (target, source, Function)  ,
char *  target,
TRIO_CONST char *  source,
int *Function   TRIO_PROTO(int) 
)

Execute a function on each character in string.

Parameters
targetTarget string.
sourceSource string.
FunctionFunction to be executed.
Returns
Number of processed characters.

Definition at line 804 of file triostr.c.

References NIL.

TRIO_STRING_PUBLIC char* trio_substring_max TRIO_ARGS3 ( (string, max, substring)  ,
TRIO_CONST char *  string,
size_t  max,
TRIO_CONST char *  substring 
)

Search for a substring in the first max characters of a string.

Parameters
stringString to be searched.
maxMaximum characters to be searched.
substringString to be found.
Returns
Pointer to first occurrence of substring in string, or NULL if no match was found.

Definition at line 860 of file triostr.c.

References NULL.

TRIO_STRING_PUBLIC unsigned long trio_to_unsigned_long TRIO_ARGS3 ( (string, endp, base)  ,
TRIO_CONST char *  string,
char **  endp,
int  base 
)

Convert string to signed integer.

Parameters
stringString to be converted.
endpPointer to end of converted string.
baseRadix number of number.

Convert string to unsigned integer.

Parameters
stringString to be converted.
endpPointer to end of converted string.
baseRadix number of number.

Definition at line 1114 of file triostr.c.

References strtol().

TRIO_STRING_PUBLIC size_t trio_format_date_max TRIO_ARGS4 ( (target, max, format, datetime)  ,
char *  target,
size_t  max,
TRIO_CONST char *  format,
TRIO_CONST struct tm datetime 
)

Format the date/time according to format.

Parameters
targetTarget string.
maxMaximum number of characters to format.
formatFormatting string.
datetimeDate/time structure.
Returns
Number of formatted characters.

The formatting string accepts the same specifiers as the standard C function strftime.

Definition at line 570 of file triostr.c.