Scrap.h
上传用户:xjjlds
上传日期:2015-12-05
资源大小:22823k
文件大小:15k
源码类别:

多媒体编程

开发平台:

Visual C++

  1. /*
  2.      File:       Scrap.h
  3.  
  4.      Contains:   Scrap Manager Interfaces.
  5.  
  6.      Version:    Technology: Mac OS 9
  7.                  Release:    QuickTime 6.0.2
  8.  
  9.      Copyright:  (c) 1985-2001 by Apple Computer, Inc., all rights reserved
  10.  
  11.      Bugs?:      For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __SCRAP__
  18. #define __SCRAP__
  19. #ifndef __MIXEDMODE__
  20. #include "MixedMode.h"
  21. #endif
  22. #ifndef __MACERRORS__
  23. #include "MacErrors.h"
  24. #endif
  25. #if PRAGMA_ONCE
  26. #pragma once
  27. #endif
  28. #ifdef __cplusplus
  29. extern "C" {
  30. #endif
  31. #if PRAGMA_IMPORT
  32. #pragma import on
  33. #endif
  34. #if PRAGMA_STRUCT_ALIGN
  35.     #pragma options align=mac68k
  36. #elif PRAGMA_STRUCT_PACKPUSH
  37.     #pragma pack(push, 2)
  38. #elif PRAGMA_STRUCT_PACK
  39.     #pragma pack(2)
  40. #endif
  41. /*
  42.     ________________________________________________________________
  43.     UNIVERSAL SCRAP MANAGER INTERFACES
  44.     ________________________________________________________________
  45.     The following interfaces are available when compiling for BOTH
  46.     Carbon AND Mac OS 8.
  47.     ________________________________________________________________
  48. */
  49. /*
  50.     While were in here mucking about, we defined a new type to
  51.     to put some confusion to rest. The old calls, as well as the
  52.     new calls, use the new type. Existing clients should be
  53.     blissfully ignorant.
  54. */
  55. typedef FourCharCode                    ScrapFlavorType;
  56. /*
  57.     Newsflash! After 15 years of arduous toil, it's finally possible
  58.     for specially trained typists wielding advanced text editing
  59.     technology to define symbolic names for commonly used scrap
  60.     flavor type constants! Apple triumphs again!
  61. */
  62. enum {
  63.     kScrapFlavorTypePicture     = FOUR_CHAR_CODE('PICT'),       /* contents of a PicHandle*/
  64.     kScrapFlavorTypeText        = FOUR_CHAR_CODE('TEXT'),       /* stream of characters*/
  65.     kScrapFlavorTypeTextStyle   = FOUR_CHAR_CODE('styl'),       /* see TEGetStyleScrapHandle*/
  66.     kScrapFlavorTypeMovie       = FOUR_CHAR_CODE('moov'),       /* reference to a movie*/
  67.     kScrapFlavorTypeSound       = FOUR_CHAR_CODE('snd '),       /* see SndRecord and SndPlay*/
  68.     kScrapFlavorTypeUnicode     = FOUR_CHAR_CODE('utxt'),       /* stream of UTF16 characters*/
  69.     kScrapFlavorTypeUnicodeStyle = FOUR_CHAR_CODE('ustl')       /* ATSUI defines; Textension uses*/
  70. };
  71. /*
  72.     If you are a Carbon client and you need to run on Mac OS 8,
  73.     you may still need to load and unload the scrap. Under Mac OS
  74.     X, the scrap is held by the pasteboard server instead of in a
  75.     handle in your app's heap, so LoadScrap and UnloadScrap do
  76.     nothing when called under Mac OS X.
  77. */
  78. EXTERN_API( OSStatus )
  79. LoadScrap                       (void)                                                      ONEWORDINLINE(0xA9FB);
  80. EXTERN_API( OSStatus )
  81. UnloadScrap                     (void)                                                      ONEWORDINLINE(0xA9FA);
  82. #if CALL_NOT_IN_CARBON
  83. /*
  84.     ________________________________________________________________
  85.     MAC OS 8 SCRAP MANAGER INTERFACES
  86.     ________________________________________________________________
  87.     The following interfaces are available only when compiling for
  88.     plain vanilla Mac OS 8. We didn't add comments to them because
  89.     Inside Mac covers them in detail.
  90.     ________________________________________________________________
  91. */
  92. struct ScrapStuff {
  93.     SInt32                          scrapSize;
  94.     Handle                          scrapHandle;
  95.     SInt16                          scrapCount;
  96.     SInt16                          scrapState;
  97.     StringPtr                       scrapName;
  98. };
  99. typedef struct ScrapStuff               ScrapStuff;
  100. typedef ScrapStuff *                    PScrapStuff;
  101. typedef ScrapStuff *                    ScrapStuffPtr;
  102. #if CALL_NOT_IN_CARBON
  103. EXTERN_API( ScrapStuffPtr )
  104. InfoScrap                       (void)                                                      ONEWORDINLINE(0xA9F9);
  105. EXTERN_API( long )
  106. GetScrap                        (Handle                 destination,
  107.                                  ScrapFlavorType        flavorType,
  108.                                  SInt32 *               offset)                             ONEWORDINLINE(0xA9FD);
  109. EXTERN_API( OSStatus )
  110. ZeroScrap                       (void)                                                      ONEWORDINLINE(0xA9FC);
  111. EXTERN_API( OSStatus )
  112. PutScrap                        (SInt32                 sourceBufferByteCount,
  113.                                  ScrapFlavorType        flavorType,
  114.                                  const void *           sourceBuffer)                       ONEWORDINLINE(0xA9FE);
  115. #endif  /* CALL_NOT_IN_CARBON */
  116. #endif  /* CALL_NOT_IN_CARBON */
  117. /*
  118.     ________________________________________________________________
  119.     CARBON SCRAP MANAGER INTERFACES
  120.     ________________________________________________________________
  121.     The following interfaces are available only when compiling for
  122.     Carbon.
  123.     ________________________________________________________________
  124. */
  125. /*
  126.     When promising a scrap flavor, it's OK if you
  127.     don't yet know how big the flavor data will be.
  128.     In this case, just pass kScrapFlavorSizeUnknown
  129.     for the flavor data size.
  130. */
  131. enum {
  132.     kScrapFlavorSizeUnknown     = -1
  133. };
  134. /*
  135.     kScrapReservedFlavorType is a flavor type which is reserved
  136.     for use by Scrap Manager. If you pass it to Scrap Manager,
  137.     it will be rejected.
  138. */
  139. enum {
  140.     kScrapReservedFlavorType    = FOUR_CHAR_CODE('srft')
  141. };
  142. /*
  143.     We've added scrap flavor flags ala Drag Manager.
  144.     kScrapFlavorMaskNone means you want none of the flags.
  145.     kScrapFlavorSenderOnlyMask means only the process which
  146.     put the flavor on the scrap can see it. If some other
  147.     process put a flavor with this flag on the scrap,
  148.     your process will never see the flavor, so there's
  149.     no point in testing for this flag.
  150.     kScrapFlavorTranslated means the flavor was translated
  151.     from some other flavor in the scrap by Translation Manager.
  152.     Most callers should not care about this bit.
  153. */
  154. enum {
  155.     kScrapFlavorMaskNone        = 0x00000000,
  156.     kScrapFlavorMaskSenderOnly  = 0x00000001,
  157.     kScrapFlavorMaskTranslated  = 0x00000002
  158. };
  159. typedef UInt32                          ScrapFlavorFlags;
  160. /*
  161.     ScrapFlavorInfo describes a single flavor within
  162.     a scrap.
  163. */
  164. struct ScrapFlavorInfo {
  165.     ScrapFlavorType                 flavorType;
  166.     ScrapFlavorFlags                flavorFlags;
  167. };
  168. typedef struct ScrapFlavorInfo          ScrapFlavorInfo;
  169. /*
  170.     Under a future version of Carbon, there may be multiple scraps.
  171.     We'll need ScrapRefs to tell them apart.
  172. */
  173. typedef struct OpaqueScrapRef*          ScrapRef;
  174. /*
  175.     GetCurrentScrap obtains a reference to the current scrap.
  176.     The ScrapRef obtained via GetCurrentScrap will become
  177.     invalid and unusable after the scrap is cleared.
  178. */
  179. EXTERN_API( OSStatus )
  180. GetCurrentScrap                 (ScrapRef *             scrap);
  181. /*
  182.     GetScrapFlavorFlags tells you [a] whether the scrap contains
  183.     data for a particular flavor and [b] some things about that
  184.     flavor if it exists. This call never blocks, and is useful
  185.     for deciding whether to enable the Paste item in your Edit
  186.     menu, among other things.
  187. */
  188. EXTERN_API( OSStatus )
  189. GetScrapFlavorFlags             (ScrapRef               scrap,
  190.                                  ScrapFlavorType        flavorType,
  191.                                  ScrapFlavorFlags *     flavorFlags);
  192. /*
  193.     GetScrapFlavorSize gets the size of the data of the specified
  194.     flavor. This function blocks until the specified flavor
  195.     data is available. GetScrapFlavorSize is intended as a prelude
  196.     to allocating memory and calling GetScrapFlavorData.
  197. */
  198. EXTERN_API( OSStatus )
  199. GetScrapFlavorSize              (ScrapRef               scrap,
  200.                                  ScrapFlavorType        flavorType,
  201.                                  Size *                 byteCount);
  202. /*
  203.     GetScrapFlavorData gets the data from the specified flavor in the
  204.     specified scrap. This function blocks until the specified flavor
  205.     data is available. Specify the maximum size your buffer can contain;
  206.     on output, this function produces the number of bytes that were
  207.     available (even if this is more than you requested).
  208. */
  209. EXTERN_API( OSStatus )
  210. GetScrapFlavorData              (ScrapRef               scrap,
  211.                                  ScrapFlavorType        flavorType,
  212.                                  Size *                 byteCount,
  213.                                  void *                 destination);
  214. /*
  215.     ClearCurrentScrap clears the current scrap. Call this
  216.     first when the user requests a Copy or Cut operation --
  217.     even if you maintain a private scrap! You should not wait
  218.     until receiving a suspend event to call ClearCurrentScrap. Call
  219.     it immediately after the user requests a Copy or Cut operation.
  220.     You don't need to put any data on the scrap immediately (although
  221.     it's perfectly fine to do so). You DO need to call GetCurrentScrap
  222.     after ClearCurrentScrap so you'll have a valid ScrapRef to pass
  223.     to other functions.
  224. */
  225. EXTERN_API( OSStatus )
  226. ClearCurrentScrap               (void);
  227. /*
  228.     PutScrapFlavor is a lot like PutScrap, with two differences:
  229.     we added a ScrapRef parameter at the beginning and you can
  230.     "promise" various aspects of a flavor. If you pass a NIL
  231.     data pointer, this is a promise that in the future you
  232.     will provide data for this flavor. Provide the data
  233.     through a subsequent call to PutScrapFlavor, either later
  234.     in the same code flow or during a scrap promise keeper proc.
  235.     If you know how big the data is, you can pass the size as
  236.     well, and this may allow subsequent callers of GetScrapFlavorInfo
  237.     to avoid blocking. If you don't know the size, pass -1.
  238.     If you pass a 0 size, you are telling Scrap Manager not to
  239.     expect any data for this flavor. In this case, the flavor
  240.     data pointer is ignored. NOTE: the last time you can provide
  241.     scrap flavor data is when your scrap promise keeper gets
  242.     called. It is NOT possible to call PutScrapFlavor while
  243.     handling a suspend event; suspend events under Carbon
  244.     simply don't work the way they do under Mac OS 8.
  245. */
  246. EXTERN_API( OSStatus )
  247. PutScrapFlavor                  (ScrapRef               scrap,
  248.                                  ScrapFlavorType        flavorType,
  249.                                  ScrapFlavorFlags       flavorFlags,
  250.                                  Size                   flavorSize,
  251.                                  const void *           flavorData) /* can be NULL */;
  252. /*
  253.     ScrapPromiseKeeper is a function you write which is called by
  254.     Scrap Manager as needed to keep your earlier promise of a
  255.     particular scrap flavor. When your function is called, deliver
  256.     the requested data by calling PutScrapFlavor.
  257. */
  258. typedef CALLBACK_API( OSStatus , ScrapPromiseKeeperProcPtr )(ScrapRef scrap, ScrapFlavorType flavorType, void *userData);
  259. typedef STACK_UPP_TYPE(ScrapPromiseKeeperProcPtr)               ScrapPromiseKeeperUPP;
  260. #if OPAQUE_UPP_TYPES
  261.     EXTERN_API(ScrapPromiseKeeperUPP)
  262.     NewScrapPromiseKeeperUPP       (ScrapPromiseKeeperProcPtr userRoutine);
  263.     EXTERN_API(void)
  264.     DisposeScrapPromiseKeeperUPP    (ScrapPromiseKeeperUPP  userUPP);
  265.     EXTERN_API(OSStatus)
  266.     InvokeScrapPromiseKeeperUPP    (ScrapRef                scrap,
  267.                                     ScrapFlavorType         flavorType,
  268.                                     void *                  userData,
  269.                                     ScrapPromiseKeeperUPP   userUPP);
  270. #else
  271.     enum { uppScrapPromiseKeeperProcInfo = 0x00000FF0 };            /* pascal 4_bytes Func(4_bytes, 4_bytes, 4_bytes) */
  272.     #define NewScrapPromiseKeeperUPP(userRoutine)                   (ScrapPromiseKeeperUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppScrapPromiseKeeperProcInfo, GetCurrentArchitecture())
  273.     #define DisposeScrapPromiseKeeperUPP(userUPP)                   DisposeRoutineDescriptor(userUPP)
  274.     #define InvokeScrapPromiseKeeperUPP(scrap, flavorType, userData, userUPP)  (OSStatus)CALL_THREE_PARAMETER_UPP((userUPP), uppScrapPromiseKeeperProcInfo, (scrap), (flavorType), (userData))
  275. #endif
  276. /* support for pre-Carbon UPP routines: NewXXXProc and CallXXXProc */
  277. #define NewScrapPromiseKeeperProc(userRoutine)                  NewScrapPromiseKeeperUPP(userRoutine)
  278. #define CallScrapPromiseKeeperProc(userRoutine, scrap, flavorType, userData) InvokeScrapPromiseKeeperUPP(scrap, flavorType, userData, userRoutine)
  279. /*
  280.     SetScrapPromiseKeeper associates a ScrapPromiseKeeper with a
  281.     scrap. You can remove a ScrapPromiseKeeper from a scrap by
  282.     passing a NIL ScrapPromiseKeeper to SetScrapPromiseKeeper.
  283.     Pass whatever you like in the last parameter; its value will
  284.     be passed to your ScrapPromiseKeeper, which can do whatever
  285.     it likes with the value. You might choose to pass a pointer
  286.     or handle to some private scrap data which the
  287.     ScrapPromiseKeeper could use in fabricating one or more
  288.     promised flavors.
  289. */
  290. EXTERN_API( OSStatus )
  291. SetScrapPromiseKeeper           (ScrapRef               scrap,
  292.                                  ScrapPromiseKeeperUPP  upp,
  293.                                  const void *           userData);
  294. /*
  295.     GetScrapFlavorCount produces the number of
  296.     items which can be obtained by GetScrapFlavorInfoList.
  297. */
  298. EXTERN_API( OSStatus )
  299. GetScrapFlavorCount             (ScrapRef               scrap,
  300.                                  UInt32 *               infoCount);
  301. /*
  302.     GetScrapFlavorInfoList fills a list (array)
  303.     of items which each describe the corresponding
  304.     flavor in the scrap. It fills no more array
  305.     elements as are specified. On exit, it produces
  306.     the count of elements it filled (which may be
  307.     smaller than the count requested). Yes, YOU
  308.     must provide the memory for the array.
  309. */
  310. EXTERN_API( OSStatus )
  311. GetScrapFlavorInfoList          (ScrapRef               scrap,
  312.                                  UInt32 *               infoCount,
  313.                                  ScrapFlavorInfo        info[]);
  314. /*
  315.     CallInPromises forces all promises to be kept.
  316.     If your application promises at least one flavor
  317.     AND it does NOT adopt the new event model, you
  318.     should call this function when your application
  319.     is about to quit. If your app promises no flavors,
  320.     there is no need to call this function, and if
  321.     your app adopts the new event model, this function
  322.     will be called automagically for you. It doesn't
  323.     hurt to call this function more than once, though
  324.     promise keepers may be asked to keep promises
  325.     they already tried and failed.
  326. */
  327. EXTERN_API( OSStatus )
  328. CallInScrapPromises             (void);
  329. #if PRAGMA_STRUCT_ALIGN
  330.     #pragma options align=reset
  331. #elif PRAGMA_STRUCT_PACKPUSH
  332.     #pragma pack(pop)
  333. #elif PRAGMA_STRUCT_PACK
  334.     #pragma pack()
  335. #endif
  336. #ifdef PRAGMA_IMPORT_OFF
  337. #pragma import off
  338. #elif PRAGMA_IMPORT
  339. #pragma import reset
  340. #endif
  341. #ifdef __cplusplus
  342. }
  343. #endif
  344. #endif /* __SCRAP__ */