1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
#pragma once
// system
#include <memory>
#include <iostream>
#include <string>
#include <vector>
// local
#include <XdgUtils/DesktopEntry/Exceptions.h>
#include <XdgUtils/DesktopEntry/DesktopEntryKeyPath.h>
#include <XdgUtils/DesktopEntry/DesktopEntryKeyValue.h>
namespace XdgUtils {
namespace DesktopEntry {
/**
* Represents a Desktop Entry according to https://standards.freedesktop.org/desktop-entry-spec/
*
* Entry contents are reference through its path.
* A path is made by: <Group Name>/<Key Name>[<locale>]. Locale section is optional.
*/
class DesktopEntry {
public:
DesktopEntry();
explicit DesktopEntry(const std::string& data);
explicit DesktopEntry(std::istream& data);
DesktopEntry(const DesktopEntry& other);
DesktopEntry& operator=(const DesktopEntry& other);
DesktopEntry(DesktopEntry&& other) noexcept;
DesktopEntry& operator=(DesktopEntry&& other) noexcept;
virtual ~DesktopEntry();
/**
* Set <value> to the entry reference by <path>.
* If the Group or Key doesn't exist they will be created.
* @param path
* @param value
*/
void set(const std::string& path, const std::string& value);
/**
* Get the value of the entry pointed by <path>.
* @param path
* @param fallback
* @return entry value or <fallback> if the entry doesn't exist
*/
std::string get(const std::string& path, const std::string& fallback = "") const;
/**
* @param path
* @return true if there is an entry at <path>, false otherwise
*/
bool exists(const std::string& path) const;
/**
* Remove entry or group referenced by <path>
* @param path
*/
void remove(const std::string& path);
/**
* @return Paths to all available entries and groups
*/
std::vector<std::string> paths() const;
/**
* Attempts to read the <is> stream as a Desktop Entry. Any existent data will be replaced.
* @param input
* @throw ReadError if something goes wrong
*/
friend std::istream& operator>>(std::istream& is, const DesktopEntry& entry);
/**
* Attempts to write this Desktop Entry to the <os> stream.
* @param output
*/
friend std::ostream& operator<<(std::ostream& os, const DesktopEntry& entry);
/**
* Access the key pointed by <keyPath> if it doesn't exist a new one will be created.
* @param keyPath
* @return
*/
DesktopEntryKeyValue operator[](const DesktopEntryKeyPath& keyPath);
/**
* Access the key pointed by <keyPath> if it doesn't exist a new one will be created.
* @param keyPath
* @return
*/
DesktopEntryKeyValue operator[](const std::string& keyPath);
bool operator==(const DesktopEntry& rhs) const;
bool operator!=(const DesktopEntry& rhs) const;
private:
struct Priv;
std::unique_ptr<Priv> priv;
};
}
}
|
