perf: Avoid creating strings for file extension checks (#1303)
## Summary **What is the goal of this PR?** This change avoids the pattern of creating a `std::string` using `.substr` in order to compare against a file extension literal. ```c++ std::string path; if (path.length() >= 4 && path.substr(path.length() - 4) == ".ext") ``` The `checkFileExtension` utility has moved from StringUtils to FsHelpers, to be available to code in lib/. The signature now accepts a `std::string_view` instead of `std::string`, which makes the single implementation reusable for Arduino `String`. Added utility functions for commonly repeated extensions. These changes **save about 2 KB of flash (5,999,427 to 5,997,343)**. --- ### AI Usage While CrossPoint doesn't have restrictions on AI tools in contributing, please be transparent about their usage as it helps set the right context for reviewers. Did you use AI tools to help write this code? _**NO**_
This commit is contained in:
@@ -1,8 +1,12 @@
|
||||
#include "FsHelpers.h"
|
||||
|
||||
#include <cctype>
|
||||
#include <cstring>
|
||||
#include <vector>
|
||||
|
||||
std::string FsHelpers::normalisePath(const std::string& path) {
|
||||
namespace FsHelpers {
|
||||
|
||||
std::string normalisePath(const std::string& path) {
|
||||
std::vector<std::string> components;
|
||||
std::string component;
|
||||
|
||||
@@ -37,3 +41,41 @@ std::string FsHelpers::normalisePath(const std::string& path) {
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
bool checkFileExtension(std::string_view fileName, const char* extension) {
|
||||
const size_t extLen = strlen(extension);
|
||||
if (fileName.length() < extLen) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const size_t offset = fileName.length() - extLen;
|
||||
for (size_t i = 0; i < extLen; i++) {
|
||||
if (tolower(static_cast<unsigned char>(fileName[offset + i])) !=
|
||||
tolower(static_cast<unsigned char>(extension[i]))) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool hasJpgExtension(std::string_view fileName) {
|
||||
return checkFileExtension(fileName, ".jpg") || checkFileExtension(fileName, ".jpeg");
|
||||
}
|
||||
|
||||
bool hasPngExtension(std::string_view fileName) { return checkFileExtension(fileName, ".png"); }
|
||||
|
||||
bool hasBmpExtension(std::string_view fileName) { return checkFileExtension(fileName, ".bmp"); }
|
||||
|
||||
bool hasGifExtension(std::string_view fileName) { return checkFileExtension(fileName, ".gif"); }
|
||||
|
||||
bool hasEpubExtension(std::string_view fileName) { return checkFileExtension(fileName, ".epub"); }
|
||||
|
||||
bool hasXtcExtension(std::string_view fileName) {
|
||||
return checkFileExtension(fileName, ".xtc") || checkFileExtension(fileName, ".xtch");
|
||||
}
|
||||
|
||||
bool hasTxtExtension(std::string_view fileName) { return checkFileExtension(fileName, ".txt"); }
|
||||
|
||||
bool hasMarkdownExtension(std::string_view fileName) { return checkFileExtension(fileName, ".md"); }
|
||||
|
||||
} // namespace FsHelpers
|
||||
|
||||
@@ -1,7 +1,58 @@
|
||||
#pragma once
|
||||
#include <string>
|
||||
#include <WString.h>
|
||||
|
||||
class FsHelpers {
|
||||
public:
|
||||
static std::string normalisePath(const std::string& path);
|
||||
};
|
||||
#include <string>
|
||||
#include <string_view>
|
||||
|
||||
namespace FsHelpers {
|
||||
|
||||
std::string normalisePath(const std::string& path);
|
||||
|
||||
/**
|
||||
* Check if the given filename ends with the specified extension (case-insensitive).
|
||||
*/
|
||||
bool checkFileExtension(std::string_view fileName, const char* extension);
|
||||
inline bool checkFileExtension(const String& fileName, const char* extension) {
|
||||
return checkFileExtension(std::string_view{fileName.c_str(), fileName.length()}, extension);
|
||||
}
|
||||
|
||||
// Check for either .jpg or .jpeg extension (case-insensitive)
|
||||
bool hasJpgExtension(std::string_view fileName);
|
||||
inline bool hasJpgExtension(const String& fileName) {
|
||||
return hasJpgExtension(std::string_view{fileName.c_str(), fileName.length()});
|
||||
}
|
||||
|
||||
// Check for .png extension (case-insensitive)
|
||||
bool hasPngExtension(std::string_view fileName);
|
||||
inline bool hasPngExtension(const String& fileName) {
|
||||
return hasPngExtension(std::string_view{fileName.c_str(), fileName.length()});
|
||||
}
|
||||
|
||||
// Check for .bmp extension (case-insensitive)
|
||||
bool hasBmpExtension(std::string_view fileName);
|
||||
|
||||
// Check for .gif extension (case-insensitive)
|
||||
bool hasGifExtension(std::string_view fileName);
|
||||
inline bool hasGifExtension(const String& fileName) {
|
||||
return hasGifExtension(std::string_view{fileName.c_str(), fileName.length()});
|
||||
}
|
||||
|
||||
// Check for .epub extension (case-insensitive)
|
||||
bool hasEpubExtension(std::string_view fileName);
|
||||
inline bool hasEpubExtension(const String& fileName) {
|
||||
return hasEpubExtension(std::string_view{fileName.c_str(), fileName.length()});
|
||||
}
|
||||
|
||||
// Check for either .xtc or .xtch extension (case-insensitive)
|
||||
bool hasXtcExtension(std::string_view fileName);
|
||||
|
||||
// Check for .txt extension (case-insensitive)
|
||||
bool hasTxtExtension(std::string_view fileName);
|
||||
inline bool hasTxtExtension(const String& fileName) {
|
||||
return hasTxtExtension(std::string_view{fileName.c_str(), fileName.length()});
|
||||
}
|
||||
|
||||
// Check for .md extension (case-insensitive)
|
||||
bool hasMarkdownExtension(std::string_view fileName);
|
||||
|
||||
} // namespace FsHelpers
|
||||
|
||||
Reference in New Issue
Block a user