Override toString method for team objects.
[mkws-moved-to-github.git] / src / mkws-team.js
1 // Factory function for team objects. As much as possible, this uses
2 // only member variables (prefixed "m_") and inner functions with
3 // private scope.
4 //
5 // Some functions are visible as member-functions to be called from
6 // outside code -- specifically, from generated HTML. These functions
7 // are that.switchView(), showDetails(), limitTarget(), limitQuery(),
8 // delimitTarget(), delimitQuery(), showPage(), pagerPrev(),
9 // pagerNext().
10 //
11 function team($, teamName) {
12     var that = {};
13     var m_teamName = teamName;
14     var m_submitted = false;
15     var m_query; // initially undefined
16     var m_sortOrder; // will be set below
17     var m_perpage; // will be set below
18     var m_filters = [];
19     var m_totalRecordCount = 0;
20     var m_currentPage = 1;
21     var m_currentRecordId = '';
22     var m_currentRecordData = null;
23     var m_logTime = {
24         // Timestamps for logging
25         "start": $.now(),
26         "last": $.now()
27     };
28     var m_paz; // will be initialised below
29     var m_template = {};
30
31     that.toString = function() { return '[Team ' + teamName + ']'; }
32
33     // Accessor methods for individual widgets: readers
34     that.name = function() { return m_teamName; }
35     that.submitted = function() { return m_submitted; }
36     that.perpage = function() { return m_perpage; }
37     that.totalRecordCount = function() { return m_totalRecordCount; }
38     that.currentPage = function() { return m_currentPage; }
39     that.currentRecordId = function() { return m_currentRecordId; }
40     that.currentRecordData = function() { return m_currentRecordData; }
41     that.filters = function() { return m_filters; }
42
43     // Accessor methods for individual widgets: writers
44     that.set_sortOrder = function(val) { m_sortOrder = val };
45     that.set_perpage = function(val) { m_perpage = val };
46
47
48     function log(s) {
49         var now = $.now();
50         var timestamp = ((now - m_logTime.start)/1000).toFixed(3) + " (+" + ((now - m_logTime.last)/1000).toFixed(3) + ") "
51         m_logTime.last = now;
52
53         mkws.log(m_teamName + ": " + timestamp + s);
54     }
55     that.log = log;
56
57     log("start running MKWS");
58
59     m_sortOrder = mkws_config.sort_default;
60     m_perpage = mkws_config.perpage_default;
61
62     log("Create main pz2 object");
63     // create a parameters array and pass it to the pz2's constructor
64     // then register the form submit event with the pz2.search function
65     // autoInit is set to true on default
66     m_paz = new pz2({ "windowid": teamName,
67                       "pazpar2path": mkws_config.pazpar2_url,
68                       "usesessions" : mkws_config.use_service_proxy ? false : true,
69                       "oninit": onInit,
70                       "onbytarget": onBytarget,
71                       "onstat": onStat,
72                       "onterm": (mkws_config.facets.length ? onTerm : undefined),
73                       "onshow": onShow,
74                       "onrecord": onRecord,
75                       "showtime": 500,            //each timer (show, stat, term, bytarget) can be specified this way
76                       "termlist": mkws_config.facets.join(',')
77                     });
78
79
80     // pz2.js event handlers:
81     function onInit() {
82         log("init");
83         m_paz.stat();
84         m_paz.bytarget();
85     }
86
87     function onBytarget(data) {
88         log("target");
89         queue("targets").publish(data);
90     }
91
92     function onStat(data) {
93         log("stat");
94         queue("stat").publish(data);
95     }
96
97     function onTerm(data) {
98         log("term");
99         queue("termlists").publish(data);
100     }
101
102     function onShow(data, teamName) {
103         log("show");
104         m_totalRecordCount = data.merged;
105         queue("pager").publish(data);
106         queue("records").publish(data);
107     }
108
109     function onRecord(data, args, teamName) {
110         log("record");
111         // FIXME: record is async!!
112         clearTimeout(m_paz.recordTimer);
113         var detRecordDiv = findnode(recordDetailsId(data.recid[0]));
114         if (detRecordDiv.length) {
115             // in case on_show was faster to redraw element
116             return;
117         }
118         m_currentRecordData = data;
119         var recordDiv = findnode('.' + recordElementId(m_currentRecordData.recid[0]));
120         var html = renderDetails(m_currentRecordData);
121         $(recordDiv).append(html);
122     }
123
124
125     // Used by promoteRecords() and onRecord()
126     function recordElementId(s) {
127         return 'mkwsRec_' + s.replace(/[^a-z0-9]/ig, '_');
128     }
129     that.recordElementId = recordElementId;
130
131     // Used by onRecord(), showDetails() and renderDetails()
132     function recordDetailsId(s) {
133         return 'mkwsDet_' + s.replace(/[^a-z0-9]/ig, '_');
134     }
135     that.recordElementId = recordElementId;
136
137
138     that.targetFiltered = function(id) {
139         for (var i = 0; i < m_filters.length; i++) {
140             if (m_filters[i].id === id ||
141                 m_filters[i].id === 'pz:id=' + id) {
142                 return true;
143             }
144         }
145         return false;
146     }
147
148
149     that.limitTarget  = function (id, name)
150     {
151         log("limitTarget(id=" + id + ", name=" + name + ")");
152         m_filters.push({ id: id, name: name });
153         triggerSearch();
154         return false;
155     }
156
157
158     that.limitQuery = function (field, value)
159     {
160         log("limitQuery(field=" + field + ", value=" + value + ")");
161         m_filters.push({ field: field, value: value });
162         triggerSearch();
163         return false;
164     }
165
166
167     that.delimitTarget = function (id)
168     {
169         log("delimitTarget(id=" + id + ")");
170         var newFilters = [];
171         for (var i in m_filters) {
172             var filter = m_filters[i];
173             if (filter.id) {
174                 log("delimitTarget() removing filter " + $.toJSON(filter));
175             } else {
176                 log("delimitTarget() keeping filter " + $.toJSON(filter));
177                 newFilters.push(filter);
178             }
179         }
180         m_filters = newFilters;
181
182         triggerSearch();
183         return false;
184     }
185
186
187     that.delimitQuery = function (field, value)
188     {
189         log("delimitQuery(field=" + field + ", value=" + value + ")");
190         var newFilters = [];
191         for (var i in m_filters) {
192             var filter = m_filters[i];
193             if (filter.field &&
194                 field == filter.field &&
195                 value == filter.value) {
196                 log("delimitQuery() removing filter " + $.toJSON(filter));
197             } else {
198                 log("delimitQuery() keeping filter " + $.toJSON(filter));
199                 newFilters.push(filter);
200             }
201         }
202         m_filters = newFilters;
203
204         triggerSearch();
205         return false;
206     }
207
208
209     that.showPage = function (pageNum)
210     {
211         m_currentPage = pageNum;
212         m_paz.showPage(m_currentPage - 1);
213     }
214
215
216     that.pagerNext = function () {
217         if (m_totalRecordCount - m_perpage*m_currentPage > 0) {
218             m_paz.showNext();
219             m_currentPage++;
220         }
221     }
222
223
224     that.pagerPrev = function () {
225         if (m_paz.showPrev() != false)
226             m_currentPage--;
227     }
228
229
230     that.reShow = function() {
231         m_paz.show(0, m_perpage, m_sortOrder);
232     }
233
234
235     function resetPage()
236     {
237         m_currentPage = 1;
238         m_totalRecordCount = 0;
239     }
240     that.resetPage = resetPage;
241
242
243     function newSearch(query, sortOrder, targets)
244     {
245         log("newSearch: " + query);
246
247         if (mkws_config.use_service_proxy && !mkws.authenticated) {
248             alert("searching before authentication");
249             return;
250         }
251
252         m_filters = []
253         triggerSearch(query, sortOrder, targets);
254         switchView('records'); // In case it's configured to start off as hidden
255         m_submitted = true;
256     }
257
258
259     function triggerSearch (query, sortOrder, targets)
260     {
261         resetPage();
262         queue("navi").publish();
263
264         var pp2filter = "";
265         var pp2limit = "";
266
267         // Continue to use previous query/sort-order unless new ones are specified
268         if (query) {
269             m_query = query;
270         }
271         if (sortOrder) {
272             m_sortOrder = sortOrder;
273         }
274         if (targets) {
275             m_filters.push({ id: targets, name: targets });
276         }
277
278         for (var i in m_filters) {
279             var filter = m_filters[i];
280             if (filter.id) {
281                 if (pp2filter)
282                     pp2filter += ",";
283                 if (filter.id.match(/^[a-z:]+[=~]/)) {
284                     log("filter '" + filter.id + "' already begins with SETTING OP");
285                 } else {
286                     filter.id = 'pz:id=' + filter.id;
287                 }
288                 pp2filter += filter.id;
289             } else {
290                 if (pp2limit)
291                     pp2limit += ",";
292                 pp2limit += filter.field + "=" + filter.value.replace(/[\\|,]/g, '\\$&');
293             }
294         }
295
296         var params = {};
297         if (pp2limit) {
298             params.limit = pp2limit;
299         }
300
301         log("triggerSearch(" + m_query + "): filters = " + $.toJSON(m_filters) + ", pp2filter = " + pp2filter + ", params = " + $.toJSON(params));
302
303         // We can use: params.torusquery = "udb=NAME"
304         // Note: that won't work when running against raw pazpar2
305         m_paz.search(m_query, m_perpage, m_sortOrder, pp2filter, undefined, params);
306     }
307
308
309     // switching view between targets and records
310     function switchView(view) {
311         var targets = findnode('.mkwsTargets');
312         var results = findnode('.mkwsResults,.mkwsRecords');
313         var blanket = findnode('.mkwsBlanket');
314         var motd    = findnode('.mkwsMOTD');
315
316         switch(view) {
317         case 'targets':
318             if (targets) targets.css('display', 'block');
319             if (results) results.css('display', 'none');
320             if (blanket) blanket.css('display', 'none');
321             if (motd) motd.css('display', 'none');
322             break;
323         case 'records':
324             if (targets) targets.css('display', 'none');
325             if (results) results.css('display', 'block');
326             if (blanket) blanket.css('display', 'block');
327             if (motd) motd.css('display', 'none');
328             break;
329         case 'none':
330             alert("mkws.switchView(" + m_teamName + ", 'none') shouldn't happen");
331             if (targets) targets.css('display', 'none');
332             if (results) results.css('display', 'none');
333             if (blanket) blanket.css('display', 'none');
334             if (motd) motd.css('display', 'none');
335             break;
336         default:
337             alert("Unknown view '" + view + "'");
338         }
339     }
340     that.switchView = switchView;
341
342
343     // detailed record drawing
344     that.showDetails = function (recId) {
345         var oldRecordId = m_currentRecordId;
346         m_currentRecordId = recId;
347
348         // remove current detailed view if any
349         // ##### restrict to current team
350         var detRecordDiv = document.getElementById(recordDetailsId(oldRecordId));
351         // lovin DOM!
352         if (detRecordDiv)
353             detRecordDiv.parentNode.removeChild(detRecordDiv);
354
355         // if the same clicked, just hide
356         if (recId == oldRecordId) {
357             m_currentRecordId = '';
358             m_currentRecordData = null;
359             return;
360         }
361         // request the record
362         log("showDetails() requesting record '" + recId + "'");
363         m_paz.record(recId);
364     }
365
366
367     /*
368      * All the HTML stuff to render the search forms and
369      * result pages.
370      */
371     function mkwsHtmlAll() {
372         mkwsSetLang();
373         if (mkws_config.show_lang)
374             mkwsHtmlLang();
375
376         log("HTML search form");
377         findnode('.mkwsSearch').html('\
378 <form name="mkwsSearchForm" class="mkwsSearchForm mkwsTeam_' + m_teamName + '" action="" >\
379   <input class="mkwsQuery mkwsTeam_' + m_teamName + '" type="text" size="' + mkws_config.query_width + '" />\
380   <input class="mkwsButton mkwsTeam_' + m_teamName + '" type="submit" value="' + M('Search') + '" />\
381 </form>');
382
383         log("HTML records");
384         // If the team has a .mkwsResults, populate it in the usual
385         // way. If not, assume that it's a smarter application that
386         // defines its own subcomponents, some or all of the
387         // following:
388         //      .mkwsTermlists
389         //      .mkwsRanking
390         //      .mkwsPager
391         //      .mkwsNavi
392         //      .mkwsRecords
393         findnode(".mkwsResults").html('\
394 <table width="100%" border="0" cellpadding="6" cellspacing="0">\
395   <tr>\
396     <td class="mkwsTermlistContainer1 mkwsTeam_' + m_teamName + '" width="250" valign="top">\
397       <div class="mkwsTermlists mkwsTeam_' + m_teamName + '"></div>\
398     </td>\
399     <td class="mkwsMOTDContainer mkwsTeam_' + m_teamName + '" valign="top">\
400       <div class="mkwsRanking mkwsTeam_' + m_teamName + '"></div>\
401       <div class="mkwsPager mkwsTeam_' + m_teamName + '"></div>\
402       <div class="mkwsNavi mkwsTeam_' + m_teamName + '"></div>\
403       <div class="mkwsRecords mkwsTeam_' + m_teamName + '"></div>\
404     </td>\
405   </tr>\
406   <tr>\
407     <td colspan="2">\
408       <div class="mkwsTermlistContainer2 mkwsTeam_' + m_teamName + '"></div>\
409     </td>\
410   </tr>\
411 </table>');
412
413         var ranking_data = '<form name="mkwsSelect" class="mkwsSelect mkwsTeam_' + m_teamName + '" action="" >';
414         if (mkws_config.show_sort) {
415             ranking_data +=  M('Sort by') + ' ' + mkwsHtmlSort() + ' ';
416         }
417         if (mkws_config.show_perpage) {
418             ranking_data += M('and show') + ' ' + mkwsHtmlPerpage() + ' ' + M('per page') + '.';
419         }
420         ranking_data += '</form>';
421         findnode(".mkwsRanking").html(ranking_data);
422
423         mkwsHtmlSwitch();
424
425         findnode('.mkwsSearchForm').submit(function() {
426             var val = findnode('.mkwsQuery').val();
427             newSearch(val);
428             return false;
429         });
430
431         // on first page, hide the termlist
432         $(document).ready(function() { findnode(".mkwsTermlists").hide(); });
433         var container = findnode(".mkwsMOTDContainer");
434         if (container.length) {
435             // Move the MOTD from the provided element down into the container
436             findnode(".mkwsMOTD").appendTo(container);
437         }
438     }
439
440
441     function mkwsSetLang()  {
442         var lang = getParameterByName("lang") || mkws_config.lang;
443         if (!lang || !mkws.locale_lang[lang]) {
444             mkws_config.lang = ""
445         } else {
446             mkws_config.lang = lang;
447         }
448
449         log("Locale language: " + (mkws_config.lang ? mkws_config.lang : "none"));
450         return mkws_config.lang;
451     }
452
453
454     /* create locale language menu */
455     function mkwsHtmlLang() {
456         var lang_default = "en";
457         var lang = mkws_config.lang || lang_default;
458         var list = [];
459
460         /* display a list of configured languages, or all */
461         var lang_options = mkws_config.lang_options || [];
462         var toBeIncluded = {};
463         for (var i = 0; i < lang_options.length; i++) {
464             toBeIncluded[lang_options[i]] = true;
465         }
466
467         for (var k in mkws.locale_lang) {
468             if (toBeIncluded[k] || lang_options.length == 0)
469                 list.push(k);
470         }
471
472         // add english link
473         if (lang_options.length == 0 || toBeIncluded[lang_default])
474             list.push(lang_default);
475
476         log("Language menu for: " + list.join(", "));
477
478         /* the HTML part */
479         var data = "";
480         for(var i = 0; i < list.length; i++) {
481             var l = list[i];
482
483             if (data)
484                 data += ' | ';
485
486             if (lang == l) {
487                 data += ' <span>' + l + '</span> ';
488             } else {
489                 data += ' <a href="?lang=' + l + '">' + l + '</a> '
490             }
491         }
492
493         findnode(".mkwsLang").html(data);
494     }
495
496
497     function mkwsHtmlSort() {
498         log("HTML sort, m_sortOrder = '" + m_sortOrder + "'");
499         var sort_html = '<select class="mkwsSort mkwsTeam_' + m_teamName + '">';
500
501         for(var i = 0; i < mkws_config.sort_options.length; i++) {
502             var opt = mkws_config.sort_options[i];
503             var key = opt[0];
504             var val = opt.length == 1 ? opt[0] : opt[1];
505
506             sort_html += '<option value="' + key + '"';
507             if (m_sortOrder == key || m_sortOrder == val) {
508                 sort_html += ' selected="selected"';
509             }
510             sort_html += '>' + M(val) + '</option>';
511         }
512         sort_html += '</select>';
513
514         return sort_html;
515     }
516
517
518     function mkwsHtmlPerpage() {
519         log("HTML perpage, m_perpage = " + m_perpage);
520         var perpage_html = '<select class="mkwsPerpage mkwsTeam_' + m_teamName + '">';
521
522         for(var i = 0; i < mkws_config.perpage_options.length; i++) {
523             var key = mkws_config.perpage_options[i];
524
525             perpage_html += '<option value="' + key + '"';
526             if (key == m_perpage) {
527                 perpage_html += ' selected="selected"';
528             }
529             perpage_html += '>' + key + '</option>';
530         }
531         perpage_html += '</select>';
532
533         return perpage_html;
534     }
535
536
537     function mkwsHtmlSwitch() {
538         log("HTML switch for team " + m_teamName);
539
540         var node = findnode(".mkwsSwitch");
541         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'records\')">' + M('Records') + '</a>'));
542         node.append($("<span/>", { text: " | " }));
543         node.append($('<a href="#" onclick="mkws.switchView(\'' + m_teamName + '\', \'targets\')">' + M('Targets') + '</a>'));
544
545         log("HTML targets");
546         var node = findnode(".mkwsTargets");
547         node.html('\
548 <div class="mkwsBytarget mkwsTeam_' + m_teamName + '">\
549   No information available yet.\
550 </div>');
551         node.css("display", "none");
552     }
553
554
555     that.runAutoSearch = function() {
556         var node = findnode('.mkwsRecords,.mkwsTermlists');
557         var query = node.attr('autosearch');
558         if (!query)
559             return;
560
561         if (query.match(/^!param!/)) {
562             var param = query.replace(/^!param!/, '');
563             query = getParameterByName(param);
564             log("obtained query '" + query + "' from param '" + param + "'");
565             if (!query) {
566                 alert("This page has a MasterKey widget that needs a query specified by the '" + param + "' parameter");
567             }
568         } else if (query.match(/^!path!/)) {
569             var index = query.replace(/^!path!/, '');
570             var path = window.location.pathname.split('/');
571             query = path[path.length - index];
572             log("obtained query '" + query + "' from path-component '" + index + "'");
573             if (!query) {
574                 alert("This page has a MasterKey widget that needs a query specified by the path-component " + index);
575             }
576         }
577
578         log("node=" + node + ", class='" + node.className + "', query=" + query);
579
580         var sortOrder = node.attr('sort');
581         var targets = node.attr('targets');
582         var s = "running auto search: '" + query + "'";
583         if (sortOrder) s += " sorted by '" + sortOrder + "'";
584         if (targets) s += " in targets '" + targets + "'";
585         log(s);
586
587         newSearch(query, sortOrder, targets);
588     }
589
590
591     // This function is taken from a StackOverflow answer
592     // http://stackoverflow.com/questions/901115/how-can-i-get-query-string-values-in-javascript/901144#901144
593     function getParameterByName(name) {
594         name = name.replace(/[\[]/, "\\[").replace(/[\]]/, "\\]");
595         var regex = new RegExp("[\\?&]" + name + "=([^&#]*)"),
596             results = regex.exec(location.search);
597         return results == null ? "" : decodeURIComponent(results[1].replace(/\+/g, " "));
598     }
599
600
601     // Translation function. At present, this is properly a
602     // global-level function (hence the assignment to mkws.M) but we
603     // want to make it per-team so different teams can operate in
604     // different languages.
605     //
606     function M(word) {
607         var lang = mkws_config.lang;
608
609         if (!lang || !mkws.locale_lang[lang])
610             return word;
611
612         return mkws.locale_lang[lang][word] || word;
613     }
614     mkws.M = M; // so the Handlebars helper can use it
615
616
617     // Finds the node of the specified class within the current team
618     // Multiple OR-clauses separated by commas are handled
619     // More complex cases may not work
620     //
621     function findnode(selector, teamName) {
622         teamName = teamName || m_teamName;
623
624         selector = $.map(selector.split(','), function(s, i) {
625             return s + '.mkwsTeam_' + teamName;
626         }).join(',');
627
628         var node = $(selector);
629         //log('findnode(' + selector + ') found ' + node.length + ' nodes');
630         return node;
631     }
632
633
634     function renderDetails(data, marker)
635     {
636         var template = loadTemplate("Record");
637         var details = template(data);
638         return '<div class="details mkwsTeam_' + m_teamName + '" id="' + recordDetailsId(data.recid[0]) + '">' + details + '</div>';
639     }
640     that.renderDetails = renderDetails;
641
642
643     function loadTemplate(name)
644     {
645         var template = m_template[name];
646
647         if (template === undefined) {
648             // Fall back to generic template if there is no team-specific one
649             var node = findnode(".mkwsTemplate_" + name);
650             if (!node.length) {
651                 node = findnode(".mkwsTemplate_" + name, "ALL");
652             }
653
654             var source = node.html();
655             if (!source) {
656                 source = defaultTemplate(name);
657             }
658
659             template = Handlebars.compile(source);
660             log("compiled template '" + name + "'");
661             m_template[name] = template;
662         }
663
664         return template;
665     }
666     that.loadTemplate = loadTemplate;
667
668
669     function defaultTemplate(name)
670     {
671         if (name === 'Record') {
672             return '\
673 <table>\
674   <tr>\
675     <th>{{translate "Title"}}</th>\
676     <td>\
677       {{md-title}}\
678       {{#if md-title-remainder}}\
679         ({{md-title-remainder}})\
680       {{/if}}\
681       {{#if md-title-responsibility}}\
682         <i>{{md-title-responsibility}}</i>\
683       {{/if}}\
684     </td>\
685   </tr>\
686   {{#if md-date}}\
687   <tr>\
688     <th>{{translate "Date"}}</th>\
689     <td>{{md-date}}</td>\
690   </tr>\
691   {{/if}}\
692   {{#if md-author}}\
693   <tr>\
694     <th>{{translate "Author"}}</th>\
695     <td>{{md-author}}</td>\
696   </tr>\
697   {{/if}}\
698   {{#if md-electronic-url}}\
699   <tr>\
700     <th>{{translate "Links"}}</th>\
701     <td>\
702       {{#each md-electronic-url}}\
703         <a href="{{this}}">Link{{index1}}</a>\
704       {{/each}}\
705     </td>\
706   </tr>\
707   {{/if}}\
708   {{#if-any location having="md-subject"}}\
709   <tr>\
710     <th>{{translate "Subject"}}</th>\
711     <td>\
712       {{#first location having="md-subject"}}\
713         {{#if md-subject}}\
714           {{#commaList md-subject}}\
715             {{this}}{{/commaList}}\
716         {{/if}}\
717       {{/first}}\
718     </td>\
719   </tr>\
720   {{/if-any}}\
721   <tr>\
722     <th>{{translate "Locations"}}</th>\
723     <td>\
724       {{#commaList location}}\
725         {{attr "@name"}}{{/commaList}}\
726     </td>\
727   </tr>\
728 </table>\
729 ';
730         } else if (name === "Summary") {
731             return '\
732 <a href="#" id="{{_id}}" onclick="{{_onclick}}">\
733   <b>{{md-title}}</b>\
734 </a>\
735 {{#if md-title-remainder}}\
736   <span>{{md-title-remainder}}</span>\
737 {{/if}}\
738 {{#if md-title-responsibility}}\
739   <span><i>{{md-title-responsibility}}</i></span>\
740 {{/if}}\
741 ';
742         }
743
744         var s = "There is no default '" + name +"' template!";
745         alert(s);
746         return s;
747     }
748
749
750     // The following PubSub code is modified from the jQuery manual:
751     // https://api.jquery.com/jQuery.Callbacks/
752     //
753     // Use as:
754     //  team.queue("eventName").subscribe(function(param1, param2 ...) { ... });
755     //  team.queue("eventName").publish(arg1, arg2, ...);
756
757     var queues = {};
758     var queue = function(id) {
759         if (!queues[id]) {
760             var callbacks = $.Callbacks();
761             queues[id] = {
762                 publish: callbacks.fire,
763                 subscribe: callbacks.add,
764                 unsubscribe: callbacks.remove
765             };
766         }
767         return queues[id];
768     }
769     that.queue = queue;
770
771     mkwsHtmlAll()
772
773     return that;
774 };