Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-10-31 05:10:57 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Userland/Libraries/LibCore/ConfigFile.h

74 lines
2.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 09:38:21 +01:00
/*
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
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-19 01:23:31 +02:00
* Copyright (c) 2021, Jakob-Niklas See <git@nwex.de>
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 09:38:21 +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
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 09:38:21 +01: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-15 02:22:08 +02:00
#pragma once
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 11:53:16 +02:00
#include <AK/HashMap.h>
AK: Rename Retainable.h => RefCounted.h.
2019-06-21 18:58:45 +02: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 12:34:39 +01:00
#include <AK/RefPtr.h>
#include <AK/String.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 11:53:16 +02:00
#include <AK/Vector.h>
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-19 01:23:31 +02:00
#include <LibCore/File.h>
LibGfx: Rename from LibDraw :^)
2020-02-06 12:04:00 +01:00
#include <LibGfx/Color.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-15 02:22:08 +02: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 12:34:39 +01: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-15 02:22:08 +02: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-19 01:23:31 +02:00
enum class AllowWriting {
Yes,
No,
};
Everywhere: Rename get in ConfigFile::get_for_{lib,app,system} to open This patch brings the ConfigFile helpers for opening lib, app and system configs more inline with the regular ConfigFile::open functions.
2021-08-21 16:33:54 +02:00
static NonnullRefPtr<ConfigFile> open_for_lib(String const& lib_name, AllowWriting = AllowWriting::No);
static NonnullRefPtr<ConfigFile> open_for_app(String const& app_name, AllowWriting = AllowWriting::No);
static NonnullRefPtr<ConfigFile> open_for_system(String const& app_name, AllowWriting = AllowWriting::No);
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-19 01:23:31 +02:00
static NonnullRefPtr<ConfigFile> open(String const& filename, AllowWriting = AllowWriting::No);
static NonnullRefPtr<ConfigFile> open(String const& filename, int fd);
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 12:34:39 +01: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-15 02:22:08 +02:00
LibCore: Convert ConfigFile to east const
2021-08-19 22:28:45 +02:00
bool has_group(String const&) const;
bool has_key(String const& group, String 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-15 02:22:08 +02:00
Vector<String> groups() const;
LibCore: Convert ConfigFile to east const
2021-08-19 22:28:45 +02:00
Vector<String> keys(String 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-15 02:22:08 +02: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 20:04:11 -06:00
size_t num_groups() const { return m_groups.size(); }
LibCore: Convert ConfigFile to east const
2021-08-19 22:28:45 +02:00
String read_entry(String const& group, String const& key, String const& default_value = String()) const;
int read_num_entry(String const& group, String const& key, int default_value = 0) const;
bool read_bool_entry(String const& group, String 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-15 02:22:08 +02:00
LibCore: Convert ConfigFile to east const
2021-08-19 22:28:45 +02:00
void write_entry(String const& group, String const& key, String const& value);
void write_num_entry(String const& group, String const& key, int value);
void write_bool_entry(String const& group, String const& key, bool value);
void write_color_entry(String const& group, String const& key, Color 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-15 02:22:08 +02:00
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 11:53:16 +02: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-15 02:22:08 +02:00
bool is_dirty() const { return m_dirty; }
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 11:53:16 +02:00
bool 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-15 02:22:08 +02:00
LibCore: Convert ConfigFile to east const
2021-08-19 22:28:45 +02:00
void remove_group(String const& group);
void remove_entry(String const& group, String 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-15 02:22:08 +02:00
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-19 01:23:31 +02:00
String filename() const { return m_file->filename(); }
Network stack is now configurable, and resolution is also configurable, but loading cursors causes a page-fault?
2019-05-24 21:10:23 -07: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-15 02:22:08 +02:00
private:
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-19 01:23:31 +02:00
explicit ConfigFile(String const& filename, AllowWriting);
explicit ConfigFile(String const& filename, int fd);
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-15 02:22:08 +02:00
void reparse();
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-19 01:23:31 +02:00
NonnullRefPtr<File> m_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-15 02:22:08 +02:00
HashMap<String, HashMap<String, String>> m_groups;
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 12:34:39 +01:00
}
Reference in a new issue Copy permalink