gnc-imp-props-tx.hpp

/********************************************************************\
 * gnc-imp-props-tx.hpp - encapsulate transaction properties for    *
 *                        use in the csv importer                   *
 *                                                                  *
 * 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       gnu@gnu.org                   *
 *                                                                  *
\********************************************************************/

#ifndef GNC_TRANS_PROPS_HPP
#define GNC_TRANS_PROPS_HPP

#include <platform.h>
#if PLATFORM(WINDOWS)
#include <windows.h>
#endif

#include <glib/gi18n.h>

#include "Account.h"
#include "Transaction.h"
#include "gnc-commodity.h"

#include <string>
#include <map>
#include <memory>
#include <optional>
#include <gnc-datetime.hpp>
#include <gnc-numeric.hpp>

enum class GncTransPropType {
    NONE,
    UNIQUE_ID,
    DATE,
    NUM,
    DESCRIPTION,
    NOTES,
    COMMODITY,
    VOID_REASON,
    TRANS_PROPS = VOID_REASON,

    ACTION,
    ACCOUNT,
    AMOUNT,
    AMOUNT_NEG,
    VALUE,
    VALUE_NEG,
    PRICE,
    MEMO,
    REC_STATE,
    REC_DATE,
    TACTION,
    TACCOUNT,
    TAMOUNT,
    TAMOUNT_NEG,
    TMEMO,
    TREC_STATE,
    TREC_DATE,
    SPLIT_PROPS = TREC_DATE
};

#define IMAP_CAT_CSV "csv-account-map"

using StrVec = std::vector<std::string>;
using ErrMap = std::map<GncTransPropType, std::string>;
using ErrPair = std::pair<GncTransPropType, std::string>;

extern std::map<GncTransPropType, const char*> gnc_csv_col_type_strs;

struct test_prop_type_str
{
    test_prop_type_str( const char* name ) : m_name(name) {}
    bool operator()( const std::pair<GncTransPropType, const char*>& v ) const
    {
        return !g_strcmp0(v.second, m_name);
    }
private:
    const char *m_name;
};

bool is_multi_col_prop (GncTransPropType prop);

GncTransPropType sanitize_trans_prop (GncTransPropType prop, bool multi_split);


gnc_commodity* parse_commodity (const std::string& comm_str);
GncNumeric parse_monetary (const std::string &str, int currency_format);


struct DraftTransaction
{
    DraftTransaction (Transaction* tx) : trans(tx) {}
    ~DraftTransaction () { if (trans) { xaccTransDestroy (trans); trans = nullptr; } }
    Transaction* trans;

    std::optional<GncNumeric> m_price;
    std::optional<std::string> m_taction;
    std::optional<std::string> m_tmemo;
    std::optional<GncNumeric> m_tamount;
    std::optional<Account*> m_taccount;
    std::optional<char> m_trec_state;
    std::optional<GncDate> m_trec_date;

    std::optional<std::string> void_reason;
};

class GncPreTrans
{
public:
    GncPreTrans(int date_format, bool multi_split)
        : m_date_format{date_format}, m_multi_split{multi_split}, m_currency{nullptr} {};

    void set (GncTransPropType prop_type, const std::string& value);
    void set_date_format (int date_format) { m_date_format = date_format ;}
    void set_multi_split (bool multi_split) { m_multi_split = multi_split ;}
    void reset (GncTransPropType prop_type);
    StrVec verify_essentials (void);
    std::shared_ptr<DraftTransaction> create_trans (QofBook* book, gnc_commodity* currency);

    bool is_part_of (std::shared_ptr<GncPreTrans> parent);
    std::optional<std::string> get_void_reason() { return m_void_reason; }

    ErrMap errors();
    void reset_cross_split_counters();
    /* Some import errors need info from multiple splits. This function
     * will evaluate possible multi-line errors and set the proper error
     * message(s) for them. */
    bool is_multi_currency();


private:
    int m_date_format;
    bool m_multi_split;
    std::optional<std::string> m_differ;
    std::optional<GncDate> m_date;
    std::optional<std::string> m_num;
    std::optional<std::string> m_desc;
    std::optional<std::string> m_notes;
    gnc_commodity *m_currency;
    std::optional<std::string> m_void_reason;
    bool created = false;


    ErrMap m_errors;

    /* m_alt_currencies will be filled with all PreSplit account's
     * commodities that are currencies. If the account is denominated in a
     * non-currency, its parent account currency is added instead.
     * This list will be used to check for multi-currency inconsistencies
     * and whether extra columns are required. */
    std::vector<gnc_commodity*> m_alt_currencies;
    /* m_acct_commodities will be filled with all PreSplit account's
     * commodities that aren't currencies. The result will be used to check for
     * a multi-currency situation (which requires extra columns to be set). */
    std::vector<gnc_commodity*> m_acct_commodities;

    friend class GncPreSplit;
};

class GncPreSplit
{
public:
    GncPreSplit (int date_format, int currency_format) : m_date_format{date_format},
        m_currency_format{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) { m_date_format = date_format ;}
    void set_currency_format (int currency_format) { m_currency_format = currency_format; }
    void set_pre_trans (std::shared_ptr<GncPreTrans> pre_trans) { m_pre_trans = pre_trans; }
    std::shared_ptr<GncPreTrans> get_pre_trans (void) { return m_pre_trans; }
    StrVec verify_essentials (void);
    void create_split(std::shared_ptr<DraftTransaction> draft_trans);

    Account* get_account () { if (m_account) return *m_account; else return nullptr; }
    void set_account (Account* acct);
    ErrMap errors();

private:
    void UpdateCrossSplitCounters ();

    std::shared_ptr<GncPreTrans> m_pre_trans;
    int m_date_format;
    int m_currency_format;
    std::optional<std::string> m_action;
    std::optional<Account*> m_account;
    std::optional<GncNumeric> m_amount;
    std::optional<GncNumeric> m_amount_neg;
    std::optional<GncNumeric> m_value;
    std::optional<GncNumeric> m_value_neg;
    std::optional<GncNumeric> m_price;
    std::optional<std::string> m_memo;
    std::optional<char> m_rec_state;
    std::optional<GncDate> m_rec_date;
    std::optional<std::string> m_taction;
    std::optional<Account*> m_taccount;
    std::optional<GncNumeric> m_tamount;
    std::optional<GncNumeric> m_tamount_neg;
    std::optional<std::string> m_tmemo;
    std::optional<char> m_trec_state;
    std::optional<GncDate> m_trec_date;
    bool created = false;

    ErrMap m_errors;
};

#endif