2 * (C) Copyright 2004-2007 Shawn Betts
3 * (C) Copyright 2007-2010 John J. Foerch
4 * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
6 * Use, modification, and distribution are subject to the terms specified in the
10 define_coroutine_hook("before_quit_hook", RUN_HOOK_UNTIL_FAILURE);
11 define_hook("quit_hook");
14 var res = yield before_quit_hook.run();
17 var appStartup = Cc["@mozilla.org/toolkit/app-startup;1"]
18 .getService(Ci.nsIAppStartup);
19 appStartup.quit(appStartup.eAttemptQuit);
22 interactive("quit", "Quit Conkeror", quit);
25 function show_conkeror_version (window) {
26 var xulrunner_version = Cc['@mozilla.org/xre/app-info;1']
27 .getService(Ci.nsIXULAppInfo)
29 window.minibuffer.message("Conkeror "+conkeror.version+
30 " (XULRunner "+xulrunner_version+
33 interactive("conkeror-version",
34 "Show version information for Conkeror.",
35 function (I) { show_conkeror_version(I.window); });
36 interactive("version",
37 "Show version information for Conkeror.",
40 /* FIXME: maybe this should be supported for non-browser buffers */
41 function scroll_horiz_complete (buffer, n) {
42 var w = buffer.focused_frame;
43 w.scrollTo (n > 0 ? w.scrollMaxX : 0, w.scrollY);
45 interactive("scroll-beginning-of-line",
46 "Scroll the current frame all the way to the left.",
47 function (I) { scroll_horiz_complete(I.buffer, -1); });
49 interactive("scroll-end-of-line",
50 "Scroll the current frame all the way to the right.",
51 function (I) { scroll_horiz_complete(I.buffer, 1); });
53 interactive("scroll-top-left",
54 "Scroll the current frame all the way to the top left",
55 function (I) { I.buffer.do_command("cmd_scrollTop");
56 scroll_horiz_complete(I.buffer, -1); });
59 function delete_window (window) {
60 window.window.close();
62 interactive("delete-window",
63 "Delete the current window.",
64 function (I) { delete_window(I.window); });
66 interactive("jsconsole",
67 "Open the JavaScript console.",
68 "find-url-new-buffer",
69 $browser_object = "chrome://global/content/console.xul");
72 function paste_x_primary_selection (field) {
73 modify_region(field, function (str) read_from_x_primary_selection());
75 interactive("paste-x-primary-selection",
76 "Insert the contents of the X primary selection into the selected field or "+
77 "minibuffer. Deactivates the region if it is active, and leaves the point "+
78 "after the inserted text.",
79 function (I) call_on_focused_field(I, paste_x_primary_selection, true));
82 function open_line (field) {
83 modify_region(field, function() ["\n", 0]);
85 interactive("open-line",
86 "If there is an active region, replace is with a newline, otherwise just "+
87 "insert a newline. In both cases leave point before the inserted newline.",
88 function (I) call_on_focused_field(I, open_line, true));
91 interactive("insert-parentheses",
92 "Insert a pair of parentheses, or surround the currently selected text "+
93 "with a pair of parentheses.",
95 call_on_focused_field(I, function (field) {
98 return ["("+str+")", (str ? str.length+2 : 1)];
104 function transpose_chars (field) {
105 var value = field.value;
106 var caret = field.selectionStart; // Caret position.
107 var length = value.length;
109 // If we have less than two character in the field or if we are at the
110 // beginning of the field, do nothing.
111 if (length < 2 || caret == 0)
114 // If we are at the end of the field, switch places on the two last
115 // characters. TODO: This should happen at the end of every line, not only
116 // at the end of the field.
120 // Do the transposing.
121 field.value = switch_subarrays(value, caret - 1, caret, caret, caret + 1);
123 // Increment the caret position. If this is not done, the caret is left at
124 // the end of the field as a result of the replacing of contents.
125 field.selectionStart = caret + 1;
126 field.selectionEnd = caret + 1;
128 interactive("transpose-chars",
129 "Interchange characters around point, moving forward one character.",
130 function (I) call_on_focused_field(I, transpose_chars, true));
133 interactive("execute-extended-command",
134 "Call a command specified in the minibuffer.",
137 var boc = I.browser_object;
140 prompt = I.key_sequence.join(" ");
142 prompt += ' ['+boc.name+']';
143 if (prefix !== null && prefix !== undefined) {
144 if (typeof prefix == "object")
145 prompt += prefix[0] == 4 ? " C-u" : " "+prefix[0];
147 prompt += " "+prefix;
149 var command = yield I.minibuffer.read_command($prompt = prompt);
150 call_after_timeout(function () {
151 input_handle_command.call(I.window, new command_event(command));
157 /// built in commands
158 // see: http://www.xulplanet.com/tutorials/xultu/commandupdate.html
160 // Performs a command on a browser buffer content area
163 define_builtin_commands(
165 function (I, command) {
166 call_builtin_command(I.window, command);
171 define_builtin_commands(
173 function (I, command) {
174 var buffer = I.buffer;
176 buffer.do_command(command);
178 /* Ignore exceptions */
183 function get_link_text () {
184 var e = document.commandDispatcher.focusedElement;
185 if (e && e.getAttribute("href")) {
186 return e.getAttribute("href");
193 function copy_email_address (loc)
195 // Copy the comma-separated list of email addresses only.
196 // There are other ways of embedding email addresses in a mailto:
197 // link, but such complex parsing is beyond us.
198 var qmark = loc.indexOf( "?" );
201 if ( qmark > 7 ) { // 7 == length of "mailto:"
202 addresses = loc.substring( 7, qmark );
204 addresses = loc.substr( 7 );
207 //XXX: the original code, which we got from firefox, unescapes the string
208 // using the current character set. To do this in conkeror, we
209 // *should* use an interactive method that gives us the character set,
210 // rather than fetching it by side-effect.
212 // // Let's try to unescape it using a character set
213 // // in case the address is not ASCII.
215 // var characterSet = this.target.ownerDocument.characterSet;
216 // const textToSubURI = Components.classes["@mozilla.org/intl/texttosuburi;1"]
217 // .getService(Components.interfaces.nsITextToSubURI);
218 // addresses = textToSubURI.unEscapeURIForUI(characterSet, addresses);
224 writeToClipboard(addresses);
225 message("Copied '" + addresses + "'");
227 interactive("copy-email-address", copy_email_address, ['focused_link_url']);
230 /* FIXME: fix this command */
232 interactive("source",
233 "Load a JavaScript file.",
234 function (fo) { load_rc (fo.path); }, [['f', function (a) { return "Source File: "; }, null, "source"]]);
236 function reinit (window) {
238 var obs = Cc["@mozilla.org/observer-service;1"]
239 .getService(Ci.nsIObserverService);
240 obs.notifyObservers(null, "startupcache-invalidate", null);
241 var path = load_rc();
242 window.minibuffer.message("Loaded: " + path);
244 window.minibuffer.message("Failed to load: "+path);
248 interactive("reinit",
249 "Reload the Conkeror rc file.",
250 function (I) { reinit(I.window); });
252 interactive("help-page", "Open the Conkeror help page.",
253 "find-url-new-buffer",
254 $browser_object = "chrome://conkeror-help/content/help.html");
256 interactive("tutorial", "Open the Conkeror tutorial.",
257 "find-url-new-buffer",
258 $browser_object = "chrome://conkeror-help/content/tutorial.html");
260 function univ_arg_to_number (prefix, default_value) {
261 if (prefix == null) {
262 if (default_value == null)
265 return default_value;
267 if (typeof prefix == "object")
273 interactive("eval-expression",
274 "Evaluate JavaScript statements.",
276 var s = yield I.minibuffer.read(
278 $history = "eval-expression",
279 $completer = javascript_completer(I.buffer));
280 var result = evaluate(s);
281 if (result !== undefined)
282 I.window.minibuffer.message(String(result));
286 function show_extension_manager () {
287 return conkeror.window_watcher.openWindow(
289 "chrome://mozapps/content/extensions/extensions.xul?type=extensions",
291 "resizable=yes,dialog=no",
294 interactive("extensions",
295 "Open the extensions manager in a new window.",
296 show_extension_manager);
298 function print_buffer (buffer) {
299 buffer.top_frame.print();
302 interactive("print-buffer",
303 "Print the currently loaded page.",
304 function (I) { print_buffer(I.buffer); });
306 function view_partial_source (window, charset, selection) {
308 charset = "charset=" + charset;
309 window.window.openDialog("chrome://global/content/viewPartialSource.xul",
310 "_blank", "scrollbars,resizable,chrome,dialog=no",
311 null, charset, selection, 'selection');
313 //interactive ('view-partial-source', view_partial_source, I.current_window, I.content_charset, I.content_selection);
316 function view_mathml_source (window, charset, target) {
318 charset = "charset=" + charset;
319 window.window.openDialog("chrome://global/content/viewPartialSource.xul",
320 "_blank", "scrollbars,resizable,chrome,dialog=no",
321 null, charset, target, 'mathml');
325 function send_key_as_event (window, element, combo) {
326 var split = unformat_key_combo(combo);
327 var event = window.document.createEvent("KeyboardEvent");
340 return element.dispatchEvent(event);
342 return window.dispatchEvent(event);
347 function ensure_content_focused (buffer) {
348 var foc = buffer.focused_frame_or_null;
350 buffer.top_frame.focus();
352 interactive("ensure-content-focused", "Ensure that the content document has focus.",
353 function (I) { ensure_content_focused(I.buffer); });
356 function network_set_online_status (status) {
357 const io_service = Cc["@mozilla.org/network/io-service;1"]
358 .getService(Ci.nsIIOService2);
360 io_service.manageOfflineStatus = false;
361 io_service.offline = status;
363 interactive("network-go-online", "Work online.",
364 function (I) { network_set_online_status(true); });
366 interactive("network-go-offline", "Work offline.",
367 function (I) { network_set_online_status(false); });
370 interactive("submit-form",
371 "Submit the form to which the focused element belongs.",
373 var el = I.buffer.focused_element.parentNode;
374 while (el && el.tagName != "FORM")
377 var inputs = el.getElementsByTagName("input");
378 for (var i = 0, ilen = inputs.length; i < ilen; i++) {
379 if (inputs[i].getAttribute("type") == "submit")
380 return browser_object_follow(I.buffer, FOLLOW_DEFAULT,
389 * Browser Object Commands
391 interactive("follow", null,
392 alternates(follow, follow_new_buffer, follow_new_window),
393 $browser_object = browser_object_links);
395 interactive("follow-top", null,
396 alternates(follow_current_buffer, follow_current_frame),
397 $browser_object = browser_object_frames,
400 interactive("follow-new-buffer",
401 "Follow a link in a new buffer",
402 alternates(follow_new_buffer, follow_new_window),
403 $browser_object = browser_object_links,
406 interactive("follow-new-buffer-background",
407 "Follow a link in a new buffer in the background",
408 alternates(follow_new_buffer_background, follow_new_window),
409 $browser_object = browser_object_links,
412 interactive("follow-new-window",
413 "Follow a link in a new window",
415 $browser_object = browser_object_links,
418 interactive("find-url", "Open a URL in the current buffer",
419 alternates(follow_current_buffer, follow_new_buffer, follow_new_window),
420 $browser_object = browser_object_url);
422 interactive("find-url-new-buffer",
423 "Open a URL in a new buffer",
424 alternates(follow_new_buffer, follow_new_window),
425 $browser_object = browser_object_url,
426 $prompt = "Find url");
428 interactive("find-url-new-window", "Open a URL in a new window",
430 $browser_object = browser_object_url,
431 $prompt = "Find url");
433 interactive("find-alternate-url", "Edit the current URL in the minibuffer",
436 define_browser_object_class("alternate-url", null,
437 function (I, prompt) {
438 check_buffer(I.buffer, content_buffer);
439 var result = yield I.buffer.window.minibuffer.read_url(
441 $initial_value = I.buffer.display_uri_string);
442 yield co_return(result);
444 $prompt = "Find url");
447 interactive("up", "Go to the parent directory of the current URL",
449 $browser_object = browser_object_up_url);
452 "Go to the homepage in the current buffer.", "follow",
453 $browser_object = function () { return homepage; });
455 interactive("make-window",
456 "Make a new window with the homepage.",
458 $browser_object = function () { return homepage; });
460 interactive("focus", null,
462 var element = yield read_browser_object(I);
463 browser_element_focus(I.buffer, element);
465 $browser_object = browser_object_frames);
468 "Save a browser object.",
470 var element = yield read_browser_object(I);
471 var spec = load_spec(element);
473 panel = create_info_panel(I.window, "download-panel",
475 element_get_operation_label(element, "Saving"),
476 load_spec_uri_string(spec)],
477 ["mime-type", "Mime type:", load_spec_mime_type(spec)]]);
479 var file = yield I.minibuffer.read_file_check_overwrite(
480 $prompt = "Save as:",
481 $initial_value = suggest_save_path_from_file_name(suggest_file_name(spec), I.buffer),
490 $browser_object = browser_object_links);
493 interactive("copy", null,
494 alternates(copy_text, copy_text_append),
495 $browser_object = browser_object_links);
497 interactive("paste-url", "Open a URL from the clipboard in the current buffer.",
498 alternates(follow_current_buffer, follow_new_buffer, follow_new_window),
499 $browser_object = browser_object_paste_url);
501 interactive("paste-url-new-buffer", "Open a URL from the clipboard in a new buffer.",
502 alternates(follow_new_buffer, follow_new_window),
503 $browser_object = browser_object_paste_url);
505 interactive("paste-url-new-window", "Open a URL from the clipboard in a new window.",
507 $browser_object = browser_object_paste_url);
509 interactive("view-source",
510 "Toggle between source and rendered views of a URL.",
511 alternates(view_source, view_source_new_buffer, view_source_new_window),
512 $browser_object = browser_object_frames);
515 interactive("shell-command-on-url",
516 "Run a shell command on the url of a browser object.",
518 var cwd = I.local.cwd;
519 var element = yield read_browser_object(I);
520 var spec = load_spec(element);
521 var uri = load_spec_uri_string(spec);
523 panel = create_info_panel(I.window, "download-panel",
525 element_get_operation_label(element, "Running on", "URI"),
526 load_spec_uri_string(spec)],
527 ["mime-type", "Mime type:", load_spec_mime_type(spec)]]);
529 var cmd = yield I.minibuffer.read_shell_command(
531 $initial_value = load_spec_default_shell_command(spec));
535 shell_command_with_argument_blind(cmd, uri, $cwd = cwd);
537 $browser_object = browser_object_url,
538 $prompt = "Shell command");
541 interactive("shell-command-on-file",
542 "Download a document to a temporary file and run a shell command on it.",
544 var cwd = I.local.cwd;
545 var element = yield read_browser_object(I);
546 var spec = load_spec(element);
547 var uri = load_spec_uri_string(spec);
549 panel = create_info_panel(I.window, "download-panel",
551 element_get_operation_label(element, "Running on"),
552 load_spec_uri_string(spec)],
553 ["mime-type", "Mime type:", load_spec_mime_type(spec)]]);
555 var cmd = yield I.minibuffer.read_shell_command(
557 $initial_value = load_spec_default_shell_command(spec));
561 yield browser_element_shell_command(I.buffer, element, cmd, cwd);
563 $browser_object = browser_object_links,
564 $prompt = "Shell command");
567 interactive("bookmark",
568 "Create a bookmark.",
570 var element = yield read_browser_object(I);
571 var spec = load_spec(element);
572 var uri_string = load_spec_uri_string(spec);
574 panel = create_info_panel(I.window, "bookmark-panel",
576 element_get_operation_label(element, "Bookmarking"),
579 var title = yield I.minibuffer.read($prompt = "Bookmark with title:", $initial_value = load_spec_title(spec) || "");
583 add_bookmark(uri_string, title);
584 I.minibuffer.message("Added bookmark: " + uri_string + " - " + title);
586 $browser_object = browser_object_frames);
589 interactive("save-page",
590 "Save a document, not including any embedded documents such as images "+
593 check_buffer(I.buffer, content_buffer);
594 var element = yield read_browser_object(I);
595 var spec = load_spec(element);
596 if (!load_spec_document(spec))
597 throw interactive_error("Element is not associated with a document.");
598 var suggested_path = suggest_save_path_from_file_name(suggest_file_name(spec), I.buffer);
601 panel = create_info_panel(I.window, "download-panel",
603 element_get_operation_label(element, "Saving"),
604 load_spec_uri_string(spec)],
605 ["mime-type", "Mime type:", load_spec_mime_type(spec)]]);
608 var file = yield I.minibuffer.read_file_check_overwrite(
609 $prompt = "Save page as:",
611 $initial_value = suggested_path);
616 save_uri(spec, file, $buffer = I.buffer);
618 $browser_object = browser_object_frames);
621 interactive("save-page-as-text",
622 "Save a page as plain text.",
624 check_buffer(I.buffer, content_buffer);
625 var element = yield read_browser_object(I);
626 var spec = load_spec(element);
628 if (!(doc = load_spec_document(spec)))
629 throw interactive_error("Element is not associated with a document.");
630 var suggested_path = suggest_save_path_from_file_name(suggest_file_name(spec, "txt"), I.buffer);
633 panel = create_info_panel(I.window, "download-panel",
635 element_get_operation_label(element, "Saving", "as text"),
636 load_spec_uri_string(spec)],
637 ["mime-type", "Mime type:", load_spec_mime_type(spec)]]);
640 var file = yield I.minibuffer.read_file_check_overwrite(
641 $prompt = "Save page as text:",
643 $initial_value = suggested_path);
648 save_document_as_text(doc, file, $buffer = I.buffer);
650 $browser_object = browser_object_frames);
653 interactive("save-page-complete",
654 "Save a page and all supporting documents, including images, css, "+
655 "and child frame documents.",
657 check_buffer(I.buffer, content_buffer);
658 var element = yield read_browser_object(I);
659 var spec = load_spec(element);
661 if (!(doc = load_spec_document(spec)))
662 throw interactive_error("Element is not associated with a document.");
663 var suggested_path = suggest_save_path_from_file_name(suggest_file_name(spec), I.buffer);
666 panel = create_info_panel(I.window, "download-panel",
668 element_get_operation_label(element, "Saving complete"),
669 load_spec_uri_string(spec)],
670 ["mime-type", "Mime type:", load_spec_mime_type(spec)]]);
673 var file = yield I.minibuffer.read_file_check_overwrite(
674 $prompt = "Save page complete:",
676 $initial_value = suggested_path);
677 // FIXME: use proper read function
678 var dir = yield I.minibuffer.read_file(
679 $prompt = "Data Directory:",
681 $initial_value = file.path + ".support");
686 save_document_complete(doc, file, dir, $buffer = I.buffer);
688 $browser_object = browser_object_frames);
691 function view_as_mime_type (I, target) {
693 var element = yield read_browser_object(I);
694 var spec = load_spec(element);
697 target = FOLLOW_CURRENT_FRAME;
699 if (!can_override_mime_type_for_uri(load_spec_uri(spec)))
700 throw interactive_error("Overriding the MIME type is not currently supported for non-HTTP URLs.");
704 var mime_type = load_spec_mime_type(spec);
705 panel = create_info_panel(I.window, "download-panel",
707 element_get_operation_label(element, "View in browser"),
708 load_spec_uri_string(spec)],
709 ["mime-type", "Mime type:", load_spec_mime_type(spec)]]);
713 let suggested_type = mime_type;
714 if (viewable_mime_type_list.indexOf(suggested_type) == -1)
715 suggested_type = "text/plain";
716 mime_type = yield I.minibuffer.read_viewable_mime_type(
717 $prompt = "View internally as",
718 $initial_value = suggested_type,
720 yield override_mime_type_for_next_load(load_spec_uri(spec), mime_type);
721 browser_object_follow(I.buffer, target, spec);
727 function view_as_mime_type_new_buffer (I) {
728 yield view_as_mime_type(I, OPEN_NEW_BUFFER);
731 function view_as_mime_type_new_window (I) {
732 yield view_as_mime_type(I, OPEN_NEW_WINDOW);
735 interactive("view-as-mime-type",
736 "Display a browser object in the browser using the specified MIME type.",
737 alternates(view_as_mime_type,
738 view_as_mime_type_new_buffer,
739 view_as_mime_type_new_window),
740 $browser_object = browser_object_frames);
743 interactive("delete",
744 "Delete a DOM node, given as a browser object.",
746 var elem = yield read_browser_object(I);
747 if (! (elem instanceof Ci.nsIDOMNode))
748 throw interactive_error("Cannot delete item");
749 elem.parentNode.removeChild(elem);
751 $browser_object = browser_object_dom_node);
754 interactive("charset-prefix",
755 "A prefix command that prompts for a charset to use in a "+
756 "subsequent navigation command.",
758 var ccman = Cc["@mozilla.org/charset-converter-manager;1"]
759 .getService(Ci.nsICharsetConverterManager);
760 var decoders = ccman.getDecoderList()
762 while (decoders.hasMore())
763 charsets.push(decoders.getNext());
764 I.forced_charset = yield I.minibuffer.read(
765 $prompt = "Charset:",
766 $completer = prefix_completer(
767 $completions = charsets,
768 $get_string = function (x) x.toLowerCase()),
775 interactive("reload-with-charset",
776 "Prompt for a charset, and reload the current page, forcing use "+
779 var ccman = Cc["@mozilla.org/charset-converter-manager;1"]
780 .getService(Ci.nsICharsetConverterManager);
781 var decoders = ccman.getDecoderList()
783 while (decoders.hasMore())
784 charsets.push(decoders.getNext());
785 var forced_charset = yield I.minibuffer.read(
786 $prompt = "Charset:",
787 $completer = prefix_completer(
788 $completions = charsets,
789 $get_string = function (x) x.toLowerCase()),
792 reload(I.buffer, false, null, forced_charset);
797 "Paste the contents of the clipboard",
799 call_builtin_command(I.window, "cmd_paste", true);
802 interactive("kill-region",
803 "Kill (\"cut\") the selected text.",
805 call_builtin_command(I.window, "cmd_cut", true);
808 interactive("kill-ring-save",
809 "Save the region as if killed, but don't kill it.",
811 call_builtin_command(I.window, "cmd_copy", true);
814 interactive("password-manager",
815 "Open the password manager.",
816 "find-url-new-buffer",
817 $browser_object = "chrome://passwordmgr/content/passwordManager.xul");
820 interactive("toggle-full-screen",
821 "Toggle full screen mode for the current window.",
823 window_set_full_screen(I.window);
824 if (I.window.fullScreen)
825 I.minibuffer.message("Fullscreen mode on");
827 I.minibuffer.message("Fullscreen mode off");
831 interactive("image-toggle-zoom-to-fit",
832 "Toggle zoom-to-fit (viewport) on an image document.",
835 var doc = I.buffer.document
836 .QueryInterface(Ci.nsIImageDocument);
837 doc.toggleImageSize();
838 zoom_hook.run(I.buffer);
840 I.minibuffer.message("Not an image document");