mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
7f9a65862b37ee1fa596916ceb7c243e04612499
libreoffice/pyuno/source/module/pyuno_iterator.cxx

313 lines
7.4 KiB
C++
Raw Normal View History

Make PyUNO provide more Pythonic behaviour - Simplifies working with UNO objects by giving the behaviour of Python lists, dicts and iterators to objects which implement UNO container interfaces - Applies a custom behaviour to allow objects which implement com::sun::star::table::XCellRange to yield cells and cell ranges by subscript - When UNO container objects are addressed in the new style, eliminates the requirement to manually construct Any objects for contained elements which are typed sequences - Allows lists and iterators to be passed wherever a UNO method accepts a sequence - Relaxes the requirements for initialising UNO structs to allow some members to be skipped when all initialisers are passed by name 1. Collection interfaces ======================== Objects which implement core UNO collection interfaces are made to behave in a way that is more natural for Python code. com::sun::star::container::XIndexAccess com::sun::star::container::XIndexReplace com::sun::star::container::XIndexContainer - Objects provide Python list access semantics num = len(obj) # Number of elements val = obj[0] # Access by index val1,val2 = obj[2:4] # Access by slice val1,val2 = obj[0:3:2] # Access by extended slice if val in obj: ... # Test value presence for val in obj: ... # Implicit iterator (values) itr = iter(obj) # Named iterator (values) obj[0] = val # Replace by index obj[2:4] = val1,val2 # Replace by slice obj[0:3:2] = val1,val2 # Replace by extended slice obj[2:3] = val1,val2 # Insert/replace by slice obj[2:2] = (val,) # Insert by slice obj[2:4] = (val,) # Replace/delete by slice obj[2:3] = () # Delete by slice (implicit) del obj[0] # Delete by index del obj[2:4] # Delete by slice com::sun::star::container::XNameAccess com::sun::star::container::XNameReplace com::sun::star::container::XNameContainer - Objects provide Python dict access semantics num = len(obj) # Number of keys val = obj[key] # Access by key if key in obj: ... # Test key presence for key in obj: ... # Implicit iterator (keys) itr = iter(obj) # Named iterator (keys) obj[key] = val # Replace by key obj[key] = val # Insert by key del obj[key] # Delete by key com::sun::star::container::XEnumerationAccess - Objects provide Python iterable semantics for val in obj: ... # Implicit iterator itr = iter(obj) # Named iterator com::sun::star::container::XEnumeration - Objects provide Python iterator semantics for val in itr: ... # Iteration of named iterator if val in itr: ... # Test value presence Objects which implement both XIndex* and XName* are supported, and respond to both integer and string keys. However, iterating over such an object will return the keys (like a Python dict) rather than the values (like a Python list). 2. Cell ranges ============== A custom behaviour is applied to objects which implement com::sun::star::table::XCellRange to allow their cells and cell ranges to be addressed by subscript, in the style of a Python list or dict (read-only). This is applicable to Calc spreadsheet sheets, Writer text tables and cell ranges created upon these. cell = cellrange[0,0] # Access cell by indices rng = cellrange[0,1:2] # Access cell range by index,slice rng = cellrange[1:2,0] # Access cell range by slice,index rng = cellrange[0:1,2:3] # Access cell range by slices rng = cellrange['A1:B2'] # Access cell range by descriptor rng = cellrange['Name'] # Access cell range by name Note that the indices used are in Python/C order, and differ from the arguments to methods provided by XCellRange. - The statement cellrange[r,c], which returns the cell from row r and column c, is equivalent to calling XCellRange::getCellByPosition(c,r) - The statement cellrange[t:b,l:r], which returns a cell range covering rows t to b(non-inclusive) and columns l to r(non- inclusive), is equivalent to calling XCellRange::getCellRangeByPosition(l,t,r-1,b-1). In contrast to the handling of objects implementing XIndex*, extended slice syntax is not supported. Negative indices (from-end addresses) are supported only for objects which also implement com::sun::star::table::XColumnRowRange (currently Calc spreadsheet sheets and cell ranges created upon these). For such objects, the following syntax is also available: rng = cellrange[0] # Access cell range by row index rng = cellrange[0,:] # Access cell range by row index rng = cellrange[:,0] # Access cell range by column index 3. Elimination of explicit Any ============================== PyUNO has not previously been able to cope with certain method arguments which are typed as Any but require a sequence of specific type to be passed. This is a particular issue for container interfaces such as XIndexContainer and XNameContainer. The existing solution to dealing with such methods is to use a special method to pass an explicitly typed Any, giving code such as: index = doc.createInstance("com.sun.star.text.ContentIndex"); ... uno.invoke( index.LevelParagraphStyles , "replaceByIndex", (0, uno.Any("[]string", ('Caption',))) ) The new Pythonic container access is able to correctly infer the expected type of the sequences required by these arguments. In the new style, the above call to .replaceByIndex() can instead be written: index.LevelParagraphStyles[0] = ('Caption',) 4. List and iterator arguments ============================== Wherever a UNO API expects a sequence, a Python list or iterator can now be passed. This enables the use of list comprehensions and generator expressions for method calls and property assignments. Example: tbl = doc.createInstance('com.sun.star.text.TextTable') tbl.initialize(10,10) # ... insert table ... # Assign numbers 0..99 to the cells using a generator expression tbl.Data = ((y for y in range(10*x,10*x + 10)) for x in range(10)) 5. Tolerant struct initialisation ================================= Previously, a UNO struct could be created fully uninitialised, or by passing a combination of positional and/or named arguments to its constructor. However, if any arguments were passed, all members were required to be initialised or an exception was thrown. This requirement is relaxed such that when all arguments passed to a struct constructor are by name, some may be omitted. The existing requirement that all members must be explicitly initialised when some constructor arguments are unnamed (positional) is not affected. Example: from com.sun.star.beans import PropertyValue prop = PropertyValue(Name='foo', Value='bar') Change-Id: Id29bff10a18099b1a00af1abee1a6c1bc58b3978 Reviewed-on: https://gerrit.libreoffice.org/16272 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Matthew Francis <mjay.francis@gmail.com>
2015-06-01 18:34:04 +08:00
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* 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/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <sal/config.h>
#include <cassert>
#include "pyuno_impl.hxx"
#include <com/sun/star/container/XEnumeration.hpp>
#include <com/sun/star/container/XIndexAccess.hpp>
#include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
#include <com/sun/star/lang/WrappedTargetException.hpp>
using com::sun::star::container::XEnumeration;
using com::sun::star::container::XIndexAccess;
using com::sun::star::lang::IndexOutOfBoundsException;
using com::sun::star::lang::WrappedTargetException;
using com::sun::star::uno::Any;
using com::sun::star::uno::Reference;
using com::sun::star::uno::RuntimeException;
using com::sun::star::uno::UNO_QUERY;
namespace pyuno
{
void PyUNO_iterator_del( PyObject* self )
{
PyUNO_iterator* me = reinterpret_cast<PyUNO_iterator*>(self);
{
PyThreadDetach antiguard;
delete me->members;
}
PyObject_Del( self );
}
PyObject* PyUNO_iterator_iter( PyObject *self )
{
Py_INCREF( self );
return self;
}
PyObject* PyUNO_iterator_next( PyObject *self )
{
PyUNO_iterator* me = reinterpret_cast<PyUNO_iterator*>(self);
Runtime runtime;
sal_Bool hasMoreElements = sal_False;
Any aRet;
try
{
{
PyThreadDetach antiguard;
hasMoreElements = me->members->xEnumeration->hasMoreElements();
if ( hasMoreElements )
{
aRet = me->members->xEnumeration->nextElement();
}
}
if ( hasMoreElements )
{
PyRef rRet = runtime.any2PyObject( aRet );
return rRet.getAcquired();
}
PyErr_SetString( PyExc_StopIteration, "" );
return NULL;
}
catch( com::sun::star::container::NoSuchElementException &e )
{
raisePyExceptionWithAny( com::sun::star::uno::makeAny( e ) );
}
catch( com::sun::star::script::CannotConvertException &e )
{
raisePyExceptionWithAny( com::sun::star::uno::makeAny( e ) );
}
catch( com::sun::star::lang::IllegalArgumentException &e )
{
raisePyExceptionWithAny( com::sun::star::uno::makeAny( e ) );
}
catch( const ::com::sun::star::lang::WrappedTargetException &e )
{
raisePyExceptionWithAny( com::sun::star::uno::makeAny( e ) );
}
catch( const ::com::sun::star::uno::RuntimeException &e )
{
raisePyExceptionWithAny( com::sun::star::uno::makeAny( e ) );
}
return NULL;
}
static PyTypeObject PyUNO_iterator_Type =
{
PyVarObject_HEAD_INIT( &PyType_Type, 0 )
"PyUNO_iterator",
sizeof (PyUNO_iterator),
0,
PyUNO_iterator_del,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
Py_TPFLAGS_HAVE_ITER,
nullptr,
nullptr,
nullptr,
nullptr,
0,
PyUNO_iterator_iter, // Generic, reused between the iterator types
PyUNO_iterator_next,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
0,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
0
#if PY_VERSION_HEX >= 0x03040000
, nullptr
#endif
};
PyObject* PyUNO_iterator_new( const Reference< XEnumeration > xEnumeration )
{
PyUNO_iterator* self = PyObject_New( PyUNO_iterator, &PyUNO_iterator_Type );
if ( self == NULL )
return NULL; // == error
self->members = new PyUNO_iterator_Internals();
self->members->xEnumeration = xEnumeration;
return reinterpret_cast<PyObject*>(self);
}
///////////////////////////////////////////////////////////////////////////////
void PyUNO_list_iterator_del( PyObject* self )
{
PyUNO_list_iterator* me = reinterpret_cast<PyUNO_list_iterator*>(self);
{
PyThreadDetach antiguard;
delete me->members;
}
PyObject_Del( self );
}
PyObject* PyUNO_list_iterator_next( PyObject *self )
{
PyUNO_list_iterator* me = reinterpret_cast<PyUNO_list_iterator*>(self);
Runtime runtime;
Any aRet;
bool noMoreElements = false;
try
{
{
PyThreadDetach antiguard;
try {
aRet = me->members->xIndexAccess->getByIndex( me->members->index );
}
catch( com::sun::star::lang::IndexOutOfBoundsException )
{
noMoreElements = true;
}
}
if ( noMoreElements )
{
PyErr_SetString( PyExc_StopIteration, "" );
return NULL;
}
PyRef rRet = runtime.any2PyObject( aRet );
me->members->index++;
return rRet.getAcquired();
}
catch( com::sun::star::script::CannotConvertException &e )
{
raisePyExceptionWithAny( com::sun::star::uno::makeAny( e ) );
}
catch( com::sun::star::lang::IllegalArgumentException &e )
{
raisePyExceptionWithAny( com::sun::star::uno::makeAny( e ) );
}
catch( const ::com::sun::star::lang::WrappedTargetException &e )
{
raisePyExceptionWithAny( com::sun::star::uno::makeAny( e ) );
}
catch( const ::com::sun::star::uno::RuntimeException &e )
{
raisePyExceptionWithAny( com::sun::star::uno::makeAny( e ) );
}
return NULL;
}
static PyTypeObject PyUNO_list_iterator_Type =
{
PyVarObject_HEAD_INIT( &PyType_Type, 0 )
"PyUNO_iterator",
sizeof (PyUNO_list_iterator),
0,
PyUNO_list_iterator_del,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
Py_TPFLAGS_HAVE_ITER,
nullptr,
nullptr,
nullptr,
nullptr,
0,
PyUNO_iterator_iter, // Generic, reused between the iterator types
PyUNO_list_iterator_next,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
0,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
nullptr,
0
#if PY_VERSION_HEX >= 0x03040000
, nullptr
#endif
};
PyObject* PyUNO_list_iterator_new( const Reference<XIndexAccess> &xIndexAccess )
{
PyUNO_list_iterator* self = PyObject_New( PyUNO_list_iterator, &PyUNO_list_iterator_Type );
if ( self == NULL )
return NULL; // == error
self->members = new PyUNO_list_iterator_Internals();
self->members->xIndexAccess = xIndexAccess;
self->members->index = 0;
return reinterpret_cast<PyObject*>(self);
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in New Issue Copy Permalink