Sequence.h

Go to the documentation of this file.

/* -*- 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 .
 */

/*
 * This file is part of LibreOffice published API.
 */
#ifndef INCLUDED_COM_SUN_STAR_UNO_SEQUENCE_H
#define INCLUDED_COM_SUN_STAR_UNO_SEQUENCE_H

#include "typelib/typedescription.h"
#include "uno/sequence2.h"
#include "com/sun/star/uno/Type.h"
#include "rtl/alloc.h"

#include <new>

#if defined LIBO_INTERNAL_ONLY
#include <cassert>
#include <initializer_list>
#endif

namespace rtl
{
class ByteSequence;
}

namespace com
{
namespace sun
{
namespace star
{
namespace uno
{

template< class E >
class SAL_WARN_UNUSED SAL_DLLPUBLIC_RTTI Sequence
{
    uno_Sequence * _pSequence;

public:

    // these are here to force memory de/allocation to sal lib.
    static void * SAL_CALL operator new ( ::size_t nSize )
        { return ::rtl_allocateMemory( nSize ); }
    static void SAL_CALL operator delete ( void * pMem )
        { ::rtl_freeMemory( pMem ); }
    static void * SAL_CALL operator new ( ::size_t, void * pMem )
        { return pMem; }
    static void SAL_CALL operator delete ( void *, void * )
        {}

    static typelib_TypeDescriptionReference * s_pType;


    typedef E ElementType;

    inline Sequence();

    inline Sequence( const Sequence & rSeq );

    inline Sequence( uno_Sequence * pSequence, __sal_NoAcquire dummy );

    inline Sequence( const E * pElements, sal_Int32 len );

    inline explicit Sequence( sal_Int32 len );

#if defined LIBO_INTERNAL_ONLY

    inline Sequence(std::initializer_list<E> init);
#endif

    inline ~Sequence();

    inline Sequence & SAL_CALL operator = ( const Sequence & rSeq );

#if defined LIBO_INTERNAL_ONLY
    inline Sequence & operator =(Sequence && other);
#endif

    sal_Int32 SAL_CALL getLength() const
        { return _pSequence->nElements; }

    bool SAL_CALL hasElements() const
        { return (_pSequence->nElements > 0); }

#if defined LIBO_INTERNAL_ONLY

    sal_uInt32 size() const
        { assert(getLength() >= 0); return static_cast<sal_uInt32>(getLength()); }
#endif

    const E * SAL_CALL getConstArray() const
        { return reinterpret_cast< const E * >( _pSequence->elements ); }

    inline E * SAL_CALL getArray();

#if !defined LIBO_INTERNAL_ONLY

    inline E * begin();
#endif

    inline E const * begin() const;

#if !defined LIBO_INTERNAL_ONLY

    inline E * end();
#endif

    inline E const * end() const;

// Non-const operator[] is not available in internal code. Consider explicit use
// of getArray(), out of tight loops if possible to avoid unneeded COW overhead.
#if !defined LIBO_INTERNAL_ONLY

    inline E & SAL_CALL operator [] ( sal_Int32 nIndex );
#endif

    inline const E & SAL_CALL operator [] ( sal_Int32 nIndex ) const;

    inline bool SAL_CALL operator == ( const Sequence & rSeq ) const;

    inline bool SAL_CALL operator != ( const Sequence & rSeq ) const;

    inline void SAL_CALL realloc( sal_Int32 nSize );

    uno_Sequence * SAL_CALL get() const
        { return _pSequence; }

#if defined LIBO_INTERNAL_ONLY

    inline void swap(Sequence& other);
#endif
};

// Find uses of illegal Sequence<bool> (instead of Sequence<sal_Bool>) during
// compilation:
template<> class Sequence<bool> {
    Sequence(Sequence<bool> const &) SAL_DELETED_FUNCTION;
};

inline ::com::sun::star::uno::Sequence< sal_Int8 > SAL_CALL toUnoSequence(
    const ::rtl::ByteSequence & rByteSequence );

}
}
}
}

template< class E > SAL_DEPRECATED("use cppu::UnoType")
inline const ::com::sun::star::uno::Type &
SAL_CALL getCppuType( const ::com::sun::star::uno::Sequence< E > * );

template< class E > SAL_DEPRECATED("use cppu::UnoType")
inline const ::com::sun::star::uno::Type &
SAL_CALL getCppuSequenceType( const ::com::sun::star::uno::Type & rElementType );

SAL_DEPRECATED("use cppu::UnoType")
inline const ::com::sun::star::uno::Type &
SAL_CALL getCharSequenceCppuType();

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */