OSUtils.h

Go to the documentation of this file.

 
#ifndef __OSUTILS__
#define __OSUTILS__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __MIXEDMODE__
#include <MixedMode.h>
#endif
 
/*  HandToHand and other memory utilties were moved to MacMemory.h */
#ifndef __MACMEMORY__
#include <MacMemory.h>
#endif
 
/*  GetTrapAddress and other trap table utilties were moved to Patches.h */
#ifndef __PATCHES__
#include <Patches.h>
#endif
 
/*  Date and Time utilties were moved to DateTimeUtils.h */
#ifndef __DATETIMEUTILS__
#include <DateTimeUtils.h>
#endif
 
#ifndef __CFSTRING__
#include <CFString.h>
#endif
 
#if !TARGET_OS_MAC
#ifndef __ENDIAN__
#include <Endian.h>
#endif
 
#endif /* !TARGET_OS_MAC */
 
#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
 
  enum
  {
    useFree = 0,
    useATalk = 1,
    useAsync = 2,
    useExtClk = 3, /*Externally clocked*/
    useMIDI = 4
  };
 
  enum
  {
    false32b = 0, /*24 bit addressing error*/
    true32b = 1   /*32 bit addressing error*/
  };
 
  enum
  {
    /* result types for RelString Call */
    sortsBefore = -1, /*first string < second string*/
    sortsEqual = 0,   /*first string = second string*/
    sortsAfter = 1    /*first string > second string*/
  };
 
  enum
  {
    dummyType = 0,
    vType = 1,
    ioQType = 2,
    drvQType = 3,
    evType = 4,
    fsQType = 5,
    sIQType = 6,
    dtQType = 7,
    nmType = 8
  };
 
  typedef SignedByte QTypes;
  struct SysParmType
  {
    UInt8 valid;
    UInt8 aTalkA;
    UInt8 aTalkB;
    UInt8 config;
    short portA;
    short portB;
    long alarm;
    short font;
    short kbdPrint;
    short volClik;
    short misc;
  };
  typedef struct SysParmType SysParmType;
  typedef SysParmType *SysPPtr;
  struct QElem
  {
    struct QElem *qLink;
    short qType;
    short qData[1];
  };
  typedef struct QElem QElem;
  typedef QElem *QElemPtr;
#if TARGET_OS_MAC
  struct QHdr
  {
    volatile short qFlags;
    volatile QElemPtr qHead;
    volatile QElemPtr qTail;
  };
  typedef struct QHdr QHdr;
  typedef QHdr *QHdrPtr;
#else
struct QHdr
{
  volatile short qFlags;
  short pad;
  long MutexID;
  volatile QElemPtr qHead;
  volatile QElemPtr qTail;
};
typedef struct QHdr QHdr;
typedef QHdr *QHdrPtr;
#endif /* TARGET_OS_MAC */
 
  typedef CALLBACK_API_REGISTER68K(void, DeferredTaskProcPtr, (long dtParam));
  typedef REGISTER_UPP_TYPE(DeferredTaskProcPtr) DeferredTaskUPP;
  DeferredTaskUPP
  NewDeferredTaskUPP(DeferredTaskProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppDeferredTaskProcInfo = 0x0000B802
  }; /* register no_return_value Func(4_bytes:A1) */
#ifdef __cplusplus
  inline DeferredTaskUPP NewDeferredTaskUPP(DeferredTaskProcPtr userRoutine)
  {
    return (DeferredTaskUPP)NewRoutineDescriptor((ProcPtr)(userRoutine),
                                                 uppDeferredTaskProcInfo,
                                                 GetCurrentArchitecture());
  }
#else
#define NewDeferredTaskUPP(userRoutine)                                     \
  (DeferredTaskUPP)                                                         \
      NewRoutineDescriptor((ProcPtr)(userRoutine), uppDeferredTaskProcInfo, \
                           GetCurrentArchitecture())
#endif
#endif
 
  void
  DisposeDeferredTaskUPP(DeferredTaskUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeDeferredTaskUPP(DeferredTaskUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeDeferredTaskUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter InvokeDeferredTaskUPP(__A1, __A0)
#endif
  void
  InvokeDeferredTaskUPP(long dtParam, DeferredTaskUPP userUPP);
#if !OPAQUE_UPP_TYPES && \
    (!TARGET_OS_MAC || !TARGET_CPU_68K || TARGET_RT_MAC_CFM)
#ifdef __cplusplus
  inline void InvokeDeferredTaskUPP(long dtParam, DeferredTaskUPP userUPP)
  {
    CALL_ONE_PARAMETER_UPP(userUPP, uppDeferredTaskProcInfo, dtParam);
  }
#else
#define InvokeDeferredTaskUPP(dtParam, userUPP) \
  CALL_ONE_PARAMETER_UPP((userUPP), uppDeferredTaskProcInfo, (dtParam))
#endif
#endif
 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
/* support for pre-Carbon UPP routines: New...Proc and Call...Proc */
#define NewDeferredTaskProc(userRoutine) NewDeferredTaskUPP(userRoutine)
#define CallDeferredTaskProc(userRoutine, dtParam) \
  InvokeDeferredTaskUPP(dtParam, userRoutine)
#endif /* CALL_NOT_IN_CARBON */
 
  struct DeferredTask
  {
    volatile QElemPtr qLink;
    short qType;
    volatile short dtFlags;
    DeferredTaskUPP dtAddr;
    long dtParam;
    long dtReserved;
  };
  typedef struct DeferredTask DeferredTask;
  typedef DeferredTask *DeferredTaskPtr;
#if TARGET_OS_MAC
  struct MachineLocation
  {
    Fract latitude;
    Fract longitude;
    union
    {
      SInt8 dlsDelta; /* signed byte; daylight savings delta */
      long gmtDelta;  /* use low 24-bits only */
    } u;
  };
  typedef struct MachineLocation MachineLocation;
#else
struct MachineLocation
{
  Fract latitude;
  Fract longitude;
  BigEndianLong
      delta; /* high byte is daylight savings delta, low 24-bits is GMT delta */
};
typedef struct MachineLocation MachineLocation;
#endif /* TARGET_OS_MAC */
 
  Boolean
  IsMetric(void);
 
  SysPPtr
  GetSysPPtr(void);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter __D0 DTInstall(__A0)
#endif
  OSErr
  DTInstall(DeferredTaskPtr dtTaskPtr);
 
#if TARGET_CPU_PPC || !TARGET_OS_MAC
#define GetMMUMode() ((SInt8)true32b)
#define SwapMMUMode(x) (*(SInt8 *)(x) = true32b)
#else
#if CALL_NOT_IN_CARBON
 
SInt8 GetMMUMode(void);
 
#endif /* CALL_NOT_IN_CARBON */
 
#if CALL_NOT_IN_CARBON
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter SwapMMUMode(__A0)
#endif
void SwapMMUMode(SInt8 *mode);
 
#endif /* CALL_NOT_IN_CARBON */
 
#endif
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter Delay(__A0, __A1)
#endif
  void
  Delay(unsigned long numTicks, unsigned long *finalTicks);
 
  OSErr
  WriteParam(void);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter Enqueue(__A0, __A1)
#endif
  void
  Enqueue(QElemPtr qElement, QHdrPtr qHeader);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter __D0 Dequeue(__A0, __A1)
#endif
  OSErr
  Dequeue(QElemPtr qElement, QHdrPtr qHeader);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter __D0 SetCurrentA5
#endif
  long
  SetCurrentA5(void);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter __D0 SetA5(__D0)
#endif
  long
  SetA5(long newA5);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter __D0 InitUtil
#endif
  OSErr
  InitUtil(void);
 
#if !TARGET_CPU_68K
  void
  MakeDataExecutable(void *baseAddress, unsigned long length);
 
#endif /* !TARGET_CPU_68K */
 
#if TARGET_CPU_68K
#if CALL_NOT_IN_CARBON
 
  Boolean
  SwapInstructionCache(Boolean cacheEnable);
 
  Boolean
  SwapDataCache(Boolean cacheEnable);
 
#endif /* CALL_NOT_IN_CARBON */
 
#if CALL_NOT_IN_CARBON
 
  void
  FlushInstructionCache(void);
 
  void
  FlushDataCache(void);
 
  void
  FlushCodeCache(void);
 
#endif /* CALL_NOT_IN_CARBON */
 
#endif /* TARGET_CPU_68K */
 
#if CALL_NOT_IN_CARBON
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter __D0 FlushCodeCacheRange(__A0, __A1)
#endif
  OSErr
  FlushCodeCacheRange(void *address, unsigned long count);
 
#endif /* CALL_NOT_IN_CARBON */
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter ReadLocation(__A0)
#endif
  void
  ReadLocation(MachineLocation *loc);
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter WriteLocation(__A0)
#endif
  void
  WriteLocation(const MachineLocation *loc);
 
  UInt32
  TickCount(void);
 
  CFStringRef
  CSCopyUserName(Boolean useShortName);
 
  CFStringRef
  CSCopyMachineName(void);
 
#if OLDROUTINENAMES
#define IUMetric() IsMetric()
#endif /* OLDROUTINENAMES */
 
  /* Environs Equates */
  enum
  {
    curSysEnvVers = 2 /*Updated to equal latest SysEnvirons version*/
  };
 
  struct SysEnvRec
  {
    short environsVersion;
    short machineType;
    short systemVersion;
    short processor;
    Boolean hasFPU;
    Boolean hasColorQD;
    short keyBoardType;
    short atDrvrVersNum;
    short sysVRefNum;
  };
  typedef struct SysEnvRec SysEnvRec;
  enum
  {
    /* Machine Types */
    envMac = -1,
    envXL = -2,
    envMachUnknown = 0,
    env512KE = 1,
    envMacPlus = 2,
    envSE = 3,
    envMacII = 4,
    envMacIIx = 5,
    envMacIIcx = 6,
    envSE30 = 7,
    envPortable = 8,
    envMacIIci = 9,
    envMacIIfx = 11
  };
 
  enum
  {
    /* CPU types */
    envCPUUnknown = 0,
    env68000 = 1,
    env68010 = 2,
    env68020 = 3,
    env68030 = 4,
    env68040 = 5
  };
 
  enum
  {
    /* Keyboard types */
    envUnknownKbd = 0,
    envMacKbd = 1,
    envMacAndPad = 2,
    envMacPlusKbd = 3,
    envAExtendKbd = 4,
    envStandADBKbd = 5,
    envPrtblADBKbd = 6,
    envPrtblISOKbd = 7,
    envStdISOADBKbd = 8,
    envExtISOADBKbd = 9
  };
 
#if CALL_NOT_IN_CARBON
 
#if TARGET_OS_MAC && TARGET_CPU_68K && !TARGET_RT_MAC_CFM
#pragma parameter __D0 SysEnvirons(__D0, __A0)
#endif
  OSErr
  SysEnvirons(short versionRequested, SysEnvRec *theWorld);
 
#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                                    /* __OSUTILS__ */
* /*/*/ * /*/*/ * /*/*/ * /*/*/ * /*/*/ * /*/*/