ajutil.c

Datatypes:

none Exit functions

Datatype: none

Sections:

exit Miscellaneous

Functions:

ajExit Calls 'exit' with a successful code (zero), but first calls ajReset to call memory clean up and debug reporting functions.

ajExitAbort Exits without flushing any files. Needed for exit from, for example, a failed system call (ajFileNewInPipe, and so on) where the parent process has open output files, and the child process needs to exit without affecting them. Failure to exit this way can mean the output buffer is flushed twice.

ajExitBad Calls 'exit' with an unsuccessful code (EXIT_FAILURE defined in stdlib.h).

Function ajExit

Calls 'exit' with a successful code (zero), but first calls ajReset to call memory clean up and debug reporting functions.

Prototype

void ajExit (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 1.0.0

Function ajExitAbort

Exits without flushing any files. Needed for exit from, for example, a failed system call (ajFileNewInPipe, and so on) where the parent process has open output files, and the child process needs to exit without affecting them. Failure to exit this way can mean the output buffer is flushed twice.

Prototype

void ajExitAbort (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 3.0.0

Function ajExitBad

Calls 'exit' with an unsuccessful code (EXIT_FAILURE defined in stdlib.h).

Prototype

void ajExitBad (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 1.0.0

Section: reset

Functions for memory cleanup

Functions:

ajReset Cleans up all internal memory by calling cleanup routines which can report on resource usage etc.

Function ajReset

Cleans up all internal memory by calling cleanup routines which can report on resource usage etc.

Prototype

void ajReset (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 5.0.0

Section: byte manipulation functions

Functions for manipulating bytes.

Functions:

ajByteRevInt Reverses the byte order in an integer.

ajByteRevLen2 Reverses the byte order in a 2 byte integer.

ajByteRevLen2u Reverses the byte order in a 2 byte integer.

ajByteRevLen4 Reverses the byte order in a 4 byte integer.

ajByteRevLen4u Reverses the byte order in a 4 byte integer.

ajByteRevLen8 Reverses the byte order in an 8 byte long.

ajByteRevLen8u Reverses the byte order in an 8 byte long.

ajByteRevLong Reverses the byte order in a long.

ajByteRevShort Reverses the byte order in a short integer.

ajByteRevUint Reverses the byte order in an unsigned integer.

ajByteRevUlong Reverses the byte order in an unsigned long.

Function ajByteRevInt

Reverses the byte order in an integer.

Prototype

void ajByteRevInt (
      ajint* ival
);

Type Name Read/Write Description

ajint* ival Modify Integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajint*`	`ival`	Modify	Integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 5.0.0

Function ajByteRevLen2

Reverses the byte order in a 2 byte integer.

Prototype

void ajByteRevLen2 (
      ajshort* sval
);

Type Name Read/Write Description

ajshort* sval Modify Short integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajshort*`	`sval`	Modify	Short integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 5.0.0

Function ajByteRevLen2u

Reverses the byte order in a 2 byte integer.

Prototype

void ajByteRevLen2u (
      ajushort* sval
);

Type Name Read/Write Description

ajushort* sval Modify Short integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajushort*`	`sval`	Modify	Short integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 6.2.0

Function ajByteRevLen4

Reverses the byte order in a 4 byte integer.

Prototype

void ajByteRevLen4 (
      ajint* ival
);

Type Name Read/Write Description

ajint* ival Modify Integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajint*`	`ival`	Modify	Integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 5.0.0

Function ajByteRevLen4u

Reverses the byte order in a 4 byte integer.

Prototype

void ajByteRevLen4u (
      ajuint* ival
);

Type Name Read/Write Description

ajuint* ival Modify Integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajuint*`	`ival`	Modify	Integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 6.2.0

Function ajByteRevLen8

Reverses the byte order in an 8 byte long.

Prototype

void ajByteRevLen8 (
      ajlong* lval
);

Type Name Read/Write Description

ajlong* lval Modify Integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajlong*`	`lval`	Modify	Integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 5.0.0

Function ajByteRevLen8u

Reverses the byte order in an 8 byte long.

Prototype

void ajByteRevLen8u (
      ajulong* lval
);

Type Name Read/Write Description

ajulong* lval Modify Integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajulong*`	`lval`	Modify	Integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 6.2.0

Function ajByteRevLong

Reverses the byte order in a long.

Prototype

void ajByteRevLong (
      ajlong* lval
);

Type Name Read/Write Description

ajlong* lval Modify Integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajlong*`	`lval`	Modify	Integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 5.0.0

Function ajByteRevShort

Reverses the byte order in a short integer.

Prototype

void ajByteRevShort (
      ajshort* sval
);

Type Name Read/Write Description

ajshort* sval Modify Short integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajshort*`	`sval`	Modify	Short integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 5.0.0

Function ajByteRevUint

Reverses the byte order in an unsigned integer.

Prototype

void ajByteRevUint (
      ajuint* ival
);

Type Name Read/Write Description

ajuint* ival Modify Unsigned integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajuint*`	`ival`	Modify	Unsigned integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 5.0.0

Function ajByteRevUlong

Reverses the byte order in an unsigned long.

Prototype

void ajByteRevUlong (
      ajulong* lval
);

Type Name Read/Write Description

ajulong* lval Modify Integer in wrong byte order. Returned in correct order.

void RETURN

Type	Name	Read/Write	Description
`ajulong*`	`lval`	Modify	Integer in wrong byte order. Returned in correct order.
`void`		RETURN

From EMBOSS 6.4.0

Section: Miscellaneous utility functions

Miscellaneous utility functions.

Functions:

ajUtilBase64DecodeC Decode a base 64 string

ajUtilBase64EncodeC Decode a base 64 string

ajUtilCatch Dummy function to be called in special cases so it can be used when debugging in GDB.

ajUtilGetBigendian Tests whether the host system uses big endian byte order.

ajUtilGetUid Returns the user's userid

ajUtilLoginfo If a log file is in use, writes run details to end of file.

Function ajUtilBase64DecodeC

Decode a base 64 string

Prototype

size_t ajUtilBase64DecodeC (
      AjPStr* Pdest,
      const char* src
);

Type Name Read/Write Description

AjPStr* Pdest Output Decoded string

const char* src Input source base64 string

size_t RETURN Length of decoded string (zero if decode error)

Type	Name	Read/Write	Description
`AjPStr*`	`Pdest`	Output	Decoded string
`const char*`	`src`	Input	source base64 string
`size_t`		RETURN	Length of decoded string (zero if decode error)

From EMBOSS 6.4.0

Function ajUtilBase64EncodeC

Decode a base 64 string

Prototype

AjBool ajUtilBase64EncodeC (
      AjPStr* Pdest,
      size_t size,
      const unsigned char* src
);

Type Name Read/Write Description

AjPStr* Pdest Modify Encoded string

size_t size Input Size of data to encode

const unsigned char* src Input source data

AjBool RETURN True on success

Type	Name	Read/Write	Description
`AjPStr*`	`Pdest`	Modify	Encoded string
`size_t`	`size`	Input	Size of data to encode
`const unsigned char*`	`src`	Input	source data
`AjBool`		RETURN	True on success

From EMBOSS 6.4.0

Function ajUtilCatch

Dummy function to be called in special cases so it can be used when debugging in GDB.

Prototype

void ajUtilCatch (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 2.5.0

Function ajUtilGetBigendian

Tests whether the host system uses big endian byte order.

Prototype

AjBool ajUtilGetBigendian (
      void
);

Type Name Read/Write Description

AjBool RETURN ajTrue if host is big endian.

Type	Name	Read/Write	Description
`AjBool`		RETURN	ajTrue if host is big endian.

From EMBOSS 5.0.0

Function ajUtilGetUid

Returns the user's userid

Prototype

AjBool ajUtilGetUid (
      AjPStr* Puid
);

Type Name Read/Write Description

AjPStr* Puid Output String to return result

AjBool RETURN ajTrue on success

Type	Name	Read/Write	Description
`AjPStr*`	`Puid`	Output	String to return result
`AjBool`		RETURN	ajTrue on success

From EMBOSS 5.0.0

Function ajUtilLoginfo

If a log file is in use, writes run details to end of file.

Prototype

void ajUtilLoginfo (
      void
);

Type Name Read/Write Description

void RETURN

Type	Name	Read/Write	Description
`void`		RETURN

From EMBOSS 5.0.0

Section: provenance

Functions providing information about the run-time environment

Functions:

ajUtilGetCmdline Returns the original command line as qualifiers and values with newline delimiters

ajUtilGetInputs Returns the user non-default inputs in commandline form

ajUtilGetProgram Returns the application (program) name from the ACD definition.

Function ajUtilGetCmdline

Returns the original command line as qualifiers and values with newline delimiters

Prototype

const AjPStr ajUtilGetCmdline (
      void
);

Type Name Read/Write Description

const AjPStr RETURN Commandline with newlines between qualifiers and parameters

Type	Name	Read/Write	Description
`const AjPStr`		RETURN	Commandline with newlines between qualifiers and parameters

From EMBOSS 6.2.0

Function ajUtilGetInputs

Returns the user non-default inputs in commandline form

Prototype

const AjPStr ajUtilGetInputs (
      void
);

Type Name Read/Write Description

const AjPStr RETURN Commandline with newlines between qualifiers and parameters

Type	Name	Read/Write	Description
`const AjPStr`		RETURN	Commandline with newlines between qualifiers and parameters

From EMBOSS 6.2.0

Function ajUtilGetProgram

Returns the application (program) name from the ACD definition.

Prototype

const AjPStr ajUtilGetProgram (
      void
);

Type Name Read/Write Description

const AjPStr RETURN Program name

Type	Name	Read/Write	Description
`const AjPStr`		RETURN	Program name

From EMBOSS 6.2.0

ajExit	Calls 'exit' with a successful code (zero), but first calls ajReset to call memory clean up and debug reporting functions.
ajExitAbort	Exits without flushing any files. Needed for exit from, for example, a failed system call (ajFileNewInPipe, and so on) where the parent process has open output files, and the child process needs to exit without affecting them. Failure to exit this way can mean the output buffer is flushed twice.
ajExitBad	Calls 'exit' with an unsuccessful code (EXIT_FAILURE defined in stdlib.h).

ajByteRevInt	Reverses the byte order in an integer.
ajByteRevLen2	Reverses the byte order in a 2 byte integer.
ajByteRevLen2u	Reverses the byte order in a 2 byte integer.
ajByteRevLen4	Reverses the byte order in a 4 byte integer.
ajByteRevLen4u	Reverses the byte order in a 4 byte integer.
ajByteRevLen8	Reverses the byte order in an 8 byte long.
ajByteRevLen8u	Reverses the byte order in an 8 byte long.
ajByteRevLong	Reverses the byte order in a long.
ajByteRevShort	Reverses the byte order in a short integer.
ajByteRevUint	Reverses the byte order in an unsigned integer.
ajByteRevUlong	Reverses the byte order in an unsigned long.

ajUtilBase64DecodeC	Decode a base 64 string
ajUtilBase64EncodeC	Decode a base 64 string
ajUtilCatch	Dummy function to be called in special cases so it can be used when debugging in GDB.
ajUtilGetBigendian	Tests whether the host system uses big endian byte order.
ajUtilGetUid	Returns the user's userid
ajUtilLoginfo	If a log file is in use, writes run details to end of file.

ajUtilGetCmdline	Returns the original command line as qualifiers and values with newline delimiters
ajUtilGetInputs	Returns the user non-default inputs in commandline form
ajUtilGetProgram	Returns the application (program) name from the ACD definition.