MixedMode.h
上传用户:xjjlds
上传日期:2015-12-05
资源大小:22823k
文件大小:32k
源码类别:

多媒体编程

开发平台:

Visual C++

  1. /*
  2.      File:       MixedMode.h
  3.  
  4.      Contains:   Mixed Mode Manager Interfaces.
  5.  
  6.      Version:    Technology: Mac OS 8
  7.                  Release:    QuickTime 6.0.2
  8.  
  9.      Copyright:  (c) 1992-2001 by Apple Computer, Inc., all rights reserved.
  10.  
  11.      Bugs?:      For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __MIXEDMODE__
  18. #define __MIXEDMODE__
  19. #ifndef __MACTYPES__
  20. #include "MacTypes.h"
  21. #endif
  22. #if PRAGMA_ONCE
  23. #pragma once
  24. #endif
  25. #ifdef __cplusplus
  26. extern "C" {
  27. #endif
  28. #if PRAGMA_IMPORT
  29. #pragma import on
  30. #endif
  31. #if PRAGMA_STRUCT_ALIGN
  32.     #pragma options align=mac68k
  33. #elif PRAGMA_STRUCT_PACKPUSH
  34.     #pragma pack(push, 2)
  35. #elif PRAGMA_STRUCT_PACK
  36.     #pragma pack(2)
  37. #endif
  38. /* Mixed Mode constants */
  39. /* Current Routine Descriptor Version */
  40. enum {
  41.     kRoutineDescriptorVersion   = 7
  42. };
  43. /* MixedModeMagic Magic Cookie/Trap number */
  44. enum {
  45.     _MixedModeMagic             = 0xAAFE
  46. };
  47. /* MixedModeState Version for CFM68K Mixed Mode */
  48. enum {
  49.     kCurrentMixedModeStateRecord = 1
  50. };
  51. /* Calling Conventions */
  52. typedef unsigned short                  CallingConventionType;
  53. enum {
  54.     kPascalStackBased           = 0,
  55.     kCStackBased                = 1,
  56.     kRegisterBased              = 2,
  57.     kD0DispatchedPascalStackBased = 8,
  58.     kD1DispatchedPascalStackBased = 12,
  59.     kD0DispatchedCStackBased    = 9,
  60.     kStackDispatchedPascalStackBased = 14,
  61.     kThinkCStackBased           = 5
  62. };
  63. /* ISA Types */
  64. typedef SInt8                           ISAType;
  65. enum {
  66.     kM68kISA                    = 0,
  67.     kPowerPCISA                 = 1
  68. };
  69. /* RTA Types */
  70. typedef SInt8                           RTAType;
  71. enum {
  72.     kOld68kRTA                  = 0 << 4,
  73.     kPowerPCRTA                 = 0 << 4,
  74.     kCFM68kRTA                  = 1 << 4
  75. };
  76. #if TARGET_CPU_PPC
  77.     #define     GetCurrentISA()     ((ISAType) kPowerPCISA)
  78.     #define     GetCurrentRTA()     ((RTAType) kPowerPCRTA)
  79. #elif TARGET_CPU_68K
  80.    #define     GetCurrentISA()     ((ISAType) kM68kISA)
  81.    #if TARGET_RT_MAC_CFM
  82.       #define GetCurrentRTA()     ((RTAType) kCFM68kRTA)
  83.  #else
  84.       #define GetCurrentRTA()     ((RTAType) kOld68kRTA)
  85.  #endif
  86. #endif
  87. #define      GetCurrentArchitecture()    (GetCurrentISA() | GetCurrentRTA())
  88. /* Constants for specifing 68k registers */
  89. enum {
  90.     kRegisterD0                 = 0,
  91.     kRegisterD1                 = 1,
  92.     kRegisterD2                 = 2,
  93.     kRegisterD3                 = 3,
  94.     kRegisterD4                 = 8,
  95.     kRegisterD5                 = 9,
  96.     kRegisterD6                 = 10,
  97.     kRegisterD7                 = 11,
  98.     kRegisterA0                 = 4,
  99.     kRegisterA1                 = 5,
  100.     kRegisterA2                 = 6,
  101.     kRegisterA3                 = 7,
  102.     kRegisterA4                 = 12,
  103.     kRegisterA5                 = 13,
  104.     kRegisterA6                 = 14,                           /* A7 is the same as the PowerPC SP */
  105.     kCCRegisterCBit             = 16,
  106.     kCCRegisterVBit             = 17,
  107.     kCCRegisterZBit             = 18,
  108.     kCCRegisterNBit             = 19,
  109.     kCCRegisterXBit             = 20
  110. };
  111. typedef unsigned short                  registerSelectorType;
  112. /* SizeCodes we use everywhere */
  113. enum {
  114.     kNoByteCode                 = 0,
  115.     kOneByteCode                = 1,
  116.     kTwoByteCode                = 2,
  117.     kFourByteCode               = 3
  118. };
  119. /* Mixed Mode Routine Records */
  120. typedef unsigned long                   ProcInfoType;
  121. /* Routine Flag Bits */
  122. typedef unsigned short                  RoutineFlagsType;
  123. enum {
  124.     kProcDescriptorIsAbsolute   = 0x00,
  125.     kProcDescriptorIsRelative   = 0x01
  126. };
  127. enum {
  128.     kFragmentIsPrepared         = 0x00,
  129.     kFragmentNeedsPreparing     = 0x02
  130. };
  131. enum {
  132.     kUseCurrentISA              = 0x00,
  133.     kUseNativeISA               = 0x04
  134. };
  135. enum {
  136.     kPassSelector               = 0x00,
  137.     kDontPassSelector           = 0x08
  138. };
  139. enum {
  140.     kRoutineIsNotDispatchedDefaultRoutine = 0x00,
  141.     kRoutineIsDispatchedDefaultRoutine = 0x10
  142. };
  143. enum {
  144.     kProcDescriptorIsProcPtr    = 0x00,
  145.     kProcDescriptorIsIndex      = 0x20
  146. };
  147. struct RoutineRecord {
  148.     ProcInfoType                    procInfo;                   /* calling conventions */
  149.     SInt8                           reserved1;                  /* Must be 0 */
  150.     ISAType                         ISA;                        /* Instruction Set Architecture */
  151.     RoutineFlagsType                routineFlags;               /* Flags for each routine */
  152.     ProcPtr                         procDescriptor;             /* Where is the thing we're calling? */
  153.     UInt32                          reserved2;                  /* Must be 0 */
  154.     UInt32                          selector;                   /* For dispatched routines, the selector */
  155. };
  156. typedef struct RoutineRecord            RoutineRecord;
  157. typedef RoutineRecord *                 RoutineRecordPtr;
  158. typedef RoutineRecordPtr *              RoutineRecordHandle;
  159. /* Mixed Mode Routine Descriptors */
  160. /* Definitions of the Routine Descriptor Flag Bits */
  161. typedef UInt8                           RDFlagsType;
  162. enum {
  163.     kSelectorsAreNotIndexable   = 0x00,
  164.     kSelectorsAreIndexable      = 0x01
  165. };
  166. /* Routine Descriptor Structure */
  167. struct RoutineDescriptor {
  168.     UInt16                          goMixedModeTrap;            /* Our A-Trap */
  169.     SInt8                           version;                    /* Current Routine Descriptor version */
  170.     RDFlagsType                     routineDescriptorFlags;     /* Routine Descriptor Flags */
  171.     UInt32                          reserved1;                  /* Unused, must be zero */
  172.     UInt8                           reserved2;                  /* Unused, must be zero */
  173.     UInt8                           selectorInfo;               /* If a dispatched routine, calling convention, else 0 */
  174.     UInt16                          routineCount;               /* Number of routines in this RD */
  175.     RoutineRecord                   routineRecords[1];          /* The individual routines */
  176. };
  177. typedef struct RoutineDescriptor        RoutineDescriptor;
  178. typedef RoutineDescriptor *             RoutineDescriptorPtr;
  179. typedef RoutineDescriptorPtr *          RoutineDescriptorHandle;
  180. /* 68K MixedModeStateRecord */
  181. struct MixedModeStateRecord {
  182.     UInt32                          state1;
  183.     UInt32                          state2;
  184.     UInt32                          state3;
  185.     UInt32                          state4;
  186. };
  187. typedef struct MixedModeStateRecord     MixedModeStateRecord;
  188. #if CALL_NOT_IN_CARBON
  189. /* Macros for building static Routine Descriptors (not available in Carbon) */
  190. /* A macro which creates a static instance of a non-dispatched routine descriptor */
  191. #define BUILD_ROUTINE_DESCRIPTOR(procInfo, procedure)                               
  192.     {                                                                               
  193.         _MixedModeMagic,                            /* Mixed Mode A-Trap */         
  194.         kRoutineDescriptorVersion,                  /* version */                   
  195.         kSelectorsAreNotIndexable,                  /* RD Flags - not dispatched */ 
  196.         0,                                          /* reserved 1 */                
  197.         0,                                          /* reserved 2 */                
  198.         0,                                          /* selector info */             
  199.         0,                                          /* number of routines */        
  200.         {                                           /* It誷 an array */             
  201.             {                                       /* It誷 a struct */             
  202.                 (procInfo),                         /* the ProcInfo */              
  203.                 0,                                  /* reserved */                  
  204.                 GetCurrentArchitecture(),           /* ISA and RTA */               
  205.                 kProcDescriptorIsAbsolute |         /* Flags - it誷 absolute addr */
  206.                 kFragmentIsPrepared |               /* It誷 prepared */             
  207.                 kUseNativeISA,                      /* Always use native ISA */     
  208.                 (ProcPtr)(procedure),               /* the procedure */             
  209.                 0,                                  /* reserved */                  
  210.                 0                                   /* Not dispatched */            
  211.             }                                                                       
  212.         }                                                                           
  213.     }
  214. /* a macro which creates a static instance of a fat routine descriptor */
  215. #define BUILD_FAT_ROUTINE_DESCRIPTOR(m68kProcInfo, m68kProcPtr, powerPCProcInfo, powerPCProcPtr)  
  216.     {                                                                               
  217.         _MixedModeMagic,                            /* Mixed Mode A-Trap */         
  218.         kRoutineDescriptorVersion,                  /* version */                   
  219.         kSelectorsAreNotIndexable,                  /* RD Flags - not dispatched */ 
  220.         0,                                          /* reserved */                  
  221.         0,                                          /* reserved */                  
  222.         0,                                          /* reserved */                  
  223.         1,                                          /* Array count */               
  224.         {                                           /* It誷 an array */             
  225.             {                                       /* It誷 a struct */             
  226.                 (m68kProcInfo),                     /* the ProcInfo */              
  227.                 0,                                  /* reserved */                  
  228.                 kM68kISA |                          /* ISA */                       
  229.                 kOld68kRTA,                         /* RTA */                       
  230.                 kProcDescriptorIsAbsolute |         /* Flags - it誷 absolute addr */
  231.                 kUseCurrentISA,                     /* Use current ISA */           
  232.                 (ProcPtr)(m68kProcPtr),             /* the procedure */             
  233.                 0,                                  /* reserved */                  
  234.                 0,                                  /* reserved */                  
  235.             },                                                                      
  236.             {                                       /* It誷 a struct */             
  237.                 (powerPCProcInfo),                  /* the ProcInfo */              
  238.                 0,                                  /* reserved */                  
  239.                 GetCurrentArchitecture(),           /* ISA and RTA */               
  240.                 kProcDescriptorIsAbsolute |         /* Flags - it誷 absolute addr */
  241.                 kFragmentIsPrepared |               /* It誷 prepared */             
  242.                 kUseCurrentISA,                     /* Always use current ISA */    
  243.                 (ProcPtr)(powerPCProcPtr),          /* the procedure */             
  244.                 0,                                  /* reserved */                  
  245.                 0                                   /* reserved */                  
  246.             }                                                                       
  247.         }                                                                           
  248.     }
  249. #endif /* CALL_NOT_IN_CARBON */
  250. /* Mixed Mode ProcInfos */
  251. enum {
  252.                                                                 /* Calling Convention Offsets */
  253.     kCallingConventionWidth     = 4,
  254.     kCallingConventionPhase     = 0,
  255.     kCallingConventionMask      = 0x0F,                         /* Result Offsets */
  256.     kResultSizeWidth            = 2,
  257.     kResultSizePhase            = kCallingConventionWidth,
  258.     kResultSizeMask             = 0x30,                         /* Parameter offsets & widths */
  259.     kStackParameterWidth        = 2,
  260.     kStackParameterPhase        = (kCallingConventionWidth + kResultSizeWidth),
  261.     kStackParameterMask         = (long)0xFFFFFFC0,             /* Register Result Location offsets & widths */
  262.     kRegisterResultLocationWidth = 5,
  263.     kRegisterResultLocationPhase = (kCallingConventionWidth + kResultSizeWidth), /* Register Parameter offsets & widths */
  264.     kRegisterParameterWidth     = 5,
  265.     kRegisterParameterPhase     = (kCallingConventionWidth + kResultSizeWidth + kRegisterResultLocationWidth),
  266.     kRegisterParameterMask      = 0x7FFFF800,
  267.     kRegisterParameterSizePhase = 0,
  268.     kRegisterParameterSizeWidth = 2,
  269.     kRegisterParameterWhichPhase = kRegisterParameterSizeWidth,
  270.     kRegisterParameterWhichWidth = 3,                           /* Dispatched Stack Routine Selector offsets & widths */
  271.     kDispatchedSelectorSizeWidth = 2,
  272.     kDispatchedSelectorSizePhase = (kCallingConventionWidth + kResultSizeWidth), /* Dispatched Stack Routine Parameter offsets */
  273.     kDispatchedParameterPhase   = (kCallingConventionWidth + kResultSizeWidth + kDispatchedSelectorSizeWidth), /* Special Case offsets & widths */
  274.     kSpecialCaseSelectorWidth   = 6,
  275.     kSpecialCaseSelectorPhase   = kCallingConventionWidth,
  276.     kSpecialCaseSelectorMask    = 0x03F0
  277. };
  278. enum {
  279.     kSpecialCase                = 0x000F                        /* (CallingConventionType) */
  280. };
  281. enum {
  282.                                                                 /* all of the special cases enumerated.  The selector field is 6 bits wide */
  283.     kSpecialCaseHighHook        = 0,
  284.     kSpecialCaseCaretHook       = 0,                            /* same as kSpecialCaseHighHook */
  285.     kSpecialCaseEOLHook         = 1,
  286.     kSpecialCaseWidthHook       = 2,
  287.     kSpecialCaseTextWidthHook   = 2,                            /* same as kSpecialCaseWidthHook */
  288.     kSpecialCaseNWidthHook      = 3,
  289.     kSpecialCaseDrawHook        = 4,
  290.     kSpecialCaseHitTestHook     = 5,
  291.     kSpecialCaseTEFindWord      = 6,
  292.     kSpecialCaseProtocolHandler = 7,
  293.     kSpecialCaseSocketListener  = 8,
  294.     kSpecialCaseTERecalc        = 9,
  295.     kSpecialCaseTEDoText        = 10,
  296.     kSpecialCaseGNEFilterProc   = 11,
  297.     kSpecialCaseMBarHook        = 12
  298. };
  299. /*
  300.     NOTES ON USING ROUTINE DESCRIPTOR FUNCTIONS
  301.     
  302.     When calling these routine from classic 68k code there are two possible intentions.
  303.     The first is source compatibility with code ported to CFM (either PowerPC or 68k CFM). When
  304.     the code is compiled for CFM the functions create routine descriptors that can be used by
  305.     the mixed mode manager operating on that machine. When the code is compiled for classic 68k
  306.     these functions do nothing so that the code will run on Macintoshes that do not have a
  307.     mixed mode manager. The dual nature of these functions is achieved by turning the CFM calls
  308.     into "no-op" macros for classic 68k: You can put "NewRoutineDescriptor" in your source,
  309.     compile it for any runtime or instruction set architecture, and it will run correctly on the
  310.     intended runtime/instruction platform. All without source changes and/or conditional source.
  311.     
  312.     The other intention is for code that "knows" that it is executing as classic 68k runtime
  313.     and is specifically trying to call code of another architecture using mixed mode. Since the
  314.     routines were designed with classic <-> CFM source compatibility in mind this second case
  315.     is treated special. For classic 68k code to create routines descriptors for use by mixed mode
  316.     it must call the "Trap" versions of the routines (NewRoutineDescriptorTrap). These versions
  317.     are only available to classic 68k callers: rigging the interfaces to allow calling them
  318.     from CFM code will result in runtime failure because no shared library implements or exports
  319.     the functions.
  320.     
  321.     This almost appears seamless until you consider "fat" routine descriptors and the advent of
  322.     CFM-68K. What does "fat" mean? CFM-68K is not emulated on PowerPC and PowerPC is not emulated
  323.     on CFM-68K. It makes no sense to create a routine descriptor having both a CFM-68K routine
  324.     and a PowerPC native routine pointer. Therefore "fat" is defined to be a mix of classic and
  325.     CFM for the hardware's native instruction set: on PowerPC fat is classic and PowerPC native,
  326.     on a 68k machine with CFM-68K installed fat is classic and CFM-68K.
  327.     
  328.     By definition fat routine descriptors are only constructed by code that is aware of the 
  329.     architecture it is executing as and that another architecture exists. Source compatibility
  330.     between code intented as pure classic and pure CFM is not an issue and so NewFatRoutineDescriptor
  331.     is not available when building pure classic code.
  332.     
  333.     NewFatRoutineDescriptorTrap is available to classic code on both PowerPC and CFM-68K. The
  334.     classic code can use the code fragment manager routine "FindSymbol" to obtain the address of 
  335.     a routine in a shared library and then construct a routine descriptor with both the CFM routine 
  336.     and classic routine.
  337. */
  338. #if TARGET_OS_MAC && TARGET_RT_MAC_CFM
  339. #if CALL_NOT_IN_CARBON
  340. EXTERN_API( UniversalProcPtr )
  341. NewRoutineDescriptor            (ProcPtr                theProc,
  342.                                  ProcInfoType           theProcInfo,
  343.                                  ISAType                theISA);
  344. EXTERN_API( void )
  345. DisposeRoutineDescriptor        (UniversalProcPtr       theProcPtr);
  346. EXTERN_API( UniversalProcPtr )
  347. NewFatRoutineDescriptor         (ProcPtr                theM68kProc,
  348.                                  ProcPtr                thePowerPCProc,
  349.                                  ProcInfoType           theProcInfo);
  350. #endif  /* CALL_NOT_IN_CARBON */
  351. #else
  352. #define DisposeRoutineDescriptor(theProcPtr)
  353. #define NewRoutineDescriptor(theProc, theProcInfo, theISA) ((UniversalProcPtr)theProc)
  354. /* Note that the call to NewFatRoutineDescriptor is undefined. */
  355. #endif  /* TARGET_OS_MAC && TARGET_RT_MAC_CFM */
  356. #if TARGET_CPU_68K && !TARGET_RT_MAC_CFM
  357. /*
  358.     The "Trap" versions of the MixedMode calls are only for classic 68K clients that 
  359.     want to load and use CFM based code.
  360. */
  361. #if CALL_NOT_IN_CARBON
  362. EXTERN_API( UniversalProcPtr )
  363. NewRoutineDescriptorTrap        (ProcPtr                theProc,
  364.                                  ProcInfoType           theProcInfo,
  365.                                  ISAType                theISA)                             TWOWORDINLINE(0x7000, 0xAA59);
  366. EXTERN_API( void )
  367. DisposeRoutineDescriptorTrap    (UniversalProcPtr       theProcPtr)                         TWOWORDINLINE(0x7001, 0xAA59);
  368. EXTERN_API( UniversalProcPtr )
  369. NewFatRoutineDescriptorTrap     (ProcPtr                theM68kProc,
  370.                                  ProcPtr                thePowerPCProc,
  371.                                  ProcInfoType           theProcInfo)                        TWOWORDINLINE(0x7002, 0xAA59);
  372. #endif  /* CALL_NOT_IN_CARBON */
  373. #endif  /* TARGET_CPU_68K && !TARGET_RT_MAC_CFM */
  374. #if !TARGET_CPU_68K || TARGET_RT_MAC_CFM
  375. /*
  376.     CallUniversalProc is defined for all targets except classic 68k code.  This will 
  377.     catch accidental calls from classic 68K code that previously only showed up as 
  378.     linker errors.
  379. */
  380. #if CALL_NOT_IN_CARBON
  381. EXTERN_API_C( long )
  382. CallUniversalProc               (UniversalProcPtr       theProcPtr,
  383.                                  ProcInfoType           procInfo,
  384.                                  ...);
  385. EXTERN_API_C( long )
  386. CallOSTrapUniversalProc         (UniversalProcPtr       theProcPtr,
  387.                                  ProcInfoType           procInfo,
  388.                                  ...);
  389. #endif  /* CALL_NOT_IN_CARBON */
  390. #endif  /* !TARGET_CPU_68K || TARGET_RT_MAC_CFM */
  391. #if TARGET_CPU_68K
  392. #if CALL_NOT_IN_CARBON
  393. EXTERN_API( OSErr )
  394. SaveMixedModeState              (MixedModeStateRecord * stateStorage,
  395.                                  UInt32                 stateVersion)                       TWOWORDINLINE(0x7003, 0xAA59);
  396. EXTERN_API( OSErr )
  397. RestoreMixedModeState           (MixedModeStateRecord * stateStorage,
  398.                                  UInt32                 stateVersion)                       TWOWORDINLINE(0x7004, 0xAA59);
  399. #endif  /* CALL_NOT_IN_CARBON */
  400. #endif  /* TARGET_CPU_68K */
  401. /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * 
  402.  *
  403.  *  Macros for building ProcInfos.  Examples:
  404.  *  
  405.  *  
  406.  *  uppModalFilterProcInfo = kPascalStackBased
  407.  *       | RESULT_SIZE(SIZE_CODE(sizeof(Boolean)))
  408.  *       | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(DialogPtr)))
  409.  *       | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(EventRecord*)))
  410.  *       | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(short*))),
  411.  *
  412.  *  uppDeskHookProcInfo = kRegisterBased
  413.  *       | REGISTER_ROUTINE_PARAMETER(1, kRegisterD0, SIZE_CODE(sizeof(Boolean)))
  414.  *       | REGISTER_ROUTINE_PARAMETER(2, kRegisterA0, SIZE_CODE(sizeof(EventRecord*)))
  415.  *
  416.  *  uppGXSpoolResourceProcInfo = kCStackBased
  417.  *       | RESULT_SIZE(SIZE_CODE(sizeof(OSErr)))
  418.  *       | STACK_ROUTINE_PARAMETER(1, SIZE_CODE(sizeof(gxSpoolFile)))
  419.  *       | STACK_ROUTINE_PARAMETER(2, SIZE_CODE(sizeof(Handle)))
  420.  *       | STACK_ROUTINE_PARAMETER(3, SIZE_CODE(sizeof(ResType)))
  421.  *       | STACK_ROUTINE_PARAMETER(4, SIZE_CODE(sizeof(long)))
  422.  *
  423.  *  uppTEFindWordProcInfo = SPECIAL_CASE_PROCINFO( 6 ),
  424.  *
  425.  */
  426. /* * * * * * * * * * * * * * 
  427.  *   SIZE_CODE -     Return the size code for an object, given its size in bytes.
  428.  *     size - size of an object in bytes
  429.  */
  430. #define SIZE_CODE(size) 
  431.     (((size) == 4) ? kFourByteCode : (((size) == 2) ? kTwoByteCode : (((size) == 1) ? kOneByteCode : 0)))
  432. /* * * * * * * * * * * * * * 
  433.  *   RESULT_SIZE -   Return the result field of a ProcInfo, given the return object誷 size.
  434.  *                   This is the same for all ProcInfos
  435.  *       sizeCode - size code
  436.  */
  437. #define RESULT_SIZE(sizeCode) 
  438.    ((ProcInfoType)(sizeCode) << kResultSizePhase)
  439. /* * * * * * * * * * * * * * 
  440.  *   STACK_ROUTINE_PARAMETER -   Return a parameter field of a ProcInfo, for a simple,
  441.  *                                non-dispatched, stack based routine.
  442.  *     whichParam - which parameter
  443.  *     sizeCode - size code
  444.  */
  445. #define STACK_ROUTINE_PARAMETER(whichParam, sizeCode) 
  446.    ((ProcInfoType)(sizeCode) << (kStackParameterPhase + (((whichParam) - 1) * kStackParameterWidth)))
  447. /* * * * * * * * * * * * * * 
  448.  *   DISPATCHED_STACK_ROUTINE_PARAMETER -    Return a parameter field of a ProcInfo, for 
  449.  *                                         a dispatched, stack based routine.  The same
  450.  *                                         macro is used regardless of the type of
  451.  *                                          dispatching.
  452.  *     whichParam - which parameter
  453.  *     sizeCode - size code
  454.  */
  455. #define DISPATCHED_STACK_ROUTINE_PARAMETER(whichParam, sizeCode) 
  456.     ((ProcInfoType)(sizeCode) << (kDispatchedParameterPhase + (((whichParam) - 1) * kStackParameterWidth)))
  457. /* * * * * * * * * * * * * * 
  458.  *   DISPATCHED_STACK_ROUTINE_SELECTOR_SIZE -    Return a the selector size field of a ProcInfo
  459.  *                                               for a dispatched, stack based routine.  The
  460.  *                                              same macro is used regardless of the type of
  461.  *                                             dispatching.
  462.  *     sizeCode - size code 
  463.  */
  464. #define DISPATCHED_STACK_ROUTINE_SELECTOR_SIZE(sizeCode) 
  465.    ((ProcInfoType)(sizeCode) << kDispatchedSelectorSizePhase)
  466. /* * * * * * * * * * * * * * 
  467.  *   REGISTER_RESULT_LOCATION -      Return the Result Location field of a ProcInfo, 
  468.  *                                 given the location.
  469.  *      whichReg - which register
  470.  */
  471. #define REGISTER_RESULT_LOCATION(whichReg) 
  472.  ((ProcInfoType)(whichReg) << kRegisterResultLocationPhase)
  473. /* * * * * * * * * * * * * * 
  474.  *   REGISTER_ROUTINE_PARAMETER -    Return a parameter field of a ProcInfo for a 
  475.  *                                    register based routine.
  476.  */
  477. #define REGISTER_ROUTINE_PARAMETER(whichParam, whichReg, sizeCode) 
  478.    ((((ProcInfoType)(sizeCode) << kRegisterParameterSizePhase) | ((ProcInfoType)(whichReg) << kRegisterParameterWhichPhase)) << 
  479.          (kRegisterParameterPhase + (((whichParam) - 1) * kRegisterParameterWidth)))
  480. /* * * * * * * * * * * * * * 
  481.  *
  482.  *    SPECIAL_CASE_PROCINFO -     Returns the procInfo constant for the following special cases:
  483.  *   
  484.  *     High Hook & Caret Hook -  (see I-379)
  485.  *            C calling conventions, Rect on stack, pointer in A3, no return value
  486.  *     EOL Hook - (see VI-15-26)
  487.  *            Register-based; inputs in D0, A3, A4; 
  488.  *           output is Z flag of status register
  489.  *      Width Hook - (see VI-15-27)
  490.  *          Register-based; inputs in D0, D1, A0, A3, A4; output in D1 
  491.  *      NWidth Hook - (see VI-15-27)
  492.  *         Register-based; inputs in D0, D1, D2, A0, A2, A3, A4; output in D1 
  493.  *      TextWidthHook - (see VI-15-28)
  494.  *           Register-based; inputs in D0, D1, A0, A3, A4; output in D1 
  495.  *      DrawHook - (see VI-15-28)
  496.  *            Register-based; inputs in D0, D1, A0, A3, A4; no output
  497.  *      HitTestHook - (See VI-15-29)
  498.  *         Register-based; inputs in D0, D1, D2, A0, A3, A4; outputs in D0, D1, D2
  499.  *      FindWord -  (see VI-15-30)
  500.  *           Register-based; inputs in D0, D2, A3, A4; outputs in D0, D1
  501.  *      ADBRoutines - (see V-371)
  502.  *            Register-based; inputs in A0, A1, A2, D0; no outputs
  503.  *     ProtocolHandler - (see II-326)
  504.  *           Register-based; inputs in A0, A1, A2, A3, A4, D1.w; output in Z 
  505.  *     SocketListener - (see II-329)
  506.  *            Register-based; inputs in A0, A1, A2, A3, A4, D0.b, D1.w; output in Z 
  507.  *       Reclac - (see I-391)
  508.  *         Register-based; inputs in A3, D7; outputs in D2, D3, D4
  509.  *      DoText - (see I-391)
  510.  *         Register-based; inputs in A3, D3, D4, D7; outputs in A0, D0
  511.  *      GNEFilterProc - (see tech note 85)
  512.  *           Register & Stack Based; inputs in A1, D0 & on the stack; outputs on the stack
  513.  *        MenuBarHook - (see I-356)
  514.  *            Register & Stack Based; input on the stack; output in D0
  515. */
  516. #define SPECIAL_CASE_PROCINFO(specialCaseCode)          
  517.       (kSpecialCase | ((ProcInfoType)(specialCaseCode) << 4))
  518. /* * * * * * * * * * * * * * * 
  519.  * STACK_UPP_TYPE    - used in typedefs to create 臮PP type
  520.  * REGISTER_UPP_TYPE - used in typedefs to create 臮PP type
  521.  * TVECTOR_UPP_TYPE  - used in typedefs to create 臮PP type
  522.  *
  523.  *  Example:
  524.  *
  525.  *      typedef STACK_UPP_TYPE(ModalFilterProcPtr)      ModalFilterUPP;
  526.  *      typedef REGISTER_UPP_TYPE(IOCompletionProcPtr)  IOCompletionUPP;
  527.  *
  528.  */
  529. #if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
  530.   /* classic 68k runtime */
  531.   #define STACK_UPP_TYPE(name)    name
  532.    #define REGISTER_UPP_TYPE(name) Register68kProcPtr
  533.  #define TVECTOR_UPP_TYPE(name)  name
  534. #elif TARGET_OS_MAC && TARGET_RT_MAC_CFM
  535.   /* PowerPC and CFM68K runtime */
  536.    #if OPAQUE_UPP_TYPES
  537.        #define STACK_UPP_TYPE(name)    struct Opaque##name##*
  538.      #define REGISTER_UPP_TYPE(name) struct Opaque##name##*
  539.      #define TVECTOR_UPP_TYPE(name)  struct Opaque##name##*
  540.  #else
  541.       #define STACK_UPP_TYPE(name)    UniversalProcPtr
  542.        #define REGISTER_UPP_TYPE(name) UniversalProcPtr
  543.        #define TVECTOR_UPP_TYPE(name)  name
  544.    #endif
  545. #elif TARGET_OS_MAC && TARGET_RT_MAC_MACHO
  546.   /* Mac OS X runtime */
  547.  #define STACK_UPP_TYPE(name)    name
  548.    #define REGISTER_UPP_TYPE(name) name
  549.    #define TVECTOR_UPP_TYPE(name)  name
  550. #else
  551.  /* other runtimes */
  552.    #define STACK_UPP_TYPE(name)    name
  553.    #define REGISTER_UPP_TYPE(name) name
  554.    #define TVECTOR_UPP_TYPE(name)  name
  555. #endif
  556. /* * * * * * * * * * * * * * * 
  557.  * CALL_臺PARAMETER_UPP  - used in Call臥roc macros
  558.  *
  559.  *  Example:
  560.  *
  561.  *      #define CallIOCompletionProc(userRoutine, paramBlock)   
  562.  *                CALL_TWO_PARAMETER_UPP((userRoutine), uppIOCompletionProcInfo, (paramBlock))
  563.  *
  564.  */
  565. #if TARGET_OS_MAC && TARGET_RT_MAC_CFM
  566.     #define CALL_ZERO_PARAMETER_UPP(    upp, procInfo)      CallUniversalProc(upp, procInfo)
  567.     #define CALL_ONE_PARAMETER_UPP(     upp, procInfo, p1)      CallUniversalProc(upp, procInfo, (p1))
  568.     #define CALL_TWO_PARAMETER_UPP(     upp, procInfo, p1, p2)      CallUniversalProc(upp, procInfo, (p1), (p2))
  569.     #define CALL_THREE_PARAMETER_UPP(   upp, procInfo, p1, p2, p3)      CallUniversalProc(upp, procInfo, (p1), (p2), (p3))
  570.     #define CALL_FOUR_PARAMETER_UPP(    upp, procInfo, p1, p2, p3, p4)      CallUniversalProc(upp, procInfo, (p1), (p2), (p3), (p4))
  571.     #define CALL_FIVE_PARAMETER_UPP(    upp, procInfo, p1, p2, p3, p4, p5)      CallUniversalProc(upp, procInfo, (p1), (p2), (p3), (p4), (p5))
  572.     #define CALL_SIX_PARAMETER_UPP(     upp, procInfo, p1, p2, p3, p4, p5, p6)      CallUniversalProc(upp, procInfo, (p1), (p2), (p3), (p4), (p5), (p6))
  573.     #define CALL_SEVEN_PARAMETER_UPP(   upp, procInfo, p1, p2, p3, p4, p5, p6, p7)      CallUniversalProc(upp, procInfo, (p1), (p2), (p3), (p4), (p5), (p6), (p7))
  574.     #define CALL_EIGHT_PARAMETER_UPP(   upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8)      CallUniversalProc(upp, procInfo, (p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8))
  575.     #define CALL_NINE_PARAMETER_UPP(    upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8, p9)      CallUniversalProc(upp, procInfo, (p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9))
  576.     #define CALL_TEN_PARAMETER_UPP(     upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10)     CallUniversalProc(upp, procInfo, (p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9), (p10))
  577.     #define CALL_ELEVEN_PARAMETER_UPP(  upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11)    CallUniversalProc(upp, procInfo, (p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9), (p10), (p11))
  578.     #define CALL_TWELVE_PARAMETER_UPP(  upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12)   CallUniversalProc(upp, procInfo, (p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9), (p10), (p11), (p12))
  579.     #define CALL_THIRTEEN_PARAMETER_UPP(upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12, p13)  CallUniversalProc(upp, procInfo, (p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9), (p10), (p11), (p12), (p13))
  580. #else
  581.     #define CALL_ZERO_PARAMETER_UPP(    upp, procInfo)      (*(upp))()
  582.     #define CALL_ONE_PARAMETER_UPP(     upp, procInfo, p1)      (*(upp))((p1))
  583.     #define CALL_TWO_PARAMETER_UPP(     upp, procInfo, p1, p2)      (*(upp))((p1), (p2))
  584.     #define CALL_THREE_PARAMETER_UPP(   upp, procInfo, p1, p2, p3)      (*(upp))((p1), (p2), (p3))
  585.     #define CALL_FOUR_PARAMETER_UPP(    upp, procInfo, p1, p2, p3, p4)      (*(upp))((p1), (p2), (p3), (p4))
  586.     #define CALL_FIVE_PARAMETER_UPP(    upp, procInfo, p1, p2, p3, p4, p5)      (*(upp))((p1), (p2), (p3), (p4), (p5))
  587.     #define CALL_SIX_PARAMETER_UPP(     upp, procInfo, p1, p2, p3, p4, p5, p6)      (*(upp))((p1), (p2), (p3), (p4), (p5), (p6))
  588.     #define CALL_SEVEN_PARAMETER_UPP(   upp, procInfo, p1, p2, p3, p4, p5, p6, p7)      (*(upp))((p1), (p2), (p3), (p4), (p5), (p6), (p7))
  589.     #define CALL_EIGHT_PARAMETER_UPP(   upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8)      (*(upp))((p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8))
  590.     #define CALL_NINE_PARAMETER_UPP(    upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8, p9)      (*(upp))((p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9))
  591.     #define CALL_TEN_PARAMETER_UPP(     upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10)     (*(upp))((p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9), (p10))
  592.     #define CALL_ELEVEN_PARAMETER_UPP(  upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11)    (*(upp))((p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9), (p10), (p11))
  593.     #define CALL_TWELVE_PARAMETER_UPP(  upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12)   (*(upp))((p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9), (p10), (p11), (p12))
  594.     #define CALL_THIRTEEN_PARAMETER_UPP(upp, procInfo, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10, p11, p12, p13)  (*(upp))((p1), (p2), (p3), (p4), (p5), (p6), (p7), (p8), (p9), (p10), (p11), (p12), (p13))
  595. #endif
  596. #if PRAGMA_STRUCT_ALIGN
  597.     #pragma options align=reset
  598. #elif PRAGMA_STRUCT_PACKPUSH
  599.     #pragma pack(pop)
  600. #elif PRAGMA_STRUCT_PACK
  601.     #pragma pack()
  602. #endif
  603. #ifdef PRAGMA_IMPORT_OFF
  604. #pragma import off
  605. #elif PRAGMA_IMPORT
  606. #pragma import reset
  607. #endif
  608. #ifdef __cplusplus
  609. }
  610. #endif
  611. #endif /* __MIXEDMODE__ */