libcsv/csv.h at master · PsychoCod3r/libcsv · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
/**********************************************
 * libcsv, Version 0.3 Alpha                  *
 * Description: CSV library for C             *
 * Author: Michael Warren, a.k.a Psycho Cod3r *
 * Date: November 2020                        *
 * License: Michael Warren FSL Version 1.1    *
 * Current module: Header file for CSV types  *
 *                 and functions              *
 **********************************************/

#ifndef _CSV_
#define _CSV_

#include <stdio.h>
#include <stdbool.h>
#include "dfloat.h"

// Types for CSV fields
enum types { csv_number, csv_string };

// Conditional operators for selecting records
enum operators { EQ, NE, LT, GT, LE, GE, SEQ, SNE, MOD };

// Metadata field for the table header
typedef struct {
	char *name;
	enum types type;
} csv_field;

// Single record in linked list table structure
struct _csv_record {
	void **record;
	struct _csv_record *next;
};

typedef struct _csv_record csv_record;

// Handle for abstract table structure
typedef struct {
	int rlen;           // # of fields in each record
	csv_field **header; // Table metadata
	csv_record *start;  // Pointer to first record
	csv_record *cur;    // Pointer to current record
} csv_table;

// Data type used by csv_set.c
typedef struct {
	int size;	// Size of the set's universe in bytes, or the number of elements in the universe divided by 8
	uint8_t *bits;	// Each bit corresponds to a member of the universe
} csv_set;

typedef struct {
	csv_table *ident; // Records that match the condition
	csv_table *cplmt; // Records that don't match the condition
} csv_partition;

// Handles end-of-line sequence:
#if defined (_WIN16) || defined (_WIN32) || defined (_WIN64) || defined (__WIN32__) || defined (__TOS_WIN__) || defined (__WINDOWS__)
# define _EOL_ "\r\n"
#elif defined (OS2) || defined(_OS2) || defined(__OS2__) || defined (__TOS_OS2__)
# define _EOL_ "\r\n"
#elif defined (MSDOS) || defined (__MSDOS__) || defined (_MSDOS) || defined (__DOS__)
# define _EOL_ "\r\n"
#elif defined (macintosh) || defined (Macintosh)
# define _EOL_ "\r"
#else
# define _EOL_ "\n"
#endif

// Shorthand functions:
#define csv_gnfbn csv_get_number_field_by_name
#define csv_gnfbi csv_get_number_field_by_index
#define csv_gsfbn csv_get_string_field_by_name
#define csv_gsfbi csv_get_string_field_by_index
#define csv_snfbn csv_set_number_field_by_name
#define csv_snfbi csv_set_number_field_by_index
#define csv_ssfbn csv_set_string_field_by_name
#define csv_ssfbi csv_set_string_field_by_index

#define csv_select_records csv_select_records_by_subset

__BEGIN_DECLS
bool csv_validate_file( FILE *, bool );
csv_table *csv_read_table( FILE *, bool );
void csv_write_table( FILE *, csv_table *, bool );
csv_table *csv_create_table( int, csv_field ** );
void csv_drop_table( csv_table * );
csv_table *csv_alter_table_add( csv_table *, csv_field * );
csv_table *csv_alter_table_drop( csv_table *, char * );
csv_record *csv_next_record( csv_table * );
void csv_rewind( csv_table * );
void csv_insert_record( csv_table *, void ** );
void csv_insert_new_record( csv_table * );
void csv_delete_current_record( csv_table * );
dfloat64_t *csv_get_number_field_by_name( csv_table *, char * );
dfloat64_t *csv_get_number_field_by_index( csv_table *, int );
char *csv_get_string_field_by_name( csv_table *, char * );
char *csv_get_string_field_by_index( csv_table *, int );
void csv_set_number_field_by_name( csv_table *, char *, dfloat64_t * );
void csv_set_number_field_by_index( csv_table *, int, dfloat64_t * );
void csv_set_string_field_by_name( csv_table *, char *, char * );
void csv_set_string_field_by_index( csv_table *, int, char * );
csv_set *csv_empty_set( int );
csv_set *csv_set_universe( int );
void csv_set_add( csv_set *, int );
void csv_set_del( csv_set *, int );
bool csv_set_member( int, csv_set * );
void csv_set_difference( csv_set *, csv_set * );
void csv_set_complement( csv_set * );
void csv_set_union( csv_set *, csv_set * );
void csv_set_intersection( csv_set *, csv_set * );
csv_set *csv_set_difference_f( csv_set *, csv_set * );
csv_set *csv_set_complement_f( csv_set * );
csv_set *csv_set_union_f( csv_set *, csv_set * );
csv_set *csv_set_intersection_f( csv_set *, csv_set * );
csv_set *csv_read_set( char * );
char *csv_write_set( csv_set * );
char *csv_write_set_f( csv_set * );
csv_set *csv_select_subset( csv_table *, enum operators, char *, char * );
csv_table *csv_select_records_by_subset( csv_table *, csv_set * );
csv_table *csv_select_records_by_expr( csv_table *, char * );
csv_partition *csv_partition_table_by_subset( csv_table *, csv_set * );
csv_partition *csv_partition_table_by_expr( csv_table *, csv_set * );
__END_DECLS

/*
 * Note: The following functions are not yet implemented:
 * csv_alter_table_add()
 * csv_alter_table_drop()
 * csv_select_records_by_expr()
 * csv_partition_table_by_expr()
 */

#endif