SaneCppLibraries/StringPath_8h_source.html

// Copyright (c) Stefano Cristiano

// SPDX-License-Identifier: MIT

#pragma once

#include "../Foundation/StringSpan.h"


namespace SC

{


struct StringPath

{

#if SC_PLATFORM_WINDOWS

    static constexpr size_t MaxPath = 260; // Equal to 'MAX_PATH' on Windows

#elif SC_PLATFORM_APPLE

    static constexpr size_t MaxPath = 1024; // Equal to 'PATH_MAX' on macOS

#else

    static constexpr size_t MaxPath = 4096; // Equal to 'PATH_MAX' on Linux

#endif

    size_t length = 0;

#if SC_PLATFORM_WINDOWS

    wchar_t path[MaxPath];

    operator StringSpan() const { return StringSpan({path, length}, true); }

#else

    char path[MaxPath];

    operator StringSpan() const { return StringSpan({path, length}, true, StringEncoding::Utf8); }

#endif


    [[nodiscard]] StringSpan view() const { return *this; }


    [[nodiscard]] bool assign(StringSpan pathToConvert);

};


} // namespace SC

SC::StringPath
Pre-sized char array holding enough space to represent a file system path.
Definition StringPath.h:10

SC::StringPath::length
size_t length
Length of the path in bytes (excluding null terminator)
Definition StringPath.h:19

SC::StringPath::MaxPath
static constexpr size_t MaxPath
Maximum size of paths on current native platform.
Definition StringPath.h:17

SC::StringPath::assign
bool assign(StringSpan pathToConvert)
Assigns a StringView to current StringPath, converting the encoding from UTF16 to UTF8 if needed.

SC::StringPath::view
StringSpan view() const
Obtain a StringSpan from the current StringPath.
Definition StringPath.h:29

SC::StringPath::path
char path[MaxPath]
Native path on Posix (UTF-8)
Definition StringPath.h:24

SC::StringSpan
An read-only view over a string (to avoid including Strings library when parsing is not needed).
Definition StringSpan.h:31