diff options
Diffstat (limited to 'include/comphelper/sequenceasvector.hxx')
| -rw-r--r-- | include/comphelper/sequenceasvector.hxx | 251 |
1 files changed, 0 insertions, 251 deletions
diff --git a/include/comphelper/sequenceasvector.hxx b/include/comphelper/sequenceasvector.hxx deleted file mode 100644 index 6b85e7233438..000000000000 --- a/include/comphelper/sequenceasvector.hxx +++ /dev/null @@ -1,251 +0,0 @@ -/* -*- 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 . - */ - -#ifndef INCLUDED_COMPHELPER_SEQUENCEASVECTOR_HXX -#define INCLUDED_COMPHELPER_SEQUENCEASVECTOR_HXX - -#include <vector> -#include <algorithm> -#include <com/sun/star/uno/Sequence.hxx> - -#include <com/sun/star/beans/IllegalTypeException.hpp> - -/** This should not be used. Use the functions in - * comphelper/vectortosequence.hxx - * @deprecated - */ - -namespace comphelper{ - - -/** @short Implements a stl vector on top of any - uno sequence. - - @descr That provides the possibility to modify - sequences very easy ... - Of course this can be useful only, if - count of modifications is high, so copying - of the sequence make sense! - */ -template< class TElementType > -class SequenceAsVector : public ::std::vector< TElementType > -{ - - // types - - public: - - - /** @short When inheriting from a template using typename is generally required when using - types from the base! */ - typedef typename ::std::vector< TElementType >::const_iterator const_iterator; - - - /** @short When inheriting from a template using typename is generally required when using - types from the base! */ - typedef typename ::std::vector< TElementType >::iterator iterator; - - - // interface - public: - - - /** @short default ctor, to create an empty list. - */ - SequenceAsVector() - {} - - - /** @short default dtor - */ - ~SequenceAsVector() - {} - - - /** @short creates a new vector with the given length. - - @param nLength - the number of elements for the new vector. - */ - explicit SequenceAsVector(sal_Int32 nLength) : - ::std::vector< TElementType >( static_cast< size_t >( nLength ) ) - { - } - - - /** @short creates a new deque from the given uno sequence. - - @param lSource - contains the new items for this deque. - */ - SequenceAsVector(const ::com::sun::star::uno::Sequence< TElementType >& lSource) - { - (*this) << lSource; - } - - - /** @short creates a new instance from the given Any, which - of course must contain a valid sequence using the - right element type for every item. - - @attention If the given Any is an empty one - (if its set to VOID), no exception - is thrown. In such case this instance will - be created as an empty one too! - - @param aSource - this any must contain a suitable sequence. :-) - - @throw A com::sun::star::beans::IllegalTypeException - if an unsupported element inside this Any - is given. An empty Any reset this instance! - */ - SequenceAsVector(const ::com::sun::star::uno::Any& aSource) - { - (*this) << aSource; - } - - - /** @short fill this instance from the given uno sequence. - - @param lSource - contains the new items for this deque. - */ - void operator<<(const ::com::sun::star::uno::Sequence< TElementType >& lSource) - { - this->clear(); - - sal_Int32 c = lSource.getLength(); - const TElementType* pSource = lSource.getConstArray(); - - for (sal_Int32 i=0; i<c; ++i) - this->push_back(pSource[i]); - } - - - /** @short fill this instance from the given Any, which - of course must contain a valid sequence using the - right element type for every item. - - @attention If the given Any is an empty one - (if its set to VOID), no exception - is thrown. In such case this instance will - be created as an empty one too! - - @param aSource - this any must contain a suitable sequence. :-) - - @throw A com::sun::star::beans::IllegalTypeException - if an unsupported element inside this Any - is given. An empty Any reset this instance! - */ - void operator<<(const ::com::sun::star::uno::Any& aSource) - { - // An empty Any reset this instance! - if (!aSource.hasValue()) - { - this->clear(); - return; - } - - ::com::sun::star::uno::Sequence< TElementType > lSource; - if (!(aSource >>= lSource)) - throw ::com::sun::star::beans::IllegalTypeException( - OUString("SequenceAsVector operator<<(Any) was called with an unsupported Any type."), - ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >()); - - (*this) << lSource; - } - - - /** @short converts this instance to an uno sequence. - - @param lDestination - target sequence for converting. - */ - void operator>>(::com::sun::star::uno::Sequence< TElementType >& lDestination) const - { - sal_Int32 c = static_cast<sal_Int32>(this->size()); - lDestination.realloc(c); - TElementType* pDestination = lDestination.getArray(); - - sal_Int32 i = 0; - for (typename std::vector<TElementType>::const_iterator pThis = this->begin(); - pThis != this->end() ; - ++pThis ) - { - pDestination[i] = *pThis; - ++i; - } - } - - - /** @short converts this instance to an uno any - which contains a suitable sequence - of items of this stl struct. - - @param aDestination - target any for converting. - */ - void operator>>(::com::sun::star::uno::Any& aDestination) const - { - sal_Int32 c = static_cast<sal_Int32>(this->size()); - ::com::sun::star::uno::Sequence< TElementType > lDestination(c); - TElementType* pDestination = lDestination.getArray(); - - sal_Int32 i = 0; - for (typename std::vector<TElementType>::const_iterator pThis = this->begin(); - pThis != this->end() ; - ++pThis ) - { - pDestination[i] = *pThis; - ++i; - } - - aDestination <<= lDestination; - } - - - /** @short converts this deque to a suitable uno - sequence which contains all items. - - @attention It return a const sequence to prevent - the outside code against using of this - return value as [in/]out parameter for - direct function calls! - Of course it can be casted to non const - ... but then it's a problem of the outside - code :-) - - @return A (const!) sequence, which contains all items of - this deque. - */ - const ::com::sun::star::uno::Sequence< TElementType > getAsConstList() const - { - ::com::sun::star::uno::Sequence< TElementType > lDestination; - (*this) >> lDestination; - return lDestination; - } -}; - -} // namespace comphelper - -#endif // INCLUDED_COMPHELPER_SEQUENCEASVECTOR_HXX - -/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |