CTBUtilities.h

Go to the documentation of this file.

 
#ifndef __CTBUTILITIES__
#define __CTBUTILITIES__
 
#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __MIXEDMODE__
#include <MixedMode.h>
#endif
 
#ifndef __DIALOGS__
#include <Dialogs.h>
#endif
 
#ifndef __APPLETALK__
#include <AppleTalk.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
 
#if CALL_NOT_IN_CARBON
  enum
  {
    curCTBUVersion = 2 
  };
 
  enum
  {
    ctbuGenericError = -1,
    ctbuNoErr = 0
  };
 
  typedef OSErr CTBUErr;
  typedef SInt16 ChooseReturnCode;
  enum
  {
    chooseDisaster = -2,
    chooseFailed = -1,
    chooseAborted = 0,
    chooseOKMinor = 1,
    chooseOKMajor = 2,
    chooseCancel = 3
  };
 
  typedef UInt16 NuLookupReturnCode;
  enum
  {
    nlOk = 0,
    nlCancel = 1,
    nlEject = 2
  };
 
  typedef UInt16 NameFilterReturnCode;
  enum
  {
    nameInclude = 1,
    nameDisable = 2,
    nameReject = 3
  };
 
  typedef UInt16 ZoneFilterReturnCode;
  enum
  {
    zoneInclude = 1,
    zoneDisable = 2,
    zoneReject = 3
  };
 
  enum
  {
    hookOK = 1,
    hookCancel = 2,
    hookOutline = 3,
    hookTitle = 4,
    hookItemList = 5,
    hookZoneTitle = 6,
    hookZoneList = 7,
    hookLine = 8,
    hookVersion = 9,
    hookReserved1 = 10,
    hookReserved2 = 11,
    hookReserved3 = 12,
    hookReserved4 = 13, 
    hookNull = 100,
    hookItemRefresh = 101,
    hookZoneRefresh = 102,
    hookEject = 103,
    hookPreflight = 104,
    hookPostflight = 105,
    hookKeyBase = 1000
  };
 
  struct NLTypeEntry
  {
    Handle hIcon;
    Str32 typeStr;
  };
  typedef struct NLTypeEntry NLTypeEntry;
  typedef NLTypeEntry NLType[4];
  struct NBPReply
  {
    EntityName theEntity;
    AddrBlock theAddr;
  };
  typedef struct NBPReply NBPReply;
  typedef CALLBACK_API(short, DialogHookProcPtr)(short item, DialogRef theDialog);
  typedef CALLBACK_API(short, NameFilterProcPtr)(const EntityName *theEntity);
  typedef CALLBACK_API(short, ZoneFilterProcPtr)(ConstStr32Param theZone);
  typedef STACK_UPP_TYPE(DialogHookProcPtr) DialogHookUPP;
  typedef STACK_UPP_TYPE(NameFilterProcPtr) NameFilterUPP;
  typedef STACK_UPP_TYPE(ZoneFilterProcPtr) ZoneFilterUPP;
#if CALL_NOT_IN_CARBON
  DialogHookUPP
  NewDialogHookUPP(DialogHookProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppDialogHookProcInfo = 0x000003A0
  }; 
#ifdef __cplusplus
  inline DialogHookUPP NewDialogHookUPP(DialogHookProcPtr userRoutine)
  {
    return (DialogHookUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppDialogHookProcInfo, GetCurrentArchitecture());
  }
#else
#define NewDialogHookUPP(userRoutine)   \
  (DialogHookUPP) NewRoutineDescriptor( \
      (ProcPtr)(userRoutine), uppDialogHookProcInfo, GetCurrentArchitecture())
#endif
#endif
 
  NameFilterUPP
  NewNameFilterUPP(NameFilterProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppNameFilterProcInfo = 0x000000E0
  }; 
#ifdef __cplusplus
  inline NameFilterUPP NewNameFilterUPP(NameFilterProcPtr userRoutine)
  {
    return (NameFilterUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppNameFilterProcInfo, GetCurrentArchitecture());
  }
#else
#define NewNameFilterUPP(userRoutine)   \
  (NameFilterUPP) NewRoutineDescriptor( \
      (ProcPtr)(userRoutine), uppNameFilterProcInfo, GetCurrentArchitecture())
#endif
#endif
 
  ZoneFilterUPP
  NewZoneFilterUPP(ZoneFilterProcPtr userRoutine);
#if !OPAQUE_UPP_TYPES
  enum
  {
    uppZoneFilterProcInfo = 0x000000E0
  }; 
#ifdef __cplusplus
  inline ZoneFilterUPP NewZoneFilterUPP(ZoneFilterProcPtr userRoutine)
  {
    return (ZoneFilterUPP)NewRoutineDescriptor(
        (ProcPtr)(userRoutine), uppZoneFilterProcInfo, GetCurrentArchitecture());
  }
#else
#define NewZoneFilterUPP(userRoutine)   \
  (ZoneFilterUPP) NewRoutineDescriptor( \
      (ProcPtr)(userRoutine), uppZoneFilterProcInfo, GetCurrentArchitecture())
#endif
#endif
 
  void
  DisposeDialogHookUPP(DialogHookUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeDialogHookUPP(DialogHookUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeDialogHookUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeNameFilterUPP(NameFilterUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeNameFilterUPP(NameFilterUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeNameFilterUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  void
  DisposeZoneFilterUPP(ZoneFilterUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline void DisposeZoneFilterUPP(ZoneFilterUPP userUPP)
  {
    DisposeRoutineDescriptor((UniversalProcPtr)userUPP);
  }
#else
#define DisposeZoneFilterUPP(userUPP) DisposeRoutineDescriptor(userUPP)
#endif
#endif
 
  short
  InvokeDialogHookUPP(short item, DialogRef theDialog, DialogHookUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline short InvokeDialogHookUPP(short item, DialogRef theDialog,
                                   DialogHookUPP userUPP)
  {
    return (short)CALL_TWO_PARAMETER_UPP(userUPP, uppDialogHookProcInfo, item,
                                         theDialog);
  }
#else
#define InvokeDialogHookUPP(item, theDialog, userUPP)                     \
  (short)CALL_TWO_PARAMETER_UPP((userUPP), uppDialogHookProcInfo, (item), \
                                (theDialog))
#endif
#endif
 
  short
  InvokeNameFilterUPP(const EntityName *theEntity, NameFilterUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline short InvokeNameFilterUPP(const EntityName *theEntity,
                                   NameFilterUPP userUPP)
  {
    return (short)CALL_ONE_PARAMETER_UPP(userUPP, uppNameFilterProcInfo,
                                         theEntity);
  }
#else
#define InvokeNameFilterUPP(theEntity, userUPP) \
  (short)CALL_ONE_PARAMETER_UPP((userUPP), uppNameFilterProcInfo, (theEntity))
#endif
#endif
 
  short
  InvokeZoneFilterUPP(ConstStr32Param theZone, ZoneFilterUPP userUPP);
#if !OPAQUE_UPP_TYPES
#ifdef __cplusplus
  inline short InvokeZoneFilterUPP(ConstStr32Param theZone,
                                   ZoneFilterUPP userUPP)
  {
    return (short)CALL_ONE_PARAMETER_UPP(userUPP, uppZoneFilterProcInfo, theZone);
  }
#else
#define InvokeZoneFilterUPP(theZone, userUPP) \
  (short)CALL_ONE_PARAMETER_UPP((userUPP), uppZoneFilterProcInfo, (theZone))
#endif
#endif
 
#endif 
#if CALL_NOT_IN_CARBON || OLDROUTINENAMES
#define NewDialogHookProc(userRoutine) NewDialogHookUPP(userRoutine)
#define NewNameFilterProc(userRoutine) NewNameFilterUPP(userRoutine)
#define NewZoneFilterProc(userRoutine) NewZoneFilterUPP(userRoutine)
#define CallDialogHookProc(userRoutine, item, theDialog) \
  InvokeDialogHookUPP(item, theDialog, userRoutine)
#define CallNameFilterProc(userRoutine, theEntity) \
  InvokeNameFilterUPP(theEntity, userRoutine)
#define CallZoneFilterProc(userRoutine, theZone) \
  InvokeZoneFilterUPP(theZone, userRoutine)
#endif 
#endif 
#if CALL_NOT_IN_CARBON
  CTBUErr
  InitCTBUtilities(void);
 
  short
  CTBGetCTBVersion(void);
 
  short
  StandardNBP(Point where, ConstStr255Param prompt, short numTypes,
              NLType typeList, NameFilterUPP nameFilter, ZoneFilterUPP zoneFilter,
              DialogHookUPP hook, NBPReply *theReply);
 
  short
  CustomNBP(Point where, ConstStr255Param prompt, short numTypes, NLType typeList,
            NameFilterUPP nameFilter, ZoneFilterUPP zoneFilter,
            DialogHookUPP hook, long userData, short dialogID,
            ModalFilterUPP filter, NBPReply *theReply);
 
#endif 
#if OLDROUTINENAMES
#define NuLookup(where, prompt, numTypes, typeList, nameFilter, zoneFilter,    \
                 hook, theReply)                                               \
  StandardNBP(where, prompt, numTypes, typeList, nameFilter, zoneFilter, hook, \
              theReply)
#define NuPLookup(where, prompt, numTypes, typeList, nameFilter, zoneFilter, \
                  hook, userData, dialogID, filter, theReply)                \
  CustomNBP(where, prompt, numTypes, typeList, nameFilter, zoneFilter, hook, \
            userData, dialogID, filter, theReply)
#endif 
#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