Active Line Demo
+ + + + +Styling the current cursor line.
+ + + +' + plugin_dict[key] + ' (' + plugin_name.replace( + 'plugins.', '') + ')' + + if req_group in ['doc','test']: + req_dict = req_dict_base.copy() + + self.logger.info("get_requirements_info: req_dict for group {} = {}".format(req_group, req_dict)) + return req_dict + + + def compare_versions(self, vers1, vers2, operator): + """ + Compare two version numbers and return if the condition is met + """ + v1s = vers1.split('.') + while len(v1s) < 4: + v1s.append('0') + v1 = [] + for v in v1s: + vi = 0 + try: + vi = int(v) + except: pass + v1.append(vi) + + v2s = vers2.split('.') + while len(v2s) < 4: + v2s.append('0') + v2 = [] + for v in v2s: + vi = 0 + try: + vi = int(v) + except: pass + v2.append(vi) + + result = False + if v1 == v2 and operator in ['>=','==','<=']: + result = True + if v1 < v2 and operator in ['<','<=']: + result = True + if v1 > v2 and operator in ['>','>=']: + result = True + + self.logger.debug("compare_versions: - - - v1 = {}, v2 = {}, operator = '{}', result = {}".format(v1, v2, operator, result)) + return result + + + def strip_operator(self, string, operator): + """ + Strip a leading operator from a string and remove quotes, if they exist + + :param string: string to remove the operator from + :param operator: operator to remove + :type string: str + :type operator: str + + :return: string without the operator + :rtype: str + """ + if string.startswith(operator): + return Utils.strip_quotes(string[len(operator):].strip()) + else: + return Utils.strip_quotes(string.strip()) + + + def split_operator(self, reqstring): + """ + split operator and version from string + + :param reqstring: string containing operator and version + :type reqstring: str + + :return: operator, version + :rtype: str, str + """ + if reqstring.startswith('=='): + operator = '==' + version = self.strip_operator(reqstring, operator) + elif reqstring.startswith('<='): + operator = '<=' + version = self.strip_operator(reqstring, operator) + elif reqstring.startswith('>='): + operator = '>=' + version = self.strip_operator(reqstring, operator) + elif reqstring.startswith('<'): + operator = '<' + version = self.strip_operator(reqstring, operator) + elif reqstring.startswith('>'): + operator = '>=' + version = self.strip_operator(reqstring, operator) + else: + operator = '' + version = reqstring + + return operator.strip(), version.strip() + + + def req_is_pyversion_req_relevant(self, pyreq, package=''): + """ + Test if requirement has a Python version restriction and if so, test if the restriction + is relevant. + """ + pyversion = "{0}.{1}".format(sys.version_info[0], sys.version_info[1]) + + pyreq = pyreq.strip().replace('python_version', '') + pyv_operator = '' + if pyreq != '': + self.logger.debug("req_is_pyversion_req_relevant: - - package {}, py_version {}".format(package, pyreq)) + if pyreq.startswith('=='): + pyv_operator = '==' + pyreq = self.strip_operator(pyreq, pyv_operator) + result = self.compare_versions(pyversion, pyreq, pyv_operator) + elif pyreq.startswith('<='): + pyv_operator = '<=' + pyreq = self.strip_operator(pyreq, pyv_operator) + result = self.compare_versions(pyversion, pyreq, pyv_operator) + elif pyreq.startswith('>='): + pyv_operator = '>=' + pyreq = self.strip_operator(pyreq, pyv_operator) + result = self.compare_versions(pyversion, pyreq, pyv_operator) + elif pyreq.startswith('<'): + pyv_operator = '<' + pyreq = self.strip_operator(pyreq, pyv_operator) + result = self.compare_versions(pyversion, pyreq, pyv_operator) + elif pyreq.startswith('>'): + pyv_operator = '>' + result = pyreq = self.strip_operator(pyreq, pyv_operator) + self.compare_versions(pyversion, pyreq, pyv_operator) + else: + pyv_operator = '' + self.logger.error("req_is_pyversion_req_relevant: no operator in front of Python version found - package {}, pyreq = {}".format(package, pyreq)) + result = False + + self.logger.debug("req_is_pyversion_req_relevant: - - - package {}, py_version_operator {}, py_version {}".format(package, pyv_operator, pyreq)) + return result + + +# operator: <, <=, ==, >=, >> +# source:
') # split up requirements from different plugins and the core + + req_result = [] + for req in req_templist: + req_result.append( self.req_split_source(req, package) ) + self.logger.info("check_requirement: package {}, len(req_result)={}, req_result = '{}'".format(package, len(req_result), req_result)) + + # Check if requirements from all sources are the same + if len(req_result) > 1: + are_equal = True + for req in req_result: + if req[1] != req_result[0][1]: + are_equal = False + if req[2] != req_result[0][2]: + are_equal = False + if are_equal: + req_result = [req_result[0]] + + req_txt = req_result + # Now we have a list of [ requirement_source, min_version (with operator), max_version (with operator) ] + if len(req_result) == 1: + result = req_result[0] + self.logger.info("check_requirement: package {}, req_result = >{}<, result = >{}<".format(package, req_result, result)) + #handle min + op, req_min = self.split_operator(result[1]) + if req_min == '*': + req_min = '' + req_txt = '' + else: + if op == '>': + req_min += '.0' + + #handle max + op, req_max = self.split_operator(result[2]) + if req_max == '*': + req_max = '' + req_txt = '' +# else: +# if op == '<': +# req_max = ? + + + self.logger.info("check_requirement: package {} ({}), req_result = '{}'".format(package, len(req_result), req_result)) + if req_min != '' or req_max != '': + req_txt = '' + + return req_min, req_max, req_txt + + + def getpackages(self): + """ + returns a list with the installed python packages and its versions + """ + self.find_visu_plugin() + + # check if pypi service is reachable + if self.pypi_timeout <= 0: + pypi_available = False + pypi_unavailable_message = translate('PyPI Prüfung deaktiviert') + else: + pypi_available = True + try: + import socket + sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) + sock.settimeout(self.pypi_timeout) + sock.connect(('pypi.python.org', 443)) + sock.close() + except: + pypi_available = False + pypi_unavailable_message = translate('PyPI nicht erreichbar') + + import pip + import xmlrpc + installed_packages = pip.get_installed_distributions() + pypi = xmlrpc.client.ServerProxy('https://pypi.python.org/pypi') + packages = [] + for dist in installed_packages: + package = {} + package['key'] = dist.key + package['version_installed'] = dist.version + if pypi_available: + try: + available = pypi.package_releases(dist.project_name) + try: + package['version_available'] = available[0] + except: + package['version_available'] = '-' + except: + package['version_available'] = [translate('Keine Antwort von PyPI')] + else: + package['version_available'] = pypi_unavailable_message + packages.append(package) + + sorted_packages = sorted([(i['key'], i['version_installed'], i['version_available']) for i in packages]) + return sorted_packages + + diff --git a/backend/BackendThreads.py b/backend/BackendThreads.py new file mode 100755 index 000000000..f7514de00 --- /dev/null +++ b/backend/BackendThreads.py @@ -0,0 +1,93 @@ +#!/usr/bin/env python3 +# -*- coding: utf8 -*- +######################################################################### +# Copyright 2016- René Frieß rene.friess@gmail.com +# Martin Sinn m.sinn@gmx.de +# Bernd Meiners +# Christian Strassburg c.strassburg@gmx.de +######################################################################### +# Backend plugin for SmartHomeNG +# +# This plugin 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 plugin 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 plugin. If not, see
+
+
+ SmartHomeNG {{ _('Logik') }}: {{ logicname }}
+ {{ _('Dateiname') }}: {{ file_path }} ++
+
+
+
+
+
+{% endblock %}
+
diff --git a/backend/templates/logics_view.html b/backend/_pv_1_3_5/templates/logics_view.html.off
old mode 100644
new mode 100755
similarity index 100%
rename from backend/templates/logics_view.html
rename to backend/_pv_1_3_5/templates/logics_view.html.off
diff --git a/backend/templates/main.html b/backend/_pv_1_3_5/templates/main.html
old mode 100644
new mode 100755
similarity index 100%
rename from backend/templates/main.html
rename to backend/_pv_1_3_5/templates/main.html
diff --git a/backend/templates/navbar.html b/backend/_pv_1_3_5/templates/navbar.html
old mode 100644
new mode 100755
similarity index 100%
rename from backend/templates/navbar.html
rename to backend/_pv_1_3_5/templates/navbar.html
diff --git a/backend/templates/plugins.html b/backend/_pv_1_3_5/templates/plugins.html
old mode 100644
new mode 100755
similarity index 51%
rename from backend/templates/plugins.html
rename to backend/_pv_1_3_5/templates/plugins.html
index 866e1b086..183e227e9
--- a/backend/templates/plugins.html
+++ b/backend/_pv_1_3_5/templates/plugins.html
@@ -21,7 +21,7 @@
{% for p in plugins %}
-
+ {% if updates %}
+
+
+ | {{ _('Status') }}: | ++ {% if not thislogic.enabled %}{{ _('Nicht aktiv') }}{% else %}{{ _('Aktiv') }}{% endif %} + | +
| {{ _('nächste Ausführung') }} | +{% if not thislogic.enabled %}{% endif %} + {{ thislogic.next_exec }} + {% if not thislogic.enabled %}{% endif %} + | +
| {{ _('Cycle') }} | ++ |
| {{ _('Crontab') }} | ++ |
| {{ _('Watch_Items') }} | ++ |
+ {% if logic_lines %}
+
+ {% if updates %}{% endif %}
+
+ {% else %}{{ _('no data available') }}{% endif %}
+
+ #, @, and : chars.
+
+[xml mode](http://codemirror.net/mode/xml/): Allow dashes in HTML tag names.
+
+[javascript mode](http://codemirror.net/mode/javascript/): Improve parsing of async methods, TypeScript-style comma-separated superclass lists.
+
+[indent-fold addon](http://codemirror.net/demo/folding.html): Ignore comment lines.
+
+### New features
+
+Positions now support a `sticky` property which determines whether they should be associated with the character before (value `"before"`) or after (value `"after"`) them.
+
+[vim bindings](http://codemirror.net/demo/vim.html): Make it possible to remove built-in bindings through the API.
+
+[comment addon](http://codemirror.net/doc/manual.html#addon_comment): Support a per-mode useInnerComments option to optionally suppress descending to the inner modes to get comment strings.
+
+### Breaking changes
+
+The [sass mode](http://codemirror.net/mode/sass/) now depends on the [css mode](http://codemirror.net/mode/css/).
+
+## 5.23.0 (2017-01-19)
+
+### Bug fixes
+
+Presentation-related elements DOM elements are now marked as such to help screen readers.
+
+[markdown mode](http://codemirror.net/mode/markdown/): Be more picky about what HTML tags look like to avoid false positives.
+
+### New features
+
+`findModeByMIME` now understands `+json` and `+xml` MIME suffixes.
+
+[closebrackets addon](http://codemirror.net/doc/manual.html#addon_closebrackets): Add support for an `override` option to ignore language-specific defaults.
+
+[panel addon](http://codemirror.net/doc/manual.html#addon_panel): Add a `stable` option that auto-scrolls the content to keep it in the same place when inserting/removing a panel.
+
+## 5.22.2 (2017-01-12)
+
+### Bug fixes
+
+Include rollup.config.js in NPM package, so that it can be used to build from source.
+
+## 5.22.0 (2016-12-20)
+
+### Bug fixes
+
+[sublime bindings](http://codemirror.net/demo/sublime.html): Make `selectBetweenBrackets` work with multiple cursors.
+
+[javascript mode](http://codemirror.net/mode/javascript/): Fix issues with parsing complex TypeScript types, imports, and exports.
+
+A contentEditable editor instance with autofocus enabled no longer crashes during initializing.
+
+### New features
+
+[emacs bindings](http://codemirror.net/demo/emacs.html): Export `CodeMirror.emacs` to allow other addons to hook into Emacs-style functionality.
+
+[active-line addon](http://codemirror.net/doc/manual.html#addon_active-line): Add `nonEmpty` option.
+
+New event: [`optionChange`](http://codemirror.net/doc/manual.html#event_optionChange).
+
+## 5.21.0 (2016-11-21)
+
+### Bug fixes
+
+Tapping/clicking the editor in [contentEditable mode](http://codemirror.net/doc/manual.html#option_inputStyle) on Chrome now puts the cursor at the tapped position.
+
+Fix various crashes and misbehaviors when reading composition events in [contentEditable mode](http://codemirror.net/doc/manual.html#option_inputStyle).
+
+Catches and ignores an IE 'Unspecified Error' when creating an editor in an iframe before there is a ``.
+
+[merge addon](http://codemirror.net/doc/manual.html#addon_merge): Fix several issues in the chunk-aligning feature.
+
+[verilog mode](http://codemirror.net/mode/verilog): Rewritten to address various issues.
+
+[julia mode](http://codemirror.net/mode/julia): Recognize Julia 0.5 syntax.
+
+[swift mode](http://codemirror.net/mode/swift): Various fixes and adjustments to current syntax.
+
+[markdown mode](http://codemirror.net/mode/markdown): Allow lists without a blank line above them.
+
+### New features
+
+The [`setGutterMarker`](http://codemirror.net/doc/manual.html#setGutterMarker), [`clearGutter`](http://codemirror.net/doc/manual.html#clearGutter), and [`lineInfo`](http://codemirror.net/doc/manual.html#lineInfo) methods are now available on `Doc` objects.
+
+The [`heightAtLine`](http://codemirror.net/doc/manual.html#heightAtLine) method now takes an extra argument to allow finding the height at the top of the line's line widgets.
+
+[ruby mode](http://codemirror.net/mode/ruby): `else` and `elsif` are now immediately indented.
+
+[vim bindings](http://codemirror.net/demo/vim.html): Bind Ctrl-T and Ctrl-D to in- and dedent in insert mode.
+
+## 5.20.2 (2016-10-21)
+
+### Bug fixes
+
+Fix `CodeMirror.version` returning the wrong version number.
+
+## 5.20.0 (2016-10-20)
+
+### Bug fixes
+
+Make `newlineAndIndent` command work with multiple cursors on the same line.
+
+Make sure keypress events for backspace are ignored.
+
+Tokens styled with overlays no longer get a nonsense `cm-cm-overlay` class.
+
+Line endings for pasted content are now normalized to the editor's [preferred ending](http://codemirror.net/doc/manual.html#option_lineSeparator).
+
+[javascript mode](http://codemirror.net/mode/javascript): Improve support for class expressions. Support TypeScript optional class properties, the `abstract` keyword, and return type declarations for arrow functions.
+
+[css mode](http://codemirror.net/mode/css): Fix highlighting of mixed-case keywords.
+
+[closebrackets addon](http://codemirror.net/doc/manual.html#addon_closebrackets): Improve behavior when typing a quote before a string.
+
+### New features
+
+The core is now maintained as a number of small files, using ES6 syntax and modules, under the `src/` directory. A git checkout no longer contains a working `codemirror.js` until you `npm build` (but when installing from NPM, it is included).
+
+The [`refresh`](http://codemirror.net/doc/manual.html#event_refresh) event is now documented and stable.
+
+## 5.19.0 (2016-09-20)
+
+### Bugfixes
+
+[erlang mode](http://codemirror.net/mode/erlang): Fix mode crash when trying to read an empty context.
+
+[comment addon](http://codemirror.net/doc/manual.html#addon_comment): Fix broken behavior when toggling comments inside a comment.
+
+xml-fold addon: Fix a null-dereference bug.
+
+Page up and page down now do something even in single-line documents.
+
+Fix an issue where the cursor position could be off in really long (~8000 character) tokens.
+
+### New features
+
+[javascript mode](http://codemirror.net/mode/javascript): Better indentation when semicolons are missing. Better support for TypeScript classes, optional parameters, and the `type` keyword.
+
+The [`blur`](http://codemirror.net/doc/manual.html#event_blur) and [`focus`](http://codemirror.net/doc/manual.html#event_focus) events now pass the DOM event to their handlers.
+
+## 5.18.2 (2016-08-23)
+
+### Bugfixes
+
+[vue mode](http://codemirror.net/mode/vue): Fix outdated references to renamed Pug mode dependency.
+
+## 5.18.0 (2016-08-22)
+
+### Bugfixes
+
+Make sure [gutter backgrounds](http://codemirror.net/doc/manual.html#addLineClass) stick to the rest of the gutter during horizontal scrolling.
+
+The contenteditable [`inputStyle`](http://codemirror.net/doc/manual.html#option_inputStyle) now properly supports pasting on pre-Edge IE versions.
+
+[javascript mode](http://codemirror.net/mode/javascript): Fix some small parsing bugs and improve TypeScript support.
+
+[matchbrackets addon](http://codemirror.net/doc/manual.html#addon_matchbrackets): Fix bug where active highlighting was left in editor when the addon was disabled.
+
+[match-highlighter addon](http://codemirror.net/doc/manual.html#addon_match-highlighter): Only start highlighting things when the editor gains focus.
+
+[javascript-hint addon](http://codemirror.net/doc/manual.html#addon_javascript-hint): Also complete non-enumerable properties.
+
+### New features
+
+The [`addOverlay`](http://codemirror.net/doc/manual.html#addOverlay) method now supports a `priority` option to control the order in which overlays are applied.
+
+MIME types that end in `+json` now default to the JSON mode when the MIME itself is not defined.
+
+### Breaking changes
+
+The mode formerly known as Jade was renamed to [Pug](http://codemirror.net/mode/pug).
+
+The [Python mode](http://codemirror.net/mode/python) now defaults to Python 3 (rather than 2) syntax.
+
+## 5.17.0 (2016-07-19)
+
+### Bugfixes
+
+Fix problem with wrapped trailing whitespace displaying incorrectly.
+
+Prevent IME dialog from overlapping typed content in Chrome.
+
+Improve measuring of characters near a line wrap.
+
+[javascript mode](http://codemirror.net/mode/javascript): Improve support for `async`, allow trailing commas in `import` lists.
+
+[vim bindings](http://codemirror.net/demo/vim.html): Fix backspace in replace mode.
+
+[sublime bindings](http://codemirror.net/demo/sublime.html): Fix some key bindings on OS X to match Sublime Text.
+
+### New features
+
+[markdown mode](http://codemirror.net/mode/markdown): Add more classes to image links in highlight-formatting mode.
+
+## 5.16.0 (2016-06-20)
+
+### Bugfixes
+
+Fix glitches when dragging content caused by the drop indicator receiving mouse events.
+
+Make Control-drag work on Firefox.
+
+Make clicking or selection-dragging at the end of a wrapped line select the right position.
+
+[show-hint addon](http://codemirror.net/doc/manual.html#addon_show-hint): Prevent widget scrollbar from hiding part of the hint text.
+
+[rulers addon](http://codemirror.net/doc/manual.html#addon_rulers): Prevent rulers from forcing a horizontal editor scrollbar.
+
+### New features
+
+[search addon](http://codemirror.net/doc/manual.html#addon_search): Automatically bind search-related keys in persistent dialog.
+
+[sublime keymap](http://codemirror.net/demo/sublime.html): Add a multi-cursor aware smart backspace binding.
+
+## 5.15.2 (2016-05-20)
+
+### Bugfixes
+
+Fix a critical document corruption bug that occurs when a document is gradually grown.
+
+## 5.15.0 (2016-05-20)
+
+### Bugfixes
+
+Fix bug that caused the selection to reset when focusing the editor in contentEditable input mode.
+
+Fix issue where not all ASCII control characters were being replaced by placeholders.
+
+Remove the assumption that all modes have a `startState` method from several wrapping modes.
+
+Fix issue where the editor would complain about overlapping collapsed ranges when there weren't any.
+
+Optimize document tree building when loading or pasting huge chunks of content.
+
+[markdown mode](http://codemirror.net/mode/markdown/): Fix several issues in matching link targets.
+
+[clike mode](http://codemirror.net/mode/clike/): Improve indentation of C++ template declarations.
+
+### New features
+
+Explicitly bind Ctrl-O on OS X to make that binding (“open line”) act as expected.
+
+Pasting [linewise-copied](http://codemirror.net/doc/manual.html#option_lineWiseCopyCut) content when there is no selection now inserts the lines above the current line.
+
+[javascript mode](http://codemirror.net/mode/javascript/): Support `async`/`await` and improve support for TypeScript type syntax.
+
+## 5.14.2 (2016-04-20)
+
+### Bugfixes
+
+Push a new package to NPM due to an [NPM bug](https://github.com/npm/npm/issues/5082) omitting the LICENSE file in 5.14.0.
+
+Set `dataTransfer.effectAllowed` in `dragstart` handler to help browsers use the right drag icon.
+
+Add the [mbox mode](http://codemirror.net/mode/mbox/index.html) to `mode/meta.js`.
+
+## 5.14.0 (2016-04-20)
+
+### Bugfixes
+
+[`posFromIndex`](http://codemirror.net/doc/manual.html#posFromIndex) and [`indexFromPos`](http://codemirror.net/doc/manual.html#indexFromPos) now take [`lineSeparator`](http://codemirror.net/doc/manual.html#option_lineSeparator) into account.
+
+[vim bindings](http://codemirror.net/demo/vim.html): Only call `.save()` when it is actually available.
+
+[comment addon](http://codemirror.net/doc/manual.html#addon_comment): Be careful not to mangle multi-line strings.
+
+[Python mode](http://codemirror.net/mode/python/index.html): Improve distinguishing of decorators from `@` operators.
+
+[`findMarks`](http://codemirror.net/doc/manual.html#findMarks): No longer return marks that touch but don't overlap given range.
+
+### New features
+
+[vim bindings](http://codemirror.net/demo/vim.html): Add yank command.
+
+[match-highlighter addon](http://codemirror.net/doc/manual.html#addon_match-highlighter): Add `trim` option to disable ignoring of whitespace.
+
+[PowerShell mode](http://codemirror.net/mode/powershell/index.html): Added.
+
+[Yacas mode](http://codemirror.net/mode/yacas/index.html): Added.
+
+[Web IDL mode](http://codemirror.net/mode/webidl/index.html): Added.
+
+[SAS mode](http://codemirror.net/mode/sas/index.html): Added.
+
+[mbox mode](http://codemirror.net/mode/mbox/index.html): Added.
+
+## 5.13.2 (2016-03-23)
+
+### Bugfixes
+
+Solves a problem where the gutter would sometimes not extend all the way to the end of the document.
+
+## 5.13.0 (2016-03-21)
+
+### New features
+
+New DOM event forwarded: [`"dragleave"`](http://codemirror.net/doc/manual.html#event_dom).
+
+[protobuf mode](http://codemirror.net/mode/protobuf/index.html): Newly added.
+
+### Bugfixes
+
+Fix problem where [`findMarks`](http://codemirror.net/doc/manual.html#findMarks) sometimes failed to find multi-line marks.
+
+Fix crash that showed up when atomic ranges and bidi text were combined.
+
+[show-hint addon](http://codemirror.net/demo/complete.html): Completion widgets no longer close when the line indented or dedented.
+
+[merge addon](http://codemirror.net/demo/merge.html): Fix bug when merging chunks at the end of the file.
+
+[placeholder addon](http://codemirror.net/doc/manual.html#addon_placeholder): No longer gets confused by [`swapDoc`](http://codemirror.net/doc/manual.html#swapDoc).
+
+[simplescrollbars addon](http://codemirror.net/doc/manual.html#addon_simplescrollbars): Fix invalid state when deleting at end of document.
+
+[clike mode](http://codemirror.net/mode/clike/index.html): No longer gets confused when a comment starts after an operator.
+
+[markdown mode](http://codemirror.net/mode/markdown/index.html): Now supports CommonMark-style flexible list indentation.
+
+[dylan mode](http://codemirror.net/mode/dylan/index.html): Several improvements and fixes.
+
+## 5.12.0 (2016-02-19)
+
+### New features
+
+[Vim bindings](http://codemirror.net/demo/vim.html): Ctrl-Q is now an alias for Ctrl-V.
+
+[Vim bindings](http://codemirror.net/demo/vim.html): The Vim API now exposes an `unmap` method to unmap bindings.
+
+[active-line addon](http://codemirror.net/demo/activeline.html): This addon can now style the active line's gutter.
+
+[FCL mode](http://codemirror.net/mode/fcl/): Newly added.
+
+[SQL mode](http://codemirror.net/mode/sql/): Now has a Postgresql dialect.
+
+### Bugfixes
+
+Fix [issue](https://github.com/codemirror/CodeMirror/issues/3781) where trying to scroll to a horizontal position outside of the document's width could cause the gutter to be positioned incorrectly.
+
+Use absolute, rather than fixed positioning in the context-menu intercept hack, to work around a [problem](https://github.com/codemirror/CodeMirror/issues/3238) when the editor is inside a transformed parent container.
+
+Solve a [problem](https://github.com/codemirror/CodeMirror/issues/3821) where the horizontal scrollbar could hide text in Firefox.
+
+Fix a [bug](https://github.com/codemirror/CodeMirror/issues/3834) that caused phantom scroll space under the text in some situations.
+
+[Sublime Text bindings](http://codemirror.net/demo/sublime.html): Bind delete-line to Shift-Ctrl-K on OS X.
+
+[Markdown mode](http://codemirror.net/mode/markdown/): Fix [issue](https://github.com/codemirror/CodeMirror/issues/3787) where the mode would keep state related to fenced code blocks in an unsafe way, leading to occasional corrupted parses.
+
+[Markdown mode](http://codemirror.net/mode/markdown/): Ignore backslashes in code fragments.
+
+[Markdown mode](http://codemirror.net/mode/markdown/): Use whichever mode is registered as `text/html` to parse HTML.
+
+[Clike mode](http://codemirror.net/mode/clike/): Improve indentation of Scala `=>` functions.
+
+[Python mode](http://codemirror.net/mode/python/): Improve indentation of bracketed code.
+
+[HTMLMixed mode](http://codemirror.net/mode/htmlmixed/): Support multi-line opening tags for sub-languages (`
+
+
+
+
+
+Any Word Completion Demo
+ + +Press ctrl-space to activate autocompletion. The +completion uses +the anyword-hint.js +module, which simply looks at nearby words in the buffer and completes +to those.
+ + +Bi-directional Text Demo
+ + + + +Demonstration of bi-directional text support. See + the related + blog post for more background.
+ +B-Tree visualization
+ + + + + + + +Multiple Buffer & Split View Demo
+ + + +
+ Select buffer:
+
+
+
+
+ Select buffer:
+
+
+
+
+
+ Demonstration of
+ using linked documents
+ to provide a split view on a document, and
+ using swapDoc
+ to use a single editor to display multiple documents.
Mode-Changing Demo
+ + +On changes to the content of the above editor, a (crude) script +tries to auto-detect the language used, and switches the editor to +either JavaScript or Scheme mode based on that.
+ + +Closebrackets Demo
+ + + +Close-Tag Demo
+ + + +Autocomplete Demo
+ + +Press ctrl-space to activate autocompletion. Built
+on top of the show-hint
+and javascript-hint
+addons.
Emacs bindings demo
+ + +The emacs keybindings are enabled by
+including keymap/emacs.js and setting
+the keyMap option to "emacs". Because
+CodeMirror's internal API is quite different from Emacs, they are only
+a loose approximation of actual emacs bindings, though.
Also note that a lot of browsers disallow certain keys from being +captured. For example, Chrome blocks both Ctrl-W and Ctrl-N, with the +result that idiomatic use of Emacs keys will constantly close your tab +or open a new window.
+ + + +Code Folding Demo
+ + +Full Screen Editing
+ + + +Demonstration of + the fullscreen + addon. Press F11 when cursor is in the editor to + toggle full screen editing. Esc can also be used + to exit full screen editing.
+Hard-wrapping Demo
+ + +Demonstration of
+the hardwrap addon.
+The above editor has its change event hooked up to
+the wrapParagraphsInRange method, so that the paragraphs
+are reflown as you are typing.
HTML completion demo
+ +Shows the XML completer + parameterized with information about the tags in HTML. + Press ctrl-space to activate completion.
+ + + + +Indented wrapped line demo
+ + +This page uses a hack on top of the "renderLine"
+ event to make wrapped text line up with the base indentation of
+ the line.
Linter Demo
+ + + + + + + + + +Lazy Mode Loading Demo
+Current mode: text/plain
+ +Filename, mime, or mode name:
+ + +Breakpoint Demo
+ + +Click the line-number gutter to add or remove 'breakpoints'.
+ + + +Selection Marking Demo
+ + + + +Simple addon to easily mark (and style) selected text. Docs.
+ +Match Highlighter Demo
+ + + + +Search and highlight occurences of the selected text.
+ +Tag Matcher Demo
+ + + + + + +Put the cursor on or inside a pair of tags to highlight them. + Press Ctrl-J to jump to the tag that matches the one under the + cursor.
+merge view demo
+ + + + +The merge
+addon provides an interface for displaying and merging diffs,
+either two-way
+or three-way.
+The left (or center) pane is editable, and the differences with the
+other pane(s) are optionally shown live as you edit
+it. In the two-way configuration, there are also options to pad changed
+sections to align them, and to collapse unchanged
+stretches of text.
This addon depends on +the google-diff-match-patch +library to compute the diffs.
+ + +Multiplexing Parser Demo
+ + + + +Demonstration of a multiplexing mode, which, at certain
+ boundary strings, switches to one or more inner modes. The out
+ (HTML) mode does not get fed the content of the <<
+ >> blocks. See
+ the manual and
+ the source for more
+ information.
Overlay Parser Demo
+ + + + +Demonstration of a mode that parses HTML, highlighting
+ the Mustache templating
+ directives inside of it by using the code
+ in overlay.js. View
+ source to see the 15 lines of code needed to accomplish this.
Panel Demo
+ +
+
+
+
+
+ The panel
+ addon allows you to display panels above or below an editor.
+
+ Click the links below to add panels at the given position:
+
+
+
++ top + after-top + before-bottom + bottom +
++ You can also replace an existing panel: +
+ + + + +Placeholder demo
+ + +The placeholder
+ plug-in adds an option placeholder that can be set to
+ make text appear in the editor when it is empty and not focused.
+ If the source textarea has a placeholder attribute,
+ it will automatically be inherited.
HTML5 preview
+ + + + +RequireJS module loading demo
+ +This demo does the same thing as + the HTML5 completion demo, but + loads its dependencies + with Require.js, rather than + explicitly. Press ctrl-space to activate + completion.
+ + + + + + +Autoresize Demo
+ + +By setting an editor's height style
+to auto and giving
+the viewportMargin
+a value of Infinity, CodeMirror can be made to
+automatically resize to fit its content.
Ruler Demo
+ + + +Demonstration of +the rulers addon, which +displays vertical lines at given column offsets.
+ +Mode Runner Demo
+ + ++ + + + + +
Running a CodeMirror mode outside of the editor.
+ The CodeMirror.runMode function, defined
+ in addon/runmode/runmode.js takes the following arguments:
-
+
text (string)
+ - The document to run through the highlighter. +
mode (mode spec)
+ - The mode to use (must be loaded as normal). +
output (function or DOM node)
+ - If this is a function, it will be called for each token with
+ two arguments, the token's text and the token's style class (may
+ be
nullfor unstyled tokens). If it is a DOM node, + the tokens will be converted tospanelements as in + an editor, and inserted into the node + (throughinnerHTML).
+
Search/Replace Demo
+ + + + +Demonstration of primitive search/replace functionality. The + keybindings (which can be configured with custom keymaps) are:
+-
+
- Ctrl-F / Cmd-F
- Start searching +
- Ctrl-G / Cmd-G
- Find next +
- Shift-Ctrl-G / Shift-Cmd-G
- Find previous +
- Shift-Ctrl-F / Cmd-Option-F
- Replace +
- Shift-Ctrl-R / Shift-Cmd-Option-F
- Replace all +
- Alt-F
- Persistent search (dialog doesn't autoclose, + enter to find next, Shift-Enter to find previous) +
- Alt-G
- Jump to line +
Searching is enabled by + including addon/search/search.js + and addon/search/searchcursor.js. + Jump to line - including addon/search/jump-to-line.js.
+For good-looking input dialogs, you also want to include + addon/dialog/dialog.js + and addon/dialog/dialog.css.
+Simple Mode Demo
+ +The mode/simple
+addon allows CodeMirror modes to be specified using a relatively simple
+declarative format. This format is not as powerful as writing code
+directly against the mode
+interface, but is a lot easier to get started with, and
+sufficiently expressive for many simple language modes.
This interface is still in flux. It is unlikely to be scrapped or +overhauled completely, so do start writing code against it, but +details might change as it stabilizes, and you might have to tweak +your code when upgrading.
+ +Simple modes (loosely based on +the Common +JavaScript Syntax Highlighting Specification, which never took +off), are state machines, where each state has a number of rules that +match tokens. A rule describes a type of token that may occur in the +current state, and possibly a transition to another state caused by +that token.
+ +The CodeMirror.defineSimpleMode(name, states) method
+takes a mode name and an object that describes the mode's states. The
+editor below shows an example of such a mode (and is itself
+highlighted by the mode shown in it).
Each state is an array of rules. A rule may have the following properties:
+ +-
+
regex: string | RegExp
+ - The regular expression that matches the token. May be a string
+ or a regex object. When a regex, the
ignoreCaseflag + will be taken into account when matching the token. This regex + has to capture groups when thetokenproperty is + an array. If it captures groups, it must capture all of the string + (since JS provides no way to find out where a group matched).
+ token: string | array<string> | null
+ - An optional token style. Multiple styles can be specified by
+ separating them with dots or spaces. When this property holds an array of token styles,
+ the
regexfor this rule must capture a group for each array item. +
+ sol: boolean
+ - When true, this token will only match at the start of the line.
+ (The
^regexp marker doesn't work as you'd expect in + this context because of limitations in JavaScript's RegExp + API.)
+ next: string
+ - When a
nextproperty is present, the mode will + transfer to the state named by the property when the token is + encountered.
+ push: string
+ - Like
next, but instead replacing the current state + by the new state, the current state is kept on a stack, and can be + returned to with thepopdirective.
+ pop: bool
+ - When true, and there is another state on the state stack, will + cause the mode to pop that state off the stack and transition to + it. +
mode: {spec, end, persistent}
+ - Can be used to embed another mode inside a mode. When present,
+ must hold an object with a
specproperty that describes + the embedded mode, and an optionalendend property + that specifies the regexp that will end the extent of the mode. When + apersistentproperty is set (and true), the nested + mode's state will be preserved between occurrences of the mode.
+ indent: bool
+ - When true, this token changes the indentation to be one unit + more than the current line's indentation. +
dedent: bool
+ - When true, this token will pop one scope off the indentation + stack. +
dedentIfLineStart: bool
+ - If a token has its
dedentproperty set, it will, by + default, cause lines where it appears at the start to be dedented. + Set this property to false to prevent that behavior.
+
The meta property of the states object is special, and
+will not be interpreted as a state. Instead, properties set on it will
+be set on the mode, which is useful for properties
+like lineComment,
+which sets the comment style for a mode. The simple mode addon also
+recognizes a few such properties:
-
+
dontIndentStates: array<string>
+ - An array of states in which the mode's auto-indentation should + not take effect. Usually used for multi-line comment and string + states. +
Simple Scrollbar Demo
+ + +The simplescrollbars addon defines two
+styles of non-native scrollbars: "simple" and "overlay" (click to try), which can be passed to
+the scrollbarStyle option. These implement
+the scrollbar using DOM elements, allowing more control over
+its appearance.
+ 
+
+
+
+
+
+CodeMirror
+
+
+
+Automatically derive odd wrapping behavior for your browser
+ + +This is a hack to automatically derive
+ a spanAffectsWrapping regexp for a browser. See the
+ comments above that variable
+ in lib/codemirror.js
+ for some more details.
Sublime Text bindings demo
+ +The sublime keymap defines many Sublime Text-specific
+bindings for CodeMirror. See the code below for an overview.
Enable the keymap by
+loading keymap/sublime.js
+and setting
+the keyMap
+option to "sublime".
(A lot of the search functionality is still missing.) + + + +
Tern Demo
+ + +Demonstrates integration of Tern +and CodeMirror. The following keys are bound:
+ +-
+
- Ctrl-Space
- Autocomplete +
- Ctrl-O
- Find docs for the expression at the cursor +
- Ctrl-I
- Find type at cursor +
- Alt-.
- Jump to definition (Alt-, to jump back) +
- Ctrl-Q
- Rename variable +
- Ctrl-.
- Select all occurrences of a variable +
Documentation is sparse for now. See the top of +the script for a rough API +overview.
+ + + +Theme Demo
+ + +Select a theme: +
+ + +Trailing Whitespace Demo
+ + + + +Uses +the trailingspace +addon to highlight trailing whitespace.
+ +Variable Height Demo
+ + +Vim bindings demo
+ +Note: The CodeMirror vim bindings do not have an +active maintainer. That means that if you report bugs in it, they are +likely to go unanswered. It also means that if you want to help, you +are very welcome to look +at the +open issues and see which ones you can solve.
+ + +Key buffer:
+
+The vim keybindings are enabled by including keymap/vim.js and setting the
+keyMap option to vim.
Features
+ +-
+
- All common motions and operators, including text objects +
- Operator motion orthogonality +
- Visual mode - characterwise, linewise, blockwise +
- Full macro support (q, @) +
- Incremental highlighted search (/, ?, #, *, g#, g*) +
- Search/replace with confirm (:substitute, :%s) +
- Search history +
- Jump lists (Ctrl-o, Ctrl-i) +
- Key/command mapping with API (:map, :nmap, :vmap) +
- Sort (:sort) +
- Marks (`, ') +
- :global +
- Insert mode behaves identical to base CodeMirror +
- Cross-buffer yank/paste +
For the full list of key mappings and Ex commands, refer to the
+defaultKeymap and defaultExCommandMap at the
+top of keymap/vim.js.
+
+
Note that while the vim mode tries to emulate the most useful +features of vim as faithfully as possible, it does not strive to +become a complete vim implementation
+ + + +Visible tabs demo
+ + +Tabs inside the editor are spans with the
+class cm-tab, and can be styled.
Inline Widget Demo
+ + + + +This demo runs JSHint over the code +in the editor (which is the script used on this page), and +inserts line widgets to +display the warnings that JSHint comes up with.
+XML Autocomplete Demo
+ + +Press ctrl-space, or type a '<' character to + activate autocompletion. This demo defines a simple schema that + guides completion. The schema can be customized—see + the manual.
+ +Development of the xml-hint addon was kindly
+ sponsored
+ by www.xperiment.mobi.
+ 
+
+
+
+
+CodeMirror
+
+
+ -
+
- Introduction +
- General Approach +
- Input +
- Selection +
- Intelligent Updating +
- Parsing +
- What Gives? +
- Content Representation +
- Key Maps +
(Re-) Implementing A Syntax-Highlighting Editor in JavaScript
+ +
+ Topic: JavaScript, code editor implementation
+ Author: Marijn Haverbeke
+ Date: March 2nd 2011 (updated November 13th 2011)
+
Caution: this text was written briefly after +version 2 was initially written. It no longer (even including the +update at the bottom) fully represents the current implementation. I'm +leaving it here as a historic document. For more up-to-date +information, look at the entries +tagged cm-internals +on my blog.
+ +This is a followup to +my Brutal Odyssey to the +Dark Side of the DOM Tree story. That one describes the +mind-bending process of implementing (what would become) CodeMirror 1. +This one describes the internals of CodeMirror 2, a complete rewrite +and rethink of the old code base. I wanted to give this piece another +Hunter Thompson copycat subtitle, but somehow that would be out of +place—the process this time around was one of straightforward +engineering, requiring no serious mind-bending whatsoever.
+ +So, what is wrong with CodeMirror 1? I'd estimate, by mailing list +activity and general search-engine presence, that it has been +integrated into about a thousand systems by now. The most prominent +one, since a few weeks, +being Google +code's project hosting. It works, and it's being used widely.
+ +Still, I did not start replacing it because I was bored. CodeMirror
+1 was heavily reliant on designMode
+or contentEditable (depending on the browser). Neither of
+these are well specified (HTML5 tries
+to specify
+their basics), and, more importantly, they tend to be one of the more
+obscure and buggy areas of browser functionality—CodeMirror, by using
+this functionality in a non-typical way, was constantly running up
+against browser bugs. WebKit wouldn't show an empty line at the end of
+the document, and in some releases would suddenly get unbearably slow.
+Firefox would show the cursor in the wrong place. Internet Explorer
+would insist on linkifying everything that looked like a URL or email
+address, a behaviour that can't be turned off. Some bugs I managed to
+work around (which was often a frustrating, painful process), others,
+such as the Firefox cursor placement, I gave up on, and had to tell
+user after user that they were known problems, but not something I
+could help.
Also, there is the fact that designMode (which seemed
+to be less buggy than contentEditable in Webkit and
+Firefox, and was thus used by CodeMirror 1 in those browsers) requires
+a frame. Frames are another tricky area. It takes some effort to
+prevent getting tripped up by domain restrictions, they don't
+initialize synchronously, behave strangely in response to the back
+button, and, on several browsers, can't be moved around the DOM
+without having them re-initialize. They did provide a very nice way to
+namespace the library, though—CodeMirror 1 could freely pollute the
+namespace inside the frame.
Finally, working with an editable document means working with
+selection in arbitrary DOM structures. Internet Explorer (8 and
+before) has an utterly different (and awkward) selection API than all
+of the other browsers, and even among the different implementations of
+document.selection, details about how exactly a selection
+is represented vary quite a bit. Add to that the fact that Opera's
+selection support tended to be very buggy until recently, and you can
+imagine why CodeMirror 1 contains 700 lines of selection-handling
+code.
And that brings us to the main issue with the CodeMirror 1 +code base: The proportion of browser-bug-workarounds to real +application code was getting dangerously high. By building on top of a +few dodgy features, I put the system in a vulnerable position—any +incompatibility and bugginess in these features, I had to paper over +with my own code. Not only did I have to do some serious stunt-work to +get it to work on older browsers (as detailed in the +previous story), things +also kept breaking in newly released versions, requiring me to come up +with new scary hacks in order to keep up. This was starting +to lose its appeal.
+ +General Approach
+ +What CodeMirror 2 does is try to sidestep most of the hairy hacks +that came up in version 1. I owe a lot to the +ACE editor for inspiration on how to +approach this.
+ +I absolutely did not want to be completely reliant on key events to +generate my input. Every JavaScript programmer knows that key event +information is horrible and incomplete. Some people (most awesomely +Mihai Bazon with Ymacs) have been able +to build more or less functioning editors by directly reading key +events, but it takes a lot of work (the kind of never-ending, fragile +work I described earlier), and will never be able to properly support +things like multi-keystoke international character +input. [see below for caveat]
+ +So what I do is focus a hidden textarea, and let the browser +believe that the user is typing into that. What we show to the user is +a DOM structure we built to represent his document. If this is updated +quickly enough, and shows some kind of believable cursor, it feels +like a real text-input control.
+ +Another big win is that this DOM representation does not have to
+span the whole document. Some CodeMirror 1 users insisted that they
+needed to put a 30 thousand line XML document into CodeMirror. Putting
+all that into the DOM takes a while, especially since, for some
+reason, an editable DOM tree is slower than a normal one on most
+browsers. If we have full control over what we show, we must only
+ensure that the visible part of the document has been added, and can
+do the rest only when needed. (Fortunately, the onscroll
+event works almost the same on all browsers, and lends itself well to
+displaying things only as they are scrolled into view.)
Input
+ +ACE uses its hidden textarea only as a text input shim, and does +all cursor movement and things like text deletion itself by directly +handling key events. CodeMirror's way is to let the browser do its +thing as much as possible, and not, for example, define its own set of +key bindings. One way to do this would have been to have the whole +document inside the hidden textarea, and after each key event update +the display DOM to reflect what's in that textarea.
+ +That'd be simple, but it is not realistic. For even medium-sized +document the editor would be constantly munging huge strings, and get +terribly slow. What CodeMirror 2 does is put the current selection, +along with an extra line on the top and on the bottom, into the +textarea.
+ +This means that the arrow keys (and their ctrl-variations), home, +end, etcetera, do not have to be handled specially. We just read the +cursor position in the textarea, and update our cursor to match it. +Also, copy and paste work pretty much for free, and people get their +native key bindings, without any special work on my part. For example, +I have emacs key bindings configured for Chrome and Firefox. There is +no way for a script to detect this. [no longer the case]
+ +Of course, since only a small part of the document sits in the +textarea, keys like page up and ctrl-end won't do the right thing. +CodeMirror is catching those events and handling them itself.
+Selection
+ +Getting and setting the selection range of a textarea in modern
+browsers is trivial—you just use the selectionStart
+and selectionEnd properties. On IE you have to do some
+insane stuff with temporary ranges and compensating for the fact that
+moving the selection by a 'character' will treat \r\n as a single
+character, but even there it is possible to build functions that
+reliably set and get the selection range.
But consider this typical case: When I'm somewhere in my document, +press shift, and press the up arrow, something gets selected. Then, if +I, still holding shift, press the up arrow again, the top of my +selection is adjusted. The selection remembers where its head +and its anchor are, and moves the head when we shift-move. +This is a generally accepted property of selections, and done right by +every editing component built in the past twenty years.
+ +But not something that the browser selection APIs expose.
+ +Great. So when someone creates an 'upside-down' selection, the next +time CodeMirror has to update the textarea, it'll re-create the +selection as an 'upside-up' selection, with the anchor at the top, and +the next cursor motion will behave in an unexpected way—our second +up-arrow press in the example above will not do anything, since it is +interpreted in exactly the same way as the first.
+ +No problem. We'll just, ehm, detect that the selection is +upside-down (you can tell by the way it was created), and then, when +an upside-down selection is present, and a cursor-moving key is +pressed in combination with shift, we quickly collapse the selection +in the textarea to its start, allow the key to take effect, and then +combine its new head with its old anchor to get the real +selection.
+ +In short, scary hacks could not be avoided entirely in CodeMirror +2.
+ +And, the observant reader might ask, how do you even know that a +key combo is a cursor-moving combo, if you claim you support any +native key bindings? Well, we don't, but we can learn. The editor +keeps a set known cursor-movement combos (initialized to the +predictable defaults), and updates this set when it observes that +pressing a certain key had (only) the effect of moving the cursor. +This, of course, doesn't work if the first time the key is used was +for extending an inverted selection, but it works most of the +time.
+Intelligent Updating
+ +One thing that always comes up when you have a complicated internal +state that's reflected in some user-visible external representation +(in this case, the displayed code and the textarea's content) is +keeping the two in sync. The naive way is to just update the display +every time you change your state, but this is not only error prone +(you'll forget), it also easily leads to duplicate work on big, +composite operations. Then you start passing around flags indicating +whether the display should be updated in an attempt to be efficient +again and, well, at that point you might as well give up completely.
+ +I did go down that road, but then switched to a much simpler model: +simply keep track of all the things that have been changed during an +action, and then, only at the end, use this information to update the +user-visible display.
+ +CodeMirror uses a concept of operations, which start by
+calling a specific set-up function that clears the state and end by
+calling another function that reads this state and does the required
+updating. Most event handlers, and all the user-visible methods that
+change state are wrapped like this. There's a method
+called operation that accepts a function, and returns
+another function that wraps the given function as an operation.
It's trivial to extend this (as CodeMirror does) to detect nesting, +and, when an operation is started inside an operation, simply +increment the nesting count, and only do the updating when this count +reaches zero again.
+ +If we have a set of changed ranges and know the currently shown +range, we can (with some awkward code to deal with the fact that +changes can add and remove lines, so we're dealing with a changing +coordinate system) construct a map of the ranges that were left +intact. We can then compare this map with the part of the document +that's currently visible (based on scroll offset and editor height) to +determine whether something needs to be updated.
+ +CodeMirror uses two update algorithms—a full refresh, where it just +discards the whole part of the DOM that contains the edited text and +rebuilds it, and a patch algorithm, where it uses the information +about changed and intact ranges to update only the out-of-date parts +of the DOM. When more than 30 percent (which is the current heuristic, +might change) of the lines need to be updated, the full refresh is +chosen (since it's faster to do than painstakingly finding and +updating all the changed lines), in the other case it does the +patching (so that, if you scroll a line or select another character, +the whole screen doesn't have to be +re-rendered). [the full-refresh +algorithm was dropped, it wasn't really faster than the patching +one]
+ +All updating uses innerHTML rather than direct DOM
+manipulation, since that still seems to be by far the fastest way to
+build documents. There's a per-line function that combines the
+highlighting, marking, and
+selection info for that line into a snippet of HTML. The patch updater
+uses this to reset individual lines, the refresh updater builds an
+HTML chunk for the whole visible document at once, and then uses a
+single innerHTML update to do the refresh.
Parsers can be Simple
+ +When I wrote CodeMirror 1, I +thought interruptable +parsers were a hugely scary and complicated thing, and I used a +bunch of heavyweight abstractions to keep this supposed complexity +under control: parsers +were iterators +that consumed input from another iterator, and used funny +closure-resetting tricks to copy and resume themselves.
+ +This made for a rather nice system, in that parsers formed strictly +separate modules, and could be composed in predictable ways. +Unfortunately, it was quite slow (stacking three or four iterators on +top of each other), and extremely intimidating to people not used to a +functional programming style.
+ +With a few small changes, however, we can keep all those +advantages, but simplify the API and make the whole thing less +indirect and inefficient. CodeMirror +2's mode API uses explicit state +objects, and makes the parser/tokenizer a function that simply takes a +state and a character stream abstraction, advances the stream one +token, and returns the way the token should be styled. This state may +be copied, optionally in a mode-defined way, in order to be able to +continue a parse at a given point. Even someone who's never touched a +lambda in his life can understand this approach. Additionally, far +fewer objects are allocated in the course of parsing now.
+ +The biggest speedup comes from the fact that the parsing no longer +has to touch the DOM though. In CodeMirror 1, on an older browser, you +could see the parser work its way through the document, +managing some twenty lines in each 50-millisecond time slice it got. It +was reading its input from the DOM, and updating the DOM as it went +along, which any experienced JavaScript programmer will immediately +spot as a recipe for slowness. In CodeMirror 2, the parser usually +finishes the whole document in a single 100-millisecond time slice—it +manages some 1500 lines during that time on Chrome. All it has to do +is munge strings, so there is no real reason for it to be slow +anymore.
+What Gives?
+ +Given all this, what can you expect from CodeMirror 2?
+ +-
+
+
- Small. the base library is +some 45k when minified +now, 17k when gzipped. It's smaller than +its own logo. + +
- Lightweight. CodeMirror 2 initializes very +quickly, and does almost no work when it is not focused. This means +you can treat it almost like a textarea, have multiple instances on a +page without trouble. + +
- Huge document support. Since highlighting is +really fast, and no DOM structure is being built for non-visible +content, you don't have to worry about locking up your browser when a +user enters a megabyte-sized document. + +
- Extended API. Some things kept coming up in the +mailing list, such as marking pieces of text or lines, which were +extremely hard to do with CodeMirror 1. The new version has proper +support for these built in. + +
- Tab support. Tabs inside editable documents were, +for some reason, a no-go. At least six different people announced they +were going to add tab support to CodeMirror 1, none survived (I mean, +none delivered a working version). CodeMirror 2 no longer removes tabs +from your document. + +
- Sane styling.
iframenodes aren't +really known for respecting document flow. Now that an editor instance +is a plaindivelement, it is much easier to size it to +fit the surrounding elements. You don't even have to make it scroll if +you do not want to.
+
+
On the downside, a CodeMirror 2 instance is not a native +editable component. Though it does its best to emulate such a +component as much as possible, there is functionality that browsers +just do not allow us to hook into. Doing select-all from the context +menu, for example, is not currently detected by CodeMirror.
+ +[Updates from November 13th 2011] Recently, I've made +some changes to the codebase that cause some of the text above to no +longer be current. I've left the text intact, but added markers at the +passages that are now inaccurate. The new situation is described +below.
+Content Representation
+ +The original implementation of CodeMirror 2 represented the
+document as a flat array of line objects. This worked well—splicing
+arrays will require the part of the array after the splice to be
+moved, but this is basically just a simple memmove of a
+bunch of pointers, so it is cheap even for huge documents.
However, I recently added line wrapping and code folding (line +collapsing, basically). Once lines start taking up a non-constant +amount of vertical space, looking up a line by vertical position +(which is needed when someone clicks the document, and to determine +the visible part of the document during scrolling) can only be done +with a linear scan through the whole array, summing up line heights as +you go. Seeing how I've been going out of my way to make big documents +fast, this is not acceptable.
+ +The new representation is based on a B-tree. The leaves of the tree +contain arrays of line objects, with a fixed minimum and maximum size, +and the non-leaf nodes simply hold arrays of child nodes. Each node +stores both the amount of lines that live below them and the vertical +space taken up by these lines. This allows the tree to be indexed both +by line number and by vertical position, and all access has +logarithmic complexity in relation to the document size.
+ +I gave line objects and tree nodes parent pointers, to the node +above them. When a line has to update its height, it can simply walk +these pointers to the top of the tree, adding or subtracting the +difference in height from each node it encounters. The parent pointers +also make it cheaper (in complexity terms, the difference is probably +tiny in normal-sized documents) to find the current line number when +given a line object. In the old approach, the whole document array had +to be searched. Now, we can just walk up the tree and count the sizes +of the nodes coming before us at each level.
+ +I chose B-trees, not regular binary trees, mostly because they +allow for very fast bulk insertions and deletions. When there is a big +change to a document, it typically involves adding, deleting, or +replacing a chunk of subsequent lines. In a regular balanced tree, all +these inserts or deletes would have to be done separately, which could +be really expensive. In a B-tree, to insert a chunk, you just walk +down the tree once to find where it should go, insert them all in one +shot, and then break up the node if needed. This breaking up might +involve breaking up nodes further up, but only requires a single pass +back up the tree. For deletion, I'm somewhat lax in keeping things +balanced—I just collapse nodes into a leaf when their child count goes +below a given number. This means that there are some weird editing +patterns that may result in a seriously unbalanced tree, but even such +an unbalanced tree will perform well, unless you spend a day making +strangely repeating edits to a really big document.
+Keymaps
+ +Above, I claimed that directly catching key +events for things like cursor movement is impractical because it +requires some browser-specific kludges. I then proceeded to explain +some awful hacks that were needed to make it +possible for the selection changes to be detected through the +textarea. In fact, the second hack is about as bad as the first.
+ +On top of that, in the presence of user-configurable tab sizes and +collapsed and wrapped lines, lining up cursor movement in the textarea +with what's visible on the screen becomes a nightmare. Thus, I've +decided to move to a model where the textarea's selection is no longer +depended on.
+ +So I moved to a model where all cursor movement is handled by my +own code. This adds support for a goal column, proper interaction of +cursor movement with collapsed lines, and makes it possible for +vertical movement to move through wrapped lines properly, instead of +just treating them like non-wrapped lines.
+ +The key event handlers now translate the key event into a string,
+something like Ctrl-Home or Shift-Cmd-R, and
+use that string to look up an action to perform. To make keybinding
+customizable, this lookup goes through
+a table, using a scheme that
+allows such tables to be chained together (for example, the default
+Mac bindings fall through to a table named 'emacsy', which defines
+basic Emacs-style bindings like Ctrl-F, and which is also
+used by the custom Emacs bindings).
A new
+option extraKeys
+allows ad-hoc keybindings to be defined in a much nicer way than what
+was possible with the
+old onKeyEvent
+callback. You simply provide an object mapping key identifiers to
+functions, instead of painstakingly looking at raw key events.
Built-in commands map to strings, rather than functions, for
+example "goLineUp" is the default action bound to the up
+arrow key. This allows new keymaps to refer to them without
+duplicating any code. New commands can be defined by assigning to
+the CodeMirror.commands object, which maps such commands
+to functions.
The hidden textarea now only holds the current selection, with no +extra characters around it. This has a nice advantage: polling for +input becomes much, much faster. If there's a big selection, this text +does not have to be read from the textarea every time—when we poll, +just noticing that something is still selected is enough to tell us +that no new text was typed.
+ +The reason that cheap polling is important is that many browsers do
+not fire useful events on IME (input method engine) input, which is
+the thing where people inputting a language like Japanese or Chinese
+use multiple keystrokes to create a character or sequence of
+characters. Most modern browsers fire input when the
+composing is finished, but many don't fire anything when the character
+is updated during composition. So we poll, whenever the
+editor is focused, to provide immediate updates of the display.
+
+
+
+
+CodeMirror
+
+ -
+
- Basic Usage +
- Configuration +
- Events +
- Key maps +
- Commands +
- Customized Styling +
- Programming API + + +
- Addons +
- Writing CodeMirror Modes +
- Vim Mode API
+
-
+
- Configuration +
- Extending VIM +
+
+ User manual and reference guide + version 5.32.0 +
+ +CodeMirror is a code-editor component that can be embedded in + Web pages. The core library provides only the editor + component, no accompanying buttons, auto-completion, or other IDE + functionality. It does provide a rich API on top of which such + functionality can be straightforwardly implemented. See + the addons included in the distribution, + and the list + of externally hosted addons, for reusable + implementations of extra features.
+ +CodeMirror works with language-specific modes. Modes are
+ JavaScript programs that help color (and optionally indent) text
+ written in a given language. The distribution comes with a number
+ of modes (see the mode/
+ directory), and it isn't hard to write new
+ ones for other languages.
Basic Usage
+ +The easiest way to use CodeMirror is to simply load the script
+ and style sheet found under lib/ in the distribution,
+ plus a mode script from one of the mode/ directories.
+ For example:
<script src="lib/codemirror.js"></script> +<link rel="stylesheet" href="lib/codemirror.css"> +<script src="mode/javascript/javascript.js"></script>+ +
(Alternatively, use a module loader. More + about that later.)
+ +Having done this, an editor instance can be created like + this:
+ +var myCodeMirror = CodeMirror(document.body);+ +
The editor will be appended to the document body, will start
+ empty, and will use the mode that we loaded. To have more control
+ over the new editor, a configuration object can be passed
+ to CodeMirror as a second
+ argument:
var myCodeMirror = CodeMirror(document.body, {
+ value: "function myScript(){return 100;}\n",
+ mode: "javascript"
+});
+
+ This will initialize the editor with a piece of code already in + it, and explicitly tell it to use the JavaScript mode (which is + useful when multiple modes are loaded). + See below for a full discussion of the + configuration options that CodeMirror accepts.
+ +In cases where you don't want to append the editor to an
+ element, and need more control over the way it is inserted, the
+ first argument to the CodeMirror function can also
+ be a function that, when given a DOM element, inserts it into the
+ document somewhere. This could be used to, for example, replace a
+ textarea with a real editor:
var myCodeMirror = CodeMirror(function(elt) {
+ myTextArea.parentNode.replaceChild(elt, myTextArea);
+}, {value: myTextArea.value});
+
+ However, for this use case, which is a common way to use + CodeMirror, the library provides a much more powerful + shortcut:
+ +var myCodeMirror = CodeMirror.fromTextArea(myTextArea);+ +
This will, among other things, ensure that the textarea's value + is updated with the editor's contents when the form (if it is part + of a form) is submitted. See the API + reference for a full description of this method.
+ +Module loaders
+ +The files in the CodeMirror distribution contain shims for
+ loading them (and their dependencies) in AMD or CommonJS
+ environments. If the variables exports
+ and module exist and have type object, CommonJS-style
+ require will be used. If not, but there is a
+ function define with an amd property
+ present, AMD-style (RequireJS) will be used.
It is possible to + use Browserify or similar + tools to statically build modules using CodeMirror. Alternatively, + use RequireJS to dynamically + load dependencies at runtime. Both of these approaches have the + advantage that they don't use the global namespace and can, thus, + do things like load multiple versions of CodeMirror alongside each + other.
+ +Here's a simple example of using RequireJS to load CodeMirror:
+ +require([
+ "cm/lib/codemirror", "cm/mode/htmlmixed/htmlmixed"
+], function(CodeMirror) {
+ CodeMirror.fromTextArea(document.getElementById("code"), {
+ lineNumbers: true,
+ mode: "htmlmixed"
+ });
+});
+
+ It will automatically load the modes that the mixed HTML mode
+ depends on (XML, JavaScript, and CSS). Do not use
+ RequireJS' paths option to configure the path to
+ CodeMirror, since it will break loading submodules through
+ relative paths. Use
+ the packages
+ configuration option instead, as in:
require.config({
+ packages: [{
+ name: "codemirror",
+ location: "../path/to/codemirror",
+ main: "lib/codemirror"
+ }]
+});
+
+Configuration
+ +Both the CodeMirror
+ function and its fromTextArea method take as second
+ (optional) argument an object containing configuration options.
+ Any option not supplied like this will be taken
+ from CodeMirror.defaults, an
+ object containing the default options. You can update this object
+ to change the defaults on your page.
Options are not checked in any way, so setting bogus option + values is bound to lead to odd errors.
+ +These are the supported options:
+ +-
+
value: string|CodeMirror.Doc
+ - The starting value of the editor. Can be a string, or + a document object. + +
mode: string|object
+ - The mode to use. When not given, this will default to the
+ first mode that was loaded. It may be a string, which either
+ simply names the mode or is
+ a MIME type
+ associated with the mode. Alternatively, it may be an object
+ containing configuration options for the mode, with
+ a
nameproperty that names the mode (for + example{name: "javascript", json: true}). The demo + pages for each mode contain information about what configuration + parameters the mode supports. You can ask CodeMirror which modes + and MIME types have been defined by inspecting + theCodeMirror.modes+ andCodeMirror.mimeModesobjects. The first maps + mode names to their constructors, and the second maps MIME types + to mode specs.
+
+ lineSeparator: string|null
+ - Explicitly set the line separator for the editor. By default
+ (value
null), the document will be split on CRLFs + as well as lone CRs and LFs, and a single LF will be used as + line separator in all output (such + asgetValue). When a + specific string is given, lines will only be split on that + string, and output will, by default, use that same + separator.
+
+ theme: string
+ - The theme to style the editor with. You must make sure the
+ CSS file defining the corresponding
.cm-s-[name]+ styles is loaded (see + thethemedirectory in the + distribution). The default is"default", for which + colors are included incodemirror.css. It is + possible to use multiple theming classes at once—for + example"foo bar"will assign both + thecm-s-fooand thecm-s-barclasses + to the editor.
+
+ indentUnit: integer
+ - How many spaces a block (whatever that means in the edited + language) should be indented. The default is 2. + +
smartIndent: boolean
+ - Whether to use the context-sensitive indentation that the + mode provides (or just indent the same as the line before). + Defaults to true. + +
tabSize: integer
+ - The width of a tab character. Defaults to 4. + +
indentWithTabs: boolean
+ - Whether, when indenting, the first N*
tabSize+ spaces should be replaced by N tabs. Default is false.
+
+ electricChars: boolean
+ - Configures whether the editor should re-indent the current + line when a character is typed that might change its proper + indentation (only works if the mode supports indentation). + Default is true. + +
specialChars: RegExp
+ - A regular expression used to determine which characters
+ should be replaced by a
+ special placeholder.
+ Mostly useful for non-printing special characters. The default
+ is
/[\u0000-\u001f\u007f-\u009f\u00ad\u061c\u200b-\u200f\u2028\u2029\ufeff]/.
+ specialCharPlaceholder: function(char) → Element
+ - A function that, given a special character identified by
+ the
specialChars+ option, produces a DOM node that is used to represent the + character. By default, a red dot (•) + is shown, with a title tooltip to indicate the character code.
+
+ rtlMoveVisually: boolean
+ - Determines whether horizontal cursor movement through
+ right-to-left (Arabic, Hebrew) text is visual (pressing the left
+ arrow moves the cursor left) or logical (pressing the left arrow
+ moves to the next lower index in the string, which is visually
+ right in right-to-left text). The default is
false+ on Windows, andtrueon other platforms.
+
+ keyMap: string
+ - Configures the key map to use. The default
+ is
"default", which is the only key map defined + incodemirror.jsitself. Extra key maps are found in + thekey mapdirectory. See + the section on key maps for more + information.
+
+ extraKeys: object
+ - Can be used to specify extra key bindings for the editor,
+ alongside the ones defined
+ by
keyMap. Should be + either null, or a valid key map value.
+
+ configureMouse: fn(cm: CodeMirror, repeat: "single" | "double" | "triple", event: Event) → Object
+ - Allows you to configure the behavior of mouse selection and
+ dragging. The function is called when the left mouse button is
+ pressed. The returned object may have the following properties:
+
-
+
unit: "char" | "word" | "line" | "rectangle" | fn(CodeMirror, Pos) → {from: Pos, to: Pos}
+ - The unit by which to select. May be one of the built-in + units, or a function that takes a position and returns a + range around that, for a custom unit. +
extend: bool
+ - Whether to extend the existing selection range or start a new one. +
addNew: bool
+ - When enabled, this adds a new range to the existing selection, rather than replacing it. +
moveOnDrag: bool
+ - When the mouse even drags content around inside the + editor, this controls whether it is copied (false) or moved + (true). +
+
+ lineWrapping: boolean
+ - Whether CodeMirror should scroll or wrap for long lines.
+ Defaults to
false(scroll).
+
+ lineNumbers: boolean
+ - Whether to show line numbers to the left of the editor. + +
firstLineNumber: integer
+ - At which number to start counting lines. Default is 1. + +
lineNumberFormatter: function(line: integer) → string
+ - A function used to format line numbers. The function is + passed the line number, and should return a string that will be + shown in the gutter. + +
gutters: array<string>
+ - Can be used to add extra gutters (beyond or instead of the
+ line number gutter). Should be an array of CSS class names, each
+ of which defines a
width(and optionally a + background), and which will be used to draw the background of + the gutters. May include + theCodeMirror-linenumbersclass, in order to + explicitly set the position of the line number gutter (it will + default to be to the right of all other gutters). These class + names are the keys passed + tosetGutterMarker.
+
+ fixedGutter: boolean
+ - Determines whether the gutter scrolls along with the content + horizontally (false) or whether it stays fixed during horizontal + scrolling (true, the default). + +
scrollbarStyle: string
+ - Chooses a scrollbar implementation. The default
+ is
"native", showing native scrollbars. The core + library also provides the"null"style, which + completely hides the + scrollbars. Addons can + implement additional scrollbar models.
+
+ coverGutterNextToScrollbar: boolean
+ - When
fixedGutter+ is on, and there is a horizontal scrollbar, by default the + gutter will be visible to the left of this scrollbar. If this + option is set to true, it will be covered by an element with + classCodeMirror-gutter-filler.
+
+ inputStyle: string
+ - Selects the way CodeMirror handles input and focus. The core
+ library defines the
"textarea"+ and"contenteditable"input models. On mobile + browsers, the default is"contenteditable". On + desktop browsers, the default is"textarea". + Support for IME and screen readers is better in + the"contenteditable"model. The intention is to + make it the default on modern desktop browsers in the + future.
+
+ readOnly: boolean|string
+ - This disables editing of the editor content by the user. If
+ the special value
"nocursor"is given (instead of + simplytrue), focusing of the editor is also + disallowed.
+
+ showCursorWhenSelecting: boolean
+ - Whether the cursor should be drawn when a selection is + active. Defaults to false. + +
lineWiseCopyCut: boolean
+ - When enabled, which is the default, doing copy or cut when + there is no selection will copy or cut the whole lines that have + cursors on them. + +
pasteLinesPerSelection: boolean
+ - When pasting something from an external source (not from the
+ editor itself), if the number of lines matches the number of
+ selection, CodeMirror will by default insert one line per
+ selection. You can set this to
falseto disable + that behavior.
+
+ undoDepth: integer
+ - The maximum number of undo levels that the editor stores. + Note that this includes selection change events. Defaults to + 200. + +
historyEventDelay: integer
+ - The period of inactivity (in milliseconds) that will cause a + new history event to be started when typing or deleting. + Defaults to 1250. + +
tabindex: integer
+ - The tab + index to assign to the editor. If not given, no tab index + will be assigned. + +
autofocus: boolean
+ - Can be used to make CodeMirror focus itself on
+ initialization. Defaults to off.
+ When
fromTextAreais + used, and no explicit value is given for this option, it will be + set to true when either the source textarea is focused, or it + has anautofocusattribute and no other element is + focused.
+
Below this a few more specialized, low-level options are + listed. These are only useful in very specific situations, you + might want to skip them the first time you read this manual.
+ +-
+
dragDrop: boolean
+ - Controls whether drag-and-drop is enabled. On by default. + +
allowDropFileTypes: array<string>
+ - When set (default is
null) only files whose + type is in the array can be dropped into the editor. The strings + should be MIME types, and will be checked against + thetype+ of theFileobject as reported by the browser.
+
+ cursorBlinkRate: number
+ - Half-period in milliseconds used for cursor blinking. The default blink + rate is 530ms. By setting this to zero, blinking can be disabled. A + negative value hides the cursor entirely. + +
cursorScrollMargin: number
+ - How much extra space to always keep above and below the + cursor when approaching the top or bottom of the visible view in + a scrollable document. Default is 0. + +
cursorHeight: number
+ - Determines the height of the cursor. Default is 1, meaning
+ it spans the whole height of the line. For some fonts (and by
+ some tastes) a smaller height (for example
0.85), + which causes the cursor to not reach all the way to the bottom + of the line, looks better
+
+ resetSelectionOnContextMenu: boolean
+ - Controls whether, when the context menu is opened with a
+ click outside of the current selection, the cursor is moved to
+ the point of the click. Defaults to
true.
+
+ workTime, workDelay: number
+ - Highlighting is done by a pseudo background-thread that will
+ work for
workTimemilliseconds, and then use + timeout to sleep forworkDelaymilliseconds. The + defaults are 200 and 300, you can change these options to make + the highlighting more or less aggressive.
+
+ pollInterval: number
+ - Indicates how quickly CodeMirror should poll its input + textarea for changes (when focused). Most input is captured by + events, but some things, like IME input on some browsers, don't + generate events that allow CodeMirror to properly detect it. + Thus, it polls. Default is 100 milliseconds. + +
flattenSpans: boolean
+ - By default, CodeMirror will combine adjacent tokens into a + single span if they have the same class. This will result in a + simpler DOM tree, and thus perform better. With some kinds of + styling (such as rounded corners), this will change the way the + document looks. You can set this option to false to disable this + behavior. + +
addModeClass: boolean
+ - When enabled (off by default), an extra CSS class will be
+ added to each token, indicating the
+ (inner) mode that produced it, prefixed
+ with
"cm-m-". For example, tokens from the XML mode + will get thecm-m-xmlclass.
+
+ maxHighlightLength: number
+ - When highlighting long lines, in order to stay responsive,
+ the editor will give up and simply style the rest of the line as
+ plain text when it reaches a certain position. The default is
+ 10 000. You can set this to
Infinityto turn off + this behavior.
+
+ viewportMargin: integer
+ - Specifies the amount of lines that are rendered above and
+ below the part of the document that's currently scrolled into
+ view. This affects the amount of updates needed when scrolling,
+ and the amount of work that such an update does. You should
+ usually leave it at its default, 10. Can be set
+ to
Infinityto make sure the whole document is + always rendered, and thus the browser's text search works on it. + This will have bad effects on performance of big + documents.
+
Events
+ +Various CodeMirror-related objects emit events, which allow
+ client code to react to various situations. Handlers for such
+ events can be registered with the on
+ and off methods on the objects
+ that the event fires on. To fire your own events,
+ use CodeMirror.signal(target, name, args...),
+ where target is a non-DOM-node object.
An editor instance fires the following events.
+ The instance argument always refers to the editor
+ itself.
-
+
"change" (instance: CodeMirror, changeObj: object)
+ - Fires every time the content of the editor is changed.
+ The
changeObjis a{from, to, text, removed, + origin}object containing information about the changes + that occurred as second argument.from+ andtoare the positions (in the pre-change + coordinate system) where the change started and ended (for + example, it might be{ch:0, line:18}if the + position is at the beginning of line #19).textis + an array of strings representing the text that replaced the + changed range (split by line).removedis the text + that used to be betweenfromandto, + which is overwritten by this change. This event is + fired before the end of + an operation, before the DOM updates + happen.
+
+ "changes" (instance: CodeMirror, changes: array<object>)
+ - Like the
"change"+ event, but batched per operation, + passing an array containing all the changes that happened in the + operation. This event is fired after the operation finished, and + display changes it makes will trigger a new operation.
+
+ "beforeChange" (instance: CodeMirror, changeObj: object)
+ - This event is fired before a change is applied, and its
+ handler may choose to modify or cancel the change.
+ The
changeObjobject + hasfrom,to, andtext+ properties, as with + the"change"event. It + also has acancel()method, which can be called to + cancel the change, and, if the change isn't + coming from an undo or redo event, anupdate(from, to, + text)method, which may be used to modify the change. + Undo or redo changes can't be modified, because they hold some + metainformation for restoring old marked ranges that is only + valid for that specific change. All three arguments + toupdateare optional, and can be left off to + leave the existing value for that field + intact. Note: you may not do anything from + a"beforeChange"handler that would cause changes + to the document or its visualization. Doing so will, since this + handler is called directly from the bowels of the CodeMirror + implementation, probably cause the editor to become + corrupted.
+
+ "cursorActivity" (instance: CodeMirror)
+ - Will be fired when the cursor or selection moves, or any + change is made to the editor content. + +
"keyHandled" (instance: CodeMirror, name: string, event: Event)
+ - Fired after a key is handled through a
+ key map.
nameis the name of the handled key (for + example"Ctrl-X"or"'q'"), + andeventis the DOMkeydown+ orkeypressevent.
+
+ "inputRead" (instance: CodeMirror, changeObj: object)
+ - Fired whenever new input is read from the hidden textarea + (typed or pasted by the user). + +
"electricInput" (instance: CodeMirror, line: integer)
+ - Fired if text input matched the + mode's electric patterns, + and this caused the line's indentation to change. + +
"beforeSelectionChange" (instance: CodeMirror, obj: {ranges, origin, update})
+ - This event is fired before the selection is moved. Its
+ handler may inspect the set of selection ranges, present as an
+ array of
{anchor, head}objects in + therangesproperty of theobj+ argument, and optionally change them by calling + theupdatemethod on this object, passing an array + of ranges in the same format. The object also contains + anoriginproperty holding the origin string passed + to the selection-changing method, if any. Handlers for this + event have the same restriction + as"beforeChange"+ handlers — they should not do anything to directly update the + state of the editor.
+
+ "viewportChange" (instance: CodeMirror, from: number, to: number)
+ - Fires whenever the view port of
+ the editor changes (due to scrolling, editing, or any other
+ factor). The
fromandtoarguments + give the new start and end of the viewport.
+
+ "swapDoc" (instance: CodeMirror, oldDoc: Doc)
+ - This is signalled when the editor's document is replaced
+ using the
swapDoc+ method.
+
+ "gutterClick" (instance: CodeMirror, line: integer, gutter: string, clickEvent: Event)
+ - Fires when the editor gutter (the line-number area) is
+ clicked. Will pass the editor instance as first argument, the
+ (zero-based) number of the line that was clicked as second
+ argument, the CSS class of the gutter that was clicked as third
+ argument, and the raw
mousedownevent object as + fourth argument.
+
+ "gutterContextMenu" (instance: CodeMirror, line: integer, gutter: string, contextMenu: Event: Event)
+ - Fires when the editor gutter (the line-number area)
+ receives a
contextmenuevent. Will pass the editor + instance as first argument, the (zero-based) number of the line + that was clicked as second argument, the CSS class of the + gutter that was clicked as third argument, and the raw +contextmenumouse event object as fourth argument. + You canpreventDefaultthe event, to signal that + CodeMirror should do no further handling.
+
+ "focus" (instance: CodeMirror, event: Event)
+ - Fires whenever the editor is focused. + +
"blur" (instance: CodeMirror, event: Event)
+ - Fires whenever the editor is unfocused. + +
"scroll" (instance: CodeMirror)
+ - Fires when the editor is scrolled. + +
"refresh" (instance: CodeMirror)
+ - Fires when the editor is refreshed + or resized. Mostly useful to invalidate + cached values that depend on the editor or character size. + +
"optionChange" (instance: CodeMirror, option: string)
+ - Dispatched every time an option is changed with
setOption.
+
+ "scrollCursorIntoView" (instance: CodeMirror, event: Event)
+ - Fires when the editor tries to scroll its cursor into view.
+ Can be hooked into to take care of additional scrollable
+ containers around the editor. When the event object has
+ its
preventDefaultmethod called, CodeMirror will + not itself try to scroll the window.
+
+ "update" (instance: CodeMirror)
+ - Will be fired whenever CodeMirror updates its DOM display. + +
"renderLine" (instance: CodeMirror, line: LineHandle, element: Element)
+ - Fired whenever a line is (re-)rendered to the DOM. Fired + right after the DOM element is built, before it is + added to the document. The handler may mess with the style of + the resulting element, or add event handlers, but + should not try to change the state of the editor. + +
"mousedown", + "dblclick", "touchstart", "contextmenu", + "keydown", "keypress", + "keyup", "cut", "copy", "paste", + "dragstart", "dragenter", + "dragover", "dragleave", + "drop" + (instance: CodeMirror, event: Event)
+ - Fired when CodeMirror is handling a DOM event of this type.
+ You can
preventDefaultthe event, or give it a + truthycodemirrorIgnoreproperty, to signal that + CodeMirror should do no further handling.
+
Document objects (instances
+ of CodeMirror.Doc) emit the
+ following events:
-
+
"change" (doc: CodeMirror.Doc, changeObj: object)
+ - Fired whenever a change occurs to the
+ document.
changeObjhas a similar type as the + object passed to the + editor's"change"+ event.
+
+ "beforeChange" (doc: CodeMirror.Doc, change: object)
+ - See the description of the + same event on editor instances. + +
"cursorActivity" (doc: CodeMirror.Doc)
+ - Fired whenever the cursor or selection in this document + changes. + +
"beforeSelectionChange" (doc: CodeMirror.Doc, selection: {head, anchor})
+ - Equivalent to + the event by the same + name as fired on editor instances. +
Line handles (as returned by, for
+ example, getLineHandle)
+ support these events:
-
+
"delete" ()
+ - Will be fired when the line object is deleted. A line object + is associated with the start of the line. Mostly useful + when you need to find out when your gutter + markers on a given line are removed. +
"change" (line: LineHandle, changeObj: object)
+ - Fires when the line's text content is changed in any way
+ (but the line is not deleted outright). The
change+ object is similar to the one passed + to change event on the editor + object.
+
Marked range handles (CodeMirror.TextMarker), as returned
+ by markText
+ and setBookmark, emit the
+ following events:
-
+
"beforeCursorEnter" ()
+ - Fired when the cursor enters the marked range. From this + event handler, the editor state may be inspected + but not modified, with the exception that the range on + which the event fires may be cleared. +
"clear" (from: {line, ch}, to: {line, ch})
+ - Fired when the range is cleared, either through cursor
+ movement in combination
+ with
clearOnEnter+ or through a call to itsclear()method. Will only + be fired once per handle. Note that deleting the range through + text editing does not fire this event, because an undo action + might bring the range back into existence.from+ andtogive the part of the document that the range + spanned when it was cleared.
+ "hide" ()
+ - Fired when the last part of the marker is removed from the + document by editing operations. +
"unhide" ()
+ - Fired when, after the marker was removed by editing, a undo + operation brought the marker back. +
Line widgets (CodeMirror.LineWidget), returned
+ by addLineWidget, fire
+ these events:
-
+
"redraw" ()
+ - Fired whenever the editor re-adds the widget to the DOM. + This will happen once right after the widget is added (if it is + scrolled into view), and then again whenever it is scrolled out + of view and back in again, or when changes to the editor options + or the line the widget is on require the widget to be + redrawn. +
Key Maps
+ +Key maps are ways to associate keys and mouse buttons with + functionality. A key map is an object mapping strings that + identify the buttons to functions that implement their + functionality.
+ +The CodeMirror distributions comes + with Emacs, Vim, + and Sublime Text-style keymaps.
+ +Keys are identified either by name or by character.
+ The CodeMirror.keyNames object defines names for
+ common keys and associates them with their key codes. Examples of
+ names defined here are Enter, F5,
+ and Q. These can be prefixed
+ with Shift-, Cmd-, Ctrl-,
+ and Alt- to specify a modifier. So for
+ example, Shift-Ctrl-Space would be a valid key
+ identifier.
Common example: map the Tab key to insert spaces instead of a tab + character.
+ +
+editor.setOption("extraKeys", {
+ Tab: function(cm) {
+ var spaces = Array(cm.getOption("indentUnit") + 1).join(" ");
+ cm.replaceSelection(spaces);
+ }
+});
+
+ Alternatively, a character can be specified directly by
+ surrounding it in single quotes, for example '$'
+ or 'q'. Due to limitations in the way browsers fire
+ key events, these may not be prefixed with modifiers.
To bind mouse buttons, use the names `LeftClick`, + `MiddleClick`, and `RightClick`. These can also be prefixed with + modifiers, and in addition, the word `Double` or `Triple` can be + put before `Click` (as in `LeftDoubleClick`) to bind a double- or + triple-click. The function for such a binding is passed the + position that was clicked as second argument.
+ +Multi-stroke key bindings can be specified
+ by separating the key names by spaces in the property name, for
+ example Ctrl-X Ctrl-V. When a map contains
+ multi-stoke bindings or keys with modifiers that are not specified
+ in the default order (Shift-Cmd-Ctrl-Alt), you must
+ call CodeMirror.normalizeKeyMap on it before it can
+ be used. This function takes a keymap and modifies it to normalize
+ modifier order and properly recognize multi-stroke bindings. It
+ will return the keymap itself.
The CodeMirror.keyMap object associates key maps
+ with names. User code and key map definitions can assign extra
+ properties to this object. Anywhere where a key map is expected, a
+ string can be given, which will be looked up in this object. It
+ also contains the "default" key map holding the
+ default bindings.
The values of properties in key maps can be either functions of
+ a single argument (the CodeMirror instance), strings, or
+ false. Strings refer
+ to commands, which are described below. If
+ the property is set to false, CodeMirror leaves
+ handling of the key up to the browser. A key handler function may
+ return CodeMirror.Pass to indicate that it has
+ decided not to handle the key, and other handlers (or the default
+ behavior) should be given a turn.
Keys mapped to command names that start with the
+ characters "go" or to functions that have a
+ truthy motion property (which should be used for
+ cursor-movement actions) will be fired even when an
+ extra Shift modifier is present (i.e. "Up":
+ "goLineUp" matches both up and shift-up). This is used to
+ easily implement shift-selection.
Key maps can defer to each other by defining
+ a fallthrough property. This indicates that when a
+ key is not found in the map itself, one or more other maps should
+ be searched. It can hold either a single key map or an array of
+ key maps.
When a key map needs to set something up when it becomes
+ active, or tear something down when deactivated, it can
+ contain attach and/or detach properties,
+ which should hold functions that take the editor instance and the
+ next or previous keymap. Note that this only works for the
+ top-level keymap, not for fallthrough
+ maps or maps added
+ with extraKeys
+ or addKeyMap.
Commands
+ +Commands are parameter-less actions that can be performed on an
+ editor. Their main use is for key bindings. Commands are defined by
+ adding properties to the CodeMirror.commands object.
+ A number of common commands are defined by the library itself,
+ most of them used by the default key bindings. The value of a
+ command property must be a function of one argument (an editor
+ instance).
Some of the commands below are referenced in the default + key map, but not defined by the core library. These are intended to + be defined by user code or addons.
+ +Commands can also be run with
+ the execCommand
+ method.
-
+
selectAllCtrl-A (PC), Cmd-A (Mac)
+ - Select the whole content of the editor. + +
singleSelectionEsc
+ - When multiple selections are present, this deselects all but + the primary selection. + +
killLineCtrl-K (Mac)
+ - Emacs-style line killing. Deletes the part of the line after + the cursor. If that consists only of whitespace, the newline at + the end of the line is also deleted. + +
deleteLineCtrl-D (PC), Cmd-D (Mac)
+ - Deletes the whole line under the cursor, including newline at the end. + +
delLineLeft
+ - Delete the part of the line before the cursor. + +
delWrappedLineLeftCmd-Backspace (Mac)
+ - Delete the part of the line from the left side of the visual line the cursor is on to the cursor. + +
delWrappedLineRightCmd-Delete (Mac)
+ - Delete the part of the line from the cursor to the right side of the visual line the cursor is on. + +
undoCtrl-Z (PC), Cmd-Z (Mac)
+ - Undo the last change. Note that, because browsers still + don't make it possible for scripts to react to or customize the + context menu, selecting undo (or redo) from the context menu in + a CodeMirror instance does not work. + +
redoCtrl-Y (PC), Shift-Cmd-Z (Mac), Cmd-Y (Mac)
+ - Redo the last undone change. + +
undoSelectionCtrl-U (PC), Cmd-U (Mac)
+ - Undo the last change to the selection, or if there are no + selection-only changes at the top of the history, undo the last + change. + +
redoSelectionAlt-U (PC), Shift-Cmd-U (Mac)
+ - Redo the last change to the selection, or the last text change if + no selection changes remain. + +
goDocStartCtrl-Home (PC), Cmd-Up (Mac), Cmd-Home (Mac)
+ - Move the cursor to the start of the document. + +
goDocEndCtrl-End (PC), Cmd-End (Mac), Cmd-Down (Mac)
+ - Move the cursor to the end of the document. + +
goLineStartAlt-Left (PC), Ctrl-A (Mac)
+ - Move the cursor to the start of the line. + +
goLineStartSmartHome
+ - Move to the start of the text on the line, or if we are + already there, to the actual start of the line (including + whitespace). + +
goLineEndAlt-Right (PC), Ctrl-E (Mac)
+ - Move the cursor to the end of the line. + +
goLineRightCmd-Right (Mac)
+ - Move the cursor to the right side of the visual line it is on. + +
goLineLeftCmd-Left (Mac)
+ - Move the cursor to the left side of the visual line it is on. If + this line is wrapped, that may not be the start of the line. + +
goLineLeftSmart
+ - Move the cursor to the left side of the visual line it is
+ on. If that takes it to the start of the line, behave
+ like
goLineStartSmart.
+
+ goLineUpUp, Ctrl-P (Mac)
+ - Move the cursor up one line. + +
goLineDownDown, Ctrl-N (Mac)
+ - Move down one line. + +
goPageUpPageUp, Shift-Ctrl-V (Mac)
+ - Move the cursor up one screen, and scroll up by the same distance. + +
goPageDownPageDown, Ctrl-V (Mac)
+ - Move the cursor down one screen, and scroll down by the same distance. + +
goCharLeftLeft, Ctrl-B (Mac)
+ - Move the cursor one character left, going to the previous line + when hitting the start of line. + +
goCharRightRight, Ctrl-F (Mac)
+ - Move the cursor one character right, going to the next line + when hitting the end of line. + +
goColumnLeft
+ - Move the cursor one character left, but don't cross line boundaries. + +
goColumnRight
+ - Move the cursor one character right, don't cross line boundaries. + +
goWordLeftAlt-B (Mac)
+ - Move the cursor to the start of the previous word. + +
goWordRightAlt-F (Mac)
+ - Move the cursor to the end of the next word. + +
goGroupLeftCtrl-Left (PC), Alt-Left (Mac)
+ - Move to the left of the group before the cursor. A group is + a stretch of word characters, a stretch of punctuation + characters, a newline, or a stretch of more than one + whitespace character. + +
goGroupRightCtrl-Right (PC), Alt-Right (Mac)
+ - Move to the right of the group after the cursor + (see above). + +
delCharBeforeShift-Backspace, Ctrl-H (Mac)
+ - Delete the character before the cursor. + +
delCharAfterDelete, Ctrl-D (Mac)
+ - Delete the character after the cursor. + +
delWordBeforeAlt-Backspace (Mac)
+ - Delete up to the start of the word before the cursor. + +
delWordAfterAlt-D (Mac)
+ - Delete up to the end of the word after the cursor. + +
delGroupBeforeCtrl-Backspace (PC), Alt-Backspace (Mac)
+ - Delete to the left of the group before the cursor. + +
delGroupAfterCtrl-Delete (PC), Ctrl-Alt-Backspace (Mac), Alt-Delete (Mac)
+ - Delete to the start of the group after the cursor. + +
indentAutoShift-Tab
+ - Auto-indent the current line or selection. + +
indentMoreCtrl-] (PC), Cmd-] (Mac)
+ - Indent the current line or selection by one indent unit. + +
indentLessCtrl-[ (PC), Cmd-[ (Mac)
+ - Dedent the current line or selection by one indent unit. + +
insertTab
+ - Insert a tab character at the cursor. + +
insertSoftTab
+ - Insert the amount of spaces that match the width a tab at + the cursor position would have. + +
defaultTabTab
+ - If something is selected, indent it by + one indent unit. If nothing is + selected, insert a tab character. + +
transposeCharsCtrl-T (Mac)
+ - Swap the characters before and after the cursor. + +
newlineAndIndentEnter
+ - Insert a newline and auto-indent the new line. + +
toggleOverwriteInsert
+ - Flip the overwrite flag. + +
saveCtrl-S (PC), Cmd-S (Mac)
+ - Not defined by the core library, only referred to in + key maps. Intended to provide an easy way for user code to define + a save command. + +
findCtrl-F (PC), Cmd-F (Mac)
+ findNextCtrl-G (PC), Cmd-G (Mac)
+ findPrevShift-Ctrl-G (PC), Shift-Cmd-G (Mac)
+ replaceShift-Ctrl-F (PC), Cmd-Alt-F (Mac)
+ replaceAllShift-Ctrl-R (PC), Shift-Cmd-Alt-F (Mac)
+ - Not defined by the core library, but defined in + the search addon (or custom client + addons). + +
Customized Styling
+ +Up to a certain extent, CodeMirror's look can be changed by
+ modifying style sheet files. The style sheets supplied by modes
+ simply provide the colors for that mode, and can be adapted in a
+ very straightforward way. To style the editor itself, it is
+ possible to alter or override the styles defined
+ in codemirror.css.
Some care must be taken there, since a lot of the rules in this + file are necessary to have CodeMirror function properly. Adjusting + colors should be safe, of course, and with some care a lot of + other things can be changed as well. The CSS classes defined in + this file serve the following roles:
+ +-
+
CodeMirror
+ - The outer element of the editor. This should be used for the
+ editor width, height, borders and positioning. Can also be used
+ to set styles that should hold for everything inside the editor
+ (such as font and font size), or to set a background. Setting
+ this class'
heightstyle toautowill + make the editor resize to fit its + content (it is recommended to also set + theviewportMargin+ option toInfinitywhen doing this.
+
+ CodeMirror-focused
+ - Whenever the editor is focused, the top element gets this + class. This is used to hide the cursor and give the selection a + different color when the editor is not focused. + +
CodeMirror-gutters
+ - This is the backdrop for all gutters. Use it to set the + default gutter background color, and optionally add a border on + the right of the gutters. + +
CodeMirror-linenumbers
+ - Use this for giving a background or width to the line number + gutter. + +
CodeMirror-linenumber
+ - Used to style the actual individual line numbers. These
+ won't be children of the
CodeMirror-linenumbers+ (plural) element, but rather will be absolutely positioned to + overlay it. Use this to set alignment and text properties for + the line numbers.
+
+ CodeMirror-lines
+ - The visible lines. This is where you specify vertical + padding for the editor content. + +
CodeMirror-cursor
+ - The cursor is a block element that is absolutely positioned. + You can make it look whichever way you want. + +
CodeMirror-selected
+ - The selection is represented by
spanelements + with this class.
+
+ CodeMirror-matchingbracket, +CodeMirror-nonmatchingbracket
+ - These are used to style matched (or unmatched) brackets. +
If your page's style sheets do funky things to
+ all div or pre elements (you probably
+ shouldn't do that), you'll have to define rules to cancel these
+ effects out again for elements under the CodeMirror
+ class.
Themes are also simply CSS files, which define colors for
+ various syntactic elements. See the files in
+ the theme directory.
Programming API
+ +A lot of CodeMirror features are only available through its + API. Thus, you need to write code (or + use addons) if you want to expose them to + your users.
+ +Whenever points in the document are represented, the API uses
+ objects with line and ch properties.
+ Both are zero-based. CodeMirror makes sure to 'clip' any positions
+ passed by client code so that they fit inside the document, so you
+ shouldn't worry too much about sanitizing your coordinates. If you
+ give ch a value of null, or don't
+ specify it, it will be replaced with the length of the specified
+ line. Such positions may also have a sticky property
+ holding "before" or "after", whether the
+ position is associated with the character before or after it. This
+ influences, for example, where the cursor is drawn on a
+ line-break or bidi-direction boundary.
Methods prefixed with doc. can, unless otherwise
+ specified, be called both on CodeMirror (editor)
+ instances and CodeMirror.Doc instances. Methods
+ prefixed with cm. are only available
+ on CodeMirror instances.
Constructor
+ +Constructing an editor instance is done with
+ the CodeMirror(place: Element|fn(Element),
+ ?option: object) constructor. If the place
+ argument is a DOM element, the editor will be appended to it. If
+ it is a function, it will be called, and is expected to place the
+ editor into the document. options may be an element
+ mapping option names to values. The options
+ that it doesn't explicitly specify (or all options, if it is not
+ passed) will be taken
+ from CodeMirror.defaults.
Note that the options object passed to the constructor will be + mutated when the instance's options + are changed, so you shouldn't share such + objects between instances.
+ +See CodeMirror.fromTextArea
+ for another way to construct an editor instance.
Content manipulation methods
+ +-
+
doc.getValue(?separator: string) → string
+ - Get the current editor content. You can pass it an optional
+ argument to specify the string to be used to separate lines
+ (defaults to
"\n").
+ doc.setValue(content: string)
+ - Set the editor content. + +
doc.getRange(from: {line, ch}, to: {line, ch}, ?separator: string) → string
+ - Get the text between the given points in the editor, which
+ should be
{line, ch}objects. An optional third + argument can be given to indicate the line separator string to + use (defaults to"\n").
+ doc.replaceRange(replacement: string, from: {line, ch}, to: {line, ch}, ?origin: string)
+ - Replace the part of the document between
from+ andtowith the given string.from+ andtomust be{line, ch}+ objects.tocan be left off to simply insert the + string at positionfrom. Whenorigin+ is given, it will be passed on + to"change"events, and + its first letter will be used to determine whether this change + can be merged with previous history events, in the way described + for selection origins.
+
+ doc.getLine(n: integer) → string
+ - Get the content of line
n.
+
+ doc.lineCount() → integer
+ - Get the number of lines in the editor. +
doc.firstLine() → integer
+ - Get the first line of the editor. This will + usually be zero but for linked sub-views, + or documents instantiated with a non-zero + first line, it might return other values. +
doc.lastLine() → integer
+ - Get the last line of the editor. This will
+ usually be
doc.lineCount() - 1, + but for linked sub-views, + it might return other values.
+
+ doc.getLineHandle(num: integer) → LineHandle
+ - Fetches the line handle for the given line number. +
doc.getLineNumber(handle: LineHandle) → integer
+ - Given a line handle, returns the current position of that
+ line (or
nullwhen it is no longer in the + document).
+ doc.eachLine(f: (line: LineHandle))
+ doc.eachLine(start: integer, end: integer, f: (line: LineHandle))
+ - Iterate over the whole document, or if
start+ andendline numbers are given, the range + fromstartup to (not including)end, + and callffor each line, passing the line handle. + This is a faster way to visit a range of line handlers than + callinggetLineHandle+ for each of them. Note that line handles have + atextproperty containing the line's content (as a + string).
+
+ doc.markClean()
+ - Set the editor content as 'clean', a flag that it will
+ retain until it is edited, and which will be set again when such
+ an edit is undone again. Useful to track whether the content
+ needs to be saved. This function is deprecated in favor
+ of
changeGeneration, + which allows multiple subsystems to track different notions of + cleanness without interfering.
+ doc.changeGeneration(?closeEvent: boolean) → integer
+ - Returns a number that can later be passed
+ to
isCleanto test whether + any edits were made (and not undone) in the meantime. + IfcloseEventis true, the current history event + will be ‘closed’, meaning it can't be combined with further + changes (rapid typing or deleting events are typically + combined).
+ doc.isClean(?generation: integer) → boolean
+ - Returns whether the document is currently clean — not
+ modified since initialization or the last call
+ to
markCleanif no + argument is passed, or since the matching call + tochangeGeneration+ if a generation value is given.
+
Cursor and selection methods
+ +-
+
doc.getSelection(?lineSep: string) → string
+ - Get the currently selected code. Optionally pass a line
+ separator to put between the lines in the output. When multiple
+ selections are present, they are concatenated with instances
+ of
lineSepin between.
+ doc.getSelections(?lineSep: string) → array<string>
+ - Returns an array containing a string for each selection, + representing the content of the selections. + +
doc.replaceSelection(replacement: string, ?select: string)
+ - Replace the selection(s) with the given string. By default,
+ the new selection ends up after the inserted text. The
+ optional
selectargument can be used to change + this—passing"around"will cause the new text to be + selected, passing"start"will collapse the + selection to the start of the inserted text.
+ doc.replaceSelections(replacements: array<string>, ?select: string)
+ - The length of the given array should be the same as the
+ number of active selections. Replaces the content of the
+ selections with the strings in the array.
+ The
selectargument works the same as + inreplaceSelection.
+
+ doc.getCursor(?start: string) → {line, ch}
+ - Retrieve one end of the primary
+ selection.
startis an optional string indicating + which end of the selection to return. It may + be"from","to","head"+ (the side of the selection that moves when you press + shift+arrow), or"anchor"(the fixed side of the + selection). Omitting the argument is the same as + passing"head". A{line, ch}object + will be returned.
+ doc.listSelections() → array<{anchor, head}>
+ - Retrieves a list of all current selections. These will
+ always be sorted, and never overlap (overlapping selections are
+ merged). Each object in the array contains
anchor+ andheadproperties referring to{line, + ch}objects.
+
+ doc.somethingSelected() → boolean
+ - Return true if any text is selected. +
doc.setCursor(pos: {line, ch}|number, ?ch: number, ?options: object)
+ - Set the cursor position. You can either pass a
+ single
{line, ch}object, or the line and the + character as two separate parameters. Will replace all + selections with a single, empty selection at the given position. + The supported options are the same as forsetSelection.
+
+ doc.setSelection(anchor: {line, ch}, ?head: {line, ch}, ?options: object)
+ - Set a single selection range.
anchor+ andheadshould be{line, ch}+ objects.headdefaults toanchorwhen + not given. These options are supported: +-
+
scroll: boolean
+ - Determines whether the selection head should be scrolled + into view. Defaults to true. +
origin: string
+ - Determines whether the selection history event may be
+ merged with the previous one. When an origin starts with the
+ character
+, and the last recorded selection had + the same origin and was similar (close + in time, both + collapsed or both non-collapsed), the new one will replace the + old one. When it starts with*, it will always + replace the previous event (if that had the same origin). + Built-in motion uses the"+move"origin. User input uses the"+input"origin.
+ bias: number
+ - Determine the direction into which the selection endpoints + should be adjusted when they fall inside + an atomic range. Can be either -1 + (backward) or 1 (forward). When not given, the bias will be + based on the relative position of the old selection—the editor + will try to move further away from that, to prevent getting + stuck. +
+
+ doc.setSelections(ranges: array<{anchor, head}>, ?primary: integer, ?options: object)
+ - Sets a new set of selections. There must be at least one
+ selection in the given array. When
primaryis a + number, it determines which selection is the primary one. When + it is not given, the primary index is taken from the previous + selection, or set to the last range if the previous selection + had less ranges than the new one. Supports the same options + assetSelection.
+ doc.addSelection(anchor: {line, ch}, ?head: {line, ch})
+ - Adds a new selection to the existing set of selections, and + makes it the primary selection. + +
doc.extendSelection(from: {line, ch}, ?to: {line, ch}, ?options: object)
+ - Similar
+ to
setSelection, but + will, if shift is held or + the extending flag is set, move the + head of the selection while leaving the anchor at its current + place.tois optional, and can be passed to ensure + a region (for example a word or paragraph) will end up selected + (in addition to whatever lies between that region and the + current anchor). When multiple selections are present, all but + the primary selection will be dropped by this method. + Supports the same options assetSelection.
+ doc.extendSelections(heads: array<{line, ch}>, ?options: object)
+ - An equivalent
+ of
extendSelection+ that acts on all selections at once.
+ doc.extendSelectionsBy(f: function(range: {anchor, head}) → {line, ch}), ?options: object)
+ - Applies the given function to all existing selections, and
+ calls
extendSelections+ on the result.
+ doc.setExtending(value: boolean)
+ - Sets or clears the 'extending' flag, which acts similar to
+ the shift key, in that it will cause cursor movement and calls
+ to
extendSelection+ to leave the selection anchor in place.
+ doc.getExtending() → boolean
+ - Get the value of the 'extending' flag. + +
cm.hasFocus() → boolean
+ - Tells you whether the editor currently has focus. + +
cm.findPosH(start: {line, ch}, amount: integer, unit: string, visually: boolean) → {line, ch, ?hitSide: boolean}
+ - Used to find the target position for horizontal cursor
+ motion.
startis a{line, ch}+ object,amountan integer (may be negative), + andunitone of the + string"char","column", + or"word". Will return a position that is produced + by movingamounttimes the distance specified + byunit. Whenvisuallyis true, motion + in right-to-left text will be visual rather than logical. When + the motion was clipped by hitting the end or start of the + document, the returned value will have ahitSide+ property set to true.
+ cm.findPosV(start: {line, ch}, amount: integer, unit: string) → {line, ch, ?hitSide: boolean}
+ - Similar to
findPosH, + but used for vertical motion.unitmay + be"line"or"page". The other + arguments and the returned value have the same interpretation as + they have infindPosH.
+
+ cm.findWordAt(pos: {line, ch}) → {anchor: {line, ch}, head: {line, ch}}
+ - Returns the start and end of the 'word' (the stretch of + letters, whitespace, or punctuation) at the given position. +
Configuration methods
+ +-
+
cm.setOption(option: string, value: any)
+ - Change the configuration of the editor.
option+ should the name of an option, + andvalueshould be a valid value for that + option.
+ cm.getOption(option: string) → any
+ - Retrieves the current value of the given option for this + editor instance. + +
cm.addKeyMap(map: object, bottom: boolean)
+ - Attach an additional key map to the
+ editor. This is mostly useful for addons that need to register
+ some key handlers without trampling on
+ the
extraKeys+ option. Maps added in this way have a higher precedence than + theextraKeys+ andkeyMapoptions, + and between them, the maps added earlier have a lower precedence + than those added later, unless thebottomargument + was passed, in which case they end up below other key maps added + with this method.
+ cm.removeKeyMap(map: object)
+ - Disable a keymap added
+ with
addKeyMap. Either + pass in the key map object itself, or a string, which will be + compared against thenameproperty of the active + key maps.
+
+ cm.addOverlay(mode: string|object, ?options: object)
+ - Enable a highlighting overlay. This is a stateless mini-mode
+ that can be used to add extra highlighting. For example,
+ the search addon uses it to
+ highlight the term that's currently being
+ searched.
modecan be a mode + spec or a mode object (an object with + atokenmethod). + Theoptionsparameter is optional. If given, it + should be an object, optionally containing the following options: +-
+
opaque: bool
+ - Defaults to off, but can be given to allow the overlay
+ styling, when not
null, to override the styling of + the base mode entirely, instead of the two being applied + together.
+ priority: number
+ - Determines the ordering in which the overlays are + applied. Those with high priority are applied after those + with lower priority, and able to override the opaqueness of + the ones that come before. Defaults to 0. +
+
+ cm.removeOverlay(mode: string|object)
+ - Pass this the exact value passed for the
mode+ parameter toaddOverlay, + or a string that corresponds to thenameproperty of + that value, to remove an overlay again.
+
+ cm.on(type: string, func: (...args))
+ - Register an event handler for the given event type (a
+ string) on the editor instance. There is also
+ a
CodeMirror.on(object, type, func)version + that allows registering of events on any object.
+ cm.off(type: string, func: (...args))
+ - Remove an event handler on the editor instance. An
+ equivalent
CodeMirror.off(object, type, + func)also exists.
+
Document management methods
+ +Each editor is associated with an instance
+ of CodeMirror.Doc, its document. A document
+ represents the editor content, plus a selection, an undo history,
+ and a mode. A document can only be
+ associated with a single editor at a time. You can create new
+ documents by calling the CodeMirror.Doc(text, mode,
+ firstLineNumber) constructor. The last two arguments are
+ optional and can be used to set a mode for the document and make
+ it start at a line number other than 0, respectively.
-
+
cm.getDoc() → Doc
+ - Retrieve the currently active document from an editor. +
doc.getEditor() → CodeMirror
+ - Retrieve the editor associated with a document. May
+ return
null.
+
+ cm.swapDoc(doc: CodeMirror.Doc) → Doc
+ - Attach a new document to the editor. Returns the old + document, which is now no longer associated with an editor. + +
doc.copy(copyHistory: boolean) → Doc
+ - Create an identical copy of the given doc.
+ When
copyHistoryis true, the history will also be + copied. Can not be called directly on an editor.
+
+ doc.linkedDoc(options: object) → Doc
+ - Create a new document that's linked to the target document.
+ Linked documents will stay in sync (changes to one are also
+ applied to the other) until unlinked.
+ These are the options that are supported:
+
-
+
+
- When turned on, the linked copy will share an undo + history with the original. Thus, something done in one of + the two can be undone in the other, and vice versa. +
from: integer
+ to: integer
+ - Can be given to make the new document a subview of the + original. Subviews only show a given range of lines. Note + that line coordinates inside the subview will be consistent + with those of the parent, so that for example a subview + starting at line 10 will refer to its first line as line 10, + not 0. +
mode: string|object
+ - By default, the new document inherits the mode of the + parent. This option can be set to + a mode spec to give it a + different mode. +
+ doc.unlinkDoc(doc: CodeMirror.Doc)
+ - Break the link between two documents. After calling this, + changes will no longer propagate between the documents, and, if + they had a shared history, the history will become + separate. +
doc.iterLinkedDocs(function: (doc: CodeMirror.Doc, sharedHist: boolean))
+ - Will call the given function for all documents linked to the + target document. It will be passed two arguments, the linked document + and a boolean indicating whether that document shares history + with the target. +
History-related methods
+ +-
+
doc.undo()
+ - Undo one edit (if any undo events are stored). +
doc.redo()
+ - Redo one undone edit. + +
doc.undoSelection()
+ - Undo one edit or selection change. +
doc.redoSelection()
+ - Redo one undone edit or selection change. + +
doc.historySize() → {undo: integer, redo: integer}
+ - Returns an object with
{undo, redo}properties, + both of which hold integers, indicating the amount of stored + undo and redo operations.
+ doc.clearHistory()
+ - Clears the editor's undo history. +
doc.getHistory() → object
+ - Get a (JSON-serializable) representation of the undo history. +
doc.setHistory(history: object)
+ - Replace the editor's undo history with the one provided,
+ which must be a value as returned
+ by
getHistory. Note that + this will have entirely undefined results if the editor content + isn't also the same as it was whengetHistorywas + called.
+
Text-marking methods
+ +-
+
doc.markText(from: {line, ch}, to: {line, ch}, ?options: object) → TextMarker
+ - Can be used to mark a range of text with a specific CSS
+ class name.
fromandtoshould + be{line, ch}objects. Theoptions+ parameter is optional. When given, it should be an object that + may contain the following configuration options: +-
+
className: string
+ - Assigns a CSS class to the marked stretch of text. +
inclusiveLeft: boolean
+ - Determines whether + text inserted on the left of the marker will end up inside + or outside of it. +
inclusiveRight: boolean
+ - Like
inclusiveLeft, + but for the right side.
+ atomic: boolean
+ - Atomic ranges act as a single unit when cursor movement is
+ concerned—i.e. it is impossible to place the cursor inside of
+ them. In atomic ranges,
inclusiveLeft+ andinclusiveRighthave a different meaning—they + will prevent the cursor from being placed respectively + directly before and directly after the range.
+ collapsed: boolean
+ - Collapsed ranges do not show up in the display. Setting a + range to be collapsed will automatically make it atomic. +
clearOnEnter: boolean
+ - When enabled, will cause the mark to clear itself whenever
+ the cursor enters its range. This is mostly useful for
+ text-replacement widgets that need to 'snap open' when the
+ user tries to edit them. The
+
"clear"event + fired on the range handle can be used to be notified when this + happens.
+ clearWhenEmpty: boolean
+ - Determines whether the mark is automatically cleared when + it becomes empty. Default is true. +
replacedWith: Element
+ - Use a given node to display this range. Implies both + collapsed and atomic. The given DOM node must be an + inline element (as opposed to a block element). +
handleMouseEvents: boolean
+ - When
replacedWithis given, this determines + whether the editor will capture mouse and drag events + occurring in this widget. Default is false—the events will be + left alone for the default browser handler, or specific + handlers on the widget, to capture.
+ readOnly: boolean
+ - A read-only span can, as long as it is not cleared, not be
+ modified except by
+ calling
setValueto reset + the whole document. Note: adding a read-only span + currently clears the undo history of the editor, because + existing undo events being partially nullified by read-only + spans would corrupt the history (in the current + implementation).
+ addToHistory: boolean
+ - When set to true (default is false), adding this marker + will create an event in the undo history that can be + individually undone (clearing the marker). +
startStyle: string- Can be used to specify + an extra CSS class to be applied to the leftmost span that + is part of the marker. +
endStyle: string- Equivalent
+ to
startStyle, but for the rightmost span.
+ css: string
+ - A string of CSS to be applied to the covered text. For example
"color: #fe3".
+ title: + string- When given, will give the nodes created
+ for this span a HTML
titleattribute with the + given value.
+ - When the
+ target document is linked to other
+ documents, you can set
sharedto true to make the + marker appear in all documents. By default, a marker appears + only in its target document.
+
CodeMirror.TextMarker), which + exposes three methods: +clear(), to remove the mark, +find(), which returns + a{from, to}object (both holding document + positions), indicating the current position of the marked range, + orundefinedif the marker is no longer in the + document, and finallychanged(), + which you can call if you've done something that might change + the size of the marker (for example changing the content of + areplacedWith+ node), and want to cheaply update the display.
+
+ doc.setBookmark(pos: {line, ch}, ?options: object) → TextMarker
+ - Inserts a bookmark, a handle that follows the text around it
+ as it is being edited, at the given position. A bookmark has two
+ methods
find()andclear(). The first + returns the current position of the bookmark, if it is still in + the document, and the second explicitly removes the bookmark. + The options argument is optional. If given, the following + properties are recognized: +-
+
widget: Element- Can be used to display a DOM
+ node at the current location of the bookmark (analogous to
+ the
replacedWith+ option tomarkText).
+ insertLeft: boolean- By default, text typed + when the cursor is on top of the bookmark will end up to the + right of the bookmark. Set this option to true to make it go + to the left instead. +
shared: boolean- See
+ the corresponding option
+ to
markText.
+ handleMouseEvents: boolean
+ - As with
markText, + this determines whether mouse events on the widget inserted + for this bookmark are handled by CodeMirror. The default is + false.
+
+
+ doc.findMarks(from: {line, ch}, to: {line, ch}) → array<TextMarker>
+ - Returns an array of all the bookmarks and marked ranges + found between the given positions (non-inclusive). +
doc.findMarksAt(pos: {line, ch}) → array<TextMarker>
+ - Returns an array of all the bookmarks and marked ranges + present at the given position. +
doc.getAllMarks() → array<TextMarker>
+ - Returns an array containing all marked ranges in the document. +
Widget, gutter, and decoration methods
+ +-
+
doc.setGutterMarker(line: integer|LineHandle, gutterID: string, value: Element) → LineHandle
+ - Sets the gutter marker for the given gutter (identified by
+ its CSS class, see
+ the
guttersoption) + to the given value. Value can be eithernull, to + clear the marker, or a DOM element, to set it. The DOM element + will be shown in the specified gutter next to the specified + line.
+
+ doc.clearGutter(gutterID: string)
+ - Remove all gutter markers in + the gutter with the given ID. + +
doc.addLineClass(line: integer|LineHandle, where: string, class: string) → LineHandle
+ - Set a CSS class name for the given line.
line+ can be a number or a line handle.wheredetermines + to which element this class should be applied, can can be one + of"text"(the text element, which lies in front of + the selection),"background"(a background element + that will be behind the selection),"gutter"(the + line's gutter space), or"wrap"(the wrapper node + that wraps all of the line's elements, including gutter + elements).classshould be the name of the class to + apply.
+
+ doc.removeLineClass(line: integer|LineHandle, where: string, class: string) → LineHandle
+ - Remove a CSS class from a line.
linecan be a + line handle or number.whereshould be one + of"text","background", + or"wrap"+ (seeaddLineClass).class+ can be left off to remove all classes for the specified node, or + be a string to remove only a specific class.
+
+ doc.lineInfo(line: integer|LineHandle) → object
+ - Returns the line number, text content, and marker status of
+ the given line, which can be either a number or a line handle.
+ The returned object has the structure
{line, handle, text, + gutterMarkers, textClass, bgClass, wrapClass, widgets}, + wheregutterMarkersis an object mapping gutter IDs + to marker elements, andwidgetsis an array + of line widgets attached to this + line, and the various class properties refer to classes added + withaddLineClass.
+
+ cm.addWidget(pos: {line, ch}, node: Element, scrollIntoView: boolean)
+ - Puts
node, which should be an absolutely + positioned DOM node, into the editor, positioned right below the + given{line, ch}position. + WhenscrollIntoViewis true, the editor will ensure + that the entire node is visible (if possible). To remove the + widget again, simply use DOM methods (move it somewhere else, or + callremoveChildon its parent).
+
+ doc.addLineWidget(line: integer|LineHandle, node: Element, ?options: object) → LineWidget
+ - Adds a line widget, an element shown below a line, spanning
+ the whole of the editor's width, and moving the lines below it
+ downwards.
lineshould be either an integer or a + line handle, andnodeshould be a DOM node, which + will be displayed below the given line.options, + when given, should be an object that configures the behavior of + the widget. The following options are supported (all default to + false): +-
+
coverGutter: boolean
+ - Whether the widget should cover the gutter. +
noHScroll: boolean
+ - Whether the widget should stay fixed in the face of + horizontal scrolling. +
above: boolean
+ - Causes the widget to be placed above instead of below + the text of the line. +
handleMouseEvents: boolean
+ - Determines whether the editor will capture mouse and + drag events occurring in this widget. Default is false—the + events will be left alone for the default browser handler, + or specific handlers on the widget, to capture. +
insertAt: integer
+ - By default, the widget is added below other widgets for + the line. This option can be used to place it at a different + position (zero for the top, N to put it after the Nth other + widget). Note that this only has effect once, when the + widget is created. +
lineproperty + pointing at the line handle that it is associated with, and the following methods: +-
+
clear()- Removes the widget. +
changed()- Call + this if you made some change to the widget's DOM node that + might affect its height. It'll force CodeMirror to update + the height of the line that contains the widget. +
+
Sizing, scrolling and positioning methods
+ +-
+
cm.setSize(width: number|string, height: number|string)
+ - Programmatically set the size of the editor (overriding the
+ applicable CSS
+ rules).
widthandheight+ can be either numbers (interpreted as pixels) or CSS units + ("100%", for example). You can + passnullfor either of them to indicate that that + dimension should not be changed.
+
+ cm.scrollTo(x: number, y: number)
+ - Scroll the editor to a given (pixel) position. Both
+ arguments may be left as
null+ orundefinedto have no effect.
+ cm.getScrollInfo() → {left, top, width, height, clientWidth, clientHeight}
+ - Get an
{left, top, width, height, clientWidth, + clientHeight}object that represents the current scroll + position, the size of the scrollable area, and the size of the + visible area (minus scrollbars).
+ cm.scrollIntoView(what: {line, ch}|{left, top, right, bottom}|{from, to}|null, ?margin: number)
+ - Scrolls the given position into view.
whatmay + benullto scroll the cursor into view, + a{line, ch}position to scroll a character into + view, a{left, top, right, bottom}pixel range (in + editor-local coordinates), or a range{from, to}+ containing either two character positions or two pixel squares. + Themarginparameter is optional. When given, it + indicates the amount of vertical pixels around the given area + that should be made visible as well.
+
+ cm.cursorCoords(where: boolean|{line, ch}, mode: string) → {left, top, bottom}
+ - Returns an
{left, top, bottom}object + containing the coordinates of the cursor position. + Ifmodeis"local", they will be + relative to the top-left corner of the editable document. If it + is"page"or not given, they are relative to the + top-left corner of the page. Ifmode+ is"window", the coordinates are relative to the + top-left corner of the currently visible (scrolled) + window.wherecan be a boolean indicating whether + you want the start (true) or the end + (false) of the selection, or, if a{line, + ch}object is given, it specifies the precise position at + which you want to measure.
+ cm.charCoords(pos: {line, ch}, ?mode: string) → {left, right, top, bottom}
+ - Returns the position and dimensions of an arbitrary
+ character.
posshould be a{line, ch}+ object. This differs fromcursorCoordsin that + it'll give the size of the whole character, rather than just the + position that the cursor would have when it would sit at that + position.
+ cm.coordsChar(object: {left, top}, ?mode: string) → {line, ch}
+ - Given an
{left, top}object (e.g. coordinates of a mouse event) returns + the{line, ch}position that corresponds to it. The + optionalmodeparameter determines relative to what + the coordinates are interpreted. It may + be"window","page"(the default), + or"local".
+ cm.lineAtHeight(height: number, ?mode: string) → number
+ - Computes the line at the given pixel
+ height.
modecan be one of the same strings + thatcoordsChar+ accepts.
+ cm.heightAtLine(line: integer|LineHandle, ?mode: string, ?includeWidgets: bool) → number
+ - Computes the height of the top of a line, in the coordinate
+ system specified by
mode+ (seecoordsChar), which + defaults to"page". When a line below the bottom of + the document is specified, the returned value is the bottom of + the last line in the document. By default, the position of the + actual text is returned. If `includeWidgets` is true and the + line has line widgets, the position above the first line widget + is returned.
+ cm.defaultTextHeight() → number
+ - Returns the line height of the default font for the editor. +
cm.defaultCharWidth() → number
+ - Returns the pixel width of an 'x' in the default font for + the editor. (Note that for non-monospace fonts, this is mostly + useless, and even for monospace fonts, non-ascii characters + might have a different width). + +
cm.getViewport() → {from: number, to: number}
+ - Returns a
{from, to}object indicating the + start (inclusive) and end (exclusive) of the currently rendered + part of the document. In big documents, when most content is + scrolled out of view, CodeMirror will only render the visible + part, and a margin around it. See also + theviewportChange+ event.
+
+ cm.refresh()
+ - If your code does something to change the size of the editor + element (window resizes are already listened for), or unhides + it, you should probably follow up by calling this method to + ensure CodeMirror is still looking as intended. See also + the autorefresh addon. +
Mode, state, and token-related methods
+ +When writing language-aware functionality, it can often be + useful to hook into the knowledge that the CodeMirror language + mode has. See the section on modes for a + more detailed description of how these work.
+ +-
+
doc.getMode() → object
+ - Gets the (outer) mode object for the editor. Note that this
+ is distinct from
getOption("mode"), which gives you + the mode specification, rather than the resolved, instantiated + mode object.
+
+ cm.getModeAt(pos: {line, ch}) → object
+ - Gets the inner mode at a given position. This will return
+ the same as
getModefor + simple modes, but will return an inner mode for nesting modes + (such ashtmlmixed).
+
+ cm.getTokenAt(pos: {line, ch}, ?precise: boolean) → object
+ - Retrieves information about the token the current mode found
+ before the given position (a
{line, ch}object). The + returned object has the following properties: +-
+
start- The character (on the given line) at which the token starts. +
end- The character at which the token ends. +
string- The token's string. +
type- The token type the mode assigned
+ to the token, such as
"keyword"+ or"comment"(may also be null).
+ state- The mode's state at the end of this token. +
preciseis true, the token will be guaranteed to be accurate based on recent edits. If false or + not specified, the token will use cached state information, which will be faster but might not be accurate if + edits were recently made and highlighting has not yet completed. +
+
+ cm.getLineTokens(line: integer, ?precise: boolean) → array<{start, end, string, type, state}>
+ - This is similar
+ to
getTokenAt, but + collects all tokens for a given line into an array. It is much + cheaper than repeatedly callinggetTokenAt, which + re-parses the part of the line before the token for every call.
+
+ cm.getTokenTypeAt(pos: {line, ch}) → string
+ - This is a (much) cheaper version
+ of
getTokenAtuseful for + when you just need the type of the token at a given position, + and no other information. Will returnnullfor + unstyled tokens, and a string, potentially containing multiple + space-separated style names, otherwise.
+
+ cm.getHelpers(pos: {line, ch}, type: string) → array<helper>
+ - Fetch the set of applicable helper values for the given
+ position. Helpers provide a way to look up functionality
+ appropriate for a mode. The
typeargument provides + the helper namespace (see +registerHelper), in + which the values will be looked up. When the mode itself has a + property that corresponds to thetype, that + directly determines the keys that are used to look up the helper + values (it may be either a single string, or an array of + strings). Failing that, the mode'shelperType+ property and finally the mode's name are used.
+ - For example, the JavaScript mode has a
+ property
foldcontaining"brace". When + thebrace-foldaddon is loaded, that defines a + helper namedbracein thefold+ namespace. This is then used by + thefoldcodeaddon to + figure out that it can use that folding function to fold + JavaScript code.
+ - When any 'global' + helpers are defined for the given namespace, their predicates + are called on the current mode and editor, and all those that + declare they are applicable will also be added to the array that + is returned. + +
cm.getHelper(pos: {line, ch}, type: string) → helper
+ - Returns the first applicable helper value.
+ See
getHelpers.
+
+ cm.getStateAfter(?line: integer, ?precise: boolean) → object
+ - Returns the mode's parser state, if any, at the end of the
+ given line number. If no line number is given, the state at the
+ end of the document is returned. This can be useful for storing
+ parsing errors in the state, or getting other kinds of
+ contextual information for a line.
preciseis defined + as ingetTokenAt().
+
Miscellaneous methods
+ +-
+
cm.operation(func: () → any) → any
+ - CodeMirror internally buffers changes and only updates its + DOM structure after it has finished performing some operation. + If you need to perform a lot of operations on a CodeMirror + instance, you can call this method with a function argument. It + will call the function, buffering up all changes, and only doing + the expensive update after the function returns. This can be a + lot faster. The return value from this method will be the return + value of your function. + +
cm.startOperation()
+ cm.endOperation()
+ - In normal circumstances, use the above
operation+ method. But if you want to buffer operations happening asynchronously, + or that can't all be wrapped in a callback function, you can + callstartOperationto tell CodeMirror to start + buffering changes, andendOperationto actually + render all the updates. Be careful: if you use this + API and forget to callendOperation, the editor will + just never update.
+
+ cm.indentLine(line: integer, ?dir: string|integer)
+ - Adjust the indentation of the given line. The second
+ argument (which defaults to
"smart") may be one of: +-
+
"prev"
+ - Base indentation on the indentation of the previous line. +
"smart"
+ - Use the mode's smart indentation if available, behave
+ like
"prev"otherwise.
+ "add"
+ - Increase the indentation of the line by + one indent unit. +
"subtract"
+ - Reduce the indentation of the line. +
<integer>
+ - Add (positive number) or reduce (negative number) the + indentation by the given amount of spaces. +
+
+ cm.toggleOverwrite(?value: boolean)
+ - Switches between overwrite and normal insert mode (when not + given an argument), or sets the overwrite mode to a specific + state (when given an argument). + +
cm.isReadOnly() → boolean
+ - Tells you whether the editor's content can be edited by the + user. + +
doc.lineSeparator()
+ - Returns the preferred line separator string for this
+ document, as per the option
+ by the same name. When that option is
null, the + string"\n"is returned.
+
+ cm.execCommand(name: string)
+ - Runs the command with the given name on the editor. + +
doc.posFromIndex(index: integer) → {line, ch}
+ - Calculates and returns a
{line, ch}object for a + zero-basedindexwho's value is relative to the start of the + editor's text. If theindexis out of range of the text then + the returned object is clipped to start or end of the text + respectively.
+ doc.indexFromPos(object: {line, ch}) → integer
+ - The reverse of
posFromIndex.
+
+ cm.focus()
+ - Give the editor focus. + +
cm.getInputField() → Element
+ - Returns the input field for the editor. Will be a textarea
+ or an editable div, depending on the value of
+ the
inputStyle+ option.
+ cm.getWrapperElement() → Element
+ - Returns the DOM node that represents the editor, and + controls its size. Remove this from your tree to delete an + editor instance. +
cm.getScrollerElement() → Element
+ - Returns the DOM node that is responsible for the scrolling + of the editor. +
cm.getGutterElement() → Element
+ - Fetches the DOM node that contains the editor gutters. +
Static properties
+The CodeMirror object itself provides
+ several useful properties.
-
+
CodeMirror.version: string
+ - It contains a string that indicates the version of the
+ library. This is a triple of
+ integers
"major.minor.patch", + wherepatchis zero for releases, and something + else (usually one) for dev snapshots.
+
+ CodeMirror.fromTextArea(textArea: TextAreaElement, ?config: object)
+ - This method provides another way to initialize an editor. It
+ takes a textarea DOM node as first argument and an optional
+ configuration object as second. It will replace the textarea
+ with a CodeMirror instance, and wire up the form of that
+ textarea (if any) to make sure the editor contents are put into
+ the textarea when the form is submitted. The text in the
+ textarea will provide the content for the editor. A CodeMirror
+ instance created this way has three additional methods:
+
-
+
cm.save()
+ - Copy the content of the editor into the textarea. + +
cm.toTextArea()
+ - Remove the editor, and restore the original textarea (with + the editor's current content). If you dynamically create and + destroy editors made with `fromTextArea`, without destroying + the form they are part of, you should make sure to call + `toTextArea` to remove the editor, or its `"submit"` handler + on the form will cause a memory leak. + +
cm.getTextArea() → TextAreaElement
+ - Returns the textarea that the instance was based on. +
+
+ CodeMirror.defaults: object
+ - An object containing default values for + all options. You can assign to its + properties to modify defaults (though this won't affect editors + that have already been created). + +
CodeMirror.defineExtension(name: string, value: any)
+ - If you want to define extra methods in terms of the
+ CodeMirror API, it is possible to
+ use
defineExtension. This will cause the given + value (usually a method) to be added to all CodeMirror instances + created from then on.
+
+ CodeMirror.defineDocExtension(name: string, value: any)
+ - Like
defineExtension, + but the method will be added to the interface + forDocobjects instead.
+
+ CodeMirror.defineOption(name: string, + default: any, updateFunc: function)
+ - Similarly,
defineOptioncan be used to define new options for + CodeMirror. TheupdateFuncwill be called with the + editor instance and the new value when an editor is initialized, + and whenever the option is modified + throughsetOption.
+
+ CodeMirror.defineInitHook(func: function)
+ - If your extension just needs to run some
+ code whenever a CodeMirror instance is initialized,
+ use
CodeMirror.defineInitHook. Give it a function as + its only argument, and from then on, that function will be called + (with the instance as argument) whenever a new CodeMirror instance + is initialized.
+
+ CodeMirror.registerHelper(type: string, name: string, value: helper)
+ - Registers a helper value with the given
namein + the given namespace (type). This is used to define + functionality that may be looked up by mode. Will create (if it + doesn't already exist) a property on theCodeMirror+ object for the giventype, pointing to an object + that maps names to values. I.e. after + doingCodeMirror.registerHelper("hint", "foo", + myFoo), the valueCodeMirror.hint.foowill + point tomyFoo.
+
+ CodeMirror.registerGlobalHelper(type: string, name: string, predicate: fn(mode, CodeMirror), value: helper)
+ - Acts
+ like
registerHelper, + but also registers this helper as 'global', meaning that it will + be included bygetHelpers+ whenever the givenpredicatereturns true when + called with the local mode and editor.
+
+ CodeMirror.Pos(line: integer, ?ch: integer, ?sticky: string)
+ - A constructor for the objects that are used to represent
+ positions in editor documents.
stickydefaults to + null, but can be set to"before"+ or"after"to make the position explicitly + associate with the character before or after it.
+
+ CodeMirror.changeEnd(change: object) → {line, ch}
+ - Utility function that computes an end position from a change
+ (an object with
from,to, + andtextproperties, as passed to + various event handlers). The + returned position will be the end of the changed + range, after the change is applied.
+
+ CodeMirror.countColumn(line: string, index: number, tabSize: number) → number
+ - Find the column position at a given string index using a given tabsize. +
Addons
+ +The addon directory in the distribution contains a
+ number of reusable components that implement extra editor
+ functionality (on top of extension functions
+ like defineOption, defineExtension,
+ and registerHelper). In
+ brief, they are:
-
+
dialog/dialog.js
+ - Provides a very simple way to query users for text input.
+ Adds the
openDialog(template, callback, options) → + closeFunctionmethod to CodeMirror instances, + which can be called with an HTML fragment or a detached DOM + node that provides the prompt (should include aninput+ orbuttontag), and a callback function that is called + when the user presses enter. It returns a functioncloseFunction+ which, if called, will close the dialog immediately. +openDialogtakes the following options: +-
+
closeOnEnter: bool
+ - If true, the dialog will be closed when the user presses
+ enter in the input. Defaults to
true.
+ closeOnBlur: bool
+ - Determines whether the dialog is closed when it loses focus. Defaults to
true.
+ onKeyDown: fn(event: KeyboardEvent, value: string, close: fn()) → bool
+ - An event handler that will be called whenever
keydownfires in the + dialog's input. If your callback returnstrue, + the dialog will not do any further processing of the event.
+ onKeyUp: fn(event: KeyboardEvent, value: string, close: fn()) → bool
+ - Same as
onKeyDownbut for the +keyupevent.
+ onInput: fn(event: InputEvent, value: string, close: fn()) → bool
+ - Same as
onKeyDownbut for the +inputevent.
+ onClose: fn(instance):
+ - A callback that will be called after the dialog has been closed and + removed from the DOM. No return value. +
Also adds an
+ +openNotification(template, options) → + closeFunctionfunction that simply shows an HTML + fragment as a notification at the top of the editor. It takes a + single option:duration, the amount of time after + which the notification will be automatically closed. If+ durationis zero, the dialog will not be closed automatically.Depends on
addon/dialog/dialog.css.
+
+ search/searchcursor.js
+ - Adds the
getSearchCursor(query, start, options) → + cursormethod to CodeMirror instances, which can be used + to implement search/replace functionality.query+ can be a regular expression or a string.start+ provides the starting position of the search. It can be + a{line, ch}object, or can be left off to default + to the start of the document.optionsis an + optional object, which can contain the property `caseFold: + false` to disable case folding when mathing a string, or the + property `multiline: disable` to disable multi-line matching for + regular expressions (which may help performance). A search + cursor has the following methods: +-
+
findNext() → boolean
+ findPrevious() → boolean
+ - Search forward or backward from the current position.
+ The return value indicates whether a match was found. If
+ matching a regular expression, the return value will be the
+ array returned by the
matchmethod, in case you + want to extract matched groups.
+ from() → {line, ch}
+ to() → {line, ch}
+ - These are only valid when the last call
+ to
findNextorfindPreviousdid + not return false. They will return{line, ch}+ objects pointing at the start and end of the match.
+ replace(text: string, ?origin: string)
+ - Replaces the currently found match with the given text + and adjusts the cursor position to reflect the + replacement. +
+
+ search/search.js
+ - Implements the search commands. CodeMirror has keys bound to
+ these by default, but will not do anything with them unless an
+ implementation is provided. Depends
+ on
searchcursor.js, and will make use + ofopenDialogwhen + available to make prompting for search queries less ugly.
+
+ search/jump-to-line.js
+ - Implements a
jumpToLinecommand and bindingAlt-Gto it. + Acceptslinenumber,+/-linenumber,line:char, +scroll%and:linenumberformats. + This will make use ofopenDialog+ when available to make prompting for line number neater.
+
+ search/matchesonscrollbar.js
+ - Adds a
showMatchesOnScrollbarmethod to editor + instances, which should be given a query (string or regular + expression), optionally a case-fold flag (only applicable for + strings), and optionally a class name (defaults + toCodeMirror-search-match) as arguments. When + called, matches of the given query will be displayed on the + editor's vertical scrollbar. The method returns an object with + aclearmethod that can be called to remove the + matches. Depends on + theannotatescrollbar+ addon, and + thematchesonscrollbar.css+ file provides a default (transparent yellowish) definition of + the CSS class applied to the matches. Note that the matches are + only perfectly aligned if your scrollbar does not have buttons + at the top and bottom. You can use + thesimplescrollbar+ addon to make sure of this. If this addon is loaded, + thesearchaddon will + automatically use it.
+
+ edit/matchbrackets.js
+ - Defines an option
matchBracketswhich, when set + to true or an options object, causes matching brackets to be + highlighted whenever the cursor is next to them. It also adds a + methodmatchBracketsthat forces this to happen + once, and a methodfindMatchingBracketthat can be + used to run the bracket-finding algorithm that this uses + internally. It takes a start position and an optional config + object. By default, it will find the match to a matchable + character either before or after the cursor (preferring the one + before), but you can control its behavior with these options: +-
+
afterCursor
+ - Only use the character after the start position, never the one before it. +
strict
+ - Causes only matches where both brackets are at the same side of the start position to be considered. +
maxScanLines
+ - Stop after scanning this amount of lines without a successful match. Defaults to 1000. +
maxScanLineLength
+ - Ignore lines longer than this. Defaults to 10000. +
+
+ edit/closebrackets.js
+ - Defines an option
autoCloseBracketsthat will + auto-close brackets and quotes when typed. By default, it'll + auto-close()[]{}''"", but you can pass it a string + similar to that (containing pairs of matching characters), or an + object withpairsand + optionallyexplodeproperties to customize + it.explodeshould be a similar string that gives + the pairs of characters that, when enter is pressed between + them, should have the second character also moved to its own + line. By default, if the active mode has + acloseBracketsproperty, that overrides the + configuration given in the option. But you can add + anoverrideproperty with a truthy value to + override mode-specific + configuration. Demo + here.
+
+
+ - Defines an option
matchTagsthat, when enabled, + will cause the tags around the cursor to be highlighted (using + theCodeMirror-matchingtagclass). Also + defines + a commandtoMatchingTag, + which you can bind a key to in order to jump to the tag matching + the one under the cursor. Depends on + theaddon/fold/xml-fold.js+ addon. Demo here.
+
+ edit/trailingspace.js
+ - Adds an option
showTrailingSpacewhich, when + enabled, adds the CSS classcm-trailingspaceto + stretches of whitespace at the end of lines. + The demo has a nice + squiggly underline style for this class.
+
+ edit/closetag.js
+ - Defines an
autoCloseTagsoption that will + auto-close XML tags when '>' or '/' + is typed, and + acloseTagcommand that + closes the nearest open tag. Depends on + thefold/xml-fold.jsaddon. See + the demo.
+
+ edit/continuelist.js
+ - Markdown specific. Defines
+ a
"newlineAndIndentContinueMarkdownList"command + that can be bound toenterto automatically + insert the leading characters for continuing a list. See + the Markdown mode + demo.
+
+ comment/comment.js
+ - Addon for commenting and uncommenting code. Adds four
+ methods to CodeMirror instances:
+
-
+
toggleComment(from: {line, ch}, to: {line, ch}, ?options: object)
+ - Tries to uncomment the current selection, and if that + fails, line-comments it. +
lineComment(from: {line, ch}, to: {line, ch}, ?options: object)
+ - Set the lines in the given range to be line comments. Will
+ fall back to
blockCommentwhen no line comment + style is defined for the mode.
+ blockComment(from: {line, ch}, to: {line, ch}, ?options: object)
+ - Wrap the code in the given range in a block comment. Will
+ fall back to
lineCommentwhen no block comment + style is defined for the mode.
+ uncomment(from: {line, ch}, to: {line, ch}, ?options: object) → boolean
+ - Try to uncomment the given range.
+ Returns
trueif a comment range was found and + removed,falseotherwise.
+
optionsobject accepted by these methods may + have the following properties: +-
+
blockCommentStart, blockCommentEnd, blockCommentLead, lineComment: string
+ - Override the comment string + properties of the mode with custom comment strings. +
padding: string
+ - A string that will be inserted after opening and leading + markers, and before closing comment markers. Defaults to a + single space. +
commentBlankLines: boolean
+ - Whether, when adding line comments, to also comment lines + that contain only whitespace. +
indent: boolean
+ - When adding line comments and this is turned on, it will + align the comment block to the current indentation of the + first line of the block. +
fullLines: boolean
+ - When block commenting, this controls whether the whole
+ lines are indented, or only the precise range that is given.
+ Defaults to
true.
+
toggleCommentcommand, + which is a shorthand command for calling +toggleCommentwith no options.
+
+ fold/foldcode.js
+ - Helps with code folding. Adds a
foldCodemethod + to editor instances, which will try to do a code fold starting + at the given line, or unfold the fold that is already present. + The method takes as first argument the position that should be + folded (may be a line number or + aPos), and as second optional + argument either a range-finder function, or an options object, + supporting the following properties: +-
+
rangeFinder: fn(CodeMirror, Pos)
+ - The function that is used to find
+ foldable ranges. If this is not directly passed, it will
+ default to
CodeMirror.fold.auto, which + usesgetHelperswith + a"fold"type to find folding functions + appropriate for the local mode. There are files in + theaddon/fold/+ directory providingCodeMirror.fold.brace, which + finds blocks in brace languages (JavaScript, C, Java, + etc),CodeMirror.fold.indent, for languages where + indentation determines block structure (Python, Haskell), + andCodeMirror.fold.xml, for XML-style languages, + andCodeMirror.fold.comment, for folding comment + blocks.
+ widget: string|Element
+ - The widget to show for folded ranges. Can be either a
+ string, in which case it'll become a span with
+ class
CodeMirror-foldmarker, or a DOM node.
+ scanUp: boolean
+ - When true (default is false), the addon will try to find + foldable ranges on the lines above the current one if there + isn't an eligible one on the given line. +
minFoldSize: integer
+ - The minimum amount of lines that a fold should span to be + accepted. Defaults to 0, which also allows single-line + folds. +
+
+ fold/foldgutter.js
+ - Provides an option
foldGutter, which can be + used to create a gutter with markers indicating the blocks that + can be folded. Create a gutter using + theguttersoption, + giving it the classCodeMirror-foldgutteror + something else if you configure the addon to use a different + class, and this addon will show markers next to folded and + foldable blocks, and handle clicks in this gutter. Note that + CSS styles should be applied to make the gutter, and the fold + markers within it, visible. A default set of CSS styles are + available in: + +addon/fold/foldgutter.css+ . + The option + can be either set totrue, or an object containing + the following optional option fields: +-
+
gutter: string
+ - The CSS class of the gutter. Defaults
+ to
"CodeMirror-foldgutter". You will have to + style this yourself to give it a width (and possibly a + background). See the default gutter style rules above.
+ indicatorOpen: string | Element
+ - A CSS class or DOM element to be used as the marker for
+ open, foldable blocks. Defaults
+ to
"CodeMirror-foldgutter-open".
+ indicatorFolded: string | Element
+ - A CSS class or DOM element to be used as the marker for
+ folded blocks. Defaults to
"CodeMirror-foldgutter-folded".
+ rangeFinder: fn(CodeMirror, Pos)
+ - The range-finder function to use when determining whether
+ something can be folded. When not
+ given,
CodeMirror.fold.auto+ will be used as default.
+
foldOptionseditor option can be set to an + object to provide an editor-wide default configuration. + Demo here.
+
+ runmode/runmode.js
+ - Can be used to run a CodeMirror mode over text without
+ actually opening an editor instance.
+ See the demo for an example.
+ There are alternate versions of the file available for
+ running stand-alone
+ (without including all of CodeMirror) and
+ for running under
+ node.js (see
bin/source-highlightfor an example of using the latter).
+
+ runmode/colorize.js
+ - Provides a convenient way to syntax-highlight code snippets
+ in a webpage. Depends on
+ the
runmodeaddon (or + its standalone variant). Provides + aCodeMirror.colorizefunction that can be called + with an array (or other array-ish collection) of DOM nodes that + represent the code snippets. By default, it'll get + allpretags. Will read thedata-lang+ attribute of these nodes to figure out their language, and + syntax-color their content using the relevant CodeMirror mode + (you'll have to load the scripts for the relevant modes + yourself). A second argument may be provided to give a default + mode, used when no language attribute is found for a node. Used + in this manual to highlight example code.
+
+ mode/overlay.js
+ - Mode combinator that can be used to extend a mode with an
+ 'overlay' — a secondary mode is run over the stream, along with
+ the base mode, and can color specific pieces of text without
+ interfering with the base mode.
+ Defines
CodeMirror.overlayMode, which is used to + create such a mode. See this + demo for a detailed example.
+
+ mode/multiplex.js
+ - Mode combinator that can be used to easily 'multiplex'
+ between several modes.
+ Defines
CodeMirror.multiplexingModewhich, when + given as first argument a mode object, and as other arguments + any number of{open, close, mode [, delimStyle, innerStyle, parseDelimiters]}+ objects, will return a mode object that starts parsing using the + mode passed as first argument, but will switch to another mode + as soon as it encounters a string that occurs in one of + theopenfields of the passed objects. When in a + sub-mode, it will go back to the top mode again when + theclosestring is encountered. + Pass"\n"foropenorclose+ if you want to switch on a blank line. +- When
delimStyleis specified, it will be the token + style returned for the delimiter tokens (as well as +[delimStyle]-openon the opening token and +[delimStyle]-closeon the closing token).
+ - When
innerStyleis specified, it will be the token + style added for each inner mode token.
+ - When
parseDelimitersis true, the content of + the delimiters will also be passed to the inner mode. + (AnddelimStyleis ignored.)
+
+ - When
hint/show-hint.js
+ - Provides a framework for showing autocompletion hints.
+ Defines
editor.showHint, which takes an optional + options object, and pops up a widget that allows the user to + select a completion. Finding hints is done with a hinting + functions (thehintoption), which is a function + that take an editor instance and options object, and return + a{list, from, to}object, wherelist+ is an array of strings or objects (the completions), + andfromandtogive the start and end + of the token that is being completed as{line, ch}+ objects. An optionalselectedHintproperty (an + integer) can be added to the completion object to control the + initially selected hint.
+ - If no hinting function is given, the addon will
+ use
CodeMirror.hint.auto, which + callsgetHelperswith + the"hint"type to find applicable hinting + functions, and tries them one by one. If that fails, it looks + for a"hintWords"helper to fetch a list of + completable words for the mode, and + usesCodeMirror.hint.fromListto complete from + those.
+ - When completions aren't simple strings, they should be
+ objects with the following properties:
+
-
+
text: string
+ - The completion text. This is the only required + property. +
displayText: string
+ - The text that should be displayed in the menu. +
className: string
+ - A CSS class name to apply to the completion's line in the + menu. +
render: fn(Element, self, data)
+ - A method used to create the DOM structure for showing the + completion by appending it to its first argument. +
hint: fn(CodeMirror, self, data)
+ - A method used to actually apply the completion, instead of + the default behavior. +
from: {line, ch}
+ - Optional
fromposition that will be used bypick()instead + of the global one passed with the full list of completions.
+ to: {line, ch}
+ - Optional
toposition that will be used bypick()instead + of the global one passed with the full list of completions.
+
+
+ - The plugin understands the following options, which may be
+ either passed directly in the argument to
showHint, + or provided by setting anhintOptionseditor + option to an object (the former takes precedence). The options + object will also be passed along to the hinting function, which + may understand additional options. +-
+
hint: function
+ - A hinting function, as specified above. It is possible to
+ set the
asyncproperty on a hinting function to + true, in which case it will be called with + arguments(cm, callback, ?options), and the + completion interface will only be popped up when the hinting + function calls the callback, passing it the object holding the + completions. + The hinting function can also return a promise, and the completion + interface will only be popped when the promise resolves. + By default, hinting only works when there is no + selection. You can give a hinting function + asupportsSelectionproperty with a truthy value + to indicate that it supports selections.
+ completeSingle: boolean
+ - Determines whether, when only a single completion is + available, it is completed without showing the dialog. + Defaults to true. +
alignWithWord: boolean
+ - Whether the pop-up should be horizontally aligned with the + start of the word (true, default), or with the cursor (false). +
closeOnUnfocus: boolean
+ - When enabled (which is the default), the pop-up will close + when the editor is unfocused. +
customKeys: keymap
+ - Allows you to provide a custom key map of keys to be active
+ when the pop-up is active. The handlers will be called with an
+ extra argument, a handle to the completion menu, which
+ has
moveFocus(n),setFocus(n),pick(), + andclose()methods (see the source for details), + that can be used to change the focused element, pick the + current element or close the menu. AdditionallymenuSize()+ can give you access to the size of the current dropdown menu, +lengthgive you the number of available completions, and +datagive you full access to the completion returned by the + hinting function.
+ extraKeys: keymap
+ - Like
customKeysabove, but the bindings will + be added to the set of default bindings, instead of replacing + them.
+
-
+
"shown" ()
+ - Fired when the pop-up is shown. +
"select" (completion, Element)
+ - Fired when a completion is selected. Passed the completion + value (string or object) and the DOM node that represents it + in the menu. +
"pick" (completion)
+ - Fired when a completion is picked. Passed the completion value + (string or object). +
"close" ()
+ - Fired when the completion is finished. +
addon/hint/show-hint.css. Check + out the demo for an + example.
+
+ hint/javascript-hint.js
+ - Defines a simple hinting function for JavaScript
+ (
CodeMirror.hint.javascript) and CoffeeScript + (CodeMirror.hint.coffeescript) code. This will + simply use the JavaScript environment that the editor runs in as + a source of information about objects and their properties.
+
+ hint/xml-hint.js
+ - Defines
CodeMirror.hint.xml, which produces + hints for XML tagnames, attribute names, and attribute values, + guided by aschemaInfooption (a property of the + second argument passed to the hinting function, or the third + argument passed toCodeMirror.showHint).
The + schema info should be an object mapping tag names to information + about these tags, with optionally a"!top"property + containing a list of the names of valid top-level tags. The + values of the properties should be objects with optional + propertieschildren(an array of valid child + element names, omit to simply allow all tags to appear) + andattrs(an object mapping attribute names + tonullfor free-form attributes, and an array of + valid values for restricted + attributes). Demo + here.
+
+ hint/html-hint.js
+ - Provides schema info to
+ the xml-hint addon for HTML
+ documents. Defines a schema
+ object
CodeMirror.htmlSchemathat you can pass to + as aschemaInfooption, and + aCodeMirror.hint.htmlhinting function that + automatically callsCodeMirror.hint.xmlwith this + schema data. See + the demo.
+
+ hint/css-hint.js
+ - A hinting function for CSS, SCSS, or LESS code.
+ Defines
CodeMirror.hint.css.
+
+ hint/anyword-hint.js
+ - A very simple hinting function
+ (
CodeMirror.hint.anyword) that simply looks for + words in the nearby code and completes to those. Takes two + optional options,word, a regular expression that + matches words (sequences of one or more character), + andrange, which defines how many lines the addon + should scan when completing (defaults to 500).
+
+ hint/sql-hint.js
+ - A simple SQL hinter. Defines
CodeMirror.hint.sql. + Takes two optional options,tables, a object with + table names as keys and array of respective column names as values, + anddefaultTable, a string corresponding to a + table name intablesfor autocompletion.
+
+ search/match-highlighter.js
+ - Adds a
highlightSelectionMatchesoption that + can be enabled to highlight all instances of a currently + selected word. Can be set either to true or to an object + containing the following options:minChars, for the + minimum amount of selected characters that triggers a highlight + (default 2),style, for the style to be used to + highlight the matches (default"matchhighlight", + which will correspond to CSS + classcm-matchhighlight),trim, which + controls whether whitespace is trimmed from the selection, + andshowTokenwhich can be set totrue+ or to a regexp matching the characters that make up a word. When + enabled, it causes the current word to be highlighted when + nothing is selected (defaults to off). + Demo here.
+
+ lint/lint.js
+ - Defines an interface component for showing linting warnings,
+ with pluggable warning sources
+ (see
html-lint.js, +json-lint.js, +javascript-lint.js, +coffeescript-lint.js, + andcss-lint.js+ in the same directory). Defines alintoption that + can be set to an annotation source (for + exampleCodeMirror.lint.javascript), to an options + object (in which case thegetAnnotationsfield is + used as annotation source), or simply totrue. When + no annotation source is + specified,getHelperwith + type"lint"is used to find an annotation function. + An annotation source function should, when given a document + string, an options object, and an editor instance, return an + array of{message, severity, from, to}objects + representing problems. When the function has + anasyncproperty with a truthy value, it will be + called with an additional second argument, which is a callback + to pass the array to. + The linting function can also return a promise, in that case the linter + will only be executed when the promise resolves. + By default, the linter will run (debounced) whenever the document is changed. + You can pass alintOnChange: falseoption to disable that. + Depends onaddon/lint/lint.css. A demo can be + found here.
+
+ selection/mark-selection.js
+ - Causes the selected text to be marked with the CSS class
+
CodeMirror-selectedtextwhen thestyleSelectedTextoption + is enabled. Useful to change the colour of the selection (in addition to the background), + like in this demo.
+
+ selection/active-line.js
+ - Defines a
styleActiveLineoption that, when + enabled, gives the wrapper of the line that contains the cursor + the classCodeMirror-activeline, adds a background + with the classCodeMirror-activeline-background, + and adds the classCodeMirror-activeline-gutterto + the line's gutter space is enabled. The option's value may be a + boolean or an object specifying the following options: +-
+
nonEmpty: bool
+ - Controls whether single-line selections, or just cursor + selections, are styled. Defaults to false (only cursor + selections). +
+
+ selection/selection-pointer.js
+ - Defines a
selectionPointeroption which you can + use to control the mouse cursor appearance when hovering over + the selection. It can be set to a string, + like"pointer", or to true, in which case + the"default"(arrow) cursor will be used. You can + see a demo here.
+
+ mode/loadmode.js
+ - Defines a
CodeMirror.requireMode(modename, + callback)function that will try to load a given mode and + call the callback when it succeeded. You'll have to + setCodeMirror.modeURLto a string that mode paths + can be constructed from, for + example"mode/%N/%N.js"—the%N's will + be replaced with the mode name. Also + definesCodeMirror.autoLoadMode(instance, mode), + which will ensure the given mode is loaded and cause the given + editor instance to refresh its mode when the loading + succeeded. See the demo.
+
+ mode/meta.js
+ - Provides meta-information about all the modes in the
+ distribution in a single file.
+ Defines
CodeMirror.modeInfo, an array of objects + with{name, mime, mode}properties, + wherenameis the human-readable + name,mimethe MIME type, andmodethe + name of the mode file that defines this MIME. There are optional + propertiesmimes, which holds an array of MIME + types for modes with multiple MIMEs associated, + andext, which holds an array of file extensions + associated with this mode. Four convenience + functions,CodeMirror.findModeByMIME, +CodeMirror.findModeByExtension, +CodeMirror.findModeByFileName+ andCodeMirror.findModeByNameare provided, which + return such an object given a MIME, extension, file name or mode name + string. Note that, for historical reasons, this file resides in the + top-levelmodedirectory, not + underaddon. Demo.
+
+ comment/continuecomment.js
+ - Adds a
continueCommentsoption, which sets whether the + editor will make the next line continue a comment when you press Enter + inside a comment block. Can be set to a boolean to enable/disable this + functionality. Set to a string, it will continue comments using a custom + shortcut. Set to an object, it will use thekeyproperty for + a custom shortcut and the booleancontinueLineComment+ property to determine whether single-line comments should be continued + (defaulting totrue).
+
+ display/placeholder.js
+ - Adds a
placeholderoption that can be used to + make content appear in the editor when it is empty and not + focused. It can hold either a string or a DOM node. Also gives + the editor aCodeMirror-emptyCSS class whenever it + doesn't contain any text. + See the demo.
+
+ display/fullscreen.js
+ - Defines an option
fullScreenthat, when set + totrue, will make the editor full-screen (as in, + taking up the whole browser window). Depends + onfullscreen.css. Demo + here.
+
+ display/autorefresh.js
+ - This addon can be useful when initializing an editor in a
+ hidden DOM node, in cases where it is difficult to
+ call
refreshwhen the editor + becomes visible. It defines an optionautoRefresh+ which you can set to true to ensure that, if the editor wasn't + visible on initialization, it will be refreshed the first time + it becomes visible. This is done by polling every 250 + milliseconds (you can pass a value like{delay: + 500}as the option value to configure this). Note that + this addon will only refresh the editor once when it + first becomes visible, and won't take care of further restyling + and resizing.
+
+ scroll/simplescrollbars.js
+ - Defines two additional scrollbar
+ models,
"simple"and"overlay"+ (see demo) that can + be selected with + thescrollbarStyle+ option. Depends + onsimplescrollbars.css, + which can be further overridden to style your own + scrollbars.
+
+ scroll/annotatescrollbar.js
+ - Provides functionality for showing markers on the scrollbar
+ to call out certain parts of the document. Adds a
+ method
annotateScrollbarto editor instances that + can be called, with a CSS class name as argument, to create a + set of annotations. The method returns an object + whoseupdatemethod can be called with a sorted array + of{from: Pos, to: Pos}objects marking the ranges + to be highlighted. To detach the annotations, call the + object'sclearmethod.
+
+ display/rulers.js
+ - Adds a
rulersoption, which can be used to show + one or more vertical rulers in the editor. The option, if + defined, should be given an array of{column [, className, + color, lineStyle, width]}objects or numbers (which + indicate a column). The ruler will be displayed at the column + indicated by the number or thecolumnproperty. + TheclassNameproperty can be used to assign a + custom style to a ruler. Demo + here.
+
+ display/panel.js
+ - Defines an
addPanelmethod for CodeMirror + instances, which places a DOM node above or below an editor, and + shrinks the editor to make room for the node. The method takes + as first argument as DOM node, and as second an optional options + object. ThePanelobject returned by this method + has aclearmethod that is used to remove the + panel, and achangedmethod that can be used to + notify the addon when the size of the panel's DOM node has + changed.
+ The method accepts the following options: +-
+
position: string
+ - Controls the position of the newly added panel. The
+ following values are recognized:
+
-
+
top (default)
+ - Adds the panel at the very top. +
after-top
+ - Adds the panel at the bottom of the top panels. +
bottom
+ - Adds the panel at the very bottom. +
before-bottom
+ - Adds the panel at the top of the bottom panels. +
+ before: Panel
+ - The new panel will be added before the given panel. +
after: Panel
+ - The new panel will be added after the given panel. +
replace: Panel
+ - The new panel will replace the given panel. +
stable: bool
+ - Whether to scroll the editor to keep the text's vertical + position stable, when adding a panel above it. Defaults to false. +
after,beforeorreplaceoptions, + if the panel doesn't exists or has been removed, + the value of thepositionoption will be used as a fallback. +
+ A demo of the addon is available here. +
+
+ wrap/hardwrap.js
+ - Addon to perform hard line wrapping/breaking for paragraphs
+ of text. Adds these methods to editor instances:
+
-
+
wrapParagraph(?pos: {line, ch}, ?options: object)
+ - Wraps the paragraph at the given position.
+ If
posis not given, it defaults to the cursor + position.
+ wrapRange(from: {line, ch}, to: {line, ch}, ?options: object)
+ - Wraps the given range as one big paragraph. +
wrapParagraphsInRange(from: {line, ch}, to: {line, ch}, ?options: object)
+ - Wraps the paragraphs in (and overlapping with) the + given range individually. +
-
+
paragraphStart, paragraphEnd: RegExp
+ - Blank lines are always considered paragraph boundaries. + These options can be used to specify a pattern that causes + lines to be considered the start or end of a paragraph. +
column: number
+ - The column to wrap at. Defaults to 80. +
wrapOn: RegExp
+ - A regular expression that matches only those + two-character strings that allow wrapping. By default, the + addon wraps on whitespace and after dash characters. +
killTrailingSpace: boolean
+ - Whether trailing space caused by wrapping should be + preserved, or deleted. Defaults to true. +
+
+ merge/merge.js
+ - Implements an interface for merging changes, using either a
+ 2-way or a 3-way view. The
CodeMirror.MergeView+ constructor takes arguments similar to + theCodeMirror+ constructor, first a node to append the interface to, and then + an options object. Options are passed through to the editors + inside the view. These extra options are recognized: +-
+
origLeftandorigRight: string
+ - If given these provide original versions of the + document, which will be shown to the left and right of the + editor in non-editable CodeMirror instances. The merge + interface will highlight changes between the editable + document and the original(s). To create a 2-way (as opposed + to 3-way) merge view, provide only one of them. +
revertButtons: boolean
+ - Determines whether buttons that allow the user to revert + changes are shown. Defaults to true. +
revertChunk: fn(mv: MergeView, from: CodeMirror, fromStart: Pos, fromEnd: Pos, to: CodeMirror, toStart: Pos, toEnd: Pos)
+ - Can be used to define custom behavior when the user + reverts a changed chunk. +
connect: string
+ - Sets the style used to connect changed chunks of code.
+ By default, connectors are drawn. When this is set
+ to
"align", the smaller chunk is padded to + align with the bigger chunk instead.
+ collapseIdentical: boolean|number
+ - When true (default is false), stretches of unchanged + text will be collapsed. When a number is given, this + indicates the amount of lines to leave visible around such + stretches (which defaults to 2). +
allowEditingOriginals: boolean
+ - Determines whether the original editor allows editing. + Defaults to false. +
showDifferences: boolean
+ - When true (the default), changed pieces of text are + highlighted. +
chunkClassLocation: string|Array
+ - By default the chunk highlights are added
+ using
addLineClass+ with "background". Override this to customize it to be any + valid `where` parameter or an Array of valid `where` + parameters.
+
"goNextDiff"+ and"goPrevDiff"to quickly jump to the next + changed chunk. Demo + here.
+
+ tern/tern.js
+ - Provides integration with + the Tern JavaScript analysis + engine, for completion, definition finding, and minor + refactoring help. See the demo + for a very simple integration. For more involved scenarios, see + the comments at the top of + the addon and the + implementation of the + (multi-file) demonstration + on the Tern website. +
Writing CodeMirror Modes
+ +Modes typically consist of a single JavaScript file. This file + defines, in the simplest case, a lexer (tokenizer) for your + language—a function that takes a character stream as input, + advances it past a token, and returns a style for that token. More + advanced modes can also handle indentation for the language.
+ +This section describes the low-level mode interface. Many modes + are written directly against this, since it offers a lot of + control, but for a quick mode definition, you might want to use + the simple mode addon.
+ +The mode script should
+ call CodeMirror.defineMode to
+ register itself with CodeMirror. This function takes two
+ arguments. The first should be the name of the mode, for which you
+ should use a lowercase string, preferably one that is also the
+ name of the files that define the mode (i.e. "xml" is
+ defined in xml.js). The second argument should be a
+ function that, given a CodeMirror configuration object (the thing
+ passed to the CodeMirror function) and an optional
+ mode configuration object (as in
+ the mode option), returns
+ a mode object.
Typically, you should use this second argument
+ to defineMode as your module scope function (modes
+ should not leak anything into the global scope!), i.e. write your
+ whole mode inside this function.
The main responsibility of a mode script is parsing + the content of the editor. Depending on the language and the + amount of functionality desired, this can be done in really easy + or extremely complicated ways. Some parsers can be stateless, + meaning that they look at one element (token) of the code + at a time, with no memory of what came before. Most, however, will + need to remember something. This is done by using a state + object, which is an object that is always passed when + reading a token, and which can be mutated by the tokenizer.
+ +Modes that use a state must define
+ a startState method on their mode
+ object. This is a function of no arguments that produces a state
+ object to be used at the start of a document.
The most important part of a mode object is
+ its token(stream, state) method. All
+ modes must define this method. It should read one token from the
+ stream it is given as an argument, optionally update its state,
+ and return a style string, or null for tokens that do
+ not have to be styled. For your styles, you are encouraged to use
+ the 'standard' names defined in the themes (without
+ the cm- prefix). If that fails, it is also possible
+ to come up with your own and write your own CSS theme file.
+ +
A typical token string would
+ be "variable" or "comment". Multiple
+ styles can be returned (separated by spaces), for
+ example "string error" for a thing that looks like a
+ string but is invalid somehow (say, missing its closing quote).
+ When a style is prefixed by "line-"
+ or "line-background-", the style will be applied to
+ the whole line, analogous to what
+ the addLineClass method
+ does—styling the "text" in the simple case, and
+ the "background" element
+ when "line-background-" is prefixed.
The stream object that's passed
+ to token encapsulates a line of code (tokens may
+ never span lines) and our current position in that line. It has
+ the following API:
-
+
eol() → boolean
+ - Returns true only if the stream is at the end of the + line. +
sol() → boolean
+ - Returns true only if the stream is at the start of the + line. + +
peek() → string
+ - Returns the next character in the stream without advancing
+ it. Will return a
nullat the end of the + line.
+ next() → string
+ - Returns the next character in the stream and advances it.
+ Also returns
nullwhen no more characters are + available.
+
+ eat(match: string|regexp|function(char: string) → boolean) → string
+ matchcan be a character, a regular expression, + or a function that takes a character and returns a boolean. If + the next character in the stream 'matches' the given argument, + it is consumed and returned. Otherwise,undefined+ is returned.
+ eatWhile(match: string|regexp|function(char: string) → boolean) → boolean
+ - Repeatedly calls
eatwith the given argument, + until it fails. Returns true if any characters were eaten.
+ eatSpace() → boolean
+ - Shortcut for
eatWhilewhen matching + white-space.
+ skipToEnd()
+ - Moves the position to the end of the line. +
skipTo(str: string) → boolean
+ - Skips to the start of the next occurrence of the given string, if + found on the current line (doesn't advance the stream if the + string does not occur on the line). Returns true if the + string was found. +
match(pattern: string, ?consume: boolean, ?caseFold: boolean) → boolean
+ match(pattern: regexp, ?consume: boolean) → array<string>
+ - Act like a
+ multi-character
eat—ifconsumeis true + or not given—or a look-ahead that doesn't update the stream + position—if it is false.patterncan be either a + string or a regular expression starting with^. + When it is a string,caseFoldcan be set to true to + make the match case-insensitive. When successfully matching a + regular expression, the returned value will be the array + returned bymatch, in case you need to extract + matched groups.
+
+ backUp(n: integer)
+ - Backs up the stream
ncharacters. Backing it up + further than the start of the current token will cause things to + break, so be careful.
+ column() → integer
+ - Returns the column (taking into account tabs) at which the + current token starts. +
indentation() → integer
+ - Tells you how far the current line has been indented, in + spaces. Corrects for tab characters. + +
current() → string
+ - Get the string between the start of the current token and + the current stream position. + +
lookAhead(n: number) → ?string
+ - Get the line
n(>0) lines after the current + one, in order to scan ahead across line boundaries. Note that + you want to do this carefully, since looking far ahead will make + mode state caching much less effective.
+
+ baseToken() → ?{type: ?string, size: number}
+ - Modes added
+ through
addOverlay+ (and only such modes) can use this method to inspect + the current token produced by the underlying mode.
+
By default, blank lines are simply skipped when
+ tokenizing a document. For languages that have significant blank
+ lines, you can define
+ a blankLine(state) method on your
+ mode that will get called whenever a blank line is passed over, so
+ that it can update the parser state.
Because state object are mutated, and CodeMirror
+ needs to keep valid versions of a state around so that it can
+ restart a parse at any line, copies must be made of state objects.
+ The default algorithm used is that a new state object is created,
+ which gets all the properties of the old object. Any properties
+ which hold arrays get a copy of these arrays (since arrays tend to
+ be used as mutable stacks). When this is not correct, for example
+ because a mode mutates non-array properties of its state object, a
+ mode object should define
+ a copyState method, which is given a
+ state and should return a safe copy of that state.
If you want your mode to provide smart indentation
+ (through the indentLine
+ method and the indentAuto
+ and newlineAndIndent commands, to which keys can be
+ bound), you must define
+ an indent(state, textAfter) method
+ on your mode object.
The indentation method should inspect the given state object,
+ and optionally the textAfter string, which contains
+ the text on the line that is being indented, and return an
+ integer, the amount of spaces to indent. It should usually take
+ the indentUnit
+ option into account. An indentation method may
+ return CodeMirror.Pass to indicate that it
+ could not come up with a precise indentation.
To work well with
+ the commenting addon, a mode may
+ define lineComment (string that
+ starts a line
+ comment), blockCommentStart, blockCommentEnd
+ (strings that start and end block comments),
+ and blockCommentLead (a string to put at the start of
+ continued lines in a block comment). All of these are
+ optional.
Finally, a mode may define either
+ an electricChars or an electricInput
+ property, which are used to automatically reindent the line when
+ certain patterns are typed and
+ the electricChars
+ option is enabled. electricChars may be a string, and
+ will trigger a reindent whenever one of the characters in that
+ string are typed. Often, it is more appropriate to
+ use electricInput, which should hold a regular
+ expression, and will trigger indentation when the part of the
+ line before the cursor matches the expression. It should
+ usually end with a $ character, so that it only
+ matches when the indentation-changing pattern was just typed, not when something was
+ typed after the pattern.
So, to summarize, a mode must provide
+ a token method, and it may
+ provide startState, copyState,
+ and indent methods. For an example of a trivial mode,
+ see the diff mode, for a more
+ involved example, see the C-like
+ mode.
Sometimes, it is useful for modes to nest—to have one
+ mode delegate work to another mode. An example of this kind of
+ mode is the mixed-mode HTML
+ mode. To implement such nesting, it is usually necessary to
+ create mode objects and copy states yourself. To create a mode
+ object, there are CodeMirror.getMode(options,
+ parserConfig), where the first argument is a configuration
+ object as passed to the mode constructor function, and the second
+ argument is a mode specification as in
+ the mode option. To copy a
+ state object, call CodeMirror.copyState(mode, state),
+ where mode is the mode that created the given
+ state.
In a nested mode, it is recommended to add an
+ extra method, innerMode which, given
+ a state object, returns a {state, mode} object with
+ the inner mode and its state for the current position. These are
+ used by utility scripts such as the tag
+ closer to get context information. Use
+ the CodeMirror.innerMode helper function to, starting
+ from a mode and a state, recursively walk down to the innermost
+ mode and state.
To make indentation work properly in a nested parser, it is
+ advisable to give the startState method of modes that
+ are intended to be nested an optional argument that provides the
+ base indentation for the block of code. The JavaScript and CSS
+ parser do this, for example, to allow JavaScript and CSS code
+ inside the mixed-mode HTML mode to be properly indented.
It is possible, and encouraged, to associate
+ your mode, or a certain configuration of your mode, with
+ a MIME type. For
+ example, the JavaScript mode associates itself
+ with text/javascript, and its JSON variant
+ with application/json. To do this,
+ call CodeMirror.defineMIME(mime,
+ modeSpec), where modeSpec can be a string or
+ object specifying a mode, as in
+ the mode option.
If a mode specification wants to add some properties to the
+ resulting mode object, typically for use
+ with getHelpers, it may
+ contain a modeProps property, which holds an object.
+ This object's properties will be copied to the actual mode
+ object.
Sometimes, it is useful to add or override mode
+ object properties from external code.
+ The CodeMirror.extendMode function
+ can be used to add properties to mode objects produced for a
+ specific mode. Its first argument is the name of the mode, its
+ second an object that specifies the properties that should be
+ added. This is mostly useful to add utilities that can later be
+ looked up through getMode.
VIM Mode API
+ +CodeMirror has a robust VIM mode that attempts to faithfully
+ emulate VIM's most useful features. It can be enabled by
+ including keymap/vim.js
+ and setting the keyMap option to
+ "vim".
Configuration
+ +VIM mode accepts configuration options for customizing
+ behavior at run time. These methods can be called at any time
+ and will affect all existing CodeMirror instances unless
+ specified otherwise. The methods are exposed on the
+ CodeMirror.Vim object.
-
+
setOption(name: string, value: any, ?cm: CodeMirror, ?cfg: object)
+ - Sets the value of a VIM option.
nameshould + be the name of an option. Ifcfg.scopeis not set + andcmis provided, then sets the global and + instance values of the option. Otherwise, sets either the + global or instance value of the option depending on whether +cfg.scopeisglobalor +local.
+ getOption(name: string, ?cm: CodeMirror: ?cfg: object)
+ - Gets the current value of a VIM option. If
+
cfg.scopeis not set andcmis + provided, then gets the instance value of the option, falling + back to the global value if not set. Ifcfg.scopeis provided, then gets theglobalor +localvalue without checking the other.
+
+ map(lhs: string, rhs: string, ?context: string)
+ - Maps a key sequence to another key sequence. Implements
+ VIM's
:mapcommand. To map ; to : in VIM would be +:map ; :. That would translate to +CodeMirror.Vim.map(';', ':');. + Thecontextcan benormal, +visual, orinsert, which correspond + to:nmap,:vmap, and +:imap+ respectively.
+
+ mapCommand(keys: string, type: string, name: string, ?args: object, ?extra: object)
+ - Maps a key sequence to a
motion, +operator, oractiontype command. + The args object is passed through to the command when it is + invoked by the provided key sequence. +extras.contextcan benormal, +visual, orinsert, to map the key + sequence only in the corresponding mode. +extras.isEditis applicable only to actions, + determining whether it is recorded for replay for the +.single-repeat command. +
Extending VIM
+ +CodeMirror's VIM mode implements a large subset of VIM's core
+ editing functionality. But since there's always more to be
+ desired, there is a set of APIs for extending VIM's
+ functionality. As with the configuration API, the methods are
+ exposed on CodeMirror.Vim and may
+ be called at any time.
-
+
defineOption(name: string, default: any, type: string, ?aliases: array<string>, ?callback: function (?value: any, ?cm: CodeMirror) → ?any)
+ - Defines a VIM style option and makes it available to the
+
:setcommand. Type can bebooleanor +string, used for validation and by +:setto determine which syntax to accept. If a +callbackis passed in, VIM does not store the value of the + option itself, but instead uses the callback as a setter/getter. If the + first argument to the callback isundefined, then the + callback should return the value of the option. Otherwise, it should set + instead. Since VIM options have global and instance values, whether a +CodeMirrorinstance is passed in denotes whether the global + or local value should be used. Consequently, it's possible for the + callback to be called twice for a singlesetOptionor +getOptioncall. Note that right now, VIM does not support + defining buffer-local options that do not have global values. If an + option should not have a global value, either always ignore the +cmparameter in the callback, or always pass in a +cfg.scopetosetOptionand +getOption.
+
+ defineMotion(name: string, fn: function(cm: CodeMirror, head: {line, ch}, ?motionArgs: object}) → {line, ch})
+ - Defines a motion command for VIM. The motion should return
+ the desired result position of the cursor.
head+ is the current position of the cursor. It can differ from +cm.getCursor('head')if VIM is in visual mode. +motionArgsis the object passed into +mapCommand().
+
+ defineOperator(name: string, fn: function(cm: CodeMirror, ?operatorArgs: object, ranges: array<{anchor, head}>) → ?{line, ch})
+ - Defines an operator command, similar to
+ defineMotion.rangesis the range + of text the operator should operate on. If the cursor should + be set to a certain position after the operation finishes, it + can return a cursor object.
+
+ defineAction(name: string, fn: function(cm: CodeMirror, ?actionArgs: object))
+ - Defines an action command, similar to
+
defineMotion. Action commands + can have arbitrary behavior, making them more flexible than + motions and operators, at the loss of orthogonality.
+
+ defineEx(name: string, ?prefix: string, fn: function(cm: CodeMirror, ?params: object))
+ - Defines an Ex command, and maps it to
:name. + If a prefix is provided, it, and any prefixed substring of the +namebeginning with theprefixcan + be used to invoke the command. If theprefixis + falsy, thennameis used as the prefix.+ params.argStringcontains the part of the prompted + string after the command name.params.argsis +params.argStringsplit by whitespace. If the + command was prefixed with a +line range, +params.lineandparams.lineEndwill + be set. +
CodeMirror real-world uses
+ +Create a pull + request if you'd like your project to be added to this list.
+ +-
+
- Adobe Brackets (code editor) +
- ALM Tools (TypeScript powered IDE) +
- Amber (JavaScript-based Smalltalk system) +
- APEye (tool for testing & documenting APIs) +
- Appengine Codiad +
- Better Text Viewer (plain text reader app for Chrome) +
- Bitbucket (code hosting) +
- Blogger's theme editor +
- BlueGriffon (HTML editor) +
- Boson Editor (code editor) +
- Cargo Collective (creative publishing platform) +
- Chrome DevTools +
- ClickHelp (technical writing tool) +
- CodeWorld (Haskell playground) +
- Complete.ly playground +
- Codeanywhere (multi-platform cloud editor) +
- Code per Node (Drupal module) +
- CodeBitt (Code snippet sharing) +
- Codebug (PHP Xdebug front-end) +
- CodeFights (practice programming) +
- CodeMirror Eclipse (embed CM in Eclipse) +
- CodeMirror movie (scripted editing demos) +
- CodeMirror2-GWT (Google Web Toolkit wrapper) +
- Code Monster & Code Maven (learning environment) +
- Codepen (gallery of animations) +
- Coderpad (interviewing tool) +
- Code School (online tech learning environment) +
- Code Snippets (WordPress snippet management plugin) +
- Code together (collaborative editing) +
- Codev (collaborative IDE) +
- Codevolve (programming lessons as-a-service) +
- CodeZample (code snippet sharing) +
- Codio (Web IDE) +
- Codiva.io (Online Java Compiler and IDE with auto-completion and error highlighting) +
- Community Code Camp (code snippet sharing) +
- compilejava.net (online Java sandbox) +
- CKWNC (UML editor) +
- CrossUI (cross-platform UI builder) +
- Cruncher (notepad with calculation features) +
- Crudzilla (self-hosted web IDE) +
- CSSDeck (CSS showcase) +
- Deck.js integration (slides with editors) +
- DbNinja (MySQL access interface) +
- eCSSpert (CSS demos and experiments) +
- Elm language examples +
- Eloquent JavaScript (book) +
- Emmet (fast XML editing) +
- Espruino Web IDE (Chrome App for writing code on Espruino devices) +
- Fastfig (online computation/math tool) +
- Farabi (modern Perl IDE) +
- FathomJS integration (slides with editors, again) +
- Fiddle Salad (web development environment) +
- Filemanager +
- Firefox Developer Tools +
- Firepad (collaborative text editor) +
- Gerrit's diff view and inline editor +
- Git Crx (Chrome App for browsing local git repos) +
- GitHub's Android app +
- Github's in-browser edit feature +
- Glitch (community-driven app building) +
- Go language tour +
- Google Apps Script +
- Graphit (function graphing) +
- HackMD (Realtime collaborative markdown notes on all platforms) +
- Handcraft (HTML prototyping) +
- Hawkee +
- Haxe (Haxe Playground) +
- HaxPad (editor for Win RT) +
- Histone template engine playground +
- Homegenie (home automation server) +
- ICEcoder (web IDE) +
- IPython (interactive computing shell) +
- iTrading (Algorithmic Trading) +
- i-MOS (modeling and simulation platform) +
- Janvas (vector graphics editor) +
- Joomla plugin +
- jQuery fundamentals (interactive tutorial) +
- jsbin.com (JS playground) +
- JSER preprocessor +
- jscpd (code duplication detector) +
- JSFiddle (another JS playground) +
- JSHint (JS linter) +
- Jumpseller (online store builder) +
- kl1p (paste service) +
- Kodit +
- Kodtest (HTML/JS/CSS playground) +
- Kotlin (web-based mini-IDE for Kotlin) +
- Light Table (experimental IDE) +
- Liveweave (HTML/CSS/JS scratchpad) +
- Markdown Delight Editor (extensible markdown editor polymer component) +
- Marklight editor (lightweight markup editor) +
- Mergely (interactive diffing) +
- MIHTool (iOS web-app debugging tool) +
- mscgen_js (online sequence chart editor) +
- MVC Playground +
- Navigate CMS +
- nodeMirror (IDE project) +
- NoTex (rST authoring) +
- nteract (interactive literate coding notebook) +
- Oak (online outliner) +
- OpenCampus +
- ORG (z80 assembly IDE) +
- Orion-CodeMirror integration (running CodeMirror modes in Orion) +
- Paper.js (graphics scripting) +
- Pharaoh (browser & desktop editor for the classroom) +
- PrinBit (collaborative coding tool) +
- Prose.io (github content editor) +
- PubliForge (online publishing system) +
- Puzzlescript (puzzle game engine) +
- Quantum (code editor for Chrome OS) +
- Qt+Webkit integration (building a desktop CodeMirror app) +
- Quivive File Manager +
- Rascal (tiny computer) +
- RealTime.io (Internet-of-Things infrastructure) +
- Refork (animation demo gallery and sharing) +
- SageMathCell (interactive mathematical software) +
- SageMathCloud (interactive mathematical software environment) +
- ServePHP (PHP code testing in Chrome dev tools) +
- Scastie (Scala playground) +
- Shadertoy (shader sharing) +
- sketchPatch Livecodelab +
- Skulpt (in-browser Python environment) +
- SourceLair (in-browser IDE for Django, Node.js, PHP and HTML5) +
- Snap Tomato (HTML editing/testing page) +
- Snippets.pro (code snippet sharing) +
- SolidShops (hosted e-commerce platform) +
- SourceCoder 3 (online calculator IDE and editor) +
- SQLFiddle (SQL playground) +
- SubTe (AI bot programming environment) +
- Structure and Interpretation of Computer Programs, Interactive Version +
- SyBox (PHP playground) +
- TagSpaces (personal data manager) +
- Textbox.io (WYSIWYG rich text editor) +
- The File Tree (collab editor) +
- TileMill (map design tool) +
- Tiki (wiki CMS groupware) +
- Toolsverse Data Explorer (database management) +
- Tumblr code highlighting shim +
- TurboPY (web publishing framework) +
- UmpleOnline (model-oriented programming tool) +
- Upsource (code browser and review tool) +
- Waliki (wiki engine) +
- Wamer (web application builder) +
- webappfind (windows file bindings for webapps) +
- WebGL academy (learning WebGL) +
- WebGL playground +
- WebKit Web inspector +
- WeScheme (learning tool) +
- Wide (golang web IDE) +
- WordPress plugin +
- writeLaTeX (Collaborative LaTeX Editor) +
- XOSide (online editor) +
- XQuery tester +
- xsd2codemirror (convert XSD to CM XML completion info) +
- Yacas Online (interactive mathematical software) +
+
+
+
+
+
+CodeMirror
+
+
+ -
+
- Version 5.x +
- Version 4.x +
- Version 3.x +
- Version 2.x +
- Version 0.x +
Release notes and version history
+ +Version 5.x
+ +22-11-2017: Version 5.32.0:
+ +-
+
- Increase contrast on default bracket-matching colors. +
- javascript mode: Recognize TypeScript type parameters for calls, type guards, and type parameter defaults. Improve handling of
enumandmodulekeywords.
+ - comment addon: Fix bug when uncommenting a comment that spans all but the last selected line. +
- searchcursor addon: Fix bug in case folding. +
- emacs bindings: Prevent single-character deletions from resetting the kill ring. +
- closebrackets addon: Tweak quote matching behavior. +
- continuelist addon: Increment ordered list numbers when adding one. +
20-10-2017: Version 5.31.0:
+ +-
+
- Modes added with
addOverlaynow have access to abaseTokenmethod on their input stream, giving access to the tokens of the underlying mode.
+ - Further improve selection drawing and cursor motion in right-to-left documents. +
- vim bindings: Fix ctrl-w behavior, support quote-dot and backtick-dot marks, make the wide cursor visible in contentEditable input mode. +
- continuecomment addon: Fix bug when pressing enter after a single-line block comment. +
- markdown mode: Fix issue with leaving indented fenced code blocks. +
- javascript mode: Fix bad parsing of operators without spaces between them. Fix some corner cases around semicolon insertion and regexps. +
20-09-2017: Version 5.30.0:
+ +-
+
- Fixed a number of issues with drawing right-to-left selections and mouse selection in bidirectional text. +
- search addon: Fix crash when restarting search after doing empty search. +
- mark-selection addon: Fix off-by-one bug. +
- tern addon: Fix bad request made when editing at the bottom of a large document. +
- javascript mode: Improve parsing in a number of corner cases. +
- markdown mode: Fix crash when a sub-mode doesn't support indentation, allow uppercase X in task lists. +
- gfm mode: Don't highlight SHA1 'hashes' without numbers to avoid false positives. +
- soy mode: Support injected data and
@paramin comments.
+ - simple mode addon: Allow groups in regexps when
tokenisn't an array.
+
24-08-2017: Version 5.29.0:
+ +-
+
- Fix crash in contentEditable input style when editing near a bookmark. +
- Make sure change origins are preserved when splitting changes on read-only marks. +
- javascript mode: More support for TypeScript syntax. +
- d mode: Support nested comments. +
- python mode: Improve tokenizing of operators. +
- markdown mode: Further improve CommonMark conformance. +
- css mode: Don't run comment tokens through the mode's state machine. +
- shell mode: Allow strings to span lines. +
- search addon: Fix crash in persistent search when
extraKeysis null.
+
21-07-2017: Version 5.28.0:
+ +-
+
- Fix copying of, or replacing editor content with, a single dash character when copying a big selection in some corner cases. +
- Make
"goLineLeft"/"goLineRight"behave better on wrapped lines.
+ - sql mode: Fix tokenizing of multi-dot operator and allow digits in subfield names. +
- searchcursor addon: Fix infinite loop on some composed character inputs. +
- markdown mode: Make list parsing more CommonMark-compliant. +
- gfm mode: Highlight colon syntax for emoji. +
29-06-2017: Version 5.27.4:
+ +-
+
- Fix crash when using mode lookahead. +
- markdown mode: Don't block inner mode's indentation support. +
22-06-2017: Version 5.27.2:
+ +-
+
- Fix crash in the simple mode addon. +
22-06-2017: Version 5.27.0:
+ +-
+
- Fix infinite loop in forced display update. +
- Properly disable the hidden textarea when
readOnlyis"nocursor".
+ - Calling the
Docconstructor withoutnewworks again.
+ - sql mode: Handle nested comments. +
- javascript mode: Improve support for TypeScript syntax. +
- markdown mode: Fix bug where markup was ignored on indented paragraph lines. +
- vim bindings: Referencing invalid registers no longer causes an uncaught exception. +
- rust mode: Add the correct MIME type. +
- matchbrackets addon: Document options. +
- Mouse button clicks can now be bound in keymaps by using names like
"LeftClick"or"Ctrl-Alt-MiddleTripleClick". When bound to a function, that function will be passed the position of the click as second argument.
+ - The behavior of mouse selection and dragging can now be customized with the
configureMouseoption.
+ - Modes can now look ahead across line boundaries with the
StringStream.lookaheadmethod.
+ - Introduces a
"type"token type, makes modes that recognize types output it, and add styling for it to the themes.
+ - New
pasteLinesPerSelectionoption to control the behavior of pasting multiple lines into multiple selections.
+ - searchcursor addon: Support multi-line regular expression matches, and normalize strings when matching. +
22-05-2017: Version 5.26.0:
+ +-
+
- In textarea-mode, don't reset the input field during composition. +
- More careful restoration of selections in widgets, during editor redraw. +
- vim bindings: Parse line offsets in line or range specs. +
- javascript mode: More TypeScript parsing fixes. +
- julia mode: Fix issue where the mode gets stuck. +
- markdown mode: Understand cross-line links, parse all bracketed things as links. +
- soy mode: Support single-quoted strings. +
- go mode: Don't try to indent inside strings or comments. +
20-04-2017: Version 5.25.2:
+ +-
+
- Better handling of selections that cover the whole viewport in contentEditable-mode. +
- No longer accidentally scroll the editor into view when calling
setValue.
+ - Work around Chrome Android bug when converting screen coordinates to editor positions. +
- Make sure long-clicking a selection sets a cursor and doesn't show the editor losing focus. +
- Fix issue where pointer events were incorrectly disabled on Chrome's overlay scrollbars. +
- javascript mode: Recognize annotations and TypeScript-style type parameters. +
- shell mode: Handle nested braces. +
- markdown mode: Make parsing of strong/em delimiters CommonMark-compliant. +
20-03-2017: Version 5.25.0:
+ +-
+
- In contentEditable-mode, properly locate changes that repeat a character when inserted with IME. +
- Fix handling of selections bigger than the viewport in contentEditable mode. +
- Improve handling of changes that insert or delete lines in contentEditable mode. +
- Count Unicode control characters 0x80 to 0x9F as special (non-printing) chars. +
- Fix handling of shadow DOM roots when finding the active element. +
- Add
role=presentationto more DOM elements to improve screen reader support.
+ - merge addon: Make aligning of unchanged chunks more robust. +
- comment addon: Fix comment-toggling on a block of text that starts and ends in a (differnet) block comment. +
- javascript mode: Improve support for TypeScript syntax. +
- r mode: Fix indentation after semicolon-less statements. +
- shell mode: Properly handle escaped parentheses in parenthesized expressions. +
- markdown mode: Fix a few bugs around leaving fenced code blocks. +
- soy mode: Improve indentation. +
- lint addon: Support asynchronous linters that return promises. +
- continuelist addon: Support continuing task lists. +
- vim bindings: Make Y behave like yy. +
- sql mode: Support sqlite dialect. +
22-02-2017: Version 5.24.2:
+ +-
+
- javascript mode: Support computed class method names. +
- merge addon: Improve aligning of unchanged code in the presence of marks and line widgets. +
20-02-2017: Version 5.24.0:
+ +-
+
- Positions now support a
stickyproperty which determines whether they should be associated with the character before (value"before") or after (value"after") them.
+ - vim bindings: Make it possible to remove built-in bindings through the API. +
- comment addon: Support a per-mode
useInnerCommentsoption to optionally suppress descending to the inner modes to get comment strings.
+ - A cursor directly before a line-wrapping break is now drawn before or after the line break depending on which direction you arrived from. +
- Visual cursor motion in line-wrapped right-to-left text should be much more correct. +
- Fix bug in handling of read-only marked text. +
- shell mode: Properly tokenize nested parentheses. +
- python mode: Support underscores in number literals. +
- sass mode: Uses the full list of CSS properties and keywords from the CSS mode, rather than defining its own incomplete subset. Now depends on the css mode. +
- css mode: Expose
lineCommentproperty for LESS and SCSS dialects. Recognize vendor prefixes on pseudo-elements.
+ - julia mode: Properly indent
elseiflines.
+ - markdown mode: Properly recognize the end of fenced code blocks when inside other markup. +
- scala mode: Improve handling of operators containing
#,@, and:chars.
+ - xml mode: Allow dashes in HTML tag names. +
- javascript mode: Improve parsing of async methods, TypeScript-style comma-separated superclass lists. +
- indent-fold addon: Ignore comment lines. +
19-01-2017: Version 5.23.0:
+ +-
+
- Presentation-related elements DOM elements are now marked as such to help screen readers. +
- markdown mode: Be more picky about what HTML tags look like to avoid false positives. +
findModeByMIMEnow understands+jsonand+xmlMIME suffixes.
+ - closebrackets addon: Add support for an
overrideoption to ignore language-specific defaults.
+ - panel addon: Add a
stableoption that auto-scrolls the content to keep it in the same place when inserting/removing a panel.
+
20-12-2016: Version 5.22.0:
+ +-
+
- sublime bindings: Make
selectBetweenBracketswork with multiple cursors.
+ - javascript mode: Fix issues with parsing complex TypeScript types, imports, and exports. +
- A contentEditable editor instance with autofocus enabled no longer crashes during initializing. +
- emacs bindings: Export
CodeMirror.emacsto allow other addons to hook into Emacs-style functionality.
+ - active-line addon: Add
nonEmptyoption.
+ - New event:
optionChange.
+
21-11-2016: Version 5.21.0:
+ +-
+
- Tapping/clicking the editor in contentEditable mode on Chrome now puts the cursor at the tapped position. +
- Fix various crashes and misbehaviors when reading composition events in contentEditable mode. +
- Catches and ignores an IE 'Unspecified Error' when creating an editor in an iframe before there is a
<body>.
+ - merge addon: Fix several issues in the chunk-aligning feature. +
- verilog mode: Rewritten to address various issues. +
- julia mode: Recognize Julia 0.5 syntax. +
- swift mode: Various fixes and adjustments to current syntax. +
- markdown mode: Allow lists without a blank line above them. +
- The
setGutterMarker,clearGutter, andlineInfomethods are now available onDocobjects.
+ - The
heightAtLinemethod now takes an extra argument to allow finding the height at the top of the line's line widgets.
+ - ruby mode:
elseandelsifare now immediately indented.
+ - vim bindings: Bind Ctrl-T and Ctrl-D to in- and dedent in insert mode. +
20-10-2016: Version 5.20.0:
+ +-
+
- Make
newlineAndIndentcommand work with multiple cursors on the same line.
+ - Make sure keypress events for backspace are ignored. +
- Tokens styled with overlays no longer get a nonsense
cm-cm-overlayclass.
+ - Line endings for pasted content are now normalized to the editor's preferred ending. +
- javascript mode: Improve support for class expressions. Support TypeScript optional class properties, the
abstractkeyword, and return type declarations for arrow functions.
+ - css mode: Fix highlighting of mixed-case keywords. +
- closebrackets addon: Improve behavior when typing a quote before a string. +
- The core is now maintained as a number of small files, using ES6 syntax and modules, under the
src/directory. A git checkout no longer contains a workingcodemirror.jsuntil younpm build(but when installing from NPM, it is included).
+ - The
refreshevent is now documented and stable.
+
20-09-2016: Version 5.19.0:
+ +-
+
- erlang mode: Fix mode crash when trying to read an empty context. +
- comment addon: Fix broken behavior when toggling comments inside a comment. +
- xml-fold addon: Fix a null-dereference bug. +
- Page up and page down now do something even in single-line documents. +
- Fix an issue where the cursor position could be off in really long (~8000 character) tokens. +
- javascript mode: Better indentation when semicolons are missing. Better support for TypeScript classes, optional parameters, and the
typekeyword.
+ - The
blurandfocusevents now pass the DOM event to their handlers.
+
23-08-2016: Version 5.18.2:
+ +-
+
- vue mode: Fix outdated references to renamed Pug mode dependency. +
22-08-2016: Version 5.18.0:
+ +-
+
- Make sure gutter backgrounds stick to the rest of the gutter during horizontal scrolling. +
- The contenteditable
inputStylenow properly supports pasting on pre-Edge IE versions.
+ - javascript mode: Fix some small parsing bugs and improve TypeScript support. +
- matchbrackets addon: Fix bug where active highlighting was left in editor when the addon was disabled. +
- match-highlighter addon: Only start highlighting things when the editor gains focus. +
- javascript-hint addon: Also complete non-enumerable properties. +
- The
addOverlaymethod now supports apriorityoption to control the order in which overlays are applied.
+ - MIME types that end in
+jsonnow default to the JSON mode when the MIME itself is not defined.
+ - The mode formerly known as Jade was renamed to Pug. +
- The Python mode now defaults to Python 3 (rather than 2) syntax. +
19-07-2016: Version 5.17.0:
+ +-
+
- Fix problem with wrapped trailing whitespace displaying incorrectly. +
- Prevent IME dialog from overlapping typed content in Chrome. +
- Improve measuring of characters near a line wrap. +
- javascript mode: Improve support for
async, allow trailing commas inimportlists.
+ - vim bindings: Fix backspace in replace mode. +
- sublime bindings: Fix some key bindings on OS X to match Sublime Text. +
- markdown mode: Add more classes to image links in highlight-formatting mode. +
20-06-2016: Version 5.16.0:
+ +-
+
- Fix glitches when dragging content caused by the drop indicator receiving mouse events. +
- Make Control-drag work on Firefox. +
- Make clicking or selection-dragging at the end of a wrapped line select the right position. +
- show-hint addon: Prevent widget scrollbar from hiding part of the hint text. +
- rulers addon: Prevent rulers from forcing a horizontal editor scrollbar. +
- search addon: Automatically bind search-related keys in persistent dialog. +
- sublime keymap: Add a multi-cursor aware smart backspace binding. +
20-05-2016: Version 5.15.2:
+ +-
+
- Fix a critical document corruption bug that occurs when a document is gradually grown. +
20-05-2016: Version 5.15.0:
+ +-
+
- Fix bug that caused the selection to reset when focusing the editor in contentEditable input mode. +
- Fix issue where not all ASCII control characters were being replaced by placeholders. +
- Remove the assumption that all modes have a
startStatemethod from several wrapping modes.
+ - Fix issue where the editor would complain about overlapping collapsed ranges when there weren't any. +
- Optimize document tree building when loading or pasting huge chunks of content. +
- Explicitly bind Ctrl-O on OS X to make that binding (“open line”) act as expected. +
- Pasting linewise-copied content when there is no selection now inserts the lines above the current line. +
- markdown mode: Fix several issues in matching link targets. +
- clike mode: Improve indentation of C++ template declarations. +
- javascript mode: Support
async/awaitand improve support for TypeScript type syntax.
+
20-04-2016: Version 5.14.0:
+ +-
+
posFromIndexandindexFromPosnow takelineSeparatorinto account
+ - vim bindings: Only call
.save()when it is actually available
+ - comment addon: Be careful not to mangle multi-line strings +
- Python mode: Improve distinguishing of decorators from
@operators
+ findMarks: No longer return marks that touch but don't overlap given range
+ - vim bindings: Add yank command +
- match-highlighter addon: Add
trimoption to disable ignoring of whitespace
+ - PowerShell mode: Added +
- Yacas mode: Added +
- Web IDL mode: Added +
- SAS mode: Added +
- mbox mode: Added +
- Full list of patches +
21-03-2016: Version 5.13.2:
+ +-
+
- Solves a problem where the gutter would sometimes not extend all the way to the end of the document. +
21-03-2016: Version 5.13:
+ +-
+
- New DOM event forwarded:
"dragleave".
+ - protobuf mode: Newly added. +
- Fix problem where
findMarkssometimes failed to find multi-line marks.
+ - Fix crash that showed up when atomic ranges and bidi text were combined. +
- show-hint addon: Completion widgets no longer close when the line indented or dedented. +
- merge addon: Fix bug when merging chunks at the end of the file. +
- placeholder addon: No longer gets confused by
swapDoc.
+ - simplescrollbars addon: Fix invalid state when deleting at end of document. +
- clike mode: No longer gets confused when a comment starts after an operator. +
- markdown mode: Now supports CommonMark-style flexible list indentation. +
- dylan mode: Several improvements and fixes. +
- Full list of patches +
19-02-2016: Version 5.12:
+ +-
+
- Vim bindings: Ctrl-Q is now an alias for Ctrl-V. +
- Vim bindings: The Vim API now exposes an
unmapmethod to unmap bindings.
+ - active-line addon: This addon can now style the active line's gutter. +
- FCL mode: Newly added. +
- SQL mode: Now has a Postgresql dialect. +
- Fix issue where trying to scroll to a horizontal position outside of the document's width could cause the gutter to be positioned incorrectly. +
- Use absolute, rather than fixed positioning in the context-menu intercept hack, to work around a problem when the editor is inside a transformed parent container. +
- Solve a problem where the horizontal scrollbar could hide text in Firefox. +
- Fix a bug that caused phantom scroll space under the text in some situations. +
- Sublime Text bindings: Bind delete-line to Shift-Ctrl-K on OS X. +
- Markdown mode: Fix issue where the mode would keep state related to fenced code blocks in an unsafe way, leading to occasional corrupted parses. +
- Markdown mode: Ignore backslashes in code fragments. +
- Markdown mode: Use whichever mode is registered as
text/htmlto parse HTML.
+ - Clike mode: Improve indentation of Scala
=>functions.
+ - Python mode: Improve indentation of bracketed code. +
- HTMLMixed mode: Support multi-line opening tags for sub-languages (
<script>,<style>, etc).
+ - Spreadsheet mode: Fix bug where the mode did not advance the stream when finding a backslash. +
- XML mode: The mode now takes a
matchClosingoption to configure whether mismatched closing tags should be highlighted as errors.
+
20-01-2016: Version 5.11:
+ +-
+
- New modes: JSX, literate Haskell +
- The editor now forwards more DOM events:
cut,copy,paste, andtouchstart. It will also forwardmousedownfor drag events
+ - Fixes a bug where bookmarks next to collapsed spans were not rendered +
- The Swift mode now supports auto-indentation +
- Frontmatters in the YAML frontmatter mode are now optional as intended +
- Full list of patches +
21-12-2015: Version 5.10:
+ +-
+
- Modify the way atomic ranges are skipped by selection to try and make it less surprising. +
- The Swift mode was rewritten. +
- New addon: jump-to-line. +
- New method:
isReadOnly.
+ - The show-hint addon now defaults to picking completions on single click. +
- The object passed to
"beforeSelectionChange"events now has anoriginproperty.
+ - New mode: Crystal. +
- Full list of patches +
23-11-2015: Version 5.9:
+ +-
+
- Improve the way overlay (OS X-style) scrollbars are handled +
- Make annotatescrollbar and scrollpastend addons work properly together +
- Make show-hint addon select options on single click by default, move selection to hovered item +
- Properly fold comments that include block-comment-start markers +
- Many small language mode fixes +
- Full list of patches +
20-10-2015: Version 5.8:
+ +-
+
- Fixes an infinite loop in + the hardwrap + addon +
- New modes: NSIS, Ceylon +
- The Kotlin mode is now a clike dialect, rather than a stand-alone mode +
- New option:
allowDropFileTypes. Binary files can no longer be dropped into CodeMirror
+ - New themes: bespin, hopscotch, isotope, railscasts +
- Full list of patches +
20-09-2015: Version 5.7:
+ +-
+
- New modes: Vue, Oz, MscGen (and dialects), Closure Stylesheets +
- Implement CommonMark-style flexible list indent and cross-line code spans in Markdown mode +
- Add a replace-all button to the search addon, and make the persistent search dialog transparent when it obscures the match +
- Handle
acync/awaitand ocal and binary numbers in JavaScript mode
+ - Fix various issues with the Haxe mode +
- Make the closebrackets addon select only the wrapped text when wrapping selection in brackets +
- Tokenize properties as properties in the CoffeeScript mode +
- The placeholder addon now accepts a DOM node as well as a string placeholder +
- Full list of patches +
20-08-2015: Version 5.6:
+ +-
+
- Fix bug where you could paste into a
readOnlyeditor
+ - Show a cursor at the drop location when dragging over the editor +
- The Rust mode was rewritten to handle modern Rust +
- The editor and theme CSS was cleaned up. Some selectors are now less specific than before +
- New theme: abcdef +
- Lines longer than
maxHighlightLengthare now less likely to mess up indentation
+ - New addons:
autorefreshfor refreshing an editor the first time it becomes visible, andhtml-lintfor using HTMLHint
+ - The
searchaddon now recognizes\rand\nin pattern and replacement input
+ - Full list of patches +
20-07-2015: Version 5.5:
+ +-
+
- New option:
lineSeparator(with corresponding method) + - New themes: dracula, seti, yeti, material, and icecoder +
- New modes: Brainfuck, VHDL, Squirrel (clike dialect) +
- Define a
findPersistentcommand in + the search addon, for a dialog + that stays open as you cycle through matches
+ - From this release on, the NPM module doesn't include documentation and demos +
- Full list of patches +
25-06-2015: Version 5.4:
+ +-
+
- New modes: Twig, Elm, Factor, Swift +
- Prefer clipboard API (if available) when pasting +
- Refined definition highlighting in clike mode +
- Full list of patches +
20-05-2015: Version 5.3:
+ +-
+
- Fix several regressions in the
show-hintaddon (completeSingleoption,"shown"and"close"events)
+ - The vim mode API was documented +
- New modes: ASN.1, TTCN, and TTCN-CFG +
- The clike mode can now deep-indent
switchstatements, and roughly recognizes types and defined identifiers
+ - Full list of patches +
20-04-2015: Version 5.2:
+ +-
+
- Fix several race conditions
+ in
show-hint's + asynchronous mode
+ - Fix backspace binding in Sublime bindings +
- Change the way IME is handled in the
"textarea"input style
+
+ - New modes: MUMPS, Handlebars +
- Rewritten modes: Django, Z80 +
- New theme: Liquibyte +
- New option:
lineWiseCopyCut
+ - The Vim mode now supports buffer-local options and the
filetypesetting
+ - Full list of patches +
23-03-2015: Version 5.1:
+ +-
+
- New modes: ASCII armor (PGP data), Troff, and CMake. +
- Remove SmartyMixed mode, rewrite Smarty mode to supersede it. +
- New commands in the merge
+ addon:
goNextDiffandgoPrevDiff.
+ - The closebrackets addon can now be configured per mode. +
- Full list of patches. +
20-02-2015: Version 5.0:
+ +-
+
- Experimental mobile support (tested on iOS, Android Chrome, stock Android browser) +
- New option
inputStyleto switch between hidden textarea and contenteditable input.
+ - The
getInputField+ method is no longer guaranteed to return a textarea.
+ - Full list of patches. +
Version 4.x
+ +20-02-2015: Version 4.13:
+ +-
+
- Fix the way the
closetagdemo handles the slash character.
+ - New modes: Forth, Stylus. +
- Make the CSS mode understand some modern CSS extensions. +
- Have the Scala mode handle symbols and triple-quoted strings. +
- Full list of patches. +
22-01-2015: Version 4.12:
+ +-
+
- The
closetag+ addon now defines a"closeTag"command.
+ - Adds a
findModeByFileNameto the mode metadata + addon.
+ - Simple mode rules can
+ now contain a
solproperty to only match at the start + of a line.
+ - New
+ addon:
selection-pointer+ to style the mouse cursor over the selection.
+ - Improvements to the Sass mode's indentation. +
- The Vim keymap's search functionality now + supports scrollbar + annotation. +
- Full list of patches. +
9-01-2015: Version 4.11:
+ +Unfortunately, 4.10 did not take care of the + Firefox scrolling issue entirely. This release adds two more patches + to address that.
+ +29-12-2014: Version 4.10:
+ +Emergency single-patch update to 4.9. Fixes + Firefox-specific problem where the cursor could end up behind the + horizontal scrollbar.
+ +23-12-2014: Version 4.9:
+ +-
+
- Overhauled scroll bar handling. + Add pluggable scrollbar + implementations. +
- Tweaked behavior for + the completion addons to + not take text after cursor into account. +
- Two new optional features in + the merge addon: aligning + editors, and folding unchanged text. +
- New + modes: Dart, EBNF, spreadsheet, + and Soy. +
- New addon to show persistent panels below/above an editor. +
- New themes: zenburn + and tomorrow night + bright. +
- Allow ctrl-click to clear existing cursors. +
- Full list of patches. +
22-11-2014: Version 4.8:
+ +-
+
- Built-in support for multi-stroke key bindings. +
- New method:
getLineTokens.
+ - New modes: dockerfile, IDL, Objective C (crude). +
- Support styling of gutter backgrounds, allow
"gutter"styles inaddLineClass.
+ - Many improvements to the Vim mode, rewritten visual mode. +
- Improvements to modes: gfm (strikethrough), SPARQL (version 1.1 support), and sTeX (no more runaway math mode). +
- Full list of patches. +
20-10-2014: Version 4.7:
+ +-
+
- Incompatible: + The lint addon now passes the + editor's value as first argument to asynchronous lint functions, + for consistency. The editor is still passed, as fourth + argument. +
- Improved handling of unicode identifiers in modes for + languages that support them. +
- More mode + improvements: CoffeeScript + (indentation), Verilog + (indentation), Scala + (indentation, triple-quoted strings), + and PHP (interpolated + variables in heredoc strings). +
- New modes: Textile and Tornado templates. +
- Experimental new way to define modes. +
- Improvements to the Vim + bindings: Arbitrary insert mode key mappings are now possible, + and text objects are supported in visual mode. +
- The mode meta-information file
+ now includes information about file extensions,
+ and helper
+ functions
findModeByMIME+ andfindModeByExtension.
+ - New logo! +
- Full list of patches. +
19-09-2014: Version 4.6:
+ +-
+
- New mode: Modelica +
- New method:
findWordAt
+ - Make it easier to use text background styling +
- Full list of patches. +
21-08-2014: Version 4.5:
+ +-
+
- Fix several serious bugs with horizontal scrolling +
- New mode: Slim +
- New command:
goLineLeftSmart
+ - More fixes and extensions for the Vim visual block mode +
- Full list of patches. +
21-07-2014: Version 4.4:
+ +-
+
- Note: Some events might now fire in slightly
+ different order (
"change"is still guaranteed to fire + before"cursorActivity")
+ - Nested operations in multiple editors are now synced (complete + at same time, reducing DOM reflows) +
- Visual block mode for vim (<C-v>) is nearly complete +
- New mode: Kotlin +
- Better multi-selection paste for text copied from multiple CodeMirror selections +
- Full list of patches. +
23-06-2014: Version 4.3:
+ +-
+
- Several vim bindings
+ improvements: search and exCommand history, global flag
+ for
:substitute,:globalcommand. + - Allow hiding the cursor by
+ setting
cursorBlinkRate+ to a negative value.
+ - Make gutter markers themeable, use this in foldgutter. +
- Full list of patches. +
19-05-2014: Version 4.2:
+ +-
+
- Fix problem where some modes were broken by the fact that empty tokens were forbidden. +
- Several fixes to context menu handling. +
- On undo, scroll change, not cursor, into view. +
- Rewritten Jade mode. +
- Various improvements to Shell (support for more syntax) and Python (better indentation) modes. +
- New mode: Cypher. +
- New theme: Neo. +
- Support direct styling options (color, line style, width) in the rulers addon. +
- Recognize per-editor configuration for the show-hint and foldcode addons. +
- More intelligent scanning for existing close tags in closetag addon. +
- In the Vim bindings: Fix bracket matching, support case conversion in visual mode, visual paste, append action. +
- Full list of patches. +
22-04-2014: Version 4.1:
+ +-
+
- Slightly incompatible:
+ The
"cursorActivity"+ event now fires after all other events for the operation (and only + for handlers that were actually registered at the time the + activity happened).
+ - New command:
insertSoftTab.
+ - New mode: Django. +
- Improved modes: Verilog (rewritten), Jinja2, Haxe, PHP (string interpolation highlighted), JavaScript (indentation of trailing else, template strings), LiveScript (multi-line strings). +
- Many small issues from the 3.x→4.x transition were found and fixed. +
- Full list of patches. +
20-03-2014: Version 4.0:
+ +This is a new major version of CodeMirror. There + are a few incompatible changes in the API. Upgrade + with care, and read the upgrading + guide.
+ +-
+
- Multiple selections (ctrl-click, alt-drag, API). +
- Sublime Text bindings. +
- Module loader shims wrapped around all modules. +
- Selection undo/redo. +
- Improved character measuring (faster, handles wrapped lines more robustly). +
- Full list of patches. +
Version 3.x
+ +22-04-2014: Version 3.24:
+ +Merges the improvements from 4.1 that could + easily be applied to the 3.x code. Also improves the way the editor + size is updated when line widgets change.
+ +20-03-2014: Version 3.23:
+ +-
+
- In the XML mode,
+ add
bracketsstyle to angle brackets, fix + case-sensitivity of tags for HTML.
+ - New mode: Dylan. +
- Many improvements to the Vim bindings. +
21-02-2014: Version 3.22:
+ +-
+
- Adds the
findMarksmethod.
+ - New addons: rulers, markdown-fold, yaml-lint. +
- New theme: mdn-like. +
- New mode: Solr. +
- Full list of patches. +
16-01-2014: Version 3.21:
+ +-
+
- Auto-indenting a block will no longer add trailing whitespace to blank lines. +
- Marking text has a new option
clearWhenEmptyto control auto-removal.
+ - Several bugfixes in the handling of bidirectional text. +
- The XML and CSS modes were largely rewritten. LESS support was added to the CSS mode. +
- The OCaml mode was moved to an mllike mode, F# support added. +
- Make it possible to fetch multiple applicable helper values with
getHelpers, and to register helpers matched on predicates withregisterGlobalHelper.
+ - New theme pastel-on-dark. +
- Better ECMAScript 6 support in JavaScript mode. +
- Full list of patches. +
21-11-2013: Version 3.20:
+ +-
+
- New modes: Julia and PEG.js. +
- Support ECMAScript 6 in the JavaScript mode. +
- Improved indentation for the CoffeeScript mode. +
- Make non-printable-character representation configurable. +
- Add ‘notification’ functionality to dialog addon. +
- Full list of patches. +
21-10-2013: Version 3.19:
+ +-
+
- New modes: Eiffel, Gherkin, MSSQL dialect. +
- New addons: hardwrap, sql-hint. +
- New theme: MBO. +
- Add support for line-level styling from mode tokenizers. +
- Full list of patches. +
23-09-2013: Version 3.18:
+ +Emergency release to fix a problem in 3.17
+ where .setOption("lineNumbers", false) would raise an
+ error.
23-09-2013: Version 3.17:
+ +-
+
- New modes: Fortran, Octave (Matlab), TOML, and DTD. +
- New addons:
css-lint,css-hint.
+ - Improve resilience to CSS 'frameworks' that globally mess up
box-sizing.
+ - Full list of patches. +
21-08-2013: Version 3.16:
+ +-
+
- The whole codebase is now under a single license file. +
- The project page was overhauled and redesigned. +
- New themes: Paraiso (light), The Matrix. +
- Improved interaction between themes and active-line/matchbrackets addons. +
- New folding function
CodeMirror.fold.comment.
+ - Added fullscreen addon. +
- Full list of patches. +
29-07-2013: Version 3.15:
+ +-
+
- New modes: Jade, Nginx. +
- New addons: Tern, matchtags, and foldgutter. +
- Introduced helper concept (context). +
- New method:
getModeAt.
+ - New themes: base16 dark/light, 3024 dark/light, tomorrow-night. +
- Full list of patches. +
20-06-2013: Version 3.14:
+ +-
+
- New + addons: trailing + space highlight, XML + completion (rewritten), + and diff merging. +
markText+ andaddLineWidget+ now take ahandleMouseEventsoption.
+ - New methods:
lineAtHeight, +getTokenTypeAt.
+ - More precise cleanness-tracking
+ using
changeGeneration+ andisClean.
+ - Many extensions to Emacs mode + (prefixes, more navigation units, and more). +
- New
+ events
"keyHandled"+ and"inputRead".
+ - Various improvements to Ruby, + Smarty, SQL, + and Vim modes. +
- Full list of patches. +
20-05-2013: Version 3.13:
+ +-
+
- New modes: COBOL and HAML. +
- New options:
cursorScrollMarginandcoverGutterNextToScrollbar.
+ - New addon: commenting. +
- More features added to the Vim keymap. +
- Full list of patches. +
19-04-2013: Version 3.12:
+ +-
+
- New mode: GNU assembler. +
- New
+ options:
maxHighlightLength+ andhistoryEventDelay.
+ - Added
addToHistory+ option formarkText.
+ - Various fixes to JavaScript tokenization and indentation corner cases. +
- Further improvements to the vim mode. +
- Full list of patches. +
20-03-2013: Version 3.11:
+ +-
+
- Removed code:
collapserange, +formatting, andsimple-hint+ addons.plsqlandmysqlmodes + (usesqlmode).
+ - Moved code: the range-finding functions for folding now have their own files. +
- Changed interface:
+ the
continuecomment+ addon now exposes an option, rather than a command.
+ - New + modes: SCSS, Tcl, LiveScript, + and mIRC. +
- New addons:
placeholder, HTML completion.
+ - New
+ methods:
hasFocus,defaultCharWidth.
+ - New events:
beforeCursorEnter,renderLine.
+ - Many improvements to the
show-hintcompletion + dialog addon.
+ - Tweak behavior of by-word cursor motion. +
- Further improvements to the vim mode. +
- Full list of patches. +
21-02-2013: Version 3.1:
+ +-
+
- Incompatible: key handlers may
+ now return, rather
+ than throw
CodeMirror.Passto signal they + didn't handle the key.
+ - Make documents a first-class + construct, support split views and subviews. +
- Add a new module
+ for showing completion hints.
+ Deprecate
simple-hint.js.
+ - Extend htmlmixed mode + to allow custom handling of script types. +
- Support an
insertLeftoption + tosetBookmark.
+ - Add an
eachLine+ method to iterate over a document.
+ - New addon modules: selection + marking, linting, + and automatic bracket + closing. +
- Add
"beforeChange"+ and"beforeSelectionChange"+ events.
+ - Add
"hide"+ and"unhide"+ events to marked ranges.
+ - Fix
coordsChar's + interpretation of its argument to match the documentation.
+ - New modes: Turtle + and Q. +
- Further improvements to the vim mode. +
- Full list of patches. +
25-01-2013: Version 3.02:
+ +Single-bugfix release. Fixes a problem that + prevents CodeMirror instances from being garbage-collected after + they become unused.
+ +21-01-2013: Version 3.01:
+ +-
+
- Move all add-ons into an organized directory structure
+ under
/addon. You might have to adjust your + paths.
+ - New + modes: D, Sass, APL, SQL + (configurable), and Asterisk. +
- Several bugfixes in right-to-left text support. +
- Add
rtlMoveVisuallyoption.
+ - Improvements to vim keymap. +
- Add built-in (lightweight) overlay mode support. +
- Support
showIfHiddenoption for line widgets.
+ - Add simple Python hinter. +
- Bring back the
fixedGutteroption.
+ - Full list of patches. +
10-12-2012: Version 3.0:
+ +New major version. Only + partially backwards-compatible. See + the upgrading guide for more + information. Changes since release candidate 2:
+ +-
+
- Rewritten VIM mode. +
- Fix a few minor scrolling and sizing issues. +
- Work around Safari segfault when dragging. +
- Full list of patches. +
20-11-2012: Version 3.0, release candidate 2:
+ +-
+
- New mode: HTTP. +
- Improved handling of selection anchor position. +
- Improve IE performance on longer lines. +
- Reduce gutter glitches during horiz. scrolling. +
- Add
addKeyMapandremoveKeyMapmethods.
+ - Rewrite
formattingandclosetagadd-ons.
+ - Full list of patches. +
20-11-2012: Version 3.0, release candidate 1:
+ +-
+
- New theme: Solarized. +
- Introduce
addLineClass+ andremoveLineClass, + dropsetLineClass.
+ - Add a lot of + new options for marked text + (read-only, atomic, collapsed, widget replacement). +
- Remove the old code folding interface in favour of these new ranges. +
- Add
isClean/markCleanmethods.
+ - Remove
compoundChangemethod, use better undo-event-combining heuristic.
+ - Improve scrolling performance smoothness. +
- Full list of patches. +
22-10-2012: Version 3.0, beta 2:
+ +-
+
- Fix page-based coordinate computation. +
- Fix firing of
gutterClickevent.
+ - Add
cursorHeightoption.
+ - Fix bi-directional text regression. +
- Add
viewportMarginoption.
+ - Directly handle mousewheel events (again, hopefully better). +
- Make vertical cursor movement more robust (through widgets, big line gaps). +
- Add
flattenSpansoption.
+ - Many optimizations. Poor responsiveness should be fixed. +
- Initialization in hidden state works again. +
- Full list of patches. +
19-09-2012: Version 3.0, beta 1:
+ +-
+
- Bi-directional text support. +
- More powerful gutter model. +
- Support for arbitrary text/widget height. +
- In-line widgets. +
- Generalized event handling. +
Version 2.x
+ +21-01-2013: Version 2.38:
+ +Integrate some bugfixes, enhancements to the vim keymap, and new + modes + (D, Sass, APL) + from the v3 branch.
+ +20-12-2012: Version 2.37:
+ +-
+
- New mode: SQL (will replace plsql and mysql modes). +
- Further work on the new VIM mode. +
- Fix Cmd/Ctrl keys on recent Operas on OS X. +
- Full list of patches. +
20-11-2012: Version 2.36:
+ +-
+
- New mode: Z80 assembly. +
- New theme: Twilight. +
- Add command-line compression helper. +
- Make
scrollIntoViewpublic.
+ - Add
defaultTextHeightmethod.
+ - Various extensions to the vim keymap. +
- Make PHP mode build on mixed HTML mode. +
- Add comment-continuing add-on. +
- Full list of patches. +
22-10-2012: Version 2.35:
+ +-
+
- New (sub) mode: TypeScript. +
- Don't overwrite (insert key) when pasting. +
- Fix several bugs in
markText/undo interaction.
+ - Better indentation of JavaScript code without semicolons. +
- Add
defineInitHookfunction.
+ - Full list of patches. +
19-09-2012: Version 2.34:
+ +-
+
- New mode: Common Lisp. +
- Fix right-click select-all on most browsers. +
- Change the way highlighting happens:
Saves memory and CPU cycles.
compareStatesis no longer needed.
onHighlightCompleteno longer works.
+ - Integrate mode (Markdown, XQuery, CSS, sTex) tests in central testsuite. +
- Add a
CodeMirror.versionproperty.
+ - More robust handling of nested modes in formatting and closetag plug-ins. +
- Un/redo now preserves marked text and bookmarks. +
- Full list of patches. +
23-08-2012: Version 2.33:
+ +-
+
- New mode: Sieve. +
- New
getViewPortandonViewportChangeAPI.
+ - Configurable cursor blink rate. +
- Make binding a key to
falsedisabling handling (again).
+ - Show non-printing characters as red dots. +
- More tweaks to the scrolling model. +
- Expanded testsuite. Basic linter added. +
- Remove most uses of
innerHTML. RemoveCodeMirror.htmlEscape.
+ - Full list of patches. +
23-07-2012: Version 2.32:
+ +Emergency fix for a bug where an editor with + line wrapping on IE will break when there is no + scrollbar.
+ +20-07-2012: Version 2.31:
+ +-
+
- New modes: OCaml, Haxe, and VB.NET. +
- Several fixes to the new scrolling model. +
- Add a
setSizemethod for programmatic resizing.
+ - Add
getHistoryandsetHistorymethods.
+ - Allow custom line separator string in
getValueandgetRange.
+ - Support double- and triple-click drag, double-clicking whitespace. +
- And more... (all patches) +
22-06-2012: Version 2.3:
+ +-
+
- New scrollbar implementation. Should flicker less. Changes DOM structure of the editor. +
- New theme: vibrant-ink. +
- Many extensions to the VIM keymap (including text objects). +
- Add mode-multiplexing utility script. +
- Fix bug where right-click paste works in read-only mode. +
- Add a
getScrollInfomethod.
+ - Lots of other fixes. +
23-05-2012: Version 2.25:
+ +-
+
- New mode: Erlang. +
- Remove xmlpure mode (use xml.js). +
- Fix line-wrapping in Opera. +
- Fix X Windows middle-click paste in Chrome. +
- Fix bug that broke pasting of huge documents. +
- Fix backspace and tab key repeat in Opera. +
23-04-2012: Version 2.24:
+ +-
+
- Drop support for Internet Explorer 6. +
- New + modes: Shell, Tiki + wiki, Pig Latin. +
- New themes: Ambiance, Blackboard. +
- More control over drag/drop
+ with
dragDrop+ andonDragEvent+ options.
+ - Make HTML mode a bit less pedantic. +
- Add
compoundChangeAPI method.
+ - Several fixes in undo history and line hiding. +
- Remove (broken) support for
catchallin key maps, + addnofallthroughboolean field instead.
+
26-03-2012: Version 2.23:
+ +-
+
- Change default binding for tab [more] + + +
- New modes: XQuery and VBScript. +
- Two new themes: lesser-dark and xq-dark. +
- Differentiate between background and text styles in
setLineClass.
+ - Fix drag-and-drop in IE9+. +
- Extend
charCoords+ andcursorCoordswith amodeargument.
+ - Add
autofocusoption.
+ - Add
findMarksAtmethod.
+
27-02-2012: Version 2.22:
+ +-
+
- Allow key handlers to pass up events, allow binding characters. +
- Add
autoClearEmptyLinesoption.
+ - Properly use tab stops when rendering tabs. +
- Make PHP mode more robust. +
- Support indentation blocks in code folder. +
- Add a script for highlighting instances of the selection. +
- New .properties mode. +
- Fix many bugs. +
27-01-2012: Version 2.21:
+ +-
+
- Added LESS, MySQL, + Go, and Verilog modes. +
- Add
smartIndent+ option.
+ - Support a cursor in
readOnly-mode.
+ - Support assigning multiple styles to a token. +
- Use a new approach to drawing the selection. +
- Add
scrollTomethod.
+ - Allow undo/redo events to span non-adjacent lines. +
- Lots and lots of bugfixes. +
20-12-2011: Version 2.2:
+ +-
+
- Slightly incompatible API changes. Read this. +
- New approach + to binding keys, + support for custom + bindings. +
- Support for overwrite (insert). +
- Custom-width + and stylable tabs. +
- Moved more code into add-on scripts. +
- Support for sane vertical cursor movement in wrapped lines. +
- More reliable handling of + editing marked text. +
- Add minimal emacs + and vim bindings. +
- Rename
coordsFromIndex+ toposFromIndex, + addindexFromPos+ method.
+
21-11-2011: Version 2.18:
+Fixes TextMarker.clear, which is broken in 2.17.
21-11-2011: Version 2.17:
+-
+
- Add support for line + wrapping and code + folding. +
- Add Github-style Markdown mode. +
- Add Monokai + and Rubyblue themes. +
- Add
setBookmarkmethod.
+ - Move some of the demo code into reusable components
+ under
lib/util.
+ - Make screen-coord-finding code faster and more reliable. +
- Fix drag-and-drop in Firefox. +
- Improve support for IME. +
- Speed up content rendering. +
- Fix browser's built-in search in Webkit. +
- Make double- and triple-click work in IE. +
- Various fixes to modes. +
27-10-2011: Version 2.16:
+-
+
- Add Perl, Rust, TiddlyWiki, and Groovy modes. +
- Dragging text inside the editor now moves, rather than copies. +
- Add a
coordsFromIndexmethod.
+ - API change:
setValuenow no longer clears history. UseclearHistoryfor that.
+ - API change:
markTextnow + returns an object withclearandfind+ methods. Marked text is now more robust when edited.
+ - Fix editing code with tabs in Internet Explorer. +
26-09-2011: Version 2.15:
+Fix bug that snuck into 2.14: Clicking the + character that currently has the cursor didn't re-focus the + editor.
+ +26-09-2011: Version 2.14:
+-
+
- Add Clojure, Pascal, NTriples, Jinja2, and Markdown modes. +
- Add Cobalt and Eclipse themes. +
- Add a
fixedGutteroption.
+ - Fix bug with
setValuebreaking cursor movement.
+ - Make gutter updates much more efficient. +
- Allow dragging of text out of the editor (on modern browsers). +
23-08-2011: Version 2.13:
+-
+
- Add Ruby, R, CoffeeScript, and Velocity modes. +
- Add
getGutterElementto API.
+ - Several fixes to scrolling and positioning. +
- Add
smartHomeoption.
+ - Add an experimental pure XML mode. +
25-07-2011: Version 2.12:
+-
+
- Add a SPARQL mode. +
- Fix bug with cursor jumping around in an unfocused editor in IE. +
- Allow key and mouse events to bubble out of the editor. Ignore widget clicks. +
- Solve cursor flakiness after undo/redo. +
- Fix block-reindent ignoring the last few lines. +
- Fix parsing of multi-line attrs in XML mode. +
- Use
innerHTMLfor HTML-escaping.
+ - Some fixes to indentation in C-like mode. +
- Shrink horiz scrollbars when long lines removed. +
- Fix width feedback loop bug that caused the width of an inner DIV to shrink. +
04-07-2011: Version 2.11:
+-
+
- Add a Scheme mode. +
- Add a
replacemethod to search cursors, for cursor-preserving replacements.
+ - Make the C-like mode mode more customizable. +
- Update XML mode to spot mismatched tags. +
- Add
getStateAfterAPI andcompareStatemode API methods for finer-grained mode magic.
+ - Add a
getScrollerElementAPI method to manipulate the scrolling DIV.
+ - Fix drag-and-drop for Firefox. +
- Add a C# configuration for the C-like mode. +
- Add full-screen editing and mode-changing demos. +
07-06-2011: Version 2.1:
+Add + a theme system + (demo). Note that this is not + backwards-compatible—you'll have to update your styles and + modes!
+ +07-06-2011: Version 2.02:
+-
+
- Add a Lua mode. +
- Fix reverse-searching for a regexp. +
- Empty lines can no longer break highlighting. +
- Rework scrolling model (the outer wrapper no longer does the scrolling). +
- Solve horizontal jittering on long lines. +
- Add runmode.js. +
- Immediately re-highlight text when typing. +
- Fix problem with 'sticking' horizontal scrollbar. +
26-05-2011: Version 2.01:
+-
+
- Add a Smalltalk mode. +
- Add a reStructuredText mode. +
- Add a Python mode. +
- Add a PL/SQL mode. +
coordsCharnow works
+ - Fix a problem where
onCursorActivityinterfered withonChange.
+ - Fix a number of scrolling and mouse-click-position glitches. +
- Pass information about the changed lines to
onChange.
+ - Support cmd-up/down on OS X. +
- Add triple-click line selection. +
- Don't handle shift when changing the selection through the API. +
- Support
"nocursor"mode forreadOnlyoption.
+ - Add an
onHighlightCompleteoption.
+ - Fix the context menu for Firefox. +
28-03-2011: Version 2.0:
+CodeMirror 2 is a complete rewrite that's + faster, smaller, simpler to use, and less dependent on browser + quirks. See this + and this + for more information.
+ +22-02-2011: Version 2.0 beta 2:
+Somewhat more mature API, lots of bugs shaken out.
+ +17-02-2011: Version 0.94:
+-
+
tabMode: "spaces"was modified slightly (now indents when something is selected).
+ - Fixes a bug that would cause the selection code to break on some IE versions. +
- Disabling spell-check on WebKit browsers now works. +
08-02-2011: Version 2.0 beta 1:
+CodeMirror 2 is a complete rewrite of + CodeMirror, no longer depending on an editable frame.
+ +19-01-2011: Version 0.93:
+-
+
- Added a Regular Expression parser. +
- Fixes to the PHP parser. +
- Support for regular expression in search/replace. +
- Add
savemethod to instances created withfromTextArea.
+ - Add support for MS T-SQL in the SQL parser. +
- Support use of CSS classes for highlighting brackets. +
- Fix yet another hang with line-numbering in hidden editors. +
Version 0.x
+ +28-03-2011: Version 1.0:
+-
+
- Fix error when debug history overflows. +
- Refine handling of C# verbatim strings. +
- Fix some issues with JavaScript indentation. +
17-12-2010: Version 0.92:
+-
+
- Make CodeMirror work in XHTML documents. +
- Fix bug in handling of backslashes in Python strings. +
- The
styleNumbersoption is now officially + supported and documented.
+ onLineNumberClickoption added.
+ - More consistent names
onLoadand +onCursorActivitycallbacks. Old names still work, but + are deprecated.
+ - Add a Freemarker mode. +
11-11-2010: Version 0.91:
+-
+
- Adds support for Java. +
- Small additions to the PHP and SQL parsers. +
- Work around various Webkit issues. +
- Fix
toTextAreato update the code in the textarea.
+ - Add a
noScriptCachingoption (hack to ease development).
+ - Make sub-modes of HTML mixed mode configurable. +
02-10-2010: Version 0.9:
+-
+
- Add support for searching backwards. +
- There are now parsers for Scheme, XQuery, and OmetaJS. +
- Makes
height: "dynamic"more robust.
+ - Fixes bug where paste did not work on OS X. +
- Add a
enterModeandelectricCharsoptions to make indentation even more customizable.
+ - Add
firstLineNumberoption.
+ - Fix bad handling of
@mediarules by the CSS parser.
+ - Take a new, more robust approach to working around the invisible-last-line bug in WebKit. +
22-07-2010: Version 0.8:
+-
+
- Add a
cursorCoordsmethod to find the screen + coordinates of the cursor.
+ - A number of fixes and support for more syntax in the PHP parser. +
- Fix indentation problem with JSON-mode JS parser in Webkit. +
- Add a minification UI. +
- Support a
height: dynamicmode, where the editor's + height will adjust to the size of its content.
+ - Better support for IME input mode. +
- Fix JavaScript parser getting confused when seeing a no-argument + function call. +
- Have CSS parser see the difference between selectors and other + identifiers. +
- Fix scrolling bug when pasting in a horizontally-scrolled + editor. +
- Support
toTextAreamethod in instances created with +fromTextArea.
+ - Work around new Opera cursor bug that causes the cursor to jump + when pressing backspace at the end of a line. +
27-04-2010: Version + 0.67:
+More consistent page-up/page-down behaviour
+ across browsers. Fix some issues with hidden editors looping forever
+ when line-numbers were enabled. Make PHP parser parse
+ "\\" correctly. Have jumpToLine work on
+ line handles, and add cursorLine function to fetch the
+ line handle where the cursor currently is. Add new
+ setStylesheet function to switch style-sheets in a
+ running editor.
01-03-2010: Version + 0.66:
+Adds removeLine method to API.
+ Introduces the PLSQL parser.
+ Marks XML errors by adding (rather than replacing) a CSS class, so
+ that they can be disabled by modifying their style. Fixes several
+ selection bugs, and a number of small glitches.
12-11-2009: Version + 0.65:
+Add support for having both line-wrapping and
+ line-numbers turned on, make paren-highlighting style customisable
+ (markParen and unmarkParen config
+ options), work around a selection bug that Opera
+ reintroduced in version 10.
23-10-2009: Version + 0.64:
+Solves some issues introduced by the
+ paste-handling changes from the previous release. Adds
+ setSpellcheck, setTextWrapping,
+ setIndentUnit, setUndoDepth,
+ setTabMode, and setLineNumbers to
+ customise a running editor. Introduces an SQL parser. Fixes a few small
+ problems in the Python
+ parser. And, as usual, add workarounds for various newly discovered
+ browser incompatibilities.
31-08-2009: Version 0.63:
+Overhaul of paste-handling (less fragile), fixes for several + serious IE8 issues (cursor jumping, end-of-document bugs) and a number + of small problems.
+ +30-05-2009: Version 0.62:
+Introduces Python
+ and Lua parsers. Add
+ setParser (on-the-fly mode changing) and
+ clearHistory methods. Make parsing passes time-based
+ instead of lines-based (see the passTime option).
Reporting bugs effectively
+ +
+
+
+
+So you found a problem in CodeMirror. By all means, report it! Bug +reports from users are the main drive behind improvements to +CodeMirror. But first, please read over these points:
+ +-
+
- CodeMirror is maintained by volunteers. They don't owe you + anything, so be polite. Reports with an indignant or belligerent + tone tend to be moved to the bottom of the pile. + +
- Include information about the browser in which the + problem occurred. Even if you tested several browsers, and + the problem occurred in all of them, mention this fact in the bug + report. Also include browser version numbers and the operating + system that you're on. + +
- Mention which release of CodeMirror you're using. Preferably, + try also with the current development snapshot, to ensure the + problem has not already been fixed. + +
- Mention very precisely what went wrong. "X is broken" is not a + good bug report. What did you expect to happen? What happened + instead? Describe the exact steps a maintainer has to take to reproduce + the error. We can not fix something that we can not observe. + +
- If the problem can not be reproduced in any of the demos + included in the CodeMirror distribution, please provide an HTML + document that demonstrates the problem. The best way to do this is + to go to jsbin.com, enter + it there, press save, and include the resulting link in your bug + report. +
Upgrading to v2.2
+ +There are a few things in the 2.2 release that require some care +when upgrading.
+ +No more default.css
+ +The default theme is now included
+in codemirror.css, so
+you do not have to included it separately anymore. (It was tiny, so
+even if you're not using it, the extra data overhead is negligible.)
+
+
Different key customization
+ +CodeMirror has moved to a system +where keymaps are used to +bind behavior to keys. This means custom +bindings are now possible.
+ +Three options that influenced key
+behavior, tabMode, enterMode,
+and smartHome, are no longer supported. Instead, you can
+provide custom bindings to influence the way these keys act. This is
+done through the
+new extraKeys
+option, which can hold an object mapping key names to functionality. A
+simple example would be:
extraKeys: {
+ "Ctrl-S": function(instance) { saveText(instance.getValue()); },
+ "Ctrl-/": "undo"
+ }
+
+Keys can be mapped either to functions, which will be given the
+editor instance as argument, or to strings, which are mapped through
+functions through the CodeMirror.commands table, which
+contains all the built-in editing commands, and can be inspected and
+extended by external code.
By default, the Home key is bound to
+the "goLineStartSmart" command, which moves the cursor to
+the first non-whitespace character on the line. You can set do this to
+make it always go to the very start instead:
extraKeys: {"Home": "goLineStart"}
+
+Similarly, Enter is bound
+to "newlineAndIndent" by default. You can bind it to
+something else to get different behavior. To disable special handling
+completely and only get a newline character inserted, you can bind it
+to false:
extraKeys: {"Enter": false}
+
+The same works for Tab. If you don't want CodeMirror
+to handle it, bind it to false. The default behaviour is
+to indent the current line more ("indentMore" command),
+and indent it less when shift is held ("indentLess").
+There are also "indentAuto" (smart indent)
+and "insertTab" commands provided for alternate
+behaviors. Or you can write your own handler function to do something
+different altogether.
Tabs
+ +Handling of tabs changed completely. The display width of tabs can
+now be set with the tabSize option, and tabs can
+be styled by setting CSS rules
+for the cm-tab class.
The default width for tabs is now 4, as opposed to the 8 that is
+hard-wired into browsers. If you are relying on 8-space tabs, make
+sure you explicitly set tabSize: 8 in your options.
+
+
+
+
+
+
+CodeMirror
+
+
+
+Upgrading to version 3
+ +Version 3 does not depart too much from 2.x API, and sites that use +CodeMirror in a very simple way might be able to upgrade without +trouble. But it does introduce a number of incompatibilities. Please +at least skim this text before upgrading.
+ +Note that version 3 drops full support for Internet +Explorer 7. The editor will mostly work on that browser, but +it'll be significantly glitchy.
+ +DOM structure
+ +This one is the most likely to cause problems. The internal +structure of the editor has changed quite a lot, mostly to implement a +new scrolling model.
+ +Editor height is now set on the outer wrapper element (CSS
+class CodeMirror), not on the scroller element
+(CodeMirror-scroll).
Other nodes were moved, dropped, and added. If you have any code +that makes assumptions about the internal DOM structure of the editor, +you'll have to re-test it and probably update it to work with v3.
+ +See the styling section of the +manual for more information.
+Gutter model
+ +In CodeMirror 2.x, there was a single gutter, and line markers
+created with setMarker would have to somehow coexist with
+the line numbers (if present). Version 3 allows you to specify an
+array of gutters, by class
+name,
+use setGutterMarker
+to add or remove markers in individual gutters, and clear whole
+gutters
+with clearGutter.
+Gutter markers are now specified as DOM nodes, rather than HTML
+snippets.
The gutters no longer horizontally scrolls along with the content.
+The fixedGutter option was removed (since it is now the
+only behavior).
+<style>
+ /* Define a gutter style */
+ .note-gutter { width: 3em; background: cyan; }
+</style>
+<script>
+ // Create an instance with two gutters -- line numbers and notes
+ var cm = new CodeMirror(document.body, {
+ gutters: ["note-gutter", "CodeMirror-linenumbers"],
+ lineNumbers: true
+ });
+ // Add a note to line 0
+ cm.setGutterMarker(0, "note-gutter", document.createTextNode("hi"));
+</script>
+
+Event handling
+ +Most of the onXYZ options have been removed. The same
+effect is now obtained by calling
+the on method with a string
+identifying the event type. Multiple handlers can now be registered
+(and individually unregistered) for an event, and objects such as line
+handlers now also expose events. See the
+full list here.
(The onKeyEvent and onDragEvent options,
+which act more as hooks than as event handlers, are still there in
+their old form.)
+cm.on("change", function(cm, change) {
+ console.log("something changed! (" + change.origin + ")");
+});
+
+markText method arguments
+ +The markText method
+(which has gained some interesting new features, such as creating
+atomic and read-only spans, or replacing spans with widgets) no longer
+takes the CSS class name as a separate argument, but makes it an
+optional field in the options object instead.
+// Style first ten lines, and forbid the cursor from entering them
+cm.markText({line: 0, ch: 0}, {line: 10, ch: 0}, {
+ className: "magic-text",
+ inclusiveLeft: true,
+ atomic: true
+});
+
+Line folding
+ +The interface for hiding lines has been
+removed. markText can
+now be used to do the same in a more flexible and powerful way.
The folding script has been +updated to use the new interface, and should now be more robust.
+ +
+// Fold a range, replacing it with the text "??"
+var range = cm.markText({line: 4, ch: 2}, {line: 8, ch: 1}, {
+ replacedWith: document.createTextNode("??"),
+ // Auto-unfold when cursor moves into the range
+ clearOnEnter: true
+});
+// Get notified when auto-unfolding
+CodeMirror.on(range, "clear", function() {
+ console.log("boom");
+});
+
+Line CSS classes
+ +The setLineClass method has been replaced
+by addLineClass
+and removeLineClass,
+which allow more modular control over the classes attached to a line.
+var marked = cm.addLineClass(10, "background", "highlighted-line");
+setTimeout(function() {
+ cm.removeLineClass(marked, "background", "highlighted-line");
+});
+
+Position properties
+ +All methods that take or return objects that represent screen
+positions now use {left, top, bottom, right} properties
+(not always all of them) instead of the {x, y, yBot} used
+by some methods in v2.x.
Affected methods
+are cursorCoords, charCoords, coordsChar,
+and getScrollInfo.
Bracket matching no longer in core
+ +The matchBrackets
+option is no longer defined in the core editor.
+Load addon/edit/matchbrackets.js to enable it.
Mode management
+ +The CodeMirror.listModes
+and CodeMirror.listMIMEs functions, used for listing
+defined modes, are gone. You are now encouraged to simply
+inspect CodeMirror.modes (mapping mode names to mode
+constructors) and CodeMirror.mimeModes (mapping MIME
+strings to mode specs).
New features
+ +Some more reasons to upgrade to version 3.
+ +-
+
- Bi-directional text support. CodeMirror will now mostly do the + right thing when editing Arabic or Hebrew text. +
- Arbitrary line heights. Using fonts with different heights + inside the editor (whether off by one pixel or fifty) is now + supported and handled gracefully. +
- In-line widgets. See the demo + and the docs. +
- Defining custom options
+ with
CodeMirror.defineOption.
+
+
+
+
+
+
+
+CodeMirror
+
+
+
+Upgrading to version 4
+ +CodeMirror 4's interface is very close version 3, but it +does fix a few awkward details in a backwards-incompatible ways. At +least skim the text below before upgrading.
+ +Multiple selections
+ +The main new feature in version 4 is multiple selections. The +single-selection variants of methods are still there, but now +typically act only on the primary selection (usually the last +one added).
+ +The exception to this
+is getSelection,
+which will now return the content of all selections
+(separated by newlines, or whatever lineSep parameter you passed
+it).
The beforeSelectionChange event
+ +This event still exists, but the object it is passed has +a completely new +interface, because such changes now concern multiple +selections.
+ +replaceSelection's collapsing behavior
+ +By
+default, replaceSelection
+would leave the newly inserted text selected. This is only rarely what
+you want, and also (slightly) more expensive in the new model, so the
+default was changed to "end", meaning the old behavior
+must be explicitly specified by passing a second argument
+of "around".
change event data
+ +Rather than forcing client code to follow next
+pointers from one change object to the next, the library will now
+simply fire
+multiple "change"
+events. Existing code will probably continue to work unmodified.
showIfHidden option to line widgets
+ +This option, which conceptually caused line widgets to be visible +even if their line was hidden, was never really well-defined, and was +buggy from the start. It would be a rather expensive feature, both in +code complexity and run-time performance, to implement properly. It +has been dropped entirely in 4.0.
+ +Module loaders
+ +All modules in the CodeMirror distribution are now wrapped in a
+shim function to make them compatible with both AMD
+(requirejs) and CommonJS (as used
+by node
+and browserify) module loaders.
+When neither of these is present, they fall back to simply using the
+global CodeMirror variable.
If you have a module loader present in your environment, CodeMirror +will attempt to use it, and you might need to change the way you load +CodeMirror modules.
+ +Deprecated interfaces dropped
+ +A few properties and methods that have been deprecated for a while
+are now gone. Most notably, the onKeyEvent
+and onDragEvent options (use the
+corresponding events instead).
Two silly methods, which were mostly there to stay close to the 0.x
+API, setLine and removeLine are now gone.
+Use the more
+flexible replaceRange
+method instead.
The long names for folding and completing functions
+(CodeMirror.braceRangeFinder, CodeMirror.javascriptHint,
+etc) are also gone
+(use CodeMirror.fold.brace, CodeMirror.hint.javascript).
The className property in the return value
+of getTokenAt, which
+has been superseded by the type property, is also no
+longer present.
CodeMirror is a versatile text editor + implemented in JavaScript for the browser. It is specialized for + editing code, and comes with a number of language modes and addons + that implement more advanced editing functionality.
+ +A rich programming API and a + CSS theming system are + available for customizing CodeMirror to fit your application, and + extending it with new functionality.
+This is CodeMirror
+ + + +
+
+
+
+
+
+ Get the current version: 5.32.0.
+ You can see the code,
+ read the release notes,
+ or study the user manual. +
+
+ + You can see the code,
+ read the release notes,
+ or study the user manual. +
Features
+-
+
- Support for over 100 languages out of the box +
- A powerful, composable language mode system +
- Autocompletion (XML) +
- Code folding +
- Configurable keybindings +
- Vim, Emacs, and Sublime Text bindings +
- Search and replace interface +
- Bracket and tag matching +
- Support for split views +
- Linter integration +
- Mixing font sizes and styles +
- Various themes +
- Able to resize to fit content +
- Inline and block widgets +
- Programmable gutters +
- Making ranges of text styled, read-only, or atomic +
- Bi-directional text support +
- Many other methods and addons... +
Community
+ +CodeMirror is an open-source project shared under + an MIT license. It is the editor used in the + dev tools for + Firefox, + Chrome, + and Safari, in Light + Table, Adobe + Brackets, Bitbucket, + and many other projects.
+ +Development and bug tracking happens + on github + (alternate git + repository). + Please read these + pointers before submitting a bug. Use pull requests to submit + patches. All contributions must be released under the same MIT + license that CodeMirror uses.
+ +Discussion around the project is done on + a discussion forum. + Announcements related to the project, such as new versions, are + posted in the + forum's "announce" + category. If needed, you can + contact the maintainer + directly. We aim to be an inclusive, welcoming community. To make + that explicit, we have + a code of + conduct that applies to communication around the project.
+ +A list of CodeMirror-related software that is not part of the + main distribution is maintained + on our + wiki. Feel free to add your project.
+Browser support
+The desktop versions of the following browsers,
+ in standards mode (HTML5 <!doctype html>
+ recommended) are supported:
| Firefox | version 4 and up |
|---|---|
| Chrome | any version |
| Safari | version 5.2 and up |
| Internet Explorer/Edge | version 8 and up |
| Opera | version 9 and up |
Support for modern mobile browsers is experimental. Recent + versions of the iOS browser and Chrome on Android should work + pretty well.
+'; + if (!regArgs) { + for (var registerName in registers) { + var text = registers[registerName].toString(); + if (text.length) { + regInfo += '"' + registerName + ' ' + text + '
'; + } + } + } else { + var registerName; + regArgs = regArgs.join(''); + for (var i = 0; i < regArgs.length; i++) { + registerName = regArgs.charAt(i); + if (!vimGlobalState.registerController.isValidRegister(registerName)) { + continue; + } + var register = registers[registerName] || new Register(); + regInfo += '"' + registerName + ' ' + register.toString() + '
'; + } + } + showConfirm(cm, regInfo); + }, + sort: function(cm, params) { + var reverse, ignoreCase, unique, number, pattern; + function parseArgs() { + if (params.argString) { + var args = new CodeMirror.StringStream(params.argString); + if (args.eat('!')) { reverse = true; } + if (args.eol()) { return; } + if (!args.eatSpace()) { return 'Invalid arguments'; } + var opts = args.match(/([dinuox]+)?\s*(\/.+\/)?\s*/); + if (!opts && !args.eol()) { return 'Invalid arguments'; } + if (opts[1]) { + ignoreCase = opts[1].indexOf('i') != -1; + unique = opts[1].indexOf('u') != -1; + var decimal = opts[1].indexOf('d') != -1 || opts[1].indexOf('n') != -1 && 1; + var hex = opts[1].indexOf('x') != -1 && 1; + var octal = opts[1].indexOf('o') != -1 && 1; + if (decimal + hex + octal > 1) { return 'Invalid arguments'; } + number = decimal && 'decimal' || hex && 'hex' || octal && 'octal'; + } + if (opts[2]) { + pattern = new RegExp(opts[2].substr(1, opts[2].length - 2), ignoreCase ? 'i' : ''); + } + } + } + var err = parseArgs(); + if (err) { + showConfirm(cm, err + ': ' + params.argString); + return; + } + var lineStart = params.line || cm.firstLine(); + var lineEnd = params.lineEnd || params.line || cm.lastLine(); + if (lineStart == lineEnd) { return; } + var curStart = Pos(lineStart, 0); + var curEnd = Pos(lineEnd, lineLength(cm, lineEnd)); + var text = cm.getRange(curStart, curEnd).split('\n'); + var numberRegex = pattern ? pattern : + (number == 'decimal') ? /(-?)([\d]+)/ : + (number == 'hex') ? /(-?)(?:0x)?([0-9a-f]+)/i : + (number == 'octal') ? /([0-7]+)/ : null; + var radix = (number == 'decimal') ? 10 : (number == 'hex') ? 16 : (number == 'octal') ? 8 : null; + var numPart = [], textPart = []; + if (number || pattern) { + for (var i = 0; i < text.length; i++) { + var matchPart = pattern ? text[i].match(pattern) : null; + if (matchPart && matchPart[0] != '') { + numPart.push(matchPart); + } else if (!pattern && numberRegex.exec(text[i])) { + numPart.push(text[i]); + } else { + textPart.push(text[i]); + } + } + } else { + textPart = text; + } + function compareFn(a, b) { + if (reverse) { var tmp; tmp = a; a = b; b = tmp; } + if (ignoreCase) { a = a.toLowerCase(); b = b.toLowerCase(); } + var anum = number && numberRegex.exec(a); + var bnum = number && numberRegex.exec(b); + if (!anum) { return a < b ? -1 : 1; } + anum = parseInt((anum[1] + anum[2]).toLowerCase(), radix); + bnum = parseInt((bnum[1] + bnum[2]).toLowerCase(), radix); + return anum - bnum; + } + function comparePatternFn(a, b) { + if (reverse) { var tmp; tmp = a; a = b; b = tmp; } + if (ignoreCase) { a[0] = a[0].toLowerCase(); b[0] = b[0].toLowerCase(); } + return (a[0] < b[0]) ? -1 : 1; + } + numPart.sort(pattern ? comparePatternFn : compareFn); + if (pattern) { + for (var i = 0; i < numPart.length; i++) { + numPart[i] = numPart[i].input; + } + } else if (!number) { textPart.sort(compareFn); } + text = (!reverse) ? textPart.concat(numPart) : numPart.concat(textPart); + if (unique) { // Remove duplicate lines + var textOld = text; + var lastLine; + text = []; + for (var i = 0; i < textOld.length; i++) { + if (textOld[i] != lastLine) { + text.push(textOld[i]); + } + lastLine = textOld[i]; + } + } + cm.replaceRange(text.join('\n'), curStart, curEnd); + }, + global: function(cm, params) { + // a global command is of the form + // :[range]g/pattern/[cmd] + // argString holds the string /pattern/[cmd] + var argString = params.argString; + if (!argString) { + showConfirm(cm, 'Regular Expression missing from global'); + return; + } + // range is specified here + var lineStart = (params.line !== undefined) ? params.line : cm.firstLine(); + var lineEnd = params.lineEnd || params.line || cm.lastLine(); + // get the tokens from argString + var tokens = splitBySlash(argString); + var regexPart = argString, cmd; + if (tokens.length) { + regexPart = tokens[0]; + cmd = tokens.slice(1, tokens.length).join('/'); + } + if (regexPart) { + // If regex part is empty, then use the previous query. Otherwise + // use the regex part as the new query. + try { + updateSearchQuery(cm, regexPart, true /** ignoreCase */, + true /** smartCase */); + } catch (e) { + showConfirm(cm, 'Invalid regex: ' + regexPart); + return; + } + } + // now that we have the regexPart, search for regex matches in the + // specified range of lines + var query = getSearchState(cm).getQuery(); + var matchedLines = [], content = ''; + for (var i = lineStart; i <= lineEnd; i++) { + var matched = query.test(cm.getLine(i)); + if (matched) { + matchedLines.push(i+1); + content+= cm.getLine(i) + '
'; + } + } + // if there is no [cmd], just display the list of matched lines + if (!cmd) { + showConfirm(cm, content); + return; + } + var index = 0; + var nextCommand = function() { + if (index < matchedLines.length) { + var command = matchedLines[index] + cmd; + exCommandDispatcher.processCommand(cm, command, { + callback: nextCommand + }); + } + index++; + }; + nextCommand(); + }, + substitute: function(cm, params) { + if (!cm.getSearchCursor) { + throw new Error('Search feature not available. Requires searchcursor.js or ' + + 'any other getSearchCursor implementation.'); + } + var argString = params.argString; + var tokens = argString ? splitBySlash(argString) : []; + var regexPart, replacePart = '', trailing, flagsPart, count; + var confirm = false; // Whether to confirm each replace. + var global = false; // True to replace all instances on a line, false to replace only 1. + if (tokens.length) { + regexPart = tokens[0]; + replacePart = tokens[1]; + if (regexPart && regexPart[regexPart.length - 1] === '$') { + regexPart = regexPart.slice(0, regexPart.length - 1) + '\\n'; + replacePart = replacePart ? replacePart + '\n' : '\n'; + } + if (replacePart !== undefined) { + if (getOption('pcre')) { + replacePart = unescapeRegexReplace(replacePart); + } else { + replacePart = translateRegexReplace(replacePart); + } + vimGlobalState.lastSubstituteReplacePart = replacePart; + } + trailing = tokens[2] ? tokens[2].split(' ') : []; + } else { + // either the argString is empty or its of the form ' hello/world' + // actually splitBySlash returns a list of tokens + // only if the string starts with a '/' + if (argString && argString.length) { + showConfirm(cm, 'Substitutions should be of the form ' + + ':s/pattern/replace/'); + return; + } + } + // After the 3rd slash, we can have flags followed by a space followed + // by count. + if (trailing) { + flagsPart = trailing[0]; + count = parseInt(trailing[1]); + if (flagsPart) { + if (flagsPart.indexOf('c') != -1) { + confirm = true; + flagsPart.replace('c', ''); + } + if (flagsPart.indexOf('g') != -1) { + global = true; + flagsPart.replace('g', ''); + } + regexPart = regexPart + '/' + flagsPart; + } + } + if (regexPart) { + // If regex part is empty, then use the previous query. Otherwise use + // the regex part as the new query. + try { + updateSearchQuery(cm, regexPart, true /** ignoreCase */, + true /** smartCase */); + } catch (e) { + showConfirm(cm, 'Invalid regex: ' + regexPart); + return; + } + } + replacePart = replacePart || vimGlobalState.lastSubstituteReplacePart; + if (replacePart === undefined) { + showConfirm(cm, 'No previous substitute regular expression'); + return; + } + var state = getSearchState(cm); + var query = state.getQuery(); + var lineStart = (params.line !== undefined) ? params.line : cm.getCursor().line; + var lineEnd = params.lineEnd || lineStart; + if (lineStart == cm.firstLine() && lineEnd == cm.lastLine()) { + lineEnd = Infinity; + } + if (count) { + lineStart = lineEnd; + lineEnd = lineStart + count - 1; + } + var startPos = clipCursorToContent(cm, Pos(lineStart, 0)); + var cursor = cm.getSearchCursor(query, startPos); + doReplace(cm, confirm, global, lineStart, lineEnd, cursor, query, replacePart, params.callback); + }, + redo: CodeMirror.commands.redo, + undo: CodeMirror.commands.undo, + write: function(cm) { + if (CodeMirror.commands.save) { + // If a save command is defined, call it. + CodeMirror.commands.save(cm); + } else if (cm.save) { + // Saves to text area if no save command is defined and cm.save() is available. + cm.save(); + } + }, + nohlsearch: function(cm) { + clearSearchHighlight(cm); + }, + yank: function (cm) { + var cur = copyCursor(cm.getCursor()); + var line = cur.line; + var lineText = cm.getLine(line); + vimGlobalState.registerController.pushText( + '0', 'yank', lineText, true, true); + }, + delmarks: function(cm, params) { + if (!params.argString || !trim(params.argString)) { + showConfirm(cm, 'Argument required'); + return; + } + + var state = cm.state.vim; + var stream = new CodeMirror.StringStream(trim(params.argString)); + while (!stream.eol()) { + stream.eatSpace(); + + // Record the streams position at the beginning of the loop for use + // in error messages. + var count = stream.pos; + + if (!stream.match(/[a-zA-Z]/, false)) { + showConfirm(cm, 'Invalid argument: ' + params.argString.substring(count)); + return; + } + + var sym = stream.next(); + // Check if this symbol is part of a range + if (stream.match('-', true)) { + // This symbol is part of a range. + + // The range must terminate at an alphabetic character. + if (!stream.match(/[a-zA-Z]/, false)) { + showConfirm(cm, 'Invalid argument: ' + params.argString.substring(count)); + return; + } + + var startMark = sym; + var finishMark = stream.next(); + // The range must terminate at an alphabetic character which + // shares the same case as the start of the range. + if (isLowerCase(startMark) && isLowerCase(finishMark) || + isUpperCase(startMark) && isUpperCase(finishMark)) { + var start = startMark.charCodeAt(0); + var finish = finishMark.charCodeAt(0); + if (start >= finish) { + showConfirm(cm, 'Invalid argument: ' + params.argString.substring(count)); + return; + } + + // Because marks are always ASCII values, and we have + // determined that they are the same case, we can use + // their char codes to iterate through the defined range. + for (var j = 0; j <= finish - start; j++) { + var mark = String.fromCharCode(start + j); + delete state.marks[mark]; + } + } else { + showConfirm(cm, 'Invalid argument: ' + startMark + '-'); + return; + } + } else { + // This symbol is a valid mark, and is not part of a range. + delete state.marks[sym]; + } + } + } + }; + + var exCommandDispatcher = new ExCommandDispatcher(); + + /** + * @param {CodeMirror} cm CodeMirror instance we are in. + * @param {boolean} confirm Whether to confirm each replace. + * @param {Cursor} lineStart Line to start replacing from. + * @param {Cursor} lineEnd Line to stop replacing at. + * @param {RegExp} query Query for performing matches with. + * @param {string} replaceWith Text to replace matches with. May contain $1, + * $2, etc for replacing captured groups using Javascript replace. + * @param {function()} callback A callback for when the replace is done. + */ + function doReplace(cm, confirm, global, lineStart, lineEnd, searchCursor, query, + replaceWith, callback) { + // Set up all the functions. + cm.state.vim.exMode = true; + var done = false; + var lastPos = searchCursor.from(); + function replaceAll() { + cm.operation(function() { + while (!done) { + replace(); + next(); + } + stop(); + }); + } + function replace() { + var text = cm.getRange(searchCursor.from(), searchCursor.to()); + var newText = text.replace(query, replaceWith); + searchCursor.replace(newText); + } + function next() { + // The below only loops to skip over multiple occurrences on the same + // line when 'global' is not true. + while(searchCursor.findNext() && + isInRange(searchCursor.from(), lineStart, lineEnd)) { + if (!global && lastPos && searchCursor.from().line == lastPos.line) { + continue; + } + cm.scrollIntoView(searchCursor.from(), 30); + cm.setSelection(searchCursor.from(), searchCursor.to()); + lastPos = searchCursor.from(); + done = false; + return; + } + done = true; + } + function stop(close) { + if (close) { close(); } + cm.focus(); + if (lastPos) { + cm.setCursor(lastPos); + var vim = cm.state.vim; + vim.exMode = false; + vim.lastHPos = vim.lastHSPos = lastPos.ch; + } + if (callback) { callback(); } + } + function onPromptKeyDown(e, _value, close) { + // Swallow all keys. + CodeMirror.e_stop(e); + var keyName = CodeMirror.keyName(e); + switch (keyName) { + case 'Y': + replace(); next(); break; + case 'N': + next(); break; + case 'A': + // replaceAll contains a call to close of its own. We don't want it + // to fire too early or multiple times. + var savedCallback = callback; + callback = undefined; + cm.operation(replaceAll); + callback = savedCallback; + break; + case 'L': + replace(); + // fall through and exit. + case 'Q': + case 'Esc': + case 'Ctrl-C': + case 'Ctrl-[': + stop(close); + break; + } + if (done) { stop(close); } + return true; + } + + // Actually do replace. + next(); + if (done) { + showConfirm(cm, 'No matches for ' + query.source); + return; + } + if (!confirm) { + replaceAll(); + if (callback) { callback(); }; + return; + } + showPrompt(cm, { + prefix: 'replace with ' + replaceWith + ' (y/n/a/q/l)', + onKeyDown: onPromptKeyDown + }); + } + + CodeMirror.keyMap.vim = { + attach: attachVimMap, + detach: detachVimMap, + call: cmKey + }; + + function exitInsertMode(cm) { + var vim = cm.state.vim; + var macroModeState = vimGlobalState.macroModeState; + var insertModeChangeRegister = vimGlobalState.registerController.getRegister('.'); + var isPlaying = macroModeState.isPlaying; + var lastChange = macroModeState.lastInsertModeChanges; + // In case of visual block, the insertModeChanges are not saved as a + // single word, so we convert them to a single word + // so as to update the ". register as expected in real vim. + var text = []; + if (!isPlaying) { + var selLength = lastChange.inVisualBlock && vim.lastSelection ? + vim.lastSelection.visualBlock.height : 1; + var changes = lastChange.changes; + var text = []; + var i = 0; + // In case of multiple selections in blockwise visual, + // the inserted text, for example: 'f
APL mode
+ + + + +Simple mode that tries to handle APL as well as it can.
+It attempts to label functions/operators based upon + monadic/dyadic usage (but this is far from fully fleshed out). + This means there are meaningful classnames so hover states can + have popups etc.
+ +MIME types defined: text/apl (APL code)
ASCII Armor (PGP) mode
+ + + + +MIME types
+defined: application/pgp, application/pgp-encrypted, application/pgp-keys, application/pgp-signature
ASN.1 example
+
+
+
+
+
+ +
Language: Abstract Syntax Notation One + (ASN.1) +
+MIME types defined: text/x-ttcn-asn
+
The development of this mode has been sponsored by Ericsson + .
+Coded by Asmelash Tsegay Gebretsadkan
+Asterisk dialplan mode
+ + + +MIME types defined: text/x-asterisk.
Brainfuck mode
+ + + + +A mode for Brainfuck
+ +MIME types defined: text/x-brainfuck
C-like mode
+ + + +C++ example
+ + + +Objective-C example
+ + + +Java example
+ + + +Scala example
+ + + +Kotlin mode
+ + + +Ceylon mode
+ + + + + +Simple mode that tries to handle C-like languages as well as it
+ can. Takes two configuration parameters: keywords, an
+ object whose property names are the keywords in the language,
+ and useCPP, which determines whether C preprocessor
+ directives are recognized.
MIME types defined: text/x-csrc
+ (C), text/x-c++src (C++), text/x-java
+ (Java), text/x-csharp (C#),
+ text/x-objectivec (Objective-C),
+ text/x-scala (Scala), text/x-vertex
+ x-shader/x-fragment (shader programs),
+ text/x-squirrel (Squirrel) and
+ text/x-ceylon (Ceylon)
Scala mode
+ + + +Clojure mode
+ + + +MIME types defined: text/x-clojure.
CMake mode
+ + + +MIME types defined: text/x-cmake.
COBOL mode
+ +Select Theme Select Font Size + + + + +
+ + +CoffeeScript mode
+ + + +MIME types defined: application/vnd.coffeescript, text/coffeescript, text/x-coffeescript.
The CoffeeScript mode was written by Jeff Pickhardt.
+ +Common Lisp mode
+ + + +MIME types defined: text/x-common-lisp.
Crystal mode
+ + + +MIME types defined: text/x-crystal.
Closure Stylesheets (GSS) mode
+ + + +A mode for Closure Stylesheets (GSS).
+MIME type defined: text/x-gss.
CSS mode
+ + + +MIME types defined: text/css, text/x-scss (demo), text/x-less (demo).
LESS mode
+ + + +The LESS mode is a sub-mode of the CSS mode (defined in css.js).
SCSS mode
+ + + +The SCSS mode is a sub-mode of the CSS mode (defined in css.js).
Cypher Mode for CodeMirror
+ +MIME types defined:
+ application/x-cypher-query
+
D mode
+ + + + +Simple mode that handle D-Syntax (DLang Homepage).
+ +MIME types defined: text/x-d
+ .
Dart mode
+ + + + +Diff mode
+ + + +MIME types defined: text/x-diff.
Django template mode
+ + + + +Mode for HTML with embedded Django template markup.
+ +MIME types defined: text/x-django
Dockerfile mode
+ + + + +Dockerfile syntax highlighting for CodeMirror. Depends on + the simplemode addon.
+ +MIME types defined: text/x-dockerfile
DTD mode
+ + + +MIME types defined: application/xml-dtd.
Dylan mode
+ + + + + + +MIME types defined: text/x-dylan.
EBNF Mode (bracesMode setting = "javascript")
+ + +The EBNF Mode
+Created by Robert Plummer
+ECL mode
+ + + +Based on CodeMirror's clike mode. For more information see HPCC Systems web site.
+MIME types defined: text/x-ecl.
Eiffel mode
+ + + +MIME types defined: text/x-eiffel.
Created by YNH.
+Elm mode
+ + + + + +MIME types defined: text/x-elm.
Erlang mode
+ + + + +MIME types defined: text/x-erlang.
Factor mode
+ + + + + +Simple mode that handles Factor Syntax (Factor on WikiPedia).
+ +MIME types defined: text/x-factor.
FCL mode
+ + + + +MIME type: text/x-fcl
Forth mode
+ + + + + +Simple mode that handle Forth-Syntax (Forth on WikiPedia).
+ +MIME types defined: text/x-forth.
Fortran mode
+ + + + + + +MIME types defined: text/x-fortran.
Gas mode
+ + + + +Handles AT&T assembler syntax (more specifically this handles
+ the GNU Assembler (gas) syntax.)
+ It takes a single optional configuration parameter:
+ architecture, which can be one of "ARM",
+ "ARMv6" or "x86".
+ Including the parameter adds syntax for the registers and special
+ directives for the supplied architecture.
+
+
MIME types defined: text/x-gas
GFM mode
+ + + + +Optionally depends on other modes for properly highlighted code blocks.
+ +Gfm mode supports these options (apart those from base Markdown mode):
+-
+
-
+
+ +gitHubSpice: boolean- Hashes, issues... (default:
+true).
+ -
+
+ +taskLists: boolean- [ ]syntax (default:true).
+ -
+
+ +strikethrough: boolean~~foo~~syntax (default:true).
+ -
+
+ +emoji: boolean:emoji:syntax (default:true).
+
Gherkin mode
+ + + +MIME types defined: text/x-feature.
Go mode
+ + + + +MIME type: text/x-go
Groovy mode
+ + + + +MIME types defined: text/x-groovy
HAML mode
+ + + +MIME types defined: text/x-haml.
Handlebars
+ + + +Handlebars syntax highlighting for CodeMirror.
+ +MIME types defined: text/x-handlebars-template
Supported options: base to set the mode to
+ wrap. For example, use
mode: {name: "handlebars", base: "text/html"}
+ to highlight an HTML template.
+Haskell literate mode
+ + +MIME types
+ defined: text/x-literate-haskell.
Parser configuration parameters recognized: base to
+ set the base mode (defaults to "haskell").
Haskell mode
+ + + + +MIME types defined: text/x-haskell.
Haxe mode
+ + +
+
+
+
+
+
+ Hxml mode:
+ + +MIME types defined: text/x-haxe, text/x-hxml.
Html Embedded Scripts mode
+ + + + +Mode for html embedded scripts like JSP and ASP.NET. Depends on multiplex and HtmlMixed which in turn depends on
+ JavaScript, CSS and XML.
Other dependencies include those of the scripting language chosen.
MIME types defined: application/x-aspx (ASP.NET),
+ application/x-ejs (Embedded Javascript), application/x-jsp (JavaServer Pages)
+ and application/x-erb
HTML mixed mode
+ + + +The HTML mixed mode depends on the XML, JavaScript, and CSS modes.
+ +It takes an optional mode configuration
+ option, tags, which can be used to add custom
+ behavior for specific tags. When given, it should be an object
+ mapping tag names (for example script) to arrays or
+ three-element arrays. Those inner arrays indicate [attributeName,
+ valueRegexp, modeSpec]
+ specifications. For example, you could use ["type", /^foo$/,
+ "foo"] to map the attribute type="foo" to
+ the foo mode. When the first two fields are null
+ ([null, null, "mode"]), the given mode is used for
+ any such tag that doesn't match any of the previously given
+ attributes. For example:
var myModeSpec = {
+ name: "htmlmixed",
+ tags: {
+ style: [["type", /^text\/(x-)?scss$/, "text/x-scss"],
+ [null, null, "css"]],
+ custom: [[null, null, "customMode"]]
+ }
+}
+
+ MIME types defined: text/html
+ (redefined, only takes effect if you load this parser after the
+ XML parser).
HTTP mode
+ + + + + + +MIME types defined: message/http.
IDL mode
+ + + + +MIME types defined: text/x-idl.
Language modes
+ +This is a list of every mode in the distribution. Each mode lives
+in a subdirectory of the mode/ directory, and typically
+defines a single JavaScript file that implements the mode. Loading
+such file will make the language available to CodeMirror, through
+the mode
+option.
+
+
+-
+
- APL +
- ASN.1 +
- Asterisk dialplan +
- Brainfuck +
- C, C++, C# +
- Ceylon +
- Clojure +
- Closure Stylesheets (GSS) +
- CMake +
- COBOL +
- CoffeeScript +
- Common Lisp +
- Crystal +
- CSS +
- Cypher +
- Cython +
- D +
- Dart +
- Django (templating language) +
- Dockerfile +
- diff +
- DTD +
- Dylan +
- EBNF +
- ECL +
- Eiffel +
- Elixir +
- Elm +
- Erlang +
- Factor +
- FCL +
- Forth +
- Fortran +
- F# +
- Gas (AT&T-style assembly) +
- Gherkin +
- Go +
- Groovy +
- HAML +
- Handlebars +
- Haskell (Literate) +
- Haxe +
- HTML embedded (JSP, ASP.NET) +
- HTML mixed-mode +
- HTTP +
- IDL +
- Java +
- JavaScript (JSX) +
- Jinja2 +
- Julia +
- Kotlin +
- LESS +
- LiveScript +
- Lua +
- Markdown (GitHub-flavour) +
- Mathematica +
- mbox +
- mIRC +
- Modelica +
- MscGen +
- MUMPS +
- Nginx +
- NSIS +
- N-Triples/N-Quads +
- Objective C +
- OCaml +
- Octave (MATLAB) +
- Oz +
- Pascal +
- PEG.js +
- Perl +
- PGP (ASCII armor) +
- PHP +
- Pig Latin +
- PowerShell +
- Properties files +
- ProtoBuf +
- Pug +
- Puppet +
- Python +
- Q +
- R +
- RPM +
- reStructuredText +
- Ruby +
- Rust +
- SAS +
- Sass +
- Spreadsheet +
- Scala +
- Scheme +
- SCSS +
- Shell +
- Sieve +
- Slim +
- Smalltalk +
- Smarty +
- Solr +
- Soy +
- Stylus +
- SQL (several dialects) +
- SPARQL +
- Squirrel +
- Swift +
- sTeX, LaTeX +
- Tcl +
- Textile +
- Tiddlywiki +
- Tiki wiki +
- TOML +
- Tornado (templating language) +
- troff (for manpages) +
- TTCN +
- TTCN Configuration +
- Turtle +
- Twig +
- VB.NET +
- VBScript +
- Velocity +
- Verilog/SystemVerilog +
- VHDL +
- Vue.js app +
- Web IDL +
- XML/HTML +
- XQuery +
- Yacas +
- YAML +
- YAML frontmatter +
- Z80 +
JavaScript mode
+ + + + + + ++ JavaScript mode supports several configuration options: +
-
+
jsonwhich will set the mode to expect JSON + data rather than a JavaScript program.
+ jsonldwhich will set the mode to expect + JSON-LD linked data rather + than a JavaScript program (demo).
+ typescriptwhich will activate additional + syntax highlighting and some other things for TypeScript code + (demo).
+ statementIndentwhich (given a number) will + determine the amount of indentation to use for statements + continued on a new line.
+ wordCharacters, a regexp that indicates which + characters should be considered part of an identifier. + Defaults to/[\w$]/, which does not handle + non-ASCII identifiers. Can be set to something more elaborate + to improve Unicode support.
+
MIME types defined: text/javascript, application/json, application/ld+json, text/typescript, application/typescript.
JSON-LD mode
+ + + + + + +This is a specialization of the JavaScript mode.
+TypeScript mode
+ + + + + + +This is a specialization of the JavaScript mode.
+Jinja2 mode
+ + +JSX mode
+ + + + + +JSX Mode for React's +JavaScript syntax extension.
+ +MIME types defined: text/jsx, text/typescript-jsx.
${] [number 10] [string-2 }`]")
+
+ MT("line_comment",
+ "([bracket&tag <][tag foo] [comment // hello]",
+ " [bracket&tag >][operator ++])")
+
+ MT("line_comment_not_in_tag",
+ "([bracket&tag <][tag foo][bracket&tag >] // hello",
+ " [bracket&tag ][operator ++])")
+
+ MT("block_comment",
+ "([bracket&tag <][tag foo] [comment /* hello]",
+ "[comment line 2]",
+ "[comment line 3 */] [bracket&tag >][operator ++])")
+
+ MT("block_comment_not_in_tag",
+ "([bracket&tag <][tag foo][bracket&tag >]/* hello",
+ " line 2",
+ " line 3 */ [bracket&tag ][operator ++])")
+
+ MT("missing_attr",
+ "([bracket&tag <][tag foo] [attribute selected][bracket&tag />][operator ++])")
+
+ MT("indent_js",
+ "([bracket&tag <][tag foo][bracket&tag >]",
+ " [bracket&tag <][tag bar] [attribute baz]={[keyword function]() {",
+ " [keyword return] [number 10]",
+ " }}[bracket&tag />]",
+ " [bracket&tag ])")
+
+ MT("spread",
+ "([bracket&tag <][tag foo] [attribute bar]={[meta ...][variable baz] [operator /][number 2]}[bracket&tag />])")
+
+ MT("tag_attribute",
+ "([bracket&tag <][tag foo] [attribute bar]=[bracket&tag <][tag foo][bracket&tag />/>][operator ++])")
+
+ var ts_mode = CodeMirror.getMode({indentUnit: 2}, "text/typescript-jsx")
+ function TS(name) { test.mode(name, ts_mode, Array.prototype.slice.call(arguments, 1)) }
+
+ TS("tsx_react_integration",
+ "[keyword interface] [def Props] {",
+ " [property foo]: [type string];",
+ "}",
+ "[keyword class] [def MyComponent] [keyword extends] [type React].[type Component] [operator <] [type Props], [type any] [operator >] {",
+ " [property render]() {",
+ " [keyword return] [bracket&tag <][tag span][bracket&tag >]{[keyword this].[property props].[property foo]}[bracket&tag ]",
+ " }",
+ "}",
+ "[bracket&tag <][tag MyComponent] [attribute foo]=[string \"bar\"] [bracket&tag />]; [comment //ok]",
+ "[bracket&tag <][tag MyComponent] [attribute foo]={[number 0]} [bracket&tag />]; [comment //error]")
+
+})()
diff --git a/backend/webif/static/codemirror/mode/julia/index.html b/backend/webif/static/codemirror/mode/julia/index.html
new file mode 100755
index 000000000..e1492c210
--- /dev/null
+++ b/backend/webif/static/codemirror/mode/julia/index.html
@@ -0,0 +1,195 @@
+
+
+Julia mode
+ + + + +MIME types defined: text/x-julia.
LiveScript mode
+ + + +MIME types defined: text/x-livescript.
The LiveScript mode was written by Kenneth Bentley.
+ +Lua mode
+ + + +Loosely based on Franciszek
+ Wawrzak's CodeMirror
+ 1 mode. One configuration parameter is
+ supported, specials, to which you can provide an
+ array of strings to have those identifiers highlighted with
+ the lua-special style.
MIME types defined: text/x-lua.
Markdown mode
+ + + + +If you also want support strikethrough, emoji and few other goodies, check out Github-Flavored Markdown mode.
Optionally depends on other modes for properly highlighted code blocks, + and XML mode for properly highlighted inline XML blocks.
+ +Markdown mode supports these options:
+-
+
-
+
+ +highlightFormatting: boolean- Whether to separately highlight markdown meta characterts (
+*[]()etc.) (default:false).
+ -
+
+ +maxBlockquoteDepth: boolean- Maximum allowed blockquote nesting (default:
+0- infinite nesting).
+ -
+
+ +xml: boolean- Whether to highlight inline XML (default:
+true).
+ -
+
+ +fencedCodeBlockHighlighting: boolean- Whether to syntax-highlight fenced code blocks, if given mode is included (default:
+true).
+ -
+
+ +tokenTypeOverrides: Object- When you want ot override default token type names (e.g.
+{code: "code"}).
+ -
+
+ +allowAtxHeaderWithoutSpace: boolean- Allow lazy headers without whitespace between hashtag and text (default:
+false).
+
MIME types defined: text/x-markdown.
foo
");
+
+})();
diff --git a/backend/webif/static/codemirror/mode/mathematica/index.html b/backend/webif/static/codemirror/mode/mathematica/index.html
new file mode 100755
index 000000000..57c429853
--- /dev/null
+++ b/backend/webif/static/codemirror/mode/mathematica/index.html
@@ -0,0 +1,72 @@
+
+
+Mathematica mode
+ + + + + + +MIME types defined: text/x-mathematica (Mathematica).
mbox mode
+ + + +MIME types defined: application/mbox.
mIRC mode
+ + + +MIME types defined: text/mirc.
OCaml mode
+ + + + +F# mode
+ + + + + +MIME types defined: text/x-ocaml (OCaml) and text/x-fsharp (F#).
Modelica mode
+ + + + + +Simple mode that tries to handle Modelica as well as it can.
+ +MIME types defined: text/x-modelica
+ (Modlica code).
MscGen mode
+ + + +Xù mode
+ + + +MsGenny mode
+ + ++ Simple mode for highlighting MscGen and two derived sequence + chart languages. +
+ + + +MIME types defined:
+ text/x-mscgen
+ text/x-xu
+ text/x-msgenny
+
MUMPS mode
+ + + + + +NGINX mode
+ + + +MIME types defined: text/nginx.
NSIS mode
+ + + + + + +MIME types defined: text/x-nsis.
N-Triples mode
+The N-Triples mode also works well with on + N-Quad documents. +
+ + + +MIME types defined: application/n-triples.
+
N-Quads add a fourth + element to the statement to track which graph the statement is from. + Otherwise, it's identical to N-Triples.
+ + + +MIME types defined: application/n-quads.
Octave mode
+ + + + +MIME types defined: text/x-octave.
Oz mode
+ +MIME type defined: text/x-oz.
Pascal mode
+ + + + + + +MIME types defined: text/x-pascal.
PEG.js Mode
+ + +The PEG.js Mode
+Created by Forbes Lindesay.
+Perl mode
+ + + + + + +MIME types defined: text/x-perl.
PHP mode
+ + + + +Simple HTML/PHP mode based on + the C-like mode. Depends on XML, + JavaScript, CSS, HTMLMixed, and C-like modes.
+ +MIME types defined: application/x-httpd-php (HTML with PHP code), text/x-php (plain, non-wrapped PHP code).
Pig Latin mode
+ + + + ++ Simple mode that handles Pig Latin language. +
+ +MIME type defined: text/x-pig
+ (PIG code)
+
PowerShell mode
+ + + + +MIME types defined: application/x-powershell.
Properties files mode
+ + + +MIME types defined: text/x-properties,
+ text/x-ini.
ProtoBuf mode
+ + + +MIME types defined: text/x-protobuf.
Pug Templating Mode
+ + +The Pug Templating Mode
+Created by Forbes Lindesay. Managed as part of a Brackets extension at https://github.com/ForbesLindesay/jade-brackets.
+MIME type defined: text/x-pug, text/x-jade.
Puppet mode
+ + + +MIME types defined: text/x-puppet.
Python mode
+ + + + +Cython mode
+ + + + +Configuration Options for Python mode:
+-
+
- version - 2/3 - The version of Python to recognize. Default is 3. +
- singleLineStringErrors - true/false - If you have a single-line string that is not terminated at the end of the line, this will show subsequent lines as errors if true, otherwise it will consider the newline as the end of the string. Default is false. +
- hangingIndent - int - If you want to write long arguments to a function starting on a new line, how much that line should be indented. Defaults to one normal indentation unit. +
Advanced Configuration Options:
+Usefull for superset of python syntax like Enthought enaml, IPython magics and questionmark help
+-
+
- singleOperators - RegEx - Regular Expression for single operator matching, default :
^[\\+\\-\\*/%&|\\^~<>!]
including@
on Python 3
+ - singleDelimiters - RegEx - Regular Expression for single delimiter matching, default :
^[\\(\\)\\[\\]\\{\\}@,:`=;\\.]
+ - doubleOperators - RegEx - Regular Expression for double operators matching, default :
^((==)|(!=)|(<=)|(>=)|(<>)|(<<)|(>>)|(//)|(\\*\\*))
+ - doubleDelimiters - RegEx - Regular Expression for double delimiters matching, default :
^((\\+=)|(\\-=)|(\\*=)|(%=)|(/=)|(&=)|(\\|=)|(\\^=))
+ - tripleDelimiters - RegEx - Regular Expression for triple delimiters matching, default :
^((//=)|(>>=)|(<<=)|(\\*\\*=))
+ - identifiers - RegEx - Regular Expression for identifier, default :
^[_A-Za-z][_A-Za-z0-9]*
on Python 2 and^[_A-Za-z\u00A1-\uFFFF][_A-Za-z0-9\u00A1-\uFFFF]*
on Python 3.
+ - extra_keywords - list of string - List of extra words ton consider as keywords +
- extra_builtins - list of string - List of extra words ton consider as builtins +
MIME types defined: text/x-python and text/x-cython.
Q mode
+ + + + + + +MIME type defined: text/x-q.
R mode
+ + + +MIME types defined: text/x-rsrc.
Development of the CodeMirror R mode was kindly sponsored + by Ubalo.
+ +
RPM changes mode
+ + + + +MIME types defined: text/x-rpm-changes.
RPM changes mode
+ + + + +RPM spec mode
+ + + + +MIME types defined: text/x-rpm-spec, text/x-rpm-changes.
reStructuredText mode
+ + + +
+ The python mode will be used for highlighting blocks
+ containing Python/IPython terminal sessions: blocks starting with
+ >>> (for Python) or In [num]: (for
+ IPython).
+
+ Further, the stex mode will be used for highlighting
+ blocks containing LaTex code.
+
MIME types defined: text/x-rst.
Ruby mode
+ + + +MIME types defined: text/x-ruby.
Development of the CodeMirror Ruby mode was kindly sponsored + by Ubalo.
+ +Rust mode
+ + + + + + +MIME types defined: text/x-rustsrc.
SAS mode
+ + + + +MIME types defined: text/x-sas.
Sass mode
+ + + +MIME types defined: text/x-sass.
Scheme mode
+ + + +MIME types defined: text/x-scheme.
Shell mode
+ + + + + + +MIME types defined: text/x-sh, application/x-sh.
Sieve (RFC5228) mode
+ + + +MIME types defined: application/sieve.
SLIM mode
+ + + +MIME types defined: application/x-slim.
Smalltalk mode
+ + + + +Simple Smalltalk mode.
+ +MIME types defined: text/x-stsrc.
Smarty mode
+ + +Mode for Smarty version 2 or 3, which allows for custom delimiter tags.
+ +Several configuration parameters are supported:
+ +-
+
leftDelimiterandrightDelimiter, + which should be strings that determine where the Smarty syntax + starts and ends.
+ version, which should be 2 or 3.
+ baseMode, which can be a mode spec + like"text/html"to set a different background mode.
+
MIME types defined: text/x-smarty
Smarty 2, custom delimiters
+ + + +Smarty 3
+ + + + + +Solr mode
+ +
+
+
+
+
+
+ MIME types defined: text/x-solr.
Soy (Closure Template) mode
+ + + + +A mode for Closure Templates (Soy).
+MIME type defined: text/x-soy.
SPARQL mode
+ + + +MIME types defined: application/sparql-query.
Spreadsheet mode
+ + + + +MIME types defined: text/x-spreadsheet.
The Spreadsheet Mode
+Created by Robert Plummer
+SQL Mode for CodeMirror
+ +MIME types defined:
+ text/x-sql,
+ text/x-mysql,
+ text/x-mariadb,
+ text/x-cassandra,
+ text/x-plsql,
+ text/x-mssql,
+ text/x-hive,
+ text/x-pgsql,
+ text/x-gql,
+ text/x-gpsql.
+ text/x-esper.
+
sTeX mode
+ + + +MIME types defined: text/x-stex.
Stylus mode
+ + + +MIME types defined: text/x-styl.
Created by Dmitry Kiselyov
+Swift mode
+ + + + +A simple mode for Swift
+ +MIME types defined: text/x-swift (Swift code)
Tcl mode
+ + + +MIME types defined: text/x-tcl.
Textile mode
+ + + +MIME types defined: text/x-textile.
]',
+ '[comment ]',
+ '',
+ '[header&header-1 h1. Welcome]',
+ '',
+ '[variable-2 * Item one]',
+ '[variable-2 * Item two]',
+ '',
+ '[comment Example]',
+ '',
+ '[comment ]',
+ '[comment
]');
+
+ MT('inlineHtml',
+ 'I can use HTML directly in my [comment Textile].');
+
+ /*
+ * No-Textile
+ */
+
+ MT('notextile',
+ '[string-2 notextile. *No* formatting]');
+
+ MT('notextileInline',
+ 'Use [string-2 ==*asterisks*==] for [strong *strong*] text.');
+
+ MT('notextileWithPre',
+ '[operator pre. *No* formatting]');
+
+ MT('notextileWithSpanningPre',
+ '[operator pre.. *No* formatting]',
+ '',
+ '[operator *No* formatting]');
+
+ /* Only toggling phrases between non-word chars. */
+
+ MT('phrase-in-word',
+ 'foo_bar_baz');
+
+ MT('phrase-non-word',
+ '[negative -x-] aaa-bbb ccc-ddd [negative -eee-] fff [negative -ggg-]');
+
+ MT('phrase-lone-dash',
+ 'foo - bar - baz');
+})();
diff --git a/backend/webif/static/codemirror/mode/textile/textile.js b/backend/webif/static/codemirror/mode/textile/textile.js
new file mode 100755
index 000000000..bc5a2f369
--- /dev/null
+++ b/backend/webif/static/codemirror/mode/textile/textile.js
@@ -0,0 +1,469 @@
+// CodeMirror, copyright (c) by Marijn Haverbeke and others
+// Distributed under an MIT license: http://codemirror.net/LICENSE
+
+(function(mod) {
+ if (typeof exports == "object" && typeof module == "object") { // CommonJS
+ mod(require("../../lib/codemirror"));
+ } else if (typeof define == "function" && define.amd) { // AMD
+ define(["../../lib/codemirror"], mod);
+ } else { // Plain browser env
+ mod(CodeMirror);
+ }
+})(function(CodeMirror) {
+ "use strict";
+
+ var TOKEN_STYLES = {
+ addition: "positive",
+ attributes: "attribute",
+ bold: "strong",
+ cite: "keyword",
+ code: "atom",
+ definitionList: "number",
+ deletion: "negative",
+ div: "punctuation",
+ em: "em",
+ footnote: "variable",
+ footCite: "qualifier",
+ header: "header",
+ html: "comment",
+ image: "string",
+ italic: "em",
+ link: "link",
+ linkDefinition: "link",
+ list1: "variable-2",
+ list2: "variable-3",
+ list3: "keyword",
+ notextile: "string-2",
+ pre: "operator",
+ p: "property",
+ quote: "bracket",
+ span: "quote",
+ specialChar: "tag",
+ strong: "strong",
+ sub: "builtin",
+ sup: "builtin",
+ table: "variable-3",
+ tableHeading: "operator"
+ };
+
+ function startNewLine(stream, state) {
+ state.mode = Modes.newLayout;
+ state.tableHeading = false;
+
+ if (state.layoutType === "definitionList" && state.spanningLayout &&
+ stream.match(RE("definitionListEnd"), false))
+ state.spanningLayout = false;
+ }
+
+ function handlePhraseModifier(stream, state, ch) {
+ if (ch === "_") {
+ if (stream.eat("_"))
+ return togglePhraseModifier(stream, state, "italic", /__/, 2);
+ else
+ return togglePhraseModifier(stream, state, "em", /_/, 1);
+ }
+
+ if (ch === "*") {
+ if (stream.eat("*")) {
+ return togglePhraseModifier(stream, state, "bold", /\*\*/, 2);
+ }
+ return togglePhraseModifier(stream, state, "strong", /\*/, 1);
+ }
+
+ if (ch === "[") {
+ if (stream.match(/\d+\]/)) state.footCite = true;
+ return tokenStyles(state);
+ }
+
+ if (ch === "(") {
+ var spec = stream.match(/^(r|tm|c)\)/);
+ if (spec)
+ return tokenStylesWith(state, TOKEN_STYLES.specialChar);
+ }
+
+ if (ch === "<" && stream.match(/(\w+)[^>]+>[^<]+<\/\1>/))
+ return tokenStylesWith(state, TOKEN_STYLES.html);
+
+ if (ch === "?" && stream.eat("?"))
+ return togglePhraseModifier(stream, state, "cite", /\?\?/, 2);
+
+ if (ch === "=" && stream.eat("="))
+ return togglePhraseModifier(stream, state, "notextile", /==/, 2);
+
+ if (ch === "-" && !stream.eat("-"))
+ return togglePhraseModifier(stream, state, "deletion", /-/, 1);
+
+ if (ch === "+")
+ return togglePhraseModifier(stream, state, "addition", /\+/, 1);
+
+ if (ch === "~")
+ return togglePhraseModifier(stream, state, "sub", /~/, 1);
+
+ if (ch === "^")
+ return togglePhraseModifier(stream, state, "sup", /\^/, 1);
+
+ if (ch === "%")
+ return togglePhraseModifier(stream, state, "span", /%/, 1);
+
+ if (ch === "@")
+ return togglePhraseModifier(stream, state, "code", /@/, 1);
+
+ if (ch === "!") {
+ var type = togglePhraseModifier(stream, state, "image", /(?:\([^\)]+\))?!/, 1);
+ stream.match(/^:\S+/); // optional Url portion
+ return type;
+ }
+ return tokenStyles(state);
+ }
+
+ function togglePhraseModifier(stream, state, phraseModifier, closeRE, openSize) {
+ var charBefore = stream.pos > openSize ? stream.string.charAt(stream.pos - openSize - 1) : null;
+ var charAfter = stream.peek();
+ if (state[phraseModifier]) {
+ if ((!charAfter || /\W/.test(charAfter)) && charBefore && /\S/.test(charBefore)) {
+ var type = tokenStyles(state);
+ state[phraseModifier] = false;
+ return type;
+ }
+ } else if ((!charBefore || /\W/.test(charBefore)) && charAfter && /\S/.test(charAfter) &&
+ stream.match(new RegExp("^.*\\S" + closeRE.source + "(?:\\W|$)"), false)) {
+ state[phraseModifier] = true;
+ state.mode = Modes.attributes;
+ }
+ return tokenStyles(state);
+ };
+
+ function tokenStyles(state) {
+ var disabled = textileDisabled(state);
+ if (disabled) return disabled;
+
+ var styles = [];
+ if (state.layoutType) styles.push(TOKEN_STYLES[state.layoutType]);
+
+ styles = styles.concat(activeStyles(
+ state, "addition", "bold", "cite", "code", "deletion", "em", "footCite",
+ "image", "italic", "link", "span", "strong", "sub", "sup", "table", "tableHeading"));
+
+ if (state.layoutType === "header")
+ styles.push(TOKEN_STYLES.header + "-" + state.header);
+
+ return styles.length ? styles.join(" ") : null;
+ }
+
+ function textileDisabled(state) {
+ var type = state.layoutType;
+
+ switch(type) {
+ case "notextile":
+ case "code":
+ case "pre":
+ return TOKEN_STYLES[type];
+ default:
+ if (state.notextile)
+ return TOKEN_STYLES.notextile + (type ? (" " + TOKEN_STYLES[type]) : "");
+ return null;
+ }
+ }
+
+ function tokenStylesWith(state, extraStyles) {
+ var disabled = textileDisabled(state);
+ if (disabled) return disabled;
+
+ var type = tokenStyles(state);
+ if (extraStyles)
+ return type ? (type + " " + extraStyles) : extraStyles;
+ else
+ return type;
+ }
+
+ function activeStyles(state) {
+ var styles = [];
+ for (var i = 1; i < arguments.length; ++i) {
+ if (state[arguments[i]])
+ styles.push(TOKEN_STYLES[arguments[i]]);
+ }
+ return styles;
+ }
+
+ function blankLine(state) {
+ var spanningLayout = state.spanningLayout, type = state.layoutType;
+
+ for (var key in state) if (state.hasOwnProperty(key))
+ delete state[key];
+
+ state.mode = Modes.newLayout;
+ if (spanningLayout) {
+ state.layoutType = type;
+ state.spanningLayout = true;
+ }
+ }
+
+ var REs = {
+ cache: {},
+ single: {
+ bc: "bc",
+ bq: "bq",
+ definitionList: /- .*?:=+/,
+ definitionListEnd: /.*=:\s*$/,
+ div: "div",
+ drawTable: /\|.*\|/,
+ foot: /fn\d+/,
+ header: /h[1-6]/,
+ html: /\s*<(?:\/)?(\w+)(?:[^>]+)?>(?:[^<]+<\/\1>)?/,
+ link: /[^"]+":\S/,
+ linkDefinition: /\[[^\s\]]+\]\S+/,
+ list: /(?:#+|\*+)/,
+ notextile: "notextile",
+ para: "p",
+ pre: "pre",
+ table: "table",
+ tableCellAttributes: /[\/\\]\d+/,
+ tableHeading: /\|_\./,
+ tableText: /[^"_\*\[\(\?\+~\^%@|-]+/,
+ text: /[^!"_=\*\[\(<\?\+~\^%@-]+/
+ },
+ attributes: {
+ align: /(?:<>|<|>|=)/,
+ selector: /\([^\(][^\)]+\)/,
+ lang: /\[[^\[\]]+\]/,
+ pad: /(?:\(+|\)+){1,2}/,
+ css: /\{[^\}]+\}/
+ },
+ createRe: function(name) {
+ switch (name) {
+ case "drawTable":
+ return REs.makeRe("^", REs.single.drawTable, "$");
+ case "html":
+ return REs.makeRe("^", REs.single.html, "(?:", REs.single.html, ")*", "$");
+ case "linkDefinition":
+ return REs.makeRe("^", REs.single.linkDefinition, "$");
+ case "listLayout":
+ return REs.makeRe("^", REs.single.list, RE("allAttributes"), "*\\s+");
+ case "tableCellAttributes":
+ return REs.makeRe("^", REs.choiceRe(REs.single.tableCellAttributes,
+ RE("allAttributes")), "+\\.");
+ case "type":
+ return REs.makeRe("^", RE("allTypes"));
+ case "typeLayout":
+ return REs.makeRe("^", RE("allTypes"), RE("allAttributes"),
+ "*\\.\\.?", "(\\s+|$)");
+ case "attributes":
+ return REs.makeRe("^", RE("allAttributes"), "+");
+
+ case "allTypes":
+ return REs.choiceRe(REs.single.div, REs.single.foot,
+ REs.single.header, REs.single.bc, REs.single.bq,
+ REs.single.notextile, REs.single.pre, REs.single.table,
+ REs.single.para);
+
+ case "allAttributes":
+ return REs.choiceRe(REs.attributes.selector, REs.attributes.css,
+ REs.attributes.lang, REs.attributes.align, REs.attributes.pad);
+
+ default:
+ return REs.makeRe("^", REs.single[name]);
+ }
+ },
+ makeRe: function() {
+ var pattern = "";
+ for (var i = 0; i < arguments.length; ++i) {
+ var arg = arguments[i];
+ pattern += (typeof arg === "string") ? arg : arg.source;
+ }
+ return new RegExp(pattern);
+ },
+ choiceRe: function() {
+ var parts = [arguments[0]];
+ for (var i = 1; i < arguments.length; ++i) {
+ parts[i * 2 - 1] = "|";
+ parts[i * 2] = arguments[i];
+ }
+
+ parts.unshift("(?:");
+ parts.push(")");
+ return REs.makeRe.apply(null, parts);
+ }
+ };
+
+ function RE(name) {
+ return (REs.cache[name] || (REs.cache[name] = REs.createRe(name)));
+ }
+
+ var Modes = {
+ newLayout: function(stream, state) {
+ if (stream.match(RE("typeLayout"), false)) {
+ state.spanningLayout = false;
+ return (state.mode = Modes.blockType)(stream, state);
+ }
+ var newMode;
+ if (!textileDisabled(state)) {
+ if (stream.match(RE("listLayout"), false))
+ newMode = Modes.list;
+ else if (stream.match(RE("drawTable"), false))
+ newMode = Modes.table;
+ else if (stream.match(RE("linkDefinition"), false))
+ newMode = Modes.linkDefinition;
+ else if (stream.match(RE("definitionList")))
+ newMode = Modes.definitionList;
+ else if (stream.match(RE("html"), false))
+ newMode = Modes.html;
+ }
+ return (state.mode = (newMode || Modes.text))(stream, state);
+ },
+
+ blockType: function(stream, state) {
+ var match, type;
+ state.layoutType = null;
+
+ if (match = stream.match(RE("type")))
+ type = match[0];
+ else
+ return (state.mode = Modes.text)(stream, state);
+
+ if (match = type.match(RE("header"))) {
+ state.layoutType = "header";
+ state.header = parseInt(match[0][1]);
+ } else if (type.match(RE("bq"))) {
+ state.layoutType = "quote";
+ } else if (type.match(RE("bc"))) {
+ state.layoutType = "code";
+ } else if (type.match(RE("foot"))) {
+ state.layoutType = "footnote";
+ } else if (type.match(RE("notextile"))) {
+ state.layoutType = "notextile";
+ } else if (type.match(RE("pre"))) {
+ state.layoutType = "pre";
+ } else if (type.match(RE("div"))) {
+ state.layoutType = "div";
+ } else if (type.match(RE("table"))) {
+ state.layoutType = "table";
+ }
+
+ state.mode = Modes.attributes;
+ return tokenStyles(state);
+ },
+
+ text: function(stream, state) {
+ if (stream.match(RE("text"))) return tokenStyles(state);
+
+ var ch = stream.next();
+ if (ch === '"')
+ return (state.mode = Modes.link)(stream, state);
+ return handlePhraseModifier(stream, state, ch);
+ },
+
+ attributes: function(stream, state) {
+ state.mode = Modes.layoutLength;
+
+ if (stream.match(RE("attributes")))
+ return tokenStylesWith(state, TOKEN_STYLES.attributes);
+ else
+ return tokenStyles(state);
+ },
+
+ layoutLength: function(stream, state) {
+ if (stream.eat(".") && stream.eat("."))
+ state.spanningLayout = true;
+
+ state.mode = Modes.text;
+ return tokenStyles(state);
+ },
+
+ list: function(stream, state) {
+ var match = stream.match(RE("list"));
+ state.listDepth = match[0].length;
+ var listMod = (state.listDepth - 1) % 3;
+ if (!listMod)
+ state.layoutType = "list1";
+ else if (listMod === 1)
+ state.layoutType = "list2";
+ else
+ state.layoutType = "list3";
+
+ state.mode = Modes.attributes;
+ return tokenStyles(state);
+ },
+
+ link: function(stream, state) {
+ state.mode = Modes.text;
+ if (stream.match(RE("link"))) {
+ stream.match(/\S+/);
+ return tokenStylesWith(state, TOKEN_STYLES.link);
+ }
+ return tokenStyles(state);
+ },
+
+ linkDefinition: function(stream, state) {
+ stream.skipToEnd();
+ return tokenStylesWith(state, TOKEN_STYLES.linkDefinition);
+ },
+
+ definitionList: function(stream, state) {
+ stream.match(RE("definitionList"));
+
+ state.layoutType = "definitionList";
+
+ if (stream.match(/\s*$/))
+ state.spanningLayout = true;
+ else
+ state.mode = Modes.attributes;
+
+ return tokenStyles(state);
+ },
+
+ html: function(stream, state) {
+ stream.skipToEnd();
+ return tokenStylesWith(state, TOKEN_STYLES.html);
+ },
+
+ table: function(stream, state) {
+ state.layoutType = "table";
+ return (state.mode = Modes.tableCell)(stream, state);
+ },
+
+ tableCell: function(stream, state) {
+ if (stream.match(RE("tableHeading")))
+ state.tableHeading = true;
+ else
+ stream.eat("|");
+
+ state.mode = Modes.tableCellAttributes;
+ return tokenStyles(state);
+ },
+
+ tableCellAttributes: function(stream, state) {
+ state.mode = Modes.tableText;
+
+ if (stream.match(RE("tableCellAttributes")))
+ return tokenStylesWith(state, TOKEN_STYLES.attributes);
+ else
+ return tokenStyles(state);
+ },
+
+ tableText: function(stream, state) {
+ if (stream.match(RE("tableText")))
+ return tokenStyles(state);
+
+ if (stream.peek() === "|") { // end of cell
+ state.mode = Modes.tableCell;
+ return tokenStyles(state);
+ }
+ return handlePhraseModifier(stream, state, stream.next());
+ }
+ };
+
+ CodeMirror.defineMode("textile", function() {
+ return {
+ startState: function() {
+ return { mode: Modes.newLayout };
+ },
+ token: function(stream, state) {
+ if (stream.sol()) startNewLine(stream, state);
+ return state.mode(stream, state);
+ },
+ blankLine: blankLine
+ };
+ });
+
+ CodeMirror.defineMIME("text/x-textile", "textile");
+});
diff --git a/backend/webif/static/codemirror/mode/tiddlywiki/index.html b/backend/webif/static/codemirror/mode/tiddlywiki/index.html
new file mode 100755
index 000000000..77dd0457c
--- /dev/null
+++ b/backend/webif/static/codemirror/mode/tiddlywiki/index.html
@@ -0,0 +1,154 @@
+
+
+TiddlyWiki mode
+ + + + + + +TiddlyWiki mode supports a single configuration.
+ +MIME types defined: text/x-tiddlywiki.
+ reWikiCommentStart = /^\/\*\*\*$/, // /*** + reWikiCommentStop = /^\*\*\*\/$/, // ***/ + reBlockQuote = /^<<<$/, + + reJsCodeStart = /^\/\/\{\{\{$/, // //{{{ js block start + reJsCodeStop = /^\/\/\}\}\}$/, // //}}} js stop + reXmlCodeStart = /^$/, // xml block start + reXmlCodeStop = /^$/, // xml stop + + reCodeBlockStart = /^\{\{\{$/, // {{{ TW text div block start + reCodeBlockStop = /^\}\}\}$/, // }}} TW text stop + + reUntilCodeStop = /.*?\}\}\}/; + + function chain(stream, state, f) { + state.tokenize = f; + return f(stream, state); + } + + function tokenBase(stream, state) { + var sol = stream.sol(), ch = stream.peek(); + + state.block = false; // indicates the start of a code block. + + // check start of blocks + if (sol && /[<\/\*{}\-]/.test(ch)) { + if (stream.match(reCodeBlockStart)) { + state.block = true; + return chain(stream, state, twTokenCode); + } + if (stream.match(reBlockQuote)) + return 'quote'; + if (stream.match(reWikiCommentStart) || stream.match(reWikiCommentStop)) + return 'comment'; + if (stream.match(reJsCodeStart) || stream.match(reJsCodeStop) || stream.match(reXmlCodeStart) || stream.match(reXmlCodeStop)) + return 'comment'; + if (stream.match(reHR)) + return 'hr'; + } + + stream.next(); + if (sol && /[\/\*!#;:>|]/.test(ch)) { + if (ch == "!") { // tw header + stream.skipToEnd(); + return "header"; + } + if (ch == "*") { // tw list + stream.eatWhile('*'); + return "comment"; + } + if (ch == "#") { // tw numbered list + stream.eatWhile('#'); + return "comment"; + } + if (ch == ";") { // definition list, term + stream.eatWhile(';'); + return "comment"; + } + if (ch == ":") { // definition list, description + stream.eatWhile(':'); + return "comment"; + } + if (ch == ">") { // single line quote + stream.eatWhile(">"); + return "quote"; + } + if (ch == '|') + return 'header'; + } + + if (ch == '{' && stream.match(/\{\{/)) + return chain(stream, state, twTokenCode); + + // rudimentary html:// file:// link matching. TW knows much more ... + if (/[hf]/i.test(ch) && + /[ti]/i.test(stream.peek()) && + stream.match(/\b(ttps?|tp|ile):\/\/[\-A-Z0-9+&@#\/%?=~_|$!:,.;]*[A-Z0-9+&@#\/%=~_|$]/i)) + return "link"; + + // just a little string indicator, don't want to have the whole string covered + if (ch == '"') + return 'string'; + + if (ch == '~') // _no_ CamelCase indicator should be bold + return 'brace'; + + if (/[\[\]]/.test(ch) && stream.match(ch)) // check for [[..]] + return 'brace'; + + if (ch == "@") { // check for space link. TODO fix @@...@@ highlighting + stream.eatWhile(isSpaceName); + return "link"; + } + + if (/\d/.test(ch)) { // numbers + stream.eatWhile(/\d/); + return "number"; + } + + if (ch == "/") { // tw invisible comment + if (stream.eat("%")) { + return chain(stream, state, twTokenComment); + } else if (stream.eat("/")) { // + return chain(stream, state, twTokenEm); + } + } + + if (ch == "_" && stream.eat("_")) // tw underline + return chain(stream, state, twTokenUnderline); + + // strikethrough and mdash handling + if (ch == "-" && stream.eat("-")) { + // if strikethrough looks ugly, change CSS. + if (stream.peek() != ' ') + return chain(stream, state, twTokenStrike); + // mdash + if (stream.peek() == ' ') + return 'brace'; + } + + if (ch == "'" && stream.eat("'")) // tw bold + return chain(stream, state, twTokenStrong); + + if (ch == "<" && stream.eat("<")) // tw macro + return chain(stream, state, twTokenMacro); + + // core macro handling + stream.eatWhile(/[\w\$_]/); + return textwords.propertyIsEnumerable(stream.current()) ? "keyword" : null + } + + // tw invisible comment + function twTokenComment(stream, state) { + var maybeEnd = false, ch; + while (ch = stream.next()) { + if (ch == "/" && maybeEnd) { + state.tokenize = tokenBase; + break; + } + maybeEnd = (ch == "%"); + } + return "comment"; + } + + // tw strong / bold + function twTokenStrong(stream, state) { + var maybeEnd = false, + ch; + while (ch = stream.next()) { + if (ch == "'" && maybeEnd) { + state.tokenize = tokenBase; + break; + } + maybeEnd = (ch == "'"); + } + return "strong"; + } + + // tw code + function twTokenCode(stream, state) { + var sb = state.block; + + if (sb && stream.current()) { + return "comment"; + } + + if (!sb && stream.match(reUntilCodeStop)) { + state.tokenize = tokenBase; + return "comment"; + } + + if (sb && stream.sol() && stream.match(reCodeBlockStop)) { + state.tokenize = tokenBase; + return "comment"; + } + + stream.next(); + return "comment"; + } + + // tw em / italic + function twTokenEm(stream, state) { + var maybeEnd = false, + ch; + while (ch = stream.next()) { + if (ch == "/" && maybeEnd) { + state.tokenize = tokenBase; + break; + } + maybeEnd = (ch == "/"); + } + return "em"; + } + + // tw underlined text + function twTokenUnderline(stream, state) { + var maybeEnd = false, + ch; + while (ch = stream.next()) { + if (ch == "_" && maybeEnd) { + state.tokenize = tokenBase; + break; + } + maybeEnd = (ch == "_"); + } + return "underlined"; + } + + // tw strike through text looks ugly + // change CSS if needed + function twTokenStrike(stream, state) { + var maybeEnd = false, ch; + + while (ch = stream.next()) { + if (ch == "-" && maybeEnd) { + state.tokenize = tokenBase; + break; + } + maybeEnd = (ch == "-"); + } + return "strikethrough"; + } + + // macro + function twTokenMacro(stream, state) { + if (stream.current() == '<<') { + return 'macro'; + } + + var ch = stream.next(); + if (!ch) { + state.tokenize = tokenBase; + return null; + } + if (ch == ">") { + if (stream.peek() == '>') { + stream.next(); + state.tokenize = tokenBase; + return "macro"; + } + } + + stream.eatWhile(/[\w\$_]/); + return keywords.propertyIsEnumerable(stream.current()) ? "keyword" : null + } + + // Interface + return { + startState: function () { + return {tokenize: tokenBase}; + }, + + token: function (stream, state) { + if (stream.eatSpace()) return null; + var style = state.tokenize(stream, state); + return style; + } + }; +}); + +CodeMirror.defineMIME("text/x-tiddlywiki", "tiddlywiki"); +}); diff --git a/backend/webif/static/codemirror/mode/tiki/index.html b/backend/webif/static/codemirror/mode/tiki/index.html new file mode 100755 index 000000000..091c5fb2a --- /dev/null +++ b/backend/webif/static/codemirror/mode/tiki/index.html @@ -0,0 +1,95 @@ + + +
Tiki wiki mode
+ + + + + + +TOML Mode
+ + +The TOML Mode
+Created by Forbes Lindesay.
+MIME type defined: text/x-toml.
Tornado template mode
+ + + + +Mode for HTML with embedded Tornado template markup.
+ +MIME types defined: text/x-tornado
troff
+ + + + + + +MIME types defined: troff.
TTCN-CFG example
+
+
+
+
+
+ +
Language: Testing and Test Control Notation - + Configuration files + (TTCN-CFG) +
+MIME types defined: text/x-ttcn-cfg.
+
The development of this mode has been sponsored by Ericsson + .
+Coded by Asmelash Tsegay Gebretsadkan
+TTCN example
+
+
+
+
+
+ +
Language: Testing and Test Control Notation + (TTCN) +
+MIME types defined: text/x-ttcn,
+ text/x-ttcn3, text/x-ttcnpp.
+
The development of this mode has been sponsored by Ericsson + .
+Coded by Asmelash Tsegay Gebretsadkan
+Turtle mode
+ + + +MIME types defined: text/turtle.
Twig mode
+ + +VB.NET mode
+
+
+
+ MIME type defined: text/x-vb.
VBScript mode
+ + + + + + +MIME types defined: text/vbscript.
Velocity mode
+ + + +MIME types defined: text/velocity.
SystemVerilog mode
+ + + + + ++Syntax highlighting and indentation for the Verilog and SystemVerilog languages (IEEE 1800). +
Configuration options:
+-
+
- noIndentKeywords - List of keywords which should not cause indentation to increase. E.g. ["package", "module"]. Default: None +
MIME types defined: text/x-verilog and text/x-systemverilog.
VHDL mode
+ + + + + ++Syntax highlighting and indentation for the VHDL language. +
Configuration options:
+-
+
- atoms - List of atom words. Default: "null" +
- hooks - List of meta hooks. Default: ["`", "$"] +
- multiLineStrings - Whether multi-line strings are accepted. Default: false +
MIME types defined: text/x-vhdl.
Vue.js mode
+ + + +MIME types defined: text/x-vue
Web IDL mode
+ +
+
+
+
+
+
+ MIME type defined: text/x-webidl.
XML mode
+ + +The XML mode supports these configuration parameters:
+-
+
htmlMode (boolean)
+ - This switches the mode to parse HTML instead of XML. This
+ means attributes do not have to be quoted, and some elements
+ (such as
br) do not require a closing tag.
+ matchClosing (boolean)
+ - Controls whether the mode checks that close tags match the + corresponding opening tag, and highlights mismatches as errors. + Defaults to true. +
alignCDATA (boolean)
+ - Setting this to true will force the opening tag of CDATA + blocks to not be indented. +
MIME types defined: application/xml, text/html.
XQuery mode
+ + +
+
+
+
+
+
+ MIME types defined: application/xquery.
Development of the CodeMirror XQuery mode was sponsored by + MarkLogic and developed by + Mike Brevoort. +
+ +][variable hello] [variable world][tag
]"); + + MT("test namespaced variable", + "[keyword declare] [keyword namespace] [variable e] [keyword =] [string \"http://example.com/ANamespace\"][variable ;declare] [keyword variable] [variable $e:exampleComThisVarIsNotRecognized] [keyword as] [keyword element]([keyword *]) [variable external;]"); + + MT("test EQName variable", + "[keyword declare] [keyword variable] [variable $\"http://www.example.com/ns/my\":var] [keyword :=] [atom 12][variable ;]", + "[tagyacas mode
+ + + + + + +MIME types defined: text/x-yacas (yacas).
YAML front matter mode
+ + +Defines a mode that parses
+a YAML frontmatter
+at the start of a file, switching to a base mode at the end of that.
+Takes a mode configuration option base to configure the
+base mode, which defaults to "gfm".
YAML mode
+ + + +MIME types defined: text/x-yaml.
Z80 assembly mode
+ + + + + + +MIME types defined: text/x-z80, text/x-ez80.
Test Suite
+ +A limited set of programmatic sanity tests for CodeMirror.
+ +
+
+
+ Ran 0 of 0 tests
Please enable JavaScript...
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +';
+ s += '
';
+ }
+ if (observedOutput.indentFailures) {
+ for (var i = 0; i < observedOutput.indentFailures.length; i++)
+ s += "' + esc(text) + ''; + s += '
';
+ s += 'expected:';
+ s += prettyPrintOutputTable(expectedOutput, diff);
+ s += 'observed: [display states]';
+ s += prettyPrintOutputTable(observedOutput, diff);
+ s += '
';
+ s += '" + esc(observedOutput.indentFailures[i]) + "
";
+ }
+ if (s) throw new Failure(s);
+ }
+
+ function stringify(obj) {
+ function replacer(key, obj) {
+ if (typeof obj == "function") {
+ var m = obj.toString().match(/function\s*[^\s(]*/);
+ return m ? m[0] : "function";
+ }
+ return obj;
+ }
+ if (window.JSON && JSON.stringify)
+ return JSON.stringify(obj, replacer, 2);
+ return "[unsupported]"; // Fail safely if no native JSON.
+ }
+
+ function highlight(string, mode) {
+ var state = mode.startState();
+
+ var lines = string.replace(/\r\n/g,'\n').split('\n');
+ var st = [], pos = 0;
+ for (var i = 0; i < lines.length; ++i) {
+ var line = lines[i], newLine = true;
+ if (mode.indent) {
+ var ws = line.match(/^\s*/)[0];
+ var indent = mode.indent(state, line.slice(ws.length));
+ if (indent != CodeMirror.Pass && indent != ws.length)
+ (st.indentFailures || (st.indentFailures = [])).push(
+ "Indentation of line " + (i + 1) + " is " + indent + " (expected " + ws.length + ")");
+ }
+ var stream = new CodeMirror.StringStream(line, 4, {
+ lookAhead: function(n) { return lines[i + n] }
+ });
+ if (line == "" && mode.blankLine) mode.blankLine(state);
+ /* Start copied code from CodeMirror.highlight */
+ while (!stream.eol()) {
+ for (var j = 0; j < 10 && stream.start >= stream.pos; j++)
+ var compare = mode.token(stream, state);
+ if (j == 10)
+ throw new Failure("Failed to advance the stream." + stream.string + " " + stream.pos);
+ var substr = stream.current();
+ if (compare && compare.indexOf(" ") > -1) compare = compare.split(' ').sort().join(' ');
+ stream.start = stream.pos;
+ if (pos && st[pos-1].style == compare && !newLine) {
+ st[pos-1].text += substr;
+ } else if (substr) {
+ st[pos++] = {style: compare, text: substr, state: stringify(state)};
+ }
+ // Give up when line is ridiculously long
+ if (stream.pos > 5000) {
+ st[pos++] = {style: null, text: this.text.slice(stream.pos)};
+ break;
+ }
+ newLine = false;
+ }
+ }
+
+ return st;
+ }
+
+ function highlightOutputsDifferent(o1, o2) {
+ var minLen = Math.min(o1.length, o2.length);
+ for (var i = 0; i < minLen; ++i)
+ if (o1[i].style != o2[i].style || o1[i].text != o2[i].text) return i;
+ if (o1.length > minLen || o2.length > minLen) return minLen;
+ }
+
+ function prettyPrintOutputTable(output, diffAt) {
+ var s = '| ' + + '' + + esc(val.replace(/ /g,'\xb7')) + // · MIDDLE DOT + '' + + ' | '; + } + s += '
| ' + (output[i].style || null) + ' | '; + } + if(output[0].state) { + s += '
' + esc(output[i].state) + ' | ';
+ }
+ }
+ s += '
هل يمكنك اختيار مستوى قسط التأمين الذي ترغب بدفعه؟
"}) + +testCM("posFromIndex", function(cm) { + cm.setValue( + "This function should\n" + + "convert a zero based index\n" + + "to line and ch." + ); + + var examples = [ + { index: -1, line: 0, ch: 0 }, // <- Tests clipping + { index: 0, line: 0, ch: 0 }, + { index: 10, line: 0, ch: 10 }, + { index: 39, line: 1, ch: 18 }, + { index: 55, line: 2, ch: 7 }, + { index: 63, line: 2, ch: 15 }, + { index: 64, line: 2, ch: 15 } // <- Tests clipping + ]; + + for (var i = 0; i < examples.length; i++) { + var example = examples[i]; + var pos = cm.posFromIndex(example.index); + eq(pos.line, example.line); + eq(pos.ch, example.ch); + if (example.index >= 0 && example.index < 64) + eq(cm.indexFromPos(pos), example.index); + } +}); + +testCM("undo", function(cm) { + cm.replaceRange("def", Pos(0, 0), Pos(0)); + eq(cm.historySize().undo, 1); + cm.undo(); + eq(cm.getValue(), "abc"); + eq(cm.historySize().undo, 0); + eq(cm.historySize().redo, 1); + cm.redo(); + eq(cm.getValue(), "def"); + eq(cm.historySize().undo, 1); + eq(cm.historySize().redo, 0); + cm.setValue("1\n\n\n2"); + cm.clearHistory(); + eq(cm.historySize().undo, 0); + for (var i = 0; i < 20; ++i) { + cm.replaceRange("a", Pos(0, 0)); + cm.replaceRange("b", Pos(3, 0)); + } + eq(cm.historySize().undo, 40); + for (var i = 0; i < 40; ++i) + cm.undo(); + eq(cm.historySize().redo, 40); + eq(cm.getValue(), "1\n\n\n2"); +}, {value: "abc"}); + +testCM("undoDepth", function(cm) { + cm.replaceRange("d", Pos(0)); + cm.replaceRange("e", Pos(0)); + cm.replaceRange("f", Pos(0)); + cm.undo(); cm.undo(); cm.undo(); + eq(cm.getValue(), "abcd"); +}, {value: "abc", undoDepth: 4}); + +testCM("undoDoesntClearValue", function(cm) { + cm.undo(); + eq(cm.getValue(), "x"); +}, {value: "x"}); + +testCM("undoMultiLine", function(cm) { + cm.operation(function() { + cm.replaceRange("x", Pos(0, 0)); + cm.replaceRange("y", Pos(1, 0)); + }); + cm.undo(); + eq(cm.getValue(), "abc\ndef\nghi"); + cm.operation(function() { + cm.replaceRange("y", Pos(1, 0)); + cm.replaceRange("x", Pos(0, 0)); + }); + cm.undo(); + eq(cm.getValue(), "abc\ndef\nghi"); + cm.operation(function() { + cm.replaceRange("y", Pos(2, 0)); + cm.replaceRange("x", Pos(1, 0)); + cm.replaceRange("z", Pos(2, 0)); + }); + cm.undo(); + eq(cm.getValue(), "abc\ndef\nghi", 3); +}, {value: "abc\ndef\nghi"}); + +testCM("undoComposite", function(cm) { + cm.replaceRange("y", Pos(1)); + cm.operation(function() { + cm.replaceRange("x", Pos(0)); + cm.replaceRange("z", Pos(2)); + }); + eq(cm.getValue(), "ax\nby\ncz\n"); + cm.undo(); + eq(cm.getValue(), "a\nby\nc\n"); + cm.undo(); + eq(cm.getValue(), "a\nb\nc\n"); + cm.redo(); cm.redo(); + eq(cm.getValue(), "ax\nby\ncz\n"); +}, {value: "a\nb\nc\n"}); + +testCM("undoSelection", function(cm) { + cm.setSelection(Pos(0, 2), Pos(0, 4)); + cm.replaceSelection(""); + cm.setCursor(Pos(1, 0)); + cm.undo(); + eqCursorPos(cm.getCursor(true), Pos(0, 2)); + eqCursorPos(cm.getCursor(false), Pos(0, 4)); + cm.setCursor(Pos(1, 0)); + cm.redo(); + eqCursorPos(cm.getCursor(true), Pos(0, 2)); + eqCursorPos(cm.getCursor(false), Pos(0, 2)); +}, {value: "abcdefgh\n"}); + +testCM("undoSelectionAsBefore", function(cm) { + cm.replaceSelection("abc", "around"); + cm.undo(); + cm.redo(); + eq(cm.getSelection(), "abc"); +}); + +testCM("selectionChangeConfusesHistory", function(cm) { + cm.replaceSelection("abc", null, "dontmerge"); + cm.operation(function() { + cm.setCursor(Pos(0, 0)); + cm.replaceSelection("abc", null, "dontmerge"); + }); + eq(cm.historySize().undo, 2); +}); + +testCM("markTextSingleLine", function(cm) { + forEach([{a: 0, b: 1, c: "", f: 2, t: 5}, + {a: 0, b: 4, c: "", f: 0, t: 2}, + {a: 1, b: 2, c: "x", f: 3, t: 6}, + {a: 4, b: 5, c: "", f: 3, t: 5}, + {a: 4, b: 5, c: "xx", f: 3, t: 7}, + {a: 2, b: 5, c: "", f: 2, t: 3}, + {a: 2, b: 5, c: "abcd", f: 6, t: 7}, + {a: 2, b: 6, c: "x", f: null, t: null}, + {a: 3, b: 6, c: "", f: null, t: null}, + {a: 0, b: 9, c: "hallo", f: null, t: null}, + {a: 4, b: 6, c: "x", f: 3, t: 4}, + {a: 4, b: 8, c: "", f: 3, t: 4}, + {a: 6, b: 6, c: "a", f: 3, t: 6}, + {a: 8, b: 9, c: "", f: 3, t: 6}], function(test) { + cm.setValue("1234567890"); + var r = cm.markText(Pos(0, 3), Pos(0, 6), {className: "foo"}); + cm.replaceRange(test.c, Pos(0, test.a), Pos(0, test.b)); + var f = r.find(); + eq(f && f.from.ch, test.f); eq(f && f.to.ch, test.t); + }); +}); + +testCM("markTextMultiLine", function(cm) { + function p(v) { return v && Pos(v[0], v[1]); } + forEach([{a: [0, 0], b: [0, 5], c: "", f: [0, 0], t: [2, 5]}, + {a: [0, 0], b: [0, 5], c: "foo\n", f: [1, 0], t: [3, 5]}, + {a: [0, 1], b: [0, 10], c: "", f: [0, 1], t: [2, 5]}, + {a: [0, 5], b: [0, 6], c: "x", f: [0, 6], t: [2, 5]}, + {a: [0, 0], b: [1, 0], c: "", f: [0, 0], t: [1, 5]}, + {a: [0, 6], b: [2, 4], c: "", f: [0, 5], t: [0, 7]}, + {a: [0, 6], b: [2, 4], c: "aa", f: [0, 5], t: [0, 9]}, + {a: [1, 2], b: [1, 8], c: "", f: [0, 5], t: [2, 5]}, + {a: [0, 5], b: [2, 5], c: "xx", f: null, t: null}, + {a: [0, 0], b: [2, 10], c: "x", f: null, t: null}, + {a: [1, 5], b: [2, 5], c: "", f: [0, 5], t: [1, 5]}, + {a: [2, 0], b: [2, 3], c: "", f: [0, 5], t: [2, 2]}, + {a: [2, 5], b: [3, 0], c: "a\nb", f: [0, 5], t: [2, 5]}, + {a: [2, 3], b: [3, 0], c: "x", f: [0, 5], t: [2, 3]}, + {a: [1, 1], b: [1, 9], c: "1\n2\n3", f: [0, 5], t: [4, 5]}], function(test) { + cm.setValue("aaaaaaaaaa\nbbbbbbbbbb\ncccccccccc\ndddddddd\n"); + var r = cm.markText(Pos(0, 5), Pos(2, 5), + {className: "CodeMirror-matchingbracket"}); + cm.replaceRange(test.c, p(test.a), p(test.b)); + var f = r.find(); + eqCursorPos(f && f.from, p(test.f)); eqCursorPos(f && f.to, p(test.t)); + }); +}); + +testCM("markTextUndo", function(cm) { + var marker1, marker2, bookmark; + marker1 = cm.markText(Pos(0, 1), Pos(0, 3), + {className: "CodeMirror-matchingbracket"}); + marker2 = cm.markText(Pos(0, 0), Pos(2, 1), + {className: "CodeMirror-matchingbracket"}); + bookmark = cm.setBookmark(Pos(1, 5)); + cm.operation(function(){ + cm.replaceRange("foo", Pos(0, 2)); + cm.replaceRange("bar\nbaz\nbug\n", Pos(2, 0), Pos(3, 0)); + }); + var v1 = cm.getValue(); + cm.setValue(""); + eq(marker1.find(), null); eq(marker2.find(), null); eq(bookmark.find(), null); + cm.undo(); + eqCursorPos(bookmark.find(), Pos(1, 5), "still there"); + cm.undo(); + var m1Pos = marker1.find(), m2Pos = marker2.find(); + eqCursorPos(m1Pos.from, Pos(0, 1)); eqCursorPos(m1Pos.to, Pos(0, 3)); + eqCursorPos(m2Pos.from, Pos(0, 0)); eqCursorPos(m2Pos.to, Pos(2, 1)); + eqCursorPos(bookmark.find(), Pos(1, 5)); + cm.redo(); cm.redo(); + eq(bookmark.find(), null); + cm.undo(); + eqCursorPos(bookmark.find(), Pos(1, 5)); + eq(cm.getValue(), v1); +}, {value: "1234\n56789\n00\n"}); + +testCM("markTextStayGone", function(cm) { + var m1 = cm.markText(Pos(0, 0), Pos(0, 1)); + cm.replaceRange("hi", Pos(0, 2)); + m1.clear(); + cm.undo(); + eq(m1.find(), null); +}, {value: "hello"}); + +testCM("markTextAllowEmpty", function(cm) { + var m1 = cm.markText(Pos(0, 1), Pos(0, 2), {clearWhenEmpty: false}); + is(m1.find()); + cm.replaceRange("x", Pos(0, 0)); + is(m1.find()); + cm.replaceRange("y", Pos(0, 2)); + is(m1.find()); + cm.replaceRange("z", Pos(0, 3), Pos(0, 4)); + is(!m1.find()); + var m2 = cm.markText(Pos(0, 1), Pos(0, 2), {clearWhenEmpty: false, + inclusiveLeft: true, + inclusiveRight: true}); + cm.replaceRange("q", Pos(0, 1), Pos(0, 2)); + is(m2.find()); + cm.replaceRange("", Pos(0, 0), Pos(0, 3)); + is(!m2.find()); + var m3 = cm.markText(Pos(0, 1), Pos(0, 1), {clearWhenEmpty: false}); + cm.replaceRange("a", Pos(0, 3)); + is(m3.find()); + cm.replaceRange("b", Pos(0, 1)); + is(!m3.find()); +}, {value: "abcde"}); + +testCM("markTextStacked", function(cm) { + var m1 = cm.markText(Pos(0, 0), Pos(0, 0), {clearWhenEmpty: false}); + var m2 = cm.markText(Pos(0, 0), Pos(0, 0), {clearWhenEmpty: false}); + cm.replaceRange("B", Pos(0, 1)); + is(m1.find() && m2.find()); +}, {value: "A"}); + +testCM("undoPreservesNewMarks", function(cm) { + cm.markText(Pos(0, 3), Pos(0, 4)); + cm.markText(Pos(1, 1), Pos(1, 3)); + cm.replaceRange("", Pos(0, 3), Pos(3, 1)); + var mBefore = cm.markText(Pos(0, 0), Pos(0, 1)); + var mAfter = cm.markText(Pos(0, 5), Pos(0, 6)); + var mAround = cm.markText(Pos(0, 2), Pos(0, 4)); + cm.undo(); + eqCursorPos(mBefore.find().from, Pos(0, 0)); + eqCursorPos(mBefore.find().to, Pos(0, 1)); + eqCursorPos(mAfter.find().from, Pos(3, 3)); + eqCursorPos(mAfter.find().to, Pos(3, 4)); + eqCursorPos(mAround.find().from, Pos(0, 2)); + eqCursorPos(mAround.find().to, Pos(3, 2)); + var found = cm.findMarksAt(Pos(2, 2)); + eq(found.length, 1); + eq(found[0], mAround); +}, {value: "aaaa\nbbbb\ncccc\ndddd"}); + +testCM("markClearBetween", function(cm) { + cm.setValue("aaa\nbbb\nccc\nddd\n"); + cm.markText(Pos(0, 0), Pos(2)); + cm.replaceRange("aaa\nbbb\nccc", Pos(0, 0), Pos(2)); + eq(cm.findMarksAt(Pos(1, 1)).length, 0); +}); + +testCM("findMarksMiddle", function(cm) { + var mark = cm.markText(Pos(1, 1), Pos(3, 1)); + var found = cm.findMarks(Pos(2, 1), Pos(2, 2)); + eq(found.length, 1); + eq(found[0], mark); +}, {value: "line 0\nline 1\nline 2\nline 3"}); + +testCM("deleteSpanCollapsedInclusiveLeft", function(cm) { + var from = Pos(1, 0), to = Pos(1, 1); + var m = cm.markText(from, to, {collapsed: true, inclusiveLeft: true}); + // Delete collapsed span. + cm.replaceRange("", from, to); +}, {value: "abc\nX\ndef"}); + +testCM("markTextCSS", function(cm) { + function present() { + var spans = cm.display.lineDiv.getElementsByTagName("span"); + for (var i = 0; i < spans.length; i++) + if (spans[i].style.color == "cyan" && span[i].textContent == "cdefg") return true; + } + var m = cm.markText(Pos(0, 2), Pos(0, 6), {css: "color: cyan"}); + m.clear(); + is(!present()); +}, {value: "abcdefgh"}); + +testCM("bookmark", function(cm) { + function p(v) { return v && Pos(v[0], v[1]); } + forEach([{a: [1, 0], b: [1, 1], c: "", d: [1, 4]}, + {a: [1, 1], b: [1, 1], c: "xx", d: [1, 7]}, + {a: [1, 4], b: [1, 5], c: "ab", d: [1, 6]}, + {a: [1, 4], b: [1, 6], c: "", d: null}, + {a: [1, 5], b: [1, 6], c: "abc", d: [1, 5]}, + {a: [1, 6], b: [1, 8], c: "", d: [1, 5]}, + {a: [1, 4], b: [1, 4], c: "\n\n", d: [3, 1]}, + {bm: [1, 9], a: [1, 1], b: [1, 1], c: "\n", d: [2, 8]}], function(test) { + cm.setValue("1234567890\n1234567890\n1234567890"); + var b = cm.setBookmark(p(test.bm) || Pos(1, 5)); + cm.replaceRange(test.c, p(test.a), p(test.b)); + eqCursorPos(b.find(), p(test.d)); + }); +}); + +testCM("bookmarkInsertLeft", function(cm) { + var br = cm.setBookmark(Pos(0, 2), {insertLeft: false}); + var bl = cm.setBookmark(Pos(0, 2), {insertLeft: true}); + cm.setCursor(Pos(0, 2)); + cm.replaceSelection("hi"); + eqCursorPos(br.find(), Pos(0, 2)); + eqCursorPos(bl.find(), Pos(0, 4)); + cm.replaceRange("", Pos(0, 4), Pos(0, 5)); + cm.replaceRange("", Pos(0, 2), Pos(0, 4)); + cm.replaceRange("", Pos(0, 1), Pos(0, 2)); + // Verify that deleting next to bookmarks doesn't kill them + eqCursorPos(br.find(), Pos(0, 1)); + eqCursorPos(bl.find(), Pos(0, 1)); +}, {value: "abcdef"}); + +testCM("bookmarkCursor", function(cm) { + var pos01 = cm.cursorCoords(Pos(0, 1)), pos11 = cm.cursorCoords(Pos(1, 1)), + pos20 = cm.cursorCoords(Pos(2, 0)), pos30 = cm.cursorCoords(Pos(3, 0)), + pos41 = cm.cursorCoords(Pos(4, 1)); + cm.setBookmark(Pos(0, 1), {widget: document.createTextNode("←"), insertLeft: true}); + cm.setBookmark(Pos(2, 0), {widget: document.createTextNode("←"), insertLeft: true}); + cm.setBookmark(Pos(1, 1), {widget: document.createTextNode("→")}); + cm.setBookmark(Pos(3, 0), {widget: document.createTextNode("→")}); + var new01 = cm.cursorCoords(Pos(0, 1)), new11 = cm.cursorCoords(Pos(1, 1)), + new20 = cm.cursorCoords(Pos(2, 0)), new30 = cm.cursorCoords(Pos(3, 0)); + near(new01.left, pos01.left, 1); + near(new01.top, pos01.top, 1); + is(new11.left > pos11.left, "at right, middle of line"); + near(new11.top == pos11.top, 1); + near(new20.left, pos20.left, 1); + near(new20.top, pos20.top, 1); + is(new30.left > pos30.left, "at right, empty line"); + near(new30.top, pos30, 1); + cm.setBookmark(Pos(4, 0), {widget: document.createTextNode("→")}); + is(cm.cursorCoords(Pos(4, 1)).left > pos41.left, "single-char bug"); +}, {value: "foo\nbar\n\n\nx\ny"}); + +testCM("multiBookmarkCursor", function(cm) { + if (phantom) return; + var ms = [], m; + function add(insertLeft) { + for (var i = 0; i < 3; ++i) { + var node = document.createElement("span"); + node.innerHTML = "X"; + ms.push(cm.setBookmark(Pos(0, 1), {widget: node, insertLeft: insertLeft})); + } + } + var base1 = cm.cursorCoords(Pos(0, 1)).left, base4 = cm.cursorCoords(Pos(0, 4)).left; + add(true); + near(base1, cm.cursorCoords(Pos(0, 1)).left, 1); + while (m = ms.pop()) m.clear(); + add(false); + near(base4, cm.cursorCoords(Pos(0, 1)).left, 1); +}, {value: "abcdefg"}); + +testCM("getAllMarks", function(cm) { + addDoc(cm, 10, 10); + var m1 = cm.setBookmark(Pos(0, 2)); + var m2 = cm.markText(Pos(0, 2), Pos(3, 2)); + var m3 = cm.markText(Pos(1, 2), Pos(1, 8)); + var m4 = cm.markText(Pos(8, 0), Pos(9, 0)); + eq(cm.getAllMarks().length, 4); + m1.clear(); + m3.clear(); + eq(cm.getAllMarks().length, 2); +}); + +testCM("setValueClears", function(cm) { + cm.addLineClass(0, "wrap", "foo"); + var mark = cm.markText(Pos(0, 0), Pos(1, 1), {inclusiveLeft: true, inclusiveRight: true}); + cm.setValue("foo"); + is(!cm.lineInfo(0).wrapClass); + is(!mark.find()); +}, {value: "a\nb"}); + +testCM("bug577", function(cm) { + cm.setValue("a\nb"); + cm.clearHistory(); + cm.setValue("fooooo"); + cm.undo(); +}); + +testCM("scrollSnap", function(cm) { + cm.setSize(100, 100); + addDoc(cm, 200, 200); + cm.setCursor(Pos(100, 180)); + var info = cm.getScrollInfo(); + is(info.left > 0 && info.top > 0); + cm.setCursor(Pos(0, 0)); + info = cm.getScrollInfo(); + is(info.left == 0 && info.top == 0, "scrolled clean to top"); + cm.setCursor(Pos(100, 180)); + cm.setCursor(Pos(199, 0)); + info = cm.getScrollInfo(); + is(info.left == 0 && info.top + 2 > info.height - cm.getScrollerElement().clientHeight, "scrolled clean to bottom"); +}); + +testCM("scrollIntoView", function(cm) { + if (phantom) return; + function test(line, ch, msg) { + var pos = Pos(line, ch); + cm.scrollIntoView(pos); + var outer = cm.getWrapperElement().getBoundingClientRect(); + var box = cm.charCoords(pos, "window"); + is(box.left >= outer.left, msg + " (left)"); + is(box.right <= outer.right, msg + " (right)"); + is(box.top >= outer.top, msg + " (top)"); + is(box.bottom <= outer.bottom, msg + " (bottom)"); + } + addDoc(cm, 200, 200); + test(199, 199, "bottom right"); + test(0, 0, "top left"); + test(100, 100, "center"); + test(199, 0, "bottom left"); + test(0, 199, "top right"); + test(100, 100, "center again"); +}); + +testCM("scrollBackAndForth", function(cm) { + addDoc(cm, 1, 200); + cm.operation(function() { + cm.scrollIntoView(Pos(199, 0)); + cm.scrollIntoView(Pos(4, 0)); + }); + is(cm.getScrollInfo().top > 0); +}); + +testCM("selectAllNoScroll", function(cm) { + addDoc(cm, 1, 200); + cm.execCommand("selectAll"); + eq(cm.getScrollInfo().top, 0); + cm.setCursor(199); + cm.execCommand("selectAll"); + is(cm.getScrollInfo().top > 0); +}); + +testCM("selectionPos", function(cm) { + if (phantom || cm.getOption("inputStyle") != "textarea") return; + cm.setSize(100, 100); + addDoc(cm, 200, 100); + cm.setSelection(Pos(1, 100), Pos(98, 100)); + var lineWidth = cm.charCoords(Pos(0, 200), "local").left; + var lineHeight = (cm.charCoords(Pos(99)).top - cm.charCoords(Pos(0)).top) / 100; + cm.scrollTo(0, 0); + var selElt = byClassName(cm.getWrapperElement(), "CodeMirror-selected"); + var outer = cm.getWrapperElement().getBoundingClientRect(); + var sawMiddle, sawTop, sawBottom; + for (var i = 0, e = selElt.length; i < e; ++i) { + var box = selElt[i].getBoundingClientRect(); + var atLeft = box.left - outer.left < 30; + var width = box.right - box.left; + var atRight = box.right - outer.left > .8 * lineWidth; + if (atLeft && atRight) { + sawMiddle = true; + is(box.bottom - box.top > 90 * lineHeight, "middle high"); + is(width > .9 * lineWidth, "middle wide"); + } else { + is(width > .4 * lineWidth, "top/bot wide enough"); + is(width < .6 * lineWidth, "top/bot slim enough"); + if (atLeft) { + sawBottom = true; + is(box.top - outer.top > 96 * lineHeight, "bot below"); + } else if (atRight) { + sawTop = true; + is(box.top - outer.top < 2.1 * lineHeight, "top above"); + } + } + } + is(sawTop && sawBottom && sawMiddle, "all parts"); +}, null); + +testCM("restoreHistory", function(cm) { + cm.setValue("abc\ndef"); + cm.replaceRange("hello", Pos(1, 0), Pos(1)); + cm.replaceRange("goop", Pos(0, 0), Pos(0)); + cm.undo(); + var storedVal = cm.getValue(), storedHist = cm.getHistory(); + if (window.JSON) storedHist = JSON.parse(JSON.stringify(storedHist)); + eq(storedVal, "abc\nhello"); + cm.setValue(""); + cm.clearHistory(); + eq(cm.historySize().undo, 0); + cm.setValue(storedVal); + cm.setHistory(storedHist); + cm.redo(); + eq(cm.getValue(), "goop\nhello"); + cm.undo(); cm.undo(); + eq(cm.getValue(), "abc\ndef"); +}); + +testCM("doubleScrollbar", function(cm) { + var dummy = document.body.appendChild(document.createElement("p")); + dummy.style.cssText = "height: 50px; overflow: scroll; width: 50px"; + var scrollbarWidth = dummy.offsetWidth + 1 - dummy.clientWidth; + document.body.removeChild(dummy); + if (scrollbarWidth < 2) return; + cm.setSize(null, 100); + addDoc(cm, 1, 300); + var wrap = cm.getWrapperElement(); + is(wrap.offsetWidth - byClassName(wrap, "CodeMirror-lines")[0].offsetWidth <= scrollbarWidth * 1.5); +}); + +testCM("weirdLinebreaks", function(cm) { + cm.setValue("foo\nbar\rbaz\r\nquux\n\rplop"); + is(cm.getValue(), "foo\nbar\nbaz\nquux\n\nplop"); + is(cm.lineCount(), 6); + cm.setValue("\n\n"); + is(cm.lineCount(), 3); +}); + +testCM("setSize", function(cm) { + cm.setSize(100, 100); + var wrap = cm.getWrapperElement(); + is(wrap.offsetWidth, 100); + is(wrap.offsetHeight, 100); + cm.setSize("100%", "3em"); + is(wrap.style.width, "100%"); + is(wrap.style.height, "3em"); + cm.setSize(null, 40); + is(wrap.style.width, "100%"); + is(wrap.style.height, "40px"); +}); + +function foldLines(cm, start, end, autoClear) { + return cm.markText(Pos(start, 0), Pos(end - 1), { + inclusiveLeft: true, + inclusiveRight: true, + collapsed: true, + clearOnEnter: autoClear + }); +} + +testCM("collapsedLines", function(cm) { + addDoc(cm, 4, 10); + var range = foldLines(cm, 4, 5), cleared = 0; + CodeMirror.on(range, "clear", function() {cleared++;}); + cm.setCursor(Pos(3, 0)); + CodeMirror.commands.goLineDown(cm); + eqCharPos(cm.getCursor(), Pos(5, 0)); + cm.replaceRange("abcdefg", Pos(3, 0), Pos(3)); + cm.setCursor(Pos(3, 6)); + CodeMirror.commands.goLineDown(cm); + eqCharPos(cm.getCursor(), Pos(5, 4)); + cm.replaceRange("ab", Pos(3, 0), Pos(3)); + cm.setCursor(Pos(3, 2)); + CodeMirror.commands.goLineDown(cm); + eqCharPos(cm.getCursor(), Pos(5, 2)); + cm.operation(function() {range.clear(); range.clear();}); + eq(cleared, 1); +}); + +testCM("collapsedRangeCoordsChar", function(cm) { + var pos_1_3 = cm.charCoords(Pos(1, 3)); + pos_1_3.left += 2; pos_1_3.top += 2; + var opts = {collapsed: true, inclusiveLeft: true, inclusiveRight: true}; + var m1 = cm.markText(Pos(0, 0), Pos(2, 0), opts); + eqCharPos(cm.coordsChar(pos_1_3), Pos(3, 3)); + m1.clear(); + var m1 = cm.markText(Pos(0, 0), Pos(1, 1), {collapsed: true, inclusiveLeft: true}); + var m2 = cm.markText(Pos(1, 1), Pos(2, 0), {collapsed: true, inclusiveRight: true}); + eqCharPos(cm.coordsChar(pos_1_3), Pos(3, 3)); + m1.clear(); m2.clear(); + var m1 = cm.markText(Pos(0, 0), Pos(1, 6), opts); + eqCharPos(cm.coordsChar(pos_1_3), Pos(3, 3)); +}, {value: "123456\nabcdef\nghijkl\nmnopqr\n"}); + +testCM("collapsedRangeBetweenLinesSelected", function(cm) { + if (cm.getOption("inputStyle") != "textarea") return; + var widget = document.createElement("span"); + widget.textContent = "\u2194"; + cm.markText(Pos(0, 3), Pos(1, 0), {replacedWith: widget}); + cm.setSelection(Pos(0, 3), Pos(1, 0)); + var selElts = byClassName(cm.getWrapperElement(), "CodeMirror-selected"); + for (var i = 0, w = 0; i < selElts.length; i++) + w += selElts[i].offsetWidth; + is(w > 0); +}, {value: "one\ntwo"}); + +testCM("randomCollapsedRanges", function(cm) { + addDoc(cm, 20, 500); + cm.operation(function() { + for (var i = 0; i < 200; i++) { + var start = Pos(Math.floor(Math.random() * 500), Math.floor(Math.random() * 20)); + if (i % 4) + try { cm.markText(start, Pos(start.line + 2, 1), {collapsed: true}); } + catch(e) { if (!/overlapping/.test(String(e))) throw e; } + else + cm.markText(start, Pos(start.line, start.ch + 4), {"className": "foo"}); + } + }); +}); + +testCM("hiddenLinesAutoUnfold", function(cm) { + var range = foldLines(cm, 1, 3, true), cleared = 0; + CodeMirror.on(range, "clear", function() {cleared++;}); + cm.setCursor(Pos(3, 0)); + eq(cleared, 0); + cm.execCommand("goCharLeft"); + eq(cleared, 1); + range = foldLines(cm, 1, 3, true); + CodeMirror.on(range, "clear", function() {cleared++;}); + eqCursorPos(cm.getCursor(), Pos(3, 0)); + cm.setCursor(Pos(0, 3)); + cm.execCommand("goCharRight"); + eq(cleared, 2); +}, {value: "abc\ndef\nghi\njkl"}); + +testCM("hiddenLinesSelectAll", function(cm) { // Issue #484 + addDoc(cm, 4, 20); + foldLines(cm, 0, 10); + foldLines(cm, 11, 20); + CodeMirror.commands.selectAll(cm); + eqCursorPos(cm.getCursor(true), Pos(10, 0)); + eqCursorPos(cm.getCursor(false), Pos(10, 4)); +}); + + +testCM("everythingFolded", function(cm) { + addDoc(cm, 2, 2); + function enterPress() { + cm.triggerOnKeyDown({type: "keydown", keyCode: 13, preventDefault: function(){}, stopPropagation: function(){}}); + } + var fold = foldLines(cm, 0, 2); + enterPress(); + eq(cm.getValue(), "xx\nxx"); + fold.clear(); + fold = foldLines(cm, 0, 2, true); + eq(fold.find(), null); + enterPress(); + eq(cm.getValue(), "\nxx\nxx"); +}); + +testCM("structuredFold", function(cm) { + if (phantom) return; + addDoc(cm, 4, 8); + var range = cm.markText(Pos(1, 2), Pos(6, 2), { + replacedWith: document.createTextNode("Q") + }); + cm.setCursor(0, 3); + CodeMirror.commands.goLineDown(cm); + eqCharPos(cm.getCursor(), Pos(6, 2)); + CodeMirror.commands.goCharLeft(cm); + eqCharPos(cm.getCursor(), Pos(1, 2)); + CodeMirror.commands.delCharAfter(cm); + eq(cm.getValue(), "xxxx\nxxxx\nxxxx"); + addDoc(cm, 4, 8); + range = cm.markText(Pos(1, 2), Pos(6, 2), { + replacedWith: document.createTextNode("M"), + clearOnEnter: true + }); + var cleared = 0; + CodeMirror.on(range, "clear", function(){++cleared;}); + cm.setCursor(0, 3); + CodeMirror.commands.goLineDown(cm); + eqCharPos(cm.getCursor(), Pos(6, 2)); + CodeMirror.commands.goCharLeft(cm); + eqCharPos(cm.getCursor(), Pos(6, 1)); + eq(cleared, 1); + range.clear(); + eq(cleared, 1); + range = cm.markText(Pos(1, 2), Pos(6, 2), { + replacedWith: document.createTextNode("Q"), + clearOnEnter: true + }); + range.clear(); + cm.setCursor(1, 2); + CodeMirror.commands.goCharRight(cm); + eqCharPos(cm.getCursor(), Pos(1, 3)); + range = cm.markText(Pos(2, 0), Pos(4, 4), { + replacedWith: document.createTextNode("M") + }); + cm.setCursor(1, 0); + CodeMirror.commands.goLineDown(cm); + eqCharPos(cm.getCursor(), Pos(2, 0)); +}, null); + +testCM("nestedFold", function(cm) { + addDoc(cm, 10, 3); + function fold(ll, cl, lr, cr) { + return cm.markText(Pos(ll, cl), Pos(lr, cr), {collapsed: true}); + } + var inner1 = fold(0, 6, 1, 3), inner2 = fold(0, 2, 1, 8), outer = fold(0, 1, 2, 3), inner0 = fold(0, 5, 0, 6); + cm.setCursor(0, 1); + CodeMirror.commands.goCharRight(cm); + eqCursorPos(cm.getCursor(), Pos(2, 3)); + inner0.clear(); + CodeMirror.commands.goCharLeft(cm); + eqCursorPos(cm.getCursor(), Pos(0, 1)); + outer.clear(); + CodeMirror.commands.goCharRight(cm); + eqCursorPos(cm.getCursor(), Pos(0, 2, "before")); + CodeMirror.commands.goCharRight(cm); + eqCursorPos(cm.getCursor(), Pos(1, 8)); + inner2.clear(); + CodeMirror.commands.goCharLeft(cm); + eqCursorPos(cm.getCursor(), Pos(1, 7, "after")); + cm.setCursor(0, 5); + CodeMirror.commands.goCharRight(cm); + eqCursorPos(cm.getCursor(), Pos(0, 6, "before")); + CodeMirror.commands.goCharRight(cm); + eqCursorPos(cm.getCursor(), Pos(1, 3)); +}); + +testCM("badNestedFold", function(cm) { + addDoc(cm, 4, 4); + cm.markText(Pos(0, 2), Pos(3, 2), {collapsed: true}); + var caught; + try {cm.markText(Pos(0, 1), Pos(0, 3), {collapsed: true});} + catch(e) {caught = e;} + is(caught instanceof Error, "no error"); + is(/overlap/i.test(caught.message), "wrong error"); +}); + +testCM("nestedFoldOnSide", function(cm) { + var m1 = cm.markText(Pos(0, 1), Pos(2, 1), {collapsed: true, inclusiveRight: true}); + var m2 = cm.markText(Pos(0, 1), Pos(0, 2), {collapsed: true}); + cm.markText(Pos(0, 1), Pos(0, 2), {collapsed: true}).clear(); + try { cm.markText(Pos(0, 1), Pos(0, 2), {collapsed: true, inclusiveLeft: true}); } + catch(e) { var caught = e; } + is(caught && /overlap/i.test(caught.message)); + var m3 = cm.markText(Pos(2, 0), Pos(2, 1), {collapsed: true}); + var m4 = cm.markText(Pos(2, 0), Pos(2, 1), {collapse: true, inclusiveRight: true}); + m1.clear(); m4.clear(); + m1 = cm.markText(Pos(0, 1), Pos(2, 1), {collapsed: true}); + cm.markText(Pos(2, 0), Pos(2, 1), {collapsed: true}).clear(); + try { cm.markText(Pos(2, 0), Pos(2, 1), {collapsed: true, inclusiveRight: true}); } + catch(e) { var caught = e; } + is(caught && /overlap/i.test(caught.message)); +}, {value: "ab\ncd\ef"}); + +testCM("editInFold", function(cm) { + addDoc(cm, 4, 6); + var m = cm.markText(Pos(1, 2), Pos(3, 2), {collapsed: true}); + cm.replaceRange("", Pos(0, 0), Pos(1, 3)); + cm.replaceRange("", Pos(2, 1), Pos(3, 3)); + cm.replaceRange("a\nb\nc\nd", Pos(0, 1), Pos(1, 0)); + cm.cursorCoords(Pos(0, 0)); +}); + +testCM("wrappingInlineWidget", function(cm) { + cm.setSize("11em"); + var w = document.createElement("span"); + w.style.color = "red"; + w.innerHTML = "one two three four"; + cm.markText(Pos(0, 6), Pos(0, 9), {replacedWith: w}); + var cur0 = cm.cursorCoords(Pos(0, 0)), cur1 = cm.cursorCoords(Pos(0, 10)); + is(cur0.top < cur1.top); + is(cur0.bottom < cur1.bottom); + var curL = cm.cursorCoords(Pos(0, 6)), curR = cm.cursorCoords(Pos(0, 9)); + eq(curL.top, cur0.top); + eq(curL.bottom, cur0.bottom); + eq(curR.top, cur1.top); + eq(curR.bottom, cur1.bottom); + cm.replaceRange("", Pos(0, 9), Pos(0)); + curR = cm.cursorCoords(Pos(0, 9)); + if (phantom) return; + eq(curR.top, cur1.top); + eq(curR.bottom, cur1.bottom); +}, {value: "1 2 3 xxx 4", lineWrapping: true}); + +testCM("showEmptyWidgetSpan", function(cm) { + var marker = cm.markText(Pos(0, 2), Pos(0, 2), { + clearWhenEmpty: false, + replacedWith: document.createTextNode("X") + }); + var text = cm.display.view[0].text; + eq(text.textContent || text.innerText, "abXc"); +}, {value: "abc"}); + +testCM("changedInlineWidget", function(cm) { + cm.setSize("10em"); + var w = document.createElement("span"); + w.innerHTML = "x"; + var m = cm.markText(Pos(0, 4), Pos(0, 5), {replacedWith: w}); + w.innerHTML = "and now the widget is really really long all of a sudden and a scrollbar is needed"; + m.changed(); + var hScroll = byClassName(cm.getWrapperElement(), "CodeMirror-hscrollbar")[0]; + is(hScroll.scrollWidth > hScroll.clientWidth); +}, {value: "hello there"}); + +testCM("changedBookmark", function(cm) { + cm.setSize("10em"); + var w = document.createElement("span"); + w.innerHTML = "x"; + var m = cm.setBookmark(Pos(0, 4), {widget: w}); + w.innerHTML = "and now the widget is really really long all of a sudden and a scrollbar is needed"; + m.changed(); + var hScroll = byClassName(cm.getWrapperElement(), "CodeMirror-hscrollbar")[0]; + is(hScroll.scrollWidth > hScroll.clientWidth); +}, {value: "abcdefg"}); + +testCM("inlineWidget", function(cm) { + var w = cm.setBookmark(Pos(0, 2), {widget: document.createTextNode("uu")}); + cm.setCursor(0, 2); + CodeMirror.commands.goLineDown(cm); + eqCharPos(cm.getCursor(), Pos(1, 4)); + cm.setCursor(0, 2); + cm.replaceSelection("hi"); + eqCharPos(w.find(), Pos(0, 2)); + cm.setCursor(0, 1); + cm.replaceSelection("ay"); + eqCharPos(w.find(), Pos(0, 4)); + eq(cm.getLine(0), "uayuhiuu"); +}, {value: "uuuu\nuuuuuu"}); + +testCM("wrappingAndResizing", function(cm) { + cm.setSize(null, "auto"); + cm.setOption("lineWrapping", true); + var wrap = cm.getWrapperElement(), h0 = wrap.offsetHeight; + var doc = "xxx xxx xxx xxx xxx"; + cm.setValue(doc); + for (var step = 10, w = cm.charCoords(Pos(0, 18), "div").right;; w += step) { + cm.setSize(w); + if (wrap.offsetHeight <= h0 * (opera_lt10 ? 1.2 : 1.5)) { + if (step == 10) { w -= 10; step = 1; } + else break; + } + } + // Ensure that putting the cursor at the end of the maximally long + // line doesn't cause wrapping to happen. + cm.setCursor(Pos(0, doc.length)); + eq(wrap.offsetHeight, h0); + cm.replaceSelection("x"); + is(wrap.offsetHeight > h0, "wrapping happens"); + // Now add a max-height and, in a document consisting of + // almost-wrapped lines, go over it so that a scrollbar appears. + cm.setValue(doc + "\n" + doc + "\n"); + cm.getScrollerElement().style.maxHeight = "100px"; + cm.replaceRange("\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n!\n", Pos(2, 0)); + forEach([Pos(0, doc.length), Pos(0, doc.length - 1), + Pos(0, 0), Pos(1, doc.length), Pos(1, doc.length - 1)], + function(pos) { + var coords = cm.charCoords(pos); + eqCharPos(pos, cm.coordsChar({left: coords.left + 2, top: coords.top + 5})); + }); +}, null, ie_lt8); + +testCM("measureEndOfLine", function(cm) { + if (phantom) return; + cm.setSize(null, "auto"); + var inner = byClassName(cm.getWrapperElement(), "CodeMirror-lines")[0].firstChild; + var lh = inner.offsetHeight; + for (var step = 10, w = cm.charCoords(Pos(0, 7), "div").right;; w += step) { + cm.setSize(w); + if (inner.offsetHeight < 2.5 * lh) { + if (step == 10) { w -= 10; step = 1; } + else break; + } + } + cm.setValue(cm.getValue() + "\n\n"); + var endPos = cm.charCoords(Pos(0, 18), "local"); + is(endPos.top > lh * .8, "not at top"); + is(endPos.left > w - 20, "at right"); + endPos = cm.charCoords(Pos(0, 18)); + eqCursorPos(cm.coordsChar({left: endPos.left, top: endPos.top + 5}), Pos(0, 18, "before")); + + var wrapPos = cm.cursorCoords(Pos(0, 9, "before")); + is(wrapPos.top < endPos.top, "wrapPos is actually in first line"); + eqCursorPos(cm.coordsChar({left: wrapPos.left + 10, top: wrapPos.top}), Pos(0, 9, "before")); +}, {mode: "text/html", value: "", lineWrapping: true}, ie_lt8 || opera_lt10); + +testCM("measureWrappedEndOfLine", function(cm) { + if (phantom) return; + cm.setSize(null, "auto"); + var inner = byClassName(cm.getWrapperElement(), "CodeMirror-lines")[0].firstChild; + var lh = inner.offsetHeight; + for (var step = 10, w = cm.charCoords(Pos(0, 7), "div").right;; w += step) { + cm.setSize(w); + if (inner.offsetHeight < 2.5 * lh) { + if (step == 10) { w -= 10; step = 1; } + else break; + } + } + for (var i = 0; i < 3; ++i) { + var endPos = cm.charCoords(Pos(0, 12)); // Next-to-last since last would wrap (#1862) + endPos.left += w; // Add width of editor just to be sure that we are behind last character + eqCursorPos(cm.coordsChar(endPos), Pos(0, 13, "before")); + endPos.left += w * 100; + eqCursorPos(cm.coordsChar(endPos), Pos(0, 13, "before")); + cm.setValue("0123456789abcابجابجابجابج"); + if (i == 1) { + var node = document.createElement("div"); + node.innerHTML = "hi"; node.style.height = "30px"; + cm.addLineWidget(0, node, {above: true}); + } + } +}, {mode: "text/html", value: "0123456789abcde0123456789", lineWrapping: true}, ie_lt8 || opera_lt10); + +testCM("measureEndOfLineBidi", function(cm) { + eqCursorPos(cm.coordsChar({left: 5000, top: cm.charCoords(Pos(0, 0)).top}), Pos(0, 8, "after")) +}, {value: "إإإإuuuuإإإإ"}) + +testCM("measureWrappedBidiLevel2", function(cm) { + cm.setSize(cm.charCoords(Pos(0, 6), "editor").right + 60) + var c9 = cm.charCoords(Pos(0, 9)) + eqCharPos(cm.coordsChar({left: c9.right - 1, top: c9.top + 1}), Pos(0, 9)) +}, {value: "foobar إإ إإ إإ إإ 555 بببببب", lineWrapping: true}) + +testCM("measureWrappedBeginOfLine", function(cm) { + if (phantom) return; + cm.setSize(null, "auto"); + var inner = byClassName(cm.getWrapperElement(), "CodeMirror-lines")[0].firstChild; + var lh = inner.offsetHeight; + for (var step = 10, w = cm.charCoords(Pos(0, 7), "div").right;; w += step) { + cm.setSize(w); + if (inner.offsetHeight < 2.5 * lh) { + if (step == 10) { w -= 10; step = 1; } + else break; + } + } + var beginOfSecondLine = Pos(0, 13, "after"); + for (var i = 0; i < 2; ++i) { + var beginPos = cm.charCoords(Pos(0, 0)); + beginPos.left -= w; + eqCursorPos(cm.coordsChar(beginPos), Pos(0, 0, "after")); + beginPos = cm.cursorCoords(beginOfSecondLine); + beginPos.left = 0; + eqCursorPos(cm.coordsChar(beginPos), beginOfSecondLine); + cm.setValue("0123456789abcابجابجابجابج"); + beginOfSecondLine = Pos(0, 25, "before"); + } +}, {mode: "text/html", value: "0123456789abcde0123456789", lineWrapping: true}); + +testCM("scrollVerticallyAndHorizontally", function(cm) { + if (cm.getOption("inputStyle") != "textarea") return; + cm.setSize(100, 100); + addDoc(cm, 40, 40); + cm.setCursor(39); + var wrap = cm.getWrapperElement(), bar = byClassName(wrap, "CodeMirror-vscrollbar")[0]; + is(bar.offsetHeight < wrap.offsetHeight, "vertical scrollbar limited by horizontal one"); + var cursorBox = byClassName(wrap, "CodeMirror-cursor")[0].getBoundingClientRect(); + var editorBox = wrap.getBoundingClientRect(); + is(cursorBox.bottom < editorBox.top + cm.getScrollerElement().clientHeight, + "bottom line visible"); +}, {lineNumbers: true}); + +testCM("moveVstuck", function(cm) { + var lines = byClassName(cm.getWrapperElement(), "CodeMirror-lines")[0].firstChild, h0 = lines.offsetHeight; + var val = "fooooooooooooooooooooooooo baaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaar\n"; + cm.setValue(val); + for (var w = cm.charCoords(Pos(0, 26), "div").right * 2.8;; w += 5) { + cm.setSize(w); + if (lines.offsetHeight <= 3.5 * h0) break; + } + cm.setCursor(Pos(0, val.length - 1)); + cm.moveV(-1, "line"); + eqCursorPos(cm.getCursor(), Pos(0, 27, "before")); + is(cm.cursorCoords(null, "local").top < h0, "cursor is in first visual line"); +}, {lineWrapping: true}, ie_lt8 || opera_lt10); + +testCM("collapseOnMove", function(cm) { + cm.setSelection(Pos(0, 1), Pos(2, 4)); + cm.execCommand("goLineUp"); + is(!cm.somethingSelected()); + eqCharPos(cm.getCursor(), Pos(0, 1)); + cm.setSelection(Pos(0, 1), Pos(2, 4)); + cm.execCommand("goPageDown"); + is(!cm.somethingSelected()); + eqCharPos(cm.getCursor(), Pos(2, 4)); + cm.execCommand("goLineUp"); + cm.execCommand("goLineUp"); + eqCharPos(cm.getCursor(), Pos(0, 4)); + cm.setSelection(Pos(0, 1), Pos(2, 4)); + cm.execCommand("goCharLeft"); + is(!cm.somethingSelected()); + eqCharPos(cm.getCursor(), Pos(0, 1)); +}, {value: "aaaaa\nb\nccccc"}); + +testCM("clickTab", function(cm) { + var p0 = cm.charCoords(Pos(0, 0)); + eqCharPos(cm.coordsChar({left: p0.left + 5, top: p0.top + 5}), Pos(0, 0)); + eqCharPos(cm.coordsChar({left: p0.right - 5, top: p0.top + 5}), Pos(0, 1)); +}, {value: "\t\n\n", lineWrapping: true, tabSize: 8}); + +testCM("verticalScroll", function(cm) { + cm.setSize(100, 200); + cm.setValue("foo\nbar\nbaz\n"); + var sc = cm.getScrollerElement(), baseWidth = sc.scrollWidth; + cm.replaceRange("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaah", Pos(0, 0), Pos(0)); + is(sc.scrollWidth > baseWidth, "scrollbar present"); + cm.replaceRange("foo", Pos(0, 0), Pos(0)); + if (!phantom) eq(sc.scrollWidth, baseWidth, "scrollbar gone"); + cm.replaceRange("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaah", Pos(0, 0), Pos(0)); + cm.replaceRange("bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbh", Pos(1, 0), Pos(1)); + is(sc.scrollWidth > baseWidth, "present again"); + var curWidth = sc.scrollWidth; + cm.replaceRange("foo", Pos(0, 0), Pos(0)); + is(sc.scrollWidth < curWidth, "scrollbar smaller"); + is(sc.scrollWidth > baseWidth, "but still present"); +}); + +testCM("extraKeys", function(cm) { + var outcome; + function fakeKey(expected, code, props) { + if (typeof code == "string") code = code.charCodeAt(0); + var e = {type: "keydown", keyCode: code, preventDefault: function(){}, stopPropagation: function(){}}; + if (props) for (var n in props) e[n] = props[n]; + outcome = null; + cm.triggerOnKeyDown(e); + eq(outcome, expected); + } + CodeMirror.commands.testCommand = function() {outcome = "tc";}; + CodeMirror.commands.goTestCommand = function() {outcome = "gtc";}; + cm.setOption("extraKeys", {"Shift-X": function() {outcome = "sx";}, + "X": function() {outcome = "x";}, + "Ctrl-Alt-U": function() {outcome = "cau";}, + "End": "testCommand", + "Home": "goTestCommand", + "Tab": false}); + fakeKey(null, "U"); + fakeKey("cau", "U", {ctrlKey: true, altKey: true}); + fakeKey(null, "U", {shiftKey: true, ctrlKey: true, altKey: true}); + fakeKey("x", "X"); + fakeKey("sx", "X", {shiftKey: true}); + fakeKey("tc", 35); + fakeKey(null, 35, {shiftKey: true}); + fakeKey("gtc", 36); + fakeKey("gtc", 36, {shiftKey: true}); + fakeKey(null, 9); +}, null, window.opera && mac); + +testCM("wordMovementCommands", function(cm) { + cm.execCommand("goWordLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 0)); + cm.execCommand("goWordRight"); cm.execCommand("goWordRight"); + eqCursorPos(cm.getCursor(), Pos(0, 7, "before")); + cm.execCommand("goWordLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 5, "after")); + cm.execCommand("goWordRight"); cm.execCommand("goWordRight"); + eqCursorPos(cm.getCursor(), Pos(0, 12, "before")); + cm.execCommand("goWordLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 9, "after")); + cm.execCommand("goWordRight"); cm.execCommand("goWordRight"); cm.execCommand("goWordRight"); + eqCursorPos(cm.getCursor(), Pos(0, 24, "before")); + cm.execCommand("goWordRight"); cm.execCommand("goWordRight"); + eqCursorPos(cm.getCursor(), Pos(1, 9, "before")); + cm.execCommand("goWordRight"); + eqCursorPos(cm.getCursor(), Pos(1, 13, "before")); + cm.execCommand("goWordRight"); cm.execCommand("goWordRight"); + eqCharPos(cm.getCursor(), Pos(2, 0)); +}, {value: "this is (the) firstline.\na foo12\u00e9\u00f8\u00d7bar\n"}); + +testCM("groupMovementCommands", function(cm) { + cm.execCommand("goGroupLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 0)); + cm.execCommand("goGroupRight"); + eqCursorPos(cm.getCursor(), Pos(0, 4, "before")); + cm.execCommand("goGroupRight"); + eqCursorPos(cm.getCursor(), Pos(0, 7, "before")); + cm.execCommand("goGroupRight"); + eqCursorPos(cm.getCursor(), Pos(0, 10, "before")); + cm.execCommand("goGroupLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 7, "after")); + cm.execCommand("goGroupRight"); cm.execCommand("goGroupRight"); cm.execCommand("goGroupRight"); + eqCursorPos(cm.getCursor(), Pos(0, 15, "before")); + cm.setCursor(Pos(0, 17)); + cm.execCommand("goGroupLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 16, "after")); + cm.execCommand("goGroupLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 14, "after")); + cm.execCommand("goGroupRight"); cm.execCommand("goGroupRight"); + eqCursorPos(cm.getCursor(), Pos(0, 20, "before")); + cm.execCommand("goGroupRight"); + eqCursorPos(cm.getCursor(), Pos(1, 0, "after")); + cm.execCommand("goGroupRight"); + eqCursorPos(cm.getCursor(), Pos(1, 2, "before")); + cm.execCommand("goGroupRight"); + eqCursorPos(cm.getCursor(), Pos(1, 5, "before")); + cm.execCommand("goGroupLeft"); cm.execCommand("goGroupLeft"); + eqCursorPos(cm.getCursor(), Pos(1, 0, "after")); + cm.execCommand("goGroupLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 20, "after")); + cm.execCommand("goGroupLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 16, "after")); +}, {value: "booo ba---quux. ffff\n abc d"}); + +testCM("groupsAndWhitespace", function(cm) { + var positions = [Pos(0, 0), Pos(0, 2), Pos(0, 5), Pos(0, 9), Pos(0, 11), + Pos(1, 0), Pos(1, 2), Pos(1, 5)]; + for (var i = 1; i < positions.length; i++) { + cm.execCommand("goGroupRight"); + eqCharPos(cm.getCursor(), positions[i]); + } + for (var i = positions.length - 2; i >= 0; i--) { + cm.execCommand("goGroupLeft"); + eqCharPos(cm.getCursor(), i == 2 ? Pos(0, 6, "before") : positions[i]); + } +}, {value: " foo +++ \n bar"}); + +testCM("charMovementCommands", function(cm) { + cm.execCommand("goCharLeft"); cm.execCommand("goColumnLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 0)); + cm.execCommand("goCharRight"); cm.execCommand("goCharRight"); + eqCursorPos(cm.getCursor(), Pos(0, 2, "before")); + cm.setCursor(Pos(1, 0)); + cm.execCommand("goColumnLeft"); + eqCursorPos(cm.getCursor(), Pos(1, 0)); + cm.execCommand("goCharLeft"); + eqCursorPos(cm.getCursor(), Pos(0, 5, "before")); + cm.execCommand("goColumnRight"); + eqCursorPos(cm.getCursor(), Pos(0, 5, "before")); + cm.execCommand("goCharRight"); + eqCursorPos(cm.getCursor(), Pos(1, 0, "after")); + cm.execCommand("goLineEnd"); + eqCursorPos(cm.getCursor(), Pos(1, 5, "before")); + cm.execCommand("goLineStartSmart"); + eqCursorPos(cm.getCursor(), Pos(1, 1, "after")); + cm.execCommand("goLineStartSmart"); + eqCursorPos(cm.getCursor(), Pos(1, 0, "after")); + cm.setCursor(Pos(2, 0)); + cm.execCommand("goCharRight"); cm.execCommand("goColumnRight"); + eqCursorPos(cm.getCursor(), Pos(2, 0)); +}, {value: "line1\n ine2\n"}); + +testCM("verticalMovementCommands", function(cm) { + cm.execCommand("goLineUp"); + eqCharPos(cm.getCursor(), Pos(0, 0)); + cm.execCommand("goLineDown"); + if (!phantom) // This fails in PhantomJS, though not in a real Webkit + eqCharPos(cm.getCursor(), Pos(1, 0)); + cm.setCursor(Pos(1, 12)); + cm.execCommand("goLineDown"); + eqCharPos(cm.getCursor(), Pos(2, 5)); + cm.execCommand("goLineDown"); + eqCharPos(cm.getCursor(), Pos(3, 0)); + cm.execCommand("goLineUp"); + eqCharPos(cm.getCursor(), Pos(2, 5)); + cm.execCommand("goLineUp"); + eqCharPos(cm.getCursor(), Pos(1, 12)); + cm.execCommand("goPageDown"); + eqCharPos(cm.getCursor(), Pos(5, 0)); + cm.execCommand("goPageDown"); cm.execCommand("goLineDown"); + eqCharPos(cm.getCursor(), Pos(5, 0)); + cm.execCommand("goPageUp"); + eqCharPos(cm.getCursor(), Pos(0, 0)); +}, {value: "line1\nlong long line2\nline3\n\nline5\n"}); + +testCM("verticalMovementCommandsWrapping", function(cm) { + cm.setSize(120); + cm.setCursor(Pos(0, 5)); + cm.execCommand("goLineDown"); + eq(cm.getCursor().line, 0); + is(cm.getCursor().ch > 5, "moved beyond wrap"); + for (var i = 0; ; ++i) { + is(i < 20, "no endless loop"); + cm.execCommand("goLineDown"); + var cur = cm.getCursor(); + if (cur.line == 1) eq(cur.ch, 5); + if (cur.line == 2) { eq(cur.ch, 1); break; } + } +}, {value: "a very long line that wraps around somehow so that we can test cursor movement\nshortone\nk", + lineWrapping: true}); + +testCM("verticalMovementCommandsSingleLine", function(cm) { + cm.display.wrapper.style.height = "auto"; + cm.refresh(); + cm.execCommand("goLineUp"); + eqCursorPos(cm.getCursor(), Pos(0, 0)); + cm.execCommand("goLineDown"); + eqCursorPos(cm.getCursor(), Pos(0, 11)); + cm.setCursor(Pos(0, 5)); + cm.execCommand("goLineDown"); + eqCursorPos(cm.getCursor(), Pos(0, 11)); + cm.execCommand("goLineDown"); + eqCursorPos(cm.getCursor(), Pos(0, 11)); + cm.execCommand("goLineUp"); + eqCursorPos(cm.getCursor(), Pos(0, 0)); + cm.execCommand("goLineUp"); + eqCursorPos(cm.getCursor(), Pos(0, 0)); + cm.execCommand("goPageDown"); + eqCursorPos(cm.getCursor(), Pos(0, 11)); + cm.execCommand("goPageDown"); cm.execCommand("goLineDown"); + eqCursorPos(cm.getCursor(), Pos(0, 11)); + cm.execCommand("goPageUp"); + eqCursorPos(cm.getCursor(), Pos(0, 0)); + cm.setCursor(Pos(0, 5)); + cm.execCommand("goPageUp"); + eqCursorPos(cm.getCursor(), Pos(0, 0)); + cm.setCursor(Pos(0, 5)); + cm.execCommand("goPageDown"); + eqCursorPos(cm.getCursor(), Pos(0, 11)); +}, {value: "single line"}); + + +testCM("rtlMovement", function(cm) { + if (cm.getOption("inputStyle") != "textarea") return; + forEach(["خحج", "خحabcخحج", "abخحخحجcd", "abخde", "abخح2342خ1حج", "خ1ح2خح3حxج", + "خحcd", "1خحcd", "abcdeح1ج", "خمرحبها مها!", "foobarر", "خ ة ق", + "![](\"/בדיקה3.jpg\")
", "يتم السحب في 05 فبراير 2014"], function(line) {
+ cm.setValue(line + "\n"); cm.execCommand("goLineStart");
+ var cursors = byClassName(cm.getWrapperElement(), "CodeMirror-cursors")[0];
+ var cursor = cursors.firstChild;
+ var prevX = cursor.offsetLeft, prevY = cursor.offsetTop;
+ for (var i = 0; i <= line.length; ++i) {
+ cm.execCommand("goCharRight");
+ cursor = cursors.firstChild;
+ if (i == line.length) is(cursor.offsetTop > prevY, "next line");
+ else is(cursor.offsetLeft > prevX, "moved right");
+ prevX = cursor.offsetLeft; prevY = cursor.offsetTop;
+ }
+ cm.setCursor(0, 0); cm.execCommand("goLineEnd");
+ prevX = cursors.firstChild.offsetLeft;
+ for (var i = 0; i < line.length; ++i) {
+ cm.execCommand("goCharLeft");
+ cursor = cursors.firstChild;
+ is(cursor.offsetLeft < prevX, "moved left");
+ prevX = cursor.offsetLeft;
+ }
+ });
+}, null, ie_lt9);
+
+// Verify that updating a line clears its bidi ordering
+testCM("bidiUpdate", function(cm) {
+ cm.setCursor(Pos(0, 2, "before"));
+ cm.replaceSelection("خحج", "start");
+ cm.execCommand("goCharRight");
+ eqCursorPos(cm.getCursor(), Pos(0, 6, "before"));
+}, {value: "abcd\n"});
+
+testCM("movebyTextUnit", function(cm) {
+ cm.setValue("בְּרֵאשִ\nééé́\n");
+ cm.execCommand("goLineStart");
+ for (var i = 0; i < 4; ++i) cm.execCommand("goCharRight");
+ eqCursorPos(cm.getCursor(), Pos(0, 0, "after"));
+ cm.execCommand("goCharRight");
+ eqCursorPos(cm.getCursor(), Pos(1, 0, "after"));
+ cm.execCommand("goCharRight");
+ cm.execCommand("goCharRight");
+ eqCursorPos(cm.getCursor(), Pos(1, 4, "before"));
+ cm.execCommand("goCharRight");
+ eqCursorPos(cm.getCursor(), Pos(1, 7, "before"));
+});
+
+testCM("lineChangeEvents", function(cm) {
+ addDoc(cm, 3, 5);
+ var log = [], want = ["ch 0", "ch 1", "del 2", "ch 0", "ch 0", "del 1", "del 3", "del 4"];
+ for (var i = 0; i < 5; ++i) {
+ CodeMirror.on(cm.getLineHandle(i), "delete", function(i) {
+ return function() {log.push("del " + i);};
+ }(i));
+ CodeMirror.on(cm.getLineHandle(i), "change", function(i) {
+ return function() {log.push("ch " + i);};
+ }(i));
+ }
+ cm.replaceRange("x", Pos(0, 1));
+ cm.replaceRange("xy", Pos(1, 1), Pos(2));
+ cm.replaceRange("foo\nbar", Pos(0, 1));
+ cm.replaceRange("", Pos(0, 0), Pos(cm.lineCount()));
+ eq(log.length, want.length, "same length");
+ for (var i = 0; i < log.length; ++i)
+ eq(log[i], want[i]);
+});
+
+testCM("scrollEntirelyToRight", function(cm) {
+ if (phantom || cm.getOption("inputStyle") != "textarea") return;
+ addDoc(cm, 500, 2);
+ cm.setCursor(Pos(0, 500));
+ var wrap = cm.getWrapperElement(), cur = byClassName(wrap, "CodeMirror-cursor")[0];
+ is(wrap.getBoundingClientRect().right > cur.getBoundingClientRect().left);
+});
+
+testCM("lineWidgets", function(cm) {
+ addDoc(cm, 500, 3);
+ var last = cm.charCoords(Pos(2, 0));
+ var node = document.createElement("div");
+ node.innerHTML = "hi";
+ var widget = cm.addLineWidget(1, node);
+ is(last.top < cm.charCoords(Pos(2, 0)).top, "took up space");
+ cm.setCursor(Pos(1, 1));
+ cm.execCommand("goLineDown");
+ eqCharPos(cm.getCursor(), Pos(2, 1));
+ cm.execCommand("goLineUp");
+ eqCharPos(cm.getCursor(), Pos(1, 1));
+});
+
+testCM("lineWidgetFocus", function(cm) {
+ var place = document.getElementById("testground");
+ place.className = "offscreen";
+ try {
+ addDoc(cm, 500, 10);
+ var node = document.createElement("input");
+ var widget = cm.addLineWidget(1, node);
+ node.focus();
+ eq(document.activeElement, node);
+ cm.replaceRange("new stuff", Pos(1, 0));
+ eq(document.activeElement, node);
+ } finally {
+ place.className = "";
+ }
+});
+
+testCM("lineWidgetCautiousRedraw", function(cm) {
+ var node = document.createElement("div");
+ node.innerHTML = "hahah";
+ var w = cm.addLineWidget(0, node);
+ var redrawn = false;
+ w.on("redraw", function() { redrawn = true; });
+ cm.replaceSelection("0");
+ is(!redrawn);
+}, {value: "123\n456"});
+
+
+var knownScrollbarWidth;
+function scrollbarWidth(measure) {
+ if (knownScrollbarWidth != null) return knownScrollbarWidth;
+ var div = document.createElement('div');
+ div.style.cssText = "width: 50px; height: 50px; overflow-x: scroll";
+ document.body.appendChild(div);
+ knownScrollbarWidth = div.offsetHeight - div.clientHeight;
+ document.body.removeChild(div);
+ return knownScrollbarWidth || 0;
+}
+
+testCM("lineWidgetChanged", function(cm) {
+ addDoc(cm, 2, 300);
+ var halfScrollbarWidth = scrollbarWidth(cm.display.measure)/2;
+ cm.setOption('lineNumbers', true);
+ cm.setSize(600, cm.defaultTextHeight() * 50);
+ cm.scrollTo(null, cm.heightAtLine(125, "local"));
+
+ var expectedWidgetHeight = 60;
+ var expectedLinesInWidget = 3;
+ function w() {
+ var node = document.createElement("div");
+ // we use these children with just under half width of the line to check measurements are made with correct width
+ // when placed in the measure div.
+ // If the widget is measured at a width much narrower than it is displayed at, the underHalf children will span two lines and break the test.
+ // If the widget is measured at a width much wider than it is displayed at, the overHalf children will combine and break the test.
+ // Note that this test only checks widgets where coverGutter is true, because these require extra styling to get the width right.
+ // It may also be worthwhile to check this for non-coverGutter widgets.
+ // Visually:
+ // Good:
+ // | ------------- display width ------------- |
+ // | ------- widget-width when measured ------ |
+ // | | -- under-half -- | | -- under-half -- | |
+ // | | --- over-half --- | |
+ // | | --- over-half --- | |
+ // Height: measured as 3 lines, same as it will be when actually displayed
+
+ // Bad (too narrow):
+ // | ------------- display width ------------- |
+ // | ------ widget-width when measured ----- | < -- uh oh
+ // | | -- under-half -- | |
+ // | | -- under-half -- | | < -- when measured, shoved to next line
+ // | | --- over-half --- | |
+ // | | --- over-half --- | |
+ // Height: measured as 4 lines, more than expected . Will be displayed as 3 lines!
+
+ // Bad (too wide):
+ // | ------------- display width ------------- |
+ // | -------- widget-width when measured ------- | < -- uh oh
+ // | | -- under-half -- | | -- under-half -- | |
+ // | | --- over-half --- | | --- over-half --- | | < -- when measured, combined on one line
+ // Height: measured as 2 lines, less than expected. Will be displayed as 3 lines!
+
+ var barelyUnderHalfWidthHtml = '';
+ var barelyOverHalfWidthHtml = '';
+ node.innerHTML = new Array(3).join(barelyUnderHalfWidthHtml) + new Array(3).join(barelyOverHalfWidthHtml);
+ node.style.cssText = "background: yellow;font-size:0;line-height: " + (expectedWidgetHeight/expectedLinesInWidget) + "px;";
+ return node;
+ }
+ var info0 = cm.getScrollInfo();
+ var w0 = cm.addLineWidget(0, w(), { coverGutter: true });
+ var w150 = cm.addLineWidget(150, w(), { coverGutter: true });
+ var w300 = cm.addLineWidget(300, w(), { coverGutter: true });
+ var info1 = cm.getScrollInfo();
+ eq(info0.height + (3 * expectedWidgetHeight), info1.height);
+ eq(info0.top + expectedWidgetHeight, info1.top);
+ expectedWidgetHeight = 12;
+ w0.node.style.lineHeight = w150.node.style.lineHeight = w300.node.style.lineHeight = (expectedWidgetHeight/expectedLinesInWidget) + "px";
+ w0.changed(); w150.changed(); w300.changed();
+ var info2 = cm.getScrollInfo();
+ eq(info0.height + (3 * expectedWidgetHeight), info2.height);
+ eq(info0.top + expectedWidgetHeight, info2.top);
+});
+
+testCM("getLineNumber", function(cm) {
+ addDoc(cm, 2, 20);
+ var h1 = cm.getLineHandle(1);
+ eq(cm.getLineNumber(h1), 1);
+ cm.replaceRange("hi\nbye\n", Pos(0, 0));
+ eq(cm.getLineNumber(h1), 3);
+ cm.setValue("");
+ eq(cm.getLineNumber(h1), null);
+});
+
+testCM("jumpTheGap", function(cm) {
+ if (phantom) return;
+ var longLine = "abcdef ghiklmnop qrstuvw xyz ";
+ longLine += longLine; longLine += longLine; longLine += longLine;
+ cm.replaceRange(longLine, Pos(2, 0), Pos(2));
+ cm.setSize("200px", null);
+ cm.getWrapperElement().style.lineHeight = 2;
+ cm.refresh();
+ cm.setCursor(Pos(0, 1));
+ cm.execCommand("goLineDown");
+ eqCharPos(cm.getCursor(), Pos(1, 1));
+ cm.execCommand("goLineDown");
+ eqCharPos(cm.getCursor(), Pos(2, 1));
+ cm.execCommand("goLineDown");
+ eq(cm.getCursor().line, 2);
+ is(cm.getCursor().ch > 1);
+ cm.execCommand("goLineUp");
+ eqCharPos(cm.getCursor(), Pos(2, 1));
+ cm.execCommand("goLineUp");
+ eqCharPos(cm.getCursor(), Pos(1, 1));
+ var node = document.createElement("div");
+ node.innerHTML = "hi"; node.style.height = "30px";
+ cm.addLineWidget(0, node);
+ cm.addLineWidget(1, node.cloneNode(true), {above: true});
+ cm.setCursor(Pos(0, 2));
+ cm.execCommand("goLineDown");
+ eqCharPos(cm.getCursor(), Pos(1, 2));
+ cm.execCommand("goLineUp");
+ eqCharPos(cm.getCursor(), Pos(0, 2));
+}, {lineWrapping: true, value: "abc\ndef\nghi\njkl\n"});
+
+testCM("addLineClass", function(cm) {
+ function cls(line, text, bg, wrap, gutter) {
+ var i = cm.lineInfo(line);
+ eq(i.textClass, text);
+ eq(i.bgClass, bg);
+ eq(i.wrapClass, wrap);
+ if (typeof i.handle.gutterClass !== 'undefined') {
+ eq(i.handle.gutterClass, gutter);
+ }
+ }
+ cm.addLineClass(0, "text", "foo");
+ cm.addLineClass(0, "text", "bar");
+ cm.addLineClass(1, "background", "baz");
+ cm.addLineClass(1, "wrap", "foo");
+ cm.addLineClass(1, "gutter", "gutter-class");
+ cls(0, "foo bar", null, null, null);
+ cls(1, null, "baz", "foo", "gutter-class");
+ var lines = cm.display.lineDiv;
+ eq(byClassName(lines, "foo").length, 2);
+ eq(byClassName(lines, "bar").length, 1);
+ eq(byClassName(lines, "baz").length, 1);
+ eq(byClassName(lines, "gutter-class").length, 2); // Gutter classes are reflected in 2 nodes
+ cm.removeLineClass(0, "text", "foo");
+ cls(0, "bar", null, null, null);
+ cm.removeLineClass(0, "text", "foo");
+ cls(0, "bar", null, null, null);
+ cm.removeLineClass(0, "text", "bar");
+ cls(0, null, null, null);
+
+ cm.addLineClass(1, "wrap", "quux");
+ cls(1, null, "baz", "foo quux", "gutter-class");
+ cm.removeLineClass(1, "wrap");
+ cls(1, null, "baz", null, "gutter-class");
+ cm.removeLineClass(1, "gutter", "gutter-class");
+ eq(byClassName(lines, "gutter-class").length, 0);
+ cls(1, null, "baz", null, null);
+
+ cm.addLineClass(1, "gutter", "gutter-class");
+ cls(1, null, "baz", null, "gutter-class");
+ cm.removeLineClass(1, "gutter", "gutter-class");
+ cls(1, null, "baz", null, null);
+
+}, {value: "hohoho\n", lineNumbers: true});
+
+testCM("atomicMarker", function(cm) {
+ addDoc(cm, 10, 10);
+ function atom(ll, cl, lr, cr, li, ri) {
+ return cm.markText(Pos(ll, cl), Pos(lr, cr),
+ {atomic: true, inclusiveLeft: li, inclusiveRight: ri});
+ }
+ var m = atom(0, 1, 0, 5);
+ cm.setCursor(Pos(0, 1));
+ cm.execCommand("goCharRight");
+ eqCursorPos(cm.getCursor(), Pos(0, 5));
+ cm.execCommand("goCharLeft");
+ eqCursorPos(cm.getCursor(), Pos(0, 1));
+ m.clear();
+ m = atom(0, 0, 0, 5, true);
+ eqCursorPos(cm.getCursor(), Pos(0, 5), "pushed out");
+ cm.execCommand("goCharLeft");
+ eqCursorPos(cm.getCursor(), Pos(0, 5));
+ m.clear();
+ m = atom(8, 4, 9, 10, false, true);
+ cm.setCursor(Pos(9, 8));
+ eqCursorPos(cm.getCursor(), Pos(8, 4), "set");
+ cm.execCommand("goCharRight");
+ eqCursorPos(cm.getCursor(), Pos(8, 4), "char right");
+ cm.execCommand("goLineDown");
+ eqCursorPos(cm.getCursor(), Pos(8, 4), "line down");
+ cm.execCommand("goCharLeft");
+ eqCursorPos(cm.getCursor(), Pos(8, 3, "after"));
+ m.clear();
+ m = atom(1, 1, 3, 8);
+ cm.setCursor(Pos(0, 0));
+ cm.setCursor(Pos(2, 0));
+ eqCursorPos(cm.getCursor(), Pos(3, 8));
+ cm.execCommand("goCharLeft");
+ eqCursorPos(cm.getCursor(), Pos(1, 1));
+ cm.execCommand("goCharRight");
+ eqCursorPos(cm.getCursor(), Pos(3, 8));
+ cm.execCommand("goLineUp");
+ eqCursorPos(cm.getCursor(), Pos(1, 1));
+ cm.execCommand("goLineDown");
+ eqCursorPos(cm.getCursor(), Pos(3, 8));
+ cm.execCommand("delCharBefore");
+ eq(cm.getValue().length, 80, "del chunk");
+ m = atom(3, 0, 5, 5);
+ cm.setCursor(Pos(3, 0));
+ cm.execCommand("delWordAfter");
+ eq(cm.getValue().length, 53, "del chunk");
+});
+
+testCM("selectionBias", function(cm) {
+ cm.markText(Pos(0, 1), Pos(0, 3), {atomic: true});
+ cm.setCursor(Pos(0, 2));
+ eqCursorPos(cm.getCursor(), Pos(0, 1));
+ cm.setCursor(Pos(0, 2));
+ eqCursorPos(cm.getCursor(), Pos(0, 3));
+ cm.setCursor(Pos(0, 2));
+ eqCursorPos(cm.getCursor(), Pos(0, 1));
+ cm.setCursor(Pos(0, 2), null, {bias: -1});
+ eqCursorPos(cm.getCursor(), Pos(0, 1));
+ cm.setCursor(Pos(0, 4));
+ cm.setCursor(Pos(0, 2), null, {bias: 1});
+ eqCursorPos(cm.getCursor(), Pos(0, 3));
+}, {value: "12345"});
+
+testCM("selectionHomeEnd", function(cm) {
+ cm.markText(Pos(1, 0), Pos(1, 1), {atomic: true, inclusiveLeft: true});
+ cm.markText(Pos(1, 3), Pos(1, 4), {atomic: true, inclusiveRight: true});
+ cm.setCursor(Pos(1, 2));
+ cm.execCommand("goLineStart");
+ eqCursorPos(cm.getCursor(), Pos(1, 1));
+ cm.execCommand("goLineEnd");
+ eqCursorPos(cm.getCursor(), Pos(1, 3));
+}, {value: "ab\ncdef\ngh"});
+
+testCM("readOnlyMarker", function(cm) {
+ function mark(ll, cl, lr, cr, at) {
+ return cm.markText(Pos(ll, cl), Pos(lr, cr),
+ {readOnly: true, atomic: at});
+ }
+ var m = mark(0, 1, 0, 4);
+ cm.setCursor(Pos(0, 2));
+ cm.replaceSelection("hi", "end");
+ eqCursorPos(cm.getCursor(), Pos(0, 2));
+ eq(cm.getLine(0), "abcde");
+ cm.execCommand("selectAll");
+ cm.replaceSelection("oops", "around");
+ eq(cm.getValue(), "oopsbcd");
+ cm.undo();
+ eqCursorPos(m.find().from, Pos(0, 1));
+ eqCursorPos(m.find().to, Pos(0, 4));
+ m.clear();
+ cm.setCursor(Pos(0, 2));
+ cm.replaceSelection("hi", "around");
+ eq(cm.getLine(0), "abhicde");
+ eqCursorPos(cm.getCursor(), Pos(0, 4));
+ m = mark(0, 2, 2, 2, true);
+ cm.setSelection(Pos(1, 1), Pos(2, 4));
+ cm.replaceSelection("t", "end");
+ eqCursorPos(cm.getCursor(), Pos(2, 3));
+ eq(cm.getLine(2), "klto");
+ cm.execCommand("goCharLeft");
+ cm.execCommand("goCharLeft");
+ eqCursorPos(cm.getCursor(), Pos(0, 2));
+ cm.setSelection(Pos(0, 1), Pos(0, 3));
+ cm.replaceSelection("xx", "around");
+ eqCursorPos(cm.getCursor(), Pos(0, 3));
+ eq(cm.getLine(0), "axxhicde");
+}, {value: "abcde\nfghij\nklmno\n"});
+
+testCM("dirtyBit", function(cm) {
+ eq(cm.isClean(), true);
+ cm.replaceSelection("boo", null, "test");
+ eq(cm.isClean(), false);
+ cm.undo();
+ eq(cm.isClean(), true);
+ cm.replaceSelection("boo", null, "test");
+ cm.replaceSelection("baz", null, "test");
+ cm.undo();
+ eq(cm.isClean(), false);
+ cm.markClean();
+ eq(cm.isClean(), true);
+ cm.undo();
+ eq(cm.isClean(), false);
+ cm.redo();
+ eq(cm.isClean(), true);
+});
+
+testCM("changeGeneration", function(cm) {
+ cm.replaceSelection("x");
+ var softGen = cm.changeGeneration();
+ cm.replaceSelection("x");
+ cm.undo();
+ eq(cm.getValue(), "");
+ is(!cm.isClean(softGen));
+ cm.replaceSelection("x");
+ var hardGen = cm.changeGeneration(true);
+ cm.replaceSelection("x");
+ cm.undo();
+ eq(cm.getValue(), "x");
+ is(cm.isClean(hardGen));
+});
+
+testCM("addKeyMap", function(cm) {
+ function sendKey(code) {
+ cm.triggerOnKeyDown({type: "keydown", keyCode: code,
+ preventDefault: function(){}, stopPropagation: function(){}});
+ }
+
+ sendKey(39);
+ eqCursorPos(cm.getCursor(), Pos(0, 1, "before"));
+ var test = 0;
+ var map1 = {Right: function() { ++test; }}, map2 = {Right: function() { test += 10; }}
+ cm.addKeyMap(map1);
+ sendKey(39);
+ eqCursorPos(cm.getCursor(), Pos(0, 1, "before"));
+ eq(test, 1);
+ cm.addKeyMap(map2, true);
+ sendKey(39);
+ eq(test, 2);
+ cm.removeKeyMap(map1);
+ sendKey(39);
+ eq(test, 12);
+ cm.removeKeyMap(map2);
+ sendKey(39);
+ eq(test, 12);
+ eqCursorPos(cm.getCursor(), Pos(0, 2, "before"));
+ cm.addKeyMap({Right: function() { test = 55; }, name: "mymap"});
+ sendKey(39);
+ eq(test, 55);
+ cm.removeKeyMap("mymap");
+ sendKey(39);
+ eqCursorPos(cm.getCursor(), Pos(0, 3, "before"));
+}, {value: "abc"});
+
+function mouseDown(cm, button, pos, mods) {
+ var coords = cm.charCoords(pos, "window")
+ var event = {type: "mousedown",
+ preventDefault: Math.min,
+ which: button,
+ target: cm.display.lineDiv,
+ clientX: coords.left, clientY: coords.top}
+ if (mods) for (var prop in mods) event[prop] = mods[prop]
+ cm.triggerOnMouseDown(event)
+}
+
+testCM("mouseBinding", function(cm) {
+ var fired = []
+ cm.addKeyMap({
+ "Shift-LeftClick": function(_cm, pos) {
+ eqCharPos(pos, Pos(1, 2))
+ fired.push("a")
+ },
+ "Shift-LeftDoubleClick": function() { fired.push("b") },
+ "Shift-LeftTripleClick": function() { fired.push("c") }
+ })
+
+ function send(button, mods) { mouseDown(cm, button, Pos(1, 2), mods) }
+ send(1, {shiftKey: true})
+ send(1, {shiftKey: true})
+ send(1, {shiftKey: true})
+ send(1, {})
+ send(2, {ctrlKey: true})
+ send(2, {ctrlKey: true})
+ eq(fired.join(" "), "a b c")
+}, {value: "foo\nbar\nbaz"})
+
+testCM("configureMouse", function(cm) {
+ cm.setOption("configureMouse", function() { return {unit: "word"} })
+ mouseDown(cm, 1, Pos(0, 5))
+ eqCharPos(cm.getCursor("from"), Pos(0, 4))
+ eqCharPos(cm.getCursor("to"), Pos(0, 7))
+ cm.setOption("configureMouse", function() { return {extend: true} })
+ mouseDown(cm, 1, Pos(0, 0))
+ eqCharPos(cm.getCursor("from"), Pos(0, 0))
+ eqCharPos(cm.getCursor("to"), Pos(0, 4))
+}, {value: "foo bar baz"})
+
+testCM("findPosH", function(cm) {
+ forEach([{from: Pos(0, 0), to: Pos(0, 1, "before"), by: 1},
+ {from: Pos(0, 0), to: Pos(0, 0), by: -1, hitSide: true},
+ {from: Pos(0, 0), to: Pos(0, 4, "before"), by: 1, unit: "word"},
+ {from: Pos(0, 0), to: Pos(0, 8, "before"), by: 2, unit: "word"},
+ {from: Pos(0, 0), to: Pos(2, 0, "after"), by: 20, unit: "word", hitSide: true},
+ {from: Pos(0, 7), to: Pos(0, 5, "after"), by: -1, unit: "word"},
+ {from: Pos(0, 4), to: Pos(0, 8, "before"), by: 1, unit: "word"},
+ {from: Pos(1, 0), to: Pos(1, 18, "before"), by: 3, unit: "word"},
+ {from: Pos(1, 22), to: Pos(1, 5, "after"), by: -3, unit: "word"},
+ {from: Pos(1, 15), to: Pos(1, 10, "after"), by: -5},
+ {from: Pos(1, 15), to: Pos(1, 10, "after"), by: -5, unit: "column"},
+ {from: Pos(1, 15), to: Pos(1, 0, "after"), by: -50, unit: "column", hitSide: true},
+ {from: Pos(1, 15), to: Pos(1, 24, "before"), by: 50, unit: "column", hitSide: true},
+ {from: Pos(1, 15), to: Pos(2, 0, "after"), by: 50, hitSide: true}], function(t) {
+ var r = cm.findPosH(t.from, t.by, t.unit || "char");
+ eqCursorPos(r, t.to);
+ eq(!!r.hitSide, !!t.hitSide);
+ });
+}, {value: "line one\nline two.something.other\n"});
+
+testCM("beforeChange", function(cm) {
+ cm.on("beforeChange", function(cm, change) {
+ var text = [];
+ for (var i = 0; i < change.text.length; ++i)
+ text.push(change.text[i].replace(/\s/g, "_"));
+ change.update(null, null, text);
+ });
+ cm.setValue("hello, i am a\nnew document\n");
+ eq(cm.getValue(), "hello,_i_am_a\nnew_document\n");
+ CodeMirror.on(cm.getDoc(), "beforeChange", function(doc, change) {
+ if (change.from.line == 0) change.cancel();
+ });
+ cm.setValue("oops"); // Canceled
+ eq(cm.getValue(), "hello,_i_am_a\nnew_document\n");
+ cm.replaceRange("hey hey hey", Pos(1, 0), Pos(2, 0));
+ eq(cm.getValue(), "hello,_i_am_a\nhey_hey_hey");
+}, {value: "abcdefghijk"});
+
+testCM("beforeChangeUndo", function(cm) {
+ cm.replaceRange("hi", Pos(0, 0), Pos(0));
+ cm.replaceRange("bye", Pos(0, 0), Pos(0));
+ eq(cm.historySize().undo, 2);
+ cm.on("beforeChange", function(cm, change) {
+ is(!change.update);
+ change.cancel();
+ });
+ cm.undo();
+ eq(cm.historySize().undo, 0);
+ eq(cm.getValue(), "bye\ntwo");
+}, {value: "one\ntwo"});
+
+testCM("beforeSelectionChange", function(cm) {
+ function notAtEnd(cm, pos) {
+ var len = cm.getLine(pos.line).length;
+ if (!len || pos.ch == len) return Pos(pos.line, pos.ch - 1);
+ return pos;
+ }
+ cm.on("beforeSelectionChange", function(cm, obj) {
+ obj.update([{anchor: notAtEnd(cm, obj.ranges[0].anchor),
+ head: notAtEnd(cm, obj.ranges[0].head)}]);
+ });
+
+ addDoc(cm, 10, 10);
+ cm.execCommand("goLineEnd");
+ eqCursorPos(cm.getCursor(), Pos(0, 9));
+ cm.execCommand("selectAll");
+ eqCursorPos(cm.getCursor("start"), Pos(0, 0));
+ eqCursorPos(cm.getCursor("end"), Pos(9, 9));
+});
+
+testCM("change_removedText", function(cm) {
+ cm.setValue("abc\ndef");
+
+ var removedText = [];
+ cm.on("change", function(cm, change) {
+ removedText.push(change.removed);
+ });
+
+ cm.operation(function() {
+ cm.replaceRange("xyz", Pos(0, 0), Pos(1,1));
+ cm.replaceRange("123", Pos(0,0));
+ });
+
+ eq(removedText.length, 2);
+ eq(removedText[0].join("\n"), "abc\nd");
+ eq(removedText[1].join("\n"), "");
+
+ var removedText = [];
+ cm.undo();
+ eq(removedText.length, 2);
+ eq(removedText[0].join("\n"), "123");
+ eq(removedText[1].join("\n"), "xyz");
+
+ var removedText = [];
+ cm.redo();
+ eq(removedText.length, 2);
+ eq(removedText[0].join("\n"), "abc\nd");
+ eq(removedText[1].join("\n"), "");
+});
+
+testCM("lineStyleFromMode", function(cm) {
+ CodeMirror.defineMode("test_mode", function() {
+ return {token: function(stream) {
+ if (stream.match(/^\[[^\]]*\]/)) return " line-brackets ";
+ if (stream.match(/^\([^\)]*\)/)) return " line-background-parens ";
+ if (stream.match(/^<[^>]*>/)) return " span line-line line-background-bg ";
+ stream.match(/^\s+|^\S+/);
+ }};
+ });
+ cm.setOption("mode", "test_mode");
+ var bracketElts = byClassName(cm.getWrapperElement(), "brackets");
+ eq(bracketElts.length, 1, "brackets count");
+ eq(bracketElts[0].nodeName, "PRE");
+ is(!/brackets.*brackets/.test(bracketElts[0].className));
+ var parenElts = byClassName(cm.getWrapperElement(), "parens");
+ eq(parenElts.length, 1, "parens count");
+ eq(parenElts[0].nodeName, "DIV");
+ is(!/parens.*parens/.test(parenElts[0].className));
+ eq(parenElts[0].parentElement.nodeName, "DIV");
+
+ is(byClassName(cm.getWrapperElement(), "bg").length > 0);
+ is(byClassName(cm.getWrapperElement(), "line").length > 0);
+ var spanElts = byClassName(cm.getWrapperElement(), "cm-span");
+ eq(spanElts.length, 2);
+ is(/^\s*cm-span\s*$/.test(spanElts[0].className));
+}, {value: "line1: [br] [br]\nline2: (par) (par)\nline3: مفتي11 تم تضمينهفتي تم تضمينها فتي تفتي تم تضمينها فتي تفتي تم تضمينها فتي تفتي تم تضمينها فتي تا فت10ي ت
", lineWrapping: true}) + +testCM("delete_wrapped", function(cm) { + makeItWrapAfter(cm, Pos(0, 2)); + cm.doc.setCursor(Pos(0, 3, "after")); + cm.deleteH(-1, "char"); + eq(cm.getLine(0), "1245"); +}, {value: "12345", lineWrapping: true}) + +testCM("issue_4878", function(cm) { + if (phantom) return + cm.setCursor(Pos(1, 12, "after")); + cm.moveH(-1, "char"); + eqCursorPos(cm.getCursor(), Pos(0, 113, "before")); +}, {value: " في تطبيق السمات مرة واحدة https://github.com/codemirror/CodeMirror/issues/4878#issuecomment-330550964على سبيل المثال\"foo bar\"\n" +
+" سيتم تعيين", direction: "rtl", lineWrapping: true});
+
+CodeMirror.defineMode("lookahead_mode", function() {
+ // Colors text as atom if the line two lines down has an x in it
+ return {
+ token: function(stream) {
+ stream.skipToEnd()
+ return /x/.test(stream.lookAhead(2)) ? "atom" : null
+ }
+ }
+})
+
+testCM("mode_lookahead", function(cm) {
+ eq(cm.getTokenAt(Pos(0, 1)).type, "atom")
+ eq(cm.getTokenAt(Pos(1, 1)).type, "atom")
+ eq(cm.getTokenAt(Pos(2, 1)).type, null)
+ cm.replaceRange("\n", Pos(2, 0))
+ eq(cm.getTokenAt(Pos(0, 1)).type, null)
+ eq(cm.getTokenAt(Pos(1, 1)).type, "atom")
+}, {value: "foo\na\nx\nx\n", mode: "lookahead_mode"})
diff --git a/backend/webif/static/codemirror/test/vim_test.js b/backend/webif/static/codemirror/test/vim_test.js
new file mode 100755
index 000000000..18268ee78
--- /dev/null
+++ b/backend/webif/static/codemirror/test/vim_test.js
@@ -0,0 +1,4238 @@
+var Pos = CodeMirror.Pos;
+CodeMirror.Vim.suppressErrorLogging = true;
+
+var code = '' +
+' wOrd1 (#%\n' +
+' word3] \n' +
+'aopop pop 0 1 2 3 4\n' +
+' (a) [b] {c} \n' +
+'int getchar(void) {\n' +
+' static char buf[BUFSIZ];\n' +
+' static char *bufp = buf;\n' +
+' if (n == 0) { /* buffer is empty */\n' +
+' n = read(0, buf, sizeof buf);\n' +
+' bufp = buf;\n' +
+' }\n' +
+'\n' +
+' return (--n >= 0) ? (unsigned char) *bufp++ : EOF;\n' +
+' \n' +
+'}\n';
+
+var lines = (function() {
+ lineText = code.split('\n');
+ var ret = [];
+ for (var i = 0; i < lineText.length; i++) {
+ ret[i] = {
+ line: i,
+ length: lineText[i].length,
+ lineText: lineText[i],
+ textStart: /^\s*/.exec(lineText[i])[0].length
+ };
+ }
+ return ret;
+})();
+var endOfDocument = makeCursor(lines.length - 1,
+ lines[lines.length - 1].length);
+var wordLine = lines[0];
+var bigWordLine = lines[1];
+var charLine = lines[2];
+var bracesLine = lines[3];
+var seekBraceLine = lines[4];
+
+var word1 = {
+ start: new Pos(wordLine.line, 1),
+ end: new Pos(wordLine.line, 5)
+};
+var word2 = {
+ start: new Pos(wordLine.line, word1.end.ch + 2),
+ end: new Pos(wordLine.line, word1.end.ch + 4)
+};
+var word3 = {
+ start: new Pos(bigWordLine.line, 1),
+ end: new Pos(bigWordLine.line, 5)
+};
+var bigWord1 = word1;
+var bigWord2 = word2;
+var bigWord3 = {
+ start: new Pos(bigWordLine.line, 1),
+ end: new Pos(bigWordLine.line, 7)
+};
+var bigWord4 = {
+ start: new Pos(bigWordLine.line, bigWord1.end.ch + 3),
+ end: new Pos(bigWordLine.line, bigWord1.end.ch + 7)
+};
+
+var oChars = [ new Pos(charLine.line, 1),
+ new Pos(charLine.line, 3),
+ new Pos(charLine.line, 7) ];
+var pChars = [ new Pos(charLine.line, 2),
+ new Pos(charLine.line, 4),
+ new Pos(charLine.line, 6),
+ new Pos(charLine.line, 8) ];
+var numChars = [ new Pos(charLine.line, 10),
+ new Pos(charLine.line, 12),
+ new Pos(charLine.line, 14),
+ new Pos(charLine.line, 16),
+ new Pos(charLine.line, 18)];
+var parens1 = {
+ start: new Pos(bracesLine.line, 1),
+ end: new Pos(bracesLine.line, 3)
+};
+var squares1 = {
+ start: new Pos(bracesLine.line, 5),
+ end: new Pos(bracesLine.line, 7)
+};
+var curlys1 = {
+ start: new Pos(bracesLine.line, 9),
+ end: new Pos(bracesLine.line, 11)
+};
+var seekOutside = {
+ start: new Pos(seekBraceLine.line, 1),
+ end: new Pos(seekBraceLine.line, 16)
+};
+var seekInside = {
+ start: new Pos(seekBraceLine.line, 14),
+ end: new Pos(seekBraceLine.line, 11)
+};
+
+function copyCursor(cur) {
+ return new Pos(cur.line, cur.ch);
+}
+
+function forEach(arr, func) {
+ for (var i = 0; i < arr.length; i++) {
+ func(arr[i], i, arr);
+ }
+}
+
+function testVim(name, run, opts, expectedFail) {
+ var vimOpts = {
+ lineNumbers: true,
+ vimMode: true,
+ showCursorWhenSelecting: true,
+ value: code
+ };
+ for (var prop in opts) {
+ if (opts.hasOwnProperty(prop)) {
+ vimOpts[prop] = opts[prop];
+ }
+ }
+ return test('vim_' + name, function() {
+ var place = document.getElementById("testground");
+ var cm = CodeMirror(place, vimOpts);
+ var vim = CodeMirror.Vim.maybeInitVimState_(cm);
+
+ function doKeysFn(cm) {
+ return function(args) {
+ if (args instanceof Array) {
+ arguments = args;
+ }
+ for (var i = 0; i < arguments.length; i++) {
+ var result = CodeMirror.Vim.handleKey(cm, arguments[i]);
+ if (!result && cm.state.vim.insertMode) {
+ cm.replaceSelections(fillArray(arguments[i], cm.listSelections().length));
+ }
+ }
+ }
+ }
+ function doInsertModeKeysFn(cm) {
+ return function(args) {
+ if (args instanceof Array) { arguments = args; }
+ function executeHandler(handler) {
+ if (typeof handler == 'string') {
+ CodeMirror.commands[handler](cm);
+ } else {
+ handler(cm);
+ }
+ return true;
+ }
+ for (var i = 0; i < arguments.length; i++) {
+ var key = arguments[i];
+ // Find key in keymap and handle.
+ var handled = CodeMirror.lookupKey(key, cm.getOption('keyMap'), executeHandler, cm);
+ // Record for insert mode.
+ if (handled == "handled" && cm.state.vim.insertMode && arguments[i] != 'Esc') {
+ var lastChange = CodeMirror.Vim.getVimGlobalState_().macroModeState.lastInsertModeChanges;
+ if (lastChange && (key.indexOf('Delete') != -1 || key.indexOf('Backspace') != -1)) {
+ lastChange.changes.push(new CodeMirror.Vim.InsertModeKey(key));
+ }
+ }
+ }
+ }
+ }
+ function doExFn(cm) {
+ return function(command) {
+ cm.openDialog = helpers.fakeOpenDialog(command);
+ helpers.doKeys(':');
+ }
+ }
+ function assertCursorAtFn(cm) {
+ return function(line, ch) {
+ var pos;
+ if (ch == null && typeof line.line == 'number') {
+ pos = line;
+ } else {
+ pos = makeCursor(line, ch);
+ }
+ eqCursorPos(cm.getCursor(), pos);
+ }
+ }
+ function fakeOpenDialog(result) {
+ return function(text, callback) {
+ return callback(result);
+ }
+ }
+ function fakeOpenNotification(matcher) {
+ return function(text) {
+ matcher(text);
+ }
+ }
+ var helpers = {
+ doKeys: doKeysFn(cm),
+ // Warning: Only emulates keymap events, not character insertions. Use
+ // replaceRange to simulate character insertions.
+ // Keys are in CodeMirror format, NOT vim format.
+ doInsertModeKeys: doInsertModeKeysFn(cm),
+ doEx: doExFn(cm),
+ assertCursorAt: assertCursorAtFn(cm),
+ fakeOpenDialog: fakeOpenDialog,
+ fakeOpenNotification: fakeOpenNotification,
+ getRegisterController: function() {
+ return CodeMirror.Vim.getRegisterController();
+ }
+ }
+ CodeMirror.Vim.resetVimGlobalState_();
+ var successful = false;
+ var savedOpenNotification = cm.openNotification;
+ var savedOpenDialog = cm.openDialog;
+ try {
+ run(cm, vim, helpers);
+ successful = true;
+ } finally {
+ cm.openNotification = savedOpenNotification;
+ cm.openDialog = savedOpenDialog;
+ if (!successful || verbose) {
+ place.style.visibility = "visible";
+ } else {
+ place.removeChild(cm.getWrapperElement());
+ }
+ }
+ }, expectedFail);
+};
+testVim('qq@q', function(cm, vim, helpers) {
+ cm.setCursor(0, 0);
+ helpers.doKeys('q', 'q', 'l', 'l', 'q');
+ helpers.assertCursorAt(0,2);
+ helpers.doKeys('@', 'q');
+ helpers.assertCursorAt(0,4);
+}, { value: ' '});
+testVim('@@', function(cm, vim, helpers) {
+ cm.setCursor(0, 0);
+ helpers.doKeys('q', 'q', 'l', 'l', 'q');
+ helpers.assertCursorAt(0,2);
+ helpers.doKeys('@', 'q');
+ helpers.assertCursorAt(0,4);
+ helpers.doKeys('@', '@');
+ helpers.assertCursorAt(0,6);
+}, { value: ' '});
+var jumplistScene = ''+
+ 'word\n'+
+ '(word)\n'+
+ '{word\n'+
+ 'word.\n'+
+ '\n'+
+ 'word search\n'+
+ '}word\n'+
+ 'word\n'+
+ 'word\n';
+function testJumplist(name, keys, endPos, startPos, dialog) {
+ endPos = makeCursor(endPos[0], endPos[1]);
+ startPos = makeCursor(startPos[0], startPos[1]);
+ testVim(name, function(cm, vim, helpers) {
+ CodeMirror.Vim.resetVimGlobalState_();
+ if(dialog)cm.openDialog = helpers.fakeOpenDialog('word');
+ cm.setCursor(startPos);
+ helpers.doKeys.apply(null, keys);
+ helpers.assertCursorAt(endPos);
+ }, {value: jumplistScene});
+};
+testJumplist('jumplist_H', ['H', '