slow_blink 0.0.2 → 0.0.3

data/lib/slow_blink/namespace.rb

@@ -0,0 +1,140 @@
+# Copyright (c) 2016 Cameron Harper
+# 
+# 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.
+
+module SlowBlink
+
+    class Namespace
+
+        include Annotatable
+
+        # @return [Hash<Definition>]
+        attr_reader :definitions
+
+        # @return [Array<Group>]
+        attr_reader :groups
+
+        # @return [String]
+        attr_reader :name
+
+        # @return [Array<IncrementalAnnotation>]
+        attr_reader :incrAnnotations
+
+        # @!method self.parse(input, **opts)
+        #
+        #   @param input [String] Blink Schema
+        #   @param opts [Hash] options
+        #   @option opts [String] :fileName filename to append to error message strings
+        #   @return [Namespace]
+
+        # @private
+        #
+        # @param filename [nil,String]
+        # @param name [nil,String]
+        # @param defs [Array<Definition,Group>]
+        def initialize(filename, name, defs)
+
+            @filename = filename
+            @annotes = {}
+            @incrAnnotations = []
+            @groups = []
+            @definitions = {}
+            @name = name
+            @schema = nil
+            
+            errors = 0
+            
+            # populate table of definitions
+            # gather list of groups and incrAnnotations
+            # set namespace reference in each def
+            defs.each do |d|
+                if d.is_a? IncrementalAnnotation
+                    @incrAnnotations << d
+                else
+                    if @definitions[d.nameWithID.name]
+                        puts "#{d.location}: error: duplicate definition name '#{d.nameWithID.name}' (first defined at #{definitions[d.nameWithID.name].location})"
+                        errors += 1
+                    else
+                        @definitions[d.nameWithID.name] = d
+                        if d.is_a? Group
+                            @groups << d
+                        end
+                        d.namespace = self           
+                    end                    
+                end
+            end
+
+            if errors > 0
+                raise
+            end
+            
+        end
+
+        # @param namespace [Namespace]
+        def merge!(namespace)
+            if namespace.name == @name
+                @incrAnnotations.concat(namespace.incrAnnotations)
+                namespace.definitions.each do |d|
+                    if @definitions[d.nameWithID.name]
+                        puts "#{d.location}: error: duplicate definition name '#{d.nameWithID.name}' (first defined at #{definitions[d.nameWithID.name].location})"
+                        errors += 1
+                    else
+                        @definitions[d.nameWithID.name] = d
+                        if d.is_a? Group
+                            @groups << d
+                        end                        
+                    end                    
+                end
+            else
+                raise "error: cannot merge different namespaces"
+            end
+        end
+
+        # @param schema [Schema] common schema
+        # @param stack [Array] used to detect cycles
+        def link(schema, stack=[])
+            if @schema.nil?
+                errors = 0
+                @definitions.each do |name, d|
+                    if !d.link(schema, stack.dup << self)
+                        errors += 1
+                    end                    
+                end
+                if errors == 0
+                    @schema = schema
+                end
+            end
+            @schema
+        end
+
+        # @param name [String] unqualified name
+        # @return [Definition,Group]
+        def resolve(name)
+            @definitions[name]
+        end
+
+        def group(name)
+            @groups.detect{|g|g.nameWithID.name == name}
+        end
+
+    end    
+
+end
+
+
+

data/lib/slow_blink/object.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2016 Cameron Harper
+# 
+# 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.
+
+
+module SlowBlink
+
+    # any group
+    #
+    # Blink Specification 3.9
+    class OBJECT < Type        
+    end
+
+end

data/lib/slow_blink/ref.rb

@@ -0,0 +1,93 @@
+# Copyright (c) 2016 Cameron Harper
+# 
+# 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.
+
+module SlowBlink
+
+    class REF < Type
+
+        # @return referenced object
+        attr_reader :ref
+
+        # @return [true] dynamic group reference
+        # @return [false] static reference
+        def dynamic?
+            @dynamic
+        end
+
+        # @return [String]
+        attr_reader :qname
+
+        # @private
+        #
+        # @param qname [String] 
+        # @param dynamic [true,false]
+        # @param location [String]    
+        def initialize(qname, dynamic, location)
+            @qname = qname
+            if qname.split(":").size == 1
+                @namespace = nil
+                @name = qname                
+            else                
+                @namespace = qname.split(":").first
+                @name = qname.split(":").last
+            end
+            @dynamic = dynamic
+            @ref = nil
+            super(location)
+        end
+
+        # @private
+        # 
+        # @macro common_link
+        def link(schema, ns, stack=[])
+            if @schema.nil?
+                if @namespace
+                    ref = schema.resolve(@namespace, @name)                    
+                else
+                    ref = ns.resolve(@name) or schema.resolve(@namespace, @name)
+                end
+                if ref and ref.link(schema, stack << self)
+                    # follow reference to get type
+                    loop do
+                        if ref.kind_of? Definition and ref.type.kind_of? REF
+                            ref = ref.type.ref
+                        else
+                            if !ref.kind_of? Group
+                                ref = ref.type
+                            end
+                            break
+                        end
+                    end
+                    if @dynamic and !ref.kind_of? Group
+                        puts "#{@location}: error: '#{@qname}' must resolve to a group with an ID"
+                    else
+                        @ref = ref
+                        @schema = schema
+                    end
+                else                    
+                    puts "#{@location}: error: '#{@qname}' is not defined in schema"
+                end                
+            end
+            @schema
+        end
+        
+    end
+
+end
+

data/lib/slow_blink/schema.rb

@@ -17,119 +17,145 @@
 # 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.
 
-require 'slow_blink/annotatable'
-
-# @!macro [new] common_link
-#   
-#   Resolve symbols to definitions in schema
-#
-#   @param schema [Schema] schema to link
-#   @param stack [Array]
-#
-#   @return [Schema] linked
-#   @return [nil] not linked
-#
-
 module SlowBlink
 
     class Schema
 
-        include Annotatable
+        # Initialise a Schema from one or more Blink Schema files
+        #
+        # @param filename [Array<String>]
+        def self.read(*filename)
+            input = []
+            if filename.size > 0
+                filename.each do |f|
+                    input << SchemaBuffer.new(File.read(f), f)
+                end
+                self.new(*input)
+            else
+                raise "at least one file required"                
+            end
+        end
 
-        # @!method self.parse(input, **opts)
+        # Tagged groups are able to be serialised as dynamic groups
         #
-        #   Initialise a Schema object from Blink Schema input string
+        # - These groups are of interest to message code generators
         #
-        #   @param input [String] Blink Schema
-        #   @param opts [Hash] options
-        #   @option opts [String] :fileName file input originated from (for error messages)
-        #   @return [Schema]
-
-        # @param namespace [nil,String]
-        # @param defs [Array<Definition>]
-        def initialize(namespace, defs)
-            @nameWithID = NameWithID.new(nil,nil)
-            @annotes = []
-            @groups = {}
-            errors = 0
-            
-            if namespace
-                @namespace = namespace
+        # @return [Hash]
+        attr_reader :tagged
+
+        # @return [Array<Namespace>]
+        attr_reader :ns
+
+        # @param buffer [Array<SchemaBuffer>]
+        def initialize(*buffer)
+
+            if buffer.size > 0
+                namespace = []
+                buffer.each do |b|
+                    namespace << Namespace.parse(b.buffer, filename: b.filename)                    
+                end
             else
-                @namespace = nil
+                raise "at least one buffer required"
             end
 
-            @defs = {}
-
-            # populate table of definitions
-            defs.each do |d|
-                if !d.is_a? IncrementalAnnotation
-                    if @defs[d.nameWithID.name]
-                        puts "#{d.location}: error: duplicate definition name"
+            @ns = {}
+            @tagged = {}
+            
+            errors = 0            
+
+            # gather and merge namespaces
+            namespace.each do |ns|
+                if @ns[ns.name]
+                    begin
+                        @ns[ns.name].merge!(ns)
+                    rescue
                         errors += 1
-                    else
-                        @defs[d.nameWithID.name] = d
                     end
+                else
+                    @ns[ns.name] = ns
                 end
             end
 
-            # now apply incremental annotation
-            defs.each do |d|
-                if d === IncrementalAnnotation
-                    d.link(schema)
+            # apply incremental annotation in order of input
+            namespace.each do |ns|
+                ns.incrAnnotations.each do |a|
+                    a.apply(self, ns)
+                end
+            end
+            
+            # gather tagged groups and detect duplicates
+            @ns.each do |name, ns|
+                ns.groups.each do |g|
+                    if g.nameWithID.id
+                        if @tagged[g.nameWithID.id]
+                            puts "error: duplicate group id"
+                            errors += 1
+                        else
+                            @tagged[g.nameWithID.id] = g
+                        end
+                    end
                 end
             end
 
-            # now link the definitions
-            @defs.each do |name, d|
-                if !d.link(self)
+            # resolve all references
+            @ns.each do |name, ns|
+                if !ns.link(self)
                     errors += 1
                 end
             end
-            
+
             if errors > 0
                 raise Error.new "#{errors} errors"
             end
             
         end
 
-        # @param name [String] definition or group name
-        # @return [Definition]
-        # @return [Group]
-        def symbol(name)
-            @defs[name]            
-        end
-
-        # @param nameOrID [String,Integer] group name or id
-        # @return [Group] group exists
-        # @return [nil] group does not exist
-        def group(nameOrID)
-            if nameOrID.kind_of? String
-                @groups[nameOrID]
+        # resolve a name to a definition in any namespace
+        #
+        # @param namespace [String,nil]
+        # @param name [String]
+        # @return [Definition,Group]
+        def resolve(namespace, name)
+            if @ns[namespace]
+                @ns[namespace].resolve(name)
             else
-                @groups.values.detect{|g|g.nameWithID.id == nameOrID}
-            end
+                nil
+            end               
         end
-
+    
     end    
 
 end
 
-require 'slow_blink/compact_encoder'
+require 'slow_blink/schema_buffer'
+require 'slow_blink/annotatable'
+require 'slow_blink/namespace'
 require 'slow_blink/error'
+require 'slow_blink/ext_compact_encoder'
 require 'slow_blink/version'
 require 'slow_blink/annotation'
 require 'slow_blink/incremental_annotation'
 require 'slow_blink/group'
 require 'slow_blink/field'
-require 'slow_blink/component_reference'
 require 'slow_blink/definition'
 require 'slow_blink/type'
+require 'slow_blink/integer'
+require 'slow_blink/decimal'
+require 'slow_blink/floating_point'
+require 'slow_blink/string'
+require 'slow_blink/binary'
+require 'slow_blink/fixed'
+require 'slow_blink/date'
+require 'slow_blink/time_of_day'
+require 'slow_blink/time'
+require 'slow_blink/sequence'
+require 'slow_blink/ref'
+require 'slow_blink/object'
+require 'slow_blink/boolean'
 require 'slow_blink/enumeration'
 require 'slow_blink/sym'
 require 'slow_blink/name_with_id'
 require 'slow_blink/ext_schema_parser'
-require 'slow_blink/message'
 
 
 

data/lib/slow_blink/{component_reference.rb → schema_buffer.rb}

@@ -19,32 +19,21 @@
 
 module SlowBlink
 
-    # SCHEMA
-    class SchemaRef
-    end
-
-    # qName
-    class DefinitionRef < SchemaRef
-        # @param qName [String] name of the definition to annotate
-        def initialize(qName)
-            @qName = qName
-        end
-    end
+    class SchemaBuffer
 
-    # qName.TYPE
-    class DefinitionTypeRef < DefinitionRef
-    end
+        # @return [String]
+        attr_reader :buffer
 
-    # qName.name
-    class FieldRef < SchemaRef
-        def initialize(qName, name)
-            @qName = qName
-            @name = name
+        # @return [String]
+        attr_reader :filename
+        
+        # @param buffer [String] the contents of the file
+        # @param filename [String] name of the file (for error reporting)
+        def initialize(buffer, filename=nil)
+            @filename = filename
+            @buffer = buffer
         end
-    end
 
-    # qName.name.TYPE
-    class FieldTypeRef < FieldRef
     end
 
 end

data/lib/slow_blink/sequence.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2016 Cameron Harper
+# 
+# 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.
+
+module SlowBlink
+
+    # Blink Specification 3.12
+    class SEQUENCE < Type
+
+        # @return [Type]
+        attr_reader :type
+
+        # @private
+        #
+        # @param type [Type] repeating type
+        # @param location [String]    
+        def initialize(type, location)
+            @type = nil
+            @rawType = type
+            super(location)
+        end
+
+        # @private
+        #
+        # @macro common_link
+        def link(schema, stack=[])
+            if @schema.nil?
+                case @rawType.class
+                when REF
+                    schema.definition(@rawType)
+                when SEQUENCE
+                    puts "error: sequence of sequence is not permitted"
+                else
+                    @type = @rawType
+                    @schema = schema
+                end
+            end
+            @schema
+        end
+
+    end
+
+end

data/lib/slow_blink/string.rb

@@ -0,0 +1,40 @@
+# Copyright (c) 2016 Cameron Harper
+# 
+# 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.
+
+module SlowBlink
+
+    # Blink Specification 3.2
+    class STRING < Type
+
+        # @return [Integer] maximum size
+        # @return [nil] no maximum size
+        attr_reader :size
+
+        # @private
+        #
+        # @param size [Integer] maximum size
+        # @param location [String]    
+        def initialize(size, location)
+            @size = size
+            super(location)
+        end
+
+    end
+
+end

data/lib/slow_blink/sym.rb

@@ -31,6 +31,10 @@ module SlowBlink
         # @return [Integer]
         attr_reader :val
 
+        def val=(value)
+            @val = value.to_i
+        end
+
         # @private
         #
         # @param name [String]

data/lib/slow_blink/time.rb

@@ -0,0 +1,30 @@
+# Copyright (c) 2016 Cameron Harper
+# 
+# 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.
+
+module SlowBlink
+
+    # Blink Specification 3.9
+    class MILLI_TIME < Type
+    end
+
+    # Blink Specification 3.9
+    class NANO_TIME < Type        
+    end
+
+end