0031213: Coding Rules, RWStl_Reader - misnamed variable THE_BUFFER
[occt.git] / src / RWStl / RWStl_Reader.cxx
1 // Created: 2016-05-01
2 // Author: Andrey Betenev
3 // Copyright: Open CASCADE 2016
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #include <RWStl_Reader.hxx>
17
18 #include <gp_XY.hxx>
19 #include <Message.hxx>
20 #include <Message_Messenger.hxx>
21 #include <Message_ProgressSentry.hxx>
22 #include <NCollection_DataMap.hxx>
23 #include <NCollection_IncAllocator.hxx>
24 #include <FSD_BinaryFile.hxx>
25 #include <OSD_OpenFile.hxx>
26 #include <OSD_Timer.hxx>
27 #include <Precision.hxx>
28 #include <Standard_CLocaleSentry.hxx>
29
30 #include <algorithm>
31 #include <limits>
32
33 IMPLEMENT_STANDARD_RTTIEXT(RWStl_Reader, Standard_Transient)
34
35 namespace
36 {
37   // Binary STL sizes
38   static const size_t THE_STL_HEADER_SIZE   = 84;
39   static const size_t THE_STL_SIZEOF_FACET  = 50;
40   static const size_t THE_STL_MIN_FILE_SIZE = THE_STL_HEADER_SIZE + THE_STL_SIZEOF_FACET;
41
42   // The length of buffer to read (in bytes)
43   static const size_t THE_BUFFER_SIZE = 1024;
44
45   //! Auxiliary tool for merging nodes during STL reading.
46   class MergeNodeTool
47   {
48   public:
49
50     //! Constructor
51     MergeNodeTool (RWStl_Reader* theReader)
52     : myReader (theReader),
53       myMap (1024, new NCollection_IncAllocator (1024 * 1024))
54     {
55     }
56
57     //! Add new triangle
58     int AddNode (double theX, double theY, double theZ)
59     {
60       // use existing node if found at the same point
61       gp_XYZ aPnt (theX, theY, theZ);
62
63       Standard_Integer anIndex = -1;
64       if (myMap.Find (aPnt, anIndex))
65       {
66         return anIndex;
67       }
68
69       anIndex = myReader->AddNode (aPnt);
70       myMap.Bind (aPnt, anIndex);
71       return anIndex;
72     }
73
74   public:
75
76     static Standard_Boolean IsEqual (const gp_XYZ& thePnt1, const gp_XYZ& thePnt2)
77     {
78       return (thePnt1 - thePnt2).SquareModulus() < Precision::SquareConfusion();
79     }
80
81     //! Computes a hash code for the point, in the range [1, theUpperBound]
82     //! @param thePoint the point which hash code is to be computed
83     //! @param theUpperBound the upper bound of the range a computing hash code must be within
84     //! @return a computed hash code, in the range [1, theUpperBound]
85     static Standard_Integer HashCode (const gp_XYZ& thePoint, const Standard_Integer theUpperBound)
86     {
87       return ::HashCode (thePoint.X() * M_LN10 + thePoint.Y() * M_PI + thePoint.Z() * M_E, theUpperBound);
88     }
89
90   private:
91     RWStl_Reader* myReader;
92     NCollection_DataMap<gp_XYZ, Standard_Integer, MergeNodeTool> myMap;
93   };
94
95   //! Read a Little Endian 32 bits float
96   inline static float readStlFloat (const char* theData)
97   {
98   #if OCCT_BINARY_FILE_DO_INVERSE
99     // on big-endian platform, map values byte-per-byte
100     union
101     {
102       uint32_t i;
103       float    f;
104     } bidargum;
105     bidargum.i  =  theData[0] & 0xFF;
106     bidargum.i |= (theData[1] & 0xFF) << 0x08;
107     bidargum.i |= (theData[2] & 0xFF) << 0x10;
108     bidargum.i |= (theData[3] & 0xFF) << 0x18;
109     return bidargum.f;
110   #else
111     // on little-endian platform, use plain cast
112     return *reinterpret_cast<const float*>(theData);
113   #endif
114   }
115
116   //! Read a Little Endian 32 bits float
117   inline static gp_XYZ readStlFloatVec3 (const char* theData)
118   {
119     return gp_XYZ (readStlFloat (theData),
120                    readStlFloat (theData + sizeof(float)),
121                    readStlFloat (theData + sizeof(float) * 2));
122   }
123
124 }
125
126 //==============================================================================
127 //function : Read
128 //purpose  :
129 //==============================================================================
130
131 Standard_Boolean RWStl_Reader::Read (const char* theFile,
132                                      const Handle(Message_ProgressIndicator)& theProgress)
133 {
134   std::filebuf aBuf;
135   OSD_OpenStream (aBuf, theFile, std::ios::in | std::ios::binary);
136   if (!aBuf.is_open())
137   {
138     return Standard_False;
139   }
140
141   Standard_IStream aStream (&aBuf);
142
143   // get length of file to feed progress indicator in Ascii mode
144   aStream.seekg (0, aStream.end);
145   std::streampos theEnd = aStream.tellg();
146   aStream.seekg (0, aStream.beg);
147
148   // binary STL files cannot be shorter than 134 bytes 
149   // (80 bytes header + 4 bytes facet count + 50 bytes for one facet);
150   // thus assume files shorter than 134 as Ascii without probing
151   // (probing may bring stream to fail state if EOF is reached)
152   bool isAscii = ((size_t)theEnd < THE_STL_MIN_FILE_SIZE || IsAscii (aStream));
153
154   Standard_ReadLineBuffer aBuffer (THE_BUFFER_SIZE);
155
156   while (aStream.good())
157   {
158     if (isAscii)
159     {
160       if (!ReadAscii (aStream, aBuffer, theEnd, theProgress))
161       {
162         break;
163       }
164     }
165     else
166     {
167       if (!ReadBinary (aStream, theProgress))
168       {
169         break;
170       }
171     }
172     aStream >> std::ws; // skip any white spaces
173   }
174   return ! aStream.fail();
175 }
176
177 //==============================================================================
178 //function : IsAscii
179 //purpose  :
180 //==============================================================================
181
182 Standard_Boolean RWStl_Reader::IsAscii (Standard_IStream& theStream)
183 {
184   // read first 134 bytes to detect file format
185   char aBuffer[THE_STL_MIN_FILE_SIZE];
186   std::streamsize aNbRead = theStream.read (aBuffer, THE_STL_MIN_FILE_SIZE).gcount();
187   if (! theStream)
188   {
189     Message::DefaultMessenger()->Send ("Error: Cannot read file", Message_Fail);
190     return true;
191   }
192
193   // put back the read symbols
194   for (std::streamsize aByteIter = aNbRead; aByteIter > 0; --aByteIter)
195   {
196     theStream.unget();
197   }
198
199   // if file is shorter than size of binary file with 1 facet, it must be ascii
200   if (aNbRead < std::streamsize(THE_STL_MIN_FILE_SIZE))
201   {
202     return true;
203   }
204
205   // otherwise, detect binary format by presence of non-ascii symbols in first 128 bytes
206   // (note that binary STL file may start with the same bytes "solid " as Ascii one)
207   for (Standard_Integer aByteIter = 0; aByteIter < aNbRead; ++aByteIter)
208   {
209     if ((unsigned char )aBuffer[aByteIter] > (unsigned char )'~')
210     {
211       return false;
212     }
213   }
214   return true;
215 }
216
217 // adapted from Standard_CString.cxx
218 #ifdef __APPLE__
219   // There are a lot of *_l functions availalbe on Mac OS X - we use them
220   #define SAVE_TL()
221 #elif defined(_MSC_VER)
222   // MSVCRT has equivalents with slightly different syntax
223   #define SAVE_TL()
224   #define sscanf_l(theBuffer, theLocale, theFormat, ...) _sscanf_s_l(theBuffer, theFormat, theLocale, __VA_ARGS__)
225 #else
226   // glibc provides only limited xlocale implementation:
227   // strtod_l/strtol_l/strtoll_l functions with explicitly specified locale
228   // and newlocale/uselocale/freelocale to switch locale within current thread only.
229   // So we switch to C locale temporarily
230   #define SAVE_TL() Standard_CLocaleSentry aLocaleSentry;
231   #define sscanf_l(theBuffer, theLocale, theFormat, ...) sscanf(theBuffer, theFormat, __VA_ARGS__)
232 #endif
233
234 // Macro to get 64-bit position of the file from std::streampos
235 #if defined(_MSC_VER) && _MSC_VER < 1700
236   // In MSVC 2010, cast of std::streampos to 64-bit int is implemented incorrectly;
237   // work-around (relevant for files larger than 4 GB) is to use internal function seekpos(). 
238   // Since MSVC 15.8, seekpos() is deprecated and is said to always return 0.
239   #define GETPOS(aPos) aPos.seekpos()
240 #else
241   #define GETPOS(aPos) ((int64_t)aPos)
242 #endif
243
244 # if defined(_MSC_VER) && ! defined(strncasecmp)
245 #  define strncasecmp _strnicmp
246 # endif
247
248 static inline bool str_starts_with (const char* theStr, const char* theWord, int theN)
249 {
250   while (isspace (*theStr) && *theStr != '\0') theStr++;
251   return !strncasecmp (theStr, theWord, theN); 
252 }
253
254 static bool ReadVertex (const char* theStr, double& theX, double& theY, double& theZ)
255 {
256   const char *aStr = theStr;
257
258   // skip 'vertex'
259   while (isspace ((unsigned char)*aStr) || isalpha ((unsigned char)*aStr)) 
260     ++aStr;
261
262   // read values
263   char *aEnd;
264   theX = Strtod (aStr, &aEnd);
265   theY = Strtod (aStr = aEnd, &aEnd);
266   theZ = Strtod (aStr = aEnd, &aEnd);
267
268   return aEnd != aStr;
269 }
270
271 //==============================================================================
272 //function : ReadAscii
273 //purpose  :
274 //==============================================================================
275 Standard_Boolean RWStl_Reader::ReadAscii (Standard_IStream& theStream,
276                                           Standard_ReadLineBuffer& theBuffer,
277                                           const std::streampos theUntilPos,
278                                           const Handle(Message_ProgressIndicator)& theProgress)
279 {
280   // use method seekpos() to get true 64-bit offset to enable
281   // handling of large files (VS 2010 64-bit)
282   const int64_t aStartPos = GETPOS(theStream.tellg());
283   size_t aLineLen = 0;
284   const char* aLine;
285
286   // skip header "solid ..."
287   aLine = theBuffer.ReadLine (theStream, aLineLen);
288   if (aLine == NULL)
289   {
290     Message::DefaultMessenger()->Send ("Error: premature end of file", Message_Fail);
291     return false;
292   }
293
294   MergeNodeTool aMergeTool (this);
295   Standard_CLocaleSentry::clocale_t aLocale = Standard_CLocaleSentry::GetCLocale();
296   (void)aLocale; // to avoid warning on GCC where it is actually not used
297   SAVE_TL() // for GCC only, set C locale globally
298
299   // report progress every 1 MiB of read data
300   const int aStepB = 1024 * 1024;
301   const Standard_Integer aNbSteps = 1 + Standard_Integer((GETPOS(theUntilPos) - aStartPos) / aStepB);
302   Message_ProgressSentry aPSentry (theProgress, "Reading text STL file", 0, aNbSteps, 1);
303   int64_t aProgressPos = aStartPos + aStepB;
304   int aNbLine = 1;
305
306   while (aPSentry.More())
307   {
308     if (GETPOS(theStream.tellg()) > aProgressPos)
309     {
310       aPSentry.Next();
311       aProgressPos += aStepB;
312     }
313
314     aLine = theBuffer.ReadLine (theStream, aLineLen); // "facet normal nx ny nz"
315     if (aLine == NULL)
316     {
317       Message::DefaultMessenger()->Send ("Error: premature end of file", Message_Fail);
318       return false;
319     }
320     if (str_starts_with (aLine, "endsolid", 8))
321     {
322       // end of STL code
323       break;
324     }
325     if (!str_starts_with (aLine, "facet", 5))
326     {
327       TCollection_AsciiString aStr ("Error: unexpected format of facet at line ");
328       aStr += aNbLine + 1;
329       Message::DefaultMessenger()->Send (aStr, Message_Fail);
330       return false;
331     }
332
333     aLine = theBuffer.ReadLine (theStream, aLineLen);  // "outer loop"
334     if (aLine == NULL || !str_starts_with (aLine, "outer", 5))
335     {
336       TCollection_AsciiString aStr ("Error: unexpected format of facet at line ");
337       aStr += aNbLine + 1;
338       Message::DefaultMessenger()->Send (aStr, Message_Fail);
339       return false;
340     }
341
342     gp_XYZ aVertex[3];
343     Standard_Boolean isEOF = false;
344     for (Standard_Integer i = 0; i < 3; i++)
345     {
346       aLine = theBuffer.ReadLine (theStream, aLineLen);
347       if (aLine == NULL)
348       {
349         isEOF = true;
350         break;
351       }
352       gp_XYZ aReadVertex;
353       if (!ReadVertex (aLine, aReadVertex.ChangeCoord (1), aReadVertex.ChangeCoord (2), aReadVertex.ChangeCoord (3)))
354       {
355         TCollection_AsciiString aStr ("Error: cannot read vertex co-ordinates at line ");
356         aStr += aNbLine;
357         Message::DefaultMessenger()->Send (aStr, Message_Fail);
358         return false;
359       }
360       aVertex[i] = aReadVertex;
361     }
362
363     // stop reading if end of file is reached;
364     // note that well-formatted file never ends by the vertex line
365     if (isEOF)
366     {
367       break;
368     }
369
370     aNbLine += 5;
371
372     // add triangle
373     int n1 = aMergeTool.AddNode (aVertex[0].X(), aVertex[0].Y(), aVertex[0].Z());
374     int n2 = aMergeTool.AddNode (aVertex[1].X(), aVertex[1].Y(), aVertex[1].Z());
375     int n3 = aMergeTool.AddNode (aVertex[2].X(), aVertex[2].Y(), aVertex[2].Z());
376     if (n1 != n2 && n2 != n3 && n3 != n1)
377     {
378       AddTriangle (n1, n2, n3);
379     }
380
381     theBuffer.ReadLine (theStream, aLineLen); // skip "endloop"
382     theBuffer.ReadLine (theStream, aLineLen); // skip "endfacet"
383
384     aNbLine += 2;
385   }
386
387   return aPSentry.More();
388 }
389
390 //==============================================================================
391 //function : readStlBinary
392 //purpose  :
393 //==============================================================================
394
395 Standard_Boolean RWStl_Reader::ReadBinary (Standard_IStream& theStream,
396                                            const Handle(Message_ProgressIndicator)& theProgress)
397 {
398 /*
399   // the size of the file (minus the header size)
400   // must be a multiple of SIZEOF_STL_FACET
401   if ((theFileLen - THE_STL_HEADER_SIZE) % THE_STL_SIZEOF_FACET != 0
402    || (theFileLen < THE_STL_MIN_FILE_SIZE))
403   {
404     Message::DefaultMessenger()->Send ("Error: Corrupted binary STL file (inconsistent file size)!", Message_Fail);
405     return Standard_False;
406   }
407   const Standard_Integer  aNbFacets = Standard_Integer((theFileLen - THE_STL_HEADER_SIZE) / THE_STL_SIZEOF_FACET);
408 */
409
410   // read file header at first
411   char aHeader[THE_STL_HEADER_SIZE + 1];
412   if (theStream.read (aHeader, THE_STL_HEADER_SIZE).gcount() != std::streamsize(THE_STL_HEADER_SIZE))
413   {
414     Message::DefaultMessenger()->Send ("Error: Corrupted binary STL file!", Message_Fail);
415     return false;
416   }
417
418   // number of facets is stored as 32-bit integer at position 80
419   const Standard_Integer aNbFacets = *(int32_t*)(aHeader + 80);
420
421   MergeNodeTool aMergeTool (this);
422
423   // don't trust the number of triangles which is coded in the file
424   // sometimes it is wrong, and with this technique we don't need to swap endians for integer
425   Message_ProgressSentry  aPSentry (theProgress, "Reading binary STL file", 0, aNbFacets, 1);
426   Standard_Integer        aNbRead = 0;
427
428   // allocate buffer for 80 triangles
429   const int THE_CHUNK_NBFACETS = 80;
430   char aBuffer[THE_STL_SIZEOF_FACET * THE_CHUNK_NBFACETS];
431
432   // normal + 3 nodes + 2 extra bytes
433   const size_t aVec3Size    = sizeof(float) * 3;
434   const size_t aFaceDataLen = aVec3Size * 4 + 2;
435   const char*  aBufferPtr   = aBuffer;
436   Standard_Integer aNbFacesInBuffer = 0;
437   for (Standard_Integer aNbFacetRead = 0; aNbFacetRead < aNbFacets && aPSentry.More();
438        ++aNbFacetRead, ++aNbRead, --aNbFacesInBuffer, aBufferPtr += aFaceDataLen, aPSentry.Next())
439   {
440     // read more data
441     if (aNbFacesInBuffer <= 0)
442     {
443       aNbFacesInBuffer = Min (THE_CHUNK_NBFACETS, aNbFacets - aNbFacetRead);
444       const std::streamsize aDataToRead = aNbFacesInBuffer * aFaceDataLen;
445       if (theStream.read (aBuffer, aDataToRead).gcount() != aDataToRead)
446       {
447         Message::DefaultMessenger()->Send ("Error: binary STL read failed", Message_Fail);
448         return false;
449       }
450       aBufferPtr = aBuffer;
451     }
452
453     // get points from buffer
454 //    readStlFloatVec3 (aBufferPtr); // skip normal
455     gp_XYZ aP1 = readStlFloatVec3 (aBufferPtr + aVec3Size);
456     gp_XYZ aP2 = readStlFloatVec3 (aBufferPtr + aVec3Size * 2);
457     gp_XYZ aP3 = readStlFloatVec3 (aBufferPtr + aVec3Size * 3);
458
459     // add triangle
460     int n1 = aMergeTool.AddNode (aP1.X(), aP1.Y(), aP1.Z());
461     int n2 = aMergeTool.AddNode (aP2.X(), aP2.Y(), aP2.Z());
462     int n3 = aMergeTool.AddNode (aP3.X(), aP3.Y(), aP3.Z());
463     if (n1 != n2 && n2 != n3 && n3 != n1)
464     {
465       AddTriangle (n1, n2, n3);
466     }
467   }
468
469   return true;
470 }