File.h

Go to the documentation of this file.

/*
 *  File.h - Spresense Arduino File library
 *  Copyright 2019 Sony Semiconductor Solutions Corporation
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef __FILE_H__
#define __FILE_H__
 
#ifdef SUBCORE
#error "File library is NOT supported by SubCore."
#endif
 
#include <Arduino.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <stdio.h>
 
#define FILE_READ O_RDONLY                         
#define FILE_WRITE (O_RDONLY | O_WRONLY | O_CREAT) 
class File : public Stream {
 
private:
  char* _name;            
  int _fd;                
  unsigned long _size;    
  unsigned long _curpos;  
  void* _dir;             
public:
  File(const char *name, uint8_t mode = FILE_READ);
 
  File();
 
  ~File();
 
  virtual size_t write(uint8_t data);
 
  virtual size_t write(const uint8_t *buf, size_t size);
 
  virtual int read();
 
  virtual int peek();
 
  virtual int available();
 
  virtual void flush();
 
  int read(void *buf, size_t nbyte);
 
  boolean seek(uint32_t pos);
 
  uint32_t position();
 
  uint32_t size();
 
  void close();
 
  operator bool();
 
  char *name();
 
  boolean isDirectory(void);
 
  File openNextFile(uint8_t mode = O_RDONLY);
 
  void rewindDirectory(void);
 
  using Print::write;
};
 
#endif