mirror of
https://github.com/ganelson/inform.git
synced 2024-07-07 17:44:22 +03:00
46 lines
2 KiB
OpenEdge ABL
46 lines
2 KiB
OpenEdge ABL
How To Include This Module.
|
|
|
|
What to do to make use of the inflections module in a new command-line tool.
|
|
|
|
@h Status.
|
|
The inflections module is provided as one of the "services" suite of modules,
|
|
which means that it was built with a view to potential incorporation in
|
|
multiple tools. It can be found, for example, in //inform7// and
|
|
//inflections-test//.
|
|
|
|
By convention, the modules considered as "services" have no dependencies on
|
|
other modules except for //foundation// and other "services" modules.
|
|
|
|
A tool can import //inflections// only if it also imports //foundation//,
|
|
//words// and //syntax//.
|
|
|
|
@h Importing the module.
|
|
We'll use the term "parent" to mean the tool which is importing //inflections//,
|
|
that is, which will include its code and be able to use it. As with any
|
|
imported module,
|
|
(*) The contents page of the parent's web must identify and locate the
|
|
module:
|
|
= (text as Inweb)
|
|
Import: somepath/inflections
|
|
=
|
|
(*) The parent must call |InflectionsModule::start()| just after it starts up, and
|
|
|InflectionsModule::end()| just before it shuts down. (But just after, and just
|
|
before, the corresponding calls to //foundation//.)
|
|
|
|
@h Using callbacks.
|
|
Shared modules like this one are tweaked in behaviour by defining "callback
|
|
functions". This means that the parent might provide a function of its own
|
|
which would answer a question put to it by the module, or take some action
|
|
on behalf of the module: it's a callback in the sense that the parent is
|
|
normally calling the module, but then the module calls the parent back to
|
|
ask for data or action.
|
|
|
|
This module has only two callbacks and both are optional:
|
|
|
|
(*) |VC_COMPILATION_INFLECTIONS_CALLBACK|, if provided, allows the |compilation_data|
|
|
part of a |verb_conjugation| to be initialised. See //Conjugation::conjugate//.
|
|
|
|
(*) |PREFORM_ERROR_INFLECTIONS_CALLBACK|, if provided, allows for more civilised
|
|
error messages than fatal halts if the Preform syntax for inflections turns out
|
|
to be defective, as can happen when non-English language bundles are being tested.
|