statusmsg.c File Reference

Status information for library functions. More...

#include "tpcclibConfig.h"
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
#include <string.h>
#include "tpcextensions.h"

Go to the source code of this file.

Functions
char *	errorMsg (tpcerror e)
void	statusPrint (FILE *fp, TPCSTATUS *s)
void	statusInit (TPCSTATUS *s)
void	statusFree (TPCSTATUS *s)
void	statusSet (TPCSTATUS *s, const char *func, const char *srcfile, int srcline, tpcerror error)

Detailed Description

Status information for library functions.

Definition in file statusmsg.c.

Function Documentation

errorMsg()

char * errorMsg

(

tpcerror

e

)

Return pointer to error message specified with the error code.

Returns

pointer to the error message string.

See also

tpcerror, statusPrint

Author

Vesa Oikonen

Parameters

e	Error code

See also

tpcerror.

Definition at line 68 of file statusmsg.c.

  {
  if(e<TPCERROR_OK || e>=TPCERROR_LAST) return NULL;
  return tpcerrormsg[e];
}

Referenced by imgRead(), and nloptIATGO().

statusFree()

void statusFree

(

TPCSTATUS *

s

)

After last use, free any memory allocated in the structure.

See also

errorMsg, statusSet, statusInit

Parameters

s	Pointer to status.

Definition at line 126 of file statusmsg.c.

  {
  if(s==NULL) return;
  free(s->last_file); free(s->last_func);
  free(s->current_file); free(s->current_func);
  if(s->fp!=NULL && s->fp!=stdout && s->fp!=stderr) fclose(s->fp);
  statusInit(s);
}

statusInit()

void statusInit

(

TPCSTATUS *

s

)

Before first use, initialize the structure contents using this function. After last use of status structure, call statusFree(), which also calls this function to re-initiate the structure contents.

See also

errorMsg, statusSet, statusFree

Parameters

s	Pointer to status.

Definition at line 104 of file statusmsg.c.

  {
  if(s==NULL) return;
  s->last_line=0;
  s->last_file=NULL;
  s->last_func=NULL;
  s->current_line=0;
  s->current_file=NULL;
  s->current_func=NULL;
  s->verbose=0;
  s->fp=stdout;
  s->forgiving=0;
  s->error=0;
}

Referenced by statusFree().

statusPrint()

void statusPrint	(	FILE *	fp,
		TPCSTATUS *	s )

Print the contents of status structure.

Author

Vesa Oikonen

See also

statusSet, errorMsg, statusInit, statusFree

Parameters

fp	File pointer for the output.
s	Pointer to status.

Definition at line 82 of file statusmsg.c.

  {
  if(fp==NULL || s==NULL) return;
  if(s->current_file!=NULL && s->current_func!=0 && s->current_line>0)
    fprintf(fp, "In %s() on line %d of file %s\n", s->current_func, s->current_line, s->current_file);
  if(s->verbose<=0) return;
  if(s->last_file!=NULL && s->last_func!=0 && s->last_line>0)
    fprintf(fp, "called in %s() on line %d of file %s\n", s->last_func, s->last_line, s->last_file);
  return;
}

statusSet()

void statusSet	(	TPCSTATUS *	s,
		const char *	func,
		const char *	srcfile,
		int	srcline,
		tpcerror	error )

Set the status contents.

See also

statusInit, statusFree, errorMsg, tpcProgramName, tpcProcessStdOptions

Parameters

s	Pointer to status.
func	Pointer to function name, usually func.
srcfile	Pointer to source file name, usually FILE.
srcline	Pointer to source file line number, usually LINE.
error	Error code, 0 if status is ok.

Definition at line 142 of file statusmsg.c.

  {
  if(s==NULL) return;
  s->error=error;
  /* Delete any previous content */
  s->last_line=0;
  free(s->last_file); free(s->last_func);
  s->last_file=NULL; s->last_func=NULL;
  /* Move current content to previous */
  s->last_line=s->current_line;
  s->last_file=s->current_file;
  s->last_func=s->current_func;
  /* Set current contents */
  s->current_line=srcline;
  if(func!=NULL) s->current_func=strdup(func);
  if(srcfile!=NULL) s->current_file=strdup(srcfile);
  s->error=error;
}

Referenced by abssWrite(), anaExists(), bfm1TCM(), bfmSRTM(), csvPutLine(), csvPutLineWithSpaces(), csvRead(), csvReorg(), csvWrite(), dcmFileList(), dcmFileRead(), dcmFileRemove(), dcmFileWrite(), dcmMListRead(), dcmmlSortByPlane(), ecatMListRead(), ecatReadMainheader(), ecatWriteMainheader(), iftCopyItems(), iftDeleteDuplicateKeys(), iftPut(), iftPutFromString(), iftPutFromStringWithSpaceSeparator(), iftRead(), iftReplaceKey(), iftReplaceValue(), iftWrite(), iftWriteItem(), imgAllocate(), imgCompareConc(), imgCompareTimes(), imgCompareUnit(), imgFillOHeader(), imgRead(), imgReadDICOM(), imgReadNifti(), imgWrite(), imgWriteDICOM(), imgWriteNifti(), micropetExists(), micropetHeaderRead(), mtgaPlotSVG(), niftiExists(), nlopt1D(), nloptIATGO(), nloptITGO1(), nloptITGO2(), nloptMPSO(), nloptPowellBrent(), nloptSimplex(), nloptSimplexARRS(), parAllocateWithTAC(), parCombineTACs(), parCompareParameterNames(), parCompareParameters(), parCompareParameterUnits(), parCompareTacNames(), parCompareWSS(), parExamplePerfectBolus(), parExampleTTACs(), parFromIFT(), parRead(), parReadCSV(), parReadFIT(), parReadRES(), parSelectByAnother(), parSelectParameters(), parSelectTACs(), parSortByName(), parToIFT(), parWrite(), parWriteCSV(), parWriteFIT(), parWriteIFT(), parWriteRES(), parWriteXML(), roinameMatch(), sifWeight(), spectralDExp(), spectralKRange(), tacAddZeroSample(), tacAllocateWithPAR(), tacAUC(), tacCompareConc(), tacCompareNames(), tacCompareTimes(), tacCompareUnit(), tacCompareWeights(), tacCorrectFrameOverlap(), tacDecayCorrection(), tacDelay(), tacFittime(), tacFormatDetermine(), tacFramesToSteps(), tacGetHeaderInjectiontime(), tacGetHeaderIsotope(), tacGetHeaderScanstarttime(), tacGetHeaderStudynr(), tacGetHeaderTimeunit(), tacGetHeaderUnit(), tacInput2sim(), tacIntegrate(), tacInterpolate(), tacInterpolateInto(), tacInterpolateToEqualLengthFrames(), tacPlotFitSVG(), tacPlotHistogramSVG(), tacPlotLineSVG(), tacRead(), tacRead4DM(), tacReadAllogg(), tacReadCarimasTxt(), tacReadCSV(), tacReadDFT(), tacReadGEMS(), tacReadHRPLUSHC(), tacReadHRRTHC(), tacReadInveonCSV(), tacReadMat(), tacReadModelingData(), tacReadModelingInput(), tacReadOldAllogg(), tacReadPMOD(), tacReadQView(), tacReadReference(), tacReadScanditronics(), tacReadSIF(), tacReadSimple(), tacSelectTACs(), tacSetWeights(), tacSetX(), tacSortByAUC(), tacSortByConc(), tacSortByName(), tacSortByTime(), tacToPAR(), tacVb(), tacVerifyTimeOrder(), tacWByFreq(), tacWeightModerate(), tacWeightNorm(), tacWMove(), tacWrite(), tacWriteCSV(), tacWriteDFT(), tacWritePMOD(), tacWriteSheetIntoXML(), tacWriteSIF(), tacWriteSimple(), tacWriteXML(), tacXUnitConvert(), tacYUnitConvert(), tacYUnitMass2Volume(), and tacYUnitVolume2Mass().