The cl-ledger Reference Manual

This is the cl-ledger Reference Manual, version 4.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed Jun 15 03:49:03 2022 GMT+0.

1 Introduction
2 Systems
- 2.1 cl-ledger
3 Modules
4 Files
- 4.1 Lisp
5 Packages
- 5.1 cl-ledger
- 5.2 ledger-textual
6 Definitions
- 6.1 Public Interface
- 6.2 Internals
Appendix A Indexes

1 Introduction

#+TITLE: CL-Ledger

*CL-Ledger* is a Common Lisp port of the [[http://ledger-cli.org/][Ledger]] double-entry
accounting system.

* Installation

The easiest way to install *CL-Ledger* is using [[https://www.quicklisp.org][Quicklisp]]:

#+BEGIN_SRC lisp
(quicklisp:quickload "cl-ledger")
#+END_SRC

If you want to work with the latest source code and need to install it
manually, you will need the following libraries:

 - alexandria
 - cl-containers
 - cl-ppcre
 - local-time
 - series

They can be installed easily using *Quicklisp*:

#+BEGIN_SRC lisp
(quicklisp:quickload '("alexandria" "cl-containers" "cl-ppcre" "local-time" "series"))
#+END_SRC

Now you need to get the source code and pull all of the projects
relating to *CL-Ledger*:

#+BEGIN_SRC shell
git clone https://github.com/ledger/cl-ledger.git
cd cl-ledger
git submodule init
git submodule update
#+END_SRC

The next step is to indicate your Common Lisp system where to load
*CL-Ledger* from.

If you are using *Quicklisp*, you can add links to the
/local-projects/ directory:

#+BEGIN_SRC shell
cd /path/to/quicklisp/
cd local-projects
ln -s /path/to/cl-ledger .
ln -s /path/to/cl-ledger/cambl .
ln -s /path/to/cl-ledger/periods .
#+END_SRC

If you don't use *Quicklisp*, you can add the following contents to
the initialization file of your Common Lisp implementation
(e.g. ~/.sbclrc for *SBCL*):

#+BEGIN_SRC lisp
(push "/path/to/cl-ledger/" asdf:*central-registry*)

(dolist (project '("cambl/" "periods/"))
  (push (merge-pathnames project "/path/to/cl-ledger/")
        asdf:*central-registry*))
#+END_SRC

Make sure you change ~/path/to/cl-ledger/~ to be the directory where
*CL-Ledger* lives. Also, be sure this pathname ends with a slash! In
CL, directory names always end with /.

Now you can run *CL-Ledger* at the REPL like this:

#+BEGIN_SRC lisp
(asdf:load-system "cl-ledger")
#+END_SRC

This compiles and loads the *CL-Ledger* core, and also the textual
parser package, for parsing standard Ledger text files.

* Basic commands

Once in the REPL, try out this command:

#+BEGIN_SRC lisp
(ledger:register-report "/path/to/cl-ledger/doc/sample.dat")
#+END_SRC

You should see a register printed representing the contents of
/sample.dat/.
You can constrain this report using keyword modifiers:

#+BEGIN_SRC lisp
(ledger:register-report "/path/to/cl-ledger/doc/sample.dat"
                        :account "books")
#+END_SRC

*CL-Ledger* only reads the file on the first run, and if it changes,
so feel free to repeat the same command several times even for large
journal files.

The following reports are supported:

#+BEGIN_SRC lisp
(ledger:register-report "/path/to/file" [OPTIONS])
(ledger:balance-report "/path/to/file" [OPTIONS])
(ledger:print-report "/path/to/file" [OPTIONS])
(ledger:equity-report "/path/to/file" [OPTIONS])
(ledger:sexp-report "/path/to/file" [OPTIONS])
(ledger:csv-report "/path/to/file" [OPTIONS])
(ledger:derive-entry "/path/to/file" [OPTIONS])
#+END_SRC

As for /OPTIONS/, any of the following keyword pairs is allowed. There
are some extra options allowed for ~derive-entry~, for which please
see below.

|-----------------------------+----------------------------------------------|
| Keyword                     | Description                                  |
|-----------------------------+----------------------------------------------|
| :account "REGEXP"           |                                              |
|-----------------------------+----------------------------------------------|
| :not-account "REGEXP"       |                                              |
|-----------------------------+----------------------------------------------|
| :payee "REGEXP"             |                                              |
|-----------------------------+----------------------------------------------|
| :not-payee "REGEXP"         |                                              |
|-----------------------------+----------------------------------------------|
| :note "REGEXP"              |                                              |
|-----------------------------+----------------------------------------------|
| :not-note "REGEXP"          |                                              |
|-----------------------------+----------------------------------------------|
| :begin "YYYY/MM/DD"         |                                              |
|-----------------------------+----------------------------------------------|
| :end "YYYY/MM/DD"           |                                              |
|-----------------------------+----------------------------------------------|
| :range "RANGE EXPRESSION"   | a range expression, like "this month"        |
|-----------------------------+----------------------------------------------|
| :period "PERIOD EXPRESSION" | like "every month this year"                 |
|-----------------------------+----------------------------------------------|
| :expr "VALUE-EXPR"          | most Ledger 2.x value exprs allowed          |
|-----------------------------+----------------------------------------------|
| :limit "VALUE-EXPR"         | the same as 2.x's --limit or -l              |
|                             | this is a convenience alias for :expr        |
|-----------------------------+----------------------------------------------|
| :only "VALUE-EXPR"          | the same as 2.x's --only                     |
|-----------------------------+----------------------------------------------|
| :display "VALUE-EXPR"       | the same as 2.x's -d or --display            |
|-----------------------------+----------------------------------------------|
| :status KEYWORD             | only report transactions whose status        |
|                             | is :CLEARED, :PENDING or :UNCLEARED          |
|-----------------------------+----------------------------------------------|
| :sort "VALUE-EXPR"          | sort based on VALUE-EXPR calculation         |
|-----------------------------+----------------------------------------------|
| :no-total BOOL              | don't show totals                            |
|-----------------------------+----------------------------------------------|
| :collapse BOOL              | collapse multiline entries                   |
|-----------------------------+----------------------------------------------|
| :subtotal BOOL              | group all transactions by account            |
|-----------------------------+----------------------------------------------|
| :invert BOOL                | negate all transaction values                |
|                             | (same as saying :amount "-a")                |
|-----------------------------+----------------------------------------------|
| :related BOOL               | show "other" transactions of each entry      |
|-----------------------------+----------------------------------------------|
| :lots BOOL                  | show all commodity lot information           |
|-----------------------------+----------------------------------------------|
| :lot-prices BOOL            | show commodity lot prices                    |
|-----------------------------+----------------------------------------------|
| :lot-dates BOOL             | show commodity lot dates                     |
|-----------------------------+----------------------------------------------|
| :lot-tags BOOL              | show commodity lot tags                      |
|-----------------------------+----------------------------------------------|
| :amount "VALUE-EXPR"        | use EXPR to display transaction amounts      |
|-----------------------------+----------------------------------------------|
| :total "VALUE-EXPR"         | use EXPR to display the running total        |
|-----------------------------+----------------------------------------------|
| :set-amount "VALUE-EXPR"    | instead of :amount, actually represent       |
|                             | the amount using EXPR (this is rarely        |
|                             | something you want to do)                    |
|-----------------------------+----------------------------------------------|
| :set-total "VALUE-EXPR"     | same for the running total                   |
|-----------------------------+----------------------------------------------|
| :bridge-totals BOOL         | if the running totals are not contiguous     |
|                             | create revaluation entries to fill gaps      |
|-----------------------------+----------------------------------------------|
| :show OUTPUT-MODE           | show amounts and totals using the given mode |
|-----------------------------+----------------------------------------------|
| :show :market               | .. in terms of their market value            |
|-----------------------------+----------------------------------------------|
| :show :basis                | .. in terms of their basis cost              |
|-----------------------------+----------------------------------------------|


Here's a quick table for translating *Ledger* 2.6.1 options into their
corresponding *CL-Ledger* keywords:

|-------------------+--------------------+-------------------|
| Short option      | Long option        | CL-Ledger keyword |
|-------------------+--------------------+-------------------|
| -b ARG            | --begin ARG        | :begin ARG        |
|-------------------+--------------------+-------------------|
| -e ARG            | --end ARG          | :end ARG          |
|-------------------+--------------------+-------------------|
| -p ARG            | --period ARG       | :period ARG       |
|-------------------+--------------------+-------------------|
| -l ARG            | --limit ARG        | :limit ARG        |
|-------------------+--------------------+-------------------|
|                   | --only ARG         | :only ARG         |
|-------------------+--------------------+-------------------|
| -d ARG            | --display ARG      | :display ARG      |
|-------------------+--------------------+-------------------|
| -n (for balances) |                    | :no-total t       |
|-------------------+--------------------+-------------------|
| -n                | --collapse         | :collapse t       |
|-------------------+--------------------+-------------------|
| -r                | --related          | :related t        |
|-------------------+--------------------+-------------------|
| -s                | --subtotal         | :subtotal t       |
|-------------------+--------------------+-------------------|
| -S EXPR           | --sort ARG         | :sort ARG         |
|-------------------+--------------------+-------------------|
| -t EXPR           | --sort-entries ARG | :sort-entries ARG |
|-------------------+--------------------+-------------------|


Here are a few examples, using /sample.dat/ as a reference:

#+BEGIN_SRC lisp
(ledger:balance-report "doc/sample.dat")
  =>
         $1,980.00
           50 AAPL  Assets
         $1,980.00    Bank:Checking
           50 AAPL    Brokerage
        $-2,500.00  Equity:Opening Balances
            $40.00  Expenses:Books
        $-1,000.00  Income:Salary
           $-20.00  Liabilities:MasterCard
  -----------------------------------------------------
        $-1,500.00
           50 AAPL

(ledger:balance-report "doc/sample.dat" :account "Assets")
  =>
         $1,980.00
           50 AAPL  Assets
         $1,980.00    Bank:Checking
           50 AAPL    Brokerage
  -----------------------------------------------------
         $1,980.00
           50 AAPL

(ledger:register-report "doc/sample.dat" :begin "2004/05/10" :end "2004/05/28")
  =>
  2004/05/14 Pay day              Assets:Bank:Checking      $1,000.00    $1,000.00
                                  Income:Salary            $-1,000.00        $0.00
  2004/05/27 Book Store           Expenses:Books               $20.00       $20.00
                                  Liabilities:MasterCard      $-20.00        $0.00
  2004/05/27 Credit card company  Liabilities:MasterCard       $20.00       $20.00
                                  Assets:Bank:Checking        $-20.00        $0.00

(ledger:register-report "doc/sample.dat" :limit "commodity=(1 AAPL)" :total "V")
  =>
  2004/05/01 Investment balance   Assets:Brokerage            50 AAPL    $1,500.00
#+END_SRC

* Options to /derive-entry/

The reporting command ~derive-entry~ takes some special options.

The /derive-entry/ report uses *CL-Ledger* to intelligently create a new
entry for you. The possible keywords arguments are:

 - ~:date~
 - ~:payee~
 - ~:account~
 - ~:balance-account~
 - ~:amount~
 - ~:append~

Except for ~:payee~, all of these keyword arguments are optional. Here
is what they mean:

|---------------------------+--------------------------------------------------|
| Keyword                   | Description                                      |
|---------------------------+--------------------------------------------------|
| :payee "REGEXP"           | Find the most recent entry whose payee matches   |
|                           | REGEXP, and base the new entry derivation on     |
|                           | its details. If no matching entry can be found,  |
|                           | the payee of the newly created entry will        |
|                           | exactly match REGEXP.                            |
|---------------------------+--------------------------------------------------|
| :date "DATE-STRING"       | The date of the new entry will be DATE-STRING,   |
|                           | otherwise it is today.                           |
|---------------------------+--------------------------------------------------|
| :account "REGEXP"         | Set the first account line in the new entry to   |
|                           | be the most recently used account which matches  |
|                           | REGEXP. If no such account can be found, an      |
|                           | account named REGEXP is used. If no account is   |
|                           | specified, the account "Expenses:Unknown" is     |
|                           | used.                                            |
|---------------------------+--------------------------------------------------|
| :balance-account "REGEXP" | Like :ACCOUNT, except this refers to the         |
|                           | account used for the second transaction in the   |
|                           | newly derived entry. If not specified, a         |
|                           | calculated "balance account" is looked for in    |
|                           | the matching entry; if this does not apply, the  |
|                           | journal's default account is used; if this does  |
|                           | not apply, the account "Assets:Unknown" is used. |
|---------------------------+--------------------------------------------------|
| :amount "VALUE-STRING"    | The amount of the first transaction. If it has   |
|                           | no commodity, the correlated commodity from the  |
|                           | discovered entry is used.                        |
|---------------------------+--------------------------------------------------|
| :append BOOL              | If non-NIL, the new entry is written to the same |
|                           | journal where the matching entry was found (for  |
|                           | a binder that references many journals, this is  |
|                           | whichever file the discovered entry was in).     |
|---------------------------+--------------------------------------------------|

Here are a few examples, using /sample.dat/ as a reference:

#+BEGIN_SRC lisp
(ledger:derive-entry "doc/sample.dat" :payee "book")
  =>
  2007/12/04 Book Store
      Expenses:Books                            $20.00
      Liabilities:MasterCard

(ledger:derive-entry :payee "book" :amount "$125")
  =>
  2007/12/04 Book Store
      Expenses:Books                           $125.00
      Liabilities:MasterCard

(ledger:derive-entry :payee "Hello World")
  =>
  2007/12/04 Hello World
      Expenses:Unknown
      Assets:Unknown

(ledger:derive-entry :date "2004/01/01" :payee "Hello World")
  =>
  2004/01/01 Hello World
      Expenses:Unknown
      Assets:Unknown

(ledger:derive-entry :payee "book" :account "equ")
  =>
  2007/12/04 Book Store
      Equity:Opening Balances                   $20.00
      Liabilities:MasterCard

(ledger:derive-entry :payee "book" :account "Who Knows")
  =>
  2007/12/04 Book Store
      Who Knows                                 $20.00
      Liabilities:MasterCard

(ledger:derive-entry :payee "book" :balance-account "bank")
  =>
  2007/12/04 Book Store
      Expenses:Books                            $20.00
      Assets:Bank:Checking

(ledger:derive-entry :payee "book" :account "liab"
                     :balance-account "bank")
  =>
  2007/12/04 Book Store
      Liabilities:MasterCard                   $-20.00
      Assets:Bank:Checking

(ledger:derive-entry :payee "book" :account "bank" :amount "50")
  =>
  2007/12/04 Book Store
      Assets:Bank:Checking                      $50.00
      Liabilities:MasterCard

(ledger:derive-entry :payee "book" :account "bank" :amount "$125")
  =>
  2007/12/04 Book Store
      Assets:Bank:Checking                     $125.00
      Liabilities:MasterCard
#+END_SRC

* Date format

The date format used in your journal file can be specified either
using the ~*input-time-format*~ variable (by default: "%Y/%m/%d%| %H:%M:%S"),
or by writing a ~F~ command directive at the beginning of the journal:

#+BEGIN_SRC
F %Y-%m-%d

2017-09-01 * Some payee
  Some account  45,18 EUR
  Some other account
#+END_SRC

The date format used in reports can be specified using the
~*output-time-format*~ variable (by default: "%Y/%m/%d").

* Binder caching

After the call to ~binder~, the variable ~*last-binder*~ contains
the contents of what was read. From that point forward, if no binder
or string is passed to the reporting function, they will assume you
wish to report on the contents of ~*last-binder*~.

* Implementations status

Here is how *CL-Ledger* stands up against current Lisp
implementations:

|----------------+---------------+--------------------------------|
| Implementation |       Version | Status                         |
|----------------+---------------+--------------------------------|
| SBCL           |        1.3.21 | WORKS                          |
| LispWorks      | 5.02 Personal | WORKS                          |
| Allegro CL     |  10.0 Express | WORKS                          |
| Clozure CL     |          1.11 | WORKS                          |
| OpenMCL        |    2007-07-22 | Fails to compile LOCAL-TIME    |
| ECL            |    2007-12-07 | WORKS                          |
| ABCL           |         1.5.0 | Fails to compile CL-LEDGER     |
| CLISP          |          2.49 | Fails to compile CL-CONTAINERS |
| CMUCL          | 19d (2007-11) | Fails to compile PERIODS       |
| GCL            |         2.6.7 |        |
|----------------+---------------+--------------------------------|

* Series

For fans of the *Series* library, you can apply ~scan-transactions~ or
~scan-entries~ to a binder/account/journal/entry in order to produce
a /series/ of the corresponding type. Example:

#+BEGIN_SRC lisp
(collect (ledger:scan-transactions
          (ledger:read-journal "doc/sample.dat")))
  => [a list of all transactions, in sequence, within sample.dat]
#+END_SRC

* Command line

You can build a standalone /cl-ledger/ binary using the /Makefile/:

#+BEGIN_SRC shell
make LISP=sbcl
cl-ledger -f doc/sample.dat balance
#+END_SRC


You can also use the [[https://github.com/roswell/roswell][Roswell]] script /cl-ledger.ros/ in the /roswell/
directory to use *CL-Ledger* from the command line:

#+BEGIN_SRC shell
cl-ledger.ros -f doc/sample.dat balance
#+END_SRC

2 Systems

The main system appears first, followed by any subsystem dependency.

cl-ledger

2.1 `cl-ledger`

Double-entry accounting system.

Maintainer

Guillaume LE VAILLANT <glv@posteo.net>

Author

John Wiegley <jwiegley@gmail.com>

License

BSD-3

Version

4.0.0

Dependencies

local-time (system).
periods-series (system).
cambl (system).
cl-ppcre (system).

Source

cl-ledger.asd.

Child Components

core (module).
transforms (module).
reports (module).
parsers (module).
driver.lisp (file).

3 Modules

Modules are listed depth-first from the system components tree.

cl-ledger/core
cl-ledger/transforms
cl-ledger/reports
cl-ledger/parsers
cl-ledger/parsers/textual

3.1 `cl-ledger/core`

Source

cl-ledger.asd.

Parent Component

cl-ledger (system).

Child Components

packages.lisp (file).
types.lisp (file).
general.lisp (file).
ledger.lisp (file).
transaction.lisp (file).
normalize.lisp (file).
valexpr.lisp (file).
emacs.lisp (file).

3.2 `cl-ledger/transforms`

Dependency

core (module).

Source

cl-ledger.asd.

Parent Component

cl-ledger (system).

Child Components

totals.lisp (file).
filter.lisp (file).
periodic.lisp (file).
sort.lisp (file).
collapse.lisp (file).
invert.lisp (file).
subtotal.lisp (file).
related.lisp (file).
transform.lisp (file).

3.3 `cl-ledger/reports`

Dependency

transforms (module).

Source

cl-ledger.asd.

Parent Component

cl-ledger (system).

Child Components

report.lisp (file).
register.lisp (file).
sexp.lisp (file).
balance.lisp (file).
print.lisp (file).
entry.lisp (file).
csv.lisp (file).

3.4 `cl-ledger/parsers`

Dependency: reports (module).
Source: cl-ledger.asd.
Parent Component: cl-ledger (system).
Child Component: textual (module).

3.5 `cl-ledger/parsers/textual`

Source

cl-ledger.asd.

Parent Component

parsers (module).

Child Components

textual.lisp (file).
autoentry.lisp (file).
perentry.lisp (file).

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

4.1 Lisp

cl-ledger/cl-ledger.asd
cl-ledger/core/packages.lisp
cl-ledger/core/types.lisp
cl-ledger/core/general.lisp
cl-ledger/core/ledger.lisp
cl-ledger/core/transaction.lisp
cl-ledger/core/normalize.lisp
cl-ledger/core/valexpr.lisp
cl-ledger/core/emacs.lisp
cl-ledger/transforms/totals.lisp
cl-ledger/transforms/filter.lisp
cl-ledger/transforms/periodic.lisp
cl-ledger/transforms/sort.lisp
cl-ledger/transforms/collapse.lisp
cl-ledger/transforms/invert.lisp
cl-ledger/transforms/subtotal.lisp
cl-ledger/transforms/related.lisp
cl-ledger/transforms/transform.lisp
cl-ledger/reports/report.lisp
cl-ledger/reports/register.lisp
cl-ledger/reports/sexp.lisp
cl-ledger/reports/balance.lisp
cl-ledger/reports/print.lisp
cl-ledger/reports/entry.lisp
cl-ledger/reports/csv.lisp
cl-ledger/parsers/textual/textual.lisp
cl-ledger/parsers/textual/autoentry.lisp
cl-ledger/parsers/textual/perentry.lisp
cl-ledger/driver.lisp

4.1.1 `cl-ledger/cl-ledger.asd`

Source: cl-ledger.asd.
Parent Component: cl-ledger (system).
ASDF Systems: cl-ledger.

4.1.2 `cl-ledger/core/packages.lisp`

Source: cl-ledger.asd.
Parent Component: core (module).
Packages: cl-ledger.

4.1.3 `cl-ledger/core/types.lisp`

Dependency

packages.lisp (file).

Source

cl-ledger.asd.

Parent Component

core (module).

Public Interface

account (class).
account-children (reader method).
(setf account-children) (writer method).
account-data (reader method).
(setf account-data) (writer method).
account-fullname (reader method).
(setf account-fullname) (writer method).
account-name (reader method).
(setf account-name) (writer method).
account-parent (reader method).
(setf account-parent) (writer method).
add-journal (generic function).
add-transaction (generic function).
binder (class).
binder-commodity-pool (reader method).
(setf binder-commodity-pool) (writer method).
binder-data (reader method).
(setf binder-data) (writer method).
binder-journals (reader method).
(setf binder-journals) (writer method).
binder-root-account (reader method).
(setf binder-root-account) (writer method).
copy-item-position (function).
entries-iterator (generic function).
entry (class).
entry-actual-date (reader method).
(setf entry-actual-date) (writer method).
entry-code (reader method).
(setf entry-code) (writer method).
entry-data (reader method).
(setf entry-data) (writer method).
entry-effective-date (reader method).
(setf entry-effective-date) (writer method).
entry-journal (reader method).
(setf entry-journal) (writer method).
entry-note (reader method).
(setf entry-note) (writer method).
entry-payee (reader method).
(setf entry-payee) (writer method).
entry-position (reader method).
(setf entry-position) (writer method).
entry-status (reader method).
(setf entry-status) (writer method).
entry-transactions (reader method).
(setf entry-transactions) (writer method).
find-account (generic function).
item-position (structure).
item-position-begin-line (reader).
(setf item-position-begin-line) (writer).
item-position-end-line (reader).
(setf item-position-end-line) (writer).
item-position-source (reader).
(setf item-position-source) (writer).
item-status (type).
journal (class).
journal-binder (reader method).
(setf journal-binder) (writer method).
journal-contents (reader method).
(setf journal-contents) (writer method).
journal-data (reader method).
(setf journal-data) (writer method).
journal-date-format (reader method).
(setf journal-date-format) (writer method).
journal-default-account (reader method).
(setf journal-default-account) (writer method).
journal-default-year (reader method).
(setf journal-default-year) (writer method).
journal-source (reader method).
(setf journal-source) (writer method).
make-item-position (function).
make-transaction (function).
make-value-expr (function).
print-object (method).
transaction (structure).
transactions-iterator (generic function).
value-expr-function (reader).
(setf value-expr-function) (writer).
value-expr-p (function).
value-expr-string (reader).
(setf value-expr-string) (writer).

Internals

binderp (function).
copy-transaction (function).
copy-value-expr (function).
entry-normalizedp (reader method).
(setf entry-normalizedp) (writer method).
get-xact-account (reader).
(setf get-xact-account) (writer).
get-xact-actual-date (reader).
(setf get-xact-actual-date) (writer).
get-xact-amount (reader).
(setf get-xact-amount) (writer).
get-xact-calculatedp (reader).
(setf get-xact-calculatedp) (writer).
get-xact-cost (reader).
(setf get-xact-cost) (writer).
get-xact-data (reader).
(setf get-xact-data) (writer).
get-xact-effective-date (reader).
(setf get-xact-effective-date) (writer).
get-xact-entry (reader).
(setf get-xact-entry) (writer).
get-xact-generatedp (reader).
(setf get-xact-generatedp) (writer).
get-xact-must-balance-p (reader).
(setf get-xact-must-balance-p) (writer).
get-xact-note (reader).
(setf get-xact-note) (writer).
get-xact-position (reader).
(setf get-xact-position) (writer).
get-xact-status (reader).
(setf get-xact-status) (writer).
get-xact-virtualp (reader).
(setf get-xact-virtualp) (writer).
item-position-p (function).
journal-last-content-cell (reader method).
(setf journal-last-content-cell) (writer method).
journal-read-date (reader method).
(setf journal-read-date) (writer method).
transaction-p (function).
value-expr (structure).

4.1.4 `cl-ledger/core/general.lisp`

Dependency

types.lisp (file).

Source

cl-ledger.asd.

Parent Component

core (module).

Internals

add-to-plist (macro).
chain-functions (function).
do-iterator (macro).
do-recurse (macro).
if-let (macro).
ignore-args (function).
ignore-rest (function).
list-iterator (function).
map-iterator (function).
negatef (macro).
split-string-at-char (function).
while (macro).

4.1.5 `cl-ledger/core/ledger.lisp`

Dependency

general.lisp (file).

Source

cl-ledger.asd.

Parent Component

core (module).

Public Interface

*allow-embedded-lisp* (special variable).
*last-binder* (special variable).
*registered-parsers* (special variable).
*use-effective-dates* (special variable).
add-journal (method).
add-journal (method).
add-journal (method).
add-journal (method).
add-to-contents (function).
add-transaction (method).
binder (function).
binder-statistics (function).
copy-entry (function).
do-entries (macro).
do-transactions (macro).
entries-iterator (method).
entries-iterator (method).
entries-iterator (method).
entries-list (function).
entry-date (function).
find-account (method).
find-account (method).
find-child-account (function).
map-entries (macro).
map-transactions (macro).
parse-journal-date (function).
read-journal (function).
scan-entries (function).
scan-transactions (function).
transactions-iterator (method).
transactions-iterator (method).
transactions-iterator (method).
transactions-iterator (method).
transactions-list (function).

Internals

account-set-value (function).
(setf account-value) (setf expander).
account-value (function).
add-journal-from-path (function).
binder-time-range (function).
compare-path-lists (function).
reset-accounts (function).
with-temporary-journal (macro).

4.1.6 `cl-ledger/core/transaction.lisp`

Dependency

ledger.lisp (file).

Source

cl-ledger.asd.

Parent Component

core (module).

Public Interface

group-transactions-by-entry (function).
(setf xact-account) (setf expander).
xact-account (function).
xact-actual-date (function).
(setf xact-amount) (setf expander).
xact-amount (function).
(setf xact-amount*) (setf expander).
xact-amount* (function).
xact-cleared-p (function).
(setf xact-cost) (setf expander).
xact-cost (function).
(setf xact-data) (setf expander).
xact-data (function).
xact-date (function).
(setf xact-effective-date) (setf expander).
xact-effective-date (function).
(setf xact-entry) (setf expander).
xact-entry (function).
(setf xact-must-balance-p) (setf expander).
xact-must-balance-p (function).
(setf xact-note) (setf expander).
xact-note (function).
xact-pending-p (function).
(setf xact-position) (setf expander).
xact-position (function).
(setf xact-status) (setf expander).
xact-status (function).
xact-uncleared-p (function).
(setf xact-value) (setf expander).
xact-value (function).
(setf xact-virtualp) (setf expander).
xact-virtualp (function).

Internals

print-transaction (function).
set-xact-account (function).
set-xact-actual-date (function).
set-xact-amount (function).
set-xact-amount* (function).
set-xact-calculatedp (function).
set-xact-cost (function).
set-xact-data (function).
set-xact-effective-date (function).
set-xact-entry (function).
set-xact-generatedp (function).
set-xact-must-balance-p (function).
set-xact-note (function).
set-xact-position (function).
set-xact-status (function).
set-xact-virtualp (function).
xact-amount-expr (function).
(setf xact-calculatedp) (setf expander).
xact-calculatedp (function).
xact-cost-total (function).
xact-display-amount (function).
xact-display-total (function).
(setf xact-generatedp) (setf expander).
xact-generatedp (function).
xact-total (function).

4.1.7 `cl-ledger/core/normalize.lisp`

Dependency

transaction.lisp (file).

Source

cl-ledger.asd.

Parent Component

core (module).

Public Interface

*post-normalization-functions* (special variable).
*pre-normalization-functions* (special variable).
normalize-entry (function).

4.1.8 `cl-ledger/core/valexpr.lisp`

Dependency

normalize.lisp (file).

Source

cl-ledger.asd.

Parent Component

core (module).

Public Interface

parse-value-expr (function).
read-value-expr (function).

Internals

*value-expr-commodity-pool* (special variable).
*value-expr-last-xact* (special variable).
*value-expr-observe-properties-p* (special variable).
*value-expr-readtable* (special variable).
*value-expr-reduce-to-smallest-units-p* (special variable).
*value-expr-series-offset* (special variable).
apply-this-or-last (function).
as-boolean (function).
ignore-character (function).
ignore-xact (function).
make-comparator (macro).
read-add-expr (function).
read-and-expr (function).
read-comma-expr (function).
read-logic-expr (function).
read-mul-expr (function).
read-or-expr (function).
read-unary-expr (function).
read-value-term (function).
value-expr-call (function).

4.1.9 `cl-ledger/core/emacs.lisp`

Dependency: valexpr.lisp (file).
Source: cl-ledger.asd.
Parent Component: core (module).
Public Interface: find-current-entity (function).

4.1.10 `cl-ledger/transforms/totals.lisp`

Source

cl-ledger.asd.

Parent Component

transforms (module).

Public Interface

calculate-totals (function).

Internals

bridge-running-totals (function).
calculate-account-totals (function).
displayed-amount-setter (function).
get-computed-amount (function).
get-computed-total (function).

4.1.11 `cl-ledger/transforms/filter.lisp`

Dependency

totals.lisp (file).

Source

cl-ledger.asd.

Parent Component

transforms (module).

Public Interface

*predicate-keywords* (special variable).
apply-filter (function).
choose-if-value-expr (function).
parse-predicate-keywords (function).

Internals

account-matcher (function).
eq-matcher (function).
fixed-time-matcher (function).
not-matcher (function).
note-matcher (function).
payee-matcher (function).
regex-matcher (function).
status-matcher (function).
time-range-matcher (function).
value-expr-matcher (function).

4.1.12 `cl-ledger/transforms/periodic.lisp`

Dependency

filter.lisp (file).

Source

cl-ledger.asd.

Parent Component

transforms (module).

Internals

group-by-period (function).
periodic-transform (function).

4.1.13 `cl-ledger/transforms/sort.lisp`

Dependency

periodic.lisp (file).

Source

cl-ledger.asd.

Parent Component

transforms (module).

Internals

sort-entries (function).
sort-transactions (function).

4.1.14 `cl-ledger/transforms/collapse.lisp`

Dependency: sort.lisp (file).
Source: cl-ledger.asd.
Parent Component: transforms (module).
Internals: collapse-entries (function).

4.1.15 `cl-ledger/transforms/invert.lisp`

Dependency: collapse.lisp (file).
Source: cl-ledger.asd.
Parent Component: transforms (module).
Internals: invert-transactions (function).

4.1.16 `cl-ledger/transforms/subtotal.lisp`

Dependency: invert.lisp (file).
Source: cl-ledger.asd.
Parent Component: transforms (module).
Internals: group-by-account (function).

4.1.17 `cl-ledger/transforms/related.lisp`

Dependency: subtotal.lisp (file).
Source: cl-ledger.asd.
Parent Component: transforms (module).
Internals: related-transactions (function).

4.1.18 `cl-ledger/transforms/transform.lisp`

Dependency: related.lisp (file).
Source: cl-ledger.asd.
Parent Component: transforms (module).
Internals: apply-key-transforms (function).

4.1.19 `cl-ledger/reports/report.lisp`

Source

cl-ledger.asd.

Parent Component

reports (module).

Internals

accounts-report (function).
basic-reporter (function).
find-all-transactions (function).
print-account (function).
transaction-printer (function).
transactions-report (function).

4.1.20 `cl-ledger/reports/register.lisp`

Dependency

report.lisp (file).

Source

cl-ledger.asd.

Parent Component

reports (module).

Public Interface

abbreviate-string (function).
register-report (function).

Internals

maybe-subseq (function).
register-reporter (function).

4.1.21 `cl-ledger/reports/sexp.lisp`

Dependency

register.lisp (file).

Source

cl-ledger.asd.

Parent Component

reports (module).

Public Interface

find-account-tree (function).
find-sibling-accounts (function).
find-unique-accounts (function).
find-unique-payees (function).
sexp-report (function).

Internals

transactions-to-sexp (function).
xacts-to-sexp (function).

4.1.22 `cl-ledger/reports/balance.lisp`

Dependency

sexp.lisp (file).

Source

cl-ledger.asd.

Parent Component

reports (module).

Public Interface

balance-report (function).

Internals

balance-print-reporter (function).
balance-reporter (function).
report-accounts (function).

4.1.23 `cl-ledger/reports/print.lisp`

Dependency

balance.lisp (file).

Source

cl-ledger.asd.

Parent Component

reports (module).

Public Interface

account-names-report (function).
equity-report (function).
payees-report (function).
print-entry (function).
print-report (function).

Internals

print-reporter (function).
print-transactions (function).

4.1.24 `cl-ledger/reports/entry.lisp`

Dependency: print.lisp (file).
Source: cl-ledger.asd.
Parent Component: reports (module).
Public Interface: derive-entry (function).
Internals: print-new-entry (function).

4.1.25 `cl-ledger/reports/csv.lisp`

Dependency: entry.lisp (file).
Source: cl-ledger.asd.
Parent Component: reports (module).
Public Interface: csv-report (function).
Internals: csv-reporter (function).

4.1.26 `cl-ledger/parsers/textual/textual.lisp`

Source

cl-ledger.asd.

Parent Component

textual (module).

Packages

ledger-textual.

Public Interface

*directive-handlers* (special variable).

Internals

*comment-line-scanner* (special variable).
*comment-regexp* (special variable).
*date-regexp* (special variable).
*entry-heading-scanner* (special variable).
*price-scanner* (special variable).
*spacing-regexp* (special variable).
*transaction-scanner* (special variable).
ledger-text-directive/account (function).
ledger-text-directive/alias (function).
ledger-text-directive/def (function).
ledger-text-directive/end (function).
ledger-text-directive/include (function).
read-plain-entry (function).
read-price (function).
read-textual-journal (function).
read-transaction (function).

4.1.27 `cl-ledger/parsers/textual/autoentry.lisp`

Dependency

textual.lisp (file).

Source

cl-ledger.asd.

Parent Component

textual (module).

Internals

apply-automated-entries (function).
auto-entry-predicate (reader method).
(setf auto-entry-predicate) (writer method).
auto-entry-predicate-expr (reader method).
(setf auto-entry-predicate-expr) (writer method).
automated-entry (class).
read-automated-entry (function).

4.1.28 `cl-ledger/parsers/textual/perentry.lisp`

Dependencies

textual.lisp (file).
autoentry.lisp (file).

Source

cl-ledger.asd.

Parent Component

textual (module).

Internals

entry-period (reader method).
(setf entry-period) (writer method).
periodic-entry (class).
read-periodic-entry (function).

4.1.29 `cl-ledger/driver.lisp`

Dependency

parsers (module).

Source

cl-ledger.asd.

Parent Component

cl-ledger (system).

Public Interface

process-command-line (function).

Internals

command-line-args (function).
driver-help (function).
main (function).
regexp-opt (function).

5 Packages

Packages are listed by definition order.

cl-ledger
ledger-textual

5.1 `cl-ledger`

Source

packages.lisp.

Nickname

ledger

Use List

cambl.
common-lisp.
local-time.
periods.
periods-series.
series.

Used By List

ledger-textual.

Public Interface

*allow-embedded-lisp* (special variable).
*last-binder* (special variable).
*post-normalization-functions* (special variable).
*pre-normalization-functions* (special variable).
*predicate-keywords* (special variable).
*registered-parsers* (special variable).
*use-effective-dates* (special variable).
abbreviate-string (function).
account (class).
account-children (generic reader).
(setf account-children) (generic writer).
account-data (generic reader).
(setf account-data) (generic writer).
account-fullname (generic reader).
(setf account-fullname) (generic writer).
account-name (generic reader).
(setf account-name) (generic writer).
account-names-report (function).
account-parent (generic reader).
(setf account-parent) (generic writer).
add-journal (generic function).
add-to-contents (function).
add-transaction (generic function).
apply-filter (function).
balance-report (function).
binder (function).
binder (class).
binder-commodity-pool (generic reader).
(setf binder-commodity-pool) (generic writer).
binder-data (generic reader).
(setf binder-data) (generic writer).
binder-journals (generic reader).
(setf binder-journals) (generic writer).
binder-root-account (generic reader).
(setf binder-root-account) (generic writer).
binder-statistics (function).
calculate-totals (function).
choose-if-value-expr (function).
copy-entry (function).
copy-item-position (function).
csv-report (function).
derive-entry (function).
do-entries (macro).
do-transactions (macro).
entries-iterator (generic function).
entries-list (function).
entry (class).
entry-actual-date (generic reader).
(setf entry-actual-date) (generic writer).
entry-code (generic reader).
(setf entry-code) (generic writer).
entry-data (generic reader).
(setf entry-data) (generic writer).
entry-date (function).
entry-effective-date (generic reader).
(setf entry-effective-date) (generic writer).
entry-journal (generic reader).
(setf entry-journal) (generic writer).
entry-note (generic reader).
(setf entry-note) (generic writer).
entry-payee (generic reader).
(setf entry-payee) (generic writer).
entry-position (generic reader).
(setf entry-position) (generic writer).
entry-status (generic reader).
(setf entry-status) (generic writer).
entry-transactions (generic reader).
(setf entry-transactions) (generic writer).
equity-report (function).
find-account (generic function).
find-account-tree (function).
find-child-account (function).
find-current-entity (function).
find-sibling-accounts (function).
find-unique-accounts (function).
find-unique-payees (function).
group-transactions-by-entry (function).
item-position (structure).
item-position-begin-line (reader).
(setf item-position-begin-line) (writer).
item-position-end-line (reader).
(setf item-position-end-line) (writer).
item-position-source (reader).
(setf item-position-source) (writer).
item-status (type).
journal (class).
journal-binder (generic reader).
(setf journal-binder) (generic writer).
journal-contents (generic reader).
(setf journal-contents) (generic writer).
journal-data (generic reader).
(setf journal-data) (generic writer).
journal-date-format (generic reader).
(setf journal-date-format) (generic writer).
journal-default-account (generic reader).
(setf journal-default-account) (generic writer).
journal-default-year (generic reader).
(setf journal-default-year) (generic writer).
journal-source (generic reader).
(setf journal-source) (generic writer).
make-item-position (function).
make-transaction (function).
make-value-expr (function).
map-entries (macro).
map-transactions (macro).
normalize-entry (function).
parse-journal-date (function).
parse-predicate-keywords (function).
parse-value-expr (function).
payees-report (function).
print-entry (function).
print-report (function).
process-command-line (function).
read-journal (function).
read-value-expr (function).
register-report (function).
scan-entries (function).
scan-transactions (function).
sexp-report (function).
transaction (structure).
transactions-iterator (generic function).
transactions-list (function).
value-expr-function (reader).
(setf value-expr-function) (writer).
value-expr-p (function).
value-expr-string (reader).
(setf value-expr-string) (writer).
(setf xact-account) (setf expander).
xact-account (function).
xact-actual-date (function).
(setf xact-amount) (setf expander).
xact-amount (function).
(setf xact-amount*) (setf expander).
xact-amount* (function).
xact-cleared-p (function).
(setf xact-cost) (setf expander).
xact-cost (function).
(setf xact-data) (setf expander).
xact-data (function).
xact-date (function).
(setf xact-effective-date) (setf expander).
xact-effective-date (function).
(setf xact-entry) (setf expander).
xact-entry (function).
(setf xact-must-balance-p) (setf expander).
xact-must-balance-p (function).
(setf xact-note) (setf expander).
xact-note (function).
xact-pending-p (function).
(setf xact-position) (setf expander).
xact-position (function).
(setf xact-status) (setf expander).
xact-status (function).
xact-uncleared-p (function).
(setf xact-value) (setf expander).
xact-value (function).
(setf xact-virtualp) (setf expander).
xact-virtualp (function).

Internals

*value-expr-commodity-pool* (special variable).
*value-expr-last-xact* (special variable).
*value-expr-observe-properties-p* (special variable).
*value-expr-readtable* (special variable).
*value-expr-reduce-to-smallest-units-p* (special variable).
*value-expr-series-offset* (special variable).
account-matcher (function).
account-set-value (function).
(setf account-value) (setf expander).
account-value (function).
accounts-report (function).
add-journal-from-path (function).
add-to-plist (macro).
apply-key-transforms (function).
apply-this-or-last (function).
as-boolean (function).
balance-print-reporter (function).
balance-reporter (function).
basic-reporter (function).
binder-time-range (function).
binderp (function).
bridge-running-totals (function).
calculate-account-totals (function).
chain-functions (function).
collapse-entries (function).
command-line-args (function).
compare-path-lists (function).
copy-transaction (function).
copy-value-expr (function).
csv-reporter (function).
displayed-amount-setter (function).
do-iterator (macro).
do-recurse (macro).
driver-help (function).
entry-normalizedp (generic reader).
(setf entry-normalizedp) (generic writer).
eq-matcher (function).
find-all-transactions (function).
fixed-time-matcher (function).
get-computed-amount (function).
get-computed-total (function).
get-xact-account (reader).
(setf get-xact-account) (writer).
get-xact-actual-date (reader).
(setf get-xact-actual-date) (writer).
get-xact-amount (reader).
(setf get-xact-amount) (writer).
get-xact-calculatedp (reader).
(setf get-xact-calculatedp) (writer).
get-xact-cost (reader).
(setf get-xact-cost) (writer).
get-xact-data (reader).
(setf get-xact-data) (writer).
get-xact-effective-date (reader).
(setf get-xact-effective-date) (writer).
get-xact-entry (reader).
(setf get-xact-entry) (writer).
get-xact-generatedp (reader).
(setf get-xact-generatedp) (writer).
get-xact-must-balance-p (reader).
(setf get-xact-must-balance-p) (writer).
get-xact-note (reader).
(setf get-xact-note) (writer).
get-xact-position (reader).
(setf get-xact-position) (writer).
get-xact-status (reader).
(setf get-xact-status) (writer).
get-xact-virtualp (reader).
(setf get-xact-virtualp) (writer).
group-by-account (function).
group-by-period (function).
if-let (macro).
ignore-args (function).
ignore-character (function).
ignore-rest (function).
ignore-xact (function).
invert-transactions (function).
item-position-p (function).
journal-last-content-cell (generic reader).
(setf journal-last-content-cell) (generic writer).
journal-read-date (generic reader).
(setf journal-read-date) (generic writer).
list-iterator (function).
main (function).
make-comparator (macro).
map-iterator (function).
maybe-subseq (function).
negatef (macro).
not-matcher (function).
note-matcher (function).
payee-matcher (function).
periodic-transform (function).
print-account (function).
print-new-entry (function).
print-reporter (function).
print-transaction (function).
print-transactions (function).
read-add-expr (function).
read-and-expr (function).
read-comma-expr (function).
read-logic-expr (function).
read-mul-expr (function).
read-or-expr (function).
read-unary-expr (function).
read-value-term (function).
regex-matcher (function).
regexp-opt (function).
register-reporter (function).
related-transactions (function).
report-accounts (function).
reset-accounts (function).
set-xact-account (function).
set-xact-actual-date (function).
set-xact-amount (function).
set-xact-amount* (function).
set-xact-calculatedp (function).
set-xact-cost (function).
set-xact-data (function).
set-xact-effective-date (function).
set-xact-entry (function).
set-xact-generatedp (function).
set-xact-must-balance-p (function).
set-xact-note (function).
set-xact-position (function).
set-xact-status (function).
set-xact-virtualp (function).
sort-entries (function).
sort-transactions (function).
split-string-at-char (function).
status-matcher (function).
time-range-matcher (function).
transaction-p (function).
transaction-printer (function).
transactions-report (function).
transactions-to-sexp (function).
value-expr (structure).
value-expr-call (function).
value-expr-matcher (function).
while (macro).
with-temporary-journal (macro).
xact-amount-expr (function).
(setf xact-calculatedp) (setf expander).
xact-calculatedp (function).
xact-cost-total (function).
xact-display-amount (function).
xact-display-total (function).
(setf xact-generatedp) (setf expander).
xact-generatedp (function).
xact-total (function).
xacts-to-sexp (function).

5.2 `ledger-textual`

Source

textual.lisp.

Use List

cambl.
cl-ledger.
cl-ppcre.
common-lisp.
local-time.
periods.

Public Interface

*directive-handlers* (special variable).

Internals

*comment-line-scanner* (special variable).
*comment-regexp* (special variable).
*date-regexp* (special variable).
*entry-heading-scanner* (special variable).
*price-scanner* (special variable).
*spacing-regexp* (special variable).
*transaction-scanner* (special variable).
apply-automated-entries (function).
auto-entry-predicate (generic reader).
(setf auto-entry-predicate) (generic writer).
auto-entry-predicate-expr (generic reader).
(setf auto-entry-predicate-expr) (generic writer).
automated-entry (class).
entry-period (generic reader).
(setf entry-period) (generic writer).
ledger-text-directive/account (function).
ledger-text-directive/alias (function).
ledger-text-directive/def (function).
ledger-text-directive/end (function).
ledger-text-directive/include (function).
periodic-entry (class).
read-automated-entry (function).
read-periodic-entry (function).
read-plain-entry (function).
read-price (function).
read-textual-journal (function).
read-transaction (function).

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

6.1.1 Special variables

Special Variable: *allow-embedded-lisp* ¶

Package: cl-ledger.
Source: ledger.lisp.

Special Variable: *directive-handlers* ¶

Package: ledger-textual.
Source: textual.lisp.

Special Variable: *last-binder* ¶

Package: cl-ledger.
Source: ledger.lisp.

Special Variable: *post-normalization-functions* ¶

Package: cl-ledger.
Source: normalize.lisp.

Special Variable: *pre-normalization-functions* ¶

Package: cl-ledger.
Source: normalize.lisp.

Special Variable: *predicate-keywords* ¶

*predicate-keywords* associates keywords that may be passed to ‘apply-filter’ or ‘parse-predicate-keywords’ with matcher functions that are called to produce the closures used to ascertain the match.

The format of each member of this list is (KEYWORD TYPE FUNCTION).

For example, in the case of allowing :ACCOUNT to specify an account to match against in a value expression predicate, the require type is either a string specifying a regular expression, or an actual account object to compare against. The function used to create the matcher is ‘account-matcher’, which takes the string/account argument passed in after the :ACCOUNT keyword, and returns a closure which can verify whether a transaction is indeed in that account.

This means that every matcher function takes a value argument to base the match on, and returns a closure *that takes a transaction* for which it will ascertain that match.

Package: cl-ledger.
Source: filter.lisp.

Special Variable: *registered-parsers* ¶

Package: cl-ledger.
Source: ledger.lisp.

Special Variable: *use-effective-dates* ¶

Package: cl-ledger.
Source: ledger.lisp.

6.1.2 Macros

Macro: do-entries ((var object &optional result) &body body) ¶

Package: cl-ledger.
Source: ledger.lisp.

Macro: do-transactions ((var object &optional result) &body body) ¶

Package: cl-ledger.
Source: ledger.lisp.

Macro: map-entries (callable object) ¶

Package: cl-ledger.
Source: ledger.lisp.

Macro: map-transactions (callable object &key entry-transform) ¶

Package: cl-ledger.
Source: ledger.lisp.

6.1.3 Setf expanders

Setf Expander: (setf xact-account) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-account (function).
Writer: set-xact-account (function).

Setf Expander: (setf xact-amount) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-amount (function).
Writer: set-xact-amount (function).

Setf Expander: (setf xact-amount*) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-amount* (function).
Writer: set-xact-amount* (function).

Setf Expander: (setf xact-cost) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-cost (function).
Writer: set-xact-cost (function).

Setf Expander: (setf xact-data) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-data (function).
Writer: set-xact-data (function).

Setf Expander: (setf xact-effective-date) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-effective-date (function).
Writer: set-xact-effective-date (function).

Setf Expander: (setf xact-entry) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-entry (function).
Writer: set-xact-entry (function).

Setf Expander: (setf xact-must-balance-p) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-must-balance-p (function).
Writer: set-xact-must-balance-p (function).

Setf Expander: (setf xact-note) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-note (function).
Writer: set-xact-note (function).

Setf Expander: (setf xact-position) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-position (function).
Writer: set-xact-position (function).

Setf Expander: (setf xact-status) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-status (function).
Writer: set-xact-status (function).

Setf Expander: (setf xact-virtualp) (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Reader: xact-virtualp (function).
Writer: set-xact-virtualp (function).

6.1.4 Ordinary functions

Function: abbreviate-string (name width &key elision-style account-p abbrev-length) ¶

Package: cl-ledger.
Source: register.lisp.

Function: account-names-report (&rest args) ¶

Package: cl-ledger.
Source: print.lisp.

Function: add-to-contents (journal item) ¶

Package: cl-ledger.
Source: ledger.lisp.

Function: apply-filter (xact-series &rest args) ¶

Package: cl-ledger.
Source: filter.lisp.

Function: balance-report (&rest args) ¶

Package: cl-ledger.
Source: balance.lisp.

Function: binder (&rest args) ¶

Package: cl-ledger.
Source: ledger.lisp.

Function: binder-statistics (&optional binder) ¶

Package: cl-ledger.
Source: ledger.lisp.

Function: calculate-totals (xact-series &key set-amount set-total displayed-amount-setter &allow-other-keys) ¶

Package: cl-ledger.
Source: totals.lisp.

Function: choose-if-value-expr (xact-series expr) ¶

Package: cl-ledger.
Source: filter.lisp.

Function: copy-entry (entry &rest args) ¶

Package: cl-ledger.
Source: ledger.lisp.

Function: copy-item-position (instance) ¶

Package: cl-ledger.
Source: types.lisp.

Function: csv-report (&rest args) ¶

Package: cl-ledger.
Source: csv.lisp.

Function: derive-entry (&rest args) ¶

The DERIVE-ENTRY report uses Ledger to intelligently create a new entry for you. The possible keywords arguments are:

:DATE <DATE-STRING>
:PAYEE <REGEXP>
:ACCOUNT <REGEXP>
:BALANCE-ACCOUNT <REGEXP>
:AMOUNT <VALUE-STRING>
:APPEND <BOOLEAN>

Except for :PAYEE, all of these keyword arguments are optional. Here is what they mean:

:PAYEE REGEXP
Find the most recent entry whose payee matches REGEXP, and base the new entry derivation on its details. If no matching entry can be found, the payee of the newly created entry will exactly match REGEXP.

:DATE DATE-STRING
The date of the new entry will be DATE-STRING, otherwise it is today.

:ACCOUNT REGEXP
Set the first account line in the new entry to be the most recently used account which matches REGEXP. If no such account can be found, an account named REGEXP is used. If no account is specified, the account "Expenses:Unknown" is used.

:BALANCE-ACCOUNT REGEXP
Like :ACCOUNT, except this refers to the account used for the second transaction in the newly derived entry. If not specified, a calculated "balance account" is looked for in the matching entry; if this does not apply, the journal’s default account is used; if this does not apply, the account "Assets:Unknown" is used.

:AMOUNT VALUE-STRING
The amount of the first transaction. If it has no commodity, the correlated commodity from the discovered entry is used.

:APPEND BOOLEAN
If non-NIL, the new entry is written to the same journal where the matching entry was found (for a binder that references many journals, this is whichever file the discovered entry was in).

Here are a few examples, using sample.dat as a reference:

(ledger:derive-entry "doc/sample.dat" :payee "book")
=>
2007/12/04 Book Store
Expenses:Books $20.00 Liabilities:MasterCard

(ledger:derive-entry :payee "book" :amount "$125")
=>
2007/12/04 Book Store
Expenses:Books $125.00 Liabilities:MasterCard

(ledger:derive-entry :payee "Hello World")
=>
2007/12/04 Hello World
Expenses:Unknown
Assets:Unknown

(ledger:derive-entry :date "2004/01/01" :payee "Hello World")
=>
2004/01/01 Hello World
Expenses:Unknown
Assets:Unknown

(ledger:derive-entry :payee "book" :account "equ")
=>
2007/12/04 Book Store
Equity:Opening Balances $20.00 Liabilities:MasterCard

(ledger:derive-entry :payee "book" :account "Who Knows")
=>
2007/12/04 Book Store
Who Knows $20.00 Liabilities:MasterCard

(ledger:derive-entry :payee "book" :balance-account "bank")
=>
2007/12/04 Book Store
Expenses:Books $20.00 Assets:Bank:Checking

(ledger:derive-entry :payee "book" :account "liab"
:balance-account "bank")
=>
2007/12/04 Book Store
Liabilities:MasterCard $-20.00 Assets:Bank:Checking

(ledger:derive-entry :payee "book" :account "bank" :amount 50)
=>
2007/12/04 Book Store
Assets:Bank:Checking $50.00 Liabilities:MasterCard

(ledger:derive-entry :payee "book" :account "bank" :amount "$125") =>
2007/12/04 Book Store
Assets:Bank:Checking $125.00 Liabilities:MasterCard

Package: cl-ledger.
Source: entry.lisp.

Function: entries-list (object) ¶

Package: cl-ledger.
Source: ledger.lisp.

Function: entry-date (entry) ¶

Package: cl-ledger.
Source: ledger.lisp.

Function: equity-report (&rest args) ¶

Package: cl-ledger.
Source: print.lisp.

Function: find-account-tree (&rest args) ¶

Package: cl-ledger.
Source: sexp.lisp.

Function: find-child-account (account account-name &key create-if-not-exists-p fullname) ¶

Package: cl-ledger.
Source: ledger.lisp.

Function: find-current-entity (journal-path goal-line) ¶

Package: cl-ledger.
Source: emacs.lisp.

Function: find-sibling-accounts (&rest args) ¶

Package: cl-ledger.
Source: sexp.lisp.

Function: find-unique-accounts (&rest args) ¶

Package: cl-ledger.
Source: sexp.lisp.

Function: find-unique-payees (&rest args) ¶

Package: cl-ledger.
Source: sexp.lisp.

Function: group-transactions-by-entry (xacts-list) ¶

"Clump" the incoming stream of transactions into sublists, where adjacent transactions with the same parent entry become part of the same sublist.

Consider the following input stream, with the first letter identifying the entry and the second identifying the member transaction:

(A-X A-Y A-Z B-X B-Y C-X)

Given this input, the resulting list from ‘group-transactions-by-entry’ will be:

((A-X A-Y A-Z) (B-X B-Y) (C-X))

Package: cl-ledger.
Source: transaction.lisp.

Reader: item-position-begin-line (instance) ¶

Writer: (setf item-position-begin-line) (instance) ¶

Package: cl-ledger.
Source: types.lisp.
Target Slot: begin-line.

Reader: item-position-end-line (instance) ¶

Writer: (setf item-position-end-line) (instance) ¶

Package: cl-ledger.
Source: types.lisp.
Target Slot: end-line.

Reader: item-position-source (instance) ¶

Writer: (setf item-position-source) (instance) ¶

Package: cl-ledger.
Source: types.lisp.
Target Slot: source.

Function: make-item-position (&key begin-line end-line source) ¶

Package: cl-ledger.
Source: types.lisp.

Function: make-transaction (&key entry actual-date effective-date status account amount cost note virtualp generatedp calculatedp must-balance-p position data) ¶

Package: cl-ledger.
Source: types.lisp.

Function: make-value-expr (&key string function) ¶

Package: cl-ledger.
Source: types.lisp.

Function: normalize-entry (entry) ¶

Package: cl-ledger.
Source: normalize.lisp.

Function: parse-journal-date (journal string) ¶

Package: cl-ledger.
Source: ledger.lisp.

Function: parse-predicate-keywords (args) ¶

Package: cl-ledger.
Source: filter.lisp.

Function: parse-value-expr (string &key observe-properties-p reduce-to-smallest-units-p pool) ¶

Package: cl-ledger.
Source: valexpr.lisp.

Function: payees-report (&rest args) ¶

Package: cl-ledger.
Source: print.lisp.

Function: print-entry (entry &key output-stream) ¶

Package: cl-ledger.
Source: print.lisp.

Function: print-report (&rest args) ¶

Package: cl-ledger.
Source: print.lisp.

Function: process-command-line (&rest args) ¶

Package: cl-ledger.
Source: driver.lisp.

Function: read-journal (path &optional binder) ¶

Read in a textual Ledger journal from the given PATH. The result is of type JOURNAL.

Package: cl-ledger.
Source: ledger.lisp.

Function: read-value-expr (in &key observe-properties-p reduce-to-smallest-units-p pool) ¶

Package: cl-ledger.
Source: valexpr.lisp.

Function: register-report (&rest args) ¶

This is a function for easily print register reports.

A typical usage might be:

(ledger:register-report "/path/to/ledger.dat"
:begin "2007/08/26" :account "food")

Package: cl-ledger.
Source: register.lisp.

Function: scan-entries (object) ¶

Package: cl-ledger.
Source: ledger.lisp.

Function: scan-transactions (object &optional entry-transform) ¶

Package: cl-ledger.
Source: ledger.lisp.

Function: sexp-report (&rest args) ¶

Package: cl-ledger.
Source: sexp.lisp.

Function: transactions-list (object &key entry-transform) ¶

Package: cl-ledger.
Source: ledger.lisp.

Reader: value-expr-function (instance) ¶

Writer: (setf value-expr-function) (instance) ¶

Package: cl-ledger.
Source: types.lisp.
Target Slot: function.

Function: value-expr-p (object) ¶

Package: cl-ledger.
Source: types.lisp.

Reader: value-expr-string (instance) ¶

Writer: (setf value-expr-string) (instance) ¶

Package: cl-ledger.
Source: types.lisp.
Target Slot: string.

Function: xact-account (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-account).

Function: xact-actual-date (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.

Function: xact-amount (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-amount).

Function: xact-amount* (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-amount*).

Function: xact-cleared-p (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.

Function: xact-cost (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-cost).

Function: xact-data (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-data).

Function: xact-date (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.

Function: xact-effective-date (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-effective-date).

Function: xact-entry (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-entry).

Function: xact-must-balance-p (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-must-balance-p).

Function: xact-note (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-note).

Function: xact-pending-p (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.

Function: xact-position (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-position).

Function: xact-status (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-status).

Function: xact-uncleared-p (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.

Function: xact-value (xact key) ¶

Setf Expander: (setf xact-value) (xact key) ¶

Package: cl-ledger.
Source: transaction.lisp.

Function: xact-virtualp (xact) ¶

Package: cl-ledger.
Source: transaction.lisp.
Setf expander for this function: (setf xact-virtualp).

6.1.5 Generic functions

Generic Reader: account-children (object) ¶

Package

	Index Entry	Section

*
	`allow-embedded-lisp`:	Public special variables
	`comment-line-scanner`:	Private special variables
	`comment-regexp`:	Private special variables
	`date-regexp`:	Private special variables
	`directive-handlers`:	Public special variables
	`entry-heading-scanner`:	Private special variables
	`last-binder`:	Public special variables
	`post-normalization-functions`:	Public special variables
	`pre-normalization-functions`:	Public special variables
	`predicate-keywords`:	Public special variables
	`price-scanner`:	Private special variables
	`registered-parsers`:	Public special variables
	`spacing-regexp`:	Private special variables
	`transaction-scanner`:	Private special variables
	`use-effective-dates`:	Public special variables
	`value-expr-commodity-pool`:	Private special variables
	`value-expr-last-xact`:	Private special variables
	`value-expr-observe-properties-p`:	Private special variables
	`value-expr-readtable`:	Private special variables
	`value-expr-reduce-to-smallest-units-p`:	Private special variables
	`value-expr-series-offset`:	Private special variables

A
	`account`:	Public structures
	`actual-date`:	Public structures
	`actual-date`:	Public classes
	`amount`:	Public structures

B
	`begin-line`:	Public structures
	`binder`:	Public classes

C
	`calculatedp`:	Public structures
	`children`:	Public classes
	`code`:	Public classes
	`commodity-pool`:	Public classes
	`contents`:	Public classes
	`cost`:	Public structures

D
	`data`:	Public structures
	`data`:	Public classes
	`data`:	Public classes
	`data`:	Public classes
	`data`:	Public classes
	`date-format`:	Public classes
	`default-account`:	Public classes
	`default-year`:	Public classes

E
	`effective-date`:	Public structures
	`effective-date`:	Public classes
	`end-line`:	Public structures
	`entry`:	Public structures

F
	`fullname`:	Public classes
	`function`:	Private structures

G
	`generatedp`:	Public structures

J
	`journal`:	Public classes
	`journals`:	Public classes

L
	`last-content-cell`:	Public classes

M
	`must-balance-p`:	Public structures

N
	`name`:	Public classes
	`normalizedp`:	Public classes
	`note`:	Public structures
	`note`:	Public classes

P
	`parent`:	Public classes
	`payee`:	Public classes
	`period`:	Private classes
	`position`:	Public structures
	`position`:	Public classes
	`predicate`:	Private classes
	`predicate-expr`:	Private classes

R
	`read-date`:	Public classes
	`root-account`:	Public classes

S
	`Slot, account`:	Public structures
	`Slot, actual-date`:	Public structures
	`Slot, actual-date`:	Public classes
	`Slot, amount`:	Public structures
	`Slot, begin-line`:	Public structures
	`Slot, binder`:	Public classes
	`Slot, calculatedp`:	Public structures
	`Slot, children`:	Public classes
	`Slot, code`:	Public classes
	`Slot, commodity-pool`:	Public classes
	`Slot, contents`:	Public classes
	`Slot, cost`:	Public structures
	`Slot, data`:	Public structures
	`Slot, data`:	Public classes
	`Slot, data`:	Public classes
	`Slot, data`:	Public classes
	`Slot, data`:	Public classes
	`Slot, date-format`:	Public classes
	`Slot, default-account`:	Public classes
	`Slot, default-year`:	Public classes
	`Slot, effective-date`:	Public structures
	`Slot, effective-date`:	Public classes
	`Slot, end-line`:	Public structures
	`Slot, entry`:	Public structures
	`Slot, fullname`:	Public classes
	`Slot, function`:	Private structures
	`Slot, generatedp`:	Public structures
	`Slot, journal`:	Public classes
	`Slot, journals`:	Public classes
	`Slot, last-content-cell`:	Public classes
	`Slot, must-balance-p`:	Public structures
	`Slot, name`:	Public classes
	`Slot, normalizedp`:	Public classes
	`Slot, note`:	Public structures
	`Slot, note`:	Public classes
	`Slot, parent`:	Public classes
	`Slot, payee`:	Public classes
	`Slot, period`:	Private classes
	`Slot, position`:	Public structures
	`Slot, position`:	Public classes
	`Slot, predicate`:	Private classes
	`Slot, predicate-expr`:	Private classes
	`Slot, read-date`:	Public classes
	`Slot, root-account`:	Public classes
	`Slot, source`:	Public structures
	`Slot, source`:	Public classes
	`Slot, status`:	Public structures
	`Slot, status`:	Public classes
	`Slot, string`:	Private structures
	`Slot, transactions`:	Public classes
	`Slot, virtualp`:	Public structures
	`source`:	Public structures
	`source`:	Public classes
	`Special Variable, allow-embedded-lisp`:	Public special variables
	`Special Variable, comment-line-scanner`:	Private special variables
	`Special Variable, comment-regexp`:	Private special variables
	`Special Variable, date-regexp`:	Private special variables
	`Special Variable, directive-handlers`:	Public special variables
	`Special Variable, entry-heading-scanner`:	Private special variables
	`Special Variable, last-binder`:	Public special variables
	`Special Variable, post-normalization-functions`:	Public special variables
	`Special Variable, pre-normalization-functions`:	Public special variables
	`Special Variable, predicate-keywords`:	Public special variables
	`Special Variable, price-scanner`:	Private special variables
	`Special Variable, registered-parsers`:	Public special variables
	`Special Variable, spacing-regexp`:	Private special variables
	`Special Variable, transaction-scanner`:	Private special variables
	`Special Variable, use-effective-dates`:	Public special variables
	`Special Variable, value-expr-commodity-pool`:	Private special variables
	`Special Variable, value-expr-last-xact`:	Private special variables
	`Special Variable, value-expr-observe-properties-p`:	Private special variables
	`Special Variable, value-expr-readtable`:	Private special variables
	`Special Variable, value-expr-reduce-to-smallest-units-p`:	Private special variables
	`Special Variable, value-expr-series-offset`:	Private special variables
	`status`:	Public structures
	`status`:	Public classes
	`string`:	Private structures

T
	`transactions`:	Public classes

V
	`virtualp`:	Public structures

The cl-ledger Reference Manual

The cl-ledger Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cl-ledger

3 Modules

3.1 cl-ledger/core

3.2 cl-ledger/transforms

3.3 cl-ledger/reports

3.4 cl-ledger/parsers

3.5 cl-ledger/parsers/textual

4 Files

4.1 Lisp

4.1.1 cl-ledger/cl-ledger.asd

4.1.2 cl-ledger/core/packages.lisp

4.1.3 cl-ledger/core/types.lisp

4.1.4 cl-ledger/core/general.lisp

4.1.5 cl-ledger/core/ledger.lisp

4.1.6 cl-ledger/core/transaction.lisp

4.1.7 cl-ledger/core/normalize.lisp

4.1.8 cl-ledger/core/valexpr.lisp

4.1.9 cl-ledger/core/emacs.lisp

4.1.10 cl-ledger/transforms/totals.lisp

4.1.11 cl-ledger/transforms/filter.lisp

4.1.12 cl-ledger/transforms/periodic.lisp

4.1.13 cl-ledger/transforms/sort.lisp

4.1.14 cl-ledger/transforms/collapse.lisp

4.1.15 cl-ledger/transforms/invert.lisp

4.1.16 cl-ledger/transforms/subtotal.lisp

4.1.17 cl-ledger/transforms/related.lisp

4.1.18 cl-ledger/transforms/transform.lisp

4.1.19 cl-ledger/reports/report.lisp

4.1.20 cl-ledger/reports/register.lisp

4.1.21 cl-ledger/reports/sexp.lisp

4.1.22 cl-ledger/reports/balance.lisp

4.1.23 cl-ledger/reports/print.lisp

4.1.24 cl-ledger/reports/entry.lisp

4.1.25 cl-ledger/reports/csv.lisp

4.1.26 cl-ledger/parsers/textual/textual.lisp

4.1.27 cl-ledger/parsers/textual/autoentry.lisp

4.1.28 cl-ledger/parsers/textual/perentry.lisp

4.1.29 cl-ledger/driver.lisp

5 Packages

5.1 cl-ledger

5.2 ledger-textual

6 Definitions

6.1 Public Interface

6.1.1 Special variables

6.1.2 Macros

6.1.3 Setf expanders

6.1.4 Ordinary functions

6.1.5 Generic functions

6.1.6 Standalone methods

6.1.7 Structures

6.1.8 Classes

6.1.9 Types

6.2 Internals

6.2.1 Special variables

6.2.2 Macros

6.2.3 Setf expanders

6.2.4 Ordinary functions

6.2.5 Generic functions

6.2.6 Structures

6.2.7 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cl-ledger`

3.1 `cl-ledger/core`

3.2 `cl-ledger/transforms`

3.3 `cl-ledger/reports`

3.4 `cl-ledger/parsers`

3.5 `cl-ledger/parsers/textual`

4.1.1 `cl-ledger/cl-ledger.asd`

4.1.2 `cl-ledger/core/packages.lisp`

4.1.3 `cl-ledger/core/types.lisp`

4.1.4 `cl-ledger/core/general.lisp`

4.1.5 `cl-ledger/core/ledger.lisp`

4.1.6 `cl-ledger/core/transaction.lisp`

4.1.7 `cl-ledger/core/normalize.lisp`

4.1.8 `cl-ledger/core/valexpr.lisp`

4.1.9 `cl-ledger/core/emacs.lisp`

4.1.10 `cl-ledger/transforms/totals.lisp`

4.1.11 `cl-ledger/transforms/filter.lisp`

4.1.12 `cl-ledger/transforms/periodic.lisp`

4.1.13 `cl-ledger/transforms/sort.lisp`

4.1.14 `cl-ledger/transforms/collapse.lisp`

4.1.15 `cl-ledger/transforms/invert.lisp`

4.1.16 `cl-ledger/transforms/subtotal.lisp`

4.1.17 `cl-ledger/transforms/related.lisp`

4.1.18 `cl-ledger/transforms/transform.lisp`

4.1.19 `cl-ledger/reports/report.lisp`

4.1.20 `cl-ledger/reports/register.lisp`

4.1.21 `cl-ledger/reports/sexp.lisp`

4.1.22 `cl-ledger/reports/balance.lisp`

4.1.23 `cl-ledger/reports/print.lisp`

4.1.24 `cl-ledger/reports/entry.lisp`

4.1.25 `cl-ledger/reports/csv.lisp`

4.1.26 `cl-ledger/parsers/textual/textual.lisp`

4.1.27 `cl-ledger/parsers/textual/autoentry.lisp`

4.1.28 `cl-ledger/parsers/textual/perentry.lisp`

4.1.29 `cl-ledger/driver.lisp`

5.1 `cl-ledger`

5.2 `ledger-textual`