This is the poler Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:35:22 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
polerInfix notation macro generator
carrotflakes
LLGPL
# poler
Poler can generate macros which convert infix notation to prefix notation.
Poler aims to easily build DSL on Common Lisp.
We call the conversion **polish** in poler.
## Usage
“‘ lisp
;; Define a polish macro named ’arithmetic’.
(poler:define-poler arithmetic
(+ :infixl 1)
(- :infixl 1)
(* :infixl 2)
(/ :infixl 2))
;; Then, we can use ’arithmetic’ macro.
(arithmetic 1 + 2 * 3)
; => 7
(macroexpand ’(arithmetic 1 * 2 / (3 + 4 + 5)))
; => (/ (* 1 2) (+ (+ 3 4) 5))
“‘
## Operator definition
A polish needs operator definitions. An operator definition is represented as following:
(name type precedence [replace-name | format])
‘name‘ is a symbol as the operator name.
‘type‘ is a keyword represents the operator type.
‘precedence‘ is a fixnum over 0 represents the operator precedence. The high precedence of operator is, the more prior association of the operators.
‘replace-name‘ is a symbol. See [Name replacement](#name-replacement).
‘format‘ is a form. See [Format of form](#format-of-form).
### Operator types
Poler supports following operator types.
#### ‘:infixl‘
Left-associative infix operator.
(1 + 2 + 3) => (+ (+ 1 2) 3)
#### ‘:infixr‘
Right-associative infix operator.
(1 + 2 + 3) => (+ 1 (+ 2 3))
#### ‘:infix‘
Non-associative infix operator.
(1 + 2 + 3) => (+ 1 2 3)
#### ‘:prefix-n‘ (‘n‘ is a natural number)
‘n‘ operands prefix operator.
; In the case of :prefix-3.
(+ 1 2 3) => (+ 1 2 3)
(+ 1 2) => Illegal.
#### ‘:prefix-*‘
Variable arity prefix operator.
(+ 1 2 3) => (+ 1 2 3)
(+ 1 2) => (+ 1 2)
#### ‘:postfix‘
Unary postfix operator.
(1 +) => (+ 1)
### Name replacement
If you gave ‘replace-name‘ to an operator, the operator name is replaced by ‘replace-name‘ while polishing.
Example:
“‘ lisp
(poler:define-poler arithmetic
(+ :infixl 1 add)
(* :infixl 2 mul))
(macroexpand ’(arithmetic 1 + 2 * 3)) ; => (add 1 (mul 2 3))
“‘
Also, if you gave ‘operator-prefix‘ to the polish macro, the operator name is appended ‘operator-prefix‘.
Example:
“‘ lisp
(poler:define-poler arithmetic
(+ :infixl 1)
(* :infixl 2)
:operator-prefix foo-)
(macroexpand ’(arithmetic 1 + 2 * 3)) ; => (foo-+ 1 (foo-* 2 3))
“‘
### Format of form
Usually a polished form shapes such as ‘(operator operand1 operand2 ...)‘, but we can transform the form to any shape also.
The shape is specified by ‘format‘ in the operator definition.
In form ‘format‘, Symbol ‘$1‘, ‘$2‘, ... will be replaced with ‘operand1‘, ‘operand2‘, ...
Symbol ‘$whole‘ will be replaced with ‘(operand1 operand2 ...)‘.
Example:
“‘ lisp
(poler:define-poler combine-string
(+ :infix 1 (concatenate ’string . $whole))
(* :infixl 2 (apply #’concatenate ’string (make-list $2 :initial-element $1))))
(macroexpand ’(combine-string "Ha" + " ha" * 3))
; => (CONCATENATE ’STRING "Ha" (APPLY #’CONCATENATE ’STRING (MAKE-LIST 3 :INITIAL-ELEMENT " ha")))
“‘
## APIs
### Macro: ‘define-poler‘
(define-poler macro-name [operator-definition ...] &key (recursive t) decorate (operator-prefix nil))
Defines a polish macro.
The keyword parameter ‘:recursive‘ enables recursive application to nested form.
The default is ‘t‘.
“‘ lisp
(poler:define-poler foo
(+ :infixl 1)
:recursive nil)
(macroexpand ’(foo 1 + (2 + 3)))
; => (+ 1 (2 + 3))
“‘
The keyword parameter ‘:decorate‘ takes a symbol, if the symbol is non-nil, a result of the polish is decorated with the symbol.
“‘ lisp
(poler:define-poler foo
(+ :infixl 1)
:decorate quote)
(macroexpand ’(foo 1 + 2))
; => ’(+ 1 2)
; i.e. (quote (+ 1 2))
“‘
The keyword parameter ‘:operator-prefix‘ takes a symbol. See [Name replacement](#name-replacement).
“‘ lisp
(poler:define-poler foo
(+ :infixl 1)
(* :infixl 2 *)
:operator-prefix foo-)
(macroexpand ’(foo 1 + 2 * 3))
; => ’(foo-+ 1 (* 2 3))
“‘
### Macro: ‘polish‘
(polish infix-form [operator-definition ...] &key (recursive t) decorate (operator-prefix nil))
‘polish‘ macro look like ‘define-poler‘, but this macro does not define a polish macro, does polish given infix form once.
“‘ lisp
(poler:polish ’(1 + 2 * 3)
(+ :infixl 1)
(- :infixl 1)
(* :infixl 2)
(/ :infixl 2))
; => (+ 1 (* 2 3))
“‘
### Macro: ‘define-operator‘
(define-operator macro-name operator-name type precedence [replace-name | format])
‘define-operator‘ macro adds an operator into the polish macro which is named ‘macro-name‘.
If ‘type‘ is ‘nil‘, the macro removes operator ‘operator-name‘.
“‘ lisp
(poler:define-poler arithmetic
(+ :infix 1)
(* :infixl 2)
(% :infixl 3))
(poler:define-operator arithmetic - :infixl 1) ; add operator -
(poler:define-operator arithmetic + :infixl 1) ; change operator +
(poler:define-operator arithmetic % nil) ; remove operator %
“‘
## Example
“‘ lisp
(defun fact (n)
(if (< 0 n)
(* n (fact (1- n)))
1))
(poler::define-poler arithmetic
(+ :infix 1)
(- :infix 1)
(* :infix 2)
(/ :infix 2)
(% :infixl 2 mod)
(^ :infixr 3 expt)
(! :postfix 4 fact))
(arithmetic 3 ! ^ 2 / 3 - 2)
; => 10
“‘
## Installation
1. Git clone the repository into ‘~/quicklisp/local-projects/‘
2. ‘(ql:quickload :poler)‘
## Author
* carrotflakes (carrotflakes@gmail.com)
## Copyright
Copyright (c) 2015 carrotflakes (carrotflakes@gmail.com)
## License
Licensed under the LLGPL License.
0.1
src (module).
Modules are listed depth-first from the system components tree.
Files are sorted by type and then listed depth-first from the systems components trees.
poler/src/poler.lispsrc (module).
*format-parameter-prefix* (special variable).
*format-parameter-whole* (special variable).
define-operator (macro).
define-poler (macro).
make-load-form (method).
polish (macro).
print-object (method).
%%define-operator (function).
%define-operator (generic function).
*decorator* (special variable).
*operators* (special variable).
*recursive* (special variable).
apply-format (function).
apply-operator (function).
build (function).
build-tree (function).
copy-operator (function).
left-associate (function).
lookup-operator (function).
make-operator (function).
merge-part (function).
new-operator (function).
operator (structure).
operator-arity (reader).
(setf operator-arity) (writer).
operator-fix (reader).
(setf operator-fix) (writer).
operator-format (reader).
(setf operator-format) (writer).
operator-name (reader).
(setf operator-name) (writer).
operator-p (function).
operator-precedence (reader).
(setf operator-precedence) (writer).
operator-replace-name (reader).
(setf operator-replace-name) (writer).
parse-arguments (function).
part-associativity (function).
part-closed-p (function).
part-precedence (function).
part-union (function).
right-associate (function).
Packages are listed by definition order.
polercommon-lisp.
*format-parameter-prefix* (special variable).
*format-parameter-whole* (special variable).
define-operator (macro).
define-poler (macro).
polish (macro).
%%define-operator (function).
%define-operator (generic function).
*decorator* (special variable).
*operators* (special variable).
*recursive* (special variable).
apply-format (function).
apply-operator (function).
build (function).
build-tree (function).
copy-operator (function).
left-associate (function).
lookup-operator (function).
make-operator (function).
merge-part (function).
new-operator (function).
operator (structure).
operator-arity (reader).
(setf operator-arity) (writer).
operator-fix (reader).
(setf operator-fix) (writer).
operator-format (reader).
(setf operator-format) (writer).
operator-name (reader).
(setf operator-name) (writer).
operator-p (function).
operator-precedence (reader).
(setf operator-precedence) (writer).
operator-replace-name (reader).
(setf operator-replace-name) (writer).
parse-arguments (function).
part-associativity (function).
part-closed-p (function).
part-precedence (function).
part-union (function).
right-associate (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
fix.
name.
| Jump to: | %
(
A B C D F G L M N O P R |
|---|
| Jump to: | %
(
A B C D F G L M N O P R |
|---|
| Jump to: | *
A F N P R S |
|---|
| Jump to: | *
A F N P R S |
|---|
| Jump to: | F M O P S |
|---|
| Jump to: | F M O P S |
|---|