|
| 1 | +--- |
| 2 | +title: Accessing Source File Paths |
| 3 | +sidebar_position: 10 |
| 4 | +--- |
| 5 | + |
| 6 | +## Source Names and Paths |
| 7 | + |
| 8 | +System properties provide source file paths, separated by `java.io.File.pathSeparator`. |
| 9 | +- `scala.source.names` filenames without a path. |
| 10 | +- `scala.sources` full paths to source files |
| 11 | + |
| 12 | +### System property `scala.source.names` |
| 13 | + |
| 14 | +This simple script reports the script file name: |
| 15 | + |
| 16 | +```scala title=reportNames.sc |
| 17 | +val name = sys.props("scala.source.names") |
| 18 | +println(s"scriptName: $name") |
| 19 | +``` |
| 20 | + |
| 21 | +```bash |
| 22 | +scala-cli reportNames.sc |
| 23 | +# scriptName: reportNames.sc |
| 24 | +``` |
| 25 | + |
| 26 | +<!-- Expected-regex: |
| 27 | +scriptName: reportNames.sc |
| 28 | +--> |
| 29 | + |
| 30 | +Likewise, for this `.scala` program: |
| 31 | + |
| 32 | +```scala title=SourceNames.scala |
| 33 | +object Main { |
| 34 | + def main(args: Array[String]): Unit = |
| 35 | + val names = sys.props("scala.source.names") |
| 36 | + println(names) |
| 37 | +} |
| 38 | +``` |
| 39 | + |
| 40 | +```bash |
| 41 | +scala-cli SourceNames.scala |
| 42 | +# SourceNames.scala |
| 43 | +``` |
| 44 | + |
| 45 | +<!-- Expected-regex: |
| 46 | +SourceNames[.]scala |
| 47 | +--> |
| 48 | + |
| 49 | +This java program prints a comma-separated list of source names: |
| 50 | + |
| 51 | +```java title=NamesLister.java |
| 52 | +public class NamesLister { |
| 53 | + public static void main(String[] args) { |
| 54 | + String sourceNames = System.getProperty("scala.source.names"); |
| 55 | + String[] names = sourceNames.split(java.io.File.pathSeparator); |
| 56 | + String list = String.join(",", names); |
| 57 | + System.out.printf("%s\n", list); |
| 58 | + } |
| 59 | +} |
| 60 | + |
| 61 | +``` |
| 62 | + |
| 63 | +```bash |
| 64 | +scala-cli NamesLister.java |
| 65 | +# NamesLister.java |
| 66 | +``` |
| 67 | + |
| 68 | +<!-- Expected-regex: |
| 69 | +NamesLister.java |
| 70 | +--> |
| 71 | + |
| 72 | + |
| 73 | +If multiple sources are provided, all are displayed: |
| 74 | + |
| 75 | +```bash |
| 76 | +scala-cli NamesLister.java reportNames.sc SourceNames.scala --main-class NamesLister |
| 77 | +# NamesLister.java,reportNames.sc,SourceNames.scala |
| 78 | +``` |
| 79 | + |
| 80 | +<!-- Expected-regex: |
| 81 | +NamesLister[.]java,reportNames[.]sc,SourceNames[.]scala |
| 82 | +--> |
| 83 | + |
| 84 | +### System property `scala.sources` |
| 85 | + |
| 86 | +```java title=PathsLister.java |
| 87 | +public class PathsLister { |
| 88 | + public static void main(String[] args) { |
| 89 | + String paths = System.getProperty("scala.sources"); |
| 90 | + String list = String.join(",", paths.split(java.io.File.pathSeparator)); |
| 91 | + System.out.printf("%s\n", list); |
| 92 | + } |
| 93 | +} |
| 94 | +``` |
| 95 | +The property "scala.sources" displays full source file paths: |
| 96 | + |
| 97 | +```bash |
| 98 | +scala-cli PathsLister.java reportNames.sc SourceNames.scala --main-class PathsLister |
| 99 | +# /tmp/workdir/PathsLister.java,/tmp/workdir/reportNames.sc,/tmp/workdir/SourceNames.scala |
| 100 | +``` |
| 101 | + |
| 102 | +<!-- Expected-regex: |
| 103 | +.*/PathsLister[.]java,.*/reportNames[.]sc,.*/SourceNames[.]scala |
| 104 | +--> |
| 105 | + |
| 106 | +### Other examples |
| 107 | + |
| 108 | +When multiple `.md` files with plain `scala` snippets are being run, names and paths can refer to '.md' files: |
| 109 | + |
| 110 | +````markdown title=MainA.md |
| 111 | +# Main class A |
| 112 | +```scala |
| 113 | +println(s"A: ${sys.props("scala.source.names")}") |
| 114 | +``` |
| 115 | +```` |
| 116 | + |
| 117 | + |
| 118 | +````markdown title=MainB.md |
| 119 | +# Main class 2 |
| 120 | +```scala |
| 121 | +println(s"2: ${sys.props("scala.source.names")}") |
| 122 | +``` |
| 123 | +```` |
| 124 | + |
| 125 | +When multiple such sources are passed as inputs, the main class has to be passed explicitly with the `--main-class` |
| 126 | +option. |
| 127 | + |
| 128 | +```bash |
| 129 | +scala-cli --power MainA.md MainB.md --main-class MainA_md |
| 130 | +# A: MainA.md:MainB.md |
| 131 | +``` |
| 132 | + |
| 133 | +```text |
| 134 | +1: MainA.md:MainB.md |
| 135 | +``` |
| 136 | +<!-- Expected-regex: |
| 137 | +A: MainA[.]md:MainB[.]md |
| 138 | +--> |
0 commit comments