Merge pull request #762 from atom-minimap/decoration-management-class

Author: aminya

docs/Developers Documentation.md

@@ -68,22 +68,24 @@ While the interface is the same, some details such as the available decorations
 A plugin can and should set the plugin origin on the decorations it creates so that the Minimap can easily know which order to apply on the decorations. When not provided, the plugin origin will be inferred from the path of the function invoking the `decorateMarker` method. If the origin can't be inferred the order value will always be `0` for this decoration.
 
 ```js
-minimapView.decorateMarker(marker, {type: 'line', color: '#ff0000', plugin: 'my-plugin-name'})
+const decorationManager = minimapView.getDecorationManagement()
+
+decorationManager.decorateMarker(marker, {type: 'line', color: '#ff0000', plugin: 'my-plugin-name'})
 ```
 
 #### Scope And Styling
 
 The most important change is that decorations on the Minimap doesn't use a `class`, but rather a `scope`
 
 ```js
-minimapView.decorateMarker(marker, {type: 'line', scope: '.scope .to .the.marker.style'})
+decorationManager.decorateMarker(marker, {type: 'line', scope: '.scope .to .the.marker.style'})
 ```
 
 It's still possible to pass a class parameter to the decoration:
 
 
 ```js
-minimapView.decorateMarker(marker, {type: 'line', class: 'the marker style'})
+decorationManager.decorateMarker(marker, {type: 'line', class: 'the marker style'})
 ```
 
 In that case, when rendering the decoration a scope will be build that will look like `.minimap .editor .the.marker.style`.
@@ -105,7 +107,9 @@ Also note that only the `background` property will be retrieved to style a decor
 A last option is to pass a css color directly in a `color` option, such as:
 
 ```js
-minimapView.decorateMarker(marker, {type: 'line', color: '#ff0000'})
+const decorationManager = minimapView.getDecorationManagement()
+
+decorationManager.decorateMarker(marker, {type: 'line', color: '#ff0000'})
 ```
 
 In that case neither the scope nor the class will be used.

lib/decoration-management.js

@@ -16,14 +16,18 @@ export default class DecorationManagement {
   /**
    * Initializes the decorations related properties.
    */
-  initializeDecorations () {
+  initializeDecorations (minimap) {
+    this.minimap = minimap
+
     if (this.emitter == null) {
       /**
        * The minimap emitter, lazily created if not created yet.
        * @type {Emitter}
        * @access private
        */
       this.emitter = new Emitter()
+    } else {
+      this.emitter = this.minimap.emitter
     }
 
     /**
@@ -66,6 +70,9 @@ export default class DecorationManagement {
      * @access private
      */
     this.decorationDestroyedSubscriptions = new Map()
+
+    // is set to true when a minimapElement is destroyed
+    this.destroyed = false
   }
 
   /**
@@ -318,7 +325,7 @@ export default class DecorationManagement {
    * @emits  {did-change} when the decoration is created successfully
    */
   decorateMarker (marker, decorationParams) {
-    if (this.destroyed || marker == null) { return }
+    if (this.destroyed || this.minimap.destroyed || marker == null) { return }
 
     const { id } = marker
 
@@ -431,7 +438,7 @@ export default class DecorationManagement {
    * @access private
    */
   emitDecorationChanges (type, decoration) {
-    if (this.editorDestroyed()) { return }
+    if (this.destroyed || this.minimap.editorDestroyed()) { return }
 
     this.invalidateDecorationForScreenRowsCache()
 
@@ -453,8 +460,8 @@ export default class DecorationManagement {
   emitRangeChanges (type, range, screenDelta) {
     const startScreenRow = range.start.row
     const endScreenRow = range.end.row
-    const lastRenderedScreenRow = this.getLastVisibleScreenRow()
-    const firstRenderedScreenRow = this.getFirstVisibleScreenRow()
+    const lastRenderedScreenRow = this.minimap.getLastVisibleScreenRow()
+    const firstRenderedScreenRow = this.minimap.getFirstVisibleScreenRow()
 
     if (screenDelta == null) {
       screenDelta = (lastRenderedScreenRow - firstRenderedScreenRow) -
@@ -531,7 +538,7 @@ export default class DecorationManagement {
     for (let i = 0, len = decorations.length; i < len; i++) {
       const decoration = decorations[i]
 
-      if (!this.adapter.editorDestroyed()) {
+      if (!this.destroyed && !this.minimap.editorDestroyed()) {
         this.emitDecorationChanges(decoration.getProperties().type, decoration)
       }
       this.emitter.emit('did-remove-decoration', {

lib/main.js

@@ -102,7 +102,7 @@ export function activate () {
 /**
    * Returns a {MinimapElement} for the passed-in model if it's a {Minimap}.
    *
-   * @param {*} model the model for which returning a view
+   * @param {Minimap} model the model for which returning a view
    * @return {MinimapElement}
    */
 export function minimapViewProvider (model) {

lib/minimap-element.js

@@ -3,6 +3,7 @@
 import { CompositeDisposable, Disposable } from 'atom'
 import { EventsDelegation, AncestorsMethods } from 'atom-utils-plus'
 import elementResizeDetectorImport from 'element-resize-detector'
+import DecorationManagement from './decoration-management'
 
 import * as Main from './main'
 import CanvasDrawer from './mixins/canvas-drawer'
@@ -177,6 +178,8 @@ class MinimapElement {
      */
     this.quickSettingsElement = undefined
 
+    this.DecorationManagement = new DecorationManagement()
+
     // States
 
     /**
@@ -452,7 +455,10 @@ class MinimapElement {
    */
   destroy () {
     this.subscriptions.dispose()
+    this.DecorationManagement.removeAllDecorations()
+    this.DecorationManagement.destroyed = true
     this.detach()
+    this.minimap.minimapElement = null
     this.minimap = null
   }
 
@@ -645,6 +651,14 @@ class MinimapElement {
     delete this.openQuickSettings
   }
 
+  /**
+   *  get the DecorationManagement API for minimapElement
+   * @return {DecorationManagement}
+   */
+  getDecorationManagement () {
+    return this.DecorationManagement
+  }
+
   //    ##     ##  #######  ########  ######## ##
   //    ###   ### ##     ## ##     ## ##       ##
   //    #### #### ##     ## ##     ## ##       ##
@@ -669,6 +683,11 @@ class MinimapElement {
   setModel (minimap) {
     this.minimap = minimap
 
+    // set minimapElement for Minimap
+    this.minimap.minimapElement = this
+
+    this.DecorationManagement.initializeDecorations(this.minimap)
+
     this.subscriptions.add(
 
       this.minimap.onDidChangeScrollTop(() => {
@@ -697,7 +716,7 @@ class MinimapElement {
         this.requestUpdate()
       }),
 
-      this.minimap.onDidChangeDecorationRange((change) => {
+      this.DecorationManagement.onDidChangeDecorationRange((change) => {
         const { type } = change
         if (type === 'line' ||
             type === 'highlight-under' ||

lib/minimap.js

@@ -1,8 +1,5 @@
 'use strict'
 
-import include from './decorators/include'
-import DecorationManagement from './decoration-management'
-
 import { Emitter, CompositeDisposable } from 'atom'
 import StableAdapter from './adapters/stable-adapter'
 
@@ -17,11 +14,6 @@ let nextModelId = 1
  * destroyed whenever their `TextEditor` is destroyed.
  */
 export default class Minimap {
-  static initClass () {
-    include(this, DecorationManagement)
-    return this
-  }
-
   /**
    * Creates a new Minimap instance for the given `TextEditor`.
    *
@@ -39,6 +31,17 @@ export default class Minimap {
       throw new Error('Cannot create a minimap without an editor')
     }
 
+    /**
+     * The Minimap's minimapElement.
+     *
+     * @type {MinimapElement}
+     * @access private
+     */
+    this.minimapElement = undefined
+
+    // local cache of this.minimapElement.DecorationManagement
+    this.DecorationManagement = undefined
+
     /**
      * The Minimap's text editor.
      *
@@ -210,8 +213,6 @@ export default class Minimap {
      */
     this.flushChangesTimer = null
 
-    this.initializeDecorations()
-
     if (atom.views.getView(this.textEditor).getScrollTop != null) {
       this.adapter = new StableAdapter(this.textEditor)
     } else {
@@ -287,7 +288,6 @@ export default class Minimap {
     clearTimeout(this.flushChangesTimer)
     this.flushChangesTimer = null
     this.pendingChangeEvents = []
-    this.removeAllDecorations()
     this.subscriptions.dispose()
     this.subscriptions = null
     this.textEditor = null
@@ -525,6 +525,13 @@ export default class Minimap {
     }
   }
 
+  /**
+   * @return {MinimapElement} returns the current minimapElement
+   */
+  getMinimapElement () {
+    return this.minimapElement
+  }
+
   /**
    * Returns the `TextEditor` that this minimap represents.
    *
@@ -1056,6 +1063,29 @@ export default class Minimap {
   clearCache () { this.adapter.clearCache() }
 
   editorDestroyed () { this.adapter.editorDestroyed() }
-}
 
-Minimap.initClass()
+  /**
+   *  get the DecorationManagement API for the current minimapElement
+   * @return {DecorationManagement}
+   */
+  getDecorationManagement () {
+    if (this.DecorationManagement === undefined) {
+      this.DecorationManagement = this.minimapElement.DecorationManagement
+    }
+    return this.DecorationManagement
+  }
+
+  // Decoration API duplicated for backward compatibility in the service
+  getDecorations () { return this.getDecorationManagement().getDecorations() }
+  onDidAddDecoration (...args) { return this.getDecorationManagement().onDidAddDecoration(...args) }
+  onDidRemoveDecoration (...args) { return this.getDecorationManagement().onDidRemoveDecoration(...args) }
+  onDidChangeDecorationRange (...args) { return this.getDecorationManagement().onDidChangeDecorationRange(...args) }
+  onDidUpdateDecoration (...args) { return this.getDecorationManagement().onDidUpdateDecoration(...args) }
+  decorationForId (...args) { return this.getDecorationManagement().decorationForId(...args) }
+  decorationsForScreenRowRange (...args) { return this.getDecorationManagement().decorationsForScreenRowRange(...args) }
+  decorationsByTypeThenRows () { return this.getDecorationManagement().decorationsByTypeThenRows() }
+  decorateMarker (...args) { return this.getDecorationManagement().decorateMarker(...args) }
+  removeDecoration (...args) { return this.getDecorationManagement().removeDecoration(...args) }
+  removeAllDecorationsForMarker (...args) { return this.getDecorationManagement().removeAllDecorationsForMarker(...args) }
+  removeAllDecorations () { return this.getDecorationManagement().removeAllDecorations() }
+}

lib/mixins/canvas-drawer.js

@@ -140,7 +140,7 @@ export default class CanvasDrawer extends Mixin {
       this.drawLines(firstRow, lastRow)
     }
 
-    const decorations = this.minimap.decorationsByTypeThenRows(firstRow, lastRow)
+    const decorations = this.DecorationManagement.decorationsByTypeThenRows(firstRow, lastRow)
 
     const renderData = {
       context: this.backLayer.context,