Engine directory for ticket #1

Engine/source/platformMac/macCarbVolume.cpp

@@ -0,0 +1,189 @@
+//-----------------------------------------------------------------------------
+// Copyright (c) 2012 GarageGames, LLC
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to
+// deal in the Software without restriction, including without limitation the
+// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+// sell copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+// IN THE SOFTWARE.
+//-----------------------------------------------------------------------------
+
+#include <CoreServices/CoreServices.h>
+
+#include "platform/platform.h"
+#include "platformMac/macCarbVolume.h"
+#include "platform/platformVolume.h"
+#include "console/console.h"
+
+
+//#define DEBUG_SPEW
+
+
+struct MacFileSystemChangeNotifier::Event
+{
+   FSEventStreamRef mStream;
+   Torque::Path mDir;
+   bool mHasChanged;
+};
+
+
+static void fsNotifyCallback(
+   ConstFSEventStreamRef stream,
+   void* callbackInfo,
+   size_t numEvents,
+   void* eventPaths,
+   const FSEventStreamEventFlags eventFlags[],
+   const FSEventStreamEventId eventIds[] )
+{
+   MacFileSystemChangeNotifier::Event* event =
+      reinterpret_cast< MacFileSystemChangeNotifier::Event* >( callbackInfo );
+      
+   // Defer handling this to internalProcessOnce() so we stay in
+   // line with how the volume system expects notifications to
+   // be reported.
+      
+   event->mHasChanged = true;
+}
+
+//-----------------------------------------------------------------------------
+//    Change notifications.
+//-----------------------------------------------------------------------------
+
+
+MacFileSystemChangeNotifier::MacFileSystemChangeNotifier( MacFileSystem* fs )
+   : Parent( fs )
+{
+   VECTOR_SET_ASSOCIATION( mEvents );   
+}
+
+MacFileSystemChangeNotifier::~MacFileSystemChangeNotifier()
+{
+   for( U32 i = 0, num = mEvents.size(); i < num; ++ i )
+   {
+      FSEventStreamStop( mEvents[ i ]->mStream );
+      FSEventStreamInvalidate( mEvents[ i ]->mStream );
+      FSEventStreamRelease( mEvents[ i ]->mStream );
+      
+      SAFE_DELETE( mEvents[ i ] );
+   }
+}
+
+void MacFileSystemChangeNotifier::internalProcessOnce()
+{
+   for( U32 i = 0; i < mEvents.size(); ++ i )
+      if( mEvents[ i ]->mHasChanged )
+      {
+         // Signal the change.
+         
+         #ifdef DEBUG_SPEW
+         Platform::outputDebugString( "[MacFileSystemChangeNotifier] Directory %i changed: '%s'",
+            i + 1, mEvents[ i ]->mDir.getFullPath().c_str() );
+         #endif
+         
+         internalNotifyDirChanged( mEvents[ i ]->mDir );
+         mEvents[i ]->mHasChanged = false;
+      }
+}
+
+bool MacFileSystemChangeNotifier::internalAddNotification( const Torque::Path& dir )
+{
+   // Map the path.
+   
+   Torque::Path fullFSPath = mFS->mapTo( dir );
+   String osPath = PathToOS( fullFSPath );
+
+   // Create event stream.
+   
+   Event* event = new Event;
+   
+   CFStringRef path = CFStringCreateWithCharacters( NULL, osPath.utf16(), osPath.numChars() );
+   CFArrayRef paths = CFArrayCreate( NULL, ( const void** ) &path, 1, NULL );
+
+   FSEventStreamRef stream;
+   CFAbsoluteTime latency = 3.f;
+
+   FSEventStreamContext context;
+   dMemset( &context, 0, sizeof( context ) );
+   context.info = event;
+   
+   stream = FSEventStreamCreate(
+      NULL,
+      &fsNotifyCallback,
+      &context,
+      paths,
+      kFSEventStreamEventIdSinceNow,
+      latency,
+      kFSEventStreamCreateFlagNone
+   );
+   
+   event->mStream = stream;
+   event->mDir = dir;
+   event->mHasChanged = false;
+   
+   mEvents.push_back( event );
+
+   // Put it in the run loop and start the stream.
+   
+   FSEventStreamScheduleWithRunLoop( stream, CFRunLoopGetCurrent(), kCFRunLoopDefaultMode );
+   FSEventStreamStart( stream );
+   
+   CFRelease( path );
+   CFRelease( paths );
+         
+   #ifdef DEBUG_SPEW
+   Platform::outputDebugString( "[MacFileSystemChangeNotifier] Added change notification %i to '%s' (full path: %s)",
+      mEvents.size(), dir.getFullPath().c_str(), osPath.c_str() );
+   #endif
+   
+   return true;
+}
+
+bool MacFileSystemChangeNotifier::internalRemoveNotification( const Torque::Path& dir )
+{
+   for( U32 i = 0, num = mEvents.size(); i < num; ++ i )
+      if( mEvents[ i ]->mDir == dir )
+      {
+         #ifdef DEBUG_SPEW
+         Platform::outputDebugString( "[MacFileSystemChangeNotifier] Removing change notification %i from '%s'",
+            i + 1, dir.getFullPath().c_str() );
+         #endif
+         
+         FSEventStreamStop( mEvents[ i ]->mStream );
+         FSEventStreamInvalidate( mEvents[ i ]->mStream );
+         FSEventStreamRelease( mEvents[ i ]->mStream );
+         
+         SAFE_DELETE( mEvents[ i ] );
+         
+         mEvents.erase( i );
+         
+         return true;
+      }
+      
+   return false;
+}
+
+//-----------------------------------------------------------------------------
+//    Platform API.
+//-----------------------------------------------------------------------------
+
+Torque::FS::FileSystemRef Platform::FS::createNativeFS( const String &volume )
+{
+   return new MacFileSystem( volume );
+}
+
+bool Torque::FS::VerifyWriteAccess(const Torque::Path &path)
+{
+   return true;
+}