eu.bandm.tools.d2d2.base

Class Def2Doc3

java.lang.Object

eu.bandm.tools.d2d2.base.Def2Doc3

public class Def2Doc3
extends Object

Create Xhtml documentation of a ResolvedModule, as produced by eu.bandm.tools.d2d2.base.Resover3 (new at 201060823).
Usage pattern: (1) Create fresh instance (alwas anew, no re-usage)
(2) call main entry method #makeHtmlDoc(ModuleRegistry,Module,boolean,String,String,NamespaceName2String)
(3) Then the directory (specified in (1)) will be filled with main "index.html" and many "*.png", etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Def2Doc3.RefPainter_custom

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Module>	allRawModules
protected List<Module>	allRawModulesSorted
static String	anchor_listOfDocEntries
static String	anchorname_toc
protected static Function<Element_block_content,Element_td.Content>	blockContent_2_tdContents
protected List<Element_block_content>	bodysubs
static String	classname_contextpath_in_header
static String	classname_creationcommand
static String	classname_defcategory_in_header
static String	classname_defname_in_header
static String	classname_enum_intconst
static String	classname_enumtable
static String	classname_error
static String	classname_footertext
static String	classname_modulename_in_header
static String	classname_nestedModuleTable
static String	classname_syntaxgraph_image
static String	classname_text_generic
protected Function<Definition,String>	def2anchor_false
protected Map<DefInstance,Definition>	defi2rewritten
protected DocTexts	docTexts
protected static Text2Udom.ErrorStrategy	docu_errorstrategy
protected static String	docu_prefix
protected Element_img	el_img_pcdata cache
static Element_br	element_br
static Element_hr	element_hr
protected Element_block_content[]	emptyBC
protected Element_tr.Choice_1_Alt_2	emptyTd
static int	erronuousExitCode
protected File	generatedDir
protected Function<Definition,String>	getCategory
static String	hashmark
protected Set<DefInstance>	hasHomonyms Contains all instantiated definitions which have homonyms in some other module instantiation.
static String	image_file_suffix
static String	imageFormat
static String	item_in_line_separator Attention, must be in in sync with ddfDoc.js
protected String	languagecode
protected int	lineWidth
static String	local_copy_css
static String	local_copy_js
static String	map_prefix
protected ModuleRegistry	moduleRegistry
protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>>	msg
protected MessageReceiver<SimpleMessage<String>>	msgMEMSTRING
String	prefix_anchor_declaration
String	prefix_anchor_importitem
String	prefix_anchor_module
static String	prefix_local_anchor
static String	resource_position_ddfdoc_css
static String	resource_position_ddfdoc_js
protected NamespaceName2String	stylesheetParams
protected Multimap<String,DefInstance>	tag2defi
protected String	targetcode
protected List<Element_li>	toctoclist
protected ResolvedModule	topModule
protected String	topModuleName Name without Resolver3.rootModuleExpandedSuffix = "$expanded" .
protected Module	topModuleRaw
static String	url_ddfdoc_css
static String	url_ddfdoc_js
protected Multimap<Definition,Definition>	uses Maps all definitions to points of usage.
static int	xml_lineWidth

Constructor Summary

Constructors

Constructor and Description
Def2Doc3(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, File generatedDir, int lineWidth)

Method Summary

Modifier and Type	Method and Description
protected String	defi2anchor(DefInstance defi, boolean isName)
protected String	defi2minUniqueName(DefInstance defi)
protected String	defi2tooltip(DefInstance defi)
protected String	defi2uniqueId(DefInstance defi)
protected String	defrw2minUniqueName(Definition def)
protected String	defrw2tooltip(Definition defrw)
protected String	dyn_module2anchor(Module mod, boolean isName)
protected void	error(Exception ex, String s)
protected void	error(Location<XMLDocumentIdentifier> loc, String s)
protected void	error(String s)
protected Element_block_content[]	f_renderDocu(CheckedList<LocString> in, String docu_ident)
protected Element_block_content[]	f_renderDocu(String docu_text, String docu_ident)
protected void	failure(String s)
protected String	getCategory_short(DefInstance defi)
protected String	getCategory(Definition def) NO MuLi support, since this is a TECHNICAL word which has to be used as such, fixed by the grammar of definition modules, idenpendently from locale.
static String	getSuffix(String fname)
static String	joinAllDocStrings(CheckedList<LocString> list)
protected void	listUsage(DefInstance defi, Definition defrw)
protected void	loadDocTextXsltTransformation() Prepare the txsl application, see Batch.java:
protected void	logEnd(String s)
protected void	logStart(String s)
protected void	makeDocuTable()
protected void	makeEnumTable(Enumeration def) Generates a tabular visualisation of an enum, following the numerical values.
protected void	makeHomonymList()
void	makeHtmlDoc(ModuleRegistry moduleRegistry, ResolvedModule mod, String targetcode, String generationString, NamespaceName2String stylesheetParams) Make xhtml-documentation of one top module and its childs or imports.
protected void	makeImportGraph()
protected Element_a	makeJumpTo(Definition def)
protected Element_a	makeJumpTo(DefInstance defi)
protected void	makeJumpToToc()
protected void	makeModuleTable()
void	makePngAndMap(DefInstance defi, XRegExp def0) Create one single graphic file containing the graphic representation of the syntax of one single declaration.
protected void	makePublicToplevelTagList()
protected void	makeTagList()
protected void	makeTagListEntry(String tag, DefInstance defi, List<Element_li> toclist)
protected void	markRawModule(Module mod)
protected Element_tr.Choice_1_Alt_2	packTd(String s)
protected void	renderDocu(SourceItem item) Convert the docu text for the given item, selected by the value of targetcode from d2d source into xhtml.
protected void	renderModulesAndDefis() Make the doc entry for one MODULE INSTANTIATION Print a header, print the module-related docu text, iff present in the selected language, call #renderOneDefInstance(String, Definition) for all defs which are reachable from the top module's definitions.
protected void	renderOneDefInstance(String modulename, DefInstance defi) Make the doc entry for one (INSTANTIATED) DECLARATION.
protected void	showModuleImports(int indent, String prefix, Module rawModule, List<Element_tr> akku, Set<Module> done, Set<Module> active)
static String[]	splitByFirst(String text)
static Function<String,String>	stringPrepend(String s0) DISLOC FIXME to ops/Functions ??
protected Element_tr.Choice_1_Alt_2	td_textAndClass(String text, String cls)
protected Element_tr.Choice_1_Alt_2	td_textClassJump(String text, String cls, String href, boolean defining)
protected void	warning(String s)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

url_ddfdoc_js

public static final String url_ddfdoc_js

See Also:

Constant Field Values

resource_position_ddfdoc_js

public static final String resource_position_ddfdoc_js

See Also:

Constant Field Values

local_copy_js

public static final String local_copy_js

See Also:

Constant Field Values

url_ddfdoc_css

public static final String url_ddfdoc_css

See Also:

Constant Field Values

resource_position_ddfdoc_css

public static final String resource_position_ddfdoc_css

See Also:

Constant Field Values

local_copy_css

public static final String local_copy_css

See Also:

Constant Field Values

item_in_line_separator

public static final String item_in_line_separator

Attention, must be in in sync with ddfDoc.js

See Also:

Constant Field Values

erronuousExitCode

public static final int erronuousExitCode

See Also:

Constant Field Values

imageFormat

public static final String imageFormat

See Also:

Constant Field Values

image_file_suffix

public static final String image_file_suffix

See Also:

Constant Field Values

map_prefix

public static final String map_prefix

See Also:

Constant Field Values

hashmark

public static final String hashmark

See Also:

Constant Field Values

prefix_local_anchor

public static final String prefix_local_anchor

See Also:

Constant Field Values

classname_error

public static final String classname_error

See Also:

Constant Field Values

classname_defcategory_in_header

public static final String classname_defcategory_in_header

See Also:

Constant Field Values

classname_defname_in_header

public static final String classname_defname_in_header

See Also:

Constant Field Values

classname_modulename_in_header

public static final String classname_modulename_in_header

See Also:

Constant Field Values

classname_contextpath_in_header

public static final String classname_contextpath_in_header

See Also:

Constant Field Values

classname_text_generic

public static final String classname_text_generic

See Also:

Constant Field Values

classname_syntaxgraph_image

public static final String classname_syntaxgraph_image

See Also:

Constant Field Values

classname_enum_intconst

public static final String classname_enum_intconst

See Also:

Constant Field Values

classname_enumtable

public static final String classname_enumtable

See Also:

Constant Field Values

classname_nestedModuleTable

public static final String classname_nestedModuleTable

See Also:

Constant Field Values

classname_footertext

public static final String classname_footertext

See Also:

Constant Field Values

classname_creationcommand

public static final String classname_creationcommand

See Also:

Constant Field Values

anchorname_toc

public static final String anchorname_toc

See Also:

Constant Field Values

anchor_listOfDocEntries

public static final String anchor_listOfDocEntries

See Also:

Constant Field Values

prefix_anchor_module

public final String prefix_anchor_module

See Also:

Constant Field Values

prefix_anchor_declaration

public final String prefix_anchor_declaration

See Also:

Constant Field Values

prefix_anchor_importitem

public final String prefix_anchor_importitem

See Also:

Constant Field Values

element_hr

public static final Element_hr element_hr

element_br

public static final Element_br element_br

emptyBC

protected final Element_block_content[] emptyBC

emptyTd

protected final Element_tr.Choice_1_Alt_2 emptyTd

docu_prefix

protected static final String docu_prefix

See Also:

Constant Field Values

docu_errorstrategy

protected static final Text2Udom.ErrorStrategy docu_errorstrategy

docTexts

protected DocTexts docTexts

msg

protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg

msgMEMSTRING

protected MessageReceiver<SimpleMessage<String>> msgMEMSTRING

generatedDir

protected File generatedDir

lineWidth

protected int lineWidth

xml_lineWidth

public static int xml_lineWidth

moduleRegistry

protected ModuleRegistry moduleRegistry

topModule

protected ResolvedModule topModule

topModuleRaw

protected Module topModuleRaw

topModuleName

protected String topModuleName

Name without Resolver3.rootModuleExpandedSuffix = "$expanded" .

targetcode

protected String targetcode

languagecode

protected String languagecode

stylesheetParams

protected NamespaceName2String stylesheetParams

bodysubs

protected final List<Element_block_content> bodysubs

toctoclist

protected final List<Element_li> toctoclist

allRawModules

protected Set<Module> allRawModules

allRawModulesSorted

protected List<Module> allRawModulesSorted

defi2rewritten

protected Map<DefInstance,Definition> defi2rewritten

tag2defi

protected Multimap<String,DefInstance> tag2defi

hasHomonyms

protected Set<DefInstance> hasHomonyms

Contains all instantiated definitions which have homonyms in some other module instantiation.

uses

protected Multimap<Definition,Definition> uses

Maps all definitions to points of usage.

el_img_pcdata

protected Element_img el_img_pcdata

cache

getCategory

protected final Function<Definition,String> getCategory

blockContent_2_tdContents

protected static final Function<Element_block_content,Element_td.Content> blockContent_2_tdContents

def2anchor_false

protected Function<Definition,String> def2anchor_false

Constructor Detail

Def2Doc3

public Def2Doc3(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
                File generatedDir,
                int lineWidth)

Parameters:

msg - MessageReceiver

generatedDir - must exist as a directory, but should be empty.

lineWidth - for the printing of the re-constructed definition fragments

Method Detail

error

protected void error(String s)

warning

protected void warning(String s)

error

protected void error(Location<XMLDocumentIdentifier> loc,
                     String s)

error

protected void error(Exception ex,
                     String s)

logStart

protected void logStart(String s)

logEnd

protected void logEnd(String s)

failure

protected void failure(String s)

splitByFirst

public static String[] splitByFirst(String text)

getSuffix

public static String getSuffix(String fname)

joinAllDocStrings

public static String joinAllDocStrings(CheckedList<LocString> list)

loadDocTextXsltTransformation

protected void loadDocTextXsltTransformation()

Prepare the txsl application, see Batch.java:

renderDocu

protected void renderDocu(SourceItem item)

Convert the docu text for the given item, selected by the value of targetcode from d2d source into xhtml. Append the latter to the growing list bodysubs.

f_renderDocu

protected Element_block_content[] f_renderDocu(CheckedList<LocString> in,
                                               String docu_ident)

f_renderDocu

protected Element_block_content[] f_renderDocu(String docu_text,
                                               String docu_ident)

makePngAndMap

public void makePngAndMap(DefInstance defi,
                          XRegExp def0)

Create one single graphic file containing the graphic representation of the syntax of one single declaration.
Calls layouter and painter, and let the latter paint to a buffered image and writes this into a PNG file the name of which is generated from the path of the declaration.
Add a html:map element with LINKS to the corresponding declarations.

getCategory

protected String getCategory(Definition def)

NO MuLi support, since this is a TECHNICAL word which has to be used as such, fixed by the grammar of definition modules, idenpendently from locale.

getCategory_short

protected String getCategory_short(DefInstance defi)

makeEnumTable

protected void makeEnumTable(Enumeration def)

Generates a tabular visualisation of an enum, following the numerical values.
FIXME MISSING: docu texts for single enum items !!

listUsage

protected void listUsage(DefInstance defi,
                         Definition defrw)

makeJumpTo

protected Element_a makeJumpTo(Definition def)

makeJumpTo

protected Element_a makeJumpTo(DefInstance defi)

makeJumpToToc

protected void makeJumpToToc()

dyn_module2anchor

protected String dyn_module2anchor(Module mod,
                                   boolean isName)

Parameters:

isName - if it is the DEFINING "a"-element, not a refering one.

defrw2minUniqueName

protected String defrw2minUniqueName(Definition def)

defi2minUniqueName

protected String defi2minUniqueName(DefInstance defi)

defi2uniqueId

protected String defi2uniqueId(DefInstance defi)

Parameters:

isName - if it is the DEFINING "a"-element, not a refering one.

defi2anchor

protected String defi2anchor(DefInstance defi,
                             boolean isName)

Parameters:

isName - if it is the DEFINING "a"-element, not a refering one.

defrw2tooltip

protected String defrw2tooltip(Definition defrw)

defi2tooltip

protected String defi2tooltip(DefInstance defi)

stringPrepend

public static Function<String,String> stringPrepend(String s0)

DISLOC FIXME to ops/Functions ??

makePublicToplevelTagList

protected void makePublicToplevelTagList()

makeTagList

protected void makeTagList()

makeHomonymList

protected void makeHomonymList()

makeTagListEntry

protected void makeTagListEntry(String tag,
                                DefInstance defi,
                                List<Element_li> toclist)

makeModuleTable

protected void makeModuleTable()

td_textAndClass

protected Element_tr.Choice_1_Alt_2 td_textAndClass(String text,
                                                    String cls)

td_textClassJump

protected Element_tr.Choice_1_Alt_2 td_textClassJump(String text,
                                                     String cls,
                                                     String href,
                                                     boolean defining)

showModuleImports

protected void showModuleImports(int indent,
                                 String prefix,
                                 Module rawModule,
                                 List<Element_tr> akku,
                                 Set<Module> done,
                                 Set<Module> active)

packTd

protected Element_tr.Choice_1_Alt_2 packTd(String s)

makeDocuTable

protected void makeDocuTable()

makeImportGraph

protected void makeImportGraph()

renderOneDefInstance

protected void renderOneDefInstance(String modulename,
                                    DefInstance defi)

Make the doc entry for one (INSTANTIATED) DECLARATION.

1. Print a header,
2. print the related docu text, iff present in the selected language,
3. print an enum table or a syntax graph
4. list cross-ref of usage
5. list homonyms

renderModulesAndDefis

protected void renderModulesAndDefis()

Make the doc entry for one MODULE INSTANTIATION

1. Print a header,
2. print the module-related docu text, iff present in the selected language,
3. call #renderOneDefInstance(String, Definition) for all defs which are reachable from the top module's definitions.

POSSIBLE EXTENSION : list all IMPORT ITEMS !?!?

markRawModule

protected void markRawModule(Module mod)

makeHtmlDoc

public void makeHtmlDoc(ModuleRegistry moduleRegistry,
                        ResolvedModule mod,
                        String targetcode,
                        String generationString,
                        NamespaceName2String stylesheetParams)

Make xhtml-documentation of one top module and its childs or imports.
"static" mode is one un-instantiated module with all contained sub-modules.
"dynamic" mode is one instantiated module with all referred-to (imported) declarations.
Contained in ONE "index.html" page, with header and table of contents and registers, and many "*.png"s The target directory where all these are stored into has been defined on creation.
The muli-translations are pre-compiled into DocTexts.
FIXME --- parametrization variant missing for dynamic case: only visit A LIST OF (one or more selected) declarations, not whole module !!

Parameters:

mod - the loaded module, either raw or instantiated

targetcode - the documentation key for doc-texts from the module's source file to include.

generationString - the text for the footer

stylesheetParams - the usual xslt parameters for "d2d_gp to_xhtml_1_0"