CsvTransImpSettings Struct Reference

Inheritance diagram for CsvTransImpSettings:

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
Account *	m_base_account
bool	m_multi_split
std::vector< GncTransPropType >	m_column_types
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-tx.hpp.

Constructor & Destructor Documentation

CsvTransImpSettings()

CsvTransImpSettings::CsvTransImpSettings ( )

inline

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

: m_base_account {nullptr}, m_multi_split (false) { }

Member Function Documentation

get_group_prefix()

const char * CsvTransImpSettings::get_group_prefix ( void  )

overrideprotectedvirtual

Implements CsvImportSettings.

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

{
    return group_prefix;
}

load()

bool CsvTransImpSettings::load

(

void

)

Load the widget properties from a key File.

Returns

true if there was a problem.

Definition at line 193 of file gnc-imp-settings-csv-tx.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
 
    m_multi_split = g_key_file_get_boolean (keyfile, group.c_str(), CSV_MULTI_SPLIT, &key_error);
    m_load_error |= handle_load_error (&key_error, group);
 
    gchar *key_char = g_key_file_get_string (keyfile, group.c_str(), CSV_ACCOUNT_GUID, &key_error);
    if (key_char && *key_char != '\0')
    {
        QofBook* book = gnc_get_current_book ();
        GncGUID guid;
 
        if (string_to_guid (key_char, &guid)) // find account by guid first
            m_base_account = xaccAccountLookup (&guid, book);
    }
    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_ACCOUNT, &key_error);
    if (key_char && *key_char != '\0')
    {
        if (m_base_account == nullptr)
        {
            m_base_account = gnc_account_lookup_by_full_name (gnc_get_current_root_account(), key_char);
 
            if (m_base_account) // save the account as guid, introduced in version 4.5
            {
                gchar acct_guid[GUID_ENCODING_LENGTH + 1];
                guid_to_string_buff (xaccAccountGetGUID (m_base_account), acct_guid);
                g_key_file_set_string (keyfile, group.c_str(), CSV_ACCOUNT_GUID, acct_guid);
            }
        }
        else // check to see if saved full name is the same and save if not
        {
            gchar *full_name = gnc_account_get_full_name (m_base_account);
 
            if (g_strcmp0 (key_char, full_name) != 0)
                g_key_file_set_string (keyfile, group.c_str(), CSV_ACCOUNT, full_name);
            g_free (full_name);
        }
    }
    m_load_error |= handle_load_error (&key_error, group);
    if (key_char)
        g_free (key_char);
 
    gsize list_len;
    m_column_types.clear();
    gchar** col_types_str = 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++)
    {
        /* Special case a few legacy column names */
        const char *col_type_str = col_types_str[i];
        if (!g_strcmp0(col_type_str, "Deposit"))  // -> "Amount"
            col_type_str = gnc_csv_col_type_strs[GncTransPropType::AMOUNT];
        if (!g_strcmp0(col_type_str, "Withdrawal"))  // -> "Amount (Negated)"
            col_type_str = gnc_csv_col_type_strs[GncTransPropType::AMOUNT_NEG];
        if (!g_strcmp0(col_type_str, "Num"))  // -> "Number"
            col_type_str = gnc_csv_col_type_strs[GncTransPropType::NUM];
        auto col_types_it = std::find_if (gnc_csv_col_type_strs.begin(),
                gnc_csv_col_type_strs.end(), test_prop_type_str (col_type_str));
        auto prop = GncTransPropType::NONE;
        if (col_types_it != gnc_csv_col_type_strs.end())
        {
            /* Found a valid column type. Now check whether it is allowed
             * in the selected mode (two-split vs multi-split) */
            prop = sanitize_trans_prop (col_types_it->first, m_multi_split);
            if (prop != col_types_it->first)
                PWARN("Found column type '%s', but this is blacklisted when multi-split mode is %s. "
                      "Inserting column type 'NONE' instead'.",
                        col_types_it->second, m_multi_split ? "enabled" : "disabled");
        }
        else
            PWARN("Found invalid column type '%s'. Inserting column type 'NONE' instead'.",
                  col_types_str[i]);
        m_column_types.push_back(prop);
    }
    if (col_types_str)
        g_strfreev (col_types_str);
 
    return m_load_error;
}

remove()

void CsvTransImpSettings::remove

(

void

)

Remove the preset from the state file.

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

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

save()

bool CsvTransImpSettings::save

(

void

)

Save the gathered widget properties to a key File.

Returns

true if there was a problem in saving.

Definition at line 293 of file gnc-imp-settings-csv-tx.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;
 
    g_key_file_set_boolean (keyfile, group.c_str(), CSV_MULTI_SPLIT, m_multi_split);
 
    if (m_base_account) // also save account guid introduced in version 4.5
    {
        gchar acct_guid[GUID_ENCODING_LENGTH + 1];
        guid_to_string_buff (xaccAccountGetGUID (m_base_account), acct_guid);
        g_key_file_set_string (keyfile, group.c_str(), CSV_ACCOUNT_GUID, acct_guid);
 
        gchar *full_name = gnc_account_get_full_name (m_base_account);
        g_key_file_set_string (keyfile, group.c_str(), CSV_ACCOUNT, full_name);
        g_free (full_name);
    }
 
    std::vector<const char*> col_types_str;
    for (auto col_type : m_column_types)
        col_types_str.push_back(gnc_csv_col_type_strs[col_type]);
 
    if (!col_types_str.empty())
        g_key_file_set_string_list (keyfile, group.c_str(), CSV_COL_TYPES,
                col_types_str.data(), col_types_str.size());
 
    return error;
}

Field Documentation

m_base_account

Account* CsvTransImpSettings::m_base_account

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

m_column_types

std::vector<GncTransPropType> CsvTransImpSettings::m_column_types

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

m_multi_split

bool CsvTransImpSettings::m_multi_split

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

---

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

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