1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
|
/**********************************************************************
* $Id: avc_rawbin.c,v 1.13 2005/06/03 03:49:59 daniel Exp $
*
* Name: avc_rawbin.c
* Project: Arc/Info vector coverage (AVC) BIN->E00 conversion library
* Language: ANSI C
* Purpose: Raw Binary file access functions.
* Author: Daniel Morissette, dmorissette@dmsolutions.ca
*
**********************************************************************
* Copyright (c) 1999-2005, Daniel Morissette
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
**********************************************************************
*
* $Log: avc_rawbin.c,v $
* Revision 1.13 2005/06/03 03:49:59 daniel
* Update email address, website url, and copyright dates
*
* Revision 1.12 2004/08/19 23:41:04 warmerda
* fixed pointer aliasing optimization bug
*
* Revision 1.11 2000/09/22 19:45:21 daniel
* Switch to MIT-style license
*
* Revision 1.10 2000/05/29 15:36:07 daniel
* Fixed compile warning
*
* Revision 1.9 2000/05/29 15:31:31 daniel
* Added Japanese DBCS support
*
* Revision 1.8 2000/01/10 02:59:11 daniel
* Fixed problem in AVCRawBinOpen() when file not found
*
* Revision 1.7 1999/12/24 07:18:34 daniel
* Added PC Arc/Info coverages support
*
* Revision 1.6 1999/08/29 15:05:43 daniel
* Added source filename in "Attempt to read past EOF" error message
*
* Revision 1.5 1999/06/08 22:09:03 daniel
* Allow opening file with "r+" (but no real random access support yet)
*
* Revision 1.4 1999/05/11 02:10:51 daniel
* Added write support
*
* Revision 1.3 1999/03/03 19:55:21 daniel
* Fixed syntax error in the CPL_MSB version of AVCRawBinReadInt32()
*
* Revision 1.2 1999/02/25 04:20:08 daniel
* Modified AVCRawBinEOF() to detect EOF even if AVCRawBinFSeek() was used.
*
* Revision 1.1 1999/01/29 16:28:52 daniel
* Initial revision
*
**********************************************************************/
#include "avc.h"
#include "avc_mbyte.h"
/*---------------------------------------------------------------------
* Define a static flag and set it with the byte ordering on this machine
* we will then compare with this value to decide if we nned to swap
* bytes or not.
*
* CPL_MSB or CPL_LSB should be set in the makefile... the default is
* CPL_LSB.
*--------------------------------------------------------------------*/
#ifndef CPL_LSB
static AVCByteOrder geSystemByteOrder = AVCBigEndian;
#else
static AVCByteOrder geSystemByteOrder = AVCLittleEndian;
#endif
/*=====================================================================
* Stuff related to buffered reading of raw binary files
*====================================================================*/
/**********************************************************************
* AVCRawBinOpen()
*
* Open a binary file for reading with buffering, or writing.
*
* Returns a valid AVCRawBinFile structure, or NULL if the file could
* not be opened or created.
*
* AVCRawBinClose() will eventually have to be called to release the
* resources used by the AVCRawBinFile structure.
**********************************************************************/
AVCRawBinFile *AVCRawBinOpen(const char *pszFname, const char *pszAccess,
AVCByteOrder eFileByteOrder,
AVCDBCSInfo *psDBCSInfo)
{
AVCRawBinFile *psFile;
psFile = (AVCRawBinFile*)CPLCalloc(1, sizeof(AVCRawBinFile));
/*-----------------------------------------------------------------
* Validate access mode and open/create file.
* For now we support only: "r" for read-only or "w" for write-only
* or "a" for append.
*
* A case for "r+" is included here, but random access is not
* properly supported yet... so this option should be used with care.
*----------------------------------------------------------------*/
if (EQUALN(pszAccess, "r+", 2))
{
psFile->eAccess = AVCReadWrite;
psFile->fp = VSIFOpen(pszFname, "r+b");
}
else if (EQUALN(pszAccess, "r", 1))
{
psFile->eAccess = AVCRead;
psFile->fp = VSIFOpen(pszFname, "rb");
}
else if (EQUALN(pszAccess, "w", 1))
{
psFile->eAccess = AVCWrite;
psFile->fp = VSIFOpen(pszFname, "wb");
}
else if (EQUALN(pszAccess, "a", 1))
{
psFile->eAccess = AVCWrite;
psFile->fp = VSIFOpen(pszFname, "ab");
}
else
{
CPLError(CE_Failure, CPLE_IllegalArg,
"Acces mode \"%s\" not supported.", pszAccess);
CPLFree(psFile);
return NULL;
}
/*-----------------------------------------------------------------
* Check that file was opened succesfully, and init struct.
*----------------------------------------------------------------*/
if (psFile->fp == NULL)
{
CPLError(CE_Failure, CPLE_OpenFailed,
"Failed to open file %s", pszFname);
CPLFree(psFile);
return NULL;
}
/*-----------------------------------------------------------------
* OK... Init psFile struct
*----------------------------------------------------------------*/
psFile->pszFname = CPLStrdup(pszFname);
psFile->eByteOrder = eFileByteOrder;
psFile->psDBCSInfo = psDBCSInfo; /* Handle on dataset DBCS info */
/*-----------------------------------------------------------------
* One can set nFileDataSize based on some header fields to force
* EOF beyond a given point in the file. Useful for cases like
* PC Arc/Info where the physical file size is always a multiple of
* 256 bytes padded with some junk at the end.
*----------------------------------------------------------------*/
psFile->nFileDataSize = -1;
return psFile;
}
/**********************************************************************
* AVCRawBinClose()
*
* Close a binary file previously opened with AVCRawBinOpen() and release
* any memory used by the handle.
**********************************************************************/
void AVCRawBinClose(AVCRawBinFile *psFile)
{
if (psFile)
{
if (psFile->fp)
VSIFClose(psFile->fp);
CPLFree(psFile->pszFname);
CPLFree(psFile);
}
}
/**********************************************************************
* AVCRawBinSetFileDataSize()
*
* One can set nFileDataSize based on some header fields to force
* EOF beyond a given point in the file. Useful for cases like
* PC Arc/Info where the physical file size is always a multiple of
* 256 bytes padded with some junk at the end.
*
* The default value is -1 which just looks for the real EOF.
**********************************************************************/
void AVCRawBinSetFileDataSize(AVCRawBinFile *psFile, int nFileDataSize)
{
if (psFile)
{
psFile->nFileDataSize = nFileDataSize;
}
}
/**********************************************************************
* AVCRawBinReadBytes()
*
* Copy the number of bytes from the input file to the specified
* memory location.
**********************************************************************/
static GBool bDisableReadBytesEOFError = FALSE;
void AVCRawBinReadBytes(AVCRawBinFile *psFile, int nBytesToRead, GByte *pBuf)
{
/* Make sure file is opened with Read access
*/
if (psFile == NULL ||
(psFile->eAccess != AVCRead && psFile->eAccess != AVCReadWrite))
{
CPLError(CE_Failure, CPLE_FileIO,
"AVCRawBinReadBytes(): call not compatible with access mode.");
return;
}
/* Quick method: check to see if we can satisfy the request with a
* simple memcpy... most calls should take this path.
*/
if (psFile->nCurPos + nBytesToRead <= psFile->nCurSize)
{
memcpy(pBuf, psFile->abyBuf+psFile->nCurPos, nBytesToRead);
psFile->nCurPos += nBytesToRead;
return;
}
/* This is the long method... it supports reading data that
* overlaps the input buffer boundaries.
*/
while(nBytesToRead > 0)
{
/* If we reached the end of our memory buffer then read another
* chunk from the file
*/
CPLAssert(psFile->nCurPos <= psFile->nCurSize);
if (psFile->nCurPos == psFile->nCurSize)
{
psFile->nOffset += psFile->nCurSize;
psFile->nCurSize = VSIFRead(psFile->abyBuf, sizeof(GByte),
AVCRAWBIN_READBUFSIZE, psFile->fp);
psFile->nCurPos = 0;
}
if (psFile->nCurSize == 0)
{
/* Attempt to read past EOF... generate an error.
*
* Note: AVCRawBinEOF() can set bDisableReadBytesEOFError=TRUE
* to disable the error message whils it is testing
* for EOF.
*/
if (bDisableReadBytesEOFError == FALSE)
CPLError(CE_Failure, CPLE_FileIO,
"Attempt to read past EOF in %s.", psFile->pszFname);
return;
}
/* If the requested bytes are not all in the current buffer then
* just read the part that's in memory for now... the loop will
* take care of the rest.
*/
if (psFile->nCurPos + nBytesToRead > psFile->nCurSize)
{
int nBytes;
nBytes = psFile->nCurSize-psFile->nCurPos;
memcpy(pBuf, psFile->abyBuf+psFile->nCurPos, nBytes);
psFile->nCurPos += nBytes;
pBuf += nBytes;
nBytesToRead -= nBytes;
}
else
{
/* All the requested bytes are now in the buffer...
* simply copy them and return.
*/
memcpy(pBuf, psFile->abyBuf+psFile->nCurPos, nBytesToRead);
psFile->nCurPos += nBytesToRead;
nBytesToRead = 0; /* Terminate the loop */
}
}
}
/**********************************************************************
* AVCRawBinReadString()
*
* Same as AVCRawBinReadBytes() except that the string is run through
* the DBCS conversion function.
*
* pBuf should be allocated with a size of at least nBytesToRead+1 bytes.
**********************************************************************/
void AVCRawBinReadString(AVCRawBinFile *psFile, int nBytesToRead, GByte *pBuf)
{
const GByte *pszConvBuf;
AVCRawBinReadBytes(psFile, nBytesToRead, pBuf);
pBuf[nBytesToRead] = '\0';
pszConvBuf = AVCE00ConvertFromArcDBCS(psFile->psDBCSInfo, pBuf,
nBytesToRead);
if (pszConvBuf != pBuf)
{
memcpy(pBuf, pszConvBuf, nBytesToRead);
}
}
/**********************************************************************
* AVCRawBinFSeek()
*
* Move the read pointer to the specified location.
*
* As with fseek(), the specified position can be relative to the
* beginning of the file (SEEK_SET), or the current position (SEEK_CUR).
* SEEK_END is not supported.
**********************************************************************/
void AVCRawBinFSeek(AVCRawBinFile *psFile, int nOffset, int nFrom)
{
int nTarget = 0;
CPLAssert(nFrom == SEEK_SET || nFrom == SEEK_CUR);
/* Supported only with read access for now
*/
CPLAssert(psFile && psFile->eAccess != AVCWrite);
if (psFile == NULL || psFile->eAccess == AVCWrite)
return;
/* Compute destination relative to current memory buffer
*/
if (nFrom == SEEK_SET)
nTarget = nOffset - psFile->nOffset;
else if (nFrom == SEEK_CUR)
nTarget = nOffset + psFile->nCurPos;
/* Is the destination located inside the current buffer?
*/
if (nTarget > 0 && nTarget <= psFile->nCurSize)
{
/* Requested location is already in memory... just move the
* read pointer
*/
psFile->nCurPos = nTarget;
}
else
{
/* Requested location is not part of the memory buffer...
* move the FILE * to the right location and be ready to
* read from there.
*/
VSIFSeek(psFile->fp, psFile->nOffset+nTarget, SEEK_SET);
psFile->nCurPos = 0;
psFile->nCurSize = 0;
psFile->nOffset = psFile->nOffset+nTarget;
}
}
/**********************************************************************
* AVCRawBinEOF()
*
* Return TRUE if there is no more data to read from the file or
* FALSE otherwise.
**********************************************************************/
GBool AVCRawBinEOF(AVCRawBinFile *psFile)
{
if (psFile == NULL || psFile->fp == NULL)
return TRUE;
/* In write access mode, always return TRUE, since we always write
* at EOF for now.
*/
if (psFile->eAccess != AVCRead && psFile->eAccess != AVCReadWrite)
return TRUE;
/* If file data size was specified, then check that we have not
* passed that point yet...
*/
if (psFile->nFileDataSize > 0 &&
(psFile->nOffset+psFile->nCurPos) >= psFile->nFileDataSize)
return TRUE;
/* If the file pointer has been moved by AVCRawBinFSeek(), then
* we may be at a position past EOF, but VSIFeof() would still
* return FALSE.
* To prevent this situation, if the memory buffer is empty,
* we will try to read 1 byte from the file to force the next
* chunk of data to be loaded (and we'll move the the read pointer
* back by 1 char after of course!).
* If we are at the end of the file, this will trigger the EOF flag.
*/
if (psFile->nCurPos == 0 && psFile->nCurSize == 0)
{
char c;
/* Set bDisableReadBytesEOFError=TRUE to temporarily disable
* the EOF error message from AVCRawBinReadBytes().
*/
bDisableReadBytesEOFError = TRUE;
AVCRawBinReadBytes(psFile, 1, &c);
bDisableReadBytesEOFError = FALSE;
if (psFile->nCurPos > 0)
AVCRawBinFSeek(psFile, -1, SEEK_CUR);
}
return (psFile->nCurPos == psFile->nCurSize &&
VSIFEof(psFile->fp));
}
/**********************************************************************
* AVCRawBinRead<datatype>()
*
* Arc/Info files are binary files with MSB first (Motorola) byte
* ordering. The following functions will read from the input file
* and return a value with the bytes ordered properly for the current
* platform.
**********************************************************************/
GInt16 AVCRawBinReadInt16(AVCRawBinFile *psFile)
{
GInt16 n16Value;
AVCRawBinReadBytes(psFile, 2, (GByte*)(&n16Value));
if (psFile->eByteOrder != geSystemByteOrder)
{
return (GInt16)CPL_SWAP16(n16Value);
}
return n16Value;
}
GInt32 AVCRawBinReadInt32(AVCRawBinFile *psFile)
{
GInt32 n32Value;
AVCRawBinReadBytes(psFile, 4, (GByte*)(&n32Value));
if (psFile->eByteOrder != geSystemByteOrder)
{
return (GInt32)CPL_SWAP32(n32Value);
}
return n32Value;
}
float AVCRawBinReadFloat(AVCRawBinFile *psFile)
{
float fValue;
AVCRawBinReadBytes(psFile, 4, (GByte*)(&fValue));
if (psFile->eByteOrder != geSystemByteOrder)
{
CPL_SWAP32PTR( &fValue );
}
return fValue;
}
double AVCRawBinReadDouble(AVCRawBinFile *psFile)
{
double dValue;
AVCRawBinReadBytes(psFile, 8, (GByte*)(&dValue));
if (psFile->eByteOrder != geSystemByteOrder)
{
CPL_SWAPDOUBLE(&dValue);
}
return dValue;
}
/**********************************************************************
* AVCRawBinWriteBytes()
*
* Write the number of bytes from the buffer to the file.
*
* If a problem happens, then CPLError() will be called and
* CPLGetLastErrNo() can be used to test if a write operation was
* succesful.
**********************************************************************/
void AVCRawBinWriteBytes(AVCRawBinFile *psFile, int nBytesToWrite, GByte *pBuf)
{
/*----------------------------------------------------------------
* Make sure file is opened with Write access
*---------------------------------------------------------------*/
if (psFile == NULL ||
(psFile->eAccess != AVCWrite && psFile->eAccess != AVCReadWrite))
{
CPLError(CE_Failure, CPLE_FileIO,
"AVCRawBinWriteBytes(): call not compatible with access mode.");
return;
}
if (VSIFWrite(pBuf, nBytesToWrite, 1, psFile->fp) != 1)
CPLError(CE_Failure, CPLE_FileIO,
"Writing to %s failed.", psFile->pszFname);
/*----------------------------------------------------------------
* In write mode, we keep track of current file position ( =nbr of
* bytes written) through psFile->nCurPos
*---------------------------------------------------------------*/
psFile->nCurPos += nBytesToWrite;
}
/**********************************************************************
* AVCRawBinWrite<datatype>()
*
* Arc/Info files are binary files with MSB first (Motorola) byte
* ordering. The following functions will reorder the byte for the
* value properly and write that to the output file.
*
* If a problem happens, then CPLError() will be called and
* CPLGetLastErrNo() can be used to test if a write operation was
* succesful.
**********************************************************************/
void AVCRawBinWriteInt16(AVCRawBinFile *psFile, GInt16 n16Value)
{
if (psFile->eByteOrder != geSystemByteOrder)
{
n16Value = (GInt16)CPL_SWAP16(n16Value);
}
AVCRawBinWriteBytes(psFile, 2, (GByte*)&n16Value);
}
void AVCRawBinWriteInt32(AVCRawBinFile *psFile, GInt32 n32Value)
{
if (psFile->eByteOrder != geSystemByteOrder)
{
n32Value = (GInt32)CPL_SWAP32(n32Value);
}
AVCRawBinWriteBytes(psFile, 4, (GByte*)&n32Value);
}
void AVCRawBinWriteFloat(AVCRawBinFile *psFile, float fValue)
{
if (psFile->eByteOrder != geSystemByteOrder)
{
CPL_SWAP32PTR( &fValue );
}
AVCRawBinWriteBytes(psFile, 4, (GByte*)&fValue);
}
void AVCRawBinWriteDouble(AVCRawBinFile *psFile, double dValue)
{
if (psFile->eByteOrder != geSystemByteOrder)
{
CPL_SWAPDOUBLE(&dValue);
}
AVCRawBinWriteBytes(psFile, 8, (GByte*)&dValue);
}
/**********************************************************************
* AVCRawBinWriteZeros()
*
* Write a number of zeros (sepcified in bytes) at the current position
* in the file.
*
* If a problem happens, then CPLError() will be called and
* CPLGetLastErrNo() can be used to test if a write operation was
* succesful.
**********************************************************************/
void AVCRawBinWriteZeros(AVCRawBinFile *psFile, int nBytesToWrite)
{
char acZeros[8] = {0, 0, 0, 0, 0, 0, 0, 0};
int i;
/* Write by 8 bytes chunks. The last chunk may be less than 8 bytes
*/
for(i=0; i< nBytesToWrite; i+=8)
{
AVCRawBinWriteBytes(psFile, MIN(8,(nBytesToWrite-i)),
(GByte*)acZeros);
}
}
/**********************************************************************
* AVCRawBinWritePaddedString()
*
* Write a string and pad the end of the field (up to nFieldSize) with
* spaces number of spaces at the current position in the file.
*
* If a problem happens, then CPLError() will be called and
* CPLGetLastErrNo() can be used to test if a write operation was
* succesful.
**********************************************************************/
void AVCRawBinWritePaddedString(AVCRawBinFile *psFile, int nFieldSize,
const char *pszString)
{
char acSpaces[8] = {' ', ' ', ' ', ' ', ' ', ' ', ' ', ' '};
int i, nLen, numSpaces;
/* If we're on a system with a multibyte codepage then we have to
* convert strings to the proper multibyte encoding.
*/
pszString = AVCE00Convert2ArcDBCS(psFile->psDBCSInfo,
pszString, nFieldSize);
nLen = strlen(pszString);
nLen = MIN(nLen, nFieldSize);
numSpaces = nFieldSize - nLen;
if (nLen > 0)
AVCRawBinWriteBytes(psFile, nLen, (GByte*)pszString);
/* Write spaces by 8 bytes chunks. The last chunk may be less than 8 bytes
*/
for(i=0; i< numSpaces; i+=8)
{
AVCRawBinWriteBytes(psFile, MIN(8,(numSpaces-i)),
(GByte*)acSpaces);
}
}
|