175 lines
6.8 KiB
EmacsLisp
175 lines
6.8 KiB
EmacsLisp
;;; ledger-commodities.el --- Helper code for use with the "ledger" command-line tool -*- lexical-binding: t; -*-
|
|
|
|
;; Copyright (C) 2003-2016 John Wiegley (johnw AT gnu DOT org)
|
|
|
|
;; This file is not part of GNU Emacs.
|
|
|
|
;; This 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, or (at your option) any later
|
|
;; version.
|
|
;;
|
|
;; This 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 GNU Emacs; see the file COPYING. If not, write to the
|
|
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
|
|
;; MA 02110-1301 USA.
|
|
|
|
;;; Commentary:
|
|
;; Helper functions to deal with commoditized numbers. A commoditized
|
|
;; number will be a list of value and string where the string contains
|
|
;; the commodity
|
|
|
|
;;; Code:
|
|
|
|
(require 'ledger-regex)
|
|
|
|
;; These keep the byte-compiler from warning about them, but have no other
|
|
;; effect:
|
|
(defvar ledger-environment-alist)
|
|
(declare-function ledger-exec-ledger "ledger-exec" (input-buffer &optional output-buffer &rest args))
|
|
|
|
(defcustom ledger-reconcile-default-commodity "$"
|
|
"The default commodity for use in target calculations in ledger reconcile."
|
|
:type 'string
|
|
:group 'ledger-reconcile)
|
|
|
|
(defun ledger-read-commodity-with-prompt (prompt)
|
|
"Read commodity name after PROMPT.
|
|
|
|
Default value is `ledger-reconcile-default-commodity'."
|
|
(let* ((buffer (current-buffer))
|
|
(commodities (with-temp-buffer
|
|
(ledger-exec-ledger buffer (current-buffer) "commodities")
|
|
(split-string (buffer-string) "\n" t))))
|
|
(completing-read prompt commodities nil t nil nil ledger-reconcile-default-commodity)))
|
|
|
|
(defun ledger-split-commodity-string (str)
|
|
"Split a commoditized string, STR, into two parts.
|
|
Returns a list with (value commodity)."
|
|
(let ((number-regex (if (assoc "decimal-comma" ledger-environment-alist)
|
|
ledger-amount-decimal-comma-regex
|
|
ledger-amount-decimal-period-regex)))
|
|
(if (> (length str) 0)
|
|
(with-temp-buffer
|
|
(insert str)
|
|
(goto-char (point-min))
|
|
(cond
|
|
((re-search-forward "\"\\(.*\\)\"" nil t) ; look for quoted commodities
|
|
(let ((com (delete-and-extract-region
|
|
(match-beginning 1)
|
|
(match-end 1))))
|
|
(if (re-search-forward
|
|
number-regex nil t)
|
|
(list
|
|
(ledger-string-to-number
|
|
(delete-and-extract-region (match-beginning 0) (match-end 0)))
|
|
com))))
|
|
((re-search-forward number-regex nil t)
|
|
;; found a number in the current locale, return it in the
|
|
;; car. Anything left over is annotation, the first
|
|
;; thing should be the commodity, separated by
|
|
;; whitespace, return it in the cdr. I can't think of
|
|
;; any counterexamples
|
|
(list
|
|
(ledger-string-to-number
|
|
(delete-and-extract-region (match-beginning 0) (match-end 0)))
|
|
(nth 0 (split-string (buffer-substring-no-properties (point-min) (point-max))))))
|
|
((re-search-forward "0" nil t)
|
|
;; couldn't find a decimal number, look for a single 0,
|
|
;; indicating account with zero balance
|
|
(list 0 ledger-reconcile-default-commodity))
|
|
;; nothing found, return 0
|
|
(t (list 0 ledger-reconcile-default-commodity)))))))
|
|
|
|
(defun ledger-string-balance-to-commoditized-amount (str)
|
|
"Return a commoditized amount (val, \"comm\") from STR."
|
|
; break any balances with multi commodities into a list
|
|
(mapcar #'(lambda (st)
|
|
(ledger-split-commodity-string st))
|
|
(split-string str "[\n\r]")))
|
|
|
|
(defun ledger-subtract-commodity (c1 c2)
|
|
"Subtract C2 from C1, ensuring their commodities match.
|
|
|
|
As an exception, if the quantity of C2 is zero, C1 is returned
|
|
directly."
|
|
(cond
|
|
((zerop (car c2)) c1)
|
|
((string= (cadr c1) (cadr c2))
|
|
(list (- (car c1) (car c2)) (cadr c1)))
|
|
(t (error "Can't subtract different commodities: %S - %S" c1 c2))))
|
|
|
|
(defun ledger-add-commodity (c1 c2)
|
|
"Add C1 and C2, ensuring their commodities match.
|
|
|
|
As an exception, if the quantity of C2 is zero, C1 is returned
|
|
directly."
|
|
(cond
|
|
((zerop (car c2)) c1)
|
|
((string= (cadr c1) (cadr c2))
|
|
(list (+ (car c1) (car c2)) (cadr c1)))
|
|
(t (error "Can't add different commodities: %S + %S" c1 c2))))
|
|
|
|
(defun ledger-negate-commodity (c)
|
|
"Return the negative of the commoditized amount C."
|
|
(list (- (car c)) (cadr c)))
|
|
|
|
(defun ledger-strip (str char)
|
|
"Return STR with CHAR removed."
|
|
(replace-regexp-in-string char "" str))
|
|
|
|
(defun ledger-string-to-number (str &optional decimal-comma)
|
|
"Parse STR as a number and return that number.
|
|
|
|
Improves builtin `string-to-number' by handling
|
|
internationalization, and return nil if number can't be parsed.
|
|
See `ledger-environment-alist' for DECIMAL-COMMA."
|
|
(let ((nstr (if (or decimal-comma
|
|
(assoc "decimal-comma" ledger-environment-alist))
|
|
(ledger-strip str "[.]")
|
|
(ledger-strip str ","))))
|
|
(while (string-match "," nstr) ;if there is a comma now, it is a decimal point
|
|
(setq nstr (replace-match "." nil nil nstr)))
|
|
(string-to-number nstr)))
|
|
|
|
(defun ledger-number-to-string (n &optional decimal-comma)
|
|
"See `number-to-string' for N.
|
|
DECIMAL-COMMA is as documented in `ledger-environment-alist'."
|
|
(let ((str (number-to-string n)))
|
|
(when (or decimal-comma
|
|
(assoc "decimal-comma" ledger-environment-alist))
|
|
(while (string-match "\\." str)
|
|
(setq str (replace-match "," nil nil str))))
|
|
str))
|
|
|
|
(defun ledger-commodity-to-string (c1)
|
|
"Return string representing C1.
|
|
Single character commodities are placed ahead of the value,
|
|
longer ones are after the value."
|
|
(let ((str (ledger-number-to-string (car c1)))
|
|
(commodity (cadr c1)))
|
|
(if (> (length commodity) 1)
|
|
(concat str " " commodity)
|
|
(concat commodity " " str))))
|
|
|
|
(defun ledger-read-commodity-string (prompt)
|
|
"Read an amount from mini-buffer using PROMPT."
|
|
(let ((str (read-from-minibuffer
|
|
(concat prompt " (" ledger-reconcile-default-commodity "): ")))
|
|
comm)
|
|
(when (and (> (length str) 0)
|
|
(ledger-split-commodity-string str))
|
|
(setq comm (ledger-split-commodity-string str))
|
|
(if (cadr comm)
|
|
comm
|
|
(list (car comm) ledger-reconcile-default-commodity)))))
|
|
|
|
(provide 'ledger-commodities)
|
|
|
|
;;; ledger-commodities.el ends here
|