applications/utilities/postProcessing/dataConversion/foamToTecplot360/tecio/tecsrc/FILESTREAM.h

   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 /*
  25  *****************************************************************
  26  *****************************************************************
  27  *******                                                  ********
  28  ******     Copyright (C) 1988-2008 Tecplot, Inc.          *******
  29  *******                                                  ********
  30  *****************************************************************
  31  *****************************************************************
  32 */
  33 #if !defined FILESTREAM_h
  34 #define FILESTREAM_h
  35
  36 #if defined EXTERN
  37 #  undef EXTERN
  38 #endif
  39 #if defined FILESTREAMMODULE
  40 #  define EXTERN
  41 #else
  42 #  define EXTERN extern
  43 #endif
  44
  45 typedef struct
  46 {
  47     FILE      *File;
  48     Boolean_t  IsByteOrderNative;
  49 } FileStream_s;
  50
  51 /**
  52  * Creates a structure for associating an open file stream with its byte
  53  * order. The byte order can changed at any time.
  54  *
  55  * @param File
  56  *     Handle to a file which can be NULL.
  57  * @param IsByteOrderNative
  58  *     TRUE if the file's byte order is native, FALSE if foreign.
  59  *
  60  * @return
  61  *     An allocated structure associating an open file to its byte order.
  62  */
  63 EXTERN FileStream_s *FileStreamAlloc(FILE      *File,
  64                                      Boolean_t  IsByteOrderNative);
  65
  66 /**
  67  * Deallocates the structure associating the file stream with the byte order.
  68  * This function does NOT close the file.
  69  *
  70  * @param FileStream
  71  *     Pointer to an open file stream or a pointer to NULL.
  72  */
  73 EXTERN void FileStreamDealloc(FileStream_s **FileStream);
  74
  75 #endif