Base class for import filters. More...

#include <import.h>

Inheritance diagram for CAImport:

[legend]

Signals
void	documentImported (CADocument *)

void	sheetImported (CASheet *)

void	staffImported (CAStaff *)

void	voiceImported (CAVoice *)

void	lyricsContextImported (CALyricsContext *)

void	functionMarkContextImported (CAFunctionMarkContext *)

void	importDone (int status)

Public Member Functions
	CAImport (QTextStream *stream=0)

	CAImport (const QString stream)

virtual	~CAImport ()

void	setStreamFromFile (const QString filename)

QString	fileName ()

virtual const QString	readableStatus ()

void	importDocument ()

void	importSheet ()

void	importStaff ()

void	importVoice ()

void	importLyricsContext ()

void	importFunctionMarkContext ()

CADocument *	importedDocument ()

CASheet *	importedSheet ()

CAStaff *	importedStaff ()

CAVoice *	importedVoice ()

CALyricsContext *	importedLyricsContext ()

CAFunctionMarkContext *	importedFunctionMarkContext ()

Public Member Functions inherited from CAFile
	CAFile ()

virtual	~CAFile ()

const int	status ()

const int	progress ()

virtual const QString	readableStatus ()=0

void	setStreamFromFile (const QString filename)

void	setStreamToFile (const QString filename)

void	setStreamFromDevice (QIODevice *device)

void	setStreamToDevice (QIODevice *device)

void	setStreamToString ()

QString	getStreamAsString ()

Protected Member Functions
virtual CADocument *	importDocumentImpl ()

virtual CASheet *	importSheetImpl ()

virtual CAStaff *	importStaffImpl ()

virtual CAVoice *	importVoiceImpl ()

virtual CALyricsContext *	importLyricsContextImpl ()

virtual CAFunctionMarkContext *	importFunctionMarkContextImpl ()

QTextStream &	in ()

Protected Member Functions inherited from CAFile
void	setStatus (const int status)

void	setProgress (const int progress)

QTextStream *	stream ()

virtual void	setStream (QTextStream *stream)

QFile *	file ()

void	setFile (QFile *file)

Protected Attributes
QString	_fileName

Private Types
enum	CAImportPart { Undefined , Document , Sheet , Staff , Voice , LyricsContext , FunctionMarkContext }

Private Member Functions
void	setImportedDocument (CADocument *doc)

void	setImportedSheet (CASheet *sheet)

void	setImportedStaff (CAStaff *staff)

void	setImportedVoice (CAVoice *voice)

void	setImportedLyricsContext (CALyricsContext *lc)

void	setImportedFunctionMarkContext (CAFunctionMarkContext *fmc)

void	run ()

void	setImportPart (CAImportPart part)

CAImportPart	importPart ()

Private Attributes
CADocument *	_importedDocument

CASheet *	_importedSheet

CAStaff *	_importedStaff

CAVoice *	_importedVoice

CALyricsContext *	_importedLyricsContext

CAFunctionMarkContext *	_importedFunctionMarkContext

CAImportPart	_importPart

Detailed Description

Base class for import filters.

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

This class inherits CAFile and is the base class for any specific import filter (eg. LilyPond, CanorusML, MusicXML etc.).

If a developer wants to write a new import filter, he should: 1) Create a new class with the base class CAImport 2) Implement CAImport constructors and at least importDocumentImpl() function which returns the new CADocument. 3) Register the filter (put a new fileformat to CAFileFormats and add the filter to open/save dialogs in CACanorus)

Optionally: Developer should change the current status and progress while operations are in progress. He should also rewrite the readableStatus() function.

The following example illustrates the usage of import class:

CAMyImportFilter import();
import.setStreamFromFile("jingle bells.xml");
import.importDocument();
import.wait();
 
setDocument( import.importedDocument() );
CACanorus::rebuildUI();

In Python the example is even more direct using the string as an input method:

lilyString = '\\relative c { \\clef "treble" \\time 4/4 c4 d e f | f e d c | c1 \\bar "|." }'
myImport = CALilyPondImport( lilyString )
myImport.importVoice()
myImport.wait()         
 
voice = myImport.importedVoice()

Note: Both stream and string can be used both in Canorus and scripting. The example is only for illustration.

Member Enumeration Documentation

◆ CAImportPart

enum CAImport::CAImportPart

private

Enumerator
Undefined
Document
Sheet
Staff
Voice
LyricsContext
FunctionMarkContext

Constructor & Destructor Documentation

◆ CAImport() [1/2]

CAImport::CAImport ( QTextStream * stream = 0 )

References _fileName, setImportedDocument(), setImportedFunctionMarkContext(), setImportedLyricsContext(), setImportedSheet(), setImportedStaff(), setImportedVoice(), setImportPart(), CAFile::setStream(), CAFile::stream(), and Undefined.

Here is the call graph for this function:

◆ CAImport() [2/2]

CAImport::CAImport ( const QString stream )

References setImportedDocument(), setImportedFunctionMarkContext(), setImportedLyricsContext(), setImportedSheet(), setImportedStaff(), setImportedVoice(), setImportPart(), CAFile::setStream(), CAFile::stream(), and Undefined.

Here is the call graph for this function:

◆ ~CAImport()

CAImport::~CAImport ( )

virtual

References CAFile::stream().

Here is the call graph for this function:

Member Function Documentation

◆ documentImported

void CAImport::documentImported ( CADocument * )

signal

Referenced by run().

Here is the caller graph for this function:

◆ fileName()

QString CAImport::fileName ( )

References _fileName.

Referenced by CAMXLImport::importDocumentImpl(), CAMidiImport::importMidiEvents(), CACanorusMLImport::importResource(), CALilyPondImport::importSheetImpl(), and CAMidiImport::importSheetImpl().

Here is the caller graph for this function:

◆ functionMarkContextImported

void CAImport::functionMarkContextImported ( CAFunctionMarkContext * )

signal

Referenced by run().

Here is the caller graph for this function:

◆ importDocument()

void CAImport::importDocument ( )

References Document, setImportPart(), and CAFile::setStatus().

Referenced by CACanImport::importDocumentImpl(), CAMainWin::openDocument(), CAAutoRecovery::openRecovery(), and CAMainWin::sourceViewCommit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importDocumentImpl()

virtual CADocument * CAImport::importDocumentImpl ( )

inlineprotectedvirtual

Reimplemented in CACanImport, CACanorusMLImport, CAMidiImport, CAMusicXmlImport, and CAMXLImport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importDone

void CAImport::importDone ( int status )

signal

Referenced by run().

Here is the caller graph for this function:

◆ importedDocument()

CADocument * CAImport::importedDocument ( )

inline

References _importedDocument.

Referenced by CACanImport::importDocumentImpl(), CAMainWin::openDocument(), CAAutoRecovery::openRecovery(), and CAMainWin::sourceViewCommit().

Here is the caller graph for this function:

◆ importedFunctionMarkContext()

CAFunctionMarkContext * CAImport::importedFunctionMarkContext ( )

inline

References _importedFunctionMarkContext.

◆ importedLyricsContext()

CALyricsContext * CAImport::importedLyricsContext ( )

inline

References _importedLyricsContext.

Referenced by CAMainWin::sourceViewCommit().

Here is the caller graph for this function:

◆ importedSheet()

CASheet * CAImport::importedSheet ( )

inline

References _importedSheet.

◆ importedStaff()

CAStaff * CAImport::importedStaff ( )

inline

References _importedStaff.

◆ importedVoice()

CAVoice * CAImport::importedVoice ( )

inline

References _importedVoice.

Referenced by CAMainWin::sourceViewCommit().

Here is the caller graph for this function:

◆ importFunctionMarkContext()

void CAImport::importFunctionMarkContext ( )

References FunctionMarkContext, setImportPart(), and CAFile::setStatus().

Here is the call graph for this function:

◆ importFunctionMarkContextImpl()

virtual CAFunctionMarkContext * CAImport::importFunctionMarkContextImpl ( )

inlineprotectedvirtual

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importLyricsContext()

void CAImport::importLyricsContext ( )

References LyricsContext, setImportPart(), and CAFile::setStatus().

Referenced by CAMainWin::sourceViewCommit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importLyricsContextImpl()

virtual CALyricsContext * CAImport::importLyricsContextImpl ( )

inlineprotectedvirtual

Reimplemented in CALilyPondImport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importPart()

CAImportPart CAImport::importPart ( )

inlineprivate

References _importPart.

Referenced by run().

Here is the caller graph for this function:

◆ importSheet()

void CAImport::importSheet ( )

References setImportPart(), CAFile::setStatus(), and Sheet.

Here is the call graph for this function:

◆ importSheetImpl()

virtual CASheet * CAImport::importSheetImpl ( )

inlineprotectedvirtual

Reimplemented in CALilyPondImport, and CAMidiImport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importStaff()

void CAImport::importStaff ( )

References setImportPart(), CAFile::setStatus(), and Staff.

Here is the call graph for this function:

◆ importStaffImpl()

virtual CAStaff * CAImport::importStaffImpl ( )

inlineprotectedvirtual

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importVoice()

void CAImport::importVoice ( )

References setImportPart(), CAFile::setStatus(), and Voice.

Referenced by CAMainWin::sourceViewCommit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importVoiceImpl()

virtual CAVoice * CAImport::importVoiceImpl ( )

inlineprotectedvirtual

Reimplemented in CALilyPondImport.

References CAFile::setStatus().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ in()

QTextStream & CAImport::in ( )

inlineprotected

References CAFile::stream().

Here is the call graph for this function:

◆ lyricsContextImported

void CAImport::lyricsContextImported ( CALyricsContext * )

signal

Referenced by run().

Here is the caller graph for this function:

◆ readableStatus()

const QString CAImport::readableStatus ( )

virtual

Implements CAFile.

Reimplemented in CALilyPondImport, CAMidiImport, and CAMusicXmlImport.

References CAFile::status().

Referenced by CAMusicXmlImport::readableStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

void CAImport::run ( )

private

Executed when a new thread is dispatched. It looks which part of the document should be imported and starts the procedure. It emits the appropriate signal when the procedure is finished.

References Document, documentImported(), FunctionMarkContext, functionMarkContextImported(), importDocumentImpl(), importDone(), importFunctionMarkContextImpl(), importLyricsContextImpl(), importPart(), importSheetImpl(), importStaffImpl(), importVoiceImpl(), LyricsContext, lyricsContextImported(), setImportedDocument(), setImportedFunctionMarkContext(), setImportedLyricsContext(), setImportedSheet(), setImportedStaff(), setImportedVoice(), CAFile::setStatus(), Sheet, sheetImported(), Staff, staffImported(), CAFile::status(), CAFile::stream(), Undefined, Voice, and voiceImported().