HyperXCmd.h

Go to the documentation of this file.

 
#ifndef __HYPERXCMD__
#define __HYPERXCMD__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __FP__
#include <fp.h>
#endif
 
#ifndef __EVENTS__
#include <Events.h>
#endif
 
#ifndef __TEXTEDIT__
#include <TextEdit.h>
#endif
 
#ifndef __MENUS__
#include <Menus.h>
#endif
 
#ifndef __STANDARDFILE__
#include <StandardFile.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
 
        /* result codes */
        enum
        {
                xresSucc = 0,
                xresFail = 1,
                xresNotImp = 2
        };
 
        /* XCMDBlock constants for event.what... */
        enum
        {
                xOpenEvt = 1000,          /* the first event after you are created */
                xCloseEvt = 1001,         /* your window is being forced close (Quit?) */
                xGiveUpEditEvt = 1002,    /* you are losing Edit... */
                xGiveUpSoundEvt = 1003,   /* you are losing the sound channel... */
                xHidePalettesEvt = 1004,  /* someone called HideHCPalettes */
                xShowPalettesEvt = 1005,  /* someone called ShowHCPalettes */
                xEditUndo = 1100,         /* Edit©©Undo */
                xEditCut = 1102,          /* Edit©©Cut */
                xEditCopy = 1103,         /* Edit©©Copy */
                xEditPaste = 1104,        /* Edit©©Paste */
                xEditClear = 1105,        /* Edit©©Clear */
                xSendEvt = 1200,          /* script has sent you a message (text) */
                xSetPropEvt = 1201,       /* set a window property */
                xGetPropEvt = 1202,       /* get a window property */
                xCursorWithin = 1300,     /* cursor is within the window */
                xMenuEvt = 1400,          /* user has selected an item in your menu */
                xMBarClickedEvt = 1401,   /* a menu is about to be shown--update if needed */
                xShowWatchInfoEvt = 1501, /* for variable and message watchers */
                xScriptErrorEvt = 1502,   /* place the insertion point */
                xDebugErrorEvt = 1503,    /* user clicked "Debug" at a complaint */
                xDebugStepEvt = 1504,     /* hilite the line */
                xDebugTraceEvt = 1505,    /* same as step but tracing */
                xDebugFinishedEvt = 1506  /* script ended */
        };
 
        enum
        {
                paletteProc = 2048,   /* Windoid with grow box */
                palNoGrowProc = 2052, /* standard Windoid defproc */
                palZoomProc = 2056,   /* Windoid with zoom and grow */
                palZoomNoGrow = 2060  /* Windoid with zoom and no grow */
        };
 
        enum
        {
                hasZoom = 8,
                hasTallTBar = 2,
                toggleHilite = 1
        };
 
        /* paramCount is set to these constants when first calling special XThings */
        enum
        {
                xMessageWatcherID = -2,
                xVariableWatcherID = -3,
                xScriptEditorID = -4,
                xDebuggerID = -5
        };
 
        /* XTalkObjectPtr->objectKind values */
        enum
        {
                stackObj = 1,
                bkgndObj = 2,
                cardObj = 3,
                fieldObj = 4,
                buttonObj = 5
        };
 
        /* selectors for ShowHCAlert's dialogs (shown as buttonID:buttonText) */
        enum
        {
                errorDlgID = 1,      /* 1:OK (default) */
                confirmDlgID = 2,    /* 1:OK (default) and 2:Cancel */
                confirmDelDlgID = 3, /* 1:Cancel (default) and 2:Delete */
                yesNoCancelDlgID = 4 /* 1:Yes (default), 2:Cancel, and 3:No */
        };
 
        /* type definitions */
        struct XCmdBlock
        {
                short paramCount; /* If = -1 then new use for XWindoids */
                Handle params[16];
                Handle returnValue;
                Boolean passFlag;
                SignedByte filler1;
                UniversalProcPtr entryPoint; /* to call back to HyperCard */
                short request;
                short result;
                long inArgs[8];
                long outArgs[4];
        };
        typedef struct XCmdBlock XCmdBlock;
        typedef XCmdBlock *XCmdPtr;
 
        struct XWEventInfo
        {
                EventRecord event;
                WindowRef eventWindow;
                long eventParams[9];
                Handle eventResult;
        };
        typedef struct XWEventInfo XWEventInfo;
        typedef XWEventInfo *XWEventInfoPtr;
        struct XTalkObject
        {
                short objectKind; /* stack, bkgnd, card, field, or button */
                long stackNum;    /* reference number of the source stack */
                long bkgndID;
                long cardID;
                long buttonID;
                long fieldID;
        };
        typedef struct XTalkObject XTalkObject;
        typedef XTalkObject *XTalkObjectPtr;
        /* maximum number of checkpoints in a script */
        enum
        {
                maxCachedChecks = 16
        };
 
        struct CheckPts
        {
                short checks[16];
        };
        typedef struct CheckPts CheckPts;
        typedef CheckPts *CheckPtPtr;
        typedef CheckPtPtr *CheckPtHandle;
#if CALL_NOT_IN_CARBON
        Handle
        EvalExpr(XCmdPtr paramPtr, ConstStr255Param expr);
 
        void
        SendCardMessage(XCmdPtr paramPtr, ConstStr255Param msg);
 
        void
        SendHCMessage(XCmdPtr paramPtr, ConstStr255Param msg);
 
        void
        RunHandler(XCmdPtr paramPtr, Handle handler);
 
        Handle
        GetGlobal(XCmdPtr paramPtr, ConstStr255Param globName);
 
        void
        SetGlobal(XCmdPtr paramPtr, ConstStr255Param globName, Handle globValue);
 
        void
        ZeroBytes(XCmdPtr paramPtr, void *dstPtr, long longCount);
 
        void
        ScanToReturn(XCmdPtr paramPtr, Ptr *scanPtr);
 
        void
        ScanToZero(XCmdPtr paramPtr, Ptr *scanPtr);
 
        Boolean
        StringEqual(XCmdPtr paramPtr, ConstStr255Param str1, ConstStr255Param str2);
 
        long
        StringLength(XCmdPtr paramPtr, void *strPtr);
 
        void *
        StringMatch(XCmdPtr paramPtr, ConstStr255Param pattern, void *target);
 
        void
        ZeroTermHandle(XCmdPtr paramPtr, Handle hndl);
 
        void
        BoolToStr(XCmdPtr paramPtr, Boolean value, Str255 str);
 
        void
        Double_tToStr(XCmdPtr paramPtr, double_t num, Str255 str);
 
        void
        LongToStr(XCmdPtr paramPtr, long posNum, Str255 str);
 
        void
        NumToHex(XCmdPtr paramPtr, long num, short nDigits, Str255 str);
 
        void
        NumToStr(XCmdPtr paramPtr, long num, Str255 str);
 
        Handle
        PasToZero(XCmdPtr paramPtr, ConstStr255Param str);
 
        void
        PointToStr(XCmdPtr paramPtr, Point pt, Str255 str);
 
        void
        RectToStr(XCmdPtr paramPtr, const Rect *rct, Str255 str);
 
        void
        ReturnToPas(XCmdPtr paramPtr, void *zeroStr, Str255 pasStr);
 
        Boolean
        StrToBool(XCmdPtr paramPtr, ConstStr255Param str);
 
        double_t
        StrToDouble_t(XCmdPtr paramPtr, ConstStr255Param str);
 
        long
        StrToLong(XCmdPtr paramPtr, ConstStr255Param str);
 
        long
        StrToNum(XCmdPtr paramPtr, ConstStr255Param str);
 
        void
        StrToPoint(XCmdPtr paramPtr, ConstStr255Param str, Point *pt);
 
        void
        StrToRect(XCmdPtr paramPtr, ConstStr255Param str, Rect *rct);
 
        void
        ZeroToPas(XCmdPtr paramPtr, void *zeroStr, Str255 pasStr);
 
        Handle
        GetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID);
 
        Handle
        GetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag,
                       ConstStr255Param fieldName);
 
        Handle
        GetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum);
 
        void
        SetFieldByID(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
                     Handle fieldVal);
 
        void
        SetFieldByName(XCmdPtr paramPtr, Boolean cardFieldFlag,
                       ConstStr255Param fieldName, Handle fieldVal);
 
        void
        SetFieldByNum(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldNum,
                      Handle fieldVal);
 
        TEHandle
        GetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
                   short fieldNum, ConstStr255Param fieldName);
 
        void
        SetFieldTE(XCmdPtr paramPtr, Boolean cardFieldFlag, short fieldID,
                   short fieldNum, ConstStr255Param fieldName, TEHandle fieldTE);
 
        void
        BeginXSound(XCmdPtr paramPtr, WindowRef window);
 
        void
        EndXSound(XCmdPtr paramPtr);
 
        Boolean
        GetFilePath(XCmdPtr paramPtr, ConstStr255Param fileName, short numTypes,
                    ConstSFTypeListPtr typeList, Boolean askUser, OSType *fileType,
                    Str255 fullName);
 
        void
        GetXResInfo(XCmdPtr paramPtr, short *resFile, short *resID, ResType *rType,
                    Str255 name);
 
        void
        Notify(XCmdPtr paramPtr);
 
        void
        SendHCEvent(XCmdPtr paramPtr, const EventRecord *event);
 
        void
        SendWindowMessage(XCmdPtr paramPtr, WindowRef windPtr,
                          ConstStr255Param windowName, ConstStr255Param msg);
 
        WindowRef
        FrontDocWindow(XCmdPtr paramPtr);
 
        long
        StackNameToNum(XCmdPtr paramPtr, ConstStr255Param stackName);
 
        short
        ShowHCAlert(XCmdPtr paramPtr, short dlgID, ConstStr255Param promptStr);
 
        Boolean
        AbortInQueue(XCmdPtr paramPtr);
 
        void
        FlushStackFile(XCmdPtr paramPtr);
 
        WindowRef
        NewXWindow(XCmdPtr paramPtr, const Rect *boundsRect, ConstStr255Param title,
                   Boolean visible, short procID, Boolean color, Boolean floating);
 
        WindowRef
        GetNewXWindow(XCmdPtr paramPtr, ResType templateType, short templateID,
                      Boolean color, Boolean floating);
 
        void
        CloseXWindow(XCmdPtr paramPtr, WindowRef window);
 
        void
        HideHCPalettes(XCmdPtr paramPtr);
 
        void
        ShowHCPalettes(XCmdPtr paramPtr);
 
        void
        RegisterXWMenu(XCmdPtr paramPtr, WindowRef window, MenuRef menu,
                       Boolean registering);
 
        void
        SetXWIdleTime(XCmdPtr paramPtr, WindowRef window, long interval);
 
        void
        XWHasInterruptCode(XCmdPtr paramPtr, WindowRef window, Boolean haveCode);
 
        void
        XWAlwaysMoveHigh(XCmdPtr paramPtr, WindowRef window, Boolean moveHigh);
 
        void
        XWAllowReEntrancy(XCmdPtr paramPtr, WindowRef window, Boolean allowSysEvts,
                          Boolean allowHCEvts);
 
        void
        BeginXWEdit(XCmdPtr paramPtr, WindowRef window);
 
        void
        EndXWEdit(XCmdPtr paramPtr, WindowRef window);
 
        WordBreakUPP
        HCWordBreakProc(XCmdPtr paramPtr);
 
        void
        PrintTEHandle(XCmdPtr paramPtr, TEHandle hTE, StringPtr header);
 
        CheckPtHandle
        GetCheckPoints(XCmdPtr paramPtr);
 
        void
        SetCheckPoints(XCmdPtr paramPtr, CheckPtHandle checkLines);
 
        void
        FormatScript(XCmdPtr paramPtr, Handle scriptHndl, long *insertionPoint,
                     Boolean quickFormat);
 
        void
        SaveXWScript(XCmdPtr paramPtr, Handle scriptHndl);
 
        void
        GetObjectName(XCmdPtr paramPtr, XTalkObjectPtr xObjPtr, Str255 objName);
 
        void
        GetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr xObjPtr, Handle *scriptHndl);
 
        void
        SetObjectScript(XCmdPtr paramPtr, XTalkObjectPtr xObjPtr, Handle scriptHndl);
 
        void
        AbortScript(XCmdPtr paramPtr);
 
        void
        GoScript(XCmdPtr paramPtr);
 
        void
        StepScript(XCmdPtr paramPtr, Boolean stepInto);
 
        void
        CountHandlers(XCmdPtr paramPtr, short *handlerCount);
 
        void
        GetHandlerInfo(XCmdPtr paramPtr, short handlerNum, Str255 handlerName,
                       Str255 objectName, short *varCount);
 
        void
        GetVarInfo(XCmdPtr paramPtr, short handlerNum, short varNum, Str255 varName,
                   Boolean *isGlobal, Str255 varValue, Handle varHndl);
 
        void
        SetVarValue(XCmdPtr paramPtr, short handlerNum, short varNum, Handle varHndl);
 
        Handle
        GetStackCrawl(XCmdPtr paramPtr);
 
        void
        TraceScript(XCmdPtr paramPtr, Boolean traceInto);
 
#endif /* CALL_NOT_IN_CARBON */
 
#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 /* __HYPERXCMD__ */