python/src/PyISimpleEnumerator.cpp

16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync/* ***** BEGIN LICENSE BLOCK *****
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * Version: MPL 1.1/GPL 2.0/LGPL 2.1
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync *
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * The contents of this file are subject to the Mozilla Public License Version
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * 1.1 (the "License"); you may not use this file except in compliance with
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * the License. You may obtain a copy of the License at
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * http://www.mozilla.org/MPL/
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync *
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * Software distributed under the License is distributed on an "AS IS" basis,
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * for the specific language governing rights and limitations under the
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * License.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync *
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * The Original Code is the Python XPCOM language bindings.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync *
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * The Initial Developer of the Original Code is
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * ActiveState Tool Corp.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * Portions created by the Initial Developer are Copyright (C) 2000
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * the Initial Developer. All Rights Reserved.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync *
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * Contributor(s):
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync *   Mark Hammond <MarkH@ActiveState.com> (original author)
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync *
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * Alternatively, the contents of this file may be used under the terms of
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * either the GNU General Public License Version 2 or later (the "GPL"), or
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * in which case the provisions of the GPL or the LGPL are applicable instead
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * of those above. If you wish to allow use of your version of this file only
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * under the terms of either the GPL or the LGPL, and not to allow others to
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * use your version of this file under the terms of the MPL, indicate your
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * decision by deleting the provisions above and replace them with the notice
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * and other provisions required by the GPL or the LGPL. If you do not delete
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * the provisions above, a recipient may use your version of this file under
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * the terms of any one of the MPL, the GPL or the LGPL.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync *
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync * ***** END LICENSE BLOCK ***** */
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync//
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync// This code is part of the XPCOM extensions for Python.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync//
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync// Written May 2000 by Mark Hammond.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync//
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync// Based heavily on the Python COM support, which is
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync// (c) Mark Hammond and Greg Stein.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync//
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync// (c) 2000, ActiveState corp.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync#include "PyXPCOM_std.h"
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync#include <nsISimpleEnumerator.h>
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsyncstatic nsISimpleEnumerator *GetI(PyObject *self) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsIID iid = NS_GET_IID(nsISimpleEnumerator);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (!Py_nsISupports::Check(self, iid)) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        PyErr_SetString(PyExc_TypeError, "This object is not the correct interface");
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    }
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    return (nsISimpleEnumerator *)Py_nsISupports::GetI(self);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync}
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsyncstatic PyObject *PyHasMoreElements(PyObject *self, PyObject *args)
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync{
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (!PyArg_ParseTuple(args, ":HasMoreElements"))
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsISimpleEnumerator *pI = GetI(self);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (pI==NULL)
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsresult r;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    PRBool more;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    Py_BEGIN_ALLOW_THREADS;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    r = pI->HasMoreElements(&more);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    Py_END_ALLOW_THREADS;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if ( NS_FAILED(r) )
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return PyXPCOM_BuildPyException(r);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    return PyInt_FromLong(more);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync}
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsyncstatic PyObject *PyGetNext(PyObject *self, PyObject *args)
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync{
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    PyObject *obIID = NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (!PyArg_ParseTuple(args, "|O:GetNext", &obIID))
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsIID iid(NS_GET_IID(nsISupports));
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (obIID != NULL && !Py_nsIID::IIDFromPyObject(obIID, &iid))
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsISimpleEnumerator *pI = GetI(self);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (pI==NULL)
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsISupports *pRet = nsnull;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsresult r;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    Py_BEGIN_ALLOW_THREADS;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    r = pI->GetNext(&pRet);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    Py_END_ALLOW_THREADS;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if ( NS_FAILED(r) )
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return PyXPCOM_BuildPyException(r);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (obIID) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        nsISupports *temp;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        Py_BEGIN_ALLOW_THREADS;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        r = pRet->QueryInterface(iid, (void **)&temp);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        pRet->Release();
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        Py_END_ALLOW_THREADS;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        if ( NS_FAILED(r) ) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            return PyXPCOM_BuildPyException(r);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        }
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        pRet = temp;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    }
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    PyObject *ret = Py_nsISupports::PyObjectFromInterface(pRet, iid);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    NS_IF_RELEASE(pRet);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    return ret;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync}
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync// A method added for Python performance if you really need
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync// it.  Allows you to fetch a block of objects in one
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync// hit, allowing the loop to remain implemented in C.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsyncstatic PyObject *PyFetchBlock(PyObject *self, PyObject *args)
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync{
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    PyObject *obIID = NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    int n_wanted;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    int n_fetched = 0;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (!PyArg_ParseTuple(args, "i|O:FetchBlock", &n_wanted, &obIID))
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsIID iid(NS_GET_IID(nsISupports));
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (obIID != NULL && !Py_nsIID::IIDFromPyObject(obIID, &iid))
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsISimpleEnumerator *pI = GetI(self);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (pI==NULL)
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    // We want to fetch with the thread-lock released,
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    // but this means we can not append to the PyList
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsISupports **fetched = new nsISupports*[n_wanted];
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (fetched==nsnull) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        PyErr_NoMemory();
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        return NULL;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    }
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    memset(fetched, 0, sizeof(nsISupports *) * n_wanted);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    nsresult r = NS_OK;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    PRBool more;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    Py_BEGIN_ALLOW_THREADS;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    for (;n_fetched<n_wanted;) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        r = pI->HasMoreElements(&more);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        if (NS_FAILED(r))
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            break; // this _is_ an error!
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        if (!more)
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            break; // Normal enum end.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        nsISupports *pNew;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        r = pI->GetNext(&pNew);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        if (NS_FAILED(r)) // IS an error
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            break;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        if (obIID) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            nsISupports *temp;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            r = pNew->QueryInterface(iid, (void **)&temp);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            pNew->Release();
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            if ( NS_FAILED(r) ) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync                break;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            }
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            pNew = temp;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        }
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        fetched[n_fetched] = pNew;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        n_fetched++;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    }
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    Py_END_ALLOW_THREADS;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    PyObject *ret;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if (NS_SUCCEEDED(r)) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        ret = PyList_New(n_fetched);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        if (ret)
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            for (int i=0;i<n_fetched;i++) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync                PyObject *new_ob = Py_nsISupports::PyObjectFromInterface(fetched[i], iid);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync                NS_IF_RELEASE(fetched[i]);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync                PyList_SET_ITEM(ret, i, new_ob);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            }
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    } else
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        ret = PyXPCOM_BuildPyException(r);
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    if ( ret == NULL ) {
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        // Free the objects we consumed.
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync        for (int i=0;i<n_fetched;i++)
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync            fetched[i]->Release();
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    }
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    delete [] fetched;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    return ret;
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync}
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsyncstruct PyMethodDef
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsyncPyMethods_ISimpleEnumerator[] =
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync{
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    { "HasMoreElements", PyHasMoreElements, 1},
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    { "hasMoreElements", PyHasMoreElements, 1},
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    { "GetNext", PyGetNext, 1},
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    { "getNext", PyGetNext, 1},
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    { "FetchBlock", PyFetchBlock, 1},
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    { "fetchBlock", PyFetchBlock, 1},
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync    {NULL}
16a8d09569a2ebd598cef72fa605be6fb4563607vboxsync};