source: trunk/synergy/lib/platform/CPMClipboard.cpp@ 2752

/*
 * synergy -- mouse and keyboard sharing utility
 * Copyright (C) 2002 Chris Schoeneman
 * Copyright (C) 2006 Knut St. Osmundsen
 * 
 * This package is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * found in the file COPYING that should have accompanied this file.
 * 
 * This package is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include "CPMClipboard.h"
#include "CPMClipboardTextConverter.h"
#include "CPMClipboardBitmapConverter.h"
#include "CPMClipboardHTMLConverter.h"
#include "CPMUtil.h"
#include "CLog.h"

//
// CPMClipboard
//

ATOM                                    CPMClipboard::s_ownershipFormat = 0;

CPMClipboard::CPMClipboard(HWND window) :
        m_window(window),
        m_time(0)
{
        // add converters, most desired first
        m_converters.push_back(new CPMClipboardTextConverter);
        m_converters.push_back(new CPMClipboardBitmapConverter);
        m_converters.push_back(new CPMClipboardHTMLConverter);
}

CPMClipboard::~CPMClipboard()
{
        clearConverters();
}

bool
CPMClipboard::emptyUnowned()
{
        LOG((CLOG_DEBUG "empty clipboard"));

        // empty the clipboard (and take ownership)
        if (!WinEmptyClipbrd(CPMUtil::getHAB())) {
                LOG((CLOG_DEBUG "failed to grab clipboard"));
                return false;
        }

        return true;
}

bool
CPMClipboard::empty()
{
        if (!emptyUnowned()) {
                return false;
        }

        // mark clipboard as being owned by synergy
    PVOID pv = NULL;
    APIRET rc = DosAllocSharedMem(&pv, NULL, 1, PAG_READ | PAG_WRITE | PAG_COMMIT | OBJ_GETTABLE | OBJ_GIVEABLE);
    if (rc) {
        assert(rc);
        return false;
    }
        return !!WinSetClipbrdData(CPMUtil::getHAB(), (ULONG)pv, getOwnershipFormat(), CFI_POINTER);
}

void
CPMClipboard::add(EFormat format, const CString& data)
{
        LOG((CLOG_DEBUG "add %d bytes to clipboard format: %d", data.size(), format));

        // convert data to win32 form
        for (ConverterList::const_iterator index = m_converters.begin();
                 index != m_converters.end();
                 ++index) {
                IPMClipboardConverter* converter = *index;

                // skip converters for other formats
                if (converter->getFormat() == format) {
                        ULONG ulPMData = converter->fromIClipboard(data);
                        if (ulPMData != NULL) {
                                ULONG ulPMFormat = converter->getPMFormat();
                ULONG ulPMFormatInfo = converter->getPMFormatInfo();
                                if (!WinSetClipbrdData(CPMUtil::getHAB(), ulPMData, ulPMFormat, ulPMFormatInfo)) {
                                        // free converted data if we couldn't put it on the clipboard
                    converter->freePMData(ulPMData);
                                }
                        }
                }
        }
}

bool
CPMClipboard::open(Time time) const
{
        LOG((CLOG_DEBUG "open clipboard"));

        if (!WinOpenClipbrd(m_window)) {
                LOG((CLOG_WARN "failed to open clipboard"));
                return false;
        }

        m_time = time;

        return true;
}

void
CPMClipboard::close() const
{
        LOG((CLOG_DEBUG "close clipboard"));
        WinCloseClipbrd(CPMUtil::getHAB());
}

IClipboard::Time
CPMClipboard::getTime() const
{
        return m_time;
}

bool
CPMClipboard::has(EFormat format) const
{
        for (ConverterList::const_iterator index = m_converters.begin();
                 index != m_converters.end();
                 ++index) {
                IPMClipboardConverter* converter = *index;
                if (converter->getFormat() == format) {
            ULONG fFmtInfo;
                        if (WinQueryClipbrdFmtInfo(CPMUtil::getHAB(), getOwnershipFormat(), &fFmtInfo)) {
                                return true;
                        }
                }
        }
        return false;
}

CString
CPMClipboard::get(EFormat format) const
{
        // find the converter for the first clipboard format we can handle
        IPMClipboardConverter* converter = NULL;
        ULONG pmFormat = WinEnumClipbrdFmts(CPMUtil::getHAB(), 0);
        while (converter == NULL && pmFormat != 0) {
                for (ConverterList::const_iterator index = m_converters.begin();
                         index != m_converters.end(); 
             ++index) {
                        converter = *index;
                        if (converter->getPMFormat() == pmFormat &&
                                converter->getFormat()   == format) {
                                break;
                        }
                        converter = NULL;
                }
                pmFormat = WinEnumClipbrdFmts(CPMUtil::getHAB(), pmFormat);
        }

        // if no converter then we don't recognize any formats
        if (converter == NULL) {
                return CString();
        }

        // get a handle to the clipboard data
        ULONG ulData = WinQueryClipbrdData(CPMUtil::getHAB(), converter->getPMFormat());
        if (ulData == 0) {
                return CString();
        }

        // convert
        return converter->toIClipboard(ulData);
}

void
CPMClipboard::clearConverters()
{
        for (ConverterList::iterator index = m_converters.begin();
                 index != m_converters.end();
                 ++index) {
                delete *index;
        }
        m_converters.clear();
}

bool
CPMClipboard::isOwnedBySynergy()
{
    ULONG fFmtInfo;
        return (!!WinQueryClipbrdFmtInfo(CPMUtil::getHAB(), getOwnershipFormat(), &fFmtInfo));
}

ATOM
CPMClipboard::getOwnershipFormat()
{
        // create ownership format if we haven't yet
        if (s_ownershipFormat == 0) {
        ATOM hAtom = WinAddAtom(WinQuerySystemAtomTable(), (PCSZ)"SynergyOwnership");
        if (hAtom == 0)
            hAtom = WinFindAtom(WinQuerySystemAtomTable(), (PCSZ)"SynergyOwnership");
        assert(hAtom != 0);
        s_ownershipFormat = hAtom;
        }

        // return the format
        return s_ownershipFormat;
}