Debian Codegraph @

ipl/packs/idol/idol.1

raw
1 .TH IDOL 1 "10 March 1991"
2 .UC 4
3 .SH NAME
4 idol \- Icon-Derived Object Language
5 .SH SYNOPSIS
6 .B idol
7 [
8 .B option...
9 ]
10 mainfile otherfiles
11 [
12 .B \-x
13 arguments
14 ]
15 .SH DESCRIPTION
16 .PP
17 .I Idol
18 is an object-oriented preprocessor for Version 8+ Icon.
19 It is a front-end for
20 .I icont(1)
21 ; typically one invokes idol on
22 a source file (extension .iol) which is translated into an
23 Icon source file (extension .icn) which is translated into a
24 file suitable for interpretation by the Icon interpreter.
25 .PP
26 On systems with directories, Idol typically stores its generated class
27 library code in a separate directory from the source code. If the
28 environment variable IDOLENV is defined, Idol uses this directory for
29 generated code. If no IDOLENV is defined, Idol creates a subdirectory
30 named idolcode.env, and removes it after successful compilation
31 if the creation occured for a single source file.
32 .PP
33 Producing an executable is skipped when the first file on the
34 list contains only classes and no Icon entities. Idol uses an
35 Icon translator selected by the environment variable ICONT, if
36 it is present.
37 .PP
38 The
39 .B \-c
40 option suppresses the linking phase normally done by
41 .I Icont.
42 .PP
43 The
44 .B \-t
45 option suppresses
46 .B all
47 translation by
48 .I Icont;
49 it is useful on systems for which Icon does not support the
50 .br
51 .B system\(\)
52 function.
53 .PP
54 The
55 .B \-s
56 option suppresses removal of
57 .B \.icn
58 files after translation by
59 .I Icont;
60 normally they are deleted after a successful translation.
61 .PP
62 The
63 .B \-quiet
64 option suppresses most Idol-specific console messages.
65 .PP
66 The
67 .B \-strict
68 option causes
69 .I Idol
70 to generate code which is paranoid about ensuring encapsulation.
71 .PP
72 The
73 .B \-ic
74 option causes
75 .I Idol
76 to generate code that is
77 .I Icon-compatible.
78 The code will be slightly slower, but allows method invocation using
79 a traditional Icon procedure call. Such procedure calls are of the form
80 class_method(o,args...). Inherited methods cannot currently be so
81 invoked, the class that defines the method must be explicitly named in
82 the procedure call.
83 .PP
84 The
85 .B \-version
86 option causes
87 .I Idol
88 to print out its version and date of creation, and then exit.
89 .PP
90 The second and following files on the command line may include
91 extensions
92 .B \.icn
93 ,
94 .B \.u1
95 , and
96 .B \.cl\.
97 The first two Idol treats as
98 Icon source code which should be translated and linked into the
99 resulting executable. Files with extension
100 .B \.cl
101 are treated as class names which are linked into the resulting executable.
102 Class names are case sensitive; Deque.cl is a different class than deque.cl.
103 If the operating system does not support case sensitive filenames, such
104 class names will not coexist peacefully.
105 .PP
106 .SH AUTHOR
107 .PP
108 Clinton Jeffery, [email protected]
109 .PP
110 .SH FILES
111 .PP
112 .nf
113 idol The Idol translator itself.
114 .br
115 prog.iol Idol source files
116 .br
117 prog.icn Icon code (non-classes) from prog.iol
118 .br
119 idolcode.env/i_object.* Icon code for the Idol object type
120 .br
121 idolcode.env/classname.icn Icon files generated for each class
122 .br
123 idolcode.env/classname.u[12] Translated class files
124 .br
125 idolcode.env/classname Class specification/interface
126 .fi
127 .SH SEE ALSO
128 .PP
129 .br
130 "Programming in Idol: An Object Primer"
131 .br
132 (U of Arizona Dept of CS Technical Report #90-10)
133 .br
134 serves as a user's guide and reference manual for Idol