cddl 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57c85df19d5a0b7d9070f233f0d4a59a3cee1bb2
-  data.tar.gz: ac391af699e243e95ae1fce85de5fdf9c863a24d
+  metadata.gz: f786ac685c1f30ca4a1510ad4e40981a6403dc7f
+  data.tar.gz: 8d2a5a22918683e260bbd79331e1b9874ea649a1
 SHA512:
-  metadata.gz: 121cbda92cc8112171d3b7395373fe09e502786a90887e2b54dd2f7639f8082a5197b5f64d6b8fa8c157555c46e476e7a81f463fd33b2f5f085cb5b5b74b0908
-  data.tar.gz: 0ed8f5e200aabf211c5489cd66487bf22e5bcde1d06894795cb36341d4e848d9f479e77cbaa30d6e81d6fd28d66b9fe9cec724b460ae9fd357d3dd981b4995ee
+  metadata.gz: 2055bf34a4f4b366b12455723dcc86eba307064c0831dad03d864f7f6a014eab724b9283917341f88c6daf8a08ecb9d4808f269161b7127404d689684f5165db
+  data.tar.gz: b3693cc1e1277a2f7848fb886ed1665cfc885438da1d2e3fd7d94355a6081265eaa62fd4db3fafea38ade41e708d0515c51a0c0001ad453ccf711009adc8b6d4

data/cddl.gemspec

@@ -1,6 +1,6 @@
 spec = Gem::Specification.new do |s|
   s.name = 'cddl'
-  s.version = '0.6.4'
+  s.version = '0.6.5'
   s.summary = "CDDL generator and validator."
   s.description = %{A parser, generator, and validator for CDDL}
   s.add_dependency('cbor-diag')

data/lib/cddl.rb

@@ -70,21 +70,86 @@ module CDDL
       }]
     end
 
+    def walk(rule, anno = nil, &block)
+      r = []
+      case rule
+      when Array
+        r.concat(Array(yield rule, anno))
+        case rule[0]
+        when :type1, :array, :map
+          a = (rule.cbor_annotations rescue nil) if rule.size == 2
+          a = a.first if a
+          r.concat(rule[1..-1].map{|x| walk(x, a, &block)})
+        when :grpchoice
+          r.concat(rule[1..-1].map{|x| x.flat_map {|y| walk(y, &block)}})
+        when :member
+          r << walk(rule[3], &block)
+          r << walk(rule[4], &block)
+        when :anno
+          r << walk(rule[2], &block)
+          r << walk(rule[3], &block)
+        else
+          # p ["LEAF", rule[0]]
+        end
+      end
+      r.compact
+    end
+
+    def cname(s)
+      s.to_s.gsub(/-/, "_")
+    end
+
     # Generate some simple #define lines from the value-only rules
     def defines(prefix)
-      s = ''
+      s = {}                    # keys form crude set of defines
+      r = rules
       prefix ||= "CDDL"
       ast.each :rule do |rule|
         if rulename = rule.typename
           t = rule.type.children(:type1)
           if t.size == 1
             if (t2 = t.first.children(:type2)) && t2.size == 1 && (v = t2.first.value)
-              s += "#define #{prefix}_#{rulename.to_s.gsub(/-/, "_")} " << v.to_s << "\n"
+              s["#define #{prefix}_#{cname(rulename)} " << v.to_s << "\n"] = true
+            end
+          end
+        end
+      end
+      # CBOR::PP.pp r
+      walk(r) do |subtree, anno|
+        if subtree[0] == :type1 && subtree[1..-1].all? {|x| x[0] == :int}
+          if enumname = subtree.cbor_annotations rescue nil
+            enumname = cname(enumname.first)
+            subtree[1..-1].each do |x| 
+              if memname = x.cbor_annotations
+                memname = "#{enumname}_#{cname(memname.first)}"
+                s["#define #{prefix}_#{memname} " << x[1].to_s << "\n"] = true
+              end
+            end
+          end
+        end
+        if subtree[0] == :array
+          if (arrayname = subtree.cbor_annotations rescue nil) || anno
+            arrayname = cname(arrayname ? arrayname.first : anno)
+            subtree[1..-1].each_with_index do |x, i|
+              if x[0] == :member
+                if Array === x[3] && x[3][0] == :string
+                  memname = x[3][1] # preferably use key string
+                elsif memname = x[4].cbor_annotations
+                  memname = memname.first # use value annotation otherwise
+                end
+                if memname
+                  memname = "#{arrayname}_#{cname(memname)}"
+                  s["#define #{prefix}_#{memname}_index " << i.to_s << "\n"] = true
+                end
+              end
+              if x[0] == :member && (x[1] != 1 || x[2] != 1)
+                break           # can't give numbers if we have optionals etc.
+              end
             end
           end
         end
       end
-      s
+      s.keys.join
     end
 
     def rules

data/test-data/extractor-demo.cddl

@@ -0,0 +1,14 @@
+message = [mtype,
+           beer: enum1, wine: bytes, ? optional: text, cantindex: int]
+
+M_ONE = 1
+M_TWO = 2
+M_THREE = 3
+
+mtype = M_ONE / M_TWO / M_THREE
+
+enum1 = &(
+      one: 1
+      two: 2
+      three: 3
+)

data/test-data/grasp-01-test.cddl

@@ -0,0 +1,90 @@
+   grasp-message = message
+
+   session-id = 0..16777215
+   ; that is up to 24 bits
+
+   message /= discovery-message
+   discovery-message = [M_DISCOVERY, session-id, objective]
+
+   message /= response-message
+   response-message = [M_RESPONSE, session-id,
+                      (+locator-option // divert-option // objective)]
+
+   message /= request-message
+   request-message = [M_REQUEST, session-id, objective]
+
+   message /= negotiation-message
+   negotiation-message = [M_NEGOTIATE, sid: session-id, objective]
+
+   message /= end-message
+   end-message = [M_END, session-id, (accept-option / decline-option)]
+
+   message /= wait-message
+   wait-message = [M_WAIT, session-id, waiting-time-option]
+
+   divert-option = [O_DIVERT, +locator-option]
+
+   accept-option = [O_ACCEPT]
+
+   decline-option = [O_DECLINE]
+
+   waiting-time-option = [O_WAITING, option-waiting-time]
+   option-waiting-time = 0..4294967295 ; in milliseconds
+
+   option-device-id = [O_DEVICE_ID, bytes]
+
+   locator-option /= ipv4-locator-option
+   ipv4-locator-option = bytes .size 4
+   ; this is simpler than [O_IPv4_LOCATOR, bytes .size 4]
+
+   locator-option /= ipv6-locator-option
+   ipv6-locator-option = bytes .size 16
+
+   locator-option /= fqdn-locator-option
+   fqdn-locator-option = [O_FQDN_LOCATOR, text]
+
+   locator-option /= url-locator-option
+   url-locator-option = [O_URL_LOCATOR, text]
+
+   objective-flags = uint .bits objective-flag
+
+   objective-flag = &(
+   D: 0
+   N: 1
+   S: 2
+   )
+
+   ; D means valid for discovery only
+   ; N means valid for discovery and negotiation
+   ; S means valid for discovery and synchronization
+
+   objective /= generic-obj
+   generic-obj = [objective-name, objective-flags, loop-count, ?any]
+
+   objective /= vendor-obj
+   vendor-obj = [{"PEN":pen}, objective-name, objective-flags,
+                 loop-count, ?any]
+
+   ; A PEN is used to distinguish vendor-specific options.
+
+   pen = 0..4294967295
+   objective-name = tstr
+   loop-count = 0..255
+
+   ; Constants
+
+   M_DISCOVERY = 1
+
+   M_RESPONSE = 2
+   M_REQUEST = 3
+   M_NEGOTIATE = 4
+   M_END = 5
+   M_WAIT = 6
+
+   O_DIVERT = 100
+   O_ACCEPT = 101
+   O_DECLINE = 102
+   O_WAITING = 103
+   O_DEVICE_ID = 104
+   O_FQDN_LOCATOR = 105
+   O_URL_LOCATOR = 106

data/test/test-cddl.rb

@@ -1417,4 +1417,84 @@ HERE
     assert_equal g, {"a" => nil}
   end
 
+  def test_extractor_ignores_map
+    parser = CDDL::Parser.new <<HERE
+a = {a: nil,
+     beer: mtype, wine: bytes, ? optional: text, cantindex: int}
+mtype = 1/2/3 ; can't generate anything meaningful here.
+HERE
+    d = parser.defines("FOO")
+    assert_equal "", d
+  end
+
+  def test_extractor_type1
+    parser = CDDL::Parser.new <<HERE
+BAR = a/b/c
+a = 1
+b = 2
+c = 3
+d = 4
+HERE
+    expected = <<HERE
+#define FOO_a 1
+#define FOO_b 2
+#define FOO_c 3
+#define FOO_d 4
+#define FOO_BAR_a 1
+#define FOO_BAR_b 2
+#define FOO_BAR_c 3
+HERE
+    d = parser.defines("FOO")
+    assert_equal expected, d
+  end
+
+  def test_extractor_enum
+    parser = CDDL::Parser.new <<HERE
+
+foo = enum1; why exactly do we need this one?
+
+enum1 = &(
+      one: 1
+      two: 2
+      three: 3
+      enum2
+)
+
+enum2 = (
+      four: 4
+      five: 5
+)
+
+HERE
+    expected = <<HERE
+#define FOO_enum1_one 1
+#define FOO_enum1_two 2
+#define FOO_enum1_three 3
+#define FOO_enum1_four 4
+#define FOO_enum1_five 5
+HERE
+    d = parser.defines("FOO")
+    assert_equal expected, d
+  end
+
+  def test_extractor_array
+    parser = CDDL::Parser.new <<HERE
+message = [mtype,
+           beer: enum1, wine: bytes, ? optional: text, cantindex: int]
+enum1 = &( one: 1, two: 2)
+mtype = 1/2/3 ; can't generate anything meaningful here.
+HERE
+    expected = <<HERE
+#define FOO_message_mtype_index 0
+#define FOO_message_beer_index 1
+#define FOO_message_wine_index 2
+#define FOO_message_optional_index 3
+#define FOO_enum1_one 1
+#define FOO_enum1_two 2
+HERE
+    d = parser.defines("FOO")
+    assert_equal expected, d
+  end
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cddl
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cbor-diag
@@ -102,6 +102,8 @@ files:
 - test-data/cdni-ct.cddl
 - test-data/dcaf.cddl
 - test-data/dcaf1.cddl
+- test-data/extractor-demo.cddl
+- test-data/grasp-01-test.cddl
 - test-data/grasp-01.cddl
 - test-data/grasp-v1.cddl
 - test-data/grasp-v2X.cddl