ift.c File Reference

Functions for basic processing of IFT data structure. More...

#include "libtpcmisc.h"

Go to the source code of this file.

Functions
void	iftSetStatus (IFT *ift, int status)
void	iftInit (IFT *ift)
void	iftEmpty (IFT *ift)
int	iftPut (IFT *ift, char *key, char *value, char *cmt_type, int verbose)
int	iftPutDouble (IFT *ift, char *key, double value, char *cmt_type, int verbose)
int	iftDeleteItem (IFT *ift, int item, int verbose)
int	iftReplaceNthValue (IFT *ift, int item, char *value, int verbose)
int	iftdup (IFT *ift1, IFT *ift2, int verbose)

Detailed Description

Functions for basic processing of IFT data structure.

Author

Vesa Oikonen

Definition in file ift.c.

Function Documentation

iftDeleteItem()

int iftDeleteItem	(	IFT *	ift,
		int	item,
		int	verbose )

Remove the specified item from IFT.

Returns

0 if ok.

See also

iftPut, iftEmpty, iftReplaceNthValue

Parameters

ift	Pointer to IFT structure.
item	Index [0..keyNr-1] of key and value to delete.
verbose	Verbose level; if zero, then only warnings are printed into stderr

Definition at line 169 of file ift.c.

  {
  int i;
 
  if(verbose>0) printf("%s(*ift, %d)\n", __func__, item);
  if(ift==NULL) return(1);
  iftSetStatus(ift, IFT_FAULT);
  if(ift==NULL) {return(1);}
  if(item<0 || item>=ift->keyNr) {return(2);}
 
  if(ift->item[item].key!=NULL) free(ift->item[item].key);
  if(ift->item[item].value!=NULL) free(ift->item[item].value);
  ift->item[item].key=ift->item[item].value=NULL;
  for(i=item+1; i<ift->keyNr; i++) {
    ift->item[i-1].type=ift->item[i].type;
    ift->item[i-1].sw=ift->item[i].sw;
    ift->item[i-1].key=ift->item[i].key;
    ift->item[i-1].value=ift->item[i].value;
    ift->item[i].key=ift->item[i].value=NULL;
  }
  ift->keyNr--;
  iftSetStatus(ift, IFT_OK);
  return(0);
}

Referenced by ecat7CopyHeadersNoQuant().

iftdup()

int iftdup	(	IFT *	ift1,
		IFT *	ift2,
		int	verbose )

Make a copy (duplicate) of IFT structure.

Returns

Returns 0 (IFT_OK) when successful, otherwise an appropriate ift status code.

See also

iftInit, iftRead, iftPut, iftEmpty

Parameters

ift1	Pointer to IFT structure to be copied.
ift2	Pointer to initiated IFT structure; any previous contents are deleted.
verbose	Verbose level; if zero, then only warnings are printed into stderr

Definition at line 235 of file ift.c.

  {
  int ret, li;
 
  if(verbose>0) printf("%s(*ift1, *ift2)\n", __func__);
  /* Check the input */
  if(ift1==NULL || ift2==NULL) return IFT_FAULT;
 
  /* Empty the new IFT */
  iftEmpty(ift2);
 
  /* Copy the contents */
  ift2->type=ift1->type;
  ift2->status=ift1->status;
  for(li=0; li<ift1->keyNr; li++) {
    ret=iftPut(ift2, ift1->item[li].key, ift1->item[li].value, NULL, verbose);
    if(ret!=IFT_OK) {iftEmpty(ift2); return(ret);} 
    ift2->item[li].type=ift1->item[li].type;
    ift2->item[li].sw=ift1->item[li].sw;
  }
  // keyNr was set by iftPut()
  return IFT_OK;
}

Referenced by imgCopyhdr().

iftEmpty()

void iftEmpty

(

IFT *

ift

)

Free memory allocated for IFT. All contents are destroyed.

See also

iftInit

Parameters

ift	Pointer to target IFT structure.

Definition at line 60 of file ift.c.

  {
  if(ift==NULL) return;
  for(int i=0; i<ift->_memNr; i++) {
    if(ift->item[i].key!=NULL) free(ift->item[i].key);
    if(ift->item[i].value!=NULL) free(ift->item[i].value);
  }
  free(ift->item); ift->item=NULL; ift->_memNr=ift->keyNr=0;
  ift->data=NULL; ift->datasize=0;
}

Referenced by cptReadOne(), defRead(), dftRead(), ehdrEmpty(), ematEmpty(), hrrtMakeCalHdr(), iftdup(), iftRead(), iftReadValue(), imgEmpty(), imgReadMicropetFrame(), imgReadMicropetHeader(), interfileIsHeader(), irdRead(), niftiHeaderToIFT(), readEcat931Calibrationfile(), res2ift(), tsvRead(), vrdRead(), and xelRead().

iftInit()

void iftInit

(

IFT *

ift

)

Initiate IFT structure. This should be called once before first use.

See also

iftEmpty, iftRead, iftPut

Parameters

ift	Pointer to target IFT structure.

Definition at line 45 of file ift.c.

  {
  if(ift==NULL) return;
  memset(ift, 0, sizeof(IFT));
  ift->_memNr=ift->keyNr=0; ift->item=NULL;
  ift->data=NULL; ift->datasize=0;
}

Referenced by cptReadOne(), dftRead(), ehdrInitiate(), ematInitiate(), hrrtMakeCalHdr(), iftReadValue(), imgInit(), interfileIsHeader(), irdRead(), readEcat931Calibrationfile(), tsvRead(), vrdRead(), and xelRead().

iftPut()

int iftPut	(	IFT *	ift,
		char *	key,
		char *	value,
		char *	cmt_type,
		int	verbose )

Add specified key and its value to the IFT.

Also comment type (first character pointed to) can be added. Either key or value can be empty, but not both of them.

Returns

Returns 0 if ok. Sets ift->status.

See also

iftInit, iftEmpty, iftPutDouble, iftDeleteItem

Parameters

ift	Pointer to initiated IFT; previous contents are not changed
key	Key string; can be empty ("" or NULL)
value	Value string; can be empty ("" or NULL)
cmt_type	Pointer to comment character, e.g. '#' or ';' or '!'; can be empty ("" or NULL)
verbose	Verbose level; if zero, then only warnings are printed into stderr

Definition at line 82 of file ift.c.

  {
  int i, add_nr=1000;
 
  if(ift==NULL) {return(1);}
  if((key==NULL || strlen(key)<1) && (value==NULL || strlen(value)<1)) {
    iftSetStatus(ift, IFT_FAULT); return(2);}
  if(verbose>0) {
    printf("%s(ift, ", __func__);
    if(key!=NULL) printf("\"%s\", ", key); else printf("NULL, ");
    if(value!=NULL) printf("\"%s\", ", value); else printf("NULL, ");
    if(cmt_type!=NULL) printf("\"%1.1s\")\n", cmt_type); else printf("NULL)\n");
  }
 
  /* If necessary, allocate more memory for items */
  if(ift->_memNr<=ift->keyNr) {
    ift->item=realloc(ift->item, (ift->_memNr+add_nr)*sizeof(IFT_KEY_AND_VALUE));
    if(ift->item==NULL) {iftSetStatus(ift, IFT_NOMEMORY); return(5);}
    ift->_memNr+=add_nr;
    for(i=ift->keyNr; i<ift->_memNr; i++) {
      ift->item[i].type=(char)0;
      ift->item[i].sw=(short int)0;
      ift->item[i].key=NULL;
      ift->item[i].value=NULL;
    }
  }
  
  /* Set the contents */
  /* type */
  if(cmt_type!=NULL) ift->item[ift->keyNr].type=cmt_type[0];
  /* key */
  if(key!=NULL) ift->item[ift->keyNr].key=strdup(key);
  else ift->item[ift->keyNr].key=strdup("");
  if(ift->item[ift->keyNr].key==NULL) {iftSetStatus(ift, IFT_NOMEMORY); return(7);}
  /* value */
  if(value!=NULL) ift->item[ift->keyNr].value=strdup(value);
  else ift->item[ift->keyNr].value=strdup("");
  if(ift->item[ift->keyNr].value==NULL) {iftSetStatus(ift, IFT_NOMEMORY); return(8);}
 
  ift->keyNr++;
  iftSetStatus(ift, IFT_OK);
  return(0);
}

Referenced by defRead(), ecat7ImageheaderToIFT(), ecat7MHeaderToIFT(), ecat7ScanheaderToIFT(), hrrtMakeCalHdr(), iftdup(), iftPutDouble(), iftRead(), niftiHeaderToIFT(), and res2ift().

iftPutDouble()

int iftPutDouble	(	IFT *	ift,
		char *	key,
		double	value,
		char *	cmt_type,
		int	verbose )

Add specified key and its floating point (double) value to the IFT.

Also comment type (first character pointed to) can be added. Key can be empty.

Returns

Returns 0 if ok. Sets ift->status.

See also

iftPut

Parameters

ift	Pointer to initiated IFT; previous contents are not changed
key	Key string; can be empty ("" or NULL)
value	Value as double
cmt_type	Pointer to comment character, e.g. '#' or ';' or '!'; can be empty ("" or NULL)
verbose	Verbose level; if zero, then only warnings are printed into stderr

Definition at line 145 of file ift.c.

  {
  char dstr[128];
  sprintf(dstr, "%g", value);
  return(iftPut(ift, key, dstr, cmt_type, verbose));
}

Referenced by hrrtMakeCalHdr().

iftReplaceNthValue()

int iftReplaceNthValue	(	IFT *	ift,
		int	item,
		char *	value,
		int	verbose )

Replaces specified value in IFT with a new value.

Returns

0 if ok.

See also

iftDeleteItem, iftPut

Parameters

ift	Pointer to IFT structure.
item	Index [0..keyNr-1] of key and value.
value	Value string; can be empty ("" or NULL).
verbose	Verbose level; if zero, then only warnings are printed into stderr

Definition at line 206 of file ift.c.

  {
  if(ift==NULL) {return(1);}
  if(item>=ift->keyNr) {iftSetStatus(ift, IFT_FAULT); return(2);}
  if(verbose>0) printf("%s(ift, %d, %s)\n", __func__, item, value);
  /* Delete old value */
  if(ift->item[item].value!=NULL) free(ift->item[item].value);
  /* Set new value */
  if(value!=NULL) ift->item[item].value=strdup(value);
  else ift->item[item].value=strdup("");
  if(ift->item[item].value==NULL) {iftSetStatus(ift, IFT_NOMEMORY); return(8);}
  iftSetStatus(ift, IFT_OK);
  return(0);
}

iftSetStatus()

void iftSetStatus	(	IFT *	ift,
		int	status )

Sets IFT status

Parameters

ift	Pointer to target IFT structure.
status	New status value.

Definition at line 29 of file ift.c.

  {
  if(ift==NULL) return;
  if(status<0 || status>8) ift->status=ift_status[IFT_FAULT];
  else ift->status=ift_status[status];
}

Referenced by defRead(), iftDeleteItem(), iftFindNthKey(), iftFindNthValue(), iftGet(), iftGetDoubleValue(), iftGetFloatValue(), iftGetFrom(), iftGetFullmatchFrom(), iftGetIntValue(), iftGetKeyNr(), iftGetNth(), iftPut(), iftRead(), iftReplaceNthValue(), iftWrite(), and iftWriteItem().