strext.c File Reference

Utility functions for processing strings. More...

#include "libtpcmisc.h"
#include <string.h>

Go to the source code of this file.

Functions
int	strTokenNr (const char *str1, const char *str2)
int	strTokenNCpy (const char *str1, const char *str2, int i, char *str3, int count)
char *	strTokenDup (const char *s1, const char *s2, int *next)
int	strChrCount (const char *str1, const char *str2)
int	strUppercaseCount (const char *s)
void	strReplaceChar (char *str, char c1, char c2)
size_t	strnlen (const char *s, size_t n)
size_t	strlcat (char *dst, const char *src, size_t dstsize)
size_t	strlcpy (char *dst, const char *src, size_t dstsize)
char *	strcasestr (const char *haystack, const char *needle)
int	strncpyCleanSpaces (char *s1, const char *s2, int maxlen)
int	strCleanSpaces (char *s)
char *	strEncodeForXML (const char *s)
void	strCleanForXML (char *s)

Detailed Description

Utility functions for processing strings.

Author

Vesa Oikonen

Definition in file strext.c.

Function Documentation

strcasestr()

char * strcasestr	(	const char *	haystack,
		const char *	needle )

Case-insensitive version of strstr().

Returns

a pointer to the beginning of the first occurrence, or NULL if not found.

Parameters

haystack	Pointer to string in which sub-string needle is searched.
needle	Pointer to sub-string which is searched for in source string haystack.

Definition at line 279 of file strext.c.

  {
  if(!haystack || !*haystack || !needle || !*needle) return 0;
 
  const char *s=haystack, *p=needle;
  do {
    if(!*p) return(char*)haystack;
    if((*p==*s) || (tolower(*p)==tolower(*s))) {
      p++; s++;
    } else {
      p=needle; if(!*s) return(NULL);
      s=++haystack;
    }
  } while(1);
  return *p ? NULL : (char*)haystack;
}

Referenced by cunitFromFilename(), dftFormat(), iftReadValue(), and resWriteHTML_table().

strChrCount()

int strChrCount	(	const char *	str1,
		const char *	str2 )

Count how many times specified characters are found in a string. Search is case-sensitive.

See also

strTokenNr, strReplaceChar, strUppercaseCount

Returns

Returns the nr of characters of str2 found in str1.

Parameters

str1	String to search for characters; not modified.
str2	String containing characters which are searched for; not modified.

Definition at line 126 of file strext.c.

  {
  unsigned int n=0, i, j;
  if(str1==NULL || str2==NULL || strlen(str1)==0 || strlen(str2)==0) return n;
  for(i=0; i<strlen(str1); i++)
    for(j=0; j<strlen(str2); j++)
      if(str1[i]==str2[j]) n++;
  return n;
}

Referenced by rnameSplit().

strCleanForXML()

void strCleanForXML

(

char *

s

)

Remove from string those characters that would require encoding in XML. Replaced by character '-'.

See also

strEncodeForXML

Parameters

s	Pointer to the string to be cleaned.

Definition at line 402 of file strext.c.

  {
  if(s==NULL || *s=='\0') return;
  strReplaceChar(s, '&', '-');
  strReplaceChar(s, '\'', '-');
  strReplaceChar(s, '\"', '-');
  strReplaceChar(s, '<', '-');
  strReplaceChar(s, '>', '-');
  return;
}

strCleanSpaces()

int strCleanSpaces

(

char *

s

)

Removes any initial and trailing space characters from specified string s.

Space characters in the middle of the string are not removed.

Returns

0 when successful, otherwise >0.

Author

Vesa Oikonen

Parameters

s	Pointer to the string.

Definition at line 343 of file strext.c.

  {
  if(s==NULL) return 0;
  int len=strlen(s); if(len<0) return 0;
  char *s2; s2=strdup(s); if(s2==NULL) return(1);
  int n=strncpyCleanSpaces(s2, s, len+1);
  if(n<1) strcpy(s, ""); else strcpy(s, s2);
  free(s2);
  return 0;
}

Referenced by csvRead().

strEncodeForXML()

char * strEncodeForXML

(

const char *

s

)

Encode special characters for XML, including SVG.

Postcondition

Free the memory of returned string pointer.

Returns

Returns pointer to encoded string. NULL is returned in case of an error, or if encoding is not necessary.

See also

svg_str_encode

Parameters

s	Pointer to the string to be encoded.

Definition at line 364 of file strext.c.

  {
  if(s==NULL) return(NULL);
  /* Count the characters needing encoding */
  int n=0;
  for(size_t i=0; i<strlen(s); i++) {
    if(s[i]=='&') {n++; continue;}
    if(s[i]=='\'') {n++; continue;}
    if(s[i]=='\"') {n++; continue;}
    if(s[i]=='<') {n++; continue;}
    if(s[i]=='>') {n++; continue;}
  }
  if(n==0) return(NULL);
  /* Allocate memory for new string (one char to max 6 chars) */
  n*=5; n+=strlen(s)+1;
  char *ns=(char*)malloc(n*sizeof(char));
  if(ns==NULL) return(NULL);
  /* Process the string */
  for(int i=0; i<n; i++) ns[i]=(char)0;
  for(size_t i=0; i<strlen(s); i++) {
    if(s[i]=='&') {strcat(ns, "&amp;"); continue;}
    if(s[i]=='\'') {strcat(ns, "&apos;"); continue;}
    if(s[i]=='\"') {strcat(ns, "&quot;"); continue;}
    if(s[i]=='<') {strcat(ns, "&lt;"); continue;}
    if(s[i]=='>') {strcat(ns, "&gt;"); continue;}
    ns[strlen(ns)]=s[i];
  }
  return(ns);
}

Referenced by dftWriteHTML(), and resWriteHTML_table().

strlcat()

size_t strlcat	(	char *	dst,
		const char *	src,
		size_t	dstsize )

Safer version of strncat. At most dstsize-1 characters are appended from the source string to destination string. Destination string will be NUL terminated, unless dstsize <= strlen(dst).

Remarks

Included in POSIX but not in GCC.

Returns

the size of the buffer that would have been needed for the destination string; if >=dstsize, then truncation occurred.

Parameters

dst	Destination string.
src	Source string.
dstsize	The actual length of buffer allocated for the destination string; for example, destination string has been allocated as char dst[dstsize];

Definition at line 206 of file strext.c.

  {
  char *d;
  const char *s=src;
  size_t dlen, n;
 
  /* Find the current length of dst */
  dlen=strnlen(dst, dstsize);
  if(s==NULL) return(dlen);
  n=dstsize-dlen;
  if(n==0) return(dlen+strlen(s));
  d=dst+dlen;
  while(*s!='\0') {
    if(n!=1) {*d=*s; d++; n--;}
    s++;
  }
  *d='\0';
  return(dlen+(s-src));
}

Referenced by anaExists(), backupExistingFile(), dftRead(), and hrrtMakeCalHdr().

strlcpy()

size_t strlcpy	(	char *	dst,
		const char *	src,
		size_t	dstsize )

Safer version of strncpy or strcpy.

At most dstsize-1 characters are copied from the source string to the destination string. Destination string will be NUL terminated.

Remarks

Included in POSIX but not in GCC.

Returns

the size of the buffer that would have been needed for the destination string; if >=dstsize, then truncation occurred.

Parameters

dst	Destination string.
src	Source string.
dstsize	The actual length of buffer allocated for the destination string; for example, destination string has been allocated as char dst[dstsize];

Definition at line 245 of file strext.c.

  {
  if(dstsize>0) dst[0]='\0';
  if(strlen(src)==0) return(0);
 
  char *d=dst;
  const char *s=src;
  size_t n;
 
  /* Copy as many chars as allowed */
  n=dstsize;
  if(n!=0) while(--n!=0) {*d=*s; if(*d=='\0') {d++; s++; break;} d++; s++;}
  if(n==0) { // not enough space, add NUL, and check how much space were needed
    if(dstsize!=0) *d='\0';
    while(*s++) {}
  }
  return(s-src-1);
}

Referenced by anaEditHeader(), anaExists(), backupExistingFile(), csv2dft_b(), csv2dft_mat(), dcmAddItem(), dcmFileRead(), dft_fill_hdr_from_IFT(), dftAllocateWithIMG(), dftRead(), dftWrite(), ecat63AddImg(), ecat63EditMHeader(), ecat63ReadAllToImg(), ecat63ReadPlaneToImg(), ecat63WriteAllImg(), ecat7EditMHeader(), ecat7EditVHeader(), ecatCopy63to7mainheader(), ecatCopy7to63mainheader(), fitRead(), hrrtMakeCalHdr(), img2sif(), imgGetAnalyzeHeader(), imgGetEcat63MHeader(), imgGetEcat7MHeader(), imgGetMicropetSIF(), imgReadAnalyze(), imgReadAnalyzeHeader(), imgReadNiftiHeader(), imgSetEcat63MHeader(), imgSetEcat7MHeader(), imgSetNiftiHeader(), imgWriteAnalyze(), niftiCreateFNames(), niftiExists(), niftiHeaderToIFT(), resRead(), selectEcat931Calibrationfile(), sif2img(), strncpyCleanSpaces(), strTokenDup(), strTokenNCpy(), studynr_from_fname2(), studynr_in_fname(), upetExists(), and xelRead().

strncpyCleanSpaces()

int strncpyCleanSpaces	(	char *	s1,
		const char *	s2,
		int	maxlen )

Version of strncpy() which as usual copies s2 to s1, but without any space characters or line end characters that may be around the string s2.

Returns

the length of the new string s1.

Author

Vesa Oikonen

Parameters

s1	Pointer to pre-allocated result string with length of at least maxlen characters, including NULL character.
s2	Pointer to the original string.
maxlen	Max length of s1, including the trailing zero.

Definition at line 308 of file strext.c.

  {
  if(s1==NULL) return(0);
  s1[0]=(char)0; if(maxlen<1) return(0);
  if(maxlen<2) {strcpy(s1, ""); return(0);}
  if(s2==NULL || strlen(s2)<1) return(0);
 
  char *cptr;
  int i;
 
  cptr=(char*)s2; cptr+=strspn(s2, "\t\n\r ");
  strlcpy(s1, cptr, maxlen); i=strlen(s1); if(i<1) return(0);
  cptr=s1+(i-1);
  while(i>0) {
    if(*cptr!='\t' && *cptr!='\n' && *cptr!='\r' && *cptr!=' ') break;
    i--; s1[i]=(char)0; cptr--;
  }
  return(i);
}

Referenced by roi_read(), roiRead(), and strCleanSpaces().

strnlen()

size_t strnlen	(	const char *	s,
		size_t	n )

Safer version of strlen, in case the argument s is not NUL terminated string. Computes the length of string s, but never scans beyond the n first bytes of the string.

Remarks

Included in POSIX and GCC, so this implementation may not be needed.

Returns

same as strlen() or n, whichever is smaller.

Parameters

s	Pointer to string, or character array, that may not be NULL terminated.
n	The actual length of buffer allocated for the string; for example, string could have been allocated as char s[n];

Definition at line 181 of file strext.c.

  {
  if(s==NULL) return(0);
  char *ps=(char*)s;
  size_t i=0;
  while(i<n && *ps!='\0') {i++; ps++;}
  return(i);
}

Referenced by csv2dft_mat(), dcmAddItem(), dcmDA2intl(), dcmDT2intl(), dcmFileRead(), dcmFileWrite(), dcmSOPIdentify(), dcmSOPUIDName(), dcmTM2intl(), dcmTrUID(), dftWrite(), irdRead(), sifRead(), strlcat(), and tpcHtmlUsage().

strReplaceChar()

void strReplaceChar	(	char *	str,
		char	c1,
		char	c2 )

Replace certain characters in string with another character.

Parameters

str	Pointer to string in which the character is replaced.
c1	Character to be replaced.
c2	Character to use instead. If NULL, then only the first character is replaced.

Definition at line 159 of file strext.c.

  {
  char *cptr;
  if(strlen(str)==0) return;
  while((cptr=strchr(str, c1))!=NULL) *cptr=c2;
  return;
}

Referenced by dftWrite(), fitRead(), roi_read(), roiRead(), and strCleanForXML().

strTokenDup()

char * strTokenDup	(	const char *	s1,
		const char *	s2,
		int *	next )

Search the string s1 for the first token. The characters making up the string s2 are the delimiters that determine the tokens.

Returns

Returns pointer to a copy of the token string, or NULL in case of an error or if no token found.

Postcondition

Remember to free the memory from the returned pointer after last use.

Author

Vesa Oikonen

Parameters

s1	String from where tokens are searched; not modified in any way.
s2	String containing character delimiters.
next	Index of s1 where the token ended; set to NULL, if not needed.

Definition at line 89 of file strext.c.

  {
  if(next!=NULL) *next=0;
  if(s1==NULL) return NULL;
 
  char *s3=NULL, *cptr;
  size_t j;
  
  /* If no delimiters, then return copy of s1 */
  if(s2==NULL || strlen(s2)<1) {
    s3=strdup(s1); if(next!=NULL) *next=strlen(s1);
    return s3;
  } 
  /* Pass initial delimiter characters */
  cptr=(char*)s1; j=strspn(cptr, s2); cptr+=j; if(next!=NULL) *next=j;
  /* calculate characters between delimiters */
  j=strcspn(cptr, s2); if(j==0) {return NULL;}
  if(next!=NULL) *next+=j;
  /* Allocate space for token */
  s3=calloc(j+1, sizeof(char)); if(s3==NULL) return NULL;
  strlcpy(s3, cptr, j+1);
  return s3;
}

Referenced by fitRead(), and textfileReadLines().

strTokenNCpy()

int strTokenNCpy	(	const char *	str1,
		const char *	str2,
		int	i,
		char *	str3,
		int	count )

The strTokenNCpy() function copies the i'th token in the string pointed to by str1 into string pointed to by str3. The characters making up the string pointed to by str2 are the delimiters that determine the token.

See also

strTokenNr, strTokenDup

Returns

Returns the length of token, 0 if no token(s) found.

Parameters

str1	String from where tokens are searched; not modified in any way.
str2	String containing character delimiters.
i	Token number to copy (1..nr of tokens).
str3	String array into where the token is copied; string will be null terminated.
count	Length of str3, including terminal null

Definition at line 45 of file strext.c.

  {
  int j=0, n=0;
  char *cptr;
  if(str1==NULL || str2==NULL || strlen(str1)==0 || strlen(str2)==0) return(0);
  if(i<1 || str3==NULL || count<2) return(0);
 
  cptr=(char*)str1;
  do {
    // pass delimiter characters
    j=strspn(cptr, str2); cptr+=j;
    // pass characters between delimiters
    j=strcspn(cptr, str2); if(j>0) n++;
    // if this is the required token nr, then stop here
    if(n==i) {
      if(j>count-1) j=count-1;
      strlcpy(str3, cptr, j+1); //strncpy(str3, cptr, j); str3[j]=(char)0;
      break;
    }
    cptr+=j;
  } while(j>0);
  if(n>i) {str3[0]=(char)0; return(0);}
  return(j);
}

Referenced by fitRead(), integerListAddFromString(), integerListExpandFromString(), pxlRead(), resRead(), and roi_read().

strTokenNr()

int strTokenNr	(	const char *	str1,
		const char *	str2 )

The strTokenNr() function returns the number of tokens in the string pointed to by str1. The characters making up the string pointed to by str2 are the delimiters that determine the token.

See also

strTokenNCpy, strChrCount

Returns

Returns the nr of tokens.

Parameters

str1	String from where tokens are calculated; not modified in any way.
str2	String containing character delimiters.

Definition at line 17 of file strext.c.

  {
  int i=0, n=0;
  char *cptr;
  if(str1==NULL || str2==NULL || strlen(str1)==0 || strlen(str2)==0) return(0);
 
  cptr=(char*)str1;
  do {
    // pass delimiter characters
    i=strspn(cptr, str2); cptr+=i;
    // pass characters between delimiters
    i=strcspn(cptr, str2); cptr+=i; if(i>0) n++; 
  } while(i>0);
  return(n);
}

Referenced by fitRead(), integerListAddFromString(), integerListExpandFromString(), pxlRead(), resRead(), and roi_read().

strUppercaseCount()

int strUppercaseCount

(

const char *

s

)

Count how many upper case characters are found in string.

Returns

Returns the nr of upper case characters found in s.

See also

strChrCount

Parameters

s	String to search for upper case characters; not modified.

Definition at line 146 of file strext.c.

  {
  unsigned int n=0, i;
  if(s==NULL || strlen(s)==0) return (int)n;
  for(i=0; i<strlen(s); i++) if(isupper(s[i])) n++;
  return (int)n;
}

Referenced by rnameSplit().