GnuCash  4.11-517-g41de4cefce
gnc-sx-instance-model.h
Go to the documentation of this file.
1 /*
2  * gnc-sx-instance-model.h
3  *
4  * Copyright (C) 2006 Josh Sled <jsled@asynchronous.org>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of version 2 and/or version 3 of the GNU General Public
8  * License as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, contact:
17  *
18  * Free Software Foundation Voice: +1-617-542-5942
19  * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652
20  * Boston, MA 02110-1301, USA gnu@gnu.org
21  */
22 
26 #ifndef _GNC_SX_INSTANCE_MODEL_H
27 #define _GNC_SX_INSTANCE_MODEL_H
28 
29 #include <config.h>
30 #include <glib.h>
31 #include <glib-object.h>
32 #include "gnc-numeric.h"
33 #include "SchedXaction.h"
34 
35 G_BEGIN_DECLS
36 
37 #define GNC_TYPE_SX_INSTANCE_MODEL (gnc_sx_instance_model_get_type ())
38 #define GNC_SX_INSTANCE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GNC_TYPE_SX_INSTANCE_MODEL, GncSxInstanceModel))
39 #define GNC_SX_INSTANCE_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GNC_TYPE_SX_INSTANCE_MODEL, GncSxInstanceModelClass))
40 #define GNC_IS_SX_INSTANCE_MODEL(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GNC_TYPE_SX_INSTANCE_MODEL))
41 #define GNC_IS_SX_INSTANCE_MODEL_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GNC_TYPE_SX_INSTANCE_MODEL))
42 #define GNC_SX_INSTANCE_MODEL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GNC_TYPE_SX_INSTANCE_MODEL, GncSxInstanceModelClass))
43 
44 typedef struct _GncSxInstanceModel
45 {
46  GObject parent;
47  gboolean disposed;
48 
49  /* private */
50  gint qof_event_handler_id;
51 
52  /* signals */
53  /* void (*added)(SchedXaction *sx); // gpointer user_data */
54  /* void (*updated)(SchedXaction *sx); // gpointer user_data */
55  /* void (*removing)(SchedXaction *sx); // gpointer user_data */
56 
57  /* public */
58  GDate range_end;
59  gboolean include_disabled;
60  GList *sx_instance_list; /* <GncSxInstances*> */
62 
63 typedef struct _GncSxInstanceModelClass
64 {
65  GObjectClass parent;
66 
67  guint removing_signal_id;
68  guint updated_signal_id;
69  guint added_signal_id;
71 
72 typedef struct _GncSxInstances
73 {
74  SchedXaction *sx;
75  GHashTable *variable_names;
76  gboolean variable_names_parsed;
77 
78  GDate next_instance_date;
79 
81  GList *instance_list;
83 
84 typedef enum
85 {
86  SX_INSTANCE_STATE_IGNORED,
87  SX_INSTANCE_STATE_POSTPONED,
88  SX_INSTANCE_STATE_TO_CREATE,
89  SX_INSTANCE_STATE_REMINDER,
90  SX_INSTANCE_STATE_CREATED,
91  SX_INSTANCE_STATE_MAX_STATE
92 } GncSxInstanceState;
93 
94 typedef struct _GncSxVariable
95 {
96  gchar *name;
97  gnc_numeric value;
98  gboolean editable;
100 
101 typedef struct _GncSxInstance
102 {
105  GncSxInstanceState orig_state;
106  GncSxInstanceState state;
107  GDate date;
108  GHashTable *variable_bindings;
109 } GncSxInstance;
110 
111 typedef struct _GncSxVariableNeeded
112 {
113  GncSxInstance *instance;
114  GncSxVariable *variable;
116 
117 GType gnc_sx_instance_model_get_type(void);
118 
121 
128 GncSxInstanceModel* gnc_sx_get_instances(const GDate *range_end, gboolean include_disabled);
129 
137 void gnc_sx_instance_model_remove_sx_instances(GncSxInstanceModel *model, SchedXaction *sx);
138 
144 void gnc_sx_scrub_split_numerics (gpointer psplit, gpointer user);
145 
148 
149 Account* gnc_sx_get_template_transaction_account(const SchedXaction *sx);
150 
154 GHashTable* gnc_sx_instance_get_variables_for_parser(GHashTable *instance_var_hash);
155 
156 GncSxVariable* gnc_sx_variable_new_full(gchar *name, gnc_numeric value, gboolean editable);
157 void gnc_sx_variable_free(GncSxVariable *var);
158 
186  GncSxInstance *instance,
187  GncSxInstanceState new_state);
188 
189 void gnc_sx_instance_model_set_variable(GncSxInstanceModel *model,
190  GncSxInstance *instance,
191  GncSxVariable *variable,
192  gnc_numeric *new_value);
193 
199 
203  gboolean auto_create_only,
204  GList **created_transaction_guids,
205  GList **creation_errors);
206 
207 typedef struct _GncSxSummary
208 {
209  gboolean need_dialog;
215 } GncSxSummary;
216 
223 
225 void gnc_sx_summary_print(const GncSxSummary *summary);
226 
227 void gnc_sx_get_variables(SchedXaction *sx, GHashTable *var_hash);
228 int gnc_sx_parse_vars_from_formula(const char *formula, GHashTable *var_hash, gnc_numeric *result);
229 void gnc_sx_randomize_variables(GHashTable *vars);
230 
236 GHashTable* gnc_g_hash_new_guid_numeric(void);
237 
246 void gnc_sx_all_instantiate_cashflow(GList *all_sxes,
247  const GDate *range_start, const GDate *range_end,
248  GHashTable* map, GList **creation_errors);
249 
257 GHashTable* gnc_sx_all_instantiate_cashflow_all(GDate range_start, GDate range_end);
258 
259 G_END_DECLS
260 
261 
262 #endif // _GNC_SX_INSTANCE_MODEL_H
GHashTable * variable_bindings
variable bindings.
GHashTable * gnc_g_hash_new_guid_numeric(void)
Returns a GHashTable<GUID*, gnc_numeric*> with no destructor for the key, but a destructor for the va...
SXTmpStateData * temporal_state
the sx creation temporal state.
GHashTable * variable_names
<name:char*,GncSxVariable*>
void gnc_sx_scrub_split_numerics(gpointer psplit, gpointer user)
Fix up numerics where they&#39;ve gotten out-of-sync with the formulas.
void gnc_sx_instance_model_change_instance_state(GncSxInstanceModel *model, GncSxInstance *instance, GncSxInstanceState new_state)
There is a constraint around a sequence of upcoming instance states.
GHashTable * gnc_sx_all_instantiate_cashflow_all(GDate range_start, GDate range_end)
Simplified wrapper around gnc_sx_all_instantiate_cashflow(): Run that function on all SX of the curre...
gint num_auto_create_no_notify_instances
The number of automatically-created instances that do no request notification.
An exact-rational-number library for gnucash.
GncSxInstanceState orig_state
the original state at generation time.
GHashTable * gnc_sx_instance_get_variables_for_parser(GHashTable *instance_var_hash)
void gnc_sx_instance_model_summarize(GncSxInstanceModel *model, GncSxSummary *summary)
void gnc_sx_instance_model_update_sx_instances(GncSxInstanceModel *model, SchedXaction *sx)
Regenerates and updates the GncSxInstances* for the given SX.
void gnc_sx_instance_model_effect_change(GncSxInstanceModel *model, gboolean auto_create_only, GList **created_transaction_guids, GList **creation_errors)
Really ("effectively") create the transactions from the SX instances in the given model...
Just the variable temporal bits from the SX structure.
Definition: SchedXaction.h:127
gint num_to_create_instances
The number of (not-auto-create) to-create instances.
gint num_instances
The number of total instances (in any state).
void gnc_sx_summary_print(const GncSxSummary *summary)
Debug output to trace file.
GncSxInstances * parent
the parent instances collection.
gint num_auto_create_instances
The total number of auto-create instances.
GDate date
the instance date.
void gnc_sx_all_instantiate_cashflow(GList *all_sxes, const GDate *range_start, const GDate *range_end, GHashTable *map, GList **creation_errors)
Instantiates the cash flow of all given SXs (in the given GList<SchedXAction*>) into the GHashTable<G...
GList * gnc_sx_instance_get_variables(GncSxInstance *inst)
GncSxInstanceModel * gnc_sx_get_instances(const GDate *range_end, gboolean include_disabled)
Allocates a new SxInstanceModel and fills it with generated instances for all scheduled transactions ...
gnc_numeric value
only numeric values are supported.
GncSxInstanceState state
the current state of the instance (during editing)
GncSxInstanceModel * gnc_sx_get_current_instances(void)
Shorthand for get_instances(now, FALSE);.
GList * instance_list
GList<GncSxInstance*>
Scheduled Transactions public handling routines.
gboolean need_dialog
If the dialog needs to be displayed.
GList * gnc_sx_instance_model_check_variables(GncSxInstanceModel *model)