cddlc 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0fb30da3097b44521e7c3fe12d6e061f7d4f64d9faa3c1239c22a8e76b629e5
-  data.tar.gz: 7cc5c141bd3833d11efb95ab25dd7649666ee6398efb3c01d95dc7cd8a220802
+  metadata.gz: aa1feed69996a1e91c43877cfbe3e68c6b935039976ae95db312fef99a0e8bbd
+  data.tar.gz: 746c4b175cb78c502ab731e43672841663cfb4a4159bcf387f8f69c9f34e347a
 SHA512:
-  metadata.gz: d119b506cf51407c66e882df9bcc59e2019926c3843d8ad5acb0a5dede020f6ecb099284eded1a6cae912db42347edafabb3be79a789d4afd2153015258abe6c
-  data.tar.gz: b30fb2251c6daaba6fe3c20a85800b64af61a1908a4ab80596891bf88687f7ec2e441649d9f05d4268e24c9a77c0818cd188a8deada0642ba20fc75961445abd
+  metadata.gz: c9b58614695995f0336496734a3684992ddd6f7a1be0dfcbc0451f45afde7e78eb2a2f89ce60e9c5e0c09a1c0e7e8856cc5e5658fe3fe78bc22bc08c4897c4d4
+  data.tar.gz: d19ca545ca39eb87af227651438755c13475dd75bd29ef11a6a6327aac42e9c4a69fe0e5322a291e7819903d89c4de1296e1605934bce9b154dcb7ef6563c151

data/bin/cddlc

@@ -44,7 +44,7 @@ require 'ostruct'
 $options = OpenStruct.new
 begin
   op = OptionParser.new do |opts|
-    opts.banner = "Usage: cddlc.rb [options] file.cddl"
+    opts.banner = "Usage: cddlc.rb [options] [file.cddl... | -]"
 
     opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
       $options.verbose = v
@@ -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.3"
+  s.version = "0.1.5"
   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"
@@ -15,6 +15,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler', '~>1'
   s.add_dependency 'treetop', '~>1'
-  s.add_dependency 'json'
-  s.add_dependency 'neatjson'
+  s.add_dependency 'json', '~>2'
+  s.add_dependency 'neatjson', '~>0.10'
 end

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

@@ -39,7 +39,22 @@ class CDDL
            end])
   end
 
+  def self.read_from_include_path(fn)
+    io = nil
+    CDDL::cddl_include_path.each do |path|
+      begin
+        io = (path + fn).open
+        break
+      rescue Errno::ENOENT
+        next
+      end
+    end
+    io
+  end
+
   SAFE_FN = /\A[-._a-zA-Z0-9]+\z/
+  IMPINC = /\A(?:import|include)\z/
+  IDENTIFIER_RE = /\A[A-Za-z@_$]([-.]*[A-Za-z@_$0-9])*\z/
 
   def self.from_cddl(s)
     ast = @@parser.parse s
@@ -50,92 +65,146 @@ class CDDL
       directives = s.lines.grep(/^;# /).map(&:chomp).map{|l| l.sub(/^;#\s+/, '').split(/\s+/)}
       # puts directives.to_yaml
     end
+
     ret = CDDL.new(ast, directives)
 
     if $options.cddl2
-      ret.directives.each do |di|
-        preferred_tag = nil
-        case di
-        in ["include" => dir, docref]
-        in ["include" => dir, docref, "as", preferred_tag]
-        in ["import" => dir, docref]
-        in ["import" => dir, docref, "as", preferred_tag]
-        else
-          warn "** Can't parse include directive #{di.inspect}"
-          next
-        end
-        unless docref =~ SAFE_FN
-          warn "** skipping unsafe filename #{docref}"
-          next
-        end
-        puts "PREFERRED_TAG #{preferred_tag}" if $options.verbose
-        puts "DOCREF #{docref}" if $options.verbose
-        fn = docref.downcase << ".cddl"
-
-        io = nil
-        CDDL::cddl_include_path.each do |path|
-          begin
-            io = (path + fn).open
-            break
-          rescue Errno::ENOENT
-            next
+      ret.perform_directives
+    end
+    ret
+  end
+
+  def perform_directives
+    directives.each do |di|
+      preferred_tag = nil
+      from = nil
+      case di
+      in [IMPINC => dir, SAFE_FN => docref, "as", SAFE_FN => preferred_tag]
+      in [IMPINC => dir, SAFE_FN => docref]
+      in [IMPINC => dir, *from, "from", SAFE_FN => docref, "as", SAFE_FN => preferred_tag]
+      in [IMPINC => dir, *from, "from", SAFE_FN => docref]
+      else
+        warn "** Can't parse directive »#{di.join(" ")}«"
+        next
+      end
+      if from
+        from = from.map do |name|
+          name.chomp!(",")
+          if IDENTIFIER_RE === name
+            name
+          else
+            warn "*** invalid identifier #{name.inspect} ignored in »#{di.join(' ')}«"
+            nil
           end
-        end
-        unless io
-          warn "** include file #{fn} not found in #{CDDL::cddl_include_path.map(&:to_s)}"
-          next
-        end
+        end.compact
+      end
+      puts "FROM #{from.inspect}" if $options.verbose
+      puts "PREFERRED_TAG #{preferred_tag.inspect}" if $options.verbose
+      puts "DOCREF #{docref.inspect}" if $options.verbose
 
-        include_file = io.read
-        included_cddl = CDDL.from_cddl(include_file)
-        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
+      fn = docref.downcase << ".cddl"
+      io = CDDL.read_from_include_path(fn)
+      unless io
+        warn "** #{dir} file #{fn} not found in #{CDDL::cddl_include_path.map(&:to_s)}"
+        next
+      end
 
-        case dir
-        in "import"
-          warn "** IMPORTING #{fn}" if $options.verbose
-          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
-                warn "IMPORTED #{name} from #{fn}" if $options.verbose
-                got_more = true
-              end
+      include_file = io.read
+      included_cddl = CDDL.from_cddl(include_file)
+      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 #{from && from.join(", ") << " from "}#{fn}" if $options.verbose
+
+        must_be_found = false
+        to_be_imported = if from
+                           if preferred_tag
+                             from.map{ |k|
+                               if k =~ /\A#{preferred_tag}[.]/
+                                 k
+                               elsif nn = name_rename[k]
+                                 if old = store_rule(k, v = ["name", nn])
+                                   warn "*** autogenerated rule #{k} = #{v} would overwrite #{old}"
+                                 end
+                                 nn
+                               else
+                                 warn_error "*** imported rule #{k.inspect} not in #{fn}"
+                               end
+                             }.compact
+                           else
+                             must_be_found = true
+                             from
+                           end
+                         else
+                           cddl_undefined
+                         end
+        loop do
+          # p to_be_imported
+          got_more = false
+          to_be_imported.each do |name|
+            if rule = included_cddl.rules[name]
+              rules[name] = rule
+              warn "IMPORTED #{name} from #{fn}" if $options.verbose
+              got_more = true
+            elsif must_be_found
+              warn_error "*** imported rule #{name.inspect} not in #{fn}"
             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
+          break unless got_more
+          to_be_imported = cddl_undefined # XXX square...
+          must_be_found = false
+        end
+        if preferred_tag
+          to_be_imported.each do |name|
+            warn "** Warning: undefined reference #{name} without namespace prefix is defined in namespaced imported module #{fn}" if name_rename[name]
+            ### instead just add rule...
           end
-        in "include"
-          warn "** INCLUDING #{fn}" if $options.verbose
-          included_cddl.rules.each do |k, v|
-            if old = ret.rules[k]
-              if old != v
-                warn "** included rule #{k} = #{v} would overwrite #{old}"
-              end
-            else
-              ret.rules[k] = v
-            end
+        end
+      in "include"
+        if from
+          from = Set[*from]
+        end
+        warn "** INCLUDING #{from && from.join(", ") << " from "}#{fn}" if $options.verbose
+        included_cddl.rules.each do |k, v|
+          if from
+            next unless from.include?(k)
+            from.delete(k)
           end
+          if old = store_rule(k, v)
+            warn "*** included rule #{k} = #{v} would overwrite #{old}"
+          end
+        end
+        if from && !from.empty?
+          warn "*** could not find #{from.join(", ")} in #{fn}"
         end
       end
     end
-    ret
+  end
+
+  def store_rule(k, v)
+    if old = rules[k]
+      if old != v
+        return old              # error
+      end
+    else
+      rules[k] = v
+    end
+    nil                         # OK
+  end
+
+  def warn_error(s)
+    warn s
+    @error = true
   end
 
   attr_accessor :ast, :tree, :directives

data/lib/parser/cddlgrammar.rb

@@ -69,12 +69,7 @@ module CDDLGRAMMAR
           break
         end
       end
-      if s2.empty?
-        @index = i2
-        r2 = nil
-      else
-        r2 = instantiate_node(SyntaxNode,input, i2...index, s2)
-      end
+      r2 = instantiate_node(SyntaxNode,input, i2...index, s2)
       s0 << r2
     end
     if s0.last

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cddlc
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Carsten Bormann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-06 00:00:00.000000000 Z
+date: 2023-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,30 +42,30 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: neatjson
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.10'
 description: cddlc implements converters and miscellaneous tools for CDDL, RFC 8610
 email: cabo@tzi.org
 executables:
@@ -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