Skip to main content
aboutsummaryrefslogtreecommitdiffstats
blob: 2dbb1de1a55b38507a31b6d85845c1876a5b825b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
/*******************************************************************************
 * Copyright (c) 2012 protos software gmbh (http://www.protos.de).
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * CONTRIBUTORS:
 * 		Henrik Rentz-Reichert (initial contribution)
 * 
 *******************************************************************************/

package org.eclipse.etrice.generator.generic

import com.google.inject.Inject
import java.util.ArrayList
import org.eclipse.etrice.core.room.ActorClass
import org.eclipse.etrice.core.room.Transition
import org.eclipse.etrice.core.room.TriggeredTransition
import org.eclipse.etrice.core.room.NonInitialTransition
import org.eclipse.etrice.generator.etricegen.ExpandedActorClass
import org.eclipse.etrice.generator.extensions.RoomExtensions
import org.eclipse.etrice.generator.base.DetailCodeTranslator
import org.eclipse.etrice.generator.base.ITranslationProvider
import static extension org.eclipse.etrice.generator.extensions.RoomNameProv.*
import org.eclipse.xtext.util.Pair
import static org.eclipse.xtext.util.Tuples.*

class GenericStateMachineGenerator {

	@Inject public extension ILanguageExtension langExt
	@Inject public extension RoomExtensions roomExt
	@Inject public extension GenericProtocolClassGenerator pcGen
	@Inject public extension LanguageGenerator languageGen
	@Inject public ITranslationProvider translator

	def private genStateIdConstants(ExpandedActorClass xpac, ActorClass ac) {
		// with inheritance we exclude inherited base states
		var offset = 2 + if (langExt.usesInheritance)
			ac.getNumberOfInheritedBaseStates() else 0
		var baseStates = if (langExt.usesInheritance)
			ac.stateMachine.getBaseStateList else xpac.stateMachine.getBaseStateList
		
		baseStates = baseStates.leafStatesFirst
		
		var list = new ArrayList<Pair<String, String>>()
		if (!langExt.usesInheritance) {
			list.add(pair("NO_STATE","0"))
			list.add(pair("STATE_TOP","1"))
		}
		for (state : baseStates) {
			list.add(pair(state.getStateId, offset.toString))
			offset = offset+1;
		}
		
		return langExt.genEnumeration("state_ids", list)
	}
	
	def private genTransitionChainConstants(ExpandedActorClass xpac, ActorClass ac) {
		var chains = if (langExt.usesInheritance)
			xpac.getOwnTransitionChains() else xpac.transitionChains
		var offset = if (langExt.usesInheritance)
			xpac.getTransitionChains().size-chains.size else 0

		var list = new ArrayList<Pair<String, String>>()
		for (chain : chains) {
			offset = offset+1;
			list.add(pair(chain.getChainId, offset.toString))
		}
		
		return langExt.genEnumeration("chain_ids", list)
	}
	
	def private genTriggerConstants(ExpandedActorClass xpac, ActorClass ac) {
		var triggers = if (langExt.usesInheritance)
			xpac.getOwnTriggers() else xpac.triggers

		var list = new ArrayList<Pair<String, String>>()
		for (mif : triggers) {
			list.add(pair(xpac.getTriggerCodeName(mif), "IFITEM_"+mif.from.name+" + EVT_SHIFT*"+pcGen.getMessageID(mif)))
		}
		
		return langExt.genEnumeration("triggers", list)
	}
	
	def genStateMachine(ExpandedActorClass xpac, ActorClass ac) {
		translator.setActorClass(ac)
		var dct = new DetailCodeTranslator(ac, translator)
		
	'''
		
		/* state IDs */
		genStateIdConstants(xpac, ac)
		
		/* transition chains */
		genTransitionChainConstants(xpac, ac)
		
		/* triggers */
		genTriggerConstants(xpac, ac)

		genExtra(xpac, ac)
		
		//*** Entry and Exit Codes
		FOR state : xpac.stateMachine.getStateList()
			IF xpac.isOwnObject(state)
				IF state.hasEntryCode()
					langExt.accessLevelProtectedvoid state.getEntryCodeOperationName()(langExt.selfPointer(ac.name, false)) {
						xpac.getEntryCode(state, dct)
					}
				ENDIF
				IF state.hasExitCode()
					langExt.accessLevelProtectedvoid state.getExitCodeOperationName()(langExt.selfPointer(ac.name, false)) {
						xpac.getExitCode(state, dct)
					}
				ENDIF
			ENDIF
		ENDFOR
		
		//*** Action Codes
		FOR tr : xpac.stateMachine.getTransitionList()
			IF xpac.isOwnObject(tr) && tr.hasActionCode()
				langExt.accessLevelProtectedvoid tr.getActionCodeOperationName()(langExt.selfPointer(ac.name, tr instanceof NonInitialTransition)IF tr instanceof NonInitialTransitionInterfaceItemBase ifitemlanguageGen.getArgumentList(xpac, tr)ENDIF) {
					xpac.getActionCode(tr, dct)
				}
			ENDIF
		ENDFOR
		
		/**
		 * calls exit codes while exiting from the current state to one of its
		 * parent states while remembering the history
		 * @param current - the current state
		 * @param to - the final parent state
		 * @param handler - entry and exit codes are called only if not handler (for handler TransitionPoints)
		 */
		langExt.accessLevelPrivatevoid exitTo(langExt.selfPointer(ac.name, true)int current, int to, boolean handler) {
			while (current!=to) {
				switch (current) {
					FOR state : xpac.stateMachine.getBaseStateList()
						case state.getStateId():
							IF state.hasExitCode()if (!handler) state.getExitCodeOperationName()(langExt.selfPointer(false));ENDIF
							langExt.memberAccesshistory[state.getParentStateId()] = state.getStateId();
							current = state.getParentStateId();
							break;
					ENDFOR
				}
			}
		}
		
		/**
		 * calls action, entry and exit codes along a transition chain. The generic data are cast to typed data
		 * matching the trigger of this chain. The ID of the final state is returned
		 * @param chain - the chain ID
		 * @param generic_data - the generic data pointer
		 * @return the ID of the final state
		 */
		langExt.accessLevelPrivateint executeTransitionChain(langExt.selfPointer(ac.name, true)int chain, InterfaceItemBase ifitem, langExt.voidPointer generic_data) {
			switch (chain) {
				var allchains = xpac.getTransitionChains()
				FOR tc : allchains
					case tc.getChainId():
					{
						xpac.getExecuteChain(tc)
					}
				ENDFOR
			}
			return NO_STATE;
		}
		
		/**
		 * calls entry codes while entering a state's history. The ID of the final leaf state is returned
		 * @param state - the state which is entered
		 * @param handler - entry code is executed if not handler
		 * @return - the ID of the final leaf state
		 */
		langExt.accessLevelPrivateint enterHistory(langExt.selfPointer(ac.name, true)int state, boolean handler, boolean skip_entry) {
			while (langExt.booleanConstant(true)) {
				switch (state) {
					FOR state : xpac.stateMachine.getBaseStateList()
					case state.getStateId():
						IF state.hasEntryCode()if (!(skip_entry || handler)) state.getEntryCodeOperationName()(langExt.selfPointer(false));ENDIF
						IF state.isLeaf()
							// in leaf state: return state id
							return state.getStateId();
						ELSE
							// state has a sub graph
							IF state.subgraph.hasInitTransition()
								// with init transition
								if (langExt.memberAccesshistory[state.getStateId()]==NO_STATE) {
									var sub_initt = state.subgraph.getInitTransition()
									state = executeTransitionChain(langExt.selfPointer(true)xpac.getChain(sub_initt).getChainId(), langExt.nullPointer, langExt.nullPointer);
								}
								else {
									state = langExt.memberAccesshistory[state.getStateId()];
								}
							ELSE
								// without init transition
								state = langExt.memberAccesshistory[state.getStateId()];
							ENDIF
							break;
						ENDIF
					ENDFOR
					case STATE_TOP:
						state = langExt.memberAccesshistory[STATE_TOP];
						break;
				}
				skip_entry = langExt.booleanConstant(false);
			}
			//return NO_STATE; // required by CDT but detected as unreachable by JDT because of while (true)
		}
		
		IF langExt.usesInheritancelangExt.accessLevelPublicELSElangExt.accessLevelPrivateENDIFvoid executeInitTransition(langExt.selfPointer(ac.name, false)) {
			var initt = xpac.stateMachine.getInitTransition()
			int chain = xpac.getChain(initt).getChainId();
			int next = executeTransitionChain(langExt.selfPointer(true)chain, langExt.nullPointer, langExt.nullPointer);
			next = enterHistory(langExt.selfPointer(true)next, langExt.booleanConstant(false), langExt.booleanConstant(false));
			setState(langExt.selfPointer(true)next);
		}
		
		/* receiveEvent contains the main implementation of the FSM */
		IF langExt.usesInheritancelangExt.accessLevelPublicELSElangExt.accessLevelPrivateENDIFvoid receiveEvent(langExt.selfPointer(ac.name, true)InterfaceItemBase ifitem, int evt, langExt.voidPointer generic_data) {
			int trigger = IF langExt.usesInheritanceifitem.getLocalId()ELSEifitem->localIdENDIF + EVT_SHIFT*evt;
			int chain = NOT_CAUGHT;
			int catching_state = NO_STATE;
			boolean is_handler = langExt.booleanConstant(false);
			boolean skip_entry = langExt.booleanConstant(false);
			
			if (!handleSystemEvent(ifitem, evt, generic_data)) {
				switch (langExt.memberAccessstate) {
					FOR state : xpac.stateMachine.getLeafStateList()
					case state.getStateId():
						var atlist =  xpac.getActiveTriggers(state)
						IF !atlist.isEmpty
							switch(trigger) {
							FOR at : atlist
								case xpac.getTriggerCodeName(at.trigger):
									var needData = xpac.hasGuard(at)
									IF needData{ at.msg.getTypedDataDefinition()ENDIF
									FOR tt : at.transitions SEPARATOR " else "
										var chain = xpac.getChain(tt)
										guard(chain.transition, at.trigger, xpac, dct)
										{
											chain = chain.getChainId();
											catching_state = chain.getContextId();
											IF chain.isHandler()is_handler = langExt.booleanConstant(true);ENDIF
											IF chain.skipEntryskip_entry = langExt.booleanConstant(true);ENDIF
										}
									ENDFOR
									IF needData}ENDIF
								break;
							ENDFOR
							}
						ENDIF
						break;
					ENDFOR
				}
			}
			if (chain != NOT_CAUGHT) {
				exitTo(langExt.selfPointer(true)langExt.memberAccessstate, catching_state, is_handler);
				int next = executeTransitionChain(langExt.selfPointer(true)chain, ifitem, generic_data);
				next = enterHistory(langExt.selfPointer(true)next, is_handler, skip_entry);
				setState(langExt.selfPointer(true)next);
			}
		}
			 
		//******************************************
		// END of generated code for FSM
		//******************************************
	'''}
	
	def genExtra(ExpandedActorClass xpac, ActorClass ac) {''''''}
	
	def private dispatch guard(TriggeredTransition tt, String trigger, ExpandedActorClass ac, DetailCodeTranslator dct) {
		var tr = tt.triggers.findFirst(e|ac.isMatching(e, trigger))
	'''
		IF tr.hasGuard()
			if (dct.translateDetailCode(tr.guard.guard))
		ENDIF
	'''
	}

	def private dispatch guard(Transition t, String trigger, ExpandedActorClass ac, DetailCodeTranslator dct) {
	'''
		/* error */
	'''
	}
}

Back to the top