429 lines
13 KiB
C
429 lines
13 KiB
C
/*
|
|
* Copyright 2003 Phil Mellor <monkeyson@users.sourceforge.net>
|
|
* Copyright 2006 James Bursa <bursa@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
|
|
* Browser window creation and manipulation (interface).
|
|
*/
|
|
|
|
#ifndef _NETSURF_DESKTOP_BROWSER_H_
|
|
#define _NETSURF_DESKTOP_BROWSER_H_
|
|
|
|
#include <inttypes.h>
|
|
#include <stdbool.h>
|
|
#include <time.h>
|
|
|
|
#include "content/content.h"
|
|
#include "desktop/gui.h"
|
|
#include "desktop/mouse.h"
|
|
#include "render/html.h"
|
|
#include "utils/types.h"
|
|
|
|
struct box;
|
|
struct hlcache_handle;
|
|
struct form;
|
|
struct form_control;
|
|
struct gui_window;
|
|
struct history;
|
|
struct selection;
|
|
struct browser_window;
|
|
struct url_data;
|
|
struct bitmap;
|
|
struct scroll_msg_data;
|
|
struct fetch_multipart_data;
|
|
|
|
typedef bool (*browser_caret_callback)(struct browser_window *bw, uint32_t key,
|
|
void *p1, void *p2);
|
|
typedef void (*browser_move_callback)(struct browser_window *bw,
|
|
void *p1, void *p2);
|
|
typedef bool (*browser_paste_callback)(struct browser_window *bw,
|
|
const char *utf8, unsigned utf8_len, bool last,
|
|
void *p1, void *p2);
|
|
|
|
|
|
typedef enum {
|
|
DRAGGING_NONE,
|
|
DRAGGING_SELECTION,
|
|
DRAGGING_PAGE_SCROLL,
|
|
DRAGGING_FRAME,
|
|
DRAGGING_SCR_X,
|
|
DRAGGING_SCR_Y,
|
|
DRAGGING_OTHER
|
|
} browser_drag_type;
|
|
|
|
|
|
|
|
/** Browser window data. */
|
|
struct browser_window {
|
|
/** Page currently displayed, or 0. Must have status READY or DONE. */
|
|
struct hlcache_handle *current_content;
|
|
/** Page being loaded, or 0. */
|
|
struct hlcache_handle *loading_content;
|
|
|
|
/** Window history structure. */
|
|
struct history *history;
|
|
|
|
/** Handler for keyboard input, or 0. */
|
|
browser_caret_callback caret_callback;
|
|
/** Handler for pasting text, or 0. */
|
|
browser_paste_callback paste_callback;
|
|
/** Handler for repositioning caret, or 0. */
|
|
browser_move_callback move_callback;
|
|
|
|
/** User parameters for caret_callback, paste_callback, and
|
|
* move_callback */
|
|
void *caret_p1;
|
|
void *caret_p2;
|
|
|
|
/** Platform specific window data. */
|
|
struct gui_window *window;
|
|
|
|
/** Busy indicator is active. */
|
|
bool throbbing;
|
|
/** Add loading_content to the window history when it loads. */
|
|
bool history_add;
|
|
|
|
/** Fragment identifier for current_content. */
|
|
char *frag_id;
|
|
|
|
/** Current drag status. */
|
|
browser_drag_type drag_type;
|
|
|
|
/** Current drag's browser window, when not in root bw. */
|
|
struct browser_window *drag_window;
|
|
|
|
/** Mouse position at start of current scroll drag. */
|
|
int drag_start_x;
|
|
int drag_start_y;
|
|
/** Scroll offsets at start of current scroll draw. */
|
|
int drag_start_scroll_x;
|
|
int drag_start_scroll_y;
|
|
/** Frame resize directions for current frame resize drag. */
|
|
unsigned int drag_resize_left : 1;
|
|
unsigned int drag_resize_right : 1;
|
|
unsigned int drag_resize_up : 1;
|
|
unsigned int drag_resize_down : 1;
|
|
|
|
/** Current fetch is download */
|
|
bool download;
|
|
|
|
/** Refresh interval (-1 if undefined) */
|
|
int refresh_interval;
|
|
|
|
/** Window has been resized, and content needs reformatting. */
|
|
bool reformat_pending;
|
|
|
|
/** Window dimensions */
|
|
int x;
|
|
int y;
|
|
int width;
|
|
int height;
|
|
|
|
struct scrollbar *scroll_x; /**< Horizontal scroll. */
|
|
struct scrollbar *scroll_y; /**< Vertical scroll. */
|
|
|
|
/** scale of window contents */
|
|
float scale;
|
|
|
|
/** Window characteristics */
|
|
enum {
|
|
BROWSER_WINDOW_NORMAL,
|
|
BROWSER_WINDOW_IFRAME,
|
|
BROWSER_WINDOW_FRAME,
|
|
BROWSER_WINDOW_FRAMESET,
|
|
} browser_window_type;
|
|
|
|
/** frameset characteristics */
|
|
int rows;
|
|
int cols;
|
|
|
|
/** frame dimensions */
|
|
struct frame_dimension frame_width;
|
|
struct frame_dimension frame_height;
|
|
int margin_width;
|
|
int margin_height;
|
|
|
|
/** frame name for targetting */
|
|
char *name;
|
|
|
|
/** frame characteristics */
|
|
bool no_resize;
|
|
frame_scrolling scrolling;
|
|
bool border;
|
|
colour border_colour;
|
|
|
|
/** iframe parent box */
|
|
struct box *box;
|
|
|
|
/** [cols * rows] children */
|
|
struct browser_window *children;
|
|
struct browser_window *parent;
|
|
|
|
/** [iframe_count] iframes */
|
|
int iframe_count;
|
|
struct browser_window *iframes;
|
|
|
|
/** browser window child of root browser window which has input focus */
|
|
struct browser_window *focus;
|
|
|
|
/** Last time a link was followed in this window */
|
|
unsigned int last_action;
|
|
|
|
/** Current selection, or NULL if none */
|
|
struct selection *cur_sel;
|
|
|
|
/** Current context for free text search, or NULL if none */
|
|
struct search_context *cur_search;
|
|
|
|
/** cache of the currently displayed status text. */
|
|
char *status_text; /**< Current status bar text. */
|
|
int status_text_len; /**< Length of the ::status_text buffer. */
|
|
int status_match; /**< Number of times an idempotent status-set operation was performed. */
|
|
int status_miss; /**< Number of times status was really updated. */
|
|
};
|
|
|
|
extern bool browser_reformat_pending;
|
|
|
|
struct browser_window * browser_window_create(const char *url,
|
|
struct browser_window *clone, const char *referrer,
|
|
bool history_add, bool new_tab);
|
|
void browser_window_initialise_common(struct browser_window *bw,
|
|
struct browser_window *clone);
|
|
void browser_window_go(struct browser_window *bw, const char *url,
|
|
const char *referrer, bool history_add);
|
|
void browser_window_go_post(struct browser_window *bw,
|
|
const char *url, char *post_urlenc,
|
|
struct fetch_multipart_data *post_multipart,
|
|
bool add_to_history, const char *referer, bool download,
|
|
bool verifiable, struct hlcache_handle *parent);
|
|
void browser_window_go_unverifiable(struct browser_window *bw,
|
|
const char *url, const char *referrer, bool history_add,
|
|
struct hlcache_handle *parent);
|
|
void browser_window_get_dimensions(struct browser_window *bw,
|
|
int *width, int *height, bool scaled);
|
|
void browser_window_set_dimensions(struct browser_window *bw,
|
|
int width, int height);
|
|
void browser_window_download(struct browser_window *bw,
|
|
const char *url, const char *referrer);
|
|
void browser_window_update(struct browser_window *bw, bool scroll_to_top);
|
|
void browser_window_update_box(struct browser_window *bw, struct rect *rect);
|
|
void browser_window_stop(struct browser_window *bw);
|
|
void browser_window_reload(struct browser_window *bw, bool all);
|
|
void browser_window_destroy(struct browser_window *bw);
|
|
void browser_window_reformat(struct browser_window *bw, bool background,
|
|
int width, int height);
|
|
void browser_window_set_scale(struct browser_window *bw, float scale, bool all);
|
|
|
|
/**
|
|
* Get access to any content, link URLs and objects (images) currently
|
|
* at the given (x, y) coordinates.
|
|
*
|
|
* \param bw browser window to look inside
|
|
* \param x x-coordinate of point of interest
|
|
* \param y y-coordinate of point of interest
|
|
* \param data pointer to contextual_content struct. Its fields are updated
|
|
* with pointers to any relevent content, or set to NULL if none.
|
|
*/
|
|
void browser_window_get_contextual_content(struct browser_window *bw,
|
|
int x, int y, struct contextual_content *data);
|
|
|
|
void browser_window_refresh_url_bar(struct browser_window *bw, const char *url,
|
|
const char *frag);
|
|
|
|
void browser_window_mouse_click(struct browser_window *bw,
|
|
browser_mouse_state mouse, int x, int y);
|
|
void browser_window_mouse_track(struct browser_window *bw,
|
|
browser_mouse_state mouse, int x, int y);
|
|
struct browser_window *browser_window_find_target(
|
|
struct browser_window *bw, const char *target,
|
|
browser_mouse_state mouse);
|
|
|
|
void browser_redraw_box(struct hlcache_handle *c, struct box *box);
|
|
|
|
void browser_select_menu_callback(void *client_data,
|
|
int x, int y, int width, int height);
|
|
|
|
void browser_window_redraw_rect(struct browser_window *bw, int x, int y,
|
|
int width, int height);
|
|
|
|
void browser_window_set_status(struct browser_window *bw, const char *text);
|
|
void browser_window_set_pointer(struct browser_window *bw,
|
|
gui_pointer_shape shape);
|
|
void browser_window_page_drag_start(struct browser_window *bw, int x, int y);
|
|
|
|
bool browser_window_back_available(struct browser_window *bw);
|
|
bool browser_window_forward_available(struct browser_window *bw);
|
|
bool browser_window_reload_available(struct browser_window *bw);
|
|
bool browser_window_stop_available(struct browser_window *bw);
|
|
|
|
|
|
/* In desktop/textinput.c */
|
|
void browser_window_place_caret(struct browser_window *bw,
|
|
int x, int y, int height,
|
|
browser_caret_callback caret_cb,
|
|
browser_paste_callback paste_cb,
|
|
browser_move_callback move_cb,
|
|
void *p1, void *p2);
|
|
void browser_window_remove_caret(struct browser_window *bw);
|
|
bool browser_window_key_press(struct browser_window *bw, uint32_t key);
|
|
bool browser_window_paste_text(struct browser_window *bw, const char *utf8,
|
|
unsigned utf8_len, bool last);
|
|
|
|
|
|
/**
|
|
* Redraw an area of a window
|
|
*
|
|
* Calls the redraw function for the content,
|
|
*
|
|
* \param bw The window to redraw
|
|
* \param x coordinate for top-left of redraw
|
|
* \param y coordinate for top-left of redraw
|
|
* \param clip clip rectangle coordinates
|
|
* \param ctx redraw context
|
|
* \return true if successful, false otherwise
|
|
*
|
|
* The clip rectangle is guaranteed to be filled to its extents, so there is
|
|
* no need to render a solid background first.
|
|
*
|
|
* x, y and clip are coordinates from the top left of the canvas area.
|
|
*
|
|
* The top left corner of the clip rectangle is (x0, y0) and
|
|
* the bottom right corner of the clip rectangle is (x1, y1).
|
|
* Units for x, y and clip are pixels.
|
|
*/
|
|
bool browser_window_redraw(struct browser_window *bw, int x, int y,
|
|
const struct rect *clip, const struct redraw_context *ctx);
|
|
|
|
/**
|
|
* Check whether browser window is ready for redraw
|
|
*
|
|
* \param bw The window to redraw
|
|
* \return true if browser window is ready for redraw
|
|
*/
|
|
bool browser_window_redraw_ready(struct browser_window *bw);
|
|
|
|
/*
|
|
* Update the extent of the inside of a browser window to that of the current
|
|
* content
|
|
*
|
|
* \param bw browser_window to update the extent of
|
|
*/
|
|
void browser_window_update_extent(struct browser_window *bw);
|
|
|
|
/*
|
|
* Get the position of the current browser window with respect to the root or
|
|
* parent browser window
|
|
*
|
|
* \param bw browser window to get the position of
|
|
* \param root true if we want position wrt root bw, false if wrt parent bw
|
|
* \param pos_x updated to x position of bw
|
|
* \param pos_y updated to y position of bw
|
|
*/
|
|
void browser_window_get_position(struct browser_window *bw, bool root,
|
|
int *pos_x, int *pos_y);
|
|
|
|
/*
|
|
* Set the position of the current browser window with respect to the parent
|
|
* browser window
|
|
*
|
|
* \param bw browser window to set the position of
|
|
* \param x x position of bw
|
|
* \param y y position of bw
|
|
*/
|
|
void browser_window_set_position(struct browser_window *bw, int x, int y);
|
|
|
|
/*
|
|
* Scroll the browser window to display the passed area
|
|
*
|
|
* \param bw browser window to scroll
|
|
* \param rect area to display
|
|
*/
|
|
void browser_window_scroll_visible(struct browser_window *bw,
|
|
const struct rect *rect);
|
|
|
|
/**
|
|
* Set scroll offsets for a browser window.
|
|
*
|
|
* \param bw The browser window
|
|
* \param x The x scroll offset to set
|
|
* \param y The y scroll offset to set
|
|
*
|
|
* TODO -- Do we really need this and browser_window_scroll_visible?
|
|
* Ditto for gui_window_* variants.
|
|
*/
|
|
void browser_window_set_scroll(struct browser_window *bw, int x, int y);
|
|
|
|
/*
|
|
* Set the position of the current browser window with respect to the parent
|
|
* browser window
|
|
*
|
|
* \param bw browser window to set the type of the current drag for
|
|
* \param type drag type
|
|
*/
|
|
void browser_window_set_drag_type(struct browser_window *bw,
|
|
browser_drag_type type);
|
|
|
|
/*
|
|
* Get the root level browser window
|
|
*
|
|
* \param bw browser window to set the type of the current drag for
|
|
* \return root browser window
|
|
*/
|
|
struct browser_window * browser_window_get_root(struct browser_window *bw);
|
|
|
|
/**
|
|
* Check whether browser window contains a selection
|
|
*
|
|
* \param bw The browser window
|
|
* \return true if browser window contains a selection
|
|
*/
|
|
bool browser_window_has_selection(struct browser_window *bw);
|
|
|
|
/**
|
|
* Set pointer to current selection. Clears any existing selection.
|
|
*
|
|
* \param bw The browser window
|
|
* \param s The new selection
|
|
*/
|
|
void browser_window_set_selection(struct browser_window *bw,
|
|
struct selection *s);
|
|
|
|
/**
|
|
* Get the current selection context from a root browser window
|
|
*
|
|
* \param bw The browser window
|
|
* \return the selection context, or NULL
|
|
*/
|
|
struct selection *browser_window_get_selection(struct browser_window *bw);
|
|
|
|
|
|
/* In platform specific hotlist.c. */
|
|
void hotlist_visited(struct hlcache_handle *c);
|
|
|
|
/* In platform specific global_history.c. */
|
|
void global_history_add(const char *url);
|
|
void global_history_add_recent(const char *url);
|
|
char **global_history_get_recent(int *count);
|
|
|
|
/* In platform specific theme_install.c. */
|
|
#ifdef WITH_THEME_INSTALL
|
|
void theme_install_start(struct hlcache_handle *c);
|
|
#endif
|
|
|
|
#endif
|