mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-04 13:13:25 +03:00
2b2be3fb82
0030551: Foundation Classes - Integer overflow in NCollection_CellFilter HashCode Signed integers are not used in hash code functions now to prevent undefined behavior on left shift operations with signed integers. A possibility of negative values of hash codes is eliminated. INT_MAX → IntegerLast() in hash code functions. All found hash code functions behaves uniformly now: they return a value in the range [1, theUpperBound]. Relevant comments are added to such functions.
450 lines
15 KiB
C++
450 lines
15 KiB
C++
// Created: 2016-05-01
|
|
// Author: Andrey Betenev
|
|
// Copyright: Open CASCADE 2016
|
|
//
|
|
// This file is part of Open CASCADE Technology software library.
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it under
|
|
// the terms of the GNU Lesser General Public License version 2.1 as published
|
|
// by the Free Software Foundation, with special exception defined in the file
|
|
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
// distribution for complete text of the license and disclaimer of any warranty.
|
|
//
|
|
// Alternatively, this file may be used under the terms of Open CASCADE
|
|
// commercial license or contractual agreement.
|
|
|
|
#include <RWStl_Reader.hxx>
|
|
|
|
#include <gp_XY.hxx>
|
|
#include <Message.hxx>
|
|
#include <Message_Messenger.hxx>
|
|
#include <Message_ProgressSentry.hxx>
|
|
#include <NCollection_DataMap.hxx>
|
|
#include <NCollection_IncAllocator.hxx>
|
|
#include <FSD_BinaryFile.hxx>
|
|
#include <OSD_OpenFile.hxx>
|
|
#include <OSD_Timer.hxx>
|
|
#include <Precision.hxx>
|
|
#include <Standard_CLocaleSentry.hxx>
|
|
|
|
#include <algorithm>
|
|
#include <limits>
|
|
|
|
IMPLEMENT_STANDARD_RTTIEXT(RWStl_Reader, Standard_Transient)
|
|
|
|
namespace
|
|
{
|
|
// Binary STL sizes
|
|
static const size_t THE_STL_HEADER_SIZE = 84;
|
|
static const size_t THE_STL_SIZEOF_FACET = 50;
|
|
static const size_t THE_STL_MIN_FILE_SIZE = THE_STL_HEADER_SIZE + THE_STL_SIZEOF_FACET;
|
|
|
|
//! Auxiliary tool for merging nodes during STL reading.
|
|
class MergeNodeTool
|
|
{
|
|
public:
|
|
|
|
//! Constructor
|
|
MergeNodeTool (RWStl_Reader* theReader)
|
|
: myReader (theReader),
|
|
myMap (1024, new NCollection_IncAllocator (1024 * 1024))
|
|
{
|
|
}
|
|
|
|
//! Add new triangle
|
|
int AddNode (double theX, double theY, double theZ)
|
|
{
|
|
// use existing node if found at the same point
|
|
gp_XYZ aPnt (theX, theY, theZ);
|
|
|
|
Standard_Integer anIndex = -1;
|
|
if (myMap.Find (aPnt, anIndex))
|
|
{
|
|
return anIndex;
|
|
}
|
|
|
|
anIndex = myReader->AddNode (aPnt);
|
|
myMap.Bind (aPnt, anIndex);
|
|
return anIndex;
|
|
}
|
|
|
|
public:
|
|
|
|
static Standard_Boolean IsEqual (const gp_XYZ& thePnt1, const gp_XYZ& thePnt2)
|
|
{
|
|
return (thePnt1 - thePnt2).SquareModulus() < Precision::SquareConfusion();
|
|
}
|
|
|
|
//! Computes a hash code for the point, in the range [1, theUpperBound]
|
|
//! @param thePoint the point which hash code is to be computed
|
|
//! @param theUpperBound the upper bound of the range a computing hash code must be within
|
|
//! @return a computed hash code, in the range [1, theUpperBound]
|
|
static Standard_Integer HashCode (const gp_XYZ& thePoint, const Standard_Integer theUpperBound)
|
|
{
|
|
return ::HashCode (thePoint.X() * M_LN10 + thePoint.Y() * M_PI + thePoint.Z() * M_E, theUpperBound);
|
|
}
|
|
|
|
private:
|
|
RWStl_Reader* myReader;
|
|
NCollection_DataMap<gp_XYZ, Standard_Integer, MergeNodeTool> myMap;
|
|
};
|
|
|
|
//! Read a Little Endian 32 bits float
|
|
inline static float readStlFloat (const char* theData)
|
|
{
|
|
#if OCCT_BINARY_FILE_DO_INVERSE
|
|
// on big-endian platform, map values byte-per-byte
|
|
union
|
|
{
|
|
uint32_t i;
|
|
float f;
|
|
} bidargum;
|
|
bidargum.i = theData[0] & 0xFF;
|
|
bidargum.i |= (theData[1] & 0xFF) << 0x08;
|
|
bidargum.i |= (theData[2] & 0xFF) << 0x10;
|
|
bidargum.i |= (theData[3] & 0xFF) << 0x18;
|
|
return bidargum.f;
|
|
#else
|
|
// on little-endian platform, use plain cast
|
|
return *reinterpret_cast<const float*>(theData);
|
|
#endif
|
|
}
|
|
|
|
//! Read a Little Endian 32 bits float
|
|
inline static gp_XYZ readStlFloatVec3 (const char* theData)
|
|
{
|
|
return gp_XYZ (readStlFloat (theData),
|
|
readStlFloat (theData + sizeof(float)),
|
|
readStlFloat (theData + sizeof(float) * 2));
|
|
}
|
|
|
|
}
|
|
|
|
//==============================================================================
|
|
//function : Read
|
|
//purpose :
|
|
//==============================================================================
|
|
|
|
Standard_Boolean RWStl_Reader::Read (const char* theFile,
|
|
const Handle(Message_ProgressIndicator)& theProgress)
|
|
{
|
|
std::filebuf aBuf;
|
|
OSD_OpenStream (aBuf, theFile, std::ios::in | std::ios::binary);
|
|
if (!aBuf.is_open())
|
|
{
|
|
return Standard_False;
|
|
}
|
|
|
|
Standard_IStream aStream (&aBuf);
|
|
|
|
// get length of file to feed progress indicator in Ascii mode
|
|
aStream.seekg (0, aStream.end);
|
|
std::streampos theEnd = aStream.tellg();
|
|
aStream.seekg (0, aStream.beg);
|
|
|
|
// binary STL files cannot be shorter than 134 bytes
|
|
// (80 bytes header + 4 bytes facet count + 50 bytes for one facet);
|
|
// thus assume files shorter than 134 as Ascii without probing
|
|
// (probing may bring stream to fail state if EOF is reached)
|
|
bool isAscii = ((size_t)theEnd < THE_STL_MIN_FILE_SIZE || IsAscii (aStream));
|
|
|
|
while (aStream.good())
|
|
{
|
|
if (isAscii)
|
|
{
|
|
if (!ReadAscii (aStream, theEnd, theProgress))
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (!ReadBinary (aStream, theProgress))
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
aStream >> std::ws; // skip any white spaces
|
|
}
|
|
return ! aStream.fail();
|
|
}
|
|
|
|
//==============================================================================
|
|
//function : IsAscii
|
|
//purpose :
|
|
//==============================================================================
|
|
|
|
Standard_Boolean RWStl_Reader::IsAscii (Standard_IStream& theStream)
|
|
{
|
|
// read first 134 bytes to detect file format
|
|
char aBuffer[THE_STL_MIN_FILE_SIZE];
|
|
std::streamsize aNbRead = theStream.read (aBuffer, THE_STL_MIN_FILE_SIZE).gcount();
|
|
if (! theStream)
|
|
{
|
|
Message::DefaultMessenger()->Send ("Error: Cannot read file", Message_Fail);
|
|
return true;
|
|
}
|
|
|
|
// put back the read symbols
|
|
for (std::streamsize aByteIter = aNbRead; aByteIter > 0; --aByteIter)
|
|
{
|
|
theStream.unget();
|
|
}
|
|
|
|
// if file is shorter than size of binary file with 1 facet, it must be ascii
|
|
if (aNbRead < std::streamsize(THE_STL_MIN_FILE_SIZE))
|
|
{
|
|
return true;
|
|
}
|
|
|
|
// otherwise, detect binary format by presence of non-ascii symbols in first 128 bytes
|
|
// (note that binary STL file may start with the same bytes "solid " as Ascii one)
|
|
for (Standard_Integer aByteIter = 0; aByteIter < aNbRead; ++aByteIter)
|
|
{
|
|
if ((unsigned char )aBuffer[aByteIter] > (unsigned char )'~')
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
// adapted from Standard_CString.cxx
|
|
#ifdef __APPLE__
|
|
// There are a lot of *_l functions availalbe on Mac OS X - we use them
|
|
#define SAVE_TL()
|
|
#elif defined(_MSC_VER)
|
|
// MSVCRT has equivalents with slightly different syntax
|
|
#define SAVE_TL()
|
|
#define sscanf_l(theBuffer, theLocale, theFormat, ...) _sscanf_s_l(theBuffer, theFormat, theLocale, __VA_ARGS__)
|
|
#else
|
|
// glibc provides only limited xlocale implementation:
|
|
// strtod_l/strtol_l/strtoll_l functions with explicitly specified locale
|
|
// and newlocale/uselocale/freelocale to switch locale within current thread only.
|
|
// So we switch to C locale temporarily
|
|
#define SAVE_TL() Standard_CLocaleSentry aLocaleSentry;
|
|
#define sscanf_l(theBuffer, theLocale, theFormat, ...) sscanf(theBuffer, theFormat, __VA_ARGS__)
|
|
#endif
|
|
|
|
// Macro to get 64-bit position of the file from streampos
|
|
#if defined(_MSC_VER) && _MSC_VER < 1700
|
|
// In MSVC 2010, cast of streampos to 64-bit int is implemented incorrectly;
|
|
// work-around (relevant for files larger than 4 GB) is to use internal function seekpos().
|
|
// Since MSVC 15.8, seekpos() is deprecated and is said to always return 0.
|
|
#define GETPOS(aPos) aPos.seekpos()
|
|
#else
|
|
#define GETPOS(aPos) ((int64_t)aPos)
|
|
#endif
|
|
|
|
static inline bool str_starts_with (const char* theStr, const char* theWord, int theN)
|
|
{
|
|
while (isspace (*theStr) && *theStr != '\0') theStr++;
|
|
return !strncmp (theStr, theWord, theN);
|
|
}
|
|
|
|
static bool ReadVertex (const char* theStr, double& theX, double& theY, double& theZ)
|
|
{
|
|
const char *aStr = theStr;
|
|
|
|
// skip 'vertex'
|
|
while (isspace ((unsigned char)*aStr) || isalpha ((unsigned char)*aStr))
|
|
++aStr;
|
|
|
|
// read values
|
|
char *aEnd;
|
|
theX = Strtod (aStr, &aEnd);
|
|
theY = Strtod (aStr = aEnd, &aEnd);
|
|
theZ = Strtod (aStr = aEnd, &aEnd);
|
|
|
|
return aEnd != aStr;
|
|
}
|
|
|
|
//==============================================================================
|
|
//function : ReadAscii
|
|
//purpose :
|
|
//==============================================================================
|
|
Standard_Boolean RWStl_Reader::ReadAscii (Standard_IStream& theStream,
|
|
const std::streampos theUntilPos,
|
|
const Handle(Message_ProgressIndicator)& theProgress)
|
|
{
|
|
// use method seekpos() to get true 64-bit offset to enable
|
|
// handling of large files (VS 2010 64-bit)
|
|
const int64_t aStartPos = GETPOS(theStream.tellg());
|
|
// Note: 1 is added to theUntilPos to be sure to read the last symbol (relevant for files without EOL at the end)
|
|
const int64_t aEndPos = (theUntilPos > 0 ? 1 + GETPOS(theUntilPos) : std::numeric_limits<int64_t>::max());
|
|
|
|
// skip header "solid ..."
|
|
theStream.ignore ((std::streamsize)(aEndPos - aStartPos), '\n');
|
|
if (!theStream)
|
|
{
|
|
Message::DefaultMessenger()->Send ("Error: premature end of file", Message_Fail);
|
|
return false;
|
|
}
|
|
|
|
MergeNodeTool aMergeTool (this);
|
|
Standard_CLocaleSentry::clocale_t aLocale = Standard_CLocaleSentry::GetCLocale();
|
|
(void)aLocale; // to avoid warning on GCC where it is actually not used
|
|
SAVE_TL() // for GCC only, set C locale globally
|
|
|
|
// report progress every 1 MiB of read data
|
|
const int aStepB = 1024 * 1024;
|
|
const Standard_Integer aNbSteps = 1 + Standard_Integer((GETPOS(theUntilPos) - aStartPos) / aStepB);
|
|
Message_ProgressSentry aPSentry (theProgress, "Reading text STL file", 0, aNbSteps, 1);
|
|
|
|
int64_t aProgressPos = aStartPos + aStepB;
|
|
const int64_t LINELEN = 1024;
|
|
int aNbLine = 1;
|
|
char aLine1[LINELEN], aLine2[LINELEN], aLine3[LINELEN];
|
|
while (aPSentry.More())
|
|
{
|
|
if (GETPOS(theStream.tellg()) > aProgressPos)
|
|
{
|
|
aPSentry.Next();
|
|
aProgressPos += aStepB;
|
|
}
|
|
|
|
char facet[LINELEN], outer[LINELEN];
|
|
theStream.getline (facet, (std::streamsize)std::min (LINELEN, aEndPos - GETPOS(theStream.tellg()))); // "facet normal nx ny nz"
|
|
if (str_starts_with (facet, "endsolid", 8))
|
|
{
|
|
// end of STL code
|
|
break;
|
|
}
|
|
theStream.getline (outer, (std::streamsize)std::min (LINELEN, aEndPos - GETPOS(theStream.tellg()))); // "outer loop"
|
|
if (!str_starts_with (facet, "facet", 5) || !str_starts_with (outer, "outer", 5))
|
|
{
|
|
TCollection_AsciiString aStr ("Error: unexpected format of facet at line ");
|
|
aStr += aNbLine + 1;
|
|
Message::DefaultMessenger()->Send (aStr, Message_Fail);
|
|
return false;
|
|
}
|
|
|
|
theStream.getline (aLine1, (std::streamsize)std::min (LINELEN, aEndPos - GETPOS(theStream.tellg())));
|
|
theStream.getline (aLine2, (std::streamsize)std::min (LINELEN, aEndPos - GETPOS(theStream.tellg())));
|
|
theStream.getline (aLine3, (std::streamsize)std::min (LINELEN, aEndPos - GETPOS(theStream.tellg())));
|
|
|
|
// stop reading if end of file is reached;
|
|
// note that well-formatted file never ends by the vertex line
|
|
if (theStream.eof() || GETPOS(theStream.tellg()) >= aEndPos)
|
|
{
|
|
break;
|
|
}
|
|
|
|
if (!theStream)
|
|
{
|
|
Message::DefaultMessenger()->Send ("Error: premature end of file", Message_Fail);
|
|
return false;
|
|
}
|
|
aNbLine += 5;
|
|
|
|
Standard_Real x1, y1, z1, x2, y2, z2, x3, y3, z3;
|
|
if (! ReadVertex (aLine1, x1, y1, z1) ||
|
|
! ReadVertex (aLine2, x2, y2, z2) ||
|
|
! ReadVertex (aLine3, x3, y3, z3))
|
|
{
|
|
TCollection_AsciiString aStr ("Error: cannot read vertex co-ordinates at line ");
|
|
aStr += aNbLine;
|
|
Message::DefaultMessenger()->Send(aStr, Message_Fail);
|
|
return false;
|
|
}
|
|
|
|
// add triangle
|
|
int n1 = aMergeTool.AddNode (x1, y1, z1);
|
|
int n2 = aMergeTool.AddNode (x2, y2, z2);
|
|
int n3 = aMergeTool.AddNode (x3, y3, z3);
|
|
if (n1 != n2 && n2 != n3 && n3 != n1)
|
|
{
|
|
AddTriangle (n1, n2, n3);
|
|
}
|
|
|
|
theStream.ignore ((std::streamsize)(aEndPos - GETPOS(theStream.tellg())), '\n'); // skip "endloop"
|
|
theStream.ignore ((std::streamsize)(aEndPos - GETPOS(theStream.tellg())), '\n'); // skip "endfacet"
|
|
|
|
aNbLine += 2;
|
|
}
|
|
|
|
return aPSentry.More();
|
|
}
|
|
|
|
//==============================================================================
|
|
//function : readStlBinary
|
|
//purpose :
|
|
//==============================================================================
|
|
|
|
Standard_Boolean RWStl_Reader::ReadBinary (Standard_IStream& theStream,
|
|
const Handle(Message_ProgressIndicator)& theProgress)
|
|
{
|
|
/*
|
|
// the size of the file (minus the header size)
|
|
// must be a multiple of SIZEOF_STL_FACET
|
|
if ((theFileLen - THE_STL_HEADER_SIZE) % THE_STL_SIZEOF_FACET != 0
|
|
|| (theFileLen < THE_STL_MIN_FILE_SIZE))
|
|
{
|
|
Message::DefaultMessenger()->Send ("Error: Corrupted binary STL file (inconsistent file size)!", Message_Fail);
|
|
return Standard_False;
|
|
}
|
|
const Standard_Integer aNbFacets = Standard_Integer((theFileLen - THE_STL_HEADER_SIZE) / THE_STL_SIZEOF_FACET);
|
|
*/
|
|
|
|
// read file header at first
|
|
char aHeader[THE_STL_HEADER_SIZE + 1];
|
|
if (theStream.read (aHeader, THE_STL_HEADER_SIZE).gcount() != std::streamsize(THE_STL_HEADER_SIZE))
|
|
{
|
|
Message::DefaultMessenger()->Send ("Error: Corrupted binary STL file!", Message_Fail);
|
|
return false;
|
|
}
|
|
|
|
// number of facets is stored as 32-bit integer at position 80
|
|
const Standard_Integer aNbFacets = *(int32_t*)(aHeader + 80);
|
|
|
|
MergeNodeTool aMergeTool (this);
|
|
|
|
// don't trust the number of triangles which is coded in the file
|
|
// sometimes it is wrong, and with this technique we don't need to swap endians for integer
|
|
Message_ProgressSentry aPSentry (theProgress, "Reading binary STL file", 0, aNbFacets, 1);
|
|
Standard_Integer aNbRead = 0;
|
|
|
|
// allocate buffer for 80 triangles
|
|
const int THE_CHUNK_NBFACETS = 80;
|
|
char aBuffer[THE_STL_SIZEOF_FACET * THE_CHUNK_NBFACETS];
|
|
|
|
// normal + 3 nodes + 2 extra bytes
|
|
const size_t aVec3Size = sizeof(float) * 3;
|
|
const size_t aFaceDataLen = aVec3Size * 4 + 2;
|
|
const char* aBufferPtr = aBuffer;
|
|
Standard_Integer aNbFacesInBuffer = 0;
|
|
for (Standard_Integer aNbFacetRead = 0; aNbFacetRead < aNbFacets && aPSentry.More();
|
|
++aNbFacetRead, ++aNbRead, --aNbFacesInBuffer, aBufferPtr += aFaceDataLen, aPSentry.Next())
|
|
{
|
|
// read more data
|
|
if (aNbFacesInBuffer <= 0)
|
|
{
|
|
aNbFacesInBuffer = Min (THE_CHUNK_NBFACETS, aNbFacets - aNbFacetRead);
|
|
const std::streamsize aDataToRead = aNbFacesInBuffer * aFaceDataLen;
|
|
if (theStream.read (aBuffer, aDataToRead).gcount() != aDataToRead)
|
|
{
|
|
Message::DefaultMessenger()->Send ("Error: binary STL read failed", Message_Fail);
|
|
return false;
|
|
}
|
|
aBufferPtr = aBuffer;
|
|
}
|
|
|
|
// get points from buffer
|
|
// readStlFloatVec3 (aBufferPtr); // skip normal
|
|
gp_XYZ aP1 = readStlFloatVec3 (aBufferPtr + aVec3Size);
|
|
gp_XYZ aP2 = readStlFloatVec3 (aBufferPtr + aVec3Size * 2);
|
|
gp_XYZ aP3 = readStlFloatVec3 (aBufferPtr + aVec3Size * 3);
|
|
|
|
// add triangle
|
|
int n1 = aMergeTool.AddNode (aP1.X(), aP1.Y(), aP1.Z());
|
|
int n2 = aMergeTool.AddNode (aP2.X(), aP2.Y(), aP2.Z());
|
|
int n3 = aMergeTool.AddNode (aP3.X(), aP3.Y(), aP3.Z());
|
|
if (n1 != n2 && n2 != n3 && n3 != n1)
|
|
{
|
|
AddTriangle (n1, n2, n3);
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|