/**************************************************************
 * 
 * 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
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef _SFXBITSET_HXX
#define _SFXBITSET_HXX

#include <tools/solar.h>

class Range;

class BitSet
{
private:
	void CopyFrom( const BitSet& rSet );
	sal_uInt16 nBlocks;
	sal_uInt16 nCount;
	sal_uIntPtr* pBitmap;
public:
	BitSet operator<<( sal_uInt16 nOffset ) const;
	BitSet operator>>( sal_uInt16 nOffset ) const;
	static sal_uInt16 CountBits( sal_uIntPtr nBits );
	sal_Bool operator!() const;
	BitSet();
	BitSet( const BitSet& rOrig );
	BitSet( sal_uInt16* pArray, sal_uInt16 nSize );
	~BitSet();
	BitSet( const Range& rRange );
	sal_uInt16 Count() const;
	BitSet& operator=( const BitSet& rOrig );
	BitSet& operator=( sal_uInt16 nBit );
	BitSet operator|( const BitSet& rSet ) const;
	BitSet operator|( sal_uInt16 nBit ) const;
	BitSet& operator|=( const BitSet& rSet );
	BitSet& operator|=( sal_uInt16 nBit );
	BitSet operator-( const BitSet& rSet ) const;
	BitSet operator-( sal_uInt16 nId ) const;
	BitSet& operator-=( const BitSet& rSet );
	BitSet& operator-=( sal_uInt16 nBit );
	BitSet operator&( const BitSet& rSet ) const;
	BitSet& operator&=( const BitSet& rSet );
	BitSet operator^( const BitSet& rSet ) const;
	BitSet operator^( sal_uInt16 nBit ) const;
	BitSet& operator^=( const BitSet& rSet );
	BitSet& operator^=( sal_uInt16 nBit );
	sal_Bool IsRealSubSet( const BitSet& rSet ) const;
	sal_Bool IsSubSet( const BitSet& rSet ) const;
	sal_Bool IsRealSuperSet( const BitSet& rSet ) const;
	sal_Bool Contains( sal_uInt16 nBit ) const;
	sal_Bool IsSuperSet( const BitSet& rSet ) const;
	sal_Bool operator==( const BitSet& rSet ) const;
	sal_Bool operator==( sal_uInt16 nBit ) const;
	sal_Bool operator!=( const BitSet& rSet ) const;
	sal_Bool operator!=( sal_uInt16 nBit ) const;

};
//--------------------------------------------------------------------

// returns sal_True if the set is empty



inline sal_Bool BitSet::operator!() const
{
	return nCount == 0;
}
//--------------------------------------------------------------------

// returns the number of bits in the bitset

inline sal_uInt16 BitSet::Count() const
{
	return nCount;
}
//--------------------------------------------------------------------

// creates the union of two bitset

inline BitSet BitSet::operator|( const BitSet& rSet ) const
{
	return BitSet(*this) |= rSet;
}
//--------------------------------------------------------------------

// creates the union of a bitset with a single bit

inline BitSet BitSet::operator|( sal_uInt16 nBit ) const
{
	return BitSet(*this) |= nBit;
}
//--------------------------------------------------------------------

// creates the asymetric difference

inline BitSet BitSet::operator-( const BitSet& ) const
{
	return BitSet();
}
//--------------------------------------------------------------------

// creates the asymetric difference with a single bit


inline BitSet BitSet::operator-( sal_uInt16 ) const
{
	return BitSet();
}
//--------------------------------------------------------------------

// removes the bits contained in rSet

inline BitSet& BitSet::operator-=( const BitSet& )
{
	return *this;
}
//--------------------------------------------------------------------


// creates the intersection with another bitset

inline BitSet BitSet::operator&( const BitSet& ) const
{
	return BitSet();
}
//--------------------------------------------------------------------

// intersects with another bitset

inline BitSet& BitSet::operator&=( const BitSet& )
{
	return *this;
}
//--------------------------------------------------------------------

// creates the symetric difference with another bitset

inline BitSet BitSet::operator^( const BitSet& ) const
{
	return BitSet();
}
//--------------------------------------------------------------------

// creates the symetric difference with a single bit

inline BitSet BitSet::operator^( sal_uInt16 ) const
{
	return BitSet();
}
//--------------------------------------------------------------------

// builds the symetric difference with another bitset

inline BitSet& BitSet::operator^=( const BitSet& )
{
	return *this;
}
//--------------------------------------------------------------------
#ifdef BITSET_READY
// builds the symetric difference with a single bit

inline BitSet& BitSet::operator^=( sal_uInt16 )
{
	// crash!!!
	return BitSet();
}
#endif
//--------------------------------------------------------------------

// determines if the other bitset is a real superset

inline sal_Bool BitSet::IsRealSubSet( const BitSet& ) const
{
	return sal_False;
}
//--------------------------------------------------------------------

// detsermines if the other bitset is a superset or equal

inline sal_Bool BitSet::IsSubSet( const BitSet& ) const
{
	return sal_False;
}
//--------------------------------------------------------------------

// determines if the other bitset is a real subset

inline sal_Bool BitSet::IsRealSuperSet( const BitSet& ) const
{
	return sal_False;
}

//--------------------------------------------------------------------

// determines if the other bitset is a subset or equal

inline sal_Bool BitSet::IsSuperSet( const BitSet& ) const
{
	return sal_False;
}
//--------------------------------------------------------------------

// determines if the bit is the only one in the bitset

inline sal_Bool BitSet::operator==( sal_uInt16 ) const
{
	return sal_False;
}
//--------------------------------------------------------------------

// determines if the bitsets aren't equal

inline sal_Bool BitSet::operator!=( const BitSet& rSet ) const
{
	return !( *this == rSet );
}
//--------------------------------------------------------------------

// determines if the bitset doesn't contain only this bit

inline sal_Bool BitSet::operator!=( sal_uInt16 nBit ) const
{
	return !( *this == nBit );
}
//--------------------------------------------------------------------

class IndexBitSet : BitSet
{
public:
  sal_uInt16 GetFreeIndex();
  void ReleaseIndex(sal_uInt16 i){*this-=i;}
};


#endif