gecko/widget/xpwidgets/nsTransferable.h
Ehsan Akhgari a95b6edeea Bug 722872 - Part 1: Add nsITransferable::Init(nsILoadContext*), enforce that it's called in debug builds, and add nsIDOMDocument* arguments to nsIClipboardHelper methods; r=roc
This patch does the following:

* It adds nsITransferable::Init(nsILoadContext*).  The load context
  might be null, which means that the transferable is non-private, but
  if it's non-null, we extract the boolean value for the privacy mode
  and store it in the transferable.
* It adds checks in debug builds to make sure that Init is always
  called, in form of fatal assertions.
* It adds nsIDOMDocument* agruments to nsIClipboardHelper methods which
  represent the document that the string is coming from.
  nsIClipboardHelper implementation internally gets the nsILoadContext
  from that and passes it on to the transferable upon creation.  The
  reason that I did this was that nsIClipboardHelper is supposed to be a
  high-level helper, and in most of its call sites, we have easy access
  to a document object.
* It modifies all of the call sites of the above interfaces according to
  this change.
* It adds a GetLoadContext helper to nsIDocument to help with changing
  the call sites.
2012-04-16 22:14:01 -04:00

83 lines
2.0 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef nsTransferable_h__
#define nsTransferable_h__
#include "nsIFormatConverter.h"
#include "nsITransferable.h"
#include "nsCOMPtr.h"
#include "nsString.h"
#include "nsTArray.h"
class nsString;
class nsDataObj;
//
// DataStruct
//
// Holds a flavor (a mime type) that describes the data and the associated data.
//
struct DataStruct
{
DataStruct ( const char* aFlavor )
: mDataLen(0), mFlavor(aFlavor), mCacheFileName(nsnull) { }
~DataStruct();
const nsCString& GetFlavor() const { return mFlavor; }
void SetData( nsISupports* inData, PRUint32 inDataLen );
void GetData( nsISupports** outData, PRUint32 *outDataLen );
nsIFile * GetFileSpec(const char * aFileName);
bool IsDataAvailable() const { return (mData && mDataLen > 0) || (!mData && mCacheFileName); }
protected:
enum {
// The size of data over which we write the data to disk rather than
// keep it around in memory.
kLargeDatasetSize = 1000000 // 1 million bytes
};
nsresult WriteCache(nsISupports* aData, PRUint32 aDataLen );
nsresult ReadCache(nsISupports** aData, PRUint32* aDataLen );
nsCOMPtr<nsISupports> mData; // OWNER - some varient of primitive wrapper
PRUint32 mDataLen;
const nsCString mFlavor;
char * mCacheFileName;
};
/**
* XP Transferable wrapper
*/
class nsTransferable : public nsITransferable
{
public:
nsTransferable();
virtual ~nsTransferable();
// nsISupports
NS_DECL_ISUPPORTS
NS_DECL_NSITRANSFERABLE
protected:
// get flavors w/out converter
nsresult GetTransferDataFlavors(nsISupportsArray** aDataFlavorList);
nsTArray<DataStruct> mDataArray;
nsCOMPtr<nsIFormatConverter> mFormatConv;
bool mPrivateData;
#if DEBUG
bool mInitialized;
#endif
};
#endif // nsTransferable_h__