ajvarread.c

Datatypes: AjPVarin none AjPTable AjPVarall none

Datatype: AjPVarin

Variation input objects

Sections: Variation input constructors variation input destructors variation input modifiers casts Variation data inputs

Section: Variation input constructors

All constructors return a new variation input object by pointer. It is the responsibility of the user to first destroy any previous variation input object. The target pointer does not need to be initialised to NULL, but it is good programming practice to do so anyway.

Functions: ajVarinNew

Function ajVarinNew

Creates a new variation input object.

Synopsis

Prototype
AjPVarin ajVarinNew (
      void
);

TypeNameRead/WriteDescription
AjPVarin RETURNNew variation input object.

Returns
AjPVarin:New variation input object.

Description

Creates a new variation input object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: variation input destructors

Destruction destroys all internal data structures and frees the memory allocated for the variation input object.

Functions: ajVarinDel

Function ajVarinDel

Deletes a variation input object.

Synopsis

Prototype
void ajVarinDel (
      AjPVarin* pthis
);

TypeNameRead/WriteDescription
AjPVarin*pthisDeleteVariation input
void RETURN

Output
pthis:(Delete)Variation input
Returns
void:No return value

Description

Deletes a variation input object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: variation input modifiers

These functions use the contents of a variation input object and update them.

Functions: ajVarinClear ajVarinQryC ajVarinQryS

Function ajVarinClear

Clears a variation input object back to "as new" condition, except for the query list which must be preserved.

Synopsis

Prototype
void ajVarinClear (
      AjPVarin thys
);

TypeNameRead/WriteDescription
AjPVarinthysOutputVariation input
void RETURN

Output
thys:(Output)Variation input
Returns
void:No return value

Description

Clears a variation input object back to "as new" condition, except for the query list which must be preserved.

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVarinQryC

Resets a variation input object using a new Universal Query Address

Synopsis

Prototype
void ajVarinQryC (
      AjPVarin thys,
      const char* txt
);

TypeNameRead/WriteDescription
AjPVarinthysModifyVariation input object.
const char*txtInputQuery
void RETURN

Input
txt:(Input)Query
Input & Output
thys:(Modify)Variation input object.
Returns
void:No return value

Description

Resets a variation input object using a new Universal Query Address

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVarinQryS

Resets a variation input object using a new Universal Query Address

Synopsis

Prototype
void ajVarinQryS (
      AjPVarin thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPVarinthysModifyVariation input object.
const AjPStrstrInputQuery
void RETURN

Input
str:(Input)Query
Input & Output
thys:(Modify)Variation input object.
Returns
void:No return value

Description

Resets a variation input object using a new Universal Query Address

See Also

See other functions in this section

Availability

In release 6.4.0

Section: casts

Return values

Functions: ajVarinTrace

Function ajVarinTrace

Debug calls to trace the data in a variation input object.

Synopsis

Prototype
void ajVarinTrace (
      const AjPVarin thys
);

TypeNameRead/WriteDescription
const AjPVarinthysInputVariation input object.
void RETURN

Input
thys:(Input)Variation input object.
Returns
void:No return value

Description

Debug calls to trace the data in a variation input object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Variation data inputs

These functions read the wxyxdesc data provided by the first argument

Functions: ajVarinRead

Function ajVarinRead

If the file is not yet open, calls varinQryProcess to convert the query into an open file stream.

Uses varinRead for the actual file reading.

Returns the results in the AjPVar object.

Synopsis

Prototype
AjBool ajVarinRead (
      AjPVarin varin,
      AjPVar var
);

TypeNameRead/WriteDescription
AjPVarinvarinModifyVariation data input definitions
AjPVarvarOutputVariation data returned.
AjBool RETURNajTrue on success.

Output
var:(Output)Variation data returned.
Input & Output
varin:(Modify)Variation data input definitions
Returns
AjBool:ajTrue on success.

Description

If the file is not yet open, calls varinQryProcess to convert the query into an open file stream.

Uses varinRead for the actual file reading.

Returns the results in the AjPVar object.

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: none

Miscellaneous

Sections: Print Miscellaneous Internals

Section: Print

Printing to a file

Functions: ajVarinprintBook ajVarinprintHtml ajVarinprintText ajVarinprintWiki

Function ajVarinprintBook

Reports the internal data structures as a Docbook table

Synopsis

Prototype
void ajVarinprintBook (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the internal data structures as a Docbook table

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVarinprintHtml

Reports the internal data structures as an HTML table

Synopsis

Prototype
void ajVarinprintHtml (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the internal data structures as an HTML table

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVarinprintText

Reports the internal data structures

Synopsis

Prototype
void ajVarinprintText (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull report (usually ajFalse)
void RETURN

Input
full:(Input)Full report (usually ajFalse)
Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the internal data structures

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVarinprintWiki

Reports the internal data structures as a wiki table

Synopsis

Prototype
void ajVarinprintWiki (
      AjPFile outf
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
void RETURN

Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Reports the internal data structures as a wiki table

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Miscellaneous

Functions to initialise and clean up internals

Functions: ajVarinExit

Function ajVarinExit

Cleans up variation input internal memory

Synopsis

Prototype
void ajVarinExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up variation input internal memory

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Internals

Functions to return internal values

Functions: ajVarinTypeGetFields ajVarinTypeGetQlinks

Function ajVarinTypeGetFields

Returns the list of known field names for ajVarinRead

Synopsis

Prototype
const char* ajVarinTypeGetFields (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

Returns
const char*:List of field names

Description

Returns the list of known field names for ajVarinRead

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVarinTypeGetQlinks

Returns the listof known query link operators for ajVarinRead

Synopsis

Prototype
const char* ajVarinTypeGetQlinks (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

Returns
const char*:List of field names

Description

Returns the listof known query link operators for ajVarinRead

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPTable

Internal call register table

Sections: Cast

Section: Cast

Return a reference to the call table

Functions: ajVaraccessGetDb ajVaraccessMethodGetQlinks ajVaraccessMethodGetScope ajVaraccessMethodTest

Function ajVaraccessGetDb

Returns the table in which variation database access details are registered

Synopsis

Prototype
AjPTable ajVaraccessGetDb (
      void
);

TypeNameRead/WriteDescription
AjPTable RETURNAccess functions hash table

Returns
AjPTable:Access functions hash table

Description

Returns the table in which variation database access details are registered

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVaraccessMethodGetQlinks

Tests for a named method for var data reading returns the known query link operators

Synopsis

Prototype
const char* ajVaraccessMethodGetQlinks (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
const char* RETURNKnown link operators

Input
method:(Input)Method required.
Returns
const char*:Known link operators

Description

Tests for a named method for var data reading returns the known query link operators

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVaraccessMethodGetScope

Tests for a named method for variation data reading and returns the scope (entry, query or all).

Synopsis

Prototype
ajuint ajVaraccessMethodGetScope (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
ajuint RETURNScope flags

Input
method:(Input)Method required.
Returns
ajuint:Scope flags

Description

Tests for a named method for variation data reading and returns the scope (entry, query or all).

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVaraccessMethodTest

Tests for a named method for variation data reading.

Synopsis

Prototype
AjBool ajVaraccessMethodTest (
      const AjPStr method
);

TypeNameRead/WriteDescription
const AjPStrmethodInputMethod required.
AjBool RETURNajTrue on success.

Input
method:(Input)Method required.
Returns
AjBool:ajTrue on success.

Description

Tests for a named method for variation data reading.

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPVarall

Variation Input Stream

Sections: Variation Input Constructors Variation Input Stream Destructors Variation input stream modifiers Variation input stream casts Variation input

Section: Variation Input Constructors

All constructors return a new variation input stream object by pointer. It is the responsibility of the user to first destroy any previous variation input object. The target pointer does not need to be initialised to NULL, but it is good programming practice to do so anyway.

Functions: ajVarallNew

Function ajVarallNew

Creates a new variation input stream object.

Synopsis

Prototype
AjPVarall ajVarallNew (
      void
);

TypeNameRead/WriteDescription
AjPVarall RETURNNew variation input stream object.

Returns
AjPVarall:New variation input stream object.

Description

Creates a new variation input stream object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Variation Input Stream Destructors

Destruction destroys all internal data structures and frees the memory allocated for the variation input stream object.

Functions: ajVarallDel

Function ajVarallDel

Deletes a variation input stream object.

Synopsis

Prototype
void ajVarallDel (
      AjPVarall* pthis
);

TypeNameRead/WriteDescription
AjPVarall*pthisDeleteVariation input stream
void RETURN

Output
pthis:(Delete)Variation input stream
Returns
void:No return value

Description

Deletes a variation input stream object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Variation input stream modifiers

These functions use the contents of a variation input stream object and update them.

Functions: ajVarallClear

Function ajVarallClear

Clears a variation input stream object back to "as new" condition, except for the query list which must be preserved.

Synopsis

Prototype
void ajVarallClear (
      AjPVarall thys
);

TypeNameRead/WriteDescription
AjPVarallthysOutputVariation input stream
void RETURN

Output
thys:(Output)Variation input stream
Returns
void:No return value

Description

Clears a variation input stream object back to "as new" condition, except for the query list which must be preserved.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Variation input stream casts

These functions return the contents of a variation input stream object

Functions: ajVarallGetvarId

Function ajVarallGetvarId

Returns the identifier of the current variation in an input stream

Synopsis

Prototype
const AjPStr ajVarallGetvarId (
      const AjPVarall thys
);

TypeNameRead/WriteDescription
const AjPVarallthysInputVariation input stream
const AjPStr RETURNIdentifier

Input
thys:(Input)Variation input stream
Returns
const AjPStr:Identifier

Description

Returns the identifier of the current variation in an input stream

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Variation input

These functions use a variation input stream object to read data

Functions: ajVarallNext

Function ajVarallNext

Parse a variation query into format, access, file and entry

Split at delimiters. Check for the first part as a valid format Check for the remaining first part as a database name or as a file that can be opened. Anything left is an entryname spec.

Return the results in the AjPVar object but leave the file open for future calls.

Synopsis

Prototype
AjBool ajVarallNext (
      AjPVarall thys,
      AjPVar* Pvar
);

TypeNameRead/WriteDescription
AjPVarallthysOutputVariation input stream
AjPVar*PvarModifyVariation returned
AjBool RETURNajTrue on success.

Output
thys:(Output)Variation input stream
Input & Output
Pvar:(Modify)Variation returned
Returns
AjBool:ajTrue on success.

Description

Parse a variation query into format, access, file and entry

Split at delimiters. Check for the first part as a valid format Check for the remaining first part as a database name or as a file that can be opened. Anything left is an entryname spec.

Return the results in the AjPVar object but leave the file open for future calls.

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: none

Input formats

Sections: cast

Section: cast

Values for input formats

Functions: ajVarinformatTerm ajVarinformatTest

Function ajVarinformatTerm

Tests whether a variation data input format term is known

Synopsis

Prototype
AjBool ajVarinformatTerm (
      const AjPStr term
);

TypeNameRead/WriteDescription
const AjPStrtermInputFormat term EDAM ID
AjBool RETURNajTrue if term was accepted

Input
term:(Input)Format term EDAM ID
Returns
AjBool:ajTrue if term was accepted

Description

Tests whether a variation data input format term is known

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajVarinformatTest

Tests whether a named variation data input format is known

Synopsis

Prototype
AjBool ajVarinformatTest (
      const AjPStr format
);

TypeNameRead/WriteDescription
const AjPStrformatInputFormat
AjBool RETURNajTrue if format was accepted

Input
format:(Input)Format
Returns
AjBool:ajTrue if format was accepted

Description

Tests whether a named variation data input format is known

See Also

See other functions in this section

Availability

In release 6.4.0