mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
d52aa0a0dd
app-utils now is an ordinery shared library
A few bits worth mentioning:
1. it's not guile-free just yet, so instead of a gnc_module_load
your code may have to call scm_c_use_module("gnucash app-utils");
to expose the scm side of the app-utils api. This call has been
added to gnucash-bin.c for example
2. while lots of noise in this commit is to rename from gncmodule-app-utils
to gnc-app-utils, I'll point out the library has also been moved from
<libdir>/gnucash to <libdir>. This required changes in app-util's
CMakeLists.txt file for the install side and in the top level
CMakeLists.txt file for the build directory structure.
3. The C side link module test has been removed as linking an ordinary
shared library should be considered well tested by the compiler devs.
The scheme side module load test has been slightly tweaked to no longer
try to use gnc:module-load, but instead now checks whether the app-utils
api is properly exposed to scheme after loading it via use-modules.
4. Dropped a completely obsolete README file.
320 lines
12 KiB
Scheme
320 lines
12 KiB
Scheme
;; 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
|
|
|
|
(define-module (gnucash app-utils))
|
|
(eval-when
|
|
(compile load eval expand)
|
|
(load-extension "libgnc-app-utils" "scm_init_sw_app_utils_module"))
|
|
(use-modules (sw_app_utils))
|
|
|
|
; Export the swig-wrapped symbols in the public interface of this module
|
|
(let ((i (module-public-interface (current-module))))
|
|
(module-use! i (resolve-interface '(sw_app_utils))))
|
|
|
|
(use-modules (srfi srfi-1))
|
|
(use-modules (gnucash utilities))
|
|
(use-modules (gnucash engine))
|
|
(use-modules (gnucash core-utils))
|
|
|
|
;; c-interface.scm
|
|
(export gnc:apply-with-error-handling)
|
|
(export gnc:eval-string-with-error-handling)
|
|
(export gnc:backtrace-if-exception)
|
|
(export gnc:make-string-database)
|
|
|
|
;; options.scm
|
|
(export gnc:make-option)
|
|
(export gnc:option-section)
|
|
(export gnc:option-name)
|
|
(export gnc:option-sort-tag)
|
|
(export gnc:option-type)
|
|
(export gnc:option-documentation)
|
|
(export gnc:option-getter)
|
|
(export gnc:option-setter)
|
|
(export gnc:option-default-getter)
|
|
(export gnc:option-generate-restore-form)
|
|
(export gnc:option-scm->kvp)
|
|
(export gnc:set-option-scm->kvp)
|
|
(export gnc:option-kvp->scm)
|
|
(export gnc:set-option-kvp->scm)
|
|
(export gnc:option-value-validator)
|
|
(export gnc:option-data)
|
|
(export gnc:option-data-fns)
|
|
(export gnc:option-set-changed-callback)
|
|
(export gnc:option-strings-getter)
|
|
(export gnc:option-widget-changed-proc)
|
|
(export gnc:option-value)
|
|
(export gnc:option-set-value)
|
|
(export gnc:option-index-get-name)
|
|
(export gnc:option-index-get-description)
|
|
(export gnc:option-index-get-value)
|
|
(export gnc:option-value-get-index)
|
|
(export gnc:option-number-of-indices)
|
|
(export gnc:option-default-value)
|
|
(export gnc:option-set-default-value)
|
|
(export gnc:restore-form-generator)
|
|
(export gnc:value->string)
|
|
(export gnc:make-string-option)
|
|
(export gnc:make-text-option)
|
|
(export gnc:make-font-option)
|
|
(export gnc:make-currency-option)
|
|
(export gnc:make-commodity-option)
|
|
(export gnc:make-simple-boolean-option)
|
|
(export gnc:make-complex-boolean-option)
|
|
(export gnc:make-pixmap-option)
|
|
(export gnc:make-date-option)
|
|
(export gnc:make-budget-option)
|
|
(export gnc:get-rd-option-data-subtype)
|
|
(export gnc:get-rd-option-data-show-time)
|
|
(export gnc:get-rd-option-data-rd-list)
|
|
(export gnc:date-option-get-subtype)
|
|
(export gnc:date-option-show-time?)
|
|
(export gnc:date-option-value-type)
|
|
(export gnc:date-option-absolute-time)
|
|
(export gnc:date-option-relative-time)
|
|
(export gnc:make-account-list-option)
|
|
(export gnc:make-account-list-limited-option)
|
|
(export gnc:make-account-sel-option)
|
|
(export gnc:make-account-sel-limited-option)
|
|
(export gnc:multichoice-list-lookup)
|
|
(export gnc:make-multichoice-option)
|
|
(export gnc:make-multichoice-callback-option)
|
|
(export gnc:make-radiobutton-option)
|
|
(export gnc:make-radiobutton-callback-option)
|
|
(export gnc:make-list-option)
|
|
(export gnc:options-make-end-date!)
|
|
(export gnc:options-make-date-interval!)
|
|
(export gnc:option-make-internal!)
|
|
(export gnc:make-number-range-option)
|
|
(export gnc:make-number-plot-size-option)
|
|
(export gnc:plot-size-option-value-type)
|
|
(export gnc:plot-size-option-value)
|
|
|
|
(export gnc:make-internal-option)
|
|
(export gnc:make-query-option)
|
|
(export gnc:make-color-option)
|
|
(export gnc:make-dateformat-option)
|
|
(export gnc:dateformat-get-format)
|
|
(export gnc:currency-accounting-option-get-curr-doc-string)
|
|
(export gnc:currency-accounting-option-get-default-curr)
|
|
(export gnc:currency-accounting-option-get-policy-doc-string)
|
|
(export gnc:currency-accounting-option-get-default-policy)
|
|
(export gnc:currency-accounting-option-get-gain-loss-account-doc-string)
|
|
(export gnc:currency-accounting-option-selected-method)
|
|
(export gnc:currency-accounting-option-selected-currency)
|
|
(export gnc:currency-accounting-option-selected-policy)
|
|
(export gnc:currency-accounting-option-selected-gain-loss-account)
|
|
|
|
(export gnc:color->html)
|
|
(export gnc:color-option->html)
|
|
(export gnc:color-option->hex-string)
|
|
(export gnc:new-options)
|
|
|
|
(export gnc:register-option)
|
|
(export gnc:unregister-option)
|
|
(export gnc:options-register-callback)
|
|
(export gnc:options-register-c-callback)
|
|
(export gnc:options-unregister-callback-id)
|
|
(export gnc:options-for-each)
|
|
(export gnc:options-for-each-general)
|
|
(export gnc:lookup-option)
|
|
(export gnc:generate-restore-forms)
|
|
(export gnc:options-fancy-date)
|
|
(export gnc:options-scm->kvp)
|
|
(export gnc:options-kvp->scm)
|
|
(export gnc:options-clear-changes)
|
|
(export gnc:options-touch)
|
|
(export gnc:options-run-callbacks)
|
|
(export gnc:options-set-default-section)
|
|
(export gnc:options-get-default-section)
|
|
(export gnc:options-copy-values)
|
|
(export gnc:send-options)
|
|
|
|
(define (gnc:option-get-value book category key)
|
|
;;Access an option directly
|
|
(qof-book-get-option book
|
|
(if (list? key)
|
|
(append (list category) key)
|
|
(list category key))))
|
|
(export gnc:option-get-value)
|
|
|
|
;; gw-engine-spec.scm
|
|
(re-export HOOK-SAVE-OPTIONS)
|
|
|
|
;; date-utilities.scm
|
|
|
|
(export gnc:reldate-list)
|
|
(export gnc:date-get-year)
|
|
(export gnc:date-get-quarter)
|
|
(export gnc:date-get-month-day)
|
|
(export gnc:date-get-month)
|
|
(export gnc:date-get-week-day)
|
|
(export gnc:date-get-week)
|
|
(export gnc:date-get-year-day)
|
|
(export gnc:time64-get-year)
|
|
(export gnc:time64-get-quarter)
|
|
(export gnc:time64-get-month-day)
|
|
(export gnc:time64-get-month)
|
|
(export gnc:time64-get-week-day)
|
|
(export gnc:time64-get-week)
|
|
(export gnc:time64-get-year-day)
|
|
(export gnc:date-get-year-string)
|
|
(export gnc:date-get-quarter-string)
|
|
(export gnc:date-get-quarter-year-string)
|
|
(export gnc:date-get-month-string)
|
|
(export gnc:date-get-month-year-string)
|
|
(export gnc:date-get-week-year-string)
|
|
(export gnc:leap-year?)
|
|
(export gnc:days-in-year)
|
|
(export gnc:days-in-month)
|
|
(export gnc:date-to-year-fraction)
|
|
(export gnc:date-year-delta)
|
|
(export gnc:date-to-month-fraction)
|
|
(export gnc:date-to-week-fraction)
|
|
(export gnc:date-to-week)
|
|
(export gnc:date-to-day-fraction)
|
|
(export gnc:date-get-fraction-func)
|
|
(export moddatek)
|
|
(export decdate)
|
|
(export incdate)
|
|
(export decdate)
|
|
(export incdate)
|
|
(export gnc:make-date-interval-list)
|
|
(export gnc:make-date-list)
|
|
(export SecDelta)
|
|
(export DayDelta)
|
|
(export WeekDelta )
|
|
(export TwoWeekDelta)
|
|
(export MonthDelta)
|
|
(export QuarterDelta)
|
|
(export HalfYearDelta)
|
|
(export YearDelta )
|
|
(export ThirtyDayDelta)
|
|
(export NinetyDayDelta)
|
|
(export gnc:deltasym-to-delta)
|
|
(export gnc:time64-start-day-time)
|
|
(export gnc:time64-end-day-time)
|
|
(export gnc:time64-previous-day)
|
|
(export gnc:time64-next-day)
|
|
(export gnc:reldate-get-symbol)
|
|
(export gnc:reldate-get-string)
|
|
(export gnc:reldate-get-desc)
|
|
(export gnc:reldate-get-fn)
|
|
(export gnc:get-absolute-from-relative-date)
|
|
(export gnc:get-relative-date-string)
|
|
(export gnc:get-relative-date-desc)
|
|
(export gnc:get-start-cal-year)
|
|
(export gnc:get-end-cal-year)
|
|
(export gnc:get-start-prev-year)
|
|
(export gnc:get-end-prev-year)
|
|
(export gnc:get-start-this-month)
|
|
(export gnc:get-end-this-month)
|
|
(export gnc:get-start-prev-month)
|
|
(export gnc:get-end-prev-month)
|
|
(export gnc:get-start-current-quarter)
|
|
(export gnc:get-end-current-quarter)
|
|
(export gnc:get-start-prev-quarter)
|
|
(export gnc:get-end-prev-quarter)
|
|
(export gnc:get-today)
|
|
(export gnc:get-one-month-ago)
|
|
(export gnc:get-three-months-ago)
|
|
(export gnc:get-six-months-ago)
|
|
(export gnc:get-one-year-ago)
|
|
(export gnc:reldate-initialize)
|
|
(export gnc:get-end-next-month)
|
|
(export gnc:get-end-next-quarter)
|
|
(export gnc:get-end-next-year)
|
|
(export gnc:get-one-month-ahead)
|
|
(export gnc:get-one-year-ahead)
|
|
(export gnc:get-six-months-ahead)
|
|
(export gnc:get-start-next-month)
|
|
(export gnc:get-start-next-quarter)
|
|
(export gnc:get-start-next-year)
|
|
(export gnc:get-three-months-ahead)
|
|
|
|
(define gnc:*kvp-option-path* (list KVP-OPTION-PATH))
|
|
(export gnc:*kvp-option-path*)
|
|
|
|
(load-from-path "gnucash/app-utils/c-interface")
|
|
(load-from-path "gnucash/app-utils/options")
|
|
(load-from-path "gnucash/app-utils/date-utilities")
|
|
|
|
;; Business options
|
|
(define gnc:*business-label* (N_ "Business"))
|
|
(define gnc:*company-name* (N_ "Company Name"))
|
|
(define gnc:*company-addy* (N_ "Company Address"))
|
|
(define gnc:*company-id* (N_ "Company ID"))
|
|
(define gnc:*company-phone* (N_ "Company Phone Number"))
|
|
(define gnc:*company-fax* (N_ "Company Fax Number"))
|
|
(define gnc:*company-url* (N_ "Company Website URL"))
|
|
(define gnc:*company-email* (N_ "Company Email Address"))
|
|
(define gnc:*company-contact* (N_ "Company Contact Person"))
|
|
(define gnc:*fancy-date-label* (N_ "Fancy Date Format"))
|
|
(define gnc:*fancy-date-format* (N_ "custom"))
|
|
(define gnc:*tax-label* (N_ "Tax"))
|
|
(define gnc:*tax-nr-label* (N_ "Tax Number"))
|
|
|
|
(define (gnc:company-info book key)
|
|
;; Access company info from key-value pairs for current book
|
|
(gnc:option-get-value book gnc:*business-label* key))
|
|
|
|
(define (gnc:fancy-date-info book key)
|
|
;; Access fancy date info from key-value pairs for current book
|
|
(gnc:option-get-value book gnc:*business-label* (list gnc:*fancy-date-label* key)))
|
|
|
|
(export gnc:*business-label* gnc:*company-name* gnc:*company-addy*
|
|
gnc:*company-id* gnc:*company-phone* gnc:*company-fax*
|
|
gnc:*company-url* gnc:*company-email* gnc:*company-contact*
|
|
gnc:*fancy-date-label* gnc:*fancy-date-format*
|
|
gnc:company-info gnc:fancy-date-info)
|
|
|
|
(define gnc:*option-section-accounts* OPTION-SECTION-ACCOUNTS)
|
|
(define gnc:*option-name-trading-accounts* OPTION-NAME-TRADING-ACCOUNTS)
|
|
(define gnc:*option-name-currency-accounting* OPTION-NAME-CURRENCY-ACCOUNTING)
|
|
(define gnc:*option-name-book-currency* OPTION-NAME-BOOK-CURRENCY)
|
|
(define gnc:*option-name-default-gains-policy* OPTION-NAME-DEFAULT-GAINS-POLICY)
|
|
(define gnc:*option-name-default-gain-loss-account* OPTION-NAME-DEFAULT-GAINS-LOSS-ACCT-GUID)
|
|
(define gnc:*option-name-auto-readonly-days* OPTION-NAME-AUTO-READONLY-DAYS)
|
|
(define gnc:*option-name-num-field-source* OPTION-NAME-NUM-FIELD-SOURCE)
|
|
|
|
(export gnc:*option-section-accounts* gnc:*option-name-trading-accounts*
|
|
gnc:*option-name-currency-accounting* gnc:*option-name-book-currency*
|
|
gnc:*option-name-default-gains-policy*
|
|
gnc:*option-name-default-gain-loss-account*
|
|
gnc:*tax-label* gnc:*tax-nr-label*
|
|
gnc:*option-name-auto-readonly-days* gnc:*option-name-num-field-source*)
|
|
|
|
(define gnc:*option-section-budgeting* OPTION-SECTION-BUDGETING)
|
|
(define gnc:*option-name-default-budget* OPTION-NAME-DEFAULT-BUDGET)
|
|
|
|
(export gnc:*option-section-budgeting* gnc:*option-name-default-budget*)
|
|
|
|
(load-from-path "gnucash/app-utils/business-options")
|
|
(load-from-path "gnucash/app-utils/business-prefs")
|
|
|
|
|
|
;; Symbols deprecated in 4.x, to remove for 5.x
|
|
(define-public (gnc:get-debit-string acct-type)
|
|
(issue-deprecation-warning "gnc:get-debit-string is deprecated. Please use (gnucash engine)'s gnc-account-get-debit-string instead.")
|
|
(gnc-account-get-debit-string acct-type))
|
|
(define-public (gnc:get-credit-string acct-type)
|
|
(issue-deprecation-warning "gnc:get-credit-string is deprecated. Please use (gnucash engine)'s gnc-account-get-credit-string instead.")
|
|
(gnc-account-get-debit-string acct-type))
|
|
(define-public (gnc:config-file-format-version version)
|
|
(issue-deprecation-warning "gnc:config-file-format-version is deprecated and will be removed from a future version.")
|
|
#t)
|