serenity/Userland/Libraries/LibCore/StandardPaths.h

/*
 * Copyright (c) 2020, Andreas Kling <kling@serenityos.org>
 * Copyright (c) 2023, Linus Groh <linusg@serenityos.org>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/Error.h>
#include <AK/Forward.h>

namespace Core {

class StandardPaths {
public:
    static DeprecatedString home_directory();
    static DeprecatedString desktop_directory();
    static DeprecatedString documents_directory();
    static DeprecatedString downloads_directory();
    static DeprecatedString tempfile_directory();
    static DeprecatedString config_directory();
    static DeprecatedString data_directory();
    static ErrorOr<DeprecatedString> runtime_directory();
    static ErrorOr<Vector<String>> font_directories();
};

}
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 08:38:21 +00:00			`/*`
LibCore: Add StandardPaths thing to retrieve various standard locations Fixes #1853. 2020-04-19 17:57:05 +00:00			`* Copyright (c) 2020, Andreas Kling <kling@serenityos.org>`
LibCore: Add StandardPaths::font_directories() This provides a list of well-known directories containing font files, e.g. for use with Gfx::FontDatabase::load_all_fonts_from_path(). 2023-01-11 20:30:30 +00:00			`* Copyright (c) 2023, Linus Groh <linusg@serenityos.org>`
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 08:38:21 +00:00			`*`
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt * 2021-04-22 08:24:48 +00:00			`* SPDX-License-Identifier: BSD-2-Clause`
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header. 2020-01-18 08:38:21 +00:00			`*/`

LibCore: Make get_current_user_home_path() return String & close passwd This API was returning a "const char*" and it was unclear who took care of the underlying memory. Returning a String makes that obvious. Also make sure we close the /etc/passwd file when we're done with it. 2019-08-03 06:32:07 +00:00			`#pragma once`

LibCore: Add a standard path for runtime communication files This corresponds to XDG_RUNTIME_DIR, which is the path applications may place runtime communication files, like local sockets. 2022-12-09 16:15:17 +00:00			`#include <AK/Error.h>`
LibCore: Add StandardPaths thing to retrieve various standard locations Fixes #1853. 2020-04-19 17:57:05 +00:00			`#include <AK/Forward.h>`
LibCore: Make get_current_user_home_path() return String & close passwd This API was returning a "const char*" and it was unclear who took care of the underlying memory. Returning a String makes that obvious. Also make sure we close the /etc/passwd file when we're done with it. 2019-08-03 06:32:07 +00:00
LibCore: Add StandardPaths thing to retrieve various standard locations Fixes #1853. 2020-04-19 17:57:05 +00:00			`namespace Core {`

			`class StandardPaths {`
			`public:`
AK+Everywhere: Rename String to DeprecatedString We have a new, improved string type coming up in AK (OOM aware, no null state), and while it's going to use UTF-8, the name UTF8String is a mouthful - so let's free up the String name by renaming the existing class. Making the old one have an annoying name will hopefully also help with quick adoption :^) 2022-12-04 18:02:33 +00:00			`static DeprecatedString home_directory();`
			`static DeprecatedString desktop_directory();`
			`static DeprecatedString documents_directory();`
			`static DeprecatedString downloads_directory();`
			`static DeprecatedString tempfile_directory();`
			`static DeprecatedString config_directory();`
LibCore: Add a standard path for application data 2022-12-05 17:46:53 +00:00			`static DeprecatedString data_directory();`
LibCore: Add a standard path for runtime communication files This corresponds to XDG_RUNTIME_DIR, which is the path applications may place runtime communication files, like local sockets. 2022-12-09 16:15:17 +00:00			`static ErrorOr<DeprecatedString> runtime_directory();`
LibCore: Add StandardPaths::font_directories() This provides a list of well-known directories containing font files, e.g. for use with Gfx::FontDatabase::load_all_fonts_from_path(). 2023-01-11 20:30:30 +00:00			`static ErrorOr<Vector<String>> font_directories();`
LibCore: Add StandardPaths thing to retrieve various standard locations Fixes #1853. 2020-04-19 17:57:05 +00:00			`};`

			`}`