#include <TFile.hpp>

Collaboration diagram for tklb::FileInfo:

Public Member Functions
	FileInfo (const char *path)

	FileInfo ()=default

void	scan ()
	Recursively scans the directory and its subfolder. More...

bool	isWave ()
	check if the file has a .wav extension More...

bool	isJSON ()
	check if the file has a .json extension More...

bool	remove ()
	Will delete the file, does not work with folders. More...

std::string	hashFile ()
	Simple hash operation. More...

void	print ()
	Print the directory tree. More...

Static Public Member Functions
static bool	write (const char path, const char data, const size_t length)
	Write to a file. More...

static std::string	joinPath (const std::initializer_list< std::string > &paths)
	Concats multiple paths TODO tklb trim path dilimters. More...

static std::string	platformPath (std::string path)
	Replaces all pathdelimters to the platform ones. More...

static bool	isRelative (const std::string &path)

static void	toUnixPath (std::string &path)

Public Attributes
std::string	name

std::string	relative

std::string	absolute

bool	isFolder = false

HeapBuffer< FileInfo >	children

Private Member Functions
void	recursivePrint (FileInfo &info, int depth)

void	recursiveScan (FileInfo &root, bool recursive)

void	appendDelimiter (FileInfo &info)

Detailed Description

Definition at line 29 of file TFile.hpp.

Constructor & Destructor Documentation

◆ FileInfo() [1/2]

tklb::FileInfo::FileInfo ( const char * path )

inline

Definition at line 36 of file TFile.hpp.

                                   {
            if (isRelative(path)) {
                relative = path;
                absolute = path;
                // TKLB_ASSERT(false)
                // TODO tklb figure out the absolute path
            } else {
                absolute = path;
                relative = "./";
            }
            toUnixPath(absolute);
            toUnixPath(relative);
            recursiveScan(*this, false);
        }

Here is the call graph for this function:

◆ FileInfo() [2/2]

tklb::FileInfo::FileInfo ( )

default

Member Function Documentation

◆ appendDelimiter()

void tklb::FileInfo::appendDelimiter ( FileInfo & info )

inlineprivate

Definition at line 235 of file TFile.hpp.

                                             {
            if (info.relative.length() - info.relative.find_last_of('/') != 1) {
                info.relative = info.relative + "/";
            }
            if (info.absolute.length() - info.absolute.find_last_of('/') != 1) {
                info.absolute = info.absolute + "/";
            }
        }

Here is the caller graph for this function:

◆ hashFile()

std::string tklb::FileInfo::hashFile ( )

inline

Simple hash operation.

Definition at line 93 of file TFile.hpp.

                             {
            const char* path = absolute.c_str();
 
            if (isFolder) {
                return ""; // Can't has folder
            }
            std::ifstream fp(path);
            std::stringstream ss;
            // Unable to hash file, return an empty hash.
            if (!fp.is_open()) {
                return "";
            }
 
            // Hashing
            uint32_t magic = 5381;
            char c;
            while (fp.get(c)) {
                magic = ((magic << 5) + magic) + c; // magic * 33 + c
            }
 
            ss << std::hex << std::setw(8) << std::setfill('0') << magic;
            return ss.str();
        }

◆ isJSON()

bool tklb::FileInfo::isJSON ( )

inline

check if the file has a .json extension

Definition at line 72 of file TFile.hpp.

                      {
            return name.length() - name.find_last_of(".JSON") == 5
                || name.length() - name.find_last_of(".json") == 5;
        }

◆ isRelative()

static bool tklb::FileInfo::isRelative ( const std::string & path )

inlinestatic

Definition at line 172 of file TFile.hpp.

                                                      {
            return path[0] == '.';
        }

Here is the caller graph for this function:

◆ isWave()

bool tklb::FileInfo::isWave ( )

inline

check if the file has a .wav extension

Definition at line 64 of file TFile.hpp.

                      {
            return name.length() - name.find_last_of(".WAV") == 4
                || name.length() - name.find_last_of(".wav") == 4;
        }

◆ joinPath()

static std::string tklb::FileInfo::joinPath ( const std::initializer_list< std::string > & paths )

inlinestatic

Concats multiple paths TODO tklb trim path dilimters.

Definition at line 145 of file TFile.hpp.

                                                                               {
            std::string joined;
            for (auto &i : paths) {
                joined += i;
            }
            return joined;
        }

◆ platformPath()

static std::string tklb::FileInfo::platformPath ( std::string path )

inlinestatic

Replaces all pathdelimters to the platform ones.

Definition at line 156 of file TFile.hpp.

                                                      {
            for (size_t i = 1; i < path.size(); i++) {
                if ((path[i - 1] == '/' || path[i - 1] == '\\') && (path[i] == '/' || path[i] == '\\')) {
                    // need to get rid of double slashes
                    TKLB_ASSERT(false);
                }
            }
 
            for (size_t i = 0; i < path.size(); i++) {
                if (path[i] == '/' || path[i] == '\\') {
                    path[i] = PATH_DELIMITER[0];
                }
            }
            return path;
        }

◆ print()

void tklb::FileInfo::print ( )

inline

Print the directory tree.

Definition at line 120 of file TFile.hpp.

                     {
            recursivePrint(*this, 0);
        }

Here is the call graph for this function:

◆ recursivePrint()

void tklb::FileInfo::recursivePrint	(	FileInfo &	info,
		int	depth
	)

inlineprivate

Definition at line 185 of file TFile.hpp.

                                                       {
            char space[256];
            std::fill_n(space, 256, 0);
            std::fill_n(space, depth, ' ');
            TKLB_PRINT("%s%s\n", space, info.name.c_str())
            for (int i = 0; i < info.children.size(); i++) {
                recursivePrint(info.children[i], depth + 1);
            }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ recursiveScan()

void tklb::FileInfo::recursiveScan	(	FileInfo &	root,
		bool	recursive
	)

inlineprivate

Definition at line 195 of file TFile.hpp.

                                                           {
            root.children.clear();
            struct dirent** files = nullptr;
            const int count = scandir(root.absolute.c_str(), &files, nullptr, alphasort);
            if (count >= 0) {
                root.isFolder = true;
                appendDelimiter(root);
                for (int i = 0; i < count; i++) {
                    const struct dirent* ent = files[i];
                    if (ent == nullptr) {
                        continue;
                    }
                    if (ent->d_name[0] != '.') {
                        FileInfo info;
                        info.isFolder = ent->d_type == DT_DIR;
                        info.name = ent->d_name;
                        info.relative = root.relative + info.name;
                        info.absolute = root.absolute + info.name;
                        if (recursive && info.isFolder) {
                            recursiveScan(info, true);
                        }
                        root.children.push(info);
                    }
                #ifdef _WIN32
                    free(files[i]);
                #else // _WIN32
                    TKLB_STD_POOL.deallocate(files[i]);
                #endif // _WIN32
                }
            } else {
                root.isFolder = false;
            }
        #ifdef _WIN32
            free(files);
        #else // _WIN32
            TKLB_STD_POOL.deallocate(files);
        #endif // _WIN32
 
        }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove()

bool tklb::FileInfo::remove ( )

inline

Will delete the file, does not work with folders.

Definition at line 80 of file TFile.hpp.

                      {
            const char* path = absolute.c_str();
            if (!isFolder) {
                return std::remove(path) == 0;
            }
            // TODO tklb Folder deleteion
            TKLB_ASSERT(false);
            return false;
        }

◆ scan()

void tklb::FileInfo::scan ( )

inline

Recursively scans the directory and its subfolder.

Definition at line 57 of file TFile.hpp.

                    {
            recursiveScan(*this, true);
        }

Here is the call graph for this function:

◆ toUnixPath()

static void tklb::FileInfo::toUnixPath ( std::string & path )

inlinestatic

Definition at line 176 of file TFile.hpp.

                                                {
            for (size_t i = 1; i < path.size(); i++) {
                if (path[i] == '\\') {
                    path[i] = '/';
                }
            }
        }

Here is the caller graph for this function:

◆ write()

static bool tklb::FileInfo::write	(	const char *	path,
		const char *	data,
		const size_t	length
	)

inlinestatic

Write to a file.

Parameters

path	The path to the file
data	The data buffer
length	The length of the data buffer

Definition at line 130 of file TFile.hpp.

                                                                                   {
            try {
                auto file = std::fstream(path, std::ios::out | std::ios::binary);
                file.write(data, length);
                file.close();
                return true;
            } catch (...) {
                return false;
            }
        }

Member Data Documentation

◆ absolute

std::string tklb::FileInfo::absolute

Definition at line 32 of file TFile.hpp.

◆ children

HeapBuffer<FileInfo> tklb::FileInfo::children

Definition at line 34 of file TFile.hpp.

◆ isFolder

bool tklb::FileInfo::isFolder = false

Definition at line 33 of file TFile.hpp.

◆ name

std::string tklb::FileInfo::name

Definition at line 30 of file TFile.hpp.

◆ relative

std::string tklb::FileInfo::relative

Definition at line 31 of file TFile.hpp.

The documentation for this struct was generated from the following file:

TFile.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ FileInfo() [1/2]

◆ FileInfo() [2/2]

Member Function Documentation

◆ appendDelimiter()

◆ hashFile()

◆ isJSON()

◆ isRelative()

◆ isWave()

◆ joinPath()

◆ platformPath()

◆ print()

◆ recursivePrint()

◆ recursiveScan()

◆ remove()

◆ scan()

◆ toUnixPath()

◆ write()

Member Data Documentation

◆ absolute

◆ children

◆ isFolder

◆ name

◆ relative