source: trunk/gtk/tr-core.h @ 8846

Last change on this file since 8846 was 8846, checked in by charles, 13 years ago

remove some unused utilities. better commenting on the utils that remain.

  • Property svn:keywords set to Date Rev Author Id
File size: 6.4 KB
Line 
1/******************************************************************************
2 * $Id: tr-core.h 8846 2009-07-22 15:55:48Z charles $
3 *
4 * Copyright (c) 2007-2008 Transmission authors and contributors
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *****************************************************************************/
24
25#ifndef TR_CORE_H
26#define TR_CORE_H
27
28#include <string.h>
29
30#include <glib-object.h>
31#include <gtk/gtk.h>
32
33#include <libtransmission/transmission.h>
34#include "conf.h" /* pref_flag_t */
35#include "tr-torrent.h"
36
37#define TR_CORE_TYPE ( tr_core_get_type( ) )
38#define TR_CORE( o ) G_TYPE_CHECK_INSTANCE_CAST( ( o ), TR_CORE_TYPE,\
39                                                TrCore )
40#define TR_IS_CORE( o ) G_TYPE_CHECK_INSTANCE_TYPE( ( o ), TR_CORE_TYPE )
41#define TR_CORE_CLASS( k ) G_TYPE_CHECK_CLASS_CAST( ( k ), TR_CORE_TYPE,\
42                                                   TrCoreClass )
43#define TR_IS_CORE_CLASS( k ) G_TYPE_CHECK_CLASS_TYPE( ( k ), TR_CORE_TYPE )
44#define TR_CORE_GET_CLASS( o ) G_TYPE_INSTANCE_GET_CLASS( ( o ),\
45                                                         TR_CORE_TYPE, \
46                                                         TrCoreClass )
47
48typedef struct TrCore
49{
50    GObject    parent;
51    struct TrCorePrivate  * priv;
52}
53TrCore;
54
55typedef struct TrCoreClass
56{
57    GObjectClass    parent;
58
59    /* "blocklist-updated" signal with a callback type of
60        void (*callback )( TrCore*, int ruleCount, gpointer userData ). */
61    int blocklistSignal;
62
63    /* "port-tested" signal with a callback type of
64       void( *callback )( TrCore*, gboolean isOpen, gpointer userData ). */
65    int portSignal;
66
67    /* "error" signal with a callback type of
68       void( *callback )( TrCore*, enum tr_core_err, const char * humanReadable, gpointer userData ). */
69    int errsig;
70
71    /* "add-torrent-prompt" signal with a callback type of
72       void ( *callback)( TrCore *, gpointer ctor, gpointer userData )
73       The handler assumes ownership of ctor and must free when done */
74    int promptsig;
75
76    /* "quit" signal:
77       void handler( TrCore *, gpointer ) */
78    int quitsig;
79
80    /* "prefs-changed" signal:
81       void handler( TrCore *, int, gpointer ) */
82    int prefsig;
83}
84TrCoreClass;
85
86enum tr_core_err
87{
88    TR_CORE_ERR_ADD_TORRENT_ERR  = TR_EINVALID,
89    TR_CORE_ERR_ADD_TORRENT_DUP  = TR_EDUPLICATE,
90    TR_CORE_ERR_NO_MORE_TORRENTS  /* finished adding a batch */
91};
92
93GType          tr_core_get_type( void );
94
95TrCore *       tr_core_new( tr_session * );
96
97void           tr_core_close( TrCore* );
98
99/* Return the model used without incrementing the reference count */
100GtkTreeModel * tr_core_model( TrCore * self );
101
102tr_session *   tr_core_session( TrCore * self );
103
104/******
105*******
106******/
107
108/**
109 * Load saved state and return number of torrents added.
110 * May trigger one or more "error" signals with TR_CORE_ERR_ADD_TORRENT
111 */
112int      tr_core_load( TrCore * self,
113                       gboolean forcepaused );
114
115/**
116 * Add a list of torrents.
117 * This function assumes ownership of torrentFiles
118 *
119 * May pop up dialogs for each torrent if that preference is enabled.
120 * May trigger one or more "error" signals with TR_CORE_ERR_ADD_TORRENT
121 */
122void     tr_core_add_list( TrCore *    self,
123                           GSList *    torrentFiles,
124                           pref_flag_t start,
125                           pref_flag_t prompt,
126                           gboolean    doNotify );
127
128#define tr_core_add_list_defaults( c, l, doNotify ) \
129    tr_core_add_list( c, l, PREF_FLAG_DEFAULT, PREF_FLAG_DEFAULT, doNotify )
130
131
132/** @brief Add a torrent. */
133gboolean tr_core_add_metainfo( TrCore      * core,
134                               const char  * base64_metainfo,
135                               gboolean    * setme_success,
136                               GError     ** err );
137
138/** Add a torrent. */
139void tr_core_add_torrent( TrCore*, TrTorrent*, gboolean doNotify );
140
141/** Present the main window */
142gboolean tr_core_present_window( TrCore*, gboolean * setme_success, GError ** err ); 
143
144
145/**
146 * Notifies listeners that torrents have been added.
147 * This should be called after one or more tr_core_add*() calls.
148 */
149void     tr_core_torrents_added( TrCore * self );
150
151/******
152*******
153******/
154
155/* we've gotten notice from RPC that a torrent has been destroyed;
156   update our gui accordingly */
157void  tr_core_torrent_destroyed( TrCore * self, int torrentId );
158
159/* remove a torrent */
160void  tr_core_remove_torrent( TrCore * self, TrTorrent * gtor, int deleteFiles );
161
162/* update the model with current torrent status */
163void  tr_core_update( TrCore * self );
164
165/* emit the "quit" signal */
166void  tr_core_quit( TrCore * self );
167
168/**
169***  Set a preference value, save the prefs file, and emit the "prefs-changed" signal
170**/
171
172void tr_core_set_pref     ( TrCore * self, const char * key, const char * val );
173void tr_core_set_pref_bool( TrCore * self, const char * key, gboolean val );
174void tr_core_set_pref_int ( TrCore * self, const char * key, int val );
175void tr_core_set_pref_double( TrCore * self, const char * key, double val );
176
177/**
178***
179**/
180
181void tr_core_port_test( TrCore * core );
182
183void tr_core_blocklist_update( TrCore * core );
184
185void tr_core_exec( TrCore * core, const tr_benc * benc );
186
187void tr_core_exec_json( TrCore * core, const char * json );
188
189
190/**
191***
192**/
193
194/* column names for the model used to store torrent information */
195/* keep this in sync with the type array in tr_core_init() in tr_core.c */
196enum
197{
198    MC_NAME,
199    MC_NAME_COLLATED,
200    MC_TORRENT,
201    MC_TORRENT_RAW,
202    MC_ACTIVITY,
203    MC_ROW_COUNT
204};
205
206#endif
Note: See TracBrowser for help on using the repository browser.