Extracted StructuredDocString interface and moved to PSI API

python/psi-api/src/com/jetbrains/python/psi/StructuredDocString.java

@@ -0,0 +1,69 @@
+package com.jetbrains.python.psi;
+
+import com.jetbrains.python.toolbox.Substring;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.List;
+
+/**
+ * @author vlan
+ */
+public interface StructuredDocString {
+  String getDescription();
+
+  String getSummary();
+
+  @Nullable
+  Substring getTagValue(String... tagNames);
+
+  @Nullable
+  Substring getTagValue(String tagName, @NotNull String argName);
+
+  @Nullable
+  Substring getTagValue(String[] tagNames, @NotNull String argName);
+
+  List<Substring> getTagArguments(String... tagNames);
+
+  List<Substring> getParameterSubstrings();
+
+  @Nullable
+  Substring getParamByNameAndKind(@NotNull String name, String kind);
+
+  List<String> getParameters();
+
+  List<String> getKeywordArguments();
+
+  @Nullable
+  String getReturnType();
+
+  @Nullable
+  String getReturnDescription();
+
+  @Nullable
+  String getParamType(@Nullable String paramName);
+
+  @Nullable
+  String getParamDescription(@Nullable String paramName);
+
+  @Nullable
+  String getKeywordArgumentDescription(@Nullable String paramName);
+
+  List<String> getRaisedExceptions();
+
+  @Nullable
+  String getRaisedExceptionDescription(@Nullable String exceptionName);
+
+  @Nullable
+  String getAttributeDescription();
+
+  List<String> getAdditionalTags();
+
+  List<Substring> getKeywordArgumentSubstrings();
+
+  @Nullable
+  Substring getReturnTypeSubstring();
+
+  @Nullable
+  Substring getParamTypeSubstring(@Nullable String paramName);
+}

python/psi-api/src/com/jetbrains/python/toolbox/Substring.java

@@ -0,0 +1,178 @@
+package com.jetbrains.python.toolbox;
+
+import com.intellij.openapi.util.TextRange;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ * Substring with explicit offsets within its parent string.
+ * <p>
+ * Regular java.lang.String objects share a single char buffer for results of substring(), trim(), etc., but the offset and count
+ * fields of Strings are unfortunately private.
+ *
+ * @author vlan
+ */
+public class Substring implements CharSequence {
+  private static final Pattern RE_NL = Pattern.compile("(\\r?\\n)");
+
+  @NotNull private final String myString;
+  private final int myStartOffset;
+  private final int myEndOffset;
+
+  public Substring(@NotNull String s) {
+    this(s, 0, s.length());
+  }
+
+  public Substring(@NotNull String s, int start, int end) {
+    myString = s;
+    myStartOffset = start;
+    myEndOffset = end;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (o instanceof String) {
+      return toString().equals(o);
+    }
+    else if (o instanceof Substring) {
+      return toString().equals(o.toString());
+    }
+    return false;
+  }
+
+  @Override
+  public int hashCode() {
+    return toString().hashCode();
+  }
+
+  @NotNull
+  @Override
+  public String toString() {
+    return getValue();
+  }
+
+  @NotNull
+  public String getValue() {
+    return getTextRange().substring(myString);
+  }
+
+  @NotNull
+  public String getSuperString() {
+    return myString;
+  }
+
+  @NotNull
+  public TextRange getTextRange() {
+    return TextRange.create(myStartOffset, myEndOffset);
+  }
+
+  @NotNull
+  public List<Substring> split(@NotNull String regex) {
+    return split(Pattern.compile(regex));
+  }
+
+  @NotNull
+  public List<Substring> split(@NotNull Pattern pattern) {
+    final List<Substring> result = new ArrayList<Substring>();
+    final Matcher m = pattern.matcher(myString);
+    int start = myStartOffset;
+    int end = myEndOffset;
+    if (m.find(start)) {
+      do {
+        end = m.start();
+        result.add(createAnotherSubstring(start, Math.min(end, myEndOffset)));
+        start = m.end();
+      } while (end < myEndOffset && m.find());
+      if (start < myEndOffset) {
+        result.add(createAnotherSubstring(start, myEndOffset));
+      }
+    } else {
+      result.add(createAnotherSubstring(start, end));
+    }
+    return result;
+  }
+
+  @NotNull
+  public List<Substring> splitLines() {
+    return split(RE_NL);
+  }
+
+  @NotNull
+  public Substring trim() {
+    int start;
+    int end;
+    for (start = myStartOffset; start < myEndOffset && myString.charAt(start) <= '\u0020'; start++) {
+    }
+    for (end = myEndOffset - 1; end > start && myString.charAt(end) <= '\u0020'; end--) {
+    }
+    return createAnotherSubstring(start, end + 1);
+  }
+
+  @NotNull
+  public Substring getMatcherGroup(@NotNull Matcher m, int group) {
+    return substring(m.start(group), m.end(group));
+  }
+
+  @Override
+  public int length() {
+    return myEndOffset - myStartOffset;
+  }
+
+  @Override
+  public char charAt(int i) {
+    return myString.charAt(myStartOffset + i);
+  }
+
+  @Override
+  public CharSequence subSequence(int start, int end) {
+    return substring(start,  end);
+  }
+
+  public boolean startsWith(@NotNull String prefix) {
+    return indexOf(prefix) == 0;
+  }
+
+  public boolean endsWith(@NotNull String prefix) {
+    return myString.lastIndexOf(prefix) == length();
+  }
+
+  public int indexOf(@NotNull String s) {
+    int n = myString.indexOf(s, myStartOffset);
+    return n < myEndOffset ? n - myStartOffset : -1;
+  }
+
+  @NotNull
+  @SuppressWarnings({"MethodNamesDifferingOnlyByCase"})
+  public Substring substring(int start) {
+    return substring(start, length());
+  }
+
+  @NotNull
+  @SuppressWarnings({"MethodNamesDifferingOnlyByCase"})
+  public Substring substring(int start, int end) {
+    return createAnotherSubstring(myStartOffset + start, myStartOffset + end);
+  }
+
+  @NotNull
+  public String concatTrimmedLines(@NotNull String separator) {
+    final StringBuilder b = new StringBuilder();
+    List<Substring> lines = splitLines();
+    final int n = lines.size();
+    for (int i = 0; i < n; i++) {
+      b.append(lines.get(i).trim().toString());
+      if (i < n - 1) {
+        b.append(separator);
+      }
+    }
+    return b.toString();
+  }
+
+  @NotNull
+  private Substring createAnotherSubstring(int start, int end) {
+    return new Substring(myString, start, end);
+  }
+}