arduino/esp8266
1
0
Fork 0
mirror of https://github.com/esp8266/Arduino.git synced 2025-07-18 23:03:34 +03:00
Code Activity

Return FALSE on seek past EOF (#7324)

Browse Source 
Fixes #7323

While I'm not a fan, the Arduino FileSeek API online shows that a seek()
past EOF should return FALSE.
https://www.arduino.cc/en/Reference/FileSeek

SPIFFS and SDFS obey this, but LittleFS followed the POSIX standard or
allowing seeks past EOF.

Update LittleFS::seek() to follow the Arduino API and add tests for it.
This commit is contained in:
Earle F. Philhower, III
2020-05-30 21:47:53 -07:00
committed by GitHub
parent 27ef03fc05
commit 8ee67ab2b5
2 changed files with 29 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
libraries/LittleFS/src/LittleFS.h
View File

@ -377,11 +377,16 @@ public:
if (mode == SeekEnd) { if (mode == SeekEnd) {
offset = -offset; // TODO - this seems like its plain wrong vs. POSIX offset = -offset; // TODO - this seems like its plain wrong vs. POSIX
} }
auto lastPos = position();
int rc = lfs_file_seek(_fs->getFS(), _getFD(), offset, (int)mode); // NB. SeekMode === LFS_SEEK_TYPES int rc = lfs_file_seek(_fs->getFS(), _getFD(), offset, (int)mode); // NB. SeekMode === LFS_SEEK_TYPES
if (rc < 0) { if (rc < 0) {
DEBUGV("lfs_file_seek rc=%d\n", rc); DEBUGV("lfs_file_seek rc=%d\n", rc);
return false; return false;
} }
if (position() > size()) {
seek(lastPos, SeekSet); // Pretend the seek() never happened
return false;
}
return true; return true;
} }

24
tests/host/fs/test_fs.inc
View File

@ -174,6 +174,30 @@ TEST_CASE(TESTPRE "open(w+) truncates file", TESTPAT)
REQUIRE( t == ""); REQUIRE( t == "");
} }
TEST_CASE(TESTPRE "peek() returns -1 on EOF", TESTPAT)
{
FS_MOCK_DECLARE(64, 8, 512, "");
REQUIRE(FSTYPE.begin());
createFile("/file1", "some text");
auto f = FSTYPE.open("/file1", "r+");
REQUIRE(f.seek(8));
REQUIRE(f.peek() == 't');
REQUIRE(f.read() == 't');
REQUIRE(f.peek() == -1);
REQUIRE(f.read() == -1);
f.close();
}
TEST_CASE(TESTPRE "seek() pase EOF returns error (#7323)", TESTPAT)
{
FS_MOCK_DECLARE(64, 8, 512, "");
REQUIRE(FSTYPE.begin());
createFile("/file1", "some text");
auto f = FSTYPE.open("/file1", "r+");
REQUIRE_FALSE(f.seek(10));
f.close();
}
#ifdef FS_HAS_DIRS #ifdef FS_HAS_DIRS
#if FSTYPE != SDFS #if FSTYPE != SDFS