wdm 0.0.3 → 0.1.0

data/LICENSE

@@ -1,22 +1,22 @@
-Copyright (c) 2012 Maher Sallam
-
-MIT License
-
-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
+Copyright (c) 2012 Maher Sallam
+
+MIT License
+
+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.

data/README.md

@@ -1,25 +1,14 @@
 # Windows Directory Monitor (WDM)
 
-Windows Directory Monitor (WDM) is a library which can be used to monitor directories for changes.
-It's mostly implemented in C and uses the Win32 API for a better performance.
-
-**Note:** This is still a work in progress, so it's not advisable to use
-it yet in anything (unless you are testing it, which is very much appreciated :)).
+Windows Directory Monitor (WDM) is a thread-safe ruby library which can be used to monitor directories for changes on Windows.
 
-TODO:
+It's mostly implemented in C and uses the Win32 API for a better performance.
 
-- Fix all the TODO's in the source.
-- ~~Enable watching subdirectories.~~
-- ~~Add options to the `watch` method.~~
-- ~~Provide info about the change in the callback.~~
-- ~~Convert \ to / in paths.~~
-- ~~Don't allow directories to be watched while the monitor is running.~~
-- ~~Check if the passed direcoty exists.~~
-- ~~Convert passed directories to absolute paths.~~
+**Important**: WDM only runs on ruby versions >= *1.9.2*! 
 
 ## Installation
 
-Add this line to your application's Gemfile:
+If you are using Bundler, add the following line to your application's Gemfile:
 
     gem 'wdm'
 
@@ -31,20 +20,180 @@ Or install it yourself as:
 
     $ gem install wdm
 
+## Usage
+
+For a simple example on how to use WDM, you can take a look at the `example` directory of the repository.
+
+## Benchmarks
+
+You can find a comparison of different ruby libraries for watching directory changes on Windows in the `benchmark` directory of the repository.
+
+## Reference
+
+### `WDM::Monitor`
+
+To start watching directories, you need an instance of `WDM::Monitor`:
+
+```ruby
+monitor = WDM::Monitor.new
+```
+
+After that, register a callback for each directory you want to watch:
+
+```ruby
+# Watch a single directory
+monitor.watch('C:\Users\Maher\Desktop') { |change|  puts change.path }
+
+# Watch a directory with its subdirectories
+monitor.watch_recursively('C:\Users\Maher\Projects\my_project') { |change|  puts change.path }
+```
+
+Both `Monitor#watch` and `Monitor#watch_recursively` can take a series of options after the first parameter to specify the watching options:
+
+```ruby
+# Report changes to directories in the watched directory (Ex.: Addition of an empty directory)
+monitor.watch('C:\Users\Maher\Desktop', :default, :directories)
+```
+
+The supported options are:
+
+<table>
+  <thead>
+    <tr>
+      <th>Value</th>
+      <th>Meaning</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>:default</td>
+
+      <td>
+        The default set of options for watching directories. It's a combination of the :files, :directories and the :last_write options.
+      </td>
+    </tr>
+    
+    <tr>
+      <td>:files</td>
+
+      <td>
+        Any file name change in the watched directory or subtree causes a change
+        notification wait operation to return. Changes include renaming, creating, or
+        deleting a file.
+      </td>
+    </tr>
+
+    <tr>
+      <td>:directories</td>
+
+      <td>
+        Any directory-name change in the watched directory or subtree causes a
+        change notification wait operation to return. Changes include creating or
+        deleting a directory.
+      </td>
+    </tr>
+
+    <tr>
+      <td>:attributes</td>
+
+      <td>
+        Any attribute change in the watched directory or subtree causes a change
+        notification wait operation to return.
+      </td>
+    </tr>
+
+    <tr>
+      <td>:size</td>
+
+      <td>
+        Any file-size change in the watched directory or subtree causes a change
+        notification wait operation to return. The operating system detects a change in
+        file size only when the file is written to the disk. For operating systems that
+        use extensive caching, detection occurs only when the cache is sufficiently
+        flushed.
+      </td>
+    </tr>
+
+    <tr>
+      <td>:last_write</td>
+
+      <td>
+        Any change to the last write-time of files in the watched directory or
+        subtree causes a change notification wait operation to return. The operating
+        system detects a change to the last write-time only when the file is written to
+        the disk. For operating systems that use extensive caching, detection occurs
+        only when the cache is sufficiently flushed.
+      </td>
+    </tr>
+
+    <tr>
+      <td>:last_access</td>
+
+      <td>
+        Any change to the last access time of files in the watched directory or
+        subtree causes a change notification wait operation to return.
+      </td>
+    </tr>
+
+    <tr>
+      <td>:creation</td>
+
+      <td>
+        Any change to the creation time of files in the watched directory or subtree
+        causes a change notification wait operation to return.
+      </td>
+    </tr>
+
+    <tr>
+      <td>:security</td>
+
+      <td>
+        Any security-descriptor change in the watched directory or subtree causes a
+        change notification wait operation to return.
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+These options map to the filters that `ReadDirectoryChangesW` takes in its `dwNotifyFilter` parameter. You can find more info on the [docs page](http://msdn.microsoft.com/en-us/library/windows/desktop/aa365465.aspx) of `ReadDirectoryChangesW`. 
+
+Now all that's left to be done is to run the monitor:
+
+```ruby
+monitor.run!
+```
+
+The `Monitor#run!` method blocks the process. Since monitors are thread-safe, you can run them in a thread if you don't want to block your main one:
+
+```ruby
+worker_thread = Thread.new { monitor.run! }
+
+# The process won't block; it will continue with the next line of code...
+```
+
+When you are done with the monitor, don't forget to stop it. Here is a snippet to always stop the monitor when the ruby process exits:
+
+```ruby
+at_exit { monitor.stop }
+```
+
+### `WDM::Change`
+
+The passed argument to the block is an instance of `WDM::Change`. This class has two methods: 
+
+- `Change#path`: The absolute path to the change.
+- `Change#type`: This can be one of the following values: `:added`, `:modified`, `:removed`, `:renamed_old_file` or `:renamed_new_file`.
+
 ## Compiling the extension for developers
 
 Download the source, then run the following:
 
-	$ rake compile
+	$ bundle exec rake compile
 
 To get debug messages, you need to enable them in the `global.h` file:
 
 	#define WDM_DEBUG_ENABLED TRUE // This is disabled by default
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it

data/ext/wdm/entry.c

@@ -8,7 +8,8 @@
 // ---------------------------------------------------------
 
 WDM_PEntryUserData
-wdm_entry_user_data_new() {
+wdm_entry_user_data_new()
+{
     WDM_PEntryUserData user_data;
 
     user_data = WDM_ALLOC(WDM_EntryUserData);
@@ -20,7 +21,8 @@ wdm_entry_user_data_new() {
 }
 
 void
-wdm_entry_user_data_free(WDM_PEntryUserData user_data) {
+wdm_entry_user_data_free(WDM_PEntryUserData user_data)
+{
     if ( user_data->dir != NULL ) free(user_data->dir);
     free(user_data);
 }
@@ -30,7 +32,8 @@ wdm_entry_user_data_free(WDM_PEntryUserData user_data) {
 // ---------------------------------------------------------
 
 WDM_PEntry
-wdm_entry_new() {
+wdm_entry_new()
+{
     WDM_PEntry entry;
 
     entry = WDM_ALLOC(WDM_Entry);
@@ -46,7 +49,8 @@ wdm_entry_new() {
 }
 
 void
-wdm_entry_free(WDM_PEntry entry) {
+wdm_entry_free(WDM_PEntry entry)
+{
     if ( entry->dir_handle != INVALID_HANDLE_VALUE ) {
         CancelIo(entry->dir_handle); // Stop monitoring changes
         CloseHandle(entry->dir_handle);
@@ -56,7 +60,8 @@ wdm_entry_free(WDM_PEntry entry) {
 }
 
 void
-wdm_entry_list_free(WDM_PEntry entry) {
+wdm_entry_list_free(WDM_PEntry entry)
+{
     WDM_PEntry tmp;
 
     while(entry != NULL) {

data/ext/wdm/extconf.rb

@@ -1,9 +1,27 @@
 require 'mkmf'
+require 'rbconfig'
 
-if have_library("kernel32") and
+def generate_makefile
+  create_makefile("wdm_ext")
+end
+
+def generate_dummy_makefile
+  File.open("Makefile", "w") do |f|
+    f.puts dummy_makefile('wdm_ext').join
+  end
+end
+
+def windows?
+  RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+end
+
+if windows? and
+   have_library("kernel32") and
    have_header("windows.h") and
    have_header("ruby.h")    and
    have_const('HAVE_RUBY_ENCODING_H')
 then
-    create_makefile("wdm")
+   generate_makefile()
+else
+  generate_dummy_makefile() 
 end

data/ext/wdm/memory.c

@@ -2,7 +2,7 @@
 
 #include "memory.h"
 
-void *
+void*
 wdm_memory_malloc (size_t size)
 {
   void *memory = malloc(size);
@@ -14,7 +14,7 @@ wdm_memory_malloc (size_t size)
   return memory;
 }
 
-void *
+void*
 wdm_memory_realloc (void *ptr, size_t size)
 {
   void *memory = realloc(ptr, size);

data/ext/wdm/memory.h

@@ -9,11 +9,9 @@ extern "C" {
 // Prototypes
 // ---------------------------------------------------------
 
-void *
-wdm_memory_malloc (size_t);
+void* wdm_memory_malloc (size_t);
 
-void *
-wdm_memory_realloc (void *, size_t);
+void* wdm_memory_realloc (void*, size_t);
 
 // ---------------------------------------------------------
 // Macros

data/ext/wdm/monitor.c

@@ -7,7 +7,8 @@
 #include "monitor.h"
 
 WDM_PMonitor
-wdm_monitor_new() {
+wdm_monitor_new()
+{
     WDM_PMonitor monitor;
 
     monitor = WDM_ALLOC(WDM_Monitor);
@@ -32,7 +33,8 @@ wdm_monitor_new() {
 }
 
 void
-wdm_monitor_free(WDM_PMonitor monitor) {
+wdm_monitor_free(WDM_PMonitor monitor)
+{
     if ( monitor->monitoring_thread != INVALID_HANDLE_VALUE ) CloseHandle(monitor->monitoring_thread);
 
     wdm_entry_list_free(monitor->head);
@@ -45,7 +47,8 @@ wdm_monitor_free(WDM_PMonitor monitor) {
 }
 
 void
-wdm_monitor_update_head(WDM_PMonitor monitor, WDM_PEntry new_head) {
+wdm_monitor_update_head(WDM_PMonitor monitor, WDM_PEntry new_head)
+{
     EnterCriticalSection(&monitor->lock);
         new_head->next = monitor->head;
         monitor->head = new_head;
@@ -53,7 +56,8 @@ wdm_monitor_update_head(WDM_PMonitor monitor, WDM_PEntry new_head) {
 }
 
 WDM_PMonitorCallbackParam
-wdm_monitor_callback_param_new(WDM_PMonitor monitor, WDM_PEntry entry) {
+wdm_monitor_callback_param_new(WDM_PMonitor monitor, WDM_PEntry entry)
+{
     WDM_PMonitorCallbackParam param;
 
     param = WDM_ALLOC(WDM_MonitorCallbackParam);
@@ -65,6 +69,7 @@ wdm_monitor_callback_param_new(WDM_PMonitor monitor, WDM_PEntry entry) {
 }
 
 void
-wdm_monitor_callback_param_free(WDM_PMonitorCallbackParam param) {
+wdm_monitor_callback_param_free(WDM_PMonitorCallbackParam param)
+{
     free(param);
 }

data/ext/wdm/queue.c

@@ -5,11 +5,19 @@
 #include "memory.h"
 #include "queue.h"
 
+// ---------------------------------------------------------
+// Prototypes of static functions
+// ---------------------------------------------------------
+
+static WDM_PQueueItem do_queue_dequeue(WDM_PQueue queue);
+
 // ---------------------------------------------------------
 // Queue item functions
 // ---------------------------------------------------------
 
-WDM_PQueueItemError wdm_queue_item_error_new(VALUE exception, LPCSTR format, ...) {
+WDM_PQueueItemError
+wdm_queue_item_error_new(VALUE exception, LPCSTR format, ...)
+{
     WDM_PQueueItemError error;
     va_list ap;
     int length;
@@ -27,15 +35,19 @@ WDM_PQueueItemError wdm_queue_item_error_new(VALUE exception, LPCSTR format, ...
     return error;
 }
 
-void wdm_queue_item_error_free(WDM_PQueueItemError error) {
+void
+wdm_queue_item_error_free(WDM_PQueueItemError error)
+{
     if ( error->message != NULL ) free(error->message);
     free(error);
 }
 
-WDM_PQueueItemData wdm_queue_item_data_new() {
+WDM_PQueueItemData
+wdm_queue_item_data_new()
+{
     WDM_PQueueItemData data;
 
-    data = ALLOC(WDM_QueueItemData);
+    data = WDM_ALLOC(WDM_QueueItemData);
     data->user_data = NULL;
 
     ZeroMemory(&data->buffer, WDM_BUFFER_SIZE);
@@ -43,12 +55,15 @@ WDM_PQueueItemData wdm_queue_item_data_new() {
     return data;
 }
 
-void wdm_queue_item_data_free(WDM_PQueueItemData data) {
+void
+wdm_queue_item_data_free(WDM_PQueueItemData data)
+{
     free(data);
 }
 
 WDM_PQueueItem
-wdm_queue_item_new(WDM_QueueItemType type) {
+wdm_queue_item_new(WDM_QueueItemType type)
+{
     WDM_PQueueItem item;
 
     item = WDM_ALLOC(WDM_QueueItem);
@@ -61,14 +76,14 @@ wdm_queue_item_new(WDM_QueueItemType type) {
         item->data = NULL;
     }
 
-    item->previous    = NULL;
     item->next        = NULL;
 
     return item;
 }
 
 void
-wdm_queue_item_free(WDM_PQueueItem item) {
+wdm_queue_item_free(WDM_PQueueItem item)
+{
     if ( item->type == WDM_QUEUE_ITEM_TYPE_ERROR ) {
         if ( item->error != NULL ) wdm_queue_item_error_free(item->error);
     }
@@ -76,8 +91,8 @@ wdm_queue_item_free(WDM_PQueueItem item) {
         if ( item->data != NULL ) wdm_queue_item_data_free(item->data);
     }
 
-    // We can't really do anything to the prev pointer nor the next pointer,
-    // because we might break any linking the user has established.
+    // We can't really do anything to the next pointer because
+    // we might break any linking the user has established.
     free(item);
 }
 
@@ -86,7 +101,8 @@ wdm_queue_item_free(WDM_PQueueItem item) {
 // ---------------------------------------------------------
 
 WDM_PQueue
-wdm_queue_new() {
+wdm_queue_new()
+{
     WDM_PQueue queue;
 
     queue = WDM_ALLOC(WDM_Queue);
@@ -103,21 +119,22 @@ wdm_queue_new() {
 }
 
 void
-wdm_queue_free(WDM_PQueue queue) {
+wdm_queue_free(WDM_PQueue queue)
+{
     wdm_queue_empty(queue);
     free(queue);
 }
 
 void
-wdm_queue_enqueue(WDM_PQueue queue, WDM_PQueueItem item) {
+wdm_queue_enqueue(WDM_PQueue queue, WDM_PQueueItem item)
+{
     EnterCriticalSection(&queue->lock);
 
-    if ( queue->rear == NULL && queue->front == NULL )  {
+    if ( wdm_queue_is_empty(queue) )  {
         queue->front = queue->rear = item;
     }
     else {
         queue->rear->next = item;
-        item->previous = queue->rear;
         queue->rear = item;
     }
 
@@ -125,12 +142,11 @@ wdm_queue_enqueue(WDM_PQueue queue, WDM_PQueueItem item) {
 }
 
 WDM_PQueueItem
-wdm_queue_dequeue(WDM_PQueue queue) {
+do_queue_dequeue(WDM_PQueue queue)
+{
     WDM_PQueueItem item;
 
-    EnterCriticalSection(&queue->lock);
-
-    if ( queue->rear == NULL && queue->front == NULL ) {
+    if ( wdm_queue_is_empty(queue) ) {
         item = NULL;
     }
     else {
@@ -141,21 +157,40 @@ wdm_queue_dequeue(WDM_PQueue queue) {
         if ( queue->front == NULL ) queue->rear = NULL;
 
         // Don't allow the user to mess with the queue
-        item->previous = item->next = NULL;
+        item->next = NULL;
     }
 
+    return item;
+}
+
+WDM_PQueueItem
+wdm_queue_dequeue(WDM_PQueue queue)
+{
+    WDM_PQueueItem item;
+
+    EnterCriticalSection(&queue->lock);
+
+    item = do_queue_dequeue(queue);
+
     LeaveCriticalSection(&queue->lock);
 
     return item;
 }
 
-void wdm_queue_empty(WDM_PQueue queue) {
+void
+wdm_queue_empty(WDM_PQueue queue)
+{
+    EnterCriticalSection(&queue->lock);
+
     while( ! wdm_queue_is_empty(queue) ) {
-        wdm_queue_item_free(wdm_queue_dequeue(queue));
+        wdm_queue_item_free( do_queue_dequeue(queue) );
     }
+
+    LeaveCriticalSection(&queue->lock);
 }
 
-BOOL
-wdm_queue_is_empty(WDM_PQueue queue) {
+inline BOOL
+wdm_queue_is_empty(WDM_PQueue queue)
+{
     return queue->front == NULL && queue->rear == NULL;
 }

data/ext/wdm/queue.h

@@ -34,11 +34,10 @@ typedef struct WDM_QueueItem {
         WDM_PQueueItemData data;
         WDM_PQueueItemError error;
     };
-    struct WDM_QueueItem* previous;
     struct WDM_QueueItem* next;
 } WDM_QueueItem, *WDM_PQueueItem;
 
-typedef struct WDM_Queue {
+typedef struct {
     CRITICAL_SECTION lock;
     WDM_PQueueItem front;
     WDM_PQueueItem rear;

data/ext/wdm/rb_change.c

@@ -11,7 +11,7 @@
 // Internal constants
 // ---------------------------------------------------------
 
-// The _wsplitpat constants account for two NULL chars, so substract 1 because we only need one!
+// The _wsplitpat constants account for two NULL chars, so subtract 1 because we only need one!
 #define WDM_MAX_FILENAME (_MAX_FNAME + _MAX_EXT - 1)
 
 // ----------------------------------------------------------
@@ -38,10 +38,11 @@ static VALUE extract_change_type_from_notification(const PFILE_NOTIFY_INFORMATIO
 // ----------------------------------------------------------
 
 // TODO:
-//   1. this function uses a lot of 'alloca' calls, which AFAIK is not recommeneded! Can this be avoided?
+//   1. this function uses a lot of 'alloca' calls, which AFAIK is not recommended! Can this be avoided?
 //   2. all wcscat calls can be done faster with memcpy, but is it worth sacrificing the readability?
 static VALUE
-extract_absolute_path_from_notification(const LPWSTR base_dir, const PFILE_NOTIFY_INFORMATION info) {
+extract_absolute_path_from_notification(const LPWSTR base_dir, const PFILE_NOTIFY_INFORMATION info)
+{
     LPWSTR buffer, absolute_filepath;
     WCHAR file[_MAX_FNAME], ext[_MAX_EXT], filename[WDM_MAX_FILENAME];
     DWORD filename_len, absolute_filepath_len;
@@ -115,7 +116,7 @@ extract_absolute_path_from_notification(const LPWSTR base_dir, const PFILE_NOTIF
         }
     }
 
-    // The convention in Ruby is to use forward-slashes to seprarate dirs on all platforms.
+    // The convention in Ruby is to use forward-slashes to separate dirs on all platforms.
     wdm_utils_convert_back_to_forward_slashes(absolute_filepath, absolute_filepath_len + 1);
 
     // Convert the path from WCHAR to multibyte CHAR to use it in a ruby string
@@ -141,7 +142,8 @@ extract_absolute_path_from_notification(const LPWSTR base_dir, const PFILE_NOTIF
 }
 
 static VALUE
-extract_change_type_from_notification(const PFILE_NOTIFY_INFORMATION info) {
+extract_change_type_from_notification(const PFILE_NOTIFY_INFORMATION info)
+{
     ID type;
 
     switch(info->Action) {
@@ -162,7 +164,8 @@ extract_change_type_from_notification(const PFILE_NOTIFY_INFORMATION info) {
 }
 
 VALUE
-wdm_rb_change_new_from_notification(const LPWSTR base_dir, const PFILE_NOTIFY_INFORMATION info) {
+wdm_rb_change_new_from_notification(const LPWSTR base_dir, const PFILE_NOTIFY_INFORMATION info)
+{
     VALUE change;
 
     change = rb_class_new_instance(0, NULL, cWDM_Change);
@@ -177,7 +180,8 @@ wdm_rb_change_new_from_notification(const LPWSTR base_dir, const PFILE_NOTIFY_IN
 }
 
 void
-wdm_rb_change_init() {
+wdm_rb_change_init()
+{
     WDM_DEBUG("Registering WDM::Event with Ruby!");
 
     wdm_rb_sym_at_path = rb_intern("@path");

data/ext/wdm/rb_monitor.c

@@ -60,7 +60,8 @@ static VALUE rb_monitor_stop(VALUE);
 // ----------------------------------------------------------
 
 static void
-monitor_mark(LPVOID param) {
+monitor_mark(LPVOID param)
+{
     WDM_PMonitor monitor;
     WDM_PEntry entry;
 
@@ -74,7 +75,8 @@ monitor_mark(LPVOID param) {
 }
 
 static void
-monitor_free(LPVOID param) {
+monitor_free(LPVOID param)
+{
     WDM_PMonitor monitor;
     WDM_PEntry entry;
 
@@ -98,7 +100,8 @@ monitor_free(LPVOID param) {
 }
 
 static VALUE
-rb_monitor_alloc(VALUE self) {
+rb_monitor_alloc(VALUE self)
+{
     WDM_DEBUG("--------------------------------");
     WDM_DEBUG("Allocating a new monitor object!");
     WDM_DEBUG("--------------------------------");
@@ -107,10 +110,11 @@ rb_monitor_alloc(VALUE self) {
 }
 
 static DWORD
-id_to_flag(ID id) {
+id_to_flag(ID id)
+{
     if ( id == wdm_rb_sym_default ) return WDM_MONITOR_FLAGS_DEFAULT;
 
-    // TODO: Maybe reorder the if's in the frequentie of use for better performance?
+    // TODO: Maybe reorder the if's in the frequency of use for better performance?
     if ( id == wdm_rb_sym_files ) return FILE_NOTIFY_CHANGE_FILE_NAME;
     if ( id == wdm_rb_sym_directories ) return FILE_NOTIFY_CHANGE_DIR_NAME;
     if ( id == wdm_rb_sym_attributes ) return FILE_NOTIFY_CHANGE_ATTRIBUTES;
@@ -124,7 +128,8 @@ id_to_flag(ID id) {
 }
 
 static DWORD
-extract_flags_from_rb_array(VALUE flags_array) {
+extract_flags_from_rb_array(VALUE flags_array)
+{
     VALUE flag_symbol;
     DWORD flags;
 
@@ -140,7 +145,8 @@ extract_flags_from_rb_array(VALUE flags_array) {
 }
 
 static VALUE
-combined_watch(BOOL recursively, int argc, VALUE *argv, VALUE self) {
+combined_watch(BOOL recursively, int argc, VALUE *argv, VALUE self)
+{
     WDM_PMonitor monitor;
     WDM_PEntry entry;
     int directory_letters_count;
@@ -237,12 +243,14 @@ combined_watch(BOOL recursively, int argc, VALUE *argv, VALUE self) {
 }
 
 static VALUE
-rb_monitor_watch(int argc, VALUE *argv, VALUE self) {
+rb_monitor_watch(int argc, VALUE *argv, VALUE self)
+{
     return combined_watch(FALSE, argc, argv, self);
 }
 
 static VALUE
-rb_monitor_watch_recursively(int argc, VALUE *argv, VALUE self) {
+rb_monitor_watch_recursively(int argc, VALUE *argv, VALUE self)
+{
     return combined_watch(TRUE, argc, argv, self);
 }
 
@@ -256,7 +264,7 @@ handle_entry_change(
     WDM_PQueueItem data_to_process;
 
     if ( err_code == ERROR_OPERATION_ABORTED ) {
-        // Async operation was canceld. This shouldn't happen.
+        // Async operation was canceled. This shouldn't happen.
         // TODO:
         //   1. Maybe add a union in the queue for errors?
         //   2. What's the best action when this happens?
@@ -293,7 +301,8 @@ handle_entry_change(
 }
 
 static BOOL
-register_monitoring_entry(WDM_PEntry entry) {
+register_monitoring_entry(WDM_PEntry entry)
+{
     BOOL success;
     DWORD bytes;
     bytes = 0; // Not used because the process callback gets passed the written bytes
@@ -318,7 +327,8 @@ register_monitoring_entry(WDM_PEntry entry) {
 }
 
 static DWORD WINAPI
-start_monitoring(LPVOID param) {
+start_monitoring(LPVOID param)
+{
     WDM_PMonitor monitor;
     WDM_PEntry curr_entry;
 
@@ -361,7 +371,8 @@ start_monitoring(LPVOID param) {
 }
 
 static VALUE
-wait_for_changes(LPVOID param) {
+wait_for_changes(LPVOID param)
+{
     HANDLE process_event;
 
     process_event = (HANDLE)param;
@@ -370,7 +381,8 @@ wait_for_changes(LPVOID param) {
 }
 
 static void
-process_changes(WDM_PQueue changes) {
+process_changes(WDM_PQueue changes)
+{
     WDM_PQueueItem item;
     LPBYTE current_info_entry_offset;
     PFILE_NOTIFY_INFORMATION info;
@@ -412,7 +424,8 @@ process_changes(WDM_PQueue changes) {
 }
 
 static void
-stop_monitoring(LPVOID param) {
+stop_monitoring(LPVOID param)
+{
     BOOL already_stopped;
     WDM_PMonitor monitor;
     WDM_PEntry entry;
@@ -449,8 +462,8 @@ stop_monitoring(LPVOID param) {
 }
 
 static VALUE
-rb_monitor_run_bang(VALUE self) {
-    DWORD thread_id;
+rb_monitor_run_bang(VALUE self)
+{
     BOOL already_running,
          waiting_succeeded;
     WDM_PMonitor monitor;
@@ -484,7 +497,7 @@ rb_monitor_run_bang(VALUE self) {
         start_monitoring,         // thread function name
         monitor,                  // argument to thread function
         0,                        // use default creation flags
-        &thread_id                // returns the thread identifier
+        NULL                      // Ignore thread identifier
     );
 
     if ( monitor->monitoring_thread == NULL ) {
@@ -514,7 +527,8 @@ rb_monitor_run_bang(VALUE self) {
 }
 
 static VALUE
-rb_monitor_stop(VALUE self) {
+rb_monitor_stop(VALUE self)
+{
     WDM_PMonitor monitor;
 
     Data_Get_Struct(self, WDM_Monitor, monitor);
@@ -527,7 +541,8 @@ rb_monitor_stop(VALUE self) {
 }
 
 void
-wdm_rb_monitor_init() {
+wdm_rb_monitor_init()
+{
     WDM_DEBUG("Registering WDM::Monitor with Ruby!");
 
     wdm_rb_sym_call = rb_intern("call");

data/ext/wdm/utils.c

@@ -8,7 +8,8 @@
 // ---------------------------------------------------------
 
 LPWSTR
-wdm_utils_convert_back_to_forward_slashes(LPWSTR path, DWORD path_len) {
+wdm_utils_convert_back_to_forward_slashes(LPWSTR path, DWORD path_len)
+{
     UINT i;
 
     for(i = 0; i < (path_len - 1); ++i) { // path_len-1 because we don't need to check the NULL-char!
@@ -19,7 +20,8 @@ wdm_utils_convert_back_to_forward_slashes(LPWSTR path, DWORD path_len) {
 }
 
 LPWSTR
-wdm_utils_full_pathname(const LPWSTR path) {
+wdm_utils_full_pathname(const LPWSTR path)
+{
     WCHAR maxed_path[WDM_MAX_WCHAR_LONG_PATH];
     LPWSTR full_path;
     size_t full_path_len;
@@ -42,7 +44,8 @@ wdm_utils_full_pathname(const LPWSTR path) {
 }
 
 BOOL
-wdm_utils_unicode_is_directory(const LPWSTR path) {
+wdm_utils_unicode_is_directory(const LPWSTR path)
+{
     WCHAR unicode_path[WDM_MAX_WCHAR_LONG_PATH];
 
     wcscpy(unicode_path, L"\\\\?\\");
@@ -59,7 +62,8 @@ wdm_utils_unicode_is_directory(const LPWSTR path) {
 }
 
 BOOL
-wdm_utils_is_directory(const LPWSTR path) {
+wdm_utils_is_directory(const LPWSTR path)
+{
   DWORD dwAttrib = GetFileAttributesW(path);
 
   return (dwAttrib != INVALID_FILE_ATTRIBUTES &&
@@ -67,6 +71,7 @@ wdm_utils_is_directory(const LPWSTR path) {
 }
 
 BOOL
-wdm_utils_is_unc_path(const LPWSTR path) {
+wdm_utils_is_unc_path(const LPWSTR path)
+{
     return path[0] == path[1] && path[0] == L'\\';
 }

data/ext/wdm/wdm.c

@@ -32,7 +32,8 @@ rb_encoding *wdm_rb_enc_utf8;
 // ----------------------------------------------------------
 
 void
-Init_wdm() {
+Init_wdm_ext()
+{
     WDM_DEBUG("Registering WDM with Ruby!");
 
     wdm_rb_enc_utf8 = rb_utf8_encoding();

data/ext/wdm/wdm.h

@@ -57,6 +57,12 @@ extern VALUE eWDM_Error;
 
 extern rb_encoding *wdm_rb_enc_utf8;
 
+// ---------------------------------------------------------
+// Prototypes
+// ---------------------------------------------------------
+
+void Init_wdm_ext();
+
 // ---------------------------------------------------------
 
 #ifdef __cplusplus

data/ext/wdm/wdm.vcxproj

@@ -20,12 +20,14 @@
     <ConfigurationType>Application</ConfigurationType>
     <UseDebugLibraries>true</UseDebugLibraries>
     <CharacterSet>Unicode</CharacterSet>
+    <PlatformToolset>v110</PlatformToolset>
   </PropertyGroup>
   <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
     <ConfigurationType>Application</ConfigurationType>
     <UseDebugLibraries>false</UseDebugLibraries>
     <WholeProgramOptimization>true</WholeProgramOptimization>
     <CharacterSet>Unicode</CharacterSet>
+    <PlatformToolset>v110</PlatformToolset>
   </PropertyGroup>
   <Import Project="$(VCTargetsPath)\Microsoft.Cpp.props" />
   <ImportGroup Label="ExtensionSettings">

data/lib/wdm.rb

@@ -0,0 +1,10 @@
+begin
+  require 'wdm_ext'
+rescue LoadError
+  raise LoadError.new(<<-EOS)
+    Can't load WDM!
+    
+    WDM is not supported on your system. For a cross-platform alternative,
+    we recommend using Listen: http://github.com/guard/listen
+  EOS
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wdm
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-15 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -153,6 +153,7 @@ files:
 - ext/wdm/wdm.sln
 - ext/wdm/wdm.vcxproj
 - ext/wdm/wdm.vcxproj.filters
+- lib/wdm.rb
 - LICENSE
 - README.md
 homepage: https://github.com/Maher4Ever/wdm
@@ -173,9 +174,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 341068911
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24