summaryrefslogtreecommitdiff
path: root/js/codeq/prolog.js
blob: 1be339f12e6c2e0566ea67ba4767f6a13923c8d2 (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
/* CodeQ: an online programming tutor.
   Copyright (C) 2015,2016 UL FRI

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */

(function() {
    "use strict";
    var jqScreen = $('#screen-prolog'), // the screen container element
        jqConsole = jqScreen.find('.block3'),
        jqBtnPlan = jqScreen.find('.btn-plan'),
        jqBtnTest = jqScreen.find('.btn-test').ladda(),
        jqAllButtons = jqBtnPlan.add(jqBtnTest), // all the buttons
        prologHandler; // created when we enter the prolog state and destroyed once we leave it

    // experiment: Prolog hints
    var jqTeacherHelp = jqScreen.find('.teacher-help');
    // end of experiment: Prolog hints

    var enterFun = function(problemDef, commonDef, currentSolution) {
        $('#navigation-problem-list').css('display', '');
        var navigationProlog = $("#navigation-prolog");
        navigationProlog.addClass("active");
        navigationProlog.css('display', '');

        jqScreen.css('display', ''); // we have to show the screen now so the code editor shows its initial values correctly
        prologHandler = createPrologHandler(problemDef, commonDef, currentSolution);
    };

    codeq.globalStateMachine.register('prolog', {
        'jqScreen': jqScreen,
        'enter': function (ref, data) {
            codeq.loadProblemData(ref, data).then(function (problem) {
                    enterFun(problem.generalProblemData, data.commonDef, problem.solution);
                })
                .fail(function (reason) {
                    codeq.log.error('Failed to obtain the problem definition: ' + reason, reason);
                    alert('Failed to obtain the problem definition: ' + reason);
                    history.back();
                })
                .done();
        },
        'exit': function () {
            // experiment: Prolog hints
            jqTeacherHelp.find('a').off('click');
            jqTeacherHelp.hide();
            // end of experiment: Prolog hints

            jqScreen.css('display', 'none');
            if (prologHandler) prologHandler.destroy();
            prologHandler = null;

            $('#navigation-problem-list').css('display', 'none');
            var navigationProlog = $("#navigation-prolog");
            navigationProlog.removeClass("active");
            navigationProlog.css('display', 'none');
        }
    });

    // 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
            manualStop = false,// if the user stopped showing next answers (false) or if there are no more answers (true)
            terminal = codeq.makeConsole(jqConsole, {
                'greeting': 'CodeQ Prolog terminal proxy',
                'autoHistory': true
            }),
            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(manualStop ? '?- ' : '.\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':
                case 'r':
                    return ';'; // show next answer on space, semicolon, 'n' or 'r'
                default:
                    return '.'; // everything else: stop searching for answers
            }
        };

        terminal.onInput = function (command) {
            if (promptMode) {
                if (!command) {
                    terminal.append('?- ', 'output');
                    return;
                }
                promptMode = false;
                manualStop = false;
                terminal.setNotBuffered();
                return codeq.comms.sendQuery({
                    'problem_id': problem_id,
                    'step': 'run',
                    'program': editor.getDoc().getValue(),
                    'query': command,
                    'trace': activityHandler.addAndPurge({'typ': 'prolog_solve', 'query': 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': 'prolog_next'})
                    }, problem_id).then(tcs, tcf);
                }
                else {
                    // stop searching for answers
                    manualStop = true;
                    return codeq.comms.sendQuery({
                        'problem_id': problem_id,
                        'step': 'end',
                        'trace': activityHandler.addAndPurge({'typ': 'prolog_end'})
                    }, problem_id).then(tcs, tcf);
                }
            }
        };

        terminal.leftmostCol = 3;
        terminal.append('?- ', 'output');

        return terminal;
    };

    codeq.on('init', function (args) {
        codeq.tr.registerDictionary('prolog', codeq.tr.emptyDictionary); // to make the translator happy, when this screen is not active
    });

    var createPrologHandler = function (problemDef, commonDef, currentSolution) {
        var jqEditor = jqScreen.find('.code_editor'),
            jqHints = jqScreen.find('.hints'),
            jqTerminal = jqConsole.find('.console'),
            editor = codeq.makeEditor(jqEditor[0],
                {
                    mode: 'prolog',
                    indentUnit: 4,
                    value: currentSolution || ''
                },
                function () {
                    jqTerminal.click();
                }),
            activityHandler = codeq.makeActivityHandler(editor, problemDef.id),
            terminal = makePrologTerminalHandler(jqTerminal, editor, problemDef.id, activityHandler),
            hinter = codeq.makeHinter(jqHints, jqEditor, editor, 'prolog_hints', problemDef, commonDef, activityHandler),
            commError = function (error) {
                alert(error);
            };

        codeq.template.processDictionary(problemDef.translations.description,
                [problemDef.language, problemDef.group, problemDef.problem]);
        codeq.tr.registerDictionary('prolog', problemDef.translations);
        codeq.tr.translateDom(jqScreen);
        if (hinter.hasNextPlan()) {
            jqBtnPlan.show();
        }
        else {
            jqBtnPlan.hide();
        }

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

            text = changeObj.removed.join('\n');
            if (text) {
                activityHandler.queueTrace({'typ': 'rm', 'off': pos, 'txt': text});
            }

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

        jqBtnPlan.on('click', function () {
            hinter.clear();
            if (!hinter.planNext()) {
                jqBtnPlan.hide();
            }
        });

        jqBtnTest.on('click', function () {
            // random timeout before returning results to the user, helps
            // maintain the illusion
            var timeout = 500 + Math.random() * 1000;

            hinter.clear();
            $(editor.getWrapperElement()).addClass('disabled');
            editor.setOption('readOnly', 'nocursor');
            terminal.inputDisable();
            jqBtnTest.ladda('start');

            codeq.throttle(
                codeq.comms.sendTest({
                    'program': editor.getDoc().getValue(),
                    'problem_id': problemDef.id
                }),
                timeout)
            .then(function (data) {
                if (data.code === 0) {
                    hinter.handle(data.hints);
                }
                else {
                    terminal.append(data.message + '\n', 'error');
                }
            })
            .fail(commError)
            .fin(function () {
                editor.setOption('readOnly', false);
                $(editor.getWrapperElement()).removeClass('disabled');
                terminal.inputEnable();
                jqBtnTest.ladda('stop');
            })
            .done();
        });

        // experiment: Prolog hints
        jqTeacherHelp.find('a').on('click', function(e) {
            e.preventDefault();
            activityHandler.queueTrace({'typ': 'experiment', 'data': 'teacher help'});
            jqTeacherHelp.hide();
        });
        jqTeacherHelp.show();
        // end of experiment: Prolog hints

        codeq.comms.loadProblem(problemDef.id).done();
        activityHandler.queueTrace({
            'typ': 'open',
            'time': Date.now(),
            'content': editor.getDoc().getValue()
        });

        return {
            destroy: function () {
                codeq.comms.endProblem().done();
                $('#screen-prolog .title').text(''); //empty the title text
                jqAllButtons.off();
                editor.off('change');
                activityHandler.queueTrace({'typ': 'close'});
                activityHandler.flush();
                hinter.destroy();
                terminal.destroy();
                jqEditor.empty(); // TODO: perhaps you do not want to "free" the editor, just empty it
                jqTerminal.empty(); // TODO: the same with the console
                jqEditor = null;
                jqTerminal = null;
                jqHints = null;
                codeq.tr.registerDictionary('prolog', codeq.tr.emptyDictionary);
            }
        };
    };
})();