sfile.h

Go to the documentation of this file.

/*
 * sfile.h
 *
 * Structured file I/O channel class.
 *
 * Portable Windows Library
 *
 * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * The Original Code is Portable Windows Library.
 *
 * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
 *
 * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
 * All Rights Reserved.
 *
 * Contributor(s): ______________________________________.
 *
 * $Revision: 27039 $
 * $Author: rjongbloed $
 * $Date: 2012-02-22 18:19:46 +1100 (Wed, 22 Feb 2012) $
 */

#ifndef PTLIB_STRUCTUREDFILE_H
#define PTLIB_STRUCTUREDFILE_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif


class PStructuredFile : public PFile
{
  PCLASSINFO(PStructuredFile, PFile);

  private:
    PBoolean Read(void * buf, PINDEX len) { return PFile::Read(buf, len); }
    PBoolean Write(const void * buf, PINDEX len) { return PFile::Write(buf, len); }

  public:
    PStructuredFile();

    PStructuredFile(
      OpenMode mode,          
      OpenOptions opts = ModeDefault  
    );
      
    PStructuredFile(
      const PFilePath & name,    
      OpenMode mode = ReadWrite, 
      OpenOptions opts = ModeDefault     
    );

    PBoolean Read(
      void * buffer   
    );
      
    PBoolean Write(
      const void * buffer   
    );

    PINDEX GetStructureSize() { return structureSize; }

    enum ElementType {
      Character,    
      Integer16,    
      Integer32,    
      Integer64,    
      Float32,      
      Float64,      
      Float80,      
      NumElementTypes
    };

    struct Element {
      ElementType type;   
      PINDEX      count;  
    };

    void SetStructure(
      Element * structure,  
      PINDEX numElements    
    );

  protected:
  // Member variables
    PINDEX structureSize;

    Element * structure;

    PINDEX numElements;


// Include platform dependent part of class
#ifdef _WIN32
#include "msos/ptlib/sfile.h"
#else
#include "unix/ptlib/sfile.h"
#endif
};


#endif // PTLIB_STRUCTUREDFILE_H


// End Of File ///////////////////////////////////////////////////////////////