LilypondGenerator (BandM signal & music)

java.lang.Object
- eu.bandm.music.haken.LilypondGenerator

```
public class LilypondGenerator
extends Object
```
Tool for generating one LilyPond source text file from a HKN K-score. The source text is generated by subsequent calls to different service providing methods. It is stored internally as a sequence of Formats. Finally it can be written out to a disk file.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`lilypond_tie_symbol` Evident
`protected MSplitter.Parameters`	`metricSplitParameters` Evident
`protected MSplitter`	`metricSplitter` Evident
`protected SimpleMessage.Sender<XMLDocumentIdentifier>`	`msg` Target of all messages.
`static String[]`	`preamble_definitions` Constant text of some function definitions to be entered in every HKN lilypond output.
`protected static Rational`	`rat_1_4` Evident
`protected static Rational`	`rat_3_4` Evident
`protected static QualifiedRational`	`sound_1_4` Evident
`protected static QualifiedRational`	`sound_3_4` Evident
`(package private) Stack<Rational>`	`totalDurations` Auxiliary storage for K-Eevent durations PLUS additional pauses.
`protected List<Format>`	`vFormats` Central list of all generated formats; will finally be written out to make a LilyPond source file.

Constructor Summary

Constructors
Constructor and Description

LilypondGenerator(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg)
Only constructor.

Constructors
Constructor and Description
`LilypondGenerator(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg)` Only constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPause(Rational rat, Vox vpause, Tp tp)` Add a pause duration to the last emmitted V-Event for later printing the graphic voices.
`void`	`close_score()` Append the LilyPond source text to close a score.
`void`	`close_staff()` Append the LilyPond source text to close a staff.
`void`	`close_staffGroup()` Append the LilyPond source text to close a staff group.
`static String`	`lilypond_duration_encoding(RationalDuration.DottedBaseDuration dbd)` Evident
`void`	`open_score()` Append the LilyPond source text to open a score.
`void`	`open_staff(String longname, String shortname)` Append the LilyPond source text to open a staff.
`void`	`open_staffGroup()` Append the LilyPond source text to open a staff group.
`void`	`open(String inputFileName, String outputFileStem, String subtitle)` Write the very beginnig of generated lilypond source file.
`void`	`putF(String text, Object... args)` Add a particular text after calling `String.format(String, Object...)` as a literal format to `vFormats`.
`void`	`putS(String text)` Add a particular text as a literal format to `vFormats`.
`void`	`putSpace()` Add a special one-blank `Format.space` to `vFormats`.
`void`	`putText(String text)` Add a longer text (including line breaks) to `vFormats`.
`void`	`startGraphEvent(Rational rat)` Append the duration of a generated V-Voice event to the list of complete durations `totalDurations`.
`(package private) void`	`writeGraphics(DoppelHaken h)` Add the macro call to the lilyPond source which creates the graphik of a DoppelHaken.
`(package private) void`	`writeGraphics(Haken h)` Add the macro call to the lilyPond source which creates the graphik of a Haken.
`(package private) void`	`writeGraphics(RelWert w)` Add the macro call to the lilyPond source which creates the graphik of a directly given RelWert (without any Haken).
`protected void`	`writeGraphics(String role, Vox inputVoice, List<RelWert> expanded, List<Tp> tps, Map<Event,RelWert> event2relwert, Map<Event,Haken> event2haken, Map<Event,DoppelHaken> event2doppelHaken)` Append a dedicated lilypond voice to the score, which presents a graphic symbol of the underlying K-event.
`(package private) void`	`writeGraphicsExpanded(RelWert r)` Method which print the graphic represention of the currently valid RelWert for all V-events which are not the first in the K-event expansion.
`(package private) void`	`writeGraphicsValueString(String s)` Aux method to add the macro call print the name of a RelWert.
`void`	`writeToFile(String outputfilename)` Write all accumulated LilyPond source text to the given file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - msg
```
protected final SimpleMessage.Sender<XMLDocumentIdentifier> msg
```
    Target of all messages.
  - lilypond_tie_symbol
```
public static final String lilypond_tie_symbol
```
    Evident
    
    See Also:
    
    Constant Field Values
  - rat_3_4
```
protected static final Rational rat_3_4
```
    Evident
  - sound_3_4
```
protected static final QualifiedRational sound_3_4
```
    Evident
  - rat_1_4
```
protected static final Rational rat_1_4
```
    Evident
  - sound_1_4
```
protected static final QualifiedRational sound_1_4
```
    Evident
  - metricSplitParameters
```
protected MSplitter.Parameters metricSplitParameters
```
    Evident
  - metricSplitter
```
protected MSplitter metricSplitter
```
    Evident
  - vFormats
```
protected List<Format> vFormats
```
    Central list of all generated formats; will finally be written out to make a LilyPond source file.
  - preamble_definitions
```
public static final String[] preamble_definitions
```
    Constant text of some function definitions to be entered in every HKN lilypond output. Includes routines to genearte Graphics for the commentary lines which indicate the original K-events.
  - totalDurations
```
Stack<Rational> totalDurations
```
    Auxiliary storage for K-Eevent durations PLUS additional pauses. For printing the additional "graphic" voices, which is done after the genration of the corrensponding V-Voice, and which shows the original K-Events, the durations of the corresponding events PLUS their subsequent pauses are needed. These are kept here and added (by the specific interpretation code) in sync with #tps and #expanded.
- Constructor Detail
  - LilypondGenerator
```
public LilypondGenerator(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg)
```
    Only constructor.
    
    Parameters:
    
    msg - targt of all messages.
- Method Detail
  - lilypond_duration_encoding
```
public static String lilypond_duration_encoding(RationalDuration.DottedBaseDuration dbd)
```
    Evident
  - putS
```
public void putS(String text)
```
    Add a particular text as a literal format to vFormats.
  - putF
```
public void putF(String text,
                 Object... args)
```
    Add a particular text after calling String.format(String, Object...) as a literal format to vFormats.
  - putSpace
```
public void putSpace()
```
    Add a special one-blank Format.space to vFormats.
  - putText
```
public void putText(String text)
```
    Add a longer text (including line breaks) to vFormats. This is done using Format.text(String).
  - addPause
```
public void addPause(Rational rat,
                     Vox vpause,
                     Tp tp)
```
    Add a pause duration to the last emmitted V-Event for later printing the graphic voices. See totalDurations.
  - startGraphEvent
```
public void startGraphEvent(Rational rat)
```
    Append the duration of a generated V-Voice event to the list of complete durations totalDurations. See there for details.
  - writeGraphics
```
protected void writeGraphics(String role,
                             Vox inputVoice,
                             List<RelWert> expanded,
                             List<Tp> tps,
                             Map<Event,RelWert> event2relwert,
                             Map<Event,Haken> event2haken,
                             Map<Event,DoppelHaken> event2doppelHaken)
```
    Append a dedicated lilypond voice to the score, which presents a graphic symbol of the underlying K-event. This voice is synchronuous to the corresponding V-events, which have just been written into a lilypond E-voice.
    
    Parameters:
    
    role - Only for generating lilypond source text comment: For what parameter this voice has been used.
    
    inputVoice - for getting the original K-events when stepping through the time points (and for inserting the voice name into the lilypond source text comment)
    
    expanded - list of all expanded values, coming from the Score_hkn.Expansion and in sync with tps.
    
    tps - list of all collected and synthesized time points, coming from the Score_hkn.Expansion and in sync with expanded.
    
    event2relwert - links possibly a K-event to a RelWert, coming from Score_haken.
    
    event2haken - links possibly a K-event to a Haken, coming from Score_haken,
    
    event2doppelHaken - links possibly a K-event to a Doppelhaken, coming from Score_haken.
  - writeGraphics
```
void writeGraphics(Haken h)
```
    Add the macro call to the lilyPond source which creates the graphik of a Haken.
  - writeGraphics
```
void writeGraphics(DoppelHaken h)
```
    Add the macro call to the lilyPond source which creates the graphik of a DoppelHaken. This is slightly different when internally overlapping and not-overlapping, e.g. "OMO" vs. "OMMO".
  - writeGraphics
```
void writeGraphics(RelWert w)
```
    Add the macro call to the lilyPond source which creates the graphik of a directly given RelWert (without any Haken).
  - writeGraphicsValueString
```
void writeGraphicsValueString(String s)
```
    Aux method to add the macro call print the name of a RelWert. This canbe directy given or part of a Haken expansion.
  - writeGraphicsExpanded
```
void writeGraphicsExpanded(RelWert r)
```
    Method which print the graphic represention of the currently valid RelWert for all V-events which are not the first in the K-event expansion.
  - open
```
public void open(String inputFileName,
                 String outputFileStem,
                 String subtitle)
```
    Write the very beginnig of generated lilypond source file. This includes generation documentation comment line, paper and header blocks, additional free components as previously entered into preamble_definitions.
  - open_score
```
public void open_score()
```
    Append the LilyPond source text to open a score.
  - open_staffGroup
```
public void open_staffGroup()
```
    Append the LilyPond source text to open a staff group.
  - open_staff
```
public void open_staff(String longname,
                       String shortname)
```
    Append the LilyPond source text to open a staff.
  - close_staff
```
public void close_staff()
```
    Append the LilyPond source text to close a staff.
  - close_staffGroup
```
public void close_staffGroup()
```
    Append the LilyPond source text to close a staff group.
  - close_score
```
public void close_score()
```
    Append the LilyPond source text to close a score.
  - writeToFile
```
public void writeToFile(String outputfilename)
```
    Write all accumulated LilyPond source text to the given file.

Class LilypondGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

msg

lilypond_tie_symbol

rat_3_4

sound_3_4

rat_1_4

sound_1_4

metricSplitParameters

metricSplitter

vFormats

preamble_definitions

totalDurations

Constructor Detail

LilypondGenerator

Method Detail

lilypond_duration_encoding

putS

putF

putSpace

putText

addPause

startGraphEvent

writeGraphics

writeGraphics

writeGraphics

writeGraphics

writeGraphicsValueString

writeGraphicsExpanded

open

open_score

open_staffGroup

open_staff

close_staff

close_staffGroup

close_score

writeToFile