ajnam.c

Function ajNamPrintDbAttr

Prints a report of the database attributes available (for entrails)

Synopsis

Prototype
void ajNamPrintDbAttr (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull output if AjTrue
void RETURN

Input
full:(Input)Full output if AjTrue
Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Prints a report of the database attributes available (for entrails)

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamPrintRsAttr

Prints a report of the resource attributes available (for entrails)

Synopsis

Prototype
void ajNamPrintRsAttr (
      AjPFile outf,
      AjBool full
);

TypeNameRead/WriteDescription
AjPFileoutfModifyOutput file
AjBoolfullInputFull output if AjTrue
void RETURN

Input
full:(Input)Full output if AjTrue
Input & Output
outf:(Modify)Output file
Returns
void:No return value

Description

Prints a report of the resource attributes available (for entrails)

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDbDetails

Returns database access method information

Synopsis

Prototype
AjBool ajNamDbDetails (
      const AjPStr name,
      AjPStr* type,
      AjBool* id,
      AjBool* qry,
      AjBool* all,
      AjPStr* comment,
      AjPStr* release,
      AjPStr* methods,
      AjPStr* defined
);

TypeNameRead/WriteDescription
const AjPStrnameInputDatabase name
AjPStr*typeOutputsequence type - 'P' or 'N'
AjBool*idOutputajTrue = can access single entries
AjBool*qryOutputajTrue = can access wild/query entries
AjBool*allOutputajTrue = can access all entries
AjPStr*commentOutputcomment about database
AjPStr*releaseOutputdatabase release date
AjPStr*methodsOutputdatabase access methods formatted
AjPStr*definedOutputdatabase definition file short name
AjBool RETURNajTrue if database details were found

Input
name:(Input)Database name
Output
type:(Output)sequence type - 'P' or 'N'
id:(Output)ajTrue = can access single entries
qry:(Output)ajTrue = can access wild/query entries
all:(Output)ajTrue = can access all entries
comment:(Output)comment about database
release:(Output)database release date
methods:(Output)database access methods formatted
defined:(Output)database definition file short name
Returns
AjBool:ajTrue if database details were found

Description

Returns database access method information

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamListOrigin

Writes a simple list of where the internal tables came from..

Synopsis

Prototype
void ajNamListOrigin (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple list of where the internal tables came from..

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDebugOrigin

Writes a simple list of where the internal tables came from..

Synopsis

Prototype
void ajNamDebugOrigin (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple list of where the internal tables came from..

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamListDatabases

Writes a simple list of all databases in the internal table.

Synopsis

Prototype
void ajNamListDatabases (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple list of all databases in the internal table.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDebugDatabases

Writes a simple debug report of all databases in the internal table.

Synopsis

Prototype
void ajNamDebugDatabases (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple debug report of all databases in the internal table.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDebugResources

Writes a simple debug report of all databases in the internal table.

Synopsis

Prototype
void ajNamDebugResources (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple debug report of all databases in the internal table.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDebugVariables

Writes a simple debug report of all envornment variables in the internal table.

Synopsis

Prototype
void ajNamDebugVariables (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple debug report of all envornment variables in the internal table.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamListListDatabases

Creates a AjPList list of all databases in the internal table.

Synopsis

Prototype
void ajNamListListDatabases (
      AjPList dbnames
);

TypeNameRead/WriteDescription
AjPListdbnamesOutputStr List of names to be populated
void RETURN

Output
dbnames:(Output)Str List of names to be populated
Returns
void:No return value

Description

Creates a AjPList list of all databases in the internal table.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamListListResources

Creates a AjPList list of all databases in the internal table.

Synopsis

Prototype
void ajNamListListResources (
      AjPList rsnames
);

TypeNameRead/WriteDescription
AjPListrsnamesOutputStr List of names to be populated
void RETURN

Output
rsnames:(Output)Str List of names to be populated
Returns
void:No return value

Description

Creates a AjPList list of all databases in the internal table.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamVariables

Writes a simple list of all variables in the internal table.

Synopsis

Prototype
void ajNamVariables (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Writes a simple list of all variables in the internal table.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamIsDbname

Returns true if the name is a valid database name.

Database names must start with a letter, and have 1 or more letters, numbers or underscores. No other characters are permitted.

Synopsis

Prototype
AjBool ajNamIsDbname (
      const AjPStr name
);

TypeNameRead/WriteDescription
const AjPStrnameInputcharacter string to find in getenv list
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string to find in getenv list
Returns
AjBool:True if name was defined.

Description

Returns true if the name is a valid database name.

Database names must start with a letter, and have 1 or more letters, numbers or underscores. No other characters are permitted.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamGetenvC

Looks for name as an environment variable. the AjPStr for this in "value". If not found returns value as NULL;

Synopsis

Prototype
AjBool ajNamGetenvC (
      const char* name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const char*nameInputcharacter string to find in getenv list
AjPStr*valueOutputString for the value.
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string to find in getenv list
Output
value:(Output)String for the value.
Returns
AjBool:True if name was defined.

Description

Looks for name as an environment variable. the AjPStr for this in "value". If not found returns value as NULL;

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamGetenvS

Looks for name as an environment variable. the AjPStr for this in "value". If not found returns NULL;

Synopsis

Prototype
AjBool ajNamGetenvS (
      const AjPStr name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputcharacter string to find in getenv list
AjPStr*valueOutputString for the value.
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string to find in getenv list
Output
value:(Output)String for the value.
Returns
AjBool:True if name was defined.

Description

Looks for name as an environment variable. the AjPStr for this in "value". If not found returns NULL;

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamGetValueC

Looks for name as an (upper case) environment variable, and then as-is in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Synopsis

Prototype
AjBool ajNamGetValueC (
      const char* name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const char*nameInputcharacter string find in hash table.
AjPStr*valueOutputStr for the value.
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string find in hash table.
Output
value:(Output)Str for the value.
Returns
AjBool:True if name was defined.

Description

Looks for name as an (upper case) environment variable, and then as-is in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamGetValueS

Looks for name as an (upper case) environment variable, and then as-is in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Synopsis

Prototype
AjBool ajNamGetValueS (
      const AjPStr name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputcharacter string find in hash table.
AjPStr*valueOutputString for the value.
AjBool RETURNTrue if name was defined.

Input
name:(Input)character string find in hash table.
Output
value:(Output)String for the value.
Returns
AjBool:True if name was defined.

Description

Looks for name as an (upper case) environment variable, and then as-is in the hash table and if found returns the AjPStr for this in "value". If not found returns NULL;

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDatabase

Looks for name in the hash table and if found returns the attribute for this. If not found returns NULL;

Synopsis

Prototype
AjBool ajNamDatabase (
      const AjPStr name
);

TypeNameRead/WriteDescription
const AjPStrnameInputcharacter string find in hash table.
AjBool RETURNtrue if database name is valid.

Input
name:(Input)character string find in hash table.
Returns
AjBool:true if database name is valid.

Description

Looks for name in the hash table and if found returns the attribute for this. If not found returns NULL;

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamInit

Initialise the variable and database definitions. Find the definition files and read them.

Synopsis

Prototype
void ajNamInit (
      const char* prefix
);

TypeNameRead/WriteDescription
const char*prefixInputDefault prefix for all file and variable names.
void RETURN

Input
prefix:(Input)Default prefix for all file and variable names.
Returns
void:No return value

Description

Initialise the variable and database definitions. Find the definition files and read them.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamExit

Delete the initialisation values in the table.

Synopsis

Prototype
void ajNamExit (
      void
);

TypeNameRead/WriteDescription
void RETURN

Returns
void:No return value

Description

Delete the initialisation values in the table.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDbTest

Looks for a database name in the known definitions.

Synopsis

Prototype
AjBool ajNamDbTest (
      const AjPStr dbname
);

TypeNameRead/WriteDescription
const AjPStrdbnameInputDatabase name.
AjBool RETURNajTrue on success.

Input
dbname:(Input)Database name.
Returns
AjBool:ajTrue on success.

Description

Looks for a database name in the known definitions.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDbGetUrl

Gets the URL definition for a database definition.

Synopsis

Prototype
AjBool ajNamDbGetUrl (
      const AjPStr dbname,
      AjPStr* url
);

TypeNameRead/WriteDescription
const AjPStrdbnameInputDatabase name.
AjPStr*urlOutputURL returned.
AjBool RETURNajTrue if success.

Input
dbname:(Input)Database name.
Output
url:(Output)URL returned.
Returns
AjBool:ajTrue if success.

Description

Gets the URL definition for a database definition.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDbGetDbalias

Gets an alias name for a database.

Synopsis

Prototype
AjBool ajNamDbGetDbalias (
      const AjPStr dbname,
      AjPStr* dbalias
);

TypeNameRead/WriteDescription
const AjPStrdbnameInputDatabase name.
AjPStr*dbaliasOutputAlias returned.
AjBool RETURNajTrue if success.

Input
dbname:(Input)Database name.
Output
dbalias:(Output)Alias returned.
Returns
AjBool:ajTrue if success.

Description

Gets an alias name for a database.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDbData

Given a query with database name and search fields, fill in the common fields. The query fields are set later.

This part of the database definition is required (specifically the "fields" definition) for setting the query details.

See also ajNamDbQuery, which calls this function if the common query data is not yet set.

Synopsis

Prototype
AjBool ajNamDbData (
      AjPSeqQuery qry
);

TypeNameRead/WriteDescription
AjPSeqQueryqryModifyQuery structure with at least dbname filled in
AjBool RETURNajTrue if success.

Input & Output
qry:(Modify)Query structure with at least dbname filled in
Returns
AjBool:ajTrue if success.

Description

Given a query with database name and search fields, fill in the common fields. The query fields are set later.

This part of the database definition is required (specifically the "fields" definition) for setting the query details.

See also ajNamDbQuery, which calls this function if the common query data is not yet set.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamDbQuery

Given a query with database name and search fields, fill in the access method and some common fields according to the query level.

Synopsis

Prototype
AjBool ajNamDbQuery (
      AjPSeqQuery qry
);

TypeNameRead/WriteDescription
AjPSeqQueryqryModifyQuery structure with at least dbname filled in
AjBool RETURNajTrue if success.

Input & Output
qry:(Modify)Query structure with at least dbname filled in
Returns
AjBool:ajTrue if success.

Description

Given a query with database name and search fields, fill in the access method and some common fields according to the query level.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamValueInstalldir

Returns the install directory root for all file searches (package level)

Synopsis

Prototype
const AjPStr ajNamValueInstalldir (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNInstall directory root

Returns
const AjPStr:Install directory root

Description

Returns the install directory root for all file searches (package level)

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamValuePackage

Returns the package name for the library

Synopsis

Prototype
const AjPStr ajNamValuePackage (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNPackage name

Returns
const AjPStr:Package name

Description

Returns the package name for the library

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamValueVersion

Returns the version number for the library

Synopsis

Prototype
const AjPStr ajNamValueVersion (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNVersion number

Returns
const AjPStr:Version number

Description

Returns the version number for the library

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamValueRootdir

Returns the directory for all file searches (package level)

Synopsis

Prototype
const AjPStr ajNamValueRootdir (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNPackage level root directory

Returns
const AjPStr:Package level root directory

Description

Returns the directory for all file searches (package level)

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamValueBasedir

Returns the base directory for all for all file searches (above package level).

Synopsis

Prototype
const AjPStr ajNamValueBasedir (
      void
);

TypeNameRead/WriteDescription
const AjPStr RETURNBase directory

Returns
const AjPStr:Base directory

Description

Returns the base directory for all for all file searches (above package level).

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamResolve

Resolves a variable name if the input string starts with a dollar sign.

Synopsis

Prototype
AjBool ajNamResolve (
      AjPStr* name
);

TypeNameRead/WriteDescription
AjPStr*nameOutputString
AjBool RETURNajTrue on success.

Output
name:(Output)String
Returns
AjBool:ajTrue on success.

Description

Resolves a variable name if the input string starts with a dollar sign.

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamSetControl

Sets special internal variables to reflect their presence.

Currently these are "namdebug, namvalid"

Synopsis

Prototype
AjBool ajNamSetControl (
      const char* optionName
);

TypeNameRead/WriteDescription
const char*optionNameInputoption name
AjBool RETURNajTrue if option was recognised

Input
optionName:(Input)option name
Returns
AjBool:ajTrue if option was recognised

Description

Sets special internal variables to reflect their presence.

Currently these are "namdebug, namvalid"

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamRsAttrValue

Return the value for a resource attribute

Synopsis

Prototype
AjBool ajNamRsAttrValue (
      const AjPStr name,
      const AjPStr attribute,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputresource name
const AjPStrattributeInputresource attribute
AjPStr*valueOutputresource value
AjBool RETURNtrue if found

Input
name:(Input)resource name
attribute:(Input)resource attribute
Output
value:(Output)resource value
Returns
AjBool:true if found

Description

Return the value for a resource attribute

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamRsAttrValueC

Return the value for a resource attribute

Synopsis

Prototype
AjBool ajNamRsAttrValueC (
      const char* name,
      const char* attribute,
      AjPStr* value
);

TypeNameRead/WriteDescription
const char*nameInputresource name
const char*attributeInputresource attribute
AjPStr*valueOutputresource value
AjBool RETURNtrue if found

Input
name:(Input)resource name
attribute:(Input)resource attribute
Output
value:(Output)resource value
Returns
AjBool:true if found

Description

Return the value for a resource attribute

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0

Function ajNamRsListValue

Return the value for a resource attribute of type 'list'

Synopsis

Prototype
AjBool ajNamRsListValue (
      const AjPStr name,
      AjPStr* value
);

TypeNameRead/WriteDescription
const AjPStrnameInputresource name
AjPStr*valueOutputresource value
AjBool RETURNtrue if found

Input
name:(Input)resource name
Output
value:(Output)resource value
Returns
AjBool:true if found

Description

Return the value for a resource attribute of type 'list'

Usage

See source code

Example

In preparation

Errors

See source code

Dependencies

See source code

See Also

See other functions in this section

Availability

In release 5.0.0