SoXtClipboard.h

Go to the documentation of this file.

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : David Mott (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifdef _WIN32
#  include <Inventor/Win/SoWinClipboard.h>
#else // _WIN32
 
#ifndef  _SO_XT_CLIPBOARD_
#define  _SO_XT_CLIPBOARD_
 
#include <X11/Xatom.h>
#include <X11/Intrinsic.h>
#include <Inventor/SbBasic.h>
#include <Inventor/Xt/SoXtDef.h>
 
class SbDict;
class SoByteStream;
class SoNode;
class SoPath;
class SoPathList;
class SoSelection;
class SoXtImportInterestList;
class SbString;
class SbPList;
 
 
// callback function prototypes
typedef void SoXtClipboardPasteCB(void *userData, SoPathList *pathList);
typedef void SoXtClipboardImportCB(
                                   void *userData,
                                   Atom dataType,
                                   void *data,
                                   uint32_t numBytes);
 
 
// The CLIPBOARD selection atom is not a predefined atom in X11 R4.
// However, it is widely recognized. We define it to 0 here for
// convenience. Internally, when SoXtClipboard sees _XA_CLIPBOARD_,
// it will use XInternAtom(d, "CLIPBOARD", False).
 
#define _XA_CLIPBOARD_ ((Atom) 0)
 
//
//  Class: SoXtClipboard
//
//
 
class  SoXtClipboard {
 public:
  // Constructor.
  // The selection atom determines which X selection atom data transfers
  // should happen through. Default is _XA_CLIPBOARD_. (wsh uses XA_PRIMARY).
 
  SoXtClipboard(SoWidget w, Atom selectionAtom = _XA_CLIPBOARD_);
 
  ~SoXtClipboard();
 
  void    copy(SoNode *node, Time eventTime);
 
  void    copy(SoPath *path, Time eventTime);
 
  void    copy(SoPathList *pathList, Time eventTime);
 
  // This copies non-Inventor data to the clipboard
  void    copy(Atom dataType, void *data, uint32_t numBytes, Time eventTime);
 
  void    paste(Time eventTime,
                SoXtClipboardPasteCB *pasteDoneFunc,
                void *userData = NULL);
 
  // This extends the paste interest to recognize an additional target as
  // specified by 'dataType'. The pasteImportFunc will be called when this
  // type of data is pasted. This may be called multiple times to register
  // interest in more than one extension.
  //
  // Passing NULL as the pasteImportFunc will remove paste interest for that
  // data type (even if the data type is one of the defaults).
  //
  // This should be called before paste() so that paste() will look for data
  // types that have been specified here.
  //
  // The dataType atom can be created with XmInternAtom, e.g.:
  //     XmInternAtom(XtDisplay(widget),"INVENTOR",False);
  //
  // The order is important - first things added to the list are the first
  // things searched for at paste time. (The default interest types come first.)
 
  void            addPasteInterest(
                                   Atom dataType,
                                   SoXtClipboardImportCB *pasteImportFunc,
                                   void *userData = NULL);
 
 private:
 
  // Convert the passed Inventor 2.1 data to a different format, specified by
  // the Atom desiredType. The data will be malloc'd here and placed in returnData,
  // with returnNumBytes describing the data length. This returns TRUE if successful.
  static SbBool  convertData(
                             SoWidget      widget,
                             void        *srcData,
                             uint32_t    srcNumBytes,
                             Atom        desiredType,
                             char        **returnData,
                             uint32_t    *returnNumBytes);
 
 private:
  // Sets a flag indicating whether the paste callback can and
  // should be passed an empty path list after a paste request is
  // made. For compatibility, this flag is FALSE by default, meaning
  // that the callback will never be invoked with an empty path list.
  void        setEmptyListOK(SbBool flag)     { emptyListOK = flag; }
  SbBool      isEmptyListOK() const           { return emptyListOK; }
 
 private:
  SoWidget      widget;         // the widget to associated data with
  Atom        clipboardAtom;  // which selection: XA_PRIMARY, XA_SECONDARY, etc.
  Time        eventTime;      // time of the event which caused the copy/paste
 
  // Paste callback info
  SoXtClipboardPasteCB    *callbackFunc;
  void                    *userData;
 
  // There can only be one owner of each X selection at any one time.
  // We use the selection atom as the key, and 'this' as the data.
  // We set the owner for each selection in this list for exportSelection.
  static SbDict           *selOwnerList;
 
  // All the overloaded copy functions call this one.
  void                    copy(SoByteStream *byteStream, Time t);
 
  // This describes what data types we look for during paste.
  SoXtImportInterestList  *pasteInterest;
  SbPList                 *copyInterest;
 
  // This is called by exportSelection
  void                    getExportTargets(
                                           char        **value,
                                           uint32_t    *length);
 
  Atom                    chooseFromImportTargets(
                                                  Atom *supportedTargets,
                                                  int length);
 
  static SbBool           writeToFile(
                                      SbString    &tmpfile,
                                      void        *srcData,
                                      uint32_t    srcNumBytes);
 
  // Read the file if it is in Inventor format and add its data to the pathList.
  static void     readFile(SoPathList *&pathList, const char *filename);
 
  // Read target data we just imported via paste or drop if it is in Inventor format.
  // This returns a newly allocated path list. This will free data when done.
  static SoPathList *readData(
                              SoWidget w,
                              Atom target,
                              void *data,
                              uint32_t numBytes);
 private:
  SoByteStream            *copyBuffer;        // copy/paste storage buffer
  Atom                    copyDataType;
  SbBool                  emptyListOK;
 
  // This handles the default cases of paste
  void            pasteImport(Atom dataType, void *data, uint32_t numBytes);
  static void     pasteImportCB(
                                void *userData, Atom dataType,
                                void *data, uint32_t numBytes)
    { ((SoXtClipboard *)userData)->pasteImport(dataType, data, numBytes); }
 
  // Copy and paste callback functions - these are called by the X server.
  // importSelection is called when we import data to paste.
  // exportSelection is called when we send data for someone else to paste.
  // loseSelection is called when we no longer own the selection.
  static void         importSelection(
                                      SoWidget              w,
                                      SoXtClipboard       *clipboard,
                                      Atom                *selAtom,
                                      Atom                *type,
                                      char                *value,
                                      uint32_t    *length,
                                      int                 *format);
 
  static Boolean      exportSelection(
                                      SoWidget              w,
                                      Atom                *xselection,
                                      Atom                *target,
                                      Atom                *type,
                                      char                **value,
                                      uint32_t    *length,
                                      int                 *format);
 
  static void         loseSelection(
                                    SoWidget              w,
                                    Atom                *xselection);
 
  static void         importSelectionTargets(
                                             SoWidget              w,
                                             SoXtClipboard       *clipboard,
                                             Atom                *selAtom,
                                             Atom                *type,
                                             char                *value,
                                             uint32_t    *length,
                                             int                 *format);
 
};
 
#endif /* _SO_XT_CLIPBOARD_ */
 
#endif // _WIN32