Skip to content

Commit b237c1b

Browse files
braindigitalisbraindigitalis
committed
docs rejig
1 parent 95f8880 commit b237c1b

File tree

531 files changed

+3003
-2356
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

531 files changed

+3003
-2356
lines changed

‎docpages/basic-language-reference/INDEX.md‎

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,37 @@
11
\page basic-ref BASIC Language Reference
22

3-
*Creating BASIC programs*
3+
## Creating BASIC programs
44

5-
Programs in Retro Rocket are simialar in strucuture to any other BASIC program. Unlike many dialects of BASIC, lines do not have to be numbered, but if they are each number must be greater than the line number before it. It is possible to have gaps in the numbering.
5+
Programs in Retro Rocket BASIC are similar in structure to other BASIC dialects, with some important differences:
66

7-
It is strongly recommended to not specify the numbers for lines in your program. Any program who's first character is not a digit (0-9) will be assumed to not have line numbers.
7+
* **Line numbers are optional.**
88

9-
The program will execute moving from one line to the next, and each line must have at least one statement, and any parameters required for that statement (see the statements section of this page).
9+
* If used, each must be greater than the one before it.
10+
* Gaps in numbering are allowed.
11+
* If the first character of the file is not a digit (`0–9`), the program is assumed to have **no line numbers**.
1012

11-
Variables may be declared, of the four types listed in the section on \ref variables. For each of these variables, they may remain local to the current program or be inherited by other programs ran by the current program.
13+
* **Sequential execution.**
14+
Programs execute line by line, top to bottom, unless redirected with control statements (e.g. `GOTO`, `IF`, `PROC`, `FUNCTION`).
1215

13-
For an example of programs in the operating system see the [/os/programs](https://github.com/brainboxdotcc/retro-rocket/tree/master/os/programs) directory.
16+
* **Statements.**
17+
Each line must contain at least one valid statement, with any required parameters.
1418

15-
* \subpage basic-beginner Beginners' Guide
16-
* \subpage variables Variable Types
17-
* \subpage keywords BASIC Keywords
18-
* \subpage builtin-functions Built-In Functions
19-
* \subpage libraries Libraries
20-
* \subpage tasks BASIC Tasks
21-
* \subpage basic-intdev Interpreter Development Guide
19+
* **Variables.**
20+
Four types of variables are available (see \ref variables). Variables may be:
21+
22+
* **Local** to the current program, or
23+
* **Inherited** by other programs run with `CHAIN` or similar mechanisms.
24+
25+
For real-world examples of programs in the operating system, see the [os/programs](https://github.com/brainboxdotcc/retro-rocket/tree/master/os/programs) directory in the source tree.
26+
27+
---
28+
29+
## Further Reference
30+
31+
* \subpage basic-beginner **Beginners’ Guide**
32+
* \subpage variables **Variable Types**
33+
* \subpage keywords **BASIC Keywords**
34+
* \subpage builtin-functions **Built-In Functions**
35+
* \subpage libraries **Libraries**
36+
* \subpage tasks **BASIC Tasks**
37+
* \subpage basic-intdev **Interpreter Development Guide**

‎docpages/basic-language-reference/functions/01_INDEX.md‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
\page builtin-functions Built-In Functions
22

3-
- \subpage int-funcs
4-
- \subpage real-funcs
5-
- \subpage string-funcs
3+
Retro Rocket BASIC provides a set of built-in functions, grouped by the type of value they operate on or return.
4+
5+
---
6+
7+
### Function Categories
8+
9+
* \subpage int-funcs – Functions that operate on or return integers
10+
* \subpage real-funcs – Functions that operate on or return real (floating-point) values
11+
* \subpage string-funcs – Functions that operate on or return strings

‎docpages/basic-language-reference/functions/integer/02_INDEX.md‎

Lines changed: 73 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,75 @@
11
\page int-funcs Integer Functions
22

3-
- \subpage ABS
4-
- \subpage ASC
5-
- \subpage CPUID
6-
- \subpage CURRENTX
7-
- \subpage CURRENTY
8-
- \subpage DAY
9-
- \subpage EOF
10-
- \subpage EXISTSVARI
11-
- \subpage GETNAMECOUNT
12-
- \subpage GETPROCCOUNT
13-
- \subpage GETPROCCPUID
14-
- \subpage GETPROCID
15-
- \subpage GETPROCMEM
16-
- \subpage GETPROCPARENT
17-
- \subpage GETSIZE
18-
- \subpage GETVARI
19-
- \subpage HEXVAL
20-
- \subpage HOUR
21-
- \subpage INPORTD
22-
- \subpage INPORT
23-
- \subpage INPORTQ
24-
- \subpage INPORTW
25-
- \subpage INSTR
26-
- \subpage INT
27-
- \subpage LCPUID
28-
- \subpage LEN
29-
- \subpage LGETLASTCPUID
30-
- \subpage MEMFREE
31-
- \subpage MEMORY
32-
- \subpage MEMPEAK
33-
- \subpage MEMPROGRAM
34-
- \subpage MEMUSED
35-
- \subpage MINUTE
36-
- \subpage MONTH
37-
- \subpage OCTVAL
38-
- \subpage OPENIN
39-
- \subpage OPENOUT
40-
- \subpage OPENUP
41-
- \subpage PEEKD
42-
- \subpage PEEK
43-
- \subpage PEEKQ
44-
- \subpage PEEKW
45-
- \subpage RADIX
46-
- \subpage IREAD
47-
- \subpage RGB
48-
- \subpage RND
49-
- \subpage SECOND
50-
- \subpage SGN
51-
- \subpage SHL
52-
- \subpage SHR
53-
- \subpage SOCKACCEPT
54-
- \subpage SOCKLISTEN
55-
- \subpage SOCKSTATUS
56-
- \subpage TERMHEIGHT
57-
- \subpage TERMWIDTH
58-
- \subpage UDPLASTSOURCEPORT
59-
- \subpage VAL
60-
- \subpage WEEKDAY
61-
- \subpage YDAY
62-
- \subpage YEAR
3+
The following functions operate on or return **integer values** in Retro Rocket BASIC.
4+
5+
* \subpage ABS
6+
* \subpage ASC
7+
* \subpage BITAND
8+
* \subpage BITEOR
9+
* \subpage BITNAND
10+
* \subpage BITNOR
11+
* \subpage BITNOT
12+
* \subpage BITOR
13+
* \subpage BITROL
14+
* \subpage BITROR
15+
* \subpage BITSHL
16+
* \subpage BITSHR
17+
* \subpage BITXNOR
18+
* \subpage CPUID
19+
* \subpage CURRENTX
20+
* \subpage CURRENTY
21+
* \subpage DAY
22+
* \subpage EOF
23+
* \subpage EXISTSVARI
24+
* \subpage GETNAMECOUNT
25+
* \subpage GETPROCCOUNT
26+
* \subpage GETPROCCPUID
27+
* \subpage GETPROCID
28+
* \subpage GETPROCMEM
29+
* \subpage GETPROCPARENT
30+
* \subpage GETSIZE
31+
* \subpage GETVARI
32+
* \subpage HEXVAL
33+
* \subpage HOUR
34+
* \subpage INPORTD
35+
* \subpage INPORT
36+
* \subpage INPORTQ
37+
* \subpage INPORTW
38+
* \subpage INSTR
39+
* \subpage INT
40+
* \subpage LCPUID
41+
* \subpage LEN
42+
* \subpage LGETLASTCPUID
43+
* \subpage MEMFREE
44+
* \subpage MEMORY
45+
* \subpage MEMPEAK
46+
* \subpage MEMPROGRAM
47+
* \subpage MEMUSED
48+
* \subpage MINUTE
49+
* \subpage MONTH
50+
* \subpage OCTVAL
51+
* \subpage OPENIN
52+
* \subpage OPENOUT
53+
* \subpage OPENUP
54+
* \subpage PEEKD
55+
* \subpage PEEK
56+
* \subpage PEEKQ
57+
* \subpage PEEKW
58+
* \subpage RADIX
59+
* \subpage IREAD
60+
* \subpage RGB
61+
* \subpage RND
62+
* \subpage SECOND
63+
* \subpage SGN
64+
* \subpage SHL
65+
* \subpage SHR
66+
* \subpage SOCKACCEPT
67+
* \subpage SOCKLISTEN
68+
* \subpage SOCKSTATUS
69+
* \subpage TERMHEIGHT
70+
* \subpage TERMWIDTH
71+
* \subpage UDPLASTSOURCEPORT
72+
* \subpage VAL
73+
* \subpage WEEKDAY
74+
* \subpage YDAY
75+
* \subpage YEAR

docpages/basic-language-reference/keywords/BITAND.md renamed to docpages/basic-language-reference/functions/integer/BITAND.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\page BITAND BITAND Keyword
1+
\page BITAND BITAND Function
22
```basic
33
X = BITAND(a, b)
44
```

docpages/basic-language-reference/keywords/BITEOR.md renamed to docpages/basic-language-reference/functions/integer/BITEOR.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\page BITEOR BITEOR Keyword
1+
\page BITEOR BITEOR Function
22
```basic
33
X = BITEOR(a, b)
44
```

docpages/basic-language-reference/keywords/BITNAND.md renamed to docpages/basic-language-reference/functions/integer/BITNAND.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\page BITNAND BITNAND Keyword
1+
\page BITNAND BITNAND Function
22
```basic
33
X = BITNAND(a, b)
44
```

docpages/basic-language-reference/keywords/BITNOR.md renamed to docpages/basic-language-reference/functions/integer/BITNOR.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\page BITNOR BITNOR Keyword
1+
\page BITNOR BITNOR Function
22
```basic
33
X = BITNOR(a, b)
44
```

docpages/basic-language-reference/keywords/BITNOT.md renamed to docpages/basic-language-reference/functions/integer/BITNOT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\page BITNOT BITNOT Keyword
1+
\page BITNOT BITNOT Function
22
```basic
33
X = BITNOT(a)
44
```

docpages/basic-language-reference/keywords/BITOR.md renamed to docpages/basic-language-reference/functions/integer/BITOR.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\page BITOR BITOR Keyword
1+
\page BITOR BITOR Function
22
```basic
33
X = BITOR(a, b)
44
```

docpages/basic-language-reference/keywords/BITROL.md renamed to docpages/basic-language-reference/functions/integer/BITROL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\page BITROL BITROL Keyword
1+
\page BITROL BITROL Function
22
```basic
33
X = BITROL(a, n, width)
44
```

0 commit comments

Comments
 (0)