CsvPriceImpSettings Struct Reference

Inheritance diagram for CsvPriceImpSettings:

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.
Public Member Functions inherited from CsvImportSettings
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
gnc_commodity *	m_from_commodity
gnc_commodity *	m_to_currency
std::vector< GncPricePropType >	m_column_types_price
Data Fields inherited from CsvImportSettings
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
const char *	get_group_prefix (void) override

Detailed Description

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

Constructor & Destructor Documentation

CsvPriceImpSettings()

CsvPriceImpSettings::CsvPriceImpSettings ( )

inline

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

: m_from_commodity {nullptr}, m_to_currency {nullptr} { }

Member Function Documentation

get_group_prefix()

const char * CsvPriceImpSettings::get_group_prefix ( void  )

overrideprotectedvirtual

Implements CsvImportSettings.

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

{
    return group_prefix;
}

load()

bool CsvPriceImpSettings::load

(

void

)

Load the widget properties from a key File.

Returns

true if there was a problem.

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

{
    if (preset_is_reserved_name (m_name))
        return true;
 
    GError *key_error = nullptr;
    m_load_error = false;
    auto keyfile = gnc_state_get_current ();
    auto group = get_group_prefix() + m_name;
 
    // Start Loading the settings
    m_load_error = CsvImportSettings::load(); // load the common settings
 
    gchar *key_char = g_key_file_get_string (keyfile, group.c_str(), CSV_TO_CURR, &key_error);
    if (key_char && *key_char != '\0')
        m_to_currency = parse_commodity_price_comm (key_char, "");
    m_load_error |= handle_load_error (&key_error, group);
    if (key_char)
        g_free (key_char);
 
    key_char = g_key_file_get_string (keyfile, group.c_str(), CSV_FROM_COMM, &key_error);
    if (key_char && *key_char != '\0')
        m_from_commodity = parse_commodity_price_comm (key_char, "");
    m_load_error |= handle_load_error (&key_error, group);
    if (key_char)
        g_free (key_char);
 
    gsize list_len;
    m_column_types_price.clear();
    gchar** col_types_str_price = g_key_file_get_string_list (keyfile, group.c_str(), CSV_COL_TYPES,
            &list_len, &key_error);
    for (uint32_t i = 0; i < list_len; i++)
    {
        auto col_types_it = std::find_if (gnc_price_col_type_strs.begin(),
                gnc_price_col_type_strs.end(), test_price_prop_type_str (col_types_str_price[i]));
        auto prop = GncPricePropType::NONE;
        if (col_types_it != gnc_price_col_type_strs.end())
            // Found a valid column type
            prop = col_types_it->first;
        else
            PWARN("Found invalid column type '%s' in group '%s'. Inserting column type 'NONE' instead'.",
                    col_types_str_price[i], group.c_str());
        m_column_types_price.push_back(prop);
    }
    if (col_types_str_price)
        g_strfreev (col_types_str_price);
 
    return m_load_error;
}

remove()

void CsvPriceImpSettings::remove

(

void

)

Remove the preset from the state file.

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

{
    if (preset_is_reserved_name (m_name))
        return;
 
    CsvImportSettings::remove();
}

save()

bool CsvPriceImpSettings::save

(

void

)

Save the gathered widget properties to a key File.

Returns

true if there was a problem in saving.

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

{
    if (preset_is_reserved_name (m_name))
    {
        PWARN ("Ignoring attempt to save to reserved name '%s'", m_name.c_str());
        return true;
    }
 
    if ((m_name.find('[') != std::string::npos))
    {
        PWARN ("Name '%s' contains invalid characters '[]'. Refusing to save", m_name.c_str());
        return true;
    }
 
    auto keyfile = gnc_state_get_current ();
    auto group = get_group_prefix() + m_name;
 
    // Drop previous saved settings with this name
    g_key_file_remove_group (keyfile, group.c_str(), nullptr);
 
    // Start Saving the settings
    bool error = CsvImportSettings::save(); // save the common settings
 
    if (error)
        return error;
 
    if (m_to_currency)
    {
        auto unique_name = g_strconcat (gnc_commodity_get_namespace (m_to_currency), "::",
                           gnc_commodity_get_mnemonic (m_to_currency), nullptr);
        g_key_file_set_string (keyfile, group.c_str(), CSV_TO_CURR, unique_name);
        g_free (unique_name);
    }
 
    if (m_from_commodity)
    {
        auto unique_name = g_strconcat (gnc_commodity_get_namespace (m_from_commodity), "::",
                           gnc_commodity_get_mnemonic (m_from_commodity), nullptr);
        g_key_file_set_string (keyfile, group.c_str(), CSV_FROM_COMM, unique_name);
        g_free (unique_name);
    }
 
    std::vector<const char*> col_types_str_price;
    for (auto col_type : m_column_types_price)
        col_types_str_price.push_back(gnc_price_col_type_strs[col_type]);
 
    if (!col_types_str_price.empty())
        g_key_file_set_string_list (keyfile, group.c_str(), CSV_COL_TYPES,
                col_types_str_price.data(), col_types_str_price.size());
 
    return error;
}

Field Documentation

m_column_types_price

std::vector<GncPricePropType> CsvPriceImpSettings::m_column_types_price

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

m_from_commodity

gnc_commodity* CsvPriceImpSettings::m_from_commodity

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

m_to_currency

gnc_commodity* CsvPriceImpSettings::m_to_currency

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

---

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

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