Implement non-page(s) target-counter(s)

DEVSIX-4693

Author: Eugene Bochilo

styled-xml-parser/src/main/java/com/itextpdf/styledxmlparser/LogMessageConstant.java

@@ -79,6 +79,10 @@ public final class LogMessageConstant {
     public static final String QUOTE_IS_NOT_CLOSED_IN_CSS_EXPRESSION = "The quote is not closed in css expression: {0}";
     /** The Constant INVALID_CSS_PROPERTY_DECLARATION. */
     public static final String INVALID_CSS_PROPERTY_DECLARATION = "Invalid css property declaration: {0}";
+    /**
+     * The Constant INCORRECT_CHARACTER_SEQUENCE.
+     */
+    public static final String INCORRECT_CHARACTER_SEQUENCE = "Incorrect character sequence.";
     public static final String INCORRECT_RESOLUTION_UNIT_VALUE = "Resolution value unit should be either dpi, dppx or dpcm!";
     /** The Constant RULE_IS_NOT_SUPPORTED. */
     public static final String RULE_IS_NOT_SUPPORTED = "The rule @{0} is unsupported. All selectors in this rule will be ignored.";

styled-xml-parser/src/main/java/com/itextpdf/styledxmlparser/css/util/CssUtils.java

@@ -86,26 +86,39 @@ private CssUtils() {
      * @return the {@link List} of split result
      */
     public static List<String> splitStringWithComma(final String value) {
+        return splitString(value, ',', new EscapeGroup('(', ')'));
+    }
+
+    /**
+     * Splits the provided {@link String} by split character with respect of escape characters.
+     *
+     * @param value value to split
+     * @param splitChar character to split the String
+     * @param escapeCharacters escape characters
+     * @return the {@link List} of split result
+     */
+    public static List<String> splitString(String value, char splitChar, EscapeGroup... escapeCharacters) {
         if (value == null) {
             return new ArrayList<>();
         }
         final List<String> resultList = new ArrayList<>();
-        int lastComma = 0;
-        int notClosedBrackets = 0;
+        int lastSplitChar = 0;
         for (int i = 0; i < value.length(); ++i) {
-            if (value.charAt(i) == ',' && notClosedBrackets == 0) {
-                resultList.add(value.substring(lastComma, i));
-                lastComma = i + 1;
-            }
-            if (value.charAt(i) == '(') {
-                ++notClosedBrackets;
+            final char currentChar = value.charAt(i);
+            boolean isEscaped = false;
+            for (final EscapeGroup character : escapeCharacters) {
+                if (currentChar == splitChar) {
+                    isEscaped = isEscaped || character.isEscaped();
+                } else {
+                    character.processCharacter(currentChar);
+                }
             }
-            if (value.charAt(i) == ')') {
-                --notClosedBrackets;
-                notClosedBrackets = Math.max(notClosedBrackets, 0);
+            if (currentChar == splitChar && !isEscaped) {
+                resultList.add(value.substring(lastSplitChar, i));
+                lastSplitChar = i + 1;
             }
         }
-        final String lastToken = value.substring(lastComma);
+        final String lastToken = value.substring(lastSplitChar);
         if (!lastToken.isEmpty()) {
             resultList.add(lastToken);
         }

styled-xml-parser/src/main/java/com/itextpdf/styledxmlparser/css/util/EscapeGroup.java

@@ -0,0 +1,76 @@
+package com.itextpdf.styledxmlparser.css.util;
+
+import com.itextpdf.io.util.MessageFormatUtil;
+import com.itextpdf.styledxmlparser.LogMessageConstant;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Class to store escape characters and their processing logic.
+ * This class is used in {@link CssUtils#splitString(String, char, EscapeGroup...)} method.
+ */
+public class EscapeGroup {
+    private static final Logger LOGGER = LoggerFactory.getLogger(EscapeGroup.class);
+
+    private final char openCharacter;
+    private final char closeCharacter;
+
+    private int counter = 0;
+
+    /**
+     * Creates instance of {@link EscapeGroup}.
+     *
+     * @param openCharacter  opening escape character
+     * @param closeCharacter closing escape character
+     */
+    public EscapeGroup(char openCharacter, char closeCharacter) {
+        this.openCharacter = openCharacter;
+        this.closeCharacter = closeCharacter;
+    }
+
+    /**
+     * Creates instance of {@link EscapeGroup} when opening and closing characters are the same.
+     *
+     * @param escapeChar opening and closing escape character
+     */
+    public EscapeGroup(char escapeChar) {
+        this.openCharacter = escapeChar;
+        this.closeCharacter = escapeChar;
+    }
+
+    /**
+     * Is currently processed character in {@link CssUtils#splitString(String, char, EscapeGroup...)} escaped.
+     *
+     * @return true if escaped, false otherwise
+     */
+    boolean isEscaped() {
+        return counter != 0;
+    }
+
+    /**
+     * Processes given character.
+     *
+     * @param nextCharacter next character to process
+     */
+    void processCharacter(char nextCharacter) {
+        if (openCharacter == closeCharacter) {
+            if (nextCharacter == openCharacter) {
+                if (isEscaped()) {
+                    ++counter;
+                } else {
+                    --counter;
+                }
+            }
+        } else {
+            if (nextCharacter == openCharacter) {
+                ++counter;
+            } else if (nextCharacter == closeCharacter) {
+                --counter;
+                if (counter < 0) {
+                    LOGGER.warn(MessageFormatUtil.format(LogMessageConstant.INCORRECT_CHARACTER_SEQUENCE));
+                    counter = 0;
+                }
+            }
+        }
+    }
+}

styled-xml-parser/src/test/java/com/itextpdf/styledxmlparser/css/util/CssUtilsTest.java

@@ -387,6 +387,7 @@ public void elementNodeAttributeIsNotStylesheet() {
     }
 
     @Test
+    @LogMessages(messages = @LogMessage(messageTemplate = LogMessageConstant.INCORRECT_CHARACTER_SEQUENCE))
     public void splitStringWithCommaTest() {
         Assert.assertEquals(new ArrayList<String>(), CssUtils.splitStringWithComma(null));
         Assert.assertEquals(Arrays.asList("value1", "value2", "value3"),
@@ -405,6 +406,25 @@ public void splitStringWithCommaTest() {
                 CssUtils.splitStringWithComma("v.al*ue1\",( v2,v3),\"(v4,v5;);,value3"));
     }
 
+    @Test
+    public void splitStringTest() {
+        Assert.assertEquals(new ArrayList<String>(), CssUtils.splitString(null, ','));
+        Assert.assertEquals(Arrays.asList("value1", "(value,with,comma)", "value3"),
+                CssUtils.splitString("value1,(value,with,comma),value3", ',', new EscapeGroup('(', ')')));
+        Assert.assertEquals(Arrays.asList("value1 ", " (val(ue,with,comma),value3"),
+                CssUtils.splitString("value1 , (val(ue,with,comma),value3", ',', new EscapeGroup('(', ')')));
+        Assert.assertEquals(Arrays.asList("some text", " (some", " text in", " brackets)", " \"some, text, in quotes,\""),
+                CssUtils.splitString("some text, (some, text in, brackets), \"some, text, in quotes,\"", ',',
+                        new EscapeGroup('\"')));
+        Assert.assertEquals(Arrays.asList("some text", " (some. text in. brackets)", " \"some. text. in quotes.\""),
+                CssUtils.splitString("some text. (some. text in. brackets). \"some. text. in quotes.\"", '.',
+                        new EscapeGroup('\"'), new EscapeGroup('(', ')')));
+        Assert.assertEquals(Arrays.asList("value1", "(value", "with" ,"comma)", "value3"),
+                CssUtils.splitString("value1,(value,with,comma),value3", ','));
+        Assert.assertEquals(Arrays.asList("value1", "value", "with" ,"comma", "value3"),
+                CssUtils.splitString("value1,value,with,comma,value3", ',', new EscapeGroup(',')));
+    }
+
     @Test
     public void parseBlendModeTest() {
         Assert.assertEquals(BlendMode.NORMAL, CssUtils.parseBlendMode(null));