cddlc 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed5e9bd6c8caace67d29c6549fd30d59fc2c17c06b671f63868d2ecb6ea0031b
-  data.tar.gz: 03d6d40e1ebf19da17117ca725ba09c60c33867606953d2566fd86ace2805e9a
+  metadata.gz: 000da759c9346bf077d53d94e0d303e6a60e2384ca81fe8a2e746a0f3a058ebc
+  data.tar.gz: 93a2e95d3ab753726aa62f97e036e554bf2ca4c008eb7189dca1c87e63b53dd3
 SHA512:
-  metadata.gz: 2b1790d8845935f61f7c12070dbb95f223a6e1914c813dbf85e4ae3979b1fbcbf37abd5730a3a471c1a5777464a8fc966d36835e20df41d3e19a17203e0969f8
-  data.tar.gz: f0884c20358c0a7edaf9df050c79d93f3df7dfb42ceb44ee59b3cc0cb8f318a5ad5efa08964dd259d3a211dd6bcc8a1b2eed5f636cae4ca5a80b524c3a40fdab
+  metadata.gz: 2e501521ac303e9a8aba48198037a3f941f2ff3b6e4c875ea42bc64e8052c4a78516c0d7cb2c5a1a7efc1827295f5c446e349c51782ac6f52e9c009d341a8bd0
+  data.tar.gz: f9ae3b76b1bbd807816b959e02d8ddaf7d79be417dfe3c3d56eb0fca3496eafd2d50f2b4496a8bd8abffb3fb539e3fb3702c140679cd25329d0a9cfe4c9af55d

data/bin/cddlc

@@ -64,6 +64,17 @@ begin
     opts.on("-tFMT", "--to=FMT", [:basic, :neat, :json, :yaml, :enum, :cddl], "Target format") do |v|
       $options.target = v
     end
+    opts.on("-sRULE", "--start=RULE", String, "Start rule name") do |v|
+      $options.start = v
+    end
+    opts.on("-iIMPORT", "--import=IMPORT", String, "Import [namespace=]reference") do |v|
+      $options.import ||= []
+      $options.import << v
+    end
+    opts.on("-IINCLUDE", "--include=INCLUDE", String, "Include [namespace=]reference") do |v|
+      $options.include ||= []
+      $options.include << v
+    end
   end
   op.parse!
 rescue Exception => e
@@ -71,11 +82,40 @@ rescue Exception => e
   exit 1
 end
 
+cddl_file = ""
+if $options.start
+  cddl_file << "$.start.$ = #{$options.start}\n"
+end
+
+[[$options.include, "include"], [$options.import, "import"]].each do |arr, directive|
+  if arr
+    arr.each do |ref|
+      asname, refname = ref.split("=", 2)
+      unless refname
+        refname = asname
+        asname = nil
+      end
+      cddl_file << ";# #{directive} #{refname}"
+      cddl_file << " as #{asname}" if asname
+      cddl_file << "\n"
+    end
+  end
+end
+
+if $options.verbose
+  warn "::: generated from options:"
+  warn cddl_file
+  warn ":::\n\n"
+end
+
 if ARGV == []
-  puts op
-  exit 1
+  if cddl_file == ""
+    puts op
+    exit 1
+  end
+else
+  cddl_file << ARGF.read
 end
-cddl_file = ARGF.read
 
 cddl = CDDL.from_cddl(cddl_file)
 result = if $options.rules

data/cddlc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "cddlc"
-  s.version = "0.1.2"
+  s.version = "0.1.4"
   s.summary = "CDDL (Concise Data Definition Language) converters and miscellaneous tools"
   s.description = %q{cddlc implements converters and miscellaneous tools for CDDL, RFC 8610}
   s.author = "Carsten Bormann"

data/data/rfc8990-cleaned.cddl

@@ -0,0 +1,213 @@
+
+grasp-message = (message .within message-structure) / noop-message
+
+message-structure = [MESSAGE_TYPE, session-id, ?initiator,
+                     *grasp-option]
+
+MESSAGE_TYPE = 0..255
+session-id = 0..4294967295 ; up to 32 bits
+grasp-option = any
+
+
+discovery-message = [M_DISCOVERY, session-id, initiator, objective]
+
+
+response-message = [M_RESPONSE, session-id, initiator, ttl,
+                    (+locator-option // divert-option), ?objective]
+
+ttl = 0..4294967295 ; in milliseconds
+
+
+request-negotiation-message = [M_REQ_NEG, session-id, objective]
+
+request-synchronization-message = [M_REQ_SYN, session-id, objective]
+
+
+negotiation-message = [M_NEGOTIATE, session-id, objective]
+
+
+end-message = [M_END, session-id, accept-option / decline-option]
+
+
+wait-message = [M_WAIT, session-id, waiting-time]
+waiting-time = 0..4294967295 ; in milliseconds
+
+
+synch-message = [M_SYNCH, session-id, objective]
+
+
+flood-message = [M_FLOOD, session-id, initiator, ttl,
+                 +[objective, (locator-option / [])]]
+
+ttl = 0..4294967295 ; in milliseconds
+
+
+invalid-message = [M_INVALID, session-id, ?any]
+
+
+noop-message = [M_NOOP]
+
+
+divert-option = [O_DIVERT, +locator-option]
+
+
+accept-option = [O_ACCEPT]
+
+
+decline-option = [O_DECLINE, ?reason]
+reason = text  ; optional UTF-8 error message
+
+
+ipv6-locator-option = [O_IPv6_LOCATOR, ipv6-address,
+                       transport-proto, port-number]
+ipv6-address = bytes .size 16
+
+transport-proto = IPPROTO_TCP / IPPROTO_UDP
+IPPROTO_TCP = 6
+IPPROTO_UDP = 17
+port-number = 0..65535
+
+
+ipv4-locator-option = [O_IPv4_LOCATOR, ipv4-address,
+                       transport-proto, port-number]
+ipv4-address = bytes .size 4
+
+
+fqdn-locator-option = [O_FQDN_LOCATOR, text,
+                       transport-proto, port-number]
+
+
+uri-locator-option = [O_URI_LOCATOR, text,
+                      transport-proto / null, port-number / null]
+
+
+objective = [objective-name, objective-flags,
+             loop-count, ?objective-value]
+
+objective-name = text
+objective-value = any
+loop-count = 0..255
+
+
+objective-flags = uint .bits objective-flag
+objective-flag = &(
+  F_DISC: 0    ; valid for discovery
+  F_NEG: 1     ; valid for negotiation
+  F_SYNCH: 2   ; valid for synchronization
+  F_NEG_DRY: 3 ; negotiation is a dry run
+)
+
+
+grasp-message = (message .within message-structure) / noop-message
+
+message-structure = [MESSAGE_TYPE, session-id, ?initiator,
+                     *grasp-option]
+
+MESSAGE_TYPE = 0..255
+session-id = 0..4294967295 ; up to 32 bits
+grasp-option = any
+
+message /= discovery-message
+discovery-message = [M_DISCOVERY, session-id, initiator, objective]
+
+message /= response-message ; response to Discovery
+response-message = [M_RESPONSE, session-id, initiator, ttl,
+                    (+locator-option // divert-option), ?objective]
+
+message /= synch-message ; response to Synchronization request
+synch-message = [M_SYNCH, session-id, objective]
+
+message /= flood-message
+flood-message = [M_FLOOD, session-id, initiator, ttl,
+                 +[objective, (locator-option / [])]]
+
+message /= request-negotiation-message
+request-negotiation-message = [M_REQ_NEG, session-id, objective]
+
+message /= request-synchronization-message
+request-synchronization-message = [M_REQ_SYN, session-id, objective]
+
+message /= negotiation-message
+negotiation-message = [M_NEGOTIATE, 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]
+
+message /= invalid-message
+invalid-message = [M_INVALID, session-id, ?any]
+
+noop-message = [M_NOOP]
+
+divert-option = [O_DIVERT, +locator-option]
+
+accept-option = [O_ACCEPT]
+
+decline-option = [O_DECLINE, ?reason]
+reason = text  ; optional UTF-8 error message
+
+waiting-time = 0..4294967295 ; in milliseconds
+ttl = 0..4294967295 ; in milliseconds
+
+locator-option /= [O_IPv4_LOCATOR, ipv4-address,
+                   transport-proto, port-number]
+ipv4-address = bytes .size 4
+
+locator-option /= [O_IPv6_LOCATOR, ipv6-address,
+                   transport-proto, port-number]
+ipv6-address = bytes .size 16
+
+locator-option /= [O_FQDN_LOCATOR, text, transport-proto,
+                   port-number]
+
+locator-option /= [O_URI_LOCATOR, text,
+                   transport-proto / null, port-number / null]
+
+transport-proto = IPPROTO_TCP / IPPROTO_UDP
+IPPROTO_TCP = 6
+IPPROTO_UDP = 17
+port-number = 0..65535
+
+initiator = ipv4-address / ipv6-address
+
+objective-flags = uint .bits objective-flag
+
+objective-flag = &(
+  F_DISC: 0    ; valid for discovery
+  F_NEG: 1     ; valid for negotiation
+  F_SYNCH: 2   ; valid for synchronization
+  F_NEG_DRY: 3 ; negotiation is a dry run
+)
+
+objective = [objective-name, objective-flags,
+             loop-count, ?objective-value]
+
+objective-name = text ; see section "Format of Objective Options"
+
+objective-value = any
+
+loop-count = 0..255
+
+; Constants for message types and option types
+
+M_NOOP = 0
+M_DISCOVERY = 1
+M_RESPONSE = 2
+M_REQ_NEG = 3
+M_REQ_SYN = 4
+M_NEGOTIATE = 5
+M_END = 6
+M_WAIT = 7
+M_SYNCH = 8
+M_FLOOD = 9
+M_INVALID = 99
+
+O_DIVERT = 100
+O_ACCEPT = 101
+O_DECLINE = 102
+O_IPv6_LOCATOR = 103
+O_IPv4_LOCATOR = 104
+O_FQDN_LOCATOR = 105
+O_URI_LOCATOR = 106

data/lib/cddlc.rb

@@ -1,4 +1,6 @@
 require_relative "parser/cddl-util.rb"
+require_relative "processor/cddl-visitor.rb"
+require_relative 'processor/cddl-undefined.rb'
 
 class CDDL
   @@parser = CDDLGRAMMARParser.new
@@ -22,7 +24,23 @@ class CDDL
     reason.join("\n")
   end
 
+  # (keeps only renamed rules)
+  def rename(rename_map)
+    rules.replace(
+      Hash[rename_map.map do |o, n|
+             [n, visit(rules[o]) do |prod|
+                case prod
+                in ["name", *] | ["gen", *]
+                  prod[1] = rename_map[prod[1]] || prod[1]
+                else
+                end
+                false
+              end]
+           end])
+  end
+
   SAFE_FN = /\A[-._a-zA-Z0-9]+\z/
+  IMPINC = /\A(?:import|include)\z/
 
   def self.from_cddl(s)
     ast = @@parser.parse s
@@ -39,16 +57,10 @@ class CDDL
       ret.directives.each do |di|
         preferred_tag = nil
         case di
-        in ["include" => dir, docref]
-        in ["include" => dir, docref, "as", preferred_tag]
-          warn "** Ignoring namespace tag #{preferred_tag} for now"
-        in ["import" => dir, docref]
+        in [IMPINC => dir, SAFE_FN => docref]
+        in [IMPINC => dir, SAFE_FN => docref, "as", SAFE_FN => preferred_tag]
         else
-          warn "** Can't parse include directive #{di.inspect}"
-          next
-        end
-        unless docref =~ SAFE_FN
-          warn "** skipping unsafe filename #{docref}"
+          warn "** Can't parse directive »#{di.join(" ")}«"
           next
         end
         puts "PREFERRED_TAG #{preferred_tag}" if $options.verbose
@@ -71,26 +83,39 @@ class CDDL
 
         include_file = io.read
         included_cddl = CDDL.from_cddl(include_file)
-        # XXX: Should namespace that thing now! all names -> preferred_tag.name
-        # p included_cddl.rules.keys
-        # XXX: do once, first, to rename COSE_Key to RFC9052.COSE_Key
+        if preferred_tag
+          included_cddl = included_cddl.deep_clone # needed?
+          renamed_names = included_cddl.rules.keys
+          name_rename = Hash[
+            renamed_names.map { |o|
+              n = "#{preferred_tag}.#{o}"
+              warn "** Warning: renamed name #{n} already in #{fn}" if included_cddl.rules[n]
+              [o, n]}]
+          included_cddl.rename(name_rename)
+        end
+
         case dir
         in "import"
           warn "** IMPORTING #{fn}" if $options.verbose
-          require_relative '../lib/processor/cddl-undefined.rb'
+          undef_rule = nil
           loop do
             undef_rule = ret.cddl_undefined # XXX square...
             # p undef_rule
             got_more = false
             undef_rule.each do |name|
               if rule = included_cddl.rules[name]
-                ret.rules[name] = rule                     # XXX must be namespaced!
-                warn "IMPORTED #{name} from #{fn}" if $options.verbose # ...: #{rule}...
+                ret.rules[name] = rule
+                warn "IMPORTED #{name} from #{fn}" if $options.verbose
                 got_more = true
               end
             end
             break unless got_more
           end
+          if preferred_tag
+            undef_rule.each do |name|
+              warn "** Warning: undefined reference #{name} without namespace prefix is defined in namespaced imported module #{fn}" if name_rename[name]
+            end
+          end
         in "include"
           warn "** INCLUDING #{fn}" if $options.verbose
           included_cddl.rules.each do |k, v|
@@ -137,7 +162,6 @@ class CDDL
           fail unless name.size == 2
           name = name[1]
         when "gen"
-          require_relative "processor/cddl-visitor.rb"
           parmnames = name[2..-1]
           name = name[1]        # XXX update val with parm/arg
           val = ["parm", parmnames,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cddlc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,6 +78,7 @@ files:
 - data/prelude.cddl
 - data/rfc8727.cddl
 - data/rfc8927.cddl
+- data/rfc8990-cleaned.cddl
 - data/rfc8990.cddl
 - data/rfc9052.cddl
 - data/rfc9053.cddl
@@ -122,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: CDDL (Concise Data Definition Language) converters and miscellaneous tools