blob: 8568854c75e6e2840850d8b805f0656a3400895b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
;;; ledger-exec.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:
;; Code for executing ledger synchronously.
;;; Code:
(declare-function ledger-master-file "ledger-report" ())
(defconst ledger-version-needed "3.0.0"
"The version of ledger executable needed for interactive features.")
(defvar ledger-works nil
"Flag showing whether the ledger binary can support `ledger-mode' interactive features.")
(defgroup ledger-exec nil
"Interface to the Ledger command-line accounting program."
:group 'ledger)
(defcustom ledger-mode-should-check-version t
"Should Ledger-mode verify that the executable is working?"
:type 'boolean
:group 'ledger-exec)
(defcustom ledger-binary-path "ledger"
"Path to the ledger executable."
:type 'file
:risky t
:group 'ledger-exec)
(defun ledger-exec-handle-error (ledger-errfile)
"Deal with ledger errors contained in LEDGER-ERRFILE."
(with-current-buffer (get-buffer-create "*Ledger Error*")
(let ((buffer-read-only nil))
(delete-region (point-min) (point-max))
(insert-file-contents ledger-errfile))
(view-mode)
(setq buffer-read-only t)
(current-buffer)))
(defun ledger-exec-success-p (exit-code ledger-output-buffer)
"Return t if EXIT-CODE is non-zero and output in LEDGER-OUTPUT-BUFFER is successful."
(with-current-buffer ledger-output-buffer
(goto-char (point-min))
(if (or (not (zerop exit-code))
(and (> (buffer-size) 1) (looking-at (regexp-quote "While"))))
nil ;; failure, there is an error starting with "While"
ledger-output-buffer)))
(defun ledger-exec-ledger (input-buffer &optional output-buffer &rest args)
"Run Ledger using INPUT-BUFFER.
Optionally capture output in OUTPUT-BUFFER, and pass ARGS on the
command line. Returns OUTPUT-BUFFER if ledger succeeded,
otherwise the error output is displayed and an error is raised."
(unless (and ledger-binary-path
(or (and (file-exists-p ledger-binary-path)
(file-executable-p ledger-binary-path))
(executable-find ledger-binary-path)))
(error "`ledger-binary-path' (value: %s) is not executable" ledger-binary-path))
(let ((buf (or input-buffer (find-file-noselect (ledger-master-file))))
(outbuf (or output-buffer
(generate-new-buffer " *ledger-tmp*")))
(errfile (make-temp-file "ledger-errors")))
(unwind-protect
(with-current-buffer buf
(let ((exit-code
(let ((coding-system-for-write 'utf-8)
(coding-system-for-read 'utf-8))
(apply #'call-process-region
(append (list (point-min) (point-max)
ledger-binary-path nil (list outbuf errfile) nil "-f" "-")
args)))))
(if (ledger-exec-success-p exit-code outbuf)
outbuf
(display-buffer (ledger-exec-handle-error errfile))
(error "Ledger execution failed"))))
(delete-file errfile))))
(defun ledger-version-greater-p (needed)
"Verify the ledger binary is usable for `ledger-mode' (version greater than NEEDED)."
(let ((version-strings '()))
(with-temp-buffer
(when (ledger-exec-ledger (current-buffer) (current-buffer) "--version")
(goto-char (point-min))
(delete-horizontal-space)
(setq version-strings (split-string
(buffer-substring-no-properties (point)
(point-max))))
(if (and (string-match (regexp-quote "Ledger") (car version-strings))
(or (string= needed (cadr version-strings))
(string< needed (cadr version-strings))))
t ;; success
nil))))) ;;failure
(defun ledger-check-version ()
"Verify that ledger works and is modern enough."
(interactive)
(if ledger-mode-should-check-version
(if (setq ledger-works (ledger-version-greater-p ledger-version-needed))
(message "Good Ledger Version")
(message "Bad Ledger Version"))))
(provide 'ledger-exec)
;;; ledger-exec.el ends here
|
