csv.h

Go to the documentation of this file.

/*
 * csv.h
 *
 * Copyright (C) 2007,2008  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef WAVEPACKET_UTIL_CSV_H__
#define WAVEPACKET_UTIL_CSV_H__


// includes --------------------------------------------------------------------
#include "common/common.h"

#include <iostream>


/// \ingroup util
/*@{*/


/**
 * \defgroup csv Comma Separated Values
 *
 * Wrapper for comma-separated-value (csv) files.
 *
 * This is for special files where:
 *   1) columns are delimited by commas (duh),
 *   2) the first row defines the column names (and column names are unique!),
 *   3) all subsequent rows have the same number of columns
 *
 * NOTE: the csv parser respects the orders of the input column names!
 * If you specify the ordering as "A,B,C", you'll receive that order in the
 *   callback vector, even if the data is actually ordered as "C,A,B".
 * Put another way: applications can assume that data is ordered in the
 *   callback data array in the exact same column order that was passed in
 *   to the parseCsvStream() call.
 */
/*@{*/

////////////////////////////////////////////////////////////////////////////////
//
//      csv parsing API
//
////////////////////////////////////////////////////////////////////////////////

// col_data_t : for a given column, contains name and value
struct col_data_t {
        const char *    col_name;
        const char *    value;
};

/// vector of values provided to callback
typedef std::vector<col_data_t> vec_col_t;

/// callback for parseCsvStream()
typedef void (*csv_callback_fn)(IN void * context,
                                IN const vec_col_t& data);


/// parse a stream of lines containing comma-separated values.
///
/// The caller must provide:
///  - the input stream
///  - a vector of the desired fields they would like
///  - a callback routine
///
/// This routine will:
///  - parse the first line as column headers
///  - parse each remaining line as comma-separated values
///  - based on the header line, find the values the caller asked for
///  - put the values in the order the caller asked for
///  - call the callback with the values
void parseCsvStream(IN std::istream& in,
                                IN const VecString& columns,
                                IN csv_callback_fn callback,
                                IN void * context);
                                

#endif  // WAVEPACKET_UTIL_CSV_H__