retro_idl 0.0.1

data/ext/retro_idl/asn/ext_parser/parser.h

@@ -0,0 +1,175 @@
+/* A Bison parser, made by GNU Bison 3.0.2.  */
+
+/* Bison interface for Yacc-like parsers in C
+
+   Copyright (C) 1984, 1989-1990, 2000-2013 Free Software Foundation, Inc.
+
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+/* As a special exception, you may create a larger work that contains
+   part or all of the Bison parser skeleton and distribute that work
+   under terms of your choice, so long as that work isn't itself a
+   parser generator using the skeleton or a modified version thereof
+   as a parser skeleton.  Alternatively, if you modify or redistribute
+   the parser skeleton itself, you may (at your option) remove this
+   special exception, which will cause the skeleton and the resulting
+   Bison output files to be licensed under the GNU General Public
+   License without this special exception.
+
+   This special exception was added by the Free Software Foundation in
+   version 2.2 of Bison.  */
+
+#ifndef YY_YY_EXT_RETRO_IDL_ASN_EXT_PARSER_PARSER_H_INCLUDED
+# define YY_YY_EXT_RETRO_IDL_ASN_EXT_PARSER_PARSER_H_INCLUDED
+/* Debug traces.  */
+#ifndef YYDEBUG
+# define YYDEBUG 0
+#endif
+#if YYDEBUG
+extern int yydebug;
+#endif
+
+/* Token type.  */
+#ifndef YYTOKENTYPE
+# define YYTOKENTYPE
+  enum yytokentype
+  {
+    TOK_EXCEPT = 258,
+    TOK_CARET = 259,
+    TOK_INTERSECTION = 260,
+    TOK_PIPE = 261,
+    TOK_UNION = 262,
+    TOK_ENDL = 263,
+    TOK_LVERSION = 264,
+    TOK_ASSIGN = 265,
+    TOK_RANGE = 266,
+    TOK_ELLIPSES = 267,
+    TOK_EXCLAIM = 268,
+    TOK_OCTET = 269,
+    TOK_CHARACTER = 270,
+    TOK_BIT = 271,
+    TOK_STRING = 272,
+    TOK_SIZE = 273,
+    TOK_CHOICE = 274,
+    TOK_SEQUENCE = 275,
+    TOK_SET = 276,
+    TOK_OF = 277,
+    TOK_ALL = 278,
+    TOK_MIN = 279,
+    TOK_MAX = 280,
+    TOK_COMPONENTS = 281,
+    TOK_COMPONENT = 282,
+    TOK_ABSENT = 283,
+    TOK_CONTAINING = 284,
+    TOK_FROM = 285,
+    TOK_INCLUDES = 286,
+    TOK_SETTINGS = 287,
+    TOK_PRESENT = 288,
+    TOK_PATTERN = 289,
+    TOK_WITH = 290,
+    TOK_OPTIONAL = 291,
+    TOK_DEFAULT = 292,
+    TOK_IMPLICIT = 293,
+    TOK_EXPLICIT = 294,
+    TOK_APPLICATION = 295,
+    TOK_PRIVATE = 296,
+    TOK_UNIVERSAL = 297,
+    TOK_CHAR = 298,
+    TOK_BOOLEAN = 299,
+    TOK_INTEGER = 300,
+    TOK_REAL = 301,
+    TOK_ENUMERATED = 302,
+    TOK_BMPString = 303,
+    TOK_GeneralString = 304,
+    TOK_GraphicString = 305,
+    TOK_IA5String = 306,
+    TOK_ISO646String = 307,
+    TOK_NumericString = 308,
+    TOK_PrintableString = 309,
+    TOK_TeletexString = 310,
+    TOK_T61String = 311,
+    TOK_UniversalString = 312,
+    TOK_UTF8String = 313,
+    TOK_VideotexString = 314,
+    TOK_VisibleString = 315,
+    TOK_DATE = 316,
+    TOK_DATE_TIME = 317,
+    TOK_DURATION = 318,
+    TOK_EMBEDDED = 319,
+    TOK_PDV = 320,
+    TOK_EXTERNAL = 321,
+    TOK_RELATIVE_OID_IRI = 322,
+    TOK_OBJECT = 323,
+    TOK_IDENTIFIER = 324,
+    TOK_RELATIVE_IRI = 325,
+    TOK_RELATIVE_OID = 326,
+    TOK_TIME = 327,
+    TOK_TIME_OF_DAY = 328,
+    TOK_POSINT = 329,
+    TOK_NEGINT = 330,
+    TOK_HEXINT = 331,
+    TOK_ID = 332,
+    TOK_RVERSION = 333,
+    TOK_PLUS_INFINITY = 334,
+    TOK_MINUS_INFINITY = 335,
+    TOK_NOT_A_NUMBER = 336,
+    TOK_TRUE = 337,
+    TOK_FALSE = 338,
+    TOK_NULL = 339,
+    TOK_CONTAINS = 340,
+    TOK_POSREAL = 341,
+    TOK_NEGREAL = 342,
+    TOK_HSTRING = 343,
+    TOK_BSTRING = 344,
+    TOK_CSTRING = 345,
+    TOK_DEFINITIONS = 346,
+    TOK_BEGIN = 347,
+    TOK_END = 348,
+    TOK_TAGS = 349,
+    TOK_INSTRUCTIONS = 350,
+    TOK_EXPORTS = 351,
+    TOK_IMPORTS = 352,
+    TOK_EXTENSIBILITY = 353,
+    TOK_IMPLIED = 354,
+    TOK_AUTOMATIC = 355,
+    TOK_TYPEREF = 356
+  };
+#endif
+
+/* Value type.  */
+#if ! defined YYSTYPE && ! defined YYSTYPE_IS_DECLARED
+typedef VALUE YYSTYPE;
+# define YYSTYPE_IS_TRIVIAL 1
+# define YYSTYPE_IS_DECLARED 1
+#endif
+
+/* Location type.  */
+#if ! defined YYLTYPE && ! defined YYLTYPE_IS_DECLARED
+typedef struct YYLTYPE YYLTYPE;
+struct YYLTYPE
+{
+  int first_line;
+  int first_column;
+  int last_line;
+  int last_column;
+};
+# define YYLTYPE_IS_DECLARED 1
+# define YYLTYPE_IS_TRIVIAL 1
+#endif
+
+
+
+int yyparse (yyscan_t scanner, VALUE filename, VALUE *tree);
+
+#endif /* !YY_YY_EXT_RETRO_IDL_ASN_EXT_PARSER_PARSER_H_INCLUDED  */

data/lib/retro_idl/asn/alternative_type.rb

@@ -0,0 +1,43 @@
+# 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.
+
+class RetroIDL::ASN::AlternativeType
+
+    def initialize(**opts)
+
+        @type = RetroIDL::ASN.const_get(opts[:class]).new(**opts)
+        @parent = parent
+
+    end
+
+    def link(mod, stack)
+
+        @type.link(mod, stack)
+
+    end
+
+    # @macro common_to_s
+    def to_s
+
+        @type.to_s
+
+    end
+
+end
+

data/lib/retro_idl/asn/asn.rb

@@ -0,0 +1,309 @@
+# 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 RetroIDL
+
+    # Module containing the ASN syntax to Ruby parser
+    module ASN
+
+        # @!macro [new] common_evaluate
+        #   
+        #   evaluate a native Ruby value against a type definition
+        #   
+        #   @note may be called before linking but will raise exception if references to not resolve
+        #   
+        #   @param value [String, Numeric] value to test against type definition
+        #   
+        #   @return [TrueClass] value fits type definition
+        #   @return [FalseClass] value does not fit type definition
+        #   
+        #   @raise [ASNError] cannot evaluate against unresolved references
+        #
+
+        # @!macro [new] common_link
+        #
+        #   resolve symbols to definitions in module
+        #
+        #   @param mod [MODULE] module this type belongs to
+        #   @param stack [Array] objects called before this object for depth first search of recursion
+        #
+        #   @return [MODULE] object has been linked
+        #   @return [nil] object has not been linked
+        #
+
+        # @!macro [new] common_to_s
+        #
+        #   Convert object to ASN.1 syntax representation
+        #
+        #   @return [String] ASN.1 syntax representation
+        #
+        #   @raise [ASNError]
+        #
+
+        LINK_ERROR = "object must be linked"
+        SYMBOL_UNDEFINED_ERROR = "symbol is undefined"
+
+        # Reserved Words
+        #
+        # X.680 section 12.38 
+        RESERVED_CHARACTER_SEQUENCE = [
+            "ABSENT".freeze,
+            "ENCODED".freeze,
+            "INTERSECTION".freeze,
+            "SEQUENCE".freeze,
+            "ABSTRACT-SYNTAX".freeze,
+            "ENCODING-CONTROL".freeze,
+            "ISO646String".freeze,
+            "SET".freeze,
+            "ALL".freeze,
+            "END".freeze,
+            "MAX".freeze,
+            "SETTINGS".freeze,
+            "APPLICATION".freeze,
+            "ENUMERATED".freeze,
+            "MIN".freeze,
+            "SIZE".freeze,
+            "AUTOMATIC".freeze,
+            "EXCEPT".freeze,
+            "MINUS-INFINITY".freeze,
+            "STRING".freeze,
+            "BEGIN".freeze,
+            "EXPLICIT".freeze,
+            "NOT-A-NUMBER".freeze,
+            "SYNTAX".freeze,
+            "BIT".freeze,
+            "EXPORTS".freeze,
+            "NULL".freeze,
+            "T61String".freeze,
+            "BMPString".freeze,
+            "EXTENSIBILITY".freeze,
+            "NumericString".freeze,
+            "TAGS".freeze,
+            "BOOLEAN".freeze,
+            "EXTERNAL".freeze,
+            "OBJECT".freeze,
+            "TeletexString".freeze,
+            "BY".freeze,
+            "FALSE".freeze,
+            "ObjectDescriptor".freeze,
+            "TIME".freeze,
+            "CHARACTER".freeze,
+            "FROM".freeze,
+            "OCTET".freeze,
+            "TIME-OF-DAY".freeze,
+            "CHOICE".freeze,
+            "GeneralizedTime".freeze,
+            "OF".freeze,
+            "TRUE".freeze,
+            "CLASS".freeze,
+            "GeneralString".freeze,
+            "OID-IRI".freeze,
+            "TYPE-IDENTIFIER".freeze,
+            "COMPONENT".freeze,
+            "GraphicString".freeze,
+            "OPTIONAL".freeze,
+            "UNION".freeze,
+            "COMPONENTS".freeze,
+            "IA5String".freeze,
+            "PATTERN".freeze,
+            "UNIQUE".freeze,
+            "CONSTRAINED".freeze,
+            "IDENTIFIER".freeze,
+            "PDV".freeze,
+            "UNIVERSAL".freeze,
+            "CONTAINING".freeze,
+            "IMPLICIT".freeze,
+            "PLUS-INFINITY".freeze,
+            "UniversalString".freeze,
+            "DATE".freeze,
+            "IMPLIED".freeze,
+            "PRESENT".freeze,
+            "UTCTime".freeze,
+            "DATE-TIME".freeze,
+            "IMPORTS".freeze,
+            "PrintableString".freeze,
+            "UTF8String".freeze,
+            "DEFAULT".freeze,
+            "INCLUDES".freeze,
+            "PRIVATE".freeze,
+            "VideotexString".freeze,
+            "DEFINITIONS".freeze,
+            "INSTANCE".freeze,
+            "REAL".freeze,
+            "VisibleString".freeze,
+            "DURATION".freeze,
+            "INSTRUCTIONS".freeze,
+            "RELATIVE-OID".freeze,
+            "WITH".freeze,
+            "EMBEDDED".freeze,
+            "INTEGER".freeze,
+            "RELATIVE-OID-IRI".freeze
+        ]
+
+        # test a typereference string against requirements
+        #
+        # @param location [Hash] location of the typereference
+        # @param typereference [String] typereference string
+        #
+        # @return [TrueClass] typereference meets format requirements
+        # @return [FalseClass] typereference does not meet format requirements 
+        #
+        def self.is_typereference?(location, typereference)
+
+            result = true
+            if typereference[/^[A-Z]/].nil?
+                putError(location, "typereference \"#{typereference}\": The initial character shall be an upper-case letter (12.2.1)")
+                result = false
+            end            
+            if typereference[/--/]
+                putError(location, "typereference \"#{typereference}\": A hyphen shall not be immediately followed by another hyphen (12.2.1)")
+                result = false    
+            end
+            if typereference[/-$/]
+                putError(location, "typereference \"#{typereference}\": A hyphen shall not be the last character (12.2.1)")
+                result = false
+            end
+            if RESERVED_CHARACTER_SEQUENCE.include?(typereference)
+                putError(location, "typereference \"#{typereference}\": A typereference shall not be one of the reserved character sequences listed in 12.38 (12.2.2)")
+                result = false    
+            end
+            return result
+
+        end
+
+        def self.putError(location, message)
+            STDERR.puts "#{location[:fileName]}:#{location[:firstLine]}:#{location[:firstCol]}: error: #{message}"
+        end
+
+        # test an identifier string against requirements
+        #
+        # @param location [Hash] location of the identifier
+        # @param identifier [String] identifier string
+        #
+        # @return [TrueClass] identifier meets format requirements
+        # @return [FalseClass] identifier does not meet format requirements 
+        #
+        def self.is_identifier?(location, identifier)
+            result = true
+            if identifier[/^[a-z]/].nil?
+                putError(location, "identifier \"#{identifier}\": The initial character shall be a lower-case letter (12.4)")
+                result = false
+            end
+            if identifier[/--/]
+                putError(location, "identifier \"#{identifier}\": A hyphen shall not be immediately followed by another hyphen (12.4)")
+                result = false
+            end
+            if identifier[/-$/]
+                putError(location, "identifier \"#{identifier}\": A hyphen shall not be the last character (12.4)")
+                result = false
+            end
+            return result
+        end
+
+        class ASN
+
+            def initialize(input)
+
+                errors = false
+
+                @modules = {}
+                
+                # run the parser to produce the syntax tree
+                tree = RetroIDL::ASN.parseFileBuffer(input)   
+
+                if tree.nil?
+                    raise "tree should not be nil"
+                end
+
+                # initialise the assignments
+                @assignments = {}
+                tree[:assignments].each do |assignment|
+                
+                    if @assignments[assignment[:id]]
+                        ASN.putError(assignment[:location], "duplicate assignment")
+                        errors = true
+                    else
+                        begin
+                            @assignments[assignment[:id]] = RetroIDL::ASN.const_get(assignment[:class]).new(**assignment)                            
+                        rescue ASNError
+                            errors = true        
+                        end
+                    end
+                end
+
+                if errors
+                    raise
+                end
+
+                @assignments.each do |assignment|
+                    assignment.link(self)
+                end
+                
+            end
+
+            # @macro common_to_s
+            def to_s
+
+                result = ""
+
+                @assignments.each do |id, assignment|
+
+                    case assignment.class
+                    when DefinedValue, BuiltinValue
+                        result << "#{id} #{assignment.governor} ::= #{assignment}"
+                    else
+                        result << " #{id} ::= #{assignment}"
+                    end
+
+                end
+
+                result
+
+            end
+
+        end
+
+    end
+
+end
+
+require 'retro_idl/asn/asn_error'
+require 'retro_idl/asn/location'
+require "retro_idl/asn/ext_parser"
+
+require 'retro_idl/asn/tag'
+
+require 'retro_idl/asn/base_type'
+require 'retro_idl/asn/component_type'
+require 'retro_idl/asn/type_list'
+require 'retro_idl/asn/alternative_type'
+require 'retro_idl/asn/value_list'
+require 'retro_idl/asn/named_number'
+require 'retro_idl/asn/enumeration_item'
+
+require 'retro_idl/asn/null'
+require 'retro_idl/asn/bitstring'
+require 'retro_idl/asn/octetstring'
+require 'retro_idl/asn/real'
+require 'retro_idl/asn/integer'
+require 'retro_idl/asn/enumerated'
+require 'retro_idl/asn/boolean'
+require 'retro_idl/asn/choice'
+require 'retro_idl/asn/sequence'
+require 'retro_idl/asn/sequenceof'

data/lib/retro_idl/asn/asn_error.rb

@@ -0,0 +1,2 @@
+class RetroIDL::ASN::ASNError < Exception
+end

data/lib/retro_idl/asn/base_type.rb

@@ -0,0 +1,87 @@
+# 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.
+
+class RetroIDL::ASN::BaseType
+
+    attr_reader :id        
+
+    # Common type object initialisation
+    #
+    # @param opts [Hash]
+    #
+    # @option opts [String, NilClass] :id object identifer or type reference (nil for anon objects)
+    # @option opts [Location] :location
+    # @option opts [Hash] :tag
+    #
+    # @raise [ASNError]
+    #
+    def initialize(**opts)
+
+        @mod = nil
+        @tag = nil
+        @parent = parent
+        @id = opts[:id]
+        @location = opts[:location]
+        @constraint = nil
+
+        if opts[:tag]
+            @tag = Tag.new(**opts[:tag])
+        end                
+        if opts[:constraint]
+            @constraint = Constraint.new(self, **opts[:constraint])
+        end
+
+    end
+    
+    # @macro common_link
+    def link(mod, stack)
+
+        if @mod.nil? or @mod != mod
+
+            @mod = nil
+            
+            if @tag.nil? or @tag.link(mod, [])
+
+                @mod = mod
+                stack.push self
+                @mod.setBranch stack
+
+            end
+
+        else
+
+            @mod
+
+        end
+
+    end
+
+    def self.===(otherClass)
+
+        if self == otherClass
+            true
+        else
+            false
+        end
+
+    end
+
+
+
+end

data/lib/retro_idl/asn/base_value.rb

@@ -0,0 +1,75 @@
+# 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.
+
+# methods and attributes common to ASN.1 values
+class RetroIDL::ASN::BaseValue
+
+    def initialize(**opts)            
+        @value = opts[:value]                
+    end
+
+    attr_reader :governor
+
+    # @return [String, NilClass] identifier
+    attr_reader :id
+    
+    # @macro common_link
+    def link(mod, stack)
+
+        if @mod.nil? or @mod != mod
+
+            @mod = nil
+
+            if @governor.link(mod, stack.push(self))
+
+                if @governor.evaluate(value)
+
+                    @mod = mod
+
+                else
+
+                    ASN.putError(@location, "evaluate didn't work")
+                    
+                end
+
+            end
+
+        else
+
+            @mod
+
+        end
+        
+    end
+
+    def self.===(otherClass)
+
+        if self == otherClass
+
+            true
+
+        else
+
+            false
+
+        end
+
+    end
+
+end