ajstr.c

Datatypes:

char*	C character string
AjPStr	String
const AjPStr	String constant
AjIStr	String iterator
AjPStrTok	String token parser

Datatype: char*

Sections:

constructors	Constructors
destructors	Destructors
formatting	Modifiers
comparison	General use
comparison (sorting)	General use
parsing functions	General use

char*: constructors

Functions:

ajCharNewC	A text string constructor which allocates memory for a string and initialises it with the text string provided.
ajCharNewS	A text string constructor which allocates memory for a string and initialises it with the string provided.
ajCharNewRes	A text string constructor which allocates memory for a string of the specified length and initialises the contents as an empty string.
ajCharNewResC	A text string constructor which allocates memory for a string of the specified length and initialises it with the text string provided.
ajCharNewResS	A text string constructor which allocates memory for a string of the specified length and initialises it with the string provided.
ajCharNewResLenC	A text string constructor which allocates memory for a string of the specified length and initialises it with the text string provided.
ajCharNull	Returns a pointer to an empty string

Function ajCharNewC

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.

From EMBOSS 1.0.0

Function ajCharNewS

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.

From EMBOSS 4.0.0

Function ajCharNewRes

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.

From EMBOSS 4.0.0

Function ajCharNewResC

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.

From EMBOSS 4.0.0

Function ajCharNewResS

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.

From EMBOSS 4.0.0

Function ajCharNewResLenC

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.

From EMBOSS 4.0.0

Function ajCharNull

Prototype

char* ajCharNull (
      void
);

Type	Name	Read/Write	Description
char*		RETURN	Empty string

From EMBOSS 6.0.0

char*: destructors

Functions:

ajCharDel

A text string destructor to free memory for a text string.

Function ajCharDel

Prototype

void ajCharDel (
      char** Ptxt
);

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

From EMBOSS 4.0.0

char*: formatting

Functions:

ajCharFmtLower	Converts a text string to lower case.
ajCharFmtUpper	Converts a text string to upper case.

Function ajCharFmtLower

Prototype

AjBool ajCharFmtLower (
      char* txt
);

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

From EMBOSS 4.0.0

Function ajCharFmtUpper

Prototype

AjBool ajCharFmtUpper (
      char* txt
);

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

From EMBOSS 4.0.0

char*: comparison

Functions:

ajCharMatchC	Simple test for matching two text strings.
ajCharMatchCaseC	Simple case-insensitive test for matching two text strings.
ajCharMatchWildC	Simple case-sensitive test for matching two text strings using wildcard characters.
ajCharMatchWildS	Simple case-sensitive test for matching a text string and a string using wildcard characters.
ajCharMatchWildCaseC	Simple case-insensitive test for matching two text strings using wildcard characters.
ajCharMatchWildCaseS	Simple case-insensitive test for matching a text string and a string using wildcard characters.
ajCharMatchWildNextC	Test for matching the next 'word' in two text strings using wildcard characters.
ajCharMatchWildNextCaseC	Test for matching the next 'word' in two text strings using wildcard characters, case-insensitive.
ajCharMatchWildWordC	Case-sensitive test for matching a text string 'word' against any word in a test text string using wildcard characters.
ajCharMatchWildWordCaseC	Case-insensitive test for matching a text string 'word' against any word in a text string using wildcard characters.
ajCharPrefixC	Test for matching the start of a text string against a given prefix text string.
ajCharPrefixS	Test for matching the start of a text string against a given prefix string.
ajCharPrefixCaseC	Case-insensitive test for matching the start of a text string against a given prefix text string.
ajCharPrefixCaseS	Case-insensitive test for matching start of a text string against a given prefix string,
ajCharSuffixC	Test for matching the end of a text string against a given suffix text string.
ajCharSuffixS	Test for matching the end of a text string against a given suffix string.
ajCharSuffixCaseC	Case-insensitive test for matching the end of a text string against a given suffix text string.
ajCharSuffixCaseS	Case-insensitive test for matching the end of a text string against a given suffix string.

Function ajCharMatchC

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

From EMBOSS 4.0.0

Function ajCharMatchCaseC

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

From EMBOSS 4.0.0

Function ajCharMatchWildC

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

From EMBOSS 4.0.0

Function ajCharMatchWildS

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

From EMBOSS 4.0.0

Function ajCharMatchWildCaseC

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

From EMBOSS 4.1.0

Function ajCharMatchWildCaseS

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

From EMBOSS 4.1.0

Function ajCharMatchWildNextC

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

From EMBOSS 4.0.0

Function ajCharMatchWildNextCaseC

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

From EMBOSS 4.1.0

Function ajCharMatchWildWordC

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

From EMBOSS 4.0.0

Function ajCharMatchWildWordCaseC

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

From EMBOSS 4.1.0

Function ajCharPrefixC

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

From EMBOSS 4.0.0

Function ajCharPrefixS

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

From EMBOSS 4.0.0

Function ajCharPrefixCaseC

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

From EMBOSS 4.0.0

Function ajCharPrefixCaseS

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

From EMBOSS 4.0.0

Function ajCharSuffixC

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

From EMBOSS 4.0.0

Function ajCharSuffixS

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

From EMBOSS 4.0.0

Function ajCharSuffixCaseC

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

From EMBOSS 4.0.0

Function ajCharSuffixCaseS

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

From EMBOSS 4.0.0

char*: comparison (sorting)

Functions:

ajCharCmpCase	Finds the sort order of two text strings.
ajCharCmpCaseLen	Finds the sort order of substrings from the start of two text strings.
ajCharCmpWild	Finds the sort-order (case insensitive) of two text strings using wildcard characters.
ajCharCmpWildCase	Finds the sort-order (case sensitive) of two text strings using wildcard characters.

Function ajCharCmpCase

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.

From EMBOSS 4.0.0

Function ajCharCmpCaseLen

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.

From EMBOSS 4.0.0

Function ajCharCmpWild

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.

From EMBOSS 4.0.0

Function ajCharCmpWildCase

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.

From EMBOSS 4.1.0

char*: parsing functions

Functions:

ajCharParseC

Simple token parsing from text string using a specified set of delimiters.

Function ajCharParseC

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

From EMBOSS 4.0.0

Datatype: AjPStr

Sections:

constructors	Constructors
destructors	Destructors
assignment	Assignments
combination functions	Modifiers
cutting	Modifiers
substitution	Modifiers
query	General use
element retrieval	General use
modifiable string retrieval	Modifiers
element assignment	Modifiers
string to datatype conversion functions	Casts
datatype to string conversion functions	Derievd values
formatting	Modifiers
comparison	General use
comparison (sorting)	General use
comparison (search) functions	General use
parsing functions	General use
debugging	Miscellaneous
exit	Miscellaneous

AjPStr: constructors

Functions:

ajStrNew	Default string constructor which allocates memory for a string.
ajStrNewC	String constructor which allocates memory for a string and initialises it with the text string provided.
ajStrNewK	String constructor which allocates memory for a string and initialises it with the single character provided.
ajStrNewS	String constructor which allocates memory for a string and initialises it with the string provided.
ajStrNewRef	String referencing function which returns a pointer to the string passed in and increases its reference count.
ajStrNewRes	String constructor which allocates memory for a string of an initial reserved size (including a possible null).
ajStrNewResC	String constructor which allocates memory for a string of an initial reserved size (including a possible null) and initialises it with the text string provided.
ajStrNewResS	String constructor which allocates memory for a string of an initial reserved size (including a possible null) and initialises it with the string provided.
ajStrNewResLenC	String constructor which allocates memory for a string of a given length and of an initial reserved size (including a possible null) and initialises it with the text string provided.

Function ajStrNew

Prototype

AjPStr ajStrNew (
      void
);

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

From EMBOSS 1.0.0

Function ajStrNewC

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

From EMBOSS 1.0.0

Function ajStrNewK

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

From EMBOSS 6.2.0

Function ajStrNewS

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.

From EMBOSS 1.0.0

Function ajStrNewRef

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.

From EMBOSS 4.0.0

Function ajStrNewRes

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.

From EMBOSS 4.0.0

Function ajStrNewResC

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.

From EMBOSS 4.0.0

Function ajStrNewResS

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.

From EMBOSS 4.0.0

Function ajStrNewResLenC

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.

From EMBOSS 4.0.0

AjPStr: destructors

Functions:

MAJSTRDEL
ajStrDel	Default string destructor which frees memory for a string.
ajStrDelStatic	String dereferencing function which sets a string pointer to NULL and decrements the use count of the string to which it referred. Strings with a use count of 1 are *not* freed to avoid freeing and reallocating memory when they are reused.
ajStrDelarray	Default string destructor which frees memory for an array of strings.

Macro MAJSTRDEL

Function ajStrDel

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

From EMBOSS 1.0.0

Function ajStrDelStatic

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.

From EMBOSS 4.0.0

Function ajStrDelarray

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

From EMBOSS 4.0.0

AjPStr: assignment

Functions:

ajStrAssignC	Copy a text string to a string.
ajStrAssignK	Copy a single character to a string.
ajStrAssignS	Copy a string to a string.
ajStrAssignClear	Clear the string value
ajStrAssignEmptyC	Ensures a string is set (has a value). If the string is set it is left alone, otherwise it is initialised with a text string.
ajStrAssignEmptyS	Ensures a string is set (has a value). If the string is set it is left alone, otherwise it is initialised with a string.
ajStrAssignLenC	Copy a text string of a given length to a string.
ajStrAssignRef	String referencing function which makes a string point to another. Increases the reference count of the string pointed to.
ajStrAssignResC	Copy a text string to a string with a minimum reserved size.
ajStrAssignResS	Copy a string to a string with a minimum reserved size.
ajStrAssignSubC	Copies a substring of a text string to a string.
ajStrAssignSubS	Copies a substring of a string to a string.

Function ajStrAssignC

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

From EMBOSS 4.0.0

Function ajStrAssignK

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

From EMBOSS 4.0.0

Function ajStrAssignS

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

From EMBOSS 4.0.0

Function ajStrAssignClear

Prototype

AjBool ajStrAssignClear (
      AjPStr* Pstr
);

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

From EMBOSS 6.0.0

Function ajStrAssignEmptyC

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

From EMBOSS 4.0.0

Function ajStrAssignEmptyS

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

From EMBOSS 4.0.0

Function ajStrAssignLenC

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

From EMBOSS 4.0.0

Function ajStrAssignRef

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

From EMBOSS 4.0.0

Function ajStrAssignResC

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

From EMBOSS 4.0.0

Function ajStrAssignResS

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

From EMBOSS 4.0.0

Function ajStrAssignSubC

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

From EMBOSS 4.0.0

Function ajStrAssignSubS

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

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 From EMBOSS 1.0.0

AjPStr: combination functions

Functions:

ajStrAppendC	Appends a text string to the end of a string.
ajStrAppendK	Appends a character to the end of a string.
ajStrAppendS	Appends a string to the end of another string.
ajStrAppendCountK	Appends any number of a given character to the end of a string.
ajStrAppendLenC	Appends a text string of a given length to the end of a string.
ajStrAppendSubC	Appends a substring of a string to the end of another string.
ajStrAppendSubS	Appends a substring of a string to the end of another string.
ajStrInsertC	Insert a text string into a string at a specified position.
ajStrInsertK	Inserts a character into a string at a specified position.
ajStrInsertS	Inserts a text string into a string at a specified position.
ajStrJoinC	Cut down string at pos1 and add string2 from position pos2.
ajStrJoinS	Appends one string to another after cutting both strings.
ajStrMaskIdent	Masks out characters from a string that are identical to a second string.
ajStrMaskRange	Masks out characters from a string over a specified range.
ajStrPasteS	Overwrite one string with another.
ajStrPasteCountK	Overwrites a string with a number of single characters.
ajStrPasteMaxC	Overwrite one string with a specified number of characters from a text string.
ajStrPasteMaxS	Overwrite one string with a specified number of characters from another string.

Function ajStrAppendC

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

From EMBOSS 4.0.0

Function ajStrAppendK

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

From EMBOSS 4.0.0

Function ajStrAppendS

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

From EMBOSS 4.0.0

Function ajStrAppendCountK

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

From EMBOSS 4.0.0

Function ajStrAppendLenC

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

From EMBOSS 4.0.0

Function ajStrAppendSubC

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

From EMBOSS 6.0.0

Function ajStrAppendSubS

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

From EMBOSS 4.0.0

Function ajStrInsertC

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

From EMBOSS 1.0.0

Function ajStrInsertK

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

From EMBOSS 2.9.0

Function ajStrInsertS

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;

From EMBOSS 4.0.0

Function ajStrJoinC

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

From EMBOSS 1.0.0

Function ajStrJoinS

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.

From EMBOSS 4.0.0

Function ajStrMaskIdent

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

From EMBOSS 6.1.0

Function ajStrMaskRange

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

From EMBOSS 6.1.0

Function ajStrPasteS

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

From EMBOSS 4.0.0

Function ajStrPasteCountK

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

From EMBOSS 4.0.0

Function ajStrPasteMaxC

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

From EMBOSS 4.0.0

Function ajStrPasteMaxS

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

From EMBOSS 4.0.0

AjPStr: cutting

Functions:

ajStrCutBraces	Removes comments enclosed in braces from a string.
ajStrCutComments	Removes comments from a string.
ajStrCutCommentsRestpos	Removes comments from a string.
ajStrCutCommentsStart	Removes comments from a string.
ajStrCutEnd	Removes a number of characters from the end of a string
ajStrCutRange	Removes a substring from a string.
ajStrCutStart	Removes a number of characters from the start of a string
ajStrKeepRange	Reduces target string to a substring of itself by deleting all except a range of character positions.
ajStrKeepSetC	Removes all characters from a string that are not in a given set.
ajStrKeepSetS	Removes all characters from a string that are not in a given set.
ajStrKeepSetAlpha	Removes all characters from a string that are not alphabetic.
ajStrKeepSetAlphaC	Removes all characters from a string that are not alphabetic and are not in a given set.
ajStrKeepSetAlphaS	Removes all characters from a string that are not alphabetic and are not in a given set.
ajStrKeepSetAlphaRest	Removes all characters from a string that are not alphabetic.
ajStrKeepSetAlphaRestC	Removes all characters from a string that are not alphabetic and are not in a given set.
ajStrKeepSetAlphaRestS	Removes all characters from a string that are not alphabetic and are not in a given set.
ajStrKeepSetAscii	Removes all characters from a string that are not within a range of ASCII character codes.
ajStrQuoteStrip	Removes any double quotes from a string.
ajStrQuoteStripAll	Removes any single or double quotes from a string.
ajStrRemoveDupchar	Removes duplicate characters from a string
ajStrRemoveGap	Removes non-sequence characters (all but alphabetic characters and asterisk) from a string.
ajStrRemoveGapF	Removes non-sequence characters (all but alphabetic characters and asterisk) from a string. Also removes floats from an array of the same size
ajStrRemoveHtml	Removes html from a string.
ajStrRemoveLastNewline	Removes last character from a string if it is a newline character.
ajStrRemoveSetC	Removes all of a given set of characters from a string.
ajStrRemoveWhite	Removes all whitespace characters from a string.
ajStrRemoveWhiteExcess	Removes excess whitespace characters from a string.
ajStrRemoveWhiteSpaces	Removes excess space characters from a string.
ajStrRemoveWild	Removes all characters after the first wildcard character (if found).
ajStrTrimC	Removes regions with a given character composition from start and end of a string.
ajStrTrimEndC	Removes a region with a given character composition from end of a string.
ajStrTrimStartC	Removes a region with a given character composition from start of a string.
ajStrTrimWhite	Removes regions composed of white space characters only from the start and end of a string.
ajStrTrimWhiteEnd	Removes regions composed of white space characters only from the end of a string.
ajStrTrimWhiteStart	Removes regions composed of white space characters only from the start of a string.
ajStrTruncateLen	Removes the end from a string reducing it to a defined length.
ajStrTruncatePos	Removes the end from a string by cutting at a defined position.

Function ajStrCutBraces

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

From EMBOSS 6.4.0

Function ajStrCutComments

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

From EMBOSS 4.0.0

Function ajStrCutCommentsRestpos

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

From EMBOSS 6.0.0

Function ajStrCutCommentsStart

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

From EMBOSS 4.0.0

Function ajStrCutEnd

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

From EMBOSS 4.0.0

Function ajStrCutRange

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

From EMBOSS 4.0.0

Function ajStrCutStart

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

From EMBOSS 4.0.0

Function ajStrKeepRange

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

From EMBOSS 4.0.0

Function ajStrKeepSetC

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

From EMBOSS 4.0.0

Function ajStrKeepSetS

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

From EMBOSS 4.1.0

Function ajStrKeepSetAlpha

Prototype

AjBool ajStrKeepSetAlpha (
      AjPStr* Pstr
);

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

From EMBOSS 4.1.0

Function ajStrKeepSetAlphaC

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

From EMBOSS 4.0.0

Function ajStrKeepSetAlphaS

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

From EMBOSS 5.0.0

Function ajStrKeepSetAlphaRest

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

From EMBOSS 5.0.0

Function ajStrKeepSetAlphaRestC

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

From EMBOSS 5.0.0

Function ajStrKeepSetAlphaRestS

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

From EMBOSS 5.0.0

Function ajStrKeepSetAscii

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

From EMBOSS 6.1.0

Function ajStrQuoteStrip

Prototype

AjBool ajStrQuoteStrip (
      AjPStr* Pstr
);

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

From EMBOSS 2.0.1

Function ajStrQuoteStripAll

Prototype

AjBool ajStrQuoteStripAll (
      AjPStr* Pstr
);

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

From EMBOSS 3.0.0

Function ajStrRemoveDupchar

Prototype

AjBool ajStrRemoveDupchar (
      AjPStr* Pstr
);

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

From EMBOSS 6.2.0

Function ajStrRemoveGap

Prototype

AjBool ajStrRemoveGap (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

Function ajStrRemoveGapF

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

From EMBOSS 6.2.0

Function ajStrRemoveHtml

Prototype

AjBool ajStrRemoveHtml (
      AjPStr* Pstr
);

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

From EMBOSS 1.9.0

Function ajStrRemoveLastNewline

Prototype

AjBool ajStrRemoveLastNewline (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

Function ajStrRemoveSetC

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

From EMBOSS 4.0.0

Function ajStrRemoveWhite

Prototype

AjBool ajStrRemoveWhite (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

Function ajStrRemoveWhiteExcess

Prototype

AjBool ajStrRemoveWhiteExcess (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

Function ajStrRemoveWhiteSpaces

Prototype

AjBool ajStrRemoveWhiteSpaces (
      AjPStr* Pstr
);

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

From EMBOSS 4.1.0

Function ajStrRemoveWild

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.

From EMBOSS 4.0.0

Function ajStrTrimC

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

From EMBOSS 1.0.0

Function ajStrTrimEndC

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

From EMBOSS 2.3.1

Function ajStrTrimStartC

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

From EMBOSS 3.0.0

Function ajStrTrimWhite

Prototype

AjBool ajStrTrimWhite (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

Function ajStrTrimWhiteEnd

Prototype

AjBool ajStrTrimWhiteEnd (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

Function ajStrTrimWhiteStart

Prototype

AjBool ajStrTrimWhiteStart (
      AjPStr* Pstr
);

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

From EMBOSS 6.2.0

Function ajStrTruncateLen

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

From EMBOSS 4.0.0

Function ajStrTruncatePos

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

From EMBOSS 4.0.0

AjPStr: substitution

Functions:

ajStrExchangeCC	Replace all occurrences in a string of one substring with another.
ajStrExchangeCS	Replace all occurrences in a string of one substring with another.
ajStrExchangeKK	Replace all occurrences in a string of one character with another.
ajStrExchangeSC	Replace all occurrences in a string of one substring with another.
ajStrExchangeSS	Replace all occurrences in a string of one substring with another.
ajStrExchangePosCC	Replace one substring with another at a given position in the text.
ajStrExchangeSetCC	Replace all occurrences in a string of one set of characters with another set.
ajStrExchangeSetSS	Replace all occurrences in a string of one set of characters with another set.
ajStrExchangeSetRestCK	Replace all occurrences in a string of one set of characters with a substitute character
ajStrExchangeSetRestSK	Replace all occurrences in a string not in one set of characters with a substitute character.
ajStrRandom	Randomly rearranges the characters in a string.
ajStrReverse	Reverses the order of characters in a string

Function ajStrExchangeCC

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

From EMBOSS 4.0.0

Function ajStrExchangeCS

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

From EMBOSS 4.0.0

Function ajStrExchangeKK

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

From EMBOSS 4.0.0

Function ajStrExchangeSC

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

From EMBOSS 4.0.0

Function ajStrExchangeSS

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

From EMBOSS 4.0.0

Function ajStrExchangePosCC

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

From EMBOSS 5.0.0

Function ajStrExchangeSetCC

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

From EMBOSS 4.0.0

Function ajStrExchangeSetSS

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

From EMBOSS 4.0.0

Function ajStrExchangeSetRestCK

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

From EMBOSS 4.1.0

Function ajStrExchangeSetRestSK

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

From EMBOSS 4.1.0

Function ajStrRandom

Prototype

AjBool ajStrRandom (
      AjPStr* Pstr
);

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

From EMBOSS 1.0.0

Function ajStrReverse

Prototype

AjBool ajStrReverse (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

AjPStr: query

Functions:

ajStrCalcCountC	Counts occurrences of set of characters in a string.
ajStrCalcCountK	Counts occurrences of a character in a string.
ajStrHasParentheses	Tests whether a string contains (possibly nested) pairs of parentheses.
ajStrIsAlnum	Test whether a string contains alphanumeric characters only (no white space).
ajStrIsAlpha	Test whether a string contains alphabetic characters only (no white space).
ajStrIsBool	Tests whether a string represents a valid Boolean value.
ajStrIsCharsetC	Test whether a string contains specified characters only.
ajStrIsCharsetS	Test whether a string contains specified characters only.
ajStrIsCharsetCaseC	Test whether a string contains specified characters only. The test is case-insensitive
ajStrIsCharsetCaseS	Test whether a string contains specified characters only. The test is case-insensitive
ajStrIsDouble	Tests whether a string represents a valid double precision value,
ajStrIsFloat	Tests whether a string represents a valid floating point value.
ajStrIsHex	Tests whether a string represents a valid hexadecimal value.
ajStrIsInt	Tests whether a string represents a valid integer value.
ajStrIsLong	Tests whether a string represents a valid ajlong integer value.
ajStrIsLower	Tests whether a string contains no upper case alphabetic characters.
ajStrIsNum	Test whether a string contains decimal digits only.
ajStrIsUpper	Test whether a string contains no lower case alphabetic characters.
ajStrIsWhite	Test whether a string contains whitespace characters only.
ajStrIsWild	Tests whether a string contains the standard wildcard characters * or ?.
ajStrIsWord	Test whether a string contains no white space characters.
ajStrWhole	Tests whether a range refers to the whole string

Function ajStrCalcCountC

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

From EMBOSS 4.0.0

Function ajStrCalcCountK

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

From EMBOSS 4.0.0

Function ajStrHasParentheses

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

From EMBOSS 4.0.0

Function ajStrIsAlnum

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

From EMBOSS 1.0.0

Function ajStrIsAlpha

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

From EMBOSS 1.0.0

Function ajStrIsBool

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.

From EMBOSS 1.0.0

Function ajStrIsCharsetC

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

From EMBOSS 4.1.0

Function ajStrIsCharsetS

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

From EMBOSS 4.1.0

Function ajStrIsCharsetCaseC

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

From EMBOSS 4.1.0

Function ajStrIsCharsetCaseS

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

From EMBOSS 4.1.0

Function ajStrIsDouble

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.

From EMBOSS 1.0.0

Function ajStrIsFloat

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.

From EMBOSS 1.0.0

Function ajStrIsHex

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.

From EMBOSS 1.13.0

Function ajStrIsInt

Prototype

AjBool ajStrIsInt (
      const AjPStr str
);

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

From EMBOSS 1.0.0

Function ajStrIsLong

Prototype

AjBool ajStrIsLong (
      const AjPStr str
);

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

From EMBOSS 1.0.0

Function ajStrIsLower

Prototype

AjBool ajStrIsLower (
      const AjPStr str
);

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

From EMBOSS 2.7.0

Function ajStrIsNum

Prototype

AjBool ajStrIsNum (
      const AjPStr str
);

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

From EMBOSS 3.0.0

Function ajStrIsUpper

Prototype

AjBool ajStrIsUpper (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if the string has no lower case characters.

From EMBOSS 2.7.0

Function ajStrIsWhite

Prototype

AjBool ajStrIsWhite (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if the string is only white space (or empty).

From EMBOSS 2.9.0

Function ajStrIsWild

Prototype

AjBool ajStrIsWild (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if string has wildcards.

From EMBOSS 1.0.0

Function ajStrIsWord

Prototype

AjBool ajStrIsWord (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if the string has no white space

From EMBOSS 1.0.0

Function ajStrWhole

Prototype

AjBool ajStrWhole (
      const AjPStr str,
      ajlong pos1,
      ajlong pos2
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
ajlong	pos1	Input	Begin position (0 start, negative from the end)
ajlong	pos2	Input	Begin position (0 start, negative from the end)
AjBool		RETURN	ajTrue is range covers the whole string

From EMBOSS 2.5.0

AjPStr: element retrieval

Functions:

ajStrGetAsciiCommon	Returns the most common ASCII character code in a string.
ajStrGetAsciiHigh	Returns the highest ASCII character code in a string.
ajStrGetAsciiLow	Returns the lowest ASCII character code in a string.
ajStrGetCharFirst	Returns the first character from a string.
ajStrGetCharLast	Returns the last character from a string.
ajStrGetCharPos	Returns a single character at a given position from a string.
ajStrGetLen	Returns the current length of the C (char *) string.
MAJSTRGETLEN
ajStrGetPtr	Returns the current pointer to C (char *) string.
MAJSTRGETPTR
ajStrGetRes	Returns the current reserved size of the C (char *) string.
MAJSTRGETRES
ajStrGetRoom	Returns the additional space available in a string before it would require reallocating.
ajStrGetUse	Returns the current usage count of the C (char *) string.
MAJSTRGETUSE
ajStrGetValid	Checks a string object for consistency.

Function ajStrGetAsciiCommon

Prototype

char ajStrGetAsciiCommon (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
char		RETURN	Most common character or null character if empty.

From EMBOSS 6.1.0

Function ajStrGetAsciiHigh

Prototype

char ajStrGetAsciiHigh (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
char		RETURN	Highest character or null character if empty.

From EMBOSS 6.1.0

Function ajStrGetAsciiLow

Prototype

char ajStrGetAsciiLow (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
char		RETURN	Lowest character or null character if empty.

From EMBOSS 6.1.0

Function ajStrGetCharFirst

Prototype

char ajStrGetCharFirst (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
char		RETURN	First character or null character if empty.

From EMBOSS 4.0.0

Function ajStrGetCharLast

Prototype

char ajStrGetCharLast (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
char		RETURN	Last character or null character if empty.

From EMBOSS 4.0.0

Function ajStrGetCharPos

Prototype

char ajStrGetCharPos (
      const AjPStr str,
      ajlong pos
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
ajlong	pos	Input	Position in the string, negative values are from the end of the string.
char		RETURN	Character at position pos or null character if out of range.

From EMBOSS 4.0.0

Function ajStrGetLen

Prototype

size_t ajStrGetLen (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	Source string
size_t		RETURN	Current string length

From EMBOSS 4.0.0

Macro MAJSTRGETLEN

Function ajStrGetPtr

Prototype

const char* ajStrGetPtr (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	Source string
const char*		RETURN	Current string pointer, or a null string if undefined.

From EMBOSS 4.0.0

Macro MAJSTRGETPTR

Function ajStrGetRes

Prototype

size_t ajStrGetRes (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	Source string
size_t		RETURN	Current string reserved size

From EMBOSS 4.0.0

Macro MAJSTRGETRES

Function ajStrGetRoom

Prototype

size_t ajStrGetRoom (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
size_t		RETURN	Space available for additional characters.

From EMBOSS 4.0.0

Function ajStrGetUse

Prototype

ajuint ajStrGetUse (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	Source string
ajuint		RETURN	Current string usage count

From EMBOSS 4.0.0

Macro MAJSTRGETUSE

Function ajStrGetValid

Prototype

AjBool ajStrGetValid (
      const AjPStr str
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool		RETURN	ajTrue if no errors were found.

From EMBOSS 4.0.0

AjPStr: modifiable string retrieval

Functions:

ajStrGetuniquePtr	Makes the string value unique by copying any string with a reference count of more than 1, and returns the current C (char *) pointer.
MAJSTRGETUNIQUESTR
ajStrGetuniqueStr	Make certain a string is modifiable by checking it has no other references, or by making a new real copy of the string.

Function ajStrGetuniquePtr

Prototype

char* ajStrGetuniquePtr (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Source string
char*		RETURN	Current string pointer, or a null string if undefined.

From EMBOSS 4.0.0

Macro MAJSTRGETUNIQUESTR

Function ajStrGetuniqueStr

Prototype

AjPStr ajStrGetuniqueStr (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String
AjPStr		RETURN	The new string pointer, or NULL for failure

From EMBOSS 4.0.0

AjPStr: element assignment

Functions:

ajStrSetClear	Clears all elements in a string object.
ajStrSetRes	Ensures a string is modifiable and big enough for its intended purpose.
ajStrSetResRound	Ensures a string is modifiable and big enough for its intended purpose.
ajStrSetValid	Reset string length when some nasty caller may have edited it
ajStrSetValidLen	Reset string length when some nasty caller may have edited it

Function ajStrSetClear

Prototype

AjBool ajStrSetClear (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Pointer to the string to be deleted. The pointer is always deleted.
AjBool		RETURN	ajTrue if string was reallocated

From EMBOSS 4.0.0

Function ajStrSetRes

Prototype

AjBool ajStrSetRes (
      AjPStr* Pstr,
      size_t size
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String
size_t	size	Input	Minimum reserved size.
AjBool		RETURN	ajTrue if the string was reallocated

From EMBOSS 4.0.0

Function ajStrSetResRound

Prototype

AjBool ajStrSetResRound (
      AjPStr* Pstr,
      size_t size
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String
size_t	size	Input	Minimum reserved size.
AjBool		RETURN	ajTrue if the string was reallocated

From EMBOSS 4.0.0

Function ajStrSetValid

Prototype

AjBool ajStrSetValid (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

Function ajStrSetValidLen

Prototype

AjBool ajStrSetValidLen (
      AjPStr* Pstr,
      size_t len
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String
size_t	len	Input	Length expected.
AjBool		RETURN	True on success

From EMBOSS 4.0.0

AjPStr: string to datatype conversion functions

Functions:

ajStrToBool	Converts a string into a Boolean value.
ajStrToDouble	Converts a string into a double precision value.
ajStrToFloat	Converts a string into a floating point value.
ajStrToHex	Converts a string from hexadecimal into an integer value.
ajStrToInt	Converts a string into an integer value.
ajStrToLong	Converts a string into an integer value.
ajStrToUint	Converts a string into an unsigned integer value.
ajStrToUlong	Converts a string into an unsigned long integer value.

Function ajStrToBool

Prototype

AjBool ajStrToBool (
      const AjPStr str,
      AjBool* Pval
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
AjBool*	Pval	Output	ajTrue if the string is "true" as a boolean.
AjBool		RETURN	ajTrue if the string had a valid boolean value.

From EMBOSS 1.0.0

Function ajStrToDouble

Prototype

AjBool ajStrToDouble (
      const AjPStr str,
      double* Pval
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
double*	Pval	Output	String represented as a double precision number.
AjBool		RETURN	ajTrue if the string had a valid double precision value.

From EMBOSS 1.0.0

Function ajStrToFloat

Prototype

AjBool ajStrToFloat (
      const AjPStr str,
      float* Pval
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
float*	Pval	Output	String represented as a floating point number.
AjBool		RETURN	ajTrue if the string had a valid floating point value.

From EMBOSS 1.0.0

Function ajStrToHex

Prototype

AjBool ajStrToHex (
      const AjPStr str,
      ajint* Pval
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
ajint*	Pval	Output	String represented as an integer.
AjBool		RETURN	ajTrue if the string had a valid hexadecimal value.

From EMBOSS 1.13.0

Function ajStrToInt

Prototype

AjBool ajStrToInt (
      const AjPStr str,
      ajint* Pval
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
ajint*	Pval	Output	String represented as an integer.
AjBool		RETURN	ajTrue if the string had a valid integer value.

From EMBOSS 1.0.0

Function ajStrToLong

Prototype

AjBool ajStrToLong (
      const AjPStr str,
      ajlong* Pval
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
ajlong*	Pval	Output	String represented as an integer.
AjBool		RETURN	ajTrue if the string had a valid integer value.

From EMBOSS 1.0.0

Function ajStrToUint

Prototype

AjBool ajStrToUint (
      const AjPStr str,
      ajuint* Pval
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
ajuint*	Pval	Output	String represented as an unsigned integer.
AjBool		RETURN	ajTrue if the string had a valid unsigned integer value.

From EMBOSS 4.1.0

Function ajStrToUlong

Prototype

AjBool ajStrToUlong (
      const AjPStr str,
      ajulong* Pval
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
ajulong*	Pval	Output	String represented as an integer.
AjBool		RETURN	ajTrue if the string had a valid integer value.

From EMBOSS 6.3.0

AjPStr: datatype to string conversion functions

Functions:

ajStrFromBool	Converts a Boolean value into a 1-letter string.
ajStrFromDouble	Converts a double precision value into a string.
ajStrFromDoubleExp	Converts a double precision value into a string.
ajStrFromFloat	Converts a floating point value into a string.
ajStrFromInt	Converts an integer value into a string.
ajStrFromLong	Converts an ajlong integer value into a string.
ajStrFromUint	Converts an unsigned integer value into a string.
ajStrFromVoid	Tests a void pointer and if it is potentially an ASCII string saves it as the output string.

Function ajStrFromBool

Prototype

AjBool ajStrFromBool (
      AjPStr* Pstr,
      AjBool val
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	String to hold the result.
AjBool	val	Input	Boolean value
AjBool		RETURN	ajTrue if string was reallocated

From EMBOSS 1.0.0

Function ajStrFromDouble

Prototype

AjBool ajStrFromDouble (
      AjPStr* Pstr,
      double val,
      ajint precision
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
double	val	Input	Double precision value
ajint	precision	Input	Precision (number of decimal places) to use.
AjBool		RETURN	ajTrue if string was reallocated

From EMBOSS 1.0.0

Function ajStrFromDoubleExp

Prototype

AjBool ajStrFromDoubleExp (
      AjPStr* Pstr,
      double val,
      ajint precision
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
double	val	Input	Double precision value
ajint	precision	Input	Precision (number of decimal places) to use.
AjBool		RETURN	ajTrue if string was reallocated

From EMBOSS 4.0.0

Function ajStrFromFloat

Prototype

AjBool ajStrFromFloat (
      AjPStr* Pstr,
      float val,
      ajint precision
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
float	val	Input	Floating point value
ajint	precision	Input	Precision (number of decimal places) to use.
AjBool		RETURN	ajTrue if string was reallocated

From EMBOSS 1.0.0

Function ajStrFromInt

Prototype

AjBool ajStrFromInt (
      AjPStr* Pstr,
      ajint val
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
ajint	val	Input	Integer value
AjBool		RETURN	ajTrue if string was reallocated

From EMBOSS 1.0.0

Function ajStrFromLong

Prototype

AjBool ajStrFromLong (
      AjPStr* Pstr,
      ajlong val
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
ajlong	val	Input	Long integer value
AjBool		RETURN	ajTrue if string was reallocated

From EMBOSS 1.0.0

Function ajStrFromUint

Prototype

AjBool ajStrFromUint (
      AjPStr* Pstr,
      ajuint val
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
ajuint	val	Input	Integer value
AjBool		RETURN	ajTrue if string was reallocated

From EMBOSS 4.1.0

Function ajStrFromVoid

Prototype

AjBool ajStrFromVoid (
      AjPStr* Pstr,
      const void* vval
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Output	Target string
const void*	vval	Input	Integer value
AjBool		RETURN	ajTrue if string was found

From EMBOSS 6.4.0

AjPStr: formatting

Functions:

ajStrFmtBlock	Splits a string into words (blocks) of a given size by inserting spaces.
ajStrFmtLower	Converts a string to lower case.
ajStrFmtLowerSub	Converts a substring of a string to lower case.
ajStrFmtPercentDecode	Converts percent-encoded characters
ajStrFmtPercentEncodeC	Percent-encoded specified characters
ajStrFmtPercentEncodeS	Percent-encoded specified characters
ajStrFmtQuery	Ensures a string is a standard EMBOSS query term with all alphabetic characters in lower case, and any non alphanumeric characters replaced by an underscore
ajStrFmtQuote	Ensures a string is quoted with double quotes.
ajStrFmtTitle	Converts the first character of a string to upper case.
ajStrFmtUpper	Converts a string to upper case.
ajStrFmtUpperSub	Converts a substring of a string to upper case.
ajStrFmtWord	Converts a string to a single word. Spaces are converted to underscores. Leading substrings ending in a colon are removed.
ajStrFmtWrap	Formats a string so that it wraps when printed.
ajStrFmtWrapAt	Formats a string so that it wraps when printed. Breaks are at a preferred character (for example ',' for author lists)
ajStrFmtWrapLeft	Formats a string so that it wraps and has a margin of space characters and an additional indent when printed.

Function ajStrFmtBlock

Prototype

AjBool ajStrFmtBlock (
      AjPStr* Pstr,
      ajulong len
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String.
ajulong	len	Input	Block size
AjBool		RETURN	ajTrue on success

From EMBOSS 4.0.0

Function ajStrFmtLower

Prototype

AjBool ajStrFmtLower (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

Function ajStrFmtLowerSub

Prototype

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

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String
ajlong	pos1	Input	start position for conversion
ajlong	pos2	Input	end position for conversion
AjBool		RETURN	ajTrue if string was reallocated

From EMBOSS 4.0.0

Function ajStrFmtPercentDecode

Prototype

AjBool ajStrFmtPercentDecode (
      AjPStr* Pstr
);

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

From EMBOSS 6.4.0

Function ajStrFmtPercentEncodeC

Prototype

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

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
const char*	txt	Input	Characters to encode
AjBool		RETURN	True if string is not empty.

From EMBOSS 6.4.0

Function ajStrFmtPercentEncodeS

Prototype

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

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
const AjPStr	str	Input	Characters to encode
AjBool		RETURN	True if string is not empty.

From EMBOSS 6.4.0

Function ajStrFmtQuery

Prototype

AjBool ajStrFmtQuery (
      AjPStr* Pstr
);

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

From EMBOSS 6.4.0

Function ajStrFmtQuote

Prototype

AjBool ajStrFmtQuote (
      AjPStr* Pstr
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	string
AjBool		RETURN	True if string is not empty. As it is at least quoted, it will always return true.

From EMBOSS 4.0.0

Function ajStrFmtTitle

Prototype

AjBool ajStrFmtTitle (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

Function ajStrFmtUpper

Prototype

AjBool ajStrFmtUpper (
      AjPStr* Pstr
);

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

From EMBOSS 4.0.0

Function ajStrFmtUpperSub

Prototype

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

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	String
ajlong	pos1	Input	start position for conversion
ajlong	pos2	Input	end position for conversion
AjBool		RETURN	ajTrue if string was reallocated

From EMBOSS 4.0.0

Function ajStrFmtWord

Prototype

AjBool ajStrFmtWord (
      AjPStr* Pstr
);

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

From EMBOSS 6.4.0

Function ajStrFmtWrap

Prototype

AjBool ajStrFmtWrap (
      AjPStr* Pstr,
      ajuint width
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
ajuint	width	Input	Line width
AjBool		RETURN	ajTrue on successful completion else ajFalse;

From EMBOSS 4.0.0

Function ajStrFmtWrapAt

Prototype

AjBool ajStrFmtWrapAt (
      AjPStr* Pstr,
      ajuint width,
      char ch
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
ajuint	width	Input	Line width
char	ch	Input	Preferred last character on line
AjBool		RETURN	ajTrue on successful completion else ajFalse;

From EMBOSS 5.0.0

Function ajStrFmtWrapLeft

Prototype

AjBool ajStrFmtWrapLeft (
      AjPStr* Pstr,
      ajuint width,
      ajuint margin,
      ajuint indent
);

Type	Name	Read/Write	Description
AjPStr*	Pstr	Modify	Target string
ajuint	width	Input	Line width
ajuint	margin	Input	Left margin
ajuint	indent	Input	Left indentation on later lines
AjBool		RETURN	ajTrue on successful completion else ajFalse;

From EMBOSS 4.0.0

AjPStr: comparison

Functions:

ajStrMatchC	Simple test for matching a string and a text string.
ajStrMatchS	Simple test for matching two strings.
ajStrMatchCaseC	Simple case-insensitive test for matching a string and a text string.
ajStrMatchCaseS	Simple case-insensitive test for matching two strings.
ajStrMatchWildC	Simple case-sensitive test for matching a string and a text string using wildcard characters.
ajStrMatchWildS	Simple case-sensitive test for matching two strings using wildcard characters.
ajStrMatchWildCaseC	Simple case-insensitive test for matching a string and a text string using wildcard characters.
ajStrMatchWildCaseS	Simple case-insensitive test for matching two strings using wildcard characters.
ajStrMatchWildWordC	Case-sensitive test for matching a text string "word" against a string using wildcard characters.
ajStrMatchWildWordS	Case-sensitive test for matching a string "word" against a string using wildcard characters.
ajStrMatchWildWordCaseC	Case-insensitive test for matching a text string "word" against a string using wildcard characters.
ajStrMatchWildWordCaseS	Case-insensitive test for matching a string "word" against a string using wildcard characters.
ajStrMatchWordAllS	Test for matching all words within a string. Matches can be to parts of words in the original string.
ajStrMatchWordOneS	Test for matching a word within a string. Matches can be to parts of words in the original string.
ajStrPrefixC	Test for matching the start of a string against a given prefix text string.
ajStrPrefixS	Test for matching the start of a string against a given prefix string.
ajStrPrefixCaseC	Case-insensitive test for matching the start of a string against a given prefix text string.
ajStrPrefixCaseS	Case-insensitive test for matching the start of a string against a given prefix string.
ajStrSuffixC	Test for matching the end of a string against a given suffix text string.
ajStrSuffixS	Test for matching the end of a string against a given suffix string.
ajStrSuffixCaseC	Case-insensitive test for matching the end of a string against a given suffix text string.
ajStrSuffixCaseS	Case-insensitive test for matching the end of a string against a given suffix string.

Function ajStrMatchC

Prototype

AjBool ajStrMatchC (
      const AjPStr str,
      const char* txt2
);

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
const char*	txt2	Input	Text
AjBool		RETURN	ajTrue if two complete strings are the same

From EMBOSS 1.0.0

Function ajStrMatchS

Prototype

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

Type	Name	Read/Write	Description
const AjPStr	str	Input	String
const AjPStr	str2	Input	Second String
AjBool		RETURN	ajTrue if two complete strings are the same