openframeworks / openframeworks/openFrameworks
Should ofPathToString(), ofGetExtensionLower(), and FS-functions be private?
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 10.4k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Description
With of_v20250330_osx_release:
I notice ofFileUtils.h adds ofPathToString() and ofGetExtensionLower() however neither is documented and it appears both are used internally.
In ofFileUtils.cpp, bot are commented with:
// Function used internally in OF core. API can change later
Should they be private within of::priv?
UPDATE: The overview list I am wondering about is:
ofPathToString()
ofGetExtensionLower()
ofToDataPathFS()
ofGetPathForDirectoryFS(const of::filesystem::path &);
ofGetAbsolutePathFS(const of::filesystem::path &, bool);
ofFilePath::getCurrentExeDirFS();
ofFile::pathFS()
ofDirectory::getAbsolutePathFS()
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the declarations in ofFileUtils.h with the implementations and comments in ofFileUtils.cpp, then trace the listed FS functions and their internal uses. The work is complete when each listed function has a consistent public or private visibility decision and the headers and implementation reflect that decision without breaking required callers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- operating-systems
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100