/*
$Id: _ScorefileVar.m,v 1.5 2006/02/05 17:57:10 leighsmith Exp $
Defined In: The MusicKit
HEADER FILES: MusicKit.h
Description:
This class is used for variable values. Setting a ScorefileVar never
changes its type unless it is an Untyped score var. Automatic type
conversion is done where possible.
This is a private musickit class.
Original Author: David A. 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
*/
/*
Modification history:
$Log: _ScorefileVar.m,v $
Revision 1.5 2006/02/05 17:57:10 leighsmith
Cleaned up prototypes for Xcode 2.2 as it is much more strict about mixing id with a defined type
Revision 1.4 2001/09/06 21:27:48 leighsmith
Merged RTF Reference documentation into headerdoc comments and prepended MK to any older class names
Revision 1.3 2000/05/13 17:16:49 leigh
Doco cleanup and stricter typing of parameters
Revision 1.2 1999/07/29 01:26:01 leigh
Added Win32 compatibility, CVS logs, SBs changes
09/18/89/daj - Changed myParameter to be a _MKParameter * instead of an object.
10/06/89/daj - Changed to use hashtable.h version of table.
03/21/90/daj - Small changes to quiet -W compiler warnings.
05/31/92/daj - Changed -name to -varName to avoid conflict with Object.
*/
#import "_musickit.h"
#import <ctype.h>
#import "_ParName.h"
#import "_ScorefileVar.h"
@implementation _ScorefileVar
_ScorefileVar *_MKNewScorefileVar(_MKParameter *parObj,NSString * name,BOOL untyped,BOOL isReadOnly)
/* You supply the parObj yourself. The name is copied, the rest of the object is not copied. */
{
_ScorefileVar *self = [_ScorefileVar new];
self->s = [name copy];// sb: was _MKMakeStr(name);
self->token = (untyped) ? _MK_untypedVar : _MK_typedVar;
self->readOnly = isReadOnly;
self->preDaemon = NULL;
self->postDaemon = NULL;
self->myParameter = parObj;
return self;
}
id _MKSetReadOnlySFVar(_ScorefileVar *self, BOOL yesOrNo)
{
self->readOnly = yesOrNo;
return self;
}
int _MKSetDoubleSFVar(_ScorefileVar *self, double floval)
/* Sets receiver, doing appropriate type conversion to type
of receiver. Attempting to set an envelope-valued typed ScorefileVar
with this method generates an error. */
{
if (self->readOnly)
return (int)MK_sfReadOnlyErr;
if (self->preDaemon) {
_MKParameterUnion aParameterNode;
aParameterNode.rval = floval;
if (!self->preDaemon(self,MK_double,&aParameterNode))
return 0;
}
if (self->token == _MK_untypedVar)
_MKSetDoublePar(self->myParameter,floval);
else switch (self->myParameter->_uType) {
case MK_double:
_MKSetDoublePar(self->myParameter,floval);
break;
case MK_int:
_MKSetIntPar(self->myParameter,(int)floval);
break;
case MK_string:
_MKSetStringPar(self->myParameter,_MKDoubleToStringNoCopy(floval));
break;
case MK_waveTable:
case MK_envelope:
return (int)MK_sfTypeConversionErr;
}
if (self->postDaemon)
self->postDaemon(self);
return 0;
}
int _MKSetIntSFVar(_ScorefileVar *self,int intval)
/* Sets receiver, doing appropriate type conversion to type
of receiver. Attempting to set an envelope-valued typed ScorefileVar
with this method generates an error. */
{
if (self->readOnly)
return (int)MK_sfReadOnlyErr;
if (self->preDaemon) {
_MKParameterUnion aParameterNode;
aParameterNode.ival = intval;
if (!self->preDaemon(self,MK_int,&aParameterNode))
return 0;
}
if (self->token == _MK_untypedVar) {
_MKSetIntPar(self->myParameter,intval);
}
else switch (self->myParameter->_uType) {
case MK_double:
_MKSetDoublePar(self->myParameter,(double)intval);
break;
case MK_int:
_MKSetIntPar(self->myParameter,intval);
break;
case MK_string:
_MKSetStringPar(self->myParameter,_MKIntToStringNoCopy(intval));
break;
default:
return (int)MK_sfTypeConversionErr;
}
if (self->postDaemon)
self->postDaemon(self);
return 0;
}
int _MKSetStringSFVar(_ScorefileVar *self,NSString * strval)
/* Sets receiver, doing appropriate type conversion to type
of receiver. Attempting to set an envelope-valued typed ScorefileVar
with this method generates an error. */
{
if (self->readOnly)
return (int)MK_sfReadOnlyErr;
if (self->preDaemon) {
_MKParameterUnion aParameterNode;
aParameterNode.sval = [strval copy];
if (!self->preDaemon(self,MK_string,&aParameterNode))
return 0;
}
if (self->token == _MK_untypedVar) {
_MKSetStringPar(self->myParameter,strval);
}
else switch (self->myParameter->_uType) {
case MK_string:
_MKSetStringPar(self->myParameter,strval);
break;
case MK_double:
_MKSetDoublePar(self->myParameter,_MKStringToDouble(strval));
break;
case MK_int:
_MKSetIntPar(self->myParameter,_MKStringToInt(strval));
break;
default:
return (int)MK_sfTypeConversionErr;
}
if (self->postDaemon)
self->postDaemon(self);
return 0;
}
static int setToSymbol(_ScorefileVar *self,id sym,int token)
{
int type;
if (self->readOnly)
return (int)MK_sfReadOnlyErr;
if (self->preDaemon) {
_MKParameterUnion aParameterNode;
aParameterNode.symbol = sym;
if (!self->preDaemon(self,token,&aParameterNode))
return 0;
}
if (self->token == _MK_untypedVar)
_MKSetObjPar(self->myParameter,sym,token);
else if ((type = self->myParameter->_uType) == token)
_MKSetObjPar(self->myParameter,sym,token);
else return (int)MK_sfTypeConversionErr;
if (self->postDaemon)
self->postDaemon(self);
return 0;
}
int _MKSetEnvSFVar(_ScorefileVar *self,id envelope)
/* Receiver must be untyped or envelope-typed. Envelope is not copied. */
{
return setToSymbol(self,envelope,MK_envelope);
}
int _MKSetWaveSFVar(_ScorefileVar *self,id waveTable)
/* Receiver must be untyped or waveTable-typed. MKWaveTable is not copied. */
{
return setToSymbol(self,waveTable,MK_waveTable);
}
int _MKSetObjSFVar(_ScorefileVar *self,id object)
/* Receiver must be untyped or object-typed. Object is not copied. */
{
return setToSymbol(self,object,MK_object);
}
int _MKSFVarInternalType(_ScorefileVar *self)
/* Return type of datum as represented in ScorefileVar. */
{
return self->myParameter->_uType;
}
_MKParameterUnion *_MKSFVarRaw(_ScorefileVar *self)
/* Returns the raw _MKParameterUnion * from the contained Parameter object. */
{
return _MKParRaw(self->myParameter);
}
_MKParameter *_MKSFVarGetParameter(_ScorefileVar *self)
/* Private method that returns the Parameter object used to hold the
receiver's value. */
{
return self->myParameter;
}
id _MKSetScorefileVarPreDaemon(self,funPtr)
_ScorefileVar *self;
BOOL (*funPtr)();
/* Assign the function pointed to by funPtr to be used before
the receiver's value is set. funPtr is a function of three arguments:
id ScorefileVarObject;
int newValueType;
_MKParameterUnion * ptrToNewValue;
It is called before the value is set and is used to filter bad values.
It returns YES if the value should be set or NO if it should not be set.
This method return self.
*/
{
self->preDaemon = funPtr;
return self;
}
id _MKSetScorefileVarPostDaemon(self,funPtr)
_ScorefileVar *self;
void (*funPtr)();
/* Assign the function pointed to by funPtr to be used after
the receiver's value is set. funPtr is a function of one argument:
id ScorefileVarObject; It is called after the value has been set and returns
no value. This method return self.
*/
{
self->postDaemon = funPtr;
return self;
}
-copy
/* Returns a copy of the ScorefileVar with the string datum
copied. */
{
_ScorefileVar *rtnVal;
rtnVal = [super copy];
rtnVal->myParameter = _MKCopyParameter(myParameter);
return rtnVal;
}
- writeScorefileStream:(NSMutableData *)aStream
/* Writes <ScorefileVarName> = <value>. */
{
[aStream appendData:[[NSString stringWithFormat:@"%s = ", s] dataUsingEncoding:NSNEXTSTEPStringEncoding]];
_MKParWriteValueOn(myParameter,aStream,NULL);
return self;
}
- (void) dealloc
/* Frees object */
{
if ((myParameter->parNum) != MK_privatePars)
_MKFreeParameter(myParameter); /* Otherwise it's a shared parval. Don't touch it in
that case. */
//free(s);
[s autorelease];
[super dealloc];
}
- (NSString *) varName
{
return s;
}
@end
