mirror
/
transmission
mirror of https://github.com/transmission/transmission
1
0
Fork 0
Code Issues Releases Wiki Activity
transmission/libtransmission/variant-common.h

53 lines
1.6 KiB
C
Raw Normal View History

refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
/*
Licensing changes: 1. add the option the code to be used under GPLv2 or GPLv3; previously only GPLv2 was allowed 2. add the "proxy option" as described in GPLv3 so we can add future licenses without having to bulk-edit everything again :) 3. remove the awkward "exception for MIT code in Mac client" clause; it was unnecessary and confusing.
2014-01-19 01:09:44 +00:00
* This file Copyright (C) 2008-2014 Mnemosyne LLC
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
*
Copyedit the license's revised text: (1) remove unnecessary repitition use of the word 'license' from the top of the header and source files (2) add the standard 'we hope it's useful, but no warranty' clause to COPYING (3) make explicit that linking OpenSSL is allowed (see https://people.gnome.org/~markmc/openssl-and-the-gpl.html for background) (4) sync the Qt and GTK+ clients' license popups with COPYING's revised text
2014-01-21 03:10:30 +00:00
* It may be used under the GNU GPL versions 2 or 3
Licensing changes: 1. add the option the code to be used under GPLv2 or GPLv3; previously only GPLv2 was allowed 2. add the "proxy option" as described in GPLv3 so we can add future licenses without having to bulk-edit everything again :) 3. remove the awkward "exception for MIT code in Mac client" clause; it was unnecessary and confusing.
2014-01-19 01:09:44 +00:00
* or any future license endorsed by Mnemosyne LLC.
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
*
*/
Ensure include guard is the first non-comment line
2017-11-14 20:21:28 +00:00
#pragma once
refactor: use GTest for running tests (#1383) * refactor: use google-test on libtransmission tests
2020-08-11 18:11:55 +00:00
#ifndef LIBTRANSMISSION_VARIANT_MODULE
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/variant-*.c should #include this header.
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
#endif
refactor: use GTest for running tests (#1383) * refactor: use google-test on libtransmission tests
2020-08-11 18:11:55 +00:00
#include "tr-macros.h"
TR_BEGIN_DECLS
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
typedef void (* VariantWalkFunc)(tr_variant const* val, void* user_data);
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
struct VariantWalkFuncs
{
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
VariantWalkFunc intFunc;
VariantWalkFunc boolFunc;
VariantWalkFunc realFunc;
VariantWalkFunc stringFunc;
VariantWalkFunc dictBeginFunc;
VariantWalkFunc listBeginFunc;
VariantWalkFunc containerEndFunc;
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
};
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
void tr_variantWalk(tr_variant const* top, struct VariantWalkFuncs const* walkFuncs, void* user_data, bool sort_dicts);
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
void tr_variantToBufJson(tr_variant const* top, struct evbuffer* buf, bool lean);
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
void tr_variantToBufBenc(tr_variant const* top, struct evbuffer* buf);
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
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
void tr_variantInit(tr_variant* v, char type);
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
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
/* source - such as a filename. Only when logging an error */
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
int tr_jsonParse(char const* source, void const* vbuf, size_t len, tr_variant* setme_benc, char const** setme_end);
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
/** @brief Private function that's exposed here only for unit tests */
refactor: use GTest for running tests (#1383) * refactor: use google-test on libtransmission tests
2020-08-11 18:11:55 +00:00
int tr_bencParseInt(void const* buf, void const* bufend, uint8_t const** setme_end, int64_t* setme_val);
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
/** @brief Private function that's exposed here only for unit tests */
refactor: use GTest for running tests (#1383) * refactor: use google-test on libtransmission tests
2020-08-11 18:11:55 +00:00
int tr_bencParseStr(void const* buf, void const* bufend, uint8_t const** setme_end, uint8_t const** setme_str,
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
size_t* setme_strlen);
refactor libtransmission's tr_benc class as tr_variant.
2012-12-14 04:34:42 +00:00
Align type qualifiers to the right (code style) This way all the qualifiers (`const`, `volatile`, `mutable`) are grouped together, e.g. `T const* const x` vs. `const T* const x`. Also helps reading types right-to-left, e.g. "constant pointer to constant T" vs. "constant pointer to T which is constant".
2017-04-20 16:02:19 +00:00
int tr_variantParseBenc(void const* buf, void const* end, tr_variant* top, char const** setme_end);
refactor: use GTest for running tests (#1383) * refactor: use google-test on libtransmission tests
2020-08-11 18:11:55 +00:00
TR_END_DECLS