added prolog state (I missed it in the previous commit)

1 files changed, 501 insertions, 0 deletions

diff --git a/js/codeq/prolog.js b/js/codeq/prolog.js
new file mode 100644
index 0000000..7c9ebb7
--- /dev/null
+++ b/js/codeq/prolog.js
@@ -0,0 +1,501 @@
+/**
+ * Created by robert on 9/17/15.
+ */
+
+(function() {
+    var problems,//this will the actual (sub)state machine
+        stateNameTag = 'stateName';
+
+    var divs = {};
+    divs['description'] = $('div.col-lg-3.col-md-6.col-sm-12:has(#description)');//lets actually find the needed divs for later use
+    divs['code'] = $('div.col-lg-3.col-md-6.col-sm-12:has(#code_editor)');
+    divs['console'] = $('div.col-lg-3.col-md-6.col-sm-12:has(#console)');//named 'consoleDiv', because 'console' is already in use
+    divs['info'] = $('div.col-lg-3.col-md-6.col-sm-12:has(#info)');
+
+    divs['description'].data(stateNameTag, 'description');
+    divs['code'].data(stateNameTag, 'code');
+    divs['console'].data(stateNameTag, 'console');
+    divs['info'].data(stateNameTag, 'info');
+
+    var eventName = 'mousedown',//event name of the event which will trigger the transition between these substates
+        mouseDownEventFunction = function () {
+            problems.transition($(this).data(stateNameTag));
+        },
+        removeListenersFromDivs = function () {
+            $.each(divs, function (i, value) {
+                value.off(eventName, mouseDownEventFunction);
+            });
+        },
+        removeBlockClassesFromDivs = function () {
+            $.each(divs, function (i, value) {
+                value.removeClass('block');
+            });
+        },
+        removeChangedClassesFromDivs = function () {
+            $.each(divs, function (i, value) {
+                value.removeClass('block-focus block-less-width block-less-height block-less-everything').addClass('block');//these class names were chosen for the view where the screen is partitioned in 4 quarters (2 by 2)
+            });
+        },
+        setTransitionsBetweenDivs = function (current) {
+            $.each(divs, function (key, value) {
+                if (current !== key) value.on(eventName, mouseDownEventFunction);
+            });
+        },
+        addClassesToDivs = function (divsWithClasses) {
+            $.each(divsWithClasses, function (divName, className) {
+                divs[divName].addClass(className);
+            });
+        },
+        substates = {
+            'description': {
+                'enter': function () {
+                    removeBlockClassesFromDivs();
+                    addClassesToDivs({
+                        'description': 'block-focus',
+                        'code': 'block-less-width',
+                        'console': 'block-less-height',
+                        'info': 'block-less-everything'
+                    });
+                    setTransitionsBetweenDivs('description');
+                },
+                'exit': function () {
+                    removeChangedClassesFromDivs();
+                    removeListenersFromDivs();
+                }
+            },
+            'code': {
+                'enter': function () {
+                    removeBlockClassesFromDivs();
+                    addClassesToDivs({
+                        'description': 'block-less-width',
+                        'code': 'block-focus',
+                        'console': 'block-less-everything',
+                        'info': 'block-less-height'
+                    });
+                    setTransitionsBetweenDivs('code');
+                },
+                'exit': function () {
+                    removeChangedClassesFromDivs();
+                    removeListenersFromDivs();
+                }
+            },
+            'info': {
+                'enter': function () {
+                    removeBlockClassesFromDivs();
+                    addClassesToDivs({
+                        'description': 'block-less-everything',
+                        'code': 'block-less-height',
+                        'console': 'block-less-width',
+                        'info': 'block-focus'
+                    });
+                    setTransitionsBetweenDivs('info');
+                },
+                'exit': function () {
+                    removeChangedClassesFromDivs();
+                    removeListenersFromDivs();
+                }
+            },
+            'console': {
+                'enter': function () {
+                    removeBlockClassesFromDivs();
+                    addClassesToDivs({
+                        'description': 'block-less-height',
+                        'code': 'block-less-everything',
+                        'console': 'block-focus',
+                        'info': 'block-less-width'
+                    });
+                    setTransitionsBetweenDivs('console');
+                },
+                'exit': function () {
+                    removeChangedClassesFromDivs();
+                    removeListenersFromDivs();
+                }
+            }
+        };
+    var prologHandler;
+    codeq.globalStateMachine.register('prolog', {
+        'enter': function (data) {
+            $('#disabled').css('display', '');
+            $('#screen_prolog').css('display', '');//we have to show the screen now so the code editor shopws its initial values correctly
+            prologHandler = createPrologHandler(data.data)//codeq.createProgrammingLanguageHandler('prolog',data.data,codeq.makePrologTerminalHandler);
+            problems = codeq.makeStateMachine(substates);
+            problems.transition(divs['description'].data(stateNameTag));
+            Q.delay(100).then(function(){
+                $('div.col-lg-3.col-md-6.col-sm-12').addClass('transition');
+            }).done();
+
+            $('#disabled').css('display', 'none');
+        },
+        'exit': function () {
+            $('#screen_prolog').css('display', 'none');
+            $('div.col-lg-3.col-md-6.col-sm-12').removeClass('transition');
+            prologHandler.destroy();
+            problems.destroy();
+        }
+    });
+
+    // a constant
+    var firstCharacterPos = {'line': 0, 'ch': 0};
+
+    //codeq.makePrologTerminalHandler = function (jqConsole, editor, problem_id, activityHandler) {
+    var makePrologTerminalHandler = function (jqConsole, editor, problem_id, activityHandler) {
+        var promptMode = true, // default: query composition; alternative: query result browsing
+            terminal = codeq.makeConsole(jqConsole, {
+                'greeting': 'CodeQ Prolog terminal proxy'
+            }),
+            tcs = function terminalCommandSuccess (data) {
+                var t, lines, i;
+                if (data.code === 0) {
+                    t = data.terminal;
+                    terminal.append(t.messages.join('\n'), 'output');
+                    promptMode = !t.have_more;
+                }
+                else {
+                    terminal.append(data.message, 'error');
+                    promptMode = true;
+                }
+                if (promptMode) {
+                    terminal.setLineBuffered();
+                    terminal.append('.\n?- ', 'output');
+                }
+            },
+            tcf = function terminalCommandFailed (error) {
+                promptMode = true;
+                terminal.setLineBuffered();
+                terminal.append(error + '\n', 'error');
+                terminal.append('?- ', 'output');
+            };
+
+        terminal.onKeypress = function (c) {
+            if (promptMode) return c; // query composition: return the character unchanged
+            switch (c) {
+                case ' ':
+                case ';':
+                case '\n':
+                    return ';'; // show next answer on space, semicolon or enter
+                default:
+                    return '.'; // everything else: stop searching for answers
+            }
+        };
+
+        terminal.onInput = function (command) {
+            if (promptMode) {
+                promptMode = false;
+                terminal.setNotBuffered();
+                return codeq.comms.sendQuery({
+                    'problem_id': problem_id,
+                    'step': 'run',
+                    'program': editor.getDoc().getValue(),
+                    'query': command,
+                    'trace': activityHandler.addAndPurge({'typ': 'slv', 'qry': command})
+                }, problem_id).then(tcs, tcf);
+            }
+            else {
+                terminal.append('\n', 'input');
+                if (command == ';') {
+                    // show next answer
+                    return codeq.comms.sendQuery({
+                        'problem_id': problem_id,
+                        'step': 'next',
+                        'trace': activityHandler.addAndPurge({'typ': 'nxt'})
+                    }, problem_id).then(tcs, tcf);
+                }
+                else {
+                    // stop searching for answers
+                    return codeq.comms.sendQuery({
+                        'problem_id': problem_id,
+                        'step': 'end',
+                        'trace': activityHandler.addAndPurge({'typ': 'stp'})
+                    }, problem_id).then(tcs, tcf);
+                }
+
+            }
+        };
+
+        terminal.leftmostCol = 3;
+        terminal.append('?- ', 'output');
+
+        return terminal;
+    };
+
+    var makeActivityHandler = function (editor, problem_id) {
+        var lastActivityMillis = Date.now(),
+            deltaActivityMillis = function deltaActivityMillisFunc () {
+                var now = Date.now(),
+                    dt = now - lastActivityMillis;
+                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(), problem_id);
+                queue.length = 0;
+                return promise;
+            },
+            flush = function () {
+                clearTimeout(ts);
+                return timer();
+            };
+
+        return {
+            'queueTrace': function (trace) {
+                trace['dt'] = deltaActivityMillis();
+                queue.push(trace);
+                if (ts === null) ts = setTimeout(timer, 10000); // flush every 10 seconds
+                return this;
+            },
+            '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}}
+     */
+    var 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, problem.id),
+            terminal = makePrologTerminalHandler(jqConsole, editor, problem.id, activityHandler),
+            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;
+            },
+            processTemplate = function (template, args) {
+                if (!args)
+                    return template;
+                return template.replace(/\[%=(\w+)%\]/g, function(match, name) {
+                    return args[name];
+                });
+            },
+            hintHandlers = {
+                'static': function (type, template, serverHint) {
+                    codeq.log.debug('Processing static hint');
+                    var message = processTemplate(template, serverHint.args);
+                    jqHints.append('<div class="hint-static">' + message + '</div>');
+                    // no hint cleaner here, a static hint remains on the screen
+                },
+                'popup': function (type, template, serverHint) {
+                    codeq.log.debug('Processing popup hint');
+                    var message = processTemplate(template, serverHint.args),
+                        mark = addMark(serverHint.start, serverHint.end), // add the mark
+                        jqMark = jqEditor.find('.' + mark.className);
+
+                    jqMark.popover({content: message, 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 () {
+                $('#btn_code_hint').off('click');
+                $('#btn_code_test').off('click');
+                editor.off();//remove listenerrs from the editor
+                terminal.off();//same for the terminal is the needed?
+                terminal.destroy();
+                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 (serverHint.indices) {
+                        indices = serverHint.indices
+                        for (i = 0; i < indices.length; i++) {
+                            hintDef = hintDef[indices[i]];
+                            if (!hintDef)
+                                break;
+                        }
+                    }
+                    if (!hintDef) {
+                        codeq.log.error('Undefined hint ' + serverHint.id + ' with indices ' + serverHint.indices);
+                        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_hint').on('click', function () {
+            terminal.append('hint.\n', 'input');
+            terminal.inputDisable();
+            var doc = editor.getDoc();
+            codeq.comms.sendHint({
+                'language': 'prolog',
+                'program': editor.getDoc().getValue(),
+                'problem_id': problem.id
+            })
+                .then(
+                function hintSuccess(data) {
+                    if (data.code === 0)
+                        handler.processServerHints(data.hints);
+                    else
+                        terminal.append(data.message + '\n', 'error');
+                },
+                function hintFailed (error) {
+                    terminal.append(error + '\n', 'error');
+                }
+            )
+                .fin(function () {
+                    terminal.inputEnable();
+                    terminal.append('?- ', 'output');
+                })
+                .done();
+        });
+        $('#btn_code_test').on('click', function () {
+            terminal.append('test.\n', 'input');
+            terminal.inputDisable();
+            var doc = editor.getDoc();
+            codeq.comms.sendTest({
+                'language': 'prolog',
+                'program': editor.getDoc().getValue(),
+                'problem_id': problem.id
+            })
+                .then(
+                function testSuccess(data) {
+                    if (data.code === 0)
+                        handler.processServerHints(data.hints);
+                    else
+                        terminal.append(data.message + '\n', 'error');
+                },
+                function testFailed (error) {
+                    terminal.append(error + '\n', 'error');
+                }
+            )
+                .fin(function () {
+                    terminal.inputEnable();
+                    terminal.append('?- ', 'output');
+                })
+                .done();
+        });
+
+        return handler;
+    };
+})();
\ No newline at end of file