XFile.h

Go to the documentation of this file.

/*
 * XFile.h
 *
 * Abstract interface for files.
 *
 * This file is part of Qualia https://github.com/sofian/qualia
 *
 * The code is an adaptation of code from Torch 3.1.
 * (c) 2013 Sofian Audry -- info(@)sofianaudry(.)com
 * (c) 2003--2004 Ronan Collobert (collober@idiap.ch)
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 */
#ifndef X_FILE_INC
#define X_FILE_INC

#include <qualia/core/common.h>
#include <string.h>

#ifndef SEEK_SET // from stdio.h
#define SEEK_SET 0x0
#define SEEK_CUR 0x1
#define SEEK_END 0x2
#endif

class XFile
{
  public:

    XFile();

    virtual int read(void *ptr, int block_size, int n_blocks) = 0;

    virtual int write(const void *ptr, int block_size, int n_blocks) = 0;

    int taggedRead(void *ptr, int block_size, int n_blocks, const char *tag);

    int taggedWrite(const void *ptr, int block_size, int n_blocks, const char *tag);

    virtual int eof() = 0;

    virtual int flush() = 0;

    virtual int seek(long offset, int whence) = 0;

    virtual long tell() = 0;
    
    virtual void rewind() = 0;

    //virtual int printf(const char *format, ...) = 0;

    //virtual int scanf(const char *format, void *ptr) = 0;

    virtual char *gets(char *dest, int size_) = 0;

    virtual long size();

    //-----

    virtual ~XFile();
};

#endif