php-src/ext/com_dotnet/com_iterator.c

/*
   +----------------------------------------------------------------------+
   | PHP Version 4                                                        |
   +----------------------------------------------------------------------+
   | Copyright (c) 1997-2003 The PHP Group                                |
   +----------------------------------------------------------------------+
   | This source file is subject to version 3.0 of the PHP license,       |
   | that is bundled with this package in the file LICENSE, and is        |
   | available through the world-wide-web at the following url:           |
   | http://www.php.net/license/3_0.txt.                                  |
   | If you did not receive a copy of the PHP license and are unable to   |
   | obtain it through the world-wide-web, please send a note to          |
   | license@php.net so we can mail you a copy immediately.               |
   +----------------------------------------------------------------------+
   | Author: Wez Furlong <wez@thebrainroom.com>                           |
   +----------------------------------------------------------------------+
 */

/* $Id$ */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "php.h"
#include "php_ini.h"
#include "ext/standard/info.h"
#include "php_com_dotnet.h"
#include "php_com_dotnet_internal.h"
#include "Zend/zend_default_classes.h"

struct php_com_iterator {
	zend_object_iterator iter;
	IEnumVARIANT *ev;
	ulong key;
	VARIANT v;
	int code_page;
};

static void com_iter_dtor(zend_object_iterator *iter TSRMLS_DC)
{
	struct php_com_iterator *I = (struct php_com_iterator*)iter->data;
	
	if (I->ev) {
		IEnumVARIANT_Release(I->ev);
	}
	VariantClear(&I->v);
	efree(I);
}

static int com_iter_has_more(zend_object_iterator *iter TSRMLS_DC)
{
	struct php_com_iterator *I = (struct php_com_iterator*)iter->data;

	if (I->key == (ulong)-1) {
		return FAILURE;
	}
	return SUCCESS;
}

static void com_iter_get_data(zend_object_iterator *iter, zval ***data TSRMLS_DC)
{
	struct php_com_iterator *I = (struct php_com_iterator*)iter->data;
	zval **ptr_ptr;
	zval *ptr;

	if (I->key == (ulong)-1) {
		*data = NULL;
		return FAILURE;
	}

	MAKE_STD_ZVAL(ptr);
	php_com_wrap_variant(ptr, &I->v, I->code_page TSRMLS_CC);
	ptr_ptr = emalloc(sizeof(*ptr_ptr));
	*ptr_ptr = ptr;
	*data = ptr_ptr;

	return SUCCESS;
}

static int com_iter_get_key(zend_object_iterator *iter, char **str_key, uint *str_key_len,
	ulong *int_key TSRMLS_DC)
{
	struct php_com_iterator *I = (struct php_com_iterator*)iter->data;

	if (I->key == (ulong)-1) {
		return HASH_KEY_NON_EXISTANT;
	}
	*int_key = I->key;
	return HASH_KEY_IS_LONG;
}

static int com_iter_move_forwards(zend_object_iterator *iter TSRMLS_DC)
{
	struct php_com_iterator *I = (struct php_com_iterator*)iter->data;
	unsigned long n_fetched;

	/* release current cached element */
	VariantClear(&I->v);
	
	/* Get the next element */
	if (SUCCEEDED(IEnumVARIANT_Next(I->ev, 1, &I->v, &n_fetched)) && n_fetched > 0) {
		I->key++;
		return SUCCESS;
	} else {
		/* indicate that there are no more items */
		I->key = (ulong)-1;
		return FAILURE;
	}
}


static zend_object_iterator_funcs com_iter_funcs = {
	com_iter_dtor,
	NULL, /* rewind */
	com_iter_has_more,
	com_iter_get_data,
	com_iter_get_key,
	com_iter_move_forwards
};

zend_object_iterator *php_com_iter_get(zend_class_entry *ce, zval *object TSRMLS_DC)
{
	php_com_dotnet_object *obj;
	struct php_com_iterator *I;
	IEnumVARIANT *iev = NULL;
	DISPPARAMS dp;
	VARIANT v;
	unsigned long n_fetched;

	obj = CDNO_FETCH(object);

	/* TODO: support enumerating through SafeArrays */
	if (V_VT(&obj->v) != VT_DISPATCH) {
		return NULL;
	}

	memset(&dp, 0, sizeof(dp));
	VariantInit(&v);	

	/* can we enumerate it? */
	if (FAILED(IDispatch_Invoke(V_DISPATCH(&obj->v), DISPID_NEWENUM,
			&IID_NULL, LOCALE_SYSTEM_DEFAULT, DISPATCH_METHOD|DISPATCH_PROPERTYGET,
			&dp, &v, NULL, NULL))) {
		return NULL;
	}

	/* get something useful out of it */
	if (V_VT(&v) == VT_UNKNOWN) {
		IUnknown_QueryInterface(V_UNKNOWN(&v), &IID_IEnumVARIANT, (void**)&iev);
	} else if (V_VT(&v) == VT_DISPATCH) {
		IDispatch_QueryInterface(V_DISPATCH(&v), &IID_IEnumVARIANT, (void**)&iev);
	}

	VariantClear(&v);

	if (iev == NULL) {
		return NULL;
	}
	
	I = (struct php_com_iterator*)ecalloc(1, sizeof(*I));
	I->iter.funcs = &com_iter_funcs;
	I->iter.data = I;
	I->ev = iev;
	I->code_page = obj->code_page;

	/* Get the first element now */
	if (SUCCEEDED(IEnumVARIANT_Next(I->ev, 1, &I->v, &n_fetched)) && n_fetched > 0) {
		/* indicate that we have element 0 */
		I->key = 0;
	} else {
		/* indicate that there are no more items */
		I->key = (ulong)-1;
	}

	return &I->iter;
}