Processes.h

Go to the documentation of this file.

 
#ifndef __PROCESSES__
#define __PROCESSES__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __EVENTS__
#include <Events.h>
#endif
 
#ifndef __FILES__
#include <Files.h>
#endif
 
#ifndef __TEXTCOMMON__
#include <TextCommon.h>
#endif
 
#ifndef __CFSTRING__
#include <CFString.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
 
  /* type for unique process identifier */
  struct ProcessSerialNumber
  {
    unsigned long highLongOfPSN;
    unsigned long lowLongOfPSN;
  };
  typedef struct ProcessSerialNumber ProcessSerialNumber;
  typedef ProcessSerialNumber *ProcessSerialNumberPtr;
  enum
  {
    /* Process identifier - Various reserved process serial numbers */
    kNoProcess = 0,
    kSystemProcess = 1,
    kCurrentProcess = 2
  };
 
  /* Definition of the parameter block passed to _Launch */
  /* Typedef and flags for launchControlFlags field*/
  typedef unsigned short LaunchFlags;
  enum
  {
    launchContinue = 0x4000,
    launchNoFileFlags = 0x0800,
    launchUseMinimum = 0x0400,
    launchDontSwitch = 0x0200,
    launchAllow24Bit = 0x0100,
    launchInhibitDaemon = 0x0080
  };
 
  /* Format for first AppleEvent to pass to new process.  The size of the overall
    buffer variable: the message body immediately follows the messageLength */
  struct AppParameters
  {
    EventRecord theMsgEvent;
    unsigned long eventRefCon;
    unsigned long messageLength;
  };
  typedef struct AppParameters AppParameters;
  typedef AppParameters *AppParametersPtr;
  /* Parameter block to _Launch */
  struct LaunchParamBlockRec
  {
    unsigned long reserved1;
    unsigned short reserved2;
    unsigned short launchBlockID;
    unsigned long launchEPBLength;
    unsigned short launchFileFlags;
    LaunchFlags launchControlFlags;
    FSSpecPtr launchAppSpec;
    ProcessSerialNumber launchProcessSN;
    unsigned long launchPreferredSize;
    unsigned long launchMinimumSize;
    unsigned long launchAvailableSize;
    AppParametersPtr launchAppParameters;
  };
  typedef struct LaunchParamBlockRec LaunchParamBlockRec;
  typedef LaunchParamBlockRec *LaunchPBPtr;
  /* Set launchBlockID to extendedBlock to specify that extensions exist.
   Set launchEPBLength to extendedBlockLen for compatibility.*/
  enum
  {
    extendedBlock = 0x4C43, /* 'LC' */
    extendedBlockLen = sizeof(LaunchParamBlockRec) - 12
  };
 
  enum
  {
    /* Definition of the information block returned by GetProcessInformation */
    modeReserved = 0x01000000,
    modeControlPanel = 0x00080000,
    modeLaunchDontSwitch = 0x00040000,
    modeDeskAccessory = 0x00020000,
    modeMultiLaunch = 0x00010000,
    modeNeedSuspendResume = 0x00004000,
    modeCanBackground = 0x00001000,
    modeDoesActivateOnFGSwitch = 0x00000800,
    modeOnlyBackground = 0x00000400,
    modeGetFrontClicks = 0x00000200,
    modeGetAppDiedMsg = 0x00000100,
    mode32BitCompatible = 0x00000080,
    modeHighLevelEventAware = 0x00000040,
    modeLocalAndRemoteHLEvents = 0x00000020,
    modeStationeryAware = 0x00000010,
    modeUseTextEditServices = 0x00000008,
    modeDisplayManagerAware = 0x00000004
  };
 
  struct ProcessInfoRec
  {
    unsigned long processInfoLength;
    StringPtr processName;
    ProcessSerialNumber processNumber;
    unsigned long processType;
    OSType processSignature;
    unsigned long processMode;
    Ptr processLocation;
    unsigned long processSize;
    unsigned long processFreeMem;
    ProcessSerialNumber processLauncher;
    unsigned long processLaunchDate;
    unsigned long processActiveTime;
    FSSpecPtr processAppSpec;
  };
  typedef struct ProcessInfoRec ProcessInfoRec;
  typedef ProcessInfoRec *ProcessInfoRecPtr;
  struct ProcessInfoExtendedRec
  {
    unsigned long processInfoLength;
    StringPtr processName;
    ProcessSerialNumber processNumber;
    unsigned long processType;
    OSType processSignature;
    unsigned long processMode;
    Ptr processLocation;
    unsigned long processSize;
    unsigned long processFreeMem;
    ProcessSerialNumber processLauncher;
    unsigned long processLaunchDate;
    unsigned long processActiveTime;
    FSSpecPtr processAppSpec;
    unsigned long processTempMemTotal;
    unsigned long processPurgeableTempMemTotal;
  };
  typedef struct ProcessInfoExtendedRec ProcessInfoExtendedRec;
  typedef ProcessInfoExtendedRec *ProcessInfoExtendedRecPtr;
  /* Record corresponding to the SIZE resource definition */
  struct SizeResourceRec
  {
    unsigned short flags;
    unsigned long preferredHeapSize;
    unsigned long minimumHeapSize;
  };
  typedef struct SizeResourceRec SizeResourceRec;
  typedef SizeResourceRec *SizeResourceRecPtr;
  typedef SizeResourceRecPtr *SizeResourceRecHandle;
  enum
  {
    kQuitBeforeNormalTimeMask = 1,
    kQuitAtNormalTimeMask = 2,
    kQuitBeforeFBAsQuitMask = 4,
    kQuitBeforeShellQuitsMask = 8,
    kQuitBeforeTerminatorAppQuitsMask = 16,
    kQuitNeverMask = 32,
    kQuitOptionsMask = 0x7F,
    kQuitNotQuitDuringInstallMask = 0x0100,
    kQuitNotQuitDuringLogoutMask = 0x0200
  };
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter __D0 LaunchApplication(__A0)
#endif
  OSErr
  LaunchApplication(LaunchPBPtr LaunchParams);
 
#if CALL_NOT_IN_CARBON
  OSErr
  LaunchDeskAccessory(const FSSpec *pFileSpec, ConstStr255Param pDAName);
 
#endif /* CALL_NOT_IN_CARBON */
 
#if TARGET_OS_MAC
#define MacGetCurrentProcess GetCurrentProcess
#endif
  OSErr
  MacGetCurrentProcess(ProcessSerialNumber *PSN);
 
  OSErr
  GetFrontProcess(ProcessSerialNumber *PSN);
 
  OSErr
  GetNextProcess(ProcessSerialNumber *PSN);
 
  OSErr
  GetProcessInformation(const ProcessSerialNumber *PSN, ProcessInfoRec *info);
 
  OSErr
  SetFrontProcess(const ProcessSerialNumber *PSN);
 
  OSErr
  WakeUpProcess(const ProcessSerialNumber *PSN);
 
  OSErr
  SameProcess(const ProcessSerialNumber *PSN1, const ProcessSerialNumber *PSN2,
              Boolean *result);
 
  /*  ExitToShell was previously in SegLoad.h*/
  void
  ExitToShell(void);
 
#if CALL_NOT_IN_CARBON
  OSErr
  LaunchControlPanel(const FSSpec *pFileSpec);
 
#endif /* CALL_NOT_IN_CARBON */
 
  TextEncoding
  GetApplicationTextEncoding(void);
 
  ScriptCode
  GetApplicationScript(void);
 
  OSStatus
  GetProcessBundleLocation(const ProcessSerialNumber *psn, FSRef *location);
 
  OSStatus
  CopyProcessName(const ProcessSerialNumber *psn, CFStringRef *name);
 
  /*************************************************************************
   *  Process Visibility.
   *************************************************************************/
  Boolean
  IsProcessVisible(const ProcessSerialNumber *psn);
 
  OSErr
  ShowHideProcess(const ProcessSerialNumber *psn, Boolean visible);
 
  /* Values of the 'message' parameter to a Control Panel 'cdev' */
  enum
  {
    initDev = 0,    /*Time for cdev to initialize itself*/
    hitDev = 1,     /*Hit on one of my items*/
    closeDev = 2,   /*Close yourself*/
    nulDev = 3,     /*Null event*/
    updateDev = 4,  /*Update event*/
    activDev = 5,   /*Activate event*/
    deactivDev = 6, /*Deactivate event*/
    keyEvtDev = 7,  /*Key down/auto key*/
    macDev = 8,     /*Decide whether or not to show up*/
    undoDev = 9,
    cutDev = 10,
    copyDev = 11,
    pasteDev = 12,
    clearDev = 13,
    cursorDev = 14
  };
 
  /* Special values a Control Panel 'cdev' can return */
  enum
  {
    cdevGenErr = -1, /*General error; gray cdev w/o alert*/
    cdevMemErr = 0,  /*Memory shortfall; alert user please*/
    cdevResErr = 1,  /*Couldn't get a needed resource; alert*/
    cdevUnset = 3    /* cdevValue is initialized to this*/
  };
 
  /* Control Panel Default Proc */
  typedef CALLBACK_API(long, ControlPanelDefProcPtr)(
      short message, short item, short numItems, short cPanelID,
      EventRecord *theEvent, long cdevValue, DialogPtr cpDialog);
  typedef STACK_UPP_TYPE(ControlPanelDefProcPtr) ControlPanelDefUPP;
#if CALL_NOT_IN_CARBON
  ControlPanelDefUPP
  NewControlPanelDefUPP(ControlPanelDefProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppControlPanelDefProcInfo = 0x000FEAB0
  }; /* pascal 4_bytes Func(2_bytes, 2_bytes, 2_bytes, 2_bytes, 4_bytes, 4_bytes,
        4_bytes) */
#ifdef __cplusplus
  inline ControlPanelDefUPP
  NewControlPanelDefUPP(ControlPanelDefProcPtr userRoutine)
  {
    return (ControlPanelDefUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                    uppControlPanelDefProcInfo,
                                                    GetCurrentArchitecture());
  }
#else
#define NewControlPanelDefUPP(userRoutine)                                     \
  (ControlPanelDefUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppControlPanelDefProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  void
  DisposeControlPanelDefUPP(ControlPanelDefUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeControlPanelDefUPP(ControlPanelDefUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeControlPanelDefUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  long
  InvokeControlPanelDefUPP(short message, short item, short numItems,
                           short cPanelID, EventRecord *theEvent, long cdevValue,
                           DialogPtr cpDialog, ControlPanelDefUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline long InvokeControlPanelDefUPP(short message, short item, short numItems,
                                       short cPanelID, EventRecord *theEvent,
                                       long cdevValue, DialogPtr cpDialog,
                                       ControlPanelDefUPP userUPP)
  {
    return (long)CALL_SEVEN_PARAMETER_UPP(userUPP, uppControlPanelDefProcInfo,
                                          message, item, numItems, cPanelID,
                                          theEvent, cdevValue, cpDialog);
  }
#else
#define InvokeControlPanelDefUPP(message, item, numItems, cPanelID, theEvent, \
                                 cdevValue, cpDialog, userUPP)                \
  (long)CALL_SEVEN_PARAMETER_UPP((userUPP), uppControlPanelDefProcInfo,       \
                                 (message), (item), (numItems), (cPanelID),   \
                                 (theEvent), (cdevValue), (cpDialog))
#endif
#endif
 
#endif /* CALL_NOT_IN_CARBON */
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
/* support for pre-Carbon UPP routines: New...Proc and Call...Proc */
#define NewControlPanelDefProc(userRoutine) NewControlPanelDefUPP(userRoutine)
#define CallControlPanelDefProc(userRoutine, message, item, numItems,    \
                                cPanelID, theEvent, cdevValue, cpDialog) \
  InvokeControlPanelDefUPP(message, item, numItems, cPanelID, theEvent,  \
                           cdevValue, cpDialog, userRoutine)
#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 /* __PROCESSES__ */
* /*/*/ */*/