diff --git a/spec/display-buffer-spec.coffee b/spec/display-buffer-spec.coffee index e3451e575..9890504d3 100644 --- a/spec/display-buffer-spec.coffee +++ b/spec/display-buffer-spec.coffee @@ -1011,7 +1011,7 @@ describe "DisplayBuffer", -> buffer.getMarker(marker2.id).destroy() expect(destroyedHandler).toHaveBeenCalled() - describe "DisplayBufferMarker::copy(attributes)", -> + describe "Marker::copy(attributes)", -> it "creates a copy of the marker with the given attributes merged in", -> initialMarkerCount = displayBuffer.getMarkerCount() marker1 = displayBuffer.markScreenRange([[5, 4], [5, 10]], a: 1, b: 2) @@ -1023,7 +1023,7 @@ describe "DisplayBuffer", -> expect(marker1.getProperties()).toEqual a: 1, b: 2 expect(marker2.getProperties()).toEqual a: 1, b: 3 - describe "DisplayBufferMarker::getPixelRange()", -> + describe "Marker::getPixelRange()", -> it "returns the start and end positions of the marker based on the line height and character widths assigned to the DisplayBuffer", -> marker = displayBuffer.markScreenRange([[5, 10], [6, 4]]) diff --git a/src/display-buffer-marker.coffee b/src/display-buffer-marker.coffee index 1611c1b52..de28e3f10 100644 --- a/src/display-buffer-marker.coffee +++ b/src/display-buffer-marker.coffee @@ -44,7 +44,7 @@ Grim = require 'grim' # # See {Editor::markBufferRange} for usage. module.exports = -class DisplayBufferMarker +class Marker EmitterMixin.includeInto(this) Subscriber.includeInto(this) @@ -121,9 +121,9 @@ class DisplayBufferMarker on: (eventName) -> switch eventName when 'changed' - Grim.deprecate("Use DisplayBufferMarker::onDidChange instead") + Grim.deprecate("Use Marker::onDidChange instead") when 'destroyed' - Grim.deprecate("Use DisplayBufferMarker::onDidDestroy instead") + Grim.deprecate("Use Marker::onDidDestroy instead") EmitterMixin::on.apply(this, arguments) @@ -233,28 +233,28 @@ class DisplayBufferMarker @setBufferRange(@displayBuffer.bufferRangeForScreenRange(screenRange), options) # Essential: Retrieves the buffer position of the marker's start. This will always be - # less than or equal to the result of {DisplayBufferMarker::getEndBufferPosition}. + # less than or equal to the result of {Marker::getEndBufferPosition}. # # Returns a {Point}. getStartBufferPosition: -> @bufferMarker.getStartPosition() # Essential: Retrieves the screen position of the marker's start. This will always be - # less than or equal to the result of {DisplayBufferMarker::getEndScreenPosition}. + # less than or equal to the result of {Marker::getEndScreenPosition}. # # Returns a {Point}. getStartScreenPosition: -> @displayBuffer.screenPositionForBufferPosition(@getStartBufferPosition(), wrapAtSoftNewlines: true) # Essential: Retrieves the buffer position of the marker's end. This will always be - # greater than or equal to the result of {DisplayBufferMarker::getStartBufferPosition}. + # greater than or equal to the result of {Marker::getStartBufferPosition}. # # Returns a {Point}. getEndBufferPosition: -> @bufferMarker.getEndPosition() # Essential: Retrieves the screen position of the marker's end. This will always be - # greater than or equal to the result of {DisplayBufferMarker::getStartScreenPosition}. + # greater than or equal to the result of {Marker::getStartScreenPosition}. # # Returns a {Point}. getEndScreenPosition: -> @@ -340,7 +340,7 @@ class DisplayBufferMarker # Returns a {String} representation of the marker inspect: -> - "DisplayBufferMarker(id: #{@id}, bufferRange: #{@getBufferRange()})" + "Marker(id: #{@id}, bufferRange: #{@getBufferRange()})" destroyed: -> delete @displayBuffer.markers[@id] diff --git a/src/display-buffer.coffee b/src/display-buffer.coffee index d966c9d8c..bfb44fa57 100644 --- a/src/display-buffer.coffee +++ b/src/display-buffer.coffee @@ -10,7 +10,7 @@ RowMap = require './row-map' Fold = require './fold' Token = require './token' Decoration = require './decoration' -DisplayBufferMarker = require './display-buffer-marker' +Marker = require './display-buffer-marker' Grim = require 'grim' class BufferToScreenConversionError extends Error @@ -865,21 +865,21 @@ class DisplayBuffer extends Model @emitter.emit 'did-remove-decoration', decoration delete @decorationsByMarkerId[marker.id] if decorations.length is 0 - # Retrieves a {DisplayBufferMarker} based on its id. + # Retrieves a {Marker} based on its id. # # id - A {Number} representing a marker id # - # Returns the {DisplayBufferMarker} (if it exists). + # Returns the {Marker} (if it exists). getMarker: (id) -> unless marker = @markers[id] if bufferMarker = @buffer.getMarker(id) - marker = new DisplayBufferMarker({bufferMarker, displayBuffer: this}) + marker = new Marker({bufferMarker, displayBuffer: this}) @markers[id] = marker marker # Retrieves the active markers in the buffer. # - # Returns an {Array} of existing {DisplayBufferMarker}s. + # Returns an {Array} of existing {Marker}s. getMarkers: -> @buffer.getMarkers().map ({id}) => @getMarker(id) @@ -934,7 +934,7 @@ class DisplayBuffer extends Model # # Refer to {DisplayBuffer::findMarkers} for details. # - # Returns a {DisplayBufferMarker} or null + # Returns a {Marker} or null findMarker: (params) -> @findMarkers(params)[0] @@ -955,7 +955,7 @@ class DisplayBuffer extends Model # :containedInBufferRange - A {Range} or range-compatible {Array}. Only # returns markers contained within this range. # - # Returns an {Array} of {DisplayBufferMarker}s + # Returns an {Array} of {Marker}s findMarkers: (params) -> params = @translateToBufferMarkerParams(params) @buffer.findMarkers(params).map (stringMarker) => @getMarker(stringMarker.id) diff --git a/src/editor.coffee b/src/editor.coffee index 4a3ace087..fa38b5444 100644 --- a/src/editor.coffee +++ b/src/editor.coffee @@ -1754,7 +1754,7 @@ class Editor extends Model # * `position` A {Point} or {Array} of `[row, column]`. # * `options` (optional) See {TextBuffer::markRange}. # - # Returns a {DisplayBufferMarker}. + # Returns a {Marker}. markBufferPosition: (args...) -> @displayBuffer.markBufferPosition(args...) @@ -1763,11 +1763,11 @@ class Editor extends Model # * `position` A {Point} or {Array} of `[row, column]`. # * `options` (optional) See {TextBuffer::markRange}. # - # Returns a {DisplayBufferMarker}. + # Returns a {Marker}. markScreenPosition: (args...) -> @displayBuffer.markScreenPosition(args...) - # Essential: Find all {DisplayBufferMarker}s that match the given properties. + # Essential: Find all {Marker}s that match the given properties. # # This method finds markers based on the given properties. Markers can be # associated with custom properties that will be compared with basic equality. @@ -1789,11 +1789,11 @@ class Editor extends Model findMarkers: (properties) -> @displayBuffer.findMarkers(properties) - # Extended: Get the {DisplayBufferMarker} for the given marker id. + # Extended: Get the {Marker} for the given marker id. getMarker: (id) -> @displayBuffer.getMarker(id) - # Extended: Get all {DisplayBufferMarker}s. + # Extended: Get all {Marker}s. getMarkers: -> @displayBuffer.getMarkers() @@ -2054,7 +2054,7 @@ class Editor extends Model getCursorsOrderedByBufferPosition: -> @getCursors().sort (a, b) -> a.compare(b) - # Add a cursor based on the given {DisplayBufferMarker}. + # Add a cursor based on the given {Marker}. addCursor: (marker) -> cursor = new Cursor(editor: this, marker: marker) @cursors.push(cursor) @@ -2397,7 +2397,7 @@ class Editor extends Model # Extended: Select the range of the given marker if it is valid. # - # * `marker` A {DisplayBufferMarker} + # * `marker` A {Marker} # # Returns the selected {Range} or `undefined` if the marker is invalid. selectMarker: (marker) -> @@ -2513,9 +2513,9 @@ class Editor extends Model _.reduce(@getSelections(), reducer, []) - # Add a {Selection} based on the given {DisplayBufferMarker}. + # Add a {Selection} based on the given {Marker}. # - # * `marker` The {DisplayBufferMarker} to highlight + # * `marker` The {Marker} to highlight # * `options` (optional) An {Object} that pertains to the {Selection} constructor. # # Returns the new {Selection}.