netsurf/desktop/gui.h

571 lines
15 KiB
C
Raw Normal View History

/*
* Copyright 2014 Vincent Sanders <vince@netsurf-browser.org>
*
* 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
2014-02-01 18:23:58 +04:00
* Interface to platform-specific gui operation tables.
*/
#ifndef _NETSURF_DESKTOP_GUI_H_
#define _NETSURF_DESKTOP_GUI_H_
2014-02-02 19:48:26 +04:00
#include <stddef.h>
2014-01-30 01:35:53 +04:00
#include "utils/types.h"
#include "utils/errors.h"
2014-01-30 01:35:53 +04:00
#include "desktop/plot_style.h"
#include "desktop/mouse.h"
typedef enum {
GUI_SAVE_SOURCE,
GUI_SAVE_DRAW,
First merge of Adam Blokus' GSoC work from his branch 'branches/adamblokus/netsurf'. Merged revisions 4212-4552,4554-4709,4711-4724 via svnmerge from svn://svn.netsurf-browser.org/branches/adamblokus/netsurf ........ r4212 | adamblokus | 2008-05-26 19:42:31 +0200 (Mon, 26 May 2008) | 4 lines Pdf plotting skeleton pinned on Print Preview in GTK. Just creates a file and draws lines. ........ r4213 | adamblokus | 2008-05-27 00:11:03 +0200 (Tue, 27 May 2008) | 4 lines Pdf plotter - added drawing some graphic primitives. Still with limited functionality, but a snapshot of the currently viewed page can be made and resembles the original. ........ r4214 | adamblokus | 2008-05-27 11:43:31 +0200 (Tue, 27 May 2008) | 2 lines Corrected encoding name ........ r4215 | adamblokus | 2008-05-27 12:47:26 +0200 (Tue, 27 May 2008) | 3 lines Colours and polygons added. ........ r4217 | adamblokus | 2008-05-27 21:39:35 +0200 (Tue, 27 May 2008) | 6 lines Added rectangles, filled boxes and clipping. Taken into consideration joty's comments. Added a todo list for this part. Added some debug stuff and checking boundaries. ........ r4218 | adamblokus | 2008-05-28 12:37:30 +0200 (Wed, 28 May 2008) | 2 lines Added path ploting (not sure if valid argument order for bezier) and dashed/dotted line styles ........ r4221 | adamblokus | 2008-05-28 22:11:05 +0200 (Wed, 28 May 2008) | 3 lines Some more options in graphic primitives and normalizing some parameters. ........ r4235 | adamblokus | 2008-05-31 22:54:56 +0200 (Sat, 31 May 2008) | 4 lines Plotting changed as jmb suggested (is the least invasive one from the possible) Added dummy bitmap plotting - way of plotting an image is determined by its type. ........ r4251 | adamblokus | 2008-06-03 17:12:15 +0200 (Tue, 03 Jun 2008) | 3 lines Added plotting jpg and png images - quite a lot to improve in this code, but it seems to work ;) ........ r4263 | adamblokus | 2008-06-05 14:20:32 +0200 (Thu, 05 Jun 2008) | 3 lines Added hadling images other than png and jpeg - with transparency. ........ r4267 | adamblokus | 2008-06-06 15:36:34 +0200 (Fri, 06 Jun 2008) | 5 lines Added handling NULL-returns from all mallocs. Added plot_bitmap_tile handling. Changed code style a little. ........ r4327 | adamblokus | 2008-06-12 17:46:34 +0200 (Thu, 12 Jun 2008) | 5 lines Added a first prototype of the paged-output organization. Still not sure about naming, file locations etc. Works with the same pdf plotting as before. ........ r4328 | adamblokus | 2008-06-13 13:52:15 +0200 (Fri, 13 Jun 2008) | 4 lines Added primitive width adjustment and outputing the whole website in multiple pages. ........ r4336 | joty | 2008-06-15 15:06:57 +0200 (Sun, 15 Jun 2008) | 1 line Fix RISC OS build failure (change r4235 wasn't complete). ........ r4337 | joty | 2008-06-15 18:15:32 +0200 (Sun, 15 Jun 2008) | 16 lines This enables "Export PDF" in RISC OS build: - Docs/Doxyfile(PREDEFINED): Added WITH_PDF_EXPORT - Makefile.sources(S_PDF): Add to RISC OS target as well. - utils/config.h: Define WITH_PDF_EXPORT which controls if we want to have PDF export functionality or not. - riscos/save_pdf.c,riscos/save_pdf.h(save_as_pdf): Use PDF print API made by Adam Blokus to write a PDF file under RISC OS. - riscos/save.c: Call save_as_pdf added. - riscos/menus.c: Add 'Export->PDF' menu entry. - riscos/menus.h(menu_action): Added BROWSER_EXPORT_PDF. - desktop/gui.h(gui_save_type): Added GUI_SAVE_PDF. - desktop/print.c(print_run): Added return value. - Makefile(CCACHE): Moved closed to the place where CC is set for the first time. (LDFLAGS): Centralised adding all non-pkgconfig libraries and added Haru + PNG libs. ........ r4343 | adamblokus | 2008-06-16 01:08:52 +0200 (Mon, 16 Jun 2008) | 3 lines Added margins and page size adjustment. ........ r4412 | adamblokus | 2008-06-21 20:22:07 +0200 (Sat, 21 Jun 2008) | 4 lines Added 'fuzzy' margins on page bottom. Disabled direct png embedding, because it is too unstable in Haru now. ........ r4421 | adamblokus | 2008-06-22 18:52:28 +0200 (Sun, 22 Jun 2008) | 2 lines Added "Save as.." dialog and Export->PDF menu entry. Print preview still works with default path. ........ r4437 | adamblokus | 2008-06-25 02:44:46 +0200 (Wed, 25 Jun 2008) | 4 lines Added skeleton of applying loose layout. Minor code cleaning-up. ........ r4492 | adamblokus | 2008-07-02 09:02:42 +0200 (Wed, 02 Jul 2008) | 5 lines Implemented the elementar ideas of the loose layout. Added scaling in the printing routine. Added some basic demonstrations. ........ r4493 | adamblokus | 2008-07-02 09:05:55 +0200 (Wed, 02 Jul 2008) | 3 lines Cleaned up the loosing code - commited to much of leftover rubbish code. ........ r4507 | adamblokus | 2008-07-04 14:25:48 +0200 (Fri, 04 Jul 2008) | 4 lines Added duplicating box tree and current content - window flickering during printing solved. Minor error checking after new HPDF_Image_AddSMask call. ........ r4515 | adamblokus | 2008-07-06 22:28:16 +0200 (Sun, 06 Jul 2008) | 2 lines Changes in loosen layout (image resizing). ........ r4517 | adamblokus | 2008-07-06 22:38:23 +0200 (Sun, 06 Jul 2008) | 2 lines Added pdf font handling and rendering functions with the use of Haru functions. ........ r4555 | adamblokus | 2008-07-10 00:59:05 +0200 (Thu, 10 Jul 2008) | 2 lines Added a very basic and still buggy GTK print implementation. ........ r4565 | adamblokus | 2008-07-10 14:50:16 +0200 (Thu, 10 Jul 2008) | 2 lines Added gtk printing one more time - I have forgotten to add the main file. ........ r4566 | adamblokus | 2008-07-10 14:57:02 +0200 (Thu, 10 Jul 2008) | 2 lines removed error with comment ........ r4569 | adamblokus | 2008-07-10 15:52:55 +0200 (Thu, 10 Jul 2008) | 5 lines Major style improvements - added a lot of doxygen comments, followed tlsa's style guide. Added some more error checking, too. ........ r4575 | adamblokus | 2008-07-10 18:48:26 +0200 (Thu, 10 Jul 2008) | 2 lines Cleaned up the code. ........ r4687 | adamblokus | 2008-07-17 14:17:19 +0200 (Thu, 17 Jul 2008) | 2 lines Changed everything according to jmb's review plus some minor bug fixes to gtk_print. ........ r4688 | adamblokus | 2008-07-17 17:16:34 +0200 (Thu, 17 Jul 2008) | 2 lines Solved the netsurf.glade clash from r4421. ........ r4693 | adamblokus | 2008-07-18 18:11:51 +0200 (Fri, 18 Jul 2008) | 2 lines Fixed bug with wrong number of pages in gtk printing. ........ r4695 | adamblokus | 2008-07-18 19:59:24 +0200 (Fri, 18 Jul 2008) | 3 lines - fixed uncommented line from the previous commit - fixed bug with scale bigger than 1.0 (incorretly clipped page) ........ r4696 | adamblokus | 2008-07-18 23:28:00 +0200 (Fri, 18 Jul 2008) | 2 lines Fixed bug in gtk_print_font_paint (and nsfont_paint). ........ r4697 | adamblokus | 2008-07-18 23:35:38 +0200 (Fri, 18 Jul 2008) | 2 lines Bug fix in nsfont_paint. ........ r4711 | adamblokus | 2008-07-19 22:44:15 +0200 (Sat, 19 Jul 2008) | 2 lines Added gtk_selection files. ........ r4712 | adamblokus | 2008-07-20 11:15:06 +0200 (Sun, 20 Jul 2008) | 2 lines Addam missing glade files. ........ r4713 | joty | 2008-07-20 17:13:10 +0200 (Sun, 20 Jul 2008) | 1 line Follow change r4517 for RISC OS and BeOS platforms : Added pdf font handling and rendering functions with the use of Haru functions. ........ r4714 | joty | 2008-07-20 18:19:50 +0200 (Sun, 20 Jul 2008) | 1 line Declare haru_nsfont iso define an instance for each C source including the font_haru.h header. This fixes breakage of PDF export on RISC OS. ........ r4724 | adamblokus | 2008-07-23 03:30:08 +0200 (Wed, 23 Jul 2008) | 6 lines Applied changes according to joty's review. Added checking the dimensions of a plotted image to pdf plotter. Commented out jpg embedding (it seems to cause some problems I'll bring it back when I figure out what's wrong) . Added back some files removed by mistake. ........ svn path=/trunk/netsurf/; revision=4741
2008-07-26 20:01:59 +04:00
GUI_SAVE_PDF,
GUI_SAVE_TEXT,
GUI_SAVE_COMPLETE,
GUI_SAVE_OBJECT_ORIG,
GUI_SAVE_OBJECT_NATIVE,
GUI_SAVE_LINK_URI,
GUI_SAVE_LINK_URL,
GUI_SAVE_LINK_TEXT,
GUI_SAVE_HOTLIST_EXPORT_HTML,
GUI_SAVE_HISTORY_EXPORT_HTML,
GUI_SAVE_TEXT_SELECTION,
GUI_SAVE_CLIPBOARD_CONTENTS
} gui_save_type;
typedef enum {
GDRAGGING_NONE,
GDRAGGING_SCROLLBAR,
2013-08-16 11:21:43 +04:00
GDRAGGING_SELECTION,
GDRAGGING_OTHER
} gui_drag_type;
2014-02-09 17:07:39 +04:00
typedef enum {
GW_CREATE_NONE = 0, /* New window */
GW_CREATE_CLONE = (1 << 0), /* Clone existing window */
GW_CREATE_TAB = (1 << 1) /* In same window as existing */
} gui_window_create_flags;
struct gui_window;
struct gui_download_window;
struct browser_window;
struct form_control;
struct ssl_cert_info;
2014-01-30 01:35:53 +04:00
struct hlcache_handle;
struct download_context;
2014-02-01 18:23:58 +04:00
struct nsurl;
struct gui_file_table;
struct gui_llcache_table;
struct gui_search_web_table;
typedef struct nsnsclipboard_styles {
size_t start; /**< Start of run */
plot_font_style_t style; /**< Style to give text run */
} nsclipboard_styles;
/**
* Graphical user interface window function table.
*
* function table implementing window operations
*/
struct gui_window_table {
/* Mandantory entries */
2014-02-09 17:07:39 +04:00
/**
* Create and open a gui window for a browsing context.
*
* \param bw bw to create gui_window for
* \param existing an existing gui_window, may be NULL
* \param flags flags for gui window creation
* \return gui window, or NULL on error
*
* If GW_CREATE_CLONE or GW_CREATE_TAB flags are set, existing is
* non-NULL.
*
* Front end's gui_window must include a reference to the
* browser window passed in the bw param.
*/
struct gui_window *(*create)(struct browser_window *bw,
struct gui_window *existing,
gui_window_create_flags flags);
/** destroy previously created gui window */
void (*destroy)(struct gui_window *g);
/**
* Force a redraw of the entire contents of a window.
*
* @todo this API should be merged with update.
*
* \param g gui_window to redraw
*/
void (*redraw)(struct gui_window *g);
/**
* Redraw an area of a window.
*
* \param g gui_window
* \param rect area to redraw
*/
void (*update)(struct gui_window *g, const struct rect *rect);
/**
* Get the scroll position of a browser window.
*
* \param g gui_window
* \param sx receives x ordinate of point at top-left of window
* \param sy receives y ordinate of point at top-left of window
* \return true iff successful
*/
bool (*get_scroll)(struct gui_window *g, int *sx, int *sy);
/**
* Set the scroll position of a browser window.
*
* \param g gui_window to scroll
* \param sx point to place at top-left of window
* \param sy point to place at top-left of window
*/
void (*set_scroll)(struct gui_window *g, int sx, int sy);
/**
* Find the current dimensions of a browser window's content area.
*
* @todo The implementations of this are buggy and its only
* used from frames code.
*
* \param g gui_window to measure
* \param width receives width of window
* \param height receives height of window
* \param scaled whether to return scaled values
*/
void (*get_dimensions)(struct gui_window *g, int *width, int *height, bool scaled);
/**
* Update the extent of the inside of a browser window to that of the
* current content.
*
* @todo this is used to update scroll bars does it need
* renaming? some frontends (windows) do not even implement it.
*
* \param g gui_window to update the extent of
*/
void (*update_extent)(struct gui_window *g);
/* Optional entries */
/**
* Set the title of a window.
*
* \param g window to update
* \param title new window title
*/
void (*set_title)(struct gui_window *g, const char *title);
/**
* set the navigation url.
*/
void (*set_url)(struct gui_window *g, const char *url);
/** set favicon */
2014-01-30 01:35:53 +04:00
void (*set_icon)(struct gui_window *g, struct hlcache_handle *icon);
/**
* Set the status bar of a browser window.
*
* \param g gui_window to update
* \param text new status text
*/
void (*set_status)(struct gui_window *g, const char *text);
/**
* Change mouse pointer shape
*/
void (*set_pointer)(struct gui_window *g, gui_pointer_shape shape);
/**
* Place the caret in a browser window.
*
* \param g window with caret
* \param x coordinates of caret
* \param y coordinates of caret
* \param height height of caret
* \param clip clip rectangle, or NULL if none
*/
void (*place_caret)(struct gui_window *g, int x, int y, int height, const struct rect *clip);
/**
* Remove the caret, if present.
*
* \param g window with caret
*/
void (*remove_caret)(struct gui_window *g);
/** start the navigation throbber. */
void (*start_throbber)(struct gui_window *g);
/** stop the navigation throbber. */
void (*stop_throbber)(struct gui_window *g);
/** start a drag operation within a window */
bool (*drag_start)(struct gui_window *g, gui_drag_type type, const struct rect *rect);
/** save link operation */
void (*save_link)(struct gui_window *g, const char *url, const char *title);
/**
* Scrolls the specified area of a browser window into view.
*
* @todo investigate if this can be merged with set_scroll
* which is what the default implementation used by most
* toolkits uses.
*
* \param g gui_window to scroll
* \param x0 left point to ensure visible
* \param y0 bottom point to ensure visible
* \param x1 right point to ensure visible
* \param y1 top point to ensure visible
*/
void (*scroll_visible)(struct gui_window *g, int x0, int y0, int x1, int y1);
/**
* Starts drag scrolling of a browser window
*
* \param g the window to scroll
*/
bool (*scroll_start)(struct gui_window *g);
/**
* Called when the gui_window has new content.
*
* \param g the gui_window that has new content
*/
void (*new_content)(struct gui_window *g);
/**
* Called when file chooser gadget is activated
*/
2014-01-30 01:35:53 +04:00
void (*file_gadget_open)(struct gui_window *g, struct hlcache_handle *hl, struct form_control *gadget);
/** object dragged to window*/
2014-01-30 01:35:53 +04:00
void (*drag_save_object)(struct gui_window *g, struct hlcache_handle *c, gui_save_type type);
/** drag selection save */
void (*drag_save_selection)(struct gui_window *g, const char *selection);
/** selection started */
void (*start_selection)(struct gui_window *g);
};
/**
* function table for download windows.
*/
struct gui_download_table {
2014-01-30 01:35:53 +04:00
struct gui_download_window *(*create)(struct download_context *ctx, struct gui_window *parent);
nserror (*data)(struct gui_download_window *dw, const char *data, unsigned int size);
void (*error)(struct gui_download_window *dw, const char *error_msg);
void (*done)(struct gui_download_window *dw);
};
2014-01-15 23:37:05 +04:00
/**
* function table for clipboard operations.
*/
2014-01-15 23:37:05 +04:00
struct gui_clipboard_table {
/**
* Core asks front end for clipboard contents.
*
* \param buffer UTF-8 text, allocated by front end, ownership yeilded to core
* \param length Byte length of UTF-8 text in buffer
*/
void (*get)(char **buffer, size_t *length);
2014-01-15 23:37:05 +04:00
/**
* Core tells front end to put given text in clipboard
*
* \param buffer UTF-8 text, owned by core
* \param length Byte length of UTF-8 text in buffer
* \param styles Array of styles given to text runs, owned by core, or NULL
* \param n_styles Number of text run styles in array
*/
void (*set)(const char *buffer, size_t length, nsclipboard_styles styles[], int n_styles);
};
/**
* function table for fetcher operations
2014-01-15 23:37:05 +04:00
*/
struct gui_fetch_table {
/* Mandantory entries */
/**
* Determine the MIME type of a local file.
*
* @note used in file fetcher
*
* \param unix_path Unix style path to file on disk
* \return Pointer to MIME type string (should not be freed) -
* invalidated on next call to fetch_filetype.
*/
const char *(*filetype)(const char *unix_path);
/* Optional entries */
2014-01-15 03:31:54 +04:00
/**
* Callback to translate resource to full url.
*
* @note used in resource fetcher
*
2014-01-15 03:31:54 +04:00
* Transforms a resource: path into a full URL. The returned URL
* is used as the target for a redirect. The caller takes ownership of
* the returned nsurl including unrefing it when finished with it.
*
* \param path The path of the resource to locate.
* \return A string containing the full URL of the target object or
* NULL if no suitable resource can be found.
*/
2014-02-01 18:23:58 +04:00
struct nsurl* (*get_resource_url)(const char *path);
/**
* Find a MIME type for a local file
*
* @note only used in curl fetcher on RISC OS otherwise its a
* strdup of filetype.
*
* \param ro_path RISC OS style path to file on disk
* \return MIME type string (on heap, caller should free), or NULL
*/
char *(*mimetype)(const char *ro_path);
};
2014-01-30 01:35:53 +04:00
/**
* User interface utf8 characterset conversion routines.
2014-01-30 01:35:53 +04:00
*/
struct gui_utf8_table {
/**
* Convert a UTF-8 encoded string into the system local encoding
*
* \param string The string to convert
* \param len The length (in bytes) of the string, or 0
* \param result Pointer to location in which to store result
* \return An nserror code
*/
nserror (*utf8_to_local)(const char *string, size_t len, char **result);
/**
* Convert a string encoded in the system local encoding to UTF-8
*
* \param string The string to convert
* \param len The length (in bytes) of the string, or 0
* \param result Pointer to location in which to store result
* \return An nserror code
*/
nserror (*local_to_utf8)(const char *string, size_t len, char **result);
};
/**
* function table for page text search.
*/
struct gui_search_table {
/**
* Change the displayed search status.
*
* \param found search pattern matched in text
* \param p gui private data pointer provided with search callbacks
*/
void (*status)(bool found, void *p);
/**
* display hourglass while searching.
*
* \param active start/stop indicator
* \param p gui private data pointer provided with search callbacks
*/
void (*hourglass)(bool active, void *p);
/**
* add search string to recent searches list
* front has full liberty how to implement the bare notification;
* core gives no guarantee of the integrity of the string
*
* \param string search pattern
* \param p gui private data pointer provided with search callbacks
*/
void (*add_recent)(const char *string, void *p);
/**
* activate search forwards button in gui
*
* \param active activate/inactivate
* \param p gui private data pointer provided with search callbacks
*/
void (*forward_state)(bool active, void *p);
/**
* activate search back button in gui
*
* \param active activate/inactivate
* \param p gui private data pointer provided with search callbacks
*/
void (*back_state)(bool active, void *p);
};
/**
* Graphical user interface browser misc function table.
*
* function table implementing GUI interface to miscelaneous browser
* functionality
*/
struct gui_browser_table {
/* Mandantory entries */
/**
* called to let the frontend update its state and run any
* I/O operations.
*/
void (*poll)(bool active);
/**
* Schedule a callback.
*
* \param t interval before the callback should be made in ms or
* negative value to remove any existing callback.
* \param callback callback function
* \param p user parameter passed to callback function
* \return NSERROR_OK on sucess or appropriate error on faliure
*
* The callback function will be called as soon as possible
* after the timeout has elapsed.
*
* Additional calls with the same callback and user parameter will
* reset the callback time to the newly specified value.
*
*/
nserror (*schedule)(int t, void (*callback)(void *p), void *p);
/* Optional entries */
/** called to allow the gui to cleanup */
void (*quit)(void);
2014-01-15 03:31:54 +04:00
/**
* core has no fetcher for url
*/
nserror (*launch_url)(struct nsurl *url);
2014-01-15 23:37:05 +04:00
2014-01-15 03:31:54 +04:00
/**
* create a form select menu
*/
void (*create_form_select_menu)(struct browser_window *bw, struct form_control *control);
2014-01-15 03:31:54 +04:00
/**
* verify certificate
*/
2014-02-01 18:23:58 +04:00
void (*cert_verify)(struct nsurl *url, const struct ssl_cert_info *certs, unsigned long num, nserror (*cb)(bool proceed, void *pw), void *cbpw);
/**
2014-01-16 04:52:17 +04:00
* Prompt user for login
*/
2014-02-01 18:23:58 +04:00
void (*login)(struct nsurl *url, const char *realm,
2014-01-16 04:52:17 +04:00
nserror (*cb)(bool proceed, void *pw), void *cbpw);
2014-01-15 03:31:54 +04:00
};
/**
* NetSurf operation function table
2014-01-15 23:37:05 +04:00
*
* Function table implementing interface operations for the browser core.
2014-01-15 23:37:05 +04:00
*/
struct netsurf_table {
2014-01-15 23:37:05 +04:00
/**
* Browser table.
2014-01-30 01:35:53 +04:00
*
* Provides miscellaneous browser functionality. The table
* is mandantory and must be provided.
*/
2014-01-15 23:37:05 +04:00
struct gui_browser_table *browser;
/** Window table */
struct gui_window_table *window;
2014-01-15 23:37:05 +04:00
/** Download table */
struct gui_download_table *download;
2014-01-15 23:37:05 +04:00
/** Clipboard table */
struct gui_clipboard_table *clipboard;
/** Fetcher table */
struct gui_fetch_table *fetch;
2014-01-30 01:35:53 +04:00
/**
* File table
*
* Provides file and filename operations to the core. The
* table is optional and may be NULL in which case the default
* posix compliant operations will be used.
*/
struct gui_file_table *file;
/**
* UTF8 table.
2014-01-30 01:35:53 +04:00
*
* Provides for conversion between the gui local character
* encoding and utf8. The table optional and may be NULL which
* implies the local encoding is utf8.
*/
struct gui_utf8_table *utf8;
/**
* Page search table.
*
* Provides routines for the interactive text search on a page.
*/
struct gui_search_table *search;
/**
* Web search table.
*
* Used by the web search provider system. The table is
* optional and may be NULL which uses the default empty
* implementation.
*/
struct gui_search_web_table *search_web;
/**
* Low level cache table.
*
* Used by the low level cache to push objects to persistant
* storage. The table is optional and may be NULL which
* uses the default implementation.
*/
struct gui_llcache_table *llcache;
2014-01-15 23:37:05 +04:00
};
#endif