home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / warphead.zip / H / STORUTIL.H < prev    next >
C/C++ Source or Header  |  1997-02-28  |  6KB  |  201 lines
  1. /* @(#)Z 1.7 com/src/utils/include/StorUtil.h, odstorage, od96os2, odos29646d 96/11/15 15:29:34 (96/08/20 11:07:27) */
  2. /*====START_GENERATED_PROLOG======================================
  3.  */
  4. /*
  5.  *   COMPONENT_NAME: odstorage
  6.  *
  7.  *   CLASSES: none
  8.  *
  9.  *   ORIGINS: 82,27
  10.  *
  11.  *
  12.  *   (C) COPYRIGHT International Business Machines Corp. 1995,1996
  13.  *   All Rights Reserved
  14.  *   Licensed Materials - Property of IBM
  15.  *   US Government Users Restricted Rights - Use, duplication or
  16.  *   disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
  17.  *       
  18.  *   IBM DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  19.  *   ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20.  *   PURPOSE. IN NO EVENT SHALL IBM BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  21.  *   CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  22.  *   USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  23.  *   OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE
  24.  *   OR PERFORMANCE OF THIS SOFTWARE.
  25.  */
  26. /*====END_GENERATED_PROLOG========================================
  27.  */
  28. /*
  29.     File:        StorUtil.h
  30.  
  31.     Contains:    Utilities for Storage.
  32.  
  33.     Owned by:    Vincent Lo
  34.  
  35.     Copyright:    ⌐ 1994 - 1995 by Apple Computer, Inc., all rights reserved.
  36.  
  37.     
  38.     In Progress:
  39.         
  40. */
  41.  
  42.  
  43.  
  44. #ifndef _STORUTIL_
  45. #define _STORUTIL_
  46.  
  47. #ifndef SOM_ODDraft_xh
  48. #include <Draft.xh>
  49. #endif
  50.  
  51. #ifndef _ODTYPES_
  52. #include <ODTypes.h>
  53. #endif
  54.  
  55. #ifndef _ODMEMORY_
  56. #include <ODMemory.h>
  57. #endif
  58.  
  59. #ifdef __PRIVATE__
  60. #ifndef _PLFMFILE_
  61. #include <PlfmFile.h>
  62. #endif
  63. #endif // __PRIVATE__
  64.  
  65. #ifndef SOM_ODPart_xh
  66. #include <Part.xh>
  67. #endif
  68.  
  69. #ifndef _PLATFORM_MACINTOSH_
  70. #include <somltype.h>
  71. #endif
  72.  
  73. #ifndef _ODMVCLNK_
  74. #include <ODMvcLnk.h>
  75. #endif
  76.  
  77. class ODContainer;
  78. class ODSession;
  79. class ODStorageUnitView;
  80. class ODStorageUnit;
  81.  
  82. #ifdef _OD_IMPL_SHARE_UTILS_
  83. #pragma import on
  84. #endif
  85.  
  86.  
  87. #ifdef _PLATFORM_MACINTOSH_
  88. extern "C" {
  89.  
  90.     void ODSUAddPropValue(Environment* ev, ODStorageUnit* su,
  91.                                ODPropertyName prop, ODValueType val);
  92.  
  93.     void ODSUForceFocus(Environment* ev, ODStorageUnit* su,
  94.                              ODPropertyName prop, ODValueType val);
  95.  
  96.     ODBoolean ODSUExistsThenFocus(Environment* ev, ODStorageUnit* su,
  97.                                        ODPropertyName prop, ODValueType val);
  98.  
  99.     void ODSURemoveProperty(Environment* ev, ODStorageUnit* su,
  100.                                                ODPropertyName prop);
  101.  
  102. #else // _PLATFORM_MACINTOSH_
  103.  
  104. SOMEXTERN _DLLIMPORTEXPORT_  void SOMLINK ODSUAddPropValue(Environment* ev, ODStorageUnit* su,
  105.                                ODPropertyName prop, ODValueType val);
  106.  
  107. SOMEXTERN _DLLIMPORTEXPORT_  void SOMLINK ODSUForceFocus(Environment* ev, ODStorageUnit* su,
  108.                               ODPropertyName prop, ODValueType val);
  109.  
  110. SOMEXTERN _DLLIMPORTEXPORT_  ODBoolean SOMLINK ODSUExistsThenFocus(Environment* ev, ODStorageUnit* su,
  111.                                        ODPropertyName prop, ODValueType val);
  112.  
  113. SOMEXTERN _DLLIMPORTEXPORT_  void SOMLINK ODSURemoveProperty(Environment* ev, ODStorageUnit* su,
  114.                                                 ODPropertyName prop);
  115.     
  116. #endif // _PLATFORM_MACINTOSH_
  117.  
  118.  
  119. #ifdef __PRIVATE__
  120.     PlatformFile*    GetPlatformFileFromContainer(Environment* ev, ODContainer* container);
  121.     ODFileSpec    GetODFileSpecFromContainer(Environment* ev, ODContainer* container);
  122.  
  123.     ODContainer*    CreateFileContainer(Environment* ev, ODSession* session, FSSpec* fsSpec);
  124.     ODContainer*    GetFileContainer(Environment* ev, ODSession* session, FSSpec* fsSpec);
  125.  
  126.     ODContainer*    CreateMemoryContainer(Environment* ev,
  127.                         ODSession* session,
  128.                         ODHandle handle,
  129.                         ODContainerType containerType);
  130.  
  131.     ODContainer*    GetMemoryContainer(Environment* ev, 
  132.                         ODSession* session,
  133.                         ODHandle handle,
  134.                         ODContainerType containerType);
  135. #endif // __PRIVATE__
  136.  
  137.  
  138. #ifdef _PLATFORM_MACINTOSH_
  139.     ODULong      StorageUnitGetValue(ODStorageUnit* su, Environment* ev,
  140.                         ODULong size, void *buffer);
  141.  
  142.     ODULong      StorageUnitViewGetValue(ODStorageUnitView* suv, Environment* ev,
  143.                         ODULong size, void *buffer);
  144.  
  145.     void    StorageUnitSetValue(ODStorageUnit* su, Environment* ev,
  146.                     ODULong size, const void *buffer);
  147.  
  148.     void    StorageUnitViewSetValue(ODStorageUnitView* suv, Environment* ev,
  149.                     ODULong size, const void *buffer);
  150.  
  151.     void   StorageUnitSetPromiseValue(ODStorageUnit* su, Environment* ev,
  152.                     ODValueType value, ODULong offset,
  153.             ODULong size, const void *buffer, ODPart *sourcePart);
  154.  
  155.     ODBoolean  StorageUnitGetStylFromStyledText(ODStorageUnit* su,
  156.                         Environment* ev,
  157.                         ODULong* size,
  158.                         ODPtr* styl);
  159.                         
  160.     ODCloneKind  GetOriginalCloneKind(Environment* ev, ODDraft* draft);
  161.  
  162.     void  RemoveDataInterchangeProperties (Environment* ev,
  163.                         ODStorageUnit* su,
  164.                         ODBoolean clonedToFileContainer);
  165. }
  166.  
  167. #else // _PLATFORM_MACINTOSH_
  168.  
  169. SOMEXTERN _DLLIMPORTEXPORT_  ODULong  SOMLINK  StorageUnitGetValue(ODStorageUnit* su, Environment* ev,
  170.                         ODULong size, void *buffer);
  171.  
  172. SOMEXTERN _DLLIMPORTEXPORT_  ODULong  SOMLINK  StorageUnitViewGetValue(ODStorageUnitView* suv, Environment* ev,
  173.                         ODULong size, void *buffer);
  174.  
  175.  
  176. SOMEXTERN _DLLIMPORTEXPORT_  void  SOMLINK  StorageUnitSetValue(ODStorageUnit* su, Environment* ev,
  177.                     ODULong size, const void *buffer);
  178.  
  179. SOMEXTERN _DLLIMPORTEXPORT_  void  SOMLINK  StorageUnitViewSetValue(ODStorageUnitView* suv, Environment* ev,
  180.                     ODULong size, const void *buffer);
  181.  
  182. SOMEXTERN _DLLIMPORTEXPORT_  void  SOMLINK  StorageUnitSetPromiseValue(ODStorageUnit* su, Environment* ev,
  183.                     ODValueType value, ODULong offset,
  184.  
  185.             ODULong size, const void *buffer, ODPart *sourcePart);
  186.  
  187.                         
  188. SOMEXTERN _DLLIMPORTEXPORT_  ODCloneKind SOMLINK  GetOriginalCloneKind(Environment* ev, ODDraft* draft);
  189.  
  190. SOMEXTERN _DLLIMPORTEXPORT_  void  SOMLINK RemoveDataInterchangeProperties (Environment* ev,
  191.                         ODStorageUnit* su,
  192.                         ODBoolean clonedToFileContainer);
  193. #endif // _PLATFORM_MACINTOSH_
  194.  
  195.  
  196. #ifdef _OD_IMPL_SHARE_UTILS_
  197. #pragma import off
  198. #endif
  199.     
  200. #endif // _STORUTIL_
  201.