/*
       File:       AEDataModel.h
   
       Contains:   AppleEvent Data Model Interfaces.
   
       Version:    Technology: System 7.5
                   Release:    QuickTime 6.0.2
   
       Copyright:  (c) 1996-2001 by Apple Computer, Inc., all rights reserved
   
       Bugs?:      For bug reports, consult the following page on
                   the World Wide Web:
   
                       http://developer.apple.com/bugreporter/
   
  */
  ifndef __AEDATAMODEL__
  define __AEDATAMODEL__
  
  ifndef __MACTYPES__
  include <MacTypes.h>
  endif
  
  ifndef __MIXEDMODE__
  include <MixedMode.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
  
  /* Apple event descriptor types */
  enum {
      typeBoolean                 = FOUR_CHAR_CODE('bool'),
      typeChar                    = FOUR_CHAR_CODE('TEXT')
  };
  
  /* Preferred numeric Apple event descriptor types */
  enum {
      typeSInt16                  = FOUR_CHAR_CODE('shor'),
      typeSInt32                  = FOUR_CHAR_CODE('long'),
      typeUInt32                  = FOUR_CHAR_CODE('magn'),
      typeSInt64                  = FOUR_CHAR_CODE('comp'),
      typeIEEE32BitFloatingPoint  = FOUR_CHAR_CODE('sing'),
      typeIEEE64BitFloatingPoint  = FOUR_CHAR_CODE('doub'),
      type128BitFloatingPoint     = FOUR_CHAR_CODE('ldbl'),
      typeDecimalStruct           = FOUR_CHAR_CODE('decm')
  };
  
  /* Non-preferred Apple event descriptor types */
  enum {
      typeSMInt                   = typeSInt16,
      typeShortInteger            = typeSInt16,
      typeInteger                 = typeSInt32,
      typeLongInteger             = typeSInt32,
      typeMagnitude               = typeUInt32,
      typeComp                    = typeSInt64,
      typeSMFloat                 = typeIEEE32BitFloatingPoint,
      typeShortFloat              = typeIEEE32BitFloatingPoint,
      typeFloat                   = typeIEEE64BitFloatingPoint,
      typeLongFloat               = typeIEEE64BitFloatingPoint,
      typeExtended                = FOUR_CHAR_CODE('exte')
  };
  
  /* More Apple event descriptor types */
  enum {
      typeAEList                  = FOUR_CHAR_CODE('list'),
      typeAERecord                = FOUR_CHAR_CODE('reco'),
      typeAppleEvent              = FOUR_CHAR_CODE('aevt'),
      typeEventRecord             = FOUR_CHAR_CODE('evrc'),
      typeTrue                    = FOUR_CHAR_CODE('true'),
      typeFalse                   = FOUR_CHAR_CODE('fals'),
      typeAlias                   = FOUR_CHAR_CODE('alis'),
      typeEnumerated              = FOUR_CHAR_CODE('enum'),
      typeType                    = FOUR_CHAR_CODE('type'),
      typeAppParameters           = FOUR_CHAR_CODE('appa'),
      typeProperty                = FOUR_CHAR_CODE('prop'),
      typeFSS                     = FOUR_CHAR_CODE('fss '),
      typeKeyword                 = FOUR_CHAR_CODE('keyw'),
      typeSectionH                = FOUR_CHAR_CODE('sect'),
      typeWildCard                = FOUR_CHAR_CODE('****'),
      typeApplSignature           = FOUR_CHAR_CODE('sign'),
      typeQDRectangle             = FOUR_CHAR_CODE('qdrt'),
      typeFixed                   = FOUR_CHAR_CODE('fixd'),
      typeSessionID               = FOUR_CHAR_CODE('ssid'),
      typeTargetID                = FOUR_CHAR_CODE('targ'),
      typeProcessSerialNumber     = FOUR_CHAR_CODE('psn '),
      typeKernelProcessID         = FOUR_CHAR_CODE('kpid'),
      typeDispatcherID            = FOUR_CHAR_CODE('dspt'),
      typeNull                    = FOUR_CHAR_CODE('null')        /* null or nonexistent data */
  };
  
  /* Keywords for Apple event attributes */
  enum {
      keyTransactionIDAttr        = FOUR_CHAR_CODE('tran'),
      keyReturnIDAttr             = FOUR_CHAR_CODE('rtid'),
      keyEventClassAttr           = FOUR_CHAR_CODE('evcl'),
      keyEventIDAttr              = FOUR_CHAR_CODE('evid'),
      keyAddressAttr              = FOUR_CHAR_CODE('addr'),
      keyOptionalKeywordAttr      = FOUR_CHAR_CODE('optk'),
      keyTimeoutAttr              = FOUR_CHAR_CODE('timo'),
      keyInteractLevelAttr        = FOUR_CHAR_CODE('inte'),       /* this attribute is read only - will be set in AESend */
      keyEventSourceAttr          = FOUR_CHAR_CODE('esrc'),       /* this attribute is read only */
      keyMissedKeywordAttr        = FOUR_CHAR_CODE('miss'),       /* this attribute is read only */
      keyOriginalAddressAttr      = FOUR_CHAR_CODE('from')        /* new in 1.0.1 */
  };
  
  /*  Constants used for specifying the factoring of AEDescLists. */
  enum {
      kAEDescListFactorNone       = 0,
      kAEDescListFactorType       = 4,
      kAEDescListFactorTypeAndSize = 8
  };
  
  /* Constants used creating an AppleEvent */
  enum {
                                                                  /* Constant for the returnID param of AECreateAppleEvent */
      kAutoGenerateReturnID       = -1,                           /* AECreateAppleEvent will generate a session-unique ID */
                                                                  /* Constant for transaction ID's */
      kAnyTransactionID           = 0                             /* no transaction is in use */
  };
  
  /* Apple event manager data types */
  typedef ResType                         DescType;
  typedef FourCharCode                    AEKeyword;
  if OPAQUE_TOOLBOX_STRUCTS
  typedef struct OpaqueAEDataStorage*     AEDataStorage;
  else
  typedef Handle                          AEDataStorage;
  endif  /* OPAQUE_TOOLBOX_STRUCTS */
  
  struct AEDesc {
      DescType                        descriptorType;
      AEDataStorage                   dataHandle;
  };
  typedef struct AEDesc                   AEDesc;
  typedef AEDesc *                        AEDescPtr;
  
  struct AEKeyDesc {
      AEKeyword                       descKey;
      AEDesc                          descContent;
  };
  typedef struct AEKeyDesc                AEKeyDesc;
  /* a list of AEDesc's is a special kind of AEDesc */
  
  typedef AEDesc                          AEDescList;
  /* AERecord is a list of keyworded AEDesc's */
  typedef AEDescList                      AERecord;
  /* an AEDesc which contains address data */
  typedef AEDesc                          AEAddressDesc;
  /* an AERecord that contains an AppleEvent, and related data types */
  typedef AERecord                        AppleEvent;
  typedef AppleEvent *                    AppleEventPtr;
  typedef SInt16                          AEReturnID;
  typedef SInt32                          AETransactionID;
  typedef FourCharCode                    AEEventClass;
  typedef FourCharCode                    AEEventID;
  typedef SInt8                           AEArrayType;
  enum {
      kAEDataArray                = 0,
      kAEPackedArray              = 1,
      kAEDescArray                = 3,
      kAEKeyDescArray             = 4
  };
  
  enum {
      kAEHandleArray              = 2
  };
  
  union AEArrayData {
      short                           kAEDataArray[1];
      char                            kAEPackedArray[1];
      Handle                          kAEHandleArray[1];
      AEDesc                          kAEDescArray[1];
      AEKeyDesc                       kAEKeyDescArray[1];
  };
  typedef union AEArrayData               AEArrayData;
  typedef AEArrayData *                   AEArrayDataPointer;