ajstr.c

Datatypes: char* AjPStr const AjPStr AjIStr AjPStrTok

Datatype: char*

Sections: constructors destructors formatting comparison comparison (sorting) parsing functions

Section: constructors

Functions: ajCharNewC ajCharNewS ajCharNewRes ajCharNewResC ajCharNewResS ajCharNewResLenC ajCharNull

Function ajCharNewC

Synopsis

Prototype

char* ajCharNewC (
      const char* txt
);

Type	Name	Read/Write	Description
const char*	txt	Input	Initial text, possibly shorter than the space allocated.
char*		RETURN	A new text string.

Input

Returns

Description

See Also

Availability

Function ajCharNewS

Synopsis

Prototype

char* ajCharNewS (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String object as initial value and size for the text.
char*		RETURN	A new text string.

Input

Returns

Description

See Also

Availability

Function ajCharNewRes

Synopsis

Prototype

char* ajCharNewRes (
      size_t size
);

Type	Name	Read/Write	Description
size_t	size	Input	Length of the Cstring, excluding the trailing NULL.
char*		RETURN	A new text string with no contents.

Input

Returns

Description

See Also

Availability

Function ajCharNewResC

Synopsis

Prototype

char* ajCharNewResC (
      const char* txt,
      size_t size
);

Type	Name	Read/Write	Description
const char*	txt	Input	String object as initial value and size for the text.
size_t	size	Input	Maximum string length, as returned by strlen
char*		RETURN	A new text string.

Input

Returns

Description

See Also

Availability

Function ajCharNewResS

Synopsis

Prototype

char* ajCharNewResS (
      const AjPStr str,
      size_t size
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String object as initial value and size for the text.
size_t	size	Input	Maximum string length, as returned by strlen
char*		RETURN	A new text string.

Input

Returns

Description

See Also

Availability

Function ajCharNewResLenC

Synopsis

Prototype

char* ajCharNewResLenC (
      const char* txt,
      size_t size,
      size_t len
);

Type	Name	Read/Write	Description
const char*	txt	Input	String object as initial value and size for the text.
size_t	size	Input	Maximum string length, as returned by strlen
size_t	len	Input	Length of txt to save calculation time.
char*		RETURN	A new text string.

Input

Returns

Description

See Also

Availability

Function ajCharNull

Synopsis

Prototype

char* ajCharNull (
      void
);

Type	Name	Read/Write	Description
char*		RETURN	Empty string

Returns

Description

See Also

Availability

Section: destructors

Functions: ajCharDel

Function ajCharDel

Synopsis

Prototype

void ajCharDel (
      char** Ptxt
);

Type	Name	Read/Write	Description
char**	Ptxt	Delete	Text string to be deallocated.
void		RETURN

Output

Returns

Description

See Also

Availability

Section: formatting

Functions: ajCharFmtLower ajCharFmtUpper

Function ajCharFmtLower

Synopsis

Prototype

AjBool ajCharFmtLower (
      char* txt
);

Type	Name	Read/Write	Description
char*	txt	Modify	Text string
AjBool		RETURN	ajTrue on success

Input & Output

Returns

Description

See Also

Availability

Function ajCharFmtUpper

Synopsis

Prototype

AjBool ajCharFmtUpper (
      char* txt
);

Type	Name	Read/Write	Description
char*	txt	Modify	Text string
AjBool		RETURN	ajTrue on success

Input & Output

Returns

Description

See Also

Availability

Section: comparison

Functions: ajCharMatchC ajCharMatchCaseC ajCharMatchWildC ajCharMatchWildS ajCharMatchWildCaseC ajCharMatchWildCaseS ajCharMatchWildNextC ajCharMatchWildNextCaseC ajCharMatchWildWordC ajCharMatchWildWordCaseC ajCharPrefixC ajCharPrefixS ajCharPrefixCaseC ajCharPrefixCaseS ajCharSuffixC ajCharSuffixS ajCharSuffixCaseC ajCharSuffixCaseS

Function ajCharMatchC

Synopsis

Prototype

AjBool ajCharMatchC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Text
AjBool		RETURN	ajTrue if text completely matches the start of String

Input

Returns

Description

See Also

Availability

Function ajCharMatchCaseC

Synopsis

Prototype

AjBool ajCharMatchCaseC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Text
AjBool		RETURN	ajTrue if two strings are exactly the same excluding case

Input

Returns

Description

See Also

Availability

Function ajCharMatchWildC

Synopsis

Prototype

AjBool ajCharMatchWildC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Text
AjBool		RETURN	ajTrue if the strings match

Input

Returns

Description

See Also

Availability

Function ajCharMatchWildS

Synopsis

Prototype

AjBool ajCharMatchWildS (
      const char* txt,
      const AjPStr str
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const AjPStr	str	Input	Wildcard text
AjBool		RETURN	ajTrue if the strings match

Input

Returns

Description

See Also

Availability

Function ajCharMatchWildCaseC

Synopsis

Prototype

AjBool ajCharMatchWildCaseC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Text
AjBool		RETURN	ajTrue if the strings match

Input

Returns

Description

See Also

Availability

Function ajCharMatchWildCaseS

Synopsis

Prototype

AjBool ajCharMatchWildCaseS (
      const char* txt,
      const AjPStr str
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const AjPStr	str	Input	Wildcard text
AjBool		RETURN	ajTrue if the strings match

Input

Returns

Description

See Also

Availability

Function ajCharMatchWildNextC

Synopsis

Prototype

AjBool ajCharMatchWildNextC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Text
AjBool		RETURN	ajTrue if found

Input

Returns

Description

See Also

Availability

Function ajCharMatchWildNextCaseC

Synopsis

Prototype

AjBool ajCharMatchWildNextCaseC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Text
AjBool		RETURN	ajTrue if found

Input

Returns

Description

See Also

Availability

Function ajCharMatchWildWordC

'Word' is defined as starting and ending with an alphanumeric character (A-Z a-z 0-9) with no white space.

The query text can use '*' or '?' as a wildcard.

Synopsis

Prototype

AjBool ajCharMatchWildWordC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Wildcard word
AjBool		RETURN	ajTrue if found

Input

Returns

Description

'Word' is defined as starting and ending with an alphanumeric character (A-Z a-z 0-9) with no white space.

The query text can use '*' or '?' as a wildcard.

See Also

Availability

Function ajCharMatchWildWordCaseC

'Word' is defined as starting and ending with an alphanumeric character (A-Z a-z 0-9) with no white space.

The query text can use '*' or '?' as a wildcard.

Synopsis

Prototype

AjBool ajCharMatchWildWordCaseC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Wildcard word
AjBool		RETURN	ajTrue if found

Input

Returns

Description

'Word' is defined as starting and ending with an alphanumeric character (A-Z a-z 0-9) with no white space.

The query text can use '*' or '?' as a wildcard.

See Also

Availability

Function ajCharPrefixC

Synopsis

Prototype

AjBool ajCharPrefixC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	Test string as text
const char*	txt2	Input	Prefix as text
AjBool		RETURN	ajTrue if the string begins with the prefix

Input

Returns

Description

See Also

Availability

Function ajCharPrefixS

Synopsis

Prototype

AjBool ajCharPrefixS (
      const char* txt,
      const AjPStr str
);

Type	Name	Read/Write	Description
const char*	txt	Input	Test string as text
const AjPStr	str	Input	Prefix as string
AjBool		RETURN	ajTrue if the string begins with the prefix

Input

Returns

Description

See Also

Availability

Function ajCharPrefixCaseC

Synopsis

Prototype

AjBool ajCharPrefixCaseC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	Text
const char*	txt2	Input	Prefix
AjBool		RETURN	ajTrue if the string begins with the prefix

Input

Returns

Description

See Also

Availability

Function ajCharPrefixCaseS

Synopsis

Prototype

AjBool ajCharPrefixCaseS (
      const char* txt,
      const AjPStr str
);

Type	Name	Read/Write	Description
const char*	txt	Input	Text
const AjPStr	str	Input	Prefix
AjBool		RETURN	ajTrue if the string begins with the prefix

Input

Returns

Description

See Also

Availability

Function ajCharSuffixC

Synopsis

Prototype

AjBool ajCharSuffixC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Suffix as text
AjBool		RETURN	ajTrue if the string ends with the suffix

Input

Returns

Description

See Also

Availability

Function ajCharSuffixS

Synopsis

Prototype

AjBool ajCharSuffixS (
      const char* txt,
      const AjPStr str
);

Type	Name	Read/Write	Description
const char*	txt	Input	Test string as text
const AjPStr	str	Input	Suffix as string
AjBool		RETURN	ajTrue if the string ends with the suffix

Input

Returns

Description

See Also

Availability

Function ajCharSuffixCaseC

Synopsis

Prototype

AjBool ajCharSuffixCaseC (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Suffix as text
AjBool		RETURN	ajTrue if the string ends with the suffix

Input

Returns

Description

See Also

Availability

Function ajCharSuffixCaseS

Synopsis

Prototype

AjBool ajCharSuffixCaseS (
      const char* txt,
      const AjPStr str
);

Type	Name	Read/Write	Description
const char*	txt	Input	Test string as text
const AjPStr	str	Input	Suffix as string
AjBool		RETURN	ajTrue if the string ends with the suffix

Input

Returns

Description

See Also

Availability

Section: comparison (sorting)

Functions: ajCharCmpCase ajCharCmpCaseLen ajCharCmpWild ajCharCmpWildCase

Function ajCharCmpCase

Synopsis

Prototype

int ajCharCmpCase (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	Text string
const char*	txt2	Input	Text string
int		RETURN	-1 if first string should sort before second, +1 if the second string should sort first. 0 if they are identical in length and content.

Input

Returns

Description

See Also

Availability

Function ajCharCmpCaseLen

Synopsis

Prototype

int ajCharCmpCaseLen (
      const char* txt,
      const char* txt2,
      size_t len
);

Type	Name	Read/Write	Description
const char*	txt	Input	Text string
const char*	txt2	Input	Text string
size_t	len	Input	length
int		RETURN	-1 if first string should sort before second, +1 if the second string should sort first. 0 if they are identical in length and content.

Input

Returns

Description

See Also

Availability

Function ajCharCmpWild

Synopsis

Prototype

int ajCharCmpWild (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Text
int		RETURN	-1 if first string should sort before second, +1 if the second string should sort first. 0 if they are identical in length and content.

Input

Returns

Description

See Also

Availability

Function ajCharCmpWildCase

Synopsis

Prototype

int ajCharCmpWildCase (
      const char* txt,
      const char* txt2
);

Type	Name	Read/Write	Description
const char*	txt	Input	String
const char*	txt2	Input	Text
int		RETURN	-1 if first string should sort before second, +1 if the second string should sort first. 0 if they are identical in length and content.

Input

Returns

Description

See Also

Availability

Section: parsing functions

Functions: ajCharParseC

Function ajCharParseC

Synopsis

Prototype

AjPStr ajCharParseC (
      const char* txt,
      const char* txtdelim
);

Type	Name	Read/Write	Description
const char*	txt	Input	String to be parsed (first call) or NULL for follow-up calls using the same string, as for the C RTL function strtok which is eventually called.
const char*	txtdelim	Input	Delimiter(s) to be used between tokens.
AjPStr		RETURN	Token

Input

Returns

Description

See Also

Availability

Datatype: AjPStr

Sections: constructors destructors assignment combination functions cutting substitution query element retrieval modifiable string retrieval element assignment string to datatype conversion functions datatype to string conversion functions formatting comparison comparison (sorting) comparison (search) functions parsing functions debugging exit

Section: constructors

Functions: ajStrNew ajStrNewC ajStrNewK ajStrNewS ajStrNewRef ajStrNewRes ajStrNewResC ajStrNewResS ajStrNewResLenC

Function ajStrNew

The null string usage pointer is incremented.

Synopsis

Prototype

AjPStr ajStrNew (
      void
);

Type	Name	Read/Write	Description
AjPStr		RETURN	Pointer to an empty string

Returns

Description

The null string usage pointer is incremented.

See Also

Availability

Function ajStrNewC

The string size is set just large enough to hold the supplied text.

Synopsis

Prototype

AjPStr ajStrNewC (
      const char* txt
);

Type	Name	Read/Write	Description
const char*	txt	Input	Null-terminated character string to initialise the new string.
AjPStr		RETURN	Pointer to a string containing the supplied text

Input

Returns

Description

The string size is set just large enough to hold the supplied text.

See Also

Availability

Function ajStrNewK

The string size is set just large enough to hold the supplied text.

Synopsis

Prototype

AjPStr ajStrNewK (
      char ch
);

Type	Name	Read/Write	Description
char	ch	Input	Null-terminated character string to initialise the new string.
AjPStr		RETURN	Pointer to a string containing the supplied text

Input

Returns

Description

The string size is set just large enough to hold the supplied text.

See Also

Availability

Function ajStrNewS

Synopsis

Prototype

AjPStr ajStrNewS (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String to be cloned
AjPStr		RETURN	Pointer to a string of the specified size containing the supplied text.

Input

Returns

Description

See Also

Availability

Function ajStrNewRef

Not a true string copy, but if modified the new string will behave as a copy.

Synopsis

Prototype

AjPStr ajStrNewRef (
      AjPStr refstr
);

Type	Name	Read/Write	Description
AjPStr	refstr	Modify	AJAX string object
AjPStr		RETURN	Pointer to the string passed as an argument, with its use count increased by 1.

Input & Output

Returns

Description

Not a true string copy, but if modified the new string will behave as a copy.

See Also

Availability

Function ajStrNewRes

Synopsis

Prototype

AjPStr ajStrNewRes (
      size_t size
);

Type	Name	Read/Write	Description
size_t	size	Input	Reserved size (including a possible null).
AjPStr		RETURN	Pointer to an empty string of specified size.

Input

Returns

Description

See Also

Availability

Function ajStrNewResC

Synopsis

Prototype

AjPStr ajStrNewResC (
      const char* txt,
      size_t size
);

Type	Name	Read/Write	Description
const char*	txt	Input	Null-terminated character string to initialise the new string.
size_t	size	Input	Reserved size (including a possible null).
AjPStr		RETURN	Pointer to a string of the specified size containing the supplied text.

Input

Returns

Description

See Also

Availability

Function ajStrNewResS

Synopsis

Prototype

AjPStr ajStrNewResS (
      const AjPStr str,
      size_t size
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String to initialise the new string.
size_t	size	Input	Reserved size (including a possible null).
AjPStr		RETURN	Pointer to a string of the specified size containing the supplied text.

Input

Returns

Description

See Also

Availability

Function ajStrNewResLenC

Synopsis

Prototype

AjPStr ajStrNewResLenC (
      const char* txt,
      size_t size,
      size_t len
);

Type	Name	Read/Write	Description
const char*	txt	Input	Null-terminated character string to initialise the new string.
size_t	size	Input	Reserved size, including a trailing null and possible space for expansion
size_t	len	Input	Length of txt to save calculation time.
AjPStr		RETURN	Pointer to a string of the specified size containing the supplied text.

Input

Returns

Description

See Also

Availability

Section: destructors

Functions: MAJSTRDEL ajStrDel ajStrDelStatic ajStrDelarray

Macro MAJSTRDEL

Decrements the use count. When it reaches zero, the string is removed from memory. If the given string is NULL, or a NULL pointer, simply returns.

A macro version of {ajStrDel} available in case it is needed for speed.

Output

Returns

Description

Decrements the use count. When it reaches zero, the string is removed from memory. If the given string is NULL, or a NULL pointer, simply returns.

A macro version of {ajStrDel} available in case it is needed for speed.

See Also

Availability

Function ajStrDel

Decrements the use count. When it reaches zero, the string is removed from memory. If the given string is NULL, or a NULL pointer, simply returns.

Synopsis

Prototype

void ajStrDel (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Delete	Pointer to the string to be deleted. The pointer is always deleted.
void		RETURN

Output

Returns

Description

Decrements the use count. When it reaches zero, the string is removed from memory. If the given string is NULL, or a NULL pointer, simply returns.

See Also

Availability

Function ajStrDelStatic

Memory reserved for the string is never deleted and can always be reused by any remaining AjPStr that points to it even if this pointer is cleared.

Use for more efficient memory management for static strings, to avoid reallocation when used in a subsequent call.

If the given string is NULL, or a NULL pointer, simply returns.

Synopsis

Prototype

AjBool ajStrDelStatic (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Pointer to the string to be deleted.
AjBool		RETURN	True if the string exists and can be reused False if the string was deleted.

Output

Returns

Description

Memory reserved for the string is never deleted and can always be reused by any remaining AjPStr that points to it even if this pointer is cleared.

Use for more efficient memory management for static strings, to avoid reallocation when used in a subsequent call.

If the given string is NULL, or a NULL pointer, simply returns.

See Also

Availability

Function ajStrDelarray

Decrements the use count. When it reaches zero, the string is removed from memory. If the given string is NULL, or a NULL pointer, simply returns.

Synopsis

Prototype

void ajStrDelarray (
      AjPStr** PPstr
);

Type	Name	Read/Write	Description
AjPStr**	PPstr	Delete	Pointer to the string array to be deleted. The last string is a NULL pointer The pointer is always deleted.
void		RETURN

Output

Returns

Description

Decrements the use count. When it reaches zero, the string is removed from memory. If the given string is NULL, or a NULL pointer, simply returns.

See Also

Availability

Section: assignment

Functions: ajStrAssignC ajStrAssignK ajStrAssignS ajStrAssignClear ajStrAssignEmptyC ajStrAssignEmptyS ajStrAssignLenC ajStrAssignRef ajStrAssignResC ajStrAssignResS ajStrAssignSubC ajStrAssignSubS

Function ajStrAssignC

Synopsis

Prototype

AjBool ajStrAssignC (
      AjPStr* Pstr,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string.
const char*	txt	Input	Source text.
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrAssignK

Synopsis

Prototype

AjBool ajStrAssignK (
      AjPStr* Pstr,
      char chr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string.
char	chr	Input	Source text.
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrAssignS

This is a genuine copy (reference count isn't used). Useful where both strings will be separately overwritten later so that they can both remain modifiable.

Synopsis

Prototype

AjBool ajStrAssignS (
      AjPStr* Pstr,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string.
const AjPStr	str	Input	Source string.
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

This is a genuine copy (reference count isn't used). Useful where both strings will be separately overwritten later so that they can both remain modifiable.

See Also

Availability

Function ajStrAssignClear

Synopsis

Prototype

AjBool ajStrAssignClear (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string.
AjBool		RETURN	ajTrue if string was reallocated

Output

Returns

Description

See Also

Availability

Function ajStrAssignEmptyC

Synopsis

Prototype

AjBool ajStrAssignEmptyC (
      AjPStr* Pstr,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string which is overwritten.
const char*	txt	Input	Source text.
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrAssignEmptyS

Synopsis

Prototype

AjBool ajStrAssignEmptyS (
      AjPStr* Pstr,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string which is overwritten.
const AjPStr	str	Input	Source string object.
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrAssignLenC

Synopsis

Prototype

AjBool ajStrAssignLenC (
      AjPStr* Pstr,
      const char* txt,
      size_t len
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string.
const char*	txt	Input	Source text.
size_t	len	Input	Length of source text.
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrAssignRef

Not a true string copy, but if modified the new string will behave as a copy.

Sets the destination string to NULL if the source string is NULL.

Synopsis

Prototype

AjBool ajStrAssignRef (
      AjPStr* Pstr,
      AjPStr refstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string which is overwritten.
AjPStr	refstr	Modify	Source string object Copy by reference count so not const.
AjBool		RETURN	ajTrue if string was reallocated

Output

Input & Output

Returns

Description

Not a true string copy, but if modified the new string will behave as a copy.

Sets the destination string to NULL if the source string is NULL.

See Also

Availability

Function ajStrAssignResC

Synopsis

Prototype

AjBool ajStrAssignResC (
      AjPStr* Pstr,
      size_t size,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string.
size_t	size	Input	Space to reserve.
const char*	txt	Input	Source text.
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrAssignResS

Synopsis

Prototype

AjBool ajStrAssignResS (
      AjPStr* Pstr,
      size_t size,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string.
size_t	size	Input	Size of new string.
const AjPStr	str	Input	Source text.
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrAssignSubC

Synopsis

Prototype

AjBool ajStrAssignSubC (
      AjPStr* Pstr,
      const char* txt,
      ajlong pos1,
      ajlong pos2
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
const char*	txt	Input	Source text
ajlong	pos1	Input	start position for substring
ajlong	pos2	Input	end position for substring
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrAssignSubS

Synopsis

Prototype

AjBool ajStrAssignSubS (
      AjPStr* Pstr,
      const AjPStr str,
      ajlong pos1,
      ajlong pos2
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
const AjPStr	str	Input	Source string
ajlong	pos1	Input	Start position in src of substring
ajlong	pos2	Input	End position in src of substring
AjBool		RETURN	ajTrue if Pstr was (re)allocated, ajFalse otherwise

Input

Output

Returns

Description

The substring is defined from character positions pos1 to pos2.

ajTrue is returned if target was (re)allocated, ajFalse is returned otherwise.

Usage

pos1: negative values count from the end of the string with -1 as the last position

pos2: negative values count from the end of the string with -1 as the last position

See Also

Availability

Section: combination functions

Functions: ajStrAppendC ajStrAppendK ajStrAppendS ajStrAppendCountK ajStrAppendLenC ajStrAppendSubC ajStrAppendSubS ajStrInsertC ajStrInsertK ajStrInsertS ajStrJoinC ajStrJoinS ajStrMaskIdent ajStrMaskRange ajStrPasteS ajStrPasteCountK ajStrPasteMaxC ajStrPasteMaxS

Function ajStrAppendC

Uses {ajStrSetRes} to make sure target string is modifiable.

Synopsis

Prototype

AjBool ajStrAppendC (
      AjPStr* Pstr,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
const char*	txt	Input	Source text
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

Uses {ajStrSetRes} to make sure target string is modifiable.

See Also

Availability

Function ajStrAppendK

Uses {ajStrSetRes} to make sure target string is modifiable.

Synopsis

Prototype

AjBool ajStrAppendK (
      AjPStr* Pstr,
      char chr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
char	chr	Input	Source character
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

Uses {ajStrSetRes} to make sure target string is modifiable.

See Also

Availability

Function ajStrAppendS

Uses {ajStrSetRes} to make sure target string is modifiable.

Synopsis

Prototype

AjBool ajStrAppendS (
      AjPStr* Pstr,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
const AjPStr	str	Input	Source string
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

Uses {ajStrSetRes} to make sure target string is modifiable.

See Also

Availability

Function ajStrAppendCountK

Equivalent to a repeat count for ajStrAppK.

Uses {ajStrSetRes} to make sure target string is modifiable.

Synopsis

Prototype

AjBool ajStrAppendCountK (
      AjPStr* Pstr,
      char chr,
      ajulong num
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
char	chr	Input	Source character
ajulong	num	Input	Repeat count
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

Equivalent to a repeat count for ajStrAppK.

Uses {ajStrSetRes} to make sure target string is modifiable.

See Also

Availability

Function ajStrAppendLenC

Uses {ajStrSetRes} to make sure target string is modifiable.

Synopsis

Prototype

AjBool ajStrAppendLenC (
      AjPStr* Pstr,
      const char* txt,
      size_t len
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
const char*	txt	Input	Source text
size_t	len	Input	String length
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

Uses {ajStrSetRes} to make sure target string is modifiable.

See Also

Availability

Function ajStrAppendSubC

Synopsis

Prototype

AjBool ajStrAppendSubC (
      AjPStr* Pstr,
      const char* txt,
      ajlong pos1,
      ajlong pos2
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
const char*	txt	Input	Source string
ajlong	pos1	Input	start position for substring
ajlong	pos2	Input	end position for substring
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrAppendSubS

Uses {ajStrSetRes} to make sure target string is modifiable.

Synopsis

Prototype

AjBool ajStrAppendSubS (
      AjPStr* Pstr,
      const AjPStr str,
      ajlong pos1,
      ajlong pos2
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
const AjPStr	str	Input	Source string
ajlong	pos1	Input	start position for substring
ajlong	pos2	Input	end position for substring
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

Uses {ajStrSetRes} to make sure target string is modifiable.

See Also

Availability

Function ajStrInsertC

Synopsis

Prototype

AjBool ajStrInsertC (
      AjPStr* Pstr,
      ajlong pos,
      const char* txt 
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
ajlong	pos	Input	Position where text is to be inserted. Negative position counts from the end
const char*	txt	Input	Text to be inserted
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrInsertK

Synopsis

Prototype

AjBool ajStrInsertK (
      AjPStr* Pstr,
      ajlong pos,
      char chr 
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
ajlong	pos	Input	Position where text is to be inserted. Negative position counts from the end
char	chr	Input	Text to be inserted
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrInsertS

Synopsis

Prototype

AjBool ajStrInsertS (
      AjPStr* Pstr,
      ajlong pos,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
ajlong	pos	Input	Position where text is to be inserted. Negative position counts from the end
const AjPStr	str	Input	String to be inserted
AjBool		RETURN	ajTrue on successful completion else ajFalse;

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrJoinC

Synopsis

Prototype

AjBool ajStrJoinC (
      AjPStr* Pstr,
      ajlong pos,
      const char* txt,
      ajlong posb
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string.
ajlong	pos	Input	Number of characters to keep in target string.
const char*	txt	Input	Text to append.
ajlong	posb	Input	Position of first character to copy from text.
AjBool		RETURN	ajTrue on success

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrJoinS

Cuts down string at pos1 and add string2 from position pos2.

Synopsis

Prototype

AjBool ajStrJoinS (
      AjPStr* Pstr,
      ajlong pos,
      const AjPStr str,
      ajlong posb
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string.
ajlong	pos	Input	Start position in target string, negative numbers count from the end.
const AjPStr	str	Input	String to append.
ajlong	posb	Input	Starts position to copy, negative numbers count from the end.
AjBool		RETURN	ajTrue on success.

Input

Input & Output

Returns

Description

Cuts down string at pos1 and add string2 from position pos2.

See Also

Availability

Function ajStrMaskIdent

Synopsis

Prototype

AjBool ajStrMaskIdent (
      AjPStr* Pstr,
      const AjPStr str,
      char maskchr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
const AjPStr	str	Input	Comparison string
char	maskchr	Input	masking character
AjBool		RETURN	ajTrue on success

Input

Output

Returns

Description

See Also

Availability

Function ajStrMaskRange

Synopsis

Prototype

AjBool ajStrMaskRange (
      AjPStr* Pstr,
      ajlong pos1,
      ajlong pos2,
      char maskchr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
ajlong	pos1	Input	start position to be masked
ajlong	pos2	Input	end position to be masked
char	maskchr	Input	masking character
AjBool		RETURN	ajTrue on success, ajFalse if begin is out of range

Input

Output

Returns

Description

See Also

Availability

Function ajStrPasteS

Replace string at pos1 with new string.

Synopsis

Prototype

AjBool ajStrPasteS (
      AjPStr* Pstr,
      ajlong pos,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
ajlong	pos	Input	Position in target string
const AjPStr	str	Input	String to replace.
AjBool		RETURN	ajTrue on success

Input

Input & Output

Returns

Description

Replace string at pos1 with new string.

See Also

Availability

Function ajStrPasteCountK

Replace string at pos and add num copies of character chr. Or to the end of the existing string

Synopsis

Prototype

AjBool ajStrPasteCountK (
      AjPStr* Pstr,
      ajlong pos,
      char chr,
      ajulong num
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
ajlong	pos	Input	position in string
char	chr	Input	Character to replace.
ajulong	num	Input	Number of characters to copy from text.
AjBool		RETURN	ajTrue on success

Input

Input & Output

Returns

Description

Replace string at pos and add num copies of character chr. Or to the end of the existing string

See Also

Availability

Function ajStrPasteMaxC

Replaces string at pos ands add len characters from text string txt. Or to the end of the existing string

Synopsis

Prototype

AjBool ajStrPasteMaxC (
      AjPStr* Pstr,
      ajlong pos,
      const char* txt,
      size_t len
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
ajlong	pos	Input	Start position in target string.
const char*	txt	Input	String to replace.
size_t	len	Input	Number of characters to copy from text.
AjBool		RETURN	ajTrue on success

Input

Input & Output

Returns

Description

Replaces string at pos ands add len characters from text string txt. Or to the end of the existing string

See Also

Availability

Function ajStrPasteMaxS

Replaces string at pos and add len characters from string str. Or to the end of the existing string

Synopsis

Prototype

AjBool ajStrPasteMaxS (
      AjPStr* Pstr,
      ajlong pos,
      const AjPStr str,
      size_t len
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
ajlong	pos	Input	Start position in target string.
const AjPStr	str	Input	Replacement string
size_t	len	Input	Number of characters to copy from text.
AjBool		RETURN	ajTrue on success

Input

Input & Output

Returns

Description

Replaces string at pos and add len characters from string str. Or to the end of the existing string

See Also

Availability

Section: cutting

Functions: ajStrCutBraces ajStrCutComments ajStrCutCommentsRestpos ajStrCutCommentsStart ajStrCutEnd ajStrCutRange ajStrCutStart ajStrKeepRange ajStrKeepSetC ajStrKeepSetS ajStrKeepSetAlpha ajStrKeepSetAlphaC ajStrKeepSetAlphaS ajStrKeepSetAlphaRest ajStrKeepSetAlphaRestC ajStrKeepSetAlphaRestS ajStrKeepSetAscii ajStrQuoteStrip ajStrQuoteStripAll ajStrRemoveDupchar ajStrRemoveGap ajStrRemoveGapF ajStrRemoveHtml ajStrRemoveLastNewline ajStrRemoveSetC ajStrRemoveWhite ajStrRemoveWhiteExcess ajStrRemoveWhiteSpaces ajStrRemoveWild ajStrTrimC ajStrTrimEndC ajStrTrimStartC ajStrTrimWhite ajStrTrimWhiteEnd ajStrTrimWhiteStart ajStrTruncateLen ajStrTruncatePos

Function ajStrCutBraces

A comment is enclosed in curly braces at the end of a string.

Synopsis

Prototype

AjBool ajStrCutBraces (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Line of text from input file
AjBool		RETURN	ajTrue if there is some text remaining

Input & Output

Returns

Description

A comment is enclosed in curly braces at the end of a string.

See Also

Availability

Function ajStrCutComments

A comment begins with a "#" character and may appear anywhere in the string. See ajStrCutCommentsStart for alternative definition of a comment.

Synopsis

Prototype

AjBool ajStrCutComments (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Line of text from input file
AjBool		RETURN	ajTrue if there is some text remaining

Input & Output

Returns

Description

A comment begins with a "#" character and may appear anywhere in the string. See ajStrCutCommentsStart for alternative definition of a comment.

See Also

Availability

Function ajStrCutCommentsRestpos

A comment begins with a "#" character and may appear anywhere in the string. See ajStrCutCommentsStart for alternative definition of a comment.

Synopsis

Prototype

AjBool ajStrCutCommentsRestpos (
      AjPStr* Pstr,
      AjPStr* Pcomment,
      size_t* Pstartpos
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Line of text from input file
AjPStr*	Pcomment	Output	Comment characters deleted
size_t*	Pstartpos	Output	Comment start position
AjBool		RETURN	ajTrue if there is some text remaining

Output

Input & Output

Returns

Description

A comment begins with a "#" character and may appear anywhere in the string. See ajStrCutCommentsStart for alternative definition of a comment.

See Also

Availability

Function ajStrCutCommentsStart

A comment is a blank line or any text starting with a "#" character.

Synopsis

Prototype

AjBool ajStrCutCommentsStart (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Line of text from input file
AjBool		RETURN	ajTrue if there is some text remaining

Input & Output

Returns

Description

A comment is a blank line or any text starting with a "#" character.

See Also

Availability

Function ajStrCutEnd

Synopsis

Prototype

AjBool ajStrCutEnd (
      AjPStr* Pstr,
      size_t len
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
size_t	len	Input	Number of characters to delete from the end
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrCutRange

Synopsis

Prototype

AjBool ajStrCutRange (
      AjPStr* Pstr,
      ajlong pos1,
      ajlong pos2
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
ajlong	pos1	Input	start position to be cut
ajlong	pos2	Input	end position to be cut
AjBool		RETURN	ajTrue on success, ajFalse if begin is out of range

Input

Output

Returns

Description

See Also

Availability

Function ajStrCutStart

Synopsis

Prototype

AjBool ajStrCutStart (
      AjPStr* Pstr,
      size_t len
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
size_t	len	Input	Number of characters to delete from the start
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrKeepRange

The end is allowed to be before begin, in which case the output is an empty string.

Synopsis

Prototype

AjBool ajStrKeepRange (
      AjPStr* Pstr,
      ajlong pos1,
      ajlong pos2
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string.
ajlong	pos1	Input	Start position for substring.
ajlong	pos2	Input	End position for substring.
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

The end is allowed to be before begin, in which case the output is an empty string.

See Also

Availability

Function ajStrKeepSetC

Synopsis

Prototype

AjBool ajStrKeepSetC (
      AjPStr* Pstr,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
const char*	txt	Input	Character set to keep
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrKeepSetS

Synopsis

Prototype

AjBool ajStrKeepSetS (
      AjPStr* Pstr,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
const AjPStr	str	Input	Character set to keep
AjBool		RETURN	ajTrue if string is not empty

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrKeepSetAlpha

Synopsis

Prototype

AjBool ajStrKeepSetAlpha (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
AjBool		RETURN	ajTrue if string is not empty

Input & Output

Returns

Description

See Also

Availability

Function ajStrKeepSetAlphaC

Synopsis

Prototype

AjBool ajStrKeepSetAlphaC (
      AjPStr* Pstr,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
const char*	txt	Input	Non-alphabetic character set to keep
AjBool		RETURN	ajTrue if string is not empty

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrKeepSetAlphaS

Synopsis

Prototype

AjBool ajStrKeepSetAlphaS (
      AjPStr* Pstr,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
const AjPStr	str	Input	Non-alphabetic character set to keep
AjBool		RETURN	ajTrue if string is not empty

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrKeepSetAlphaRest

Also returns any non-whitespace characters in the strings

Synopsis

Prototype

AjBool ajStrKeepSetAlphaRest (
      AjPStr* Pstr,
      AjPStr* Prest
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
AjPStr*	Prest	Modify	Excluded non-whitespace characters.
AjBool		RETURN	ajTrue if string is not empty

Input & Output

Returns

Description

Also returns any non-whitespace characters in the strings

See Also

Availability

Function ajStrKeepSetAlphaRestC

Also returns any non-whitespace characters in the strings

Synopsis

Prototype

AjBool ajStrKeepSetAlphaRestC (
      AjPStr* Pstr,
      const char* txt,
      AjPStr* Prest
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
const char*	txt	Input	Non-alphabetic character set to keep
AjPStr*	Prest	Modify	Excluded non-whitespace characters.
AjBool		RETURN	ajTrue if string is not empty

Input

Input & Output

Returns

Description

Also returns any non-whitespace characters in the strings

See Also

Availability

Function ajStrKeepSetAlphaRestS

Also returns any non-whitespace characters in the strings

Synopsis

Prototype

AjBool ajStrKeepSetAlphaRestS (
      AjPStr* Pstr,
      const AjPStr str,
      AjPStr* Prest
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
const AjPStr	str	Input	Non-alphabetic character set to keep
AjPStr*	Prest	Modify	Excluded non-whitespace characters.
AjBool		RETURN	ajTrue if string is not empty

Input

Input & Output

Returns

Description

Also returns any non-whitespace characters in the strings

See Also

Availability

Function ajStrKeepSetAscii

Synopsis

Prototype

AjBool ajStrKeepSetAscii (
      AjPStr* Pstr,
      int minchar,
      int maxchar
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
int	minchar	Input	Lowest ASCII code to keep
int	maxchar	Input	Highest ASCII code to keep
AjBool		RETURN	ajTrue if string is not empty

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrQuoteStrip

Internal escaped or double quotes are converted to single quotes.

Synopsis

Prototype

AjBool ajStrQuoteStrip (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
AjBool		RETURN	ajTrue if string is not empty

Input & Output

Returns

Description

Internal escaped or double quotes are converted to single quotes.

See Also

Availability

Function ajStrQuoteStripAll

Internal escaped or doubled-up quotes are converted to single quotes.

Synopsis

Prototype

AjBool ajStrQuoteStripAll (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
AjBool		RETURN	True on success

Input & Output

Returns

Description

Internal escaped or doubled-up quotes are converted to single quotes.

See Also

Availability

Function ajStrRemoveDupchar

Synopsis

Prototype

AjBool ajStrRemoveDupchar (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
AjBool		RETURN	True if string is not empty

Output

Returns

Description

See Also

Availability

Function ajStrRemoveGap

Synopsis

Prototype

AjBool ajStrRemoveGap (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
AjBool		RETURN	True if string is not empty

Output

Returns

Description

See Also

Availability

Function ajStrRemoveGapF

Synopsis

Prototype

AjBool ajStrRemoveGapF (
      AjPStr* Pstr,
      float* Pfloat
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
float*	Pfloat	Output	Floating point array (e.g. quality scores)
AjBool		RETURN	True if string is not empty

Output

Returns

Description

See Also

Availability

Function ajStrRemoveHtml

html is defined as all substrings between and including angle brackets.

Synopsis

Prototype

AjBool ajStrRemoveHtml (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
AjBool		RETURN	ajTrue on success

Output

Returns

Description

html is defined as all substrings between and including angle brackets.

See Also

Availability

Function ajStrRemoveLastNewline

Synopsis

Prototype

AjBool ajStrRemoveLastNewline (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
AjBool		RETURN	True is string is not empty

Output

Returns

Description

See Also

Availability

Function ajStrRemoveSetC

Synopsis

Prototype

AjBool ajStrRemoveSetC (
      AjPStr* Pstr,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
const char*	txt	Input	characters to remove
AjBool		RETURN	True on success

Input

Output

Returns

Description

See Also

Availability

Function ajStrRemoveWhite

Synopsis

Prototype

AjBool ajStrRemoveWhite (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
AjBool		RETURN	ajTrue if string was reallocated

Input & Output

Returns

Description

See Also

Availability

Function ajStrRemoveWhiteExcess

Leading/trailing whitespace removed. Multiple spaces replaced by single spaces.

Synopsis

Prototype

AjBool ajStrRemoveWhiteExcess (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
AjBool		RETURN	ajTrue if string was reallocated

Input & Output

Returns

Description

Leading/trailing whitespace removed. Multiple spaces replaced by single spaces.

See Also

Availability

Function ajStrRemoveWhiteSpaces

Leading/trailing whitespace removed. Multiple spaces replaced by single spaces. Tabs converted to spaces. Newlines left unchanged

Synopsis

Prototype

AjBool ajStrRemoveWhiteSpaces (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String to clean.
AjBool		RETURN	ajTrue if string was reallocated

Input & Output

Returns

Description

Leading/trailing whitespace removed. Multiple spaces replaced by single spaces. Tabs converted to spaces. Newlines left unchanged

See Also

Availability

Function ajStrRemoveWild

Synopsis

Prototype

AjBool ajStrRemoveWild (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String
AjBool		RETURN	ajTrue if the string contained a wildcard and was truncated.

Input & Output

Returns

Description

See Also

Availability

Function ajStrTrimC

Synopsis

Prototype

AjBool ajStrTrimC (
      AjPStr* Pstr,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
const char*	txt	Input	Characters to delete from each end
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrTrimEndC

Synopsis

Prototype

AjBool ajStrTrimEndC (
      AjPStr* Pstr,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
const char*	txt	Input	Characters to delete from the end
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrTrimStartC

Synopsis

Prototype

AjBool ajStrTrimStartC (
      AjPStr* Pstr,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
const char*	txt	Input	Characters to delete from the end
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrTrimWhite

Synopsis

Prototype

AjBool ajStrTrimWhite (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String
AjBool		RETURN	ajTrue if string was reallocated

Input & Output

Returns

Description

See Also

Availability

Function ajStrTrimWhiteEnd

Synopsis

Prototype

AjBool ajStrTrimWhiteEnd (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String
AjBool		RETURN	ajTrue if string was reallocated

Input & Output

Returns

Description

See Also

Availability

Function ajStrTrimWhiteStart

Synopsis

Prototype

AjBool ajStrTrimWhiteStart (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String
AjBool		RETURN	ajTrue if string was reallocated

Input & Output

Returns

Description

See Also

Availability

Function ajStrTruncateLen

Synopsis

Prototype

AjBool ajStrTruncateLen (
      AjPStr* Pstr,
      size_t len
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
size_t	len	Input	Length of required string.
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrTruncatePos

Synopsis

Prototype

AjBool ajStrTruncatePos (
      AjPStr* Pstr,
      ajlong pos
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	target string
ajlong	pos	Input	First position to be deleted. Negative values count from the end
AjBool		RETURN	True is string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Section: substitution

Functions: ajStrExchangeCC ajStrExchangeCS ajStrExchangeKK ajStrExchangeSC ajStrExchangeSS ajStrExchangePosCC ajStrExchangeSetCC ajStrExchangeSetSS ajStrExchangeSetRestCK ajStrExchangeSetRestSK ajStrRandom ajStrReverse

Function ajStrExchangeCC

Synopsis

Prototype

AjBool ajStrExchangeCC (
      AjPStr* Pstr,
      const char* txt,
      const char* txtnew
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string.
const char*	txt	Input	string to replace.
const char*	txtnew	Input	string to insert.
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrExchangeCS

Synopsis

Prototype

AjBool ajStrExchangeCS (
      AjPStr* Pstr,
      const char* txt,
      const AjPStr strnew
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string.
const char*	txt	Input	string to replace.
const AjPStr	strnew	Input	string to insert.
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrExchangeKK

Synopsis

Prototype

AjBool ajStrExchangeKK (
      AjPStr* Pstr,
      char chr,
      char chrnew
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string.
char	chr	Input	Character to replace.
char	chrnew	Input	Character to insert.
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrExchangeSC

Synopsis

Prototype

AjBool ajStrExchangeSC (
      AjPStr* Pstr,
      const AjPStr str,
      const char* txtnew
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string.
const AjPStr	str	Input	string to replace.
const char*	txtnew	Input	string to insert.
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrExchangeSS

Synopsis

Prototype

AjBool ajStrExchangeSS (
      AjPStr* Pstr,
      const AjPStr str,
      const AjPStr strnew
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string.
const AjPStr	str	Input	string to replace.
const AjPStr	strnew	Input	string to insert.
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrExchangePosCC

Synopsis

Prototype

AjBool ajStrExchangePosCC (
      AjPStr* Pstr,
      ajlong ipos,
      const char* txt,
      const char* txtnew
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string.
ajlong	ipos	Input	Position in the string, negative values are from the end of the string.
const char*	txt	Input	string to replace.
const char*	txtnew	Input	string to insert.
AjBool		RETURN	ajTrue if string was reallocated

Input

Input & Output

Returns

Description

See Also

Availability

Function ajStrExchangeSetCC

Synopsis

Prototype

AjBool ajStrExchangeSetCC (
      AjPStr* Pstr,
      const char* txt,
      const char* txtnew
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
const char*	txt	Input	Unwanted characters
const char*	txtnew	Input	Replacement characters
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrExchangeSetSS

Synopsis

Prototype

AjBool ajStrExchangeSetSS (
      AjPStr* Pstr,
      const AjPStr str,
      const AjPStr strnew
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
const AjPStr	str	Input	Unwanted characters
const AjPStr	strnew	Input	Replacement characters
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrExchangeSetRestCK

Synopsis

Prototype

AjBool ajStrExchangeSetRestCK (
      AjPStr* Pstr,
      const char* txt,
      char chrnew
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
const char*	txt	Input	Wanted characters
char	chrnew	Input	Replacement character
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrExchangeSetRestSK

Synopsis

Prototype

AjBool ajStrExchangeSetRestSK (
      AjPStr* Pstr,
      const AjPStr str,
      char chrnew
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
const AjPStr	str	Input	Wanted characters
char	chrnew	Input	Replacement character
AjBool		RETURN	ajTrue if string was reallocated

Input

Output

Returns

Description

See Also

Availability

Function ajStrRandom

The application code must first call ajRandomSeed().

Synopsis

Prototype

AjBool ajStrRandom (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
AjBool		RETURN	True unless string is empty

Input & Output

Returns

Description

The application code must first call ajRandomSeed().

See Also

Availability

Function ajStrReverse

Synopsis

Prototype

AjBool ajStrReverse (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
AjBool		RETURN	ajTrue if string was reallocated

Output

Returns

Description

See Also

Availability

Section: query

Functions: ajStrCalcCountC ajStrCalcCountK ajStrHasParentheses ajStrIsAlnum ajStrIsAlpha ajStrIsBool ajStrIsCharsetC ajStrIsCharsetS ajStrIsCharsetCaseC ajStrIsCharsetCaseS ajStrIsDouble ajStrIsFloat ajStrIsHex ajStrIsInt ajStrIsLong ajStrIsLower ajStrIsNum ajStrIsUpper ajStrIsWhite ajStrIsWild ajStrIsWord ajStrWhole

Function ajStrCalcCountC

Synopsis

Prototype

ajulong ajStrCalcCountC (
      const AjPStr str,
      const char* txt
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
const char*	txt	Input	Characters to count
ajulong		RETURN	Number of times characters were found in string

Input

Returns

Description

See Also

Availability

Function ajStrCalcCountK

Synopsis

Prototype

ajulong ajStrCalcCountK (
      const AjPStr str,
      char chr
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
char	chr	Input	Character to count
ajulong		RETURN	Number of times character was found in string

Input

Returns

Description

See Also

Availability

Function ajStrHasParentheses

Pairs of parentheses are difficult to test for with regular expressions.

Synopsis

Prototype

AjBool ajStrHasParentheses (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String to test
AjBool		RETURN	ajTrue if string has zero or more () pairs with possibly other text

Input

Returns

Description

Pairs of parentheses are difficult to test for with regular expressions.

See Also

Availability

Function ajStrIsAlnum

The test is defined by isalnum in the C RTL plus underscores.

Synopsis

Prototype

AjBool ajStrIsAlnum (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if the string is entirely alphanumeric

Input

Returns

Description

The test is defined by isalnum in the C RTL plus underscores.

See Also

Availability

Function ajStrIsAlpha

Test is defined by isalpha in the C RTL.

Synopsis

Prototype

AjBool ajStrIsAlpha (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if the string is entirely alphabetic

Input

Returns

Description

Test is defined by isalpha in the C RTL.

See Also

Availability

Function ajStrIsBool

The string must be a single character boolean value, or one of "yes, "no", "true" or "false".

Synopsis

Prototype

AjBool ajStrIsBool (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if the string is acceptable as a boolean.

Input

Returns

Description

The string must be a single character boolean value, or one of "yes, "no", "true" or "false".

See Also

Availability

Function ajStrIsCharsetC

Synopsis

Prototype

AjBool ajStrIsCharsetC (
      const AjPStr str,
      const char* txt
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
const char*	txt	Input	Character set to test
AjBool		RETURN	ajTrue if the string is entirely composed of characters in the specified set

Input

Returns

Description

See Also

Availability

Function ajStrIsCharsetS

Synopsis

Prototype

AjBool ajStrIsCharsetS (
      const AjPStr str,
      const AjPStr str2
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
const AjPStr	str2	Input	Character set to test
AjBool		RETURN	ajTrue if the string is entirely composed of characters in the specified set

Input

Returns

Description

See Also

Availability

Function ajStrIsCharsetCaseC

Synopsis

Prototype

AjBool ajStrIsCharsetCaseC (
      const AjPStr str,
      const char* txt
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
const char*	txt	Input	Character set to test
AjBool		RETURN	ajTrue if the string is entirely composed of characters in the specified set

Input

Returns

Description

See Also

Availability

Function ajStrIsCharsetCaseS

Synopsis

Prototype

AjBool ajStrIsCharsetCaseS (
      const AjPStr str,
      const AjPStr str2
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
const AjPStr	str2	Input	Character set to test
AjBool		RETURN	ajTrue if the string is entirely composed of characters in the specified set

Input

Returns

Description

See Also

Availability

Function ajStrIsDouble

Test uses the strtod call in the C RTL.

Synopsis

Prototype

AjBool ajStrIsDouble (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if the string is acceptable as a double precision number.

Input

Returns

Description

Test uses the strtod call in the C RTL.

See Also

Availability

Function ajStrIsFloat

Test uses the strtod call in the C RTL.

Synopsis

Prototype

AjBool ajStrIsFloat (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if the string is acceptable as a floating point number.

Input

Returns

Description

Test uses the strtod call in the C RTL.

See Also

Availability

Function ajStrIsHex

Test uses the strtol call in the C RTL.

Synopsis

Prototype

AjBool ajStrIsHex (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if the string is acceptable as a hexadecimal value.

Input

Returns

Description

Test uses the strtol call in the C RTL.

See Also