Def2Doc (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.d2d2.base.Def2Doc

```
public class Def2Doc
extends Object
```
Create Xhtml documentation of an (instantiated or un-instantiated) d2d module.
(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), already existing) will be filled with main "index.html" and many "*.png", etc.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Def2Doc.RefPainter_custom

Nested Classes
Modifier and Type	Class and Description
`static class`	`Def2Doc.RefPainter_custom`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`anchor_listOfDocEntries`
`static String`	`anchorname_toc`
`protected static Function<Element_block_content,Element_td.Content>`	`blockContent_2_tdContents`
`protected Vector<Element>`	`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_syntaxgraph_image`
`static String`	`classname_text_generic`
`protected DocTexts`	`docTexts`
`protected static Text2Udom.ErrorStrategy`	`docu_errorstrategy`
`protected static String`	`docu_prefix`
`protected Function<Definition,String>`	`dyn_def2anchor_false`
`protected Function<Definition,String>`	`dyn_fullname`
`protected boolean`	`dynamic`
`protected Set<XRegExp>`	`dynVisited_def`
`protected Element_img`	`el_img_pcdata`
`protected Element_block_content[]`	`emptyBC`
`static int`	`erronuousExitCode`
`protected Map<String,Module>`	`fullpath2module`
`protected File`	`generatedDir`
`protected Multimap<Definition,Definition>`	`genericRefs` Collects all generic definitions still referred to!
`protected Function<Definition,String>`	`getCategory`
`static String`	`hashmark`
`static String`	`image_file_suffix`
`static String`	`imageFormat`
`static String`	`item_in_line_separator`
`protected String`	`languagecode`
`static String`	`local_copy_js`
`static String`	`map_prefix`
`protected Map<Module,String>`	`module2moduleName` Maps all instantiated Modules to a name containing a numbering.
`protected ModuleRegistry`	`moduleReg`
`protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>>`	`msg`
`protected MessageReceiver<SimpleMessage<String>>`	`msgMEMSTRING`
`String`	`prefix_anchor_declaration`
`String`	`prefix_anchor_module`
`static String`	`prefix_local_anchor`
`protected Multimap<String,Module>`	`rawModule2instantiated` Maps all raw modules (given by their full paths) to all appearing instantiations.
`static String`	`resource_position_ddfdoc_js`
`protected Multimap<SourceItem,String>`	`sourceItem2docu`
`protected NamespaceName2String`	`stylesheetParams`
`protected Multimap<String,Definition>`	`tag2Def`
`protected String`	`targetcode`
`protected Module`	`topModule`
`static String`	`url_ddfdoc_js`
`protected Multimap<Definition,Definition>`	`usedIn` Maps all definitions to points of usage.

Constructor Summary

Constructors
Constructor and Description

Def2Doc(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, File generatedDir)

Constructors
Constructor and Description
`Def2Doc(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, File generatedDir)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected String`	`dyn_def2anchor(Definition def, boolean isName)`
`protected String`	`dyn_fullname(Definition def)` Get the name of the definition w.r.t.
`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(Location<XMLDocumentIdentifier> location, String docIdent, CheckedMap_RD<String,CheckedList<LocString>> map)` Convert the docu text for the item (according to the value of targetcode) from d2d source into xhtml.
`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)`
`protected String`	`joinAllDocStrings(CheckedList<LocString> list)`
`protected void`	`listHomonyms(String tag, Definition def)`
`protected void`	`listUsage(Definition def)`
`static void`	`main(String[] args)` PROVISONALLY test purpose definitions : args[0] is the module name, args[1] if static or dynamic args[2] the language code args[3] the output directory name args[4] the prj source tree (for finding "doctypes" with the ddf sources)
`protected void`	`makeDynDefDoc(String modulename, Definition def)` Make the doc entry for one (INSTANTIATED) DECLARATION.
`protected void`	`makeDynDoc()` Analyze and generate documentation for one instantiated module: collect sll declarations referred to from ALL declarations in the top-level module.
`protected void`	`makeDynModuleDocs()` Make the doc entry for one MODULE INSTANTIATION Print a header, print the module-related docu text, iff present in the selected language, call `makeDynDefDoc(String, Definition)` for all defs which are reachable from the top module's definitions.
`protected void`	`makeDynTocs()` Makes List of the following ToCs.
`protected void`	`makeEnumTable(Enumeration def)` Generates a tabular visualisation of an enum, following the numerical values.
`void`	`makeHtmlDoc(ModuleRegistry modreg, Module mod, boolean dynamic, String targetcode, String generationString, NamespaceName2String stylesheetParams)` Make xhtml-documentation of one top module and its childs or imports.
`protected Element_a`	`makeJumpTo(Definition def)`
`protected void`	`makeJumpToToc()`
`void`	`makePngAndMap(XRegExp def0)` Create one single graphic file containing the graphic representation of the syntax of one single declaration.
`protected Element_ul`	`makeSortedListOfDefinitions(Set<Definition> defs)`
`protected void`	`makeStaticDoc()` In the static case the references are NOT resolved.
`protected void`	`renderDocu(SourceItem item)` Convert the docu text for the item (according to the value of targetcode) from d2d source into xhtml.
`static Element_span`	`spanCC(String classname, String content)` Creates a simple html-span with a certain css-class and only character data.
`static String[]`	`splitByFirst(String text)`
`static Function<String,String>`	`stringPrepend(String s0)` DISLOC FIXME to ops/Functions ??
`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
  - msg
```
protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg
```
  - msgMEMSTRING
```
protected MessageReceiver<SimpleMessage<String>> msgMEMSTRING
```
  - moduleReg
```
protected ModuleRegistry moduleReg
```
  - generatedDir
```
protected File generatedDir
```
  - topModule
```
protected Module topModule
```
  - targetcode
```
protected String targetcode
```
  - languagecode
```
protected String languagecode
```
  - dynamic
```
protected boolean dynamic
```
  - stylesheetParams
```
protected NamespaceName2String stylesheetParams
```
  - bodysubs
```
protected Vector<Element> bodysubs
```
  - docTexts
```
protected DocTexts docTexts
```
  - 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
  - item_in_line_separator
```
public static final String item_in_line_separator
```
    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_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
  - el_img_pcdata
```
protected Element_img el_img_pcdata
```
  - docu_prefix
```
protected static final String docu_prefix
```
    See Also:
    
    Constant Field Values
  - docu_errorstrategy
```
protected static final Text2Udom.ErrorStrategy docu_errorstrategy
```
  - tag2Def
```
protected Multimap<String,Definition> tag2Def
```
  - fullpath2module
```
protected Map<String,Module> fullpath2module
```
  - sourceItem2docu
```
protected Multimap<SourceItem,String> sourceItem2docu
```
  - dynVisited_def
```
protected Set<XRegExp> dynVisited_def
```
  - rawModule2instantiated
```
protected Multimap<String,Module> rawModule2instantiated
```
    Maps all raw modules (given by their full paths) to all appearing instantiations.
  - module2moduleName
```
protected Map<Module,String> module2moduleName
```
    Maps all instantiated Modules to a name containing a numbering.
  - usedIn
```
protected Multimap<Definition,Definition> usedIn
```
    Maps all definitions to points of usage.
  - genericRefs
```
protected Multimap<Definition,Definition> genericRefs
```
    Collects all generic definitions still referred to!
  - emptyBC
```
protected final Element_block_content[] emptyBC
```
  - getCategory
```
protected final Function<Definition,String> getCategory
```
  - blockContent_2_tdContents
```
protected static final Function<Element_block_content,Element_td.Content> blockContent_2_tdContents
```
  - dyn_fullname
```
protected Function<Definition,String> dyn_fullname
```
  - dyn_def2anchor_false
```
protected Function<Definition,String> dyn_def2anchor_false
```
- Constructor Detail
  - Def2Doc
```
public Def2Doc(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
               File generatedDir)
```
    Parameters:
    
    msg - MessageReceiver
    
    generatedDir - must exist as a directory, but should be empty.
- 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)
```
  - splitByFirst
```
public static String[] splitByFirst(String text)
```
  - getSuffix
```
public static String getSuffix(String fname)
```
  - spanCC
```
public static Element_span spanCC(String classname,
                                  String content)
```
    Creates a simple html-span with a certain css-class and only character data.
  - joinAllDocStrings
```
protected String joinAllDocStrings(CheckedList<LocString> list)
```
  - renderDocu
```
protected void renderDocu(SourceItem item)
```
    Convert the docu text for the item (according to 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(Location<XMLDocumentIdentifier> location,
                                               String docIdent,
                                               CheckedMap_RD<String,CheckedList<LocString>> map)
```
    Convert the docu text for the item (according to the value of targetcode) from d2d source into xhtml. Append the latter to the growing list "bodysubs".
  - makePngAndMap
```
public void makePngAndMap(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.
  - 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(Definition def)
```
  - listHomonyms
```
protected void listHomonyms(String tag,
                            Definition def)
```
  - makeJumpTo
```
protected Element_a makeJumpTo(Definition def)
```
  - makeJumpToToc
```
protected void makeJumpToToc()
```
  - makeStaticDoc
```
protected void makeStaticDoc()
```
    In the static case the references are NOT resolved. So mostly we work on STRING data, not on References.
  - dyn_module2anchor
```
protected String dyn_module2anchor(Module mod,
                                   boolean isName)
```
    Parameters:
    
    isName - if it is the DEFINING "a"-element, not a refering.
  - dyn_def2anchor
```
protected String dyn_def2anchor(Definition def,
                                boolean isName)
```
    Parameters:
    
    isName - if it is the DEFINING "a"-element, not a refering.
  - dyn_fullname
```
protected String dyn_fullname(Definition def)
```
    Get the name of the definition w.r.t. the correct INSTANTIATION of its hosting module, which can be one of several!
  - stringPrepend
```
public static Function<String,String> stringPrepend(String s0)
```
    DISLOC FIXME to ops/Functions ??
  - makeSortedListOfDefinitions
```
protected Element_ul makeSortedListOfDefinitions(Set<Definition> defs)
```
  - makeDynTocs
```
protected void makeDynTocs()
```
    Makes
    1. List of the following ToCs.
    2. List of Modules
    3. Call Graph
    4. List of Tags
    POSSIBLE EXTENSION : list all GENERICS (still open!!)
  - makeDynDefDoc
```
protected void makeDynDefDoc(String modulename,
                             Definition def)
```
    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
  - makeDynModuleDocs
```
protected void makeDynModuleDocs()
```
    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 makeDynDefDoc(String, Definition) for all defs which are reachable from the top module's definitions.
    POSSIBLE EXTENSION : list all IMPORT ITEMS !?!?
  - makeDynDoc
```
protected void makeDynDoc()
```
    Analyze and generate documentation for one instantiated module:
    1. collect sll declarations referred to from ALL declarations in the top-level module.
    2. treat these recursively
    3. collect their containing (instantiated) modules and assign a numbering to different instantiations of the same raw module.
    4. generate doc text for all instantiated modules in alphabetical order, restricted to those declarations reachable by the top module's definitions.
  - makeHtmlDoc
```
public void makeHtmlDoc(ModuleRegistry modreg,
                        Module mod,
                        boolean dynamic,
                        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 they are put 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
    
    dynamic - =true indicates instantiated case
    
    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"
  - main
```
public static void main(String[] args)
```
    PROVISONALLY test purpose definitions :
    args[0] is the module name,
    args[1] if static or dynamic
    args[2] the language code
    args[3] the output directory name
    args[4] the prj source tree (for finding "doctypes" with the ddf sources)

Class Def2Doc

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

msg

msgMEMSTRING

moduleReg

generatedDir

topModule

targetcode

languagecode

dynamic

stylesheetParams

bodysubs

docTexts

url_ddfdoc_js

resource_position_ddfdoc_js

local_copy_js

item_in_line_separator

erronuousExitCode

imageFormat

image_file_suffix

map_prefix

hashmark

prefix_local_anchor

classname_error

classname_defcategory_in_header

classname_defname_in_header

classname_modulename_in_header

classname_contextpath_in_header

classname_text_generic

classname_syntaxgraph_image

classname_enum_intconst

classname_enumtable

classname_footertext

classname_creationcommand

anchorname_toc

anchor_listOfDocEntries

prefix_anchor_module

prefix_anchor_declaration

el_img_pcdata

docu_prefix

docu_errorstrategy

tag2Def

fullpath2module

sourceItem2docu

dynVisited_def

rawModule2instantiated

module2moduleName

usedIn

genericRefs

emptyBC

getCategory

blockContent_2_tdContents

dyn_fullname

dyn_def2anchor_false

Constructor Detail

Def2Doc

Method Detail

error

warning

error

error

splitByFirst

getSuffix

spanCC

joinAllDocStrings

renderDocu

f_renderDocu

makePngAndMap

getCategory

makeEnumTable

listUsage

listHomonyms

makeJumpTo

makeJumpToToc

makeStaticDoc