Utility functions for the GnuCash GUI

Files
file	gnc-ui-util.h
	utility functions for the GnuCash UI

Data Structures
struct	GNCPrintAmountInfo

Macros
#define	GNC_PREFS_GROUP_OPEN_SAVE   "dialogs.open-save"
#define	GNC_PREFS_GROUP_EXPORT   "dialogs.export-accounts"
#define	GNC_PREFS_GROUP_REPORT   "dialogs.report"
#define	GNC_PREF_AUTO_DECIMAL_POINT   "auto-decimal-point"
#define	GNC_PREF_AUTO_DECIMAL_PLACES   "auto-decimal-places"
#define	WLINK   'w'
#define	FLINK   'f'

Typedefs
typedef QofSession *(*	QofSessionCB) (void)

Enumerations
enum	GNCEquityType { EQUITY_OPENING_BALANCE , EQUITY_RETAINED_EARNINGS , NUM_EQUITY_TYPES }

Functions
char *	gnc_normalize_account_separator (const char *separator)
gboolean	gnc_reverse_balance (const Account *account)
void	gnc_set_use_equity_type_opening_balance_account (QofBook *book)
gboolean	gnc_using_equity_type_opening_balance_account (QofBook *book)
char *	gnc_get_default_directory (const char *section)
void	gnc_set_default_directory (const char *section, const char *directory)
QofBook *	gnc_get_current_book (void)
gboolean	gnc_is_new_book (void)
void	gnc_set_current_book_tax_name_type (gboolean name_changed, const char *tax_name, gboolean type_changed, const char *tax_type)
const char *	gnc_get_current_book_tax_name (void)
const char *	gnc_get_current_book_tax_type (void)
void	gnc_book_option_num_field_source_change_cb (gboolean num_action)
	Calls gnc_book_option_num_field_source_change to initiate registered callbacks when num_field_source book option changes so that registers/reports can update themselves; sets feature flag.
Account *	gnc_get_current_root_account (void)
gnc_commodity_table *	gnc_get_current_commodities (void)
char *	gnc_get_account_name_for_register (const Account *account)
	Get either the full name of the account or the simple name, depending on the configuration parameter general/register/show_leaf_account_names.
Account *	gnc_account_lookup_for_register (const Account *base_account, const char *name)
	Retrieve the account matching the given name starting from the descendants of base_account.
char *	gnc_get_account_name_for_split_register (const Account *account, gboolean show_leaf_accounts)
	Get either the full name of the account or the simple name, depending on the show_leaf_accounts.
const char *	gnc_get_reconcile_str (char reconciled_flag)
const char *	gnc_get_reconcile_valid_flags (void)
const char *	gnc_get_reconcile_flag_order (void)
const char *	gnc_get_doclink_valid_flags (void)
	Get a string containing documentation link valid flags.
const char *	gnc_get_doclink_flag_order (void)
	Get a string containing document link flag order.
const char *	gnc_get_doclink_str (char link_flag)
	Get a string representing the document link type.
Account *	gnc_find_or_create_equity_account (Account *root, GNCEquityType equity_type, gnc_commodity *currency)
gboolean	gnc_account_create_opening_balance (Account *account, gnc_numeric balance, time64 date, QofBook *book)
gnc_commodity *	gnc_locale_default_currency_nodefault (void)
	Returns the default currency of the current locale, or NULL if no sensible currency could be identified from the locale.
gnc_commodity *	gnc_locale_default_currency (void)
	Returns the default currency of the current locale.
gnc_commodity *	gnc_default_currency (void)
	Return the default currency set by the user.
gnc_commodity *	gnc_account_or_default_currency (const Account *account, gboolean *currency_from_account_found)
	Returns a gnc_commodity that is a currency, suitable for being a Transaction's currency.
gnc_commodity *	gnc_default_report_currency (void)
	Return the default currency for use in reports, as set by the user.
GNCPrintAmountInfo	gnc_default_print_info (gboolean use_symbol)
GNCPrintAmountInfo	gnc_commodity_print_info (const gnc_commodity *commodity, gboolean use_symbol)
GNCPrintAmountInfo	gnc_account_print_info (const Account *account, gboolean use_symbol)
GNCPrintAmountInfo	gnc_split_amount_print_info (Split *split, gboolean use_symbol)
GNCPrintAmountInfo	gnc_price_print_info (const gnc_commodity *curr, gboolean use_symbol)
GNCPrintAmountInfo	gnc_share_print_info_places (int decplaces)
GNCPrintAmountInfo	gnc_default_share_print_info (void)
GNCPrintAmountInfo	gnc_default_price_print_info (const gnc_commodity *curr)
GNCPrintAmountInfo	gnc_integral_print_info (void)
const char *	xaccPrintAmount (gnc_numeric val, GNCPrintAmountInfo info)
	Make a string representation of a gnc_numeric.
int	xaccSPrintAmount (char *buf, gnc_numeric val, GNCPrintAmountInfo info)
	Make a string representation of a gnc_numeric.
const char *	printable_value (gdouble val, gint denom)
char *	numeric_to_words (gnc_numeric val)
gboolean	xaccParseAmount (const char *in_str, gboolean monetary, gnc_numeric *result, char **endstr)
	Parses in_str to obtain a numeric result.
gboolean	xaccParseAmountExtended (const char *in_str, gboolean monetary, gunichar negative_sign, gunichar decimal_point, gunichar group_separator, const char *ignore_list, gnc_numeric *result, char **endstr)
	Converts a string to a gnc_numeric.
gboolean	xaccParseAmountImport (const char *in_str, gboolean monetary, gnc_numeric *result, char **endstr, gboolean skip)
	Similar to xaccParseAmount, but with two differences.
gboolean	xaccParseAmountExtImport (const char *in_str, gboolean monetary, gunichar negative_sign, gunichar decimal_point, gunichar group_separator, const char *ignore_list, gnc_numeric *result, char **endstr)
	Similar to xaccParseAmountExtended, but will not automatically set a decimal point, regardless of what the user has set for this option.
const char *	gnc_print_amount_with_bidi_ltr_isolate (gnc_numeric val, GNCPrintAmountInfo info)
	Make a string representation of a gnc_numeric.
char *	gnc_wrap_text_with_bidi_ltr_isolate (const char *text)
	This function helps with GTK's use of 'Unicode Bidirectional Text Algorithm'.
void	gnc_ui_util_init (void)
void	gnc_ui_util_remove_registered_prefs (void)
char *	gnc_filter_text_for_bidi_marks (const char *incoming_text)
	Returns the incoming text with Unicode bidi control characters removed.
char *	gnc_filter_text_for_control_chars (const char *incoming_text)
	Returns the incoming text removed of control characters.
void	gnc_filter_text_set_cursor_position (const char *incoming_text, const char *symbol, int *zcursor_position)
	Updates cursor_position after removal of currency symbols.
char *	gnc_filter_text_for_currency_symbol (const char *incoming_text, const char *symbol)
	Returns the incoming text removed of a currency symbol.
char *	gnc_filter_text_for_currency_commodity (const gnc_commodity *comm, const char *incoming_text, const char **symbol)
	Returns the incoming text removed of currency symbol.
gchar *	gnc_list_formatter (GList *strings)
	This function takes a GList of char*, and uses locale-sensitive list formatter.

Detailed Description

Macro Definition Documentation

FLINK

#define FLINK   'f'

Definition at line 155 of file gnc-ui-util.h.

GNC_PREF_AUTO_DECIMAL_PLACES

#define GNC_PREF_AUTO_DECIMAL_PLACES   "auto-decimal-places"

Definition at line 63 of file gnc-ui-util.h.

GNC_PREF_AUTO_DECIMAL_POINT

#define GNC_PREF_AUTO_DECIMAL_POINT   "auto-decimal-point"

Definition at line 62 of file gnc-ui-util.h.

GNC_PREFS_GROUP_EXPORT

#define GNC_PREFS_GROUP_EXPORT   "dialogs.export-accounts"

Definition at line 60 of file gnc-ui-util.h.

GNC_PREFS_GROUP_OPEN_SAVE

#define GNC_PREFS_GROUP_OPEN_SAVE   "dialogs.open-save"

Definition at line 59 of file gnc-ui-util.h.

GNC_PREFS_GROUP_REPORT

#define GNC_PREFS_GROUP_REPORT   "dialogs.report"

Definition at line 61 of file gnc-ui-util.h.

WLINK

#define WLINK   'w'

Definition at line 154 of file gnc-ui-util.h.

Typedef Documentation

QofSessionCB

typedef QofSession *(* QofSessionCB) (void)

Definition at line 47 of file gnc-ui-util.h.

Enumeration Type Documentation

GNCEquityType

enum GNCEquityType

Definition at line 177 of file gnc-ui-util.h.

{
    EQUITY_OPENING_BALANCE,
    EQUITY_RETAINED_EARNINGS,
    NUM_EQUITY_TYPES
} GNCEquityType;

Function Documentation

gnc_account_create_opening_balance()

gboolean gnc_account_create_opening_balance	(	Account *	account,
		gnc_numeric	balance,
		time64	date,
		QofBook *	book
	)

Definition at line 668 of file gnc-ui-util.cpp.

{
    if (gnc_numeric_zero_p (balance))
        return TRUE;
 
    g_return_val_if_fail (account != nullptr, FALSE);
    auto commodity = xaccAccountGetCommodity (account);
    g_return_val_if_fail (gnc_commodity_is_currency (commodity), FALSE);
 
    auto equity_account =
        gnc_find_or_create_equity_account (gnc_account_get_root(account),
                                           EQUITY_OPENING_BALANCE,
                                           commodity);
    if (!equity_account)
        return FALSE;
 
    xaccAccountBeginEdit (account);
    xaccAccountBeginEdit (equity_account);
 
    auto trans = xaccMallocTransaction (book);
 
    xaccTransBeginEdit (trans);
 
    xaccTransSetCurrency (trans, gnc_account_or_default_currency (account, nullptr));
    xaccTransSetDatePostedSecsNormalized (trans, date);
    xaccTransSetDescription (trans, _("Opening Balance"));
 
    auto split = xaccMallocSplit (book);
 
    xaccTransAppendSplit (trans, split);
    xaccAccountInsertSplit (account, split);
 
    xaccSplitSetAmount (split, balance);
    xaccSplitSetValue (split, balance);
 
    balance = gnc_numeric_neg (balance);
 
    split = xaccMallocSplit (book);
 
    xaccTransAppendSplit (trans, split);
    xaccAccountInsertSplit (equity_account, split);
 
    xaccSplitSetAmount (split, balance);
    xaccSplitSetValue (split, balance);
 
    xaccTransCommitEdit (trans);
    xaccAccountCommitEdit (equity_account);
    xaccAccountCommitEdit (account);
 
    return TRUE;
}

gnc_account_lookup_for_register()

Account * gnc_account_lookup_for_register	(	const Account *	base_account,
		const char *	name
	)

Retrieve the account matching the given name starting from the descendants of base_account.

name is either considered to be the name of the leaf in the account tree or to be the full account path, depending on the configuration parameter general.register/show_leaf_account_names.

Parameters

base_account	The account to start the search at.
name	The name to search for.

Returns

A pointer to the account, or NULL if the account was not found.

Definition at line 450 of file gnc-ui-util.cpp.

{
    auto show_leaf_accounts =
        gnc_prefs_get_bool(GNC_PREFS_GROUP_GENERAL_REGISTER,
                           GNC_PREF_SHOW_LEAF_ACCT_NAMES);
 
    if (show_leaf_accounts)
        return gnc_account_lookup_by_name (base_account, name);
    else
        return gnc_account_lookup_by_full_name (base_account, name);
}

gnc_account_or_default_currency()

gnc_commodity * gnc_account_or_default_currency	(	const Account *	account,
		gboolean *	currency_from_account_found
	)

Returns a gnc_commodity that is a currency, suitable for being a Transaction's currency.

The gnc_commodity is taken either from the current account, or from the next parent account that has a gnc_commodity that is a currency, or from gnc_default_currency().

If the given account or any of its parent account have a commodity that is a currency, it is returned and the gboolean currency_from_account_found is set to TRUE (if non-NULL). If neither this account nor any of its parent accounts have such a commodity, gnc_default_currency() is returned and the gboolean currency_from_account_found is set to FALSE (if non-NULL). This can be used to show an appropriate warning message.

If account is NULL, gnc_default_currency() is returned and currency_from_account_found is set to FALSE.

Parameters

account	The account where the currency should be looked up. May be NULL.
currency_from_account_found	A gboolean pointer that takes the output argument of whether the returned currency was found in the account. May be NULL.

Returns

A currency pointer (and never NULL).

Definition at line 790 of file gnc-ui-util.cpp.

{
    gnc_commodity *currency;
    if (!account)
    {
        if (currency_from_account_found)
            *currency_from_account_found = FALSE;
        return gnc_default_currency();
    }
 
    currency = gnc_account_get_currency_or_parent(account);
    if (currency)
    {
        if (currency_from_account_found)
            *currency_from_account_found = TRUE;
    }
    else
    {
        if (currency_from_account_found)
            *currency_from_account_found = FALSE;
        currency = gnc_default_currency();
    }
    return currency;
}

gnc_account_print_info()

GNCPrintAmountInfo gnc_account_print_info	(	const Account *	account,
		gboolean	use_symbol
	)

Definition at line 957 of file gnc-ui-util.cpp.

{
    return gnc_account_print_info_helper(account, use_symbol,
                                         xaccAccountGetCommodity,
                                         xaccAccountGetCommoditySCU);
}

gnc_book_option_num_field_source_change_cb()

void gnc_book_option_num_field_source_change_cb

(

gboolean

num_action

)

Calls gnc_book_option_num_field_source_change to initiate registered callbacks when num_field_source book option changes so that registers/reports can update themselves; sets feature flag.

Definition at line 4709 of file gnc-main-window.cpp.

{
    gnc_suspend_gui_refresh ();
    if (num_action)
    {
        /* Set a feature flag in the book for use of the split action field as number.
         * This will prevent older GnuCash versions that don't support this feature
         * from opening this file. */
        gnc_features_set_used (gnc_get_current_book(),
                               GNC_FEATURE_NUM_FIELD_SOURCE);
    }
    gnc_book_option_num_field_source_change (num_action);
    gnc_resume_gui_refresh ();
}

gnc_commodity_print_info()

GNCPrintAmountInfo gnc_commodity_print_info	(	const gnc_commodity *	commodity,
		gboolean	use_symbol
	)

Definition at line 887 of file gnc-ui-util.cpp.

{
    GNCPrintAmountInfo info;
 
    if (commodity == nullptr)
        return gnc_default_print_info (use_symbol);
 
    info.commodity = commodity;
 
    auto is_iso = gnc_commodity_is_iso (commodity);
 
    if (is_decimal_fraction (gnc_commodity_get_fraction (commodity),
                             &info.max_decimal_places))
    {
        if (is_iso)
            info.min_decimal_places = info.max_decimal_places;
        else
            info.min_decimal_places = 0;
    }
    else
        info.max_decimal_places = info.min_decimal_places = 0;
 
    info.use_separators = 1;
    info.use_symbol = use_symbol ? 1 : 0;
    info.use_locale = is_iso ? 1 : 0;
    info.monetary = 1;
    info.force_fit = 0;
    info.round = 0;
 
    return info;
}

gnc_default_currency()

gnc_commodity * gnc_default_currency

(

void

)

Return the default currency set by the user.

If the user's preference is invalid, then this routine will return the default currency for the user's locale.

Returns

A pointer to a currency.

Definition at line 783 of file gnc-ui-util.cpp.

{
    return gnc_default_currency_common (user_default_currency,
                                        GNC_PREFS_GROUP_GENERAL);
}

gnc_default_price_print_info()

GNCPrintAmountInfo gnc_default_price_print_info

(

const gnc_commodity *

curr

)

Definition at line 1061 of file gnc-ui-util.cpp.

{
    return gnc_price_print_info (curr, FALSE);
}

gnc_default_print_info()

GNCPrintAmountInfo gnc_default_print_info

(

gboolean

use_symbol

)

Definition at line 835 of file gnc-ui-util.cpp.

{
    static GNCPrintAmountInfo info;
    static bool got_it = false;
 
    /* These must be updated each time. */
    info.use_symbol = use_symbol ? 1 : 0;
    info.commodity = gnc_default_currency ();
 
    if (got_it)
        return info;
 
    auto lc = gnc_localeconv ();
 
    info.max_decimal_places = lc->frac_digits;
    info.min_decimal_places = lc->frac_digits;
 
    info.use_separators = 1;
    info.use_locale = 1;
    info.monetary = 1;
    info.force_fit = 0;
    info.round = 0;
 
    got_it = TRUE;
 
    return info;
}

gnc_default_report_currency()

gnc_commodity * gnc_default_report_currency

(

void

)

Return the default currency for use in reports, as set by the user.

If the user's preference is invalid, then this routine will return the default currency for the user's locale.

Returns

A pointer to a currency.

Definition at line 819 of file gnc-ui-util.cpp.

{
    return gnc_default_currency_common (user_report_currency,
                                        GNC_PREFS_GROUP_GENERAL_REPORT);
}

gnc_default_share_print_info()

GNCPrintAmountInfo gnc_default_share_print_info

(

void

)

Definition at line 998 of file gnc-ui-util.cpp.

{
    static GNCPrintAmountInfo info;
    static bool got_it = false;
 
    if (!got_it)
    {
        info = gnc_default_print_info_helper (5);
        info.monetary = 0;
        got_it = TRUE;
    }
 
    return info;
}

gnc_filter_text_for_bidi_marks()

char * gnc_filter_text_for_bidi_marks

(

const char *

incoming_text

)

Returns the incoming text with Unicode bidi control characters removed.

Strips directional marks (U+200E, U+200F), embedding/override codes (U+202A–U+202E), isolate codes (U+2066–U+2069) and the Arabic letter mark (U+061C) that GnuCash inserts for RTL display, so that values copied to the clipboard are clean plain text.

Parameters

incoming_text

The text to filter (may be NULL)

Returns

A newly-allocated string with bidi marks removed, or NULL when incoming_text is NULL. Must be freed by the caller.

Definition at line 2137 of file gnc-ui-util.cpp.

{
    if (!text)
        return nullptr;
 
    int32_t len = static_cast<int32_t> (strlen (text));
    std::string result;
    result.reserve (len);
 
    const char* p = text;
    int32_t i = 0;
 
    while (i < len)
    {
        UChar32 c;
        int32_t start = i;
        U8_NEXT (p, i, len, c);
 
        if (c >= 0 && !u_hasBinaryProperty (c, UCHAR_BIDI_CONTROL))
            result.append (p + start, i - start);
    }
 
    return g_strdup (result.c_str ());
}

gnc_filter_text_for_control_chars()

char * gnc_filter_text_for_control_chars

(

const char *

incoming_text

)

Returns the incoming text removed of control characters.

Parameters

incoming_text

The text to filter

Returns

The incoming text filtered of control characters to be freed by the caller.

Definition at line 2169 of file gnc-ui-util.cpp.

{
    bool cntrl = false;
    bool text_found = false;
 
    if (!text)
        return nullptr;
 
    if (!g_utf8_validate (text, -1, nullptr))
        return nullptr;
 
    auto filtered = g_string_sized_new (strlen (text) + 1);
 
    auto ch = text;
 
    while (*ch)
    {
        auto uc = g_utf8_get_char (ch);
 
        // check for starting with control characters
        if (unichar_is_cntrl (uc) && !text_found)
        {
            ch = g_utf8_next_char (ch);
            continue;
        }
        // check for alpha, num and punctuation
        if (!unichar_is_cntrl (uc))
        {
            filtered = g_string_append_unichar (filtered, uc);
            text_found = true;
        }
        // check for control characters after text
        if (unichar_is_cntrl (uc))
            cntrl = true;
 
        ch = g_utf8_next_char (ch);
 
        if (cntrl) // if control characters in text replace with space
        {
            auto uc2 = g_utf8_get_char (ch);
 
            if (!unichar_is_cntrl (uc2))
                filtered = g_string_append_unichar (filtered, ' ');
        }
        cntrl = false;
    }
    return g_string_free (filtered, FALSE);
}

gnc_filter_text_for_currency_commodity()

char * gnc_filter_text_for_currency_commodity	(	const gnc_commodity *	comm,
		const char *	incoming_text,
		const char **	symbol
	)

Returns the incoming text removed of currency symbol.

Parameters

comm	commodity of entry if known
incoming_text	The text to filter
symbol	return the symbol used

Returns

The incoming text with symbol removed to be freed by the caller

Definition at line 2271 of file gnc-ui-util.cpp.

{
    if (!incoming_text)
    {
        *symbol = nullptr;
        return nullptr;
    }
 
    if (!gnc_commodity_is_currency (comm))
    {
        *symbol = nullptr;
        return g_strdup (incoming_text);
    }
 
    if (comm)
        *symbol = gnc_commodity_get_nice_symbol (comm);
    else
        *symbol = gnc_commodity_get_nice_symbol (gnc_default_currency ());
 
    return gnc_filter_text_for_currency_symbol (incoming_text, *symbol);
}

gnc_filter_text_for_currency_symbol()

char * gnc_filter_text_for_currency_symbol	(	const char *	incoming_text,
		const char *	symbol
	)

Returns the incoming text removed of a currency symbol.

Parameters

incoming_text	The text to filter
symbol	to remove
cursor_position	the position of cursor in the incoming text

Returns

The incoming text with symbol removed to be freed by the caller

Definition at line 2250 of file gnc-ui-util.cpp.

{
    if (!incoming_text)
        return nullptr;
 
    if (!symbol)
       return g_strdup (incoming_text);
 
    if (g_strrstr (incoming_text, symbol) == nullptr)
        return g_strdup (incoming_text);
 
    auto split = g_strsplit (incoming_text, symbol, -1);
 
    auto ret_text = g_strjoinv (nullptr, split);
 
    g_strfreev (split);
    return ret_text;
}

gnc_filter_text_set_cursor_position()

void gnc_filter_text_set_cursor_position	(	const char *	incoming_text,
		const char *	symbol,
		int *	zcursor_position
	)

Updates cursor_position after removal of currency symbols.

Parameters

incoming_text	The text to filter
symbol	to remove
cursor_position	the position of cursor in the incoming text

Returns

nothing

gnc_find_or_create_equity_account()

Account * gnc_find_or_create_equity_account	(	Account *	root,
		GNCEquityType	equity_type,
		gnc_commodity *	currency
	)

Definition at line 565 of file gnc-ui-util.cpp.

{
    g_return_val_if_fail (equity_type >= 0, nullptr);
    g_return_val_if_fail (equity_type < NUM_EQUITY_TYPES, nullptr);
    g_return_val_if_fail (currency != nullptr, nullptr);
    g_return_val_if_fail (root != nullptr, nullptr);
    g_return_val_if_fail (gnc_commodity_is_currency(currency), nullptr);
 
    auto use_eq_op_feature = equity_type == EQUITY_OPENING_BALANCE && gnc_using_equity_type_opening_balance_account (gnc_get_current_book ());
 
    if (use_eq_op_feature)
    {
        auto account = gnc_account_lookup_by_opening_balance (root, currency);
        if (account)
            return account;
    }
 
    auto base_name = equity_base_name (equity_type);
 
    auto account = gnc_account_lookup_by_name(root, base_name);
    if (account && xaccAccountGetType (account) != ACCT_TYPE_EQUITY)
        account = nullptr;
 
    if (!account)
    {
        base_name = base_name && *base_name ? _(base_name) : "";
 
        account = gnc_account_lookup_by_name(root, base_name);
        if (account && xaccAccountGetType (account) != ACCT_TYPE_EQUITY)
            account = nullptr;
    }
 
    auto base_name_exists = (account != nullptr);
 
    if (account &&
            gnc_commodity_equiv (currency, xaccAccountGetCommodity (account)))
    {
        if (use_eq_op_feature)
            xaccAccountSetIsOpeningBalance (account, TRUE);
        return account;
    }
 
    auto name = g_strconcat (base_name, " - ",
                        gnc_commodity_get_mnemonic (currency), nullptr);
    account = gnc_account_lookup_by_name(root, name);
    if (account && xaccAccountGetType (account) != ACCT_TYPE_EQUITY)
        account = nullptr;
 
    auto name_exists = (account != nullptr);
 
    if (account &&
            gnc_commodity_equiv (currency, xaccAccountGetCommodity (account)))
    {
        if (use_eq_op_feature)
            xaccAccountSetIsOpeningBalance (account, TRUE);
        return account;
    }
 
    /* Couldn't find one, so create it */
    if (name_exists && base_name_exists)
    {
        PWARN ("equity account with unexpected currency");
        g_free (name);
        return nullptr;
    }
 
    if (!base_name_exists &&
            gnc_commodity_equiv (currency, gnc_default_currency ()))
    {
        g_free (name);
        name = g_strdup (base_name);
    }
 
    auto parent = gnc_account_lookup_by_name(root, _("Equity"));
    if (!parent || xaccAccountGetType (parent) != ACCT_TYPE_EQUITY)
        parent = root;
    g_assert(parent);
 
    account = xaccMallocAccount (gnc_account_get_book(root));
 
    xaccAccountBeginEdit (account);
 
    xaccAccountSetName (account, name);
    xaccAccountSetType (account, ACCT_TYPE_EQUITY);
    xaccAccountSetCommodity (account, currency);
 
    if (use_eq_op_feature)
        xaccAccountSetIsOpeningBalance (account, TRUE);
 
    xaccAccountBeginEdit (parent);
    gnc_account_append_child (parent, account);
    xaccAccountCommitEdit (parent);
 
    xaccAccountCommitEdit (account);
 
    g_free (name);
 
    return account;
}

gnc_get_account_name_for_register()

char * gnc_get_account_name_for_register

(

const Account *

account

)

Get either the full name of the account or the simple name, depending on the configuration parameter general/register/show_leaf_account_names.

Parameters

account

The account to retrieve the name for.

Returns

A newly allocated string.

Definition at line 440 of file gnc-ui-util.cpp.

{
    auto show_leaf_accounts =
        gnc_prefs_get_bool(GNC_PREFS_GROUP_GENERAL_REGISTER,
                           GNC_PREF_SHOW_LEAF_ACCT_NAMES);
 
    return gnc_get_account_name_for_split_register(account, show_leaf_accounts);
}

gnc_get_account_name_for_split_register()

char * gnc_get_account_name_for_split_register	(	const Account *	account,
		gboolean	show_leaf_accounts
	)

Get either the full name of the account or the simple name, depending on the show_leaf_accounts.

Parameters

account	The account to retrieve the name for.
show_leaf_accounts	Whether the full name will be returned.

Returns

A newly allocated string.

Definition at line 430 of file gnc-ui-util.cpp.

{
    if (show_leaf_accounts)
        return g_strdup (xaccAccountGetName (account));
    else
        return gnc_account_get_full_name (account);
}

gnc_get_current_book()

QofBook * gnc_get_current_book

(

void

)

Definition at line 209 of file gnc-ui-util.cpp.

{
    return qof_session_get_book (gnc_get_current_session ());
}

gnc_get_current_book_tax_name()

const char * gnc_get_current_book_tax_name

(

void

)

Definition at line 329 of file gnc-ui-util.cpp.

{
    auto book = gnc_get_current_book();
    auto tax_name = qof_book_get_string_option(book, OPTION_TAXUS_NAME);
    if (tax_name)
    {
        return tax_name;
    }
    else
    {
        const char* old_option_taxus_name =
            qof_book_get_string_option(book, OLD_OPTION_TAXUS_NAME);
        if (old_option_taxus_name)
        {
            char* taxus_name = g_strdup(old_option_taxus_name);
            const char* old_option_taxus_type =
                qof_book_get_string_option(book, OLD_OPTION_TAXUS_TYPE);
            if (old_option_taxus_type)
            { /* switch both name and type and remove unused frames */
                char* taxus_type = g_strdup(old_option_taxus_type);
                qof_book_set_string_option(book, OPTION_TAXUS_NAME, taxus_name);
                qof_book_set_string_option(book, OLD_OPTION_TAXUS_NAME, nullptr);
                qof_book_set_string_option(book, OPTION_TAXUS_TYPE, taxus_type);
                qof_book_set_string_option(book, OLD_OPTION_TAXUS_TYPE, nullptr);
                qof_book_option_frame_delete(book, "book/tax_US");
                qof_book_option_frame_delete(book, "book");
                g_free (taxus_type);
            }
            else
            { /* switch just name and remove unused frames */
                qof_book_set_string_option(book, OPTION_TAXUS_NAME, taxus_name);
                qof_book_set_string_option(book, OLD_OPTION_TAXUS_NAME, nullptr);
                qof_book_option_frame_delete(book, "book/tax_US");
                qof_book_option_frame_delete(book, "book");
            }
            g_free (taxus_name);
            return qof_book_get_string_option(book, OPTION_TAXUS_NAME);
        }
        return nullptr;
    }
}

gnc_get_current_book_tax_type()

const char * gnc_get_current_book_tax_type

(

void

)

Definition at line 372 of file gnc-ui-util.cpp.

{
    auto book = gnc_get_current_book();
    auto tax_type =
        qof_book_get_string_option(book, OPTION_TAXUS_TYPE);
    if (tax_type)
    {
        return tax_type;
    }
    else
    {
        auto old_option_taxus_type =
            qof_book_get_string_option(book, OLD_OPTION_TAXUS_TYPE);
        if (old_option_taxus_type)
        {
            auto taxus_type = g_strdup(old_option_taxus_type);
            auto old_option_taxus_name =
                qof_book_get_string_option(book, OLD_OPTION_TAXUS_NAME);
            if (old_option_taxus_name)
            { /* switch both name and type and remove unused frames */
                auto taxus_name = g_strdup(old_option_taxus_name);
                qof_book_set_string_option(book, OPTION_TAXUS_NAME, taxus_name);
                qof_book_set_string_option(book, OLD_OPTION_TAXUS_NAME, nullptr);
                qof_book_set_string_option(book, OPTION_TAXUS_TYPE, taxus_type);
                qof_book_set_string_option(book, OLD_OPTION_TAXUS_TYPE, nullptr);
                qof_book_option_frame_delete(book, "book/tax_US");
                qof_book_option_frame_delete(book, "book");
                g_free (taxus_name);
            }
            else
            { /* switch just type and remove unused frames */
                qof_book_set_string_option(book, OPTION_TAXUS_TYPE, taxus_type);
                qof_book_set_string_option(book, OLD_OPTION_TAXUS_TYPE, nullptr);
                qof_book_option_frame_delete(book, "book/tax_US");
                qof_book_option_frame_delete(book, "book");
            }
            g_free (taxus_type);
            return qof_book_get_string_option(book, OPTION_TAXUS_TYPE);
        }
        return nullptr;
    }
}

gnc_get_current_commodities()

gnc_commodity_table * gnc_get_current_commodities

(

void

)

Definition at line 422 of file gnc-ui-util.cpp.

{
     if (gnc_current_session_exist())
          return gnc_commodity_table_get_table (gnc_get_current_book ());
     return nullptr;
}

gnc_get_current_root_account()

Account * gnc_get_current_root_account

(

void

)

Definition at line 416 of file gnc-ui-util.cpp.

{
    return gnc_book_get_root_account (gnc_get_current_book ());
}

gnc_get_default_directory()

char * gnc_get_default_directory

(

const char *

section

)

Definition at line 187 of file gnc-ui-util.cpp.

{
    auto dir = gnc_prefs_get_string (section, GNC_PREF_LAST_PATH);
    if (!(dir && *dir))
    {
        g_free (dir); // if it's ""
#ifdef G_OS_WIN32
        dir = g_strdup (g_get_user_data_dir ()); /* equivalent of "My Documents" */
#else
        dir = g_strdup (g_get_home_dir ());
#endif
    }
    return dir;
}

gnc_get_doclink_flag_order()

const char * gnc_get_doclink_flag_order

(

void

)

Get a string containing document link flag order.

Returns

a string containing the document link flag change order

Definition at line 542 of file gnc-ui-util.cpp.

{
    static const char flags[] = { FLINK, WLINK, ' ', 0 };
    return flags;
}

gnc_get_doclink_str()

const char * gnc_get_doclink_str

(

char

link_flag

)

Get a string representing the document link type.

Parameters

link_flag

The flag to convert into a string

Returns

the i18n'd doclink string

Definition at line 518 of file gnc-ui-util.cpp.

{
    switch (link_flag)
    {
    case WLINK:
        return C_("Document Link flag for 'web'", "w");
    case FLINK:
        return C_("Document Link flag for 'file'", "f");
    case ' ':
        return " ";
    default:
        PERR("Bad link flag");
        return nullptr;
    }
}

gnc_get_doclink_valid_flags()

const char * gnc_get_doclink_valid_flags

(

void

)

Get a string containing documentation link valid flags.

Returns

a string containing the list of valid link_flags

Definition at line 535 of file gnc-ui-util.cpp.

{
    static const char flags[] = { FLINK, WLINK, ' ', 0 };
    return flags;
}

gnc_get_reconcile_flag_order()

const char * gnc_get_reconcile_flag_order

(

void

)

Definition at line 511 of file gnc-ui-util.cpp.

{
    static const char flags[] = { NREC, CREC, 0 };
    return flags;
}

gnc_get_reconcile_str()

const char * gnc_get_reconcile_str

(

char

reconciled_flag

)

Definition at line 470 of file gnc-ui-util.cpp.

{
    switch (reconciled_flag)
    {
    case NREC:
        return C_("Reconciled flag 'not cleared'", "n");
    case CREC:
        return C_("Reconciled flag 'cleared'", "c");
    case YREC:
        return C_("Reconciled flag 'reconciled'", "y");
    case FREC:
        return C_("Reconciled flag 'frozen'", "f");
    case VREC:
        return C_("Reconciled flag 'void'", "v");
    default:
        PERR("Bad reconciled flag\n");
        return nullptr;
    }
}

gnc_get_reconcile_valid_flags()

const char * gnc_get_reconcile_valid_flags

(

void

)

Definition at line 497 of file gnc-ui-util.cpp.

{
    static const char flags[] = { NREC, CREC, YREC, FREC, VREC, 0 };
    return flags;
}

gnc_integral_print_info()

GNCPrintAmountInfo gnc_integral_print_info

(

void

)

Definition at line 1068 of file gnc-ui-util.cpp.

{
    static GNCPrintAmountInfo info;
    static bool got_it = false;
 
    if (!got_it)
    {
        info = gnc_default_print_info_helper (0);
        got_it = TRUE;
    }
 
    return info;
}

gnc_is_new_book()

gboolean gnc_is_new_book

(

void

)

Definition at line 223 of file gnc-ui-util.cpp.

{
    return (!gnc_current_session_exist() ||
            gnc_account_n_children (gnc_book_get_root_account (gnc_get_current_book ())) == 0);
}

gnc_list_formatter()

gchar * gnc_list_formatter

(

GList *

strings

)

This function takes a GList of char*, and uses locale-sensitive list formatter.

Parameters

strings

The GList* of char*.

Returns

a newly allocated char*

Definition at line 2296 of file gnc-ui-util.cpp.

{
    g_return_val_if_fail (strings, nullptr);
 
    UErrorCode status = U_ZERO_ERROR;
    auto formatter = icu::ListFormatter::createInstance(status);
    std::vector<UniStr> strvec;
    UniStr result;
    std::string retval;
 
    for (auto n = strings; n; n = g_list_next (n))
    {
        auto utf8_str{static_cast<const char*>(n->data)};
        strvec.push_back (UniStr::fromUTF8(utf8_str));
    }
 
    formatter->format (strvec.data(), strvec.size(), result, status);
 
    if (U_FAILURE(status))
        PERR ("Unicode error");
    else
        result.toUTF8String(retval);
 
    delete formatter;
    return g_strdup (retval.c_str());
}

gnc_locale_default_currency()

gnc_commodity * gnc_locale_default_currency

(

void

)

Returns the default currency of the current locale.

WATCH OUT: If no currency could be identified from the locale, this one returns "USD", but this will have nothing to do with the actual locale.

Definition at line 738 of file gnc-ui-util.cpp.

{
    auto currency = gnc_locale_default_currency_nodefault ();
 
    return (currency ? currency :
            gnc_commodity_table_lookup (gnc_get_current_commodities (),
                                        GNC_COMMODITY_NS_CURRENCY, "USD"));
}

gnc_locale_default_currency_nodefault()

gnc_commodity * gnc_locale_default_currency_nodefault

(

void

)

Returns the default currency of the current locale, or NULL if no sensible currency could be identified from the locale.

Definition at line 725 of file gnc-ui-util.cpp.

{
    auto table = gnc_get_current_commodities ();
    auto code = gnc_locale_default_iso_currency_code ();
 
    auto currency = gnc_commodity_table_lookup (table,
                                                GNC_COMMODITY_NS_CURRENCY,
                                                code);
 
    return (currency ? currency : nullptr);
}

gnc_price_print_info()

GNCPrintAmountInfo gnc_price_print_info	(	const gnc_commodity *	curr,
		gboolean	use_symbol
	)

Definition at line 1027 of file gnc-ui-util.cpp.

{
    GNCPrintAmountInfo info;
    auto force = gnc_prefs_get_bool (GNC_PREFS_GROUP_GENERAL,
                                     GNC_PREF_PRICES_FORCE_DECIMAL);
    info.commodity = curr;
 
    if (info.commodity)
    {
        int frac = gnc_commodity_get_fraction (curr);
        guint8 decplaces = 0;
        while (frac != 1 && (frac % 10) == 0 && (frac /= 10)) ++decplaces;
        if (force)
            decplaces += 2;
        info.max_decimal_places = decplaces;
        info.min_decimal_places = decplaces;
    }
    else
    {
        info.max_decimal_places = 6;
        info.min_decimal_places = 0;
    }
 
    info.use_separators = 1;
    info.use_symbol = use_symbol ? 1 : 0;
    info.use_locale = 1;
    info.monetary = 1;
 
    info.force_fit = force;
    info.round = force;
    return info;
}

gnc_print_amount_with_bidi_ltr_isolate()

const char * gnc_print_amount_with_bidi_ltr_isolate	(	gnc_numeric	val,
		GNCPrintAmountInfo	info
	)

Make a string representation of a gnc_numeric.

Warning, the gnc_numeric is not checked for validity and the returned char* may point to random garbage.

This is the same as xaccPrintAmount but wraps the output with BiDi left to right isolate if a symbol is displayed.

Definition at line 1448 of file gnc-ui-util.cpp.

{
    /* hack alert -- this is not thread safe ... */
    static char buf[BUFLEN];
    static const char ltr_isolate[] = { '\xe2', '\x81', '\xa6' };
    static const char ltr_pop_isolate[] = { '\xe2', '\x81', '\xa9' };
    auto offset = info.use_symbol ? 3 : 0;
 
    if (!gnc_commodity_is_currency (info.commodity))
        offset = 0;
 
    memset (buf, 0, BUFLEN);
    if (!xaccSPrintAmount (buf + offset, val, info))
    {
        buf[0] = '\0';
        return buf;
    };
 
    if (offset == 0)
        return buf;
 
    memcpy (buf, ltr_isolate, 3);
 
    if (buf[BUFLEN - 4] == '\0')
    {
        auto length = strlen (buf);
        memcpy (buf + length, ltr_pop_isolate, 3);
    }
    else
    {
        buf[BUFLEN - 1] = '\0';
        memcpy (buf + BUFLEN - 4, ltr_pop_isolate, 3);
 
        PWARN("buffer length %d exceeded, string truncated was %s", BUFLEN, buf);
    }
    /* its OK to return buf, since we declared it static
       and is immediately g_strdup'd */
    return buf;
}

gnc_reverse_balance()

gboolean gnc_reverse_balance

(

const Account *

account

)

Definition at line 161 of file gnc-ui-util.cpp.

{
    if (account == nullptr)
        return FALSE;
 
    auto type = xaccAccountGetType (account);
    if ((type < 0) || (type >= NUM_ACCOUNT_TYPES))
        return FALSE;
 
    if (!reverse_balance_inited)
        gnc_reverse_balance_init ();
 
    return reverse_type[type];
}

gnc_set_current_book_tax_name_type()

void gnc_set_current_book_tax_name_type	(	gboolean	name_changed,
		const char *	tax_name,
		gboolean	type_changed,
		const char *	tax_type
	)

Definition at line 235 of file gnc-ui-util.cpp.

{
    if (name_changed)
    {
        if (type_changed)
        {
            auto book = gnc_get_current_book();
            if ((g_strcmp0 (tax_name, "") == 0) ||
                (tax_name == nullptr))
            { /* change to no name */
                if ((g_strcmp0 (tax_type, "Other") == 0) ||
                    (g_strcmp0 (tax_type, "") == 0) ||
                    (tax_type == nullptr))
                { /* need to delete both name and type and the "tax_US" frame */
                    qof_book_set_string_option(book, OPTION_TAXUS_NAME, nullptr);
                    qof_book_set_string_option(book, OPTION_TAXUS_TYPE, nullptr);
                    qof_book_option_frame_delete(book, "tax_US");
                }
                else
                { /* delete the name & change the type; keep the "tax_US" frame */
                    qof_book_set_string_option(book, OPTION_TAXUS_NAME, nullptr);
                    qof_book_set_string_option(book, OPTION_TAXUS_TYPE, tax_type);
                }
            }
            else /* new name */
            {
                if ((g_strcmp0 (tax_type, "Other") == 0) ||
                    (g_strcmp0 (tax_type, "") == 0) ||
                    (tax_type == nullptr))
                { /* delete the type & change the name; keep the "tax_US" frame */
                    qof_book_set_string_option(book, OPTION_TAXUS_TYPE, nullptr);
                    qof_book_set_string_option(book, OPTION_TAXUS_NAME, tax_name);
                }
                else /* and new type */
                { /* change the name & change the type */
                    qof_book_set_string_option(book, OPTION_TAXUS_NAME, tax_name);
                    qof_book_set_string_option(book, OPTION_TAXUS_TYPE, tax_type);
                }
            }
        }
        else /* no type change but name changed */
        {
            auto book = gnc_get_current_book();
            if ((g_strcmp0 (tax_name, "") == 0) ||
                (tax_name == nullptr))
            { /* change to no name */
                if ((g_strcmp0 (tax_type, "Other") == 0) ||
                    (g_strcmp0 (tax_type, "") == 0) ||
                    (tax_type == nullptr))
                { /* delete the name; there is no type; deleted the "tax_US" frame */
                    qof_book_set_string_option(book, OPTION_TAXUS_NAME, nullptr);
                    qof_book_option_frame_delete(book, "tax_US");
                }
                else
                { /* need to delete the name and keep "tax_US" frame */
                    qof_book_set_string_option(book, OPTION_TAXUS_NAME, nullptr);
                }
            }
            else
            { /* change the name & keep "tax_US" frame */
                qof_book_set_string_option(book, OPTION_TAXUS_NAME, tax_name);
            }
        }
   }
   else /* no name change */
   {
        if (type_changed)
        {
            auto book = gnc_get_current_book();
            if ((g_strcmp0 (tax_type, "Other") == 0) ||
                (g_strcmp0 (tax_type, "") == 0) ||
                (tax_type == nullptr))
            {
                if ((g_strcmp0 (tax_name, "") == 0) ||
                    (tax_name == nullptr))
                {/* delete the type; there is no name; delete the "tax_US" frame */
                    qof_book_set_string_option(book, OPTION_TAXUS_TYPE, nullptr);
                    qof_book_option_frame_delete(book, "tax_US");
                }
                else
                { /* need to delete the type and keep "tax_US" frame */
                    qof_book_set_string_option(book, OPTION_TAXUS_TYPE, nullptr);
                }
            }
            else
            { /* change the type & keep "tax_US" frame */
                qof_book_set_string_option(book, OPTION_TAXUS_TYPE, tax_type);
            }
        } /*else no name and no type change - do nothing */
   }
}

gnc_set_default_directory()

void gnc_set_default_directory	(	const char *	section,
		const char *	directory
	)

Definition at line 203 of file gnc-ui-util.cpp.

{
    gnc_prefs_set_string(section, GNC_PREF_LAST_PATH, directory);
}

gnc_set_use_equity_type_opening_balance_account()

void gnc_set_use_equity_type_opening_balance_account

(

QofBook *

book

)

Definition at line 181 of file gnc-ui-util.cpp.

{
    gnc_features_set_used (book, GNC_FEATURE_EQUITY_TYPE_OPENING_BALANCE);
}

gnc_share_print_info_places()

GNCPrintAmountInfo gnc_share_print_info_places

(

int

decplaces

)

Definition at line 1014 of file gnc-ui-util.cpp.

{
    GNCPrintAmountInfo info;
 
    info = gnc_default_share_print_info ();
    info.max_decimal_places = decplaces;
    info.min_decimal_places = decplaces;
    info.force_fit = 1;
    info.round = 1;
    return info;
}

gnc_split_amount_print_info()

GNCPrintAmountInfo gnc_split_amount_print_info	(	Split *	split,
		gboolean	use_symbol
	)

Definition at line 965 of file gnc-ui-util.cpp.

{
    if (!split)
    {
        GNCPrintAmountInfo info = gnc_default_share_print_info ();
        info.use_symbol = use_symbol;
        return info;
    }
 
    return gnc_account_print_info (xaccSplitGetAccount (split), use_symbol);
}

gnc_ui_util_init()

void gnc_ui_util_init

(

void

)

Definition at line 2062 of file gnc-ui-util.cpp.

{
    gnc_configure_account_separator ();
    gnc_auto_decimal_init();
 
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL, GNC_PREF_ACCOUNT_SEPARATOR,
                          (void*)gnc_configure_account_separator, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL, GNC_PREF_REVERSED_ACCTS_NONE,
                          (void*)gnc_configure_reverse_balance, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL, GNC_PREF_REVERSED_ACCTS_CREDIT,
                          (void*)gnc_configure_reverse_balance, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL, GNC_PREF_REVERSED_ACCTS_INC_EXP,
                          (void*)gnc_configure_reverse_balance, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL, GNC_PREF_CURRENCY_CHOICE_LOCALE,
                          (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL, GNC_PREF_CURRENCY_CHOICE_OTHER,
                          (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL, GNC_PREF_CURRENCY_OTHER,
                          (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL_REPORT, GNC_PREF_CURRENCY_CHOICE_LOCALE,
                          (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL_REPORT, GNC_PREF_CURRENCY_CHOICE_OTHER,
                          (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL_REPORT, GNC_PREF_CURRENCY_OTHER,
                          (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL, GNC_PREF_AUTO_DECIMAL_POINT,
                          (void*)gnc_set_auto_decimal_enabled, nullptr);
    gnc_prefs_register_cb(GNC_PREFS_GROUP_GENERAL, GNC_PREF_AUTO_DECIMAL_PLACES,
                          (void*)gnc_set_auto_decimal_places, nullptr);
 
}

gnc_ui_util_remove_registered_prefs()

void gnc_ui_util_remove_registered_prefs

(

void

)

Definition at line 2095 of file gnc-ui-util.cpp.

{
    // remove the registered pref call backs above
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL,
                                 GNC_PREF_ACCOUNT_SEPARATOR,
                                 (void*)gnc_configure_account_separator, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL,
                                 GNC_PREF_REVERSED_ACCTS_NONE,
                                 (void*)gnc_configure_reverse_balance, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL,
                                 GNC_PREF_REVERSED_ACCTS_CREDIT,
                                 (void*)gnc_configure_reverse_balance, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL,
                                 GNC_PREF_REVERSED_ACCTS_INC_EXP,
                                 (void*)gnc_configure_reverse_balance, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL,
                                 GNC_PREF_CURRENCY_CHOICE_LOCALE,
                                 (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL,
                                 GNC_PREF_CURRENCY_CHOICE_OTHER,
                                 (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL,
                                 GNC_PREF_CURRENCY_OTHER,
                                 (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL_REPORT,
                                 GNC_PREF_CURRENCY_CHOICE_LOCALE,
                                 (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL_REPORT,
                                 GNC_PREF_CURRENCY_CHOICE_OTHER,
                                 (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL_REPORT,
                                 GNC_PREF_CURRENCY_OTHER,
                                 (void*)gnc_currency_changed_cb, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL,
                                 GNC_PREF_AUTO_DECIMAL_POINT,
                                 (void*)gnc_set_auto_decimal_enabled, nullptr);
    gnc_prefs_remove_cb_by_func (GNC_PREFS_GROUP_GENERAL,
                                 GNC_PREF_AUTO_DECIMAL_PLACES,
                                 (void*)gnc_set_auto_decimal_places, nullptr);
}

gnc_using_equity_type_opening_balance_account()

gboolean gnc_using_equity_type_opening_balance_account

(

QofBook *

book

)

Definition at line 176 of file gnc-ui-util.cpp.

{
    return gnc_features_check_used (book, GNC_FEATURE_EQUITY_TYPE_OPENING_BALANCE);
}

gnc_wrap_text_with_bidi_ltr_isolate()

char * gnc_wrap_text_with_bidi_ltr_isolate

(

const char *

text

)

This function helps with GTK's use of 'Unicode Bidirectional Text Algorithm'.

To keep the format of the text, this function wraps the text with a BiDi isolate charatcter and a BiDi closing character.

This helps with monetary values in RTL languages that display the currency symbol.

Definition at line 1489 of file gnc-ui-util.cpp.

{
    static const char* ltr = "\u2066"; // ltr isolate
    static const char* pop = "\u2069"; // pop directional formatting
 
    if (!text)
        return nullptr;
 
    return g_strconcat (ltr, text, pop, nullptr);
}

numeric_to_words()

char * numeric_to_words

(

gnc_numeric

val

)

Definition at line 1563 of file gnc-ui-util.cpp.

{
    if (val.denom < 0)      // reciprocal denominator means num * -denom
        val = gnc_numeric_convert (val, 1, GNC_HOW_RND_NEVER);
    if (gnc_numeric_check (val))
        return g_strdup ("");
 
    std::string out;
    out.reserve (300);
    auto append_word = [&out](auto word){ if (!out.empty()) out += ' '; out += word; };
    auto append_below_1000 = [&](uint64_t n)
    {
        if (n >= 100)
        {
            append_word (small_numbers[n / 100]);
            append_word (big_numbers[0]);
            n %= 100;
        }
        if (n > 20)
        {
            append_word (medium_numbers[n / 10]);
            n %= 10;
        }
        if (n > 0)
            append_word (small_numbers[n]);
    };
 
    auto absnum = val.num < 0 ? 0 - static_cast<uint64_t> (val.num)
        : static_cast<uint64_t> (val.num);
    auto denom = static_cast<uint64_t> (val.denom);
    auto whole = absnum / denom;
    if (whole == 0)
        out = "zero";
    else
    {
        std::vector<unsigned> groups;
        for (; whole; whole /= 1000)
            groups.push_back (whole % 1000);
 
        for (int i = groups.size() - 1; i >= 0; --i)
        {
            if (groups[i] == 0)
                continue;
            append_below_1000 (groups[i]);
            if (i > 0)
                append_word (big_numbers[i]);
        }
    }
 
    if (denom != 1)
    {
        out += " and ";
        auto rem = absnum % denom;
        for (auto d = denom, r = rem ? rem : 1; d % 10 == 0; d /= 10, r /= 10)
            if (r == 0)
                out += '0';
        out += std::to_string (rem);
        out += '/';
        out += std::to_string (denom);
    }
    return g_strndup (out.c_str(), out.size());
}

xaccParseAmount()

gboolean xaccParseAmount	(	const char *	in_str,
		gboolean	monetary,
		gnc_numeric *	result,
		char **	endstr
	)

Parses in_str to obtain a numeric result.

The routine will parse as much of in_str as it can to obtain a single number. The number is parsed using the current locale information and the 'monetary' flag. The routine will return TRUE if it successfully parsed a number and FALSE otherwise. If TRUE is returned and result is non-NULL, the value of the parsed number is stored in *result. If FALSE is returned, *result is unchanged. If TRUE is returned and endstr is non-NULL, the location of the first character in in_str not used by the parser will be returned in *endstr. If FALSE is returned and endstr is non-NULL, *endstr will point to in_str.

Definition at line 1994 of file gnc-ui-util.cpp.

{
    return xaccParseAmountBasicInternal (in_str, monetary, auto_decimal_enabled,
                                         result, endstr, FALSE);
}

xaccParseAmountExtended()

gboolean xaccParseAmountExtended	(	const char *	in_str,
		gboolean	monetary,
		gunichar	negative_sign,
		gunichar	decimal_point,
		gunichar	group_separator,
		const char *	ignore_list,
		gnc_numeric *	result,
		char **	endstr
	)

Converts a string to a gnc_numeric.

The caller must provide all the locale-specific information.

ignore_list is a list of characters that are completely ignored while processing the input string. If ignore_list is NULL, nothing is ignored.

Definition at line 2012 of file gnc-ui-util.cpp.

{
    return xaccParseAmountInternal (in_str, monetary, negative_sign,
                                    decimal_point, group_separator,
                                    ignore_list, auto_decimal_enabled,
                                    result, endstr);
}

xaccParseAmountExtImport()

gboolean xaccParseAmountExtImport	(	const char *	in_str,
		gboolean	monetary,
		gunichar	negative_sign,
		gunichar	decimal_point,
		gunichar	group_separator,
		const char *	ignore_list,
		gnc_numeric *	result,
		char **	endstr
	)

Similar to xaccParseAmountExtended, but will not automatically set a decimal point, regardless of what the user has set for this option.

Primarily meant for cases where numbers are coming into gnucash that are not typed in by the user (like via csv import).

Definition at line 2024 of file gnc-ui-util.cpp.

{
    return xaccParseAmountInternal (in_str, monetary, negative_sign,
                                    decimal_point, group_separator,
                                    ignore_list, FALSE,
                                    result, endstr);
}

xaccParseAmountImport()

gboolean xaccParseAmountImport	(	const char *	in_str,
		gboolean	monetary,
		gnc_numeric *	result,
		char **	endstr,
		gboolean	skip
	)

Similar to xaccParseAmount, but with two differences.

• it exposes a flag to indicate whether the locale's positive sign (or in absence the '+') character is ignored. Setting skip to TRUE will cause the function to ignore any positive sign. Setting it to FALSE, and positive signs will be treated as unrecognized characters. xaccParseAmount will run as if skip is FALSE for compatibility reasons (gnc-expression-parser depends on this behaviour).
• The other important difference with xaccParseAmount is that this function will never apply automatic decimal point logc, whereas xaccParseAmount will follow the automatic decimal point preference as set by the user.

Definition at line 2002 of file gnc-ui-util.cpp.

{
    return xaccParseAmountBasicInternal (in_str, monetary, FALSE,
                                         result, endstr, skip);
}

xaccPrintAmount()

const char * xaccPrintAmount	(	gnc_numeric	val,
		GNCPrintAmountInfo	info
	)

Make a string representation of a gnc_numeric.

Warning, the gnc_numeric is not checked for validity and the returned char* may point to random garbage.

Definition at line 1435 of file gnc-ui-util.cpp.

{
    /* hack alert -- this is not thread safe ... */
    static char buf[BUFLEN];
 
    if (!xaccSPrintAmount (buf, val, info))
        buf[0] = '\0';
 
    /* its OK to return buf, since we declared it static */
    return buf;
}

xaccSPrintAmount()

int xaccSPrintAmount	(	char *	bufp,
		gnc_numeric	val,
		GNCPrintAmountInfo	info
	)

Make a string representation of a gnc_numeric.

Warning, the gnc_numeric is not checked for validity and the contents of the buffer will be unchanged. It is up to the calling function to ensure that buf is large enough for the results.

Parameters

bufp	Should be at least 64 chars.

Definition at line 1308 of file gnc-ui-util.cpp.

{
    auto orig_bufp = bufp;
    auto currency_symbol = "";
    const char* sign;
 
    char cs_precedes;
    char sep_by_space;
    char sign_posn;
 
    bool print_sign = true;
    bool print_absolute = false;
 
    if (!bufp)
        return 0;
 
    auto lc = gnc_localeconv();
    if (info.use_locale)
        if (gnc_numeric_negative_p (val))
        {
            cs_precedes  = lc->n_cs_precedes;
            sep_by_space = lc->n_sep_by_space;
        }
        else
        {
            cs_precedes  = lc->p_cs_precedes;
            sep_by_space = lc->p_sep_by_space;
        }
    else
    {
        cs_precedes = TRUE;
        sep_by_space = TRUE;
    }
 
    if (info.commodity && info.use_symbol)
    {
        currency_symbol = gnc_commodity_get_nice_symbol (info.commodity);
        if (!gnc_commodity_is_iso (info.commodity))
        {
            cs_precedes  = FALSE;
            sep_by_space = TRUE;
        }
    }
 
    if (gnc_numeric_negative_p (val))
    {
        sign = lc->negative_sign;
        sign_posn = lc->n_sign_posn;
    }
    else
    {
        sign = lc->positive_sign;
        sign_posn = lc->p_sign_posn;
    }
 
    if (gnc_numeric_zero_p (val) || (sign == nullptr) || (sign[0] == 0))
        print_sign = FALSE;
 
    /* See if we print sign now */
    if (print_sign && (sign_posn == 1))
        bufp = g_stpcpy(bufp, sign);
 
    /* Now see if we print currency */
    if (cs_precedes)
    {
        /* See if we print sign now */
        if (print_sign && (sign_posn == 3))
            bufp = g_stpcpy(bufp, sign);
 
        if (info.use_symbol)
        {
            bufp = g_stpcpy(bufp, currency_symbol);
            if (sep_by_space)
                bufp = g_stpcpy(bufp, " ");
        }
 
        /* See if we print sign now */
        if (print_sign && (sign_posn == 4))
            bufp = g_stpcpy(bufp, sign);
    }
 
    /* Now see if we print parentheses */
    if (print_sign && (sign_posn == 0))
    {
        bufp = g_stpcpy(bufp, "(");
        print_absolute = TRUE;
    }
 
    /* Now print the value */
    bufp += PrintAmountInternal(bufp,
                                print_absolute ? gnc_numeric_abs(val) : val,
                                &info);
 
    /* Now see if we print parentheses */
    if (print_sign && (sign_posn == 0))
        bufp = g_stpcpy(bufp, ")");
 
    /* Now see if we print currency */
    if (!cs_precedes)
    {
        /* See if we print sign now */
        if (print_sign && (sign_posn == 3))
            bufp = g_stpcpy(bufp, sign);
 
        if (info.use_symbol)
        {
            if (sep_by_space)
                bufp = g_stpcpy(bufp, " ");
            bufp = g_stpcpy(bufp, currency_symbol);
        }
 
        /* See if we print sign now */
        if (print_sign && (sign_posn == 4))
            bufp = g_stpcpy(bufp, sign);
    }
 
    /* See if we print sign now */
    if (print_sign && (sign_posn == 2))
        bufp = g_stpcpy(bufp, sign);
 
    /* return length of printed string */
    return (bufp - orig_bufp);
}