tla-sbuilder 0.1.0

data/lib/utils/string_inject.rb

@@ -0,0 +1,10 @@
+# http://stackoverflow.com/questions/3772864/how-do-i-remove-leading-whitespace-chars-from-ruby-heredoc
+
+class String
+  # Strip leading whitespace from each line that is the same as the 
+  # amount of whitespace on the first line of the string.
+  # Leaves _additional_ indentation on later lines intact.
+  def unindent
+    gsub /^#{self[/\A[ \t]*/]}/, ''
+  end
+end

data/lib/utils/version.rb

@@ -0,0 +1,13 @@
+module Sbuilder
+
+
+  def self.version
+    File.readlines( File.join File.dirname( __FILE__ ), "../../VERSION" ).first.gsub( /\n/, "" )
+  end
+
+  def self.model_version
+    return File.readlines( "VERSION" ).first.gsub( /\n/, "" ) if File.exist?( "VERSION" )
+    return "Model version file #{Dir.pwd}/VERSION not found"
+  end
+
+end

data/mustache/cfg/const_def.mustache

@@ -0,0 +1,8 @@
+  
+(* Declare magic constants *)
+CONSTANT WildCard = WildCard
+CONSTANT Nil = Nil
+
+(* Pluscal sets 'defaultInitValue' for unitialized variables *)
+CONSTANT defaultInitValue <- Nil
+

data/mustache/cfg/const_run.mustache

@@ -0,0 +1,3 @@
+  
+(* Environment *)
+CONSTANT Steps <- RunSteps

data/mustache/cfg/invariant-infrastructure-service.mustache

@@ -0,0 +1,4 @@
+
+
+\* Ensure that infrastrucutre services return correct types
+INVARIANT InfrastructureService_TypeInvariant

data/mustache/cfg/macro_run.mustache

@@ -0,0 +1,6 @@
+(* 'enabled' macro check is process enables *)
+CONSTANT ProcessEnabled <- RunProcessEnabled
+CONSTANT ProcessRunning <- RunProcessRunning
+CONSTANT ProcessParameter <- RunProcessParameter
+CONSTANT ProcessesToRun <- RunProcessesToRun
+CONSTANT TickNext <- RunTickNext

data/mustache/cfg/module_header.mustache

@@ -0,0 +1,7 @@
+(*
+   Model version: {{META.model_version}}
+   Generator version {{META.version}}
+   Generation timestemp: {{META.timestamp}}
+*)   
+SPECIFICATION Spec
+\* Add statements after this line.

data/mustache/data-model-dump.mustache

@@ -0,0 +1,19 @@
+{{!
+
+	data-model.dump.mustache - dump content of model data using markdown markup
+
+	- output header
+	- dump model data content
+
+
+}}
+
+##  {{META.desc}} - data model element '{{META.modelData}}' 
+
+<!-- a class='navigator' href='#top'>[top]</a -->
+
+<pre>
+{{{dump}}}
+</pre>
+
+<!-- a class='navigator' href='#top'>[top]</a -->

data/mustache/data-model-footer.mustache

@@ -0,0 +1,5 @@
+{{!
+
+	data-model-footer.mustache - output footer in data-model dump
+}}
+

data/mustache/data-model-header.mustache

@@ -0,0 +1,16 @@
+{{!
+
+	data-model-header.mustache - output header in data-model dump
+}}
+
+# Data model
+
+
+<!-- ul>
+    <li><a href="#interfaces">Model interfaces</a></li>
+    <li><a href="#definitions">Model definitions</a></li>    
+    <li><a href="#domains">Model domains</a></li>
+    <li><a href="#variables">Model variables</a></li>
+    <li><a href="#steps">Model steps</a></li>    
+</ul -->
+

data/mustache/definition_types.mustache

@@ -0,0 +1,40 @@
+
+(******************************************************************
+Defined types {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*******************************************************************)
+
+{{#definitions}}
+{{>name_definition_type.mustache}} == {{!
+
+    Start of definition.
+
+    Add 'SUBSET ' for an array type
+
+}}{{#isArray}}SUBSET {{/isArray}}{{!
+
+    Start of record and 
+
+}}[{{!
+
+    add fiels from #parameter_definitions
+}}
+{{#parameter_definitions}}
+ {{>name_parameter_definition.mustache}}: {{#isArray}}SUBSET {{/isArray}}{{>name_parameter_type.mustache}}{{_comma}}
+{{/parameter_definitions}}{{!
+
+     end of definition
+}}]{{!
+
+
+  End of array
+
+
+}}{{#isArray}}{{/isArray}}{{!
+
+   Comment in the end
+
+}} \* definition '{{definition_name}}'
+
+{{/definitions}}

data/mustache/domains.mustache

@@ -0,0 +1,20 @@
+{{!
+
+   domains.mustache
+
+   Iterate domains
+
+}}
+
+
+(******************************************************************
+{{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+ ******************************************************************)
+ 
+{{#domains}}
+CONSTANTS {{>name_domain.mustache}} 
+{{/domains}}
+
+

data/mustache/domains_assign.mustache

@@ -0,0 +1,22 @@
+{{!
+
+   assign_domains.mustache
+
+   Assign run-domain to domains
+
+}}
+
+
+(******************************************************************
+ Map domain ranges in setup to specification domains:
+ 
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+ ******************************************************************)
+
+{{#domains}}
+CONSTANT {{>name_domain.mustache}}  <- Run_{{>name_domain.mustache}}
+{{/domains}}
+
+

data/mustache/domains_run.mustache

@@ -0,0 +1,21 @@
+{{!
+
+   run_domains.mustache - define domain values
+
+   - iterate #domain_values
+   - include Nil to valid domain value
+
+}}
+
+(******************************************************************
+Assign values to skeleton domains: {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*******************************************************************)
+
+(* Domains for {{META.setup}} start *)
+{{#domains}}
+Run_{{>name_domain.mustache}}    == { {{#domain_values}}"{{>name_domain_value.mustache}}"{{_comma}} {{/domain_values}} } \cup {Nil} \*
+{{/domains}}
+(* Domains for {{META.setup}} end *)
+

data/mustache/extend/extend_assumptions.mustache

@@ -0,0 +1,7 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+{{!>assumption}}

data/mustache/extend/extend_const.mustache

@@ -0,0 +1,5 @@
+(******************************************************************
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+ ******************************************************************)

data/mustache/extend/extend_implementation.mustache

@@ -0,0 +1,9 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+
+{{!>infrastructure}}
+{{!>service}}

data/mustache/extend/extend_invariant.mustache

@@ -0,0 +1,7 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+{{!>correctness}}

data/mustache/extend/extend_invariant_cfg.mustache

@@ -0,0 +1,7 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+{{!>correctness.cfg}}

data/mustache/extend/extend_macros.mustache

@@ -0,0 +1,19 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+(* ******************************************************************
+ Transactions (modify state)
+ * ******************************************************************)
+
+{{!>transaction}}
+
+
+(* ******************************************************************
+ Macros implmeneting entries to interface services
+ * ******************************************************************)
+
+{{!>interface}}
+

data/mustache/extend/extend_operations.mustache

@@ -0,0 +1,9 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+
+{{!>operator}}
+

data/mustache/extend/extend_state.mustache

@@ -0,0 +1,9 @@
+(*
+ {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*)
+
+{{!>state}}
+
+

data/mustache/infrastructure-service-init.mustache

@@ -0,0 +1,36 @@
+(******************************************************************
+{{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+
+******************************************************************)
+
+\* create record to put into 'responses'variable field
+InfrastructureServiceResponse( status, response ) == [ status |-> status, response |-> response ]
+
+\* Initial value to variable 'responses' 
+InfrastructureServiceInit == {{!
+
+    No infrastructure services defined
+
+}}{{^infrastructureServices.length}} Nil \* No infrastructure services defined
+
+{{/infrastructureServices.length}}{{!
+
+      Some infrastructure services defined
+
+}}{{#infrastructureServices.length}} [ {{/infrastructureServices.length}} {{!
+
+    iterate infrastructureServices
+
+    - output: <interface_name> |-> Nil, 
+
+
+}}{{#infrastructureServices}} {{>name_process.mustache}} |-> InfrastructureServiceResponse( Nil, Nil ){{_comma}}{{/infrastructureServices}}{{!
+
+    Infrastructure-services defined && end
+
+    - ouput: ];
+
+}}{{#infrastructureServices.length}}  ] {{/infrastructureServices.length}}
+

data/mustache/infrastructure-service-variables.mustache

@@ -0,0 +1,10 @@
+(******************************************************************
+{{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+
+******************************************************************)
+
+\* Variable for returning responses from infrastructure services
+responses = InfrastructureServiceInit;
+

data/mustache/interface_processes.mustache

@@ -0,0 +1,38 @@
+{{!
+
+   interface_processes: speficy a process for each interface
+
+
+}}
+
+(******************************************************************
+Interfaces generated  {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+******************************************************************)
+
+{{#interfaces}}
+(* Process {{interface_operation}} *)
+fair process ({{>name_process.mustache}}="{{interface_operation}}") {
+     {{>name_process.mustache}}_enter: while (TRUE) {
+         enable( "{{>name_process.mustache}}" );
+	 (* enable next process to run parallel *)
+	 \* process_done( "{{interface_operation}}" );
+	 with ( _input \in { t \in ProcessParameterInput( {{>name_interface_type.mustache}} ) : ProcessParameterBind( t ) } ) {
+	    \* PREFERENCES.debug-output: {{PREFERENCES.debug-output}}
+	    {{^PREFERENCES.debug-output}}\* {{/PREFERENCES.debug-output}}print <<"Default process {{>name_process.mustache}} for operation '{{interface_operation}}',tick=", currentTime>>;
+	    {{^implementation}}
+	    {{^PREFERENCES.debug-output}}\* {{/PREFERENCES.debug-output}}print <<"   - input=>", _input >>;	    
+	    (* print <<"   - {{>name_interface_type.mustache}}=>", {{>name_interface_type.mustache}} >>; *)
+	    {{/implementation}}
+	    (* Valid input type? *)
+	    assert(  _input \in {{>name_interface_type.mustache}} );
+	    {{#implementation}}{{implementation}}( _input );{{/implementation}}
+	 }; \* with _input
+	 (* enable next process - after current process *)
+	 {{>name_process.mustache}}_exit: process_done( "{{interface_operation}}" );
+     } \* while(TRUE)
+} \* failr process {{>name_process.mustache}}
+
+{{/interfaces}}
+

data/mustache/interface_stubs_dummy.mustache

@@ -0,0 +1,13 @@
+(******************************************************************
+Interfaces generated  {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+******************************************************************)
+
+(* Create a dummy procedure with input variable so that pcal creates
+   constant defaultInitValue (which is assigned a value in setup.tla)
+*)
+
+procedure dummy( dummy_input ) {
+	dummy_start:  skip;
+}

data/mustache/interface_types.mustache

@@ -0,0 +1,52 @@
+{{!
+
+   interface_types.mustache : types for 
+
+   
+
+}}
+
+
+(******************************************************************
+Interface input types: {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*******************************************************************)
+
+{{#interfaces}}
+{{>name_interface_type.mustache}} == [{{#parameter_definitions}}
+     {{>name_parameter_definition.mustache}}: {{>name_parameter_type.mustache}}{{_comma}}{{/parameter_definitions}}{{!
+
+     Empty parameter definition (passes swagger schema validation).
+     
+     ouput 'dummy : Nil'
+     
+}}{{^parameter_definitions.length}}dummy: Nil{{/parameter_definitions.length}}
+] \* operation '{{interface_operation}}' --> process '{{>name_process.mustache}}'
+
+{{/interfaces}}
+
+\* end of Interface input types
+
+(******************************************************************
+Interface response types: {{META.desc}}
+ - modelData {{META.modelData}}
+ - template  {{META.template}}
+*******************************************************************)
+
+{{#interfaces}}
+{{>name_interface_response_type.mustache}} =={{!
+
+    When something defined as a response i.e. 'response_definitions.length' exists
+
+}}{{#response_definitions.length}}[{{/response_definitions.length}}{{#response_definitions}}
+                {{>name_parameter_definition.mustache}}: {{>name_parameter_type.mustache}}{{_comma}}{{/response_definitions}}
+{{#response_definitions.length}}]{{/response_definitions.length}}{{!
+
+    When no response defidined i.e. 'response_definitions.length' exists
+
+}}{{^response_definitions.length}}{ Nil }{{/response_definitions.length}}{{!
+
+    Put a comment in the end
+}} \* interface '{{interface_name}}' response type
+{{/interfaces}}