OSA.h

Go to the documentation of this file.

 
#ifndef __OSA__
#define __OSA__
 
#ifndef __MACERRORS__
#include <MacErrors.h>
#endif
 
#ifndef __APPLEEVENTS__
#include <AppleEvents.h>
#endif
 
#ifndef __AEOBJECTS__
#include <AEObjects.h>
#endif
 
#ifndef __AEINTERACTION__
#include <AEInteraction.h>
#endif
 
#ifndef __COMPONENTS__
#include <Components.h>
#endif
 
#ifndef __MACERRORS__
#include <MacErrors.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
    /***************************************************************************
        Types and Constants
    **************************************************************************/
 
    enum
    {
        kOSAComponentType = FOUR_CHAR_CODE('osa ')
    };
 
    enum
    {
        kOSAGenericScriptingComponentSubtype = FOUR_CHAR_CODE('scpt')
    };
 
    enum
    {
        kOSAFileType = FOUR_CHAR_CODE('osas')
    };
 
    enum
    {
        kOSASuite = FOUR_CHAR_CODE('ascr')
    };
 
    enum
    {
        kOSARecordedText = FOUR_CHAR_CODE('recd')
    };
 
    enum
    {
        kOSAScriptIsModified = FOUR_CHAR_CODE('modi')
    };
 
    enum
    {
        kOSAScriptIsTypeCompiledScript = FOUR_CHAR_CODE('cscr')
    };
 
    enum
    {
        kOSAScriptIsTypeScriptValue = FOUR_CHAR_CODE('valu')
    };
 
    enum
    {
        kOSAScriptIsTypeScriptContext = FOUR_CHAR_CODE('cntx')
    };
 
    enum
    {
        kOSAScriptBestType = FOUR_CHAR_CODE('best')
    };
 
    enum
    {
        kOSACanGetSource = FOUR_CHAR_CODE('gsrc')
    };
 
    enum
    {
        typeOSADialectInfo = FOUR_CHAR_CODE('difo'),     
        keyOSADialectName = FOUR_CHAR_CODE('dnam'),      
        keyOSADialectCode = FOUR_CHAR_CODE('dcod'),      
        keyOSADialectLangCode = FOUR_CHAR_CODE('dlcd'),  
        keyOSADialectScriptCode = FOUR_CHAR_CODE('dscd') 
    };
 
    typedef ComponentResult OSAError;
    typedef unsigned long OSAID;
    enum
    {
        kOSANullScript = 0L
    };
 
    enum
    {
        kOSANullMode = 0, 
        kOSAModeNull = 0  
    };
 
    typedef CALLBACK_API(OSErr, OSACreateAppleEventProcPtr)(
        AEEventClass theAEEventClass, AEEventID theAEEventID,
        const AEAddressDesc *target, short returnID, long transactionID,
        AppleEvent *result, long refCon);
    typedef CALLBACK_API(OSErr,
                         OSASendProcPtr)(const AppleEvent *theAppleEvent,
                                         AppleEvent *reply, AESendMode sendMode,
                                         AESendPriority sendPriority,
                                         long timeOutInTicks, AEIdleUPP idleProc,
                                         AEFilterUPP filterProc, long refCon);
    typedef STACK_UPP_TYPE(OSACreateAppleEventProcPtr) OSACreateAppleEventUPP;
    typedef STACK_UPP_TYPE(OSASendProcPtr) OSASendUPP;
    OSACreateAppleEventUPP
    NewOSACreateAppleEventUPP(OSACreateAppleEventProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
    enum
    {
        uppOSACreateAppleEventProcInfo = 0x000FEFE0
    }; 
#ifdef __cplusplus
    inline OSACreateAppleEventUPP
    NewOSACreateAppleEventUPP(OSACreateAppleEventProcPtr userRoutine)
    {
        return (OSACreateAppleEventUPP)NewRoutineDescriptor(
            (ProcPtr)(userRoutine), uppOSACreateAppleEventProcInfo,
            GetCurrentArchitecture());
    }
#else
#define NewOSACreateAppleEventUPP(userRoutine)                  \
    (OSACreateAppleEventUPP) NewRoutineDescriptor(              \
        (ProcPtr)(userRoutine), uppOSACreateAppleEventProcInfo, \
        GetCurrentArchitecture())
#endif
#endif
 
    OSASendUPP
    NewOSASendUPP(OSASendProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
    enum
    {
        uppOSASendProcInfo = 0x003FEFE0
    }; 
#ifdef __cplusplus
    inline OSASendUPP NewOSASendUPP(OSASendProcPtr userRoutine)
    {
        return (OSASendUPP)NewRoutineDescriptor(
            (ProcPtr)(userRoutine), uppOSASendProcInfo, GetCurrentArchitecture());
    }
#else
#define NewOSASendUPP(userRoutine)     \
    (OSASendUPP) NewRoutineDescriptor( \
        (ProcPtr)(userRoutine), uppOSASendProcInfo, GetCurrentArchitecture())
#endif
#endif
 
    void
    DisposeOSACreateAppleEventUPP(OSACreateAppleEventUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
    inline void DisposeOSACreateAppleEventUPP(OSACreateAppleEventUPP userUPP)
    {
        DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
    }
#else
#define DisposeOSACreateAppleEventUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
    void
    DisposeOSASendUPP(OSASendUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
    inline void DisposeOSASendUPP(OSASendUPP userUPP)
    {
        DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
    }
#else
#define DisposeOSASendUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
    OSErr
    InvokeOSACreateAppleEventUPP(AEEventClass theAEEventClass,
                                 AEEventID theAEEventID,
                                 const AEAddressDesc *target, short returnID,
                                 long transactionID, AppleEvent *result,
                                 long refCon, OSACreateAppleEventUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
    inline OSErr InvokeOSACreateAppleEventUPP(AEEventClass theAEEventClass,
                                              AEEventID theAEEventID,
                                              const AEAddressDesc *target,
                                              short returnID, long transactionID,
                                              AppleEvent *result, long refCon,
                                              OSACreateAppleEventUPP userUPP)
    {
        return (OSErr)CALL_SEVEN_PARAMETER_UPP(
            userUPP, uppOSACreateAppleEventProcInfo, theAEEventClass, theAEEventID,
            target, returnID, transactionID, result, refCon);
    }
#else
#define InvokeOSACreateAppleEventUPP(theAEEventClass, theAEEventID, target,     \
                                     returnID, transactionID, result, refCon,   \
                                     userUPP)                                   \
    (OSErr) CALL_SEVEN_PARAMETER_UPP((userUPP), uppOSACreateAppleEventProcInfo, \
                                     (theAEEventClass), (theAEEventID),         \
                                     (target), (returnID), (transactionID),     \
                                     (result), (refCon))
#endif
#endif
 
    OSErr
    InvokeOSASendUPP(const AppleEvent *theAppleEvent, AppleEvent *reply,
                     AESendMode sendMode, AESendPriority sendPriority,
                     long timeOutInTicks, AEIdleUPP idleProc,
                     AEFilterUPP filterProc, long refCon, OSASendUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
    inline OSErr InvokeOSASendUPP(const AppleEvent *theAppleEvent,
                                  AppleEvent *reply, AESendMode sendMode,
                                  AESendPriority sendPriority, long timeOutInTicks,
                                  AEIdleUPP idleProc, AEFilterUPP filterProc,
                                  long refCon, OSASendUPP userUPP)
    {
        return (OSErr)CALL_EIGHT_PARAMETER_UPP(
            userUPP, uppOSASendProcInfo, theAppleEvent, reply, sendMode, sendPriority,
            timeOutInTicks, idleProc, filterProc, refCon);
    }
#else
#define InvokeOSASendUPP(theAppleEvent, reply, sendMode, sendPriority,       \
                         timeOutInTicks, idleProc, filterProc, refCon,       \
                         userUPP)                                            \
    (OSErr) CALL_EIGHT_PARAMETER_UPP(                                        \
        (userUPP), uppOSASendProcInfo, (theAppleEvent), (reply), (sendMode), \
        (sendPriority), (timeOutInTicks), (idleProc), (filterProc), (refCon))
#endif
#endif
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
#define NewOSACreateAppleEventProc(userRoutine) \
    NewOSACreateAppleEventUPP(userRoutine)
#define NewOSASendProc(userRoutine) NewOSASendUPP(userRoutine)
#define CallOSACreateAppleEventProc(userRoutine, theAEEventClass,         \
                                    theAEEventID, target, returnID,       \
                                    transactionID, result, refCon)        \
    InvokeOSACreateAppleEventUPP(theAEEventClass, theAEEventID, target,   \
                                 returnID, transactionID, result, refCon, \
                                 userRoutine)
#define CallOSASendProc(userRoutine, theAppleEvent, reply, sendMode,        \
                        sendPriority, timeOutInTicks, idleProc, filterProc, \
                        refCon)                                             \
    InvokeOSASendUPP(theAppleEvent, reply, sendMode, sendPriority,          \
                     timeOutInTicks, idleProc, filterProc, refCon, userRoutine)
#endif 
    /***************************************************************************
        OSA Interface Descriptions
    **************************************************************************
        The OSA Interface is broken down into a required interface, and several
        optional interfaces to support additional functionality.  A given scripting
        component may choose to support only some of the optional interfaces in
        addition to the basic interface.  The OSA Component Flags may be used to
        query the Component Manager to find a scripting component with a particular
        capability, or determine if a particular scripting component supports a
        particular capability.
    **************************************************************************/
    enum
    {
        kOSASupportsCompiling = 0x0002,
        kOSASupportsGetSource = 0x0004,
        kOSASupportsAECoercion = 0x0008,
        kOSASupportsAESending = 0x0010,
        kOSASupportsRecording = 0x0020,
        kOSASupportsConvenience = 0x0040,
        kOSASupportsDialects = 0x0080,
        kOSASupportsEventHandling = 0x0100
    };
 
    enum
    {
        kOSASelectLoad = 0x0001,
        kOSASelectStore = 0x0002,
        kOSASelectExecute = 0x0003,
        kOSASelectDisplay = 0x0004,
        kOSASelectScriptError = 0x0005,
        kOSASelectDispose = 0x0006,
        kOSASelectSetScriptInfo = 0x0007,
        kOSASelectGetScriptInfo = 0x0008,
        kOSASelectSetActiveProc = 0x0009,
        kOSASelectGetActiveProc = 0x000A
    };
 
    enum
    {
        kOSASelectScriptingComponentName = 0x0102,
        kOSASelectCompile = 0x0103,
        kOSASelectCopyID = 0x0104
    };
 
    enum
    {
        kOSASelectCopyScript = 0x0105
    };
 
    enum
    {
        kOSASelectGetSource = 0x0201
    };
 
    enum
    {
        kOSASelectCoerceFromDesc = 0x0301,
        kOSASelectCoerceToDesc = 0x0302
    };
 
    enum
    {
        kOSASelectSetSendProc = 0x0401,
        kOSASelectGetSendProc = 0x0402,
        kOSASelectSetCreateProc = 0x0403,
        kOSASelectGetCreateProc = 0x0404,
        kOSASelectSetDefaultTarget = 0x0405
    };
 
    enum
    {
        kOSASelectStartRecording = 0x0501,
        kOSASelectStopRecording = 0x0502
    };
 
    enum
    {
        kOSASelectLoadExecute = 0x0601,
        kOSASelectCompileExecute = 0x0602,
        kOSASelectDoScript = 0x0603
    };
 
    enum
    {
        kOSASelectSetCurrentDialect = 0x0701,
        kOSASelectGetCurrentDialect = 0x0702,
        kOSASelectAvailableDialects = 0x0703,
        kOSASelectGetDialectInfo = 0x0704,
        kOSASelectAvailableDialectCodeList = 0x0705
    };
 
    enum
    {
        kOSASelectSetResumeDispatchProc = 0x0801,
        kOSASelectGetResumeDispatchProc = 0x0802,
        kOSASelectExecuteEvent = 0x0803,
        kOSASelectDoEvent = 0x0804,
        kOSASelectMakeContext = 0x0805
    };
 
    enum
    {
        kOSADebuggerCreateSession = 0x0901,
        kOSADebuggerGetSessionState = 0x0902,
        kOSADebuggerSessionStep = 0x0903,
        kOSADebuggerDisposeSession = 0x0904,
        kOSADebuggerGetStatementRanges = 0x0905,
        kOSADebuggerGetBreakpoint = 0x0910,
        kOSADebuggerSetBreakpoint = 0x0911,
        kOSADebuggerGetDefaultBreakpoint = 0x0912,
        kOSADebuggerGetCurrentCallFrame = 0x0906,
        kOSADebuggerGetCallFrameState = 0x0907,
        kOSADebuggerGetVariable = 0x0908,
        kOSADebuggerSetVariable = 0x0909,
        kOSADebuggerGetPreviousCallFrame = 0x090A,
        kOSADebuggerDisposeCallFrame = 0x090B,
        kOSADebuggerCountVariables = 0x090C
    };
 
    enum
    {
        kOSASelectComponentSpecificStart = 0x1001
    };
 
    enum
    {
        kOSAModePreventGetSource = 0x00000001
    };
 
    enum
    {
        kOSAModeNeverInteract = kAENeverInteract,
        kOSAModeCanInteract = kAECanInteract,
        kOSAModeAlwaysInteract = kAEAlwaysInteract,
        kOSAModeDontReconnect = kAEDontReconnect
    };
 
    enum
    {
        kOSAModeCantSwitchLayer = 0x00000040
    };
 
    enum
    {
        kOSAModeDoRecord = 0x00001000
    };
 
    enum
    {
        kOSAModeCompileIntoContext = 0x00000002
    };
 
    enum
    {
        kOSAModeAugmentContext = 0x00000004
    };
 
    enum
    {
        kOSAModeDisplayForHumans = 0x00000008
    };
 
    enum
    {
        kOSAModeDontStoreParent = 0x00010000
    };
 
    enum
    {
        kOSAModeDispatchToDirectObject = 0x00020000
    };
 
    enum
    {
        kOSAModeDontGetDataForArguments = 0x00040000
    };
 
    /***************************************************************************
        OSA Basic Scripting Interface
    **************************************************************************
        Scripting components must at least support the Basic Scripting interface.
    **************************************************************************/
    enum
    {
        kOSAScriptResourceType = kOSAGenericScriptingComponentSubtype
    };
 
    enum
    {
        typeOSAGenericStorage = kOSAScriptResourceType
    };
 
    OSAError
    OSALoad(ComponentInstance scriptingComponent, const AEDesc *scriptData,
            long modeFlags, OSAID *resultingScriptID);
 
    OSAError
    OSAStore(ComponentInstance scriptingComponent, OSAID scriptID,
             DescType desiredType, long modeFlags, AEDesc *resultingScriptData);
 
    OSAError
    OSAExecute(ComponentInstance scriptingComponent, OSAID compiledScriptID,
               OSAID contextID, long modeFlags, OSAID *resultingScriptValueID);
 
    OSAError
    OSADisplay(ComponentInstance scriptingComponent, OSAID scriptValueID,
               DescType desiredType, long modeFlags, AEDesc *resultingText);
 
    OSAError
    OSAScriptError(ComponentInstance scriptingComponent, OSType selector,
                   DescType desiredType, AEDesc *resultingErrorDescription);
 
    enum
    {
        kOSAErrorNumber = keyErrorNumber
    };
 
    enum
    {
        kOSAErrorMessage = keyErrorString
    };
 
    enum
    {
        kOSAErrorBriefMessage = FOUR_CHAR_CODE('errb')
    };
 
    enum
    {
        kOSAErrorApp = FOUR_CHAR_CODE('erap')
    };
 
    enum
    {
        kOSAErrorPartialResult = FOUR_CHAR_CODE('ptlr')
    };
 
    enum
    {
        kOSAErrorOffendingObject = FOUR_CHAR_CODE('erob')
    };
 
    enum
    {
        kOSAErrorExpectedType = FOUR_CHAR_CODE('errt')
    };
 
    enum
    {
        kOSAErrorRange = FOUR_CHAR_CODE('erng')
    };
 
    enum
    {
        typeOSAErrorRange = FOUR_CHAR_CODE('erng')
    };
 
    enum
    {
        keyOSASourceStart = FOUR_CHAR_CODE('srcs')
    };
 
    enum
    {
        keyOSASourceEnd = FOUR_CHAR_CODE('srce')
    };
 
    OSAError
    OSADispose(ComponentInstance scriptingComponent, OSAID scriptID);
 
    OSAError
    OSASetScriptInfo(ComponentInstance scriptingComponent, OSAID scriptID,
                     OSType selector, long value);
 
    OSAError
    OSAGetScriptInfo(ComponentInstance scriptingComponent, OSAID scriptID,
                     OSType selector, long *result);
 
    typedef CALLBACK_API(OSErr, OSAActiveProcPtr)(long refCon);
    typedef STACK_UPP_TYPE(OSAActiveProcPtr) OSAActiveUPP;
    OSAActiveUPP
    NewOSAActiveUPP(OSAActiveProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
    enum
    {
        uppOSAActiveProcInfo = 0x000000E0
    }; 
#ifdef __cplusplus
    inline OSAActiveUPP NewOSAActiveUPP(OSAActiveProcPtr userRoutine)
    {
        return (OSAActiveUPP)NewRoutineDescriptor(
            (ProcPtr)(userRoutine), uppOSAActiveProcInfo, GetCurrentArchitecture());
    }
#else
#define NewOSAActiveUPP(userRoutine)     \
    (OSAActiveUPP) NewRoutineDescriptor( \
        (ProcPtr)(userRoutine), uppOSAActiveProcInfo, GetCurrentArchitecture())
#endif
#endif
 
    void
    DisposeOSAActiveUPP(OSAActiveUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
    inline void DisposeOSAActiveUPP(OSAActiveUPP userUPP)
    {
        DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
    }
#else
#define DisposeOSAActiveUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
    OSErr
    InvokeOSAActiveUPP(long refCon, OSAActiveUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
    inline OSErr InvokeOSAActiveUPP(long refCon, OSAActiveUPP userUPP)
    {
        return (OSErr)CALL_ONE_PARAMETER_UPP(userUPP, uppOSAActiveProcInfo, refCon);
    }
#else
#define InvokeOSAActiveUPP(refCon, userUPP) \
    (OSErr) CALL_ONE_PARAMETER_UPP((userUPP), uppOSAActiveProcInfo, (refCon))
#endif
#endif
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
#define NewOSAActiveProc(userRoutine) NewOSAActiveUPP(userRoutine)
#define CallOSAActiveProc(userRoutine, refCon) \
    InvokeOSAActiveUPP(refCon, userRoutine)
#endif 
    OSAError
    OSASetActiveProc(ComponentInstance scriptingComponent, OSAActiveUPP activeProc,
                     long refCon);
 
    OSAError
    OSAGetActiveProc(ComponentInstance scriptingComponent, OSAActiveUPP *activeProc,
                     long *refCon);
 
    /***************************************************************************
        OSA Optional Compiling Interface
    **************************************************************************
        Scripting components that support the Compiling interface have the
        kOSASupportsCompiling bit set in it's ComponentDescription.
    **************************************************************************/
    OSAError
    OSAScriptingComponentName(ComponentInstance scriptingComponent,
                              AEDesc *resultingScriptingComponentName);
 
    OSAError
    OSACompile(ComponentInstance scriptingComponent, const AEDesc *sourceData,
               long modeFlags, OSAID *previousAndResultingScriptID);
 
    OSAError
    OSACopyID(ComponentInstance scriptingComponent, OSAID fromID, OSAID *toID);
 
#if CALL_NOT_IN_CARBON
    OSAError
    OSACopyScript(ComponentInstance scriptingComponent, OSAID fromID, OSAID *toID);
 
#endif 
    /***************************************************************************
        OSA Optional GetSource Interface
    **************************************************************************
        Scripting components that support the GetSource interface have the
        kOSASupportsGetSource bit set in their ComponentDescription.
    **************************************************************************/
    OSAError
    OSAGetSource(ComponentInstance scriptingComponent, OSAID scriptID,
                 DescType desiredType, AEDesc *resultingSourceData);
 
    /***************************************************************************
        OSA Optional AECoercion Interface
    **************************************************************************
        Scripting components that support the AECoercion interface have the
        kOSASupportsAECoercion bit set in their ComponentDescription.
    **************************************************************************/
    OSAError
    OSACoerceFromDesc(ComponentInstance scriptingComponent,
                      const AEDesc *scriptData, long modeFlags,
                      OSAID *resultingScriptID);
 
    OSAError
    OSACoerceToDesc(ComponentInstance scriptingComponent, OSAID scriptID,
                    DescType desiredType, long modeFlags, AEDesc *result);
 
    /***************************************************************************
        OSA Optional AESending Interface
    **************************************************************************
        Scripting components that support the AESending interface have the
        kOSASupportsAESending bit set in their ComponentDescription.
    **************************************************************************/
    OSAError
    OSASetSendProc(ComponentInstance scriptingComponent, OSASendUPP sendProc,
                   long refCon);
 
    OSAError
    OSAGetSendProc(ComponentInstance scriptingComponent, OSASendUPP *sendProc,
                   long *refCon);
 
    OSAError
    OSASetCreateProc(ComponentInstance scriptingComponent,
                     OSACreateAppleEventUPP createProc, long refCon);
 
    OSAError
    OSAGetCreateProc(ComponentInstance scriptingComponent,
                     OSACreateAppleEventUPP *createProc, long *refCon);
 
    OSAError
    OSASetDefaultTarget(ComponentInstance scriptingComponent,
                        const AEAddressDesc *target);
 
    /***************************************************************************
        OSA Optional Recording Interface
    **************************************************************************
        Scripting components that support the Recording interface have the
        kOSASupportsRecording bit set in their ComponentDescription.
    **************************************************************************/
    OSAError
    OSAStartRecording(ComponentInstance scriptingComponent,
                      OSAID *compiledScriptToModifyID);
 
    OSAError
    OSAStopRecording(ComponentInstance scriptingComponent, OSAID compiledScriptID);
 
    /***************************************************************************
        OSA Optional Convenience Interface
    **************************************************************************
        Scripting components that support the Convenience interface have the
        kOSASupportsConvenience bit set in their ComponentDescription.
    **************************************************************************/
    OSAError
    OSALoadExecute(ComponentInstance scriptingComponent, const AEDesc *scriptData,
                   OSAID contextID, long modeFlags, OSAID *resultingScriptValueID);
 
    OSAError
    OSACompileExecute(ComponentInstance scriptingComponent,
                      const AEDesc *sourceData, OSAID contextID, long modeFlags,
                      OSAID *resultingScriptValueID);
 
    OSAError
    OSADoScript(ComponentInstance scriptingComponent, const AEDesc *sourceData,
                OSAID contextID, DescType desiredType, long modeFlags,
                AEDesc *resultingText);
 
    /***************************************************************************
        OSA Optional Dialects Interface
    **************************************************************************
        Scripting components that support the Dialects interface have the
        kOSASupportsDialects bit set in their ComponentDescription.
    **************************************************************************/
    OSAError
    OSASetCurrentDialect(ComponentInstance scriptingComponent, short dialectCode);
 
    OSAError
    OSAGetCurrentDialect(ComponentInstance scriptingComponent,
                         short *resultingDialectCode);
 
    OSAError
    OSAAvailableDialects(ComponentInstance scriptingComponent,
                         AEDesc *resultingDialectInfoList);
 
    OSAError
    OSAGetDialectInfo(ComponentInstance scriptingComponent, short dialectCode,
                      OSType selector, AEDesc *resultingDialectInfo);
 
    OSAError
    OSAAvailableDialectCodeList(ComponentInstance scriptingComponent,
                                AEDesc *resultingDialectCodeList);
 
    /***************************************************************************
        OSA Optional Event Handling Interface
    **************************************************************************
        Scripting components that support the Event Handling interface have the
        kOSASupportsEventHandling bit set in their ComponentDescription.
    **************************************************************************/
    OSAError
    OSASetResumeDispatchProc(ComponentInstance scriptingComponent,
                             AEEventHandlerUPP resumeDispatchProc, long refCon);
 
    enum
    {
        kOSAUseStandardDispatch = kAEUseStandardDispatch
    };
 
    enum
    {
        kOSANoDispatch = kAENoDispatch
    };
 
    enum
    {
        kOSADontUsePhac = 0x0001
    };
 
    OSAError
    OSAGetResumeDispatchProc(ComponentInstance scriptingComponent,
                             AEEventHandlerUPP *resumeDispatchProc, long *refCon);
 
    OSAError
    OSAExecuteEvent(ComponentInstance scriptingComponent,
                    const AppleEvent *theAppleEvent, OSAID contextID,
                    long modeFlags, OSAID *resultingScriptValueID);
 
    OSAError
    OSADoEvent(ComponentInstance scriptingComponent,
               const AppleEvent *theAppleEvent, OSAID contextID, long modeFlags,
               AppleEvent *reply);
 
    OSAError
    OSAMakeContext(ComponentInstance scriptingComponent, const AEDesc *contextName,
                   OSAID parentContext, OSAID *resultingContextID);
 
    typedef OSAID OSADebugSessionRef;
    typedef OSAID OSADebugCallFrameRef;
    typedef UInt32 OSAProgramState;
    enum
    {
        eNotStarted = 0,
        eRunnable = 1,
        eRunning = 2,
        eStopped = 3,
        eTerminated = 4
    };
 
    typedef UInt32 OSADebugStepKind;
    enum
    {
        eStepOver = 0,
        eStepIn = 1,
        eStepOut = 2,
        eRun = 3
    };
 
    typedef UInt32 OSALocalOrGlobal;
    enum
    {
        eLocal = 0,
        eGlobal = 1,
        eProperties = 2
    };
 
    enum
    {
        keyProgramState = FOUR_CHAR_CODE('dsps')
    };
 
    struct StatementRange
    {
        unsigned long startPos;
        unsigned long endPos;
    };
    typedef struct StatementRange StatementRange;
    enum
    {
        typeStatementRange = FOUR_CHAR_CODE('srng')
    };
 
    enum
    {
        keyProcedureName = FOUR_CHAR_CODE('dfnm'),  
        keyStatementRange = FOUR_CHAR_CODE('dfsr'), 
        keyLocalsNames = FOUR_CHAR_CODE('dfln'),    
        keyGlobalsNames = FOUR_CHAR_CODE('dfgn'),   
        keyParamsNames = FOUR_CHAR_CODE('dfpn')     
    };
 
    OSAError
    OSADebuggerCreateSession(ComponentInstance scriptingComponent, OSAID inScript,
                             OSAID inContext, OSADebugSessionRef *outSession);
 
    OSAError
    OSADebuggerGetSessionState(ComponentInstance scriptingComponent,
                               OSADebugSessionRef inSession, AERecord *outState);
 
    OSAError
    OSADebuggerSessionStep(ComponentInstance scriptingComponent,
                           OSADebugSessionRef inSession, OSADebugStepKind inKind);
 
    OSAError
    OSADebuggerDisposeSession(ComponentInstance scriptingComponent,
                              OSADebugSessionRef inSession);
 
    OSAError
    OSADebuggerGetStatementRanges(ComponentInstance scriptingComponent,
                                  OSADebugSessionRef inSession,
                                  AEDescList *outStatementRangeArray);
 
    OSAError
    OSADebuggerGetBreakpoint(ComponentInstance scriptingComponent,
                             OSADebugSessionRef inSession, UInt32 inSrcOffset,
                             OSAID *outBreakpoint);
 
    OSAError
    OSADebuggerSetBreakpoint(ComponentInstance scriptingComponent,
                             OSADebugSessionRef inSession, UInt32 inSrcOffset,
                             OSAID inBreakpoint);
 
    OSAError
    OSADebuggerGetDefaultBreakpoint(ComponentInstance scriptingComponent,
                                    OSADebugSessionRef inSession,
                                    OSAID *outBreakpoint);
 
    OSAError
    OSADebuggerGetCurrentCallFrame(ComponentInstance scriptingComponent,
                                   OSADebugSessionRef inSession,
                                   OSADebugCallFrameRef *outCallFrame);
 
    OSAError
    OSADebuggerGetCallFrameState(ComponentInstance scriptingComponent,
                                 OSADebugCallFrameRef inCallFrame,
                                 AERecord *outState);
 
    OSAError
    OSADebuggerGetVariable(ComponentInstance scriptingComponent,
                           OSADebugCallFrameRef inCallFrame,
                           const AEDesc *inVariableName, OSAID *outVariable);
 
    OSAError
    OSADebuggerSetVariable(ComponentInstance scriptingComponent,
                           OSADebugCallFrameRef inCallFrame,
                           const AEDesc *inVariableName, OSAID inVariable);
 
    OSAError
    OSADebuggerGetPreviousCallFrame(ComponentInstance scriptingComponent,
                                    OSADebugCallFrameRef inCurrentFrame,
                                    OSADebugCallFrameRef *outPrevFrame);
 
    OSAError
    OSADebuggerDisposeCallFrame(ComponentInstance scriptingComponent,
                                OSADebugCallFrameRef inCallFrame);
 
    OSAError
    OSADebuggerCountVariables(ComponentInstance scriptingComponent,
                              OSADebugSessionRef inSession,
                              OSADebugCallFrameRef inCallFrame,
                              OSALocalOrGlobal inWhichSet, long *outVariableCount);
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif