ooc.1

Object-Oriented Programming With ANSI-C这本书中的源代码!找了很久

.IR class .
Function names are remembered as necessary for initialization of the description of
.I class
and the corresponding metaclass if any.
There can be an optional tag preceding
.I class
unless
.I method
has static linkage.
.TP
.BI %casts
This is replaced by definitions of local variables
to securely dereference parameter pointers to objects in the current class.
For statically linked methods this is
followed by checks to verify the parameters pointing to objects
of other classes.
.B %casts
should be used where local variables can be defined;
for statically linked methods it must be the last definition.
Note that null pointers flunk the checks and terminate the calling program.
.TP
.BI %init
This should be near the end of the implementation file.
If the
.I description
introduced a new metaclass,
a constructor for the metaclass,
selectors for the class,
and initializations for the metaclass are generated.
In either case,
an initialization for the class is generated.
.PP
If a method
.I m
does not have static linkage,
there are two selectors:
.I m
with the same parameters as the method
selecting the method defined for
.BR self ,
and
.BI super_ m
with an explicit class description as an additional first parameter.
The second selector is used to pass a method call to
the superclass of the class where the method is defined.
.PP
If a dynamically linked or class method has a variable argument list,
the selector passes
.B va_list * app
to the actual method.
.PP
If a selector recognizes that it cannot be applied to its object,
it calls
.B forward
and passes its object,
a pointer to a result area, or a null pointer,
its own address,
its name as a string,
and its entire argument list.
.B forward
should be a dynamically linked method in the root class;
it can be used to forward a message from one object to another.
.SS Tags
.B respondsTo()
is a method in the root class which
takes an object and a tag, i.e., a C string
containing an identifier,
and returns either a null pointer or a selector
which will accept the object and other parameters
and call the method corresponding to the tag.
.PP
The tag under which a class or dynamically linked method can be found
is defined as follows.
The default is either the method name or
.I tag
in the method header in the class description file:
.RS
[ \f2tag \f3:\f1 ] \f2declarator\f3 ( \f2declarator \f1{ \f3,\f2 declarator\f1 } [ \f3, ...\f1 ] \f3);\f1
.RE
.PP
The method header in the implementation may overwrite the tag:
.RS
.BI % " mtag" : " class method " {
.RE
.PP
The effective tag is
.I mtag
if specified, or
.I tag
if not.
If
.I mtag
or
.I tag
is empty but the colon is specified,
.B respondsTo()
cannot find the method.
.SS Report File
.I ooc
uses report files containing all code fragments
which
.I ooc
will generate.
Names such as
.B app
for an argument list pointer
can be changed in the report file.
Only
.B self
is built into
.I ooc
itself.
.PP
A report file contains one or more reports.
The usual lexical conventions apply.
Each report is preceded by a line starting with
.B %
and containing the report name
which may be enclosed by white space.
The report name is arbitrary text
but it must be unique.
.PP
A report consists of lines of words separated by single blanks or tabs,
called spaces.
An empty word results between any two adjacent spaces
or if a space starts or ends a line.
.PP
An empty word,
not at the beginning of an output line,
is printed as a blank.
In particular,
this means that two successive spaces in a report
represent a single blank to be printed.
Any word not starting with a back quote
.B `
is printed as is.
.PP
A word starting with
.B `%
causes a report to be printed.
The report name is the remainder of the word.
.PP
.B `#line
followed by a word
causes a line stamp to be printed
if option
.B \(mil
is specified;
the phrase is ignored otherwise.
If the word is a class, method, or class component name,
the line stamp refers to its position in a class description file.
Otherwise,
and in particular for empty words,
the line stamp refers to the current input file position.
.PP
A word starting with
.B `{
starts a group.
The group is terminated with a word starting with
.BR `} .
All other words starting with a back quote
.B `
are replaced during printing.
Some replacements are globally defined,
others are set up by certain groups.
A table of replacements follows at the end of this section.
.PP
Groups are either loops over parts of the database
collected by
.I ooc
or they are conditionals based on a comparison.
Words inside a group are printed under control of the loop
or the comparison.
Afterwards, printing continues with the word following the group.
Groups can be nested,
but that may not make sense for some parts of the database.
Here is a table of words starting a loop:
.TS
center;
Lb L.
`{%	static methods for the current \f3`class\fP
`{%\(mi	dynamic methods for the current \f3`class\fP
`{%+	class methods for the current \f3`class\fP
`{()	parameters for the current \f3`method\fP
`{dcl	class headers in the \f3`desc\fP description file
`{pub	public lines in the \f3`desc\fP description file
`{prot	protected lines in the \f3`desc\fP description file
`{links\f2\& class\fP	dynamic and class methods defined for \f2class\fP
`{struct\f2\& class\fP	components for \f2class\fP
`{super	\f3`desc\fP and all its superclasses back to \f3`root\fP
.TE
.PP
A loop is terminated with a word starting with
.BR `} .
If the terminating word is
.B `},
in the loop over parameters,
and if the loop will continue for more parameters,
a comma followed by a blank is printed for this word.
If the terminating word is
.B `}n
and if the group has produced any output,
a newline is printed for this word.
Otherwise, nothing is printed for termination.
.PP
A conditional group starts with
.B `{if
or
.B `{ifnot
followed by two words.
The words are replaced if necessary and compared.
If they are equal,
the group starting with
.B `{if
is executed;
if they are not equal,
the group starting with
.B `{ifnot
is executed.
If either group is not executed
and if it is followed by a group starting with
.BR `{else ,
this group is executed.
Otherwise the
.B `{else
group is skipped.
.PP
In general it is best if the
.B `}
terminating the
.B `{if
group immediately precedes
.B `{else
on the same line of the report.
.PP
Here is a table of replaced words
together with the events that set up the replacements:
.TS
center;
Li S
Ab L.
set up globally
`	no text (empty string)
``	` (back quote)
`t	tab
`n	newline (limited to one blank line)
.sp .5v
.T&
Li S
Ab L.
set up once class descriptions are loaded
`desc	last \f2description\fP from command line
`root	root class' name
`metaroot	root's metaclass name
.sp .5v
.T&
Liz Rb
Ab L.
set up for a class	% %\(mi %+ `{dcl `{prot `{pub `{super
`class	class' name
`super	class' superclass name
`meta	class' metaclass name
`supermeta	metaclass' superclass name
.sp .5v
.T&
Liz Rb
Ab L.
set up for a method	`{% `{%\(mi `{%+ `{links\f2\& class\fP
`method	method's name
`result	method's result type
`linkage	method's linkage: \f3%\fP, \f3%\(mi\fP, or \f3%+\fP
`tag	method's tag
`,...	\f3, ...\fP if variable arguments are declared,
\^	   empty if not
`_last	last parameter's name if variable arguments,
\^	   undefined if not
.sp .5v
.T&
Liz Rb
Ab L.
set up for a declarator	`{() `{struct\f2\& class\fP
`name	name in declarator
`const	\f3const\fP followed by a blank, if so declared
`type	\f3void *\fP for objects, declared type otherwise
`_	\f3_\fP if used in declaration, empty otherwise
`cast	object's class name, empty otherwise
.sp .5v
.T&
Liz Rb
Ab L.
set up for lines from the description file	`{dcl `{prot `{pub
`class	set up for a class description, empty otherwise
`line	line's text if not class description, undefined otherwise
`newmeta	\f3\&1\fP if new metaclass is defined, \f3\&0\fP if not
.TE
.PP
A
.I description
on the command line of
.I ooc
sets up for a class.
Requesting a method header in a source file
sets up for a class and a method.
The loops
.BR `{dcl ,
.BR `{prot ,
and
.B `{pub
set up for lines from a class description file.
The loops
.BR `{% ,
.BR `{%\(mi ,
.BR `{%+ ,
and
.B `{links
.I class
set up for a method.
The loop
.B `{()
sets up for a parameter declarator.
The loop
.B `{struct
.I class
sets up for the declarator of a component of a class.
The loop
.B `{super
runs from
.I description
through all its superclasses.
.SS Environment
.B OOCPATH
is a colon-separated list of paths.
If a file name does not contain path delimiters,
.I ooc
looks for the file (class descriptions, sources, and report files)
by prefixing each entry of
.B OOCPATH
to the required file name.
By default,
.B OOCPATH
consists of the working directory and a standard place.
.SH FILES
. nf
. ta 30n
\f2class\f3.d\f1	description for \f2class\fP 
\f2class\f3.dc\f1	implementation for \f2class\fP 
\f2report\f3.rep\f1	report file
\f2\s-1AWKPATH\s0\^/\|*\fP\f3.awk\fP	modules
\f2\s-1AWKPATH\s0\^/\|*\fP\f3.dbg\fP	debugger modules
\f2\s-1OOCPATH\s0\^/\|\fP\f3c.rep\fP	implementation file reports
\f2\s-1OOCPATH\s0\^/\|\fP\f3dc.rep\fP	implementation thunks report
\f2\s-1OOCPATH\s0\^/\|\fP\f3etc.rep\fP	common reports
\f2\s-1OOCPATH\s0\^/\|\fP\f3h.rep\fP	interface file report
\f2\s-1OOCPATH\s0\^/\|\fP\f3header.rep\fP	common reports
\f2\s-1OOCPATH\s0\^/\|\fP\f3m.rep\fP	\f2makefile\fP dependency report
\f2\s-1OOCPATH\s0\^/\|\fP\f3r.rep\fP	representation file reports
\f2\s-1OOCPATH\s0\^/\|\fP\f3va.rep\fP	common reports
\f2\s-1OOCPATH\s0\^/\|\fP\f3[chr]-R.rep\fP	root class versions
. fi
.SH BUGS
The C preprocessor is applied to the output of
.IR ooc ,
not to the input,
i.e., conditional compilation should not be applied to
.I ooc
controls.
.tr ``