Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-11-06 00:00:58 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Userland/Libraries/LibDesktop/AppFile.h

61 lines
1.9 KiB
C
Raw Normal View History

LibGUI: Add GUI::AppFile, a simple wrapper around .af files
2020-12-27 18:50:50 +01:00
/*
Everywhere: Use linusg@serenityos.org for my copyright headers
2021-04-22 22:51:19 +02:00
* Copyright (c) 2020, Linus Groh <linusg@serenityos.org>
Libraries: Use default constructors/destructors in LibCpp https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#cother-other-default-operation-rules "The compiler is more likely to get the default semantics right and you cannot implement these functions better than the compiler."
2022-02-26 10:30:59 -07:00
* Copyright (c) 2022, the SerenityOS developers.
LibGUI: Add GUI::AppFile, a simple wrapper around .af files
2020-12-27 18:50:50 +01: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 01:24:48 -07:00
* SPDX-License-Identifier: BSD-2-Clause
LibGUI: Add GUI::AppFile, a simple wrapper around .af files
2020-12-27 18:50:50 +01:00
*/
#pragma once
#include <LibCore/ConfigFile.h>
#include <LibGUI/FileIconProvider.h>
#include <LibGUI/Icon.h>
AppFile: Add spawn_with_escalation
2024-01-05 17:20:33 +13:00
#include <LibGUI/Window.h>
LibGUI: Add GUI::AppFile, a simple wrapper around .af files
2020-12-27 18:50:50 +01:00
Everywhere: Move AppFile from LibGUI to LibDesktop This was mentioned in #4574, and the more I think about it the more it feels just right - let's move it there! :^) Having to link LaunchServer against LibGUI explicitly should've been telling enough...
2020-12-28 01:06:38 +01:00
namespace Desktop {
LibGUI: Add GUI::AppFile, a simple wrapper around .af files
2020-12-27 18:50:50 +01:00
class AppFile : public RefCounted<AppFile> {
public:
Everywhere: Add sv suffix to strings relying on StringView(char const*) Each of these strings would previously rely on StringView's char const* constructor overload, which would call __builtin_strlen on the string. Since we now have operator ""sv, we can replace these with much simpler versions. This opens the door to being able to remove StringView(char const*). No functional changes.
2022-07-11 17:32:29 +00:00
static constexpr auto APP_FILES_DIRECTORY = "/res/apps"sv;
AppFile: Add helpers for dealing with AppFile paths
2023-11-04 19:31:08 +01:00
static bool exists_for_app(StringView app_name);
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 17:49:34 +03:30
static ByteString file_for_app(StringView app_name);
static ByteString app_file_path_for_app(StringView app_name);
AppFile: Add helpers for dealing with AppFile paths
2023-11-04 19:31:08 +01:00
Everywhere: Pass AK::StringView by value
2021-11-11 00:55:02 +01:00
static NonnullRefPtr<AppFile> get_for_app(StringView app_name);
static NonnullRefPtr<AppFile> open(StringView path);
static void for_each(Function<void(NonnullRefPtr<AppFile>)>, StringView directory = APP_FILES_DIRECTORY);
Libraries: Use default constructors/destructors in LibDesktop https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#cother-other-default-operation-rules "The compiler is more likely to get the default semantics right and you cannot implement these functions better than the compiler."
2022-02-26 10:32:57 -07:00
~AppFile() = default;
LibGUI: Add GUI::AppFile, a simple wrapper around .af files
2020-12-27 18:50:50 +01:00
bool is_valid() const { return m_valid; }
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 17:49:34 +03:30
ByteString filename() const { return m_config->filename(); }
ByteString name() const;
LibDesktop: Add menu_name() to AppFile This really just takes the [App].Name config value and removes the ampersands `&` from the name. These ampersands are hotkeys for the system menu. Instead of typing them twice - error prone - use the fact that name is just menu_name without the ampersand. Remove the ampersand to use as the name and use it as is as the menu_name.
2024-01-04 08:19:34 +13:00
ByteString menu_name() const;
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 17:49:34 +03:30
ByteString executable() const;
ByteString category() const;
ByteString description() const;
ByteString working_directory() const;
ByteString icon_path() const;
LibDesktop: Add support for IconPath in AppFile With `IconPath`, you can override the icon used for the application shortcut. This currently only supports resolving the icon through `GUI::FileIconProvider`, the implementation for pointing to actual image files is left as an exercise for the reader.
2021-08-04 13:16:26 +02:00
GUI::Icon icon() const;
LibDesktop: Add a RunInTerminal boolean field to app files This is common enough to warrant its own setting by now - but it's also partially a workaround. Since app files currently only support a single executable path with no arguments, we resort to generating wrapper scripts for port launchers with arguments - and then the executable is that shell script. We also moved from manually specifying icon files to embedding them in executables. As shell scripts can't have icons embedded in them, a different solution is needed - this one solves the common case of running a CLI program in a terminal, and still allows embedding of icons in the executable itself as no shell script is needed, meaning it will be shown in the taskbar and system menu. The second use case of actually passing arguments to the executable itself (and not just "Terminal -e ...") is not covered by this and still requires an external script (meaning no icon for now), but I think that can easily be solved by adding something like an "Arguments" field to app files. :^)
2021-07-19 22:00:34 +01:00
bool run_in_terminal() const;
LibDesktop: Add support for RequiresRoot option to AppFile
2022-10-03 20:08:34 -04:00
bool requires_root() const;
LibDesktop+Taskbar: Add an option to exclude apps from the system menu We currently hard-code excluding Settings apps from the system menu. This adds an "ExcludeFromSystemMenu" option to the AppFile configuration to selectively exclude these apps, which all Settings app now set. This is to allow selectively excluding a few Demo apps in a future commit.
2023-01-02 11:59:48 -05:00
bool exclude_from_system_menu() const;
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 17:49:34 +03:30
Vector<ByteString> launcher_mime_types() const;
Vector<ByteString> launcher_file_types() const;
Vector<ByteString> launcher_protocols() const;
LibDesktop: Pass an optional arguments list to AppFile::spawn()
2023-01-20 21:50:53 +00:00
bool spawn(ReadonlySpan<StringView> arguments = {}) const;
AppFile: Add spawn_with_escalation
2024-01-05 17:20:33 +13:00
bool spawn_with_escalation(ReadonlySpan<StringView> arguments = {}) const;
void spawn_with_escalation_or_show_error(GUI::Window&, ReadonlySpan<StringView> arguments = {}) const;
LibGUI: Add GUI::AppFile, a simple wrapper around .af files
2020-12-27 18:50:50 +01:00
private:
Everywhere: Pass AK::StringView by value
2021-11-11 00:55:02 +01:00
explicit AppFile(StringView path);
LibGUI: Add GUI::AppFile, a simple wrapper around .af files
2020-12-27 18:50:50 +01:00
bool validate() const;
RefPtr<Core::ConfigFile> m_config;
bool m_valid { false };
};
}
Reference in a new issue Copy permalink