1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*
This file is part of GNUnet.
(C) 2010 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
by the Free Software Foundation; either version 2, or (at your
option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.
*/
/**
* @file src/fs/gnunet-fs-gtk_common.h
* @brief Common includes for all gnunet-gtk source files
* @author Christian Grothoff
*/
#ifndef GNUNET_FS_GTK_COMMON_H
#define GNUNET_FS_GTK_COMMON_H
#include "gnunet_gtk.h"
#include <gnunet/gnunet_fs_service.h>
#include <extractor.h>
/**
* Obtain pixbuf from thumbnail data in meta data.
*
* @param meta input meta data
* @return NULL on error, otherwise the embedded thumbnail
*/
GdkPixbuf *
GNUNET_FS_GTK_get_thumbnail_from_meta_data (const struct
GNUNET_CONTAINER_MetaData *meta);
/**
* Initialize the 'expiration_year_adjustment' of the given
* builder to have a lower range of current-year+1 and a
* default of current-year+2.
* FIXME-STYLE: odd API...
*
* @param builder builder object for which we should manipulate
* the adjustment
*/
void
GNUNET_FS_GTK_setup_expiration_year_adjustment (GtkBuilder * builder);
/**
* Convert the year from the spin button to an expiration
* time (on midnight, January 1st of that year).
*
* @param spin button with the year
* @param time converted from the spin button
*/
struct GNUNET_TIME_Absolute
GNUNET_FS_GTK_get_expiration_time (GtkSpinButton * spin);
/**
* mmap the given file and run the GNUNET_FS_directory_list_contents
* function on it.
*
* @param filename name with the directory
* @param dep function to call on each entry
* @param dep_cls closure for 'dep'
* @return GNUNET_OK on success
*/
int
GNUNET_FS_GTK_mmap_and_scan (const char *filename,
GNUNET_FS_DirectoryEntryProcessor dep,
void *dep_cls);
/**
* Add meta data to list store.
*
* @param cls closure (the GtkListStore)
* @param plugin_name name of the plugin that produced this value;
* special values can be used (i.e. '<zlib>' for zlib being
* used in the main libextractor library and yielding
* meta data).
* @param type libextractor-type describing the meta data
* @param format basic format information about data
* @param data_mime_type mime-type of data (not of the original file);
* can be NULL (if mime-type is not known)
* @param data actual meta-data found
* @param data_len number of bytes in data
* @return 0 to continue (always)
*/
int
GNUNET_FS_GTK_add_meta_data_to_list_store (void *cls, const char *plugin_name,
enum EXTRACTOR_MetaType type,
enum EXTRACTOR_MetaFormat format,
const char *data_mime_type,
const char *data, size_t data_len);
/**
* Converts metadata specified by @data of size @data_len
* and saved in format @format to UTF-8 encoded string.
* Works only for C-string and UTF8 metadata formats
* (returns NULL for everything else).
* Verifies UTF-8 strings.
*
* @param format format of the @data
* @param data data to convert
* @param data_len length of the data buffer (in bytes)
* @return NULL if can't be converted, allocated string otherwise,
* freeable with GNUNET_free* ().
*/
char *
GNUNET_FS_GTK_dubious_meta_to_utf8 (enum EXTRACTOR_MetaFormat format,
const char *data, size_t data_len);
/**
* Obtain the string we will use to describe a search result from
* the respective meta data.
*
* @param meta meta data to inspect
* @param is_a_dup is set to GNUNET_YES if the result is a dup, and there was
* no description to be found. GNUNET_NO otherwise.
* @return description of the result in utf-8, never NULL
*/
char *
GNUNET_FS_GTK_get_description_from_metadata (
const struct GNUNET_CONTAINER_MetaData *meta, int *is_a_dup);
/**
* A URI was selected (or pasted into the application). Run
* the appropriate action.
*
* @param uri the URI
* @param anonymity_level anonymity level to use
*/
void
GNUNET_FS_GTK_handle_uri (const struct GNUNET_FS_Uri *uri,
guint anonymity_level);
/**
* Finds largest namespace rating.
* Used to calculate a rating for newly discovered namespaces.
* Returns from cache, if possible.
*
* @return largest namespace rating. Might be negative and even. INT_MIN means
* that no namespaces are known.
*/
int
GNUNET_GTK_find_largest_namespace_rating (void);
/**
* Sets largest namespace rating.
* Used to change cached largest namespace rating, when namespace list
* was changed in a way that is easy to track.
* If namespace list was changed in a way that makes it difficult to
* decide upon the new value, set new value to INT_MIN.
*
* @param new_value new value for the rating.
*/
void
GNUNET_GTK_set_largest_namespace_rating (int new_value);
/**
* Converts a GtkTreeRowReference to a GtkTreeIter.
*
* @param rr row reference
* @param iter pointer to an iter structure to fill
* @return GNUNET_OK if iter was filled, GNUNET_SYSERR otherwise
*/
int
GNUNET_GTK_get_iter_from_reference (GtkTreeRowReference *rr, GtkTreeIter *iter);
/**
* Creates a GtkTreeRowReference from a GtkTreeIter.
*
* @param model a model to reference
* @param iter an iter that points to a row in the model
* @return newly created reference or NULL in case of error
*/
GtkTreeRowReference *
GNUNET_GTK_get_reference_from_iter (GtkTreeModel *model, GtkTreeIter *iter);
/**
* Fills "next_iter" with iterator for an item that comes next in the tree
* after "iter".
* Next item is, in order of precedence:
* 1) First child of "iter", if "iter" has children and "allow_children"
* is enabled.
* 2) Next sibling of "iter", unless "iter" is the last sibling.
* If none of those are present, function recursively checks parents of
* "iter" until it finds next item or runs out of parents.
*
* @param model a model to reference
* @param iter an iter that points to current row in the model
* @param allow_children whether child of "iter" is considered to be next.
* @param next_iter will be filled with the next row in the model on success
* @return TRUE if next_iter is set to a valid iter,
* FALSE if ran out of parents
*/
gboolean
GNUNET_GTK_tree_model_get_next_flat_iter (GtkTreeModel *model,
GtkTreeIter *iter, gboolean allow_children, GtkTreeIter *next_iter);
#endif
/* end of gnunet-fs-gtk-common.h */
|
