For JSP Matching, recognize comments

[CodesAway]

commented out lines (<%-- and --%>)

Also <!-- and -->

https://stackoverflow.com/questions/220243/how-comment-a-jsp-expression

[CodesAway]

Starting point

• Need to test some more (and add unit tests)
• Need to incorporate Java single line and multiline comment (see above StackOverflow page)

	/**
	 * Parses the specified JSP text and determines the <code>BEXMatchingTextState</code>s
	 * @param text the JSP text
	 * @return an unmodifiable map from the range to the BEXMatchingTextState
	 */
	public static ImmutableIntRangeMap<MatchingStateOption> parseJSPTextStates(final CharSequence text) {
		// TODO: used Java as a basic and need to enhance
		// For example, to handle JSP Expression
		// https://www.tutorialspoint.com/jsp/jsp_syntax.htm

		// TODO: need to make RangeMap class and correctly and nested ranges
		// Currently, doesn't work as expected
		// "stuff <%= expression%> more stuff"
		// "More stuff" after the expression should be seen as part of the String literal,
		// but isn't since it gets the last range, which is the expression, which is over
		// Think can fix by end the state when go into a inner state
		// Then, when leave inner state, start a new state based on the outer state

		// TODO: make RangeMap class to handle this
		// When adding a new record, check for overlap using the below logic
		// + An overlap occurs if and only if
		// a) The added range's start in part of an existing range
		// * Can check by finding existing range in map and seeing if the added range's start is in the middle
		// * BEXUtilities.getEntryInRanges
		// b) An existing range's start is contained in the new range
		// * Can do a subRange check on the existing NavigableMap and see if there are any entries
		// If there's an overlap, handle by breaking apart ranges in pieces

		// Parse text to get states
		// * Block comment
		// * Line comment
		// * In String literal
		// * Other stuff?

		ImmutableIntRangeMap.Builder<MatchingStateOption> builder = ImmutableIntRangeMap.builder();
		ArrayDeque<MatchingStateOption> stateStack = new ArrayDeque<>();
		ArrayDeque<Integer> startTextInfoStack = new ArrayDeque<>();

		for (int i = 0; i < text.length(); i++) {
			char c = text.charAt(i);

			if (stateStack.peek() == IN_STRING_LITERAL) {
				if (c == '\\') {
					// Escape next character
					if (nextChar(text, i) == '\0') {
						break;
					}

					i++;
				} else if (c == '"') {
					int startTextInfo = startTextInfoStack.pop();
					builder.put(IntBEXRange.closed(startTextInfo, i), stateStack.pop());
				} else if (hasText(text, i, "<%=")) {
					// Going into second level, so end current level
					int startTextInfo = startTextInfoStack.pop();
					if (startTextInfo != i) {
						// Only add if not empty range
						// Would be empty for example if ended one expression then immediately started next one
						builder.put(IntBEXRange.of(startTextInfo, i), stateStack.peek());
					}

					stateStack.push(IN_EXPRESSION_BLOCK);
					startTextInfoStack.push(i);
					i += 2;
				}

				// Other characters don't matter??
				// TODO: handle unicode and other escaping in String literal
			} else if (stateStack.peek() == IN_SECONDARY_STRING_LITERAL) {
				if (c == '\\') {
					// Escape next character
					if (nextChar(text, i) == '\0') {
						break;
					}

					i++;
				} else if (c == '\'') {
					int startTextInfo = startTextInfoStack.pop();
					builder.put(IntBEXRange.closed(startTextInfo, i), stateStack.pop());
				} else if (hasText(text, i, "<%=")) {
					// Going into second level, so end current level
					int startTextInfo = startTextInfoStack.pop();
					if (startTextInfo != i) {
						builder.put(IntBEXRange.of(startTextInfo, i), stateStack.peek());
					}
					stateStack.push(IN_EXPRESSION_BLOCK);
					startTextInfoStack.push(i);
					i += 2;
				}

				// Other characters don't matter??
				// TODO: handle unicode and other escaping in String literal

				// TODO: Java comments only valid in <% code block %>
				//			} else if (stateStack.peek() == IN_LINE_COMMENT) {
				//				if (c == '\n' || c == '\r') {
				//					int startTextInfo = startTextInfoStack.pop();
				//					builder.put(IntBEXRange.of(startTextInfo, i), stateStack.pop());
				//				}
				//				// Other characters don't matter?
				//			} else if (stateStack.peek() == IN_MULTILINE_COMMENT) {
				//				if (hasText(text, i, "*/")) {
				//					i++;
				//					int startTextInfo = startTextInfoStack.pop();
				//					builder.put(IntBEXRange.closed(startTextInfo, i), stateStack.pop());
				//				}
			} else if (stateStack.peek() == IN_MULTILINE_COMMENT) {
				if (hasText(text, i, "--%>")) {
					i += 3;
					int startTextInfo = startTextInfoStack.pop();
					builder.put(IntBEXRange.closed(startTextInfo, i), stateStack.pop());

					if (!stateStack.isEmpty()) {
						// Inside a first level, so add startTextInfo for after expression blocks ends
						startTextInfoStack.push(i + 1);
					}
				}
			} else if (stateStack.peek() == IN_SECONDARY_MULTILINE_COMMENT) {
				if (hasText(text, i, "-->")) {
					i += 2;
					int startTextInfo = startTextInfoStack.pop();
					builder.put(IntBEXRange.closed(startTextInfo, i), stateStack.pop());

					if (!stateStack.isEmpty()) {
						// Inside a first level, so add startTextInfo for after expression blocks ends
						startTextInfoStack.push(i + 1);
					}
				}
			} else if (stateStack.peek() == IN_EXPRESSION_BLOCK) {
				if (hasText(text, i, "%>")) {
					i++;
					int startTextInfo = startTextInfoStack.pop();
					builder.put(IntBEXRange.closed(startTextInfo, i), stateStack.pop());

					if (!stateStack.isEmpty()) {
						// Inside a first level, so add startTextInfo for after expression blocks ends
						startTextInfoStack.push(i + 1);
					}
				}
			} else if (hasText(text, i, "<%--")) {
				stateStack.push(IN_MULTILINE_COMMENT);
				startTextInfoStack.push(i);
				i += 3;
			} else if (hasText(text, i, "<!--")) {
				stateStack.push(IN_SECONDARY_MULTILINE_COMMENT);
				startTextInfoStack.push(i);
				i += 3;
				// TODO: Java comments only valid in <% code block %>
				//			} else if (c == '/' && nextChar(text, i) == '/') {
				//				stateStack.push(IN_LINE_COMMENT);
				//				startTextInfoStack.push(i);
				//				i++;
				//			} else if (c == '/' && nextChar(text, i) == '*') {
				//				stateStack.push(IN_MULTILINE_COMMENT);
				//				startTextInfoStack.push(i);
				//				i++;
			} else if (c == '"') {
				stateStack.push(IN_STRING_LITERAL);
				startTextInfoStack.push(i);
			} else if (c == '\'') {
				stateStack.push(IN_SECONDARY_STRING_LITERAL);
				startTextInfoStack.push(i);
			} else if (hasText(text, i, "<%=")) {
				stateStack.push(IN_EXPRESSION_BLOCK);
				startTextInfoStack.push(i);
				i += 2;
			}
		}

		if (!stateStack.isEmpty()) {
			// TODO: what if there are multiple entries?
			// (this would suggest improperly formatted code)
			int startTextInfo = startTextInfoStack.pop();
			builder.put(IntBEXRange.of(startTextInfo, text.length()), stateStack.pop());
		}

		return builder.build();
	}

[CodesAway]

Fixed JSP parser (above was nowhere close to correct)