ccp4_program.h File Reference

Header file for utilies to set and fetch program information. More...

Go to the source code of this file.

Defines
#define	CCP4_VERSION_NO   "5.0"
#define	CCP4_PATCH_LEVEL   "5.0.2"
#define	GPP4_VERSION_NO   VERSION
#define	MAXLEN_PROGNAME   80
#define	MAXLEN_PROGVERSION   80
#define	MAXLEN_RCSDATE   80
Functions
char *	ccp4_prog_vers (char *progvers)
char *	ccp4ProgramName (const char *progname)
char *	ccp4RCSDate (const char *rcs_string)
void	ccp4ProgramTime (int init)
int	ccp4VerbosityLevel (int level)
int	ccp4_licence_exists (const char *name)
int	html_log_output (int ihtml_in)
int	summary_output (int isumm_in)

---

Detailed Description

Header file for utilies to set and fetch program information.

Author:

Peter Briggs, CCP4

Date:

May 2001

---

Define Documentation

#define CCP4_PATCH_LEVEL   "5.0.2"

Patch level of CCP4 that gpp4 is derived from

Referenced by ccp4_banner().

#define CCP4_VERSION_NO   "5.0"

Version of CCP4 that gpp4 is derived from

#define GPP4_VERSION_NO   VERSION

GPP4 version is defined by autoconf

Referenced by ccp4_banner(), and ccp4fyp().

#define MAXLEN_PROGNAME   80

Maximum length of program name

Referenced by ccp4ProgramName().

#define MAXLEN_PROGVERSION   80

Maximum length of program version string

Referenced by ccp4_prog_vers().

#define MAXLEN_RCSDATE   80

Maximum length of date string

Referenced by ccp4RCSDate().

---

Function Documentation

int ccp4_licence_exists

(

const char *

name

)

Check existence of licence agreement

Parameters:

name

Name of licence, e.g. "CCP4".

Returns:

always return 1. This is a dummy routine in gpp4.

char* ccp4_prog_vers

(

char *

progvers

)

Register or query program version.

Parameters:

progvers

Program version string, or NULL to query existing value.

Returns:

Program version string.

References MAXLEN_PROGVERSION.

Referenced by ccp4_banner(), and ccp4fyp().

char* ccp4ProgramName

(

const char *

progname

)

Set or return program name.

Parameters:

progname

Program name, or NULL to query existing value.

Returns:

Program name

Always returns a pointer to the program name If progname is not NULL then set the program name to progname.

Note:

Default program name will be returned as "CCP4", until reset by the calling subprogram.

References MAXLEN_PROGNAME.

Referenced by ccp4_banner(), ccp4fyp(), ccp4setenv(), and ccperror_noexit().

void ccp4ProgramTime

(

int

init

)

Set or print program time information

Parameters:

init

The timer is started when this routine is called with a non-zero argument. When the routine is called with a 0 argument, timing information is printed to stdout.

Note:

Only one timer can be handled.

References ccp4_utils_etime().

Referenced by ccp4fyp(), and ccperror_noexit().

char* ccp4RCSDate

(

const char *

rcs_string

)

Set or return program RCS date

Parameters:

rcs_string

Date string, or NULL to query existing value.

Returns:

Date string

If the input string is not a NULL pointer then it is assumed to be an RCS string This is processed to extract a date string in the form "DD/MM/YY" (day/month/year), which is then stored.

ccp4RCSDate always returns the currently stored date string.

Note:

This routine does not make sense in gpp4, since RCS idents are not expanede in the SCM system we are using.

References MAXLEN_RCSDATE.

int ccp4VerbosityLevel

(

int

level

)

Set or return the reference verbosity level

Parameters:

level

Verbosity level, or -1 to query existing value.

Returns:

Verbosity level Always return the verbosity level - if verboselevel is between 0 and 9 then reset the verbosity level to verboselevel

Referenced by ccp4fyp(), and ccp4printf().

int html_log_output

(

int

ihtml_in

)

Register or query html output level.

Parameters:

ihtml_in

0 = turn off html output, 1 = turn on html output, -1 = query existing value

Returns:

0 = no html output, 1 = html output html_log_output and summary_output currently only used by ccperror to tidy up Fortran program output. Defaults are 0 for C programs.

Referenced by ccperror_noexit().

int summary_output

(

int

isumm_in

)

Register or query summary output level.

Parameters:

isumm_in

0 = turn off summary output, 1 = turn on summary output, -1 = query existing value

Returns:

0 = no summary output, 1 = summary output

Referenced by ccperror_noexit().