1
0
mirror of https://github.com/netsurf-browser/netsurf synced 2024-12-25 13:37:02 +03:00
netsurf/content/content_protected.h

316 lines
9.8 KiB
C
Raw Normal View History

/*
* Copyright 2005-2007 James Bursa <bursa@users.sourceforge.net>
* Copyright 2003 Philip Pemberton <philpem@users.sourceforge.net>
*
* This file is part of NetSurf, http://www.netsurf-browser.org/
*
* NetSurf 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; version 2 of the License.
*
* NetSurf 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, see <http://www.gnu.org/licenses/>.
*/
/** \file
* Content handling (interface).
*
* The content functions manipulate struct contents, which correspond to URLs.
*/
#ifndef _NETSURF_CONTENT_CONTENT_PROTECTED_H_
#define _NETSURF_CONTENT_CONTENT_PROTECTED_H_
#include <stdint.h>
#include <time.h>
2016-04-19 01:04:16 +03:00
#include <stdio.h>
#include "utils/config.h"
#include "content/content.h"
#include "content/content_factory.h"
#include "content/llcache.h"
#include "utils/errors.h"
struct bitmap;
struct content;
struct rect;
struct redraw_context;
2016-04-19 01:04:16 +03:00
struct http_parameter;
struct content_handler {
void (*fini)(void);
nserror (*create)(const content_handler *handler,
2016-04-19 01:04:16 +03:00
lwc_string *imime_type,
const struct http_parameter *params,
llcache_handle *llcache,
const char *fallback_charset, bool quirks,
struct content **c);
bool (*process_data)(struct content *c,
const char *data, unsigned int size);
bool (*data_complete)(struct content *c);
void (*reformat)(struct content *c, int width, int height);
void (*destroy)(struct content *c);
void (*stop)(struct content *c);
void (*mouse_track)(struct content *c, struct browser_window *bw,
browser_mouse_state mouse, int x, int y);
void (*mouse_action)(struct content *c, struct browser_window *bw,
browser_mouse_state mouse, int x, int y);
bool (*keypress)(struct content *c, uint32_t key);
bool (*redraw)(struct content *c, struct content_redraw_data *data,
const struct rect *clip,
const struct redraw_context *ctx);
void (*open)(struct content *c, struct browser_window *bw,
2012-08-20 17:22:28 +04:00
struct content *page, struct object_params *params);
void (*close)(struct content *c);
void (*clear_selection)(struct content *c);
char * (*get_selection)(struct content *c);
nserror (*get_contextual_content)(struct content *c, int x, int y,
struct browser_window_features *data);
bool (*scroll_at_point)(struct content *c, int x, int y,
int scrx, int scry);
bool (*drop_file_at_point)(struct content *c, int x, int y,
char *file);
void (*search)(struct content *c, void *context, search_flags_t flags,
const char *string);
void (*search_clear)(struct content *c);
2014-08-04 03:36:14 +04:00
nserror (*debug_dump)(struct content *c, FILE *f, enum content_debug op);
nserror (*debug)(struct content *c, enum content_debug op);
nserror (*clone)(const struct content *old, struct content **newc);
bool (*matches_quirks)(const struct content *c, bool quirks);
const char *(*get_encoding)(const struct content *c, enum content_encoding_type op);
content_type (*type)(void);
void (*add_user)(struct content *c);
void (*remove_user)(struct content *c);
/** handler dependant content sensitive internal data interface. */
void * (*get_internal)(const struct content *c, void *context);
/** There must be one content per user for this type. */
bool no_share;
};
/** Linked list of users of a content. */
struct content_user
{
void (*callback)(struct content *c, content_msg msg,
union content_msg_data data, void *pw);
void *pw;
struct content_user *next;
};
/** Corresponds to a single URL. */
struct content {
llcache_handle *llcache; /**< Low-level cache object */
lwc_string *mime_type; /**< Original MIME type of data */
const content_handler *handler; /**< Handler for content */
content_status status; /**< Current status. */
int width, height; /**< Dimensions, if applicable. */
int available_width; /**< Available width (eg window width). */
bool quirks; /**< Content is in quirks mode */
char *fallback_charset; /**< Fallback charset, or NULL */
nsurl *refresh; /**< URL for refresh request */
struct content_rfc5988_link *links; /**< list of metadata links */
/** Creation timestamp when LOADING or READY.
* Total time in ms when DONE.
*/
uint64_t time;
uint64_t reformat_time; /**< Earliest time to attempt a period
* reflow while fetching a page's objects.
*/
unsigned int size; /**< Estimated size of all data
associated with this content */
char *title; /**< Title for browser window. */
unsigned int active; /**< Number of child fetches or
conversions currently in progress. */
struct content_user *user_list; /**< List of users. */
char status_message[120]; /**< Full text for status bar. */
char sub_status[80]; /**< Status of content. */
/** Content is being processed: data structures may be inconsistent
* and content must not be redrawn or modified. */
bool locked;
unsigned long total_size; /**< Total data size, 0 if unknown. */
long http_code; /**< HTTP status code, 0 if not HTTP. */
/** Array of first n rendering errors or warnings. */
struct {
const char *token;
unsigned int line; /**< Line no, 0 if not applicable. */
} error_list[40];
unsigned int error_count; /**< Number of valid error entries. */
};
extern const char * const content_type_name[];
extern const char * const content_status_name[];
nserror content__init(struct content *c, const content_handler *handler,
2016-04-19 01:04:16 +03:00
lwc_string *imime_type, const struct http_parameter *params,
struct llcache_handle *llcache, const char *fallback_charset,
bool quirks);
nserror content__clone(const struct content *c, struct content *nc);
void content_set_ready(struct content *c);
void content_set_done(struct content *c);
void content_set_error(struct content *c);
2012-08-15 14:50:08 +04:00
void content_set_status(struct content *c, const char *status_message);
void content_broadcast(struct content *c, content_msg msg,
union content_msg_data data);
2012-11-26 20:24:48 +04:00
/**
* Send an errorcode message to all users.
*/
void content_broadcast_errorcode(struct content *c, nserror errorcode);
void content_add_error(struct content *c, const char *token,
unsigned int line);
bool content__add_rfc5988_link(struct content *c,
const struct content_rfc5988_link *link);
struct content_rfc5988_link *content__free_rfc5988_link(
struct content_rfc5988_link *link);
void content__reformat(struct content *c, bool background,
int width, int height);
void content__request_redraw(struct content *c,
int x, int y, int width, int height);
2014-11-09 01:08:29 +03:00
/**
* Retrieve mime-type of content
*
* \param c Content to retrieve mime-type of
* \return Pointer to referenced mime-type, or NULL if not found.
*/
lwc_string *content__get_mime_type(struct content *c);
2014-11-09 01:08:29 +03:00
/**
* Set title associated with content
*
* \param c Content to set title on.
2014-11-09 15:50:30 +03:00
* \param title The new title to set.
2014-11-09 01:08:29 +03:00
* \return true on sucess else false.
*/
bool content__set_title(struct content *c, const char *title);
/**
* Retrieve title associated with content
*
* \param c Content to retrieve title from
* \return Pointer to title, or NULL if not found.
*/
const char *content__get_title(struct content *c);
2014-11-09 01:08:29 +03:00
/**
* Retrieve status message associated with content
*
* \param c Content to retrieve status message from
* \return Pointer to status message, or NULL if not found.
*/
const char *content__get_status_message(struct content *c);
2014-11-09 01:08:29 +03:00
/**
* Retrieve width of content
*
* \param c Content to retrieve width of
* \return Content width
*/
int content__get_width(struct content *c);
2014-11-09 01:08:29 +03:00
/**
* Retrieve height of content
*
* \param c Content to retrieve height of
* \return Content height
*/
int content__get_height(struct content *c);
2014-11-09 01:08:29 +03:00
/**
* Retrieve available width of content
*
* \param c content to get available width of.
* \return Available width of content.
*/
int content__get_available_width(struct content *c);
2014-11-09 01:08:29 +03:00
/**
* Retrieve source of content.
*
* \param c Content to retrieve source of.
* \param size Pointer to location to receive byte size of source.
* \return Pointer to source data.
*/
const char *content__get_source_data(struct content *c, unsigned long *size);
2014-11-08 19:49:32 +03:00
/**
* Invalidate content reuse data.
*
* causes subsequent requests for content URL to query server to
* determine if content can be reused. This is required behaviour for
* forced reloads etc.
*
* \param c Content to invalidate.
*/
void content__invalidate_reuse_data(struct content *c);
2014-11-08 19:49:32 +03:00
/**
* Retrieve the refresh URL for a content
*
* \param c Content to retrieve refresh URL from
* \return Pointer to URL or NULL if none
*/
nsurl *content__get_refresh_url(struct content *c);
2014-11-08 19:49:32 +03:00
/**
* Retrieve the bitmap contained in an image content
*
* \param c Content to retrieve opacity from
* \return Pointer to bitmap or NULL if none.
*/
struct bitmap *content__get_bitmap(struct content *c);
2014-11-08 19:49:32 +03:00
/**
* Determine if a content is opaque
*
* \param c Content to retrieve opacity from
* \return false if the content is not opaque or information is not
* known else true.
*/
bool content__get_opaque(struct content *c);
2014-11-08 19:49:32 +03:00
/**
* Retrieve the encoding of a content
*
* \param c the content to examine the encoding of.
* \param op encoding operation.
* \return Pointer to content info or NULL if none.
*/
const char *content__get_encoding(struct content *c, enum content_encoding_type op);
2014-11-08 19:49:32 +03:00
/**
* Return whether a content is currently locked
*
* \param c Content to test
* \return true iff locked, else false
*/
bool content__is_locked(struct content *c);
#endif