transmission/libtransmission/platform.h

// This file Copyright © Mnemosyne LLC.
// It may be used under GPLv2 (SPDX: GPL-2.0-only), GPLv3 (SPDX: GPL-3.0-only),
// or any future license endorsed by Mnemosyne LLC.
// License text can be found in the licenses/ folder.

#pragma once

#ifndef __TRANSMISSION__
#error only libtransmission should #include this header.
#endif

#include <string>

struct tr_session;

/** @brief return the directory where the Web Client's web ui files are kept */
[[nodiscard]] std::string tr_getWebClientDir(tr_session const*);

/** @brief return the directory where session id lock files are stored */
[[nodiscard]] std::string tr_getSessionIdDir();
chore: removed copyright timespans in headers (#4850) 2023-11-01 21:11:11 +00:00			`// This file Copyright © Mnemosyne LLC.`
chore: fix spdx abbreviations (#3602) 2022-08-08 18:05:39 +00:00			`// It may be used under GPLv2 (SPDX: GPL-2.0-only), GPLv3 (SPDX: GPL-3.0-only),`
chore: update copyright years, make notices consistent (#2463) 2022-01-20 18:27:56 +00:00			`// or any future license endorsed by Mnemosyne LLC.`
			`// License text can be found in the licenses/ folder.`
(trunk libT) update the copyrights on some files that no longer have old code in them 2009-01-07 06:53:29 +00:00
Ensure include guard is the first non-comment line 2017-11-14 20:21:28 +00:00			`#pragma once`

(trunk) add #include guards to prevent non-libtransmission files from #including implementation headers 2009-12-15 00:51:39 +00:00			`#ifndef __TRANSMISSION__`
Adjust uncrustify config, reformat all but Mac client There're places where manual intervention is still required as uncrustify is not ideal (unfortunately), but at least one may rely on it to do the right thing most of the time (e.g. when sending in a patch). The style itself is quite different from what we had before but making it uniform across all the codebase is the key. I also hope that it'll make the code more readable (YMMV) and less sensitive to further changes. 2017-04-19 12:04:45 +00:00			`#error only libtransmission should #include this header.`
(trunk) add #include guards to prevent non-libtransmission files from #including implementation headers 2009-12-15 00:51:39 +00:00			`#endif`

feat: add tr_strvPath() (#2134) * feat: add tr_strvJoin * feat: add tr_strvPath 2021-11-13 00:10:04 +00:00			`#include <string>`
make TR_PATH_DELIMITER and TR_PATH_DELIMITER_STR private to libtransmission 2008-02-09 17:48:53 +00:00
refactor: replace tr_thread with std::thread (#2548) 2022-01-31 19:34:04 +00:00			`struct tr_session;`

(trunk libT) #2911 "requirement of javascript/transmission.js for webinterface unnecessary" -- implemented in trunk for 2.00 2010-03-19 18:48:37 +00:00			`/** @brief return the directory where the Web Client's web ui files are kept */`
refactor: add more nodiscard, constexpr, and noexcept (#4089) 2022-11-03 23:08:02 +00:00			`[[nodiscard]] std::string tr_getWebClientDir(tr_session const*);`
#684: Use XDG basedir spec for configuration and cache files in $HOME 2008-04-05 20:12:11 +00:00
Maintain lock file(s) corresponding to session ID 2016-09-21 20:56:03 +00:00			`/** @brief return the directory where session id lock files are stored */`
refactor: add more nodiscard, constexpr, and noexcept (#4089) 2022-11-03 23:08:02 +00:00			`[[nodiscard]] std::string tr_getSessionIdDir();`