Add plugin annotations to String API that have to be supported easily and be useful

Author: koperagen

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/cast.kt

@@ -9,6 +9,7 @@ import org.jetbrains.kotlinx.dataframe.DataColumn
 import org.jetbrains.kotlinx.dataframe.DataFrame
 import org.jetbrains.kotlinx.dataframe.DataRow
 import org.jetbrains.kotlinx.dataframe.annotations.Check
+import org.jetbrains.kotlinx.dataframe.annotations.Interpretable
 import org.jetbrains.kotlinx.dataframe.columns.ColumnAccessor
 import org.jetbrains.kotlinx.dataframe.columns.ColumnGroup
 import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
@@ -84,8 +85,10 @@ public fun <T> ColumnGroup<*>.cast(): ColumnGroup<T> = this as ColumnGroup<T>
 
 public fun <T> ColumnWithPath<*>.cast(): ColumnWithPath<T> = this as ColumnWithPath<T>
 
+@Interpretable("ColumnAccessorCast")
 public fun <T> ColumnAccessor<*>.cast(): ColumnAccessor<T> = this as ColumnAccessor<T>
 
+@Interpretable("ColumnSetCast")
 public fun <C> ColumnSet<*>.cast(): ColumnSet<C> = this as ColumnSet<C>
 
 public fun <C> ColumnsResolver<*>.cast(): ColumnsResolver<C> = this as ColumnsResolver<C>

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/col.kt

@@ -5,6 +5,7 @@ import org.jetbrains.kotlinx.dataframe.ColumnGroupReference
 import org.jetbrains.kotlinx.dataframe.DataFrame
 import org.jetbrains.kotlinx.dataframe.DataRow
 import org.jetbrains.kotlinx.dataframe.annotations.AccessApiOverload
+import org.jetbrains.kotlinx.dataframe.annotations.Interpretable
 import org.jetbrains.kotlinx.dataframe.columns.ColumnAccessor
 import org.jetbrains.kotlinx.dataframe.columns.ColumnGroup
 import org.jetbrains.kotlinx.dataframe.columns.ColumnPath
@@ -225,12 +226,14 @@ public interface ColColumnsSelectionDsl<out _UNUSED> {
      */
     @Suppress("INAPPLICABLE_JVM_NAME")
     @JvmName("colUnTyped")
+    @Interpretable("Col")
     public fun col(name: String): ColumnAccessor<*> = column<Any?>(name)
 
     /**
      * @include [ColNameDocs] {@set [CommonColDocs.RECEIVER]}
      * @include [CommonColDocs.ColumnTypeParam]
      */
+    @Interpretable("ColUntyped")
     public fun <C> col(name: String): ColumnAccessor<C> = column(name)
 
     /**
@@ -269,12 +272,14 @@ public interface ColColumnsSelectionDsl<out _UNUSED> {
      */
     @Suppress("INAPPLICABLE_JVM_NAME")
     @JvmName("colUnTyped")
+    @Interpretable("StringNestedColUntyped")
     public fun String.col(name: String): ColumnAccessor<*> = col<Any?>(name)
 
     /**
      * @include [ColNameDocs] {@set [CommonColDocs.RECEIVER] "myColumnGroup".}
      * @include [CommonColDocs.ColumnTypeParam]
      */
+    @Interpretable("StringNestedCol")
     public fun <C> String.col(name: String): ColumnAccessor<C> =
         columnGroup(this)
             .ensureIsColumnGroup()
@@ -303,12 +308,14 @@ public interface ColColumnsSelectionDsl<out _UNUSED> {
      */
     @Suppress("INAPPLICABLE_JVM_NAME")
     @JvmName("colUnTyped")
+    @Interpretable("ColumnPathColUntyped")
     public fun ColumnPath.col(name: String): ColumnAccessor<*> = col<Any?>(name)
 
     /**
      * @include [ColNameDocs] {@set [CommonColDocs.RECEIVER] "pathTo"["myColumnGroup"].}
      * @include [CommonColDocs.ColumnTypeParam]
      */
+    @Interpretable("ColumnPathCol")
     public fun <C> ColumnPath.col(name: String): ColumnAccessor<C> =
         columnGroup(this).ensureIsColumnGroup().column(name)
 

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/constructors.kt

@@ -545,6 +545,7 @@ public fun <T> emptyDataFrame(): DataFrame<T> = DataFrame.empty().cast()
 
 // region create ColumnPath
 
+@Interpretable("PathOf")
 public fun pathOf(vararg columnNames: String): ColumnPath = ColumnPath(columnNames.asList())
 
 // endregion

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/select.kt

@@ -81,6 +81,8 @@ public fun <T> DataFrame<T>.select(vararg columns: KProperty<*>): DataFrame<T> =
  * @include [SelectingColumns.ColumnNames.WithExample] {@include [SetSelectOperationArg]}
  * @param [columns] The [Column Names][String] used to select the columns of this [DataFrame].
  */
+@Refine
+@Interpretable("SelectString")
 public fun <T> DataFrame<T>.select(vararg columns: String): DataFrame<T> = select { columns.toColumnSet() }
 
 /**
@@ -206,6 +208,7 @@ public interface SelectColumnsSelectionDsl {
      *
      * `df.`[select][DataFrame.select]`  { "myColGroup"  `[`{`][String.select]`  colA  `[and][ColumnsSelectionDsl.and]`  colB  `[`}`][String.select]` }`
      */
+    @Interpretable("StringSelect")
     public fun <R> String.select(selector: ColumnsSelector<*, R>): ColumnSet<R> = columnGroup(this).select(selector)
 
     /**
@@ -220,6 +223,7 @@ public interface SelectColumnsSelectionDsl {
      *
      * `df.`[select][DataFrame.select]`  {  `[pathOf][pathOf]`("pathTo", "myColGroup")`[`() {`][ColumnPath.select]`  someCol  `[and][ColumnsSelectionDsl.and]` `[colsOf][SingleColumn.colsOf]`<`[String][String]`>() `[`}`][ColumnPath.select]` }`
      */
+    @Interpretable("ColumnPathSelect")
     public fun <R> ColumnPath.select(selector: ColumnsSelector<*, R>): ColumnSet<R> = columnGroup(this).select(selector)
 }