pidgin/pidgin

yahoo: Add yahoojp.c to EXTRA_DIST

2016-10-09, Mike Ruprecht
4c7417b4d5fa
yahoo: Add yahoojp.c to EXTRA_DIST

yahoojp.c is in POTFILES.in, but isn't actually use for the build.
This causes `make distcheck` to fail as the file isn't "distributed".
This patch adds yahoojp.c to EXTRA_DIST so it will be distributed
and successfully checked when generating the translation files.

Really this file could be removed, but the 2.x.y branch has all of
the Yahoo prpl removed and that will be merged here soon enough.
/* 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_IMAGE_H_
#define _PURPLE_IMAGE_H_
/**
* SECTION:image
* @include:image.h
* @section_id: libpurple-image
* @short_description: implementation-independent image data container
* @title: Images
*
* #PurpleImage object is a container for raw image data. It doesn't manipulate
* image data, just stores it in its binary format - png, jpeg etc. Thus, it's
* totally independent from the UI.
*
* This class also provides certain file-related features, like: friendly
* filenames (not necessarily real filename for displaying); remote images
* (which data is not yet loaded) or guessing file format from its header.
*/
#include <glib-object.h>
typedef struct _PurpleImage PurpleImage;
typedef struct _PurpleImageClass PurpleImageClass;
#define PURPLE_TYPE_IMAGE (purple_image_get_type())
#define PURPLE_IMAGE(smiley) (G_TYPE_CHECK_INSTANCE_CAST((smiley), PURPLE_TYPE_IMAGE, PurpleImage))
#define PURPLE_IMAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), PURPLE_TYPE_IMAGE, PurpleImageClass))
#define PURPLE_IS_IMAGE(smiley) (G_TYPE_CHECK_INSTANCE_TYPE((smiley), PURPLE_TYPE_IMAGE))
#define PURPLE_IS_IMAGE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), PURPLE_TYPE_IMAGE))
#define PURPLE_IMAGE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), PURPLE_TYPE_IMAGE, PurpleImageClass))
/**
* PurpleImage:
*
* An image data container.
*/
struct _PurpleImage
{
/*< private >*/
GObject parent;
};
/**
* PurpleImageClass:
*
* Base class for #PurpleImage objects.
*/
struct _PurpleImageClass
{
/*< private >*/
GObjectClass parent_class;
void (*purple_reserved1)(void);
void (*purple_reserved2)(void);
void (*purple_reserved3)(void);
void (*purple_reserved4)(void);
};
G_BEGIN_DECLS
/**
* purple_image_get_type:
*
* Returns: the #GType for an image.
*/
GType
purple_image_get_type(void);
/**
* purple_image_new_from_file:
* @path: the path to the image file.
* @be_eager: %TRUE, if file should be loaded now, %FALSE when needed.
*
* Loads an image file as a new #PurpleImage object. The @path must exists, be
* readable and should point to a valid image file. If you don't set @be_eager
* parameter, there will be a risk that file will be removed from disk before
* you access its data.
*
* Returns: the new #PurpleImage.
*/
PurpleImage *
purple_image_new_from_file(const gchar *path, gboolean be_eager);
/**
* purple_image_new_from_data:
* @data: the pointer to the image data buffer.
* @length: the length of @data.
*
* Creates a new #PurpleImage object with contents of @data buffer.
*
* The @data buffer is owned by #PurpleImage object, so you might want
* to #g_memdup it first.
*
* Returns: the new #PurpleImage.
*/
PurpleImage *
purple_image_new_from_data(gpointer data, gsize length);
/**
* purple_image_save:
* @image: the image.
* @path: destination of a saved image file.
*
* Saves an @image to the disk.
*
* Returns: %TRUE if succeeded, %FALSE otherwise.
*/
gboolean
purple_image_save(PurpleImage *image, const gchar *path);
/**
* purple_image_get_path:
* @image: the image.
*
* Returns the physical path of the @image file. It is set only, if the @image is
* really backed by an existing file. In the other case it returns %NULL.
*
* Returns: the physical path of the @image, or %NULL.
*/
const gchar *
purple_image_get_path(PurpleImage *image);
/**
* purple_image_is_ready:
* @image: the image.
*
* Checks, if the @image data is ready to be displayed. Remote image data may
* not be accessible at the moment, so you should check it before using
* #purple_image_get_data. If the image is not ready yet, you may wait for
* #PurpleImage::ready signal.
*
* Returns: %TRUE, if the @image is ready.
*/
gboolean
purple_image_is_ready(PurpleImage *image);
/**
* purple_image_has_failed:
* @image: the image.
*
* Checks, if the @image has failed to load its data. It can be caused either by
* a remote failure (and #purple_image_transfer_failed call) or local file being
* removed (see #purple_image_new_from_file).
*
* Returns: %TRUE, if the @image has failed to load.
*/
gboolean
purple_image_has_failed(PurpleImage *image);
/**
* purple_image_get_size:
* @image: the image.
*
* Returns the size of @image's data.
*
* Returns: the size of data, or 0 in case of failure.
*/
gsize
purple_image_get_size(PurpleImage *image);
/**
* purple_image_get_data:
* @image: the image.
*
* Returns the pointer to the buffer containing image data.
*
* Returns: (transfer none): the @image data.
*/
gconstpointer
purple_image_get_data(PurpleImage *image);
/**
* purple_image_get_extension:
* @image: the image.
*
* Guesses the @image format based on its contents.
*
* Returns: (transfer none): the file extension suitable for @image format.
*/
const gchar *
purple_image_get_extension(PurpleImage *image);
/**
* purple_image_get_mimetype:
* @image: the image.
*
* Guesses the @image mime-type based on its contents.
*
* Returns: (transfer none): the mime-type suitable for @image format.
*/
const gchar *
purple_image_get_mimetype(PurpleImage *image);
/**
* purple_image_generate_filename:
* @image: the image.
*
* Calculates almost-unique filename by computing checksum from file contents
* and appending a suitable extension. You should not assume the checksum
* is SHA-1, because it may change in the future.
*
* Returns: (transfer none): the generated file name.
*/
const gchar *
purple_image_generate_filename(PurpleImage *image);
/**
* purple_image_set_friendly_filename:
* @image: the image.
* @filename: the friendly filename.
*
* Sets the "friendly filename" for the @image. This don't have to be a real
* name, because it's used for displaying or as a default file name when the
* user wants to save the @image to the disk.
*
* The provided @filename may either be a full path, or contain
* filesystem-unfriendly characters, because it will be reformatted.
*/
void
purple_image_set_friendly_filename(PurpleImage *image, const gchar *filename);
/**
* purple_image_get_friendly_filename:
* @image: the image.
*
* Returns the "friendly filename" for the @image, to be displayed or used as
* a default name when saving a file to the disk.
* See #purple_image_set_friendly_filename.
*
* If the friendly filename was not set, it will be generated with
* #purple_image_generate_filename.
*
* Returns: (transfer none): the friendly filename.
*/
const gchar *
purple_image_get_friendly_filename(PurpleImage *image);
/**
* purple_image_transfer_new:
*
* Creates a new remote image, with a possibility to load data with
* #purple_image_transfer_write and #purple_image_transfer_close. In case of
* failure, you should call #urple_image_transfer_failed.
*
* Returns: the new image object.
*/
PurpleImage *
purple_image_transfer_new(void);
/**
* purple_image_transfer_write:
* @image: the image.
* @data: the incoming data buffer.
* @length: the length of @data.
*
* Adds a chunk of data to the internal receive buffer. Called when receiving
* a remote file.
*/
void
purple_image_transfer_write(PurpleImage *image, gconstpointer data,
gsize length);
/**
* purple_image_transfer_close:
* @image: the image.
*
* Marks a remote @image as ready to be displayed. Called when finishing
* transfer of remote file. You may call this only once for a certain @image.
*/
void
purple_image_transfer_close(PurpleImage *image);
/**
* purple_image_transfer_failed:
* @image: the image.
*
* Marks a remote @image as failed to transfer. Called on error in remote file
* transfer. You may call this only once for a certain @image.
*/
void
purple_image_transfer_failed(PurpleImage *image);
G_END_DECLS
#endif /* _PURPLE_IMAGE_H_ */