transmission/libtransmission/magnet.h

/*
 * This file Copyright (C) 2010-2014 Mnemosyne LLC
 *
 * It may be used under the GNU GPL versions 2 or 3
 * or any future license endorsed by Mnemosyne LLC.
 *
 */

#pragma once

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

#include "tr-macros.h"
#include "transmission.h"
#include "variant.h"

TR_BEGIN_DECLS

typedef struct tr_magnet_info
{
    uint8_t hash[20];

    char* displayName;

    int trackerCount;
    char** trackers;

    int webseedCount;
    char** webseeds;
} tr_magnet_info;

tr_magnet_info* tr_magnetParse(char const* uri);

struct tr_variant;

void tr_magnetCreateMetainfo(tr_magnet_info const*, tr_variant*);

void tr_magnetFree(tr_magnet_info* info);

TR_END_DECLS
(trunk libT) #2096: add code magnet URL parser and unit tests 2009-11-20 04:38:19 +00:00			`/*`
(trunk) restore copyright year as suggested in email by rms 2014-01-18 20:56:57 +00:00			`* This file Copyright (C) 2010-2014 Mnemosyne LLC`
(trunk libT) #2096: add code magnet URL parser and unit tests 2009-11-20 04:38:19 +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.`
(trunk libT) #2096: add code magnet URL parser and unit tests 2009-11-20 04:38:19 +00:00			`*`
			`*/`

Ensure include guard is the first non-comment line 2017-11-14 20:21:28 +00:00			`#pragma once`

(trunk) housekeeping: (1) add standard svn properties for $Id$ substitution in some files (2) add #include guards in a couple of libtransmission headers (3) refresh build instructions in README 2010-01-14 14:20:49 +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) housekeeping: (1) add standard svn properties for $Id$ substitution in some files (2) add #include guards in a couple of libtransmission headers (3) refresh build instructions in README 2010-01-14 14:20:49 +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"`
(trunk libT) #2096: add code magnet URL parser and unit tests 2009-11-20 04:38:19 +00:00			`#include "transmission.h"`
refactor libtransmission's tr_benc class as tr_variant. 2012-12-14 04:34:42 +00:00			`#include "variant.h"`
(trunk libT) #2096: add code magnet URL parser and unit tests 2009-11-20 04:38:19 +00:00
refactor: use GTest for running tests (#1383) * refactor: use google-test on libtransmission tests 2020-08-11 18:11:55 +00:00			`TR_BEGIN_DECLS`

(trunk libT) a very minor commit. remove trailing spaces from lines and other stuff like that 2009-11-22 03:57:36 +00:00			`typedef struct tr_magnet_info`
(trunk libT) #2096: add code magnet URL parser and unit tests 2009-11-20 04:38:19 +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			`uint8_t hash[20];`
(trunk libT) #2631 "Add webseed support to magnet links" 2009-11-29 17:49:58 +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			`char* displayName;`
(trunk libT) #2631 "Add webseed support to magnet links" 2009-11-29 17:49:58 +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			`int trackerCount;`
			`char** trackers;`
(trunk libT) #2631 "Add webseed support to magnet links" 2009-11-29 17:49:58 +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			`int webseedCount;`
			`char** webseeds;`
Switch to clang-format for code formatting, include Mac client 2021-08-15 09:41:48 +00:00			`} tr_magnet_info;`
(trunk libT) #2096: add code magnet URL parser and unit tests 2009-11-20 04:38:19 +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			`tr_magnet_info* tr_magnetParse(char const* uri);`
(trunk libT) #2096: add code magnet URL parser and unit tests 2009-11-20 04:38:19 +00:00
refactor libtransmission's tr_benc class as tr_variant. 2012-12-14 04:34:42 +00:00			`struct tr_variant;`
(trunk) #2802, #2716, #2717 -- remember magnet links and their settings between sessions, and allow their trackers to be modified 2010-02-02 22:45:22 +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_magnetCreateMetainfo(tr_magnet_info const, tr_variant);`
(trunk libT) #2096: add code magnet URL parser and unit tests 2009-11-20 04:38:19 +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_magnetFree(tr_magnet_info* info);`
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`