Instantiating an Arduino_SPIFFS object within the module and changing the implementation of Arduino_SPIFFS_File in such way that the pointer to the spiffs structure is solely contained within the class Arduino_SPIFFS

Author: aentinger

examples/SPIFFSDirectories/SPIFFSDirectories.ino

@@ -12,12 +12,6 @@
 
 #include <Arduino_MKRMEM.h>
 
-/**************************************************************************************
- * GLOBAL VARIABLES
- **************************************************************************************/
-
-Arduino_SPIFFS filesystem;
-
 /**************************************************************************************
  * SETUP/LOOP
  **************************************************************************************/

examples/SPIFFSFormat/SPIFFSFormat.ino

@@ -12,12 +12,6 @@
 
 #include <Arduino_MKRMEM.h>
 
-/**************************************************************************************
- * GLOBAL VARIABLES
- **************************************************************************************/
-
-Arduino_SPIFFS filesystem;
-
 /**************************************************************************************
  * SETUP/LOOP
  **************************************************************************************/

examples/SPIFFSUsage/SPIFFSUsage.ino

@@ -19,12 +19,6 @@
 /* A pangram is a sentence using every letter of a given alphabet at least once. */
 static char const PANGRAM[] = "The quick brown fox jumps over the lazy dog.";
 
-/**************************************************************************************
- * GLOBAL VARIABLES
- **************************************************************************************/
-
-Arduino_SPIFFS filesystem;
-
 /**************************************************************************************
  * SETUP/LOOP
  **************************************************************************************/
@@ -54,7 +48,7 @@ void setup() {
    * write only mode (SPIFFS_WRONLY ). If the file does exist
    * delete the existing content (SPIFFS_TRUNC).
    */
-  File file = filesystem.open("fox.txt", CREATE | WRITE_ONLY | TRUNCATE);
+  File file = filesystem.open("fox.txt", CREATE | READ_WRITE| TRUNCATE);
 
   int const bytes_to_write = strlen(PANGRAM);
   int const bytes_written = file.write((void *)PANGRAM, bytes_to_write);
@@ -66,8 +60,6 @@ void setup() {
     Serial.println(" bytes written");
   }
 
-  file.close();
-
 
   Serial.println("Retrieving filesystem info ...");
   unsigned int bytes_total = 0,
@@ -82,7 +74,7 @@ void setup() {
 
 
   Serial.println("Reading ...");
-  file = filesystem.open("fox.txt", READ_ONLY);
+  file.lseek(0, START); /* Rewind file pointer to the start */
 
   char buf[64] = {0};
   int const bytes_read = file.read(buf, sizeof(buf));

src/Arduino_SPIFFS.cpp

@@ -57,7 +57,7 @@ int Arduino_SPIFFS::mount()
 File Arduino_SPIFFS::open(const char *path, uint16_t const flags)
 {
   spiffs_file const fh = SPIFFS_open(&_fs, path, flags, 0);
-  return File::create(&_fs, fh);
+  return File::create(fh);
 }
 
 Directory Arduino_SPIFFS::opendir(const char *name)
@@ -88,3 +88,9 @@ s32_t w25q16_spi_erase(u32_t addr, u32_t size)
   flash.eraseSector(addr);
   return SPIFFS_OK;
 }
+
+/**************************************************************************************
+ * EXTERN DECLARATION
+ **************************************************************************************/
+
+Arduino_SPIFFS filesystem;

src/Arduino_SPIFFS.h

@@ -87,6 +87,16 @@ class Arduino_SPIFFS
   inline Directory   opendir (String const & name)                        { return opendir(name.c_str()); }
 
 
+  /* In order to allow access to the private functions
+   * read, write, lseek, eof, tell, close, remove, flush
+   * we allow Arduino_SPIFFS_File to be a 'friend' of
+   * 'Arduino_SPIFFS'. Another alternative would be to
+   * make those functions public but what would users do
+   * without the availabilty of a file handle?
+   */
+  friend class Arduino_SPIFFS_File; 
+
+
 private:
 
   spiffs _fs;
@@ -95,6 +105,22 @@ class Arduino_SPIFFS
   u8_t   _spiffs_fds[32*4];
   u8_t   _spiffs_cache_buf[(SPIFFS_CFG_LOG_PAGE_SZ(0)+32)*4];
 
+
+  inline int read  (spiffs_file fh, void * buf, int len)  { return SPIFFS_read(&_fs, fh, buf, len); }
+  inline int write (spiffs_file fh, void * buf, int len)  { return SPIFFS_write(&_fs, fh, buf, len); }
+  inline int lseek (spiffs_file fh, int offs, int whence) { return SPIFFS_lseek(&_fs, fh, offs, whence); }
+  inline int eof   (spiffs_file fh)                       { return SPIFFS_eof(&_fs, fh); }
+  inline int tell  (spiffs_file fh)                       { return SPIFFS_tell(&_fs, fh); }
+  inline int close (spiffs_file fh)                       { return SPIFFS_close(&_fs, fh); }
+  inline int remove(spiffs_file fh)                       { return SPIFFS_fremove(&_fs, fh); }
+  inline int flush (spiffs_file fh)                       { return SPIFFS_fflush(&_fs, fh); }
+
 };
 
+/**************************************************************************************
+ * EXTERN DEFINITION
+ **************************************************************************************/
+
+extern Arduino_SPIFFS filesystem;
+
 #endif /* ARDUINO_SPIFFS_H_ */

src/Arduino_SPIFFS_File.cpp

@@ -22,13 +22,20 @@
 
 #include "Arduino_SPIFFS_File.h"
 
+#include <Arduino_SPIFFS.h>
+
+/**************************************************************************************
+ * EXTERN DEFINITION
+ **************************************************************************************/
+
+extern Arduino_SPIFFS filesystem;
+
 /**************************************************************************************
  * CTOR/DTOR
  **************************************************************************************/
 
-Arduino_SPIFFS_File::Arduino_SPIFFS_File(spiffs * fs, spiffs_file const fh)
-: _fs(fs)
-, _fh(fh)
+Arduino_SPIFFS_File::Arduino_SPIFFS_File(spiffs_file const fh)
+: _fh(fh)
 {
 
 }
@@ -42,23 +49,52 @@ Arduino_SPIFFS_File::~Arduino_SPIFFS_File()
  * PUBLIC MEMBER FUNCTIONS
  **************************************************************************************/
 
-String Arduino_SPIFFS_File::name()
+int Arduino_SPIFFS_File::read(void * buf, int len)
+{
+  return filesystem.read(_fh, buf, len);
+}
+
+int Arduino_SPIFFS_File::write(void * buf, int len)
+{
+  return filesystem.write(_fh, buf, len);
+}
+
+int Arduino_SPIFFS_File::lseek(int offs, int whence)
+{
+  return filesystem.lseek(_fh, offs, whence);
+}
+
+int Arduino_SPIFFS_File::eof()
+{
+  return filesystem.eof(_fh);
+}
+
+int Arduino_SPIFFS_File::tell()
+{
+  return filesystem.tell(_fh);
+}
+
+int Arduino_SPIFFS_File::close()
+{
+  return filesystem.close(_fh);
+}
+
+int Arduino_SPIFFS_File::remove()
+{
+  return filesystem.remove(_fh);
+}
+
+int Arduino_SPIFFS_File::flush()
 {
-  spiffs_stat stat;
-  if(SPIFFS_OK == SPIFFS_fstat(_fs, _fh, &stat)) {
-    return String(reinterpret_cast<const char *>(&(stat.name)));
-  } else {
-    return String("ERROR");
-  }
+  return filesystem.flush(_fh);
 }
 
-Arduino_SPIFFS_File Arduino_SPIFFS_File::create(spiffs * fs, spiffs_file const fh)
+Arduino_SPIFFS_File Arduino_SPIFFS_File::create(spiffs_file const fh)
 {
-  return Arduino_SPIFFS_File(fs, fh);
+  return Arduino_SPIFFS_File(fh);
 }
 
 Arduino_SPIFFS_File Arduino_SPIFFS_File::operator = (Arduino_SPIFFS_File const & other)
 {
-  _fs = other.getFs();
   _fh = other.getFh();
 }

src/Arduino_SPIFFS_File.h

@@ -31,7 +31,7 @@ extern "C"
 }
 
 /**************************************************************************************
- * CLASS DECLARATION
+ * CONSTANTS
  **************************************************************************************/
 
 static int constexpr START   = SPIFFS_SEEK_SET; /* Start to seek from the beginning of the file                */
@@ -50,32 +50,28 @@ class Arduino_SPIFFS_File
   ~Arduino_SPIFFS_File();
 
 
-  String     name  ();
-  inline int read  (void * buf, int len)  { return SPIFFS_read(_fs, _fh, buf, len); }
-  inline int write (void * buf, int len)  { return SPIFFS_write(_fs, _fh, buf, len); }
-  inline int lseek (int offs, int whence) { return SPIFFS_lseek(_fs, _fh, offs, whence); }
-  inline int eof   ()                     { return SPIFFS_eof(_fs, _fh); }
-  inline int tell  ()                     { return SPIFFS_tell(_fs, _fh); }
-  inline int close ()                     { return SPIFFS_close(_fs, _fh); }
-  inline int remove()                     { return SPIFFS_fremove(_fs, _fh); }
-  inline int flush ()                     { return SPIFFS_fflush(_fs, _fh); }
+  int read  (void * buf, int len);
+  int write (void * buf, int len);
+  int lseek (int offs, int whence);
+  int eof   ();
+  int tell  ();
+  int close ();
+  int remove();
+  int flush ();
 
 
-  static Arduino_SPIFFS_File create(spiffs * fs, spiffs_file const fh);
+  static Arduino_SPIFFS_File create(spiffs_file const fh);
 
 
   Arduino_SPIFFS_File operator = (Arduino_SPIFFS_File const & other);
-  inline spiffs *    getFs() const { return _fs; }
   inline spiffs_file getFh() const { return _fh; }
 
 
 private:
 
-  spiffs * _fs;
   spiffs_file _fh;
 
-  Arduino_SPIFFS_File(spiffs * fs, spiffs_file const fh);
-
+  Arduino_SPIFFS_File(spiffs_file const fh);
 
 };