###############################################################################
#
# SageMathCloud: A collaborative web-based interface to Sage, IPython, LaTeX and the Terminal.
#
# Copyright (C) 2014, William Stein
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see .
#
###############################################################################
{IS_MOBILE} = require("feature")
misc = require('misc')
{dmp} = require('diffsync')
buttonbar = require('buttonbar')
templates = $("#salvus-misc-templates")
exports.is_shift_enter = (e) -> e.which is 13 and e.shiftKey
exports.is_enter = (e) -> e.which is 13 and not e.shiftKey
exports.is_ctrl_enter = (e) -> e.which is 13 and e.ctrlKey
exports.is_escape = (e) -> e.which is 27
local_diff = exports.local_diff = (before, after) ->
# Return object
#
# {pos:index_into_before, orig:"substring of before starting at pos", repl:"what to replace string by"}
#
# that explains how to transform before into after via a substring
# replace. This addresses the case when before has been *locally*
# edited to obtain after.
#
if not before?
return {pos:0, orig:'', repl:after}
i = 0
while i < before.length and before[i] == after[i]
i += 1
# We now know that they differ at position i
orig = before.slice(i)
repl = after.slice(i)
# Delete the biggest string in common at the end of orig and repl.
# This works well for local edits, which is what this command is
# aimed at.
j = orig.length - 1
d = repl.length - orig.length
while j >= 0 and d+j>=0 and orig[j] == repl[d+j]
j -= 1
# They differ at position j (resp., d+j)
orig = orig.slice(0, j+1)
repl = repl.slice(0, d+j+1)
return {pos:i, orig:orig, repl:repl}
exports.scroll_top = () ->
# Scroll smoothly to the top of the page.
$("html, body").animate({ scrollTop: 0 })
exports.human_readable_size = (bytes) ->
if bytes < 1000
return "#{bytes}"
if bytes < 1000000
b = Math.floor(bytes/100)
return "#{b/10}K"
if bytes < 1000000000
b = Math.floor(bytes/100000)
return "#{b/10}M"
b = Math.floor(bytes/100000000)
return "#{b/10}G"
#############################################
# JQuery Plugins
#############################################
{required, defaults} = require('misc')
# jQuery plugin for spinner (/spin/spin.min.js)
$.fn.spin = (opts) ->
@each ->
$this = $(this)
data = $this.data()
if data.spinner
data.spinner.stop()
delete data.spinner
if opts isnt false
data.spinner = new Spinner($.extend({color: $this.css("color")}, opts)).spin(this)
this
# Easily enable toggling details of some elements...
# (grep code for usage examples)
$.fn.smc_toggle_details = (opts) ->
opts = defaults opts,
show : required # string -- jquery selector
hide : required # string -- jquery selector
target : required # string -- jquery selector
@each ->
elt = $(this)
elt.find(opts.show).click () ->
elt.find(opts.show).hide()
elt.find(opts.hide).show()
elt.find(opts.target).show()
elt.addClass('smc-toggle-show')
elt.find(opts.hide).click () ->
elt.find(opts.hide).hide()
elt.find(opts.show).show()
elt.find(opts.target).hide()
elt.removeClass('smc-toggle-show')
return elt
# jQuery plugin that sets the innerHTML of an element and doesn't do anything with script tags;
# in particular, doesn't explicitly remove and run them like jQuery does.
$.fn.html_noscript = (html) ->
@each ->
this.innerHTML = html
t = $(this)
t.find('script').remove()
return t
# MathJax some code -- jQuery plugin
$.fn.extend
mathjax: (opts={}) ->
opts = defaults opts,
tex : undefined
display : false
inline : false
cb : undefined # if defined, gets called as cb(t) for *every* element t in the jquery set!
@each () ->
t = $(this)
if not opts.tex? and not opts.display and not opts.inline
# Doing this test is still much better than calling mathjax below, since I guess
# it doesn't do a simple test first... and mathjax is painful.
html = t.html()
if html.indexOf('$') == -1 and html.indexOf('\\') == -1
return t
# this is a common special case - the code below would work, but would be
# stupid, since it involves converting back and forth between html
element = t
else
if opts.tex?
tex = opts.tex
else
tex = t.html()
if opts.display
tex = "$${#{tex}}$$"
else if opts.inline
tex = "\\({#{tex}}\\)"
element = t.html(tex)
MathJax.Hub.Queue(["Typeset", MathJax.Hub, element[0]])
if opts.cb?
MathJax.Hub.Queue([opts.cb, t])
return t
$.fn.extend
unmathjax: (opts={}) ->
opts = defaults(opts,{})
@each () ->
t = $(this)
for c in "MathJax_Preview MathJax_SVG MathJax_SVG_Display MathJax MathJax_MathML".split(' ')
t.find(".#{c}").remove()
for s in t.find("script[type='math/tex']")
a = $(s)
a.replaceWith(" $#{a.text()}$ ")
for s in t.find("script[type='math/tex; mode=display']")
a = $(s)
a.replaceWith(" $$#{a.text()}$$ ")
return t
$.fn.extend
equation_editor: (opts={}) ->
opts = defaults opts,
display : false
value : ''
onchange : undefined
@each () ->
t = $(this)
if opts.display
delim = '$$'
s = $("
")
else
delim = '$'
s = $("
")
s.attr('id', misc.uuid())
ed = s.find("textarea")
options =
autofocus : true
mode : {name:'stex', globalVars: true}
lineNumbers : false
showTrailingSpace : false
indentUnit : 4
tabSize : 4
smartIndent : true
electricChars : true
undoDepth : 100
matchBrackets : true
autoCloseBrackets : true
autoCloseTags : true
lineWrapping : true
readOnly : false
styleActiveLine : 15
indentWithTabs : false
showCursorWhenSelecting : true
viewportMargin : Infinity
extraKeys : {}
t.replaceWith(s)
cm = CodeMirror.fromTextArea(ed[0], options)
#console.log("setting value to '#{opts.value}'")
trim_dollars = (code) ->
code = code.trim()
while code[0] == '$'
code = code.slice(1)
while code[code.length-1] == '$'
code = code.slice(0,code.length-1)
return code.trim()
cm.setValue(delim + '\n\n' + opts.value + '\n\n' + delim)
cm.setCursor(line:2,ch:0)
ed.val(opts.value)
#cm.clearHistory() # ensure that the undo history doesn't start with "empty document"
$(cm.getWrapperElement()).css(height:'auto')
preview = s.find(".sagews-editor-latex-preview")
preview.click () =>
cm.focus()
update_preview = () ->
preview.mathjax
tex : trim_dollars(cm.getValue())
display : opts.display
inline : not opts.display
if opts.onchange?
cm.on 'change', () =>
update_preview()
opts.onchange()
ed.val(trim_dollars(cm.getValue()))
s.data('delim', delim)
update_preview()
return t
# Mathjax-enabled Contenteditable Editor plugin
$.fn.extend
make_editable: (opts={}) ->
@each () ->
opts = defaults opts,
value : undefined # defaults to what is already there
onchange : undefined # function that gets called when content changes
interval : 250 # call onchange if there was a change, but no more for this many ms.
one_line : false # if true, blur when user presses the enter key
mathjax : false # if false, completey ignore ever running mathjax -- probably a good idea since support for running it is pretty broken.
cancel : false # if given, instead removes all handlers/editable from element
t = $(this)
if opts.cancel
t.data('cancel_editor')?()
# TODO: clear state -- get rid of function data...
return
if not opts.value?
opts.value = t.html()
last_sync = opts.value
t.data('onchange', opts.onchange)
change_timer = undefined
report_change = () ->
change_timer = undefined
last_update = t.data('last_update')
if t.data('mode') == 'edit'
now = t.html()
else
now = t.data('raw')
if last_update isnt now
#console.log("reporting change since '#{last_update}' != '#{now}'")
opts.onchange(now, t)
t.data('last_update', now)
last_sync = now
set_change_timer = () ->
if opts.onchange?
if change_timer?
clearTimeout(change_timer)
change_timer = setTimeout(report_change, opts.interval)
# set the text content; it will be subsequently processed by mathjax, if opts.mathjax is true
set_value = (value) ->
t.data
raw : value
mode : 'view'
t.html(value)
if opts.mathjax
t.mathjax()
set_change_timer()
get_value = () ->
if t.data('mode') == 'view'
return t.data('raw')
else
return t.html()
set_upstream = (upstream) ->
cur = get_value()
if cur != upstream
last = last_sync
p = dmp.patch_make(last, upstream)
#console.log("syncing:\ncur='#{cur}'\nupstream='#{upstream}'\nlast='#{last}'\npatch='#{misc.to_json(p)}'")
new_cur = dmp.patch_apply(p, cur)[0]
last_sync = new_cur
if new_cur != cur
#console.log("new_cur='#{new_cur}'")
set_value(new_cur)
report_change()
on_focus = () ->
#console.log("on_focus")
if t.data('mode') == 'edit'
return
t.data('mode', 'edit')
t = $(this)
x = t.data('raw')
on_blur = () ->
#console.log("on_blur")
t = $(this)
t.data
raw : t.html()
mode : 'view'
if opts.mathjax
t.mathjax()
#on_keydown = (evt) ->
# if evt.which == 27 or (opts.one_line and evt.which == 13)
# t.blur()
# return false
t.attr('contenteditable', true)
handlers =
focus : on_focus
blur : on_blur
paste : set_change_timer
keyup : set_change_timer
keydown : set_change_timer
for evt, f of handlers
t.on(evt, f)
data =
set_value : set_value
get_value : get_value
set_upstream : set_upstream
last_update : opts.value
t.data(data)
t.data 'cancel_editor', () =>
#console.log("cancel_editor")
t.attr('contenteditable', false)
for evt, f of handlers
t.unbind(evt, f)
for key,_ of data
t.removeData(key)
set_value(opts.value)
return t
# Expand element to be vertically maximal in height, keeping its current top position.
$.fn.maxheight = (opts={}) ->
if not opts.offset?
opts.offset = 0
@each ->
elt = $(this)
elt.height($(window).height() - elt.offset().top - opts.offset)
this
$.fn.icon_spin = (start) ->
if typeof start == "object"
{start,delay} = defaults start,
start : true
delay : 0
else
delay = 0
@each () ->
elt = $(this)
if start
f = () ->
if elt.find("i.fa-spinner").length == 0 # fa-spin
elt.append("")
# do not do this on Chrome, where it is TOTALLY BROKEN in that it uses tons of CPU
# (and the font-awesome people can't work around it):
# https://github.com/FortAwesome/Font-Awesome/issues/701
#if not $.browser.chrome
## -- re-enabling soince fontawesome 4.0 is way faster.
elt.find("i.fa-spinner").addClass('fa-spin')
if delay
elt.data('fa-spin', setTimeout(f, delay))
else
f()
else
t = elt.data('fa-spin')
if t?
clearTimeout(t)
elt.find("i.fa-spinner").remove()
# from http://stackoverflow.com/questions/4233265/contenteditable-set-caret-at-the-end-of-the-text-cross-browser/4238971#4238971
$.fn.focus_end = () ->
@each () ->
el = $(this).focus()
if window.getSelection? and document.createRange?
range = document.createRange()
range.selectNodeContents(this)
range.collapse(false)
sel = window.getSelection()
sel.removeAllRanges()
sel.addRange(range)
else if document.body.createTextRange?
textRange = document.body.createTextRange()
textRange.moveToElementText(this)
textRange.collapse(false)
textRange.select()
####################################
# Codemirror Extensions
####################################
exports.define_codemirror_extensions = () ->
# LaTeX code folding (isn't included in CodeMirror)
get_latex_environ = (s) ->
i = s.indexOf('{')
j = s.indexOf('}')
if i != -1 and j != -1
return s.slice(i+1,j).trim()
else
return undefined
startswith = misc.startswith
CodeMirror.registerHelper "fold", "stex", (cm, start) ->
line = cm.getLine(start.line).trimLeft()
find_close = () ->
BEGIN = "\\begin"
if startswith(line, BEGIN)
# \begin{foo}
# ...
# \end{foo}
# find environment close
environ = get_latex_environ(line.slice(BEGIN.length))
if not environ?
return [undefined, undefined]
# find environment close
END = "\\end"
level = 0
begin = new RegExp("\\\\begin\\s*{#{environ}}")
end = new RegExp("\\\\end\\s*{#{environ}}")
for i in [start.line..cm.lastLine()]
cur = cm.getLine(i)
m = cur.search(begin)
j = cur.search(end)
if m != -1 and (j == -1 or m < j)
level += 1
if j != -1
level -= 1
if level == 0
return [i, j + END.length]
else if startswith(line, "\\[")
for i in [start.line+1..cm.lastLine()]
if startswith(cm.getLine(i).trimLeft(), "\\]")
return [i, 0]
else if startswith(line, "\\(")
for i in [start.line+1..cm.lastLine()]
if startswith(cm.getLine(i).trimLeft(), "\\)")
return [i, 0]
else if startswith(line, "\\documentclass")
# pre-amble
for i in [start.line+1..cm.lastLine()]
if startswith(cm.getLine(i).trimLeft(), "\\begin{document}")
return [i - 1, 0]
else if startswith(line, "\\chapter")
# book chapter
for i in [start.line+1..cm.lastLine()]
if startswith(cm.getLine(i).trimLeft(), ["\\chapter", "\\end{document}"])
return [i - 1, 0]
return cm.lastLine()
else if startswith(line, "\\section")
# article section
for i in [start.line+1..cm.lastLine()]
if startswith(cm.getLine(i).trimLeft(), ["\\chapter", "\\section", "\\end{document}"])
return [i - 1, 0]
return cm.lastLine()
else if startswith(line, "\\subsection")
# article subsection
for i in [start.line+1..cm.lastLine()]
if startswith(cm.getLine(i).trimLeft(), ["\\chapter", "\\section", "\\subsection", "\\end{document}"])
return [i - 1, 0]
return cm.lastLine()
else if startswith(line, "\\subsubsection")
# article subsubsection
for i in [start.line+1..cm.lastLine()]
if startswith(cm.getLine(i).trimLeft(), ["\\chapter", "\\section", "\\subsection", "\\subsubsection", "\\end{document}"])
return [i - 1, 0]
return cm.lastLine()
else if startswith(line, "\\subsubsubsection")
# article subsubsubsection
for i in [start.line+1..cm.lastLine()]
if startswith(cm.getLine(i).trimLeft(), ["\\chapter", "\\section", "\\subsection", "\\subsubsection", "\\subsubsubsection", "\\end{document}"])
return [i - 1, 0]
return cm.lastLine()
else if startswith(line, "%\\begin{}")
# support what texmaker supports for custom folding -- http://tex.stackexchange.com/questions/44022/code-folding-in-latex
for i in [start.line+1..cm.lastLine()]
if startswith(cm.getLine(i).trimLeft(), "%\\end{}")
return [i, 0]
return [undefined, undefined] # no folding here...
[i, j] = find_close()
if i?
line = cm.getLine(start.line)
k = line.indexOf("}")
if k == -1
k = line.length
range =
from : CodeMirror.Pos(start.line, k+1)
to : CodeMirror.Pos(i, j)
return range
else
# nothing to fold
return undefined
CodeMirror.defineExtension 'unindent_selection', () ->
editor = @
for selection in editor.listSelections()
{start_line, end_line} = cm_start_end(selection)
all_need_unindent = true
for n in [start_line .. end_line]
s = editor.getLine(n)
if not s?
return
if s.length ==0 or s[0] == '\t' or s[0] == ' '
continue
else
all_need_unindent = false
break
if all_need_unindent
for n in [start_line .. end_line]
editor.indentLine(n, "subtract")
CodeMirror.defineExtension 'tab_as_space', () ->
cursor = @getCursor()
for i in [0...@.options.tabSize]
@replaceRange(' ', cursor)
# Apply a CodeMirror changeObj to this editing buffer.
CodeMirror.defineExtension 'apply_changeObj', (changeObj) ->
@replaceRange(changeObj.text, changeObj.from, changeObj.to)
if changeObj.next?
@apply_changeObj(changeObj.next)
# Delete all trailing whitespace from the editor's buffer.
CodeMirror.defineExtension 'delete_trailing_whitespace', (opts={}) ->
opts = defaults opts,
omit_lines : {}
# We *could* easily make a one-line version of this function that
# just uses setValue. However, that would mess up the undo
# history (!), and potentially feel jumpy.
changeObj = undefined
val = @getValue()
text1 = val.split('\n')
text2 = misc.delete_trailing_whitespace(val).split('\n') # a very fast regexp.
pos = @getCursor()
if text1.length != text2.length
console.log("Internal error -- there is a bug in misc.delete_trailing_whitespace; please report.")
return
opts.omit_lines[pos.line] = true
for i in [0...text1.length]
if opts.omit_lines[i]?
continue
if text1[i].length != text2[i].length
obj = {from:{line:i,ch:text2[i].length}, to:{line:i,ch:text1[i].length}, text:[""]}
if not changeObj?
changeObj = obj
currentObj = changeObj
else
currentObj.next = obj
currentObj = obj
if changeObj?
@apply_changeObj(changeObj)
# Set the value of the buffer to something new by replacing just the ranges
# that changed, so that the view/history/etc. doesn't get messed up.
CodeMirror.defineExtension 'setValueNoJump', (value) ->
cur_value = @getValue()
@.diffApply(dmp.diff_main(@getValue(), value))
CodeMirror.defineExtension 'patchApply', (patch) ->
## TODO: this is a very stupid/inefficient way to turn
## a patch into a diff. We should just directly rewrite
## the code below to work with patch.
cur_value = @getValue()
new_value = dmp.patch_apply(patch, cur_value)[0]
diff = dmp.diff_main(cur_value, new_value)
@.diffApply(diff)
CodeMirror.defineExtension 'diffApply', (diff) ->
## TODO: this is a very stupid/inefficient way to turn
## a patch into a diff. We should just directly rewrite
## the code below to work with patch.
next_pos = (val, pos) ->
# This functions answers the question:
# If you were to insert the string val at the CodeMirror position pos
# in a codemirror document, at what position (in codemirror) would
# the inserted string end at?
number_of_newlines = (val.match(/\n/g)||[]).length
if number_of_newlines == 0
return {line:pos.line, ch:pos.ch+val.length}
else
return {line:pos.line+number_of_newlines, ch:(val.length - val.lastIndexOf('\n')-1)}
pos = {line:0, ch:0} # start at the beginning
for chunk in diff
#console.log(chunk)
op = chunk[0] # 0 = stay same; -1 = delete; +1 = add
val = chunk[1] # the actual text to leave same, delete, or add
pos1 = next_pos(val, pos)
switch op
when 0 # stay the same
# Move our pos pointer to the next position
pos = pos1
#console.log("skipping to ", pos1)
when -1 # delete
# Delete until where val ends; don't change pos pointer.
@replaceRange("", pos, pos1)
#console.log("deleting from ", pos, " to ", pos1)
when +1 # insert
# Insert the new text right here.
@replaceRange(val, pos)
#console.log("inserted new text at ", pos)
# Move our pointer to just beyond the text we just inserted.
pos = pos1
# This is an improved rewrite of simple-hint.js from the CodeMirror3 distribution.
CodeMirror.defineExtension 'showCompletions', (opts) ->
{from, to, completions, target, completions_size} = defaults opts,
from : required
to : required
completions : required
target : required
completions_size : 20
if completions.length == 0
return
start_cursor_pos = @getCursor()
that = @
insert = (str) ->
pos = that.getCursor()
from.line = pos.line
to.line = pos.line
shift = pos.ch - start_cursor_pos.ch
from.ch += shift
to.ch += shift
that.replaceRange(str, from, to)
if completions.length == 1
insert(target + completions[0])
return
sel = $("