merge with 3.7

src/Buffer.ts

@@ -5,7 +5,7 @@
 
 import { CircularList } from './common/CircularList';
 import { CharData, ITerminal, IBuffer, IBufferLine, IBufferLineConstructor } from './Types';
-import { EventEmitter } from './EventEmitter';
+import { EventEmitter } from './common/EventEmitter';
 import { IMarker } from 'xterm';
 import { BufferLine, BufferLineTypedArray } from './BufferLine';
 

src/BufferSet.ts

@@ -5,7 +5,7 @@
 
 import { ITerminal, IBufferSet } from './Types';
 import { Buffer } from './Buffer';
-import { EventEmitter } from './EventEmitter';
+import { EventEmitter } from './common/EventEmitter';
 
 /**
  * The BufferSet represents the set of two buffers used by xterm terminals (normal and alt) and

src/Linkifier.ts

@@ -6,7 +6,7 @@
 import { IMouseZoneManager } from './ui/Types';
 import { ILinkHoverEvent, ILinkMatcher, LinkMatcherHandler, LinkHoverEventTypes, ILinkMatcherOptions, ILinkifier, ITerminal, IBufferLine } from './Types';
 import { MouseZone } from './ui/MouseZoneManager';
-import { EventEmitter } from './EventEmitter';
+import { EventEmitter } from './common/EventEmitter';
 import { CHAR_DATA_ATTR_INDEX } from './Buffer';
 
 /**

src/SelectionManager.ts

@@ -3,11 +3,12 @@
  * @license MIT
  */
 
-import { ITerminal, ISelectionManager, IBuffer, CharData, XtermListener, IBufferLine } from './Types';
+import { ITerminal, ISelectionManager, IBuffer, CharData, IBufferLine } from './Types';
+import { XtermListener } from './common/Types';
 import { MouseHelper } from './utils/MouseHelper';
 import * as Browser from './shared/utils/Browser';
 import { CharMeasure } from './ui/CharMeasure';
-import { EventEmitter } from './EventEmitter';
+import { EventEmitter } from './common/EventEmitter';
 import { SelectionModel } from './SelectionModel';
 import { CHAR_DATA_WIDTH_INDEX, CHAR_DATA_CHAR_INDEX, CHAR_DATA_CODE_INDEX } from './Buffer';
 import { AltClickHandler } from './handlers/AltClickHandler';

src/Terminal.ts

@@ -27,7 +27,7 @@ import { IRenderer } from './renderer/Types';
 import { BufferSet } from './BufferSet';
 import { Buffer, MAX_BUFFER_SIZE, DEFAULT_ATTR, NULL_CELL_CODE, NULL_CELL_WIDTH, NULL_CELL_CHAR } from './Buffer';
 import { CompositionHelper } from './CompositionHelper';
-import { EventEmitter } from './EventEmitter';
+import { EventEmitter } from './common/EventEmitter';
 import { Viewport } from './Viewport';
 import { rightClickHandler, moveTextAreaUnderMouseCursor, pasteHandler, copyHandler } from './handlers/Clipboard';
 import { C0 } from './common/data/EscapeSequences';

src/Types.ts

@@ -7,11 +7,10 @@ import { Terminal as PublicTerminal, ITerminalOptions as IPublicTerminalOptions,
 import { IColorSet, IRenderer } from './renderer/Types';
 import { IMouseZoneManager } from './ui/Types';
 import { ICharset } from './core/Types';
+import { ICircularList } from './common/Types';
 
 export type CustomKeyEventHandler = (event: KeyboardEvent) => boolean;
 
-export type XtermListener = (...args: any[]) => void;
-
 export type CharData = [number, string, number, number];
 export type LineData = CharData[];
 
@@ -296,19 +295,6 @@ export interface IBufferSet extends IEventEmitter {
   activateAltBuffer(): void;
 }
 
-export interface ICircularList<T> extends IEventEmitter {
-  length: number;
-  maxLength: number;
-
-  get(index: number): T;
-  set(index: number, value: T): void;
-  push(value: T): void;
-  pop(): T;
-  splice(start: number, deleteCount: number, ...items: T[]): void;
-  trimStart(count: number): void;
-  shiftElements(start: number, count: number, offset: number): void;
-}
-
 export interface ISelectionManager {
   selectionText: string;
   selectionStart: [number, number];

src/addons/attach/tsconfig.json

@@ -2,6 +2,10 @@
   "compilerOptions": {
     "module": "commonjs",
     "target": "es5",
+    "lib": [
+      "dom",
+      "es6",
+    ],
     "rootDir": ".",
     "outDir": "../../../lib/addons/attach/",
     "sourceMap": true,

src/addons/fit/tsconfig.json

@@ -2,6 +2,10 @@
   "compilerOptions": {
     "module": "commonjs",
     "target": "es5",
+    "lib": [
+      "dom",
+      "es6",
+    ],
     "rootDir": ".",
     "outDir": "../../../lib/addons/fit/",
     "sourceMap": true,

src/addons/fullscreen/tsconfig.json

@@ -2,6 +2,10 @@
   "compilerOptions": {
     "module": "commonjs",
     "target": "es5",
+    "lib": [
+      "dom",
+      "es6",
+    ],
     "rootDir": ".",
     "outDir": "../../../lib/addons/fullscreen/",
     "sourceMap": true,

src/addons/search/Interfaces.ts

@@ -17,6 +17,18 @@ export interface ISearchAddonTerminal extends Terminal {
 }
 
 export interface ISearchHelper {
-  findNext(term: string): boolean;
-  findPrevious(term: string): boolean;
+  findNext(term: string, searchOptions: ISearchOptions): boolean;
+  findPrevious(term: string, searchOptions: ISearchOptions): boolean;
+}
+
+export interface ISearchOptions {
+  regex?: boolean;
+  wholeWord?: boolean;
+  caseSensitive?: boolean;
+}
+
+export interface ISearchResult {
+  term: string;
+  col: number;
+  row: number;
 }

src/addons/search/SearchHelper.ts

@@ -3,13 +3,7 @@
  * @license MIT
  */
 
-import { ISearchHelper, ISearchAddonTerminal } from './Interfaces';
-
-interface ISearchResult {
-  term: string;
-  col: number;
-  row: number;
-}
+import { ISearchHelper, ISearchAddonTerminal, ISearchOptions, ISearchResult } from './Interfaces';
 
 /**
  * A class that knows how to search the terminal and how to display the results.
@@ -19,16 +13,16 @@ export class SearchHelper implements ISearchHelper {
     // TODO: Search for multiple instances on 1 line
     // TODO: Don't use the actual selection, instead use a "find selection" so multiple instances can be highlighted
     // TODO: Highlight other instances in the viewport
-    // TODO: Support regex, case sensitivity, etc.
   }
 
   /**
    * Find the next instance of the term, then scroll to and select it. If it
    * doesn't exist, do nothing.
    * @param term Tne search term.
+   * @param searchOptions Search options.
    * @return Whether a result was found.
    */
-  public findNext(term: string): boolean {
+  public findNext(term: string, searchOptions?: ISearchOptions): boolean {
     if (!term || term.length === 0) {
       return false;
     }
@@ -43,7 +37,7 @@ export class SearchHelper implements ISearchHelper {
 
     // Search from ydisp + 1 to end
     for (let y = startRow + 1; y < this._terminal._core.buffer.ybase + this._terminal.rows; y++) {
-      result = this._findInLine(term, y);
+      result = this._findInLine(term, y, searchOptions);
       if (result) {
         break;
       }
@@ -52,7 +46,7 @@ export class SearchHelper implements ISearchHelper {
     // Search from the top to the current ydisp
     if (!result) {
       for (let y = 0; y < startRow; y++) {
-        result = this._findInLine(term, y);
+        result = this._findInLine(term, y, searchOptions);
         if (result) {
           break;
         }
@@ -67,9 +61,10 @@ export class SearchHelper implements ISearchHelper {
    * Find the previous instance of the term, then scroll to and select it. If it
    * doesn't exist, do nothing.
    * @param term Tne search term.
+   * @param searchOptions Search options.
    * @return Whether a result was found.
    */
-  public findPrevious(term: string): boolean {
+  public findPrevious(term: string, searchOptions?: ISearchOptions): boolean {
     if (!term || term.length === 0) {
       return false;
     }
@@ -84,7 +79,7 @@ export class SearchHelper implements ISearchHelper {
 
     // Search from ydisp + 1 to end
     for (let y = startRow - 1; y >= 0; y--) {
-      result = this._findInLine(term, y);
+      result = this._findInLine(term, y, searchOptions);
       if (result) {
         break;
       }
@@ -93,7 +88,7 @@ export class SearchHelper implements ISearchHelper {
     // Search from the top to the current ydisp
     if (!result) {
       for (let y = this._terminal._core.buffer.ybase + this._terminal.rows - 1; y > startRow; y--) {
-        result = this._findInLine(term, y);
+        result = this._findInLine(term, y, searchOptions);
         if (result) {
           break;
         }
@@ -106,14 +101,25 @@ export class SearchHelper implements ISearchHelper {
 
   /**
    * Searches a line for a search term.
-   * @param term Tne search term.
+   * @param term The search term.
    * @param y The line to search.
+   * @param searchOptions Search options.
    * @return The search result if it was found.
    */
-  private _findInLine(term: string, y: number): ISearchResult {
+  protected _findInLine(term: string, y: number, searchOptions: ISearchOptions = {}): ISearchResult {
     const lowerStringLine = this._terminal._core.buffer.translateBufferLineToString(y, true).toLowerCase();
     const lowerTerm = term.toLowerCase();
-    let searchIndex = lowerStringLine.indexOf(lowerTerm);
+    let searchIndex = -1;
+    if (searchOptions.regex) {
+      const searchRegex = RegExp(lowerTerm, 'g');
+      const foundTerm = searchRegex.exec(lowerStringLine);
+      if (foundTerm) {
+        searchIndex = searchRegex.lastIndex - foundTerm[0].length;
+        term = foundTerm[0];
+      }
+    } else {
+      searchIndex = lowerStringLine.indexOf(lowerTerm);
+    }
     if (searchIndex >= 0) {
       const line = this._terminal._core.buffer.lines.get(y);
       for (let i = 0; i < searchIndex; i++) {

src/addons/search/search.test.ts

@@ -6,17 +6,17 @@
 import { assert, expect } from 'chai';
 import * as search from './search';
 import { SearchHelper } from './SearchHelper';
-import { ISearchHelper } from './Interfaces';
+import { ISearchOptions, ISearchResult } from './Interfaces';
 
 
 class MockTerminalPlain {}
 
 class MockTerminal {
   private _core: any;
-  public searchHelper: ISearchHelper;
+  public searchHelper: TestSearchHelper;
   constructor(options: any) {
     this._core = new (require('../../../lib/Terminal').Terminal)(options);
-    this.searchHelper = new SearchHelper(this as any);
+    this.searchHelper = new TestSearchHelper(this as any);
   }
   get core(): any {
     return this._core;
@@ -26,6 +26,12 @@ class MockTerminal {
   }
 }
 
+class TestSearchHelper extends SearchHelper {
+  public findInLine(term: string, y: number, searchOptions?: ISearchOptions): ISearchResult {
+    return this._findInLine(term, y, searchOptions);
+  }
+}
+
 describe('search addon', function(): void {
   describe('apply', () => {
     it('should register findNext and findPrevious', () => {
@@ -39,11 +45,40 @@ describe('search addon', function(): void {
     const term = new MockTerminal({cols: 20, rows: 3});
     term.core.write('Hello World\r\ntest\n123....hello');
     term.pushWriteData();
-    const hello0 = (term.searchHelper as any)._findInLine('Hello', 0);
-    const hello1 = (term.searchHelper as any)._findInLine('Hello', 1);
-    const hello2 = (term.searchHelper as any)._findInLine('Hello', 2);
+    const hello0 = term.searchHelper.findInLine('Hello', 0);
+    const hello1 = term.searchHelper.findInLine('Hello', 1);
+    const hello2 = term.searchHelper.findInLine('Hello', 2);
     expect(hello0).eql({col: 0, row: 0, term: 'Hello'});
     expect(hello1).eql(undefined);
     expect(hello2).eql({col: 11, row: 2, term: 'Hello'});
   });
+  it('should respect search regex', function(): void {
+    search.apply(<any>MockTerminal);
+    const term = new MockTerminal({cols: 10, rows: 4});
+    term.core.write('abcdefghijklmnopqrstuvwxyz\r\n~/dev  ');
+    /*
+      abcdefghij
+      klmnopqrst
+      uvwxyz
+      ~/dev
+    */
+    term.pushWriteData();
+    const searchOptions = {
+      regex: true,
+      wholeWord: false,
+      caseSensitive: false
+    };
+    const hello0 = term.searchHelper.findInLine('dee*', 0, searchOptions);
+    term.searchHelper.findInLine('jkk*', 0, searchOptions);
+    term.searchHelper.findInLine('mnn*', 1, searchOptions);
+    const tilda0 = term.searchHelper.findInLine('^~', 3, searchOptions);
+    const tilda1 = term.searchHelper.findInLine('^[~]', 3, searchOptions);
+    const tilda2 = term.searchHelper.findInLine('^\\~', 3, searchOptions);
+    expect(hello0).eql({col: 3, row: 0, term: 'de'});
+    // TODO: uncomment this test when line wrap search is checked in expect(hello1).eql({col: 9, row: 0, term: 'jk'});
+    // TODO: uncomment this test when line wrap search is checked in expect(hello2).eql(undefined);
+    expect(tilda0).eql({col: 0, row: 3, term: '~'});
+    expect(tilda1).eql({col: 0, row: 3, term: '~'});
+    expect(tilda2).eql({col: 0, row: 3, term: '~'});
+  });
 });

src/addons/search/search.ts

@@ -5,42 +5,44 @@
 
 import { SearchHelper } from './SearchHelper';
 import { Terminal } from 'xterm';
-import { ISearchAddonTerminal } from './Interfaces';
+import { ISearchAddonTerminal, ISearchOptions } from './Interfaces';
 
 /**
  * Find the next instance of the term, then scroll to and select it. If it
  * doesn't exist, do nothing.
  * @param term Tne search term.
+ * @param searchOptions Search options
  * @return Whether a result was found.
  */
-export function findNext(terminal: Terminal, term: string): boolean {
+export function findNext(terminal: Terminal, term: string, searchOptions: ISearchOptions = {}): boolean {
   const addonTerminal = <ISearchAddonTerminal>terminal;
   if (!addonTerminal.__searchHelper) {
     addonTerminal.__searchHelper = new SearchHelper(addonTerminal);
   }
-  return addonTerminal.__searchHelper.findNext(term);
+  return addonTerminal.__searchHelper.findNext(term, searchOptions);
 }
 
 /**
  * Find the previous instance of the term, then scroll to and select it. If it
  * doesn't exist, do nothing.
  * @param term Tne search term.
+ * @param searchOptions Search options
  * @return Whether a result was found.
  */
-export function findPrevious(terminal: Terminal, term: string): boolean {
+export function findPrevious(terminal: Terminal, term: string, searchOptions: ISearchOptions): boolean {
   const addonTerminal = <ISearchAddonTerminal>terminal;
   if (!addonTerminal.__searchHelper) {
     addonTerminal.__searchHelper = new SearchHelper(addonTerminal);
   }
-  return addonTerminal.__searchHelper.findPrevious(term);
+  return addonTerminal.__searchHelper.findPrevious(term, searchOptions);
 }
 
 export function apply(terminalConstructor: typeof Terminal): void {
-  (<any>terminalConstructor.prototype).findNext = function(term: string): boolean {
-    return findNext(this, term);
+  (<any>terminalConstructor.prototype).findNext = function(term: string, searchOptions: ISearchOptions): boolean {
+    return findNext(this, term, searchOptions);
   };
 
-  (<any>terminalConstructor.prototype).findPrevious = function(term: string): boolean {
-    return findPrevious(this, term);
+  (<any>terminalConstructor.prototype).findPrevious = function(term: string, searchOptions: ISearchOptions): boolean {
+    return findPrevious(this, term, searchOptions);
   };
 }

src/addons/search/tsconfig.json

@@ -2,6 +2,10 @@
   "compilerOptions": {
     "module": "commonjs",
     "target": "es5",
+    "lib": [
+      "dom",
+      "es6",
+    ],
     "rootDir": ".",
     "outDir": "../../../lib/addons/search/",
     "sourceMap": true,

src/addons/terminado/tsconfig.json

@@ -2,6 +2,10 @@
   "compilerOptions": {
     "module": "commonjs",
     "target": "es5",
+    "lib": [
+      "dom",
+      "es6",
+    ],
     "rootDir": ".",
     "outDir": "../../../lib/addons/terminado/",
     "sourceMap": true,

src/addons/webLinks/tsconfig.json

@@ -2,6 +2,10 @@
   "compilerOptions": {
     "module": "commonjs",
     "target": "es5",
+    "lib": [
+      "dom",
+      "es6",
+    ],
     "rootDir": ".",
     "outDir": "../../../lib/addons/webLinks/",
     "sourceMap": true,

src/addons/winptyCompat/tsconfig.json

@@ -2,6 +2,10 @@
   "compilerOptions": {
     "module": "commonjs",
     "target": "es5",
+    "lib": [
+      "dom",
+      "es6",
+    ],
     "rootDir": ".",
     "outDir": "../../../lib/addons/winptyCompat/",
     "sourceMap": true,

src/addons/zmodem/tsconfig.json

@@ -2,6 +2,10 @@
   "compilerOptions": {
     "module": "commonjs",
     "target": "es5",
+    "lib": [
+      "dom",
+      "es6",
+    ],
     "rootDir": ".",
     "outDir": "../../../lib/addons/zmodem/",
     "sourceMap": true,

src/common/CircularList.ts

@@ -3,15 +3,15 @@
  * @license MIT
  */
 
-import { EventEmitter } from '../EventEmitter';
-import { ICircularList } from '../Types';
+import { EventEmitter } from './EventEmitter';
+import { ICircularList } from './Types';
 
 /**
  * Represents a circular list; a list with a maximum size that wraps around when push is called,
  * overriding values at the start of the list.
  */
 export class CircularList<T> extends EventEmitter implements ICircularList<T> {
-  protected _array: T[];
+  protected _array: (T | undefined)[];
   private _startIndex: number;
   private _length: number;
 
@@ -36,7 +36,7 @@ export class CircularList<T> extends EventEmitter implements ICircularList<T> {
 
     // Reconstruct array, starting at index 0. Only transfer values from the
     // indexes 0 to length.
-    const newArray = new Array<T>(newMaxLength);
+    const newArray = new Array<T | undefined>(newMaxLength);
     for (let i = 0; i < Math.min(newMaxLength, this.length); i++) {
       newArray[i] = this._array[this._getCyclicIndex(i)];
     }
@@ -66,7 +66,7 @@ export class CircularList<T> extends EventEmitter implements ICircularList<T> {
    * @param index The index of the value to get.
    * @return The value corresponding to the index.
    */
-  public get(index: number): T {
+  public get(index: number): T | undefined {
     return this._array[this._getCyclicIndex(index)];
   }
 
@@ -78,7 +78,7 @@ export class CircularList<T> extends EventEmitter implements ICircularList<T> {
    * @param index The index to set.
    * @param value The value to set.
    */
-  public set(index: number, value: T): void {
+  public set(index: number, value: T | undefined): void {
     this._array[this._getCyclicIndex(index)] = value;
   }
 
@@ -104,7 +104,7 @@ export class CircularList<T> extends EventEmitter implements ICircularList<T> {
    * Removes and returns the last value on the list.
    * @return The popped value.
    */
-  public pop(): T {
+  public pop(): T | undefined {
     return this._array[this._getCyclicIndex(this._length-- - 1)];
   }
 

src/common/EventEmitter.ts

@@ -5,7 +5,7 @@
 
 import { XtermListener } from './Types';
 import { IEventEmitter, IDisposable } from 'xterm';
-import { Disposable } from './common/Lifecycle';
+import { Disposable } from './Lifecycle';
 
 export class EventEmitter extends Disposable implements IEventEmitter, IDisposable {
   private _events: {[type: string]: XtermListener[]};
@@ -30,14 +30,15 @@ export class EventEmitter extends Disposable implements IEventEmitter, IDisposab
   public addDisposableListener(type: string, handler: XtermListener): IDisposable {
     // TODO: Rename addDisposableEventListener to more easily disambiguate from Dom listener
     this.on(type, handler);
+    let disposed = false;
     return {
       dispose: () => {
-        if (!handler) {
+        if (disposed) {
           // Already disposed
           return;
         }
         this.off(type, handler);
-        handler = null;
+        disposed = true;
       }
     };
   }

src/common/Types.ts

@@ -3,6 +3,10 @@
  * @license MIT
  */
 
+import { IEventEmitter } from 'xterm';
+
+export type XtermListener = (...args: any[]) => void;
+
 /**
  * A keyboard event interface which does not depend on the DOM, KeyboardEvent implicitly extends
  * this event.
@@ -16,3 +20,16 @@ export interface IKeyboardEvent {
   key: string;
   type: string;
 }
+
+export interface ICircularList<T> extends IEventEmitter {
+  length: number;
+  maxLength: number;
+
+  get(index: number): T | undefined;
+  set(index: number, value: T): void;
+  push(value: T): void;
+  pop(): T | undefined;
+  splice(start: number, deleteCount: number, ...items: T[]): void;
+  trimStart(count: number): void;
+  shiftElements(start: number, count: number, offset: number): void;
+}

src/handlers/AltClickHandler.ts

@@ -3,7 +3,8 @@
  * @license MIT
  */
 
-import { ITerminal, ICircularList, IBufferLine } from '../Types';
+import { ITerminal, IBufferLine } from '../Types';
+import { ICircularList } from '../common/Types';
 import { C0 } from '../common/data/EscapeSequences';
 
 const enum Direction {

src/renderer/Renderer.ts

@@ -10,7 +10,7 @@ import { ColorManager } from './ColorManager';
 import { IRenderLayer, IColorSet, IRenderer, IRenderDimensions, ICharacterJoinerRegistry } from './Types';
 import { ITerminal, CharacterJoinerHandler } from '../Types';
 import { LinkRenderLayer } from './LinkRenderLayer';
-import { EventEmitter } from '../EventEmitter';
+import { EventEmitter } from '../common/EventEmitter';
 import { RenderDebouncer } from '../ui/RenderDebouncer';
 import { ScreenDprMonitor } from '../ui/ScreenDprMonitor';
 import { ITheme } from 'xterm';

src/renderer/dom/DomRenderer.ts

@@ -6,10 +6,10 @@
 import { IRenderer, IRenderDimensions, IColorSet } from '../Types';
 import { ITerminal, CharacterJoinerHandler } from '../../Types';
 import { ITheme } from 'xterm';
-import { EventEmitter } from '../../EventEmitter';
+import { EventEmitter } from '../../common/EventEmitter';
 import { ColorManager } from '../ColorManager';
 import { RenderDebouncer } from '../../ui/RenderDebouncer';
-import { BOLD_CLASS, ITALIC_CLASS, CURSOR_CLASS, DomRendererRowFactory } from './DomRendererRowFactory';
+import { BOLD_CLASS, ITALIC_CLASS, CURSOR_CLASS, CURSOR_STYLE_BLOCK_CLASS, CURSOR_STYLE_BAR_CLASS, CURSOR_STYLE_UNDERLINE_CLASS, DomRendererRowFactory } from './DomRendererRowFactory';
 
 const TERMINAL_CLASS_PREFIX = 'xterm-dom-renderer-owner-';
 const ROW_CONTAINER_CLASS = 'xterm-rows';
@@ -160,13 +160,19 @@ export class DomRenderer extends EventEmitter implements IRenderer {
         `}`;
     // Cursor
     styles +=
-        `${this._terminalSelector} .${ROW_CONTAINER_CLASS}.${FOCUS_CLASS} .${CURSOR_CLASS} {` +
+        `${this._terminalSelector} .${ROW_CONTAINER_CLASS}:not(.${FOCUS_CLASS}) .${CURSOR_CLASS} {` +
+        ` outline: 1px solid ${this.colorManager.colors.cursor.css};` +
+        ` outline-offset: -1px;` +
+        `}` +
+        `${this._terminalSelector} .${ROW_CONTAINER_CLASS}.${FOCUS_CLASS} .${CURSOR_CLASS}.${CURSOR_STYLE_BLOCK_CLASS} {` +
         ` background-color: ${this.colorManager.colors.cursor.css};` +
         ` color: ${this.colorManager.colors.cursorAccent.css};` +
         `}` +
-        `${this._terminalSelector} .${ROW_CONTAINER_CLASS}:not(.${FOCUS_CLASS}) .${CURSOR_CLASS} {` +
-        ` outline: 1px solid #fff;` +
-        ` outline-offset: -1px;` +
+        `${this._terminalSelector} .${ROW_CONTAINER_CLASS}.${FOCUS_CLASS} .${CURSOR_CLASS}.${CURSOR_STYLE_BAR_CLASS} {` +
+        ` box-shadow: 1px 0 0 ${this.colorManager.colors.cursor.css} inset;` +
+        `}` +
+        `${this._terminalSelector} .${ROW_CONTAINER_CLASS}.${FOCUS_CLASS} .${CURSOR_CLASS}.${CURSOR_STYLE_UNDERLINE_CLASS} {` +
+        ` box-shadow: 0 -1px 0 ${this.colorManager.colors.cursor.css} inset;` +
         `}`;
     // Selection
     styles +=
@@ -319,7 +325,8 @@ export class DomRenderer extends EventEmitter implements IRenderer {
 
       const row = y + terminal.buffer.ydisp;
       const lineData = terminal.buffer.lines.get(row);
-      rowElement.appendChild(this._rowFactory.createRow(lineData, row === cursorAbsoluteY, cursorX, terminal.charMeasure.width, terminal.cols));
+      const cursorStyle = terminal.options.cursorStyle;
+      rowElement.appendChild(this._rowFactory.createRow(lineData, row === cursorAbsoluteY, cursorStyle, cursorX, terminal.charMeasure.width, terminal.cols));
     }
 
     this._terminal.emit('refresh', {start, end});

src/renderer/dom/DomRendererRowFactory.test.ts

@@ -24,7 +24,7 @@ describe('DomRendererRowFactory', () => {
 
   describe('createRow', () => {
     it('should create an element for every character in the row', () => {
-      const fragment = rowFactory.createRow(lineData, false, 0, 5, 20);
+      const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 20);
       assert.equal(getFragmentHtml(fragment),
         '<span> </span>' +
         '<span> </span>'
@@ -35,24 +35,26 @@ describe('DomRendererRowFactory', () => {
       lineData.set(0, [DEFAULT_ATTR, '語', 2, '語'.charCodeAt(0)]);
       // There should be no element for the following "empty" cell
       lineData.set(1, [DEFAULT_ATTR, '', 0, undefined]);
-      const fragment = rowFactory.createRow(lineData, false, 0, 5, 20);
+      const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 20);
       assert.equal(getFragmentHtml(fragment),
         '<span style="width: 10px;">語</span>'
       );
     });
 
-    it('should add class for cursor', () => {
-      const fragment = rowFactory.createRow(lineData, true, 0, 5, 20);
-      assert.equal(getFragmentHtml(fragment),
-        '<span class="xterm-cursor"> </span>' +
-        '<span> </span>'
-      );
+    it('should add class for cursor and cursor style', () => {
+      for (const style of ['block', 'bar', 'underline']) {
+        const fragment = rowFactory.createRow(lineData, true, style, 0, 5, 20);
+        assert.equal(getFragmentHtml(fragment),
+          `<span class="xterm-cursor xterm-cursor-${style}"> </span>` +
+          '<span> </span>'
+        );
+      }
     });
 
     it('should not render cells that go beyond the terminal\'s columns', () => {
       lineData.set(0, [DEFAULT_ATTR, 'a', 1, 'a'.charCodeAt(0)]);
       lineData.set(1, [DEFAULT_ATTR, 'b', 1, 'b'.charCodeAt(0)]);
-      const fragment = rowFactory.createRow(lineData, false, 0, 5, 1);
+      const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 1);
       assert.equal(getFragmentHtml(fragment),
         '<span>a</span>'
       );
@@ -61,7 +63,7 @@ describe('DomRendererRowFactory', () => {
     describe('attributes', () => {
       it('should add class for bold', () => {
         lineData.set(0, [DEFAULT_ATTR | (FLAGS.BOLD << 18), 'a', 1, 'a'.charCodeAt(0)]);
-        const fragment = rowFactory.createRow(lineData, false, 0, 5, 20);
+        const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 20);
         assert.equal(getFragmentHtml(fragment),
           '<span class="xterm-bold">a</span>' +
           '<span> </span>'
@@ -70,7 +72,7 @@ describe('DomRendererRowFactory', () => {
 
       it('should add class for italic', () => {
         lineData.set(0, [DEFAULT_ATTR | (FLAGS.ITALIC << 18), 'a', 1, 'a'.charCodeAt(0)]);
-        const fragment = rowFactory.createRow(lineData, false, 0, 5, 20);
+        const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 20);
         assert.equal(getFragmentHtml(fragment),
           '<span class="xterm-italic">a</span>' +
           '<span> </span>'
@@ -81,7 +83,7 @@ describe('DomRendererRowFactory', () => {
         const defaultAttrNoFgColor = (0 << 9) | (256 << 0);
         for (let i = 0; i < 256; i++) {
           lineData.set(0, [defaultAttrNoFgColor | (i << 9), 'a', 1, 'a'.charCodeAt(0)]);
-          const fragment = rowFactory.createRow(lineData, false, 0, 5, 20);
+          const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 20);
           assert.equal(getFragmentHtml(fragment),
             `<span class="xterm-fg-${i}">a</span>` +
             '<span> </span>'
@@ -93,7 +95,7 @@ describe('DomRendererRowFactory', () => {
         const defaultAttrNoBgColor = (257 << 9) | (0 << 0);
         for (let i = 0; i < 256; i++) {
           lineData.set(0, [defaultAttrNoBgColor | (i << 0), 'a', 1, 'a'.charCodeAt(0)]);
-          const fragment = rowFactory.createRow(lineData, false, 0, 5, 20);
+          const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 20);
           assert.equal(getFragmentHtml(fragment),
             `<span class="xterm-bg-${i}">a</span>` +
             '<span> </span>'
@@ -103,7 +105,7 @@ describe('DomRendererRowFactory', () => {
 
       it('should correctly invert colors', () => {
         lineData.set(0, [(FLAGS.INVERSE << 18) | (2 << 9) | (1 << 0), 'a', 1, 'a'.charCodeAt(0)]);
-        const fragment = rowFactory.createRow(lineData, false, 0, 5, 20);
+        const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 20);
         assert.equal(getFragmentHtml(fragment),
           '<span class="xterm-fg-1 xterm-bg-2">a</span>' +
           '<span> </span>'
@@ -112,7 +114,7 @@ describe('DomRendererRowFactory', () => {
 
       it('should correctly invert default fg color', () => {
         lineData.set(0, [(FLAGS.INVERSE << 18) | (257 << 9) | (1 << 0), 'a', 1, 'a'.charCodeAt(0)]);
-        const fragment = rowFactory.createRow(lineData, false, 0, 5, 20);
+        const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 20);
         assert.equal(getFragmentHtml(fragment),
           '<span class="xterm-fg-1 xterm-bg-15">a</span>' +
           '<span> </span>'
@@ -121,7 +123,7 @@ describe('DomRendererRowFactory', () => {
 
       it('should correctly invert default bg color', () => {
         lineData.set(0, [(FLAGS.INVERSE << 18) | (1 << 9) | (256 << 0), 'a', 1, 'a'.charCodeAt(0)]);
-        const fragment = rowFactory.createRow(lineData, false, 0, 5, 20);
+        const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 20);
         assert.equal(getFragmentHtml(fragment),
           '<span class="xterm-fg-0 xterm-bg-1">a</span>' +
           '<span> </span>'
@@ -131,7 +133,7 @@ describe('DomRendererRowFactory', () => {
       it('should turn bold fg text bright', () => {
         for (let i = 0; i < 8; i++) {
           lineData.set(0, [(FLAGS.BOLD << 18) | (i << 9) | (256 << 0), 'a', 1, 'a'.charCodeAt(0)]);
-          const fragment = rowFactory.createRow(lineData, false, 0, 5, 20);
+          const fragment = rowFactory.createRow(lineData, false, undefined, 0, 5, 20);
           assert.equal(getFragmentHtml(fragment),
             `<span class="xterm-bold xterm-fg-${i + 8}">a</span>` +
             '<span> </span>'

src/renderer/dom/DomRendererRowFactory.ts

@@ -10,6 +10,9 @@ import { IBufferLine } from '../../Types';
 export const BOLD_CLASS = 'xterm-bold';
 export const ITALIC_CLASS = 'xterm-italic';
 export const CURSOR_CLASS = 'xterm-cursor';
+export const CURSOR_STYLE_BLOCK_CLASS = 'xterm-cursor-block';
+export const CURSOR_STYLE_BAR_CLASS = 'xterm-cursor-bar';
+export const CURSOR_STYLE_UNDERLINE_CLASS = 'xterm-cursor-underline';
 
 export class DomRendererRowFactory {
   constructor(
@@ -17,7 +20,7 @@ export class DomRendererRowFactory {
   ) {
   }
 
-  public createRow(lineData: IBufferLine, isCursorRow: boolean, cursorX: number, cellWidth: number, cols: number): DocumentFragment {
+  public createRow(lineData: IBufferLine, isCursorRow: boolean, cursorStyle: string | undefined, cursorX: number, cellWidth: number, cols: number): DocumentFragment {
     const fragment = this._document.createDocumentFragment();
     let colCount = 0;
 
@@ -48,6 +51,18 @@ export class DomRendererRowFactory {
 
       if (isCursorRow && x === cursorX) {
         charElement.classList.add(CURSOR_CLASS);
+
+        switch (cursorStyle) {
+          case 'bar':
+            charElement.classList.add(CURSOR_STYLE_BAR_CLASS);
+            break;
+          case 'underline':
+            charElement.classList.add(CURSOR_STYLE_UNDERLINE_CLASS);
+            break;
+          default:
+            charElement.classList.add(CURSOR_STYLE_BLOCK_CLASS);
+            break;
+        }
       }
 
       // If inverse flag is on, the foreground should become the background.

src/ui/CharMeasure.ts

@@ -4,7 +4,7 @@
  */
 
 import { ICharMeasure, ITerminalOptions } from '../Types';
-import { EventEmitter } from '../EventEmitter';
+import { EventEmitter } from '../common/EventEmitter';
 
 /**
  * Utility class that measures the size of a character. Measurements are done in

src/utils/TestUtils.test.ts

@@ -4,8 +4,9 @@
  */
 
 import { IColorSet, IRenderer, IRenderDimensions, IColorManager } from '../renderer/Types';
-import { IInputHandlingTerminal, IViewport, ICompositionHelper, ITerminal, IBuffer, IBufferSet, IBrowser, ICharMeasure, ISelectionManager, ITerminalOptions, ICircularList, ILinkifier, IMouseHelper, ILinkMatcherOptions, XtermListener, CharacterJoinerHandler, IBufferLine, CharData } from '../Types';
-import { Buffer, NULL_CELL_CHAR, NULL_CELL_CODE, NULL_CELL_WIDTH } from '../Buffer';
+import { IInputHandlingTerminal, IViewport, ICompositionHelper, ITerminal, IBuffer, IBufferSet, IBrowser, ICharMeasure, ISelectionManager, ITerminalOptions, ILinkifier, IMouseHelper, ILinkMatcherOptions, CharacterJoinerHandler, IBufferLine, CharData } from '../Types';
+import { ICircularList, XtermListener } from '../common/Types';
+import { Buffer, NULL_CELL_CHAR, NULL_CELL_WIDTH, NULL_CELL_CODE } from '../Buffer';
 import * as Browser from '../shared/utils/Browser';
 import { ITheme, IDisposable, IMarker } from 'xterm';
 import { BufferLine } from '../BufferLine';