Arduino/hardware/arduino/avr/libraries/Bridge/FileIO.h

/*
  Copyright (c) 2013 Arduino LLC. All right reserved.

  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 __FILEIO_H__
#define __FILEIO_H__

#include <Process.h>

#define FILE_READ 0
#define FILE_WRITE 1
#define FILE_APPEND 2

class File : public Stream {
 
public:
  File(BridgeClass &b = Bridge);
  File(const char *_filename, uint8_t _mode, BridgeClass &b = Bridge);
  ~File();
  
  virtual size_t write(uint8_t);
  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, uint16_t nbyte);
  boolean seek(uint32_t pos);
  uint32_t position();
  uint32_t size();
  void close();
  operator bool();
  const char * name();
  boolean isDirectory();
  File openNextFile(uint8_t mode = FILE_READ);
  void rewindDirectory(void);
  
  //using Print::write;

private:
  void doBuffer();
  uint8_t buffered;
  uint8_t readPos;
  static const int BUFFER_SIZE = 64;
  uint8_t buffer[BUFFER_SIZE];
  
private:
  BridgeClass &bridge;
  String filename;
  uint8_t mode;
  uint8_t handle;
};

class FileSystemClass {
public:
  FileSystemClass() : bridge(Bridge) { }
  FileSystemClass(BridgeClass &_b) : bridge(_b) { }
  
  boolean begin();
  
  // Open the specified file/directory with the supplied mode (e.g. read or
  // write, etc). Returns a File object for interacting with the file.
  // Note that currently only one file can be open at a time.
  File open(const char *filename, uint8_t mode = FILE_READ);

  // Methods to determine if the requested file path exists.
  boolean exists(const char *filepath);

  // Create the requested directory heirarchy--if intermediate directories
  // do not exist they will be created.
  boolean mkdir(const char *filepath);
  
  // Delete the file.
  boolean remove(const char *filepath);
  
  boolean rmdir(const char *filepath);

private:
  friend class File;
  
  BridgeClass &bridge;
};

extern FileSystemClass FileSystem;

#endif