ooc.1

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

.\"	ooc.1 -- 5.6 Sep 27 16:06:26 1993
.\"	Copyright (c) 1993 Axel T. Schreiner
.\" preprocess with tbl
.TH ooc  1 "local: ats"
.
.ds AC \s-1ANSI\s0 C
.tr `\(ga
.
.SH NAME
ooc \(em preprocessor for object-oriented coding in \*(AC
.SH SYNOPSIS
.B ooc
[option ...] [report ...] description target ...
.SH DESCRIPTION
.I ooc
is an
.I awk
program
which reads class descriptions
and performs the routine coding tasks necessary
to do object-oriented coding in \*(AC.
Code generated by
.I ooc
is controlled by reports which may be changed.
This manual page describes the effects of the standard reports.
.PP
.I description
is a class name.
.I ooc
loads a class description file with the name
.IB description .d
and recursively class description files for all superclasses
back to the root class.
If
.B \(mih
or
.B \(mir
is specified as a
.IR target ,
a C header file for the public interface or the private representation of
.I description
is written to standard output.
If
.IB source .dc
or
.B \(mi
is specified as a
.IR target ,
.B #include
statements for the
.I description
header files are written to standard output
and
.IB source .dc
or standard input
is read,
preprocessed,
and copied to standard output.
If
.B \(midc
is specified as a
.IR target ,
a source skeleton for
.I description
is written to standard output,
which contains all possible methods.
.PP
The output is produced by report generation from standard report files.
If
.IB file .rep
is specified as a
.IR report ,
the standard files are not loaded.
.PP
There are some global
.IR option s
to control
.IR ooc :
.TP
\f3\(miD\f2name\f1[\f3=\f2value\^\f1]
defines
.I value
or an empty string as replacement for
\f3\(ga\f2name\f1.
The
.I name
should be a single word.
.I ooc
predefines
.B \s-1GNUC\s0
with value
.BR 0 .
.TP
.B \(mid
arranges for debugging to follow normal processing.
Debugging commands are read from standard input:
.IB class .d
loads a class description file;
.IB report .rep
loads a report file;
a description, report, class, or method name
produces a dump of the appropriate information;
and
.BR all ,
.BR classes ,
.BR descriptions ,
or
.B reports
dump all information in the respective category.
.TP
.B \(mil
produces
.B #line
stamps as directed by the reports. 
.TP
.B \(miM
produces a
.I makefile
dependency line between each
.I description
and its superclass description files.
.TP
.B \(miR
must be specified if the root class is processed.
Other standard reports are loaded in this case.
.SS Lexical Conventions
All input lines are processed as follows:
first, a comment is removed;
next, lines are glued together as long as they end with a backslash;
finally, trailing white space is removed.
.PP
A comment extends from
.B //
to the end of a line.
It is removed together with preceding white space
before glueing takes place.
.PP
In glueing,
the backslash marks the contact point and is removed.
All white space around the contact point is replaced with a single space.
.PP
Identifiers significant to
.I ooc
follow the conventions of C,
except that they may not use underscore characters.
The underscore is used to avoid clashes between
.IR ooc 's
and the user's code.
.PP
Declarators significant to
.I ooc
are simplified relative to C.
They may start with
.B const
and the type information must precede the name.
The type information may use
.B *
but no parentheses.
In general,
an arbitrary declarator can be adapted for
.I ooc
by introducing a type name with
.BR typedef .
.PP
A line starting with
.B %%
acts as end of file.
.SS Class Description File
The class description file has the following format:
.RS
.nf
.I header
.BI % " meta class " {
.I "\&   components"
.B %
.I "\&   methods with static linkage"
.B %\(mi
.I "\&   methods with dynamic linkage"
.B %+
.I "\&   class methods"
.BI %}
\&...
.fi
.RE
.PP
.I header
is arbitrary information
which is copied to standard output if the interface file is produced.
Information following
.B %prot
is copied to standard output if the representation file is produced.
.PP
.I components
are C structure component declarations with one declarator per line.
They are copied into the
.B struct
generated in the representation file for the class.
They also determine the order of the construction parameters
for the root metaclass.
.PP
The first set of
.I "methods"
has static linkage,
i.e., they are functions with at least one object as a parameter;
the second set has dynamic linkage
and has an object as a parameter for which the method is selected;
the third set are class methods,
i.e., they have a class as a parameter for which the method is selected.
The selection object is always called
.BR self .
The method declarations define C function headers,
selectors,
and information for the metaclass constructor.
.PP
The class header line
.BI % " meta class " {
has one of three forms.
The first form is used to introduce the root class only:
.TP
.BI % " meta  class " {
.I class
is the root class,
indicated by the fact that it has no superclass.
The superclass is then defined to be the root class itself.
.I meta
should be introduced later as the root metaclass,
indicated by the fact that it has itself as metaclass.
.TP
.BI % " meta  class" : " super " {
.I class
is a new class with
.I meta
as its metaclass and
.I super
as its superclass.
This would also be used to introduce the root metaclass,
which has itself as metaclass and the root class as superclass.
If
.I super
is undefined,
.I ooc
will recursively (but only once)
load the class description file
.IB super .d
and then
.I super
and
.I meta
must have been defined so that
.I class
can be defined.
If this form of the class header is used,
only methods with static linkage can be introduced.
.TP
\f3%\f2 meta\f3\^: \f2supermeta  class\f3\^: \f2super\f3 {\f1
This additionally defines
.I meta
as a new metaclass with
.I supermeta
as its superclass.
If
.I super
is undefined,
.I ooc
will recursively (but only once)
load the class description file
.IB super .d
and then
.I super
and
.I supermeta
must have been defined so that
.I meta
and
.I class
can be defined.
.PP
A method declaration line has the following form,
where braces indicate zero or more occurrences and
brackets indicate an optional item:
.TP
[ \f2tag \f3:\f1 ] \f2declarator\f3 ( \f2declarator \f1{ \f3,\f2 declarator\f1 } [ \f3, ...\f1 ] \f3);\f1
The optional
.I tag
is an identifier involved in locating a method with
.BR respondsTo() .
The first
.I declarator
introduces the method name and result type, the remaining
.IR declarator s
introduce parameter names and types.
Exactly one parameter name must be
.B self
to indicate the receiver of the method call.
.PP
A
.I declarator
is a simplified C declarator as described above,
but there are two special cases:
.TP
.BI _ name
introduces
.I name
as the declarator name.
The type is a pointer to an instance of the current class
or to the class for which a dynamically linked method is overwritten.
Such a pointer will be dereferenced by
.B %casts
as
.I name
within a method.
Therefore,
.B self
must be introduced as
.BR _self ,
where
.B self
is the dereferenced object or class for class methods and
.B _self
is the raw pointer.
.TP
.IB class " @ " name
.br
introduces
.I name
as a pointer to an instance of
.IR class .
Such a pointer will not be dereferenced
but it will be checked by
.BR %casts .
.PP
The result type of a method can employ
.IB class " @" .
In this case, the result type is generated as a pointer to a
.B struct
.I class
which is useful when implementing methods,
and which cannot be used other than for assignments to
.B "void *"
in application code.
The result type should be
.B "void *"
for constructors and similar methods to emphasize the generic aspects
of construction.
.SS Preprocessing
Subject to the lexical conventions described above,
an implementation file
.IB source .dc
is copied to standard output.
Lines starting with
.B %
are preprocessed as follows:
.TP
.BI % " class method " {
This is replaced by a C function header for
.IR method ;
the header is declared
.B static
with the name
.IB class _ method,
unless
.I method
has static linkage.
In the latter case,
.I class
is optional.
.I ooc
checks in all cases that the method can be specified for