Add deprecation warning for global CodeMirror the first time it's called from a given location

Author: Narciso Jaramillo

src/brackets.js

@@ -99,8 +99,21 @@ define(function (require, exports, module) {
         ColorUtils              = require("utils/ColorUtils"),
         CodeInspection          = require("language/CodeInspection"),
         NativeApp               = require("utils/NativeApp"),
+        DeprecationWarning      = require("utils/DeprecationWarning"),
         _                       = require("thirdparty/lodash");
-        
+    
+    // DEPRECATED: In future we want to remove the global CodeMirror, but for now we
+    // expose our required CodeMirror globally so as to avoid breaking extensions in the
+    // interim.
+    var CodeMirror = require("thirdparty/CodeMirror2/lib/codemirror");
+
+    Object.defineProperty(window, "CodeMirror", {
+        get: function () {
+            DeprecationWarning.deprecationWarning('Use brackets.getModule("thirdparty/CodeMirror2/lib/codemirror") instead of global CodeMirror.', true);
+            return CodeMirror;
+        }
+    });
+    
     // Load modules that self-register and just need to get included in the main project
     require("command/DefaultMenus");
     require("document/ChangedDocumentTracker");

src/utils/DeprecationWarning.js

@@ -58,16 +58,31 @@ define(function (require, exports, module) {
      * Show deprecation message with the call stack if it 
      * has never been displayed before.
      * @param {!string} message The deprecation message to be displayed.
+     * @param {boolean=} oncePerCaller If true, displays the message once for each unique call location.
+     *     If false (the default), only displays the message once no matter where it's called from.
      */
-    function deprecationWarning(message) {
+    function deprecationWarning(message, oncePerCall) {
+        // The true caller location is the fourth line in the stack trace:
+        // * 0 is the word "Error"
+        // * 1 is this function
+        // * 2 is the caller of this function (the one throwing the deprecation warning)
+        // * 3 is the actual caller of the deprecated function.
+        var stack = new Error().stack,
+            callerLocation = stack.split("\n")[3];
+        
         // If we have displayed this message before, then don't 
         // show it again.
-        if (!message || displayedWarnings[message]) {
+        if (!message ||
+                (!oncePerCall && displayedWarnings[message]) ||
+                (oncePerCall && displayedWarnings[message] && displayedWarnings[message][callerLocation])) {
             return;
         }
 
-        console.warn(message + "\n" + _trimStack(new Error().stack));
-        displayedWarnings[message] = true;
+        console.warn(message + "\n" + _trimStack(stack));
+        if (!displayedWarnings[message]) {
+            displayedWarnings[message] = {};
+        }
+        displayedWarnings[message][callerLocation] = true;
     }
 
     // Define public API