csv.c File Reference

CSV struct processing. More...

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

Go to the source code of this file.

Functions
void	csvInit (CSV *csv)
void	csvFree (CSV *csv)
int	csvAllocate (CSV *csv, int nr)
int	csvDuplicate (CSV *csv1, CSV *csv2)
	Make a duplicate of CSV structure.
int	csvPutString (CSV *csv, const char *s, int newline)
int	csvPutDouble (CSV *csv, double v, int newline, int tointl)
int	csvPutInt (CSV *csv, int v, int newline)
int	csvRowLength (CSV *csv, int row)
int	csvSetDimensions (CSV *csv)
int	csvIsRegular (CSV *csv)
int	csvTrimRight (CSV *csv)
char *	csvCell (CSV *csv, int row, int col)
int	csvCellReplace (CSV *csv, int row, int col, const char *s)
int	csvRemoveItem (CSV *csv, int i)
int	csvRemoveEmptyRows (CSV *csv)
int	csvRemoveComments (CSV *csv)
int	csvReorg (CSV *d, TPCSTATUS *status)
int	csvTranspose (CSV *csv)

Detailed Description

CSV struct processing.

Test

Update test function arguments.

Definition in file csv.c.

Function Documentation

csvAllocate()

int csvAllocate	(	CSV *	csv,
		int	nr )

Allocate memory for list of field items for CSV data.

Any previous content is preserved.

Precondition

Before first use initialize the CSV struct with csvInit().

Returns

enum tpcerror (TPCERROR_OK when successful).

Author

Vesa Oikonen

See also

csvInit, csvFree, csvDuplicate, csvSetDimensions, csvList

Parameters

csv	Pointer to CSV.
nr	Nr of field items to add to the list.

Definition at line 58 of file csv.c.

  {
  if(csv==NULL) return TPCERROR_FAIL;
  if(nr<1) return TPCERROR_OK;
 
  /* If not allocated previously, then just allocate and thats it */
  if(csv->_item_nr==0) {
    csv->c=(CSV_item*)calloc(nr, sizeof(CSV_item));
    if(csv->c==NULL) return TPCERROR_OUT_OF_MEMORY;
    csv->_item_nr=nr;
    return TPCERROR_OK;
  }
 
  /* How many unused places there are already? */
  int unused=csv->_item_nr-csv->nr;
  /* Check if enough memory is already allocated */
  if(unused>=nr) return TPCERROR_OK;
 
  /* Ok, we have to reallocate more memory for the list */
  nr+=csv->nr;
  CSV_item *new_list;
  new_list=(CSV_item*)realloc(csv->c, nr*sizeof(CSV_item));
  if(new_list==NULL) return TPCERROR_OUT_OF_MEMORY;
  else csv->c=new_list;
  /* Initiate the list */
  for(int i=csv->_item_nr; i<nr; i++) {
    csv->c[i].row=0; csv->c[i].col=0; csv->c[i].content=NULL;
  }
  csv->_item_nr=nr;
  return TPCERROR_OK;
}

Referenced by csvDuplicate(), csvPutString(), parWriteCSV(), and tacWriteCSV().

csvCell()

char * csvCell	(	CSV *	csv,
		int	row,
		int	col )

Get the CVS field contents in specified row and column.

Returns

Returns pointer to the content string, or NULL if not found.

Author

Vesa Oikonen

See also

csvRead, csvSearchField, csvFindField, csvCellReplace, csvSetDimensions

Parameters

csv	Pointer to CSV.
row	CSV row index.
col	CSV column index.

Definition at line 358 of file csv.c.

  {
  if(csv==NULL) return((char*)NULL);
  for(int i=0; i<csv->nr; i++) 
    if(csv->c[i].row==row && csv->c[i].col==col)
      return(csv->c[i].content);
  return((char*)NULL); 
}

Referenced by csvDuplicate(), csvRemoveEmptyRows(), csvWrite(), parReadFIT(), parReadRES(), tacRead(), tacReadCarimasTxt(), tacReadInveonCSV(), tacReadMat(), tacReadQView(), tacReadSIF(), and tacReadSimple().

csvCellReplace()

int csvCellReplace	(	CSV *	csv,
		int	row,
		int	col,
		const char *	s )

Replace the value of CVS field.

Returns

tpcerror (TPCERROR_OK when successful).

Author

Vesa Oikonen

See also

csvRead, csvSearchField, csvCell, csvRemoveItem, csvTranspose

Parameters

csv	Pointer to CSV.
row	CSV row index.
col	CSV column index.
s	Field string to add; can be empty ("" or NULL).

Definition at line 380 of file csv.c.

  {
  if(csv==NULL) return(TPCERROR_FAIL);
  int ci=-1;
  for(int i=0; i<csv->nr; i++) if(csv->c[i].row==row && csv->c[i].col==col) {ci=i; break;}
  if(ci<0) return(TPCERROR_MISSING_DATA);
  /* Delete the previous value */
  free(csv->c[ci].content);
  /* Save the new item */
  if(s==NULL || *s=='\0') csv->c[ci].content=strdup(""); 
  else csv->c[ci].content=strdup(s);
  if(csv->c[ci].content==NULL) return(TPCERROR_OUT_OF_MEMORY);
  return(TPCERROR_OK); 
}

csvDuplicate()

int csvDuplicate	(	CSV *	csv1,
		CSV *	csv2 )

Make a duplicate of CSV structure.

Previous contents are copied. In the duplicate the space is allocated for row_nr times col_nr cells.

See also

csvInit, csvAllocate, csvFree

Returns

Returns TPCERROR status (0 when successful).

Parameters

csv1	Pointer to the source CSV.
csv2	Pointer to the target CSV; must be initiated; any old contents are deleted.

Definition at line 102 of file csv.c.

  {
  if(csv1==NULL || csv2==NULL) return TPCERROR_FAIL;
  if(csv1->nr<1 || csv1->_item_nr<csv1->nr || csv1->row_nr<1 || csv1->col_nr<1) return TPCERROR_NO_DATA;
 
  /* Empty the duplicate */
  csvFree(csv2);
 
  /* Allocate memory for csv2 */
  int ret=csvAllocate(csv2, csv1->row_nr*csv1->col_nr);
  if(ret!=TPCERROR_OK) return(ret);
  csv2->col_nr=csv1->col_nr;
  csv2->row_nr=csv1->row_nr;
  csv2->nr=csv2->col_nr*csv2->row_nr;
 
  /* Copy the contents */
  csv2->separator=csv1->separator;
  int ni=0, fulln=0;
  for(int ri=0; ri<csv2->row_nr; ri++)
    for(int ci=0; ci<csv2->col_nr; ci++) {
      csv2->c[ni].row=ri;
      csv2->c[ni].col=ci;
      char *cp=csvCell(csv1, ri, ci);
      if(cp==NULL) csv2->c[ni].content=NULL; else {csv2->c[ni].content=strdup(cp); fulln++;}
      ni++;
    }
  if(fulln<1) return TPCERROR_NO_DATA;
  return TPCERROR_OK;
}

csvFree()

void csvFree

(

CSV *

csv

)

Free memory allocated for CSV data. All contents are destroyed.

Precondition

Before first use initialize the CSV struct with csvInit().

Author

Vesa Oikonen

See also

csvInit, csvAllocate, csvWrite

Parameters

csv	Pointer to CSV.

Definition at line 38 of file csv.c.

  {
  if(csv==NULL) return;
  for(int i=0; i<csv->_item_nr; i++) free(csv->c[i].content);
  free(csv->c);
  csvInit(csv);
}

Referenced by csvDuplicate(), parRead(), parWriteCSV(), tacRead(), and tacWriteCSV().

csvInit()

void csvInit

(

CSV *

csv

)

Initiate the CSV struct before any use.

Author

Vesa Oikonen

See also

csvFree, csvAllocate, csvRead

Parameters

csv	Pointer to CSV.

Definition at line 22 of file csv.c.

  {
  if(csv==NULL) return;
  csv->c=NULL; csv->_item_nr=csv->nr=csv->row_nr=csv->col_nr=0;
  csv->separator='\t'; //(char)0;
}

Referenced by csvFree(), parRead(), parWriteCSV(), tacFormatDetermine(), tacRead(), and tacWriteCSV().

csvIsRegular()

int csvIsRegular

(

CSV *

csv

)

Check whether CSV is regular, that is, each row contain the same number of columns.

Author

Vesa Oikonen

See also

csvTranspose, csvTrimRight, csvSetDimensions, csvRowLength, csvRead, csvDuplicate

Returns

Returns 1 if CSV is regular, 0 if not.

Parameters

csv	Pointer to CSV

Definition at line 292 of file csv.c.

  {
  if(csv==NULL) return(0);
  if(csv->nr<2) return(1);
  int i, r, n=0, m=0;
  i=0; r=csv->c[i].row; m++;
  for(i=1; i<csv->nr; i++) {
    if(r==csv->c[i].row) {
      m++; 
      continue;}
    if(n>0 && m!=n) return(0);
    r=csv->c[i].row; n=m; m=1;
  }
  if(n>0 && m!=n) return(0);
  return(1);
}

Referenced by tacRead(), tacReadMat(), and tacReadSimple().

csvPutDouble()

int csvPutDouble	(	CSV *	csv,
		double	v,
		int	newline,
		int	tointl )

Add specified double value as string into CSV.

Returns

tpcerror (TPCERROR_OK when successful).

Precondition

Before first use initialize the CSV struct with csvInit().

Author

Vesa Oikonen

See also

csvInit, csvPutString, csvPutInt, csvPutLine

Parameters

csv	Pointer to initiated CSV; previous contents are not changed.
v	Double value to add; NaN is added as an empty field.
newline	New line (1) or same line (0).
tointl	Convert (1) or do not convert (0) commas to semicolons and dots to commas.

Definition at line 193 of file csv.c.

  {
  int ret;
  if(isnan(v)) {
    ret=csvPutString(csv, "", newline);
  } else {
    char s[128];
    sprintf(s, "%g", v); if(tointl) strReplaceChar(s, '.', ',');
    ret=csvPutString(csv, s, newline);
  }
  return ret;
}

Referenced by parWriteCSV(), and tacWriteCSV().

csvPutInt()

int csvPutInt	(	CSV *	csv,
		int	v,
		int	newline )

Add specified integer value as string into CSV.

Returns

tpcerror (TPCERROR_OK when successful).

Precondition

Before first use initialize the CSV struct with csvInit().

Author

Vesa Oikonen

See also

csvInit, csvPutDouble, csvPutString, csvPutLine

Parameters

csv	Pointer to initiated CSV; previous contents are not changed
v	Integer value to add; use csvPutString() to add an empty field
newline	New line (1) or same line (0)

Definition at line 222 of file csv.c.

  {
  int ret;
  char s[128];
  sprintf(s, "%d", v);
  ret=csvPutString(csv, s, newline);
  return ret;
}

Referenced by parWriteCSV().

csvPutString()

int csvPutString	(	CSV *	csv,
		const char *	s,
		int	newline )

Add specified string to CSV.

Returns

tpcerror (TPCERROR_OK when successful).

Precondition

Before first use initialize the CSV struct with csvInit().

Author

Vesa Oikonen

See also

csvInit, csvPutDouble, csvPutInt, csvPutLine

Parameters

csv	Pointer to initiated CSV; previous contents are not changed.
s	Field string to add; can be empty ("" or NULL).
newline	New line (1) or same line (0).

Definition at line 144 of file csv.c.

  {
  if(csv==NULL) return TPCERROR_FAIL;
  /* Allocate memory, if needed, and if needed, then a bigger chunk */
  int avail=csv->_item_nr-csv->nr;
  if(avail<1) {
    int ret=csvAllocate(csv, 10);
    if(ret!=TPCERROR_OK) return ret;
  }
  /* Write the item */
  if(s==NULL || *s=='\0') csv->c[csv->nr].content=strdup(""); 
  else csv->c[csv->nr].content=strdup(s);
  if(csv->c[csv->nr].content==NULL) return TPCERROR_OUT_OF_MEMORY;
  /* Set the row and column number */
  int r, c;
  if(csv->nr==0) {r=c=0;}
  else {
    if(newline!=0) {
      c=0;
      r=csv->c[csv->nr-1].row+1;
    } else {
      c=csv->c[csv->nr-1].col+1;
      r=csv->c[csv->nr-1].row;
    }
  }
  csv->c[csv->nr].col=c; csv->c[csv->nr].row=r;
  /* Update row_nr and max col nr, if necessary */
  c++; r++;
  if(c>csv->col_nr) csv->col_nr=c;
  if(r>csv->row_nr) csv->row_nr=r;
 
  csv->nr++;
  return TPCERROR_OK;
}

Referenced by csvPutDouble(), csvPutInt(), csvPutLine(), csvPutLineWithSpaces(), parWriteCSV(), tacReadSIF(), and tacWriteCSV().

csvRemoveComments()

int csvRemoveComments

(

CSV *

csv

)

Remove those cells from CSV structure whose contents start with '#'.

Returns

enum tpcerror (TPCERROR_OK when successful).

See also

csvIsRegular, csvRemoveEmptyRows

Parameters

csv	Pointer to CSV.

Definition at line 470 of file csv.c.

  {
  if(csv==NULL) return(TPCERROR_FAIL);
  if(csv->nr<1) return(TPCERROR_NO_DATA);
 
  int i=csv->nr-1;
  while(i>=0) {
    if(csv->c[i].content!=NULL && csv->c[i].content[0]=='#') csvRemoveItem(csv, i);
    i--;
  }
  return(TPCERROR_OK);
//  return(csvRemoveEmptyRows(csv));
}

csvRemoveEmptyRows()

int csvRemoveEmptyRows

(

CSV *

csv

)

Remove empty rows from CSV. Rows that contain only empty cells or cells that start with '#' are considered empty.

Returns

enum tpcerror (TPCERROR_OK when successful).

See also

csvRemoveComments, csvIsRegular, csvDuplicate, csvCellReplace

Parameters

csv	Pointer to CSV.

Definition at line 434 of file csv.c.

  {
  if(csv==NULL) return TPCERROR_FAIL;
  if(csv->nr<1 || csv->row_nr<1 || csv->col_nr<1) return TPCERROR_NO_DATA;
 
  /* Check the rows */
  int ri=csv->row_nr-1;
  while(ri>=0) {
    int n=0;
    for(int ci=0; ci<csv->col_nr; ci++) {
      char *cp=csvCell(csv, ri, ci); if(cp==NULL) continue;
      if(*cp=='\0' || *cp=='#') continue;
      n++;
    }
    if(n==0) { // this line is empty
      int i=csv->nr-1;
      while(i>=0) {
        if(csv->c[i].row==ri) csvRemoveItem(csv, i);
        i--;
      }
      for(i=0; i<csv->nr; i++) if(csv->c[i].row>ri) csv->c[i].row--;
      csv->row_nr--;
    }
    ri--;
  }
  return(TPCERROR_OK);
}

csvRemoveItem()

int csvRemoveItem	(	CSV *	csv,
		int	i )

Remove item from CSV data structure.

Returns

enum tpcerror (TPCERROR_OK when successful).

See also

csvCellReplace, csvFree, csvDuplicate, csvRemoveEmptyRows

Parameters

csv	Pointer to CSV.
i	Index of item to delete.

Definition at line 409 of file csv.c.

  {
  if(csv==NULL || i<0) return TPCERROR_FAIL;
  if(csv->nr<1 || i>=csv->nr) return TPCERROR_NO_DATA;
  free(csv->c[i].content); csv->c[i].content=NULL;
  for(int j=i+1; j<csv->nr; j++) {
    csv->c[j-1].row=csv->c[j].row;
    csv->c[j-1].col=csv->c[j].col;
    csv->c[j-1].content=csv->c[j].content;
  }
  csv->nr--; csv->c[csv->nr].content=NULL;
  return(TPCERROR_OK); 
}

Referenced by csvRemoveComments(), csvRemoveEmptyRows(), and csvTrimRight().

csvReorg()

int csvReorg	(	CSV *	d,
		TPCSTATUS *	status )

Sort CSV data array by increasing row and column numbers.

Returns

enum tpcerror (TPCERROR_OK when successful).

See also

csvTranspose, csvList, csvAllocate, csvWrite

Parameters

d	Pointer to CSV structure.
status	Pointer to status data; enter NULL if not needed.

Definition at line 503 of file csv.c.

  {
  int verbose=0; if(status!=NULL) verbose=status->verbose;
  if(verbose>0) printf("%s()\n", __func__);
  /* Check that required data exists */
  if(d==NULL || d->nr<1) {
    statusSet(status, __func__, __FILE__, __LINE__, TPCERROR_NO_DATA);
    return TPCERROR_NO_DATA;
  }
  statusSet(status, __func__, __FILE__, __LINE__, TPCERROR_OK);
  if(d->nr<2) return TPCERROR_OK;
  qsort(d->c, d->nr, sizeof(CSV_item), csvReorgQSort);
  return TPCERROR_OK;
}

Referenced by csvTranspose(), and tacReadSIF().

csvRowLength()

int csvRowLength	(	CSV *	csv,
		int	row )

Count the nr of columns on specified CSV row.

Author

Vesa Oikonen

See also

csvCell, csvRead, csvIsRegular, csvSetDimensions

Returns

The number of columns.

Parameters

csv	Pointer to CSV
row	CSV row index

Definition at line 244 of file csv.c.

  {
  if(csv==NULL) return(0);
//  int i, n=0;
//  for(i=0; i<csv->nr; i++) if(csv->c[i].row==row) n++;
//  return(n); 
  int n=-1;
  for(int i=0; i<csv->nr; i++) if(csv->c[i].row==row && csv->c[i].col>n) n=csv->c[i].col;
  return(1+n); 
}

Referenced by csvWrite(), parReadFIT(), parReadRES(), tacReadDFT(), tacReadSIF(), and tacReadSimple().

csvSetDimensions()

int csvSetDimensions

(

CSV *

csv

)

Set the number of rows and columns in CSV table, based on the row and column stored with each cell. CSV may not be regular, thus maximum row and column numbers are used.

Author

Vesa Oikonen

See also

csvIsRegular, csvRowLength, csvRead, csvRemoveComments

Returns

enum tpcerror (TPCERROR_OK when successful).

Parameters

csv	Pointer to CSV structure.

Definition at line 269 of file csv.c.

  {
  if(csv==NULL) return TPCERROR_FAIL;
  if(csv->nr<1) {csv->col_nr=0; csv->row_nr=0; return(TPCERROR_OK);}
 
  int maxri=0, maxci=0;
  for(int i=0; i<csv->nr; i++) {
    if(csv->c[i].row>maxri) maxri=csv->c[i].row;
    if(csv->c[i].col>maxci) maxci=csv->c[i].col;
  }
  csv->col_nr=1+maxci; csv->row_nr=1+maxri;
  return(TPCERROR_OK);
}

Referenced by csvTranspose().

csvTranspose()

int csvTranspose

(

CSV *

csv

)

Transpose data in CSV structure.

To work properly, CSV should not contain comment cells/lines.

Returns

enum tpcerror (TPCERROR_OK when successful).

See also

csvIsRegular, csvDuplicate, csvCellReplace, csvReorg, csvRmComments

Parameters

csv	Pointer to CSV.

Definition at line 530 of file csv.c.

  {
  if(csv==NULL) return(TPCERROR_FAIL);
  if(csv->nr<1) return(TPCERROR_NO_DATA);
 
  /* Get dimensions */
  {
    int ret=csvSetDimensions(csv);
    if(ret!=TPCERROR_OK) return(ret);
  }
  if(csv->row_nr<1 || csv->col_nr<1) return(TPCERROR_NO_DATA);
 
  /* If only one row and column, then nothing to do */
  if(csv->row_nr==1 && csv->col_nr==1) return(TPCERROR_OK);
 
  /* Switch column and row numbers */
  for(int i=0; i<csv->nr; i++) {
    int cr=csv->c[i].col;
    csv->c[i].col=csv->c[i].row;
    csv->c[i].row=cr;
  }
  {
    int cn=csv->col_nr;
    csv->col_nr=csv->row_nr;
    csv->row_nr=cn;
  }
 
  /* Sort CSV data by rows and columns */
  {
    int ret=csvReorg(csv, NULL);
    if(ret!=TPCERROR_OK) return(ret);
  }
 
  return(TPCERROR_OK);
}

csvTrimRight()

int csvTrimRight

(

CSV *

csv

)

Remove empty cells from the right side of CVS table until a non-empty column is reached.

Resulting CSV may still not be regular.

Author

Vesa Oikonen

See also

csvIsRegular, csvRowLength, csvRead, csvTranspose

Returns

enum tpcerror (TPCERROR_OK when successful).

Parameters

csv	Pointer to CSV

Definition at line 321 of file csv.c.

  {
  if(csv==NULL) return TPCERROR_FAIL;
  if(csv->nr<1 || csv->col_nr<2 || csv->row_nr<2) return TPCERROR_NO_DATA;
 
  int ci=csv->col_nr-1;
  while(ci>0) {
    /* Does this column contain any data? */
    int n=0;
    for(int i=0; i<csv->nr; i++) if(csv->c[i].col==ci) {
      if(csv->c[i].content!=NULL && csv->c[i].content[0]!='\0' && csv->c[i].content[0]!='#') n++;
    }
    if(n>0) break; // yes
    /* No, so let's delete the last column */
    int i=csv->nr-1;
    while(i>=0) {
      if(csv->c[i].col==ci) {
        if(csvRemoveItem(csv, i)!=TPCERROR_OK) return TPCERROR_FAIL;
      }
      i--;
    }
    csv->col_nr--;
    /* Try the previous column */
    ci--;
  }
  return(TPCERROR_OK);
}

Referenced by tacReadSimple().