Helper class to use files is APIs other than openmsx::File. More...
#include <LocalFileReference.hh>
Public Member Functions | |
| LocalFileReference (const Filename &filename) | |
| LocalFileReference (const std::string &url) | |
| LocalFileReference (File &file) | |
| ~LocalFileReference () | |
| const std::string | getFilename () const |
| Returns path to a local uncompressed version of this file. | |
Additional Inherited Members |
Detailed Description
Helper class to use files is APIs other than openmsx::File.
The openMSX File class has support for (g)zipped files (or maybe in the future files over http, ftp, ...). Sometimes you need to pass a filename to an API that doesn't support this (for example SDL_LoadWav()). This class allows to create a temporary local uncompressed version of such files. Use it like this:
LocalFileReference file(filename); // can be any filename supported // by openmsx::File my_function(file.getFilename()); // my_function() can now work on // a regular local file
Note: In the past this functionality was available in the openmsx::File class. The current implementation of that class always keep an open file reference to the corresponding file. This gave problems on (some versions of) windows if the external function tries to open the file in read-write mode (for example IMG_Load() does this). The implementation of this class does not keep a reference to the file.
Definition at line 31 of file LocalFileReference.hh.
Constructor & Destructor Documentation
|
explicit |
Definition at line 15 of file LocalFileReference.cc.
References openmsx::Filename::getResolved().
|
explicit |
Definition at line 20 of file LocalFileReference.cc.
|
explicit |
Definition at line 25 of file LocalFileReference.cc.
| openmsx::LocalFileReference::~LocalFileReference | ( | ) |
Definition at line 72 of file LocalFileReference.cc.
References openmsx::FileOperations::rmdir(), and openmsx::FileOperations::unlink().
Member Function Documentation
| const string openmsx::LocalFileReference::getFilename | ( | ) | const |
Returns path to a local uncompressed version of this file.
This path only remains valid as long as this object is in scope.
Definition at line 82 of file LocalFileReference.cc.
Referenced by openmsx::GlobalCommandController::source().
The documentation for this class was generated from the following files:
