Holds the configuration information from the fieldmask and the data to create a single split. More...

Inheritance diagram for StockTransactionEntry:

Public Member Functions
	StockTransactionEntry (const char action, const char kvp_tag)

	StockTransactionEntry (const StockTransactionEntry &)=default

virtual void	set_fieldmask (FieldMask mask)
	Set up the state variables from the FieldMask.

virtual bool	enabled () const

virtual bool	debit_side () const

virtual void	set_capitalize (bool capitalize)

virtual bool	input_new_balance () const

virtual bool	do_capitalize () const

virtual void	set_account (Account *account)

virtual Account *	account () const

virtual const char *	print_account () const

virtual void	set_memo (const char *memo)

virtual const char *	get_kvp_tag ()

virtual const char *	memo () const

virtual void	set_value (gnc_numeric amount)

virtual GncNumeric	value ()

virtual void	set_amount (gnc_numeric)

virtual gnc_numeric	amount () const

virtual bool	has_amount () const

virtual bool	marker_split () const

virtual void	validate_amount (Logger &) const

virtual void	set_balance (gnc_numeric balance)

virtual gnc_numeric	get_balance () const

virtual void	create_split (Transaction *trans, AccountVec &commits) const

virtual const char *	print_value () const

virtual const char *	print_amount (gnc_numeric amt) const

virtual std::string	amount_str_for_display () const
	Generate a string representation of the value.

virtual gnc_numeric	calculate_price () const
	Calculate the price (amount/value) for non-currency accounts.

virtual const char *	print_price () const

Protected Attributes
bool	m_enabled

bool	m_debit_side

bool	m_allow_zero

bool	m_allow_negative

bool	m_input_new_balance = false

Account *	m_account

gnc_numeric	m_value

const char *	m_memo

const char *	m_action

gnc_numeric	m_balance = gnc_numeric_zero()

const char *	m_kvp_tag

int	m_qof_event_handler

Detailed Description

Holds the configuration information from the fieldmask and the data to create a single split.

The base class is used for cash splits to currency accounts. Except as noted the functions are simple accessors and setters that don't need much documentation.

Definition at line 534 of file assistant-stock-transaction.cpp.

Constructor & Destructor Documentation

◆ StockTransactionEntry() [1/2]

StockTransactionEntry::StockTransactionEntry ( )

inline

Definition at line 550 of file assistant-stock-transaction.cpp.

                            :
        m_enabled{false}, m_debit_side{false}, m_allow_zero{false},  m_account{nullptr},
        m_value{gnc_numeric_error(GNC_ERROR_ARG)}, m_memo{nullptr}, m_action{nullptr},
        m_kvp_tag{nullptr}, m_qof_event_handler{qof_event_register_handler(account_destroyed_handler, this)} {}

◆ StockTransactionEntry() [2/2]

StockTransactionEntry::StockTransactionEntry	(	const char *	action,
		const char *	kvp_tag
	)

inline

Definition at line 554 of file assistant-stock-transaction.cpp.

                                                                   :
        m_enabled{false}, m_debit_side{false}, m_allow_zero{false},  m_account{nullptr},
        m_value{gnc_numeric_error(GNC_ERROR_ARG)}, m_memo{nullptr}, m_action{action},
        m_kvp_tag{kvp_tag}, m_qof_event_handler{qof_event_register_handler(account_destroyed_handler, this)} {}

◆ ~StockTransactionEntry()

virtual StockTransactionEntry::~StockTransactionEntry ( )

inlinevirtual

Definition at line 559 of file assistant-stock-transaction.cpp.

559{ qof_event_unregister_handler(m_qof_event_handler); }

qof_event_unregister_handler

void qof_event_unregister_handler(gint handler_id)

Unregister an event handler.

Definition qofevent.cpp:103

Member Function Documentation

◆ account()

virtual Account * StockTransactionEntry::account ( ) const

inlinevirtual

Definition at line 571 of file assistant-stock-transaction.cpp.

571{ return m_account; }

◆ amount()

virtual gnc_numeric StockTransactionEntry::amount ( ) const

inlinevirtual

Definition at line 579 of file assistant-stock-transaction.cpp.

579{ return m_value; }

◆ amount_str_for_display()

virtual std::string StockTransactionEntry::amount_str_for_display ( ) const

inlinevirtual

Generate a string representation of the value.

Internally uses xaccPrintAmount, which writes to a static string, so the result is copied to a std::string to prevent it being replaced by subsequent calls.

Returns: a std:sstring containing a representation of the value.

Reimplemented in StockTransactionStockEntry.

Definition at line 613 of file assistant-stock-transaction.cpp.

613{ return ""; }

◆ calculate_price()

virtual gnc_numeric StockTransactionEntry::calculate_price ( ) const

inlinevirtual

Calculate the price (amount/value) for non-currency accounts.

Note that multiple currencies in stock transaction s are not supported.

Returns: The calculated price for the Stock entry, GNC_ERROR_ARG otherwise.

Reimplemented in StockTransactionStockEntry.

Definition at line 620 of file assistant-stock-transaction.cpp.

620{ return gnc_numeric_error(GNC_ERROR_ARG); }

◆ create_split()

void StockTransactionEntry::create_split	(	Transaction *	trans,
		AccountVec &	commits
	)		const

virtual

Definition at line 740 of file assistant-stock-transaction.cpp.

{
  g_return_if_fail(trans);
  if (!m_account || gnc_numeric_check(m_value))
    return;
  auto split = xaccMallocSplit(qof_instance_get_book(trans));
  xaccSplitSetParent(split, trans);
  xaccAccountBeginEdit(m_account);
  account_commits.push_back(m_account);
  xaccSplitSetAccount(split, m_account);
  xaccSplitSetMemo(split, m_memo);
  if (m_enabled)
      xaccSplitSetValue(split, m_debit_side ? m_value : gnc_numeric_neg(m_value));
  xaccSplitSetAmount(split, amount());
  PINFO("creating %s split in Acct(%s): Val(%s), Amt(%s) => Val(%s), Amt(%s)",
        m_action, m_account ? xaccAccountGetName (m_account) : "Empty!",
        gnc_num_dbg_to_string(m_value),
        gnc_num_dbg_to_string(amount()),
        gnc_num_dbg_to_string(xaccSplitGetValue(split)),
        gnc_num_dbg_to_string(xaccSplitGetAmount(split)));
  gnc_set_num_action(nullptr, split, nullptr,
                     g_dpgettext2(nullptr, "Stock Assistant: Action field",
                                  m_action));
}

◆ debit_side()

virtual bool StockTransactionEntry::debit_side ( ) const

inlinevirtual

Definition at line 566 of file assistant-stock-transaction.cpp.

566{ return m_debit_side; }

◆ do_capitalize()

virtual bool StockTransactionEntry::do_capitalize ( ) const

inlinevirtual

Definition at line 569 of file assistant-stock-transaction.cpp.

569{ return false; }

◆ enabled()

virtual bool StockTransactionEntry::enabled ( ) const

inlinevirtual

Definition at line 565 of file assistant-stock-transaction.cpp.

565{ return m_enabled; }

◆ get_balance()

virtual gnc_numeric StockTransactionEntry::get_balance ( ) const

inlinevirtual

Definition at line 589 of file assistant-stock-transaction.cpp.

589{ return m_balance; }

◆ get_kvp_tag()

virtual const char * StockTransactionEntry::get_kvp_tag ( )

inlinevirtual

Definition at line 574 of file assistant-stock-transaction.cpp.

574{ return m_kvp_tag; }

◆ has_amount()

virtual bool StockTransactionEntry::has_amount ( ) const

inlinevirtual

Definition at line 580 of file assistant-stock-transaction.cpp.

580{ return false; }

◆ input_new_balance()

virtual bool StockTransactionEntry::input_new_balance ( ) const

inlinevirtual

Definition at line 568 of file assistant-stock-transaction.cpp.

568{ return m_input_new_balance; }

◆ marker_split()

virtual bool StockTransactionEntry::marker_split ( ) const

inlinevirtual

Definition at line 581 of file assistant-stock-transaction.cpp.

581{ return false; }

◆ memo()

virtual const char * StockTransactionEntry::memo ( ) const

inlinevirtual

Definition at line 575 of file assistant-stock-transaction.cpp.

575{ return m_memo; }

◆ print_account()

const char * StockTransactionEntry::print_account ( ) const

virtual

Definition at line 649 of file assistant-stock-transaction.cpp.

{
    auto acct_required = m_enabled &&
        !(m_allow_zero && (gnc_numeric_zero_p(m_value) ||
                           gnc_numeric_check(m_value)));
    return m_account ? xaccAccountGetName(m_account) :
        acct_required ? _("missing") : "";
}

◆ print_amount()

const char * StockTransactionEntry::print_amount ( gnc_numeric amt ) const

virtual

Returns: a string representation of the amount.

Definition at line 730 of file assistant-stock-transaction.cpp.

{
    if (!m_account || gnc_numeric_check(amt))
        return nullptr;
    auto commodity{xaccAccountGetCommodity(m_account)};
    auto pinfo{gnc_commodity_print_info(commodity, TRUE)};
    return xaccPrintAmount(amt, pinfo);
}

◆ print_price()

const char * StockTransactionEntry::print_price ( ) const

virtual

Returns: a string representation of the price if valid.

Definition at line 766 of file assistant-stock-transaction.cpp.

{
    auto price{calculate_price()};
    if (gnc_numeric_check(price))
//Translators: "N/A" here means that a commodity doesn't have a valid price.
        return _("N/A");
    auto currency{gnc_account_get_currency_or_parent(m_account)};
    auto pinfo{gnc_price_print_info(currency, TRUE)};
    return xaccPrintAmount(price, pinfo);
}

◆ print_value()

const char * StockTransactionEntry::print_value ( ) const

virtual

Returns: a string representation of the value.

Definition at line 709 of file assistant-stock-transaction.cpp.

{
    if (!m_enabled || (gnc_numeric_check(m_value) && m_allow_zero))
        return nullptr;
 
    if ((gnc_numeric_check(m_value) || gnc_numeric_zero_p(m_value))
        && !m_allow_zero)
        return _("missing");
 
    /* Don't combine this with the first if, it would prevent showing
     * "missing" when the value is required.
     */
    if (!m_account)
        return nullptr;
 
    auto currency{gnc_account_get_currency_or_parent(m_account)};
    auto pinfo{gnc_commodity_print_info(currency, TRUE)};
    return xaccPrintAmount(m_value, pinfo);
}

◆ set_account()

virtual void StockTransactionEntry::set_account ( Account * account )

inlinevirtual

Definition at line 570 of file assistant-stock-transaction.cpp.

570{ m_account = account; }

◆ set_amount()

virtual void StockTransactionEntry::set_amount ( gnc_numeric )

inlinevirtual

Definition at line 578 of file assistant-stock-transaction.cpp.

578{}

◆ set_balance()

virtual void StockTransactionEntry::set_balance ( gnc_numeric balance )

inlinevirtual

Definition at line 588 of file assistant-stock-transaction.cpp.

588{ m_balance = balance; }

◆ set_capitalize()

virtual void StockTransactionEntry::set_capitalize ( bool capitalize )

inlinevirtual

Definition at line 567 of file assistant-stock-transaction.cpp.

567{}

◆ set_fieldmask()

void StockTransactionEntry::set_fieldmask ( FieldMask mask )

virtual

Set up the state variables from the FieldMask.

Parameters

A	Fieldmast to configure the StockTransactionEntry.

Reimplemented in StockTransactionStockEntry, and StockTransactionFeesEntry.

Definition at line 640 of file assistant-stock-transaction.cpp.

{
    m_enabled = mask != FieldMask::DISABLED;
    m_debit_side = mask & FieldMask::ENABLED_DEBIT;
    m_allow_zero = mask & FieldMask::ALLOW_ZERO;
    m_allow_negative = mask & FieldMask::ALLOW_NEGATIVE;
}

◆ set_memo()

virtual void StockTransactionEntry::set_memo ( const char * memo )

inlinevirtual

Definition at line 573 of file assistant-stock-transaction.cpp.

573{ m_memo = memo; }

◆ set_value()

void StockTransactionEntry::set_value ( gnc_numeric amount )

virtual

Definition at line 659 of file assistant-stock-transaction.cpp.

{
    if (gnc_numeric_check (amount))
    {
        m_value = gnc_numeric_error(GNC_ERROR_ARG);
        return;
    }
 
    if (gnc_numeric_negative_p (amount))
    {
        m_value = gnc_numeric_neg(amount);
        m_debit_side = !m_debit_side;
    }
    else
    {
        m_value = amount;
    }
    PINFO("Set %s value to %" PRId64 "/%" PRId64, m_action, m_value.num, m_value.denom);
}

◆ validate_amount()

void StockTransactionEntry::validate_amount ( Logger & logger ) const

virtual

Definition at line 680 of file assistant-stock-transaction.cpp.

{
    auto add_error = [&logger](const char* format_str, const char* arg)
    {
        char *buf = g_strdup_printf (_(format_str),
                                      g_dpgettext2 (nullptr, "Stock Assistant: Page name", arg));
        logger.error(buf);
        g_free (buf);
    };
 
 
    if (gnc_numeric_check (m_value))
    {
        if (!m_allow_zero)
            add_error (N_("Amount for %s is missing."), m_action);
        return;
    }
 
    if (gnc_numeric_negative_p (m_value) && !m_allow_negative && m_allow_zero)
        add_error (N_("Amount for %s must not be negative."), m_action);
 
    if (!m_allow_zero && !gnc_numeric_positive_p (m_value))
        add_error (N_("Amount for %s must be positive."), m_action);
 
    if (!gnc_numeric_zero_p(m_value) && !m_account)
        add_error(N_("The %s amount has no associated account."), m_action);
}

◆ value()

virtual GncNumeric StockTransactionEntry::value ( )

inlinevirtual

Definition at line 577 of file assistant-stock-transaction.cpp.

577{ return (gnc_numeric_check(m_value) ? GncNumeric{} : GncNumeric(m_value)); }

GncNumeric

The primary numeric class for representing amounts and values.

Definition gnc-numeric.hpp:61

Field Documentation

◆ m_account

Account* StockTransactionEntry::m_account

protected

Definition at line 542 of file assistant-stock-transaction.cpp.

◆ m_action

const char* StockTransactionEntry::m_action

protected

Definition at line 545 of file assistant-stock-transaction.cpp.

◆ m_allow_negative

bool StockTransactionEntry::m_allow_negative

protected

Definition at line 540 of file assistant-stock-transaction.cpp.

◆ m_allow_zero

bool StockTransactionEntry::m_allow_zero

protected

Definition at line 539 of file assistant-stock-transaction.cpp.

◆ m_balance

gnc_numeric StockTransactionEntry::m_balance = gnc_numeric_zero()

protected

Definition at line 546 of file assistant-stock-transaction.cpp.

◆ m_debit_side

bool StockTransactionEntry::m_debit_side

protected

Definition at line 538 of file assistant-stock-transaction.cpp.

◆ m_enabled

bool StockTransactionEntry::m_enabled

protected

Definition at line 537 of file assistant-stock-transaction.cpp.

◆ m_input_new_balance

bool StockTransactionEntry::m_input_new_balance = false

protected

Definition at line 541 of file assistant-stock-transaction.cpp.

◆ m_kvp_tag

const char* StockTransactionEntry::m_kvp_tag

protected

Definition at line 547 of file assistant-stock-transaction.cpp.

◆ m_memo

const char* StockTransactionEntry::m_memo

protected

Definition at line 544 of file assistant-stock-transaction.cpp.

◆ m_qof_event_handler

int StockTransactionEntry::m_qof_event_handler

protected

Definition at line 548 of file assistant-stock-transaction.cpp.

◆ m_value

gnc_numeric StockTransactionEntry::m_value

protected

Definition at line 543 of file assistant-stock-transaction.cpp.

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

assistant-stock-transaction.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StockTransactionEntry() [1/2]

◆ StockTransactionEntry() [2/2]

◆ ~StockTransactionEntry()

Member Function Documentation

◆ account()

◆ amount()

◆ amount_str_for_display()

◆ calculate_price()

◆ create_split()

◆ debit_side()

◆ do_capitalize()

◆ enabled()

◆ get_balance()

◆ get_kvp_tag()

◆ has_amount()

◆ input_new_balance()

◆ marker_split()

◆ memo()

◆ print_account()

◆ print_amount()

◆ print_price()

◆ print_value()

◆ set_account()

◆ set_amount()

◆ set_balance()

◆ set_capitalize()

◆ set_fieldmask()

◆ set_memo()

◆ set_value()

◆ validate_amount()

◆ value()

Field Documentation

◆ m_account

◆ m_action

◆ m_allow_negative

◆ m_allow_zero

◆ m_balance

◆ m_debit_side

◆ m_enabled

◆ m_input_new_balance

◆ m_kvp_tag

◆ m_memo

◆ m_qof_event_handler

◆ m_value