GUIDOFactory.h

Go to the documentation of this file.

#ifndef GUIDOFactory_H
#define GUIDOFactory_H

/*
  GUIDO Library
  Copyright (C) 2003, 2004  Grame

  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.

  Grame Research Laboratory, 11, cours de Verdun Gensoul 69002 Lyon - France
  research@grame.fr

*/

#include "GUIDOExport.h"
#include "GUIDOEngine.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef void * ARFactoryHandler;


// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryOpen( ARFactoryHandler * outFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(void)  GuidoFactoryClose( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryOpenMusic( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(ARHandler) GuidoFactoryCloseMusic( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
/*
\brief Converts an abstract music representation to a graphic music representation.

    Performs the graphical score layout: applies the spacing and page breaking
    algorithms.

    \return a GUIDO handler to the new GR structure, or 0.
    \sa \p GuidoMakeGRMusic()

    
    replaced by GuidoAR2GR 
*/
//  GUIDOAPI(GRHandler) GuidoFactoryMakeGR_Obsolete( ARHandler inHandleAR );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryOpenVoice( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryCloseVoice( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryOpenChord( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryCloseChord( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
//  todo check semantic and rename
    GUIDOAPI(GuidoErrCode)  GuidoFactoryInsertCommata( ARFactoryHandler inFactory ); // is it a correct name ?

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryOpenEvent( ARFactoryHandler inFactory, const char * inEventName );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryCloseEvent( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryAddSharp( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryAddFlat( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactorySetEventDots( ARFactoryHandler inFactory, int dots );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactorySetEventAccidentals( ARFactoryHandler inFactory, int accident );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactorySetOctave( ARFactoryHandler inFactory, int octave );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactorySetDuration( ARFactoryHandler inFactory, int numerator, int denominator );

// ----------------------------------------------------------------------------
/* \brief Add a tag to the current voice.

    \param inFactory a handler to a Guido Factory (created with GuidoFactoryOpen)
    \param name: the tag name
    \param tagID: is the number that the parser generates for advanced GUIDO
    \return an error code.
*/
    GUIDOAPI(GuidoErrCode)  GuidoFactoryOpenTag( ARFactoryHandler inFactory, const char * name, long tagID );

// ----------------------------------------------------------------------------
/* \brief Add a tag to the current voice.

    \param inFactory a handler to a Guido Factory (created with GuidoFactoryOpen)
    \param name: the tag name
    \param tagID: is the number that the parser generates for advanced GUIDO
    \return an error code.
*/
    GUIDOAPI(GuidoErrCode)  GuidoFactoryOpenRangeTag( ARFactoryHandler inFactory, const char * name, long tagID );


// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryEndTag( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryCloseTag( ARFactoryHandler inFactory );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryAddTagParameterString( ARFactoryHandler inFactory, const char * val );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryAddTagParameterInt( ARFactoryHandler inFactory, int val );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryAddTagParameterFloat( ARFactoryHandler inFactory, double val );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactorySetParameterName( ARFactoryHandler inFactory, const char * name );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactorySetParameterUnit( ARFactoryHandler inFactory, const char * unit );
#ifdef __UseOldGUIDOFactory__
// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryCreateTag( ARFactoryHandler inFactory, const char * inTagName, long tagID );

// ----------------------------------------------------------------------------
    GUIDOAPI(GuidoErrCode)  GuidoFactoryIsRangeTag( ARFactoryHandler inFactory );

#endif

#ifdef __cplusplus
}
#endif

#endif