Skip to content

Commit 2c187b1

Browse files
committed
Refactoring generic type-names
1 parent 3990589 commit 2c187b1

File tree

8 files changed

+100
-95
lines changed

8 files changed

+100
-95
lines changed

StateMachine/Fsm.cs

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -34,32 +34,32 @@
3434
namespace StateMachine
3535
{
3636
[PublicAPI]
37-
public class Fsm<TState, TTrigger> : Fsm<TState, TTrigger, float>
37+
public class Fsm<TS, TT> : Fsm<TS, TT, float>
3838
{
39-
public Fsm(FsmModel<TState, TTrigger, float> model) : base(model)
39+
public Fsm(FsmModel<TS, TT, float> model) : base(model)
4040
{
4141
}
4242

43-
public Fsm(State<TState, TTrigger, float> current, bool stackEnabled = false) : base(current, stackEnabled)
43+
public Fsm(State<TS, TT, float> current, bool stackEnabled = false) : base(current, stackEnabled)
4444
{
4545
}
4646

4747
public void Update()
4848
{
49-
Model.Current.RaiseUpdated(new UpdateArgs<TState, TTrigger, float>(this, Current, 0f));
49+
Model.Current.RaiseUpdated(new UpdateArgs<TS, TT, float>(this, Current, 0f));
5050
}
5151
}
5252

5353
[PublicAPI]
54-
public class Fsm<TState, TTrigger, TData>
54+
public class Fsm<TS, TT, TD>
5555
{
56-
protected FsmModel<TState, TTrigger, TData> Model { get; set; } = new FsmModel<TState, TTrigger, TData>();
56+
protected FsmModel<TS, TT, TD> Model { get; set; } = new FsmModel<TS, TT, TD>();
5757

58-
public State<TState, TTrigger, TData> Current => Model.Current;
59-
public Stack<State<TState, TTrigger, TData>> Stack => Model.Stack;
58+
public State<TS, TT, TD> Current => Model.Current;
59+
public Stack<State<TS, TT, TD>> Stack => Model.Stack;
6060

6161
/// <exception cref="FsmBuilderException">When the model is null</exception>
62-
public Fsm(FsmModel<TState, TTrigger, TData> model)
62+
public Fsm(FsmModel<TS, TT, TD> model)
6363
{
6464
if (model == null) throw FsmBuilderException.ModelCannotBeNull();
6565

@@ -71,7 +71,7 @@ public Fsm(FsmModel<TState, TTrigger, TData> model)
7171
}
7272

7373
/// <exception cref="FsmBuilderException">When the initial state is null</exception>
74-
public Fsm(State<TState, TTrigger, TData> current, bool stackEnabled = false)
74+
public Fsm(State<TS, TT, TD> current, bool stackEnabled = false)
7575
{
7676
Model.StackEnabled = stackEnabled;
7777
if (current == null) throw FsmBuilderException.StateCannotBeNull();
@@ -84,18 +84,18 @@ public Fsm(State<TState, TTrigger, TData> current, bool stackEnabled = false)
8484
}
8585

8686
/// <summary>
87-
/// Gets you a builder for a Finite-State-Machine (FSM).
87+
/// Gets you a builder for a Finite-State-Machine (FSM).
8888
/// </summary>
8989
/// <param name="startState">The start state's key.</param>
9090
/// <returns></returns>
91-
public static BuilderFluent<TState, TTrigger, TData> Builder(TState startState)
91+
public static BuilderFluent<TS, TT, TD> Builder(TS startState)
9292
{
93-
return new FluentImplementation<TState, TTrigger, TData>(startState);
93+
return new FluentImplementation<TS, TT, TD>(startState);
9494
}
9595

9696
/// <exception cref="FsmBuilderException">When the handler is null</exception>
97-
public Fsm<TState, TTrigger, TData> AddStateChangeHandler(
98-
EventHandler<StateChangeArgs<TState, TTrigger, TData>> e)
97+
public Fsm<TS, TT, TD> AddStateChangeHandler(
98+
EventHandler<StateChangeArgs<TS, TT, TD>> e)
9999
{
100100
if (e == null) throw FsmBuilderException.HandlerCannotBeNull();
101101

@@ -104,7 +104,7 @@ public Fsm<TState, TTrigger, TData> AddStateChangeHandler(
104104
}
105105

106106
/// <exception cref="FsmBuilderException">When the state is null or the state has already been added before</exception>
107-
public Fsm<TState, TTrigger, TData> Add(State<TState, TTrigger, TData> state)
107+
public Fsm<TS, TT, TD> Add(State<TS, TT, TD> state)
108108
{
109109
if (state == null) throw FsmBuilderException.StateCannotBeNull();
110110
if (Model.States.ContainsKey(state.Identifier)) throw FsmBuilderException.StateCanOnlyBeAddedOnce(state);
@@ -117,28 +117,28 @@ public Fsm<TState, TTrigger, TData> Add(State<TState, TTrigger, TData> state)
117117
/// When the transition is null or another transition already leads to the same
118118
/// target state
119119
/// </exception>
120-
public Fsm<TState, TTrigger, TData> Add(Transition<TState, TTrigger, TData> t)
120+
public Fsm<TS, TT, TD> Add(Transition<TS, TT, TD> t)
121121
{
122122
if (t == null) throw FsmBuilderException.TransitionCannotBeNull();
123123

124124
Model.GlobalTransitions.Add(t.Target, t);
125125
return this;
126126
}
127127

128-
public void JumpTo(TState state, bool isPop = false)
128+
public void JumpTo(TS state, bool isPop = false)
129129
{
130-
State<TState, TTrigger, TData> s;
130+
State<TS, TT, TD> s;
131131
if (Model.States.TryGetValue(state, out s))
132132
{
133-
DoTransition(state, default(TTrigger), isPop);
133+
DoTransition(state, default(TT), isPop);
134134
}
135135
}
136-
137-
private void DoTransition(TState state, TTrigger input, bool isPop)
136+
137+
private void DoTransition(TS state, TT input, bool isPop)
138138
{
139139
if (state == null || input == null) return;
140140

141-
State<TState, TTrigger, TData> old = Model.Current;
141+
State<TS, TT, TD> old = Model.Current;
142142
if (Model.StackEnabled && isPop)
143143
{
144144
Model.Stack.Pop();
@@ -158,15 +158,15 @@ private void DoTransition(TState state, TTrigger input, bool isPop)
158158

159159
if (!Model.Current.Equals(old))
160160
{
161-
StateChangeArgs<TState, TTrigger, TData> args =
162-
new StateChangeArgs<TState, TTrigger, TData>(this, old, Model.Current, input);
161+
StateChangeArgs<TS, TT, TD> args =
162+
new StateChangeArgs<TS, TT, TD>(this, old, Model.Current, input);
163163
old.RaiseExited(args);
164164
Model.Current.RaiseEntered(args);
165165
Model.RaiseStateChanged(args);
166166
}
167167
}
168168

169-
public void Trigger(TTrigger input)
169+
public void Trigger(TT input)
170170
{
171171
if (input == null) return;
172172

@@ -179,16 +179,16 @@ public void Trigger(TTrigger input)
179179
}
180180
}
181181

182-
Transition<TState, TTrigger, TData> t = Model.Current.Process(input);
182+
Transition<TS, TT, TD> t = Model.Current.Process(input);
183183
if (t != null)
184184
{
185185
DoTransition(t.Target, input, t.Pop);
186186
}
187187
}
188188

189-
public void Update(TData data)
189+
public void Update(TD data)
190190
{
191-
Model.Current.RaiseUpdated(new UpdateArgs<TState, TTrigger, TData>(this, Current, data));
191+
Model.Current.RaiseUpdated(new UpdateArgs<TS, TT, TD>(this, Current, data));
192192
}
193193
}
194194
}

StateMachine/FsmBuilderException.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ private FsmBuilderException(string message, Exception innerException) : base(mes
3939
{
4040
}
4141

42-
public static FsmBuilderException StateCanOnlyBeAddedOnce<TState, TTrigger, TData>(
43-
State<TState, TTrigger, TData> state)
42+
public static FsmBuilderException StateCanOnlyBeAddedOnce<TS, TT, TD>(
43+
State<TS, TT, TD> state)
4444
{
4545
return
4646
new FsmBuilderException($"A state [{state.Identifier}] has already been added. You can only one add" +
@@ -72,7 +72,7 @@ public static FsmBuilderException ModelCannotBeNull()
7272
return new FsmBuilderException("The model cannot be null.");
7373
}
7474

75-
public static FsmBuilderException TriggerAlreadyDeclared<TTrigger>(TTrigger trigger)
75+
public static FsmBuilderException TriggerAlreadyDeclared<TT>(TT trigger)
7676
{
7777
return new FsmBuilderException($"The transition already contains the trigger [{trigger}]");
7878
}

StateMachine/FsmModel.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,30 +33,30 @@
3333
namespace StateMachine
3434
{
3535
[PublicAPI]
36-
public class FsmModel<TState, TTrigger, TData>
36+
public class FsmModel<TS, TT, TD>
3737
{
38-
public event EventHandler<StateChangeArgs<TState, TTrigger, TData>> StateChanged;
38+
public event EventHandler<StateChangeArgs<TS, TT, TD>> StateChanged;
3939

40-
public State<TState, TTrigger, TData> Current { get; set; }
40+
public State<TS, TT, TD> Current { get; set; }
4141

42-
public Stack<State<TState, TTrigger, TData>> Stack { get; } = new Stack<State<TState, TTrigger, TData>>();
42+
public Stack<State<TS, TT, TD>> Stack { get; } = new Stack<State<TS, TT, TD>>();
4343
public bool StackEnabled { get; set; }
4444

45-
public Dictionary<TState, State<TState, TTrigger, TData>> States { get; } =
46-
new Dictionary<TState, State<TState, TTrigger, TData>>();
45+
public Dictionary<TS, State<TS, TT, TD>> States { get; } =
46+
new Dictionary<TS, State<TS, TT, TD>>();
4747

48-
public Dictionary<TState, Transition<TState, TTrigger, TData>> GlobalTransitions { get; } =
49-
new Dictionary<TState, Transition<TState, TTrigger, TData>>();
48+
public Dictionary<TS, Transition<TS, TT, TD>> GlobalTransitions { get; } =
49+
new Dictionary<TS, Transition<TS, TT, TD>>();
5050

5151
public void AddStateChangedHandler(
52-
EventHandler<StateChangeArgs<TState, TTrigger, TData>> e)
52+
EventHandler<StateChangeArgs<TS, TT, TD>> e)
5353
{
5454
if (e == null) throw FsmBuilderException.HandlerCannotBeNull();
5555

5656
StateChanged += e;
5757
}
5858

59-
public void RaiseStateChanged(StateChangeArgs<TState, TTrigger, TData> e)
59+
public void RaiseStateChanged(StateChangeArgs<TS, TT, TD> e)
6060
{
6161
StateChanged?.Invoke(this, e);
6262
}

StateMachine/NUnitTests/TestTools.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ namespace StateMachine.NUnitTests
3232
{
3333
public static class TestTools
3434
{
35-
public static void ConsoleOut<TState, TTrigger, TData>(object sender, StateChangeArgs<TState, TTrigger, TData> e)
35+
public static void ConsoleOut<TS, TT, TD>(object sender, StateChangeArgs<TS, TT, TD> e)
3636
{
3737
Console.Out.WriteLine($"From [{e.From}] with [{e.Input}] to [{e.To}]");
3838
}

StateMachine/State.cs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -31,33 +31,33 @@
3131
namespace StateMachine
3232
{
3333
[PublicAPI]
34-
public class State<TState, TTrigger, TData>
34+
public class State<TS, TT, TD>
3535
{
36-
private StateModel<TState, TTrigger, TData> Model { get; set; }
36+
private StateModel<TS, TT, TD> Model { get; set; }
3737

38-
public TState Identifier => Model.Identifier;
38+
public TS Identifier => Model.Identifier;
3939

4040
public bool ClearStack
4141
{
4242
get { return Model.ClearStack; }
4343
set { Model.ClearStack = value; }
4444
}
4545

46-
public void RaiseUpdated(UpdateArgs<TState, TTrigger, TData> args) => Model.RaiseUpdated(args);
47-
public void RaiseEntered(StateChangeArgs<TState, TTrigger, TData> args) => Model.RaiseEntered(args);
48-
public void RaiseExited(StateChangeArgs<TState, TTrigger, TData> args) => Model.RaiseExited(args);
46+
public void RaiseUpdated(UpdateArgs<TS, TT, TD> args) => Model.RaiseUpdated(args);
47+
public void RaiseEntered(StateChangeArgs<TS, TT, TD> args) => Model.RaiseEntered(args);
48+
public void RaiseExited(StateChangeArgs<TS, TT, TD> args) => Model.RaiseExited(args);
4949

50-
public State(StateModel<TState, TTrigger, TData> model)
50+
public State(StateModel<TS, TT, TD> model)
5151
{
5252
Model = model;
5353
}
5454

55-
public State(TState identifier) : this(new StateModel<TState, TTrigger, TData>(identifier))
55+
public State(TS identifier) : this(new StateModel<TS, TT, TD>(identifier))
5656
{
5757
}
5858

5959
/// <exception cref="FsmBuilderException"> When the transition is null</exception>
60-
public State<TState, TTrigger, TData> Add(Transition<TState, TTrigger, TData> t)
60+
public State<TS, TT, TD> Add(Transition<TS, TT, TD> t)
6161
{
6262
if (t == null) throw FsmBuilderException.TransitionCannotBeNull();
6363

@@ -66,17 +66,17 @@ public State<TState, TTrigger, TData> Add(Transition<TState, TTrigger, TData> t)
6666
return this;
6767
}
6868

69-
public State<TState, TTrigger, TData> AddTransisionOn(TTrigger trigger, TState target)
69+
public State<TS, TT, TD> AddTransisionOn(TT trigger, TS target)
7070
{
71-
return Add(new Transition<TState, TTrigger, TData>(trigger, Identifier, target));
71+
return Add(new Transition<TS, TT, TD>(trigger, Identifier, target));
7272
}
7373

74-
public State<TState, TTrigger, TData> AddPopTransisionOn(TTrigger trigger)
74+
public State<TS, TT, TD> AddPopTransisionOn(TT trigger)
7575
{
76-
return Add(new Transition<TState, TTrigger, TData>(trigger, Identifier));
76+
return Add(new Transition<TS, TT, TD>(trigger, Identifier));
7777
}
7878

79-
public Transition<TState, TTrigger, TData> Process(TTrigger input)
79+
public Transition<TS, TT, TD> Process(TT input)
8080
{
8181
foreach (var t in Model.Transitions.Values)
8282
{

StateMachine/StateModel.cs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,59 +33,59 @@
3333
namespace StateMachine
3434
{
3535
[PublicAPI]
36-
public class StateModel<TState, TTrigger, TData>
36+
public class StateModel<TS, TT, TD>
3737
{
38-
public event Action<StateChangeArgs<TState, TTrigger, TData>> Entered;
39-
public event Action<StateChangeArgs<TState, TTrigger, TData>> Exited;
40-
public event Action<UpdateArgs<TState, TTrigger, TData>> Updated;
38+
public event Action<StateChangeArgs<TS, TT, TD>> Entered;
39+
public event Action<StateChangeArgs<TS, TT, TD>> Exited;
40+
public event Action<UpdateArgs<TS, TT, TD>> Updated;
4141

42-
public TState Identifier { get; private set; }
42+
public TS Identifier { get; private set; }
4343
public bool EndState { get; set; }
4444
public bool ClearStack { get; set; }
4545

46-
public Dictionary<TState, Transition<TState, TTrigger, TData>> Transitions { get; } =
47-
new Dictionary<TState, Transition<TState, TTrigger, TData>>();
46+
public Dictionary<TS, Transition<TS, TT, TD>> Transitions { get; } =
47+
new Dictionary<TS, Transition<TS, TT, TD>>();
4848

49-
public StateModel(TState identifier)
49+
public StateModel(TS identifier)
5050
{
5151
Identifier = identifier;
5252
}
5353

5454
/// <exception cref="FsmBuilderException">When the handler is null</exception>
55-
public void AddEnteredHandler(Action<StateChangeArgs<TState, TTrigger, TData>> e)
55+
public void AddEnteredHandler(Action<StateChangeArgs<TS, TT, TD>> e)
5656
{
5757
if (e == null) throw FsmBuilderException.HandlerCannotBeNull();
5858

5959
Entered += e;
6060
}
6161

62-
public void RaiseEntered(StateChangeArgs<TState, TTrigger, TData> e)
62+
public void RaiseEntered(StateChangeArgs<TS, TT, TD> e)
6363
{
6464
Entered?.Invoke(e);
6565
}
6666

6767
/// <exception cref="FsmBuilderException">When the handler is null</exception>
68-
public void AddExitedHandler(Action<StateChangeArgs<TState, TTrigger, TData>> e)
68+
public void AddExitedHandler(Action<StateChangeArgs<TS, TT, TD>> e)
6969
{
7070
if (e == null) throw FsmBuilderException.HandlerCannotBeNull();
7171

7272
Exited += e;
7373
}
7474

75-
public void RaiseExited(StateChangeArgs<TState, TTrigger, TData> e)
75+
public void RaiseExited(StateChangeArgs<TS, TT, TD> e)
7676
{
7777
Exited?.Invoke(e);
7878
}
7979

8080
/// <exception cref="FsmBuilderException">When the handler is null</exception>
81-
public void AddUpdatedHandler(Action<UpdateArgs<TState, TTrigger, TData>> e)
81+
public void AddUpdatedHandler(Action<UpdateArgs<TS, TT, TD>> e)
8282
{
8383
if (e == null) throw FsmBuilderException.HandlerCannotBeNull();
8484

8585
Updated += e;
8686
}
8787

88-
public void RaiseUpdated(UpdateArgs<TState, TTrigger, TData> data)
88+
public void RaiseUpdated(UpdateArgs<TS, TT, TD> data)
8989
{
9090
Updated?.Invoke(data);
9191
}

0 commit comments

Comments
 (0)