CsvImportSettings Struct Reference

Inheritance diagram for CsvImportSettings:

Public Member Functions
bool	save (void)
	Save the gathered widget properties to a key File.
bool	load (void)
	Load the widget properties from a key File.
void	remove (void)
	Remove the preset from the state file.

Data Fields
std::string	m_name
GncImpFileFormat	m_file_format
std::string	m_encoding
int	m_date_format
int	m_currency_format
uint32_t	m_skip_start_lines
uint32_t	m_skip_end_lines
bool	m_skip_alt_lines
std::string	m_separators
bool	m_enable_escape
bool	m_load_error
std::vector< uint32_t >	m_column_widths

Protected Member Functions
virtual const char *	get_group_prefix (void)=0

Detailed Description

Definition at line 51 of file gnc-imp-settings-csv.hpp.

Constructor & Destructor Documentation

CsvImportSettings()

CsvImportSettings::CsvImportSettings ( )

inline

Definition at line 53 of file gnc-imp-settings-csv.hpp.

                        : m_file_format (GncImpFileFormat::CSV), m_encoding {"UTF-8"},
            m_date_format {0}, m_currency_format {0},
            m_skip_start_lines{0}, m_skip_end_lines{0}, m_skip_alt_lines (false),
            m_separators {","}, m_enable_escape {true}, m_load_error {false} { }

Member Function Documentation

load()

bool CsvImportSettings::load

(

void

)

Load the widget properties from a key File.

Returns

true if there was a problem.

Definition at line 123 of file gnc-imp-settings-csv.cpp.

{
    GError *key_error = nullptr;
    m_load_error = false;
    auto group = get_group_prefix() + m_name;
    auto keyfile = gnc_state_get_current ();
 
    m_skip_start_lines = g_key_file_get_integer (keyfile, group.c_str(), CSV_SKIP_START, &key_error);
    m_load_error |= handle_load_error (&key_error, group);
 
    m_skip_end_lines = g_key_file_get_integer (keyfile, group.c_str(), CSV_SKIP_END, &key_error);
    m_load_error |= handle_load_error (&key_error, group);
 
    m_skip_alt_lines = g_key_file_get_boolean (keyfile, group.c_str(), CSV_SKIP_ALT, &key_error);
    m_load_error |= handle_load_error (&key_error, group);
 
    auto csv_format = g_key_file_get_boolean (keyfile, group.c_str(), CSV_FORMAT, &key_error);
    if (key_error) csv_format = true; // default to true, but above command will return false in case of error
    m_load_error |= handle_load_error (&key_error, group);
    if (csv_format)
        m_file_format = GncImpFileFormat::CSV;
    else
        m_file_format = GncImpFileFormat::FIXED_WIDTH;
 
    gchar *key_char = g_key_file_get_string (keyfile, group.c_str(), CSV_SEP, &key_error);
    if (key_char && *key_char != '\0')
        m_separators = key_char;
    m_load_error |= handle_load_error (&key_error, group);
    if (key_char)
        g_free (key_char);
 
    m_enable_escape = g_key_file_get_boolean (keyfile, group.c_str(), CSV_ESC, &key_error);
    // Older import settings will not have a value for escape processing
    // so set it to true if no value is found in the file format settings
    if (key_error && key_error->code == G_KEY_FILE_ERROR_KEY_NOT_FOUND)
        m_enable_escape = true;
    else
        m_load_error |= handle_load_error (&key_error, group);
 
    m_date_format = g_key_file_get_integer (keyfile, group.c_str(), CSV_DATE, &key_error);
    m_load_error |= handle_load_error (&key_error, group);
 
    m_currency_format = g_key_file_get_integer (keyfile, group.c_str(), CSV_CURRENCY, &key_error);
    m_load_error |= handle_load_error (&key_error, group);
 
    key_char = g_key_file_get_string (keyfile, group.c_str(), CSV_ENCODING, &key_error);
    if (key_char && *key_char != '\0')
        m_encoding = key_char;
    else
        m_encoding = "UTF-8";
    m_load_error |= handle_load_error (&key_error, group);
    if (key_char)
        g_free (key_char);
 
    // Widths
    gsize list_len;
    m_column_widths.clear();
    gint *col_widths_int = g_key_file_get_integer_list (keyfile, group.c_str(), CSV_COL_WIDTHS,
            &list_len, &key_error);
    for (uint32_t i = 0; i < list_len; i++)
    {
        if (col_widths_int[i] > 0)
            m_column_widths.push_back(col_widths_int[i]);
    }
    m_load_error |= handle_load_error (&key_error, group);
    if (col_widths_int)
        g_free (col_widths_int);
 
    return m_load_error;
}

remove()

void CsvImportSettings::remove

(

void

)

Remove the preset from the state file.

Definition at line 255 of file gnc-imp-settings-csv.cpp.

{
    auto keyfile = gnc_state_get_current ();
    auto group = get_group_prefix() + m_name;
    g_key_file_remove_group (keyfile, group.c_str(), nullptr);
}

save()

bool CsvImportSettings::save

(

void

)

Save the gathered widget properties to a key File.

Returns

true if there was a problem in saving.

Definition at line 200 of file gnc-imp-settings-csv.cpp.

{
    auto keyfile = gnc_state_get_current ();
    auto group = get_group_prefix() + m_name;
 
    // Start Saving the Common settings
    g_key_file_set_string (keyfile, group.c_str(), CSV_NAME, m_name.c_str());
 
    g_key_file_set_integer (keyfile, group.c_str(), CSV_SKIP_START, m_skip_start_lines);
    g_key_file_set_integer (keyfile, group.c_str(), CSV_SKIP_END, m_skip_end_lines);
    g_key_file_set_boolean (keyfile, group.c_str(), CSV_SKIP_ALT, m_skip_alt_lines);
    g_key_file_set_boolean (keyfile, group.c_str(), CSV_FORMAT,
        (m_file_format == GncImpFileFormat::CSV) ? true : false);
 
    g_key_file_set_string (keyfile, group.c_str(), CSV_SEP, m_separators.c_str());
    g_key_file_set_boolean (keyfile, group.c_str(), CSV_ESC, m_enable_escape);
    g_key_file_set_integer (keyfile, group.c_str(), CSV_DATE, m_date_format);
    std::ostringstream cmt_ss;
    cmt_ss << "Supported date formats: ";
    int fmt_num = 0;
    std::for_each (GncDate::c_formats.cbegin(), GncDate::c_formats.cend(),
                    [&cmt_ss, &fmt_num](const GncDateFormat& fmt)
                        { cmt_ss << fmt_num++ << ": '" << fmt.m_fmt << "', "; });
    auto cmt = cmt_ss.str().substr(0, static_cast<long>(cmt_ss.tellp()) - 2);
    g_key_file_set_comment (keyfile, group.c_str(), CSV_DATE, cmt.c_str(), nullptr);
    g_key_file_set_integer (keyfile, group.c_str(), CSV_CURRENCY, m_currency_format);
    g_key_file_set_string (keyfile, group.c_str(), CSV_ENCODING, m_encoding.c_str());
 
    if (!m_column_widths.empty())
        g_key_file_set_integer_list (keyfile, group.c_str(), CSV_COL_WIDTHS,
                (gint*)(m_column_widths.data()), m_column_widths.size());
 
    // Do a test read of encoding
    GError *key_error = nullptr;
    bool error = false;
    auto enc_val = g_key_file_get_string (keyfile, group.c_str(), CSV_ENCODING, &key_error);
    auto enc_str = std::string{enc_val};
    if (enc_val)
        g_free (enc_val);
 
    if ((key_error) || (enc_str != m_encoding.c_str()))
    {
        if (key_error)
        {
            g_warning ("Error reading group %s key %s: %s", group.c_str(), CSV_ENCODING, key_error->message);
            g_error_free (key_error);
        }
        else
            g_warning ("Error comparing group %s key %s: '%s' and '%s'", group.c_str(), CSV_ENCODING, enc_str.c_str(), group.c_str());
        error = true;
    }
    return error;
}

Field Documentation

m_column_widths

std::vector<uint32_t> CsvImportSettings::m_column_widths

Definition at line 87 of file gnc-imp-settings-csv.hpp.

m_currency_format

int CsvImportSettings::m_currency_format

Definition at line 80 of file gnc-imp-settings-csv.hpp.

m_date_format

int CsvImportSettings::m_date_format

Definition at line 79 of file gnc-imp-settings-csv.hpp.

m_enable_escape

bool CsvImportSettings::m_enable_escape

Definition at line 85 of file gnc-imp-settings-csv.hpp.

m_encoding

std::string CsvImportSettings::m_encoding

Definition at line 78 of file gnc-imp-settings-csv.hpp.

m_file_format

GncImpFileFormat CsvImportSettings::m_file_format

Definition at line 77 of file gnc-imp-settings-csv.hpp.

m_load_error

bool CsvImportSettings::m_load_error

Definition at line 86 of file gnc-imp-settings-csv.hpp.

m_name

std::string CsvImportSettings::m_name

Definition at line 76 of file gnc-imp-settings-csv.hpp.

m_separators

std::string CsvImportSettings::m_separators

Definition at line 84 of file gnc-imp-settings-csv.hpp.

m_skip_alt_lines

bool CsvImportSettings::m_skip_alt_lines

Definition at line 83 of file gnc-imp-settings-csv.hpp.

m_skip_end_lines

uint32_t CsvImportSettings::m_skip_end_lines

Definition at line 82 of file gnc-imp-settings-csv.hpp.

m_skip_start_lines

uint32_t CsvImportSettings::m_skip_start_lines

Definition at line 81 of file gnc-imp-settings-csv.hpp.

---

The documentation for this struct was generated from the following files:

• gnc-imp-settings-csv.hpp
• gnc-imp-settings-csv.cpp