summaryrefslogtreecommitdiff
path: root/js/prolog.js
blob: 429ac7220c78f0dc5fa7bebf6594550c348fe53e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
/**
 * Handler for a Prolog assignment. Works with the corresponding prolog.html content.
 */

(function () {
    // a constant
    var firstCharacterPos = {'line': 0, 'ch': 0};

    var makePrologTerminalHandler = function (jqConsole, editor, problem_id, activityHandler) {
        var promptMode = true, // default: query composition; alternative: query result browsing
            tcs = function terminalCommandSuccess (data) {
                var t, lines, i;
                terminal.resume();
                if (data.code === 0) {
                    t = data.terminal;
                    lines = t.messages;
                    for (i = 0; i < lines.length; i++) {
                        terminal.echo(lines[i]);
                    }
                    promptMode = !t.have_more;
                }
                else {
                    terminal.error(data.message);
                    promptMode = true;
                }
            },
            tcf = function terminalCommandFailed (error) {
                terminal.resume();
                terminal.exception(error);
                promptMode = true;
            },
            terminal = jqConsole.terminal(function (command, terminal) {
                if (promptMode) {
                    terminal.pause();
                    codeq.comms.sendQuery({
                        'step': 'run',
                        'program': editor.getDoc().getValue(),
                        'query': command,
                        'problem_id': problem_id,
                        'trace': activityHandler.addAndPurge({'typ': 'slv', 'qry': command})
                    }).then(tcs, tcf).done();
                }
                else {
                    // not in prompt mode -- we should never land here, but handle it anyway
                    codeq.comms.sendQuery({
                        'step': 'end',
                        'trace': activityHandler.addAndPurge({'typ': 'stp'})
                    }).then(tcs, tcf).done();
                }
            }, {
                'history': true,
                'prompt': '?- ',
                'greetings': 'CodeQ prolog terminal proxy',
                'exit': false,
                'clear': false,
                'keypress': function (event, terminal) {
                    if (promptMode) return true;
                    setTimeout(function () {
                        terminal.echo(''); // send newline after semicolon or full-stop
                        terminal.pause();
                    }, 0);
                    if ((event.which == 32) || (event.which == 59)) {
                        // space or semicolon -> show next answer
                        event.which = 59; // semicolon
                        codeq.comms.sendQuery({
                            'step': 'next',
                            'trace': activityHandler.addAndPurge({'typ': 'nxt'})
                        }).then(tcs, tcf).done();
                    }
                    else {
                        // everything else: stop searching for answers
                        event.which = 46; // full stop
                        codeq.comms.sendQuery({
                            'step': 'end',
                            'trace': activityHandler.addAndPurge({'typ': 'stp'})
                        }).then(tcs, tcf).done();
                    }
                }
            });

        return {};
    };

    var makeActivityHandler = function (editor) {
        var lastActivityMillis = Date.now(),
            deltaActivityMillis = function deltaActivityMillisFunc () {
                var now = Date.now(),
                    dt = Math.max(0, Math.min(30000, now - lastActivityMillis)); // 0 sec <= dt <= 30 sec
                lastActivityMillis = now;
                return dt;
            },
            queue = [],
            ts = null,
            timer = function () {
                var promise;
                ts = null;
                if (queue.length === 0) return Q(true);
                promise = codeq.comms.sendActivity(queue, editor.getDoc().getValue());
                queue.length = 0;
                return promise;
            },
            flush = function () {
                clearTimeout(ts);
                return timer();
            };

        return {
            "trace": function (trace) {
                trace['dt'] = deltaActivityMillis();
                return trace;
            },
            'queue': function (trace) {
                queue.push(trace);
                if (ts === null) setTimeout(timer, 10000); // flush every 10 seconds
            },
            'queueTrace': function (trace) {
                this.queue(this.trace(trace));
            },
            'flush': flush,
            'addAndPurge': function (trace) {
                var accumulatedTrace = queue;
                queue = [];
                trace['dt'] = deltaActivityMillis();
                accumulatedTrace.push(trace);
                if (ts !== null) {
                    clearTimeout(ts);
                    ts = null;
                }
                return accumulatedTrace;
            }
        };
    };

    /**
     * Creates a new handler for the given Prolog assignment definition.
     *
     * @param {PrologTaskDef} info
     * @returns {{destroy: Function, processServerHints: Function}}
     */
    codeq.createPrologHandler = function (info) {
        var problem = info.problem,
            jqDescription = $('#description'),
            jqEditor = $('#code_editor'),
            jqConsole = $('#console'),
            jqHints = $('#info'),
            editor = CodeMirror(jqEditor[0], { cursorHeight: 0.85, lineNumbers: true, matchBrackets: true }),
            activityHandler = makeActivityHandler(editor),
/*            controller = jqConsole.console({
                promptLabel: '?- ',
                commandValidate: function (line) {
                    return !!line;
                },
                commandHandle: function (line) {
                    return [{msg:'Not implemented.', className:'console-response'}];
                },
                autofocus: false,
                animateScroll: false,
                promptHistory: false,
                welcomeMessage: 'Prolog REPL.'
            }),*/
            terminal = makePrologTerminalHandler(jqConsole, editor, problem.id, activityHandler),
            /** Object.<string, HintDefinition> */
            hintDefs = problem.hint,
            hintCounter = 0, // for generating unique class-names
            hintCleaners = [],
            clearHints = function () {
                var i;
                for (i = hintCleaners.length - 1; i >= 0; i--) {
                    hintCleaners[i]();
                }
                hintCleaners.length = 0;
                hintCounter = 0;
            },
            addMark = function (start, end) {
                var posStart = editor.posFromIndex(start),
                    posEnd = editor.posFromIndex(end),
                    doc = editor.getDoc(),
                    mark = doc.markText(posStart, posEnd, {className: 'editor-mark _emark_' + hintCounter}),
                    result = {start: posStart, end: posEnd, mark: mark, className: '_emark_' + hintCounter};
                hintCleaners.push(function () { mark.clear(); mark = null; doc = null; result.mark = null; });
                hintCounter++;
                return result;
            },
            hintHandlers = {
                'static': function (type, template, serverHint) {
                    codeq.log.debug('Processing static hint');
                    jqHints.append('<div class="hint-static">' + template + '</div>'); // TODO: incorporate any serverHint.args
                    // no hint cleaner here, a static hint remains on the screen
                },
                'popup': function (type, template, serverHint) {
                    codeq.log.debug('Processing popup hint');
                    var mark = addMark(serverHint.start, serverHint.end), // add the mark
                        jqMark = jqEditor.find('.' + mark.className);
/*                        jqPopup = null,
                        onBlur = function () {
                            codeq.log.debug('Removing popup');
                            if (jqPopup) {
                                jqPopup.off('blur', onBlur);
                                jqPopup.remove();
                                jqPopup = null;
                            }
                        };

                    window.jqMark = jqMark; // TODO: DEBUG

                    jqMark.on('click', function () {
                        if (jqPopup) return;
                        codeq.log.debug('Showing popup');
                        var pos = mark.mark.find(), // results in {from: {line: number, ch: number}, to: {line: number, ch: number}}
                            left = pos.from.ch < pos.to.ch ? pos.from.ch : pos.to.ch,
                            down = pos.from.line < pos.to.line ? pos.to.line : pos.from.line;
                        jqPopup = $('<div style="position: absolute;" class="editor-popup ' + mark.className + '"></div>').html(template);
                        editor.addWidget({line: down, ch: left}, jqPopup[0], true);
                        jqPopup = jqEditor.find('.editor-popup.' + mark.className);
                        setTimeout(function () {jqPopup.trigger('focus'); jqPopup.on('click', onBlur);}, 50); // event handlers can be registered only when the DOM elements is part of the document
                        window.jqPopup = jqPopup; // TODO: DEBUG
                    });

                    hintCleaners.push(function () {
                        if (jqPopup) {
                            jqPopup.off('blur', onBlur);
                            jqPopup.remove();
                            jqPopup = null;
                        }
                        if (jqMark) {
                            jqMark = null;
                        }
                        mark = null;
                    });*/

                    jqMark.popover({content: template, html: true, placement: 'auto bottom', trigger: 'hover focus click', container: 'body'});
                    hintCleaners.push(function () { if (jqMark) { jqMark.popover('destroy'); jqMark = null; } });

                    mark.mark.on('', function () {});
                },
                'dropdown': function (type, template, serverHint) {
                    codeq.log.debug('Processing dropdown hint');
                    var completion = null, // the completion object, created in showHint()
                        close = function () {
                            if (completion) {
                                completion.close();
                                completion = null;
                            }
                        };

                    if ((editor.listSelections().length > 1) || editor.somethingSelected()) {
                        // showHint() doesn't work if a selection is activeparts
                    }

                    editor.showHint({
                        hint: function () {
                            var hints = {
                                list: serverHint.choices,
                                from: editor.posFromIndex(serverHint.start),
                                to: editor.posFromIndex(serverHint.end)
                            };
                            completion = editor.state.completionActive;
                            return hints;
                        },
                        completeOnSingleClick: true,
                        completeSingle: false
                    });

                    hintCleaners.push(close);
                }
            };

        editor.setValue(info.solution);
        $('#title').text(problem.slug);
        jqDescription.html(problem.description);

        editor.on('change', function (instance, changeObj) {
            var doc = editor.getDoc(),
                pos = codeq.codePointCount(doc.getRange(firstCharacterPos, changeObj.from));

            if (changeObj.removed) {
                activityHandler.queueTrace({'typ': 'rm', 'off': pos, 'len': codeq.codePointCount(changeObj.removed)});
            }

            if (changeObj.text) {
                activityHandler.queueTrace({'typ': 'ins', 'off': pos, 'txt': changeObj.text});
            }
        });

        var handler = {
            destroy: function () {
                jqDescription.empty();
                jqEditor.empty(); // TODO: perhaps you do not want to "free" the editor, just empty it
                jqConsole.empty(); // TODO: the same with the console
                jqHints.empty(); // TODO: just make static references to these
                jqDescription = null;
                jqEditor = null;
                jqConsole = null;
                jqHints = null;
            },

            /**
             * Processes and display appropriately the server hints.
             * TODO: sort hints so static and popup hints come first, and a (single) drop-down hint last
             *
             * @param {ServerHint[]} serverHints an array of hints from the server
             */
            processServerHints: function (serverHints) {
                var n = serverHints.length,
                    /** number */ i,
                    /** ServerHint */ serverHint,
                    /** HintDefinition */ hintDef,
                    hintType, hintTemplate, t, fn;
                clearHints();
                for (i = 0; i < n; i++) {
                    serverHint = serverHints[i];
                    hintDef = hintDefs[serverHint.id];
                    if (!hintDef) {
                        codeq.log.error('Undefined hint: ' + serverHint.id);
                        continue;
                    }
                    t = typeof hintDef;
                    if (t === 'object') {
                        hintType = hintDef.type;
                        hintTemplate = hintDef.message;
                    }
                    else if (t === 'string') {
                        hintType = 'static';
                        hintTemplate = hintDef;
                    }
                    else {
                        codeq.log.error('Unsupported hint definition: ' + t);
                        continue;
                    }

                    fn = hintHandlers[hintType];
                    if (!fn) codeq.log.error('Unsupported hint type: ' + hintType);
                    else fn(hintType, hintTemplate, serverHint);
                }
            }
        };

        var jqButtons = $('#block-toolbar button');
//        $(jqButtons.get(0)).on('click', function () { handler.processServerHints([{id:'x_must_be_female'}]); });
//        $(jqButtons.get(1)).on('click', function () { handler.processServerHints([{id:'popup_unknown', start: 20, end: 26}]); });
//        $(jqButtons.get(2)).on('click', function () { handler.processServerHints([{id:'drop_down', start: 20, end: 26, choices:['ena', 'dva', 'tri']}]); });

        $('#btn_code_run').on('click', function () {
            var doc = editor.getDoc();
//            codeq.comms.sendActivity({'typ': 'slv', 'dt': dt, 'qry': });
//            handler.processServerHints([{id:'list_empty'}]);
        });
        $('#btn_code_break').on('click', function () {
//            handler.processServerHints([{id:'popup_unknown', start: 20, end: 26}]);
        });
        $('#btn_code_hint').on('click', function () {
//            handler.processServerHints([{id:'drop_down', start: 20, end: 26, choices:['ena', 'dva', 'tri']}]);
        });

        return handler;
    };
})();