The projectured Reference Manual

Table of Contents

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

The projectured Reference Manual

This is the projectured Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 15:32:20 2018 GMT+0.


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

1 Introduction

My image

Description

ProjecturEd is a general purpose projectional editor written in Common Lisp.

It supports the integrated presentation and editing of arbitrary problem domains. These domains potentially include but not limited to: word processing, spreadsheets, markup languages, programming langueges, modelling, graphs, graphics, etc. and any combination of them. The edited data is represented in their natural, domain specific data structures (as opposed to a flat string of characters), which accommodates for the implementation of many interesting, but yet to be explored features of structured editing.

It also supports multiple projections of the same data, and thus it can simultaneously provide different notations, potentially all of them editable. These views can be textual, fully graphical, or in between, and because of the internal architecture of the editor, the various projections combine well. It is expected that users would not only add new documents, but also new projections as needed.

Running the Editor

The easiest way to run the editor is to install it using Quicklisp.

1. Get a reasonably fresh SBCL

For example, on Debian Stretch:

sudo apt-get install sbcl rlwrap git libsdl2-2.0-0 libsdl2-image-2.0-0 libsdl2-ttf-2.0-0

Otherwise visit the SBCL website for instructions, and make sure you have the right version of libSDL2 libraries installed for the SDL backend.

2. Install Quicklisp

Once you have SBCL installed, you can continue with installing Quicklisp:

cd ~
wget http://beta.quicklisp.org/quicklisp.lisp

sbcl --load quicklisp.lisp --eval "(quicklisp-quickstart:install)" --eval "(ql:add-to-init-file)" --eval "(exit)"

To finish the installation of Quicklisp approve the prompted question.

3. Get ProjecturEd

Get the latest from git (recommended)

If you want to play with the latest (and potentially less stable) version of ProjecturEd:

cd ~/quicklisp/local-projects/
git clone https://github.com/projectured/projectured.git

Or get it from Quicklisp

sbcl --eval "(ql-dist:ensure-installed (ql-dist:find-system :projectured.executable))" --eval "(exit)"

4. Build a standalone executable of ProjecturEd

Depending on how you got ProjecturEd, run one of the following shell scripts:

~/quicklisp/local-projects/projectured/bin/build.sh

Or:

sh ~/quicklisp/dists/quicklisp/software/projectured*/bin/build.sh

Note: The build log will be saved next to the build.sh script.

5. Run the editor executable

After the build has been completed you can run the editor from the command line with:

cd ~/quicklisp/local-projects/projectured/
bin/projectured -h

There are a few small example documents that you can promptly start editing:

cd ~/quicklisp/local-projects/projectured/
bin/projectured example/contact-list.json

Alternatively, you can run the editor by loading the project in your lisp. This allows experimentation with the code, changing this and that. Start SBCL with rlwrap sbcl, and copy these into its REPL:

(ql:quickload :projectured.executable)
(projectured::executable-toplevel)

If everything went fine, then you should see a window presenting an empty generic document.

(ql:quickload :projectured.executable)
(projectured::executable-toplevel "~/quicklisp/local-projects/projectured/example/contact-list.json")

This last example will show a window presenting an example JSON document. You can always press Control + H to get context sensitive help in the editor.

Run some of the tests

Start SBCL with rlwrap sbcl, and copy these into its REPL:

(ql:quickload :projectured.sdl.test)
(projectured.test::test)

This will run the automated test suite and print the result in the REPL.

Troubleshooting

Isolate locally installed libraries

If you have some Common Lisp libraries installed somewhere on your system, then try to make sure that nothing besides what's in quicklisp gets loaded. You can achieve that by adding the following to the beginning of your .sbclrc:

(require :asdf)
(funcall (read-from-string "asdf:initialize-source-registry")
         '(:source-registry :ignore-inherited-configuration))

Too old ASDF

If you get ASDF realted errors then try to clone the latest ASDF release:

cd ~/quicklisp/local-projects/
git clone https://gitlab.common-lisp.net/asdf/asdf.git --branch release

Loading without building an executable

(ql:quickload '(:projectured.executable :hu.dwim.def+swank))
(projectured::executable-toplevel)

Collaboration

It's an unfunded opensource project, under much slower development than we would like it to be. If you want to help us, either financially or with your patches, then feel free to get in touch at projectured@gmail.com or the google group.

Donation

The less we need to work to pay our bills, the more we can work on ProjecturEd. Bitcoin donations are welcome to the following address: 15XjRQUnSy8U7j2EFZyGFAi2KFnDnTEwqZ

Wiki

There's a separate wiki with an increasing number of pages. It gives an overview of the whole idea, and it also allows contributing documentation to the project.

Documentation

Currently the best thing to do is to look at the source code. Luckily the codebase is relatively small (around 20k LoC).

Check out the latest version

If you want to try the latest version, then you should git clone the repository into ~/quicklisp/local-projects/ and Quicklisp will automatically use that version instead of the snapshot from its archives.

Status

ProjecturEd is work in progress, and at this stage it's interesting primarily for programmers who are ready to experiment with it.

Screenshots

If you would like to take a look at the editor in action, then look at this page. It contains a couple of screenshots showing various problem domains using different projections. Please note that these screenshots are somewhat outdated.

Videos

There are some screencasts on youtube that shows the editor in action and demonstrate certain features.

Performance

The printer and the reader are written using a "purely functional" constraint based change propagation algorithm that allows lazy and incremental computation of results. So, the infrastructure is in place to be fast enough to be useful one day...

License

BSD License

Happy hacking!


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

2 Systems

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


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

2.1 projectured.document

Author

Levente Mészáros

License

BSD or Bugroff

Description

Collection of various documents.

Defsystem Dependency

hu.dwim.asdf

Dependencies
Source

projectured.document.asd (file)

Component

source (module)


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

2.2 projectured.editor

Author

Levente Mészáros

License

BSD or Bugroff

Description

Editor core components.

Defsystem Dependency

hu.dwim.asdf

Dependencies
Source

projectured.editor.asd (file)

Component

source (module)


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

3 Modules

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


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

3.1 projectured.document/source

Parent

projectured.document (system)

Location

source/

Component

document (module)


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

3.2 projectured.document/source/document

Parent

source (module)

Location

source/document/

Components

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

3.3 projectured.editor/source

Parent

projectured.editor (system)

Location

source/

Components

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

3.4 projectured.editor/source/util

Dependency

package.lisp (file)

Parent

source (module)

Location

source/util/

Components

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

3.5 projectured.editor/source/editor

Dependency

util (module)

Parent

source (module)

Location

source/editor/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 projectured.document.asd

Location

projectured.document.asd

Systems

projectured.document (system)


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

4.1.2 projectured.editor.asd

Location

projectured.editor.asd

Systems

projectured.editor (system)


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

4.1.3 projectured.document/source/document/book.lisp

Dependency

sequence.lisp (file)

Parent

document (module)

Location

source/document/book.lisp

Internal Definitions

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

4.1.4 projectured.document/source/document/color.lisp

Parent

document (module)

Location

source/document/color.lisp

Internal Definitions

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

4.1.5 projectured.document/source/document/common-lisp.lisp

Dependency

lisp-form.lisp (file)

Parent

document (module)

Location

source/document/common-lisp.lisp

Internal Definitions

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

4.1.6 projectured.document/source/document/document.lisp

Parent

document (module)

Location

source/document/document.lisp

Internal Definitions

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

4.1.7 projectured.document/source/document/evaluator.lisp

Dependency

sequence.lisp (file)

Parent

document (module)

Location

source/document/evaluator.lisp

Internal Definitions

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

4.1.8 projectured.document/source/document/font.lisp

Parent

document (module)

Location

source/document/font.lisp

Internal Definitions

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

4.1.9 projectured.document/source/document/graphics.lisp

Parent

document (module)

Location

source/document/graphics.lisp

Internal Definitions

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

4.1.10 projectured.document/source/document/help.lisp

Parent

document (module)

Location

source/document/help.lisp

Internal Definitions

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

4.1.11 projectured.document/source/document/image.lisp

Parent

document (module)

Location

source/document/image.lisp

Internal Definitions

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

4.1.12 projectured.document/source/document/json.lisp

Dependency

sequence.lisp (file)

Parent

document (module)

Location

source/document/json.lisp

Internal Definitions

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

4.1.13 projectured.document/source/document/lisp-form.lisp

Parent

document (module)

Location

source/document/lisp-form.lisp

Internal Definitions

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

4.1.14 projectured.document/source/document/number.lisp

Parent

document (module)

Location

source/document/number.lisp

Internal Definitions

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

4.1.15 projectured.document/source/document/output.lisp

Parent

document (module)

Location

source/document/output.lisp

Internal Definitions

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

4.1.16 projectured.document/source/document/searching.lisp

Parent

document (module)

Location

source/document/searching.lisp

Internal Definitions

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

4.1.17 projectured.document/source/document/sequence.lisp

Parent

document (module)

Location

source/document/sequence.lisp

Internal Definitions

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

4.1.18 projectured.document/source/document/string.lisp

Parent

document (module)

Location

source/document/string.lisp

Internal Definitions

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

4.1.19 projectured.document/source/document/t.lisp

Parent

document (module)

Location

source/document/t.lisp

Internal Definitions

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

4.1.20 projectured.document/source/document/text.lisp

Parent

document (module)

Location

source/document/text.lisp

Internal Definitions

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

4.1.21 projectured.document/source/document/tree.lisp

Parent

document (module)

Location

source/document/tree.lisp

Internal Definitions

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

4.1.22 projectured.document/source/document/widget.lisp

Parent

document (module)

Location

source/document/widget.lisp

Internal Definitions

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

4.1.23 projectured.document/source/document/xml.lisp

Dependency

sequence.lisp (file)

Parent

document (module)

Location

source/document/xml.lisp

Internal Definitions

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

4.1.24 projectured.document/source/document/versioning.lisp

Parent

document (module)

Location

source/document/versioning.lisp

Internal Definitions

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

4.1.25 projectured.editor/source/package.lisp

Parent

source (module)

Location

source/package.lisp

Packages

projectured


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

4.1.26 projectured.editor/source/util/computed.lisp

Dependency

util.lisp (file)

Parent

util (module)

Location

source/util/computed.lisp

Internal Definitions

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

4.1.27 projectured.editor/source/util/logger.lisp

Parent

util (module)

Location

source/util/logger.lisp

Internal Definitions

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

4.1.28 projectured.editor/source/util/util.lisp

Parent

util (module)

Location

source/util/util.lisp

Internal Definitions

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

4.1.29 projectured.editor/source/editor/backend.lisp

Parent

editor (module)

Location

source/editor/backend.lisp

Internal Definitions

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

4.1.30 projectured.editor/source/editor/command.lisp

Parent

editor (module)

Location

source/editor/command.lisp

Internal Definitions

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

4.1.31 projectured.editor/source/editor/device.lisp

Parent

editor (module)

Location

source/editor/device.lisp

Internal Definitions

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

4.1.32 projectured.editor/source/editor/document.lisp

Parent

editor (module)

Location

source/editor/document.lisp

Internal Definitions

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

4.1.33 projectured.editor/source/editor/editor.lisp

Dependencies
Parent

editor (module)

Location

source/editor/editor.lisp

Internal Definitions

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

4.1.34 projectured.editor/source/editor/event.lisp

Parent

editor (module)

Location

source/editor/event.lisp

Internal Definitions

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

4.1.35 projectured.editor/source/editor/gesture.lisp

Dependency

event.lisp (file)

Parent

editor (module)

Location

source/editor/gesture.lisp

Internal Definitions

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

4.1.36 projectured.editor/source/editor/iomap.lisp

Parent

editor (module)

Location

source/editor/iomap.lisp

Internal Definitions

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

4.1.37 projectured.editor/source/editor/loader.lisp

Parent

editor (module)

Location

source/editor/loader.lisp

Internal Definitions

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

4.1.38 projectured.editor/source/editor/maker.lisp

Parent

editor (module)

Location

source/editor/maker.lisp

Internal Definitions

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

4.1.39 projectured.editor/source/editor/mapper.lisp

Parent

editor (module)

Location

source/editor/mapper.lisp

Internal Definitions

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

4.1.40 projectured.editor/source/editor/operation.lisp

Parent

editor (module)

Location

source/editor/operation.lisp

Internal Definitions

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

4.1.41 projectured.editor/source/editor/printer.lisp

Parent

editor (module)

Location

source/editor/printer.lisp

Internal Definitions

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

4.1.42 projectured.editor/source/editor/projection.lisp

Parent

editor (module)

Location

source/editor/projection.lisp

Internal Definitions

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

4.1.43 projectured.editor/source/editor/reader.lisp

Parent

editor (module)

Location

source/editor/reader.lisp

Internal Definitions

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

4.1.44 projectured.editor/source/editor/reference.lisp

Parent

editor (module)

Location

source/editor/reference.lisp

Internal Definitions

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

4.1.45 projectured.editor/source/editor/saver.lisp

Parent

editor (module)

Location

source/editor/saver.lisp

Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 projectured

Source

package.lisp (file)

Use List
Internal Definitions