Script Programming Language/Procedures - Revision history

Andrew Branscom: /* Also See */

2026-01-02T16:40:04Z

Also See

← Older revision		Revision as of 12:40, 2 January 2026
Line 237:		Line 237:
	[[Category:Technical Info]]		[[Category:Technical Info]]
	[[Category:SCI Technical Info]]		[[Category:SCI Technical Info]]
	[[Category:Scripting ~~Articles~~]]		[[Category:Scripting]]
	[[Category:SCI Scripting ~~Articles~~]]		[[Category:SCI Scripting]]
	[[Category:Procedures]]		[[Category:Procedures]]
	[[Category:SCI Procedures]]		[[Category:SCI Procedures]]

Andrew Branscom at 20:59, 1 January 2026

2026-01-01T20:59:34Z

← Older revision		Revision as of 16:59, 1 January 2026
Line 1:		Line 1:
	[[~~The Original~~ SCI Documentation]]<br />		[[Category:SCI Pages]]
			[[Official SCI Documentation]]<br />
			[[Script Programming Language \| Table of Contents]]

	<div align="center">		<div align="center">
	Chapter:		Chapter:
Line 12:		Line 14:
	[[Script Programming Language/Using SC\|8]] \|		[[Script Programming Language/Using SC\|8]] \|
	[[Script Programming Language/Index\|Index]]		[[Script Programming Language/Index\|Index]]
	</div~~><br /~~>		</div>
			<div align="center"><span style="font-size: 22pt">Procedures</span><br />''Author: [[Jeff Stephenson]]''<br />''1988-04-04''</div></div>
	<div align="center">~~<span style="font-size: 22pt">The Script Programming Language</span><br />~~
	<span style="font-size: 22pt">Procedures</span><br />
	''Author: [[Jeff Stephenson]]''</div>

	~~ ~~

			<br />
	==<br /> Procedures ==		==<br /> Procedures ==

Line 207:		Line 205:
	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).		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 /> References ==

			<references /><!-- Do not edit this section. It is autopopulated by <ref></ref> tags -->

	~~;Notes~~		==<br /> Also See ==
	<~~references~~ />

			* [[:Category:SCI Documentation\|SCI Documentation]]
			* [[:Category:Official SCI Documentation\|Official SCI Documentation]]
			* [[:Category:Scripting Articles\|Scripting Articles]]
			* [[:Category:SCI Procedures\|SCI Procedures]]
			* [[:Category:Primitive Procedures\|Primitive Procedures]]
			* [[Script Resource (SCI)]]
			* [[SCI Specifications: Chapter 1 - Introduction#SCRIPT\|SCRIPT in the SCI Specifications]]


			[[Official SCI Documentation]]<br />
	[[Script Programming Language \| Table of Contents]]		[[Script Programming Language \| Table of Contents]]

	<span style="float: left">[[Script Programming Language/Control Flow \| < Previous: Control Flow]]</span><span style="float: right">[[Script Programming Language/Using SC \| Next: Using SC >]]</span>		<span style="float: left">[[Script Programming Language/Control Flow \| < Previous: Control Flow]]</span><span style="float: right">[[Script Programming Language/Using SC \| Next: Using SC >]]</span>


			[[Category:References]]
			[[Category:SCI References]]
			[[Category:Historical Pages]]
			[[Category:SCI Historical Pages]]
			[[Category:Development]]
			[[Category:SCI Development]]
			[[Category:Documentation]]
	[[Category:SCI Documentation]]		[[Category:SCI Documentation]]
	[[Category:Scripting]]		[[Category:Official Documentation]]
			[[Category:Official SCI Documentation]]
			[[Category:Technical Info]]
			[[Category:SCI Technical Info]]
			[[Category:Scripting Articles]]
			[[Category:SCI Scripting Articles]]
	[[Category:Procedures]]		[[Category:Procedures]]
			[[Category:SCI Procedures]]
			[[Category:Primitive Procedures]]
			[[Category:Script Resources]]
			[[Category:SCI Script Resources]]
			[[Category:Official SCI Documentation]]
			[[Category:Primitive Procedures]]

Andrew Branscom at 22:58, 28 December 2025

2025-12-28T22:58:07Z

← Older revision		Revision as of 18:58, 28 December 2025
Line 3:		Line 3:
	<div align="center">		<div align="center">
	Chapter:		Chapter:
	[[~~The~~ Script Programming Language/Introduction\|1]] \|		[[Script Programming Language/Introduction\|1]] \|
	[[~~The~~ Script Programming Language/Files\|2]] \|		[[Script Programming Language/Files\|2]] \|
	[[~~The~~ Script Programming Language/Definitions\|3]] \|		[[Script Programming Language/Definitions\|3]] \|
	[[~~The~~ Script Programming Language/Data Types and Variables\|4]] \|		[[Script Programming Language/Data Types and Variables\|4]] \|
	[[~~The~~ Script Programming Language/Primitive Procedures\|5]] \|		[[Script Programming Language/Primitive Procedures\|5]] \|
	[[~~The~~ Script Programming Language/Control Flow\|6]] \|		[[Script Programming Language/Control Flow\|6]] \|
	[[~~The~~ Script Programming Language/Procedures\|7]] \|		[[Script Programming Language/Procedures\|7]] \|
	[[~~The~~ Script Programming Language/Using SC\|8]] \|		[[Script Programming Language/Using SC\|8]] \|
	[[~~The~~ Script Programming Language/Index\|Index]]		[[Script Programming Language/Index\|Index]]
	</div><br />		</div><br />

Line 214:		Line 214:


	[[~~The~~ Script Programming Language \| Table of Contents]]		[[Script Programming Language \| Table of Contents]]

	<span style="float: left">[[~~The~~ Script Programming Language/Control Flow \| < Previous: Control Flow]]</span><span style="float: right">[[~~The~~ Script Programming Language/Using SC \| Next: Using SC >]]</span>		<span style="float: left">[[Script Programming Language/Control Flow \| < Previous: Control Flow]]</span><span style="float: right">[[Script Programming Language/Using SC \| Next: Using SC >]]</span>

Andrew Branscom: Andrew Branscom moved page The Script Programming Language/Procedures to Script Programming Language/Procedures

2025-12-28T22:33:11Z

Andrew Branscom moved page The Script Programming Language/Procedures to Script Programming Language/Procedures

← Older revision	Revision as of 18:33, 28 December 2025
(No difference)

Andrew Branscom: 2 revisions imported

2025-02-16T21:18:11Z

2 revisions imported

← Older revision	Revision as of 17:18, 16 February 2025
(No difference)

Andrew Branscom: 1 revision imported

2024-06-03T05:19:51Z

1 revision imported

← Older revision	Revision as of 01:19, 3 June 2024
(No difference)

Andrew Branscom: 1 revision imported

2018-03-02T23:12:17Z

1 revision imported

New page

[[The Original SCI Documentation]]<br />

<div align="center">
Chapter:
[[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 />

<div align="center"><span style="font-size: 22pt">The Script Programming Language</span><br />
<span style="font-size: 22pt">Procedures</span><br />
''Author: [[Jeff Stephenson]]''</div>

 

==<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).

 

;Notes
<references />

 

[[The Script Programming Language | Table of Contents]]

<span style="float: left">[[The Script Programming Language/Control Flow | < Previous: Control Flow]]</span><span style="float: right">[[The Script Programming Language/Using SC | Next: Using SC >]]</span>

 

[[Category:SCI Documentation]]
[[Category:Scripting]]
[[Category:Procedures]]

← Older revision		Revision as of 18:58, 28 December 2025
Line 3:		Line 3:
	<div align="center">		<div align="center">
	Chapter:		Chapter:
	[[~~The~~ Script Programming Language/Introduction\|1]] \|		[[Script Programming Language/Introduction\|1]] \|
	[[~~The~~ Script Programming Language/Files\|2]] \|		[[Script Programming Language/Files\|2]] \|
	[[~~The~~ Script Programming Language/Definitions\|3]] \|		[[Script Programming Language/Definitions\|3]] \|
	[[~~The~~ Script Programming Language/Data Types and Variables\|4]] \|		[[Script Programming Language/Data Types and Variables\|4]] \|
	[[~~The~~ Script Programming Language/Primitive Procedures\|5]] \|		[[Script Programming Language/Primitive Procedures\|5]] \|
	[[~~The~~ Script Programming Language/Control Flow\|6]] \|		[[Script Programming Language/Control Flow\|6]] \|
	[[~~The~~ Script Programming Language/Procedures\|7]] \|		[[Script Programming Language/Procedures\|7]] \|
	[[~~The~~ Script Programming Language/Using SC\|8]] \|		[[Script Programming Language/Using SC\|8]] \|
	[[~~The~~ Script Programming Language/Index\|Index]]		[[Script Programming Language/Index\|Index]]
	</div><br />		</div><br />

Line 214:		Line 214:


	[[~~The~~ Script Programming Language \| Table of Contents]]		[[Script Programming Language \| Table of Contents]]

	<span style="float: left">[[~~The~~ Script Programming Language/Control Flow \| < Previous: Control Flow]]</span><span style="float: right">[[~~The~~ Script Programming Language/Using SC \| Next: Using SC >]]</span>		<span style="float: left">[[Script Programming Language/Control Flow \| < Previous: Control Flow]]</span><span style="float: right">[[Script Programming Language/Using SC \| Next: Using SC >]]</span>