Top
print_jvm_class
Base library
SmallEiffel Tools: short
short [-format] [options] Class_name
Short prints the interface of the class Class_name on the
standard output.
The default -format is -plain: no special characters are added.
Other available formats are described in the SmallEiffel short
directory (see below how to add a new output format).
Options
- -sort
- Features are sorted alphabetically.
- -short
- Do not consider inherited features.
- -no_warning
- Suppress output for all warning messages (error messages
are still printed).
- -case_insensitive
- Switch on the case insensitive mode. For example,
when this mode is selected, the Eiffel parser considers that the
following identifiers are equivalent : `item', `ITEM', `ItEm', ...
Output formats
- -plain
- Being plain, this does no formatting at all; there are
no hook files. This is the default format.
- -html1
- This format produces a self-contained HTML document.
- -html_deb
- This format produces a self-contained HTML page,
(using the same formats as -html1)
enclosed in a wrapper appropriate to the Debian package of SmallEiffel.
- -tex1
- A format to be included in a LaTeX document; this encloses
the entire output in \begin{verbatim} ... \end{verbatim}.
- -tex2
- A format to be included in a LaTeX document; this encloses
the entire output in \begin{alltt} ... \end{alltt}.
(This is like -tex1, except that the characters \, { and } have
their normal TeX meanings.)
- -tex3
- A format to be included in a LaTeX document; this format
follows the style recommended by Eiffel: The Language, appendix A.,
and encloses the entire output in \begin{alltt} ... \end{alltt}.
Adding a new output format
To define a new output format, you have to add a new sub-directory in
the SmallEiffel short directory. In order to change the output, this
new directory must contains various hook files, which contain text used
to replace the default output.
Here is the current list of hook files and their functions:
Changing the output of the class interface header
- hook000
- If this hook file exists, the contents of this file are
printed first of all.
- hook010
- If this hook file exists, and if the processed class
is an expanded one, the contents of this file are printed before
the class name to replace the default string
"expanded class interface ".
- hook011
- If this hook file exists, and if the processed class
is a deferred one, the contents of this file are printed before
the class name to replace the default string
"deferred class interface ".
- hook012
- If this hook file exists, and if the processed class
is an ordinary one (not deferred nor expanded) the contents of
this file are printed before the class name to replace the default
string "class interface ".
- hook013
- If this hook file exists, the contents of this file are
printed before the class name whatever the kind of class (expanded,
deferred or ordinary) to replace the default empty string "".
- hook014
- If this hook exists, the contents of the file are printed
after the class name to replace the default string "%N".
- hook015
- If this hook file exists, and if a class header comment
is present, this file is printed once before the heading class
comment.
- hook016
- If this hook file exists, and if a heading comment is
present, the contents of this file are printed to replace the default
string " -- " at the beginning of each comment line.
- hook017
- If this hook file exists, and if a heading comment is
present, the contents of this file are printed to replace the default
string "%N" at the end of each comment line.
- hook018
- If this hook file exists, and if a class heading comment is
present, the contents of this file are printed once after the heading
comment.
- hook019
- If this hook file exists, and if the processed class has no
heading comment, this file is printed once.
Changing the output of the creation list
- hook100
- If it exists, this file is printed before the creation list
to replace the default string "creation%N".
- hook101
- If it exists, this file is printed after the creation list
to replace the default empty string "".
- hook102
- If it exists, this file is printed when the class has no
creation list.
Changing the output of the feature list
- hook200
- If it exists, this file is printed before the feature list
when option -sort is selected to replace the default string "feature(s)%N".
- hook201
- If it exists, this file is printed after the feature list
when option -sort is selected to replace the default empty string "".
- hook202
- If it exists, this file is printed before each feature list
with no heading comment to replace the default string "feature(s) from ".
- hook203
- If it exists, this file is printed after the class name of
hook202 to replace the default string "%N".
- hook204
- If it exists, this file is printed before a feature list
with a heading comment to replace the default string "feature(s) from ".
- hook205
- If it exists, this file is printed after the class name
introduced at hook204 to replace the default string "%N".
- hook206
- If it exists, this file is printed before each line of the
feature list comment to replace the default string " -- ".
- hook207
- If it exists, this file is printed after each line of the
feature list comment to replace the default string "%N".
- hook208
- If it exists, this file is printed after a feature list
comment to replace the default empty string "".
Changing the output of a feature signature
- hook300
- If this hook exists, the contents of this file are printed
before each feature to replace the default string " ".
- hook301
- If this hook exists, the contents of this file are printed
once when the feature has no arguments to replace the default
empty string "".
- hook302
- If this hook exists, the contents of this file are printed
once when the feature has arguments to replace the default
string " (".
- hook303
- If this hook exists, the contents of this file are printed
when the feature has arguments to replace the default
string " ;".
- hook304
- If this hook exists, the contents of this file are printed
when the feature has arguments to replace the default
string ", ".
- hook305
- If this hook exists, the contents of this file are printed
when the feature has arguments to replace the default
string ": ".
- hook306
- If this hook exists, the contents of this file are printed
once when the feature has arguments to replace the default
string ")".
- hook307
- If this hook exists, the contents of this file are printed
once when the feature has no result to replace the default
string "%N".
- hook308
- If this hook exists, the contents of this file are printed
once before the result type of the feature to replace the default
string ": ".
- hook309
- If this hook exists, the contents of this file are printed
once after the result type of the feature to replace the default
string "%N".
Changing the output of a feature comment
- hook310
- If this hook file exists, and if a feature has a heading
comment, this file is printed once before the comment.
- hook311
- If this hook file exists, and if a feature has a heading
comment, the contents of this file are printed to replace the
default string " -- " at the beginning of each comment line.
- hook312
- If this hook file exists, and if a feature has a heading
comment, the contents of this file are printed to replace the default
string "%N" at the end of each comment line.
- hook313
- If this hook file exists, and if a feature has a heading
comment, the contents of this file are printed once after this
comment.
- hook314
- If this hook file exists, and if a feature has no heading
comment, the contents of this file are printed.
Changing the output of require clauses
For the header of a require clause
- hook400
- If this hook file exists, and if a feature has no require
assertion, the contents of this file are printed to replace the
default empty string "".
- hook401
- If this hook file exists, and if a feature has one require
assertion, the contents of this file are printed before the latest
inherited assertion to replace the default string " require%N".
- hook402
- If this hook file exists, and if a feature has more than
one require assertion, the contents of this file are printed before
the require assertion to replace the default string
" require else%N".
- hook403
- If this hook file exists, and if a feature has at least one
require assertion, the contents of this file are printed to finish the
job (once after the last printed require assertion) to replace the
default empty string "".
- hook412
- If this file exists, its contents are printed when a require
clause has no heading comment to replace the default empty string "".
- hook413
- If this file exists, its contents are printed once before
the require clause heading comment to replace the default empty string "".
- hook414
- If this file exists, its contents are printed before each line
of the heading comment to replace the default string " -- ".
- hook415
- If this file exists, its contents are printed after each line
of the heading comment to replace the default string "%N".
- hook416
- If this file exists, its contents are printed once after the
require clause heading comment.
- hook417
- If this file exists, its contents are printed when a require
clause has no assertion to replace the default empty string "".
- hook418
- If this file exists, its contents are printed once before the
first assertion of a require clause to replace the default empty string "".
- hook433
- If this file exists, its contents are printed once after the
last assertion of a require clause to replace the default empty string "".
- hook434
- If this file exists, its contents are printed to finish a
require clause to replace the default empty string "".
For each assertion in a require clause
- hook419
- If this file exists, its contents are printed before each
assertion of a require clause to replace the default string " ".
- hook420
- If this file exists, its contents are printed when an
assertion has no tag to replace the default empty string "".
- hook421
- If this file exists, its contents are printed before a tag to
replace the default empty string "".
- hook422
- If this file exists, its contents are printed after a tag to
replace the default string ": ".
- hook423
- If this file exists, its contents are printed when the assertion
has no expression to replace the default empty string "".
- hook424
- If this file exists, its contents are printed before the
expression to replace the default empty string "".
- hook425
- If this file exists, its contents are printed after the
expression (except for the last assertion) to replace the default string ";".
- hook426
- If this file exists, its contents are printed when an
assertion has no comment to replace the default string "%N".
- hook427
- If this file exists, its contents are printed once before
the assertion comment to replace the default empty string "".
- hook428
- If this file exists, its contents are printed before each
line of the expression comment to replace the default string " -- ".
- hook429
- If this file exists, its contents are printed after each
line of the expression comment to replace the default string "%N".
- hook430
- If this file exists, its contents are printed once after
the assertion's comment to replace the default string "".
- hook431
- If this file exists, its contents are printed after the
assertion to replace the default empty string "".
For the last assertion in a require clause
Same hook file list as described in the previous section except hook425 which
becomes :
- hook432
- If this file exists, its contents are printed after the last
expresion to replace the default empty string "".
Changing output of ensure clauses
For the header of the ensure clause
- hook500
- If this hook file exists, and a feature has no ensure
clause, the contents of this file are printed to replace the default
empty string "".
- hook511
- If this hook file exists, the contents of this file are
printed before each ensure clause to replace the default string
" ensure%N".
- hook512
- If this file exists, its contents are printed when ensure
clause has no heading comment to replace default empty string "".
- hook513
- If this file exists, its contents are printed once before
the ensure clause heading comment to replace the default empty string "".
- hook514
- If this file exists, its contents are printed before each line
of the heading comment to replace the default string " -- ".
- hook555
- If this file exists, its contents are printed after each line
of the heading comment to replace the default string "%N".
- hook516
- If this file exists, its contents are printed once after the
ensure clause heading comment.
- hook517
- If this file exists, its contents are printed when an ensure
clause has no assertion to replace the default empty string "".
- hook518
- If this file exists, its contents are printed once before the
first assertion of the ensure clause to replace the default empty string "".
- hook533
- If this file exists, its contents are printed once after the last
assertion of the ensure clause to replace the default empty string "".
- hook534
- If this file exists, its contents are printed to finish the
ensure clause to replace the default empty string "".
For each assertion in the ensure assertion
- hook519
- If this file exists, its contents are printed before each
assertion of the ensure clause to replace the default string " ".
- hook520
- If this file exists, its contents are printed when an assertion
has no tag to replace the default empty string "".
- hook521
- If this file exists, its contents are printed before a tag to
replace the default empty string "".
- hook522
- If this file exists, its contents are printed after a tag to
replace the default string ": ".
- hook523
- If this file exists, its contents are printed when the assertion
has no expression to replace the default empty string "".
- hook524
- If this file exists, its contents are printed before the
expression to replace the default empty string "".
- hook525
- If this file exists, its contents are printed after the
expresion (except for the last assertion) to replace the default string ";".
- hook526
- If this file exists, its contents are printed when an assertion
has no comment to replace the default string "%N".
- hook527
- If this file exists, its contents are printed once before the
assertion comment to replace the default empty string "".
- hook528
- If this file exists, its contents are printed before each line
of the expression comment to replace the default string " -- ".
- hook529
- If this file exists, its contents are printed after each line
of the expression comment to replace the default string "%N".
- hook530
- If this file exists, its contents are printed once after the
assertion's comment to replace the default string "".
- hook531
- If this file exists, its contents are printed after the
assertion to replace the default empty string "".
For the last assertion in the ensure clause
Same hook files list as described in the previous section except hook525 which
becomes:
- hook532
- If this file exists, its contents are printed after the last
expresion to replace the default empty string "".
Changing output after each feature
- hook599
- If this file exists, its contents are printed after each
feature to replace the default empty string "".
Changing output of the class invariant
For the header of the class invariant
- hook800
- If this hook file exists, and when no class invariant exists,
the contents of this file are printed to replace the default empty
string "".
- hook811
- If this hook file exists, the contents of this file is
printed before the class invariant to replace the default string
"invariant%N".
- hook812
- If this file exists, its contents are printed when the class
invariant has no heading comment to replace default empty string "".
- hook813
- If this file exists, its contents are printed once before
the invariant heading comment to replace the default empty string "".
- hook814
- If this file exists, its contents are printed before each line
of the heading comment to replace the default string " -- ".
- hook855
- If this file exists, its contents are printed after each line
of the heading comment to replace the default string "%N".
- hook816
- If this file exists, its contents are printed once after the
invariant heading comment.
- hook817
- If this file exists, its contents are printed when class
invariant has no assertion to replace the default empty string "".
- hook818
- If this file exists, its contents are printed once before
the first assertion of the class invariant to replace the default
empty string "".
- hook833
- If this file exists, its contents are printed once after the last
assertion of the class invariant to replace the default empty string "".
- hook834
- If this file exists, its contents are printed to finish the
class invariant to replace the default empty string "".
For each assertion in the class invariant
- hook819
- If this file exists, its contents are printed before each
assertion of the class invariant to replace the default string " ".
- hook820
- If this file exists, its contents are printed when an assertion
has no tag to replace the default empty string "".
- hook821
- If this file exists, its contents are printed before a tag to
replace the default empty string "".
- hook822
- If this file exists, its contents are printed after a tag to
replace the default string ": ".
- hook823
- If this file exists, its contents are printed when the assertion
has no expression to replace the default empty string "".
- hook824
- If this file exists, its contents are printed before the
expression to replace the default empty string "".
- hook825
- If this file exists, its contents are printed after the
expresion (except for the last assertion) to replace the default string ";".
- hook826
- If this file exists, its contents are printed when an assertion
has no comment to replace the default string "%N".
- hook827
- If this file exists, its contents are printed once before the
assertion comment to replace the default empty string "".
- hook828
- If this file exists, its contents are printed before each line
of the expression comment to replace the default string " -- ".
- hook829
- If this file exists, its contents are printed after each line
of the expression comment to replace the default string "%N".
- hook830
- If this file exists, its contents are printed once after the
assertion's comment to replace the default string "".
- hook831
- If this file exists, its contents are printed after the
assertion to replace the default empty string "".
For the last assertion in the class invariant
Same hook files list as described in the previous section except hook825 which
becomes :
- hook832
- If this file exists, its contents are printed after the
last expresion to replace the default string ";".
Changing output of the class interface footer
- hook900
- When this file exists, its contents are printed once before the
class footer to replace the default empty string "".
- hook901
- When this file exists, its contents are printed once at the end
of an expanded class before the class name to replace the default "end of expanded ".
- hook902
- When this file exists, its contents are printed once at the end
of a deferred class before the class name to replace the default "end of deferred ".
- hook903
- When this file exists, its contents are printed once at the end
of an ordinary (not expanded nor deferred) class, before the class name
to replace the default string "end of ".
- hook904
- When this file exists, its contents are printed just before the
class name to replace the default empty string "".
- hook905
- When it exists, the contents of this file are printed after the
class name to replace the default string "%N".
- hook999
- If this hook file exists, its contents are printed once to
finish the job.
Changing the output of class names
- Bcn
- When this file exists, its contents are printed before each class name.
- Acn
- When this file exists, its contents are printed after each class name.
- Ucn
- To replace the underscore character in a class name.
Changing the output of a type mark
- Btm
- When this file exists, its contents are printed before each type mark.
- Atm
- When this file exists, its contents are printed after each type mark.
- open_sb
- To replace the opening square bracket (default "[").
- close_sb
- To replace the closing square bracket (default "]").
- fgl_sep
- To replace the default comma "," in a formal generic
argument list.
- tm_blank
- To replace a blank character in a type mark.
- tm_sep
- To replace default string "," as a separator in a generic
list.
- like
- To replace the default string "like ".
- expanded
- To replace the default string "expanded ".
Changing the output of feature names
Simple feature names
- Bsfn
- When this file exists, its contents are printed before each
Simple Feature Name.
- Asfn
- When this file exists, its contents are printed after each
Simple Feature Name.
- Usfn
- To replace the underscore character in a simple feature name.
Infix feature names
- Bifn
- When it exists, this file's contents replace the default
string "infix %"" before an infix feature name definition.
- Aifn
- When it exists, this file's contents replace the default
string "%"" to close Bifn.
- Binfix
- When it exists, this file's contents replace the default
string " " printed before the infix name used in an expression.
- Ainfix
- When it exists, this file's contents replace the default
string " " printed after the infix name used in an expression.
- rem
- When it exists, this file's contents replace the default string "\\".
Prefix feature names
- Bpfn
- When it exists, this file's contents replace the default string
"prefix %"" before a prefix feature name definition.
- Apfn
- When it exists, this file's contents replace the default string
"%"" to close Bpfn.
Changing the output of an argument name
- Ban
- When this file exists, its contents are printed before each
argument name.
- Aan
- When this file exists, its contents are printed after each
argument name.
- Uan
- To replace the underscore character in an argument name.
Changing the output of a tag name
- Btag
- When this file exists, its contents are printed before each tag name.
- Atag
- When this file exists, its contents are printed after each tag name.
- Utag
- To replace the underscore character in a tag name.
Changing the output of an effective argument list
- op_eal
- To replace the default string "(" to open an effective argument list.
- eal_sep
- To replace the default string "," in an effective argument list.
- cl_eal
- To replace the default string ")" for an effective argument list.
Changing the output of manifest strings
- open_ms
- To replace the default opening string "%"".
- close_ms
- To replace the default closing string "%"".
- Prcnt_ms
- To replace a % character inside a manifest string.
- Slash_ms
- To replace a / character inside a manifest string.
Changing the output of a manifest array
- op_ma
- To replace the default string "<<" to open a manifest array.
- ma_sep
- To replace the default string "," in a manifest array.
- cl_ma
- To replace the default string ">>" to close a manifest array.
Changing the output of comments line
- BECL
- Before Each Comment Line. This hook is applied to all comments
whatever the kind of comment. If this file exists, its contents are
printed before the contents of each line of each comment (usually
after the default string "-- ").
- AECL
- After Each Comment Line. This hook is applied to all comments
whatever the kind of comment. If exits, printed after the contents
of each line of each comment (usually, printed before the default "%N").
- Ucomment
- To replace the underscore character in a comment.
- op_quote
- To replace the default opening quote mark "`".
- cl_quote
- To close an op_quote to replace the closing quote mark "'".
Miscellaneous tuning
- open_b
- To replace the default opening bracket "(" in expressions.
- close_b
- To replace the default closing bracket ")" in expressions.
- arrow
- - To replace the default string " >" in a formal generic list.
- dot
- To replace the default string "." in an expression.
- Result
- To replace the default string "Result".
- old
- To replace the default string "old " in ensure clauses.
- op_strip
- To replace the default string "strip (".
- cl_strip
- To replace default string ")" which closes op_strip.
- fnl_sep
- To replace the default string ", " in a feature name list.
- Current
- To replace the default string "Current".
- Void
- To replace the default string "Void".
Top
print_jvm_class
Base library
This page was last changed by Oliver Elphick on 13th October 1997.