home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Source Code / C / Frameworks / Extension Shell 1.5 / Extension Shell 1.5 (Source) / InstallCode.c < prev    next >
Encoding:
Text File  |  1996-04-12  |  12.5 KB  |  555 lines  |  [TEXT/R*ch]
  1. /*    NAME:
  2.         InstallCode.c
  3.  
  4.     WRITTEN BY:
  5.         Dair Grant
  6.                 
  7.     DESCRIPTION:
  8.         Routines for installing various code resources.
  9.         
  10.     ___________________________________________________________________________
  11. */
  12. //=============================================================================
  13. //        Include files
  14. //-----------------------------------------------------------------------------
  15. #include <Memory.h>
  16. #include <Gestalt.h>
  17. #include <Errors.h>
  18. #include <Resources.h>
  19. #include <Shutdown.h>
  20. #include <Timer.h>
  21. #include "ES.h"
  22. #include "ES Address Table.h"
  23. #include "InstallCode.h"
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39. //=============================================================================
  40. //        Private function prototypes
  41. //-----------------------------------------------------------------------------
  42. OSErr    InstallTrapPatch(short i, Ptr theCode);
  43. OSErr    InstallGestaltSelector(short i, Ptr theCode);
  44. OSErr    InstallShutdownTask(short i, Ptr theCode);
  45. OSErr    InstallVBLTask(short i, Ptr theCode);
  46. OSErr    InstallLowMemFilter(short i, Ptr theCode);
  47. OSErr    InstallCodeBlock(short i, Ptr theCode);
  48. OSErr    InstallTimeManagerTask(short i, Ptr theCode);
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64. //=============================================================================
  65. //        Global variables
  66. //-----------------------------------------------------------------------------
  67. extern ESParamBlock            gTheParamBlock;
  68. extern ESAddressTable        *gTheESAddressTable;
  69.  
  70.  
  71.  
  72.  
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84. //=============================================================================
  85. //        InstallCode : Install a code resource depending on its type.                                                                 
  86. //-----------------------------------------------------------------------------
  87. //        Note :    We get the index of something in gTheParamBlock.theCodeResources
  88. //                and case out on its type to do the installation. If any error
  89. //                occurs, we return the error code - our caller fills in the
  90. //                details in gTheParamBlock.
  91. //-----------------------------------------------------------------------------
  92. OSErr InstallCode(short i)
  93. {    Handle        theHnd;
  94.     OSErr        theErr;
  95.     Ptr            theCode;
  96.     
  97.     
  98.  
  99.  
  100.     // Get the code resource we're after, and return if it wasn't there.
  101.     theHnd = Get1Resource(gTheParamBlock.theCodeResources[i].resType,
  102.                           gTheParamBlock.theCodeResources[i].resID);
  103.     if (theHnd == nil)
  104.         return(resNotFound);
  105.  
  106.  
  107.     
  108.     // Unlock the resource, compact the heap, then lock it down. We then
  109.     // detach it so it stays around after Extension Shell is gone.
  110.     HUnlock(theHnd);
  111.     ResrvMem(GetHandleSize(theHnd));
  112.     HLock(theHnd);
  113.     DetachResource(theHnd);
  114.  
  115.  
  116.  
  117.     // Get a clean address from the handle
  118.     theCode = (Ptr) StripAddress(*theHnd);
  119.  
  120.  
  121.  
  122.     // Now case out on the type of the code, and call the install routine
  123.     switch(gTheParamBlock.theCodeResources[i].codeType) {
  124.         case kTrapPatchType:
  125.              theErr = InstallTrapPatch(i, theCode);
  126.              break;
  127.              
  128.         case kGestaltSelectorType:
  129.              theErr = InstallGestaltSelector(i, theCode);
  130.              break;
  131.              
  132.         case kShutdownTaskType:
  133.              theErr = InstallShutdownTask(i, theCode);
  134.              break;
  135.              
  136.         case kVBLTaskType:
  137.              theErr = InstallVBLTask(i, theCode);
  138.              break;
  139.         
  140.         case kLowMemFilterType:
  141.              theErr = InstallLowMemFilter(i, theCode);
  142.              break;
  143.         
  144.         case kCodeBlockType:
  145.              theErr = InstallCodeBlock(i, theCode);
  146.              break;
  147.         
  148.         case kTimeManagerTaskType:
  149.              theErr = InstallTimeManagerTask(i, theCode);
  150.              break;
  151.         
  152.         default:
  153.              theErr = noErr;
  154.     }
  155.  
  156.     
  157.     // Return any errors that occurred    
  158.     return(theErr);
  159. } 
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175. //=============================================================================
  176. //        InstallESAddressTable : Install an address table.
  177. //-----------------------------------------------------------------------------
  178. //        Note :    We install the Gestalt selector, call Gestalt to obtain the
  179. //                address of the address table, and leave the result in
  180. //                gTheESAddressTable.
  181. //
  182. //                Because the address table is so fundamental, any failure
  183. //                to load, install, or call it drops us into MacsBug.
  184. //
  185. //                We also initialse the magicNumber and versionNumber fields.
  186. //-----------------------------------------------------------------------------
  187. void InstallESAddressTable(void)
  188. {    Handle            theHnd;
  189.     OSErr            theErr;
  190.     ProcPtr            theCode;    
  191.  
  192.  
  193.  
  194.     // Load the AddressTable Gestalt selector, and install it with NewGestalt.
  195.     theHnd = GetResource(kAddrsTableCodeType, kAddrsTableCodeID);
  196.     if (theHnd == nil)
  197.         DebugStr("\pExtension Shell - couldn't find Address Table resource");
  198.     
  199.     
  200.     // We have it, so lock it in place
  201.     HUnlock(theHnd);
  202.     ResrvMem(GetHandleSize(theHnd));
  203.     HLock(theHnd);
  204.     DetachResource(theHnd);
  205.     
  206.     
  207.     // Get a clean address from the handle
  208.     theCode = (ProcPtr) StripAddress(*theHnd);
  209.     
  210.     
  211.     // Install the address table as a Gestalt selector
  212.     theErr = NewGestalt(gTheParamBlock.addressTableSelector,
  213.                                 NewSelectorFunctionProc(theCode));
  214.     if (theErr != noErr)
  215.         DebugStr("\pExtension Shell - couldn't install AddressTable");
  216.         
  217.  
  218.     // Call Gestalt to get the address of the address table and initialise
  219.     // the magicNumber and versionNumber fields.
  220.     theErr = Gestalt(gTheParamBlock.addressTableSelector, (long *) &gTheESAddressTable);
  221.     if (theErr != noErr)
  222.         DebugStr("\pExtension Shell - couldn't call AddressTable");
  223.     else
  224.         {
  225.         gTheESAddressTable->magicNumber   = 0xDEADBEEF;
  226.         gTheESAddressTable->versionNumber = 0xFEEDFACE;
  227.         }
  228. }
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244. //=============================================================================
  245. //        InstallTrapPatch : Install a trap patch.                                                         
  246. //-----------------------------------------------------------------------------
  247. //        Note :    Given a trap word and a pointer to the new routine, we save
  248. //                the original entry in the dispatch table and insert the new
  249. //                one.
  250. //
  251. //                We assume that the trap *is* implemented. If globalPatch is
  252. //                true, the patch is applied to all applications (this is the
  253. //                default behaviour). If globalPatch is false, the patch only
  254. //                takes affect in the application appName. (THIS FEATURE IS
  255. //                NOT IMPLEMENTED YET)
  256. //-----------------------------------------------------------------------------
  257. OSErr InstallTrapPatch(short i, Ptr theCode)
  258. {    short        trapWord;
  259.     TrapType    trapType;
  260.     ProcPtr        oldCodeAddress;
  261.     
  262.     
  263.     
  264.     // Find out what we need to know
  265.      trapWord = gTheParamBlock.theCodeResources[i].theCodeThing.theTrapPatch.trapWord;
  266.     trapType = (trapWord & 0x0800) ? ToolTrap : OSTrap;
  267.  
  268.  
  269.     // Replace the old value in the dispatch table with the new value.
  270.     oldCodeAddress = (ProcPtr) StripAddress((Ptr) NGetTrapAddress(trapWord, trapType));
  271.     NSetTrapAddress((UniversalProcPtr) theCode, trapWord, trapType);
  272.     
  273.     
  274.     
  275.     // Handle globalPatch and appName
  276.     //
  277.     // THIS FEATURE IS NOT IMPLEMENTED YET - IT WOULD NEED SOME KIND OF
  278.     // GENERIC EXTENSION SHELL PATCH TO SOMETHING LIKE _INITALLPACKS OR
  279.     // _INITGRAF, AND THEN THE APPLICATION OF PATCHES DEPENDING ON
  280.     // THE APPLICATION BEING EXECUTED.
  281.     //
  282.     //
  283.     
  284.     
  285.     
  286.     // Fill in the entry in the address table and save the address of the new code.
  287.     gTheESAddressTable->theTable[i]                    = oldCodeAddress;
  288.     gTheParamBlock.theCodeResources[i].theAddress    = theCode;
  289.  
  290.  
  291.     // Return any errors
  292.     return(noErr);
  293. }
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309. //=============================================================================
  310. //        InstallGestaltSelector : Install a Gestalt Selector.                                                         
  311. //-----------------------------------------------------------------------------
  312. OSErr InstallGestaltSelector(short i, Ptr theCode)
  313. {    OSErr                    theErr;
  314.     SelectorFunctionUPP        theUPP;
  315.     AGestaltSelector        *theGestaltInfo;
  316.  
  317.  
  318.  
  319.  
  320.     // Find out what we need to know
  321.     theGestaltInfo = &gTheParamBlock.theCodeResources[i].theCodeThing.theGestaltSelector;
  322.     theUPP = NewSelectorFunctionProc(theCode);
  323.     
  324.  
  325.     
  326.     // Try and install the routine
  327.     theErr = NewGestalt(theGestaltInfo->theSelector, theUPP);
  328.  
  329.     
  330.     
  331.     // If the selector exists, replace it if we're allowed to, and save
  332.     // the address of the old routine in the address table
  333.     if (theErr == gestaltDupSelectorErr && theGestaltInfo->overwriteExistingSelector)
  334.         theErr = ReplaceGestalt(theGestaltInfo->theSelector, theUPP,
  335.                                 (SelectorFunctionUPP *) &gTheESAddressTable->theTable[i]);
  336.     
  337.     
  338.     
  339.     // If there wasn't a problem, save the address of the new code. The address
  340.     // table is only used if we need to get access to the old Gestalt routine.
  341.     if (theErr == noErr)
  342.         gTheParamBlock.theCodeResources[i].theAddress = theCode;
  343.         
  344.         
  345.     
  346.     // Return any errors
  347.     return(theErr);
  348. }
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364. //=============================================================================
  365. //        InstallShutdownTask : Install a Shutdown Task.                                                         
  366. //-----------------------------------------------------------------------------
  367. OSErr InstallShutdownTask(short i, Ptr theCode)
  368. {
  369.  
  370.  
  371.     // Install the task with its flags and save the address in gTheParamBlock.
  372.     // We don't use the address table at all.
  373.     ShutDwnInstall(NewShutDwnProc(theCode),
  374.                    gTheParamBlock.theCodeResources[i].theCodeThing.theShutdownTask.theFlags);
  375.     gTheParamBlock.theCodeResources[i].theAddress = theCode;
  376.  
  377.  
  378.     // Return any errors
  379.     return(noErr);
  380. }
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396. //=============================================================================
  397. //        InstallVBLTask : Install a VBL task.                                                         
  398. //-----------------------------------------------------------------------------
  399. OSErr InstallVBLTask(short i, Ptr theCode)
  400. {    VBLTask         *theVblPtr;
  401.     OSErr            theErr;
  402.     
  403.     
  404.     
  405.     
  406.     // Allocate a little block of memory in the System Heap for the task information
  407.     theVblPtr = (VBLTask*) NewPtrSys(sizeof(VBLTask));
  408.     
  409.     
  410.     
  411.     // Fill in the fields, and install it as a VBL task
  412.     theVblPtr->qType    = vType;
  413.     theVblPtr->vblAddr  = NewVBLProc(theCode);
  414.     theVblPtr->vblCount = gTheParamBlock.theCodeResources[i].theCodeThing.theVBLTask.vblCount;
  415.     theVblPtr->vblPhase = gTheParamBlock.theCodeResources[i].theCodeThing.theVBLTask.vblPhase;
  416.     theErr = VInstall((QElemPtr) theVblPtr);
  417.     
  418.     
  419.     
  420.     // Save the address of the VBLTask structure in the address table and the param block
  421.     if (theErr == noErr)
  422.         {
  423.         gTheESAddressTable->theTable[i]                    = (ProcPtr) theVblPtr;
  424.         gTheParamBlock.theCodeResources[i].theAddress    = (Ptr) theVblPtr;
  425.         }
  426.     
  427.     
  428.     // Return any errors
  429.     return(theErr);
  430. }
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446. //=============================================================================
  447. //        InstallLowMemFilter : Install a low-memory filter.                                                         
  448. //-----------------------------------------------------------------------------
  449. OSErr InstallLowMemFilter(short i, Ptr theCode)
  450. {    ProcPtr        theEntryPoint;
  451.     
  452.  
  453.  
  454.     
  455.     // Get the address of the filter chain.
  456.     theEntryPoint = (ProcPtr) gTheParamBlock.theCodeResources[i].theCodeThing.theLowMemFilter.theEntryPoint;
  457.     
  458.     
  459.     
  460.     // Save the address currently at the front of the chain in the address table
  461.     // and save ourselves in the param block.
  462.     gTheESAddressTable->theTable[i]                    = (ProcPtr) *((void **) theEntryPoint);
  463.     gTheParamBlock.theCodeResources[i].theAddress    = theCode;
  464.     
  465.     
  466.     // Insert ourselves into the front of the chain
  467.     *((long *) theEntryPoint) = (long) theCode;
  468.  
  469.  
  470.     // Return any errors
  471.     return(noErr);
  472. }
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488. //=============================================================================
  489. //        InstallCodeBlock : Install a block of code.                                                         
  490. //-----------------------------------------------------------------------------
  491. OSErr InstallCodeBlock(short i, Ptr theCode)
  492. {    
  493.     
  494.     
  495.     // Set the reserved field to some value
  496.     gTheParamBlock.theCodeResources[i].theCodeThing.theCodeBlock.refCon = 0xDEADBEEF;
  497.  
  498.     
  499.     // Save the address of the code block in the address table and the param block
  500.     gTheESAddressTable->theTable[i]                    = (ProcPtr) theCode;
  501.     gTheParamBlock.theCodeResources[i].theAddress    = theCode;
  502.  
  503.  
  504.     // Return any errors
  505.     return(noErr);
  506. }
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522. //=============================================================================
  523. //        InstallTimeManagerTask : Install a Time Manager task.                                                         
  524. //-----------------------------------------------------------------------------
  525. OSErr InstallTimeManagerTask(short i, Ptr theCode)
  526. {    TMTask             *theTaskPtr;
  527.  
  528.  
  529.  
  530.  
  531.     // Allocate a little block of memory in the System Heap for the task information
  532.     theTaskPtr = (TMTask*) NewPtrSys(sizeof(TMTask));
  533.     
  534.     
  535.     
  536.     // Fill in the fields, and install it as an Time Manager task. We don't install
  537.     // it as with InsXTime because we probably won't need that accurate timing.
  538.     theTaskPtr->tmAddr    = (TimerUPP) theCode;
  539.     theTaskPtr->tmCount    = 0;
  540.     InsTime((QElemPtr) theTaskPtr);
  541.     PrimeTime((QElemPtr) theTaskPtr,
  542.                 gTheParamBlock.theCodeResources[i].theCodeThing.theTimeManagerTask.theDelay);
  543.     
  544.     
  545.     
  546.     // Save the address of the TMTask structure in the address table and the param block
  547.     gTheESAddressTable->theTable[i]                    = (ProcPtr) theTaskPtr;
  548.     gTheParamBlock.theCodeResources[i].theAddress    = (Ptr) theTaskPtr;
  549.     
  550.     
  551.     
  552.     // Return any errors
  553.     return(noErr);
  554. }
  555.