notepadqq_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39710914d68c92d17c5a22ecf2127f080e7129e4
+  data.tar.gz: ea8fd30106d0259a57f4142dba03f256a761e232
+SHA512:
+  metadata.gz: bfb8a113bc860463d9b05ca26018e3deeab3af14d3c927def213d894d2ec28fd0caace181b6ade134479895a12cf0748549b44c6fff90b250589cc9ba737b99d
+  data.tar.gz: c0ab795d4f91060b5c7cef325d17ab3638f476e9ad9c429a70516868713641291819deb99b9b53ded7d54e458bb33ea1fc4f01c3ffe2210fcc1f1926e3b921f0

data/lib/notepadqq_api/message_channel.rb

@@ -0,0 +1,94 @@
+require 'socket'
+require 'json'
+
+class NotepadqqApi
+  class MessageChannel
+
+    def initialize(socketPath)
+      # Connect to Notepadqq socket
+      @client = UNIXSocket.open(socketPath)
+
+      @incomingBuffer = "" # Incomplete json messages (as strings)
+      @parsedBuffer = [] # Unprocessed object messages
+    end
+
+    # Sends a JSON message to Notepadqq
+    def sendMessage(msg)
+      sendRawMessage(JSON.generate(msg))
+    end
+
+    # Read incoming messages
+    def getMessages(block=true)
+
+      begin
+        if block and @incomingBuffer.empty? and @parsedBuffer.empty?
+          read = @client.recv(1048576)
+        else
+          read = @client.recv_nonblock(1048576)
+        end
+      rescue
+        read = ""
+      end
+
+      @incomingBuffer += read
+      messages = @incomingBuffer.split("\n")
+
+      if @incomingBuffer.end_with? "\n"
+        # We only got complete messages: clear the buffer
+        @incomingBuffer.clear
+      else
+        # We need to store the incomplete message in the buffer
+        @incomingBuffer = messages.pop || ""
+      end
+
+      converted = []
+      for i in 0...messages.length
+        begin
+          msg = JSON.parse(messages[i])
+          converted.push(msg)
+        rescue
+          puts "Invalid message received."
+        end
+      end
+
+      retval = @parsedBuffer + converted
+      @parsedBuffer = []
+
+      # Make sure that, when block=true, at least one message is received
+      if block and retval.empty?
+        retval += getMessages(true)
+      end
+
+      return retval
+    end
+
+    # Get the next message of type "result".
+    # The other messages will still be returned by getMessages 
+    def getNextResultMessage
+      discarded = []
+
+      while true do
+        chunk = self.getMessages
+        for i in 0...chunk.length
+          if chunk[i].has_key?("result")
+            discarded += chunk[0...i]
+            discarded += chunk[i+1..-1]
+            @parsedBuffer = discarded
+            return chunk[i]
+          end
+        end
+
+        discarded += chunk
+      end
+
+    end
+
+    private
+
+    # Sends a raw string message to Notepadqq
+    def sendRawMessage(msg)
+      @client.send(msg, 0)
+    end
+
+  end
+end

data/lib/notepadqq_api/message_interpreter.rb

@@ -0,0 +1,113 @@
+class NotepadqqApi
+  class MessageInterpreter
+
+    def initialize(messageChannel)
+      @messageChannel = messageChannel
+
+      # Hash of event handlers, for example
+      # {
+      #   1: {
+      #     "newWindow": [<callback1>, ..., <callbackn>]
+      #   },
+      #   ...
+      # }
+      # Where 1 is an objectId and "newWindow" is an event of that object
+      @eventHandlers = {}
+    end
+
+    # Assign an event of a particular objectId to a callback
+    def registerEventHandler(objectId, event, callback)
+      event = event.to_sym
+
+      @eventHandlers[objectId] ||= {}
+      @eventHandlers[objectId][event] ||= []
+
+      @eventHandlers[objectId][event].push(callback)
+    end
+
+    # Calls a method on the remote object objectId
+    def invokeApi(objectId, method, args)
+      message = {
+        :objectId => objectId,
+        :method => method,
+        :args => args
+      }
+
+      @messageChannel.sendMessage(message)
+      reply = @messageChannel.getNextResultMessage
+
+      result = [reply["result"]]
+      convertStubs!(result)
+      result = result[0]
+
+      # Fixme check for errors in reply["err"]
+
+      return result
+    end
+
+    def processMessage(message)
+      if message.has_key?("event")
+        processEventMessage(message)
+      elsif message.has_key?("result")
+        # We shouldn't have received it here... ignore it
+      end
+    end
+
+    private
+
+    # Call the handlers connected to this event
+    def processEventMessage(message)
+      event = message["event"].to_sym
+      objectId = message["objectId"]
+
+      if @eventHandlers[objectId] and @eventHandlers[objectId][event]
+        handlers = @eventHandlers[objectId][event]
+
+        args = message["args"]
+        convertStubs!(args)
+
+        (handlers.length-1).downto(0).each { |i| 
+          handlers[i].call(*args)
+        }
+      end
+    end
+
+    def convertStubs!(dataArray)
+      # FIXME Use a stack
+
+      dataArray.map! { |value|
+        unless value.nil?
+          if value.kind_of?(Array)
+            convertStubs!(value)
+
+          elsif value.kind_of?(Hash) and
+                value["$__nqq__stub_type"].kind_of?(String) and
+                value["id"].kind_of?(Fixnum)
+
+            stubType = value["$__nqq__stub_type"]
+            begin
+              stub = Object::const_get(Stubs.name + "::" + stubType)
+              stub.new(self, value["id"])
+            rescue
+              puts "Unknown stub: " + stubType
+              value
+            end
+
+          elsif value.kind_of?(Hash)
+            value.each do |key, data|
+              tmpArray = [data]
+              convertStubs!(tmpArray)
+              value[key] = tmpArray[0]
+            end
+
+            value
+
+          else
+            value
+          end
+        end
+      }
+    end
+
+  end
+end

data/lib/notepadqq_api/stubs.rb

@@ -0,0 +1,37 @@
+class NotepadqqApi
+  module Stubs
+
+    class Stub
+
+      def initialize(messageInterpreter, id)
+        @messageInterpreter = messageInterpreter
+        @id = id
+      end
+
+      def on(event, &callback)
+        @messageInterpreter.registerEventHandler(@id, event, callback)
+      end
+
+      def method_missing(method, *args, &block)  
+        return @messageInterpreter.invokeApi(@id, method, args)
+      end 
+
+      def ==(other)
+        other.class <= Stub && id == other.id
+      end
+
+      protected
+
+      def id
+        @id
+      end
+
+    end
+
+    class Notepadqq < Stub; end
+    class Editor < Stub; end
+    class Window < Stub; end
+    class MenuItem < Stub; end
+
+  end
+end

data/lib/notepadqq_api.rb

@@ -0,0 +1,38 @@
+require 'notepadqq_api/message_channel'
+require 'notepadqq_api/message_interpreter'
+require 'notepadqq_api/stubs'
+
+class NotepadqqApi
+  
+  NQQ_STUB_ID = 1
+  
+  attr_reader :extensionId
+  
+  def initialize(socketPath = ARGV[0], extensionId = ARGV[1])
+    @socketPath = socketPath
+    @extensionId = extensionId
+    
+    @messageChannel = MessageChannel.new(@socketPath)
+    @messageInterpreter = MessageInterpreter.new(@messageChannel)
+  end
+  
+  # Start reading messages and calling event handlers
+  def runEventLoop
+    yield
+    
+    while true do
+      messages = @messageChannel.getMessages
+      messages.each do |msg|
+        @messageInterpreter.processMessage(msg)
+      end
+    end
+    
+  end
+  
+  # Returns an instance of Notepadqq
+  def notepadqq
+    @nqq ||= Stubs::Notepadqq.new(@messageInterpreter, NQQ_STUB_ID);
+    return @nqq
+  end
+  
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: notepadqq_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniele Di Sarli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+description: Notepadqq API Layer for extensions
+email: danieleds0@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/notepadqq_api.rb
+- lib/notepadqq_api/message_channel.rb
+- lib/notepadqq_api/message_interpreter.rb
+- lib/notepadqq_api/stubs.rb
+homepage: http://rubygems.org/gems/hola
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Notepadqq API Layer
+test_files: []