csv.h

Go to the documentation of this file.

 
 
// Copyright 2020 Matthew Chandler
 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
 
#ifndef CSV_H
#define CSV_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdarg.h>
#include <stdbool.h>
#include <stdio.h>
 
#include "version.h"
 
 
typedef enum {
    CSV_OK,                      
    CSV_EOF,                     
    CSV_PARSE_ERROR,             
    CSV_IO_ERROR,                
    CSV_TOO_MANY_FIELDS_WARNING, 
    CSV_INTERNAL_ERROR           
} CSV_status;
 
 
char * CSV_strdup(const char * src);
 
 
typedef struct CSV_row CSV_row;
 
 
CSV_row * CSV_row_init(void);
 
 
void CSV_row_free(CSV_row * rec);
 
 
void CSV_row_append(CSV_row * rec, char * field);
 
 
size_t CSV_row_size(const CSV_row * rec);
 
 
const char * CSV_row_get(const CSV_row * rec, size_t i);
 
 
CSV_status CSV_row_read_v(CSV_row * rec, ...);
 
 
const char * const * CSV_row_arr(const CSV_row * rec);
 
 
typedef struct CSV_reader CSV_reader;
 
 
CSV_reader * CSV_reader_init_from_filename(const char * filename);
 
 
CSV_reader * CSV_reader_init_from_file(FILE * file);
 
 
CSV_reader * CSV_reader_init_from_str(const char * input);
 
 
void CSV_reader_free(CSV_reader * reader);
 
 
void CSV_reader_set_delimiter(CSV_reader * reader, const char delimiter);
 
 
void CSV_reader_set_quote(CSV_reader * reader, const char quote);
 
 
void CSV_reader_set_lenient(CSV_reader * reader, const bool lenient);
 
 
char * CSV_reader_read_field(CSV_reader * reader);
 
 
CSV_status CSV_reader_read_v(CSV_reader * reader, ...);
 
 
CSV_row * CSV_reader_read_row(CSV_reader * reader);
 
 
CSV_status CSV_reader_read_row_ptr(CSV_reader * reader, char *** fields, size_t * num_fields);
 
 
bool CSV_reader_eof(const CSV_reader * reader);
 
 
bool CSV_reader_end_of_row(const CSV_reader * reader);
 
 
const char * CSV_reader_get_error_msg(const CSV_reader * reader);
 
 
CSV_status CSV_reader_get_error(const CSV_reader * reader);
 
 
typedef struct CSV_writer CSV_writer;
 
 
CSV_writer * CSV_writer_init_from_filename(const char * filename);
 
 
CSV_writer * CSV_writer_init_from_file(FILE * file);
 
 
CSV_writer * CSV_writer_init_to_str(void);
 
 
void CSV_writer_free(CSV_writer * writer);
 
 
void CSV_writer_set_delimiter(CSV_writer * writer, const char delimiter);
 
 
void CSV_writer_set_quote(CSV_writer * writer, const char quote);
 
 
CSV_status CSV_writer_end_row(CSV_writer * writer);
 
 
CSV_status CSV_writer_write_field(CSV_writer * writer, const char * field);
 
 
CSV_status CSV_writer_write_fields(CSV_writer * writer, const CSV_row * fields);
 
 
CSV_status CSV_writer_write_fields_ptr(CSV_writer * writer, const char *const * fields, const size_t num_fields);
 
 
CSV_status CSV_writer_write_fields_v(CSV_writer * writer, ...);
 
 
CSV_status CSV_writer_write_row(CSV_writer * writer, const CSV_row * fields);
 
 
CSV_status CSV_writer_write_row_ptr(CSV_writer * writer, const char *const * fields, const size_t num_fields);
 
 
CSV_status CSV_writer_write_row_v(CSV_writer * writer, ...);
 
 
const char * CSV_writer_get_str(CSV_writer * writer);
 
#ifdef __cplusplus
}
#endif
 
#endif // CSV_H