30 #include "gncEntryP.h" 31 #include "gncOrderP.h" 32 #include "gncInvoiceP.h" 33 #include "gncTaxTableP.h" 35 #include "gnc-xml-helper.h" 37 #include "sixtp-utils.h" 38 #include "sixtp-parsers.h" 39 #include "sixtp-utils.h" 40 #include "sixtp-dom-parsers.h" 41 #include "sixtp-dom-generators.h" 44 #include "io-gncxml-gen.h" 46 #include "gnc-entry-xml-v2.h" 47 #include "gnc-owner-xml-v2.h" 49 #define _GNC_MOD_NAME GNC_ID_ENTRY 51 static QofLogModule log_module = GNC_MOD_IO;
53 const gchar* entry_version_string =
"2.0.0";
56 #define gnc_entry_string "gnc:GncEntry" 57 #define entry_guid_string "entry:guid" 58 #define entry_date_string "entry:date" 59 #define entry_dateentered_string "entry:entered" 60 #define entry_description_string "entry:description" 61 #define entry_action_string "entry:action" 62 #define entry_notes_string "entry:notes" 63 #define entry_qty_string "entry:qty" 66 #define entry_invacct_string "entry:i-acct" 67 #define entry_iprice_string "entry:i-price" 68 #define entry_idiscount_string "entry:i-discount" 69 #define entry_idisctype_string "entry:i-disc-type" 70 #define entry_idischow_string "entry:i-disc-how" 71 #define entry_itaxable_string "entry:i-taxable" 72 #define entry_itaxincluded_string "entry:i-taxincluded" 73 #define entry_itaxtable_string "entry:i-taxtable" 76 #define entry_billacct_string "entry:b-acct" 77 #define entry_bprice_string "entry:b-price" 78 #define entry_btaxable_string "entry:b-taxable" 79 #define entry_btaxincluded_string "entry:b-taxincluded" 80 #define entry_btaxtable_string "entry:b-taxtable" 81 #define entry_billable_string "entry:billable" 82 #define entry_billto_string "entry:billto" 85 #define entry_billpayment_string "entry:b-pay" 88 #define entry_order_string "entry:order" 89 #define entry_invoice_string "entry:invoice" 90 #define entry_bill_string "entry:bill" 91 #define entry_slots_string "entry:slots" 94 maybe_add_string (xmlNodePtr ptr,
const char* tag,
const char* str)
97 xmlAddChild (ptr, text_to_dom_tree (tag, str));
101 maybe_add_numeric (xmlNodePtr ptr,
const char* tag, gnc_numeric num)
104 xmlAddChild (ptr, gnc_numeric_to_dom_tree (tag, &num));
108 entry_dom_tree_create (GncEntry* entry)
116 ret = xmlNewNode (NULL, BAD_CAST gnc_entry_string);
117 xmlSetProp (ret, BAD_CAST
"version", BAD_CAST entry_version_string);
119 xmlAddChild (ret, guid_to_dom_tree (entry_guid_string,
123 xmlAddChild (ret, time64_to_dom_tree (entry_date_string, time));
125 time = gncEntryGetDateEntered (entry);
126 xmlAddChild (ret, time64_to_dom_tree (entry_dateentered_string, time));
128 maybe_add_string (ret, entry_description_string,
129 gncEntryGetDescription (entry));
130 maybe_add_string (ret, entry_action_string, gncEntryGetAction (entry));
131 maybe_add_string (ret, entry_notes_string, gncEntryGetNotes (entry));
137 acc = gncEntryGetInvAccount (entry);
139 xmlAddChild (ret, guid_to_dom_tree (entry_invacct_string,
142 maybe_add_numeric (ret, entry_iprice_string, gncEntryGetInvPrice (entry));
144 maybe_add_numeric (ret, entry_idiscount_string,
145 gncEntryGetInvDiscount (entry));
147 invoice = gncEntryGetInvoice (entry);
150 xmlAddChild (ret, guid_to_dom_tree (entry_invoice_string,
153 xmlAddChild (ret, text_to_dom_tree (entry_idisctype_string,
154 gncAmountTypeToString (
155 gncEntryGetInvDiscountType (entry))));
156 xmlAddChild (ret, text_to_dom_tree (entry_idischow_string,
158 gncEntryGetInvDiscountHow (entry))));
160 xmlAddChild (ret, int_to_dom_tree (entry_itaxable_string,
161 gncEntryGetInvTaxable (entry)));
162 xmlAddChild (ret, int_to_dom_tree (entry_itaxincluded_string,
163 gncEntryGetInvTaxIncluded (entry)));
166 taxtable = gncEntryGetInvTaxTable (entry);
168 xmlAddChild (ret, guid_to_dom_tree (entry_itaxtable_string,
173 acc = gncEntryGetBillAccount (entry);
175 xmlAddChild (ret, guid_to_dom_tree (entry_billacct_string,
178 maybe_add_numeric (ret, entry_bprice_string, gncEntryGetBillPrice (entry));
180 invoice = gncEntryGetBill (entry);
184 xmlAddChild (ret, guid_to_dom_tree (entry_bill_string,
186 xmlAddChild (ret, int_to_dom_tree (entry_billable_string,
187 gncEntryGetBillable (entry)));
188 owner = gncEntryGetBillTo (entry);
189 if (owner && owner->owner.undefined != NULL)
190 xmlAddChild (ret, gnc_owner_to_dom_tree (entry_billto_string, owner));
192 xmlAddChild (ret, int_to_dom_tree (entry_btaxable_string,
193 gncEntryGetBillTaxable (entry)));
194 xmlAddChild (ret, int_to_dom_tree (entry_btaxincluded_string,
195 gncEntryGetBillTaxIncluded (entry)));
196 maybe_add_string (ret, entry_billpayment_string,
197 gncEntryPaymentTypeToString (gncEntryGetBillPayment (entry)));
200 taxtable = gncEntryGetBillTaxTable (entry);
202 xmlAddChild (ret, guid_to_dom_tree (entry_btaxtable_string,
207 order = gncEntryGetOrder (entry);
209 xmlAddChild (ret, guid_to_dom_tree (entry_order_string,
213 xmlAddChild (ret, qof_instance_slots_to_dom_tree (entry_slots_string,
214 QOF_INSTANCE (entry)));
227 static inline gboolean
228 set_time64 (xmlNodePtr node, GncEntry* entry,
229 void (*func) (GncEntry* entry,
time64 ts))
231 time64 time = dom_tree_to_time64 (node);
232 if (!dom_tree_valid_time64 (time, node->name)) time = 0;
237 static inline gboolean
238 set_numeric (xmlNodePtr node, GncEntry* entry,
239 void (*func) (GncEntry* entry, gnc_numeric num))
241 func (entry, dom_tree_to_gnc_numeric (node));
245 static inline gboolean
246 set_boolean (xmlNodePtr node, GncEntry* entry,
247 void (*func) (GncEntry* entry, gboolean val))
251 if (!dom_tree_to_integer (node, &val))
253 func (entry, (gboolean)val);
257 static inline gboolean
258 set_account (xmlNodePtr node,
struct entry_pdata* pdata,
259 void (*func) (GncEntry* entry,
Account* acc))
263 auto guid = dom_tree_to_guid (node);
264 g_return_val_if_fail (guid, FALSE);
266 g_return_val_if_fail (acc, FALSE);
269 func (pdata->entry, acc);
275 static inline gboolean
276 set_taxtable (xmlNodePtr node,
struct entry_pdata* pdata,
277 void (*func) (GncEntry* entry,
GncTaxTable* taxtable))
281 auto guid = dom_tree_to_guid (node);
282 g_return_val_if_fail (guid, FALSE);
283 taxtable = gncTaxTableLookup (pdata->book, &*guid);
286 taxtable = gncTaxTableCreate (pdata->book);
287 gncTaxTableBeginEdit (taxtable);
288 gncTaxTableSetGUID (taxtable, &*guid);
289 gncTaxTableCommitEdit (taxtable);
292 gncTaxTableDecRef (taxtable);
294 func (pdata->entry, taxtable);
299 entry_guid_handler (xmlNodePtr node, gpointer
entry_pdata)
304 auto guid = dom_tree_to_guid (node);
305 g_return_val_if_fail (guid, FALSE);
306 entry = gncEntryLookup (pdata->book, &*guid);
309 gncEntryDestroy (pdata->entry);
310 pdata->entry = entry;
311 gncEntryBeginEdit (entry);
315 gncEntrySetGUID (pdata->entry, &*guid);
322 entry_date_handler (xmlNodePtr node, gpointer
entry_pdata)
329 entry_dateentered_handler (xmlNodePtr node, gpointer
entry_pdata)
332 return set_time64 (node, pdata->entry, gncEntrySetDateEntered);
336 entry_description_handler (xmlNodePtr node, gpointer
entry_pdata)
340 return apply_xmlnode_text (gncEntrySetDescription, pdata->entry, node);
344 entry_action_handler (xmlNodePtr node, gpointer
entry_pdata)
348 return apply_xmlnode_text (gncEntrySetAction, pdata->entry, node);
352 entry_notes_handler (xmlNodePtr node, gpointer
entry_pdata)
356 return apply_xmlnode_text (gncEntrySetNotes, pdata->entry, node);
360 entry_qty_handler (xmlNodePtr node, gpointer
entry_pdata)
370 entry_invacct_handler (xmlNodePtr node, gpointer
entry_pdata)
373 return set_account (node, pdata, gncEntrySetInvAccount);
377 entry_iprice_handler (xmlNodePtr node, gpointer
entry_pdata)
381 return set_numeric (node, pdata->entry, gncEntrySetInvPrice);
385 entry_idiscount_handler (xmlNodePtr node, gpointer
entry_pdata)
389 return set_numeric (node, pdata->entry, gncEntrySetInvDiscount);
393 entry_idisctype_handler (xmlNodePtr node, gpointer
entry_pdata)
396 auto entry = pdata->entry;
397 auto set_discount_type = [entry](
auto str)
400 if (!gncAmountStringToType (str, &type))
return false;
401 gncEntrySetInvDiscountType (entry, type);
404 return apply_xmlnode_text (set_discount_type, node, FALSE);
408 entry_idischow_handler (xmlNodePtr node, gpointer
entry_pdata)
411 auto entry = pdata->entry;
412 auto set_discount_how = [entry](
auto str)
415 if (!gncEntryDiscountStringToHow (str, &how))
return false;
416 gncEntrySetInvDiscountHow (entry, how);
419 return apply_xmlnode_text (set_discount_how, node, FALSE);
423 entry_itaxable_handler (xmlNodePtr node, gpointer
entry_pdata)
426 return set_boolean (node, pdata->entry, gncEntrySetInvTaxable);
430 entry_itaxincluded_handler (xmlNodePtr node, gpointer
entry_pdata)
433 return set_boolean (node, pdata->entry, gncEntrySetInvTaxIncluded);
437 entry_itaxtable_handler (xmlNodePtr node, gpointer
entry_pdata)
440 return set_taxtable (node, pdata, gncEntrySetInvTaxTable);
446 entry_billacct_handler (xmlNodePtr node, gpointer
entry_pdata)
449 return set_account (node, pdata, gncEntrySetBillAccount);
453 entry_bprice_handler (xmlNodePtr node, gpointer
entry_pdata)
457 return set_numeric (node, pdata->entry, gncEntrySetBillPrice);
461 entry_btaxable_handler (xmlNodePtr node, gpointer
entry_pdata)
464 return set_boolean (node, pdata->entry, gncEntrySetBillTaxable);
468 entry_btaxincluded_handler (xmlNodePtr node, gpointer
entry_pdata)
471 return set_boolean (node, pdata->entry, gncEntrySetBillTaxIncluded);
475 entry_btaxtable_handler (xmlNodePtr node, gpointer
entry_pdata)
478 return set_taxtable (node, pdata, gncEntrySetBillTaxTable);
482 entry_billable_handler (xmlNodePtr node, gpointer
entry_pdata)
485 return set_boolean (node, pdata->entry, gncEntrySetBillable);
489 entry_billto_handler (xmlNodePtr node, gpointer
entry_pdata)
495 ret = gnc_dom_tree_to_owner (node, &billto, pdata->book);
497 gncEntrySetBillTo (pdata->entry, &billto);
504 entry_billpayment_handler (xmlNodePtr node, gpointer
entry_pdata)
507 auto entry = pdata->entry;
508 auto set_billpayment = [entry](
auto str)
510 GncEntryPaymentType type;
511 if (!gncEntryPaymentStringToType (str, &type))
return false;
512 gncEntrySetBillPayment (entry, type);
515 return apply_xmlnode_text (set_billpayment, node, FALSE);
521 entry_order_handler (xmlNodePtr node, gpointer
entry_pdata)
526 auto guid = dom_tree_to_guid (node);
527 g_return_val_if_fail (guid, FALSE);
528 order = gncOrderLookup (pdata->book, &*guid);
531 order = gncOrderCreate (pdata->book);
532 gncOrderBeginEdit (order);
533 gncOrderSetGUID (order, &*guid);
534 gncOrderCommitEdit (order);
536 gncOrderBeginEdit (order);
537 gncOrderAddEntry (order, pdata->entry);
538 gncOrderCommitEdit (order);
544 entry_invoice_handler (xmlNodePtr node, gpointer
entry_pdata)
549 auto guid = dom_tree_to_guid (node);
550 g_return_val_if_fail (guid, FALSE);
551 invoice = gncInvoiceLookup (pdata->book, &*guid);
554 invoice = gncInvoiceCreate (pdata->book);
555 gncInvoiceBeginEdit (invoice);
556 gncInvoiceSetGUID (invoice, &*guid);
557 gncInvoiceCommitEdit (invoice);
559 gncInvoiceBeginEdit (invoice);
560 gncInvoiceAddEntry (invoice, pdata->entry);
561 gncInvoiceCommitEdit (invoice);
567 entry_bill_handler (xmlNodePtr node, gpointer
entry_pdata)
572 auto guid = dom_tree_to_guid (node);
573 g_return_val_if_fail (guid, FALSE);
574 invoice = gncInvoiceLookup (pdata->book, &*guid);
577 invoice = gncInvoiceCreate (pdata->book);
578 gncInvoiceBeginEdit (invoice);
579 gncInvoiceSetGUID (invoice, &*guid);
580 gncInvoiceCommitEdit (invoice);
582 gncInvoiceBeginEdit (invoice);
584 gncInvoiceCommitEdit (invoice);
592 entry_acct_handler (xmlNodePtr node, gpointer
entry_pdata)
599 return set_account (node, pdata, NULL);
603 entry_price_handler (xmlNodePtr node, gpointer
entry_pdata)
609 res = set_numeric (node, pdata->entry, gncEntrySetInvPrice);
611 gncEntrySetBillPrice (pdata->entry, gncEntryGetInvPrice (pdata->entry));
616 entry_slots_handler (xmlNodePtr node, gpointer
entry_pdata)
620 return dom_tree_create_instance_slots (node, QOF_INSTANCE (pdata->entry));
625 { entry_guid_string, entry_guid_handler, 1, 0 },
626 { entry_date_string, entry_date_handler, 1, 0 },
627 { entry_dateentered_string, entry_dateentered_handler, 1, 0 },
628 { entry_description_string, entry_description_handler, 0, 0 },
629 { entry_action_string, entry_action_handler, 0, 0 },
630 { entry_notes_string, entry_notes_handler, 0, 0 },
631 { entry_qty_string, entry_qty_handler, 0, 0 },
634 { entry_invacct_string, entry_invacct_handler, 0, 0 },
635 { entry_iprice_string, entry_iprice_handler, 0, 0 },
636 { entry_idiscount_string, entry_idiscount_handler, 0, 0 },
637 { entry_idisctype_string, entry_idisctype_handler, 0, 0 },
638 { entry_idischow_string, entry_idischow_handler, 0, 0 },
639 { entry_itaxable_string, entry_itaxable_handler, 0, 0 },
640 { entry_itaxincluded_string, entry_itaxincluded_handler, 0, 0 },
641 { entry_itaxtable_string, entry_itaxtable_handler, 0, 0 },
644 { entry_billacct_string, entry_billacct_handler, 0, 0 },
645 { entry_bprice_string, entry_bprice_handler, 0, 0 },
646 { entry_btaxable_string, entry_btaxable_handler, 0, 0 },
647 { entry_btaxincluded_string, entry_btaxincluded_handler, 0, 0 },
648 { entry_btaxtable_string, entry_btaxtable_handler, 0, 0 },
649 { entry_billable_string, entry_billable_handler, 0, 0 },
650 { entry_billto_string, entry_billto_handler, 0, 0 },
653 { entry_billpayment_string, entry_billpayment_handler, 0, 0 },
656 { entry_order_string, entry_order_handler, 0, 0 },
657 { entry_invoice_string, entry_invoice_handler, 0, 0 },
658 { entry_bill_string, entry_bill_handler, 0, 0 },
659 { entry_slots_string, entry_slots_handler, 0, 0 },
662 {
"entry:acct", entry_acct_handler, 0, 0 },
663 {
"entry:price", entry_price_handler, 0, 0 },
664 {
"entry:discount", entry_idiscount_handler, 0, 0 },
665 {
"entry:disc-type", entry_idisctype_handler, 0, 0 },
666 {
"entry:disc-how", entry_idischow_handler, 0, 0 },
667 {
"entry:taxable", entry_itaxable_handler, 0, 0 },
668 {
"entry:taxincluded", entry_itaxincluded_handler, 0, 0 },
669 {
"entry:taxtable", entry_itaxtable_handler, 0, 0 },
674 dom_tree_to_entry (xmlNodePtr node, QofBook* book)
684 successful = dom_tree_generic_parse (node, entry_handlers_v2,
698 PERR (
"failed to parse entry tree");
707 gnc_entry_end_handler (gpointer data_for_children,
708 GSList* data_from_children, GSList* sibling_data,
709 gpointer parent_data, gpointer global_data,
710 gpointer* result,
const gchar* tag)
713 xmlNodePtr tree = (xmlNodePtr)data_for_children;
714 gxpf_data* gdata = (gxpf_data*)global_data;
715 QofBook* book =
static_cast<decltype (book)
> (gdata->bookdata);
730 g_return_val_if_fail (tree, FALSE);
732 entry = dom_tree_to_entry (tree, book);
735 gdata->cb (tag, gdata->parsedata, entry);
740 return entry != NULL;
744 entry_sixtp_parser_create (
void)
746 return sixtp_dom_parser_new (gnc_entry_end_handler, NULL, NULL);
752 int* count =
static_cast<decltype (count)
> (count_p);
757 entry_get_count (QofBook* book)
765 xml_add_entry (
QofInstance* entry_p, gpointer out_p)
768 GncEntry* entry = (GncEntry*) entry_p;
769 FILE* out =
static_cast<decltype (out)
> (out_p);
775 if (! (gncEntryGetOrder (entry) || gncEntryGetInvoice (entry) ||
776 gncEntryGetBill (entry)))
779 node = entry_dom_tree_create (entry);
780 xmlElemDump (out, NULL, node);
782 if (ferror (out) || fprintf (out,
"\n") < 0)
787 entry_write (FILE* out, QofBook* book)
790 return ferror (out) == 0;
796 g_return_val_if_fail (out, FALSE);
797 return gnc_xml2_write_namespace_decl (out,
"entry");
801 gnc_entry_xml_initialize (
void)
803 static GncXmlDataType_t be_data =
805 GNC_FILE_BACKEND_VERS,
807 entry_sixtp_parser_create,
815 gnc_xml_register_backend (be_data);
const GncGUID * qof_instance_get_guid(gconstpointer inst)
Return the GncGUID of this instance.
void gncEntrySetQuantity(GncEntry *entry, gnc_numeric quantity)
Set the internal quantity without any conversion.
gboolean gnc_numeric_zero_p(gnc_numeric a)
Returns 1 if the given gnc_numeric is 0 (zero), else returns 0.
#define PERR(format, args...)
Log a serious error.
time64 gncEntryGetDate(const GncEntry *entry)
DEPRECATED - use gncEntryGetDateGDate() instead! (Because the time-of-day is a misleading extra infor...
void qof_object_foreach_sorted(QofIdTypeConst type_name, QofBook *book, QofInstanceForeachCB cb, gpointer user_data)
Invoke callback 'cb' on each instance in guid orted order.
api for GnuCash version 2 XML-based file format
void gncBillAddEntry(GncInvoice *bill, GncEntry *entry)
Call this function when adding an entry to a bill instead of an invoice.
void qof_object_foreach(QofIdTypeConst type_name, QofBook *book, QofInstanceForeachCB cb, gpointer user_data)
Invoke the callback 'cb' on every instance ov a particular object type.
const char * gncEntryDiscountHowToString(GncDiscountHow how)
How to apply the discount and taxes.
gnc_numeric gncEntryGetQuantity(const GncEntry *entry)
Get the quantity as stored internally.
gint64 time64
Most systems that are currently maintained, including Microsoft Windows, BSD-derived Unixes and Linux...
void gncEntrySetDate(GncEntry *entry, time64 date)
DEPRECATED - use gncEntrySetDateGDate() instead! (Because the time-of-day is a misleading extra infor...
GncAmountType
How to interpret the amount.
modtime is the internal date of the last modtime See libgnucash/engine/TaxTableBillTermImmutability.txt for an explanation of the following Code that handles refcount, parent, child, invisible and children is identical to that in ::GncBillTerm
Account * xaccAccountLookup(const GncGUID *guid, QofBook *book)
The xaccAccountLookup() subroutine will return the account associated with the given id...