readasciifile.c File Reference

Read ASCII text file raw contents for further processing. More...

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

Go to the source code of this file.

Functions
size_t	asciiFileSize (FILE *fp, int *nonprintable)
char *	asciiFileRead (FILE *fp, char *data, size_t maxlen)
int	asciiCommentLine (const char *line, int *cont)

Detailed Description

Read ASCII text file raw contents for further processing.

Definition in file readasciifile.c.

Function Documentation

asciiCommentLine()

int asciiCommentLine	(	const char *	line,
		int *	cont )

Check if ASCII text line starts with comment character '#'.

Comment character is searched from the first non-space character (space characters here include spaces and tabs).

Returns

1 if this is comment line and 0 if not.

Author

Vesa Oikonen

See also

asciiFileRead, asciiFileSize, strTrimLeft, strstrNoQuotation

Parameters

line	Pointer to string containing one line of ASCII text file.
cont	Optional pointer which is set to the index of line where the first non-space character after the comment character starts. If line does not start with comment character, then this will point to the first non-space character of the line. Enter NULL if not needed.

Definition at line 149 of file readasciifile.c.

  {
  if(cont!=NULL) *cont=0; 
  if(line==NULL) return 0;
  char *cptr=(char*)line;
  int i=strspn(cptr, " \t"); cptr+=i; if(cont!=NULL) *cont=i;
  if(*cptr!='#') return 0;
  if(cont==NULL) return 1;
  cptr++; i=strspn(cptr, " \t"); *cont+=(i+1);
  return 1;
}

Referenced by iftPutFromString(), iftPutFromStringWithSpaceSeparator(), and tacFormatDetermine().

asciiFileRead()

char * asciiFileRead	(	FILE *	fp,
		char *	data,
		size_t	maxlen )

Read at most maxlen-1 characters from given file pointer to ASCII text file.

Author

Vesa Oikonen

Returns

Pointer to the string, or NULL in case of an error.

See also

asciiFileSize, asciiCommentLine, fileExist, filenameGetExtension

Parameters

fp	File pointer; rewind() is NOT called here to allow reading data in chunks.
data	Pointer to character array in which the data is written; NULL, if memory is to allocated here (in that case remember to free it after use). Terminal zero is added.
maxlen	Nr of characters to read, and the size of data array (including terminal zero).

Definition at line 117 of file readasciifile.c.

  {
  /* Check the input */
  if(fp==NULL || maxlen<2) return NULL;
  /* Allocate memory if needed */
  char *cptr;
  if(data!=NULL) cptr=data; else {
    cptr=malloc(maxlen*sizeof(char)); if(cptr==NULL) return NULL;
  }
  size_t i=0; int c;
  while((c=fgetc(fp))!=EOF && i<maxlen-1) cptr[i++]=(char)c;
  cptr[i]=(char)0; if(i==0) {if(data==NULL) free(cptr); cptr=NULL;}
  return cptr;
}

Referenced by csvRead(), iftRead(), and tacFormatDetermine().

asciiFileSize()

size_t asciiFileSize	(	FILE *	fp,
		int *	nonprintable )

Get the size of ASCII text file, or size of initial ASCII part of file containing binary data after the text part (in certain image formats).

One NUL character is not counted as binary data, but two already is; this, because equipment failures sometimes lead to data ending with NUL.

Author

Vesa Oikonen

Returns

The number of characters in the initial ASCII part of file. This does not include the terminal zero that would be added to a string.

See also

asciiFileRead, asciiCommentLine, fileExist

Parameters

fp	File pointer; rewind() is called before returning.
nonprintable	Value will be set to 1 if reading was stopped at a non-printable character meaning that file may contain a binary part, or to 0 if file contains only printable characters and size of all contents was counted. Enter NULL, if not needed.

Definition at line 26 of file readasciifile.c.

  {
  if(nonprintable!=NULL) *nonprintable=0;
  if(fp==NULL) return(0);
  size_t n, bn;
  int c;
  n=bn=0;
  while((c=fgetc(fp))!=EOF && n<SIZE_MAX-1 && bn<2) {
    if(iscntrl(c) && c!=13 && c!=10 && c!=9 && c!=169) {
      bn++;
      if(c!=0) {
        if(nonprintable!=NULL) *nonprintable=1; 
        break;
      }
    }
    n++;
  }
  rewind(fp);
  if(nonprintable!=NULL && bn>1) *nonprintable=1; 
  return n;
}

Referenced by csvRead(), iftRead(), tacFormatDetermine(), and tacRead().