The burgled-batteries.syntax Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The burgled-batteries.syntax Reference Manual

This is the burgled-batteries.syntax Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 07:45:43 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

burgled-batteries.syntax

Quicklisp MIT License

This library provides Embedded Python syntax for burgled-batteries

To enable the syntax:

(python.syntax:enable-python-syntax)

Python syntax is enclosed between brackets. The embedded syntax is very similar to Python's syntax, with some differences:

Example:

   (let (($url "http://pinterface.livejournal.com/data/atom"))
       [^feedparser.parse($url)])

Some examples:

(import :feedparser)
[^feedparser.parse('http://pinterface.livejournal.com/data/atom')]
; => #<HASH-TABLE>

To explore what is happening behind the scenes, quote the Python expression:

PYTHON> '[^.feedparser.parse('http://pinterface.livejournal.com/data/atom')]
(LET ((#:TRANSFORMED2520
       (CFFI:CONVERT-FROM-FOREIGN
        (CALL* (REF* "feedparser") "parse"
               (STRING.FROM-STRING*
                "http://pinterface.livejournal.com/data/atom"))
        'PYTHON.CFFI::OBJECT!)))
  #:TRANSFORMED2520)

Bigger example:

PYTHON> (let (($cal [icalendar.Calendar()]))
  [$cal.add('prodid', '-//My calendar product//mxm.dk//')]
  (let (($event [icalendar.Event()]))
    [$event.add('summary', 'Python meeting about calendaring')]
    [$event.add('dtstart', datetime.datetime(2005,4,4,8,0,0))]
    [$event.add('dtend', datetime.datetime(2005,4,4,10,0,0))]
    [$event.add('dtstamp', datetime.datetime(2005,4,4,0,10,0))]
    (let (($organizer [icalendar.vCalAddress('MAILTO: noone@example.com')]))
      [$organizer.params['cn'] = icalendar.vText('Max Rasmussen')]
      [$organizer.params['role'] = icalendar.vText('CHAIR')]
      [$event['organizer'] = $organizer]
      [$event['location'] = icalendar.vText('Odense, Denmark')]

      [$event['uid'] = '20050115T101010/27346262376@mxm.dk']
      [$event.add('priority', 5)]

      (let (($attendee [icalendar.vCalAddress('MAILTO:maxm@example.com')]))
         [$attendee.params['cn'] = icalendar.vText('Max Rasmussen')]
         [$attendee.params['ROLE'] = icalendar.vText('REQ-PARTICIPANT')]
         [$event.add('attendee', $attendee, encode=0)])

      (let (($attendee [icalendar.vCalAddress('MAILTO:the-dude@example.com')]))
         [$attendee.params['cn'] = icalendar.vText('The Dude')]
         [$attendee.params['ROLE'] = icalendar.vText('REQ-PARTICIPANT')]
         [$event.add('attendee', $attendee, encode=0)])

      [$cal.add_component($event)]
      [^$cal.to_ical()])))
=>

"BEGIN:VCALENDAR
PRODID:-//My calendar product//mxm.dk//
BEGIN:VEVENT
SUMMARY:Python meeting about calendaring
DTSTART;VALUE=DATE-TIME:20050404T080000
DTEND;VALUE=DATE-TIME:20050404T100000
DTSTAMP;VALUE=DATE-TIME:20050404T001000Z
UID:20050115T101010/27346262376@mxm.dk
LOCATION:Odense\\, Denmark
MAILTO:MAXM@EXAMPLE.COM:attendee
MAILTO:THE-DUDE@EXAMPLE.COM:attendee
ORGANIZER;CN=\"Max Rasmussen\";ROLE=CHAIR:MAILTO: noone@example.com
PRIORITY:5
END:VEVENT
END:VCALENDAR"

For more examples, checkout the syntax tests or this blog post.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 burgled-batteries.syntax

Author

Mariano Montone

License

MIT

Description

Embedded Python syntax for burgled-batteries

Dependencies
Source

burgled-batteries.syntax.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 burgled-batteries.syntax.asd

Location

burgled-batteries.syntax.asd

Systems

burgled-batteries.syntax (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 burgled-batteries.syntax/package.lisp

Parent

burgled-batteries.syntax (system)

Location

package.lisp

Packages

burgled-batteries.syntax


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 burgled-batteries.syntax/syntax.lisp

Dependency

package.lisp (file)

Parent

burgled-batteries.syntax (system)

Location

syntax.lisp

Exported Definitions

enable-python-syntax (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 burgled-batteries.syntax

Source

package.lisp (file)

Nickname

python.syntax

Use List
Exported Definitions

enable-python-syntax (function)

Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: enable-python-syntax ()
Package

burgled-batteries.syntax

Source

syntax.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *lisp-reference-prefix*
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Special Variable: *transform-character*
Package

burgled-batteries.syntax

Source

syntax.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: push-last THING LIST
Package

burgled-batteries.syntax

Source

syntax.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: call OBJECT METHOD &rest ARGS
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: call* OBJECT METHOD &rest ARGS
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: call-with-split-args ARGS BODY
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: compile-expression EXPRESSION
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: compile-python STRING
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: is-false X
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: is-none X
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: is-true X
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: not-doublequote CHAR
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: parse-python STRING
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: py-slot-value OBJECT SLOT
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: ref NAME
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: ref* NAME
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: run-python INPUT
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: send METHOD OBJECT &rest ARGS
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: send* METHOD OBJECT &rest ARGS
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Function: split-args ARGS
Package

burgled-batteries.syntax

Source

syntax.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Generic functions

Generic Function: compile-expression% EXPRESSION-TYPE EXPRESSION
Package

burgled-batteries.syntax

Source

syntax.lisp (file)

Methods
Method: compile-expression% (TYPE (eql lisp-expression)) EXPRESSION
Method: compile-expression% (TYPE (eql transform)) EXPRESSION
Method: compile-expression% (TYPE (eql assignment)) EXPRESSION
Method: compile-expression% (TYPE (eql index-access)) EXPRESSION
Method: compile-expression% (TYPE (eql property-access)) EXPRESSION
Method: compile-expression% (TYPE (eql method-call)) EXPRESSION
Method: compile-expression% (TYPE (eql function-call)) EXPRESSION
Method: compile-expression% (TYPE (eql lisp-reference)) EXPRESSION
Method: compile-expression% (TYPE (eql python-reference)) EXPRESSION
Method: compile-expression% (TYPE (eql literal-dictionary)) EXPRESSION
Method: compile-expression% (TYPE (eql literal-list)) EXPRESSION
Method: compile-expression% (TYPE (eql literal-float)) EXPRESSION
Method: compile-expression% (TYPE (eql literal-long)) EXPRESSION
Method: compile-expression% (TYPE (eql literal-integer)) EXPRESSION
Method: compile-expression% (TYPE (eql literal-string)) EXPRESSION
Method: compile-expression% (TYPE (eql literal-none)) EXPRESSION
Method: compile-expression% (TYPE (eql literal-boolean)) EXPRESSION

Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   B   F   L  
Index Entry  Section

B
burgled-batteries.syntax.asd: The burgled-batteries<dot>syntax<dot>asd file
burgled-batteries.syntax/package.lisp: The burgled-batteries<dot>syntax/package<dot>lisp file
burgled-batteries.syntax/syntax.lisp: The burgled-batteries<dot>syntax/syntax<dot>lisp file

F
File, Lisp, burgled-batteries.syntax.asd: The burgled-batteries<dot>syntax<dot>asd file
File, Lisp, burgled-batteries.syntax/package.lisp: The burgled-batteries<dot>syntax/package<dot>lisp file
File, Lisp, burgled-batteries.syntax/syntax.lisp: The burgled-batteries<dot>syntax/syntax<dot>lisp file

L
Lisp File, burgled-batteries.syntax.asd: The burgled-batteries<dot>syntax<dot>asd file
Lisp File, burgled-batteries.syntax/package.lisp: The burgled-batteries<dot>syntax/package<dot>lisp file
Lisp File, burgled-batteries.syntax/syntax.lisp: The burgled-batteries<dot>syntax/syntax<dot>lisp file

Jump to:   B   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   C   E   F   G   I   M   N   P   R   S  
Index Entry  Section

C
call: Internal functions
call*: Internal functions
call-with-split-args: Internal functions
compile-expression: Internal functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-expression%: Internal generic functions
compile-python: Internal functions

E
enable-python-syntax: Exported functions

F
Function, call: Internal functions
Function, call*: Internal functions
Function, call-with-split-args: Internal functions
Function, compile-expression: Internal functions
Function, compile-python: Internal functions
Function, enable-python-syntax: Exported functions
Function, is-false: Internal functions
Function, is-none: Internal functions
Function, is-true: Internal functions
Function, not-doublequote: Internal functions
Function, parse-python: Internal functions
Function, py-slot-value: Internal functions
Function, ref: Internal functions
Function, ref*: Internal functions
Function, run-python: Internal functions
Function, send: Internal functions
Function, send*: Internal functions
Function, split-args: Internal functions

G
Generic Function, compile-expression%: Internal generic functions

I
is-false: Internal functions
is-none: Internal functions
is-true: Internal functions

M
Macro, push-last: Internal macros
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions
Method, compile-expression%: Internal generic functions

N
not-doublequote: Internal functions

P
parse-python: Internal functions
push-last: Internal macros
py-slot-value: Internal functions

R
ref: Internal functions
ref*: Internal functions
run-python: Internal functions

S
send: Internal functions
send*: Internal functions
split-args: Internal functions

Jump to:   C   E   F   G   I   M   N   P   R   S  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*lisp-reference-prefix*: Internal special variables
*transform-character*: Internal special variables

S
Special Variable, *lisp-reference-prefix*: Internal special variables
Special Variable, *transform-character*: Internal special variables

Jump to:   *  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   P   S  
Index Entry  Section

B
burgled-batteries.syntax: The burgled-batteries<dot>syntax system
burgled-batteries.syntax: The burgled-batteries<dot>syntax package

P
Package, burgled-batteries.syntax: The burgled-batteries<dot>syntax package

S
System, burgled-batteries.syntax: The burgled-batteries<dot>syntax system

Jump to:   B   P   S