EsoRex File Utility Functions

Functions
const char *	er_fileutils_tilde_replace (const char *name)
	Replaces the leading tilde (~) in a name.
const char *	er_fileutils_dot_replace (const char *name)
	Replaces the leading dot (.) in a name.
int	fileutils_directory_exists (const char *directory_name)
	Checks whether the given directory actually exists.
int	fileutils_file_exists (const char *file_name)
	Checks whether the given file actually exists.
char *	fileutils_create_fqfname (char *dir_name, char *file_name)
	Creates a Fully Qualified File Name based on a directory name and a filename.
char *	fileutils_fqfname_filename (const char *path)
	Extracts filename from a Fully Qualified File Name.
char *	fileutils_fqfname_dirname (const char *path)
	Extracts directoryname from a Fully Qualified File Name.
int	er_fileutils_file_is_fits (const char *name)
	Determine whether a given file is a FITS file.

Detailed Description

Utility functions for hadling files.

Function Documentation

er_fileutils_dot_replace()

const char * er_fileutils_dot_replace

(

const char *

name

)

Replaces the leading dot (.) in a name.

Parameters

name	The input file name/path string

Returns

A string with the replaced ".".

This function takes an input string. If the string begins with a single dot (.), then the function returns this string, but with the dot replaced by the current working directory (as an absolute path) using the $PWD environment variable. If not, then the string is returned unmodified.

OJO: this routine returns a pointer to a static string, if you need the returned filename later on, you must copy it to a string of PATHSET_MAX length otherwise the returned pointer may point later on to something very different :-(

er_fileutils_file_is_fits()

int er_fileutils_file_is_fits

(

const char *

name

)

Determine whether a given file is a FITS file.

Parameters

name	The name of the fits

Returns

1 if the file is FITS, 0 if not, negative on error

er_fileutils_tilde_replace()

const char * er_fileutils_tilde_replace

(

const char *

name

)

Replaces the leading tilde (~) in a name.

Parameters

name	The input file name/path string

Returns

A string with the replaced tilde.

This function takes an input string. If the string begins with a tilde (~), then the function returns this string, but with the tilde replaced by the home directory of the current user (using the $HOME environment variable). If not, then the string is returned unmodified. This function also cleans up any multiple or trailing forward-slashes.

This function also performs the replacement of any environment variables.

OJO: this routine returns a pointer to a static string, if you need the returned filename later on, you must copy it to a string of PATHSET_MAX length otherwise the returned pointer may point later on to something very different :-(

fileutils_create_fqfname()

char * fileutils_create_fqfname	(	char *	dir_name,
		char *	file_name
	)

Creates a Fully Qualified File Name based on a directory name and a filename.

Parameters

dir_name	Directory
file_name	File

Returns

A newly allocated string containing FQFN

fileutils_directory_exists()

int fileutils_directory_exists

(

const char *

directory_name

)

Checks whether the given directory actually exists.

Parameters

directory_name

Directory

Returns

TRUE if directory exists, FALSE otherwise

fileutils_file_exists()

int fileutils_file_exists

(

const char *

file_name

)

Checks whether the given file actually exists.

Parameters

file_name

Filename

Returns

1 if file exists, 0 otherwise

fileutils_fqfname_dirname()

char * fileutils_fqfname_dirname

(

const char *

path

)

Extracts directoryname from a Fully Qualified File Name.

Parameters

path

FQFN

Returns

A newly allocated string containing directoryname

fileutils_fqfname_filename()

char * fileutils_fqfname_filename

(

const char *

path

)

Extracts filename from a Fully Qualified File Name.

Parameters

path

FQFN

Returns

A newly allocated string containing Filename