001package org.hl7.fhir.utilities;
002
003import java.util.ArrayList;
004import java.util.List;
005
006public class UnicodeUtilities {
007
008  public static class StateStackEntry {
009
010    private char c;
011    private int i;
012
013    public StateStackEntry(char c, int i) {
014      this.c = c;
015      this.i = i;
016    }
017  }
018
019  public static class StateStack {
020
021    private List<StateStackEntry> list = new ArrayList<>();
022
023    public void clear() {
024      list.clear();      
025    }
026
027    public void push(char c, int i) {
028      list.add(new StateStackEntry(c, i));      
029    }
030
031    public void popJustOne(CharSet oneSet) {
032      if (!list.isEmpty() && oneSet.contains(list.get(list.size()-1).c)) {
033        list.remove(list.size()-1);
034      }
035    }
036
037    public void popOneAndOthers(CharSet oneSet, CharSet otherSet) {
038      boolean found = false;
039      for (StateStackEntry t : list) {
040        if (oneSet.contains(t.c)) {
041          found = true;
042          break;
043        }
044      }
045      if (found) {
046        while (!list.isEmpty() && (oneSet.contains(list.get(list.size()-1).c) || otherSet.contains(list.get(list.size()-1).c))) {
047          boolean done = oneSet.contains(list.get(list.size()-1).c);
048          list.remove(list.size()-1);
049          if (done) {
050            break;
051          }
052        }
053      }
054    }
055
056    public boolean empty() {
057      return list.isEmpty();
058    }
059
060    public String summary(String src) {
061      char ch = list.get(list.size()-1).c;
062      int i = list.get(list.size()-1).i;
063      String pt;
064      if (i == 0) {
065        pt = "";
066      } else if (i < 5) {
067        pt = " (preceding text = '"+src.substring(0, i)+"')";
068      } else {
069        pt = " (preceding text = '"+src.substring(i-5, i)+"')";
070      }
071      return "Unicode Character "+describe(ch)+" at index "+i+" has no terminating match"+pt;
072    }
073
074  
075  }
076
077  public static class CharSet {
078
079    private char[] chars;
080
081    public CharSet(char... chars) {
082      this.chars = chars;
083    }
084
085    public boolean contains(char c) {
086      for (char t : chars) {
087        if (c == t) {
088          return true;
089        }
090      }
091      return false;
092    }
093
094  }
095
096  public static final char LRE = '\u202a';
097  public static final char RLE = '\u202b';
098  public static final char PDF = '\u202c';
099  public static final char LRO = '\u202d';
100  public static final char RLO = '\u202e';
101  public static final char LRI = '\u2066';
102  public static final char RLI = '\u2067';
103  public static final char FSI = '\u2068';
104  public static final char PDI = '\u2069';
105  public static final char LRM = '\u200E';
106  public static final char RLM = '\u200F';
107  public static final char ALM = '\u061C';
108  public static final char PARA = '\n';
109
110  private static CharSet allBiDiChars = new CharSet(LRE, RLE, PDF, LRO, RLO, LRI, RLI, FSI, PDI, LRM, RLM, ALM, PARA);
111
112  public static boolean hasBiDiChars(String src) {
113    for (char c : src.toCharArray()) {
114      if (allBiDiChars.contains(c)) {
115        return true;
116      }
117    }
118    return false;
119  }
120
121  /**
122   * returns null if src is well formed, or a description of a structure problem with bi-directional characters
123   * @param src
124   * @return
125   */
126  public static String checkUnicodeWellFormed(String src) {
127    StateStack ss = new StateStack();
128    for (int i = 0; i < src.length(); i++) {
129      char c = src.charAt(i);
130      if (allBiDiChars.contains(c)) {
131        switch (c) {
132        case PARA: 
133          ss.clear();
134          break;
135        case LRO:
136        case RLO:
137          ss.push(c, i);
138          break;
139        case PDF:
140          ss.popJustOne(new CharSet(LRE, RLE, LRO, RLO, LRM, RLM, ALM));
141          break;
142        case LRI:
143        case RLI:
144        case FSI:
145          ss.push(c, i);
146          break;
147        case PDI:
148          ss.popOneAndOthers(new CharSet(LRI, RLI, FSI), new CharSet(LRE, RLE, LRO, RLO, LRM, RLM, ALM));
149          break;
150        case LRM:
151        case RLM:
152        case ALM:
153          ss.push(c, i);
154          break;
155        }
156      }      
157    }
158    if (ss.empty()) {
159      return null;      
160    } else {
161      return ss.summary(src);
162    }
163  }
164
165  public static String describe(char c) {
166    switch (c) {
167    case LRE: return "LRE";
168    case RLE: return "RLE";
169    case PDF: return "PDF";
170    case LRO: return "LRO";
171    case RLO: return "RLO";
172    case LRI: return "LRI";
173    case RLI: return "RLI";
174    case FSI: return "FSI";
175    case PDI: return "PDI";
176    case LRM: return "LRM";
177    case RLM: return "RLM";
178    case ALM: return "ALM";
179    case PARA: return "PARA";
180    }
181    return String.valueOf(c);
182  }
183
184  public static Object replaceBiDiChars(String s) {
185    if (s == null) {
186      return null;
187    }
188    StringBuilder b = new StringBuilder();
189    for (char c : s.toCharArray()) {
190      if (allBiDiChars.contains(c)) {
191        b.append("|"+describe(c)+"|");
192        
193      } else {
194        b.append(c);
195      }
196    }
197    return b.toString();
198  }
199}