Merge pull request #5797 from adobe/glenn/file-system

New FileSystem API

Author: peterflynn

src/LiveDevelopment/LiveDevelopment.js

@@ -77,15 +77,14 @@ define(function LiveDevelopment(require, exports, module) {
     var STATUS_SYNC_ERROR     = exports.STATUS_SYNC_ERROR     =  5;
 
     var Async                = require("utils/Async"),
-        FileIndexManager     = require("project/FileIndexManager"),
         Dialogs              = require("widgets/Dialogs"),
         DefaultDialogs       = require("widgets/DefaultDialogs"),
         DocumentManager      = require("document/DocumentManager"),
         EditorManager        = require("editor/EditorManager"),
         FileServer           = require("LiveDevelopment/Servers/FileServer").FileServer,
+        FileSystemError      = require("filesystem/FileSystemError"),
         FileUtils            = require("file/FileUtils"),
         LiveDevServerManager = require("LiveDevelopment/LiveDevServerManager"),
-        NativeFileError      = require("file/NativeFileError"),
         NativeApp            = require("utils/NativeApp"),
         PreferencesDialogs   = require("preferences/PreferencesDialogs"),
         ProjectManager       = require("project/ProjectManager"),
@@ -674,7 +673,7 @@ define(function LiveDevelopment(require, exports, module) {
         var baseUrl = ProjectManager.getBaseUrl(),
             hasOwnServerForLiveDevelopment = (baseUrl && baseUrl.length);
 
-        FileIndexManager.getFileInfoList("all").done(function (allFiles) {
+        ProjectManager.getAllFiles().done(function (allFiles) {
             var projectRoot = ProjectManager.getProjectRoot().fullPath,
                 containingFolder,
                 indexFileFound = false,
@@ -1090,7 +1089,7 @@ define(function LiveDevelopment(require, exports, module) {
                         var message;
 
                         _setStatus(STATUS_ERROR);
-                        if (err === NativeFileError.NOT_FOUND_ERR) {
+                        if (err === FileSystemError.NOT_FOUND) {
                             message = Strings.ERROR_CANT_FIND_CHROME;
                         } else {
                             message = StringUtils.format(Strings.ERROR_LAUNCHING_BROWSER, err);

src/brackets.js

@@ -76,7 +76,7 @@ define(function (require, exports, module) {
         CommandManager          = require("command/CommandManager"),
         CodeHintManager         = require("editor/CodeHintManager"),
         PerfUtils               = require("utils/PerfUtils"),
-        FileIndexManager        = require("project/FileIndexManager"),
+        FileSystem              = require("filesystem/FileSystem"),
         QuickOpen               = require("search/QuickOpen"),
         Menus                   = require("command/Menus"),
         FileUtils               = require("file/FileUtils"),
@@ -89,7 +89,6 @@ define(function (require, exports, module) {
         Async                   = require("utils/Async"),
         UpdateNotification      = require("utils/UpdateNotification"),
         UrlParams               = require("utils/UrlParams").UrlParams,
-        NativeFileSystem        = require("file/NativeFileSystem").NativeFileSystem,
         PreferencesManager      = require("preferences/PreferencesManager"),
         Resizer                 = require("utils/Resizer"),
         LiveDevelopmentMain     = require("LiveDevelopment/main"),
@@ -114,8 +113,17 @@ define(function (require, exports, module) {
     require("extensibility/InstallExtensionDialog");
     require("extensibility/ExtensionManagerDialog");
 
+    // Compatibility shims for filesystem API migration
+    require("project/FileIndexManager");
+    require("file/NativeFileSystem");
+    require("file/NativeFileError");
+    
     PerfUtils.addMeasurement("brackets module dependencies resolved");
+    
 
+    // Initialize the file system
+    FileSystem.init(require("filesystem/impls/appshell/AppshellFileSystem"));
+    
     // Local variables
     var params = new UrlParams();
 
@@ -141,7 +149,7 @@ define(function (require, exports, module) {
             JSUtils                 : JSUtils,
             CommandManager          : CommandManager,
             FileSyncManager         : FileSyncManager,
-            FileIndexManager        : FileIndexManager,
+            FileSystem              : FileSystem,
             Menus                   : Menus,
             KeyBindingManager       : KeyBindingManager,
             CodeHintManager         : CodeHintManager,
@@ -162,6 +170,7 @@ define(function (require, exports, module) {
             RemoteAgent             : require("LiveDevelopment/Agents/RemoteAgent"),
             HTMLInstrumentation     : require("language/HTMLInstrumentation"),
             MultiRangeInlineEditor  : require("editor/MultiRangeInlineEditor").MultiRangeInlineEditor,
+            LanguageManager         : LanguageManager,
             doneLoading             : false
         };
 
@@ -172,7 +181,7 @@ define(function (require, exports, module) {
 
     function _onReady() {
         PerfUtils.addMeasurement("window.document Ready");
-        
+
         EditorManager.setEditorHolder($("#editor-holder"));
 
         // Let the user know Brackets doesn't run in a web browser yet
@@ -223,12 +232,14 @@ define(function (require, exports, module) {
                     if (!params.get("skipSampleProjectLoad") && !prefs.getValue("afterFirstLaunch")) {
                         prefs.setValue("afterFirstLaunch", "true");
                         if (ProjectManager.isWelcomeProjectPath(initialProjectPath)) {
-                            var dirEntry = new NativeFileSystem.DirectoryEntry(initialProjectPath);
-                            
-                            dirEntry.getFile("index.html", {}, function (fileEntry) {
-                                var promise = CommandManager.execute(Commands.FILE_ADD_TO_WORKING_SET, { fullPath: fileEntry.fullPath });
-                                promise.then(deferred.resolve, deferred.reject);
-                            }, deferred.reject);
+                            FileSystem.resolve(initialProjectPath + "index.html", function (err, file) {
+                                if (!err) {
+                                    var promise = CommandManager.execute(Commands.FILE_ADD_TO_WORKING_SET, { fullPath: file.fullPath });
+                                    promise.then(deferred.resolve, deferred.reject);
+                                } else {
+                                    deferred.reject();
+                                }
+                            });
                         } else {
                             deferred.resolve();
                         }
@@ -333,8 +344,9 @@ define(function (require, exports, module) {
 
         // TODO: (issue 269) to support IE, need to listen to document instead (and even then it may not work when focus is in an input field?)
         $(window).focus(function () {
+            // This call to syncOpenDocuments() *should* be a no-op now that we have
+            // file watchers, but is still here as a safety net.
             FileSyncManager.syncOpenDocuments();
-            FileIndexManager.markDirty();
         });
 
         // Prevent unhandled middle button clicks from triggering native behavior

src/document/Document.js

@@ -28,9 +28,9 @@
 define(function (require, exports, module) {
     "use strict";
 
-    var NativeFileSystem    = require("file/NativeFileSystem").NativeFileSystem,
-        EditorManager       = require("editor/EditorManager"),
+    var EditorManager       = require("editor/EditorManager"),
         FileUtils           = require("file/FileUtils"),
+        InMemoryFile        = require("document/InMemoryFile"),
         PerfUtils           = require("utils/PerfUtils"),
         LanguageManager     = require("language/LanguageManager");
 
@@ -69,7 +69,7 @@ define(function (require, exports, module) {
      * deleted -- When the file for this document has been deleted. All views onto the document should
      *      be closed. The document will no longer be editable or dispatch "change" events.
      *
-     * @param {!FileEntry} file  Need not lie within the project.
+     * @param {!File} file  Need not lie within the project.
      * @param {!Date} initialTimestamp  File's timestamp when we read it off disk.
      * @param {!string} rawText  Text content of the file.
      */
@@ -90,9 +90,9 @@ define(function (require, exports, module) {
     Document.prototype._refCount = 0;
 
     /**
-     * The FileEntry for this document. Need not lie within the project.
-     * If Document is untitled, this is an InaccessibleFileEntry object.
-     * @type {!FileEntry}
+     * The File for this document. Need not lie within the project.
+     * If Document is untitled, this is an InMemoryFile object.
+     * @type {!File}
      */
     Document.prototype.file = null;
 
@@ -240,11 +240,16 @@ define(function (require, exports, module) {
             if (useOriginalLineEndings) {
                 return this._text;
             } else {
-                return this._text.replace(/\r\n/g, "\n");
+                return Document.normalizeText(this._text);
             }
         }
     };
 
+    /** Normalizes line endings the same way CodeMirror would */
+    Document.normalizeText = function (text) {
+        return text.replace(/\r\n/g, "\n");
+    };
+    
     /**
      * Sets the contents of the document. Treated as an edit. Line endings will be rewritten to
      * match the document's current line-ending style.
@@ -415,16 +420,14 @@ define(function (require, exports, module) {
 
         // TODO: (issue #295) fetching timestamp async creates race conditions (albeit unlikely ones)
         var thisDoc = this;
-        this.file.getMetadata(
-            function (metadata) {
-                thisDoc.diskTimestamp = metadata.modificationTime;
-                $(exports).triggerHandler("_documentSaved", thisDoc);
-            },
-            function (error) {
+        this.file.stat(function (err, stat) {
+            if (!err) {
+                thisDoc.diskTimestamp = stat.mtime;
+            } else {
                 console.log("Error updating timestamp after saving file: " + thisDoc.file.fullPath);
-                $(exports).triggerHandler("_documentSaved", thisDoc);
             }
-        );
+            $(exports).triggerHandler("_documentSaved", thisDoc);
+        });
     };
 
     /* (pretty toString(), to aid debugging) */
@@ -468,7 +471,7 @@ define(function (require, exports, module) {
      * @return {boolean} - whether or not the document is untitled
      */
     Document.prototype.isUntitled = function () {
-        return this.file instanceof NativeFileSystem.InaccessibleFileEntry;
+        return this.file instanceof InMemoryFile;
     };