csv.h

Go to the documentation of this file.

/*
 * dballe/csv - CSV utility functions
 *
 * Copyright (C) 2005--2014  ARPA-SIM <urpsim@smr.arpa.emr.it>
 *
 * 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.
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * Author: Enrico Zini <enrico@enricozini.com>
 */

#ifndef DBA_CSV_H
#define DBA_CSV_H

#include <iosfwd>
#include <stdio.h>
#include <string>
#include <vector>
#include <wreport/var.h>

namespace dballe {

bool csv_read_next(FILE* in, std::vector<std::string>& cols);

class CSVReader
{
protected:
    std::istream* in;

    int next_char();

public:
    bool close_on_exit;
    std::string line;

    std::vector<std::string> cols;

    CSVReader();
    CSVReader(std::istream& in);
    CSVReader(const std::string& pathname);
    ~CSVReader();

    void open(const std::string& pathname);
    void close();

    int as_int(unsigned col) const;

    int as_int_withmissing(unsigned col) const;

    wreport::Varcode as_varcode(unsigned col) const;

    bool move_to_data(unsigned number_col = 0);

    bool next();

    static std::string unescape(const std::string& csvstr);
};

// TODO: CSV readers allowing to peek on the next line without consuming it, to
// allow the Msg parser to stop at msg boundary after peeking at a line
// also, stripping newlines at end of lines
// also, reading from istream
// also, de-escaping strings (if they start with quote)

void csv_output_quoted_string(std::ostream& out, const std::string& str);

void csv_output_quoted_string(FILE* out, const std::string& str);

class CSVWriter
{
protected:
    std::string row;

public:
    virtual ~CSVWriter();

    void add_value_empty();

    void add_value_raw(const char* str);

    void add_value_raw(const std::string& str);

    void add_value(int val);

    void add_value_withmissing(int val);

    void add_value(unsigned val);

    void add_value(uint64_t val);

    void add_value(wreport::Varcode val);

    void add_var_value_raw(const wreport::Var& val);

    void add_var_value_formatted(const wreport::Var& val);

    void add_value(const char* val);

    void add_value(const std::string& val);

    virtual void flush_row() = 0;
};

} // namespace dballe
#endif