baum

annotate baum.1 @ 49:00de718c8590

find changesets by author, revision, files, or words in the commit message
Added tag 0.3 for changeset f9fc4c4f9e3d666dad2bd1efa627fb646334433c
author meillo@marmaro.de
date Sun, 02 Mar 2008 13:35:42 +0100
parents 0b82169d4129
children 7d7abe88e71b
rev   line source
meillo@37 1 .TH baum 1 "2008-03-01" "baum 0.3"
meillo@18 2 .SH NAME
meillo@18 3 baum \- an esoteric programming language
meillo@18 4
meillo@18 5
meillo@18 6
meillo@18 7 .SH SYNOPSIS
meillo@18 8 .B baum
meillo@31 9 [\-v]\ <file>
meillo@18 10
meillo@18 11
meillo@18 12
meillo@18 13 .SH DESCRIPTION
meillo@18 14 .B baum
meillo@18 15 is an interpreter for the baum programming language which is an experiment to create an esoteric programming language.
meillo@18 16
meillo@18 17 Source code is a representation of a tree in which every node is a command or data.
meillo@18 18
meillo@18 19 baum is only an experiment and the functionality is (currently) very restricted.
meillo@18 20
meillo@18 21
meillo@18 22
meillo@18 23
meillo@18 24 .SH OPTIONS
meillo@18 25
meillo@18 26 .TP
meillo@18 27 .BI \-v
meillo@42 28 Verbose output (All verbose output goes to stderr)
meillo@18 29
meillo@18 30 .TP
meillo@18 31 .BI \-\-help
meillo@18 32 Print usage information
meillo@18 33
meillo@18 34 .TP
meillo@18 35 .BI \-\-version
meillo@18 36 Print version information
meillo@18 37
meillo@18 38
meillo@18 39
meillo@18 40
meillo@18 41
meillo@18 42
meillo@48 43 .SH CONCEPT
meillo@48 44
meillo@48 45 baum programs are represented as nodes in a tree structure. Nodes are of specific kind and contain a value.
meillo@48 46
meillo@48 47 The tree is processed recursive starting at the root node. Every node controls it's sons and should only know them; while most nodes only use their leftmost son.
meillo@48 48
meillo@48 49 Each node returns a value to it's parent. (The root node returns an exit code to the shell.) The internal value of the node could be used in any useful way, but only inside the node.
meillo@48 50
meillo@48 51 All values in the language (return values, expected return values and in-node values) should be of the same type, so that every combination of nodes is possible.
meillo@48 52
meillo@48 53 Nodes can modify the tree, but should do this only on it's brothers or better only through it's rightmost brother.
meillo@48 54
meillo@48 55
meillo@48 56
meillo@18 57 .SH SOURCE CODE
meillo@18 58
meillo@18 59 Source code are plain text files with one node per line representing the tree. The indention controls in which level in the tree the node is. Indention can be made with SPACE or with TAB characters. Every character means one level.
meillo@18 60
meillo@18 61 Empty lines and everything vom the hash symbol (`#') to the end of the line is ignored.
meillo@18 62
meillo@37 63 .B An example that echoes (and returns) `42':
meillo@18 64
meillo@18 65 .nf
meillo@18 66 # comment
meillo@18 67 print(0)
meillo@18 68 sum(0) #comment
meillo@18 69 number(40)
meillo@18 70 number(2)
meillo@18 71 .fi
meillo@18 72
meillo@18 73
meillo@48 74 .SH NODES
meillo@18 75
meillo@48 76 .TP
meillo@48 77 .B input
meillo@48 78 Reads a number from standard input which is treated as ASCII value. It inserts a number node with this value as last brother. Returns 0 always.
meillo@18 79
meillo@48 80 .TP
meillo@48 81 .B number
meillo@48 82 Executes it's leftmost son. Returns the internal value.
meillo@18 83
meillo@48 84 .TP
meillo@48 85 .B print
meillo@48 86 Prints the return value of it's leftmost son. Ether as char (if the internal value is 99), or as number otherwise. Returns the return value of the leftmost son (passes through).
meillo@18 87
meillo@48 88 .TP
meillo@48 89 .B sum
meillo@48 90 Executes all of it's sons. Returns the sum of their return values.
meillo@18 91
meillo@48 92 .TP
meillo@48 93 .B times
meillo@48 94 Copies everything below the node and pastes it as last brother(s). Returns 0 always.
meillo@18 95
meillo@48 96
meillo@48 97
meillo@48 98
meillo@18 99
meillo@18 100
meillo@18 101 .SH ERRORS
meillo@18 102
meillo@43 103 You have to keep in mind, that valid programs that run successful can return exit codes different from zero too! Each program returns the return value of the root node to the shell. If you don't want your program doing this, just set a `number(0)' node as root, and put everything else below.
meillo@43 104
meillo@18 105 .TP
meillo@18 106 .BI 1
meillo@18 107 common error
meillo@18 108
meillo@18 109 .TP
meillo@18 110 .BI 3
meillo@18 111 no or more than one source file given
meillo@18 112
meillo@18 113 .TP
meillo@18 114 .BI 4
meillo@18 115 invalid node
meillo@18 116
meillo@18 117 .TP
meillo@31 118 .BI 5
meillo@31 119 indention over more than one level
meillo@31 120
meillo@31 121 .TP
meillo@33 122 .BI 6
meillo@33 123 node name too long, or no value given
meillo@33 124
meillo@33 125 .TP
meillo@42 126 .BI 126
meillo@18 127 invalid command line options
meillo@18 128
meillo@18 129
meillo@18 130
meillo@18 131 .SH BUGS
meillo@18 132 Please report if you find some.
meillo@18 133
meillo@18 134
meillo@18 135 .SH CREDITS
meillo@18 136 Ju developed the idea of
meillo@18 137 .B baum
meillo@18 138 with me in a conversation. Actually it was his idea to use the tree as basic structure.
meillo@18 139
meillo@18 140
meillo@18 141
meillo@18 142 .SH AUTHOR
meillo@18 143 markus schnalke <meillo@marmaro.de> and julian forster