|
|
| (21 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| − | [[The Original SCI Documentation]]<br /> | + | [[Official SCI Documentation]]<br /> |
| | | | |
| | <div align="center"><span style="font-size: 22pt">The Script Programming Language</span><br /> | | <div align="center"><span style="font-size: 22pt">The Script Programming Language</span><br /> |
| Line 5: |
Line 5: |
| | Date: 4 April 1988</div> | | Date: 4 April 1988</div> |
| | | | |
| | + | <blockquote> |
| | + | *[[The Script Programming Language/Introduction | Introduction]] |
| | *[[The Script Programming Language/Files | Files]] | | *[[The Script Programming Language/Files | Files]] |
| | *[[The Script Programming Language/Definitions | Definitions]] | | *[[The Script Programming Language/Definitions | Definitions]] |
| Line 17: |
Line 19: |
| | *[[The Script Programming Language/Procedures | Procedures]] | | *[[The Script Programming Language/Procedures | Procedures]] |
| | *[[The Script Programming Language/Using SC | Using SC]] | | *[[The Script Programming Language/Using SC | Using SC]] |
| − | | + | *[[The Script Programming Language/Index | Index]] |
| − |
| |
| − | | |
| − | ==<br /> Introduction ==
| |
| − | | |
| − | The Script adventure game language is an object-oriented language with a Lisp-like syntax. It is compiled by the sc compiler into the pseudo-code which is used by the interpreter, sci. | |
| − | | |
| − | We will begin our discussion of the language with its basic Lisp-like characteristics, then go on to the object-oriented parts of the language.
| |
| − | | |
| − | As is Lisp, Script is based on parenthesized expressions which return values. An expression is of the form
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (procedure [parameter parameter ...]).
| |
| − | </syntaxhighlight>
| |
| | </blockquote> | | </blockquote> |
| | | | |
| − | The parameters to a procedure may themselves be expressions to be evaluated, and may be nested until you lose track of the parentheses. | + | <div align="center"> |
| − | | + | Chapter: |
| − | Unlike Lisp, the procedure itself may NOT be the result of an evaluation. An example of an expression is
| + | [[The Script Programming Language/Introduction|1]] | |
| | + | [[The Script Programming Language/Files|2]] | |
| | + | [[The Script Programming Language/Definitions|3]] | |
| | + | [[The Script Programming Language/Data Types and Variables|4]] | |
| | + | [[The Script Programming Language/Primitive Procedures|5]] | |
| | + | [[The Script Programming Language/Control Flow|6]] | |
| | + | [[The Script Programming Language/Procedures|7]] | |
| | + | [[The Script Programming Language/Using SC|8]] | |
| | + | [[The Script Programming Language/Index|Index]] |
| | + | </div><br /> |
| | | | |
| − | <blockquote>
| + | * [[Media:SCRIPT.pdf|Download The Script Programming Language in PDF Form]]<br /> |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (+ (- y 2) (/ x 3))
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| | | | |
| − | which would be written in infix notation as
| |
| | | | |
| − | <blockquote>
| + | |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (y - 2) + (x / 3).
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| | | | |
| − | All expressions are guaranteed to be evaluated from left to right. Thus,
| + | <span style="float: left"><span class="Inactive">< Previous: </span></span><span style="float: right">[[The Script Programming Language/Introduction|Next: Introduction >]]</span> |
| | | | |
| − | <blockquote>
| + | |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (= x 4)
| |
| − | (= y (/ (+= x 4) (/= x 2)))
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | will result in y = 2 and x = 4.
| |
| − | | |
| − | Comments in Script begin with a semi-colon, ';', and continue to the end of the line.
| |
| − | | |
| − | == <br />Files ==
| |
| − | | |
| − | == <br /> Definitions ==
| |
| − | | |
| − | ==<br /> Data Types and Variables ==
| |
| − | | |
| − | == <br /> Primitive Procedures ==
| |
| − | | |
| − | ==<br /> Control Flow ==
| |
| − | | |
| − | ==<br /> Procedures ==
| |
| − | | |
| − | Procedures are created with the procedure construct:
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (procedure (proc-name [p1 p2 ...] [&tmp t1 t2...])
| |
| − | code
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | This defines the procedure with the name proc-name. This procedure takes parameters p1, p2, ... and allocates temporary variables (which disappear on exit from the procedure) t1, t2, .... Note that the procedure may take no parameters and have no automatic variables. In this case, the definition would be
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (procedure (proc-name)
| |
| − | code
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | You can define temporary arrays in the same way as you would local arrays:
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (procedure (proc-name &tmp [array n])
| |
| − | code
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | Code in these examples is any list of valid expressions.
| |
| − | | |
| − | All procedures have at least one parameter, the compiler defined variable argc (argument count), which gives the number of parameters passed to the procedure.
| |
| − | | |
| − | For example, you might define the procedure square, to square a number, as follows:
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (procedure (square n)
| |
| − | (* n n)
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | or the procedure max to find the maximum of an arbitrary number of numbers passed to the procedure:
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (procedure
| |
| − | (max
| |
| − | p ;parameters (will be accessed as an array)
| |
| − | &tmp
| |
| − | biggest ;temporary variable containing maximum
| |
| − | i ;index into parameter array
| |
| − | )
| |
| − | | |
| − | (for ((= i 0) (= biggest 0))
| |
| − | (< i argc) ;compare to number of parameters passed.
| |
| − | ((++ i)) ;note that this is a LIST of expressions,
| |
| − | ;not a single expression.
| |
| − | | |
| − | (if (> [p i] biggest)
| |
| − | (= biggest [p i])
| |
| − | )
| |
| − | | |
| − | )
| |
| − | | |
| − | (return biggest)
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | | |
| − | The call
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (max 3 -4 -9 0 -2 7 12 4 3 5)
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | will return the value 12.
| |
| − | | |
| − | In order to use a procedure before it has been defined in a source file (for example making a call to max before the actual definition of max), the compiler must be told that the procedure's name corresponds to a procedure, not an object. This is done with another form of the procedure statement:
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (procedure
| |
| − | procedure-name
| |
| − | procedure-name
| |
| − | ...
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | Tells the compiler to compile code for procedure calls when it encounters procedure-name, rather than code for send messages to an object.
| |
| − | | |
| − | ===<br > &rest: ===
| |
| − | | |
| − | Argc, as discussed above, makes it easy to write procedures (or methods, discussed in Object Oriented Programming in Script) which handle a variable number of arguments. If a procedure or method has received a variable number of arguments and wants to pass them on to another procedure or method, things get messy. The only way to do this given only argc is to build a switch statement on argc which looks like
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (procedure (foo arg)
| |
| − | (switch argc
| |
| − | (0 (mumble))
| |
| − | (1 (mumble arg))
| |
| − | (2 (mumble arg [arg 1]))
| |
| − | (3 (mumble arg [arg 1] [arg 2]))
| |
| − | ...
| |
| − | )
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | This not only involves a lot of typing and generates a lot of code, it limits the number of arguments which can be passed to the next function (you can only type a finite number of clauses in the switch statement).
| |
| − | | |
| − | &rest exists to solve this problem -- it stands for the rest of the parameters not specified in the procedure or method definition. The above procedure could then be written simply as
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (procedure (foo)
| |
| − | (mumble &rest)
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | which is not only easier to type and read but also produces smaller, faster object code.
| |
| − | | |
| − | A variant of &rest allows you to specify all parameters starting at any point in a parameter list of a procedure or method definition:
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (procedure (foo arg1 arg2 arg3 arg4)
| |
| − | (mumble (&rest arg3))
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | passes all arguments starting with arg3 to procedure mumble.
| |
| − | | |
| − | ===<br > Extern: ===
| |
| − | | |
| − | Calling a procedure in another script is another matter. Since there is no link phase in the development cycle, one procedure cannot know the address of a procedure in a different script. The extern statement allows a script to know where the external procedure is:
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (extern
| |
| − | procedure-name script-number entry-number
| |
| − | ...
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | This says that the procedure referred to by the symbol procedure-name in this script is to be found in script number script-number at entry number entry-number in the script's dispatch table. kernel.sh and base.sh both use the extern statement to let all other scripts know where their public procedures are.
| |
| − | | |
| − | The dispatch table for a script is defined by the public statement:
| |
| − | | |
| − | ===<br > Public: ===
| |
| − | | |
| − | All procedures within a script which are to be accessed from outside the script must be entered in the dispatch table for the script with the public statement:
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | (public
| |
| − | procedure-name entry-number
| |
| − | ...
| |
| − | )
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | puts the procedure procedure-name in the dispatch table at entry number entry-number. The entries need not be in numeric order, nor do the numbers need to be continuous (though if they're not continuous the table will be larger than it needs to be).
| |
| − | | |
| − | ==<br /> Using SC ==
| |
| − | | |
| − | The sc compiler is invoked with the command
| |
| − | | |
| − | <blockquote>
| |
| − | <div class="CodeBlockHeader">Code:</div>
| |
| − | <syntaxhighlight lang="sci">
| |
| − | sc file_spec [file_spec] [options]
| |
| − | </syntaxhighlight>
| |
| − | </blockquote>
| |
| − | | |
| − | Any number of file specifications may be entered on the command line, and a file specification may include wild-card names.
| |
| − | | |
| − | ===<br /> Options ===
| |
| − |
| |
| − | ====<br /> -l ====
| |
| − | <blockquote>Generate an assembly language code listing for the file. This is useful when using the built-in debugger of sci, which lists only the assembly language code, not the source. When compiling filename.sc, the list file is named filename.sl</blockquote>
| |
| − | | |
| − | ====<br /> -n ====
| |
| − | <blockquote>Turns off 'auto-naming' of objects. As described in Script Classes for Adventure Games, each object has a name, or 'print-string' property, which is how to represent the object textually. Unless the property is explicitly set, the compiler will generate the value for this property automatically, using the object's symbol string for the name. The object names, however, take up space in the heap. While they are useful (almost vital) for debugging, if you're running out of heap in a room, it might help to compile with the -n option to leave the names out.</blockquote>
| |
| − |
| |
| − | ====<br /> -oout-dir ====
| |
| − | <blockquote>Set the directory for the output file (script.nnn) to out-dir.</blockquote>
| |
| − |
| |
| − | ====<br /> -v ====
| |
| − | <blockquote>Turns on verbose mode, which prints the number of bytes occupied by various parts of the output file (code, objects, text, etc.).</blockquote>
| |
| − |
| |
| − | ====<br /> -z ====
| |
| − | <blockquote>Turn off optimization. Not a particularly useful option except for those of us who must maintain the compiler.</blockquote>
| |
| − | | |
| − | == <br />Index ==
| |
| | | | |
| − | ! . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| + | [[Category:SCI Documentation]] |
| − | != . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14<br />
| + | [[Category:Scripting]] |
| − | + . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | ++ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | += . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | - . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | -- . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | -= . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | <nowiki>*</nowiki> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | <nowiki>*=</nowiki> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | / . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | /= . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | ^ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | ^= . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | < . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14<br />
| |
| − | << . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | <<= . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | <= . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14<br />
| |
| − | = . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | == . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14<br />
| |
| − | > . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14<br />
| |
| − | >= . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14<br />
| |
| − | >> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | >>= . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | & . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | &= . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | &rest . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20<br />
| |
| − | | . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | |= . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | ~ . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | and . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14<br />
| |
| − | arithmetic primitives . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9<br />
| |
| − | arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9<br />
| |
| − | assignment primitives . . . . . . . . . . . . . . . . . . . . . . . . . 15<br />
| |
| − | base.sh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4<br />
| |
| − | boolean primitives . . . . . . . . . . . . . . . . . . . . . . . . . . . 14<br />
| |
| − | break . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17<br />
| |
| − | breakif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17<br />
| |
| − | characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12<br />
| |
| − | classdef . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4<br />
| |
| − | classtbl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4<br />
| |
| − | cond . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16<br />
| |
| − | conditionals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16<br />
| |
| − | contif . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18<br />
| |
| − | continue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18<br />
| |
| − | define . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6<br />
| |
| − | enum . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6<br />
| |
| − | extern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21<br />
| |
| − | for . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17<br />
| |
| − | global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8<br />
| |
| − | if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16<br />
| |
| − | include . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5<br />
| |
| − | iteration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17<br />
| |
| − | kernal.sh . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4<br />
| |
| − | local . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8<br />
| |
| − | mod . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13<br />
| |
| − | not . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14<br />
| |
| − | numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8<br />
| |
| − | options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23<br />
| |
| − | or . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14<br />
| |
| − | pointers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10<br />
| |
| − | procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19, 20<br />
| |
| − | public . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22<br />
| |
| − | repeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17<br />
| |
| − | return . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16<br />
| |
| − | sc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23<br />
| |
| − | script# . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5<br />
| |
| − | selector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4<br />
| |
| − | <nowiki> literal</nowiki> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12<br />
| |
| − | SINCLUDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5<br />
| |
| − | switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17<br />
| |
| − | synonyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7<br />
| |
| − | text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10<br />
| |
| − | variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8<br />
| |
| − | <nowiki> global</nowiki> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8<br />
| |
| − | <nowiki> local</nowiki> . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8<br />
| |
| − | <nowiki> temporary</nowiki> . . . . . . . . . . . . . . . . . . . . . . . . . . . 8, 19<br />
| |
| − | vocab.000 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4<br />
| |
| − | while . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17<br />
| |
| − | word strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11<br />
| |
