ConfigFile.h 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. * Copyright (c) 2021, networkException <networkexception@serenityos.org>
  4. * Copyright (c) 2022, Sam Atkins <atkinssj@serenityos.org>
  5. *
  6. * SPDX-License-Identifier: BSD-2-Clause
  7. */
  8. #pragma once
  9. #include <AK/DeprecatedString.h>
  10. #include <AK/Forward.h>
  11. #include <AK/HashMap.h>
  12. #include <AK/RefCounted.h>
  13. #include <AK/RefPtr.h>
  14. #include <AK/Vector.h>
  15. #include <LibCore/Stream.h>
  16. namespace Core {
  17. class ConfigFile : public RefCounted<ConfigFile> {
  18. public:
  19. enum class AllowWriting {
  20. Yes,
  21. No,
  22. };
  23. static ErrorOr<NonnullRefPtr<ConfigFile>> open_for_lib(DeprecatedString const& lib_name, AllowWriting = AllowWriting::No);
  24. static ErrorOr<NonnullRefPtr<ConfigFile>> open_for_app(DeprecatedString const& app_name, AllowWriting = AllowWriting::No);
  25. static ErrorOr<NonnullRefPtr<ConfigFile>> open_for_system(DeprecatedString const& app_name, AllowWriting = AllowWriting::No);
  26. static ErrorOr<NonnullRefPtr<ConfigFile>> open(DeprecatedString const& filename, AllowWriting = AllowWriting::No);
  27. static ErrorOr<NonnullRefPtr<ConfigFile>> open(DeprecatedString const& filename, int fd);
  28. static ErrorOr<NonnullRefPtr<ConfigFile>> open(DeprecatedString const& filename, NonnullOwnPtr<Core::Stream::File>);
  29. ~ConfigFile();
  30. bool has_group(DeprecatedString const&) const;
  31. bool has_key(DeprecatedString const& group, DeprecatedString const& key) const;
  32. Vector<DeprecatedString> groups() const;
  33. Vector<DeprecatedString> keys(DeprecatedString const& group) const;
  34. size_t num_groups() const { return m_groups.size(); }
  35. DeprecatedString read_entry(DeprecatedString const& group, DeprecatedString const& key, DeprecatedString const& default_value = DeprecatedString()) const;
  36. bool read_bool_entry(DeprecatedString const& group, DeprecatedString const& key, bool default_value = false) const;
  37. template<Integral T = int>
  38. T read_num_entry(DeprecatedString const& group, DeprecatedString const& key, T default_value = 0) const
  39. {
  40. if (!has_key(group, key))
  41. return default_value;
  42. if constexpr (IsSigned<T>)
  43. return read_entry(group, key).to_int<T>().value_or(default_value);
  44. else
  45. return read_entry(group, key).to_uint<T>().value_or(default_value);
  46. }
  47. void write_entry(DeprecatedString const& group, DeprecatedString const& key, DeprecatedString const& value);
  48. void write_bool_entry(DeprecatedString const& group, DeprecatedString const& key, bool value);
  49. template<Integral T = int>
  50. void write_num_entry(DeprecatedString const& group, DeprecatedString const& key, T value)
  51. {
  52. write_entry(group, key, DeprecatedString::number(value));
  53. }
  54. void dump() const;
  55. bool is_dirty() const { return m_dirty; }
  56. ErrorOr<void> sync();
  57. void add_group(DeprecatedString const& group);
  58. void remove_group(DeprecatedString const& group);
  59. void remove_entry(DeprecatedString const& group, DeprecatedString const& key);
  60. DeprecatedString const& filename() const { return m_filename; }
  61. private:
  62. ConfigFile(DeprecatedString const& filename, OwnPtr<Stream::BufferedFile> open_file);
  63. ErrorOr<void> reparse();
  64. DeprecatedString m_filename;
  65. OwnPtr<Stream::BufferedFile> m_file;
  66. HashMap<DeprecatedString, HashMap<DeprecatedString, DeprecatedString>> m_groups;
  67. bool m_dirty { false };
  68. };
  69. }