GncPreSplit Class Reference

Public Member Functions
	GncPreSplit (int date_format, int currency_format)
void	set (GncTransPropType prop_type, const std::string &value)
void	reset (GncTransPropType prop_type)
void	add (GncTransPropType prop_type, const std::string &value)
void	set_date_format (int date_format)
void	set_currency_format (int currency_format)
void	set_pre_trans (std::shared_ptr< GncPreTrans > pre_trans)
std::shared_ptr< GncPreTrans >	get_pre_trans (void)
StrVec	verify_essentials (void)
void	create_split (std::shared_ptr< DraftTransaction > draft_trans)
Account *	get_account ()
void	set_account (Account *acct)
ErrMap	errors ()

Detailed Description

Definition at line 221 of file gnc-imp-props-tx.hpp.

Constructor & Destructor Documentation

GncPreSplit()

GncPreSplit::GncPreSplit ( int  date_format, int  currency_format  )

inline

Definition at line 224 of file gnc-imp-props-tx.hpp.

                                                       : m_date_format{date_format},
        m_currency_format{currency_format} {};

Member Function Documentation

add()

void GncPreSplit::add	(	GncTransPropType	prop_type,
		const std::string &	value
	)

Definition at line 572 of file gnc-imp-props-tx.cpp.

{
    try
    {
        /* Don't try to add to a property that has an error already */
        if (m_errors.find(prop_type) != m_errors.cend())
            return;
 
        auto num_val = GncNumeric();
        switch (prop_type)
        {
            case GncTransPropType::AMOUNT:
                num_val = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                if (m_amount)
                    num_val += *m_amount;
                m_amount = num_val;
                break;
 
            case GncTransPropType::AMOUNT_NEG:
                num_val = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                if (m_amount_neg)
                    num_val += *m_amount_neg;
                m_amount_neg = num_val;
                break;
 
            case GncTransPropType::VALUE:
                num_val = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                if (m_value)
                    num_val += *m_value;
            m_value = num_val;
            break;
 
            case GncTransPropType::VALUE_NEG:
                num_val = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                if (m_value_neg)
                    num_val += *m_value_neg;
            m_value_neg = num_val;
            break;
 
            case GncTransPropType::TAMOUNT:
                num_val = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                if (m_tamount)
                    num_val += *m_tamount;
                m_tamount = num_val;
                break;
 
            case GncTransPropType::TAMOUNT_NEG:
                num_val = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                if (m_tamount_neg)
                    num_val += *m_tamount_neg;
                m_tamount_neg = num_val;
                break;
 
            default:
                /* Issue a warning for all other prop_types. */
                PWARN ("%d can't be used to add values in a split", static_cast<int>(prop_type));
                break;
        }
    }
    catch (const std::exception& e)
    {
        auto err_str = (bl::format (std::string{_("{1}: {2}")}) %
                        std::string{_(gnc_csv_col_type_strs[prop_type])} %
                        e.what()).str();
        m_errors.emplace(prop_type, err_str);
    }
}

create_split()

void GncPreSplit::create_split

(

std::shared_ptr< DraftTransaction >

draft_trans

)

Definition at line 712 of file gnc-imp-props-tx.cpp.

{
    if (created)
        return;
 
    /* Gently refuse to create the split if the basics are not set correctly
     * This should have been tested before calling this function though!
     */
    auto check = verify_essentials();
    if (!check.empty())
    {
        auto err_msg = std::string("Not creating split because essentials not set properly:");
        auto add_bullet_item = [](std::string& a, std::string& b)->std::string { return std::move(a) + "\n• " + b; };
        err_msg = std::accumulate (check.begin(), check.end(), std::move (err_msg), add_bullet_item);
        PWARN ("%s", err_msg.c_str());
        return;
    }
 
    auto splits_created = 0;
    Account *account = nullptr;
    Account *taccount = nullptr;
    auto amount = GncNumeric();
 
    if (m_account)
        account = *m_account;
    if (m_taccount)
        taccount = *m_taccount;
    if (m_amount)
        amount += *m_amount;
    if (m_amount_neg)
        amount -= *m_amount_neg;
 
    std::optional<GncNumeric> tamount;
    if (m_tamount || m_tamount_neg)
    {
        tamount = GncNumeric();
        if (m_tamount)
            *tamount += *m_tamount;
        if (m_tamount_neg)
            *tamount -= *m_tamount_neg;
    }
 
    /* Value can be calculated in several ways, depending on what
     * data was available in the csv import file.
     * Below code will prefer the method with the least
     * risk on rounding errors.
     * */
    auto value = GncNumeric();
    auto trans_curr = xaccTransGetCurrency(draft_trans->trans);
    auto acct_comm = xaccAccountGetCommodity(account);
    if (m_value || m_value_neg)
    {
        if (m_value)
            value += *m_value;
        if (m_value_neg)
            value -= *m_value_neg;
    }
    else if (gnc_commodity_equiv(trans_curr, acct_comm))
            value = amount;
    else if (tamount)
        value = -*tamount;
    else if (m_price)
        value = amount * *m_price;
    else
    {
        QofBook* book = xaccTransGetBook (draft_trans->trans);
        auto time = xaccTransRetDatePosted (draft_trans->trans);
        /* Import data didn't specify price, let's lookup the nearest in time */
        auto nprice =
        gnc_pricedb_lookup_nearest_in_time64(gnc_pricedb_get_db(book),
                                             acct_comm, trans_curr, time);
        GncNumeric rate = nprice ? gnc_price_get_value (nprice): gnc_numeric_zero();
        if (!gnc_numeric_zero_p (rate))
        {
            /* Found a usable price. Let's check if the conversion direction is right
             * Reminder: value = amount * price, or amount = value / price */
            if (gnc_commodity_equiv(gnc_price_get_currency(nprice), trans_curr))
                value = amount * rate;
            else
                value = amount * rate.inv();
        }
        else
            PERR("No price found, can't create this split.");
    }
 
    /* Add a split with the cumulative amount value. */
    trans_add_split (draft_trans->trans, account, amount, value, m_action, m_memo, m_rec_state, m_rec_date);
    splits_created++;
 
    if (taccount)
    {
        /* If a taccount is set that forcibly means we're processing a single-line
         * transaction. The csv importer will assume this can only create a
         * two-split transaction, so whatever transfer data is available, the
         * transfer split's value must balance the first split value. Remains
         * to determine: the transfer amount. As with value above, for single
         * currency case use transfer value. Otherwise calculate from whatever
         * is found in the csv data preferring minimal rounding calculations. */
        auto tvalue = -value;
        auto trans_curr = xaccTransGetCurrency(draft_trans->trans);
        auto acct_comm = xaccAccountGetCommodity(taccount);
        if (gnc_commodity_equiv(trans_curr, acct_comm))
            tamount = tvalue;
        else if (tamount)
            ; // Nothing to do, was already calculated
        else if (m_price)
            tamount = tvalue * m_price->inv();
        else
        {
            QofBook* book = xaccTransGetBook (draft_trans->trans);
            auto time = xaccTransRetDatePosted (draft_trans->trans);
            /* Import data didn't specify price, let's lookup the nearest in time */
            auto nprice =
            gnc_pricedb_lookup_nearest_in_time64(gnc_pricedb_get_db(book),
                                                    acct_comm, trans_curr, time);
            GncNumeric rate = nprice ? gnc_price_get_value (nprice): gnc_numeric_zero();
            if (!gnc_numeric_zero_p (rate))
            {
                /* Found a usable price. Let's check if the conversion direction is right
                    * Reminder: value = amount * price, or amount = value / price */
                if (gnc_commodity_equiv(gnc_price_get_currency(nprice), trans_curr))
                    tamount = tvalue * rate.inv();
                else
                    tamount = tvalue * rate;
            }
        }
        if (tamount)
        {
            trans_add_split (draft_trans->trans, taccount, *tamount, tvalue, m_taction, m_tmemo, m_trec_state, m_trec_date);
            splits_created++;
        }
            else
                PWARN("No price found, defer creation of second split to generic import matcher.");
    }
 
    if (splits_created == 1)
    {
        /* If we get here, we're either
         * - in multi-line mode
         * - or single-line mode but didn't have enough details to create the
         *   transfer split.
         * For the latter we will pass what we know about the transfer split to
         * allow the generic import matcher to ask the user for the final
         * details before creating this split.
         */
        draft_trans->m_price = m_price;
        draft_trans->m_taction = m_taction;
        draft_trans->m_tmemo = m_tmemo;
        draft_trans->m_tamount = tamount;
        draft_trans->m_taccount = m_taccount;
        draft_trans->m_trec_state = m_trec_state;
        draft_trans->m_trec_date = m_trec_date;
    }
 
    created = true;
}

errors()

ErrMap GncPreSplit::errors

(

void

)

Definition at line 869 of file gnc-imp-props-tx.cpp.

{
    return m_errors;
}

get_account()

Account * GncPreSplit::get_account ( )

inline

Definition at line 236 of file gnc-imp-props-tx.hpp.

{ if (m_account) return *m_account; else return nullptr; }

get_pre_trans()

std::shared_ptr< GncPreTrans > GncPreSplit::get_pre_trans ( void  )

inline

Definition at line 232 of file gnc-imp-props-tx.hpp.

{ return m_pre_trans; }

reset()

void GncPreSplit::reset

(

GncTransPropType

prop_type

)

Definition at line 564 of file gnc-imp-props-tx.cpp.

{
        set (prop_type, std::string());
        // Set with an empty string will effectively clear the property
        // but can also set an error for the property. Clear that error here.
        m_errors.erase(prop_type);
}

set()

void GncPreSplit::set	(	GncTransPropType	prop_type,
		const std::string &	value
	)

Definition at line 426 of file gnc-imp-props-tx.cpp.

{
    try
    {
        // Drop any existing error for the prop_type we're about to set
        m_errors.erase(prop_type);
 
        Account *acct = nullptr;
        switch (prop_type)
        {
            case GncTransPropType::ACTION:
                m_action.reset();
                if (!value.empty())
                    m_action = value;
                break;
 
            case GncTransPropType::TACTION:
                m_taction.reset();
                if (!value.empty())
                    m_taction = value;
                break;
 
            case GncTransPropType::ACCOUNT:
                m_account.reset();
                if (value.empty())
                    throw std::invalid_argument (_("Account value can't be empty."));
                if ((acct = gnc_account_imap_find_any (gnc_get_current_book(), IMAP_CAT_CSV, value.c_str())) ||
                    (acct = gnc_account_lookup_by_full_name (gnc_get_current_root_account(), value.c_str())))
                    m_account = acct;
                else
                    throw std::invalid_argument (_("Account value can't be mapped back to an account."));
                break;
 
            case GncTransPropType::TACCOUNT:
                m_taccount.reset();
                if (value.empty())
                    throw std::invalid_argument (_("Transfer account value can't be empty."));
 
                if ((acct = gnc_account_imap_find_any (gnc_get_current_book(), IMAP_CAT_CSV,value.c_str())) ||
                    (acct = gnc_account_lookup_by_full_name (gnc_get_current_root_account(), value.c_str())))
                    m_taccount = acct;
                else
                    throw std::invalid_argument (_("Transfer account value can't be mapped back to an account."));
                break;
 
            case GncTransPropType::MEMO:
                m_memo.reset();
                if (!value.empty())
                    m_memo = value;
                break;
 
            case GncTransPropType::TMEMO:
                m_tmemo.reset();
                if (!value.empty())
                    m_tmemo = value;
                break;
 
            case GncTransPropType::AMOUNT:
                m_amount.reset();
                m_amount = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                break;
 
            case GncTransPropType::AMOUNT_NEG:
                m_amount_neg.reset();
                m_amount_neg = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                break;
 
            case GncTransPropType::VALUE:
                m_value.reset();
                m_value = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                break;
 
            case GncTransPropType::VALUE_NEG:
                m_value_neg.reset();
                m_value_neg = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                break;
 
            case GncTransPropType::TAMOUNT:
                m_tamount.reset();
                m_tamount = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                break;
 
            case GncTransPropType::TAMOUNT_NEG:
                m_tamount_neg.reset();
                m_tamount_neg = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                break;
 
            case GncTransPropType::PRICE:
                /* Note while a price is not stricly a currency, it will likely use
                 * the same decimal point as currencies in the csv file, so parse
                 * using the same parser */
                m_price.reset();
                m_price = parse_monetary (value, m_currency_format); // Will throw if parsing fails
                break;
 
            case GncTransPropType::REC_STATE:
                m_rec_state.reset();
                m_rec_state = parse_reconciled (value); // Throws if parsing fails
                break;
 
            case GncTransPropType::TREC_STATE:
                m_trec_state.reset();
                m_trec_state = parse_reconciled (value); // Throws if parsing fails
                break;
 
            case GncTransPropType::REC_DATE:
                m_rec_date.reset();
                if (!value.empty())
                    m_rec_date = GncDate (value,
                                          GncDate::c_formats[m_date_format].m_fmt); // Throws if parsing fails
                break;
 
            case GncTransPropType::TREC_DATE:
                m_trec_date.reset();
                if (!value.empty())
                    m_trec_date = GncDate (value,
                                           GncDate::c_formats[m_date_format].m_fmt); // Throws if parsing fails
                break;
 
            default:
                /* Issue a warning for all other prop_types. */
                PWARN ("%d is an invalid property for a split", static_cast<int>(prop_type));
                break;
        }
    }
    catch (const std::exception& e)
    {
        auto err_str = (bl::format (std::string{_("{1}: {2}")}) %
                        std::string{_(gnc_csv_col_type_strs[prop_type])} %
                        e.what()).str();
        m_errors.emplace(prop_type, err_str);
    }
 
    /* Extra currency related postprocessing for account type */
    if (prop_type == GncTransPropType::ACCOUNT)
        UpdateCrossSplitCounters();
}

set_account()

void GncPreSplit::set_account

(

Account *

acct

)

Definition at line 875 of file gnc-imp-props-tx.cpp.

{
    if (acct)
        m_account = acct;
    else
        m_account.reset();
 
    UpdateCrossSplitCounters();
}

set_currency_format()

void GncPreSplit::set_currency_format ( int  currency_format )

inline

Definition at line 230 of file gnc-imp-props-tx.hpp.

{ m_currency_format = currency_format; }

set_date_format()

void GncPreSplit::set_date_format ( int  date_format )

inline

Definition at line 229 of file gnc-imp-props-tx.hpp.

{ m_date_format = date_format ;}

set_pre_trans()

void GncPreSplit::set_pre_trans ( std::shared_ptr< GncPreTrans >  pre_trans )

inline

Definition at line 231 of file gnc-imp-props-tx.hpp.

{ m_pre_trans = pre_trans; }

verify_essentials()

StrVec GncPreSplit::verify_essentials

(

void

)

Definition at line 640 of file gnc-imp-props-tx.cpp.

{
    auto err_msg = StrVec();
    /* Make sure this split has the minimum required set of properties defined. */
    if (!m_amount && !m_amount_neg)
        err_msg.emplace_back (_("No amount or negated amount column."));
 
    if (m_rec_state && *m_rec_state == YREC && !m_rec_date)
        err_msg.emplace_back (_("Split is reconciled but reconcile date column is missing or invalid."));
 
    if (m_trec_state && *m_trec_state == YREC && !m_trec_date)
        err_msg.emplace_back (_("Transfer split is reconciled but transfer reconcile date column is missing or invalid."));
 
 
    /* When current account selections imply multi-currency
     * transactions, we require extra columns to ensure each split is
     * fully defined.
     * Note this check only involves splits created by the csv importer
     * code. The generic import matcher may add a balancing split
     * optionally using Transfer <something> properties. The generic
     * import matcher has its own tools to balance that split so
     * we won't concern ourselves with that one here.
     */
    if (m_pre_trans->is_multi_currency())
    {
        if (m_pre_trans->m_multi_split && !m_price && !m_value && !m_value_neg)
            err_msg.emplace_back( _("Choice of accounts makes this a multi-currency transaction but price or (negated) value column is missing or invalid."));
        else if (!m_pre_trans->m_multi_split &&
            !m_price && !m_value && !m_value_neg && !m_tamount && !m_tamount_neg )
            err_msg.emplace_back( _("Choice of accounts makes this a multi-currency transaction but price, (negated) value or (negated) transfer amount column is missing or invalid."));
    }
 
    return err_msg;
}

---

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

• gnc-imp-props-tx.hpp
• gnc-imp-props-tx.cpp