file.h

Go to the documentation of this file.

/*
Copyright (c) 2019-2024 Alexander Scholz
 
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
 
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
 
1. The origin of this software must not be misrepresented; you must not
   claim that you wrote the original software. If you use this software
   in a product, an acknowledgment in the product documentation would be
   appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
   misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
*/
#ifndef YOURGAME_FILE_H
#define YOURGAME_FILE_H
 
#include <cstdint>
#include <string>
#include <vector>
 
namespace yourgame
{
    namespace file
    {
        int readFile(const std::string &filename, std::vector<uint8_t> &dst);
 
        int readAssetFile(const std::string &filename, std::vector<uint8_t> &dst);
 
        int readProjectFile(const std::string &filename, std::vector<uint8_t> &dst);
 
        int writeFile(const std::string &filename, const void *data, size_t numBytes);
 
        int writeAssetFile(const std::string &filename, const void *data, size_t numBytes);
 
        int writeProjectFile(const std::string &filename, const void *data, size_t numBytes);
 
        void setProjectPath(const std::string &path);
 
        std::string getBasePath(const std::string &pathRelative = "");
 
        std::string getAssetFilePath(const std::string &pathRelative = "");
 
        std::string getProjectFilePath(const std::string &pathRelative = "");
 
        std::string getFileLocation(const std::string &filepath);
 
        std::string getFileName(const std::string &filepath);
 
        std::string getFileNameWithoutExtension(const std::string &filepath);
 
        std::string getFileExtension(const std::string &filepath);
 
        std::vector<std::string> ls(const std::string &pattern);
    } // namespace file
} // namespace yourgame
 
#endif