ajfile.c

Datatypes:

AjPDir	Directory
AjPDirout	Output directory
AjPFile	File object
AjPFilebuff	Buffered file object
AjPOutfile	Output file object
AjPStr	Filename functions
AjPlist	Lists of filenames
none	File internal values

Datatype: AjPDir

Sections:

Directory constructors	Constructors
Directory destructors	Destructors
Directory element retrieval	General use

AjPDir: Directory constructors

To replace or reuse an existing file, see instead the file assignments and file modifiers functions.

The range of constructors is provided to allow flexibility in how applications can open files to read various kinds of data.

Functions:

ajDirNewPath	Creates a new directory object.
ajDirNewPathExt	Creates a new directory object.
ajDirNewPathPreExt	Creates a new directory object.

Function ajDirNewPath

Prototype

AjPDir ajDirNewPath (
      const AjPStr path
);

Type	Name	Read/Write	Description
const AjPStr	path	Input	Directory name
AjPDir		RETURN	New directory object.

From EMBOSS 6.0.0

Function ajDirNewPathExt

Prototype

AjPDir ajDirNewPathExt (
      const AjPStr path,
      const AjPStr ext
);

Type	Name	Read/Write	Description
const AjPStr	path	Input	Directory name
const AjPStr	ext	Input	File extension
AjPDir		RETURN	New directory object.

From EMBOSS 6.0.0

Function ajDirNewPathPreExt

Prototype

AjPDir ajDirNewPathPreExt (
      const AjPStr path,
      const AjPStr prefix,
      const AjPStr ext
);

Type	Name	Read/Write	Description
const AjPStr	path	Input	Directory name
const AjPStr	prefix	Input	Filename prefix
const AjPStr	ext	Input	Filename extension
AjPDir		RETURN	New directory object.

From EMBOSS 6.0.0

AjPDir: Directory destructors

Functions:

ajDirDel

Close and free a directory object.

Function ajDirDel

Prototype

void ajDirDel (
      AjPDir* Pdir
);

Type	Name	Read/Write	Description
AjPDir*	Pdir	Delete	Directory object.
void		RETURN

From EMBOSS 2.9.0

AjPDir: Directory element retrieval

Functions:

ajDirGetExt	Returns the extension(s) of a directory object
ajDirGetPath	Returns the full path of a directory object
ajDirGetPrefix	Returns the filename prefix(es) of a directory object
ajDirGetPrintpath	Returns the full printable path of a directory object

Function ajDirGetExt

Prototype

const AjPStr ajDirGetExt (
      const AjPDir thys
);

Type	Name	Read/Write	Description
const AjPDir	thys	Input	Directory object.
const AjPStr		RETURN	Directory name

From EMBOSS 6.0.0

Function ajDirGetPath

Prototype

const AjPStr ajDirGetPath (
      const AjPDir thys
);

Type	Name	Read/Write	Description
const AjPDir	thys	Input	Directory object.
const AjPStr		RETURN	Directory name

From EMBOSS 6.0.0

Function ajDirGetPrefix

Prototype

const AjPStr ajDirGetPrefix (
      const AjPDir thys
);

Type	Name	Read/Write	Description
const AjPDir	thys	Input	Directory object.
const AjPStr		RETURN	Directory name

From EMBOSS 6.0.0

Function ajDirGetPrintpath

Prototype

const AjPStr ajDirGetPrintpath (
      const AjPDir thys
);

Type	Name	Read/Write	Description
const AjPDir	thys	Input	Directory object.
const AjPStr		RETURN	Directory printable name

From EMBOSS 6.4.0

Datatype: AjPDirout

Sections:

Output directory constructors	Constructors
Output directory destructors	Destructors
Output directory element retrieval	General use
Output directory element modifiers	General use

AjPDirout: Output directory constructors

To replace or reuse an existing file, see instead the File Assignments and File Modifiers functions.

The range of constructors is provided to allow flexibility in how applications can open files to read various kinds of data.

Functions:

ajDiroutNewPath	Creates a new directory output object.
ajDiroutNewPathExt	Creates a new directory output object.

Function ajDiroutNewPath

Prototype

AjPDirout ajDiroutNewPath (
      const AjPStr path
);

Type	Name	Read/Write	Description
const AjPStr	path	Input	Directory name
AjPDirout		RETURN	New directory object.

From EMBOSS 6.0.0

Function ajDiroutNewPathExt

Prototype

AjPDirout ajDiroutNewPathExt (
      const AjPStr path,
      const AjPStr ext
);

Type	Name	Read/Write	Description
const AjPStr	path	Input	Directory name
const AjPStr	ext	Input	File extension
AjPDirout		RETURN	New directory object.

From EMBOSS 6.0.0

AjPDirout: Output directory destructors

Functions:

ajDiroutDel

Close and free a directory object.

Function ajDiroutDel

Prototype

void ajDiroutDel (
      AjPDirout* Pdir
);

Type	Name	Read/Write	Description
AjPDirout*	Pdir	Delete	Directory object.
void		RETURN

From EMBOSS 2.9.0

AjPDirout: Output directory element retrieval

Functions:

ajDiroutGetExt	Returns the extension of an output directory object
ajDiroutGetPath	Returns the name of an output directory object
ajDiroutGetPrintpath	Returns the printable name of an output directory object

Function ajDiroutGetExt

Prototype

const AjPStr ajDiroutGetExt (
      const AjPDirout thys
);

Type	Name	Read/Write	Description
const AjPDirout	thys	Input	Directory object.
const AjPStr		RETURN	Directory name

From EMBOSS 6.0.0

Function ajDiroutGetPath

Prototype

const AjPStr ajDiroutGetPath (
      const AjPDirout thys
);

Type	Name	Read/Write	Description
const AjPDirout	thys	Input	Directory object.
const AjPStr		RETURN	Directory name

From EMBOSS 6.0.0

Function ajDiroutGetPrintpath

Prototype

const AjPStr ajDiroutGetPrintpath (
      const AjPDirout thys
);

Type	Name	Read/Write	Description
const AjPDirout	thys	Input	Directory object.
const AjPStr		RETURN	Directory printable name

From EMBOSS 6.4.0

AjPDirout: Output directory element modifiers

Functions:

ajDiroutExists	Tests a directory output object is for an existing directory
ajDiroutOpen	Opens a directory output object, creating it if it does not already exist

Function ajDiroutExists

Prototype

AjBool ajDiroutExists (
      AjPDirout thys
);

Type	Name	Read/Write	Description
AjPDirout	thys	Modify	Directory name
AjBool		RETURN	True on success.

From EMBOSS 6.1.0

Function ajDiroutOpen

Prototype

AjBool ajDiroutOpen (
      AjPDirout thys
);

Type	Name	Read/Write	Description
AjPDirout	thys	Modify	Directory name
AjBool		RETURN	True on success.

From EMBOSS 6.1.0

Datatype: AjPFile

Sections:

File constructors	Constructors
File destructors	Destructors
File reopen	Modifiers
File modifiers	Modifiers
File casts	General use
File debug	Miscellaneous
File exit	Miscellaneous

AjPFile: File constructors

The range of constructors is provided to allow flexibility in how applications can open files to read and write various kinds of data.

Functions:

ajFileNewFromCfile	Creates a new file object from an open C file.
ajFileNewInBlockS	Creates a new file object to read a named file using blocked fread calls.
ajFileNewInNameC	Creates a new file object to read a named file.
ajFileNewInNameS	Creates a new file object to read a named file.
ajFileNewInNamePathC	Opens directory "dir". Looks for file "file"
ajFileNewInNamePathS	Opens directory "dir". Looks for file "file"
ajFileNewInPipe	Creates a new file object to read the output from a command.
ajFileNewListinDirPre	Opens directory "dir". Looks for file "file" with the extension (if any) specified for the directory
ajFileNewListinList	Creates a new file object with a list of input file names.
ajFileNewListinNameDirS	Opens directory "dir" and looks for file "filename".
ajFileNewListinPathWild	Opens directory "dir" Looks for file(s) matching "file" Opens them as a list of files using a simple file object.
ajFileNewListinPathWildExclude	Opens directory "dir". Looks for file(s) matching "file". Skip files matching excluded files wildcard. Opens them as a list of files using a simple file object.
ajFileNewOutNameC	Creates a new output file object with a specified name.
ajFileNewOutNameS	Creates a new output file object with a specified name.
ajFileNewOutNameDirS	Creates a new output file object with a specified directory and name. Uses the default extension (if any) specified for the directory.
ajFileNewOutNamePathS	Creates a new output file object with a specified directory and name.
ajFileNewOutappendNameS	Creates an output file object with a specified name. The file is opened for append so it either appends to an existing file or opens a new one.

Function ajFileNewFromCfile

Prototype

AjPFile ajFileNewFromCfile (
      FILE* file
);

Type	Name	Read/Write	Description
FILE*	file	Modify	C file.
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewInBlockS

Prototype

AjPFile ajFileNewInBlockS (
      const AjPStr name,
      ajuint blocksize
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	File name.
ajuint	blocksize	Input	Block size
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewInNameC

Prototype

AjPFile ajFileNewInNameC (
      const char* name
);

Type	Name	Read/Write	Description
const char*	name	Input	File name.
AjPFile		RETURN	New file object.

From EMBOSS 6.2.0

Function ajFileNewInNameS

Prototype

AjPFile ajFileNewInNameS (
      const AjPStr name
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	File name.
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewInNamePathC

Prototype

AjPFile ajFileNewInNamePathC (
      const char* name,
      const AjPStr path
);

Type	Name	Read/Write	Description
const char*	name	Input	Filename.
const AjPStr	path	Input	Directory
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewInNamePathS

Prototype

AjPFile ajFileNewInNamePathS (
      const AjPStr name,
      const AjPStr path
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	Filename.
const AjPStr	path	Input	Directory
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewInPipe

Prototype

AjPFile ajFileNewInPipe (
      const AjPStr command
);

Type	Name	Read/Write	Description
const AjPStr	command	Input	Command string. The string may end with a trailing pipe character.
AjPFile		RETURN	New file object.

From EMBOSS 1.0.0

Function ajFileNewListinDirPre

Prototype

AjPFile ajFileNewListinDirPre (
      const AjPDir dir,
      const AjPStr prefix
);

Type	Name	Read/Write	Description
const AjPDir	dir	Input	Directory
const AjPStr	prefix	Input	Wildcard Filename.
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewListinList

Prototype

AjPFile ajFileNewListinList (
      AjPList list
);

Type	Name	Read/Write	Description
AjPList	list	Modify	List of input filenames as strings.
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewListinNameDirS

Prototype

AjPFile ajFileNewListinNameDirS (
      const AjPStr name,
      const AjPDir dir
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	Wildcard Filename.
const AjPDir	dir	Input	Directory
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewListinPathWild

Prototype

AjPFile ajFileNewListinPathWild (
      const AjPStr path,
      const AjPStr wildname
);

Type	Name	Read/Write	Description
const AjPStr	path	Input	Directory
const AjPStr	wildname	Input	Wildcard filename.
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewListinPathWildExclude

Prototype

AjPFile ajFileNewListinPathWildExclude (
      const AjPStr path,
      const AjPStr wildname,
      const AjPStr exclude
);

Type	Name	Read/Write	Description
const AjPStr	path	Input	Directory path
const AjPStr	wildname	Input	Wildcard filename.
const AjPStr	exclude	Input	Wildcard excluded filename.
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewOutNameC

Prototype

AjPFile ajFileNewOutNameC (
      const char* name
);

Type	Name	Read/Write	Description
const char*	name	Input	File name.
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewOutNameS

Prototype

AjPFile ajFileNewOutNameS (
      const AjPStr name
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	File name.
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewOutNameDirS

Prototype

AjPFile ajFileNewOutNameDirS (
      const AjPStr name,
      const AjPDirout dir
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	File name.
const AjPDirout	dir	Input	Directory (optional, can be empty or NULL).
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewOutNamePathS

Prototype

AjPFile ajFileNewOutNamePathS (
      const AjPStr name,
      const AjPStr path
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	File name.
const AjPStr	path	Input	Directory (optional, can be empty or NULL).
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

Function ajFileNewOutappendNameS

Prototype

AjPFile ajFileNewOutappendNameS (
      const AjPStr name
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	File name.
AjPFile		RETURN	New file object.

From EMBOSS 6.0.0

AjPFile: File destructors

Unlike ANSI C, there are tests to ensure a file is not closed twice.

Functions:

ajFileClose

Close and free a file object.

Function ajFileClose

Prototype

void ajFileClose (
      AjPFile* Pfile
);

Type	Name	Read/Write	Description
AjPFile*	Pfile	Delete	File.
void		RETURN

From EMBOSS 1.0.0

AjPFile: File reopen

Functions:

ajFileReopenName	Reopens an input file with a new name
ajFileReopenNext	Given a file object that includes a list of input files, closes the current input file and opens the next one.

Function ajFileReopenName

Prototype

AjBool ajFileReopenName (
      AjPFile file,
      const AjPStr name
);

Type	Name	Read/Write	Description
AjPFile	file	Modify	Input file.
const AjPStr	name	Input	name of file.
AjBool		RETURN	True on success

From EMBOSS 6.0.0

Function ajFileReopenNext

Prototype

AjBool ajFileReopenNext (
      AjPFile file
);

Type	Name	Read/Write	Description
AjPFile	file	Modify	File object.
AjBool		RETURN	ajTrue on success.

From EMBOSS 6.0.0

AjPFile: File modifiers

Functions:

ajFileFix	Resets internal file attribute after non-AJAX operations.
ajFileResetEof	Resets the end of file attribute after non-AJAX operations.
ajFileResetPos	Resets and returns the current position in an open file.
ajFileSeek	Sets the current position in an open file.
ajFileSetUnbuffer	Turns off system buffering of an output file, for example to allow debug output to appear even in the event of a program abort.

Function ajFileFix

Prototype

AjBool ajFileFix (
      AjPFile file
);

Type	Name	Read/Write	Description
AjPFile	file	Modify	File.
AjBool		RETURN	True if end of file is reached

From EMBOSS 6.0.0

Function ajFileResetEof

Prototype

AjBool ajFileResetEof (
      AjPFile file
);

Type	Name	Read/Write	Description
AjPFile	file	Modify	File.
AjBool		RETURN	True if end of file is set

From EMBOSS 6.0.0

Function ajFileResetPos

Prototype

ajlong ajFileResetPos (
      AjPFile file
);

Type	Name	Read/Write	Description
AjPFile	file	Modify	File.
ajlong		RETURN	Result of 'ftell'

From EMBOSS 6.0.0

Function ajFileSeek

Prototype

ajint ajFileSeek (
      AjPFile file,
      ajlong offset,
      ajint wherefrom
);

Type	Name	Read/Write	Description
AjPFile	file	Modify	File.
ajlong	offset	Input	Offset
ajint	wherefrom	Input	Start of offset, as defined for 'fseek'.
ajint		RETURN	Result of 'fseek'

From EMBOSS 1.0.0

Function ajFileSetUnbuffer

Prototype

void ajFileSetUnbuffer (
      AjPFile file
);

Type	Name	Read/Write	Description
AjPFile	file	Modify	File object.
void		RETURN

From EMBOSS 6.0.0

AjPFile: File casts

Functions:

ajFileGetFileptr	Returns the C file pointer for an open file.
ajFileGetNameC	Returns the file name for a file object. The filename returned is a pointer to the real string internally, so the user must take care not to change it and cannot trust the value if the file object is deleted.
ajFileGetNameS	Returns the file name for a file object. The filename returned is a pointer to the real string internally, so the user must take care not to change it and cannot trust the value if the file object is deleted.
ajFileGetPrintnameC	Returns the file name for a file object. The filename returned is a pointer to the real string internally, so the user must take care not to change it and cannot trust the value if the file object is deleted.
ajFileGetPrintnameS	Returns the file name for a file object. The filename returned is a pointer to the real string internally, so the user must take care not to change it and cannot trust the value if the file object is deleted.
ajFileIsAppend	Returns the App element for a file object. The App element is True if the file was opened for appending to, False otherwise.
ajFileIsEof	Tests whether we have reached end of file already
ajFileIsFile	Tests whether a file object is really a regular file.
ajFileIsStderr	Tests whether a file object is really stderr.
ajFileIsStdin	Tests whether a file object is really stdin.
ajFileIsStdout	Tests whether a file object is really stdout.

Function ajFileGetFileptr

Prototype

FILE* ajFileGetFileptr (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File.
FILE*		RETURN	C file pointer for the file.

From EMBOSS 6.0.0

Function ajFileGetNameC

Prototype

const char* ajFileGetNameC (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File.
const char*		RETURN	Filename as a C character string.

From EMBOSS 6.0.0

Function ajFileGetNameS

Prototype

const AjPStr ajFileGetNameS (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File.
const AjPStr		RETURN	Filename as a C character string.

From EMBOSS 6.0.0

Function ajFileGetPrintnameC

Prototype

const char* ajFileGetPrintnameC (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File.
const char*		RETURN	Printable filename as a C character string.

From EMBOSS 6.4.0

Function ajFileGetPrintnameS

Prototype

const AjPStr ajFileGetPrintnameS (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File.
const AjPStr		RETURN	Printable filename as a C character string.

From EMBOSS 6.4.0

Function ajFileIsAppend

Prototype

AjBool ajFileIsAppend (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File.
AjBool		RETURN	App element, True if if file was opened for appending to, False otherwise.

From EMBOSS 6.0.0

Function ajFileIsEof

Prototype

AjBool ajFileIsEof (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File
AjBool		RETURN	ajTrue if we already set end-of-file

From EMBOSS 6.0.0

Function ajFileIsFile

Prototype

AjBool ajFileIsFile (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File object.
AjBool		RETURN	ajTrue if the file matches stderr.

From EMBOSS 6.3.0

Function ajFileIsStderr

Prototype

AjBool ajFileIsStderr (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File object.
AjBool		RETURN	ajTrue if the file matches stderr.

From EMBOSS 6.0.0

Function ajFileIsStdin

Prototype

AjBool ajFileIsStdin (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File object.
AjBool		RETURN	ajTrue if the file matches stdin.

From EMBOSS 6.0.0

Function ajFileIsStdout

Prototype

AjBool ajFileIsStdout (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File object.
AjBool		RETURN	ajTrue if the file matches stdout.

From EMBOSS 6.0.0

AjPFile: File debug

Functions:

ajFileTrace

Writes debug messages to trace the contents of a file object.

Function ajFileTrace

Prototype

void ajFileTrace (
      const AjPFile file
);

Type	Name	Read/Write	Description
const AjPFile	file	Input	File.
void		RETURN

From EMBOSS 1.0.0

AjPFile: File exit

Functions:

ajFileExit

Prints a summary of file usage with debug calls

Function ajFileExit

Prototype

void ajFileExit (
      void
);

Type	Name	Read/Write	Description
void		RETURN

From EMBOSS 1.0.0

Datatype: AjPFilebuff

Sections:

Buffered file constructors	Constructors
Buffered file destructors	Destructors
Buffered file reopen	Modifiers
Buffered file modifiers	Modifiers
Buffered file content modifiers	Modifiers
Buffered file operators	General use
Buffered file debug	Miscellaneous

AjPFilebuff: Buffered file constructors

To replace or reuse an existing file, see instead the File Assignments and File Modifiers functions.

The range of constructors is provided to allow flexibility in how applications can open files to read various kinds of data.

Functions:

ajFilebuffNewFromCfile	Creates a new buffered input file from an already open C file.
ajFilebuffNewFromFile	Creates a new buffered input file object from an open file.
ajFilebuffNewLine	Creates a new buffered input file object with no file but with one line of buffered data provided.
ajFilebuffNewListinList	Creates a new buffered file object from a list of filenames.
ajFilebuffNewNameS	Creates a new buffered input file object with an opened named file.
ajFilebuffNewNamePathC	Opens directory "dir", finds and opens file "name"
ajFilebuffNewNamePathS	Opens directory "dir", finds and opens file "name"
ajFilebuffNewNofile	Creates a new buffered input file object with an undefined file to be used as a text buffer.
ajFilebuffNewPathWild	Opens directory "dir" Looks for file(s) matching "file" Opens them as a list of files using a buffered file object.
ajFilebuffNewPathWildExclude	Opens directory "dir" Looks for file(s) matching "file" Skip files matching excluded files wildcard Opens them as a list of files using a buffered file object.

Function ajFilebuffNewFromCfile

Prototype

AjPFilebuff ajFilebuffNewFromCfile (
      FILE* file
);

Type	Name	Read/Write	Description
FILE*	file	Modify	Open C file.
AjPFilebuff		RETURN	New buffered file object.

From EMBOSS 6.0.0

Function ajFilebuffNewFromFile

Prototype

AjPFilebuff ajFilebuffNewFromFile (
      AjPFile file
);

Type	Name	Read/Write	Description
AjPFile	file	Modify	File object to be buffered.
AjPFilebuff		RETURN	New buffered file object.

From EMBOSS 6.0.0

Function ajFilebuffNewLine

Prototype

AjPFilebuff ajFilebuffNewLine (
      const AjPStr line
);

Type	Name	Read/Write	Description
const AjPStr	line	Input	One line of buffered data.
AjPFilebuff		RETURN	New buffered file object.

From EMBOSS 6.0.0

Function ajFilebuffNewListinList

Prototype

AjPFilebuff ajFilebuffNewListinList (
      AjPList list
);

Type	Name	Read/Write	Description
AjPList	list	Modify	List of filenames as strings.
AjPFilebuff		RETURN	New buffered file object.

From EMBOSS 6.0.0

Function ajFilebuffNewNameS

Prototype

AjPFilebuff ajFilebuffNewNameS (
      const AjPStr name
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	File name.
AjPFilebuff		RETURN	New buffered file object.

From EMBOSS 6.0.0

Function ajFilebuffNewNamePathC

Prototype

AjPFilebuff ajFilebuffNewNamePathC (
      const char* name,
      const AjPStr path
);

Type	Name	Read/Write	Description
const char*	name	Input	Filename.
const AjPStr	path	Input	Directory. If empty uses current directory.
AjPFilebuff		RETURN	New buffered file object.

From EMBOSS 6.0.0

Function ajFilebuffNewNamePathS

Prototype

AjPFilebuff ajFilebuffNewNamePathS (
      const AjPStr name,
      const AjPStr path
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	Filename.
const AjPStr	path	Input	Directory. If empty uses current directory.
AjPFilebuff		RETURN	New buffered file object.

From EMBOSS 6.0.0

Function ajFilebuffNewNofile

Prototype

AjPFilebuff ajFilebuffNewNofile (
      void
);

Type	Name	Read/Write	Description
AjPFilebuff		RETURN	New buffered file object.

From EMBOSS 6.0.0

Function ajFilebuffNewPathWild

Prototype

AjPFilebuff ajFilebuffNewPathWild (
      const AjPStr path,
      const AjPStr wildname
);

Type	Name	Read/Write	Description
const AjPStr	path	Input	Directory
const AjPStr	wildname	Input	Wildcard filename.
AjPFilebuff		RETURN	New buffered file object.

From EMBOSS 6.0.0

Function ajFilebuffNewPathWildExclude

Prototype

AjPFilebuff ajFilebuffNewPathWildExclude (
      const AjPStr path,
      const AjPStr wildname,
      const AjPStr exclude
);

Type	Name	Read/Write	Description
const AjPStr	path	Input	Directory
const AjPStr	wildname	Input	Wildcard filename.
const AjPStr	exclude	Input	Wildcard excluded filename.
AjPFilebuff		RETURN	New buffered file object.

From EMBOSS 6.0.0

AjPFilebuff: Buffered file destructors

Unlike ANSI C, there are tests to ensure a file is not closed twice.

Functions:

ajFilebuffDel

Destructor for a buffered file object.

Function ajFilebuffDel

Prototype

void ajFilebuffDel (
      AjPFilebuff* Pbuff
);

Type	Name	Read/Write	Description
AjPFilebuff*	Pbuff	Delete	Buffered file object.
void		RETURN

From EMBOSS 6.0.0

AjPFilebuff: Buffered file reopen

Functions:

ajFilebuffReopenFile

Sets buffered input file to use a new open file.

Function ajFilebuffReopenFile

Prototype

AjBool ajFilebuffReopenFile (
      AjPFilebuff* Pbuff,
      AjPFile file
);

Type	Name	Read/Write	Description
AjPFilebuff*	Pbuff	Output	Buffered file object.
AjPFile	file	Modify	File object to be buffered.
AjBool		RETURN	ajTrue on success

From EMBOSS 6.0.0

AjPFilebuff: Buffered file modifiers

Functions:

ajFilebuffClear	Deletes processed lines from a file buffer. The buffer has a record (Pos) of the next unprocessed line in the buffer.
ajFilebuffClearStore	Deletes processed lines from a file buffer. The buffer has a record (Pos) of the next unprocessed line in the buffer.
ajFilebuffFix	Resets the pointer and current record of a file buffer so the next read starts at the first buffered line. Fixes buffer size after the buffer has been edited.
ajFilebuffReset	Resets the pointer and current record of a file buffer so the next read starts at the first buffered line.
ajFilebuffResetPos	Resets the pointer and current record of a file buffer so the next read starts at the first buffered line.
ajFilebuffResetStore	Resets the pointer and current record of a file buffer so the next read starts at the first buffered line.
ajFilebuffSetBuffered	Sets file to be buffered. If it already has buffered data, we have to first run down the buffer.
ajFilebuffSetUnbuffered	Sets file to be unbuffered. If it already has buffered data, we have to first run down the buffer.

Function ajFilebuffClear

Prototype

void ajFilebuffClear (
      AjPFilebuff buff,
      ajint lines
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	File buffer
ajint	lines	Input	Number of lines to retain. -1 deletes everything.
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffClearStore

Prototype

void ajFilebuffClearStore (
      AjPFilebuff buff,
      ajint lines,
      const AjPStr lastline,
      AjBool dostore,
      AjPStr* Pstore
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	File buffer
ajint	lines	Input	Number of lines to retain. -1 deletes everything.
const AjPStr	lastline	Input	Last line of input. Used to count characters to be saved
AjBool	dostore	Input	append if true
AjPStr*	Pstore	Output	Caller's record of the processed lines
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffFix

Prototype

void ajFilebuffFix (
      AjPFilebuff buff
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	File buffer
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffReset

Prototype

void ajFilebuffReset (
      AjPFilebuff buff
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	File buffer
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffResetPos

Prototype

void ajFilebuffResetPos (
      AjPFilebuff buff
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	File buffer
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffResetStore

Prototype

void ajFilebuffResetStore (
      AjPFilebuff buff,
      AjBool dostore,
      AjPStr* Pstore
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	File buffer
AjBool	dostore	Input	True if text is stored
AjPStr*	Pstore	Output	Stored string cleared if store is true
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffSetBuffered

Prototype

AjBool ajFilebuffSetBuffered (
      AjPFilebuff buff
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	Buffered file object.
AjBool		RETURN	ajTrue if the file was unbuffered before

From EMBOSS 6.0.0

Function ajFilebuffSetUnbuffered

Prototype

AjBool ajFilebuffSetUnbuffered (
      AjPFilebuff buff
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	Buffered file object.
AjBool		RETURN	ajTrue if the file was unbuffered before

From EMBOSS 6.0.0

AjPFilebuff: Buffered file content modifiers

Functions:

ajFilebuffHtmlNoheader	Processes data in the file buffer, removing HTML titles and decoding possible chunked input
ajFilebuffHtmlPre	If we only have one pre-formatted section in HTML, that is all we keep.
ajFilebuffHtmlStrip	Processes data in the file buffer, removing HTML tokens between angle brackets, plus any TITLE. This seems to be enough to make HTML output readable.
ajFilebuffLoadC	Adds a line to the buffer.
ajFilebuffLoadS	Adds a copy of a line to the buffer.
ajFilebuffLoadAll	Reads all input lines from a file into the buffer.
ajFilebuffLoadReadurl	Reads from a URL and loads all input lines into the buffer.

Function ajFilebuffHtmlNoheader

Prototype

ajuint ajFilebuffHtmlNoheader (
      AjPFilebuff buff
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	Buffered file with data loaded in the buffer.
ajuint		RETURN	HTTP error code

From EMBOSS 6.2.0

Function ajFilebuffHtmlPre

Prototype

AjBool ajFilebuffHtmlPre (
      AjPFilebuff buff
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	buffer
AjBool		RETURN	ajTrue=cleaned ajFalse=unchanged

From EMBOSS 6.0.0

Function ajFilebuffHtmlStrip

Prototype

void ajFilebuffHtmlStrip (
      AjPFilebuff buff
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	Buffered file with data loaded in the buffer.
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffLoadC

Prototype

void ajFilebuffLoadC (
      AjPFilebuff buff,
      const char* line
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	Buffered file.
const char*	line	Input	Line of input.
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffLoadS

Prototype

void ajFilebuffLoadS (
      AjPFilebuff buff,
      const AjPStr line
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	Buffered file.
const AjPStr	line	Input	Line of input.
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffLoadAll

Prototype

void ajFilebuffLoadAll (
      AjPFilebuff buff
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	Buffered file.
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffLoadReadurl

Prototype

AjBool ajFilebuffLoadReadurl (
      AjPFilebuff buff,
      const AjPStr url
);

Type	Name	Read/Write	Description
AjPFilebuff	buff	Modify	Buffered file.
const AjPStr	url	Input	URL
AjBool		RETURN	True on success

From EMBOSS 6.4.0

AjPFilebuff: Buffered file operators

Functions:

ajFilebuffGetFile	Returns the file object from a buffered file object.
ajFilebuffGetFileptr	Returns the C file pointer for an open buffered file.
ajFilebuffGetFirst	Returns the first line of a file buffer
ajFilebuffIsBuffered	Tests whether an input file is buffered.
ajFilebuffIsEmpty	Tests whether a file buffer is empty, including testing for a possible next file
ajFilebuffIsEnded	Tests whether the current file is exhausted. This means end of file is reached and the buffer is empty.
ajFilebuffIsEof	Tests whether we have reached end of file already

Function ajFilebuffGetFile

Prototype

AjPFile ajFilebuffGetFile (
      const AjPFilebuff buff
);

Type	Name	Read/Write	Description
const AjPFilebuff	buff	Input	Buffered file.
AjPFile		RETURN	File object.

From EMBOSS 6.0.0

Function ajFilebuffGetFileptr

Prototype

FILE* ajFilebuffGetFileptr (
      const AjPFilebuff buff
);

Type	Name	Read/Write	Description
const AjPFilebuff	buff	Input	Buffered file.
FILE*		RETURN	C file pointer for the file.

From EMBOSS 6.0.0

Function ajFilebuffGetFirst

Prototype

const AjPStr ajFilebuffGetFirst (
      const AjPFilebuff buff
);

Type	Name	Read/Write	Description
const AjPFilebuff	buff	Input	File buffer
const AjPStr		RETURN	First line

From EMBOSS 6.4.0

Function ajFilebuffIsBuffered

Prototype

AjBool ajFilebuffIsBuffered (
      const AjPFilebuff buff
);

Type	Name	Read/Write	Description
const AjPFilebuff	buff	Input	Buffered file object.
AjBool		RETURN	ajTrue if the file was unbuffered before

From EMBOSS 6.0.0

Function ajFilebuffIsEmpty

Prototype

AjBool ajFilebuffIsEmpty (
      const AjPFilebuff buff
);

Type	Name	Read/Write	Description
const AjPFilebuff	buff	Input	Buffered file.
AjBool		RETURN	ajTrue if the buffer is empty.

From EMBOSS 6.0.0

Function ajFilebuffIsEnded

Prototype

AjBool ajFilebuffIsEnded (
      const AjPFilebuff buff
);

Type	Name	Read/Write	Description
const AjPFilebuff	buff	Input	File buffer
AjBool		RETURN	ajTrue if we already set end-of-file

From EMBOSS 6.0.0

Function ajFilebuffIsEof

Prototype

AjBool ajFilebuffIsEof (
      const AjPFilebuff buff
);

Type	Name	Read/Write	Description
const AjPFilebuff	buff	Input	File buffer
AjBool		RETURN	ajTrue if we already set end-of-file

From EMBOSS 6.0.0

AjPFilebuff: Buffered file debug

Functions:

ajFilebuffTrace	Writes debug messages to indicate the contents of a buffered file.
ajFilebuffTraceFull	Writes debug messages to show the full contents of a buffered file.
ajFilebuffTraceTitle	Writes the full contents of a buffered file to the debug file

Function ajFilebuffTrace

Prototype

void ajFilebuffTrace (
      const AjPFilebuff buff
);

Type	Name	Read/Write	Description
const AjPFilebuff	buff	Input	Buffered file.
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffTraceFull

Prototype

void ajFilebuffTraceFull (
      const AjPFilebuff buff,
      size_t nlines,
      size_t nfree
);

Type	Name	Read/Write	Description
const AjPFilebuff	buff	Input	Buffered file.
size_t	nlines	Input	Maximum number of lines to trace.
size_t	nfree	Input	Maximum number of free lines to trace.
void		RETURN

From EMBOSS 6.0.0

Function ajFilebuffTraceTitle

Prototype

void ajFilebuffTraceTitle (
      const AjPFilebuff buff,
      const char* title
);

Type	Name	Read/Write	Description
const AjPFilebuff	buff	Input	Buffered file.
const char*	title	Input	Report title
void		RETURN

From EMBOSS 6.0.0

Datatype: AjPOutfile

Sections:

Outfile constructors	Constructors
Outfile destructors	Destructors
Outfile casts	Casts

AjPOutfile: Outfile constructors

To replace or reuse an existing file, see instead the File Assignments and File Modifiers functions.

The range of constructors is provided to allow flexibility in how applications can open files to read various kinds of data.

Functions:

ajOutfileNewNameS

Creates a new formatted output file object with a specified name.

Function ajOutfileNewNameS

Prototype

AjPOutfile ajOutfileNewNameS (
      const AjPStr name
);

Type	Name	Read/Write	Description
const AjPStr	name	Input	File name.
AjPOutfile		RETURN	New output file object.

From EMBOSS 6.0.0

AjPOutfile: Outfile destructors

Unlike ANSI C, there are tests to ensure a file is not closed twice.

Functions:

ajOutfileClose

Close and free an outfile object.

Function ajOutfileClose

Prototype

void ajOutfileClose (
      AjPOutfile* Pfile
);

Type	Name	Read/Write	Description
AjPOutfile*	Pfile	Delete	Output file.
void		RETURN

From EMBOSS 2.9.0

AjPOutfile: Outfile casts

Functions:

ajOutfileGetFile	Returns the AjPFile for an AjPOutfile object
ajOutfileGetFileptr	Returns the C FILE* for an AjPOutfile object
ajOutfileGetFormat	Returns the file format name for an AjPOutfile object
ajOutfileGetFormatindex	Returns the file format name for an AjPOutfile object

Function ajOutfileGetFile

Prototype

AjPFile ajOutfileGetFile (
      const AjPOutfile file
);

Type	Name	Read/Write	Description
const AjPOutfile	file	Input	Outfile object
AjPFile		RETURN	AjPFile object

From EMBOSS 6.0.0

Function ajOutfileGetFileptr

Prototype

FILE* ajOutfileGetFileptr (
      const AjPOutfile file
);

Type	Name	Read/Write	Description
const AjPOutfile	file	Input	Outfile object
FILE*		RETURN	C file pointer

From EMBOSS 6.0.0

Function ajOutfileGetFormat

Prototype

const AjPStr ajOutfileGetFormat (
      const AjPOutfile file
);

Type	Name	Read/Write	Description
const AjPOutfile	file	Input	Outfile object
const AjPStr		RETURN	Format name

From EMBOSS 6.0.0

Function ajOutfileGetFormatindex

Prototype

ajuint ajOutfileGetFormatindex (
      const AjPOutfile file
);

Type	Name	Read/Write	Description
const AjPOutfile	file	Input	Outfile object
ajuint		RETURN	Format name

From EMBOSS 6.4.0

Datatype: AjPStr

Sections:

Filename tests	General use
Filename modifiers	Modifiers

AjPStr: Filename tests

Functions:

ajFilenameExists	Returns true if file exists and is read or write or executable by the user as determined by AJ_FILE_R AJ_FILE_W AJ_FILE_X file modes
ajFilenameExistsDir	Returns true if file exists and is a directory
ajFilenameExistsExec	Returns true if file exists and is executable by the user
ajFilenameExistsRead	Returns true if file exists and is readable by the user
ajFilenameExistsWrite	Returns true if file exists and is writable by the user
ajFilenameGetSize	Returns the length of a file
ajFilenameHasPath	Tests whether a filename includes a directory specification.
ajFilenameTestExclude	Tests a filename against wildcard lists of file names to be included and excluded.
ajFilenameTestExcludePath	Tests a full path filename against wildcard lists of file names to be included and excluded.
ajFilenameTestInclude	Tests a filename against wildcard lists of file names to be included and excluded.
ajFilenameTestIncludePath	Tests a filename against wildcard lists of file names to be included and excluded.

Function ajFilenameExists

Prototype

AjBool ajFilenameExists (
      const AjPStr filename
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	Filename.
AjBool		RETURN	ajTrue on success

From EMBOSS 6.0.0

Function ajFilenameExistsDir

Prototype

AjBool ajFilenameExistsDir (
      const AjPStr filename
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	Filename.
AjBool		RETURN	ajTrue on success

From EMBOSS 6.0.0

Function ajFilenameExistsExec

Prototype

AjBool ajFilenameExistsExec (
      const AjPStr filename
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	Filename.
AjBool		RETURN	ajTrue on success

From EMBOSS 6.0.0

Function ajFilenameExistsRead

Prototype

AjBool ajFilenameExistsRead (
      const AjPStr filename
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	Filename.
AjBool		RETURN	ajTrue on success

From EMBOSS 6.0.0

Function ajFilenameExistsWrite

Prototype

AjBool ajFilenameExistsWrite (
      const AjPStr filename
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	Filename.
AjBool		RETURN	ajTrue on success

From EMBOSS 6.0.0

Function ajFilenameGetSize

Prototype

ajlong ajFilenameGetSize (
      const AjPStr filename
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	Filename.
ajlong		RETURN	length or -1 if file doesn't exist

From EMBOSS 6.0.0

Function ajFilenameHasPath

Prototype

AjBool ajFilenameHasPath (
      const AjPStr filename
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	File name.
AjBool		RETURN	ajTrue if directory filename syntax was found

From EMBOSS 6.0.0

Function ajFilenameTestExclude

Prototype

AjBool ajFilenameTestExclude (
      const AjPStr filename,
      const AjPStr exclude,
      const AjPStr include
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	File to test
const AjPStr	exclude	Input	List of wildcard names to exclude
const AjPStr	include	Input	List of wildcard names to include
AjBool		RETURN	ajTrue if the filename is accepted.

From EMBOSS 6.0.0

Function ajFilenameTestExcludePath

Prototype

AjBool ajFilenameTestExcludePath (
      const AjPStr filename,
      const AjPStr exclude,
      const AjPStr include
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	File to test
const AjPStr	exclude	Input	List of wildcard names to exclude
const AjPStr	include	Input	List of wildcard names to include
AjBool		RETURN	ajTrue if the filename is accepted.

From EMBOSS 6.0.0

Function ajFilenameTestInclude

Prototype

AjBool ajFilenameTestInclude (
      const AjPStr filename,
      const AjPStr exclude,
      const AjPStr include
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	File to test
const AjPStr	exclude	Input	List of wildcard names to exclude
const AjPStr	include	Input	List of wildcard names to include
AjBool		RETURN	ajTrue if the filename is accepted.

From EMBOSS 6.0.0

Function ajFilenameTestIncludePath

Prototype

AjBool ajFilenameTestIncludePath (
      const AjPStr filename,
      const AjPStr exclude,
      const AjPStr include
);

Type	Name	Read/Write	Description
const AjPStr	filename	Input	File to test
const AjPStr	exclude	Input	List of wildcard names to exclude
const AjPStr	include	Input	List of wildcard names to include
AjBool		RETURN	ajTrue if the filename is accepted.

From EMBOSS 6.0.0

AjPStr: Filename modifiers

Functions:

ajFilenameReplaceExtC	Replaces the extension part of a filename
ajFilenameReplaceExtS	Replaces the extension part of a filename
ajFilenameReplacePathC	Sets the directory part of a filename
ajFilenameReplacePathS	Sets the directory part of a filename
ajFilenameSetExtC	Sets the extension part of a filename
ajFilenameSetExtS	Sets the extension part of a base filename
ajFilenameSetTempname	Returns an available temporary filename that can be opened for writing Filename will be of the form progname-time.randomnumber Tries 5 times to find a new filename. Returns ajFalse if not successful or the file cannot be opened for writing. This function returns only the filename, not a file pointer.
ajFilenameSetTempnamePathC	Returns an available temporary filename that can be opened for writing Filename will be of the form progname-time.randomnumber Tries 5 times to find a new filename. Returns ajFalse if not successful or the file cannot be opened for writing. This function returns only the filename, not a file pointer.
ajFilenameSetTempnamePathS	Returns an available temporary filename that can be opened for writing Filename will be of the form progname-time.randomnumber Tries 5 times to find a new filename. Returns ajFalse if not successful or the file cannot be opened for writing. This function returns only the filename, not a file pointer.
ajFilenameTrimAll	Truncates a filename to a basic file name.
ajFilenameTrimExt	Trims the extension (if any) from a filename
ajFilenameTrimPath	Trims the directory path (if any) from a filename
ajFilenameTrimPathExt	Trims the directory path (if any) and extension (if any) from a filename.

Function ajFilenameReplaceExtC

Prototype

AjBool ajFilenameReplaceExtC (
      AjPStr* Pfilename,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Modify	Filename.
const char*	txt	Input	New file extension
AjBool		RETURN	ajTrue if the replacement succeeded.

From EMBOSS 6.0.0

Function ajFilenameReplaceExtS

Prototype

AjBool ajFilenameReplaceExtS (
      AjPStr* Pfilename,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Modify	Filename.
const AjPStr	str	Input	New file extension
AjBool		RETURN	ajTrue if the replacement succeeded.

From EMBOSS 6.0.0

Function ajFilenameReplacePathC

Prototype

AjBool ajFilenameReplacePathC (
      AjPStr* Pfilename,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Modify	Filename.
const char*	txt	Input	Directory
AjBool		RETURN	ajTrue if the replacement succeeded.

From EMBOSS 6.0.0

Function ajFilenameReplacePathS

Prototype

AjBool ajFilenameReplacePathS (
      AjPStr* Pfilename,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Modify	Filename.
const AjPStr	str	Input	New directory
AjBool		RETURN	ajTrue if the replacement succeeded.

From EMBOSS 6.0.0

Function ajFilenameSetExtC

Prototype

AjBool ajFilenameSetExtC (
      AjPStr* Pfilename,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Modify	Filename.
const char*	txt	Input	New file extension
AjBool		RETURN	ajTrue if the replacement succeeded.

From EMBOSS 6.3.0

Function ajFilenameSetExtS

Prototype

AjBool ajFilenameSetExtS (
      AjPStr* Pfilename,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Modify	Filename.
const AjPStr	str	Input	New file extension
AjBool		RETURN	ajTrue if the replacement succeeded.

From EMBOSS 6.3.0

Function ajFilenameSetTempname

Prototype

AjBool ajFilenameSetTempname (
      AjPStr* Pfilename
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Output	Filename of new temporary file
AjBool		RETURN	True on success

From EMBOSS 6.0.0

Function ajFilenameSetTempnamePathC

Prototype

AjBool ajFilenameSetTempnamePathC (
      AjPStr* Pfilename,
      const char* txt
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Output	Filename of new temporary file
const char*	txt	Input	Directory path
AjBool		RETURN	True on success

From EMBOSS 6.0.0

Function ajFilenameSetTempnamePathS

Prototype

AjBool ajFilenameSetTempnamePathS (
      AjPStr* Pfilename,
      const AjPStr str
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Output	Filename of new temporary file
const AjPStr	str	Input	Directory path
AjBool		RETURN	True on success

From EMBOSS 6.0.0

Function ajFilenameTrimAll

Prototype

AjBool ajFilenameTrimAll (
      AjPStr* Pfilename
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Modify	File name
AjBool		RETURN	ajTrue on success, and returns a filename. ajFalse on failure, and returns an empty string.

From EMBOSS 6.0.0

Function ajFilenameTrimExt

Prototype

AjBool ajFilenameTrimExt (
      AjPStr* Pfilename
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Modify	Filename
AjBool		RETURN	ajTrue is there was an extension

From EMBOSS 6.0.0

Function ajFilenameTrimPath

Prototype

AjBool ajFilenameTrimPath (
      AjPStr* Pfilename
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Modify	Filename
AjBool		RETURN	ajTrue is there was a directory

From EMBOSS 6.0.0

Function ajFilenameTrimPathExt

Prototype

AjBool ajFilenameTrimPathExt (
      AjPStr* Pfilename
);

Type	Name	Read/Write	Description
AjPStr*	Pfilename	Modify	Filename
AjBool		RETURN	ajTrue is there was a directory path or extension.

From EMBOSS 6.0.0

AjPStr: Directory name modifiers

Functions:

ajDirnameFillPath	Checks that a string is a valid directory, and makes sure it has the full path definition.
ajDirnameFix	If the directory name has no trailing slash (on Unix) then one is added. This is why the directory name must be writable.
ajDirnameFixExists	Checks that a string is a valid existing directory, and appends a trailing '/' if it is missing.
ajDirnameUp	Changes directory name to one level up

Function ajDirnameFillPath

Prototype

AjBool ajDirnameFillPath (
      AjPStr* Pdirname
);

Type	Name	Read/Write	Description
AjPStr*	Pdirname	Modify	Directory path
AjBool		RETURN	true if a valid directory.

From EMBOSS 6.0.0

Function ajDirnameFix

Prototype

void ajDirnameFix (
      AjPStr* Pdirname
);

Type	Name	Read/Write	Description
AjPStr*	Pdirname	Modify	Directory name.
void		RETURN

From EMBOSS 6.0.0

Function ajDirnameFixExists

Prototype

AjBool ajDirnameFixExists (
      AjPStr* Pdirname
);

Type	Name	Read/Write	Description
AjPStr*	Pdirname	Modify	Directory path
AjBool		RETURN	true if a valid directory.

From EMBOSS 6.0.0

Function ajDirnameUp

Prototype

AjBool ajDirnameUp (
      AjPStr* Pdirname
);

Type	Name	Read/Write	Description
AjPStr*	Pdirname	Modify	Directory name.
AjBool		RETURN	ajTrue on success.

From EMBOSS 6.0.0

AjPStr: Directory name functions

Functions:

ajDirnamePrintRecursiveIgnore

Recursively scan through a directory, printing directory and file names

Function ajDirnamePrintRecursiveIgnore

Prototype

void ajDirnamePrintRecursiveIgnore (
      const AjPStr path,
      AjPList ignorelist,
      AjPFile outfile
);

Type	Name	Read/Write	Description
const AjPStr	path	Input	Directory to scan
AjPList	ignorelist	Modify	List of directories to ignore
AjPFile	outfile	Modify	File for "show" results (or NULL)
void		RETURN

From EMBOSS 6.0.0

Datatype: AjPlist

Sections:

File list addition

Modifiers

AjPlist: File list addition

Functions:

ajFilelistAddDirectory	Scan through a directory object returning all filenames that are not directories. Uses the file extension and any other attributes of the directory object. An empty string as a file extension accepts only files that have no extension.
ajFilelistAddListname	Adds to a list of files that match a comma-separated string of filenames which can include wildcards or listfiles
ajFilelistAddPath	Scan through a directory returning all filenames excluding directory names
ajFilelistAddPathDir	Scan through a directory returning all filenames and directory names except '.' and '..', including directories
ajFilelistAddPathWild	Scan through a directory returning all filenames matching a wildcard filename
ajFilelistAddPathWildDir	Scan through a directory returning all filenames matching a wildcard filename, including directories
ajFilelistAddPathWildRecursiveIgnore	Recursively scan through a directory

Function ajFilelistAddDirectory

Prototype

ajint ajFilelistAddDirectory (
      AjPList list,
      const AjPDir dir
);

Type	Name	Read/Write	Description
AjPList	list	Modify	List for matching entries
const AjPDir	dir	Input	Directory to scan
ajint		RETURN	number of entries in list

From EMBOSS 6.3.0

Function ajFilelistAddListname

Prototype

ajint ajFilelistAddListname (
      AjPList list,
      const AjPStr listname
);

Type	Name	Read/Write	Description
AjPList	list	Modify	List of filenames
const AjPStr	listname	Input	comma-separated filename list
ajint		RETURN	Number of entries added to list

From EMBOSS 6.0.0

Function ajFilelistAddPath

Prototype

ajint ajFilelistAddPath (
      AjPList list,
      const AjPStr path
);

Type	Name	Read/Write	Description
AjPList	list	Modify	List for matching entries
const AjPStr	path	Input	Directory to scan
ajint		RETURN	number of entries in list

From EMBOSS 6.0.0

Function ajFilelistAddPathDir

Prototype

ajint ajFilelistAddPathDir (
      AjPList list,
      const AjPStr path
);

Type	Name	Read/Write	Description
AjPList	list	Modify	List for matching entries
const AjPStr	path	Input	Directory to scan
ajint		RETURN	number of entries in list

From EMBOSS 6.0.0

Function ajFilelistAddPathWild

Prototype

ajint ajFilelistAddPathWild (
      AjPList list,
      const AjPStr path,
      const AjPStr wildname
);

Type	Name	Read/Write	Description
AjPList	list	Output	List for matching entries
const AjPStr	path	Input	Directory to scan
const AjPStr	wildname	Input	Filename to search for
ajint		RETURN	number of entries in list

From EMBOSS 6.0.0

Function ajFilelistAddPathWildDir

Prototype

ajint ajFilelistAddPathWildDir (
      AjPList list,
      const AjPStr path,
      const AjPStr wildname
);

Type	Name	Read/Write	Description
AjPList	list	Output	List for matching entries
const AjPStr	path	Input	Directory to scan
const AjPStr	wildname	Input	Filename to search for
ajint		RETURN	number of entries in list

From EMBOSS 6.0.0

Function ajFilelistAddPathWildRecursiveIgnore

Prototype

ajint ajFilelistAddPathWildRecursiveIgnore (
      AjPList list,
      const AjPStr path,
      const AjPStr wildname,
      AjPList ignorelist
);

Type	Name	Read/Write	Description
AjPList	list	Modify	List for matching filenames
const AjPStr	path	Input	Directory to scan
const AjPStr	wildname	Input	Filename to search for (or NULL)
AjPList	ignorelist	Modify	List of directories to ignore
ajint		RETURN	number of new entries in list

From EMBOSS 6.0.0

Datatype: none

Sections:

Internal values

Miscellaneous

Section: Internal values

Functions:

ajFileValueBuffsize	Returns the default buffer size for a file
ajFileValueCwd	Returns the current directory
ajFileValueRedirectStderr	Tests whether stderr is in use by an internal file
ajFileValueRedirectStdin	Tests whether stdin is in use by an internal file
ajFileValueRedirectStdout	Tests whether stdout is in use by an internal file

Function ajFileValueBuffsize

Prototype

ajuint ajFileValueBuffsize (
      void
);

Type	Name	Read/Write	Description
ajuint		RETURN	Buffer size default value

From EMBOSS 6.0.0

Function ajFileValueCwd

Prototype

const AjPStr ajFileValueCwd (
      void
);

Type	Name	Read/Write	Description
const AjPStr		RETURN	Directory name.

From EMBOSS 6.0.0

Function ajFileValueRedirectStderr

Prototype

AjBool ajFileValueRedirectStderr (
      void
);

Type	Name	Read/Write	Description
AjBool		RETURN	ajTrue if the file matches stderr.

From EMBOSS 6.0.0

Function ajFileValueRedirectStdin

Prototype

AjBool ajFileValueRedirectStdin (
      void
);

Type	Name	Read/Write	Description
AjBool		RETURN	ajTrue if the file matches stdin.

From EMBOSS 6.0.0

Function ajFileValueRedirectStdout

Prototype

AjBool ajFileValueRedirectStdout (
      void
);

Type	Name	Read/Write	Description
AjBool		RETURN	ajTrue if the file matches stdout.

From EMBOSS 6.0.0