dmaax/ladybird
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ladybird/Userland/Libraries/LibCore/ConfigFile.h

93 lines
3.4 KiB
C
Raw Normal View History

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 05:38:21 -03:00
/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
Everywhere: Use my very shiny serenityos.org email :^)
2022-09-12 11:06:24 -03:00
* Copyright (c) 2021, networkException <networkexception@serenityos.org>
LibCore: Migrate ConfigFile to Core::Stream API :^) As part of this, moved the call to `reparse()` out of the constructor and into the factory methods, to allow the error to propagate.
2022-02-06 12:27:17 -03:00
* Copyright (c) 2022, Sam Atkins <atkinssj@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 05:38:21 -03: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 05:24:48 -03: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 05:38:21 -03:00
*/
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
#pragma once
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 15:02:33 -03:00
#include <AK/DeprecatedString.h>
LibCore: Automatically create config directories if necessary If the .config directory (or its children, like lib) was deleted, ConfigFile would crash because it would try to open or create a file in a directory that didn't exist. Therefore, for user and library configs (but not system configs), ensure that the parent directories exist. This allows the user to delete the entire .config folder and all apps still work. (Except those which can't handle missing config. That's a separate issue though.) Fixes #13555 Note: Some changes to pledges and unveils are necessary for this to work. The only one who can recreate .config at the moment is ConfigServer, as others probably don't pledge the user home directory.
2022-04-09 07:35:21 -03:00
#include <AK/Forward.h>
Add clang-format file Also run it across the whole tree to get everything using the One True Style. We don't yet run this in an automated fashion as it's a little slow, but there is a snippet to do so in makeall.sh.
2019-05-28 06:53:16 -03:00
#include <AK/HashMap.h>
LibCore: Remove `Stream.h`
2023-02-08 23:11:50 -03:00
#include <AK/OwnPtr.h>
AK: Rename Retainable.h => RefCounted.h.
2019-06-21 13:58:45 -03:00
#include <AK/RefCounted.h>
LibCore: Put all classes in the Core namespace and remove the leading C I've been wanting to do this for a long time. It's time we start being consistent about how this stuff works. The new convention is: - "LibFoo" is a userspace library that provides the "Foo" namespace. That's it :^) This was pretty tedious to convert and I didn't even start on LibGUI yet. But it's coming up next.
2020-02-02 08:34:39 -03:00
#include <AK/RefPtr.h>
Add clang-format file Also run it across the whole tree to get everything using the One True Style. We don't yet run this in an automated fashion as it's a little slow, but there is a snippet to do so in makeall.sh.
2019-05-28 06:53:16 -03:00
#include <AK/Vector.h>
LibCore: Move Stream-based file into the `Core` namespace
2023-02-08 23:02:46 -03:00
#include <LibCore/File.h>
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
LibCore: Put all classes in the Core namespace and remove the leading C I've been wanting to do this for a long time. It's time we start being consistent about how this stuff works. The new convention is: - "LibFoo" is a userspace library that provides the "Foo" namespace. That's it :^) This was pretty tedious to convert and I didn't even start on LibGUI yet. But it's coming up next.
2020-02-02 08:34:39 -03:00
namespace Core {
class ConfigFile : public RefCounted<ConfigFile> {
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
public:
LibCore: Support using a file descriptor for opening ConfigFile This patch adds support for opening a ConfigFile using a file descriptor rather than trying to open a the file by name directly. In contrast to the previous implementation, ConfigFile now always keeps a reference to an open File and does not reopen it for writing. This requires providing an additional argument to open functions if a file gets opened based on its name and the user of the api intends to write to the file in the future.
2021-08-18 20:23:31 -03:00
enum class AllowWriting {
Yes,
No,
};
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 15:02:33 -03:00
static ErrorOr<NonnullRefPtr<ConfigFile>> open_for_lib(DeprecatedString const& lib_name, AllowWriting = AllowWriting::No);
static ErrorOr<NonnullRefPtr<ConfigFile>> open_for_app(DeprecatedString const& app_name, AllowWriting = AllowWriting::No);
static ErrorOr<NonnullRefPtr<ConfigFile>> open_for_system(DeprecatedString const& app_name, AllowWriting = AllowWriting::No);
static ErrorOr<NonnullRefPtr<ConfigFile>> open(DeprecatedString const& filename, AllowWriting = AllowWriting::No);
static ErrorOr<NonnullRefPtr<ConfigFile>> open(DeprecatedString const& filename, int fd);
LibCore: Move Stream-based file into the `Core` namespace
2023-02-08 23:02:46 -03:00
static ErrorOr<NonnullRefPtr<ConfigFile>> open(DeprecatedString const& filename, NonnullOwnPtr<Core::File>);
LibCore: Put all classes in the Core namespace and remove the leading C I've been wanting to do this for a long time. It's time we start being consistent about how this stuff works. The new convention is: - "LibFoo" is a userspace library that provides the "Foo" namespace. That's it :^) This was pretty tedious to convert and I didn't even start on LibGUI yet. But it's coming up next.
2020-02-02 08:34:39 -03:00
~ConfigFile();
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
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 15:02:33 -03:00
bool has_group(DeprecatedString const&) const;
bool has_key(DeprecatedString const& group, DeprecatedString const& key) const;
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
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 15:02:33 -03:00
Vector<DeprecatedString> groups() const;
Vector<DeprecatedString> keys(DeprecatedString const& group) const;
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
LibCore: Add getter for how many groups exist in a Core::ConfigFile This can be used by an application to find out if any config sections were loaded from the file after a reparse.
2021-06-27 23:04:11 -03:00
size_t num_groups() const { return m_groups.size(); }
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 15:02:33 -03:00
DeprecatedString read_entry(DeprecatedString const& group, DeprecatedString const& key, DeprecatedString const& default_value = DeprecatedString()) const;
bool read_bool_entry(DeprecatedString const& group, DeprecatedString const& key, bool default_value = false) const;
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
LibConfig+LibCore+ConfigServer: Support u32 configuration entries
2022-12-20 09:12:21 -03:00
template<Integral T = int>
T read_num_entry(DeprecatedString const& group, DeprecatedString const& key, T default_value = 0) const
{
if (!has_key(group, key))
return default_value;
if constexpr (IsSigned<T>)
return read_entry(group, key).to_int<T>().value_or(default_value);
else
return read_entry(group, key).to_uint<T>().value_or(default_value);
}
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 15:02:33 -03:00
void write_entry(DeprecatedString const& group, DeprecatedString const& key, DeprecatedString const& value);
void write_bool_entry(DeprecatedString const& group, DeprecatedString const& key, bool value);
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
LibConfig+LibCore+ConfigServer: Support u32 configuration entries
2022-12-20 09:12:21 -03:00
template<Integral T = int>
void write_num_entry(DeprecatedString const& group, DeprecatedString const& key, T value)
{
write_entry(group, key, DeprecatedString::number(value));
}
Add clang-format file Also run it across the whole tree to get everything using the One True Style. We don't yet run this in an automated fashion as it's a little slow, but there is a snippet to do so in makeall.sh.
2019-05-28 06:53:16 -03:00
void dump() const;
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
bool is_dirty() const { return m_dirty; }
LibCore+Everywhere: Return ErrorOr from ConfigFile::sync() Currently this method always succeeds, but that won't be true once we switch to the Core::Stream API. :^) Some of these places would ideally show an error message to the user, since failure to save a file is significant, but let's not get distracted right now.
2022-02-06 11:26:33 -03:00
ErrorOr<void> sync();
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
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 15:02:33 -03:00
void add_group(DeprecatedString const& group);
void remove_group(DeprecatedString const& group);
void remove_entry(DeprecatedString const& group, DeprecatedString const& key);
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
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 15:02:33 -03:00
DeprecatedString const& filename() const { return m_filename; }
Network stack is now configurable, and resolution is also configurable, but loading cursors causes a page-fault?
2019-05-25 01:10:23 -03:00
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
private:
AK: Add the `Input` word to input-only buffered streams This concerns both `BufferedSeekable` and `BufferedFile`.
2023-05-03 19:45:18 -03:00
ConfigFile(DeprecatedString const& filename, OwnPtr<InputBufferedFile> open_file);
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
LibCore: Migrate ConfigFile to Core::Stream API :^) As part of this, moved the call to `reparse()` out of the constructor and into the factory methods, to allow the error to propagate.
2022-02-06 12:27:17 -03:00
ErrorOr<void> reparse();
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
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 15:02:33 -03:00
DeprecatedString m_filename;
AK: Add the `Input` word to input-only buffered streams This concerns both `BufferedSeekable` and `BufferedFile`.
2023-05-03 19:45:18 -03:00
OwnPtr<InputBufferedFile> m_file;
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 15:02:33 -03:00
HashMap<DeprecatedString, HashMap<DeprecatedString, DeprecatedString>> m_groups;
LibCore: Add a CConfigFile class, a simple INI file parser. You open the configuration for an app like so: auto config = CConfigFile::get_for_app("MyApp"); This will then open ~/MyApp.ini and parse it for you. Immediately start using it in Minesweeper to load the field size and mine count from a config file.
2019-04-14 21:22:08 -03:00
bool m_dirty { false };
};
LibCore: Put all classes in the Core namespace and remove the leading C I've been wanting to do this for a long time. It's time we start being consistent about how this stuff works. The new convention is: - "LibFoo" is a userspace library that provides the "Foo" namespace. That's it :^) This was pretty tedious to convert and I didn't even start on LibGUI yet. But it's coming up next.
2020-02-02 08:34:39 -03:00
}
Reference in a new issue Copy permalink