office-gobmx/sw/qa/core/bigpointerarray-new.hxx
2011-05-18 00:28:27 -04:00

160 lines
3.9 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef _BPARR_HXX
#define _BPARR_HXX
#include <tools/solar.h>
#include <deque>
class BigPtrArray;
/** Base class for container entries
*/
class BigPtrEntry
{
friend class BigPtrArray;
BigPtrArray* pBigPtrArray_;
sal_uLong pos_;
protected:
BigPtrEntry() : pBigPtrArray_(0), pos_(0)
{}
virtual ~BigPtrEntry()
{}
sal_uLong GetPos() const
{
return pos_;
}
BigPtrArray& GetArray() const
{
return *pBigPtrArray_;
}
};
typedef BigPtrEntry* ElementPtr;
typedef sal_Bool (*FnForEach)(const ElementPtr&, void* pArgs);
/** A container abstraction
*/
class BigPtrArray
{
public:
typedef std::deque<ElementPtr> Container_t;
public:
/**
*/
BigPtrArray();
/** Return the number of entries inserted
into the array
*/
sal_uLong Count() const;
/** Insert an Element into the array at a certain
position
@param rElem
[in] the element
@param pos
[in] the position where to insert the element.
@pre (pos >= 0 && pos <= BigPtrArray.Count())
@post (((oldCount + 1) == BigPtrArray.Count()) && BigPtrArray[pos] == rElem)
*/
void Insert(const ElementPtr& rElem, sal_uLong pos);
/** Remove a specified number of elements starting at a certain position.
@param pos
[in] the position where to start removing elements
@param n
[in] the number of elements to remove
@pre (pos < BigPtrArray.Count() && n <= BigPtrArray.Count())
@post ((oldCount - n) == BigPtrArray.Count())
*/
void Remove(sal_uLong pos, sal_uLong n = 1);
/** Move an entry from a certain position to another on.
@param from
[in]
@param to
[in]
*/
void Move(sal_uLong fromPos, sal_uLong toPos);
/** Replace an entry at a certain position
@param pos
[in] the position of the entry
@param rElem
[in] the new entry
@pre pos < BigPtrArray.Count()
@post (oldCount == BigPtrArray.Count() && BigPtrArray[pos] == rElem)
*/
void Replace(sal_uLong pos, const ElementPtr& rElem);
/** Get the entry at a certain index
@param pos
[in] the position of the entry
@pre pos < BigPtrArray.Count()
*/
ElementPtr operator[](sal_uLong pos) const;
/**
*/
void ForEach(FnForEach fn, void* pArgs = NULL);
/**
*/
void ForEach(sal_uLong fromPos, sal_uLong toPos, FnForEach fn, void* pArgs = NULL);
private:
void FixElementIndizes(Container_t::const_iterator begin, Container_t::const_iterator end) const;
private:
Container_t container_;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */