annotate common/xdg.cpp @ 28:9a907e58f978

Plugin ask: fix errors in documentation
author David Demelier <markand@malikania.fr>
date Mon, 22 Feb 2016 13:00:56 +0100
parents 1158cffe5a5e
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * Xdg.cpp -- XDG directory specifications
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 * Copyright (c) 2013, 2014, 2015 David Demelier <markand@malikania.fr>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #include <cstdlib>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #include <stdexcept>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 #include <sstream>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 #include "xdg.h"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 namespace irccd {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 namespace {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 bool isabsolute(const std::string &path)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 return path.length() > 0 && path[0] == '/';
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 std::vector<std::string> split(const std::string &arg)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 std::stringstream iss(arg);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 std::string item;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 std::vector<std::string> elems;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 while (std::getline(iss, item, ':'))
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 if (isabsolute(item))
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 elems.push_back(item);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 return elems;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 std::string envOrHome(const std::string &var, const std::string &repl)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 auto value = getenv(var.c_str());
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 if (value == nullptr || !isabsolute(value)) {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 auto home = getenv("HOME");
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 if (home == nullptr)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 throw std::runtime_error("could not get home directory");
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
56
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 return std::string(home) + "/" + repl;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
59
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 return value;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
62
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 std::vector<std::string> listOrDefaults(const std::string &var, const std::vector<std::string> &list)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 auto value = getenv(var.c_str());
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
66
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 if (!value)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 return list;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
69
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 // No valid item at all? Use defaults
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 auto result = split(value);
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
72
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
73 return (result.size() == 0) ? list : result;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
74 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
75
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
76 } // !namespace
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
77
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
78 Xdg::Xdg()
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
79 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
80 m_configHome = envOrHome("XDG_CONFIG_HOME", ".config");
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
81 m_dataHome = envOrHome("XDG_DATA_HOME", ".local/share");
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
82 m_cacheHome = envOrHome("XDG_CACHE_HOME", ".cache");
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
83
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
84 m_configDirs = listOrDefaults("XDG_CONFIG_DIRS", { "/etc/xdg" });
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
85 m_dataDirs = listOrDefaults("XDG_DATA_DIRS", { "/usr/local/share", "/usr/share" });
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
86
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
87 /*
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
88 * Runtime directory is a special case and does not have a replacement, the
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
89 * application should manage this by itself.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
90 */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
91 auto runtime = getenv("XDG_RUNTIME_DIR");
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
92 if (runtime && isabsolute(runtime))
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
93 m_runtimeDir = runtime;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
94 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
95
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 const std::string &Xdg::configHome() const noexcept
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 return m_configHome;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
100
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
101 const std::string &Xdg::dataHome() const noexcept
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
102 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
103 return m_dataHome;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
104 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
105
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
106 const std::string &Xdg::cacheHome() const noexcept
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
107 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
108 return m_cacheHome;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
109 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
110
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
111 const std::string &Xdg::runtimeDir() const
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
112 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
113 if (m_runtimeDir.size() == 0)
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
114 throw std::runtime_error("XDG_RUNTIME_DIR is not set");
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
115
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
116 return m_runtimeDir;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
117 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
118
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
119 const Xdg::List &Xdg::configDirs() const noexcept
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
120 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
121 return m_configDirs;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
122 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
123
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
124 const Xdg::List &Xdg::dataDirs() const noexcept
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
125 {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
126 return m_dataDirs;
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
127 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
128
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
129 } // !irccd