/home/pascal/depot/filedata/src/parasolfilereader.h

/***************************************************************************
 *   Copyright (C) 2005 by Nicolas PASCAL   *
 *   nicolas.pascal@icare.univ-lille1.fr   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef PARASOLFILEREADER_H
#define PARASOLFILEREADER_H

#include "file_tools.h"
#include "file_exceptions.h"
#include "parasolfilerecord.h"
#include "parasolfileformat.h"

#include <string>
#include <iostream>
using namespace std;

typedef struct EntryBlock {
    /* number of time the group is repeated */
    int ntime;
    /* size in bytes of the group */
    int size;
    EntryBlock (int ntime = -1, int size = -1) : ntime(ntime), size(size) {};
    friend ostream &operator<< (std::ostream &stream, const EntryBlock &obj) {
        stream << "{ntime = " << obj.ntime << " ; size = " << obj.size << "}" ;
        return stream;
    }
} EntryBlock;

class PARASOLFileReader{
    friend class PARASOLFileData;
protected:
    string filename;
    PARASOLProduct product;
    FILE* fp;

    virtual void read_record(const Record &record_code);
    void read_entry( void* record, const Record & record_code, int &entry_nb, RecordFormat::iterator & entry_format, const int & record_offset);

    const size_t read_value(void* val, const RecordFormat::iterator &val_format, const int &previous_value_offset);
    void swap_endianess(void * val, const PARASOLDataType &type);

    // ***** methods that must implement the inherited class  ***** //
    virtual const bool is_record_loaded(const Record &rec)=0;
    virtual void free_records()=0;
    virtual PARASOLFileRecord* init_record(const Record &rec)=0;
    virtual const int get_record_offset(const Record &rec)=0;
//     virtual const int get_entry_offset(const Record rec, const int entry_idx, const int record_idx=-1, const int entry_group_idx=-1, const int val_idx=-1)=0;
    virtual const int get_entry_offset(const Record rec, const int entry_idx, const vector <int>& i_val);
//     virtual const int get_entry_group_nb_val(const Record rec, const int entry_idx) const =0;
    virtual vector <EntryBlock> get_entry_block (const Record rec, const int entry_idx) const = 0;
    virtual const RecordFormat* get_record_format(const Record &rec)=0;
    virtual PARASOLFileRecord* get_record(const Record &rec)=0;
    const bool is_file_loaded(){
        return (fp!=NULL);
    };
    void open_file();
    void close_file();
    static void fill_buffer_default(void* buf,const int &nb_val,const PARASOLDataType &type);
public:
    PARASOLFileReader(const string filename="");
    virtual ~PARASOLFileReader();

    static PARASOLProduct get_product(const string &filename) ;
    static void* custom_new(void* buf, const int& nb_data, const PARASOLDataType &type);
    static void* inc_ptr(void* buf_start, const int& inc, const PARASOLDataType &type);
};

#endif