applications/utilities/postProcessing/dataConversion/foamToTecplot360/tecio/tecsrc/dataio.cpp

   1 /*
   2  * NOTICE and LICENSE for Tecplot Input/Output Library (TecIO) - OpenFOAM
   3  *
   4  * Copyright (C) 1988-2009 Tecplot, Inc.  All rights reserved worldwide.
   5  *
   6  * Tecplot hereby grants OpenCFD limited authority to distribute without
   7  * alteration the source code to the Tecplot Input/Output library, known
   8  * as TecIO, as part of its distribution of OpenFOAM and the
   9  * OpenFOAM_to_Tecplot converter.  Users of this converter are also hereby
  10  * granted access to the TecIO source code, and may redistribute it for the
  11  * purpose of maintaining the converter.  However, no authority is granted
  12  * to alter the TecIO source code in any form or manner.
  13  *
  14  * This limited grant of distribution does not supersede Tecplot, Inc.'s
  15  * copyright in TecIO.  Contact Tecplot, Inc. for further information.
  16  *
  17  * Tecplot, Inc.
  18  * 3535 Factoria Blvd, Ste. 550
  19  * Bellevue, WA 98006, USA
  20  * Phone: +1 425 653 1200
  21  * http://www.tecplot.com/
  22  *
  23  */
  24 #include "stdafx.h"
  25 #include "MASTER.h"
  26 #define TECPLOTENGINEMODULE
  27
  28 /*
  29 ******************************************************************
  30 ******************************************************************
  31 *******                                                   ********
  32 ******  (C) 1988-2008 Tecplot, Inc.                        *******
  33 *******                                                   ********
  34 ******************************************************************
  35 ******************************************************************
  36 */
  37
  38 #define DATAIOMODULE
  39 #include "GLOBAL.h"
  40 #include "TASSERT.h"
  41 #include "Q_UNICODE.h"
  42 #include "TranslatedString.h"
  43
  44 #if defined TECPLOTKERNEL
  45 /* CORE SOURCE CODE REMOVED */
  46 #else
  47 #ifdef MSWIN
  48 /* Disable warning about conversion from long to short.
  49    Even if we have disabled it in stdafx.h,
  50    we still need to disable here also for
  51    tecio, which includes this cpp file. */
  52
  53 #pragma warning (disable : 4244)
  54 #endif
  55 /*
  56  * Temp text and geom buffers.
  57  */
  58 static Geom_s TempGeom;
  59 static Text_s TempText;
  60 #endif
  61
  62 #include "DATASET0.h"
  63 #include "SET.h"
  64 #include "FILESTREAM.h"
  65 #include "DATAIO.h"
  66 #include "DATAIO4.h"
  67 #include "STRUTIL.h"
  68 #include "AUXDATA.h"
  69 #include "ARRLIST.h"
  70 #include "STRLIST.h"
  71 #include "ALLOC.h"
  72 #include "DATASET.h"
  73 #include "SYSTEM.h"
  74 #include "Q_MSG.h"
  75
  76 #if defined TECPLOTKERNEL
  77 /* CORE SOURCE CODE REMOVED */
  78 #endif
  79 using namespace tecplot::strutil;
  80
  81 #if defined TECPLOTKERNEL
  82 /* CORE SOURCE CODE REMOVED */
  83 #if !defined ENGINE
  84 #endif
  85 #if !defined ENGINE /* TODO(RMS)-M 12/13/2005: ENGINE-P2 - no status feedback */
  86 #endif
  87 #endif /* TECPLOTKERNEL */
  88
  89
  90 /*
  91  * Multi-Purpose datafile header reader.  This is designed so that
  92  * not all parts of the header is loaded and so that the task of loading
  93  * the header information is separated out from installing of that
  94  * information into a dataset.
  95  *
  96  */
  97
  98 Boolean_t ReadDataFileHeader(FileStream_s    *FileStream,
  99                              short            IVersion,
 100                              Boolean_t        ShowDataIOStatus,
 101                              EntIndex_t      *NumZones,
 102                              EntIndex_t      *NumVars,
 103                              SmInteger_t     *NumCustomLabelSets,
 104                              char           **DataSetTitle,
 105                              Text_s         **BaseText,
 106                              Geom_s         **BaseGeom,
 107                              StringList_pa  **CustomLabelBase,
 108                              StringList_pa   *UserRec,
 109                              AuxData_pa      *DataSetAuxData,
 110                              Set_pa         **IsVarCellCentered,  /* Create an Array dim by zones */
 111                              Boolean_t       *HasText,
 112                              Boolean_t       *HasGeoms,
 113                              ArrayList_pa    *ZoneSpecList,
 114                              StringList_pa   *VarNames,
 115                              ArrayList_pa    *VarAuxDataList, /*<AuxData_pa>[NumVars]*/
 116                              Set_pa          *IsRawFNAvailable, /* classic data only */
 117                              LgIndex_t      **FNNumBndryConns,  /* classic data only */
 118                              DataFileType_e  *FileType)
 119 {
 120     Boolean_t    IsOk = TRUE;
 121     Boolean_t    SentError = FALSE;
 122     double       X1;
 123     int          Pass;
 124     FileOffset_t InitialFilePosition;
 125
 126     REQUIRE(VALID_REF(FileStream) && VALID_REF(FileStream->File));
 127     REQUIRE(IVersion > 0);
 128     REQUIRE(VALID_BOOLEAN(ShowDataIOStatus));
 129     REQUIRE(VALID_REF(NumZones));
 130     REQUIRE(VALID_REF(NumVars));
 131     REQUIRE(VALID_REF(DataSetTitle)       || (DataSetTitle == NULL));
 132     REQUIRE(VALID_REF(BaseText)           || (BaseText == NULL));
 133     REQUIRE(VALID_REF(BaseGeom)           || (BaseGeom == NULL));
 134     REQUIRE(VALID_REF(HasText)            || (HasText == NULL));
 135     REQUIRE(VALID_REF(HasGeoms)           || (HasGeoms == NULL));
 136     REQUIRE(VALID_REF(ZoneSpecList)       || (ZoneSpecList == NULL));
 137     REQUIRE(VALID_REF(VarNames)           || (VarNames == NULL));
 138     REQUIRE(VALID_REF(NumCustomLabelSets) || (NumCustomLabelSets == NULL));
 139     REQUIRE(VALID_REF(UserRec)            || (UserRec == NULL));
 140     REQUIRE((VALID_REF(DataSetAuxData) &&
 141              (VALID_REF(*DataSetAuxData) || *DataSetAuxData == NULL)) ||
 142             DataSetAuxData == NULL);
 143     REQUIRE((VALID_REF(VarAuxDataList) &&
 144              (VALID_REF(*VarAuxDataList) || *VarAuxDataList == NULL)) ||
 145             VarAuxDataList == NULL);
 146     REQUIRE(VALID_REF(IsVarCellCentered)  || (IsVarCellCentered == NULL));
 147     REQUIRE((VALID_REF(CustomLabelBase) && VALID_REF(NumCustomLabelSets)) || (CustomLabelBase == NULL));
 148     REQUIRE(VALID_REF(IsRawFNAvailable) || (IsRawFNAvailable == NULL));
 149     REQUIRE(VALID_REF(FNNumBndryConns)  || (FNNumBndryConns == NULL));
 150     REQUIRE(VALID_REF(FileType)         || (FileType == NULL));
 151
 152     if (DataSetTitle)
 153         *DataSetTitle = NULL;
 154     if (BaseText)
 155         *BaseText = NULL;
 156     if (BaseGeom)
 157         *BaseGeom = NULL;
 158     if (HasText)
 159         *HasText = FALSE;
 160     if (HasGeoms)
 161         *HasGeoms = FALSE;
 162     if (ZoneSpecList)
 163         *ZoneSpecList = NULL;
 164     if (VarNames)
 165         *VarNames = NULL;
 166     if (NumCustomLabelSets)
 167         *NumCustomLabelSets = 0;
 168     if (CustomLabelBase)
 169         *CustomLabelBase = NULL;
 170     if (DataSetAuxData != NULL)
 171     {
 172         /*
 173          * Note unlike most of the other output only parameters that we nullify,
 174          * DataSetAuxData is both an input and output parameter therefore we do
 175          * not nullify it. The CHECK is here for clarity.
 176          */
 177         CHECK(VALID_REF(*DataSetAuxData) || *DataSetAuxData == NULL);
 178     }
 179     if (VarAuxDataList != NULL)
 180     {
 181         /*
 182          * Note unlike most of the other output only parameters that we nullify,
 183          * VarAuxDataList is both an input and output parameter therefore we do
 184          * not nullify it. The CHECK is here for clarity.
 185          */
 186         CHECK(VALID_REF(*VarAuxDataList) || *VarAuxDataList == NULL);
 187     }
 188     if (UserRec)
 189         *UserRec = NULL;
 190     if (IsVarCellCentered)
 191         *IsVarCellCentered = NULL;
 192
 193     if (IsRawFNAvailable)
 194         *IsRawFNAvailable = NULL;
 195
 196     if (FNNumBndryConns)
 197         *FNNumBndryConns = NULL;
 198
 199     if (FileType)
 200         *FileType = DataFileType_Full;
 201
 202     /*
 203      * Pass 1 is used only to count up the number of zones and custom label sets,
 204      * Also determine if there are any preset zone colors.
 205      */
 206
 207     InitialFilePosition = TP_FTELL(FileStream->File);
 208
 209     for (Pass = 1; IsOk && (Pass <= 2); Pass++)
 210     {
 211         if (Pass == 2)
 212         {
 213             if (TP_FSEEK(FileStream->File, InitialFilePosition, SEEK_SET) != 0)
 214                 IsOk = FALSE;
 215
 216             if (IsOk && (*NumZones > 0 && ZoneSpecList != NULL && *ZoneSpecList == NULL))
 217             {
 218                 *ZoneSpecList = ArrayListAlloc(*NumZones, ArrayListType_VoidPtr,
 219                                                ZoneOrVarListAdjustCapacityRequest, 0);
 220                 IsOk = (*ZoneSpecList != NULL);
 221             }
 222             if (IsOk && (CustomLabelBase != NULL    &&
 223                          *CustomLabelBase == NULL &&
 224                          *NumCustomLabelSets > 0))
 225             {
 226                 *CustomLabelBase = ALLOC_ARRAY(*NumCustomLabelSets, StringList_pa, "CustomLabel Sets");
 227                 IsOk = (*CustomLabelBase != NULL);
 228                 if (IsOk)
 229                 {
 230                     SmInteger_t N;
 231                     for (N = 0; N < *NumCustomLabelSets; N++)
 232                         (*CustomLabelBase)[N] = NULL;
 233                 }
 234             }
 235             if (IsOk && (UserRec != NULL && *UserRec == NULL))
 236             {
 237                 *UserRec = StringListAlloc();
 238                 IsOk = (Boolean_t)(*UserRec != NULL);
 239             }
 240             if (IsOk && (DataSetAuxData != NULL && *DataSetAuxData == NULL))
 241             {
 242                 *DataSetAuxData = AuxDataAlloc();
 243                 IsOk = (Boolean_t)(*DataSetAuxData != NULL);
 244             }
 245             if (IsOk && (VarAuxDataList != NULL && *VarAuxDataList == NULL) && *NumVars > 0)
 246             {
 247                 *VarAuxDataList = ArrayListAlloc(0, ArrayListType_VoidPtr,
 248                                                  ZoneOrVarListAdjustCapacityRequest, 0);
 249                 IsOk = (*VarAuxDataList != NULL &&
 250                         ArrayListSetVoidPtr(*VarAuxDataList, *NumVars - 1, NULL));
 251             }
 252             if (IsOk            &&
 253                 (*NumZones > 0) &&
 254                 (IsVarCellCentered != NULL) &&
 255                 (*IsVarCellCentered == NULL))
 256             {
 257                 /*
 258                  * First construct the array of sets...
 259                  */
 260                 *IsVarCellCentered = ALLOC_ARRAY(*NumZones, Set_pa, "Array of IsVarCellCentered sets");
 261                 if (*IsVarCellCentered)
 262                 {
 263                     EntIndex_t Z;
 264                     for (Z = 0; IsOk && (Z < *NumZones); Z++)
 265                     {
 266                         /*
 267                          * Now allocate a set for each zone
 268                          */
 269                         (*IsVarCellCentered)[Z] = AllocSet(FALSE);
 270                         IsOk = (Boolean_t)((*IsVarCellCentered)[Z] != NULL);
 271                     }
 272                 }
 273                 else
 274                     IsOk = FALSE;
 275             }
 276             if (IsOk && *NumZones > 0 && IsRawFNAvailable != NULL)
 277             {
 278                 *IsRawFNAvailable = AllocSet(FALSE);
 279                 IsOk = (*IsRawFNAvailable != NULL);
 280             }
 281             if (IsOk && *NumZones > 0 && FNNumBndryConns != NULL)
 282             {
 283                 *FNNumBndryConns = ALLOC_ARRAY(*NumZones, LgIndex_t, "Array of FNNumBndryConns");
 284                 IsOk = (*FNNumBndryConns != NULL);
 285                 if (IsOk)
 286                     for (LgIndex_t i = 0; i < *NumZones; i++)
 287                         (*FNNumBndryConns)[i] = 0;
 288             }
 289         }
 290
 291         if (NumCustomLabelSets != NULL)
 292             *NumCustomLabelSets = 0;
 293
 294         EntIndex_t TotalNumZones = *NumZones; /* ...only meaningful for pass 2 */
 295
 296         *NumZones = 0;
 297         *NumVars  = 0;
 298
 299         if (IsOk)
 300         {
 301             char *S = NULL;
 302             int  INumVars;
 303
 304             IsOk = ReadInDataFileTypeTitleAndVarNames(FileStream,
 305                                                       IVersion,
 306                                                       ((Pass == 2) ? &S : (char **)NULL),
 307                                                       ((Pass == 2) ? FileType : (DataFileType_e *)NULL),
 308                                                       &INumVars,
 309                                                       ((Pass == 2) ? VarNames : (StringList_pa *)NULL));
 310
 311             if (IsOk)
 312                 *NumVars = (EntIndex_t)INumVars;
 313
 314             if ((Pass == 2) && S && IsOk && DataSetTitle)
 315                 *DataSetTitle = S;
 316             else if (S != NULL)
 317                 FREE_ARRAY(S, "data set title");
 318         }
 319
 320         if (IsOk)
 321         {
 322 #if !defined ENGINE /* TODO(RMS)-M 12/13/2005: ENGINE-P2 - no dialog feedback */
 323             LgIndex_t NumGeoms = 0;
 324             LgIndex_t NumTexts = 0;
 325 #endif
 326
 327             if (IsOk)
 328                 X1 = GetNextValue(FileStream, FieldDataType_Float, 0.0, 1000.0, &IsOk);
 329
 330             while (IsOk && (X1 != EndHeaderMarker))
 331             {
 332                 if (X1 == ZoneMarker)
 333                 {
 334                     ZoneSpec_s *ZoneSpec = ZoneSpecAlloc();
 335                     Boolean_t OkToLoad = (Pass == 2 &&
 336                                           IsVarCellCentered != NULL);
 337                     IsOk = (ZoneSpec != NULL);
 338                     if (IsOk)
 339                     {
 340                         Boolean_t LocalIsRawFNAvailable;
 341                         LgIndex_t LocalFNNumBndryConns;
 342                         IsOk = ReadInZoneHeader(FileStream, IVersion, ZoneSpec,
 343                                                 OkToLoad ? (*IsVarCellCentered)[*NumZones] : NULL,
 344                                                 *NumVars, &LocalIsRawFNAvailable,
 345                                                 &LocalFNNumBndryConns);
 346                         if (IsOk && OkToLoad && IsRawFNAvailable != NULL)
 347                         {
 348                             if (LocalIsRawFNAvailable)
 349                                 IsOk = AddToSet(*IsRawFNAvailable, *NumZones, FALSE);
 350                         }
 351                         if (IsOk && OkToLoad && FNNumBndryConns != NULL)
 352                             (*FNNumBndryConns)[*NumZones] = LocalFNNumBndryConns;
 353                     }
 354
 355                     if (IsOk                 &&
 356                         ZoneSpecList != NULL &&
 357                         Pass == 2)
 358                     {
 359                         IsOk = (ZoneSpec->ParentZone == BAD_SET_VALUE ||
 360                                 (ZoneSpec->ParentZone != *NumZones &&
 361                                  (0 <= ZoneSpec->ParentZone && ZoneSpec->ParentZone < TotalNumZones)));
 362                         if (IsOk)
 363                         {
 364                             ArrayListItem_u CurZoneSpecItem;
 365                             CurZoneSpecItem.VoidPtr = (void *)ZoneSpec;
 366                             ArrayListSetItem(*ZoneSpecList, *NumZones,
 367                                              CurZoneSpecItem,
 368                                              ZoneSpecItemDestructor, 0);
 369                         }
 370                         else
 371                         {
 372                             if (ZoneSpec->ParentZone == *NumZones)
 373                                 ErrMsg(translate("Parent zone assignment for zone %d "
 374                                                  "may not be self referencing."),
 375                                        *NumZones + 1);
 376                             else
 377                                 ErrMsg(translate("Parent zone assignment for zone %d "
 378                                                  "must be to an existing zone within the datafile."),
 379                                        *NumZones + 1);
 380                             ZoneSpecDealloc(&ZoneSpec);
 381                             SentError = TRUE;
 382                         }
 383                     }
 384                     else
 385                         ZoneSpecDealloc(&ZoneSpec);
 386
 387                     if (IsOk)
 388                         (*NumZones)++;
 389                     if (*NumZones > MaxNumZonesOrVars)
 390                     {
 391                         ErrMsg(translate("Exceeding Tecplot's current zone limit of %d. "
 392                                          "Reduce the number of zones being loaded."), MaxNumZonesOrVars);
 393                         IsOk = FALSE;
 394                         SentError = TRUE;
 395                     }
 396                 }
 397                 else if (X1 == GeomMarker)
 398                 {
 399 #if defined TECPLOTKERNEL
 400 /* CORE SOURCE CODE REMOVED */
 401 #else
 402                     IsOk = ReadInGeometry(FileStream,
 403                                           IVersion,
 404                                           FALSE,
 405                                           &TempGeom,
 406                                           5000);
 407 #endif
 408                     if (IsOk)
 409                     {
 410                         if (Pass == 1)
 411                         {
 412                             if (HasGeoms)
 413                                 *HasGeoms = TRUE;
 414                         }
 415 #if defined TECPLOTKERNEL
 416 /* CORE SOURCE CODE REMOVED */
 417 #endif
 418                     }
 419 #if defined TECPLOTKERNEL
 420 /* CORE SOURCE CODE REMOVED */
 421 #if !defined ENGINE /* TODO(RMS)-M 12/13/2005: ENGINE-P2 - no status feedback */
 422 #endif
 423 #endif
 424                 }
 425                 else if (X1 == TextMarker)
 426                 {
 427 #if defined TECPLOTKERNEL
 428 /* CORE SOURCE CODE REMOVED */
 429 #else
 430                     IsOk = ReadInText(FileStream,
 431                                       IVersion,
 432                                       FALSE,
 433                                       &TempText,
 434                                       200);
 435 #endif
 436                     if (IsOk)
 437                     {
 438                         if (Pass == 1)
 439                         {
 440                             if (HasText)
 441                                 *HasText = TRUE;
 442                         }
 443 #if defined TECPLOTKERNEL
 444 /* CORE SOURCE CODE REMOVED */
 445 #endif
 446                     }
 447 #if defined TECPLOTKERNEL
 448 /* CORE SOURCE CODE REMOVED */
 449 #if !defined ENGINE /* TODO(RMS)-M 12/13/2005: ENGINE-P2 - no status feedback */
 450 #endif
 451 #endif
 452                 }
 453                 else if (X1 == CustomLabelMarker)
 454                 {
 455                     Boolean_t OkToLoad;
 456
 457                     OkToLoad = (Pass == 2)                                &&
 458                                NumCustomLabelSets                         &&
 459                                (*NumCustomLabelSets < MaxCustomLabelSets) &&
 460                                CustomLabelBase;
 461
 462                     IsOk = ReadInCustomLabels(FileStream,
 463                                               IVersion,
 464                                               OkToLoad,
 465                                               (OkToLoad ? &(*CustomLabelBase)[*NumCustomLabelSets] : NULL));
 466                     if (IsOk && NumCustomLabelSets)
 467                         (*NumCustomLabelSets)++;
 468                 }
 469                 else if (X1 == UserRecMarker)
 470                 {
 471                     Boolean_t OkToLoad;
 472                     char     *CurUserRec = NULL;
 473
 474                     OkToLoad = (Boolean_t)((Pass == 2) && UserRec);
 475
 476                     IsOk = ReadInUserRec(FileStream,
 477                                          IVersion,
 478                                          500,
 479                                          OkToLoad ? &CurUserRec : (char **)NULL);
 480                     if (IsOk && OkToLoad)
 481                         IsOk = StringListAppendString(*UserRec, CurUserRec);
 482                     if (CurUserRec)
 483                         FREE_ARRAY(CurUserRec, "temp user rec");
 484                     CurUserRec = NULL;
 485                 }
 486                 else if (X1 == DataSetAuxMarker)
 487                 {
 488                     Boolean_t OkToLoad;
 489                     CHECK(IVersion >= 101);
 490                     OkToLoad = (Pass == 2 &&
 491                                 DataSetAuxData != NULL);
 492                     IsOk = ReadInAuxData(FileStream, IVersion,
 493                                          OkToLoad ? *DataSetAuxData : NULL);
 494                     if (!IsOk)
 495                     {
 496                         ErrMsg(translate("Invalid DATASETAUXDATA record in binary datafile"));
 497                         SentError = TRUE;
 498                     }
 499                 }
 500                 else if (X1 == VarAuxMarker)
 501                 {
 502                     Boolean_t OkToLoad;
 503                     LgIndex_t VarNum;
 504                     CHECK(IVersion >= 102);
 505                     OkToLoad = (Pass == 2 &&
 506                                 VarAuxDataList != NULL);
 507                     VarNum = GetIoFileInt(FileStream, IVersion, 0, *NumVars - 1, &IsOk);
 508                     if (IsOk)
 509                     {
 510                         AuxData_pa VarAuxData;
 511                         if (OkToLoad)
 512                         {
 513                             VarAuxData = (AuxData_pa)ArrayListGetVoidPtr(*VarAuxDataList, VarNum);
 514                             if (VarAuxData == NULL)
 515                             {
 516                                 VarAuxData = AuxDataAlloc();
 517                                 IsOk = (VarAuxData != NULL &&
 518                                         ArrayListSetVoidPtr(*VarAuxDataList, VarNum, VarAuxData));
 519                             }
 520                         }
 521                         else
 522                             VarAuxData = NULL;
 523
 524                         IsOk = IsOk && ReadInAuxData(FileStream, IVersion, VarAuxData);
 525                         if (!IsOk)
 526                         {
 527                             ErrMsg(translate("Invalid VARAUXDATA record in binary datafile"));
 528                             SentError = TRUE;
 529                         }
 530                     }
 531                     else
 532                     {
 533                         ErrMsg(translate("Invalid VARAUXDATA variable number association"));
 534                         SentError = TRUE;
 535                     }
 536                 }
 537                 else
 538                     IsOk = FALSE;
 539                 if (IsOk)
 540                     X1 = GetNextValue(FileStream, FieldDataType_Float, 0.0, 1000.0, &IsOk);
 541             }
 542         }
 543     }
 544
 545     /*
 546      * Old plt files that did not contain data still contained variable name
 547      * definitions in the header.  This is no longer necessary and in fact can
 548      * cause confusion in the data read options dialog.  If the number of zones
 549      * in the datafile is zero set the number of variables to 0 and dealloc the
 550      * variable name list.
 551      */
 552
 553     if (IsOk && (*NumZones == 0) && (*NumVars > 0))
 554     {
 555         *NumVars = 0;
 556         if (VarNames && *VarNames)
 557         {
 558             StringListDealloc(VarNames);
 559         }
 560     }
 561
 562
 563     if (!IsOk)
 564     {
 565         if (ZoneSpecList && *ZoneSpecList)
 566             ArrayListDealloc(ZoneSpecList, ZoneSpecItemDestructor, 0);
 567         if (DataSetTitle && *DataSetTitle)
 568         {
 569             FREE_ARRAY(*DataSetTitle, "DataSetTitle");
 570             *DataSetTitle = NULL;
 571         }
 572 #if defined TECPLOTKERNEL
 573 /* CORE SOURCE CODE REMOVED */
 574 #endif
 575         if (VarNames && *VarNames)
 576         {
 577             StringListDealloc(VarNames);
 578         }
 579 #if defined TECPLOTKERNEL
 580 /* CORE SOURCE CODE REMOVED */
 581 #endif
 582         if (UserRec && *UserRec)
 583             StringListDealloc(UserRec);
 584     }
 585
 586     /* If there was an error, get rid of the auxiliary data list. */
 587     if ((DataSetAuxData != NULL && *DataSetAuxData != NULL) &&
 588         (!IsOk))
 589         AuxDataDealloc(DataSetAuxData);
 590
 591     if (!IsOk && !SentError)
 592         ErrMsg(translate("Invalid header in binary datafile"));
 593
 594     /*
 595      * NOTE: Do not close the file.  Some calling functions will continue
 596      *       to read from this point on.
 597      */
 598
 599     ENSURE((VarNames == NULL) || (*VarNames == NULL) || StringListValid(*VarNames));
 600     ENSURE(IMPLICATION(UserRec != NULL,
 601                        (*UserRec == NULL ||
 602                         StringListValid(*UserRec))));
 603     ENSURE(IMPLICATION(DataSetAuxData != NULL,
 604                        (*DataSetAuxData == NULL ||
 605                         VALID_REF(*DataSetAuxData))));
 606     return (IsOk);
 607 }
 608
 609
 610
 611 #if defined TECPLOTKERNEL
 612 /* CORE SOURCE CODE REMOVED */
 613 #endif /* TECPLOTKERNEL */
 614
 615
 616 Boolean_t OpenBinaryFileAndCheckMagicNumber(FileStream_s **FileStream,
 617                                             char          *FName,
 618                                             FileOffset_t   StartOffset,
 619                                             short         *IVersion)
 620 {
 621     Boolean_t Result = TRUE;
 622     REQUIRE(VALID_REF(FileStream));
 623     REQUIRE(*FileStream == NULL);
 624     REQUIRE(VALID_REF(FName));
 625     REQUIRE(StartOffset >= 0);
 626     REQUIRE(VALID_REF(IVersion));
 627
 628 #if defined TECPLOTKERNEL
 629 /* CORE SOURCE CODE REMOVED */
 630 #else
 631     FILE *File = TP_FOPEN(FName, "rb");
 632     if (File == NULL)
 633         Result = FALSE;
 634 #endif
 635     if (Result)
 636     {
 637         *FileStream = FileStreamAlloc(File, TRUE);
 638         Result = (*FileStream != NULL);
 639     }
 640     Result = Result && (TP_FSEEK((*FileStream)->File, StartOffset, SEEK_SET) == 0);
 641     if (Result)
 642     {
 643         *IVersion = GetInputVersion(*FileStream);
 644         /*
 645          * After version 71 we started listing individual valid
 646          * versions. Before that time we just listed ranges. Also,
 647          * note that versions 72, 73, and 74 were invalid.
 648          */
 649         Result = (/* past valid plt file version ranges follow: */
 650                      (40 <= *IVersion && *IVersion <=  71) ||
 651                      (*IVersion ==  75)                    ||
 652                      (100 <= *IVersion && *IVersion <= TecplotBinaryFileVersion));
 653
 654         /*
 655          * This check is put here to make sure that the above code gets visited
 656          * when the TecplotBinaryFileVersion number changes. When the version
 657          * changes the "past valid plt file version ranges" above and the number
 658          * compared to the TecplotBinaryFileVersion below may need to be
 659          * adjusted such as when we skip a consecutive number as we did between
 660          * version 71 and 75, and between 75 and 100.
 661          */
 662         CHECK(TecplotBinaryFileVersion == 112);
 663     }
 664
 665     ENSURE(VALID_BOOLEAN(Result));
 666     return (Result);
 667 }
 668
 669
 670
 671
 672 #if defined TECPLOTKERNEL
 673 /* CORE SOURCE CODE REMOVED */
 674             #if !defined NO_ASSERTS
 675             #endif
 676                 #if !defined NO_ASSERTS
 677                 #endif
 678 #if !defined ENGINE /* TODO(RMS)-M 12/13/2005: ENGINE-P2 - no status feedback */
 679 #endif
 680 #if !defined ENGINE /* TODO(RMS)-M 12/13/2005: ENGINE-P2 - no status feedback */
 681 #endif
 682 #if !defined ENGINE /* TODO(RMS)-M 12/13/2005: ENGINE-P2 - no status feedback */
 683 #endif
 684 #if !defined ENGINE /* TODO(RMS)-M 12/13/2005: ENGINE-P2 - no status feedback */
 685 #endif
 686 #if !defined ENGINE /* TODO(RMS)-M 12/13/2005: ENGINE-P2 - no status feedback */
 687 #endif
 688 #if !defined ENGINE /* TODO(RMS)-M 12/13/2005: ENGINE-P2 - no status feedback */
 689 #endif
 690 #if !defined ENGINE /* TODO(RMS)-H 12/12/2005: ENGINE: refactor to use just the Interrupted flag as-is */
 691 #else
 692 #endif
 693 #if 0 /* we changed this behavior... not sure when */
 694 #endif
 695 #endif /* TECPLOTKERNEL */