/usr/include/libpurple/imgstore.h is in libpurple-dev 2.12.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 220 221 222 223 224 225 226 227 228 229 230 | /**
* @file imgstore.h IM Image Store API
* @ingroup core
* @see @ref imgstore-signals
*/
/* purple
*
* Purple is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This program 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 of the License, or
* (at your option) any later version.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef _PURPLE_IMGSTORE_H_
#define _PURPLE_IMGSTORE_H_
#include <glib.h>
/**
* A set of utility functions that provide a reference-counted immutable
* wrapper around an image's data and filename. These functions do not
* cache any data to disk.
*/
typedef struct _PurpleStoredImage PurpleStoredImage;
#ifdef __cplusplus
extern "C" {
#endif
/**
* Create a new PurpleStoredImage.
*
* Despite the name of this function, the image is NOT added to the image
* store and no ID is assigned. If you need to reference the image by an
* ID, use purple_imgstore_add_with_id() instead.
*
* The caller owns a reference to this image and must dereference it with
* purple_imgstore_unref() for it to be freed.
*
* @param data Pointer to the image data, which the imgstore will take
* ownership of and free as appropriate. If you want a
* copy of the data, make it before calling this function.
* @param size Image data's size.
* @param filename Filename associated with image. This is for your
* convenience. It could be the full path to the
* image or, more commonly, the filename of the image
* without any directory information. It can also be
* NULL, if you don't need to keep track of a filename.
*
* @return The stored image, or NULL if the image was not added (because of
* empty data or size).
*/
PurpleStoredImage *
purple_imgstore_add(gpointer data, size_t size, const char *filename);
/**
* Create a PurpleStoredImage using purple_imgstore_add() by reading the
* given filename from disk.
*
* The image is not added to the image store and no ID is assigned. If you
* need to reference the image by an ID, use purple_imgstore_add_with_id()
* instead.
*
* The caller owns a reference to this image and must dereference it with
* purple_imgstore_unref() for it to be freed.
*
* @param path The path to the image.
*
* @return The stored image, or NULL if the image was not added (because of
* empty data or size).
*
* @since 2.5.0
*/
PurpleStoredImage *
purple_imgstore_new_from_file(const char *path);
/**
* Create a PurpleStoredImage using purple_imgstore_add() and add the
* image to the image store. A unique ID will be assigned to the image.
*
* The caller owns a reference to the image and must dereference it with
* purple_imgstore_unref() or purple_imgstore_unref_by_id() for it to be
* freed.
*
* @param data Pointer to the image data, which the imgstore will take
* ownership of and free as appropriate. If you want a
* copy of the data, make it before calling this function.
* @param size Image data's size.
* @param filename Filename associated with image. This is for your
* convenience. It could be the full path to the
* image or, more commonly, the filename of the image
* without any directory information. It can also be
* NULL, if you don't need to keep track of a filename.
*
* @return ID for the image. This is a unique number that can be used
* within libpurple to reference the image. 0 is returned if the
* image was not added (because of empty data or size).
*/
int purple_imgstore_add_with_id(gpointer data, size_t size, const char *filename);
/**
* Retrieve an image from the store. The caller does not own a
* reference to the image.
*
* @param id The ID for the image.
*
* @return A pointer to the requested image, or NULL if it was not found.
*/
PurpleStoredImage *purple_imgstore_find_by_id(int id);
/**
* Retrieves a pointer to the image's data.
*
* @param img The Image.
*
* @return A pointer to the data, which must not
* be freed or modified.
*/
gconstpointer purple_imgstore_get_data(PurpleStoredImage *img);
/**
* Retrieves the length of the image's data.
*
* @param img The Image.
*
* @return The size of the data that the pointer returned by
* purple_imgstore_get_data points to.
*/
size_t purple_imgstore_get_size(PurpleStoredImage *img);
/**
* Retrieves a pointer to the image's filename.
*
* @param img The image.
*
* @return A pointer to the filename, which must not
* be freed or modified.
*/
const char *purple_imgstore_get_filename(const PurpleStoredImage *img);
/**
* Looks at the magic numbers of the image data (the first few bytes)
* and returns an extension corresponding to the image's file type.
*
* @param img The image.
*
* @return The image's extension (for example "png") or "icon"
* if unknown.
*/
const char *purple_imgstore_get_extension(PurpleStoredImage *img);
/**
* Increment the reference count.
*
* @param img The image.
*
* @return @a img
*/
PurpleStoredImage *
purple_imgstore_ref(PurpleStoredImage *img);
/**
* Decrement the reference count.
*
* If the reference count reaches zero, the image will be freed.
*
* @param img The image.
*
* @return @a img or @c NULL if the reference count reached zero.
*/
PurpleStoredImage *
purple_imgstore_unref(PurpleStoredImage *img);
/**
* Increment the reference count using an ID.
*
* This is a convience wrapper for purple_imgstore_find_by_id() and
* purple_imgstore_ref(), so if you have a PurpleStoredImage, it'll
* be more efficient to call purple_imgstore_ref() directly.
*
* @param id The ID for the image.
*/
void purple_imgstore_ref_by_id(int id);
/**
* Decrement the reference count using an ID.
*
* This is a convience wrapper for purple_imgstore_find_by_id() and
* purple_imgstore_unref(), so if you have a PurpleStoredImage, it'll
* be more efficient to call purple_imgstore_unref() directly.
*
* @param id The ID for the image.
*/
void purple_imgstore_unref_by_id(int id);
/**
* Returns the image store subsystem handle.
*
* @return The subsystem handle.
*/
void *purple_imgstore_get_handle(void);
/**
* Initializes the image store subsystem.
*/
void purple_imgstore_init(void);
/**
* Uninitializes the image store subsystem.
*/
void purple_imgstore_uninit(void);
#ifdef __cplusplus
}
#endif
#endif /* _PURPLE_IMGSTORE_H_ */
|