Paths.h

///----------------------------------------------------------------------------------------------------
/// Copyright (c) Raidcore.GG - All rights reserved.
///
/// Name         :  Paths.h
/// Description  :  Contains a variety of utility for the filesystem and paths.
/// Authors      :  K. Bieniek
///----------------------------------------------------------------------------------------------------

#pragma once

#include <filesystem>
#include <string>
#include <windows.h>

///----------------------------------------------------------------------------------------------------
/// Path Namespace
///----------------------------------------------------------------------------------------------------
namespace Path
{
	///----------------------------------------------------------------------------------------------------
	/// GetModule:
	/// 	Returns the path of the specified module.
	///----------------------------------------------------------------------------------------------------
	inline std::filesystem::path GetModule(HMODULE aModule)
	{
		char buff[MAX_PATH]{};
		GetModuleFileNameA(aModule, buff, MAX_PATH);

		return buff;
	}

	///----------------------------------------------------------------------------------------------------
	/// GetSystem:
	/// 	Returns a system path with the specified string appended.
	///----------------------------------------------------------------------------------------------------
	inline std::filesystem::path GetSystem(const char* aAppend = nullptr)
	{
		char buff[MAX_PATH]{};
		GetSystemDirectoryA(buff, MAX_PATH);

		if (!aAppend)
		{
			/* return just the system path */
			return buff;
		}

		std::filesystem::path path = buff;
		path.append(aAppend);

		return path;
	}

	///----------------------------------------------------------------------------------------------------
	/// CreateDir:
	/// 	Wrapper function to create directories recursively.
	///----------------------------------------------------------------------------------------------------
	inline void CreateDir(const std::filesystem::path& aDirectory)
	{
		if (!std::filesystem::exists(aDirectory))
		{
			std::filesystem::create_directories(aDirectory);
		}
	}

	///----------------------------------------------------------------------------------------------------
	/// GetUnused:
	/// 	Returns an unused path based on the passed one.
	/// 	Increments like: "filename_#.extension".
	///----------------------------------------------------------------------------------------------------
	inline std::filesystem::path GetUnused(const std::filesystem::path& aPath)
	{
		std::filesystem::path probe = aPath;

		std::filesystem::path dir = aPath.parent_path();
		std::string           filename = aPath.stem().string();
		std::string           ext = aPath.extension().string();

		int i = 0;
		while (std::filesystem::exists(probe))
		{
			i++;
			probe = dir / (filename + std::to_string(i) + ext);
		}

		return probe;
	}
}