ajurlread.c

Datatypes: AjPUrlin none AjPTable AjPUrlall none

Datatype: AjPUrlin

Url input objects

Sections: Url input constructors url input destructors url input modifiers casts Url data inputs

Section: Url input constructors

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

Functions: ajUrlinNew

Function ajUrlinNew

Creates a new url input object.

Synopsis

Prototype
AjPUrlin ajUrlinNew (
      void
);

TypeNameRead/WriteDescription
AjPUrlin RETURNNew url input object.

Returns
AjPUrlin:New url input object.

Description

Creates a new url input object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: url input destructors

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

Functions: ajUrlinDel

Function ajUrlinDel

Deletes an url input object.

Synopsis

Prototype
void ajUrlinDel (
      AjPUrlin* pthis
);

TypeNameRead/WriteDescription
AjPUrlin*pthisDeleteUrl input
void RETURN

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

Description

Deletes an url input object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: url input modifiers

These functions use the contents of an url input object and update them.

Functions: ajUrlinClear ajUrlinQryC ajUrlinQryS

Function ajUrlinClear

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

Synopsis

Prototype
void ajUrlinClear (
      AjPUrlin thys
);

TypeNameRead/WriteDescription
AjPUrlinthysOutputUrl input
void RETURN

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

Description

Clears an url 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 ajUrlinQryC

Resets an url input object using a new Universal Query Address

Synopsis

Prototype
void ajUrlinQryC (
      AjPUrlin thys,
      const char* txt
);

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

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

Description

Resets an url input object using a new Universal Query Address

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajUrlinQryS

Resets an url input object using a new Universal Query Address

Synopsis

Prototype
void ajUrlinQryS (
      AjPUrlin thys,
      const AjPStr str
);

TypeNameRead/WriteDescription
AjPUrlinthysModifyUrl input object.
const AjPStrstrInputQuery
void RETURN

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

Description

Resets an url 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: ajUrlinTrace

Function ajUrlinTrace

Debug calls to trace the data in an url input object.

Synopsis

Prototype
void ajUrlinTrace (
      const AjPUrlin thys
);

TypeNameRead/WriteDescription
const AjPUrlinthysInputUrl input object.
void RETURN

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

Description

Debug calls to trace the data in an url input object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Url data inputs

These functions read the wxyxdesc data provided by the first argument

Functions: ajUrlinRead

Function ajUrlinRead

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

Uses urlinRead for the actual file reading.

Returns the results in the AjPUrl object.

Synopsis

Prototype
AjBool ajUrlinRead (
      AjPUrlin urlin,
      AjPUrl url
);

TypeNameRead/WriteDescription
AjPUrlinurlinModifyUrl data input definitions
AjPUrlurlOutputUrl data returned.
AjBool RETURNajTrue on success.

Output
url:(Output)Url data returned.
Input & Output
urlin:(Modify)Url data input definitions
Returns
AjBool:ajTrue on success.

Description

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

Uses urlinRead for the actual file reading.

Returns the results in the AjPUrl 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: ajUrlinprintBook ajUrlinprintHtml ajUrlinprintText ajUrlinprintWiki

Function ajUrlinprintBook

Reports the internal data structures as a Docbook table

Synopsis

Prototype
void ajUrlinprintBook (
      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 ajUrlinprintHtml

Reports the internal data structures as an HTML table

Synopsis

Prototype
void ajUrlinprintHtml (
      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 ajUrlinprintText

Reports the internal data structures

Synopsis

Prototype
void ajUrlinprintText (
      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 ajUrlinprintWiki

Reports the internal data structures as a wiki table

Synopsis

Prototype
void ajUrlinprintWiki (
      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: ajUrlinExit

Function ajUrlinExit

Cleans up url input internal memory

Synopsis

Prototype
void ajUrlinExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Cleans up url 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: ajUrlinTypeGetFields ajUrlinTypeGetQlinks

Function ajUrlinTypeGetFields

Returns the listof known field names for ajUrlinRead

Synopsis

Prototype
const char* ajUrlinTypeGetFields (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

Returns
const char*:List of field names

Description

Returns the listof known field names for ajUrlinRead

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajUrlinTypeGetQlinks

Returns the list of known query link operators for ajUrlinRead

Synopsis

Prototype
const char* ajUrlinTypeGetQlinks (
      void
);

TypeNameRead/WriteDescription
const char* RETURNList of field names

Returns
const char*:List of field names

Description

Returns the list of known query link operators for ajUrlinRead

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: ajUrlaccessGetDb ajUrlaccessMethodGetQlinks ajUrlaccessMethodGetScope ajUrlaccessMethodTest

Function ajUrlaccessGetDb

Returns the table in which url database access details are registered

Synopsis

Prototype
AjPTable ajUrlaccessGetDb (
      void
);

TypeNameRead/WriteDescription
AjPTable RETURNAccess functions hash table

Returns
AjPTable:Access functions hash table

Description

Returns the table in which url database access details are registered

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajUrlaccessMethodGetQlinks

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

Synopsis

Prototype
const char* ajUrlaccessMethodGetQlinks (
      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 url data reading returns the known query link operators

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajUrlaccessMethodGetScope

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

Synopsis

Prototype
ajuint ajUrlaccessMethodGetScope (
      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 url 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 ajUrlaccessMethodTest

Tests for a named method for url data reading.

Synopsis

Prototype
AjBool ajUrlaccessMethodTest (
      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 url data reading.

See Also

See other functions in this section

Availability

In release 6.4.0

Datatype: AjPUrlall

Url Input Stream

Sections: Url Input Constructors Url Input Stream Destructors Url input stream modifiers Url input stream casts url input

Section: Url Input Constructors

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

Functions: ajUrlallNew

Function ajUrlallNew

Creates a new url input stream object.

Synopsis

Prototype
AjPUrlall ajUrlallNew (
      void
);

TypeNameRead/WriteDescription
AjPUrlall RETURNNew url input stream object.

Returns
AjPUrlall:New url input stream object.

Description

Creates a new url input stream object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Url Input Stream Destructors

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

Functions: ajUrlallDel

Function ajUrlallDel

Deletes a url input stream object.

Synopsis

Prototype
void ajUrlallDel (
      AjPUrlall* pthis
);

TypeNameRead/WriteDescription
AjPUrlall*pthisDeleteUrl input stream
void RETURN

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

Description

Deletes a url input stream object.

See Also

See other functions in this section

Availability

In release 6.4.0

Section: Url input stream modifiers

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

Functions: ajUrlallClear

Function ajUrlallClear

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

Synopsis

Prototype
void ajUrlallClear (
      AjPUrlall thys
);

TypeNameRead/WriteDescription
AjPUrlallthysOutputUrl input stream
void RETURN

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

Description

Clears a url 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: Url input stream casts

These functions return the contents of a url input stream object

Functions: ajUrlallGeturlId

Function ajUrlallGeturlId

Returns the identifier of the current url in an input stream

Synopsis

Prototype
const AjPStr ajUrlallGeturlId (
      const AjPUrlall thys
);

TypeNameRead/WriteDescription
const AjPUrlallthysInputUrl input stream
const AjPStr RETURNIdentifier

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

Description

Returns the identifier of the current url in an input stream

See Also

See other functions in this section

Availability

In release 6.4.0

Section: url input

These functions use a url input stream object to read data

Functions: ajUrlallNext

Function ajUrlallNext

Parse a url 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 AjPUrl object but leave the file open for future calls.

Synopsis

Prototype
AjBool ajUrlallNext (
      AjPUrlall thys,
      AjPUrl* Purl
);

TypeNameRead/WriteDescription
AjPUrlallthysOutputUrl input stream
AjPUrl*PurlModifyUrl returned
AjBool RETURNajTrue on success.

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

Description

Parse a url 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 AjPUrl 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: ajUrlinformatTerm ajUrlinformatTest

Function ajUrlinformatTerm

Tests whether a url data input format term is known

Synopsis

Prototype
AjBool ajUrlinformatTerm (
      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 url data input format term is known

See Also

See other functions in this section

Availability

In release 6.4.0

Function ajUrlinformatTest

Tests whether a named url data input format is known

Synopsis

Prototype
AjBool ajUrlinformatTest (
      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 url data input format is known

See Also

See other functions in this section

Availability

In release 6.4.0