Conditionally include deprecations in Marker

This commit is contained in:
Kevin Sawicki
2015-03-25 12:59:27 -07:00
parent 00b31c5c6e
commit d799254cbb

View File

@@ -1,7 +1,5 @@
{Range} = require 'text-buffer'
_ = require 'underscore-plus'
{Subscriber} = require 'emissary'
EmitterMixin = require('emissary').Emitter
{Emitter} = require 'event-kit'
Grim = require 'grim'
@@ -45,9 +43,6 @@ Grim = require 'grim'
# See {TextEditor::markBufferRange} for usage.
module.exports =
class Marker
EmitterMixin.includeInto(this)
Subscriber.includeInto(this)
bufferMarkerSubscription: null
oldHeadBufferPosition: null
oldHeadScreenPosition: null
@@ -118,17 +113,6 @@ class Marker
onDidDestroy: (callback) ->
@emitter.on 'did-destroy', callback
on: (eventName) ->
switch eventName
when 'changed'
Grim.deprecate("Use Marker::onDidChange instead")
when 'destroyed'
Grim.deprecate("Use Marker::onDidDestroy instead")
else
Grim.deprecate("Marker::on is deprecated. Use documented event subscription methods instead.")
EmitterMixin::on.apply(this, arguments)
###
Section: Marker Details
###
@@ -161,9 +145,6 @@ class Marker
# the marker.
getProperties: ->
@bufferMarker.getProperties()
getAttributes: ->
Grim.deprecate 'Use Marker::getProperties instead'
@getProperties()
# Essential: Merges an {Object} containing new properties into the marker's
# existing properties.
@@ -171,16 +152,10 @@ class Marker
# * `properties` {Object}
setProperties: (properties) ->
@bufferMarker.setProperties(properties)
setAttributes: (properties) ->
Grim.deprecate 'Use Marker::getProperties instead'
@setProperties(properties)
matchesProperties: (attributes) ->
attributes = @displayBuffer.translateToBufferMarkerParams(attributes)
@bufferMarker.matchesParams(attributes)
matchesAttributes: (attributes) ->
Grim.deprecate 'Use Marker::matchesProperties instead'
@matchesProperties(attributes)
###
Section: Comparing to other markers
@@ -344,7 +319,7 @@ class Marker
destroyed: ->
delete @displayBuffer.markers[@id]
@emit 'destroyed'
@emit 'destroyed' if Grim.includeDeprecations
@emitter.emit 'did-destroy'
@emitter.dispose()
@@ -375,7 +350,7 @@ class Marker
if @deferredChangeEvents?
@deferredChangeEvents.push(changeEvent)
else
@emit 'changed', changeEvent
@emit 'changed', changeEvent if Grim.includeDeprecations
@emitter.emit 'did-change', changeEvent
@oldHeadBufferPosition = newHeadBufferPosition
@@ -392,9 +367,38 @@ class Marker
@deferredChangeEvents = null
for event in deferredChangeEvents
@emit 'changed', event
@emit 'changed', event if Grim.includeDeprecations
@emitter.emit 'did-change', event
return
getPixelRange: ->
@displayBuffer.pixelRangeForScreenRange(@getScreenRange(), false)
if Grim.includeDeprecations
{Subscriber} = require 'emissary'
EmitterMixin = require('emissary').Emitter
EmitterMixin.includeInto(Marker)
Subscriber.includeInto(Marker)
Marker::on = (eventName) ->
switch eventName
when 'changed'
Grim.deprecate("Use Marker::onDidChange instead")
when 'destroyed'
Grim.deprecate("Use Marker::onDidDestroy instead")
else
Grim.deprecate("Marker::on is deprecated. Use documented event subscription methods instead.")
EmitterMixin::on.apply(this, arguments)
Marker::getAttributes = ->
Grim.deprecate 'Use Marker::getProperties instead'
@getProperties()
Marker::setAttributes = (properties) ->
Grim.deprecate 'Use Marker::setProperties instead'
@setProperties(properties)
Marker::matchesAttributes = (attributes) ->
Grim.deprecate 'Use Marker::matchesProperties instead'
@matchesProperties(attributes)