LilyPond export filter This class is used to export the document or parts of the document to LilyPond syntax. The most common use is to simply call one of the constructors. More...

#include <lilypondexport.h>

Inheritance diagram for CALilyPondExport:

[legend]

Public Member Functions
	CALilyPondExport (QTextStream *out=0)

CAVoice *	curVoice ()

CASheet *	curSheet ()

CAContext *	curContext ()

int	curContextIndex ()

int	curIndentLevel ()

Public Member Functions inherited from CAExport
	CAExport (QTextStream *stream=0)

virtual	~CAExport ()

virtual const QString	readableStatus ()

void	exportDocument (CADocument *, bool bStartThread=true)

void	exportSheet (CASheet *)

void	exportStaff (CAStaff *)

void	exportVoice (CAVoice *)

void	exportLyricsContext (CALyricsContext *)

void	exportFunctionMarkContext (CAFunctionMarkContext *)

CADocument *	exportedDocument ()

CASheet *	exportedSheet ()

CAStaff *	exportedStaff ()

CAVoice *	exportedVoice ()

CALyricsContext *	exportedLyricsContext ()

CAFunctionMarkContext *	exportedFunctionMarkContext ()

virtual void	setStreamToFile (const QString filename)

bool	wait (unsigned long time=ULONG_MAX)

Public Member Functions inherited from CAFile
	CAFile ()

virtual	~CAFile ()

const int	status ()

const int	progress ()

void	setStreamFromFile (const QString filename)

void	setStreamToFile (const QString filename)

void	setStreamFromDevice (QIODevice *device)

void	setStreamToDevice (QIODevice *device)

Private Member Functions
void	exportDocumentImpl (CADocument *doc)

void	exportSheetImpl (CASheet *sheet)

void	exportScoreBlock (CASheet *sheet)

void	exportStaffVoices (CAStaff *staff)

void	exportVoiceImpl (CAVoice *voice)

void	exportLyricsContextBlock (CALyricsContext *lc)

void	exportLyricsContextImpl (CALyricsContext *lc)

void	exportMarks (CAMusElement *)

void	exportPlayable (CAPlayable *elt)

void	writeDocumentHeader ()

CADiatonicPitch	writeRelativeIntro ()

void	doAnacrusisCheck (CATimeSignature *time)

const QString	clefTypeToLilyPond (CAClef::CAClefType type, int c1, int offset)

const QString	diatonicKeyGenderToLilyPond (CADiatonicKey::CAGender gender)

const QString	playableLengthToLilyPond (CAPlayableLength length)

const QString	diatonicPitchToLilyPond (CADiatonicPitch p)

const QString	restTypeToLilyPond (CARest::CARestType type)

const QString	barlineTypeToLilyPond (CABarline::CABarlineType type)

const QString	syllableToLilyPond (CASyllable *s)

const QString	relativePitchToString (CANote *note, CADiatonicPitch prevPitch)

const QString	relativePitchToString (CADiatonicPitch p, CADiatonicPitch prevPitch)

void	voiceVariableName (QString &name, int staffNum, int voiceNum)

void	spellNumbers (QString &s)

QString	markupString (QString)

QString	escapeWeirdChars (QString)

void	indent ()

void	indentMore ()

void	indentLess ()

void	setCurVoice (CAVoice *voice)

void	setCurSheet (CASheet *sheet)

void	setCurContext (CAContext *context)

void	setCurContextIndex (int c)

void	setIndentLevel (int level)

Private Attributes
QTextStream *	_out

CAVoice *	_curVoice

CASheet *	_curSheet

CAContext *	_curContext

int	_curContextIndex

int	_curIndentLevel

CADiatonicPitch	_lastNotePitch

CAPlayableLength	_lastPlayableLength

int	_curStreamTime

Additional Inherited Members
Signals inherited from CAExport
void	documentExported (CADocument *)

void	sheetExported (CASheet *)

void	staffExported (CAStaff *)

void	voiceExported (CAVoice *)

void	lyricsContextExported (CALyricsContext *)

void	functionMarkContextExported (CAFunctionMarkContext *)

void	exportDone (int status)

Protected Member Functions inherited from CAExport
virtual void	exportStaffImpl (CAStaff *)

virtual void	exportFunctionMarkContextImpl (CAFunctionMarkContext *)

QTextStream &	out ()

void	run ()

Detailed Description

LilyPond export filter This class is used to export the document or parts of the document to LilyPond syntax. The most common use is to simply call one of the constructors.

Licensed under the GNU GENERAL PUBLIC LICENSE. See LICENSE.GPL for details.

CALilyPondExport( myDocument, &textStream );

textStream is usually the file stream or the content of the score source view widget.

See Also: CALilyPondImport

Constructor & Destructor Documentation

CALilyPondExport::CALilyPondExport ( QTextStream * out = 0 )

Constructor for the lilypond export. Called when viewing a single voice source in Lily syntax or exporting the whole document to a file.

Uses out for the output.

References setIndentLevel().

Here is the call graph for this function:

Member Function Documentation

const QString CALilyPondExport::barlineTypeToLilyPond ( CABarline::CABarlineType type )

private

Converts the barline type to LilyPond syntax.

References CABarline::Dotted, CABarline::Double, CABarline::End, CABarline::RepeatClose, CABarline::RepeatCloseOpen, CABarline::RepeatOpen, and CABarline::Single.

Referenced by exportVoiceImpl().

Here is the caller graph for this function:

const QString CALilyPondExport::clefTypeToLilyPond	(	CAClef::CAClefType	clefType,
		int	c1orig,
		int	offset
	)

private

Converts the given clefType to LilyPond syntax.

References CAClef::C, CAClef::F, CAClef::G, CAClef::PercussionHigh, CAClef::PercussionLow, and CAClef::Tab.

Referenced by exportVoiceImpl().

Here is the caller graph for this function:

CAContext* CALilyPondExport::curContext ( )

inline

References _curContext.

Referenced by exportScoreBlock().

Here is the caller graph for this function:

int CALilyPondExport::curContextIndex ( )

inline

References _curContextIndex.

Referenced by exportStaffVoices().

Here is the caller graph for this function:

int CALilyPondExport::curIndentLevel ( )

inline

References _curIndentLevel.

Referenced by indent().

Here is the caller graph for this function:

CASheet* CALilyPondExport::curSheet ( )

inline

References _curSheet.

Referenced by exportScoreBlock().

Here is the caller graph for this function:

CAVoice* CALilyPondExport::curVoice ( )

inline

References _curVoice.

Referenced by doAnacrusisCheck(), exportStaffVoices(), and writeRelativeIntro().

Here is the caller graph for this function:

const QString CALilyPondExport::diatonicKeyGenderToLilyPond ( CADiatonicKey::CAGender gender )

private

Returns the key signature gender major/minor in LilyPond syntax.

See Also: keySignaturePitchToLilyPond()

References CADiatonicKey::Major, and CADiatonicKey::Minor.

Referenced by exportVoiceImpl().

Here is the caller graph for this function:

const QString CALilyPondExport::diatonicPitchToLilyPond ( CADiatonicPitch pitch )

private

Converts the note pitch to LilyPond syntax.

References CADiatonicPitch::accs(), and CADiatonicPitch::noteName().

Referenced by exportVoiceImpl(), and relativePitchToString().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::doAnacrusisCheck ( CATimeSignature * time )

private

Writes the partial command before the first note if there is an upbeat.

References CAMusElement::Barline, CATimeSignature::beat(), CATimeSignature::beats(), curVoice(), CAPlayableLength::HundredTwentyEighth, CAMusElement::isPlayable(), CAVoice::musElementAt(), CAVoice::musElementCount(), CAPlayableLength::musicLength(), CAExport::out(), CAPlayableLength::playableLengthToTimeLength(), CAPlayableLength::Quarter, and CAMusElement::timeLength().

Referenced by exportVoiceImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

QString CALilyPondExport::escapeWeirdChars ( QString in )

private

Replaces characters like backslashes and double brackets with their escaped variant.

Referenced by markupString().

Here is the caller graph for this function:

void CALilyPondExport::exportDocumentImpl ( CADocument * doc )

privatevirtual

Exports the current document to Lilypond syntax as a complete .ly file.

Reimplemented from CAExport.

References exportSheetImpl(), CAExport::out(), CADocument::sheetAt(), CADocument::sheetCount(), and writeDocumentHeader().

Here is the call graph for this function:

void CALilyPondExport::exportLyricsContextBlock ( CALyricsContext * lc )

private

Exports the lyrics in form: SopranoLyricsOne = { My bu – ny is o – ver the o – cean __ My bu – ny. }

References exportLyricsContextImpl(), indent(), indentLess(), indentMore(), CAContext::name(), CAExport::out(), and spellNumbers().

Referenced by exportSheetImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::exportLyricsContextImpl ( CALyricsContext * lc )

privatevirtual

Exports the syllables only without the SopranoLyircsOne = {} frame.

Reimplemented from CAExport.

References CAExport::out(), CALyricsContext::syllableAt(), CALyricsContext::syllableCount(), and syllableToLilyPond().

Referenced by exportLyricsContextBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::exportMarks ( CAMusElement * elt )

private

Exports the music element's elt marks.

References CAMusElement::markList(), CAMark::markType(), CAExport::out(), CAMark::RehersalMark, and CAMark::Text.

Referenced by exportVoiceImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::exportPlayable ( CAPlayable * elt )

private

Todo:: If the time isn't the same, insert hidden rests to fill the needed time

Todo:: If the time isn't the same, insert hidden rests to fill the needed time

References _curStreamTime, _lastNotePitch, _lastPlayableLength, CATuplet::actualNumber(), CANote::diatonicPitch(), CANote::getChord(), CANote::isFirstInChord(), CAPlayable::isFirstInTuplet(), CANote::isLastInChord(), CAPlayable::isLastInTuplet(), CANote::isPartOfChord(), CAMusElement::musElementType(), CAMusElement::Note, CATuplet::number(), CAExport::out(), CANote::phrasingSlurEnd(), CANote::phrasingSlurStart(), CAPlayable::playableLength(), playableLengthToLilyPond(), relativePitchToString(), CAMusElement::Rest, CARest::restType(), restTypeToLilyPond(), CANote::slurEnd(), CANote::slurStart(), CANote::tieStart(), CAMusElement::timeLength(), CAMusElement::timeStart(), and CAPlayable::tuplet().

Referenced by exportVoiceImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::exportScoreBlock ( CASheet * sheet )

private

Exports the block for LilyPond from the current sheet. Looks like this:

\score {
        <<
                \new Staff {
                        <<
                                \new Voice { \voiceOne \StaffOneVoiceOne }
                                \new Voice { \voiceTwo \StaffOneVoiceTwo }
                        >>
                }
                \new Staff {
                        <<
                                \new Voice { \voiceOne \StaffTwoVoiceOne }
                                \new Voice { \voiceTwo \StaffTwoVoiceTwo }
                        >>
                }
                ...
        >>
}

References CALyricsContext::associatedVoice(), CASheet::contextAt(), CASheet::contextCount(), CAContext::contextType(), curContext(), curSheet(), indent(), indentLess(), indentMore(), CAContext::LyricsContext, CAContext::name(), CAVoice::name(), CAExport::out(), setCurContext(), spellNumbers(), CAContext::Staff, CAVoice::staff(), CAStaff::voiceAt(), CAStaff::voiceCount(), CAStaff::voiceList(), and voiceVariableName().

Referenced by exportSheetImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::exportSheetImpl ( CASheet * sheet )

privatevirtual

Exports the current sheet to Lilypond syntax.

Reimplemented from CAExport.

References CASheet::contextAt(), CASheet::contextCount(), CAContext::contextType(), exportLyricsContextBlock(), exportScoreBlock(), exportStaffVoices(), CAContext::LyricsContext, setCurContextIndex(), setCurSheet(), and CAContext::Staff.

Referenced by exportDocumentImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::exportStaffVoices ( CAStaff * staff )

private

Exports all the voices in the staff to Lilypond. Each voice in the staff is stored as a Lilypond variable:

StaffOneVoiceOne = c { ... }

References curContextIndex(), curVoice(), exportVoiceImpl(), indent(), CAVoice::name(), CAExport::out(), setCurVoice(), CAStaff::voiceAt(), CAStaff::voiceCount(), and voiceVariableName().

Referenced by exportSheetImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::exportVoiceImpl ( CAVoice * v )

privatevirtual

Exports the given voice music elements to LilyPond syntax.

See Also: CALilypondImport

Todo:: If the time isn't the same, insert hidden rests to fill the needed time

Todo:: If the time isn't the same, insert hidden rests to fill the needed time

Todo:: If the time isn't the same, insert hidden rests to fill the needed time

Todo:: If the time isn't the same, insert hidden rests to fill the needed time

Reimplemented from CAExport.

References _curStreamTime, _lastNotePitch, _lastPlayableLength, CAMusElement::Barline, CABarline::barlineType(), barlineTypeToLilyPond(), CATimeSignature::beat(), CATimeSignature::beats(), CAClef::c1(), CAMusElement::Clef, CAClef::clefType(), clefTypeToLilyPond(), CAKeySignature::diatonicKey(), diatonicKeyGenderToLilyPond(), CADiatonicKey::diatonicPitch(), diatonicPitchToLilyPond(), doAnacrusisCheck(), exportMarks(), exportPlayable(), CADiatonicKey::gender(), indent(), indentLess(), indentMore(), CAMusElement::isPlayable(), CAMusElement::KeySignature, CAVoice::musElementAt(), CAVoice::musElementCount(), CAMusElement::musElementType(), CAClef::offset(), CAExport::out(), setCurVoice(), CABarline::Single, CAMusElement::TimeSignature, CAMusElement::timeStart(), CAPlayableLength::Undefined, and writeRelativeIntro().

Referenced by exportStaffVoices().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::indent ( )

private

Output tabs according to _indentLevel.

References curIndentLevel(), and CAExport::out().

Referenced by exportLyricsContextBlock(), exportScoreBlock(), exportStaffVoices(), exportVoiceImpl(), and writeDocumentHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::indentLess ( )

inlineprivate

References _curIndentLevel.

Referenced by exportLyricsContextBlock(), exportScoreBlock(), exportVoiceImpl(), and writeDocumentHeader().

Here is the caller graph for this function:

void CALilyPondExport::indentMore ( )

inlineprivate

References _curIndentLevel.

Referenced by exportLyricsContextBlock(), exportScoreBlock(), exportVoiceImpl(), and writeDocumentHeader().

Here is the caller graph for this function:

QString CALilyPondExport::markupString ( QString in )

private

Encapsulates the given string into {}.

References escapeWeirdChars().

Referenced by writeDocumentHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

const QString CALilyPondExport::playableLengthToLilyPond ( CAPlayableLength playableLength )

private

Converts the note length to LilyPond syntax.

References CAPlayableLength::Breve, CAPlayableLength::dotted(), CAPlayableLength::Eighth, CAPlayableLength::Half, CAPlayableLength::HundredTwentyEighth, CAPlayableLength::musicLength(), CAPlayableLength::Quarter, CAPlayableLength::Sixteenth, CAPlayableLength::SixtyFourth, CAPlayableLength::ThirtySecond, and CAPlayableLength::Whole.

Referenced by exportPlayable().

Here is the call graph for this function:

Here is the caller graph for this function:

const QString CALilyPondExport::relativePitchToString	(	CANote *	note,
		CADiatonicPitch	prevPitch
	)

inlineprivate

References CANote::diatonicPitch().

Referenced by exportPlayable(), and writeRelativeIntro().

Here is the call graph for this function:

Here is the caller graph for this function:

const QString CALilyPondExport::relativePitchToString	(	CADiatonicPitch	p,
		CADiatonicPitch	prevPitch
	)

private

This function returns the relative note pitch in LilyPond syntax on the given Canorus pitch and previous note pitch.

eg. pitch=10, accs=1, prevPitch=5 => returns "f'"

See Also: notePitchToLilyPond()

References diatonicPitchToLilyPond(), and CADiatonicPitch::noteName().

Here is the call graph for this function:

const QString CALilyPondExport::restTypeToLilyPond ( CARest::CARestType type )

private

Converts the rest type to LilyPond syntax.

References CARest::Hidden, and CARest::Normal.

Referenced by exportPlayable().

Here is the caller graph for this function:

void CALilyPondExport::setCurContext ( CAContext * context )

inlineprivate

References _curContext.

Referenced by exportScoreBlock().

Here is the caller graph for this function:

void CALilyPondExport::setCurContextIndex ( int c )

inlineprivate

References _curContextIndex.

Referenced by exportSheetImpl().

Here is the caller graph for this function:

void CALilyPondExport::setCurSheet ( CASheet * sheet )

inlineprivate

References _curSheet.

Referenced by exportSheetImpl().

Here is the caller graph for this function:

void CALilyPondExport::setCurVoice ( CAVoice * voice )

inlineprivate

References _curVoice.

Referenced by exportStaffVoices(), and exportVoiceImpl().

Here is the caller graph for this function:

void CALilyPondExport::setIndentLevel ( int level )

inlineprivate

References _curIndentLevel.

Referenced by CALilyPondExport().

Here is the caller graph for this function:

void CALilyPondExport::spellNumbers ( QString & s )

private

Spell out numbers in a QString: "Staff1Voice2" -> "StaffOneVoiceTwo" This is necessary because Lilypond variable names can only contain letters.

Referenced by exportLyricsContextBlock(), exportScoreBlock(), and voiceVariableName().

Here is the caller graph for this function:

const QString CALilyPondExport::syllableToLilyPond ( CASyllable * s )

private

References CASyllable::hyphenStart(), CASyllable::melismaStart(), and CASyllable::text().

Referenced by exportLyricsContextImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

void CALilyPondExport::voiceVariableName	(	QString &	name,
		int	staffNum,
		int	voiceNum
	)

private

Modify name to contain a string "StaffXVoiceY" where X and Y are spelled-out versions of staffNum and voiceNum, respectively. This is for generating names of Lilypond variables from Canorus staff and voices indices, since Lilypond variable names must contain only alphabetical characters.

Example: voiceVariableName( name, 1, 2 ); –> name is "StaffOneVoiceTwo"

References spellNumbers().

Referenced by exportScoreBlock(), and exportStaffVoices().

Here is the call graph for this function: