Files
SLikeNet/Source/include/slikenet/DS_RangeList.h
2025-11-24 14:19:51 +05:30

291 lines
7.9 KiB
C++

/*
* Original work: Copyright (c) 2014, Oculus VR, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* RakNet License.txt file in the licenses directory of this source tree. An additional grant
* of patent rights can be found in the RakNet Patents.txt file in the same directory.
*
*
* Modified work: Copyright (c) 2017-2018, SLikeSoft UG (haftungsbeschränkt)
*
* This source code was modified by SLikeSoft. Modifications are licensed under the MIT-style
* license found in the license.txt file in the root directory of this source tree.
*/
/// \file DS_RangeList.h
/// \internal
/// \brief A queue implemented as a linked list.
///
#ifndef __RANGE_LIST_H
#define __RANGE_LIST_H
#include "DS_OrderedList.h"
#include "BitStream.h"
#include "memoryoverride.h"
#include "assert.h"
namespace DataStructures
{
template <class range_type>
struct RangeNode
{
RangeNode() {}
~RangeNode() {}
RangeNode(range_type min, range_type max) {minIndex=min; maxIndex=max;}
range_type minIndex;
range_type maxIndex;
};
template <class range_type>
int RangeNodeComp(const range_type &a, const RangeNode<range_type> &b)
{
if (a < b.minIndex) {
return -1;
}
if (a > b.maxIndex) {
return 1;
}
return 0;
}
template <class range_type>
class RAK_DLL_EXPORT RangeList
{
public:
RangeList();
~RangeList();
void Insert(range_type index);
void Clear(void);
bool IsWithinRange(range_type value) const;
unsigned Size(void) const;
unsigned RangeSum(void) const;
SLNet::BitSize_t Serialize(SLNet::BitStream *in, SLNet::BitSize_t maxBits, bool clearSerialized);
bool Deserialize(SLNet::BitStream *out);
DataStructures::OrderedList<range_type, RangeNode<range_type>, RangeNodeComp<range_type>> ranges;
// internal helpers
private:
static bool DeserializeSingleRange(SLNet::BitStream *out, range_type& min, range_type& max);
};
template <class range_type>
SLNet::BitSize_t RangeList<range_type>::Serialize(SLNet::BitStream *in, SLNet::BitSize_t maxBits, bool clearSerialized)
{
RakAssert(ranges.Size() < (unsigned short)-1);
SLNet::BitStream tempBS;
SLNet::BitSize_t bitsWritten;
unsigned short countWritten;
unsigned i;
countWritten=0;
bitsWritten=0;
for (i=0; i < ranges.Size(); i++) {
// #med - review this calculation --- shouldn't this be +8 rather than +1 due to minEqualsMax being 1 byte?
if ((int)sizeof(unsigned short)*8+bitsWritten+(int)sizeof(range_type)*8*2+1>maxBits) {
break;
}
unsigned char minEqualsMax;
if (ranges[i].minIndex==ranges[i].maxIndex) {
minEqualsMax=1;
} else {
minEqualsMax=0;
}
tempBS.Write(minEqualsMax); // Use one byte, instead of one bit, for speed, as this is done a lot
tempBS.Write(ranges[i].minIndex);
bitsWritten+=sizeof(range_type)*8+8;
if (ranges[i].minIndex!=ranges[i].maxIndex) {
tempBS.Write(ranges[i].maxIndex);
bitsWritten+=sizeof(range_type)*8;
}
countWritten++;
}
in->AlignWriteToByteBoundary();
SLNet::BitSize_t before=in->GetWriteOffset();
in->Write(countWritten);
bitsWritten+=in->GetWriteOffset()-before;
// RAKNET_DEBUG_PRINTF("%i ", in->GetNumberOfBitsUsed());
in->Write(&tempBS, tempBS.GetNumberOfBitsUsed());
// RAKNET_DEBUG_PRINTF("%i %i \n", tempBS.GetNumberOfBitsUsed(),in->GetNumberOfBitsUsed());
if (clearSerialized && countWritten) {
unsigned rangeSize=ranges.Size();
for (i=0; i < rangeSize-countWritten; i++) {
ranges[i]=ranges[i+countWritten];
}
ranges.RemoveFromEnd(countWritten);
}
return bitsWritten;
}
template <class range_type>
bool RangeList<range_type>::Deserialize(SLNet::BitStream *out)
{
ranges.Clear(true, _FILE_AND_LINE_);
unsigned short count;
out->AlignReadToByteBoundary();
if (!out->Read(count)) {
return false;
}
range_type absMin;
range_type min, max;
if (count == 0) {
return true;
}
if (!DeserializeSingleRange(out, min, max)) {
return false;
}
ranges.InsertAtEnd(RangeNode<range_type>(min, max), _FILE_AND_LINE_);
for (unsigned short i = 1; i < count; i++) {
absMin = max;
if (!DeserializeSingleRange(out, min, max)) {
return false;
}
if (min <= absMin) {
return false;
}
ranges.InsertAtEnd(RangeNode<range_type>(min, max), _FILE_AND_LINE_);
}
return true;
}
template <class range_type>
bool RangeList<range_type>::DeserializeSingleRange(SLNet::BitStream *out, range_type& min, range_type& max)
{
unsigned char maxEqualToMin;
if (!out->Read(maxEqualToMin)) {
return false;
}
if (!out->Read(min)) {
return false;
}
if (maxEqualToMin == 0) {
if (!out->Read(max)) {
return false;
}
if (max <= min) {
return false;
}
} else {
max = min;
}
return true;
}
template <class range_type>
RangeList<range_type>::RangeList()
{
RangeNodeComp<range_type>(0, RangeNode<range_type>());
}
template <class range_type>
RangeList<range_type>::~RangeList()
{
Clear();
}
template <class range_type>
void RangeList<range_type>::Insert(range_type index)
{
if (ranges.Size()==0) {
ranges.Insert(index, RangeNode<range_type>(index, index), true, _FILE_AND_LINE_);
return;
}
bool objectExists;
unsigned insertionIndex=ranges.GetIndexFromKey(index, &objectExists);
if (objectExists) {
return; // index already covered by a range entry - do not create a duplicated entry
}
// index > maxIndex on entire range list
if (insertionIndex==ranges.Size()) {
if (index == ranges[insertionIndex-1].maxIndex+(range_type)1) {
ranges[insertionIndex-1].maxIndex++;
} else if (index > ranges[insertionIndex-1].maxIndex+(range_type)1) {
// Insert at end
ranges.Insert(index, RangeNode<range_type>(index, index), true, _FILE_AND_LINE_);
}
return;
}
// verify it's really not within the current range (otherwise objectExists should have been true)
RakAssert(index < ranges[insertionIndex].minIndex || index > ranges[insertionIndex].maxIndex);
if (index < ranges[insertionIndex].minIndex-(range_type)1)
{
// Insert here
ranges.InsertAtIndex(RangeNode<range_type>(index, index), insertionIndex, _FILE_AND_LINE_);
return;
}
if (index == ranges[insertionIndex].minIndex-(range_type)1)
{
// Decrease minIndex and join left
ranges[insertionIndex].minIndex--;
if (insertionIndex>0 && ranges[insertionIndex-1].maxIndex+(range_type)1==ranges[insertionIndex].minIndex)
{
ranges[insertionIndex-1].maxIndex=ranges[insertionIndex].maxIndex;
ranges.RemoveAtIndex(insertionIndex);
}
return;
}
if (index == ranges[insertionIndex].maxIndex+(range_type)1)
{
// Increase maxIndex and join right
ranges[insertionIndex].maxIndex++;
if (insertionIndex<ranges.Size()-1 && ranges[insertionIndex+(range_type)1].minIndex==ranges[insertionIndex].maxIndex+(range_type)1)
{
ranges[insertionIndex+1].minIndex=ranges[insertionIndex].minIndex;
ranges.RemoveAtIndex(insertionIndex);
}
}
}
template <class range_type>
void RangeList<range_type>::Clear(void)
{
ranges.Clear(true, _FILE_AND_LINE_);
}
template <class range_type>
bool RangeList<range_type>::IsWithinRange(range_type value) const
{
bool objectExists;
// not interested in the return value
(void)ranges.GetIndexFromKey(value, &objectExists);
return objectExists;
}
template <class range_type>
unsigned RangeList<range_type>::Size(void) const
{
return ranges.Size();
}
template <class range_type>
unsigned RangeList<range_type>::RangeSum(void) const
{
unsigned sum = 0, i;
for (i = 0; i < ranges.Size(); i++) {
sum += ranges[i].maxIndex-ranges[i].minIndex + 1;
}
return sum;
}
}
#endif