2 * (C) Copyright 2007-2009 John J. Foerch
3 * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
5 * Use, modification, and distribution are subject to the terms specified in the
13 var interactive_commands = new string_hashmap();
16 * name: string name of the command.
18 * doc: Documentation string, may be null.
20 * handler: A function to handle the command.
22 * The $prefix keyword, when true, means that the command
23 * is a prefix-command.
25 define_keywords("$prefix", "$browser_object", "$prompt");
26 function interactive (name, doc, handler) {
31 browser_object: arguments.$browser_object,
32 prefix: arguments.$prefix,
34 shortdoc: get_shortdoc_string(doc),
35 prompt: arguments.$prompt,
36 source_code_reference: get_caller_source_code_reference() };
38 interactive_commands.put(name, cmd);
42 function interactive_error (str) {
43 var e = new Error(str);
44 e.__proto__ = interactive_error.prototype;
47 interactive_error.prototype.__proto__ = Error.prototype;
50 function interactive_context (buffer) {
51 this.local = conkeror;
54 this.window = this.buffer.window;
56 this.local = buffer.page.local;
58 this.local = buffer.local;
62 interactive_context.prototype = {
63 constructor: interactive_context,
65 get P () this.prefix_argument,
67 get p () univ_arg_to_number(this.prefix_argument),
69 set p (default_value) univ_arg_to_number(this.prefix_argument, default_value),
71 get minibuffer () this.window.minibuffer,
75 function handle_interactive_error (window, e) {
78 if (e instanceof interactive_error) {
79 window.minibuffer.message(e.message);
80 } else if (e instanceof abort) {
81 window.minibuffer.message("Quit");
84 window.minibuffer.message("call interactively: " + e);
88 function call_interactively (I, command) {
90 var window = I.window;
92 if (typeof command == "function") {
93 // Special interactive command
98 var cmd = interactive_commands.get(command);
100 handle_interactive_error(
102 interactive_error("Invalid command: " + command));
109 // if there was no interactive browser-object,
110 // binding_browser_object becomes the default.
111 if (I.browser_object == null) {
112 I.browser_object = I.binding_browser_object;
114 // if the command's default browser object is a non-null literal,
115 // it overrides an interactive browser-object, but not a binding
117 if (cmd.browser_object != null &&
118 (! (cmd.browser_object instanceof browser_object_class)) &&
119 (I.binding_browser_object == null))
121 I.browser_object = cmd.browser_object;
123 // if we still have no browser-object, look for a page-mode
124 // default, or finally the command default.
125 if (I.browser_object == null) {
127 (I.buffer && I.buffer.default_browser_object_classes[command]) ||
131 handler = cmd.handler;
134 while (typeof handler == "string") {
135 let parent = interactive_commands.get(handler);
136 handler = parent.handler;
137 if (handler == command) {
138 throw (interactive_error("circular command alias, "+command));
145 handle_interactive_error(window, e);
148 handle_interactive_error(window, e);
153 function alternates () {
154 let alts = Array.prototype.slice.call(arguments, 0);
155 return function (I) {
157 if (I.prefix_argument instanceof Array) {
158 let num = I.prefix_argument = I.prefix_argument[0];
159 while (num >= 4 && index + 1 < alts.length) {
164 yield alts[index](I);
170 * Utility functions for use in the rc to alter the behavior
171 * of interactive commands.
173 function set_handler (name, handler) {
174 var cmd = interactive_commands.get(name);
175 cmd.handler = handler;
178 function set_default_browser_object (name, browser_object) {
179 var cmd = interactive_commands.get(name);
180 cmd.browser_object = browser_object;
183 provide("interactive");