split-register-p.h

/********************************************************************\
 * split-register-p.h -- private split register declarations        *
 *                                                                  *
 * This program is free software; you can redistribute it and/or    *
 * modify it under the terms of the GNU General Public License as   *
 * published by the Free Software Foundation; either version 2 of   *
 * the License, or (at your option) any later version.              *
 *                                                                  *
 * This program is distributed in the hope that it will be useful,  *
 * but WITHOUT ANY WARRANTY; without even the implied warranty of   *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the    *
 * GNU General Public License for more details.                     *
 *                                                                  *
 * You should have received a copy of the GNU General Public License*
 * along with this program; if not, contact:                        *
 *                                                                  *
 * Free Software Foundation           Voice:  +1-617-542-5942       *
 * 51 Franklin Street, Fifth Floor    Fax:    +1-617-542-2652       *
 * Boston, MA  02110-1301,  USA       [email protected]                   *
 *                                                                  *
\********************************************************************/

#ifndef SPLIT_REGISTER_P_H
#define SPLIT_REGISTER_P_H

#include "split-register.h"


#define SPLIT_TRANS_STR _("-- Split Transaction --")
#define STOCK_SPLIT_STR _("-- Stock Split --")

#define ACTION_BUY_STR  _("Buy")
#define ACTION_SELL_STR _("Sell")

typedef enum {
    RATE_RESET_NOT_REQD = 0,
    RATE_RESET_REQD     = 1,
    RATE_RESET_DONE     = 2
} RateReset_t;

struct sr_info
{
    /* The blank split at the bottom of the register */
    GncGUID blank_split_guid;

    /* The currently open transaction, if any */
    GncGUID pending_trans_guid;

    /* A transaction used to remember where to put the cursor */
    Transaction *cursor_hint_trans;

    /* A split used to remember where to put the cursor */
    Split *cursor_hint_split;

    /* A split used to remember where to put the cursor */
    Split *cursor_hint_trans_split;

    /* Used to remember where to put the cursor */
    CursorClass cursor_hint_cursor_class;

    /* If the hints were set by the traverse callback */
    gboolean hint_set_by_traverse;

    /* If traverse is to the newly created split */
    gboolean traverse_to_new;

    /* A flag indicating if the last traversal was 'exact'.
     * See table-allgui.[ch] for details. */
    gboolean exact_traversal;

    /* Indicates that the current transaction is expanded
     * in ledger mode. Meaningless in other modes. */
    gboolean trans_expanded;

    /* set to TRUE after register is loaded */
    gboolean reg_loaded;

    /* flag indicating whether full refresh is ok */
    gboolean full_refresh;

    /* The default account where new splits are added */
    GncGUID default_account;

    /* The last date recorded in the blank split */
    time64 last_date_entered;

    /* true if the current blank split has been edited and commited */
    gboolean blank_split_edited;

    /* true if the demarcation between 'past' and 'future' transactions
     * should be visible */
    gboolean show_present_divider;

    /* true if we are loading the register for the first time */
    gboolean first_pass;

    /* true if the user has already confirmed changes of a reconciled
     * split */
    gboolean change_confirmed;

    /* RATE_RESET_NOT_REQD => No exchange rate dialog needed for current split
     * RATE_RESET_REQD => Need new exchange rate for current split
     * RATE_RESET_DONE => Already got a new exchange rate for current split
     */
    RateReset_t rate_reset;
    
    /* true if the transaction being edited was auto-filled */
    gboolean auto_complete;

    /* account on the current split when the exchange rate was last set */
    Account *rate_account;

    /* User data for users of SplitRegisters */
    gpointer user_data;

    /* hook to get parent widget */
    SRGetParentCallback get_parent;

    /* The template account which template transaction should belong to */
    GncGUID template_account;

    /* configured strings for debit/credit headers */
    char *debit_str;
    char *credit_str;
    char *tdebit_str;
    char *tcredit_str;

    /* true if the account separator has changed */
    gboolean separator_changed;
};


SRInfo * gnc_split_register_get_info (SplitRegister *reg);

GtkWidget *gnc_split_register_get_parent (SplitRegister *reg);

Split * gnc_split_register_get_split (SplitRegister *reg,
                                      VirtualCellLocation vcell_loc);

Account * gnc_split_register_get_default_account (SplitRegister *reg);

Transaction * gnc_split_register_get_trans (SplitRegister *reg,
        VirtualCellLocation vcell_loc);

Split *
gnc_split_register_get_trans_split (SplitRegister *reg,
                                    VirtualCellLocation vcell_loc,
                                    VirtualCellLocation *trans_split_loc);

gboolean gnc_split_register_find_split (SplitRegister *reg,
                                        Transaction *trans, Split *trans_split,
                                        Split *split, CursorClass cursor_class,
                                        VirtualCellLocation *vcell_loc);

void gnc_split_register_show_trans (SplitRegister *reg,
                                    VirtualCellLocation start_loc);

// Set the visibility of the split rows belonging to a transaction located at
// vcell_loc.
//
// If only_blank_split is TRUE, only the row used for entering an
// additional split is affected. Despite the name, this should not be confused
// with the "blank split" row used for entering the first split of a brand-new
// transaction. Instead, here it only refers to rows not tied to any split at
// all, such as those created for entering new splits on old transactions or
// the 2nd through nth split on brand-new transactions.
void gnc_split_register_set_trans_visible (SplitRegister *reg,
        VirtualCellLocation vcell_loc,
        gboolean visible,
        gboolean only_blank_split);

void gnc_split_register_set_cell_fractions (SplitRegister *reg, Split *split);

CellBlock * gnc_split_register_get_passive_cursor (SplitRegister *reg);
CellBlock * gnc_split_register_get_active_cursor (SplitRegister *reg);

void gnc_split_register_set_last_num (SplitRegister *reg, const char *num);

Account * gnc_split_register_get_account_by_name(
    SplitRegister *reg, BasicCell * cell, const char *name);
Account * gnc_split_register_get_account (SplitRegister *reg,
        const char *cell_name);

gboolean gnc_split_register_recn_cell_confirm (char old_flag, gpointer data);

gboolean gnc_split_register_check_cell (SplitRegister *reg,
                                        const char *cell_name);

CursorClass gnc_split_register_cursor_name_to_class (const char *cursor_name);

gnc_numeric gnc_split_register_debcred_cell_value (SplitRegister *reg);

/* Determine if we need to perform any conversion on the splits in this
 * transaction, and if so, what conversion we need
 */
gboolean gnc_split_reg_has_rate_cell (SplitRegisterType type);
gboolean gnc_split_register_split_needs_amount(
    SplitRegister *reg, Split *split);
gboolean gnc_split_register_needs_conv_rate(
    SplitRegister *reg, Transaction *txn, Account *acc);

#endif