summaryrefslogtreecommitdiff
path: root/BJC-Utils2/src/main/java/bjc/utils/parserutils/ShuntingYard.java
blob: 0ca1879cfb62eb6edd4708679c3c05a88db3a4a3 (plain)
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
package bjc.utils.parserutils;

import java.util.Deque;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;

import bjc.utils.funcdata.FunctionalList;
import bjc.utils.funcutils.StringUtils;

/**
 * Utility to run the shunting yard algorithm on a bunch of tokens
 * 
 * @author ben
 *
 * @param <E>
 *            The type of tokens being shunted
 */
public class ShuntingYard<E> {

	private final class TokenShunter implements Consumer<String> {
		private FunctionalList<E>	output;
		private Deque<String>		stack;
		private Function<String, E>	transform;

		public TokenShunter(FunctionalList<E> outpt, Deque<String> stack,
				Function<String, E> transform) {
			this.output = outpt;
			this.stack = stack;
			this.transform = transform;
		}

		@Override
		public void accept(String token) {
			if (operators.containsKey(token)) {
				while (!stack.isEmpty()
						&& isHigherPrec(token, stack.peek())) {
					output.add(transform.apply(stack.pop()));
				}

				stack.push(token);
			} else if (StringUtils.containsOnly(token, "\\(")) {
				stack.push(token);
			} else if (StringUtils.containsOnly(token, "\\)")) {
				while (stack.peek().equals(token.replace(')', '('))) {
					output.add(transform.apply(stack.pop()));
				}

				stack.pop();
			} else {
				output.add(transform.apply(token));
			}
		}
	}

	/**
	 * A enum representing the fundamental operator types
	 * 
	 * @author ben
	 *
	 */
	public static enum Operator implements IPrecedent {
		/**
		 * Represents addition
		 */
		ADD(1),
		/**
		 * Represents division
		 */
		DIVIDE(4),
		/**
		 * Represents multiplication
		 */
		MULTIPLY(3),
		/**
		 * Represents subtraction
		 */
		SUBTRACT(2);

		private final int precedence;

		private Operator(int prec) {
			precedence = prec;
		}

		/*
		 * (non-Javadoc)
		 * 
		 * @see bjc.utils.parserutils.IPrecedent#getPrecedence()
		 */
		@Override
		public int getPrecedence() {
			return precedence;
		}
	}

	/**
	 * Holds all the shuntable operations
	 */
	private Map<String, IPrecedent> operators;

	/**
	 * Create a new shunting yard with a default set of operators
	 */
	public ShuntingYard() {
		operators = new HashMap<>();

		operators.put("+", Operator.ADD);
		operators.put("-", Operator.SUBTRACT);
		operators.put("*", Operator.MULTIPLY);
		operators.put("/", Operator.DIVIDE);
	}

	/**
	 * Add an operator to the list of shuntable operators
	 * 
	 * @param operatorToken
	 *            The token representing the operator
	 * @param precedence
	 *            The precedence of the operator to add
	 */
	public void addOp(String operatorToken, int precedence) {
		this.addOp(operatorToken,
				IPrecedent.newSimplePrecedent(precedence));
	}

	/**
	 * Add an operator to the list of shuntable operators
	 * 
	 * @param token
	 *            The token representing the operator
	 * @param precedence
	 *            The precedence of the operator
	 */
	public void addOp(String token, IPrecedent precedence) {
		operators.put(token, precedence);
	}

	private boolean isHigherPrec(String operator, String rightOperator) {
		return (operators.containsKey(rightOperator) && operators
				.get(rightOperator).getPrecedence() >= operators
						.get(operator).getPrecedence());
	}

	/**
	 * Transform a string of tokens from infix notation to postfix
	 * 
	 * @param input
	 *            The string to transform
	 * @param tokenTransformer
	 *            The function to use to transform strings to tokens
	 * @return A list of tokens in postfix notation
	 */
	public FunctionalList<E> postfix(FunctionalList<String> input,
			Function<String, E> tokenTransformer) {
		FunctionalList<E> output = new FunctionalList<>();
		Deque<String> stack = new LinkedList<>();

		input.forEach(new TokenShunter(output, stack, tokenTransformer));

		while (!stack.isEmpty()) {
			output.add(tokenTransformer.apply(stack.pop()));
		}

		return output;
	}

	/**
	 * Remove an operator from the list of shuntable operators
	 * 
	 * @param tok
	 *            The token representing the operator
	 */
	public void removeOp(String tok) {
		operators.remove(tok);
	}
}