tla-sbuilder 0.3.4 → 0.3.7

data/lib/sbuilder/default-sbuilder.yaml

@@ -190,13 +190,24 @@ generate:
                modelData: none
 
        # ----------------------------------------
-       # Default setup.cfg
+       # interfaces.rb - reverse map interfaces
        #
-       #  Override template extension points
-       #  - extend_invariant.cfg
 
 
-       - output: tla/setup.cfg
+       - output: tla/interfaces.yaml
+         inputs: 
+             - desc: Model interfaces
+               template: interfaces/interface_mapper.mustache
+               modelData: interfaces
+
+
+       # ----------------------------------------
+       # Default config.cfg: 
+       #
+       #  Override template extension points
+       #  - extend_invariant.cfg
+               
+       - output: tla/config.cfg
          inputs: 
 
              - desc: Configuration module header
@@ -245,32 +256,31 @@ generate:
 
 
        # ----------------------------------------
-       # Default setup.tla
-       #
-       #  Override template extension points
+       # config.tla: define setup configuration, extend model
+       # 
        
                
-       - output: tla/setup.tla
+       - output: tla/config.tla
          inputs: 
 
              - desc: Start of module
-               template: setup/module_header.mustache
+               template: config/module_header.mustache
                modelData: none
 
              - desc: Implemenation for environment execution operators
-               template: setup/operator_run.mustache
+               template: config/operator_run.mustache
                modelData: none
 
              - desc: Implemenation for environment time tick operator
-               template: setup/operator_tick.mustache
+               template: config/operator_tick.mustache
                modelData: none
-
+               
              - desc: Setup domain values
-               template: setup/domains_run.mustache
+               template: config/domains_run.mustache
                modelData: domains
 
              - desc: Activate assumptions on setup
-               template: setup/assumptions_activate.mustache
+               template: config/assumptions_activate.mustache
                modelData: assumptions
                
 
@@ -279,14 +289,43 @@ generate:
              #   modelData: interfaces
 
              - desc: Setup environment execution steps
-               template: setup/steps_run.mustache
+               template: config/steps_run.mustache
                modelData: steps
 
              - desc: End of of module
-               template: setup/module_footer.mustache
+               template: config/module_footer.mustache
                modelData: none
 
 
+       # ----------------------------------------
+       # setup.tla: model checking for Correctness 
+       # 
+               
+       - output: tla/setup.tla
+         inputs: 
+             - desc: Start of module
+               template: setup/module_header.mustache
+               modelData: none
+
+             - desc: Specification constans assignments
+               template: setup/operator_set_step_input.mustache
+               modelData: none
+               
+             - desc: End of of module
+               template: setup/module_footer.mustache
+               modelData: none
+
+       # ----------------------------------------
+       # setup.cfg: include config.cfg (after generating it)
+       # 
+               
+       - output: tla/setup.cfg
+         inputs: 
+           
+             - desc: Include config.cfg
+               template: inherit/inherit_config.mustache
+               modelData: none
+               
        # ----------------------------------------
        # Dump data-models for template generation
 
@@ -357,11 +396,15 @@ generate:
              - desc: Start of module
                template: possibility/module_header.mustache
                modelData: possibility
-
+               
              - desc: Extension definition
                template: possibility/module_extends.mustache
                modelData: possibility
 
+             - desc: Specification constans assignments
+               template: possibility/operator_set_step_input.mustache
+               modelData: none
+               
              - desc: Define possibility invariant operator
                template: possibility/possibility_definition.mustache
                modelData: possibility
@@ -376,11 +419,12 @@ generate:
          category: possibility
          inputs:
            
-             - desc: Include setup.cfg
-               template: possibility/possility_setup.mustache
-               modelData: possibility
-               templateParameters:
-                    include: tla/setup.cfg
+             - desc: Include config.cfg
+               template: inherit/inherit_config.mustache
+               modelData: none
+               # modelData: possibility
+               # templateParameters:
+               #      include: tla/config.cfg
 
 
              - desc: Activate possibility directive

data/lib/sbuilder/facade/api_loader_facade.rb

@@ -91,7 +91,8 @@ module Sbuilder
     end
 
     ##
-    # Tag all interfaces created using this facadate with property 'infrastructureServices'
+    # Tag all interfaces loaded using this facede with property
+    # 'infrastructureServices'. See attriute {#infrastructureServices}
     #
     # @param [Boolean] infrastructureServices true/false set on all interfaces
     #
@@ -100,7 +101,8 @@ module Sbuilder
     end
 
     ##
-    # Tag all interfaces created using this facadate with property 'interfaceService'
+    # Tag all interfaces loaded using this facadate with property
+    # 'interfaceService'. See attribute {interfaceServices}
     def configureInterfaceService( interfaceServices )
       @interfaceServices = interfaceServices
     end
@@ -235,6 +237,13 @@ module Sbuilder
     # Create new interface paramtereter set (and a response parameter
     # set)
     #
+    # @param optionReturn [Boolean, nil] true allow inteface to return
+    # response, nil uses facade {#infrastructureServices}
+    #
+    # @param optionInterface [Boolean, nil] true generates interface
+    # process for the service, nil uses facade default
+    # {#interfaceServices}
+    #
     # @param [String] path of restfull interface operation
     #
     # @param  [String] op rest operation (get, put, post,...), defaults
@@ -242,13 +251,33 @@ module Sbuilder
     #
     # @return [Sbuilder::ParamSet_If] New interface param set createds
     # for request. Use #response to access response object.
-    def newInterface( path, op  )
-      interfaceParamSet = newParamset( path, op )
+    def newInterface( path, op, optionReturn=nil, optionInterface=nil  )
+      @logger.info "#{__method__}: path=#{path}, op=#{op}, optionReturn=#{optionReturn},  optionInterface=#{optionInterface}"
+
+      interfaceParamSet = newParamset( path, op, optionReturn,  optionInterface )
       paramSetResponse = newParamset( path )
       interfaceParamSet.setResponse( paramSetResponse )
       return interfaceParamSet
     end
 
+
+    # Implementation delegates 'setSourceLink' to 'paramSet'
+    #
+    # @param paramSet [Sbuilder::ParamSet] parameset where to set the link to
+    #
+    # @param sourceModule [String] pointer to module defining
+    # parameter set
+    #
+    # @param sourceLine [int] sourceLine line number in {#sourceModule}
+    #
+    # @param sourceColumn [int] source column number {#sourceModule}
+    
+    def setSourceLink(paramSet, sourceModule, sourceLine, sourceColumn=0)
+      @logger.info "#{__method__}: paramSet=#{paramSet}, sourceModule=#{sourceModule}, sourceLine=#{sourceLine}"
+      paramSet.setSourceLink(sourceModule, sourceLine, sourceColumn)
+    end
+
+
     # Cretate new pojo for a simple paramter
     # @param  [String] name of the simple paramter to create
     # @param  [Boolean] isArray true if array
@@ -392,15 +421,22 @@ module Sbuilder
 
     private
 
-    # @return [Sbuilder::ParamSet_If] New interface param set created    
-    def newParamset( path, op ='response' )
+    # @param optionReturn [Boolean, nil] true generates
+    # response
+    #
+    # @param optionInterface [Boolean, nil] true generates interface
+    # process for the service
+    #
+    # @return [Sbuilder::ParamSet_If] New interface param set created
+    def newParamset( path, op ='response', optionReturn=nil, optionInterface=nil )
       interfaceParamSet =  createParamSet( Sbuilder::Constants::INTERFACE_OPERATION )
       interfaceParamSet.setIdentity( path, op )
-      # infrastructureService (capability to return response), and
-      # infrastructureService (interface process) use values set using
-      # configure* -methods
-      interfaceParamSet.setInfrastructureService( infrastructureServices )
-      interfaceParamSet.setInterfaceService( interfaceServices )      
+      
+      # infrastructureService (capability to return response)
+      interfaceParamSet.setInfrastructureService( optionReturn.nil? ? infrastructureServices : optionReturn  )
+      # setInterfaceService (interface process) 
+      interfaceParamSet.setInterfaceService( optionInterface.nil? ? interfaceServices :  optionInterface )
+      
       return interfaceParamSet
     end
 

data/lib/sbuilder/facade/facade_constants.rb

@@ -14,10 +14,36 @@ module Sbuilder
     META_MODEL_FRAMEWORK_SVC="framework-svc"
     META_MODEL_INVARIANT='invariants'
 
+    # Create template string, which invokes lambda to returns domain
+    # of 'field' in parameter set 'definition'.
+    def self.snippetFacadeParamsetDomain( definition, field ) 
+      "{{#PARAM_SET_FIELD_DOMAIN}}#{definition}.#{field}{{/PARAM_SET_FIELD_DOMAIN}}"
+    end
+    
+    # Create template string, which invokes lambda to return init
+    # value from domain for the 'field' in parameter set 'definition'.
+    def self.snippetFacadeParamsetDomainInit( definition, field ) 
+      "{{#PARAM_SET_FIELD_DOMAIN_INIT}}#{definition}.#{field}{{/PARAM_SET_FIELD_DOMAIN_INIT}}"
+    end
+
+    # Create template string, which invokes lambda to return init
+    # value from domain for the 'field' in RESPONSE parameter set
+    # 'definition' (of type interface)
+    def self.snippetFacadeResponseDomainInit( definition, field ) 
+      "{{#RESPONSE_SET_FIELD_DOMAIN_INIT}}#{definition}.#{field}{{/RESPONSE_SET_FIELD_DOMAIN_INIT}}"
+    end
+
+
+    # Non-existing value (initial value if domain.includeNil)
+    NIL = "Nil"
+    DOMAIN_BOOLEAN = "BOOLEAN"
+
   end
 
   class Facade
     include Sbuilder::FacadeConstants
+
+    
   end
 
 end

data/lib/sbuilder/facade/loader_plugin_root.rb

@@ -40,7 +40,10 @@ module Sbuilder
     def self.validateProperties( hash, required_props, allowed_props )
       Sbuilder::Utils::Validate.validateProperties( hash, required_props, allowed_props )      
     end
-    
+
+    def self.baseMetatypes
+      Sbuilder::Controller.baseMetatypes
+    end
 
     def validateProperties( hash, required_props, allowed_props )
       self.class.validateProperties( hash, required_props, allowed_props )      

data/lib/sbuilder/facade/param_set_root.rb

@@ -9,6 +9,15 @@ module Sbuilder
 
   class ParamSetRoot
 
+    # @# @!attribute [String] sourceModule pointer to to source module
+    # where defined
+    attr_accessor :sourceModule
+
+    # @# @!attribute [int] sourceLine  line number inf {#sourceModule}
+    attr_accessor :sourceLine
+
+    # @# @!attribute [int] sourceColumn  
+    attr_accessor :sourceColumn
     
     attr_reader :parameters                   # array of parameters:Parameter
 
@@ -21,7 +30,25 @@ module Sbuilder
       @parameters = []
     end
 
-    # @!endgroup    
+    # @!endgroup
+
+    # ------------------------------------------------------------------
+    # @!group Static services
+
+    def self.id2name(id)
+      id.
+        gsub( /\//, "_" ).   # / --> _
+        gsub( /\(/, "_" ).   # ( --> _
+        gsub( /\{/, "_" ).   # { --> _
+        gsub( /\}/, "_" ).   # } --> _
+        gsub( /\./, "_" ).   # . --> _              
+        gsub( /\)/, "_" )    # ) --> _
+      
+    end
+    
+
+    # @!endgroup
+
 
     # ------------------------------------------------------------------
     # @!group Configure Model Object Relationships
@@ -34,6 +61,16 @@ module Sbuilder
       self
     end
 
+    # @param sourceModule [String] pointer to module defining
+    # parameter set
+    #
+    # @param sourceLine [int] sourceLine line number in {#sourceModule}
+    def setSourceLink(sourceModule, sourceLine, sourceColumn)
+      self.sourceModule = sourceModule
+      self.sourceLine = sourceLine
+      self.sourceColumn = sourceColumn
+    end
+
     # @param [String] name to look
     #
     # @return [Sbuilder::Parameter|nil] return parameter with name, nil if not found

data/lib/sbuilder/facade/snippet_loader_facade.rb

@@ -235,9 +235,8 @@ module Sbuilder
       # enable mapping from 'metatype/appName' to 'specName'
       addSymbol( metatype, appName, entry['specName'] )
 
-      # TLA code generated for interface defition need to entry point
-      # to model implementation defined using
-      # META_MODEL_SERVICE_IMPLEMENTATION -metatype
+      # Snippet entry defines behavior for an interface implementation
+      # or complelation?
       if ( metatype == Sbuilder::Constants::META_MODEL_SERVICE_IMPLEMENTATION ) then
         interfaceExtension(  appName, entry['specName'], 'implementation' )
       elsif metatype == Sbuilder::Constants::META_MODEL_SERVICE_COMPLETION
@@ -289,7 +288,10 @@ module Sbuilder
         
         # snippet loader can process only one snippet at a time
         raise Sbuilder::FacadeException.new  <<-EOS if snippets.length > 1
-        Too many snippets defined in an entry
+        Too many snippets defined in an entry:
+
+        #{snippetCode}
+
         EOS
 
         # extract name && type of the snippet from the parsed result
@@ -329,13 +331,93 @@ module Sbuilder
     # @option snippetEntry [String] metatype
     # @option snippetEntry [String] appName
     # @option snippetEntry [String] specName    
-    private def initialReaderData( snippetEntry )
+    private def initialReaderData( mustache, snippetEntry )
+      snippetEntry
+
+      # Template function, which returns domain of 'field' from 'paramSet'
+      # Template cal
+      snippetEntry['PARAM_SET_FIELD_DOMAIN'] = lambda do |accesKey|
+        
+        key = mustache.render( accesKey, snippetEntry )
+        keys = key.split( '.' )
+        begin
+          return key if ( keys.length == 1 ) # just a name
+          paramSet = controller.model.getParamset( keys[0] )
+          parameter = paramSet.locateParameter( keys[1] )
+          domain = parameter.getType
+          ret = domain
+        rescue Exception => ee
+          msg =<<-EOS
+              Error 
+
+                   #{ee} 
+              when accessing model domain with key #{accesKey}
+          
+              EOS
+          @logger.error( "#{__method__} #{msg}" )        
+          raise ControllerException.new,  msg, ee.backtrace
+        end
+        ret
+      end # PARAM_SET_FIELD_DOMAIN
+
+      
+      # Template function, which returns init value for domain of
+      # 'field' from 'paramSet' Template cal
+      snippetEntry['PARAM_SET_FIELD_DOMAIN_INIT'] = lambda do |paramSet_paramName|
+        getDomainInitEntry( paramSet_paramName, false, snippetEntry, mustache )
+      end # PARAM_SET_FIELD_DOMAIN
+      
+      snippetEntry['RESPONSE_SET_FIELD_DOMAIN_INIT'] = lambda do |paramSet_paramName|
+        
+        getDomainInitEntry( paramSet_paramName, true, snippetEntry, mustache )
+        
+      end # PARAM_SET_FIELD_DOMAIN
+
       snippetEntry
     end
 
 
-    
-    private def initRenderData
+    # @return [DomainEntry,NIL] initial value in domain of the
+    # (inResponse?) field pointed by 'mustache' rendering
+    # 'paramSet_paramName' in 'snippetEntry' data context.
+    #
+    private def getDomainInitEntry(paramSet_paramName, inResponse, snippetEntry, mustache )
+
+        key = mustache.render( paramSet_paramName, snippetEntry )
+        keys = key.split( '.' )
+        begin
+          raise "Expecting string 'paramset.parameter' in #{key} rendered for #{paramSet_paramName}" if ( keys.length != 2 ) # just a name
+          paramSet = controller.model.getParamset( keys[0] )
+          
+          # dig deeper - for interfaces response parameter set
+          paramSet = paramSet.response if inResponse
+
+          # Access named parameter in 'paramSet'
+          parameter = paramSet.locateParameter( keys[1] )
+          raise "Implementation missing for reference paramSet_paramName=#{paramSet_paramName} paramter=#{parameter}" if parameter.isReference
+          domain = parameter.resolvedDomain
+          raise "Domain '#{parameter.domain}' was not resolved paramSet_paramName=#{paramSet_paramName} parameter=#{parameter}" if domain.nil?
+          # return Nil if Nil valid, 0 (or range min/smallest element)
+          @logger.debug "#{__method__}: domain=#{domain}, domain.includeNil=#{domain.includeNil}, domain.extension=#{domain.extension}" if @logger.debug?
+          if domain.includeNil
+            ret = FacadeConstants::NIL
+          else
+            ret = domain.domain_entry( 0 )
+          end
+          @logger.info "#{__method__}: domain=#{domain}, domain.includeNil=#{domain.includeNil}, domain init value==#{ret}"          
+        rescue Exception => ee
+          msg =<<-EOS
+              Error 
+
+                   #{ee} 
+              when accessing model domain with key #{paramSet_paramName}
+          
+              EOS
+          @logger.error( "#{__method__} #{msg}" )        
+          raise ControllerException.new,  msg, ee.backtrace
+        end
+        ret
+      
       
     end
 
@@ -495,7 +577,7 @@ module Sbuilder
           @logger.debug "#{__method__}: snippetEntry['snippetBody']=#{snippetEntry['snippetBody']}" if @logger.debug?
 
           # create initial hash
-          renderData = initialReaderData( snippetEntry )
+          renderData = initialReaderData( mustache, snippetEntry )
           
           # add functions to renderData allowing access to symbol_table
           # (SPEC_NAME)