src/report/report-formatter-csv.cpp

/* Copyright (c) 2012 Samsung Electronics Co., Ltd.
 *	http://www.samsung.com/
 *
 * This file is part of PowerTOP
 *
 * This program file 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; 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 in a file named COPYING; if not, write to the
 * Free Software Foundation, Inc,
 * 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA
 * or just google for it.
 *
 * CSV report generator.
 * Written by Igor Zhbanov <i.zhbanov@samsung.com>
 * 2012.10 */

#define _BSD_SOURCE

/* Uncomment to disable asserts */
/*#define NDEBUG*/

#include <stdio.h>
#include <assert.h>
#include <stdarg.h>

#include "report-formatter-csv.h"

static const char report_csv_header[] = "PowerTOP Report";

/* ************************************************************************ */

report_formatter_csv::report_formatter_csv()
{
	add_doc_header();
}

/* ************************************************************************ */

void
report_formatter_csv::finish_report()
{
	/* Do nothing special */
}

/* ************************************************************************ */

void
report_formatter_csv::add_doc_header()
{
	add_header(report_csv_header, 1);
}

/* ************************************************************************ */

void
report_formatter_csv::add_header(const char *header, int level)
{
	assert(header);

	text_start = result.length();
	csv_need_quotes = false;
	addf("%.*s%s%.*s", 4 - level, "***", header, 4 - level, "***");
	add_quotes();
	add_exact("\n");
}

/* ************************************************************************ */

void
report_formatter_csv::begin_section(section_type stype)
{
	/* Do nothing special */
}

/* ************************************************************************ */

void
report_formatter_csv::end_section()
{
	/* Do nothing special */
}

/* ************************************************************************ */

void
report_formatter_csv::begin_table(table_type ttype)
{
	add_exact("\n");
}

/* ************************************************************************ */

void
report_formatter_csv::end_table()
{
	add_exact("\n");
}

/* ************************************************************************ */

void
report_formatter_csv::begin_row(row_type rtype)
{
	table_cell_number = 0;
}

/* ************************************************************************ */

void
report_formatter_csv::end_row()
{
	add_exact("\n");
}

/* ************************************************************************ */

void
report_formatter_csv::begin_cell(cell_type ctype)
{
	if (table_cell_number > 0) {
		addf_exact("%c", REPORT_CSV_DELIMITER);
#ifdef REPORT_CSV_ADD_SPACE
		add_exact(" ");
#endif /* !REPORT_CSV_ADD_SPACE */
	}

	text_start = result.length();
	csv_need_quotes = false;
}

/* ************************************************************************ */

void
report_formatter_csv::add_quotes()
{
#ifdef REPORT_CSV_ESCAPE_EMPTY
	if (csv_need_quotes || result.length() == text_start) {
#else /* !REPORT_CSV_ESCAPE_EMPTY */
	if (csv_need_quotes) {
#endif /* !REPORT_CSV_ESCAPE_EMPTY */
		result.insert(text_start, "\"");
		add_exact("\"");
	}
}

/* ************************************************************************ */

void
report_formatter_csv::end_cell()
{
	add_quotes();
	table_cell_number++;
}

/* ************************************************************************ */

void
report_formatter_csv::add_empty_cell()
{
	/* Do nothing special */
}

/* ************************************************************************ */

void
report_formatter_csv::begin_paragraph()
{
	text_start = result.length();
	csv_need_quotes = false;
}

/* ************************************************************************ */

void
report_formatter_csv::end_paragraph()
{
	add_quotes();
	add_exact("\n");
}

/* ************************************************************************ */

std::string
report_formatter_csv::escape_string(const char *str)
{
	std::string res;

	assert(str);

	for (const char *i = str; *i; i++) {
		switch (*i) {
			case '"':
				res += '"';
#ifdef REPORT_CSV_SPACE_NEED_QUOTES
			case ' ':
#endif /* REPORT_CSV_SPACE_NEED_QUOTES */
			case '\n':
			case REPORT_CSV_DELIMITER:
				csv_need_quotes = true;
				break;
		}

		res += *i;
	}

	return res;
}

/* ************************************************************************ */

void
report_formatter_csv::set_cpu_number(int nr UNUSED)
{
	/* Do nothing */
}