538 lines
20 KiB
OpenEdge ABL
538 lines
20 KiB
OpenEdge ABL
[Formats::] Weave Formats.
|
|
|
|
To characterise the different weaving output formats (text, typeset,
|
|
web and so on).
|
|
|
|
@h Formats.
|
|
Exactly as in the previous chapter, each format expresses its behaviour
|
|
through optional method calls.
|
|
|
|
=
|
|
typedef struct weave_format {
|
|
struct text_stream *format_name;
|
|
struct text_stream *woven_extension;
|
|
METHOD_CALLS
|
|
MEMORY_MANAGEMENT
|
|
} weave_format;
|
|
|
|
weave_format *Formats::create_weave_format(text_stream *name, text_stream *ext) {
|
|
weave_format *wf = CREATE(weave_format);
|
|
wf->format_name = Str::duplicate(name);
|
|
wf->woven_extension = Str::duplicate(ext);
|
|
ENABLE_METHOD_CALLS(wf);
|
|
return wf;
|
|
}
|
|
|
|
weave_format *Formats::find_by_name(text_stream *name) {
|
|
weave_format *wf;
|
|
LOOP_OVER(wf, weave_format)
|
|
if (Str::eq_insensitive(name, wf->format_name))
|
|
return wf;
|
|
return NULL;
|
|
}
|
|
|
|
@ Note that this is the file extension before any post-processing. For
|
|
example, PDFs are made by weaving a TeX file and then running this through
|
|
|pdftex|. The extension here will be |.tex| because that's what the weave
|
|
stage produces, even though we will later end up with a |.pdf|.
|
|
|
|
=
|
|
text_stream *Formats::file_extension(weave_format *wf) {
|
|
return wf->woven_extension;
|
|
}
|
|
|
|
@h Creation.
|
|
This must be performed very early in Inweb's run.
|
|
|
|
=
|
|
void Formats::create_weave_formats(void) {
|
|
TeX::create();
|
|
PlainText::create();
|
|
HTMLFormat::create();
|
|
}
|
|
|
|
@h Methods.
|
|
These two don't allow output to be produced: they're for any setting up and
|
|
putting away that needs tp be done.
|
|
|
|
|BEGIN_WEAVING_FOR_MTID| is called before any output is generated, indeed,
|
|
before even the filename(s) for the output are worked out. Note that it
|
|
can return a |*_SWM| code to change the swarm behaviour of the weave to come;
|
|
this is helpful for EPUB weaving.
|
|
|
|
More simply, |END_WEAVING_FOR_MTID| is called when all weaving is done.
|
|
|
|
@e BEGIN_WEAVING_FOR_MTID
|
|
@e END_WEAVING_FOR_MTID
|
|
|
|
=
|
|
IMETHOD_TYPE(BEGIN_WEAVING_FOR_MTID, weave_format *wf, web *W, weave_pattern *pattern)
|
|
VMETHOD_TYPE(END_WEAVING_FOR_MTID, weave_format *wf, web *W, weave_pattern *pattern)
|
|
int Formats::begin_weaving(web *W, weave_pattern *pattern) {
|
|
int rv = FALSE;
|
|
IMETHOD_CALL(rv, pattern->pattern_format, BEGIN_WEAVING_FOR_MTID, W, pattern);
|
|
if (rv) return rv;
|
|
return SWARM_OFF_SWM;
|
|
}
|
|
void Formats::end_weaving(web *W, weave_pattern *pattern) {
|
|
VMETHOD_CALL(pattern->pattern_format, END_WEAVING_FOR_MTID, W, pattern);
|
|
}
|
|
|
|
@ Now the weave output, roughly in order from top to bottom.
|
|
|
|
|TOP_FOR_MTID| has the opportunity to put a header at the top of the woven
|
|
file. The |comment| will be anodyne text such as "Weave of... generated at...",
|
|
which isn't intended to be read by human eyes, and might become e.g. an
|
|
HTML comment.
|
|
|
|
@e TOP_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(TOP_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv, text_stream *comment)
|
|
void Formats::top(OUTPUT_STREAM, weave_target *wv, text_stream *comment) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, TOP_FOR_MTID, OUT, wv, comment);
|
|
}
|
|
|
|
@ The |TOC_FOR_MTID| method should weave a table of contents at the top of a section.
|
|
It is called with four possible values of |stage|:
|
|
|
|
(a) 1 for the introductory text, which is in |text1|;
|
|
(b) 2 for a division between contents items;
|
|
(c) 3 for a contents item, with paragraph number |text1| and heading |text2|;
|
|
(d) 4 for any concluding text, such as a full stop, or skipped line.
|
|
|
|
@e TOC_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(TOC_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv,
|
|
int stage, text_stream *text1, text_stream *text2, paragraph *P)
|
|
void Formats::toc(OUTPUT_STREAM, weave_target *wv, int stage, text_stream *text1,
|
|
text_stream *text2, paragraph *P) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, TOC_FOR_MTID, OUT, wv, stage, text1, text2, P);
|
|
}
|
|
|
|
@ When whole chapters are wovem, or all-in-one weaves include multiple
|
|
chapters, the format can add a table of chapter contents, or some similar
|
|
interstitial material. This is how:
|
|
|
|
@e CHAPTER_TP_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(CHAPTER_TP_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv, chapter *C)
|
|
void Formats::chapter_title_page(OUTPUT_STREAM, weave_target *wv, chapter *C) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, CHAPTER_TP_FOR_MTID, OUT, wv, C);
|
|
}
|
|
|
|
@ The |SUBHEADING_FOR_MTID| method is expected to produce subheadings of
|
|
two levels of importance, where |level| is
|
|
|
|
(a) 1 for extract subheadings used in themed weaves, or
|
|
(b) 2 for minor headings such as the "Purpose" at the top of a section,
|
|
or (for old webs which still have them) "Definitions" headings.
|
|
|
|
Note that paragraph headings (the result of |@h|) do not fall under this
|
|
method. The |heading| is the text for it; the |addendum| if not |NULL| is
|
|
some supplementary text, used in some cases for running heads.
|
|
|
|
@e SUBHEADING_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(SUBHEADING_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv,
|
|
int level, text_stream *heading, text_stream *addendum)
|
|
void Formats::subheading(OUTPUT_STREAM, weave_target *wv, int level,
|
|
text_stream *heading, text_stream *addendum) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, SUBHEADING_FOR_MTID, OUT, wv, level, heading, addendum);
|
|
}
|
|
|
|
@ And now we do paragraph headings. This method has rather a lot of
|
|
arguments, but for most formats, some can be ignored. In particular
|
|
|TeX_macro|, |chaptermark|, and |sectionmark| have been precalculated for
|
|
the benefit of the TeX format, and all other formats can leave them be.
|
|
|
|
|weight| is more significant, and is
|
|
|
|
(a) 1 for a |@h| paragraph heading,
|
|
(b) 2 for a section heading,
|
|
(c) 3 for a chapter heading.
|
|
|
|
In each case, the text of the heading is (unsurprisingly) in |heading_text|.
|
|
|
|
@e PARAGRAPH_HEADING_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(PARAGRAPH_HEADING_FOR_MTID, weave_format *wf, text_stream *OUT,
|
|
weave_target *wv, text_stream *TeX_macro, section *S, paragraph *P,
|
|
text_stream *heading_text, text_stream *chaptermark, text_stream *sectionmark, int weight)
|
|
void Formats::paragraph_heading(OUTPUT_STREAM, weave_target *wv, text_stream *TeX_macro,
|
|
section *S, paragraph *P, text_stream *heading_text, text_stream *chaptermark, text_stream *sectionmark,
|
|
int weight) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, PARAGRAPH_HEADING_FOR_MTID, OUT, wv, TeX_macro, S, P, heading_text, chaptermark, sectionmark, weight);
|
|
}
|
|
|
|
@ The following method is expected to weave a piece of code, which has already
|
|
been syntax-coloured; there can also be some indentation, and perhaps even some
|
|
|prefatory| text before the line of code, and also potentially a
|
|
|concluding_comment| at the end of the line.
|
|
|
|
@e SOURCE_CODE_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(SOURCE_CODE_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv,
|
|
int tab_stops_of_indentation, text_stream *prefatory, text_stream *matter,
|
|
text_stream *colouring, text_stream *concluding_comment, int starts, int finishes,
|
|
int code_mode)
|
|
|
|
void Formats::source_code(OUTPUT_STREAM, weave_target *wv, int tab_stops_of_indentation,
|
|
text_stream *prefatory, text_stream *matter, text_stream *colouring,
|
|
text_stream *concluding_comment, int starts, int finishes, int code_mode) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, SOURCE_CODE_FOR_MTID, OUT, wv, tab_stops_of_indentation,
|
|
prefatory, matter, colouring, concluding_comment, starts, finishes, code_mode);
|
|
}
|
|
|
|
@ More primitively, this method weaves a piece of code which has been coloured
|
|
drably in a uniform |EXTRACT_COLOUR| colour. This is used for weaving words like
|
|
|these_ones| of code given inside commentary.
|
|
|
|
@e INLINE_CODE_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(INLINE_CODE_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv, int pre)
|
|
void Formats::source_fragment(OUTPUT_STREAM, weave_target *wv, text_stream *fragment) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, INLINE_CODE_FOR_MTID, OUT, wv, TRUE);
|
|
TEMPORARY_TEXT(colouring);
|
|
for (int i=0; i< Str::len(fragment); i++) PUT_TO(colouring, EXTRACT_COLOUR);
|
|
Formats::source_code(OUT, wv, 0, I"", fragment, colouring, I"", FALSE, FALSE, TRUE);
|
|
DISCARD_TEXT(colouring);
|
|
VMETHOD_CALL(wf, INLINE_CODE_FOR_MTID, OUT, wv, FALSE);
|
|
}
|
|
|
|
@ This method produces the |>> Example| bits of example source text, really
|
|
a convenience for Inform 7 code commentary.
|
|
|
|
@e DISPLAY_LINE_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(DISPLAY_LINE_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv, text_stream *from)
|
|
void Formats::display_line(OUTPUT_STREAM, weave_target *wv, text_stream *from) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, DISPLAY_LINE_FOR_MTID, OUT, wv, from);
|
|
}
|
|
|
|
@ |ITEM_FOR_MTID| produces an item marker in a typical (a), (b), (c), ... sort
|
|
of list. |depth| can be 1 or 2: you can have lists in lists, but not lists in
|
|
lists in lists. |label| is the marker text, e.g., |a|, |b|, |c|, ...; it can
|
|
also be empty, in which case the method should move to the matching level of
|
|
indentation but not weave any bracketed marker.
|
|
|
|
(a) This was produced by |depth| equal to 1, |label| equal to |a|.
|
|
(-i) This was produced by |depth| equal to 2, |label| equal to |i|.
|
|
(-ii) This was produced by |depth| equal to 2, |label| equal to |ii|.
|
|
(...) This was produced by |depth| equal to 1, |label| empty.
|
|
(b) This was produced by |depth| equal to 1, |label| equal to |b|.
|
|
|
|
@e ITEM_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(ITEM_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv,
|
|
int depth, text_stream *label)
|
|
void Formats::item(OUTPUT_STREAM, weave_target *wv, int depth, text_stream *label) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, ITEM_FOR_MTID, OUT, wv, depth, label);
|
|
}
|
|
|
|
@ The "bar" is a horizontal line across the page, but it's woven only for
|
|
very old webs nowadays. New formats really needn't implement this.
|
|
|
|
@e BAR_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(BAR_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv)
|
|
void Formats::bar(OUTPUT_STREAM, weave_target *wv) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, BAR_FOR_MTID, OUT, wv);
|
|
}
|
|
|
|
@ |FIGURE_FOR_MTID| has to weave a figure, i.e., render an image in some way.
|
|
|figname| should be (the text of) a leafname within the |Figures| directory
|
|
of the web.
|
|
|
|
@e FIGURE_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(FIGURE_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv,
|
|
text_stream *figname, int w, int h)
|
|
void Formats::figure(OUTPUT_STREAM, weave_target *wv, text_stream *figname, int w, int h) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, FIGURE_FOR_MTID, OUT, wv, figname, w, h);
|
|
}
|
|
|
|
@ This method weaves an angle-bracketed paragraph macro name. |defn| is set
|
|
if and only if this is the place where the macro is defined -- the usual
|
|
thing is to render some sort of equals sign after it, if so.
|
|
|
|
@e PARA_MACRO_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(PARA_MACRO_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv,
|
|
para_macro *pmac, int defn)
|
|
void Formats::para_macro(OUTPUT_STREAM, weave_target *wv, para_macro *pmac, int defn) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, PARA_MACRO_FOR_MTID, OUT, wv, pmac, defn);
|
|
}
|
|
|
|
@ For many formats, page breaks are meaningless, and in that case this method
|
|
should not be provided. Inweb uses them only for cosmetic benefit (and rarely
|
|
at that), so no harm is done if there's no visual indication here.
|
|
|
|
@e PAGEBREAK_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(PAGEBREAK_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv)
|
|
void Formats::pagebreak(OUTPUT_STREAM, weave_target *wv) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, PAGEBREAK_FOR_MTID, OUT, wv);
|
|
}
|
|
|
|
@ "Blank line" here might better be called "vertical skip of some kind". The
|
|
following should render some kind of skip, and may want to take note of whether
|
|
this happens in commentary or in code: the |in_comment| flag provides this
|
|
information.
|
|
|
|
@e BLANK_LINE_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(BLANK_LINE_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv,
|
|
int in_comment)
|
|
void Formats::blank_line(OUTPUT_STREAM, weave_target *wv, int in_comment) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, BLANK_LINE_FOR_MTID, OUT, wv, in_comment);
|
|
}
|
|
|
|
@ Another opportunity for vertical tidying-up. At the beginning of a code
|
|
line which occurs after a run of |@d| or |@e| definitions, this method is
|
|
called. It can then insert a little vertical gap to separate the code from
|
|
the definitions.
|
|
|
|
@e AFTER_DEFINITIONS_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(AFTER_DEFINITIONS_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv)
|
|
void Formats::after_definitions(OUTPUT_STREAM, weave_target *wv) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, AFTER_DEFINITIONS_FOR_MTID, OUT, wv);
|
|
}
|
|
|
|
@ This method is called when the weaver changes "material" -- for example,
|
|
from |REGULAR_MATERIAL| to |CODE_MATERIAL|. The flag |content| is set if
|
|
the line on which this happens contains some content which will then be
|
|
woven; it will be clear for blank lines, or lines intercepted by the
|
|
weaver and turned into something else (such as list items).
|
|
|
|
@e CHANGE_MATERIAL_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(CHANGE_MATERIAL_FOR_MTID, weave_format *wf, text_stream *OUT,
|
|
weave_target *wv, int old_material, int new_material, int content)
|
|
void Formats::change_material(OUTPUT_STREAM, weave_target *wv,
|
|
int old_material, int new_material, int content) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, CHANGE_MATERIAL_FOR_MTID, OUT, wv, old_material, new_material, content);
|
|
}
|
|
|
|
@ This is called on a change of colour. "Colour" is really a shorthand way
|
|
of saying something more like "style", but seemed less ambiguous. In HTML,
|
|
this might trigger a change of CSS span style; in plain text, it would do
|
|
nothing.
|
|
|
|
@e CHANGE_COLOUR_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(CHANGE_COLOUR_FOR_MTID, weave_format *wf, text_stream *OUT,
|
|
weave_target *wv, int col, int in_code)
|
|
void Formats::change_colour(OUTPUT_STREAM, weave_target *wv, int col, int in_code) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, CHANGE_COLOUR_FOR_MTID, OUT, wv, col, in_code);
|
|
}
|
|
|
|
@ The following takes text, divides it up at stroke-mark boundaries --
|
|
that is, |this is inside|, this is outside -- and sends contiguous pieces
|
|
of it either to |Formats::source_fragment| or |Formats::text_fragment|
|
|
as appropriate.
|
|
|
|
=
|
|
void Formats::text(OUTPUT_STREAM, weave_target *wv, text_stream *id) {
|
|
Formats::text_r(OUT, wv, id, FALSE);
|
|
}
|
|
|
|
void Formats::text_r(OUTPUT_STREAM, weave_target *wv, text_stream *id, int within) {
|
|
for (int i=0; i < Str::len(id); i++) {
|
|
if (Str::get_at(id, i) == '\\') i++;
|
|
else if (Str::get_at(id, i) == '|') {
|
|
TEMPORARY_TEXT(before);
|
|
Str::copy(before, id); Str::truncate(before, i);
|
|
TEMPORARY_TEXT(after);
|
|
Str::substr(after, Str::at(id, i+1), Str::end(id));
|
|
Formats::text_r(OUT, wv, before, within);
|
|
Formats::text_r(OUT, wv, after, (within)?FALSE:TRUE);
|
|
DISCARD_TEXT(before);
|
|
DISCARD_TEXT(after);
|
|
return;
|
|
}
|
|
}
|
|
if (within) {
|
|
Formats::source_fragment(OUT, wv, id);
|
|
} else {
|
|
Formats::text_fragment(OUT, wv, id);
|
|
}
|
|
}
|
|
|
|
@ |COMMENTARY_TEXT_FOR_MTID| straightforwardly weaves out a run of contiguous
|
|
text. Ordinarily, any formulae written in TeX notation (i.e., in dollar signs
|
|
used as brackets) will be transmogrified into a plain text paraphrase, but
|
|
the |PRESERVE_MATH_MODE_FOR_MTID| can prevent this. (And of course the TeX
|
|
format does, because it wants to keep the formulae in all their glory.)
|
|
|
|
@e COMMENTARY_TEXT_FOR_MTID
|
|
@e PRESERVE_MATH_MODE_FOR_MTID
|
|
|
|
=
|
|
IMETHOD_TYPE(PRESERVE_MATH_MODE_FOR_MTID, weave_format *wf,
|
|
text_stream *matter, text_stream *id)
|
|
VMETHOD_TYPE(COMMENTARY_TEXT_FOR_MTID, weave_format *wf, text_stream *OUT,
|
|
weave_target *wv, text_stream *matter)
|
|
|
|
void Formats::text_fragment(OUTPUT_STREAM, weave_target *wv, text_stream *fragment) {
|
|
weave_format *wf = wv->format;
|
|
TEMPORARY_TEXT(matter);
|
|
int rv = FALSE;
|
|
IMETHOD_CALL(rv, wf, PRESERVE_MATH_MODE_FOR_MTID, matter, fragment);
|
|
if (rv == FALSE) TeX::remove_math_mode(matter, fragment);
|
|
else Str::copy(matter, fragment);
|
|
VMETHOD_CALL(wf, COMMENTARY_TEXT_FOR_MTID, OUT, wv, matter);
|
|
DISCARD_TEXT(matter);
|
|
}
|
|
|
|
@ The weaver has special typographical support for the stand-alone Inform
|
|
document of Preform grammar, and this is the hook for it. Most formats
|
|
should ignore it.
|
|
|
|
@e PREFORM_DOCUMENT_FOR_MTID
|
|
|
|
=
|
|
IMETHOD_TYPE(PREFORM_DOCUMENT_FOR_MTID, weave_format *wf, text_stream *OUT,
|
|
weave_target *wv, web *W, chapter *C, section *S, source_line *L,
|
|
text_stream *matter, text_stream *concluding_comment)
|
|
int Formats::preform_document(OUTPUT_STREAM, weave_target *wv, web *W,
|
|
chapter *C, section *S, source_line *L, text_stream *matter,
|
|
text_stream *concluding_comment) {
|
|
weave_format *wf = wv->format;
|
|
int rv = FALSE;
|
|
IMETHOD_CALL(rv, wf, PREFORM_DOCUMENT_FOR_MTID, OUT, wv, W, C, S, L, matter,
|
|
concluding_comment);
|
|
return rv;
|
|
}
|
|
|
|
@ When the weaver adds one of its endnotes -- "This function is used in...",
|
|
or some such -- it calls this method twice, once before the start, with
|
|
|end| set to 1, and once after the end, with |end| set to 2.
|
|
|
|
@e ENDNOTE_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(ENDNOTE_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv, int end)
|
|
void Formats::endnote(OUTPUT_STREAM, weave_target *wv, int end) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, ENDNOTE_FOR_MTID, OUT, wv, end);
|
|
}
|
|
|
|
@ "Locale" here isn't used in the Unix sense. It means text which describes
|
|
a range of numbered paragraphs, from |par1| to |par2|, though |par2| can
|
|
instead be null, in which case the description is of just one para. (This
|
|
is often used in endnotes.)
|
|
|
|
@e LOCALE_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(LOCALE_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv,
|
|
paragraph *par1, paragraph *par2)
|
|
void Formats::locale(OUTPUT_STREAM, weave_target *wv, paragraph *par1, paragraph *par2) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, LOCALE_FOR_MTID, OUT, wv, par1, par2);
|
|
}
|
|
|
|
@ And finally: the bottom of the woven file. The |comment| is, again, not
|
|
intended for human eyes, and will be some sort of "End of weave" remark.
|
|
|
|
@e TAIL_FOR_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(TAIL_FOR_MTID, weave_format *wf, text_stream *OUT, weave_target *wv,
|
|
text_stream *comment, section *S)
|
|
void Formats::tail(OUTPUT_STREAM, weave_target *wv, text_stream *comment, section *S) {
|
|
weave_format *wf = wv->format;
|
|
VMETHOD_CALL(wf, TAIL_FOR_MTID, OUT, wv, comment, S);
|
|
}
|
|
|
|
@h Post-processing.
|
|
Consider what happens when Inweb makes a PDF, via TeX. The initial weave is
|
|
to a TeX file; it's then "post-processing" which will turn this into a PDF.
|
|
The following method calls allow such two-stage formats to function; in
|
|
this case, it would be the PDF format which provides the necessary methods
|
|
to turn TeX into PDF. The important method is this one:
|
|
|
|
@e POST_PROCESS_POS_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(POST_PROCESS_POS_MTID, weave_format *wf, weave_target *wv, int open_afterwards)
|
|
void Formats::post_process_weave(weave_target *wv, int open_afterwards) {
|
|
VMETHOD_CALL(wv->format, POST_PROCESS_POS_MTID, wv, open_afterwards);
|
|
}
|
|
|
|
@ Optionally, a fancy report can be printed out, to describe what has been
|
|
done:
|
|
|
|
@e POST_PROCESS_REPORT_POS_MTID
|
|
|
|
=
|
|
VMETHOD_TYPE(POST_PROCESS_REPORT_POS_MTID, weave_format *wf, weave_target *wv)
|
|
void Formats::report_on_post_processing(weave_target *wv) {
|
|
VMETHOD_CALL(wv->format, POST_PROCESS_REPORT_POS_MTID, wv);
|
|
}
|
|
|
|
@ After post-processing, an index file is sometimes needed. For example, if a
|
|
big web is woven to a swarm of PDFs, one for each section, then we also want
|
|
to make an index page in HTML which provides annotated links to those PDFs.
|
|
|
|
@e INDEX_PDFS_POS_MTID
|
|
|
|
=
|
|
IMETHOD_TYPE(INDEX_PDFS_POS_MTID, weave_format *wf)
|
|
int Formats::index_pdfs(text_stream *format) {
|
|
weave_format *wf = Formats::find_by_name(format);
|
|
if (wf == NULL) return FALSE;
|
|
int rv = FALSE;
|
|
IMETHOD_CALLV(rv, wf, INDEX_PDFS_POS_MTID);
|
|
return rv;
|
|
}
|
|
|
|
@ And in that index file, we may want to substitute in values for placeholder
|
|
text like |[[PDF Size]]| in the template file. This is the |detail|.
|
|
|
|
@e POST_PROCESS_SUBSTITUTE_POS_MTID
|
|
|
|
=
|
|
IMETHOD_TYPE(POST_PROCESS_SUBSTITUTE_POS_MTID, weave_format *wf, text_stream *OUT,
|
|
weave_target *wv, text_stream *detail, weave_pattern *pattern)
|
|
int Formats::substitute_post_processing_data(OUTPUT_STREAM, weave_target *wv,
|
|
text_stream *detail, weave_pattern *pattern) {
|
|
int rv = FALSE;
|
|
IMETHOD_CALL(rv, wv->format, POST_PROCESS_SUBSTITUTE_POS_MTID, OUT, wv, detail, pattern);
|
|
return rv;
|
|
}
|