sforman
/
Thun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor cleanup.

This commit is contained in:
Simon Forman 2022-04-04 09:09:01 -07:00
parent a0374c5734
commit 68f6e210e5
1 changed files with 33 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
README
View File

@ -4,8 +4,6 @@ A Dialect of Joy.
v0.4.2 v0.4.2
§.1 Introduction
Joy is a programming language created by Manfred von Thun that is easy to Joy is a programming language created by Manfred von Thun that is easy to
use and understand and has many other nice properties. This project use and understand and has many other nice properties. This project
implements interpreters for a dialect that attempts to stay very close to implements interpreters for a dialect that attempts to stay very close to
@ -21,40 +19,44 @@ Joy and its deeper facets as well as how to program in it and several
interesting aspects. It's quite a treasure trove. interesting aspects. It's quite a treasure trove.
§.2 Installation Directory structure
From PyPI in the usual way, e.g.: Thun
|-- LICENSE - GPLv3
pip install Thun |-- README - this file
|
Or if you have downloaded the source, from the top directory: |-- archive
| |-- Joy-Programming.zip
python ./setup.py install | `-- README
|
Or you can run the package directly from the top directory. |-- docs
| |-- notebooks - Jupyter Notebooks and supporting modules
To start a crude REPL: | |-- reference - Docs for each function.
| |-- sphinx_docs - Generate https://joypy.osdn.io/ site.
python -m joy | `-- README - Table of Contents
|
There is a "quiet" mode for e.g. using joy from a shell script: `-- implementations
|-- Nim - interpreter
python -m joy -q |-- Prolog - interpreter
| type inference
This supresses the initial banner output and the prompt text. | work-in-progress compiler
|-- Python - interpreter
|-- Rust - work-in-progress interpreter
`-- defs.txt - common Joy definitions for all interpreters
§.3 Documentation Documentation
§.3.1 Jupyter Notebooks Jupyter Notebooks
The docs/ folder contains Jupyter notebooks, ... TODO The docs/notebooks dir contains Jupyter notebooks, ... TODO
§.3.2 Sphinx Docs Sphinx Docs
Some of the documentation is in the form of ReST files Some of the documentation is in the form of ReST files in
docs/sphinx_docs dir.
§.3.3 Building the Docs Building the Docs
Building the documentation is a little tricky at the moment. It involves Building the documentation is a little tricky at the moment. It involves
a makefile that uses nbconvert to generate ReST files from some of the a makefile that uses nbconvert to generate ReST files from some of the
@ -67,7 +69,7 @@ Get the dependencies for (re)building the docs:
make docs make docs
§.4 Basics of Joy Basics of Joy
Joy is stack-based. There is a main stack that holds data items: Joy is stack-based. There is a main stack that holds data items:
integers, floats, strings, functions, and sequences or quotes which hold integers, floats, strings, functions, and sequences or quotes which hold
@ -81,22 +83,8 @@ by iterating through the terms in the expression, putting all literals
onto the main stack and executing functions as they are encountered. onto the main stack and executing functions as they are encountered.
Functions receive the current stack and return the next stack. Functions receive the current stack and return the next stack.
§.4.1 Python Semantics
In general, where otherwise unspecified, the semantics of Thun are that Literals and Simple Functions
of the underlying Python. That means, for example, that integers are
unbounded (whatever your machine can handle), strings cannot be added to
integers but can be multiplied, Boolean True and False are effectively
identical to ints 1 and 0, empty sequences are considered False, etc.
Nothing is done about Python exceptions currently, although it would be
possible to capture the stack and expression just before the exception
and build a robust and flexible error handler. Because they are both
just datastructures, you could immediately retry them under a debugger,
or edit either or both of the stack and expression. All state is in one
or the other.
§.4.2 Literals and Simple Functions
joy? 1 2 3 joy? 1 2 3
. 1 2 3 . 1 2 3
@ -123,7 +111,7 @@ or the other.
joy? joy?
§.4.3 Combinators Combinators
The main loop is very simple as most of the action happens through what The main loop is very simple as most of the action happens through what
are called "combinators": functions which accept quoted programs on the are called "combinators": functions which accept quoted programs on the
@ -153,41 +141,6 @@ TODO:
§.4.6 Refactoring §.4.6 Refactoring
§.5 This Implementation
Run with:
python -m joy
Thun
|-- COPYING - license
|-- README - this file
|
|-- archive - info on Joy
| |-- Joy-Programming.zip
| `-- README
|
|-- docs - Various Examples and Demos
| |-- * - Jupyter Notebooks on Thun and supporting modules
| `-- README - Table of Contents
|
|-- joy
| |-- joy.py - main loop, REPL
| |-- library.py - Functions, Combinators, Definitions
| |-- parser.py - convert text to Joy datastructures
| |
| `-- utils
| |-- pretty_print.py - convert Joy datastructures to text
| `-- stack.py - work with stacks
|
|-- thun - Experimental Prolog Code
| |-- compiler.pl - A start on a compiler for Prof. Wirth's RISC CPU
| `-- thun.pl - An interpreter in the Logical Paradigm, compiler.
|
`-- setup.py
§.6 References & Further Reading §.6 References & Further Reading