tla-sbuilder 0.1.0

data/lib/sbuilder/default-sbuilder.yaml

@@ -0,0 +1,372 @@
+
+# ------------------------------------------------------------------
+# default generation configs, with template extension points
+
+generate:
+
+       # ----------------------------------------
+       # Default model.tla.
+       # 
+       #  Override template extension points
+       # - extend_const.tla
+       # - extend_state.tla
+       # - extend_operations.tla
+       # - extend_macros.tla
+       # - extend_implementation.tla
+       # - extend_invariant.tla
+       # - extend_assumptions.tla
+       
+       
+
+       - output: tla/model.tla
+         inputs: 
+
+             - desc: Hader for tla module
+               template: tla/module_header.mustache
+               modelData: none
+
+             - desc: Constants for environment model
+               template: tla/const_run.mustache
+               modelData: none
+
+             - desc: Constants for specification 
+               template: tla/const_def.mustache
+               modelData: none
+               
+               # --------------------
+               # extension point: extend_const.tla
+             - desc: Extension point for constants
+               template: extend/extend_const.mustache
+               modelData: none
+
+             - desc: Domain definitions
+               template: domains.mustache
+               modelData: domains
+
+             - desc: Environment operators 
+               template: tla/operator_run.mustache
+               modelData: none
+
+             - desc: Initial value for infrastructure service responses
+               template: infrastructure-service-init.mustache
+               modelData: infrastructureServices
+
+             - desc: Data type definitions
+               template: definition_types.mustache
+               modelData: definitions
+
+             - desc: Interface types 
+               template: interface_types.mustache
+               modelData: interfaces
+
+             - desc: Start of plc block
+               template: tla/plc_header.mustache
+               modelData: none
+
+             - desc: State environment model
+               template: tla/plc_run_state.mustache
+               modelData: none
+
+             - desc: Variables used by infrastructure-services
+               template: infrastructure-service-variables.mustache
+               modelData: none
+               
+
+               # --------------------
+               # extension point: extend_state.tla
+               
+             - desc: Extension point for specification state
+               template: extend/extend_state.mustache
+               modelData: none
+
+             - desc: Specification state
+               template: state_variables.mustache
+               modelData: variables
+
+             - desc: Start of plc define block
+               template: tla/plc_define_header.mustache
+               modelData: none
+
+             - desc: Environment execution operators
+               template: tla/plc_define_run.mustache
+               modelData: none
+
+             - desc: Operators for infrastrcuture service (generated)
+               template: operator-infrastructure-service.mustache
+               modelData: infrastructureServices
+               
+               
+             - desc: Operators supporting infrastructure services
+               template: tla/operators-infrastructure-service.mustache
+               modelData: none
+               
+               # --------------------
+               # extension point: extend_operations.tla
+
+             - desc: Extension point for operations 
+               template: extend/extend_operations.mustache
+               modelData: none
+
+             - desc: End of plc define block
+               template: tla/plc_define_footer.mustache
+               modelData: none
+
+             - desc: Environment execution macros (state change)
+               template: tla/macro_run.mustache
+               modelData: none
+
+             - desc: Macros for infrastructure services
+               template: tla/macro-infrastructure-service.mustache
+               modelData: none
+
+               # --------------------
+               # extension point: extend_macros.tla
+               
+             - desc: Extension poin to add macros
+               template: extend/extend_macros.mustache
+               modelData: none
+
+             - desc: Create a dummy procedure to have 'defaultInitValue' in the model
+               template: interface_stubs_dummy.mustache
+               modelData: none
+               
+               # --------------------
+               # extension point: extend_implementation.tla
+               
+             - desc: Extension point for implementation
+               template: extend/extend_implementation.mustache
+               modelData: none
+
+             - desc: Process interfaces
+               template: interface_processes.mustache
+               modelData: interfaces
+
+             - desc: Environment model 'Tail' process
+               template: tla/plc_tail.mustache
+               modelData: none
+
+             - desc: End of plc block
+               template: tla/plc_footer.mustache
+               modelData: none
+
+             - desc: Plc translation section
+               template: tla/plc_translation.mustache
+               modelData: none
+
+             - desc: Type constraint in specification
+               template: state_type_invariant.mustache
+               modelData: variables
+               
+               # --------------------
+               # extension point: extend_type_invariant.tla
+
+               # - desc: Extension point for  type invariants
+               #   template: extend/extend_type_invariant.tla
+               #   modelData: none
+
+             - desc: Validate types for infrastructure service return values
+               template: state_type_invariant-infrastructure-service.mustache
+               modelData: infrastructureServices
+               
+
+               # --------------------
+               # extension point: extend_invariant.tla
+
+             - desc: Extension point for specification invariants
+               template: extend/extend_invariant.mustache
+               modelData: none
+
+               # --------------------
+               # extension point: extend_assumptions.tla
+             - desc: Extension point for assumptions
+               template: extend/extend_assumptions.mustache
+               modelData: none
+
+             - desc: module_footer.tla
+               template: tla/module_footer.mustache
+               modelData: none
+
+       # ----------------------------------------
+       # Default setup.cfg
+       #
+       #  Override template extension points
+       #  - extend_invariant.cfg
+
+
+       - output: tla/setup.cfg
+         inputs: 
+
+             - desc: Configuration module header
+               template: cfg/module_header.mustache
+               modelData: none
+
+             - desc: Environment execution step assignments
+               template: cfg/const_run.mustache
+               modelData: none
+
+             - desc: Environment execution macro assignments
+               template: cfg/macro_run.mustache
+               modelData: none
+
+             - desc: Specification constans assignments
+               template: cfg/const_def.mustache
+               modelData: none
+
+
+             # - desc: processes stubs in specification
+             #   template: interface_stubs.mustache
+             #   modelData: interfaces
+
+
+             - desc: Configure specification domains
+               template: domains_assign.mustache
+               modelData: domains
+
+             - desc: Activate specification invariants
+               template: state_type_invariant_cfg.mustache
+               modelData: variables
+
+             - desc: Activate type invariants for infrastrcuture services
+               template: cfg/invariant-infrastructure-service.mustache
+               modelData: none
+
+
+               # --------------------
+               # extension point: extend_type_invariant.cfg
+               # - desc: Extesion pointo to activate type constraints
+               #   template: extend/extend_type_invariant.cfg
+               #   modelData: none
+
+               # --------------------
+               # extension point: extend_invariant.cfg
+               
+             - desc: Extension pointo to activate specification invariants
+               template: extend/extend_invariant_cfg.mustache
+               modelData: none
+
+             - desc: End of module
+               template: cfg/module_footer.mustache
+               modelData: none
+
+
+       # ----------------------------------------
+       # Default setup.tla
+       #
+       #  Override template extension points
+       
+               
+       - output: tla/setup.tla
+         inputs: 
+
+             - desc: Start of module
+               template: setup/module_header.mustache
+               modelData: none
+
+             - desc: Implemenation for environment execution operators
+               template: setup/operator_run.mustache
+               modelData: none
+
+             - desc: Implemenation for environment time tick operator
+               template: setup/operator_tick.mustache
+               modelData: none
+
+             - desc: Setup domain values
+               template: domains_run.mustache
+               modelData: domains
+
+             # - desc: interface calls in setup
+             #   template: interface_steps.mustache
+             #   modelData: interfaces
+
+             - desc: Setup environment execution steps
+               template: setup/steps_run.mustache
+               modelData: steps
+
+             - desc: End of of module
+               template: setup/module_footer.mustache
+               modelData: none
+
+
+       # ----------------------------------------
+       # Dump data-models for template generation
+
+       - output: doc/data-model.md
+         inputs: 
+
+           - desc: Model header
+             template:  data-model-header.mustache
+             modelData: none
+
+           - desc: Model interfaces
+             template: data-model-dump.mustache
+             modelData: interfaces
+
+           - desc: Model infrastructureServices
+             template: data-model-dump.mustache
+             modelData: infrastructureServices
+
+           - desc: Model definitions
+             template: data-model-dump.mustache
+             modelData: definitions
+
+           - desc: Model domains
+             template: data-model-dump.mustache
+             modelData: domains
+
+           - desc: Model state
+             template: data-model-dump.mustache
+             modelData: variables
+
+           - desc: Model steps
+             template: data-model-dump.mustache
+             modelData: steps
+
+           - desc: Model footer 
+             template: data-model-footer.mustache
+             modelData: none
+
+
+       # ------------------------------------------------------------------
+             
+       # Category possibility: iterate configs per possibility defines
+       # in setup. Generation processes each 'category' separately.
+             
+
+       # output to file evaluated using array 'possibilities' in setup
+       
+       - output: tla/possible_{{possibility}}.tla
+         category: possibility
+         inputs:
+           
+             - desc: Start of module
+               template: possibility/module_header.mustache
+               modelData: possibility
+
+             - desc: Extension definition
+               template: possibility/module_extends.mustache
+               modelData: possibility
+
+             - desc: Define possibility invariant operator
+               template: possibility/possibility_definition.mustache
+               modelData: possibility
+
+
+             - desc: End of module
+               template: possibility/module_footer.mustache
+               modelData: possibility
+
+
+       - output: tla/possible_{{possibility}}.cfg
+         category: possibility
+         inputs:
+           
+             - desc: Include setup.cfg
+               template: possibility/possility_setup.mustache
+               modelData: possibility
+               templateParameters:
+                    include: tla/setup.cfg
+
+
+             - desc: Activate possibility directive
+               template: possibility/possibility_directive.mustache
+               modelData: possibility

data/lib/sbuilder/domain.rb

@@ -0,0 +1,124 @@
+
+module Sbuilder
+
+  class Domain
+
+    attr_reader :name
+
+    attr_reader :extension
+
+    # ------------------------------------------------------------------
+    # mixer
+    PROGNAME = "domain"               # progname for logger
+    include Sbuilder::Utils::MyLogger # mix logger
+    
+
+    def initialize( options = {} )
+      @logger = getLogger( PROGNAME, options )
+      @logger.info( "#{__method__} initialized" )
+    end
+
+    def to_s
+      "#{self.class}: name=#{name}"
+    end
+
+    # ------------------------------------------------------------------
+    # config
+
+    def setName( name )
+      @name = name
+      self
+    end
+
+    # def setCardinality( cardinality )
+    #   @cardinality = cardinality
+    #   raise "deprecated #{__method__} in #{self.class}"
+    #   self
+    # end
+
+    # ------------------------------------------------------------------
+    # extendDomain 
+    
+    def setExtension( extension )
+      @extension = extension
+    end
+
+    # ------------------------------------------------------------------
+    # use extension
+
+    # delegate to extension - return 1 if does not exist
+    def cardinality
+      return 1 unless extension
+      extension.cardinality
+    end
+
+    # ------------------------------------------------------------------
+    # generate
+
+    # alias for 
+    alias domain_name :name
+
+    # # used to generate default values - in extension loaded
+    # def domain_prefix
+    #   domain_name + "_"
+    # end
+
+    # Return domain value for for element 'i'. Possibly delegate to sub-class.
+    # 
+    #
+    # @param i [Integer|String] element index (interger) or String value non integer
+    #
+    # @return value of domain element 'i', false if i==0
+    def domain_entry( i )
+
+      # interpret 0 as Nil
+      return false if i.is_a?(Integer) && i == 0
+
+      # delegage - if possible
+      return extension.domain_entry( i ) if extension
+      
+      raise DomainException.new <<-EOS unless i.is_a?(Integer)
+      Unknown type '#{i.class}' with value '#{i}' in 'domain_entry' #{name}.
+
+      Support only for Integer
+      EOS
+
+      raise DomainException.new <<-EOS if i > cardinality
+      Requested cardinality #{i} exceeds cardinality #{cardinality} of domain #{name}
+      EOS
+                                                     
+                                                     
+      "d_#{domain_name}_#{i}"
+    end
+    
+
+    # return array of strings for entries in domain - overrid
+    def domain_entries
+      arr = *(1..cardinality).map { |i| domain_entry( i ) }
+      return arr
+    end
+
+
+    # return and array of {:value,:_comma} hashes
+    def domain_values
+      # delegate  - if extended
+      return extension.domain_values if extension
+      arra = domain_entries.map.with_index do |domain_entry, i|
+                {
+                  :namespace => Constants::TYPE_NAMESPACE_DOM,
+                  :value => domain_entry, 
+                  :_comma => (i +1) == cardinality ? "" : ",",
+                  :index => i+1,
+                }
+      end
+      @logger.debug( "#{__method__} #{name}: arra #{arra.to_yaml}" )                  
+      return arra
+    end
+
+  end
+
+  
+end
+
+
+