feat(java_common): add function to render signature as plaintext (#5400)

kythe · Oct 21, 2022 · a70ccc0 · a70ccc0
1 parent 50e7e23
commit a70ccc0
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/kythe/java/com/google/devtools/kythe/doc/MarkedSourceRenderer.java b/kythe/java/com/google/devtools/kythe/doc/MarkedSourceRenderer.java
@@ -50,6 +50,20 @@ public static SafeHtml renderSignature(
             0);
   }
 
+  /**
+   * Render {@code signature} a full signature as plaintext.
+   *
+   * @param signature the {@link MarkedSource} to render.
+   */
+  public static String renderSignatureText(MarkedSource signature) {
+    return new RenderSimpleIdentifierState(null)
+        .renderText(
+            signature,
+            Sets.immutableEnumSet(
+                MarkedSource.Kind.IDENTIFIER, MarkedSource.Kind.TYPE, MarkedSource.Kind.PARAMETER),
+            0);
+  }
+
   /**
    * Extract and render a plaintext initializer from {@code signature}.
    *

diff --git a/kythe/javatests/com/google/devtools/kythe/doc/MarkedSourceRendererTest.java b/kythe/javatests/com/google/devtools/kythe/doc/MarkedSourceRendererTest.java
@@ -81,6 +81,8 @@ public void testRenderingSignatures() throws IOException {
         .isEqualTo(
             "<span>void H(<a href=\"a\">String </a>message, <a href=\"b\">Throwable"
                 + " </a>cause)</span>");
+    assertThat(MarkedSourceRenderer.renderSignatureText(markedSource))
+        .isEqualTo("void H(String message, Throwable cause)");
   }
 
   public void testRenderingLists() throws IOException {