The cl-ledger Reference Manual

Table of Contents

The cl-ledger Reference Manual

This is the cl-ledger Reference Manual, version 4.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 14:58:22 2021 GMT+0.

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.

2.1 cl-ledger

Maintainer

Guillaume LE VAILLANT <glv@posteo.net>

Author

John Wiegley <jwiegley@gmail.com>

License

BSD-3

Description

Double-entry accounting system.

Version

4.0.0

Dependencies

• local-time
• periods-series
• cambl
• cl-ppcre

Source

cl-ledger.asd (file)

Components

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

3 Modules

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

3.1 cl-ledger/core

Parent

cl-ledger (system)

Location

core/

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)

Parent

cl-ledger (system)

Location

transforms/

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)

Parent

cl-ledger (system)

Location

reports/

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)

Parent

cl-ledger (system)

Location

parsers/

Component

textual (module)

3.5 cl-ledger/parsers/textual

Parent

parsers (module)

Location

parsers/textual/

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.

4.1 Lisp

4.1.1 cl-ledger.asd

Location

cl-ledger.asd

Systems

cl-ledger (system)

4.1.2 cl-ledger/core/packages.lisp

Parent

core (module)

Location

core/packages.lisp

Packages

cl-ledger

4.1.3 cl-ledger/core/types.lisp

Dependency

packages.lisp (file)

Parent

core (module)

Location

core/types.lisp

Exported Definitions

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

Internal Definitions

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

4.1.4 cl-ledger/core/general.lisp

Dependency

types.lisp (file)

Parent

core (module)

Location

core/general.lisp

Internal Definitions

• 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)

Parent

core (module)

Location

core/ledger.lisp

Exported Definitions

• *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)

Internal Definitions

• account-set-value (function)
• account-value (function)
• (setf account-value) (setf expander)
• 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)

Parent

core (module)

Location

core/transaction.lisp

Exported Definitions

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

Internal Definitions

• 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)
• xact-calculatedp (function)
• (setf xact-calculatedp) (setf expander)
• xact-cost-total (function)
• xact-display-amount (function)
• xact-display-total (function)
• xact-generatedp (function)
• (setf xact-generatedp) (setf expander)
• xact-total (function)

4.1.7 cl-ledger/core/normalize.lisp

Dependency

transaction.lisp (file)

Parent

core (module)

Location

core/normalize.lisp

Exported Definitions

• *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)

Parent

core (module)

Location

core/valexpr.lisp

Exported Definitions

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

Internal Definitions

• *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)

Parent

core (module)

Location

core/emacs.lisp

Exported Definitions

find-current-entity (function)

4.1.10 cl-ledger/transforms/totals.lisp

Parent

transforms (module)

Location

transforms/totals.lisp

Exported Definitions

calculate-totals (function)

Internal Definitions

• 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)

Parent

transforms (module)

Location

transforms/filter.lisp

Exported Definitions

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

Internal Definitions

• 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)

Parent

transforms (module)

Location

transforms/periodic.lisp

Internal Definitions

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

4.1.13 cl-ledger/transforms/sort.lisp

Dependency

periodic.lisp (file)

Parent

transforms (module)

Location

transforms/sort.lisp

Internal Definitions

• sort-entries (function)
• sort-transactions (function)

4.1.14 cl-ledger/transforms/collapse.lisp

Dependency

sort.lisp (file)

Parent

transforms (module)

Location

transforms/collapse.lisp

Internal Definitions

collapse-entries (function)

4.1.15 cl-ledger/transforms/invert.lisp

Dependency

collapse.lisp (file)

Parent

transforms (module)

Location

transforms/invert.lisp

Internal Definitions

invert-transactions (function)

4.1.16 cl-ledger/transforms/subtotal.lisp

Dependency

invert.lisp (file)

Parent

transforms (module)

Location

transforms/subtotal.lisp

Internal Definitions

group-by-account (function)

4.1.17 cl-ledger/transforms/related.lisp

Dependency

subtotal.lisp (file)

Parent

transforms (module)

Location

transforms/related.lisp

Internal Definitions

related-transactions (function)

4.1.18 cl-ledger/transforms/transform.lisp

Dependency

related.lisp (file)

Parent

transforms (module)

Location

transforms/transform.lisp

Internal Definitions

apply-key-transforms (function)

4.1.19 cl-ledger/reports/report.lisp

Parent

reports (module)

Location

reports/report.lisp

Internal Definitions

• 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)

Parent

reports (module)

Location

reports/register.lisp

Exported Definitions

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

Internal Definitions

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

4.1.21 cl-ledger/reports/sexp.lisp

Dependency

register.lisp (file)

Parent

reports (module)

Location

reports/sexp.lisp

Exported Definitions

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

Internal Definitions

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

4.1.22 cl-ledger/reports/balance.lisp

Dependency

sexp.lisp (file)

Parent

reports (module)

Location

reports/balance.lisp

Exported Definitions

balance-report (function)

Internal Definitions

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

4.1.23 cl-ledger/reports/print.lisp

Dependency

balance.lisp (file)

Parent

reports (module)

Location

reports/print.lisp

Exported Definitions

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

Internal Definitions

• print-reporter (function)
• print-transactions (function)

4.1.24 cl-ledger/reports/entry.lisp

Dependency

print.lisp (file)

Parent

reports (module)

Location

reports/entry.lisp

Exported Definitions

derive-entry (function)

Internal Definitions

print-new-entry (function)

4.1.25 cl-ledger/reports/csv.lisp

Dependency

entry.lisp (file)

Parent

reports (module)

Location

reports/csv.lisp

Exported Definitions

csv-report (function)

Internal Definitions

csv-reporter (function)

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

Parent

textual (module)

Location

parsers/textual/textual.lisp

Packages

ledger-textual

Exported Definitions

*directive-handlers* (special variable)

Internal Definitions

• *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)

Parent

textual (module)

Location

parsers/textual/autoentry.lisp

Internal Definitions

• apply-automated-entries (function)
• auto-entry-predicate (method)
• (setf auto-entry-predicate) (method)
• auto-entry-predicate-expr (method)
• (setf auto-entry-predicate-expr) (method)
• automated-entry (class)
• read-automated-entry (function)

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

Dependencies

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

Parent

textual (module)

Location

parsers/textual/perentry.lisp

Internal Definitions

• entry-period (method)
• (setf entry-period) (method)
• periodic-entry (class)
• read-periodic-entry (function)

4.1.29 cl-ledger/driver.lisp

Dependency

parsers (module)

Parent

cl-ledger (system)

Location

driver.lisp

Exported Definitions

process-command-line (function)

Internal Definitions

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

5 Packages

Packages are listed by definition order.

5.1 cl-ledger

Source

packages.lisp (file)

Nickname

ledger

Use List

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

Used By List

ledger-textual

Exported Definitions

• *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 function)
• account-children (method)
• (setf account-children) (method)
• (setf account-children) (generic function)
• account-data (generic function)
• account-data (method)
• (setf account-data) (method)
• (setf account-data) (generic function)
• account-fullname (generic function)
• account-fullname (method)
• (setf account-fullname) (method)
• (setf account-fullname) (generic function)
• account-name (generic function)
• account-name (method)
• (setf account-name) (method)
• (setf account-name) (generic function)
• account-names-report (function)
• account-parent (generic function)
• account-parent (method)
• (setf account-parent) (method)
• (setf account-parent) (generic function)
• add-journal (generic function)
• add-journal (method)
• add-journal (method)
• add-journal (method)
• add-journal (method)
• add-to-contents (function)
• add-transaction (generic function)
• add-transaction (method)
• apply-filter (function)
• balance-report (function)
• binder (function)
• binder (class)
• binder-commodity-pool (generic function)
• binder-commodity-pool (method)
• (setf binder-commodity-pool) (method)
• (setf binder-commodity-pool) (generic function)
• binder-data (generic function)
• binder-data (method)
• (setf binder-data) (method)
• (setf binder-data) (generic function)
• binder-journals (generic function)
• binder-journals (method)
• (setf binder-journals) (method)
• (setf binder-journals) (generic function)
• binder-root-account (generic function)
• binder-root-account (method)
• (setf binder-root-account) (method)
• (setf binder-root-account) (generic function)
• 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-iterator (method)
• entries-iterator (method)
• entries-iterator (method)
• entries-list (function)
• entry (class)
• entry-actual-date (generic function)
• entry-actual-date (method)
• (setf entry-actual-date) (method)
• (setf entry-actual-date) (generic function)
• entry-code (generic function)
• entry-code (method)
• (setf entry-code) (method)
• (setf entry-code) (generic function)
• entry-data (generic function)
• entry-data (method)
• (setf entry-data) (method)
• (setf entry-data) (generic function)
• entry-date (function)
• entry-effective-date (generic function)
• entry-effective-date (method)
• (setf entry-effective-date) (method)
• (setf entry-effective-date) (generic function)
• entry-journal (generic function)
• entry-journal (method)
• (setf entry-journal) (method)
• (setf entry-journal) (generic function)
• entry-note (generic function)
• entry-note (method)
• (setf entry-note) (method)
• (setf entry-note) (generic function)
• entry-payee (generic function)
• entry-payee (method)
• (setf entry-payee) (method)
• (setf entry-payee) (generic function)
• entry-position (generic function)
• entry-position (method)
• (setf entry-position) (method)
• (setf entry-position) (generic function)
• entry-status (generic function)
• entry-status (method)
• (setf entry-status) (method)
• (setf entry-status) (generic function)
• entry-transactions (generic function)
• entry-transactions (method)
• (setf entry-transactions) (method)
• (setf entry-transactions) (generic function)
• equity-report (function)
• find-account (generic function)
• find-account (method)
• find-account (method)
• 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 (function)
• (setf item-position-begin-line) (function)
• item-position-end-line (function)
• (setf item-position-end-line) (function)
• item-position-source (function)
• (setf item-position-source) (function)
• item-status (type)
• journal (class)
• journal-binder (generic function)
• journal-binder (method)
• (setf journal-binder) (method)
• (setf journal-binder) (generic function)
• journal-contents (generic function)
• journal-contents (method)
• (setf journal-contents) (method)
• (setf journal-contents) (generic function)
• journal-data (generic function)
• journal-data (method)
• (setf journal-data) (method)
• (setf journal-data) (generic function)
• journal-date-format (generic function)
• journal-date-format (method)
• (setf journal-date-format) (method)
• (setf journal-date-format) (generic function)
• journal-default-account (generic function)
• journal-default-account (method)
• (setf journal-default-account) (method)
• (setf journal-default-account) (generic function)
• journal-default-year (generic function)
• journal-default-year (method)
• (setf journal-default-year) (method)
• (setf journal-default-year) (generic function)
• journal-source (generic function)
• journal-source (method)
• (setf journal-source) (method)
• (setf journal-source) (generic function)
• 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-iterator (method)
• transactions-iterator (method)
• transactions-iterator (method)
• transactions-iterator (method)
• transactions-list (function)
• value-expr-function (function)
• (setf value-expr-function) (function)
• value-expr-p (function)
• value-expr-string (function)
• (setf value-expr-string) (function)
• xact-account (function)
• (setf xact-account) (setf expander)
• xact-actual-date (function)
• xact-amount (function)
• (setf xact-amount) (setf expander)
• xact-amount* (function)
• (setf xact-amount*) (setf expander)
• xact-cleared-p (function)
• xact-cost (function)
• (setf xact-cost) (setf expander)
• xact-data (function)
• (setf xact-data) (setf expander)
• xact-date (function)
• xact-effective-date (function)
• (setf xact-effective-date) (setf expander)
• xact-entry (function)
• (setf xact-entry) (setf expander)
• xact-must-balance-p (function)
• (setf xact-must-balance-p) (setf expander)
• xact-note (function)
• (setf xact-note) (setf expander)
• xact-pending-p (function)
• xact-position (function)
• (setf xact-position) (setf expander)
• xact-status (function)
• (setf xact-status) (setf expander)
• xact-uncleared-p (function)
• xact-value (function)
• (setf xact-value) (setf expander)
• xact-virtualp (function)
• (setf xact-virtualp) (setf expander)

Internal Definitions

• *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)
• account-value (function)
• (setf account-value) (setf expander)
• 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 function)
• entry-normalizedp (method)
• (setf entry-normalizedp) (method)
• (setf entry-normalizedp) (generic function)
• eq-matcher (function)
• find-all-transactions (function)
• fixed-time-matcher (function)
• get-computed-amount (function)
• get-computed-total (function)
• get-xact-account (function)
• (setf get-xact-account) (function)
• get-xact-actual-date (function)
• (setf get-xact-actual-date) (function)
• get-xact-amount (function)
• (setf get-xact-amount) (function)
• get-xact-calculatedp (function)
• (setf get-xact-calculatedp) (function)
• get-xact-cost (function)
• (setf get-xact-cost) (function)
• get-xact-data (function)
• (setf get-xact-data) (function)
• get-xact-effective-date (function)
• (setf get-xact-effective-date) (function)
• get-xact-entry (function)
• (setf get-xact-entry) (function)
• get-xact-generatedp (function)
• (setf get-xact-generatedp) (function)
• get-xact-must-balance-p (function)
• (setf get-xact-must-balance-p) (function)
• get-xact-note (function)
• (setf get-xact-note) (function)
• get-xact-position (function)
• (setf get-xact-position) (function)
• get-xact-status (function)
• (setf get-xact-status) (function)
• get-xact-virtualp (function)
• (setf get-xact-virtualp) (function)
• 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 function)
• journal-last-content-cell (method)
• (setf journal-last-content-cell) (method)
• (setf journal-last-content-cell) (generic function)
• journal-read-date (generic function)
• journal-read-date (method)
• (setf journal-read-date) (method)
• (setf journal-read-date) (generic function)
• 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)
• xact-calculatedp (function)
• (setf xact-calculatedp) (setf expander)
• xact-cost-total (function)
• xact-display-amount (function)
• xact-display-total (function)
• xact-generatedp (function)
• (setf xact-generatedp) (setf expander)
• xact-total (function)
• xacts-to-sexp (function)

5.2 ledger-textual

Source

textual.lisp (file)

Use List

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

Exported Definitions

*directive-handlers* (special variable)

Internal Definitions

• *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 function)
• auto-entry-predicate (method)
• (setf auto-entry-predicate) (method)
• (setf auto-entry-predicate) (generic function)
• auto-entry-predicate-expr (generic function)
• auto-entry-predicate-expr (method)
• (setf auto-entry-predicate-expr) (method)
• (setf auto-entry-predicate-expr) (generic function)
• automated-entry (class)
• entry-period (generic function)
• entry-period (method)
• (setf entry-period) (method)
• (setf entry-period) (generic function)
• 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.

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *allow-embedded-lisp*

Package

cl-ledger

Source

ledger.lisp (file)

Special Variable: *directive-handlers*

Package

ledger-textual

Source

textual.lisp (file)

Special Variable: *last-binder*

Package

cl-ledger

Source

ledger.lisp (file)

Special Variable: *post-normalization-functions*

Package

cl-ledger

Source

normalize.lisp (file)

Special Variable: *pre-normalization-functions*

Package

cl-ledger

Source

normalize.lisp (file)

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 (file)

Special Variable: *registered-parsers*

Package

cl-ledger

Source

ledger.lisp (file)

Special Variable: *use-effective-dates*

Package

cl-ledger

Source

ledger.lisp (file)

6.1.2 Macros

Macro: do-entries (VAR OBJECT &optional RESULT) &body BODY

Package

cl-ledger

Source

ledger.lisp (file)

Macro: do-transactions (VAR OBJECT &optional RESULT) &body BODY

Package

cl-ledger

Source

ledger.lisp (file)

Macro: map-entries CALLABLE OBJECT

Package

cl-ledger

Source

ledger.lisp (file)

Macro: map-transactions CALLABLE OBJECT &key ENTRY-TRANSFORM

Package

cl-ledger

Source

ledger.lisp (file)

6.1.3 Functions

Function: abbreviate-string NAME WIDTH &key ELISION-STYLE ACCOUNT-P ABBREV-LENGTH

Package

cl-ledger

Source

register.lisp (file)

Function: account-names-report &rest ARGS

Package

cl-ledger

Source

print.lisp (file)

Function: add-to-contents JOURNAL ITEM

Package

cl-ledger

Source

ledger.lisp (file)

Function: apply-filter XACT-SERIES &rest ARGS

Package

cl-ledger

Source

filter.lisp (file)

Function: balance-report &rest ARGS

Package

cl-ledger

Source

balance.lisp (file)

Function: binder &rest ARGS

Package

cl-ledger

Source

ledger.lisp (file)

Function: binder-statistics &optional BINDER

Package

cl-ledger

Source

ledger.lisp (file)

Function: calculate-totals XACT-SERIES &key SET-AMOUNT SET-TOTAL DISPLAYED-AMOUNT-SETTER &allow-other-keys

Package

cl-ledger

Source

totals.lisp (file)

Function: choose-if-value-expr XACT-SERIES EXPR

Package

cl-ledger

Source

filter.lisp (file)

Function: copy-entry ENTRY &rest ARGS

Package

cl-ledger

Source

ledger.lisp (file)

Function: copy-item-position INSTANCE

Package

cl-ledger

Source

types.lisp (file)

Function: csv-report &rest ARGS

Package

cl-ledger

Source

csv.lisp (file)

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 (file)

Function: entries-list OBJECT

Package

cl-ledger

Source

ledger.lisp (file)

Function: entry-date ENTRY

Package

cl-ledger

Source

ledger.lisp (file)

Function: equity-report &rest ARGS

Package

cl-ledger

Source

print.lisp (file)

Function: find-account-tree &rest ARGS

Package

cl-ledger

Source

sexp.lisp (file)

Function: find-child-account ACCOUNT ACCOUNT-NAME &key CREATE-IF-NOT-EXISTS-P FULLNAME

Package

cl-ledger

Source

ledger.lisp (file)

Function: find-current-entity JOURNAL-PATH GOAL-LINE

Package

cl-ledger

Source

emacs.lisp (file)

Function: find-sibling-accounts &rest ARGS

Package

cl-ledger

Source

sexp.lisp (file)

Function: find-unique-accounts &rest ARGS

Package

cl-ledger

Source

sexp.lisp (file)

Function: find-unique-payees &rest ARGS

Package

cl-ledger

Source

sexp.lisp (file)

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 (file)

Function: item-position-begin-line INSTANCE

Function: (setf item-position-begin-line) VALUE INSTANCE

Package

cl-ledger

Source

types.lisp (file)

Function: item-position-end-line INSTANCE

Function: (setf item-position-end-line) VALUE INSTANCE

Package

cl-ledger

Source

types.lisp (file)

Function: item-position-source INSTANCE

Function: (setf item-position-source) VALUE INSTANCE

Package

cl-ledger

Source

types.lisp (file)

Function: make-item-position &key (BEGIN-LINE BEGIN-LINE) (END-LINE END-LINE) (SOURCE SOURCE)

Package

cl-ledger

Source

types.lisp (file)

Function: make-transaction &key (ENTRY ENTRY) (ACTUAL-DATE ACTUAL-DATE) (EFFECTIVE-DATE EFFECTIVE-DATE) (STATUS STATUS) (ACCOUNT ACCOUNT) (AMOUNT AMOUNT) (COST COST) (NOTE NOTE) (VIRTUALP VIRTUALP) (GENERATEDP GENERATEDP) (CALCULATEDP CALCULATEDP) (MUST-BALANCE-P MUST-BALANCE-P) (POSITION POSITION) (DATA DATA)

Package

cl-ledger

Source

types.lisp (file)

Function: make-value-expr &key (STRING STRING) (FUNCTION FUNCTION)

Package

cl-ledger

Source

types.lisp (file)

Function: normalize-entry ENTRY

Package

cl-ledger

Source

normalize.lisp (file)

Function: parse-journal-date JOURNAL STRING

Package

cl-ledger

Source

ledger.lisp (file)

Function: parse-predicate-keywords ARGS

Package

cl-ledger

Source

filter.lisp (file)

Function: parse-value-expr STRING &key OBSERVE-PROPERTIES-P REDUCE-TO-SMALLEST-UNITS-P POOL

Package

cl-ledger

Source

valexpr.lisp (file)

Function: payees-report &rest ARGS

Package

cl-ledger

Source

print.lisp (file)

Function: print-entry ENTRY &key OUTPUT-STREAM

Package

cl-ledger

Source

print.lisp (file)

Function: print-report &rest ARGS

Package

cl-ledger

Source

print.lisp (file)

Function: process-command-line &rest ARGS

Package

cl-ledger

Source

driver.lisp (file)

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 (file)

Function: read-value-expr IN &key OBSERVE-PROPERTIES-P REDUCE-TO-SMALLEST-UNITS-P POOL

Package

cl-ledger

Source

valexpr.lisp (file)

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 (file)

Function: scan-entries OBJECT

Package

cl-ledger

Source

ledger.lisp (file)

Function: scan-transactions OBJECT &optional ENTRY-TRANSFORM

Package

cl-ledger

Source

ledger.lisp (file)

Function: sexp-report &rest ARGS

Package

cl-ledger

Source

sexp.lisp (file)

Function: transactions-list OBJECT &key ENTRY-TRANSFORM

Package

cl-ledger

Source

ledger.lisp (file)

Function: value-expr-function INSTANCE

Function: (setf value-expr-function) VALUE INSTANCE

Package

cl-ledger

Source

types.lisp (file)

Function: value-expr-p OBJECT

Package

cl-ledger

Source

types.lisp (file)

Function: value-expr-string INSTANCE

Function: (setf value-expr-string) VALUE INSTANCE

Package

cl-ledger

Source

types.lisp (file)

Function: xact-account XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-account) (setf expander)

Setf Expander: (setf xact-account) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-account (function)

Writer

set-xact-account (function)

Function: xact-actual-date XACT

Package

cl-ledger

Source

transaction.lisp (file)

Function: xact-amount XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-amount) (setf expander)

Setf Expander: (setf xact-amount) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-amount (function)

Writer

set-xact-amount (function)

Function: xact-amount* XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-amount*) (setf expander)

Setf Expander: (setf xact-amount*) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-amount* (function)

Writer

set-xact-amount* (function)

Function: xact-cleared-p XACT

Package

cl-ledger

Source

transaction.lisp (file)

Function: xact-cost XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-cost) (setf expander)

Setf Expander: (setf xact-cost) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-cost (function)

Writer

set-xact-cost (function)

Function: xact-data XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-data) (setf expander)

Setf Expander: (setf xact-data) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-data (function)

Writer

set-xact-data (function)

Function: xact-date XACT

Package

cl-ledger

Source

transaction.lisp (file)

Function: xact-effective-date XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-effective-date) (setf expander)

Setf Expander: (setf xact-effective-date) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-effective-date (function)

Writer

set-xact-effective-date (function)

Function: xact-entry XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-entry) (setf expander)

Setf Expander: (setf xact-entry) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-entry (function)

Writer

set-xact-entry (function)

Function: xact-must-balance-p XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-must-balance-p) (setf expander)

Setf Expander: (setf xact-must-balance-p) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-must-balance-p (function)

Writer

set-xact-must-balance-p (function)

Function: xact-note XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-note) (setf expander)

Setf Expander: (setf xact-note) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-note (function)

Writer

set-xact-note (function)

Function: xact-pending-p XACT

Package

cl-ledger

Source

transaction.lisp (file)

Function: xact-position XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-position) (setf expander)

Setf Expander: (setf xact-position) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-position (function)

Writer

set-xact-position (function)

Function: xact-status XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-status) (setf expander)

Setf Expander: (setf xact-status) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-status (function)

Writer

set-xact-status (function)

Function: xact-uncleared-p XACT

Package

cl-ledger

Source

transaction.lisp (file)

Function: xact-value XACT KEY

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-value) (setf expander)

Setf Expander: (setf xact-value) XACT KEY

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-value (function)

Function: xact-virtualp XACT

Package

cl-ledger

Source

transaction.lisp (file)

Setf Expander

(setf xact-virtualp) (setf expander)

Setf Expander: (setf xact-virtualp) XACT VALUE

Package

cl-ledger

Source

transaction.lisp (file)

Reader

xact-virtualp (function)

Writer

set-xact-virtualp (function)

6.1.4 Generic functions

Generic Function: account-children OBJECT

Generic Function: (setf account-children) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: account-children (ACCOUNT account)

automatically generated reader method

Source

types.lisp (file)

Method: (setf account-children) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

types.lisp (file)

Generic Function: account-data OBJECT

Generic Function: (setf account-data) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: account-data (ACCOUNT account)

automatically generated reader method

Source

types.lisp (file)

Method: (setf account-data) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

types.lisp (file)

Generic Function: account-fullname OBJECT

Generic Function: (setf account-fullname) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: account-fullname (ACCOUNT account)

automatically generated reader method

Source

types.lisp (file)

Method: (setf account-fullname) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

types.lisp (file)

Generic Function: account-name OBJECT

Generic Function: (setf account-name) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: account-name (ACCOUNT account)

automatically generated reader method

Source

types.lisp (file)

Method: (setf account-name) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

types.lisp (file)

Generic Function: account-parent OBJECT

Generic Function: (setf account-parent) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: account-parent (ACCOUNT account)

automatically generated reader method

Source

types.lisp (file)

Method: (setf account-parent) NEW-VALUE (ACCOUNT account)

automatically generated writer method

Source

types.lisp (file)

Generic Function: add-journal BINDER JOURNAL

Package

cl-ledger

Source

types.lisp (file)

Methods

Method: add-journal (JOURNAL journal) (CHILD journal)

Source

ledger.lisp (file)

Method: add-journal (BINDER binder) (PATH pathname)

Source

ledger.lisp (file)

Method: add-journal (BINDER binder) (PATH-STRING string)

Source

ledger.lisp (file)

Method: add-journal (BINDER binder) (JOURNAL journal)

Source

ledger.lisp (file)

Generic Function: add-transaction ITEM TRANSACTION

Package

cl-ledger

Source

types.lisp (file)

Methods

Method: add-transaction (ENTRY entry) (TRANSACTION transaction)

Source

ledger.lisp (file)

Generic Function: binder-commodity-pool OBJECT

Generic Function: (setf binder-commodity-pool) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: binder-commodity-pool (BINDER binder)

automatically generated reader method

Source

types.lisp (file)

Method: (setf binder-commodity-pool) NEW-VALUE (BINDER binder)

automatically generated writer method

Source

types.lisp (file)

Generic Function: binder-data OBJECT

Generic Function: (setf binder-data) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: binder-data (BINDER binder)

automatically generated reader method

Source

types.lisp (file)

Method: (setf binder-data) NEW-VALUE (BINDER binder)

automatically generated writer method

Source

types.lisp (file)

Generic Function: binder-journals OBJECT

Generic Function: (setf binder-journals) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: binder-journals (BINDER binder)

automatically generated reader method

Source

types.lisp (file)

Method: (setf binder-journals) NEW-VALUE (BINDER binder)

automatically generated writer method

Source

types.lisp (file)

Generic Function: binder-root-account OBJECT

Generic Function: (setf binder-root-account) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: binder-root-account (BINDER binder)

automatically generated reader method

Source

types.lisp (file)

Method: (setf binder-root-account) NEW-VALUE (BINDER binder)

automatically generated writer method

Source

types.lisp (file)

Generic Function: entries-iterator OBJECT

Package

cl-ledger

Source

types.lisp (file)

Methods

Method: entries-iterator (ENTRY entry)

Source

ledger.lisp (file)

Method: entries-iterator (JOURNAL journal)

Source

ledger.lisp (file)

Method: entries-iterator (BINDER binder)

Source

ledger.lisp (file)

Generic Function: entry-actual-date OBJECT

Generic Function: (setf entry-actual-date) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: entry-actual-date (ENTRY entry)

automatically generated reader method

Source

types.lisp (file)

Method: (setf entry-actual-date) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

types.lisp (file)

Generic Function: entry-code OBJECT

Generic Function: (setf entry-code) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: entry-code (ENTRY entry)

automatically generated reader method

Source

types.lisp (file)

Method: (setf entry-code) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

types.lisp (file)

Generic Function: entry-data OBJECT

Generic Function: (setf entry-data) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: entry-data (ENTRY entry)

automatically generated reader method

Source

types.lisp (file)

Method: (setf entry-data) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

types.lisp (file)

Generic Function: entry-effective-date OBJECT

Generic Function: (setf entry-effective-date) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: entry-effective-date (ENTRY entry)

automatically generated reader method

Source

types.lisp (file)

Method: (setf entry-effective-date) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

types.lisp (file)

Generic Function: entry-journal OBJECT

Generic Function: (setf entry-journal) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: entry-journal (ENTRY entry)

automatically generated reader method

Source

types.lisp (file)

Method: (setf entry-journal) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

types.lisp (file)

Generic Function: entry-note OBJECT

Generic Function: (setf entry-note) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: entry-note (ENTRY entry)

automatically generated reader method

Source

types.lisp (file)

Method: (setf entry-note) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

types.lisp (file)

Generic Function: entry-payee OBJECT

Generic Function: (setf entry-payee) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: entry-payee (ENTRY entry)

automatically generated reader method

Source

types.lisp (file)

Method: (setf entry-payee) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

types.lisp (file)

Generic Function: entry-position OBJECT

Generic Function: (setf entry-position) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: entry-position (ENTRY entry)

automatically generated reader method

Source

types.lisp (file)

Method: (setf entry-position) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

types.lisp (file)

Generic Function: entry-status OBJECT

Generic Function: (setf entry-status) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: entry-status (ENTRY entry)

automatically generated reader method

Source

types.lisp (file)

Method: (setf entry-status) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

types.lisp (file)

Generic Function: entry-transactions OBJECT

Generic Function: (setf entry-transactions) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: entry-transactions (ENTRY entry)

automatically generated reader method

Source

types.lisp (file)

Method: (setf entry-transactions) NEW-VALUE (ENTRY entry)

automatically generated writer method

Source

types.lisp (file)

Generic Function: find-account ITEM ACCOUNT-PATH &key CREATE-IF-NOT-EXISTS-P

Package

cl-ledger

Source

types.lisp (file)

Methods

Method: find-account (JOURNAL journal) (ACCOUNT-PATH string) &key CREATE-IF-NOT-EXISTS-P

Source

ledger.lisp (file)

Method: find-account (BINDER binder) (ACCOUNT-PATH string) &key CREATE-IF-NOT-EXISTS-P

Source

ledger.lisp (file)

Generic Function: journal-binder OBJECT

Generic Function: (setf journal-binder) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: journal-binder (JOURNAL journal)

automatically generated reader method

Source

types.lisp (file)

Method: (setf journal-binder) NEW-VALUE (JOURNAL journal)

automatically generated writer method

Source

types.lisp (file)

Generic Function: journal-contents OBJECT

Generic Function: (setf journal-contents) NEW-VALUE OBJECT

Package

cl-ledger

Methods

Method: journal-contents (JOURNAL journal)

automatically generated reader method

Source

types.lisp (file)

Method: (setf journal-contents) NEW-VALUE (JOURNAL journal)

automatically generated writer method

Source

types.lisp (file)