modules/interactive.js

   1 /**
   2  * (C) Copyright 2007-2009 John J. Foerch
   3  * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
   4  *
   5  * Use, modification, and distribution are subject to the terms specified in the
   6  * COPYING file.
   7 **/
   8
   9 require("utils.js");
  10
  11 var interactive_commands = {};
  12
  13 /**
  14  * name: string name of the command.
  15  *
  16  * doc: Documentation string, may be null.
  17  *
  18  * handler: A function to handle the command.
  19  *
  20  * The $prefix keyword, when true, means that the command
  21  * is a prefix-command.
  22  */
  23 define_keywords("$prefix", "$browser_object", "$prompt");
  24 function interactive (name, doc, handler) {
  25     keywords(arguments);
  26     var cmd = {
  27         name: name,
  28         handler: handler,
  29         browser_object: arguments.$browser_object,
  30         prefix: arguments.$prefix,
  31         doc: doc,
  32         shortdoc: get_shortdoc_string(doc),
  33         prompt: arguments.$prompt,
  34         source_code_reference: get_caller_source_code_reference() };
  35     interactive_commands[name] = cmd;
  36     return name;
  37 }
  38
  39 function interactive_error (str) {
  40     var e = new Error(str);
  41     e.__proto__ = interactive_error.prototype;
  42     return e;
  43 }
  44 interactive_error.prototype.__proto__ = Error.prototype;
  45
  46
  47 function interactive_context (buffer) {
  48     this.local = conkeror;
  49     this.buffer = buffer;
  50     if (buffer) {
  51         this.window = this.buffer.window;
  52         if (buffer.page) {
  53             this.local = buffer.page.local;
  54         } else {
  55             this.local = buffer.local;
  56         }
  57     }
  58 }
  59 interactive_context.prototype = {
  60     constructor: interactive_context,
  61
  62     get P () this.prefix_argument,
  63
  64     get p () univ_arg_to_number(this.prefix_argument),
  65
  66     set p (default_value) univ_arg_to_number(this.prefix_argument, default_value),
  67
  68     get minibuffer () this.window.minibuffer,
  69 };
  70
  71
  72 function handle_interactive_error (window, e) {
  73     if (! window)
  74         throw e;
  75     if (e instanceof interactive_error) {
  76         window.minibuffer.message(e.message);
  77     } else if (e instanceof abort) {
  78         window.minibuffer.message("Quit");
  79     } else {
  80         dump_error(e);
  81         window.minibuffer.message("call interactively: " + e);
  82     }
  83 }
  84
  85 function call_interactively (I, command) {
  86     var handler;
  87     var window = I.window;
  88
  89     if (typeof command == "function") {
  90         // Special interactive command
  91         command(I);
  92         yield co_return();
  93     }
  94
  95     var cmd = interactive_commands[command];
  96     if (!cmd) {
  97         handle_interactive_error(
  98             window,
  99             interactive_error("Invalid command: " + command));
 100         yield co_return();
 101     }
 102
 103     I.command = cmd;
 104     handler = cmd.handler;
 105
 106     try {
 107         while (typeof handler == "string") {
 108             let parent = interactive_commands[handler];
 109             handler = parent.handler;
 110             if (handler == command) {
 111                 throw (interactive_error("circular command alias, "+command));
 112             }
 113         }
 114
 115         try {
 116             yield handler(I);
 117         } catch (e) {
 118             handle_interactive_error(window, e);
 119         }
 120     } catch (e) {
 121         handle_interactive_error(window, e);
 122     }
 123 }
 124
 125
 126 function alternates () {
 127     let alts = Array.prototype.slice.call(arguments, 0);
 128     return function (I) {
 129         var index = 0;
 130         if (I.prefix_argument instanceof Array) {
 131             let num = I.prefix_argument = I.prefix_argument[0];
 132             while (num >= 4 && index + 1 < alts.length) {
 133                 num = num / 4;
 134                 index++;
 135             }
 136         }
 137         yield alts[index](I);
 138     };
 139 }
 140
 141
 142 /*
 143  * Utility functions for use in the rc to alter the behavior
 144  * of interactive commands.
 145  */
 146 function set_handler (name, handler) {
 147     var cmd = interactive_commands[name];
 148     cmd.handler = handler;
 149 }
 150
 151 function set_default_browser_object (name, browser_object) {
 152     var cmd = interactive_commands[name];
 153     cmd.browser_object = browser_object;
 154 }
 155
 156 provide("interactive");