| 1 |
NAME |
| 2 |
idol - Icon-Derived Object Language |
| 3 |
|
| 4 |
SYNOPSIS |
| 5 |
idol [ option ... ] mainfile otherfiles... [-x arguments] |
| 6 |
|
| 7 |
DESCRIPTION |
| 8 |
Idol is an object-oriented preprocessor for Version 8+ Icon. |
| 9 |
It is a front-end for icont(1); typically one invokes idol on |
| 10 |
a source file (extension .iol) which is translated into an |
| 11 |
Icon source file (extension .icn) which is translated into a |
| 12 |
file suitable for interpretation by the Icon interpreter. |
| 13 |
|
| 14 |
On systems with directories, Idol typically stores its generated |
| 15 |
class library code in a separate directory from the source code. |
| 16 |
If the environment variable IDOLENV is defined, Idol uses this |
| 17 |
directory for generated code. If no IDOLENV is defined, Idol |
| 18 |
creates a subdirectory named idolcode.env, and removes it after |
| 19 |
successful compilation if the creation occurred for a single |
| 20 |
source file. |
| 21 |
|
| 22 |
Producing an executable is skipped when the first file on the |
| 23 |
list contains only classes and no Icon entities. Idol uses an |
| 24 |
Icon translator selected by the environment variable ICONT, |
| 25 |
if it is present. |
| 26 |
|
| 27 |
The following options are recognized by idol: |
| 28 |
|
| 29 |
-c Suppress the linking phase |
| 30 |
-t Suppress all translation by icont |
| 31 |
-s Suppress removal of .icn files after translation by icont |
| 32 |
-quiet Suppress most Idol-specific console messages |
| 33 |
-strict Generate code that is paranoid about ensuring encapsulation |
| 34 |
-version Print out the version of Idol and its date of creation |
| 35 |
-ic Generate code to create Icon-compatible class libraries |
| 36 |
|
| 37 |
The second and following files on the command line may include |
| 38 |
extensions .icn, .u1, and .cl. The first two Idol treats as |
| 39 |
Icon source code which should be translated and linked into the |
| 40 |
resulting executable. Files with extension .cl are treated as |
| 41 |
class names which are linked into the resulting executable. |
| 42 |
If no extension is given, Idol attempts to find the desired |
| 43 |
source file by appending .iol, .icn, .u1, or .cl in that order. |
| 44 |
|
| 45 |
FILES |
| 46 |
|
| 47 |
prog.iol : source file |
| 48 |
prog.icn : code generated for non-classes in prog.iol |
| 49 |
idolcode.env/i_object.* : Icon code for the universal object type |
| 50 |
idolcode.env/classname.icn : Icon files are generated for each class |
| 51 |
idolcode.env/classname.u[12] : translated class files |
| 52 |
idolcode.env/classname : class specification/interface |
| 53 |
|
| 54 |
SEE ALSO |
| 55 |
|
| 56 |
"Programming in Idol: An Object Primer" |
| 57 |
(U of Arizona Dept of CS Technical Report #90-10) |
| 58 |
serves as user's guide and reference manual for Idol |