// **************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: http://www.gnu.org/licenses/gpl.html       *
// * Copyright (C) 2008-2010 ZenJu (zhnmju123 AT gmx.de)                    *
// **************************************************************************
//
#ifndef COM_UTILÎTY_HEADER
#define COM_UTILÎTY_HEADER

#include "com_ptr.h"
#include <string>
#include <cassert>


namespace util
{
//get an enumeration interface as a std::vector of bound(!) ComPtr(s)
template <class T, class U>
std::vector<ComPtr<T> > convertEnum(const ComPtr<U>& enumObj); //enumObj: must have the "_NewEnum" property that supports the IEnumUnknown interface

/*
extract text from com object member function returning a single BSTR:	HRESULT ComInterface::MemFun([out]  BSTR *pbstr);
	Example: ComPtr<...> comObj =...;
			 std::wstring description = getText(comObj, &IUPnPDevice::get_Description);
*/
template <class T, class MemFun>
std::wstring getText(ComPtr<T> comObj, MemFun memFun);


//RAII class handling BSTR
class Bstring
{
public:
    Bstring(const std::wstring& str);
    ~Bstring();

    const BSTR get() const;

private:
    Bstring(const Bstring&);            //not implemented
    Bstring& operator=(const Bstring&); //

    BSTR str_;
};


































//############################ inline implemenatation ##################################
template <class T, class U>
inline
std::vector<ComPtr<T> > convertEnum(const ComPtr<U>& enumObj)
{
    std::vector<ComPtr<T> > output;

    if (enumObj)
    {
        ComPtr<IUnknown> unknown;
        enumObj->get__NewEnum(unknown.init());
        ComPtr<IEnumUnknown> enumUnknown = com_dynamic_cast<IEnumUnknown>(unknown);

        assert(enumUnknown); //IEnumUnknown must be supported!
        if (enumUnknown)
        {
            ComPtr<IUnknown> itemTmp;
            while (enumUnknown->Next(1, itemTmp.init(), NULL) == S_OK) //returns S_FALSE == 1 when finished! Don't use SUCCEEDED()!!!
            {
                ComPtr<T> itemNew = com_dynamic_cast<T>(itemTmp);
                if (itemNew)
                    output.push_back(itemNew);
            }
        }
    }

    return output;
}


template <class T, class MemFun>
inline
std::wstring getText(ComPtr<T> comObj, MemFun memFun)
{
    std::wstring text;
    {
        if (!comObj)
            return std::wstring();

        BSTR bstr = NULL;
        if (FAILED((comObj.get()->*memFun)(&bstr)))
            return std::wstring();

        if (bstr) //NULL means "no text"
        {
            text = std::wstring(bstr, ::SysStringLen(bstr)); //correctly copy 0-characters
            ::SysFreeString(bstr);
        }
    }
    return text;
}


inline
Bstring::Bstring(const std::wstring& str)
{
    str_ = ::SysAllocStringLen(str.data(), str.length()); //string::data() returns unmodified string potentially containing 0-values
}


inline
Bstring::~Bstring()
{
    if (str_)
        ::SysFreeString(str_);
}


inline
const BSTR Bstring::get() const
{
    return str_;
}
}


#endif //COM_UTILÎTY_HEADER