BxBinaryFile.h

// ##################################################################
// Binx
// $Id: BxBinaryFile_8h-source.html,v 1.1.1.1 2006/04/19 14:19:02 edikt2 Exp $
//
// Super class for binary file reading
// ##################################################################
/*

//  edikt::BinX
//  www.edikt.org
//  support@edikt.org

// Copyright (c) 2003 The University of Edinburgh.

*/

#ifndef __BxBinaryFile__
#define __BxBinaryFile__

#include <stdio.h>
#include "BxObject.h"
#include "BxDataTypes.h"
#include "BxBinxSchema.h"

enum BxByteOrder {
    BX_UNSPECIFIED,
    BX_BIG_ENDIAN,
    BX_LITTLE_ENDIAN
};

class BxDataset;

class DECLSPEC BxBinaryFile : public BxObject
{
public:
    BxBinaryFile();
    virtual ~BxBinaryFile();

    virtual char* className() const { return "BxBinaryFile"; } //<Returns the null-terminated string "BxBinaryFile".

    char * getFilename() const { return filename_; }
    long getFileSize();   //file size in bytes
    long getFilePos();
    BxDataset * getDataset() { return datasetptr_; }

    bool isOpen() const { return f_!=NULL; }
    bool isReadOnly() const { return readonly_; }

    void setFilename(char * filename);
    void copyFilename(const char * filename);

    FILE * open(const char * filename); //open an existing file
    FILE * create(const char * filename); //create a new file
    FILE * getFile() const { return f_; } //Return file handle of FILE *.
    void close();      //close this file
    int seek(long pos); //seek to a file position
    int readBuffer(void *, int);
    int writeBuffer(void *, int);

    static BxByteOrder calcMemoryByteOrder();  //calculate byte order in memory
    static void reverseBytes(byte * buffer, int numBytes);

    BxByteOrder getMemByteOrder() const { return memByteOrder_; }

    void setDatasetPointer(BxDataset * pset) { datasetptr_ = pset; }

protected:
    FILE * f_;  //<file pointer
    bool    readonly_;  //<indicate a read only or writable file
    BxByteOrder memByteOrder_; //<indicates whether the file stores big endian or little endian representation

private:
    char * filename_;   //<filename with path name
    BxDataset * datasetptr_;  //<list of binary files, used only when creating a BinX document
};

#endif

---