errors.h

Go to the documentation of this file.

/*
  $Id: errors.h 3623 2009-09-25 11:14:32Z leighsmith $
  Defined In: The MusicKit

  Description:
    This file has trace codes as well as error codes used by the MusicKit.

  Original Author: David Jaffe

  Copyright (c) 1988-1992, NeXT Computer, Inc.
  Portions Copyright (c) 1994 NeXT Computer, Inc. and reproduced under license from NeXT
  Portions Copyright (c) 1994 Stanford University
  Portions Copyright (c) 1999-2005 The MusicKit Project.
*/
#ifndef __MK_errors_H___
#define __MK_errors_H___

#import <Foundation/Foundation.h>

#define MK_TRACEORCHALLOC 1

#define MK_TRACEPARS 2

#define MK_TRACEDSP 4

#define MK_TRACEMIDI 8

#define MK_TRACEPREEMPT 16

#define MK_TRACESYNTHINS  32

#define MK_TRACESYNTHPATCH 64

#define MK_TRACEUNITGENERATOR 128

#define MK_TRACECONDUCTOR 256

#define MK_TRACEDSPARRAYS 512

extern unsigned MKSetTrace(int traceCode);

extern unsigned MKClearTrace(int traceCode);

extern BOOL MKIsTraced(int traceCode);

extern void MKSetScorefileParseErrorAbort(int threshholdCount);

extern void MKSetErrorProc(void (*errProc)(NSString *msg));

extern void MKError(NSString *msg);

extern void MKSetErrorStream(NSMutableData *aStream);

extern NSMutableData *MKErrorStream(void);

/* Errors generated by the MusicKit. You don't normally generate these 
 * yourself. */

#define MK_ERRORBASE 4000    /* 1000 error codes for us start here */

typedef enum _MKErrno {
    // <b>GENERAL ERRORS</b>
    MK_musicKitErr = MK_ERRORBASE,
    MK_machErr,

    // <b>REPRESENTATION ERRORS</b>General purpose errors dealing with music representation.    
    MK_cantOpenFileErr,
    MK_cantCloseFileErr,
    MK_outOfOrderErr,           /* Scorefile parsing/writing error */
    MK_samplesNoResampleErr,
    MK_noMoreTagsErr,
    MK_notScorefileObjectTypeErr,
    
    /* Synthesis errors */    
    MK_orchBadFreeErr,
    MK_synthDataCantClearErr,   /* MKSynthData errors */ 
    MK_synthDataLoadErr,
    MK_synthDataReadonlyErr,
    MK_synthInsOmitNoteErr,     /* MKSynthInstrument errors */
    MK_synthInsNoClass,
    MK_ugLoadErr,               /* MKUnitGenerator errors. */
    MK_ugBadArgErr,
    MK_ugBadAddrPokeErr,
    MK_ugBadDatumPokeErr,
    MK_ugOrchMismatchErr,
    MK_ugArgSpaceMismatchErr,
    MK_ugNonAddrErr,
    MK_ugNonDatumErr,

    /* Scorefile Language Errors. */
    MK_sfBadExprErr,     /* Illegal constructs */
    MK_sfBadDefineErr,
    MK_sfBadParValErr,
    MK_sfNoNestDefineErr,

    MK_sfBadDeclErr,     /* Missing constructs */
    MK_sfMissingStringErr,
    MK_sfBadNoteTypeErr,
    MK_sfBadNoteTagErr,
    MK_sfMissingBackslashErr,
    MK_sfMissingSemicolonErr,
    MK_sfUndeclaredErr,
    MK_sfBadAssignErr,
    MK_sfBadIncludeErr,
    MK_sfBadParamErr,
    MK_sfNumberErr,
    MK_sfStringErr,
    MK_sfGlobalErr,
    MK_sfCantFindGlobalErr,
    
    MK_sfMulDefErr, /* Duplicate constructs */
    MK_sfDuplicateDeclErr,

    MK_sfNotHereErr,
    MK_sfWrongTypeDeclErr,
    MK_sfBadHeaderStmtErr,
    MK_sfBadStmtErr,

    MK_sfBadInitErr,
    MK_sfNoTuneErr,
    MK_sfNoIncludeErr,
    MK_sfCantFindFileErr,
    MK_sfCantWriteErr,
    MK_sfOutOfOrderErr,
    MK_sfUnmatchedCommentErr,
    MK_sfInactiveNoteTagErr,
    MK_sfCantFindClass,
    MK_sfBoundsErr, 
    MK_sfTypeConversionErr,
    MK_sfReadOnlyErr,
    MK_sfArithErr,
    MK_sfNonScorefileErr,
    MK_sfTooManyErrorsErr,
    
    /* Unit generator library errors. */
    MK_ugsNotSetRunErr,
    MK_ugsPowerOf2Err,
    MK_ugsNotSetGetErr,

    /* Synth patch library errors. */
    MK_spsCantGetMemoryErr,
    MK_spsSineROMSubstitutionErr,
    MK_spsInvalidPartialsDatabaseKeywordErr, 
    MK_spsOutOfRangeErr,
    MK_spsCantGetUGErr,

    /* Errors added in Release 3.0 */
    MK_synthDataCantReadDSPErr,
    MK_dspMonitorVersionError,
    /* End marker */
    MK_highestErr,
    /* Reserved from here until MK_maxErr */
    MK_maxErr = (MK_ERRORBASE + 1000)
} MKErrno;

#define MK_sfNonAsciiErr MK_sfNonScorefileErr /* For backwards compatibility */


/* The remaining functions are the MusicKit's own internal error handling
 * functions. Normally, you don't call these functions.  However, if you 
 * need to raise an error with a MusicKit error code, you call MKErrorCode().  
 */

extern void MKErrorCode(int errorCode, ...); 
/* Calling sequence like printf, but first arg is musickit error code instead
 * of formating info, the second arg is a formating NSString derived from the string in
 * /Local/Library/MusicKit/Languages/<language>.lproj/Localized.strings. 
 *
 * It's the caller's responsibility that the expansion of the arguments 
 * using sprintf doesn't exceed the size of the error buffer (_MK_ERRLEN). 
 * Fashions the error message and sends it to MKError(). 
 */

#define _MK_ERRLEN 2048

/* 
 * These functions are for accessing MusicKit's localized strings. 
 */ 
extern NSBundle *_MKErrorBundle(void); 
/* 
 * MusicKit bundle for selected language in 
 * /usr/local/lib/MusicKit/Languages, if found.  
 */
extern NSString *_MKErrorStringFile(void); 
/* Returns "Localized" if _MKErrorBundle() returns non-null */

#endif

---