diff options
| -rw-r--r-- | AUTHORS | 5 | ||||
| -rw-r--r-- | README | 1005 | ||||
| -rw-r--r-- | examples/config/config | 8 | ||||
| -rw-r--r-- | examples/data/scripts/follow.js (renamed from examples/data/scripts/follow_Numbers.js) | 76 | ||||
| -rw-r--r-- | examples/data/scripts/follow_Numbers_Strings.js | 212 | ||||
| -rw-r--r-- | examples/data/scripts/follower.js | 420 | ||||
| -rw-r--r-- | src/uzbl-core.c | 6 | ||||
| -rw-r--r-- | tests/test-command.c | 4 | ||||
| -rw-r--r-- | tests/test-expand.c | 4 |
9 files changed, 1100 insertions, 640 deletions
@@ -29,6 +29,7 @@ In alphabetical order: Chris Mason - code snippets such as basic cookie handler Chris van Dijk (quigybo) - work on uzbl_tabbed.py Damien Leon - misc + Daniel M. Hackney - documentation cleanups David Keijser - various C and python patches. Devon Jones <devon.jones@gmail.com> - uzbl_tabbed: bring_to_front Dieter Plaetinck (Dieter@be) <dieter AT plaetinck.be> - several contributions @@ -39,7 +40,7 @@ In alphabetical order: Jake Probst <jake.probst@gmail.com> - uzbl_tabbed: multiline tablist James S Wheaton (uranther) - zoom level, test framework Jan Kolkmeier (jouz) - scrolling, link following - Jason Woofenden (JasonWoof) - geometry=maximized + Jason Woofenden (JasonWoof) - geometry=maximized, link following Laurence Withers (lwithers) - talk_to_socket Mark Nevill - misc patches Mason Larobina - uzbl-tabbed.py, cookie-daemon, event-manager&plugins, ... @@ -49,7 +50,7 @@ In alphabetical order: Moritz Lenz - small doc fix Nicolas Pouillard - refactored scroll command Olivier Schwander - auto file:// prepend - Paweł Zuzelski (pawelz) - download handler proxy patch + Paweł Zuzelski (pawelz) - http auth handler, misc patches Peter Suschlik - backwards searching Přemysl Hrubý (anydot) <email is dfenze AT gmail.com> - several C contributions and cleanups Robert Manea (robm) <email is rob DOT manea AT gmail DOT com> - C code all over the place @@ -1,334 +1,449 @@ ### INTRODUCTION - Any program can only be really useful if it complies to the unix philosophy. - Web browsers (and other tools that work with html, such as feedreaders) are frequent violators of this principle: -* They build in way too much things into one (complex) program, dramatically decreasing the options to do things the way you want. -* They store things in way too fancy formats (xml, rdf, sqlite, ... ) which are hard to store under version control, reuse in other scripts, ... +Any program can only be really useful if it complies with the Unix +philosophy. Web browsers (and other tools that work with HTML, such as feed +readers) are frequent violators of this principle: -The uzbl project was started as an attempt to resolve this. +* They build in way too much things into one (complex) program, dramatically + decreasing the options to do things the way you want. +* They store things in way too fancy formats (XML, RDF, SQLite, etc.) which are + hard to store under version control, reuse in other scripts, and so on. + +The Uzbl project was started as an attempt to resolve this. ### EDITIONS -"Uzbl" is an umbrella-project consisting of different flavors. -In the future more things may come, but for now: +"Uzbl" is an umbrella project consisting of different flavors. In the future +more things may come, but for now: #### uzbl-core: main component meant for integration with other tools and scripts - * Uses WebkitGtk+ for rendering, network interaction (libsoup). Css, javascript, plugin support etc come for free - * Provides interfaces to get data in (commands/configuration) and out (events): stdin/stdout/fifo/unix sockets - * You see a webkit view and (optionally) a statusbar which gets popuplated externally - * No built-in means for url changing, loading/saving of bookmarks, saving history, keybinds, downloads, ... - * Extra functionality: many sample scripts come with it, on <a href="http://www.uzbl.org/wiki/scripts">uzbl wiki</a> or write them yourself - * Entire configuration/state can be changed at runtime - * Uzbl keeps it simple, and puts <strong>you</strong> in charge. +* Uses WebKitGtk+ for rendering and network interaction (libsoup). CSS, + JavaScript, and plugin support come for free. +* Provides interfaces to get data in (commands/configuration) and out (events): + stdin/stdout/fifo/Unix sockets. +* You see a WebKit view and (optionally) a statusbar which gets populated + externally. +* No built-in means for URL changing, loading/saving of bookmarks, saving + history, keybinds, downloads, etc. +* Extra functionality: many sample scripts come with it. More are available on + the [Uzbl wiki](http://www.uzbl.org/wiki/scripts) or you can write them + yourself. +* Entire configuration/state can be changed at runtime. +* Uzbl keeps it simple, and puts **you** in charge. #### uzbl-browser: a complete browser experience based on uzbl-core - * Uses a set of scripts (mostly python) that will fit most people, so things work out of the box. Yet plenty of room for customisation - * Brings everything you expect: url changing, history, downloads, form filling, link navigation, cookies, event management etc. However: one page per instance - * Advanced, customizable keyboard interface with support for modes, modkeys, multichars, variables (keywords) etc. (eg you can tweak the interface to be vim-like, emacs-like or any-other-program-like) - * Adequate default configuration - * Focus on plaintext storage for your data and configs in simple, parseable formats and adherence to the xdg basedir spec - * Visually, similar to uzbl-core except that the statusbar contains useful things. One window per webpage +* Uses a set of scripts (mostly Python) that will fit most people, so things + work out of the box; yet plenty of room for customization. +* Brings everything you expect: URL changing, history, downloads, form filling, + link navigation, cookies, event management etc. However: one page per + instance. +* Advanced, customizable keyboard interface with support for modes, modkeys, + multichars, variables (keywords) etc. (eg you can tweak the interface to be + Vi-like, Emacs-like or any-other-program-like). +* Adequate default configuration. +* Focus on plaintext storage for your data and configs in simple, parseable + formats and adherence to the XDG basedir spec. +* Visually, similar to `uzbl-core` except that the statusbar contains useful + information. One window per webpage. #### uzbl-tabbed: wraps around uzbl-browser and multiplexes it - * Spawns one window containing multiple tabs, each tab containing a full embedded uzbl-browser - * Ideal as a quick and simple solution to manage multiple uzbl-browser instances without getting lost +* Spawns one window containing multiple tabs, each tab containing a full + embedded `uzbl-browser`. +* Ideal as a quick and simple solution to manage multiple `uzbl-browser` + instances without getting lost. +Throughout the documentation, when referring to `uzbl` we mean `uzbl-core`, +unless otherwise specified. -Throughout the documentation, when referring to `uzbl` we mean uzbl-core, unless otherwise specified. +### CONFIGURATION / CONTROL: +The general idea is that Uzbl by default is very bare bones. You can send it +commands to update settings and perform actions, through various +interfaces. There is a limited default configuration. Please see `config.h` to +see what it contains. By default, there are *no* keybinds defined at +all. (Default keybinds would work counterproductive when you try to +customize). For examples of the possibilities what you can do, please see the +sample config(s), and uzbl wiki page. -### CONFIGURATION / CONTROL: -The general idea is that uzbl by default is very bare bones. You can send it commands to update settings and perform actions, through various interfaces. -There is a limited default configuration. Please see config.h to see what it contains. -By default, there are *no* keybinds defined at all. (Default keybinds would work counterproductive when you try to customize) -For examples of the possibilities what you can do, please see the sample config(s), and uzbl wiki page. -There are several interfaces to interact with uzbl: - -* uzbl --config <filename>: <filename> will be read line by line, and the commands in it will be executed. Useful to configure uzbl at startup. - If you have a file in `$XDG_CONFIG_HOME/uzbl/config` (this expands to ~/.config/uzbl/config on most systems) it will be automatically recognized -* stdin: to write commands into stdin, use `--config -` (or `-c -`) -* interactive: you can enter commands (and bind them to shortcuts, even at runtime) - By default, the behaviour is modal (vi style): - command mode: every keystroke is interpreted to run commands - insert mode: keystrokes are not interpreted so you can enter text into html forms - But if you don't like modal interfaces, you can set `always_insert_mode` and configure a modkey to execute the commands. (emacs style). - There is also support for "chained" commands (multiple characters long) (with backspace/esc shortcuts), and keyworded commands. - Also you can have incremental matching on commands or match after pressing return. (see sampleconfig for more info) - Also, copy paste works when typing commands: - * insert (paste X cliboard) - * shift insert (paste primary selection buffer) -* FIFO & socket file: if enabled by setting their paths through one of the above means, you can have socket and fifo files available which are very useful to programatically control uzbl (from scripts etc). - The advantage of the fifo is you can write plaintxt commands to it, but it's half duplex only (uzbl cannot send a response to you). - The socket is full duplex but you need a socket-compatible wrapper such as socat to work with it. - For example: echo <command> | socat - unix-connect:<socketfile> - -When uzbl forks a new instance (eg "open in new window") it will use the same commandline arguments (eg the same --config <file>), except --uri and--name. -If you made changes to the configuration at runtime, these are not passed on to the child. +There are several interfaces to interact with Uzbl: + +* `uzbl --config <filename>`: `<filename>` will be read line by line, and the + commands in it will be executed. Useful to configure Uzbl at startup. If you + have a file in `$XDG_CONFIG_HOME/uzbl/config` (this expands to + `~/.config/uzbl/config` on most systems), it will be automatically recognized. +* `stdin`: to write commands into `stdin`, use `--config -` (or `-c -`). +* Interactive: you can enter commands (and bind them to shortcuts, even at + runtime) By default, the behaviour is modal (Vi style): + + - command mode: every keystroke is interpreted to run commands + - insert mode: keystrokes are not interpreted so you can enter text into html + forms + + There is also support for "chained" commands (multiple characters long), and + keyworded commands. Also you can have incremental matching on commands or + match after pressing return. See the sample configuration file for more info. + Also, copy and paste works when typing commands: + + - `insert` (paste X cliboard) + - `shift insert` (paste primary selection buffer) + +* FIFO & socket files: If enabled by setting their paths through one of the + above means, you can have socket and fifo files available which are very + useful to programmatically control `uzbl` (from scripts etc). + + - The advantage of the FIFO is you can write plaintext commands to it, but + it's half duplex only (`uzbl` cannot send a response to you). + - The socket is full duplex but you need a socket-compatible wrapper such as + `socat` to work with it. For example: + + echo <command> | socat - unix-connect:<socketfile> + +When `uzbl` forks a new instance (eg "open in new window") it will use the same +command line arguments (eg the same `--config <file>`), except `--uri` and +`--name`. If you made changes to the configuration at runtime, these are not +passed on to the child. #### Uzbl-browser -- default config -- EM -- EM plugins -- bindings/events/requests + +* default config +* Event Manager +* Event Manager plugins +* bindings/events/requests #### Uzbl-tabbed -- also has some own keybindings +* also has some of its own keybindings. ### COMMAND SYNTAX -Uzbl will read commands via standard input, named fifo pipe (if `fifo_dir` is set) and IPC socket (when `socket_dir` is set). -For convenience, uzbl can also be instructed to read commands from a file on startup by using the `-c` option. Indeed, the config file is nothing more than a list of commands. -Each command starts with the name of the command or an uzbl variable that expands to it. A command is terminated by a newline. -Empty lines and lines that start with the hash sign are ignored by the parser. Command names are always written in lowercase. +Uzbl will read commands via standard input, named FIFO pipe (if `fifo_dir` is +set) and Unix socket (when `socket_dir` is set). For convenience, `uzbl` can +also be instructed to read commands from a file on startup by using the +`--config` option. Indeed, the config file is nothing more than a list of +commands. + +Each command starts with the name of a command or a `uzbl` variable that expands +to it. A command is terminated by a newline. Empty lines and lines that start +with the hash sign are ignored by the parser. Command names are always written +in lowercase. The following commands are recognized: -* `set <key> = <value>` - - used for changing variables on the fly - - the changes are effective immediately; for example, setting the variable `uri` will make uzbl start loading, and changing `status_format` will make the status bar react immediately - - if you want to unset a string, use `set` with one space after the equals sign -* `print @<key>` - - use this to print the value of a variable. * `back` + - Navigate to the previous URI in the history. * `forward` + - Navigate to the next URI in the history. * `scroll <vertical|horizontal> <argument>` - - argument can be `begin`, `end`, or an amount given in pixels(?) - or as a percentage of the size of the view - - set the amount to 100% to scroll a whole page + - argument can be `begin`, `end`, or an amount given in pixels(?) or as a + percentage of the size of the view + - set the amount to 100% to scroll a whole page * `reload` + - Reload the current page. * `reload_ign_cache` + - Reload the current page, discarding any cached resources. * `stop` + - Stop loading the current page. * `zoom_in` + - Increase the zoom level. * `zoom_out` + - Decrease the zoom level. +* `toggle_zoom_type` + - Toggles the variable `zoom_type` between "full-content" and "text-only" + zoom. In "text-only" zoom, only the text of the page is zoomed, while in + "full-content" zoom, images and other page elements are zoomed along with + the text. * `uri <address>` + - Attempt to load `<address>`. This is equivalent to `set uri = <address>`. * `js <body>` - - execute the javascript in `<body>` - - remember that the commands must not contain line breaks + - Execute the JavaScript in `<body>`. + - Remember that the commands must not contain line breaks. * `script <file>` - - execute the javascript in `<file>` + - Execute the JavaScript in `<file>`. * `toggle_status` + - Toggle the display of the status bar. * `spawn <executable> <additional args>` TODO explain path-alike expansion - - runs a command; see EXTERNAL SCRIPTS for details - - PATH is searched so giving the full path to commands is not necessary - - note that the arguments as specified in "EXTERNAL SCRIPTS" are appended at the end, so the argument numbers will be higher. -* `sh <command>` - - runs a shell command by expanding `%s` in the `shell_cmd` variable with the specified command; primarily useful as a shortcut for `spawn sh -c <body>` - - note that the arguments as specified in "EXTERNAL SCRIPTS" are appended at the end, so the argument numbers will be higher. + - Runs a command; see EXTERNAL SCRIPTS for details. + - `$PATH` is searched, so giving the full path to commands is not necessary. + - Note that the arguments as specified in "EXTERNAL SCRIPTS" are appended at + the end, so the argument numbers will be higher. * `sync_spawn <executable> <additional args>` + - A synchronous variant of `spawn`, which means `uzbl` will wait for it to + return. + - You should only need to use this manually if you want to use a `chain` + command in a handler that wants output from the command it runs. +* `sh <command>` + - Runs a shell command by expanding `%s` in the `shell_cmd` variable with the + specified command; primarily useful as a shortcut for `spawn sh -c + <command>` + - Note that the arguments as specified in "EXTERNAL SCRIPTS" are appended at + the end, so the argument numbers will be higher. * `sync_sh <command>` - - these are synchronous variants of `spawn` and `sh`, which means uzbl will wait for them to return - - you should only need to use these manually if you want to use a chain command in a handler that wants output from the command it runs -* `talk_to_socket <socketfile> <tokens/command>` - - lets uzbl talk to a socketfile + - Synchronous version of `sh`, See `sync_spawn`. +* `talk_to_socket <socketfile> <tokens>` + - Send a message to `<socketfile>` and wait for a response. `<tokens>` are + concatenated and separated by ASCII NUL bytes. + - Expects the socket type to be `SOCK_SEQPACKET` (see `connect(2)`). + - Waits for 500ms for a response. * `exit` + - Closes `uzbl`. * `search <string>` + - Search forward for `<string>`. With no string, search for the next + occurrence of the previously searched string. * `search_reverse <string>` - - search with no string will search for the next/previous occurrence of the string previously searched for + - Like `search`, but searches backward. * `search_clear` - - unmark and clear the search string -* `toggle_insert_mode <optional state>` TODO new plugin based syntax - - if the optional state is 0, disable insert mode. If 1, enable insert mode. + - Dehighlight matches and clear the search string. +* `dehilight` + - Remove highlighting of search matches. +* `set <key> = <value>` + - Sets `<key>` to `<value>`. + - The changes are effective immediately; for example, setting the variable + `uri` will make `uzbl` start loading, and changing `status_format` will make + the status bar react immediately. + - If you want to unset a string, use `set` with one space after the equals + sign. * `dump_config` - - dumps your current config (which may have been changed at runtime) to stdout, in a format you can use to pipe into uzbl again (or use as config file) -* `keycmd <string>` -* `keycmd_nl <string>` - - keycmd sets the interactive command buffer to `<string>`. If the given string is a valid binding, it will execute. `Keycmd_nl` is like `keycmd`, but it also emulates a press of return, causing bindings with a parameter to execute. For example, `keycmd_nl o google.com` would load the said url if you have a binding like `bind o _ = uri %s`. -* `keycmd_bs` - - erase (backspace) one character from the command buffer -* `chain <command> <command> ..` - - use for chaining multiple commands - - remember to quote the commands; one command must come as one parameter - - if you use `chain` with a handler script which must return some output (such as a cookie handler -- uzbl will wait for and use its output), use sync_spawn or sync_sh instead of spawn or sh in the command that should give the output + - Dumps the current config (which may have been changed at runtime) to stdout. + - Uses a format which can be piped into `uzbl` again or saved as a config + file. +* `dump_config_as_events` + - Dump the current config as a series of `VARIABLE_SET` events, which can be + handled by an event manager. +* `chain <command> <command> ...` + - Used for chaining multiple commands. + - Remember to quote the commands; one command must come as one parameter. + - If you use `chain` with a handler script which must return some output (such + as a cookie handler -- `uzbl` will wait for and use its output), use + `sync_spawn` or `sync_sh` instead of `spawn` or `sh` in the command that + should give the output. +* `print <string>` + - Expands variables in `<string>` and prints its output to stdout. Is useful + for getting the value of variables. * `event <event_name> [event_details]` - - send custom event + - Send a custom event. * `request <request_name> [request_details]` - - send custom request (same idea as events, but to be processed by EM, not uzbl-core) -* `menu_add <label> = <uzbl command>` -* `menu_link_add <label> = <uzbl command>` -* `menu_image_add <label> = <uzbl command>` -* `menu_editable_add <label> = <uzbl command>` - - add a new entry "label" that will execute "uzbl command" to one of the right click context menus -* `menu_separator <label>` -* `menu_link_separator <label>` -* `menu_image_separator <label>` + - Send a custom request (same idea as events, but to be processed by the event + manager, not `uzbl-core`). +* `menu_add <label> = <command>` + - Add a new entry `<label>` to the default right-click menu that will execute + `<command>`. +* `menu_link_add <label> = <command>` + - Add a new entry `<label>`, executing `<command>` to the right-click menu for + links. +* `menu_image_add <label> = <command>` + - Same as `menu_add`, but for images. +* `menu_editable_add <label> = <command>` + - Same as `menu_add`, but for editable text areas. +* `menu_separator <label>` + - Add a separator, named `<label>` to the default right-click menu. +* `menu_link_separator <label>` + - Same as `menu_separator`, but for links. +* `menu_image_separator <label>` + - Same as `menu_separator`, but for images. * `menu_editable_separator <label>` - - adds a separator line to one of the right click context menus -* `menu_remove <label>` -* `menu_link_remove <label>` -* `menu_image_remove <label>` + - Same as `menu_separator`, but for editable text areas. +* `menu_remove <label>` + - Removes the menu entry `<label>` from the default right-click menu. +* `menu_link_remove <label>` + - Same as `menu_remove`, but for links. +* `menu_image_remove <label>` + - Same as `menu_remove`, but for images. * `menu_editable_remove <label>` - - removes the entry "label" from one of the right click context menus + - Same as `menu_remove`, but for editable text areas. * `hardcopy` - - open print dialog + - Open the print dialog. * `include <file>` - - read contents of file and interpret commands - + - Read contents of `<file>` and interpret as a set of `uzbl` commands. ### VARIABLES AND CONSTANTS -Uzbl has a lot of internal variables and constants. You can get the values (using the `print` command, see above), and for variables you can also change the value at -runtime. Some of the values can be passed at start up through commandline arguments, others need to be set by using commands (eg in config file). -Some of them have default values (see config.h) -Some variables have callback functions which will get called after setting the variable to perform some additional logic (see below) - -Besides the builtin variables you can also define your own ones and use them in the exact same way as the builtin ones. - -* Variables: - - `uri`: (callback: load the uri) - - `verbose`: affects output on stdout - - `inject_html` - - `keycmd`: holds the input buffer (callback: update input buffer) - - `status_message`: (callback: update title) - - `show_status`: show statusbar or not - - `status_top`: statusbar on top? - - `status_format`: marked up, to be expanded string for statusbar (callback: update statusbar) - - `status_pbar_done`: character to denote done % of pageload - - `status_pbar_pending`: character to denote pending % of pageload - - `status_pbar_width`: width of progressbar - - `status_background`: color which can be used to override Gtk theme. - - `insert_indicator`: string to denote insert mode TODO plugin variable - - `command_indicator`: string to denote command mode TODO plugin variable - - `title_format_long`: titlebar string when no statusbar shown (will be expanded - - `title_format_short`: titlebar string when statusbar shown (will be expanded) - - `icon`: path to icon for Gtk - - `forward_keys`: whether uzbl-core should send key events to the webkit view - - `insert_mode`: whether insert mode is active TODO explain plugin variable - - `always_insert_mode`: set this to true if you don't like modal (vim-like) interfaces TODO explain plugin variable - - `reset_command_mode`: automatically revert to command mode on pageload (unless always_insert_mode is set) TODO explain plugin variable - - `modkey`: modkey which can be pressed to activate keybind from inside insert mode - - `download_handler` - - `cookie_handler` - - `new_window`: handler to execute to invoke new uzbl window (TODO better name) - - `scheme_handler`: handler to execute for each URI navigated to - the navigation request will be ignored if handler prints "USED\n" - - `authentication_handler`: command that handles http authentication - - `fifo_dir`: location to store fifo's - - `socket_dir`: location to store sockets - - `print_events`: show events on stdout - - `http_debug`: http debug mode (value 0-3) - - `shell_cmd`: alias which will be expanded to use shell commands (eg sh -c) - - `proxy_url`: http traffic socks proxy (eg: http://<host>:<port>) - - `max_conns`: max simultaneous connections (default: 100) - - `max_conns_host`: max simultaneous connections per hostname (default: 6) - - `useragent`: to be expanded string - - `zoom_level` - - `font_size` - - `monospace_size` - - `minimum_font_size` - - `disable_plugins` (TODO rename to enable) - - `disable_scripts` (TODO rename to enable) - - `autoload_images` - - `autoshrink_images`: shrink images to window size (default 0) - - `enable_spellcheck` - - `enable_private` - - `print_backgrounds`: print background images? (default 0) - - `stylesheet_uri`: use this to override the pagelayout with a custom stylesheet - - `resizable_text_areas` - - `default_encoding`: iso-8859-1 by default - - `enforce_96_dpi`: 1 by default - - `caret_browsing` - - `default_font_family` = sans-serif - - `monospace_font_family` = monospace (example "Aerial Mono" ) - - `cursive_font_family` = sans - - `fantasy_font_family` = "Pterra" - - `serif_font_family` = serif (example "DejaVu Serif") - - `sans_serif_font_family` = sans (example "DejaVu Sans") - - `scrollbars_visible`: set to 1 to have GTK scrollbars if the document doesn't fit into the window (defaults to 0) - - -* Constants (not dumpable or writeable): - - WEBKIT_MAJOR: set at compile time - - WEBKIT_MINOR: set at compile time - - WEBKIT_MICRO: set at compile time - - ARCH_UZBL: set at compile time - - COMMIT: set at compile time - - LOAD_PROGRESS - - LOAD_PROGRESSBAR - - TITLE - - SELECTED_URI - - MODE - - NAME: name of the uzbl instance (TODO: can't we make this a variable?) - * default: Xorg window id - * overridable with cmdline arg - * in GtkSocket mode, this is a random number to prevent name clashes - - -### VARIABLE EXPANSION AND COMMAND/JAVA SCRIPT SUBSTITUTION - -Variable expansion works pretty much as known from shell interpreters (sh, bash, etc.). This means you can -construct strings with uzbl variables in them and have uzbl replace the variable name with its contents. - -In order to let uzbl know what to expand you'll need to prepend @ to the variable name: + +Uzbl has a lot of internal variables and constants. You can get the values +(using the `print` command, see above), and for variables you can also change +the value at runtime. Some of the values can be passed at start up through +commandline arguments, others need to be set by using commands (eg in config +file). + +* Some of them have default values (see config.h) +* Some variables have callback functions which will get called after setting the + variable to perform some additional logic (see below). +* Besides the builtin variables you can also define your own ones and use them + in the exact same way as the builtin ones. + +#### Variables + +* `uri`: The URI of the current page. (callback: load the uri) +* `verbose`: Controls the verbosity printed to `stdout`. +* `inject_html`: Inject an HTML string, navigating to the URI "about:blank" and + rendering the HTML sting given. +* `geometry`: Geometry and position of the Uzbl window. Format is + "<width>x<height>+<x-offset>+<y-offset>". +* `keycmd`: Holds the input buffer (callback: update input buffer). +* `show_status`: Show statusbar or not. +* `status_top`: statusbar on top? +* `status_format`: Marked up, to be expanded string for statusbar (callback: + update statusbar). +* `status_background`: color which can be used to override Gtk theme. +* `title_format_long`: titlebar string when no statusbar shown (will be + expanded). +* `title_format_short`: titlebar string when statusbar shown (will be expanded). +* `icon`: path to icon for Gtk. +* `forward_keys`: Whether `uzbl-core` should send key events to the webkit view. +* `download_handler`: Handler called when page requests a download. In addition + to the standard handler arguments, appends the following extra arguments: + - `url`: The URL of the item to be downloaded. + - `proxy`: (optional) The URL of an HTTP proxy. +* `cookie_handler`: Handler called when the page requests a cookie to be + retrieved or set. Appends the following arguments to the standard handler + arguments. + - `op`: Either "GET" if the browser requests a cookie to be sent to the server + or "PUT" if the server requests the browser save a cookie. + - `scheme`: The request address scheme ("http" or "https"). + - `host`: The host requesting the cookie. + - `path`: The request address path. + - `data`: The cookie data. Only included for "PUT" requests. +* `new_window`: handler to execute to invoke new uzbl window (TODO better name) +* `scheme_handler`: handler to execute for each URI navigated to - the + navigation request will be ignored if handler prints "USED\n" +* `fifo_dir`: location to store FIFOs. +* `socket_dir`: location to store sockets. +* `http_debug`: HTTP debug mode (value 0-3). +* `scrollbars_visible`: set to 1 to have GTK scrollbars if the document + doesn't fit into the window (defaults to 0) +* `shell_cmd`: Alias which will be expanded to use shell commands (eg `sh -c`). +* `print_events`: show events on stdout +* `proxy_url`: HTTP traffic SOCKS proxy (eg: `http://<host>:<port>`). +* `max_conns`: Max simultaneous connections (default: 100). +* `max_conns_host`: max simultaneous connections per hostname (default: 6) +* `view_source`: Set the browser in "view source" mode (default 0). Any URI + visited while "view_source" is 1 will display the page source rather than the + rendered content. +* `useragent`: The User-Agent to send to the browser, expands variables in its + definition. +* `zoom_level`: The factor by which elements in the page are scaled with respect + to their original size. Setting this will resize the currently displayed page. +* `zoom_type`: Whether to use "full-content" zoom (defaults to true). With + full-content zoom on, all page content, not just text, is zoomed. When + full-content zoom is off, only the text of a page is zoomed. +* `font_size`: The default font size. +* `default_font_family`: The default font family used to display text. +* `monospace_font_family`: The default font family used to display monospace + text. +* `cursive_font_family`: The default Cursive font family used to display text. +* `sans_serif_font_family`: The default Sans Serif font family used to display + text. +* `serif_font_family`: The default Serif font family used to display text. +* `fantasy_font_family`: The default Fantasy font family used to display text. +* `monospace_size`: The default size of monospaced font (default 1). +* `minimum_font_size`: The minimum font size used to display text (default 1). +* `disable_plugins`: Disable embedded plugin objects (default 0). +* `disable_scripts`: Disable embedded scripting languages (default 0). +* `autoload_images`: Automatically load images (default 1). +* `autoshrink_images`: Shrink images to window size (default 0). +* `enable_spellcheck`: Whether to enable spell checking while typing (default + 0). +* `enable_private`: Whether to enable private browsing mode (default 0). +* `print_backgrounds`: Print background images? (default 0). +* `stylesheet_uri`: Use this to override the pagelayout with a custom + stylesheet. +* `resizable_text_areas`: Whether text areas can be resized (default 0). +* `default_encoding`: The default text encoding (default "iso-8859-1"). +* `enforce_96_dpi`: Enforce a resolution of 96 DPI (default 1). +* `caret_browsing`: Whether the caret is enabled in the text portion of pages + (default 0). +* `follow_hint_keys`: keys for keyboard-based navigation and link + highlighting + +#### Constants (not dumpable or writeable) + +* `WEBKIT_MAJOR`: WebKit major version number, set at compile time. +* `WEBKIT_MINOR`: WebKit minor version number, set at compile time. +* `WEBKIT_MICRO`: WebKit micro version number, set at compile time +* `ARCH_UZBL`: Processor architecture for which Uzbl is compiled, set at compile + time. +* `COMMIT`: ID of the current Git commit, set at compile time. +* `TITLE`: The current page title or "(no title)" if no title exists for the + current page. +* `SELECTED_URI`: The URL currently hovered over by the mouse. +* `NAME`: name of the uzbl instance (TODO: can't we make this a variable?) + - default: Xorg window id + - overridable with cmdline arg + - in GtkSocket mode, this is a random number to prevent name clashes +* `PID`: The process ID of this Uzbl instance. + +### VARIABLE EXPANSION AND COMMAND / JAVASCRIPT SUBSTITUTION + +Variable expansion works pretty much as known from shell interpreters (sh, bash, +etc.). This means you can construct strings with uzbl variables in them and have +uzbl replace the variable name with its contents. + +In order to let uzbl know what to expand you'll need to prepend @ to the +variable name: print The variable \@show_status contains @show_status The above example demonstrates two things: - * '\' is treated as escape character and will use the character immediately following it literally - this means '\@show_status' will not expand to the variable content but be rather printed as - '@show_status' - - * prepending the variable with '@' will expand to its contents - - * like in the shell you can use @{uzbl_var} to denote the beginning/end of the variable name in - cases where it is not obvious what belongs to the name and what not. - E.g.: print @{show_status}foobar +* `\` is treated as escape character and will use the character immediately + following it literally this means `\@show_status` will not expand to the + variable content but be rather printed as `@show_status` +* prepending the variable with `@` will expand to its contents +* like in the shell you can use `@{uzbl_var}` to denote the beginning/end of the + variable name in cases where it is not obvious what belongs to the name and + what not. E.g. `print @{show_status}foobar` +Command substitution will launch any commands and substitute the call with the +return value of the command. There are two methods: -Command substitution will launch any commands and substitute the call with the return value of the command. -There are two methods: - - * through a shell: enclose commands with @( )@ (quotes escaping is handled by uzbl): +* Through a shell: enclose commands with `@( )@` (quote escaping is handled by + Uzbl): print Command substitution: @(uname -a)@ -This method allows you to use posix shell syntax in your commands +This method allows you to use POSIX shell syntax in your commands. - * directly: +* directly: - print Command substitution: @(+uname -a)@ + print Command substitution: @(+uname -a)@ -This example will execute uname directly +This example will execute uname directly. -Note that you can access any uzbl variable from within a command substitution: +Note that you can access any `uzbl` variable from within a command substitution: print @(echo -n 'Accessing the show_status var from an external script, value: @show_status')@ - -Java script substitution works in the exact same way as command substitution but you will need to enclose -the java script in @< >@. +JavaScript substitution works in the exact same way as command substitution but +you will need to enclose the JavaScript in `@< >@`. print The currently viewed document contains @<document.links.length>@ links -The @<>@ substitution can also load JavaScript from a file, syntax: @<+filename>@ +The `@<>@` substitution can also load JavaScript from a file, syntax: `@<+filename>@` print JS return value from file: @<+/path/to/file.js>@ -Variable expansion also works within a java script substitution. - +Variable expansion also works within a JavaScript substitution. When a piece of text needs to be XML escaped after it is expanded (for example, -in the status bar format), you can use @[ ]@ substitution: +in the status bar format), you can use `@[ ]@` substitution: print This text is XML escaped: @[<&>]@ # prints: This text is XML escaped: <&> - -NOTE: If you need to use literal @ or \ characters you will need to escape them: +NOTE: If you need to use literal `@` or `\` characters you will need to escape +them: print At sign: \@ and backslash: \\ - ### TITLE AND STATUS BAR EVALUATION -The contents of the status bar can be customized by setting the status_format +The contents of the status bar can be customized by setting the `status_format` variable. The contents of the window title can be customized by setting the -title_format_short variable (which is used when the status bar is displayed) and -the title_format_long variable (which is used when the status bar is not +`title_format_short` variable (which is used when the status bar is displayed) +and the `title_format_long` variable (which is used when the status bar is not displayed). Their values can be set using the expansion and substitution techniques described above. @@ -347,55 +462,56 @@ that should be evaluated on every update need to be escaped: set title_format_short = \\\@(date)\\\@ # the title will stay constant as a literal "@(date)@" -The status_format variable can contain Pango markup (see -<http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html>). In the -status_format, variables that might contain characters like '<', '&' and '>', -should be wrapped in a @[]@ substitution so that they don't interfere with the -status bar's markup; see the example config for examples. - +The `status_format` variable can contain +[Pango](http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html) +markup . In the `status_format`, variables that might contain characters like +`<`, `&` and `>`, should be wrapped in a `@[ ]@` substitution so that they don't +interfere with the status bar's markup; see the sample config for examples. ### EXTERNAL SCRIPTS -You can use external scripts with uzbl the following ways: - -* let uzbl call them. these scripts are called handlers in the uzbl config. used for handling logging history, handling a new download,.. -* call them yourself from inside uzbl. you can bind keys for this. examples: add new bookmark, load new url,.. -* You could also use xbindkeys or your WM config to trigger scripts if uzbl does not have focus -Have a look at the sample configs and scripts! +You can use external scripts with Uzbl the following ways: -Handler scripts that are called by uzbl are passed the following arguments: +* Let `uzbl` call them. These scripts are called "handlers" in the `uzbl` + config. Used for handling cookies, starting a new download, and more. +* Call them yourself from inside `uzbl`. You can bind keys for this. Examples: + add new bookmark, load new URL. +* You could also use `xbindkeys` or your WM config to trigger scripts if `uzbl` + does not have focus. - $1 uzbl-config-file - $2 uzbl-pid - $3 uzbl-x-window-id - $4 uzbl_fifo-filename - $5 uzbl_socket-filename - $6 current page url - $7 current page title - .. [ script specific ] (optional) +Have a look at the sample configs and scripts! -The script specific arguments are this: +Handler scripts that are called by `uzbl` are passed the following arguments: -* add bookmark: +* `$1 config`: The configuration file loaded by this `uzbl` instance. +* `$2 pid`: The process ID of this `uzbl` instance. +* `$3 x_id`: The X Windows ID of the process. +* `$4 fifo`: The filename of the FIFO being used, if any. +* `$5 socket`: The filename of the Unix socket being used, if any. +* `$6 uri`: The URI of the current page. +* `$7 title`: The current page title. +* `.. [ script specific ] (optional)` - none +The script specific arguments are: -* download: +* download - $8 url of item to download - $9 url of http proxy (optional) + - `$8 url`: The URL of the item to be downloaded. + - `$9 proxy`: (optional) The URL of an HTTP proxy. * cookie handler - $8 GET/PUT - $9 request address scheme (e.g. http or https) - $10 request address host (if current page url is www.foo.com/somepage, this could be something else than foo, eg advertising from another host) - $11 request address path - $12 cookie (only with PUT requests) + - `$8 GET/PUT`: Whether a cookie should be sent to the server (`GET`) or + stored by the browser (`PUT`). + - `$9 scheme`: Either `http` or `https`. + - `$10 host`: If current page URL is `www.example.com/somepage`, this could be + something else than `example.com`, eg advertising from another host. + - `$11 path`: The request address path. + - `$12 data`: The cookie data. Only included for `PUT` requests. -* scheme handler: +* scheme handler - $8 URI of the page to be navigated to + - `$8 URI` of the page to be navigated to * authentication handler: @@ -404,37 +520,33 @@ The script specific arguments are this: $10 authentication realm $11 FALSE if this is the first attempt to authenticate, TRUE otherwise -Custom, userdefined scripts (`spawn foo bar`) get first the arguments as specified in the config and then the above 7 are added at the end. - -### JAVASCRIPT HELPER OBJECT DISABLED BECAUSE OF SECURITY LEAK - -Javascript code run from uzbl is given a special object in the global namespace which gives special privileges to these scripts. This object is called `Uzbl`, and it is added and removed before and after the script execution so that it is hidden to web javascripts (There is no race condition, since all the javascript code runs in a single thread) - -Currently, the `Uzbl` object provides only one function: - -* `Uzbl.run( <command> )` - - command is any uzbl command as defined above - - return value: a string, either empty or containing the output of the command. Very few commands return their output currently, including js, script, and print. - - Examples: - * `Uzbl.run("spawn insert_bookmark.sh")` - * `uri = Uzbl.run("print @uri")` (see variable expansion below) +Custom, userdefined scripts (`spawn foo bar`) get first the arguments as +specified in the config and then the above 7 are added at the end. -### AUTHENTICATION ### +### HTTP/BASIC AUTHENTICATION ### -If authentication_handler variable is not set, http authentication is handled internally by WebKit. If you want to use custom script for http authentication, set authentication_handler. For example: +If authentication_handler variable is not set, http authentication is handled +internally by WebKit. If you want to use custom script for http authentication, +set authentication_handler. For example: set authentication_handler = sync_spawn /patch/to/your/script -Script will be executed on each authentication request. It will receive four auth-related parameters: - - $8 authentication zone unique identifier (may be used as hash key in passwords database) +Script will be executed on each authentication request. +It will receive four auth-related parameters: + + $8 authentication zone unique identifier (may be used as 'key') $9 domain part of URL that requests authentication $10 authentication realm $11 FALSE if this is the first attempt to authenticate, TRUE otherwise -Script is expected to print exactly two lines of text on stdout (that means its output must contain exactly two '\n' bytes). The first line contains username, the second one - password. -If authentication fail, script will be executed again (with $11 = TRUE). Non-interactive scripts should handle this case and do not try to authenticate again to avoid loops. -If number of '\n' characters in scripts output does not equal 2, authentication will fail. That means 401 error will be displayed and uzbl won't try to authenticate anymore. +Script is expected to print exactly two lines of text on stdout (that means +its output must contain exactly two '\n' bytes). +The first line contains username, the second one - password. +If authentication fails, script will be executed again (with $11 = TRUE). +Non-interactive scripts should handle this case and do not try to +authenticate again to avoid loops. If number of '\n' characters in scripts +output does not equal 2, authentication will fail. +That means 401 error will be displayed and uzbl won't try to authenticate anymore. The simplest example of authentication handler script is: @@ -443,124 +555,219 @@ The simplest example of authentication handler script is: echo alice echo wonderland -This script tries to authenticate as user alice with password wonderland once and never retries authentication. See examples for more sofisticated, interactive authentication handler. +This script tries to authenticate as user alice with password wonderland once +and never retries authentication. +See examples for more sofisticated, interactive authentication handler. -### EVENTS ### +### JAVASCRIPT HELPER OBJECT DISABLED BECAUSE OF SECURITY LEAK -Unlike commands, events are not handled in uzbl itself, but are propagated (dispatched) asynchronously through -a text stream on stdout and/or through a socket. You'll usually use uzbl by piping it's output to a so called 'event manager' -or by having the EM listen to a socket. -- makes it possible to use whichever language you want for event handling (python, perl, bash, .. you name it). - you'll usually send commands (see above) back to uzbl through its fifo or socket -- keybindings use x keysyms -- many finegrained events (hover_over_link, key_press, key_down,..) -- see example event_handler.py +JavaScript code run from `uzbl` is given a special object in the global +namespace which gives special privileges to these scripts. This object is called +`Uzbl`, and it is added and removed before and after the script execution so +that it is hidden to web JavaScript code (there is no race condition, since all +the JavaScript code runs in a single thread). -Note: cookie events are not sent to an event handler but handled internally through the cookie handler because of their synchronous nature. -Cookie events are really something completely different from all other events. Maybe someday we'll use HTTP proxies or something for cookies -or synchronous events (which also have other nice use cases), but for now we still use the handler code) +Currently, the `Uzbl` object provides only one function: -Basically all events have this format: +* `Uzbl.run( <command> )` + - Command is any `uzbl` command as defined above. + - Return value: a string, either empty or containing the output of the + command. Very few commands return their output currently, including `js`, + `script`, and `print`. + - Examples: + * `Uzbl.run("spawn insert_bookmark.sh")` + * `uri = Uzbl.run("print @uri")` (see variable expansion below) + +### EVENTS + +Unlike commands, events are not handled in `uzbl` itself, but are propagated +(dispatched) asynchronously through a text stream on `stdout` and/or through a +socket. You'll usually use uzbl by piping it's output to a so-called "event +manager" (EM), or by having the EM listen to a socket. + +The EM allows: + +* Use of whichever language you want for event handling (Python, Perl, Bash, + ... you name it). You'll usually send commands (see above) back to `uzbl` + through its FIFO or socket. +* Keybindings use X keysyms. +* Many fine-grained events (`hover_over_link`, `key_press`, `key_release`,..) +* See example `uzbl-event-manager`. + +**Note**: Cookie events are not sent to an event handler but handled internally + through the cookie handler because of their synchronous nature. Cookie events + are really something completely different from all other events. Maybe someday + we'll use HTTP proxies or synchronous events (which also have other nice use + cases), but for now we still use the handler code. + +Events have this format: EVENT [uzbl_instance_name] EVENT_NAME event_details +#### Reported events + +* `EVENT [uzbl_instance_name] INSTANCE_START process_id`: `uzbl` startup. +* `EVENT [uzbl_instance_name] INSTANCE_EXIT process_id`: `uzbl` shutdown +* `EVENT [uzbl_instance_name] VARIABLE_SET variable_name str|int|float + variable_value`: Note: `str|int|float` denote the type of `variable_value`. +* `EVENT [uzbl_instance_name] COMMAND_EXECUTED command_name optional_arguments`: + A command is executed. +* `EVENT [uzbl_instance_name] COMMAND_ERROR command_name`: Tried to execute the + command `command_name`, but it does not exist. +* `EVENT [uzbl_instance_name] GEOMETRY_CHANGED + WIDTHxHEIGHT+X_POSITION+Y_POSITION`: When the size or position of the `uzbl` + window changes. +* `EVENT [uzbl_instance_name] FIFO_SET path_to_fifo`: The path to the FIFO is + set. +* `EVENT [uzbl_instance_name] SOCKET_SET path_to_socket`: The path to the socket + is set. +* `EVENT [uzbl_instance_name] LOAD_COMMIT uri`: The first data of a page has + loaded. `uri` is the URI of the page being loaded. +* `EVENT [uzbl_instance_name] LOAD_START uri`: A change of the page has been + requested. `uri` is the current URI; the one being departed. +* `EVENT [uzbl_instance_name] LOAD_FINISHED uri`: Loading has finished for the + page at `uri`. +* `EVENT [uzbl_instance_name] LOAD_ERROR uri reason_of_error`: The URI `uri` + could not be loaded for the reason described in `reason_of_error`. +* `EVENT [uzbl_instance_name] LOAD_PROGRESS percentage` : While the page is + loading, gives the `percentage` of the page that has finished loading. +* `EVENT [uzbl_instance_name] TITLE_CHANGED title_name`: When the title of the + page (and hence maybe, the window title) changed. `title_name` is the new + title. +* `EVENT [uzbl_instance_name] DOWNLOAD_REQUEST download_uri`: When content needs + to be downloaded, `download_uri` is the URI to get. +* `EVENT [uzbl_instance_name] LINK_HOVER uri`: The mouse hovers over the link + `uri`. +* `EVENT [uzbl_instance_name] LINK_UNHOVER uri`: The mouse leaves the link + `uri`. +* `EVENT [uzbl_instance_name] KEY_PRESS key_name`: The key (or mouse button) + `key_name` is pressed. +* `EVENT [uzbl_instance_name] KEY_RELEASE key_name`: The key (or mouse button) + `key_name` is released. +* `EVENT [uzbl_instance_name] SELECTION_CHANGED selected_text`: When text is + selected in the `uzbl` window. +* `EVENT [uzbl_instance_name] NEW_WINDOW uri`: Creation of new `uzbl` window, + with URI `uri`. +* `EVENT [uzbl_instance_name] WEBINSPECTOR open`: Upon opening webinspector + window. +* `EVENT [uzbl_instance_name] WEBINSPECTOR close`: Upon closing webinspector + window. +* `EVENT [uzbl_instance_name] FOCUS_GAINED`: When `uzbl` window gains keyboard + focus. +* `EVENT [uzbl_instance_name] FOCUS_LOST`: When `uzbl` window loses keyboard + focus. +* `EVENT [uzbl_instance_name] FORM_ACTIVE`: When an editable HTML is clicked. +* `EVENT [uzbl_instance_name] ROOT_ACTIVE`: When the document body or any + non-editable element is clicked. +* `EVENT [uzbl_instance_name] FILE_INCLUDED filename`: When the `include` + commands successfully loads a file, given by `filename`. +* `EVENT [uzbl_instance_name] PLUG_CREATED plug_id`: When `uzbl-core` is in + Xembed mode, `plug_id` is the Xembed ID used. +* `EVENT [uzbl_instance_name] BUILTINS command_list`: Shows a list of all `uzbl` + commands, whitespace separated, on startup. + +Events/requests which the EM and its plugins listens for + +* `BIND` and `MODE_BIND`: Define global and per-mode key/button binds. + - `request BIND <keycmd> = <command>` Set global binding (this is a shortcut + for `request MODE_BIND global <keycmd> = <command>`). + - `request MODE_BIND <modespec> <keycmd> = <command>` Set a local binding for + `<modespec>`. The `<modespec>` can be anything like `command`, + `insert,command`, `global`, `global,-insert`. + + The `<keycmd>` has a special syntax: + - `<keycmd>` ends with a `_`: the command will only be invoked after pressing + return/enter. If the user enters text where `<string>` has the underscore, + `%s` in the `<command>` string will be replaced by this text (optional). + - `<keycmd>` ends with a `*`: similar behavior as with an underscore, but also + makes the binding incremental (i.e. the command will be invoked on every + keystroke). + - `<keycmd>` ends with a `!`: the command will only be invoked after pressing + return/enter, no replacement happens. this is useful for preventing `x` to + match when you want to bind `xx` also. + - `<keycmd>` ends on a different character: you need to type the full string, + which will trigger the command immediately, without pressing enter/return. + - TODO explain stacked bindings and multi-stage (is that the same?) and what + else am i missing? modkeys, showing a prompt mid-bind. + + The `<keycmd>` can be any representation of a key on your keyboard or a + mousebutton. (note: not all mousebuttons work correctly yet). Examples: + + - `event BIND o _ = uri %s` + - `uzbl` will load the url when you type: `o <url><enter>` + - `event BIND /* = search %s` + - A `search` command which is called on every character typed after the slash, + letting you see the search narrow down while typing. + - Hitting return, enter or esc will terminate the search. + - `event BIND ZZ = exit` + - When you type `ZZ` and nothing else, the `exit` command will be triggered + immediately. +* `MODE_CONFIG`: Set mode specific configs. If the mode being modified is the + current mode then apply the changes immediately. + - `request MODE_CONFIG <mode> <key> = <value>` +* `ON_EVENT`: Execute a command when a given event is fired. + - `request ON_EVENT <EVENT_NAME> <command>` +* `PROGRESS_CONFIG`: Set a configuration option for `LOAD_PROGRESS` updates. + - `request PROGRESS_CONFIG <key> = <value>`: Set progress config variable + `key` to `value`. +* `MODMAP`: Set an alternate name for a key or button. + - `request MODMAP <from> <to>`: Create an alias `<to>` for key command + `<from>`. This allows `<to>` to be bound to a command, which will be invoked + when the `<from>` key or button is pressed. +* `IGNORE_KEY`: Ignore a key pattern, specified by `<glob>`. + - `request IGNORE_KEY <glob>` +* `MODKEY_ADDITION`: Create a compound modkey from multiple individual keys. + - `request MODKEY_ADDITION <key1> <key2> <keyn> <result>`: The modkey + `<result>` is considered pressed when all of `<key1>`, `<key2>`, and + `<keyn>` are pressed. +* `TOGGLE_MODES` + - `request TOGGLE_MODES <mode1> <mode2> ... <moden>` +* `APPEND_KEYCMD`: Append a string to the current keycmd. + - `request APPEND_KEYCMD <string>`: Append `<string>` to the current keycmd. +* `INJECT_KEYCMD`: Injecting a string into the keycmd at the cursor position. + - `request INJECT_KEYCMD <string>`: Inject `<string>` into the keycmd at the + current cursor position. +* `KEYCMD_DELETE`: Removes the character after the cursor position in the + keycmd. +* `KEYCMD_STRIP_WORD`: Removes the last word from the keycmd, similar to + readline `^W`. +* `KEYCMD_EXEC_CURRENT`: (tries to) execute whatever is in the keycmd. +* `SET_KEYCMD`: Allow setting of the keycmd externally. + - `request SET_KEYCMD <string>`: Set the keycmd to `<string>`. +* `SET_CURSOR_POS`: Allow setting of the cursor position externally. + - `request SET_CURSOR_POS <index>`: Set the keycmd cursor to `<index>`. If + `<index>` is `+`, advance the cursor by one character, and if it is `-`, + move the cursor back by one character. +* `START_COMPLETION`: TODO explain completion -* Reported events: - - `EVENT [uzbl_instance_name] INSTANCE_START process_id`: uzbl startup - - `EVENT [uzbl_instance_name] INSTANCE_EXIT process_id`: uzbl shutdown - - `EVENT [uzbl_instance_name] VARIABLE_SET variable_name str|int|float variable_value`. Note: str|int|float denote the type of variable_value - - `EVENT [uzbl_instance_name] COMMAND_EXECUTED command_name optional_command_arguments` - - `EVENT [uzbl_instance_name] COMMAND_ERROR command` - - `EVENT [uzbl_instance_name] GEOMETRY_CHANGED WIDTHxHEIGHT+X_POSITION+Y_POSITION`: when the size or position of the uzbl window changes - - `EVENT [uzbl_instance_name] FIFO_SET path_to_fifo` - - `EVENT [uzbl_instance_name] SOCKET_SET path_to_socket` - - `EVENT [uzbl_instance_name] LOAD_COMMIT uri` - - `EVENT [uzbl_instance_name] LOAD_START uri` - - `EVENT [uzbl_instance_name] LOAD_FINISHED uri` - - `EVENT [uzbl_instance_name] LOAD_ERROR reason_of_error` - - `EVENT [uzbl_instance_name] LOAD_PROGRESS percentage` : while the page is loading - - `EVENT [uzbl_instance_name] TITLE_CHANGED title_name`: when the title of the webpage (and hence maybe, the window title) changed - - `EVENT [uzbl_instance_name] DOWNLOAD_REQUEST download_uri`: when content needs to be downloaded - - `EVENT [uzbl_instance_name] LINK_HOVER uri`: mouse hovers over a link - - `EVENT [uzbl_instance_name] LINK_UNHOVER uri`: same but unhover. - - `EVENT [uzbl_instance_name] KEY_PRESS key_name`: press of a keyboard key or mouse button - - `EVENT [uzbl_instance_name] KEY_RELEASE key_name`: release of keyboard key or mouse button - - `EVENT [uzbl_instance_name] SELECTION_CHANGED selected_text`: when you select text inside the uzbl window - - `EVENT [uzbl_instance_name] NEW_WINDOW uri`: creation of new uzbl window - - `EVENT [uzbl_instance_name] WEBINSPECTOR open`: upon opening webinspector window - - `EVENT [uzbl_instance_name] WEBINSPECTOR close`: upon closing webinspector window - - `EVENT [uzbl_instance_name] FOCUS_GAINED`: when uzbl window gained keyboard focus - - `EVENT [uzbl_instance_name] FOCUS_LOST`: when uzbl window lost keyboard focus - - `EVENT [uzbl_instance_name] FORM_ACTIVE`: when a editable HTML is clicked - - `EVENT [uzbl_instance_name] ROOT_ACTIVE`: when the document body or any non-editable element is clicked - - `EVENT [uzbl_instance_name] FILE_INCLUDED /path/to/file`: when the include commands succesfully loads a file - - `EVENT [uzbl_instance_name] PLUG_CREATED plug-id`: when uzbl-core is in xembed mode - - `EVENT [uzbl_instance_name] BUILTINS command_list`: shows a list of all uzbl commands, whitespace separated, on startup - -* Events/requests which the EM and its plugins listens for: - - `BIND` and `MODE_BIND`: define global resp. per-mode key/button binds. - `request BIND <keycmd> = <command>` # set global binding (this is a shortcut for `request MODE_BIND global <keycmd> = <command>`) - `request MODE_BIND <modespec> <keycmd> = <command>` - The `<modespec>` can be anything like 'command', 'insert,command', 'global', 'global,-insert'. - The `<keycmd>` has a special syntax: - * `<keycmd>` ends with an underscore: the command will only be invoked after pressing return/enter. If the user enters text where `<string>` has the underscore, `%s` in the `<command>` string will be replaced by this text. (optional) - * `<keycmd>` ends with an asterisk: similar behavior as with an underscore, but also makes the binding incremental (i.e. the command will be invoked on every keystroke). - * `<keycmd>` ends with an '!': the command will only be invoked after pressing return/enter, no replacement happens. this is useful for preventing 'x' to match when you want to bind 'xx' also. - * `<keycmd>` ends on a different character: you need to type the full string, which will trigger the command immediately, without pressing enter/return. - * TODO explain stacked bindings and multi-stage (is that the same?) and what else am i missing? modkeys, showing a prompt mid-bind. - The `<keycmd>` can be any representation of a key on your keyboard or a mousebutton. (note: not all mousebuttons work correctly yet) - examples: - * `event BIND o _ = uri %s` - - uzbl will load the url when you type: 'o <url><enter>' - * `event BIND /* = search %s` - - a search command which is called on every character typed after the slash, letting you see the search narrow down while typing. - - Hitting return, enter or esc will terminate the search. - * `event BIND ZZ = exit` - - When you type `ZZ` and nothing else, the exit command will be triggered immediately. - - `MODE_CONFIG`: ?? - request MODE_CONFIG <mode> <key> = <value - - `ON_EVENT`: allows you to bind misc commands to misc events - request ON_EVENT <EVENT_NAME> <command> - - `PROGRESS_CONFIG` - request PROGRESS_CONFIG <key> = <value> - - `MODMAD` - request MODMAP From To - - `IGNORE_KEY` - request IGNORE_KEY <glob> - - `MODKEY_ADDITION` - request MODKEY_ADDITION <key1> <key2> <keyn> <result> - - `TOGGLE_MODES` - event TOGGLE_MODES <mode1> <mode2> ... <moden> - - `APPEND_KEYCMD`: append `<string> to keycmd - - `INJECT_KEYCMD <string>`: replace keycmd by `<string>` - - `KEYCMD_DELETE` - - `KEYCMD_STRIP_WORD` - - `KEYCMD_EXEC_CURRENT`: (tries to) execute whatever is in the keycmd - - `SET_KEYCMD` - - `SET_CURSOR_POS` - - `START_COMPLETION`: TODO explain completion +### COMMAND LINE ARGUMENTS +`uzbl` is invoked as + uzbl-(core|browser|tabbed) [ arguments ] [ uri ] -### COMMAND LINE ARGUMENTS - uzbl-core [OPTION...] [ uri ] - -u, --uri=URI Uri to load at startup (equivalent to 'uzbl <uri>' or 'set uri = URI' after uzbl has launched) - -v, --verbose Whether to print all messages or just errors. - -n, --name=NAME Name of the current instance (defaults to Xorg window id or random for GtkSocket mode) - -c, --config=FILE Path to config file or '-' for stdin - -s, --socket=SOCKET Socket ID - --connect-socket=CSOCKET Connect to server socket - -p, --print-events Whether to print events to stdout - -g, --geometry=GEOMETRY Set window geometry (format: WIDTHxHEIGHT+-X+-Y or maximized) - -V, --version Print the version and exit - --display=DISPLAY X display to use - --help Help - -uzbl scheme://address will work as you expect. If you don't provide the -scheme:// part, it will check if the argument is an existing file in the -filesystem: if it is, it will prepend file://, if not, it will -prepend http://. +where `arguments` and `uri` are both optional. `arguments` can be: +* `-u`, `--uri=URI`: URI to load at startup. Equivalent to `uzbl <uri>` or `set + uri = URI` after `uzbl` has launched. +* `-v`, `--verbose`: Whether to print all messages or just errors. +* `-n`, `--name=NAME`: Name of the current instance (defaults to Xorg window + id or random for GtkSocket mode). +* `-c`, `--config=FILE`: Path to config file or `-` for stdin. +* `-s`, `--socket=SOCKET`: Xembed socket ID. +* `--connect-socket=SOCKET`: Connect to server socket for event managing. +* `-p`, `--print-events`: Whether to print events to stdout +* `-g`, `--geometry=GEOMETRY`: Set window geometry (format: `WIDTHxHEIGHT+-X+-Y` + or `maximized`). +* `-V`, `--version`: Print the version and exit. +* `--display=DISPLAY`: X display to use. +* `--help`: Display help. + +`uzbl-core scheme://address` will work as you expect. If you don't provide the +`scheme://` part, it will check if the argument is an existing file in the +filesystem, if it is, it will prepend `file://`, if not, it will prepend +`http://`. ### BUGS -Please report new issues @ uzbl.org/bugs + +Please report new issues to the [Uzbl bugtracker](http://uzbl.org/bugs). diff --git a/examples/config/config b/examples/config/config index 5dd0e72..929397d 100644 --- a/examples/config/config +++ b/examples/config/config @@ -293,9 +293,11 @@ set toggle_cmd_ins = @toggle_modes command insert @cbind u = spawn @scripts_dir/load_url_from_bookmarks.sh # --- Link following (similar to vimperator and konqueror) --- -@cbind fl* = script @scripts_dir/follow_Numbers.js %s -# Or number with strings instead of numbers: -@cbind fL* = script @scripts_dir/follow_Numbers_Strings.js %s +# Set custom keys you wish to use for navigation. Some common examples: +set follow_hint_keys = qwerty +#set follow_hint_keys = asdfghjkl; +#set follow_hint_keys = thsnd-rcgmvwb/;789aefijkopquxyz234 +@cbind f* = script @scripts_dir/follow.js '%s @{follow_hint_keys}' # --- Form filler binds --- # this script allows you to configure (per domain) values to fill in form diff --git a/examples/data/scripts/follow_Numbers.js b/examples/data/scripts/follow.js index 00b279e..12b3765 100644 --- a/examples/data/scripts/follow_Numbers.js +++ b/examples/data/scripts/follow.js @@ -17,10 +17,6 @@ var doc = document; var win = window; var links = document.links; var forms = document.forms; - -//Reset keycmd, modcmd and return to default mode. -function clearKeycmd() { Uzbl.run('set mode ='); } - //Make onlick-links "clickable" try { HTMLElement.prototype.click = function() { @@ -106,19 +102,21 @@ function generateHint(el, label) { hint.style.fontWeight = 'bold'; hint.style.lineHeight = '9px'; hint.style.margin = '0px'; + hint.style.width = 'auto'; // fix broken rendering on w3schools.com hint.style.padding = '1px'; hint.style.position = 'absolute'; hint.style.zIndex = '1000'; + // hint.style.textTransform = 'uppercase'; hint.style.left = pos[1] + 'px'; hint.style.top = pos[0] + 'px'; - var img = el.getElementsByTagName('img'); - if (img.length > 0) { - hint.style.left = pos[1] + img[0].width / 2 + 'px'; - } + // var img = el.getElementsByTagName('img'); + // if (img.length > 0) { + // hint.style.top = pos[1] + img[0].height / 2 - 6 + 'px'; + // } hint.style.textDecoration = 'none'; - hint.style.webkitBorderRadius = '6px'; + // hint.style.webkitBorderRadius = '6px'; // slow // Play around with this, pretty funny things to do :) - hint.style.webkitTransform = 'scale(1) rotate(0deg) translate(-6px,-5px)'; + // hint.style.webkitTransform = 'scale(1) rotate(0deg) translate(-6px,-5px)'; return hint; } //Here we choose what to do with an element if we @@ -127,7 +125,6 @@ function generateHint(el, label) { //but at least set the href of the link. (needs some improvements) function clickElem(item) { removeAllHints(); - clearKeycmd(); if (item) { var name = item.tagName; if (name == 'A') { @@ -193,26 +190,66 @@ function reDrawHints(elems, chars) { document.body.appendChild(hintdiv); } } +// pass: number of keys +// returns: key length +function labelLength(n) { + var oldn = n; + var keylen = 0; + if(n < 2) { + return 1; + } + n -= 1; // our highest key will be n-1 + while(n) { + keylen += 1; + n = Math.floor(n / charset.length); + } + return keylen; +} +// pass: number +// returns: label +function intToLabel(n) { + var label = ''; + do { + label = charset.charAt(n % charset.length) + label; + n = Math.floor(n / charset.length); + } while(n); + return label; +} +// pass: label +// returns: number +function labelToInt(label) { + var n = 0; + var i; + for(i = 0; i < label.length; ++i) { + n *= charset.length; + n += charset.indexOf(label[i]); + } + return n; +} //Put it all together function followLinks(follow) { + // if(follow.charAt(0) == 'l') { + // follow = follow.substr(1); + // charset = 'thsnlrcgfdbmwvz-/'; + // } var s = follow.split(''); - var linknr = parseInt(follow, 10); + var linknr = labelToInt(follow); if (document.body) document.body.setAttribute('onkeyup', 'keyPressHandler(event)'); var linkelems = addLinks(); var formelems = addFormElems(); var elems = [linkelems[0].concat(formelems[0]), linkelems[1].concat(formelems[1])]; - var len = (elems[0].length + '').length; + var len = labelLength(elems[0].length); var oldDiv = doc.getElementById(uzbldivid); var leftover = [[], []]; - if (linknr + 1 && s.length == len && linknr < elems[0].length && linknr >= 0) { + if (s.length == len && linknr < elems[0].length && linknr >= 0) { clickElem(elems[0][linknr]); } else { for (var j = 0; j < elems[0].length; j++) { var b = true; - var label = j + ''; + var label = intToLabel(j); var n = label.length; for (n; n < len; n++) { - label = '0' + label; + label = charset.charAt(0) + label; } for (var k = 0; k < s.length; k++) { b = b && label.charAt(k) == s[k]; @@ -225,4 +262,9 @@ function followLinks(follow) { reDrawHints(leftover, s.length); } } -followLinks('%s'); + +//Parse input: first argument is user input, second is defined hint keys. +var args = '%s'.split(' '); +var charset = args[1]; + +followLinks(args[0]); diff --git a/examples/data/scripts/follow_Numbers_Strings.js b/examples/data/scripts/follow_Numbers_Strings.js deleted file mode 100644 index e50da5d..0000000 --- a/examples/data/scripts/follow_Numbers_Strings.js +++ /dev/null @@ -1,212 +0,0 @@ -var uzblid = 'uzbl_link_hint'; -var uzbldivid = uzblid + '_div_container'; -var doc = document; -var win = window; -var links = document.links; -var forms = document.forms; - -//Reset keycmd, modcmd and return to default mode. -function clearKeycmd() { Uzbl.run('set mode ='); } - -try { - HTMLElement.prototype.click = function() { - if (typeof this.onclick == 'function') { - this.onclick({ - type: 'click' - }); - } - }; -} catch(e) {} -function keyPressHandler(e) { - var kC = window.event ? event.keyCode: e.keyCode; - var Esc = window.event ? 27 : e.DOM_VK_ESCAPE; - if (kC == Esc) { - removeAllHints(); - } -} -function elementPosition(el) { - var up = el.offsetTop; - var left = el.offsetLeft; - var width = el.offsetWidth; - var height = el.offsetHeight; - while (el.offsetParent) { - el = el.offsetParent; - up += el.offsetTop; - left += el.offsetLeft; - } - return [up, left, width, height]; -} -function isVisible(el) { - if (el == doc) { - return true; - } - if (!el) { - return false; - } - if (!el.parentNode) { - return false; - } - if (el.style) { - if (el.style.display == 'none') { - return false; - } - if (el.style.visibility == 'hidden') { - return false; - } - } - return isVisible(el.parentNode); -} -function elementInViewport(el) { - offset = elementPosition(el); - var up = offset[0]; - var left = offset[1]; - var width = offset[2]; - var height = offset[3]; - return up < window.pageYOffset + window.innerHeight && left < window.pageXOffset + window.innerWidth && (up + height) > window.pageYOffset && (left + width) > window.pageXOffset; -} -function removeAllHints() { - var elements = doc.getElementById(uzbldivid); - if (elements) { - elements.parentNode.removeChild(elements); - } -} -function generateHint(el, label) { - var pos = elementPosition(el); - var hint = doc.createElement('div'); - hint.setAttribute('name', uzblid); - hint.innerText = label; - hint.style.display = 'inline'; - hint.style.backgroundColor = '#B9FF00'; - hint.style.border = '2px solid #4A6600'; - hint.style.color = 'black'; - hint.style.zIndex = '1000'; - hint.style.fontSize = '9px'; - hint.style.fontWeight = 'bold'; - hint.style.lineHeight = '9px'; - hint.style.margin = '0px'; - hint.style.padding = '1px'; - hint.style.position = 'absolute'; - hint.style.left = pos[1] + 'px'; - hint.style.top = pos[0] + 'px'; - var img = el.getElementsByTagName('img'); - if (img.length > 0) { - hint.style.left = pos[1] + img[0].width / 2 + 'px'; - } - hint.style.textDecoration = 'none'; - hint.style.webkitBorderRadius = '6px'; - hint.style.webkitTransform = 'scale(1) rotate(0deg) translate(-6px,-5px)'; - return hint; -} - -function clickElem(item) { - removeAllHints(); - clearKeycmd(); - if (item) { - var name = item.tagName; - if (name == 'A') { - item.click(); - window.location = item.href; - } else if (name == 'INPUT') { - var type = item.getAttribute('type').toUpperCase(); - if (type == 'TEXT' || type == 'FILE' || type == 'PASSWORD') { - item.focus(); - item.select(); - } else { - item.click(); - } - } else if (name == 'TEXTAREA' || name == 'SELECT') { - item.focus(); - item.select(); - } else { - item.click(); - window.location = item.href; - } - } -} - -function addLinks() { - res = [[], []]; - for (var l = 0; l < links.length; l++) { - var li = links[l]; - if (isVisible(li) && elementInViewport(li)) { - res[0].push(li); - res[1].push(li.innerText.toLowerCase()); - } - } - return res; -} -function addFormElems() { - res = [[], []]; - for (var f = 0; f < forms.length; f++) { - for (var e = 0; e < forms[f].elements.length; e++) { - var el = forms[f].elements[e]; - if (el && ['INPUT', 'TEXTAREA', 'SELECT'].indexOf(el.tagName) + 1 && isVisible(el) && elementInViewport(el)) { - res[0].push(el); - if (el.getAttribute('value')) { - res[1].push(el.getAttribute('value').toLowerCase()); - } else { - res[1].push(el.getAttribute('name').toLowerCase()); - } - } - } - } - return res; -} -function reDrawHints(elems, len) { - var hintdiv = doc.createElement('div'); - hintdiv.setAttribute('id', uzbldivid); - hintdiv.style.opacity = '0.0'; - for (var i = 0; i < elems[0].length; i++) { - var label = i + ''; - var n = label.length; - for (n; n < len; n++) { - label = '0' + label; - } - if (elems[0][i]) { - var h = generateHint(elems[0][i], label); - hintdiv.appendChild(h); - } - } - if (document.body) { - document.body.appendChild(hintdiv); - hintdiv.style.opacity = '0.7' - } -} -function followLinks(follow) { - var s = follow.split(''); - var linknr = parseInt(follow, 10); - if (document.body) document.body.setAttribute('onkeyup', 'keyPressHandler(event)'); - var linkelems = addLinks(); - var formelems = addFormElems(); - var elems = [linkelems[0].concat(formelems[0]), linkelems[1].concat(formelems[1])]; - var len = (elems[0].length + '').length; - var oldDiv = doc.getElementById(uzbldivid); - var leftover = [[], []]; - if (linknr + 1 && s.length == len && linknr < elems[0].length && linknr >= 0) { - clickElem(elems[0][linknr]); - } else { - for (var j = 0; j < elems[0].length; j++) { - var b = true; - for (var k = 0; k < s.length; k++) { - b = b && elems[1][j].charAt(k) == s[k]; - } - if (!b) { - elems[0][j] = null; - elems[1][j] = null; - } else { - leftover[0].push(elems[0][j]); - leftover[1].push(elems[1][j]); - } - } - if (leftover[0].length == 1) { - clickElem(leftover[0][0]); - } else if (!oldDiv) { - if (linknr + 1 || s.length == 0) { - reDrawHints(elems, len); - } else { - reDrawHints(leftover, len); - } - } - } -} -followLinks('%s'); diff --git a/examples/data/scripts/follower.js b/examples/data/scripts/follower.js new file mode 100644 index 0000000..604b779 --- /dev/null +++ b/examples/data/scripts/follower.js @@ -0,0 +1,420 @@ +// A Link Follower for Uzbl. +// P.C. Shyamshankar <sykora@lucentbeing.com> +// +// WARNING: this script depends on the Uzbl object which is now disabled for +// WARNING security reasons. So the script currently doesn't work but it's +// WARNING interesting nonetheless +// +// Based extensively (like copy-paste) on the follow_numbers.js and +// linkfollow.js included with uzbl, but modified to be more customizable and +// extensible. +// +// Usage +// ----- +// +// First, you'll need to make sure the script is loaded on each page. This can +// be done with: +// +// @on_event LOAD_COMMIT script /path/to/follower.js +// +// Then you can bind it to a key: +// +// @bind f* = js follower.follow('%s', matchSpec, handler, hintStyler) +// +// where matchSpec, handler and hintStyler are parameters which control the +// operation of follower. If you don't want to customize any further, you can +// set these to follower.genericMatchSpec, follower.genericHandler and +// follower.genericHintStyler respectively. +// +// For example, +// +// @bind f* = js follower.follow('%s', follower.genericMatchSpec, follower.genericHandler, follower.genericHintStyler) +// @bind F* = js follower.follow('%s', follower.onlyLinksMatchSpec, follower.newPageHandler, follower.newPageHintStyler) +// +// In order to make hints disappear when pressing a key (the Escape key, for +// example), you can do this: +// +// @bind <Escape> = js follower.clearHints() +// +// If your Escape is already bound to something like command mode, chain it. +// +// Alternatively, you can tell your <Escape> key to emit an event, and handle +// that instead. +// +// @bind <Escape> = event ESCAPE +// @on_event ESCAPE js follower.clearHints() +// +// Customization +// ------------- +// +// If however you do want to customize, 3 Aspects of the link follower can be +// customized with minimal pain or alteration to the existing code base: +// +// * What elements are hinted. +// * The style of the hints displayed. +// * How the hints are handled. +// +// In order to customize behavior, write an alternative, and pass that in to +// follower.follow invocation. You _will_ have to modify this script, but only +// locally, it beats having to copy the entire script under a new name and +// modify. +// +// TODO: +// * Whatever all the other TODOs in the file say. +// * Find out how to do default arguments in Javascript. +// * Abstract out the hints into a Hint object, make hintables a list of hint +// objects instead of two lists. + +// Helpers +String.prototype.lpad = function(padding, length) { + var padded = this; + while (padded.length < length) { + padded = padding + padded; + } + + return padded; +} + +function Follower() { + + // Globals + var uzblID = 'uzbl-follow'; // ID to apply to each hint. + var uzblContainerID = 'uzbl-follow-container'; // ID to apply to the div containing hints. + + // Translation table, used to display something other than numbers as hint + // labels. Typically set to the ten keys of the home row. + // + // Must have exactly 10 elements. + // + // I haven't parameterized this, to make it customizable. Should I? Do + // people really use more than one set of keys at a time? + var translation = ["a", "r", "s", "t", "d", "h", "n", "e", "i", "o"]; + + // MatchSpecs + // These are XPath expressions which indicate which elements will be hinted. + // Use multiple expressions for different situations, like hinting only form + // elements, or only links, etc. + // + // TODO: Check that these XPath expressions are correct, and optimize/make + // them more elegant. Preferably by someone who actually knows XPath, unlike + // me. + + // Vimperator default (copy-pasted, I never used vimperator). + this.genericMatchSpec = " //*[@onclick or @onmouseover or @onmousedown or @onmouseup or @oncommand or @class='lk' or @role='link' or @href] | //input[not(@type='hidden')] | //a | //area | //iframe | //textarea | //button | //select"; + + // Matches only links, suitable for opening in a new instance (I think). + this.onlyLinksMatchSpec = " //*[@href] | //a | //area"; + + // Follow Handlers + // These decide how an element should be 'followed'. The handler is passed + // the element in question. + + // Generic Handler, opens links in the same instance, emits the FORM_ACTIVE + // event if a form element was chosen. Also clears the keycmd. + this.genericHandler = function(node) { + if (node) { + if (window.itemClicker != undefined) { + window.itemClicker(node); + } else { + var tag = node.tagName.toLowerCase(); + if (tag == 'a') { + node.click(); + window.location = node.href; + } else if (tag == 'input') { + var inputType = node.getAttribute('type'); + if (inputType == undefined) + inputType = 'text'; + + inputType = inputType.toLowerCase(); + + if (inputType == 'text' || inputType == 'file' || inputType == 'password') { + node.focus(); + node.select(); + } else { + node.click(); + } + Uzbl.run("event FORM_ACTIVE"); + } else if (tag == 'textarea'|| tag == 'select') { + node.focus(); + node.select(); + Uzbl.run("event FORM_ACTIVE"); + } else { + node.click(); + if ((node.href != undefined) && node.href) + window.location = node.href; + } + } + } + Uzbl.run("event SET_KEYCMD"); + } + + // Handler to open links in a new page. The rest is the same as before. + this.newPageHandler = function(node) { + if (node) { + if (window.itemClicker != undefined) { + window.itemClicker(node); + } else { + var tag = node.tagName.toLowerCase(); + if (tag == 'a') { + node.click(); + Uzbl.run("@new_window " + node.href); + } else if (tag == 'input') { + var inputType = node.getAttribute('type'); + if (inputType == undefined) + inputType = 'text'; + + inputType = inputType.toLowerCase(); + + if (inputType == 'text' || inputType == 'file' || inputType == 'password') { + node.focus(); + node.select(); + } else { + node.click(); + } + Uzbl.run("event FORM_ACTIVE"); + } else if (tag == 'textarea'|| tag == 'select') { + node.focus(); + node.select(); + Uzbl.run("event FORM_ACTIVE"); + } else { + node.click(); + if ((node.href != undefined) && node.href) + window.location = node.href; + } + } + } + Uzbl.run("event SET_KEYCMD"); + }; + + // Hint styling. + // Pretty much any attribute of the hint object can be modified here, but it + // was meant to change the styling. Useful to differentiate between hints + // with different handlers. + // + // Hint stylers are applied at the end of hint creation, so that they + // override the defaults. + + this.genericHintStyler = function(hint) { + hint.style.backgroundColor = '#AAAAAA'; + hint.style.border = '2px solid #4A6600'; + hint.style.color = 'black'; + hint.style.fontSize = '10px'; + hint.style.fontWeight = 'bold'; + hint.style.lineHeight = '12px'; + return hint; + }; + + this.newPageHintStyler = function(hint) { + hint.style.backgroundColor = '#FFCC00'; + hint.style.border = '2px solid #4A6600'; + hint.style.color = 'black'; + hint.style.fontSize = '10px'; + hint.style.fontWeight = 'bold'; + hint.style.lineHeight = '12px'; + return hint; + }; + + // Beyond lies a jungle of pasta and verbosity. + + // Translate a numeric label using the translation table. + function translate(digitLabel, translationTable) { + translatedLabel = ''; + for (var i = 0; i < digitLabel.length; i++) { + translatedLabel += translationTable[digitLabel.charAt(i)]; + } + + return translatedLabel; + } + + function computeElementPosition(element) { + var up = element.offsetTop; + var left = element.offsetLeft; + var width = element.offsetWidth; + var height = element.offsetHeight; + + while (element.offsetParent) { + element = element.offsetParent; + up += element.offsetTop; + left += element.offsetLeft; + } + + return {up: up, left: left, width: width, height: height}; + } + + // Pretty much copy-pasted from every other link following script. + function isInViewport(element) { + offset = computeElementPosition(element); + + var up = offset.up; + var left = offset.left; + var width = offset.width; + var height = offset.height; + + return up < window.pageYOffset + window.innerHeight && + left < window.pageXOffset + window.innerWidth && + (up + height) > window.pageYOffset && + (left + width) > window.pageXOffset; + } + + function isVisible(element) { + if (element == document) { + return true; + } + + if (!element){ + return false; + } + + if (element.style) { + if (element.style.display == 'none' || element.style.visibiilty == 'hidden') { + return false; + } + } + + return isVisible(element.parentNode); + } + + function generateHintContainer() { + var container = document.getElementById(uzblContainerID); + if (container) { + container.parentNode.removeChild(container); + } + + container = document.createElement('div'); + container.id = uzblContainerID; + + if (document.body) { + document.body.appendChild(container); + } + return container; + } + + // Generate everything that is to be hinted, as per the given matchSpec. + // hintables[0] refers to the items, hintables[1] to their labels. + function generateHintables(matchSpec) { + var hintables = [[], []]; + + var itemsFromXPath = document.evaluate(matchSpec, document, null, XPathResult.ORDERED_NODE_SNAPSHOT_TYPE, null); + + for (var i = 0; i < itemsFromXPath.snapshotLength; ++i) { + var element = itemsFromXPath.snapshotItem(i); + if (element && isVisible(element) && isInViewport(element)) { + hintables[0].push(element); + } + } + + // Assign labels to each hintable. Can't be combined with the previous + // step, because we didn't know how many there were at that time. + var hintLength = hintables.length; + for (var i = 0; i < hintables[0].length; ++i) { + var code = translate(i.toString(), translation); + hintables[1].push(code.lpad(translation[0], hintLength)); + } + + return hintables; + } + + // Filter the hintables based on input from the user. Makes the screen less + // cluttered after the user has typed some prefix of hint labels. + function filterHintables(hintables, target) { + var filtered = [[], []]; + + var targetPattern = new RegExp("^" + target); + + for (var i = 0; i < hintables[0].length; i++) { + if (hintables[1][i].match(targetPattern)) { + filtered[0].push(hintables[0][i]); + filtered[1].push(hintables[1][i].substring(target.length)); + } + } + + return filtered; + } + + // TODO make this use the container variable from main, instead of searching + // for it? + function clearHints() { + var container = document.getElementById(uzblContainerID); + if (container) { + container.parentNode.removeChild(container); + } + } + + // So that we can offer this as a separate function. + this.clearHints = clearHints; + + function makeHint(node, code, styler) { + var position = computeElementPosition(node); + var hint = document.createElement('div'); + + hint.name = uzblID; + hint.innerText = code; + hint.style.display = 'inline'; + + hint.style.margin = '0px'; + hint.style.padding = '1px'; + hint.style.position = 'absolute'; + hint.style.zIndex = '10000'; + + hint.style.left = position.left + 'px'; + hint.style.top = position.up + 'px'; + + var img = node.getElementsByTagName('img'); + if (img.length > 0) { + hint.style.left = position.left + img[0].width / 2 + 'px'; + } + + hint.style.textDecoration = 'none'; + hint.style.webkitBorderRadius = '6px'; + hint.style.webkitTransform = 'scale(1) rotate(0deg) translate(-6px, -5px)'; + + hint = styler(hint); // So that custom hint stylers can override the above. + return hint; + } + + + function drawHints(container, hintables, styler) { + for (var i = 0; i < hintables[0].length; i++) { + hint = makeHint(hintables[0][i], hintables[1][i], styler); + container.appendChild(hint); + } + + if (document.body) { + document.body.appendChild(container); + } + } + + // The main hinting function. I don't know how to do default values to + // functions, so all arguments must be specified. Use generics if you must. + this.follow = function(target, matchSpec, handler, hintStyler) { + var container = generateHintContainer(); // Get a container to hold all hints. + var allHintables = generateHintables(matchSpec); // Get all items that can be hinted. + hintables = filterHintables(allHintables, target); // Filter them based on current input. + + clearHints(); // Clear existing hints, if any. + + if (hintables[0].length == 0) { + // Nothing was hinted, user pressed an unknown key, maybe? + // Do nothing. + } else if (hintables[0].length == 1) { + handler(hintables[0][0]); // Only one hint remains, handle it. + } else { + drawHints(container, hintables, hintStyler); // Draw whatever hints remain. + } + + return; + }; +} + +// Make on-click links clickable. +try { + HTMLElement.prototype.click = function() { + if (typeof this.onclick == 'function') { + this.onclick({ + type: 'click' + }); + } + }; +} catch(e) {} + +follower = new Follower(); diff --git a/src/uzbl-core.c b/src/uzbl-core.c index f5b89df..1558882 100644 --- a/src/uzbl-core.c +++ b/src/uzbl-core.c @@ -50,13 +50,13 @@ GOptionEntry entries[] = { "config", 'c', 0, G_OPTION_ARG_STRING, &uzbl.state.config_file, "Path to config file or '-' for stdin", "FILE" }, { "socket", 's', 0, G_OPTION_ARG_INT, &uzbl.state.socket_id, - "Socket ID", "SOCKET" }, + "Xembed Socket ID", "SOCKET" }, { "connect-socket", 0, 0, G_OPTION_ARG_STRING_ARRAY, &uzbl.state.connect_socket_names, - "Connect to server socket", "CSOCKET" }, + "Connect to server socket for event managing", "CSOCKET" }, { "print-events", 'p', 0, G_OPTION_ARG_NONE, &uzbl.state.events_stdout, "Whether to print events to stdout.", NULL }, { "geometry", 'g', 0, G_OPTION_ARG_STRING, &uzbl.gui.geometry, - "Set window geometry (format: WIDTHxHEIGHT+-X+-Y or maximized)", "GEOMETRY" }, + "Set window geometry (format: 'WIDTHxHEIGHT+-X+-Y' or 'maximized')", "GEOMETRY" }, { "version", 'V', 0, G_OPTION_ARG_NONE, &uzbl.behave.print_version, "Print the version and exit", NULL }, { NULL, 0, 0, 0, NULL, NULL, NULL } diff --git a/tests/test-command.c b/tests/test-command.c index fc3b092..6194081 100644 --- a/tests/test-command.c +++ b/tests/test-command.c @@ -22,8 +22,8 @@ #include <fcntl.h> #include <signal.h> -#include <uzbl-core.h> -#include <config.h> +#include <src/uzbl-core.h> +#include <src/config.h> extern UzblCore uzbl; diff --git a/tests/test-expand.c b/tests/test-expand.c index 01af401..7ea3d61 100644 --- a/tests/test-expand.c +++ b/tests/test-expand.c @@ -22,8 +22,8 @@ #include <fcntl.h> #include <signal.h> -#include <uzbl-core.h> -#include <config.h> +#include <src/uzbl-core.h> +#include <src/config.h> extern UzblCore uzbl; |