home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK2.toast / Development Kits (Disc 2) / OpenDoc / OpenDoc Development / Debugging Support / OpenDoc™ Source Code / Storage / Bento / CM / CMAPIIDs.h < prev    next >
Encoding:
C/C++ Source or Header  |  1996-08-28  |  9.6 KB  |  208 lines  |  [TEXT/MPS ]
  1. /*
  2.     File:        CMAPIIDs.h
  3.  
  4.     Contains:    Container Manager Standard Object ID Definitions, etc.
  5.  
  6.     Written by:    Ira L. Ruben
  7.  
  8.     Owned by:    Ed Lai
  9.  
  10.     Copyright:    © 1991 - 1994 by Apple Computer, Inc., all rights reserved.
  11.  
  12.     Change History (most recent first):
  13.  
  14.          <2>     8/26/94    EL        #1181622 Ownership update.
  15.  
  16.     To Do:
  17. */
  18.  
  19. /* (use tabs = 2 to view this file correctly) */
  20. /*---------------------------------------------------------------------------*
  21.  |                                                                           |
  22.  |                         <<< CM_API_StdObjIDs.h >>>                        |
  23.  |                                                                           |
  24.  |          Container Manager Standard Object ID Definitions, etc.           |
  25.  |                                                                           |
  26.  |                               Ira L. Ruben                                |
  27.  |                                 12/13/91                                  |
  28.  |                                                                           |
  29.  |                  Copyright Apple Computer, Inc. 1991-1994                 |
  30.  |                           All rights reserved.                            |
  31.  |                                                                           |
  32.  *---------------------------------------------------------------------------*
  33.  
  34.  All standard object ID's and global names are defined in the file.  Also defined are the
  35.  standard metahandler operation type strings.
  36. */
  37.  
  38.  
  39. #ifndef __CM_API_STDOBJIDS__
  40. #define __CM_API_STDOBJIDS__
  41.  
  42.  
  43. /*-------------------------------------------*
  44.  | Predefined Object, Property, and Type IDs |
  45.  *-------------------------------------------*
  46.  
  47.  These ID's are used by the API to define standard objects in the container and its TOC.
  48.  You can use them where applicable to look at these objects.
  49. */
  50.  
  51. #define CM_StdObjID_TOC                             1        /* TOC object    ID                                       (object)    */
  52. #define CM_StdObjID_TOC_Seed                  2        /* TOC object starting seed              (property) */
  53. #define CM_StdObjID_TOC_MinSeed              3        /* TOC object minimum seed                 (property) */
  54. #define CM_StdObjID_TOC_Object             4        /* TOC object                                             (property)    */
  55. #define CM_StdObjID_TOC_Container         5        /* TOC object    entire container          (property)    */
  56. #define CM_StdObjID_TOC_Deleted             6        /* TOC object amount deleted              (property)    */
  57. #define CM_StdObjID_TOC_Free                 7        /* TOC object    free space                     (property)    */
  58. #define CM_StdObjID_TOC_NewValuesTOC 8        /* TOC object new values TOC             (property)    */
  59. #define CM_StdObjID_TOC_Target             9        /* TOC object    target container ref.(property)    */
  60. #define CM_StdObjID_TOC_DeleteList    10        /* TOC object delete update list     (property)    */
  61.  
  62. #define CM_StdObjID_TOC_Type                19        /* TOC object property value type             (type) */
  63.  
  64. #define CM_StdObjID_Writable                20        /* Predefined ID's below this value will be        */
  65.                                                                                     /* written to container TOC.  Predefined ID's    */
  66.                                                                                     /* above this are NOT written.                                */
  67.  
  68. #define CM_StdObjID_7BitASCII                21        /* 7-bit ASCII                                                 (type) */
  69. #define CM_StdObjID_8BitASCII                22        /* 8-bit ASCII                                                 (type) */
  70. #define CM_StdObjID_GlobalTypeName    23        /* Global type name                                 (property) */
  71. #define CM_StdObjID_GlobalPropName    24        /* Global property name                         (property) */
  72.  
  73. #define CM_StdObjID_DynamicValues      25        /* Dynamic values                                 (property) */
  74. #define CM_StdObjID_BaseTypes              26        /* Base types                                         (property) */
  75. #define CM_StdObjID_BaseTypeList      27        /* Base type list                                           (type) */
  76.  
  77. #define CM_StdObjID_TargetContainer    28        /* Target container                                       (type) */
  78. #define CM_StdObjID_ValueUpdates        29        /* Value updates for object             (property) */
  79. #define CM_StdObjID_UpdatesData            30        /* Internal updating instruction data  (type) */
  80.  
  81. #define CM_StdObjID_ObjReferences        31        /* Referenced objects from an object(property)*/
  82. #define CM_StdObjID_ObjRefData             32        /* Reference data                                             (type) */
  83.  
  84. #define CM_StdObjID_32BitImmValue        40        /* 32-bit immediate data value                 (type) */
  85. #define CM_StdObjID_16BitImmValue        41        /* 16-bit immediate data value                 (type) */
  86. #define CM_StdObjID_8BitImmValue        42        /*  8-bit immediate data value                 (type) */
  87.  
  88. #define CM_StdObjID_MinGeneralID     100        /* min object ID for general standard objects */
  89.  
  90.  
  91. /*------------------------------------*
  92.  | Predefined Property and Type Names |
  93.  *------------------------------------*
  94.  
  95.  These define global names which can be passed to CMRegisterType() or CMRegisterProperty()
  96.  to get the associated type or property descriptor object.  Note, some of these are used
  97.  internally by the Container Manager and are marked as "(CM)".
  98. */
  99.  
  100. #define CMTOCSeedGlobalName                     "Apple:Global_Name_TOC_Seed"                /* property            */
  101. #define CMTOCMinSeedGlobalName             "Apple:Global_Name_TOC_MinSeed"            /* property            */
  102. #define CMTOCObjectGlobalName                 "Apple:Global_Name_TOC_Object"            /* property            */
  103. #define CMTOCContainerGlobalName         "Apple:Global_Name_TOC_Container"        /* property            */
  104. #define CMTOCDeletedGlobalName             "Apple:Global_Name_TOC_Deleted"            /* property            */
  105. #define CMTOCTotalFreeGlobalName         "Apple:Global_Name_TOC_Free"                /* property            */
  106. #define CMTOCNewValuesTOCGlobalName    "Apple:Global_Name_TOC_NewValuesTOC"/* property            */
  107. #define CMTOCTargetGlobalName              "Apple:Global_Name_TOC_Target"            /* property            */
  108. #define CMTOCDeleteListGlobalName     "Apple:Global_Name_TOC_DeleteList"    /* property            */
  109. #define CMTOCValueTypeGlobalName        "Apple:Global_Name_TOC_Type"                /* type                    */
  110.  
  111. #define CMDynamicValueGlobalName         "Apple:Dynamic_Value"                                /* property (CM)*/
  112. #define CMBaseTypesGlobalName                 "Apple:Type_BaseType"                                /* property (CM)*/
  113. #define CMBaseTypeListGlobalName        "Apple:Type_BaseTypeList"                        /* type         (CM)*/
  114. #define CMTargetContainerName                 "Apple:Target_Container"                        /* type            (CM)*/
  115. #define CMValueUpdatesGlobalName        "Apple:Type_ValueUpdates"                        /* property (CM)*/
  116. #define CMUpdatesDataGlobalName            "Apple:Type_UpdatesData"                        /* type          (CM)*/
  117.  
  118.  
  119. /*-------------------------------------*
  120.  | Predfined Editing Metahandler Types |
  121.  *-------------------------------------*
  122.  
  123.  These define a type names to be associated with special metahandler packages.  Currently 
  124.  there is only one (!), which defines the type known to the Container Manager, that must
  125.  be associated with target container handlers whenever a target container is opened by an
  126.  updating container.  The target container handlers must be registered as the handler
  127.  package assoicated with this type.
  128. */
  129.  
  130. #define CMTargetHandlersTypeName    "Apple:Target_Handlers_TypeName"
  131.  
  132.  
  133. /*---------------------------------------------------------------------*
  134.  | Metahandler Operation Types For Container Special Global Operations |
  135.  *---------------------------------------------------------------------*
  136.  
  137.  These are the defined strings the API passes to a metahandler (passed to CMStartSession())
  138.  to get the handler routine addresses for special global (to all containers) operations.
  139. */
  140.  
  141. #define CMErrorOpType                        "Apple:ReportError"
  142. #define CMAllocOpType                        "Apple:AllocMemory"
  143. #define CMFreeOpType                        "Apple:FreeMemory"
  144.  
  145.  
  146. /*----------------------------------------------------------*
  147.  | Metahandler Operation Types For Container I/O Operations |
  148.  *----------------------------------------------------------*
  149.  
  150.  These are the defined strings the API passes to a metahandler to get the handler routine
  151.  addresses for the I/O operations the API needs to do on a container.
  152. */
  153.  
  154. #define CMOpenOpType                        "Apple:OpenStream"
  155. #define CMCloseOpType                        "Apple:CloseStream"
  156. #define CMFlushOpType                        "Apple:FlushStream"
  157. #define CMSeekOpType                        "Apple:SetPosStream"
  158. #define CMTellOpType                        "Apple:GetPosStream"
  159. #define CMReadOpType                        "Apple:ReadStream"
  160. #define CMWriteOpType                        "Apple:WriteStream"
  161. #define CMEofOpType                            "Apple:EofStream"
  162. #define CMTruncOpType                        "Apple:TruncateStream"
  163. #define CMSizeOpType                        "Apple:SizeStream"
  164. #define CMReadLblOpType                    "Apple:ReadLabel"
  165. #define CMWriteLblOpType                "Apple:WriteLabel"
  166. #define CMParentOpType                    "Apple:ReturnParentValue"
  167. #define CMContainerOpName                "Apple:ReturnContainerName"
  168. #define CMTargetTypeOpType            "Apple:TargetContainerDynamicValueType"
  169. #define CMExtractDataOpType            "Apple:ExtractData"
  170. #define CMFormatDataOpType            "Apple:FormatData"
  171.  
  172.  
  173. /*------------------------------------------------*
  174.  | Metahandler Operation Types For Dynamic Values |
  175.  *------------------------------------------------*
  176.  
  177.  These are the defined strings that CMUseValue() and CMNewValue() pass to a metahandler if
  178.  the type of the value is that of a globally unique name and that name has a "use value"
  179.  matahandler defined for it.  These are used to create dynamic values.
  180. */
  181.  
  182. #define CMDefineMetaDataOpType    "Apple:DefineMetaData"
  183. #define CMNewValueOpType                "Apple:NewValue"
  184. #define CMUseValueOpType                "Apple:UseValue"
  185.  
  186.  
  187. /*----------------------------------------------------------*
  188.  | Metahandler Operation Types For Dynamic Value Operations |
  189.  *----------------------------------------------------------*
  190.  
  191.  These are the defined strings the API passes to a dynamic value metahandler (returned
  192.  from a "use value" handler) to get the dynamic value handler addresses for value
  193.  operations.
  194. */
  195.  
  196. #define CMGetValueSizeOpType        "Apple:CMGetValueSize"
  197. #define CMReadValueDataOpType        "Apple:CMReadValueData"
  198. #define CMWriteValueDataOpType    "Apple:CMWriteValueData"
  199. #define CMInsertValueDataOpType    "Apple:CMInsertValueData"
  200. #define CMDeleteValueDataOpType    "Apple:CMDeleteValueData"
  201. #define CMGetValueInfoOpType        "Apple:CMGetValueInfo"
  202. #define CMSetValueTypeOpType        "Apple:CMSetValueType"
  203. #define CMSetValueGenOpType            "Apple:CMSetValueGeneration"
  204. #define CMReleaseValueOpType        "Apple:CMReleaseValue"
  205.  
  206.  
  207. #endif
  208.