gnc-csv-model.h

Go to the documentation of this file.

/********************************************************************\
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program is distributed in the hope that it will be useful,  *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of   *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
 * GNU General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       [email protected]                   *
\********************************************************************/

#ifndef GNC_CSV_MODEL_H
#define GNC_CSV_MODEL_H

#include "config.h"

#include "Account.h"
#include "Transaction.h"

#include "stf/stf-parse.h"

enum GncCsvColumnType {GNC_CSV_NONE,
                       GNC_CSV_DATE,
                       GNC_CSV_NUM,
                       GNC_CSV_DESCRIPTION,
                       GNC_CSV_NOTES,
                       GNC_CSV_ACCOUNT,
                       GNC_CSV_DEPOSIT,
                       GNC_CSV_WITHDRAWAL,
                       GNC_CSV_BALANCE,
                       GNC_CSV_NUM_COL_TYPES
                      };

enum GncCsvErrorType {GNC_CSV_FILE_OPEN_ERR,
                      GNC_CSV_ENCODING_ERR
                     };

typedef struct
{
    char* begin;
    char* end;
} GncCsvStr;

/* TODO We now sort transactions by date, not line number, so we
 * should probably get rid of this struct and uses of it. */

typedef struct
{
    int line_no;
    Transaction* trans;
    gnc_numeric balance; 
    gboolean balance_set; 
    gchar *num; 
} GncCsvTransLine;

/* A set of currency formats that the user sees. */
extern const int num_currency_formats;
extern const gchar* currency_format_user[];

/* A set of date formats that the user sees. */
extern const int num_date_formats;
extern const gchar* date_format_user[];

/* This array contains all of the different strings for different column types. */
extern gchar* gnc_csv_column_type_strs[];

typedef struct
{
    gchar* encoding;
    GMappedFile* raw_mapping;   
    GncCsvStr raw_str;          
    GncCsvStr file_str;         
    GPtrArray* orig_lines;      
    GArray* orig_row_lengths;   
    int orig_max_row;           
    GStringChunk* chunk;        
    StfParseOptions_t* options; 
    GArray* column_types;       
    GList* error_lines;         
    GList* transactions;        
    int date_format;            
    int start_row;              
    int end_row;                
    gboolean skip_rows;         
    int currency_format;        
} GncCsvParseData;

GncCsvParseData* gnc_csv_new_parse_data (void);

void gnc_csv_parse_data_free (GncCsvParseData* parse_data);

int gnc_csv_load_file (GncCsvParseData* parse_data, const char* filename,
                      GError** error);

int gnc_csv_convert_encoding (GncCsvParseData* parse_data, const char* encoding, GError** error);

int gnc_csv_parse (GncCsvParseData* parse_data, gboolean guessColTypes, GError** error);

int gnc_csv_parse_to_trans (GncCsvParseData* parse_data, Account* account, gboolean redo_errors);

time64 parse_date (const char* date_str, int format);

#endif