You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1460 lines
33 KiB
1460 lines
33 KiB
/*==LICENSE==* |
|
|
|
CyanWorlds.com Engine - MMOG client, server and tools |
|
Copyright (C) 2011 Cyan Worlds, Inc. |
|
|
|
This program is free software: you can redistribute it and/or modify |
|
it under the terms of the GNU General Public License as published by |
|
the Free Software Foundation, either version 3 of the License, or |
|
(at your option) any later version. |
|
|
|
This program 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 General Public License for more details. |
|
|
|
You should have received a copy of the GNU General Public License |
|
along with this program. If not, see <http://www.gnu.org/licenses/>. |
|
|
|
Additional permissions under GNU GPL version 3 section 7 |
|
|
|
If you modify this Program, or any covered work, by linking or |
|
combining it with any of RAD Game Tools Bink SDK, Autodesk 3ds Max SDK, |
|
NVIDIA PhysX SDK, Microsoft DirectX SDK, OpenSSL library, Independent |
|
JPEG Group JPEG library, Microsoft Windows Media SDK, or Apple QuickTime SDK |
|
(or a modified version of those libraries), |
|
containing parts covered by the terms of the Bink SDK EULA, 3ds Max EULA, |
|
PhysX SDK EULA, DirectX SDK EULA, OpenSSL and SSLeay licenses, IJG |
|
JPEG Library README, Windows Media SDK EULA, or QuickTime SDK EULA, the |
|
licensors of this Program grant you additional |
|
permission to convey the resulting work. Corresponding Source for a |
|
non-source form of such a combination shall include the source code for |
|
the parts of OpenSSL and IJG JPEG Library used as well as that of the covered |
|
work. |
|
|
|
You can contact Cyan Worlds, Inc. by email legal@cyan.com |
|
or by snail mail at: |
|
Cyan Worlds, Inc. |
|
14617 N Newport Hwy |
|
Mead, WA 99021 |
|
|
|
*==LICENSE==*/ |
|
#include "hsStream.h" |
|
#include "hsMemory.h" |
|
|
|
#include "hsTemplates.h" |
|
|
|
#if HS_BUILD_FOR_UNIX |
|
#include <unistd.h> |
|
#endif |
|
|
|
#if HS_BUILD_FOR_WIN32 |
|
#include <io.h> |
|
#endif |
|
|
|
////////////////////////////////////////////////////////////////////////////////// |
|
|
|
void hsStream::FastFwd() |
|
{ |
|
hsThrow("FastFwd unimplemented by subclass of stream"); |
|
} |
|
|
|
uint32_t hsStream::GetPosition() const |
|
{ |
|
return fPosition; |
|
} |
|
|
|
void hsStream::SetPosition(uint32_t position) |
|
{ |
|
if (position == fPosition) |
|
return; |
|
Rewind(); |
|
Skip(position); |
|
} |
|
|
|
void hsStream::Truncate() |
|
{ |
|
hsThrow("Truncate unimplemented by subclass of stream"); |
|
} |
|
|
|
uint32_t hsStream::GetSizeLeft() |
|
{ |
|
uint32_t ret = 0; |
|
if (GetPosition() > GetEOF()) |
|
{ |
|
hsThrow("Position is beyond EOF"); |
|
} |
|
else |
|
{ |
|
ret = GetEOF() - GetPosition(); |
|
} |
|
|
|
return ret; |
|
} |
|
|
|
////////////////////////////////////////////////////////////////////////////////// |
|
|
|
uint32_t hsStream::GetEOF() |
|
{ |
|
hsThrow( "GetEOF() unimplemented by subclass of stream"); |
|
return 0; |
|
} |
|
|
|
void hsStream::CopyToMem(void* mem) |
|
{ |
|
hsThrow( "CopyToMem unimplemented by subclass of stream"); |
|
} |
|
|
|
////////////////////////////////////////////////////////////////////////////////// |
|
|
|
uint32_t hsStream::WriteFmt(const char * fmt, ...) |
|
{ |
|
va_list av; |
|
va_start( av, fmt ); |
|
uint32_t n = WriteFmtV( fmt, av ); |
|
va_end( av ); |
|
return n; |
|
} |
|
|
|
uint32_t hsStream::WriteFmtV(const char * fmt, va_list av) |
|
{ |
|
plString buf = plString::IFormat(fmt, av); |
|
return Write( buf.GetSize(), buf.c_str() ); |
|
} |
|
|
|
uint32_t hsStream::WriteSafeStringLong(const plString &string) |
|
{ |
|
uint32_t len = string.GetSize(); |
|
WriteLE32(len); |
|
if (len > 0) |
|
{ |
|
const char *buffp = string.c_str(); |
|
uint32_t i; |
|
for (i = 0; i < len; i++) |
|
{ |
|
WriteByte(~buffp[i]); |
|
} |
|
return i; |
|
} |
|
else |
|
return 0; |
|
} |
|
|
|
uint32_t hsStream::WriteSafeWStringLong(const plString &string) |
|
{ |
|
plStringBuffer<uint16_t> wbuff = string.ToUtf16(); |
|
uint32_t len = wbuff.GetSize(); |
|
WriteLE32(len); |
|
if (len > 0) |
|
{ |
|
const uint16_t *buffp = wbuff.GetData(); |
|
for (uint32_t i=0; i<len; i++) |
|
{ |
|
WriteLE16(~buffp[i]); |
|
} |
|
WriteLE16(static_cast<uint16_t>(0)); |
|
} |
|
return 0; |
|
} |
|
|
|
plString hsStream::ReadSafeStringLong_TEMP() |
|
{ |
|
plStringBuffer<char> name; |
|
uint32_t numChars = ReadLE32(); |
|
if (numChars > 0 && numChars <= GetSizeLeft()) |
|
{ |
|
char *buff = name.CreateWritableBuffer(numChars); |
|
Read(numChars, buff); |
|
buff[numChars] = 0; |
|
|
|
// if the high bit is set, flip the bits. Otherwise it's a normal string, do nothing. |
|
if (buff[0] & 0x80) |
|
{ |
|
for (int i = 0; i < numChars; i++) |
|
buff[i] = ~buff[i]; |
|
} |
|
} |
|
|
|
return name; |
|
} |
|
|
|
char *hsStream::ReadSafeStringLong() |
|
{ |
|
plString name = ReadSafeStringLong_TEMP(); |
|
char *buff = new char[name.GetSize() + 1]; |
|
memcpy(buff, name.c_str(), name.GetSize() + 1); |
|
return buff; |
|
} |
|
|
|
plString hsStream::ReadSafeWStringLong_TEMP() |
|
{ |
|
plStringBuffer<uint16_t> retVal; |
|
uint32_t numChars = ReadLE32(); |
|
if (numChars > 0 && numChars <= (GetSizeLeft()/2)) // divide by two because each char is two bytes |
|
{ |
|
uint16_t *buff = retVal.CreateWritableBuffer(numChars); |
|
for (int i=0; i<numChars; i++) |
|
buff[i] = ReadLE16(); |
|
ReadLE16(); // we wrote the null out, read it back in |
|
buff[numChars] = 0; // But terminate it safely anyway |
|
|
|
if (buff[0]* 0x80) |
|
{ |
|
for (int i=0; i<numChars; i++) |
|
buff[i] = ~buff[i]; |
|
} |
|
} |
|
|
|
return plString::FromUtf16(retVal); |
|
} |
|
|
|
wchar_t *hsStream::ReadSafeWStringLong() |
|
{ |
|
// Horribly inefficient (convert to UTF-8 and then back to UTF-16), which |
|
// is why this should go away completely after plString has taken over |
|
// the world^H^H^H^H^HPlasma |
|
plStringBuffer<wchar_t> retVal = ReadSafeWStringLong_TEMP().ToWchar(); |
|
wchar_t *buff = new wchar_t[retVal.GetSize() + 1]; |
|
memcpy(buff, retVal.GetData(), retVal.GetSize() + 1); |
|
return buff; |
|
} |
|
|
|
uint32_t hsStream::WriteSafeString(const plString &string) |
|
{ |
|
int len = string.GetSize(); |
|
hsAssert(len<0xf000, plString::Format("string len of %d is too long for WriteSafeString %s, use WriteSafeStringLong", |
|
len, string.c_str()).c_str() ); |
|
|
|
WriteLE16(len | 0xf000); |
|
if (len > 0) |
|
{ |
|
uint32_t i; |
|
const char *buffp = string.c_str(); |
|
for (i = 0; i < len; i++) |
|
{ |
|
WriteByte(~buffp[i]); |
|
} |
|
return i; |
|
} |
|
else |
|
return 0; |
|
} |
|
|
|
uint32_t hsStream::WriteSafeWString(const plString &string) |
|
{ |
|
plStringBuffer<uint16_t> wbuff = string.ToUtf16(); |
|
uint32_t len = wbuff.GetSize(); |
|
hsAssert(len<0xf000, plString::Format("string len of %d is too long for WriteSafeWString, use WriteSafeWStringLong", |
|
len).c_str() ); |
|
|
|
WriteLE16(len | 0xf000); |
|
if (len > 0) |
|
{ |
|
const uint16_t *buffp = wbuff.GetData(); |
|
for (uint32_t i=0; i<len; i++) |
|
{ |
|
WriteLE16(~buffp[i]); |
|
} |
|
WriteLE16(static_cast<uint16_t>(0)); |
|
} |
|
return 0; |
|
} |
|
|
|
plString hsStream::ReadSafeString_TEMP() |
|
{ |
|
plStringBuffer<char> name; |
|
uint16_t numChars = ReadLE16(); |
|
|
|
#ifndef REMOVE_ME_SOON |
|
// Backward compat hack - remove in a week or so (from 6/30/03) |
|
bool oldFormat = !(numChars & 0xf000); |
|
if (oldFormat) |
|
ReadLE16(); |
|
#endif |
|
|
|
numChars &= ~0xf000; |
|
hsAssert(numChars <= GetSizeLeft(), "Bad string"); |
|
if (numChars > 0 && numChars <= GetSizeLeft()) |
|
{ |
|
char *buff = name.CreateWritableBuffer(numChars); |
|
Read(numChars, buff); |
|
buff[numChars] = 0; |
|
|
|
// if the high bit is set, flip the bits. Otherwise it's a normal string, do nothing. |
|
if (buff[0] & 0x80) |
|
{ |
|
int i; |
|
for (i = 0; i < numChars; i++) |
|
buff[i] = ~buff[i]; |
|
} |
|
} |
|
|
|
return name; |
|
} |
|
|
|
char *hsStream::ReadSafeString() |
|
{ |
|
plString name = ReadSafeString_TEMP(); |
|
char *buff = new char[name.GetSize() + 1]; |
|
memcpy(buff, name.c_str(), name.GetSize() + 1); |
|
return buff; |
|
} |
|
|
|
plString hsStream::ReadSafeWString_TEMP() |
|
{ |
|
plStringBuffer<uint16_t> retVal; |
|
uint32_t numChars = ReadLE16(); |
|
|
|
numChars &= ~0xf000; |
|
hsAssert(numChars <= GetSizeLeft()/2, "Bad string"); |
|
if (numChars > 0 && numChars <= (GetSizeLeft()/2)) // divide by two because each char is two bytes |
|
{ |
|
uint16_t *buff = retVal.CreateWritableBuffer(numChars); |
|
for (int i=0; i<numChars; i++) |
|
buff[i] = ReadLE16(); |
|
ReadLE16(); // we wrote the null out, read it back in |
|
buff[numChars] = 0; // But terminate it safely anyway |
|
|
|
if (buff[0]* 0x80) |
|
{ |
|
for (int i=0; i<numChars; i++) |
|
buff[i] = ~buff[i]; |
|
} |
|
} |
|
|
|
return plString::FromUtf16(retVal); |
|
} |
|
|
|
wchar_t *hsStream::ReadSafeWString() |
|
{ |
|
// Horribly inefficient (convert to UTF-8 and then back to UTF-16), which |
|
// is why this should go away completely after plString has taken over |
|
// the world^H^H^H^H^HPlasma |
|
plStringBuffer<wchar_t> retVal = ReadSafeWString_TEMP().ToWchar(); |
|
wchar_t *buff = new wchar_t[retVal.GetSize() + 1]; |
|
memcpy(buff, retVal.GetData(), retVal.GetSize() + 1); |
|
return buff; |
|
} |
|
|
|
bool hsStream::Read4Bytes(void *pv) // Virtual, faster version in sub classes |
|
{ |
|
int knt = this->Read(sizeof(uint32_t), pv); |
|
if (knt != 4) |
|
return false; |
|
return true; |
|
} |
|
|
|
bool hsStream::Read12Bytes(void *buffer) // Reads 12 bytes, return true if success |
|
{ |
|
int knt = this->Read(12,buffer); |
|
if (knt != 12) |
|
return false; |
|
return true; |
|
} |
|
|
|
bool hsStream::Read8Bytes(void *buffer) // Reads 12 bytes, return true if success |
|
{ |
|
int knt = this->Read(8,buffer); |
|
if (knt !=8) |
|
return false; |
|
return true; |
|
} |
|
|
|
bool hsStream::ReadBOOL() |
|
{ |
|
uint32_t val; |
|
this->Read(sizeof(uint32_t), &val); |
|
return val != 0; |
|
} |
|
|
|
bool hsStream::ReadBool() // Virtual, faster version in sub classes |
|
{ |
|
return (this->ReadByte() != 0); |
|
} |
|
|
|
void hsStream::ReadBool(int count, bool values[]) |
|
{ |
|
this->Read(count, values); |
|
} |
|
|
|
uint8_t hsStream::ReadByte() |
|
{ |
|
uint8_t value; |
|
|
|
this->Read(sizeof(uint8_t), &value); |
|
return value; |
|
} |
|
|
|
bool hsStream::AtEnd() |
|
{ |
|
hsAssert(0,"No hsStream::AtEnd() implemented for this stream class"); |
|
return false; |
|
} |
|
|
|
bool hsStream::IsTokenSeparator(char c) |
|
{ |
|
return (isspace(c) || c==',' || c=='='); |
|
} |
|
|
|
bool hsStream::GetToken(char *s, uint32_t maxLen, const char beginComment, const char endComment) |
|
{ |
|
char c; |
|
char endCom; |
|
endCom = endComment; |
|
|
|
while( true ) |
|
{ |
|
while( !AtEnd() && IsTokenSeparator(c = ReadByte()) ) |
|
c = c; |
|
; |
|
if( AtEnd() ) |
|
return false; |
|
|
|
if( beginComment != c ) |
|
break; |
|
|
|
// skip to end of comment |
|
while( !AtEnd() && (endCom != (c = ReadByte())) ) |
|
c= c; |
|
; |
|
} |
|
|
|
s[0] = c; |
|
uint32_t k = 1; |
|
while( !AtEnd() && !IsTokenSeparator(c = ReadByte()) ) |
|
{ |
|
if( k < maxLen ) |
|
s[k++] = c; |
|
} |
|
s[k] = 0; |
|
|
|
|
|
if( (k > 0)&&!stricmp(s, "skip") ) |
|
{ |
|
int depth = 1; |
|
while( depth && GetToken(s, maxLen, beginComment, endCom) ) |
|
{ |
|
if( !stricmp(s, "skip") ) |
|
depth++; |
|
else |
|
if( !stricmp(s, "piks") ) |
|
depth--; |
|
} |
|
return GetToken(s, maxLen, beginComment, endCom); |
|
} |
|
|
|
return true; |
|
} |
|
|
|
bool hsStream::ReadLn(char *s, uint32_t maxLen, const char beginComment, const char endComment) |
|
{ |
|
char c; |
|
char endCom; |
|
endCom = endComment; |
|
|
|
while( true ) |
|
{ |
|
while( !AtEnd() && strchr("\r\n",c = ReadByte()) ) |
|
c = c; |
|
; |
|
if( AtEnd() ) |
|
return false; |
|
|
|
if( beginComment != c ) |
|
break; |
|
|
|
// skip to end of comment |
|
while( !AtEnd() && (endCom != (c = ReadByte())) ) |
|
c= c; |
|
; |
|
} |
|
|
|
s[0] = c; |
|
uint32_t k = 1; |
|
while( !AtEnd() && !strchr("\r\n",c = ReadByte()) ) |
|
{ |
|
if( k < maxLen ) |
|
s[k++] = c; |
|
} |
|
s[k] = 0; |
|
|
|
|
|
if( (k > 0)&&!stricmp(s, "skip") ) |
|
{ |
|
int depth = 1; |
|
while( depth && ReadLn(s, maxLen, beginComment, endCom) ) |
|
{ |
|
if( !stricmp(s, "skip") ) |
|
depth++; |
|
else |
|
if( !stricmp(s, "piks") ) |
|
depth--; |
|
} |
|
return ReadLn(s, maxLen, beginComment, endCom); |
|
} |
|
|
|
return true; |
|
} |
|
|
|
uint16_t hsStream::ReadLE16() |
|
{ |
|
uint16_t value; |
|
this->Read(sizeof(uint16_t), &value); |
|
value = hsToLE16(value); |
|
return value; |
|
} |
|
|
|
void hsStream::ReadLE16(int count, uint16_t values[]) |
|
{ |
|
this->Read(count * sizeof(uint16_t), values); |
|
for (int i = 0; i < count; i++) |
|
values[i] = hsToLE16(values[i]); |
|
} |
|
|
|
uint32_t hsStream::ReadLE32() |
|
{ |
|
uint32_t value; |
|
Read4Bytes(&value); |
|
value = hsToLE32(value); |
|
return value; |
|
} |
|
|
|
void hsStream::ReadLE32(int count, uint32_t values[]) |
|
{ |
|
this->Read(count * sizeof(uint32_t), values); |
|
for (int i = 0; i < count; i++) |
|
values[i] = hsToLE32(values[i]); |
|
} |
|
|
|
uint32_t hsStream::ReadBE32() |
|
{ |
|
uint32_t value; |
|
Read4Bytes(&value); |
|
value = hsToBE32(value); |
|
return value; |
|
} |
|
|
|
double hsStream::ReadLEDouble() |
|
{ |
|
double value; |
|
Read8Bytes(&value); |
|
value = hsToLEDouble(value); |
|
return value; |
|
} |
|
|
|
void hsStream::ReadLEDouble(int count, double values[]) |
|
{ |
|
this->Read(count * sizeof(double), values); |
|
for (int i = 0; i < count; i++) |
|
values[i] = hsToLEDouble(values[i]); |
|
} |
|
|
|
|
|
float hsStream::ReadLEFloat() |
|
{ |
|
float value; |
|
Read4Bytes(&value); |
|
value = hsToLEFloat(value); |
|
return value; |
|
} |
|
|
|
void hsStream::ReadLEFloat(int count, float values[]) |
|
{ |
|
this->Read(count * sizeof(float), values); |
|
for (int i = 0; i < count; i++) |
|
values[i] = hsToLEFloat(values[i]); |
|
} |
|
|
|
float hsStream::ReadBEFloat() |
|
{ |
|
float value; |
|
this->Read(sizeof(float), &value); |
|
value = hsToBEFloat(value); |
|
return value; |
|
} |
|
|
|
|
|
void hsStream::WriteBOOL(bool value) |
|
{ |
|
uint32_t dst = value != 0; |
|
this->Write(sizeof(uint32_t), &dst); |
|
} |
|
|
|
void hsStream::WriteBool(bool value) |
|
{ |
|
uint8_t dst = value != 0; |
|
this->Write(sizeof(uint8_t), &dst); |
|
} |
|
|
|
void hsStream::WriteBool(int count, const bool values[]) |
|
{ |
|
this->Write(count, values); |
|
} |
|
|
|
void hsStream::WriteByte(uint8_t value) |
|
{ |
|
this->Write(sizeof(uint8_t), &value); |
|
} |
|
|
|
void hsStream::WriteLE16(uint16_t value) |
|
{ |
|
value = hsToLE16(value); |
|
this->Write(sizeof(int16_t), &value); |
|
} |
|
|
|
void hsStream::WriteLE16(int count, const uint16_t values[]) |
|
{ |
|
for (int i = 0; i < count; i++) |
|
this->WriteLE16(values[i]); |
|
} |
|
|
|
void hsStream::WriteLE32(uint32_t value) |
|
{ |
|
value = hsToLE32(value); |
|
this->Write(sizeof(int32_t), &value); |
|
} |
|
|
|
void hsStream::WriteLE32(int count, const uint32_t values[]) |
|
{ |
|
for (int i = 0; i < count; i++) |
|
this->WriteLE32(values[i]); |
|
} |
|
|
|
void hsStream::WriteBE32(uint32_t value) |
|
{ |
|
value = hsToBE32(value); |
|
this->Write(sizeof(int32_t), &value); |
|
} |
|
|
|
void hsStream::WriteLEDouble(double value) |
|
{ |
|
value = hsToLEDouble(value); |
|
this->Write(sizeof(double), &value); |
|
} |
|
|
|
void hsStream::WriteLEDouble(int count, const double values[]) |
|
{ |
|
for (int i = 0; i < count; i++) |
|
this->WriteLEDouble(values[i]); |
|
} |
|
|
|
void hsStream::WriteLEFloat(float value) |
|
{ |
|
value = hsToLEFloat(value); |
|
this->Write(sizeof(float), &value); |
|
} |
|
|
|
void hsStream::WriteLEFloat(int count, const float values[]) |
|
{ |
|
for (int i = 0; i < count; i++) |
|
this->WriteLEFloat(values[i]); |
|
} |
|
|
|
void hsStream::WriteBEFloat(float value) |
|
{ |
|
value = hsToBEFloat(value); |
|
this->Write(sizeof(float), &value); |
|
} |
|
|
|
void hsStream::WriteLEAtom(uint32_t tag, uint32_t size) |
|
{ |
|
this->WriteLE32(tag); |
|
this->WriteLE32(size); |
|
} |
|
|
|
uint32_t hsStream::ReadLEAtom(uint32_t* sizePtr) |
|
{ |
|
uint32_t tag = this->ReadLE32(); |
|
uint32_t size = this->ReadLE32(); |
|
|
|
if (sizePtr) |
|
*sizePtr = size; |
|
return tag; |
|
} |
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////// |
|
|
|
|
|
hsUNIXStream::~hsUNIXStream() |
|
{ |
|
// Don't Close here, because Sub classes Don't always want that behaviour! |
|
} |
|
|
|
bool hsUNIXStream::Open(const plFileName &name, const char *mode) |
|
{ |
|
fPosition = 0; |
|
fRef = plFileSystem::Open(name, mode); |
|
return (fRef) ? true : false; |
|
} |
|
|
|
bool hsUNIXStream::Close() |
|
{ |
|
int rtn = true; |
|
if (fRef) |
|
rtn = fclose(fRef); |
|
fRef = nil; |
|
delete [] fBuff; |
|
fBuff = nil; |
|
|
|
return !rtn; |
|
} |
|
|
|
uint32_t hsUNIXStream::Read(uint32_t bytes, void* buffer) |
|
{ |
|
if (!fRef || !bytes) |
|
return 0; |
|
size_t numItems = ::fread(buffer, 1 /*size*/, bytes /*count*/, fRef); |
|
fBytesRead += numItems; |
|
fPosition += numItems; |
|
if (numItems < bytes) |
|
{ |
|
if (!feof(fRef)) |
|
{ |
|
hsDebugMessage("Error on UNIX Read", ferror(fRef)); |
|
} |
|
} |
|
return numItems; |
|
} |
|
|
|
bool hsUNIXStream::AtEnd() |
|
{ |
|
if (!fRef) |
|
return 1; |
|
bool rVal; |
|
int x = getc(fRef); |
|
rVal = feof(fRef) != 0; |
|
ungetc(x, fRef); |
|
return rVal; |
|
} |
|
|
|
uint32_t hsUNIXStream::Write(uint32_t bytes, const void* buffer) |
|
{ |
|
if (!fRef) |
|
return 0; |
|
fPosition += bytes; |
|
return fwrite(buffer, bytes, 1, fRef); |
|
} |
|
|
|
void hsUNIXStream::SetPosition(uint32_t position) |
|
{ |
|
if (!fRef || (position == fPosition)) |
|
return; |
|
fBytesRead = position; |
|
fPosition = position; |
|
(void)::fseek(fRef, position, SEEK_SET); |
|
} |
|
|
|
void hsUNIXStream::Skip(uint32_t delta) |
|
{ |
|
if (!fRef) |
|
return; |
|
fBytesRead += delta; |
|
fPosition += delta; |
|
(void)::fseek(fRef, delta, SEEK_CUR); |
|
} |
|
|
|
void hsUNIXStream::Rewind() |
|
{ |
|
if (!fRef) |
|
return; |
|
fBytesRead = 0; |
|
fPosition = 0; |
|
(void)::fseek(fRef, 0, SEEK_SET); |
|
} |
|
|
|
void hsUNIXStream::FastFwd() |
|
{ |
|
if (!fRef) |
|
return; |
|
(void)::fseek(fRef, 0, SEEK_END); |
|
fBytesRead = fPosition = ftell(fRef); |
|
} |
|
|
|
uint32_t hsUNIXStream::GetEOF() |
|
{ |
|
if( !fRef ) |
|
return 0; |
|
|
|
long oldPos = ftell( fRef ); |
|
(void)::fseek( fRef, 0, SEEK_END ); |
|
uint32_t end = (uint32_t)ftell( fRef ); |
|
(void)::fseek( fRef, oldPos, SEEK_SET ); |
|
|
|
return end; |
|
} |
|
|
|
void hsUNIXStream::Truncate() |
|
{ |
|
if (!fRef) |
|
return; |
|
int handle = fileno(fRef); |
|
#if HS_BUILD_FOR_WIN32 |
|
_chsize(handle, fPosition); |
|
#else |
|
ftruncate(handle, fPosition); |
|
#endif |
|
} |
|
|
|
void hsUNIXStream::Flush() |
|
{ |
|
if (!fRef) |
|
return; |
|
(void)::fflush(fRef); |
|
} |
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////////// |
|
|
|
plReadOnlySubStream::~plReadOnlySubStream() |
|
{ |
|
} |
|
|
|
void plReadOnlySubStream::Open( hsStream *base, uint32_t offset, uint32_t length ) |
|
{ |
|
fBase = base; |
|
fOffset = offset; |
|
fLength = length; |
|
|
|
fBase->SetPosition( fOffset ); |
|
IFixPosition(); |
|
} |
|
|
|
void plReadOnlySubStream::IFixPosition( void ) |
|
{ |
|
fPosition = fBase->GetPosition() - fOffset; |
|
} |
|
|
|
bool plReadOnlySubStream::AtEnd() |
|
{ |
|
if( fPosition >= fLength ) |
|
return true; |
|
return false; |
|
} |
|
|
|
uint32_t plReadOnlySubStream::Read(uint32_t byteCount, void* buffer) |
|
{ |
|
if( byteCount > GetSizeLeft() ) |
|
{ |
|
hsThrow("Attempting to read past end of stream"); |
|
byteCount = GetSizeLeft(); |
|
} |
|
|
|
uint32_t read = fBase->Read( byteCount, buffer ); |
|
IFixPosition(); |
|
return read; |
|
} |
|
|
|
uint32_t plReadOnlySubStream::Write(uint32_t byteCount, const void* buffer) |
|
{ |
|
hsAssert( false, "Write not allowed on an plReadOnlySubStream" ); |
|
return 0; |
|
} |
|
|
|
void plReadOnlySubStream::Skip(uint32_t deltaByteCount) |
|
{ |
|
fBase->Skip( deltaByteCount ); |
|
IFixPosition(); |
|
} |
|
|
|
void plReadOnlySubStream::Rewind() |
|
{ |
|
fBase->SetPosition( fOffset ); |
|
IFixPosition(); |
|
} |
|
|
|
void plReadOnlySubStream::FastFwd() |
|
{ |
|
fBase->SetPosition( fOffset + fLength ); |
|
IFixPosition(); |
|
} |
|
|
|
void plReadOnlySubStream::Truncate() |
|
{ |
|
hsAssert( false, "Can't truncate a read-only stream" ); |
|
} |
|
|
|
uint32_t plReadOnlySubStream::GetEOF() |
|
{ |
|
return fLength; |
|
} |
|
|
|
////////////////////////////////////////////////////////////////////////////////////// |
|
|
|
#define kRAMStreamChunkSize 1024 |
|
|
|
hsRAMStream::hsRAMStream() : fAppender(1, kRAMStreamChunkSize) |
|
{ |
|
fIter.ResetToHead(&fAppender); |
|
} |
|
|
|
hsRAMStream::hsRAMStream(uint32_t chunkSize) : fAppender(1, chunkSize) |
|
{ |
|
fIter.ResetToHead(&fAppender); |
|
} |
|
|
|
hsRAMStream::~hsRAMStream() |
|
{ |
|
} |
|
|
|
void hsRAMStream::Reset() |
|
{ |
|
fBytesRead = 0; |
|
fPosition = 0; |
|
|
|
fAppender.Reset(); |
|
fIter.ResetToHead(&fAppender); |
|
} |
|
|
|
bool hsRAMStream::AtEnd() |
|
{ |
|
return (fBytesRead >= fAppender.Count() * fAppender.ElemSize()); |
|
} |
|
|
|
uint32_t hsRAMStream::Read(uint32_t byteCount, void * buffer) |
|
{ |
|
if (fBytesRead + byteCount > fAppender.Count() * fAppender.ElemSize()) |
|
byteCount = (fAppender.Count() * fAppender.ElemSize()) - fBytesRead; |
|
|
|
fBytesRead += byteCount; |
|
fPosition += byteCount; |
|
|
|
fIter.Next(byteCount, buffer); |
|
|
|
return byteCount; |
|
} |
|
|
|
uint32_t hsRAMStream::Write(uint32_t byteCount, const void* buffer) |
|
{ |
|
fPosition += byteCount; |
|
|
|
fAppender.PushTail(byteCount, buffer); |
|
|
|
return byteCount; |
|
} |
|
|
|
void hsRAMStream::Skip(uint32_t deltaByteCount) |
|
{ |
|
fPosition += deltaByteCount; |
|
fIter.Next(deltaByteCount, nil); |
|
} |
|
|
|
void hsRAMStream::Rewind() |
|
{ |
|
fBytesRead = 0; |
|
fPosition = 0; |
|
fIter.ResetToHead(&fAppender); |
|
} |
|
|
|
void hsRAMStream::Truncate() |
|
{ |
|
Reset(); |
|
} |
|
|
|
uint32_t hsRAMStream::GetEOF() |
|
{ |
|
return fAppender.Count() * fAppender.ElemSize(); |
|
} |
|
|
|
void hsRAMStream::CopyToMem(void* mem) |
|
{ |
|
(void)fAppender.CopyInto(mem); |
|
} |
|
|
|
////////////////////////////////////////////////////////////////////// |
|
|
|
uint32_t hsNullStream::Read(uint32_t byteCount, void * buffer) |
|
{ |
|
hsThrow("hsNullStream: Can't read from this stream!"); |
|
return 0; |
|
} |
|
|
|
uint32_t hsNullStream::Write(uint32_t byteCount, const void* buffer) |
|
{ |
|
fBytesRead += byteCount; |
|
fPosition += byteCount; |
|
|
|
return byteCount; |
|
} |
|
|
|
void hsNullStream::Skip(uint32_t deltaByteCount) |
|
{ |
|
fBytesRead += deltaByteCount; |
|
fPosition += deltaByteCount; |
|
} |
|
|
|
void hsNullStream::Rewind() |
|
{ |
|
fBytesRead = 0; |
|
fPosition = 0; |
|
} |
|
|
|
void hsNullStream::Truncate() |
|
{ |
|
} |
|
|
|
///////////////////////////////////////////////////////////////////////////////// |
|
|
|
bool hsReadOnlyStream::AtEnd() |
|
{ |
|
return fData >= fStop; |
|
} |
|
|
|
uint32_t hsReadOnlyStream::Read(uint32_t byteCount, void* buffer) |
|
{ |
|
if (fData + byteCount > fStop) |
|
{ |
|
hsThrow("Attempting to read past end of stream"); |
|
byteCount = GetSizeLeft(); |
|
} |
|
|
|
HSMemory::BlockMove(fData, buffer, byteCount); |
|
fData += byteCount; |
|
fBytesRead += byteCount; |
|
fPosition += byteCount; |
|
return byteCount; |
|
} |
|
|
|
uint32_t hsReadOnlyStream::Write(uint32_t byteCount, const void* buffer) |
|
{ |
|
hsThrow( "can't write to a readonly stream"); |
|
return 0; |
|
} |
|
|
|
void hsReadOnlyStream::Skip(uint32_t deltaByteCount) |
|
{ |
|
fBytesRead += deltaByteCount; |
|
fPosition += deltaByteCount; |
|
fData += deltaByteCount; |
|
if (fData > fStop) |
|
hsThrow( "Skip went past end of stream"); |
|
} |
|
|
|
void hsReadOnlyStream::Rewind() |
|
{ |
|
fBytesRead = 0; |
|
fPosition = 0; |
|
fData = fStart; |
|
} |
|
|
|
void hsReadOnlyStream::Truncate() |
|
{ |
|
hsThrow( "can't write to a readonly stream"); |
|
} |
|
|
|
void hsReadOnlyStream::CopyToMem(void* mem) |
|
{ |
|
if (fData < fStop) |
|
HSMemory::BlockMove(fData, mem, fStop-fData); |
|
} |
|
|
|
|
|
//////////////////////////////////////////////////////////////////////////////////// |
|
uint32_t hsWriteOnlyStream::Read(uint32_t byteCount, void* buffer) |
|
{ |
|
hsThrow( "can't read to a writeonly stream"); |
|
return 0; |
|
} |
|
|
|
uint32_t hsWriteOnlyStream::Write(uint32_t byteCount, const void* buffer) |
|
{ |
|
if (fData + byteCount > fStop) |
|
hsThrow("Write past end of stream"); |
|
HSMemory::BlockMove(buffer, fData, byteCount); |
|
fData += byteCount; |
|
fBytesRead += byteCount; |
|
fPosition += byteCount; |
|
return byteCount; |
|
} |
|
|
|
|
|
/////////////////////////////////////////////////////////////////////////////////// |
|
|
|
hsQueueStream::hsQueueStream(int32_t size) : |
|
fSize(size), |
|
fReadCursor(0), |
|
fWriteCursor(0) |
|
{ |
|
fQueue = new char[fSize]; |
|
} |
|
|
|
hsQueueStream::~hsQueueStream() |
|
{ |
|
delete [] fQueue; |
|
} |
|
|
|
uint32_t hsQueueStream::Read(uint32_t byteCount, void * buffer) |
|
{ |
|
hsAssert(fWriteCursor >= 0 && fWriteCursor < fSize,"hsQueueStream: WriteCursor out of range."); |
|
hsAssert(fReadCursor >= 0 && fReadCursor < fSize,"hsQueueStream: ReadCursor out of range."); |
|
|
|
int32_t limit, length, total; |
|
|
|
limit = fWriteCursor >= fReadCursor ? fWriteCursor : fSize; |
|
length = hsMinimum(limit-fReadCursor,byteCount); |
|
HSMemory::BlockMove(fQueue+fReadCursor,buffer,length); |
|
fReadCursor += length; |
|
fReadCursor %= fSize; |
|
total = length; |
|
|
|
if (length < byteCount && limit != fWriteCursor) |
|
{ |
|
limit = fWriteCursor; |
|
length = hsMinimum(limit,byteCount-length); |
|
HSMemory::BlockMove(fQueue,static_cast<char*>(buffer)+total,length); |
|
fReadCursor = length; |
|
total += length; |
|
} |
|
|
|
return total; |
|
} |
|
|
|
uint32_t hsQueueStream::Write(uint32_t byteCount, const void* buffer) |
|
{ |
|
hsAssert(fWriteCursor >= 0 && fWriteCursor < fSize,"hsQueueStream: WriteCursor out of range."); |
|
hsAssert(fReadCursor >= 0 && fReadCursor < fSize,"hsQueueStream: ReadCursor out of range."); |
|
|
|
int32_t length; |
|
|
|
length = hsMinimum(fSize-fWriteCursor,byteCount); |
|
HSMemory::BlockMove(buffer,fQueue+fWriteCursor,length); |
|
if (fReadCursor > fWriteCursor) |
|
{ |
|
#if 0 |
|
if (fReadCursor < fWriteCursor+length+1) |
|
hsStatusMessage("ReadCursor wrapped\n"); |
|
#endif |
|
fReadCursor = hsMaximum(fReadCursor,fWriteCursor+length+1); |
|
fReadCursor %= fSize; |
|
} |
|
fWriteCursor += length; |
|
fWriteCursor %= fSize; |
|
|
|
if (length < byteCount) |
|
{ |
|
Write(byteCount - length,static_cast<const char*>(buffer)+length); |
|
} |
|
|
|
return byteCount; |
|
} |
|
|
|
void hsQueueStream::Skip(uint32_t deltaByteCount) |
|
{ |
|
int32_t limit, length; |
|
|
|
limit = fWriteCursor >= fReadCursor ? fWriteCursor : fSize; |
|
length = hsMinimum(limit-fReadCursor,deltaByteCount); |
|
fReadCursor += length; |
|
|
|
if (length < deltaByteCount && limit != fWriteCursor) |
|
{ |
|
limit = fWriteCursor; |
|
length = hsMinimum(limit,deltaByteCount-length); |
|
fReadCursor = length; |
|
} |
|
else |
|
{ |
|
fReadCursor %= fSize; |
|
} |
|
} |
|
|
|
void hsQueueStream::Rewind() |
|
{ |
|
fReadCursor = fWriteCursor+1; |
|
fReadCursor %= fSize; |
|
} |
|
|
|
void hsQueueStream::FastFwd() |
|
{ |
|
fReadCursor = fWriteCursor; |
|
} |
|
|
|
bool hsQueueStream::AtEnd() |
|
{ |
|
return fReadCursor == fWriteCursor; |
|
} |
|
|
|
/////////////////////////////////////////////////////////////////////////////// |
|
// hsBufferedStream |
|
/////////////////////////////////////////////////////////////////////////////// |
|
|
|
inline void FastByteCopy(void* dest, const void* src, uint32_t bytes) |
|
{ |
|
// Don't use memcpy if the read is 4 bytes or less, it's faster to just do a |
|
// direct copy |
|
switch (bytes) |
|
{ |
|
case 4: |
|
*((uint32_t*)dest) = *((const uint32_t*)src); |
|
break; |
|
case 2: |
|
*((uint16_t*)dest) = *((const uint16_t*)src); |
|
break; |
|
case 1: |
|
*((uint8_t*)dest) = *((const uint8_t*)src); |
|
break; |
|
default: |
|
memcpy(dest, src, bytes); |
|
} |
|
} |
|
|
|
//#define LOG_BUFFERED |
|
|
|
hsBufferedStream::hsBufferedStream() |
|
: fRef(nil) |
|
, fFileSize(0) |
|
, fBufferLen(0) |
|
, fWriteBufferUsed(false) |
|
#ifdef HS_DEBUGGING |
|
, fBufferHits(0) |
|
, fBufferMisses(0) |
|
, fBufferReadIn(0) |
|
, fBufferReadOut(0) |
|
, fReadDirect(0) |
|
, fLastReadPos(0) |
|
, fCloseReason(nil) |
|
#endif |
|
{ |
|
} |
|
|
|
bool hsBufferedStream::Open(const plFileName& name, const char* mode) |
|
{ |
|
hsAssert(!fRef, "hsBufferedStream:Open Stream already opened"); |
|
fRef = plFileSystem::Open(name, mode); |
|
if (!fRef) |
|
return false; |
|
|
|
SetFileRef(fRef); |
|
|
|
#ifdef LOG_BUFFERED |
|
fBufferHits = fBufferMisses = 0; |
|
fBufferReadIn = fBufferReadOut = fReadDirect = fLastReadPos = 0; |
|
fFilename = name; |
|
fCloseReason = nil; |
|
#endif // LOG_BUFFERED |
|
|
|
return true; |
|
} |
|
|
|
bool hsBufferedStream::Close() |
|
{ |
|
int rtn = true; |
|
if (fRef) |
|
rtn = fclose(fRef); |
|
fRef = nil; |
|
|
|
#ifdef LOG_BUFFERED |
|
hsUNIXStream s; |
|
static bool firstClose = true; |
|
if (firstClose) |
|
{ |
|
firstClose = false; |
|
s.Open("log\\BufferedStream.csv", "wt"); |
|
s.WriteString("File,Hits,Misses,Read In,Read Out,Read Direct,% Wasted,Reason\n"); |
|
} |
|
else |
|
s.Open("log\\BufferedStream.csv", "at"); |
|
|
|
int wasted = 100; |
|
if (fBufferReadIn + fReadDirect > 0) |
|
wasted -= int((float(fBufferReadOut+fReadDirect) / float(fBufferReadIn+fReadDirect)) * 100.f); |
|
|
|
s.WriteFmt("%s,%d,%d,%u,%u,%u,%d,%s\n", |
|
fFilename.c_str(), fBufferHits, fBufferMisses, fBufferReadIn, fBufferReadOut, fReadDirect, |
|
wasted, |
|
fCloseReason ? fCloseReason : "Unknown"); |
|
|
|
s.Close(); |
|
#endif // LOG_BUFFERED |
|
|
|
return !rtn; |
|
} |
|
|
|
FILE* hsBufferedStream::GetFileRef() |
|
{ |
|
return fRef; |
|
} |
|
|
|
void hsBufferedStream::SetFileRef(FILE* ref) |
|
{ |
|
hsAssert(ref, "bad ref"); |
|
fRef = ref; |
|
|
|
fseek(fRef, 0, SEEK_END); |
|
fFileSize = ftell(fRef); |
|
fseek(fRef, 0, SEEK_SET); |
|
|
|
fBufferLen = 0; |
|
fPosition = 0; |
|
fWriteBufferUsed = false; |
|
} |
|
|
|
uint32_t hsBufferedStream::Read(uint32_t bytes, void* buffer) |
|
{ |
|
hsAssert(fRef, "fRef uninitialized"); |
|
if (!fRef || bytes == 0) |
|
return 0; |
|
|
|
uint32_t numReadBytes = 0; |
|
|
|
while (bytes > 0 && fPosition < fFileSize) |
|
{ |
|
// First, see if we've got anything in the buffer |
|
if (fBufferLen > 0) |
|
{ |
|
// Figure out how much we can copy out of the buffer |
|
uint32_t bufferPos = fPosition % kBufferSize; |
|
uint32_t bytesInBuffer = fBufferLen - bufferPos; |
|
uint32_t cachedReadSize = bytesInBuffer < bytes ? bytesInBuffer : bytes; |
|
|
|
FastByteCopy(buffer, &fBuffer[bufferPos], cachedReadSize); |
|
|
|
fPosition += cachedReadSize; |
|
numReadBytes += cachedReadSize; |
|
bytes -= cachedReadSize; |
|
buffer = (void*)(((char*)buffer) + cachedReadSize); |
|
|
|
// If we read all the data out of the buffer, set it to empty |
|
if ((bufferPos + cachedReadSize) == fBufferLen) |
|
fBufferLen = 0; |
|
|
|
#ifdef HS_DEBUGGING |
|
fLastReadPos = fPosition; |
|
fBufferHits++; |
|
fBufferReadOut += cachedReadSize; |
|
#endif |
|
} |
|
|
|
// Now see if the remaining read (if any) is the size of the buffer or larger. |
|
// If it is, read as many complete blocks as possible directly into the output buffer. |
|
if (bytes >= kBufferSize && fPosition % kBufferSize == 0) |
|
{ |
|
uint32_t directReadSize = bytes - (bytes % kBufferSize); |
|
hsAssert(ftell(fRef) % kBufferSize == 0 , "read buffer is not in alignment."); |
|
int amtRead = ::fread(buffer, 1, directReadSize, fRef); |
|
fPosition += amtRead; |
|
numReadBytes += amtRead; |
|
bytes -= amtRead; |
|
buffer = (void*)(((char*)buffer) + amtRead); |
|
#ifdef HS_DEBUGGING |
|
fLastReadPos = fPosition; |
|
fReadDirect += directReadSize; |
|
#endif |
|
} |
|
|
|
// If we've got bytes left to read and we didn't pass the end of the file, buffer a new block |
|
if (bytes > 0 && fPosition < fFileSize) |
|
{ |
|
hsAssert(ftell(fRef) % kBufferSize == 0 , "read buffer is not in alignment."); |
|
fBufferLen = ::fread(fBuffer, 1, kBufferSize, fRef); |
|
|
|
#ifdef HS_DEBUGGING |
|
// If our last read wasn't at the start of the new buffer, it's a miss. |
|
if (fLastReadPos != fPosition) |
|
{ |
|
fBufferMisses++; |
|
fBufferHits--; |
|
} |
|
|
|
fBufferReadIn += fBufferLen; |
|
#endif |
|
} |
|
} |
|
|
|
return numReadBytes; |
|
} |
|
|
|
uint32_t hsBufferedStream::Write(uint32_t bytes, const void* buffer) |
|
{ |
|
hsAssert(fRef, "fRef uninitialized"); |
|
fWriteBufferUsed = true; |
|
int amtWritten = fwrite((void*)buffer, 1, bytes, fRef); |
|
fPosition += amtWritten; |
|
return amtWritten; |
|
} |
|
|
|
bool hsBufferedStream::AtEnd() |
|
{ |
|
if (fWriteBufferUsed) |
|
{ |
|
if (!fRef) |
|
return true; |
|
bool rVal; |
|
int x = getc(fRef); |
|
rVal = feof(fRef) != 0; |
|
ungetc(x, fRef); |
|
return rVal; |
|
} |
|
else |
|
{ |
|
// buffered read |
|
return fPosition >= fFileSize; |
|
} |
|
} |
|
|
|
void hsBufferedStream::Skip(uint32_t delta) |
|
{ |
|
if (fWriteBufferUsed) |
|
{ |
|
// buffered write not implemented yet. |
|
fseek(fRef, delta, SEEK_CUR); |
|
} |
|
else |
|
{ |
|
uint32_t blockStart = ((fPosition + delta) / kBufferSize) * kBufferSize; |
|
|
|
// We've got data in the buffer, see if we can just skip in that |
|
if (fBufferLen > 0) |
|
{ |
|
int32_t newBufferPos = int32_t(fPosition % kBufferSize) + int32_t(delta); |
|
|
|
// If we skipped outside of our buffer, invalidate it |
|
if (newBufferPos < 0 || uint32_t(newBufferPos) >= fBufferLen) |
|
{ |
|
fBufferLen = 0; |
|
fseek(fRef, blockStart, SEEK_SET); |
|
} |
|
} |
|
else |
|
fseek(fRef, blockStart, SEEK_SET); |
|
} |
|
|
|
fPosition += delta; |
|
} |
|
|
|
void hsBufferedStream::Rewind() |
|
{ |
|
if (fWriteBufferUsed) |
|
{ |
|
// buffered write not implemented yet. |
|
fseek(fRef, 0, SEEK_SET); |
|
} |
|
// If the currently buffered block isn't the first one, invalidate our buffer |
|
else if (fPosition >= kBufferSize) |
|
fBufferLen = 0; |
|
|
|
fPosition = 0; |
|
} |
|
|
|
uint32_t hsBufferedStream::GetEOF() |
|
{ |
|
if (fWriteBufferUsed) |
|
{ |
|
if (!fRef) |
|
return 0; |
|
|
|
long oldPos = ftell(fRef); |
|
fseek(fRef, 0, SEEK_END); |
|
uint32_t end = (uint32_t)ftell(fRef); |
|
fseek(fRef, oldPos, SEEK_SET); |
|
|
|
return end; |
|
} |
|
else |
|
return fFileSize; |
|
} |
|
|
|
void hsBufferedStream::Truncate() |
|
{ |
|
hsAssert(0, "hsBufferedStream::Truncate unimplemented"); |
|
}
|
|
|