LocalProcessTerminalView.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <title>LocalProcessTerminalView Class Reference</title>
  5. <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
  6. <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
  7. <meta charset='utf-8'>
  8. <script src="../js/jquery.min.js" defer></script>
  9. <script src="../js/jazzy.js" defer></script>
  10. <script src="../js/lunr.min.js" defer></script>
  11. <script src="../js/typeahead.jquery.js" defer></script>
  12. <script src="../js/jazzy.search.js" defer></script>
  13. </head>
  14. <body>
  15. <a name="//apple_ref/swift/Class/LocalProcessTerminalView" class="dashAnchor"></a>
  16. <a title="LocalProcessTerminalView Class Reference"></a>
  17. <header>
  18. <div class="content-wrapper">
  19. <p><a href="../index.html">SwiftTerm 1.0 Docs</a> (68% documented)</p>
  20. <p class="header-right"><a href="https://github.com/migueldeicaza/SwiftTerm"><img src="../img/gh.png"/>View on GitHub</a></p>
  21. <p class="header-right"><a href="dash-feed://https%3A%2F%2Fmigueldeicaza.github.io%2FSwiftTerm%2Fdocsets%2FSwiftTerm.xml"><img src="../img/dash.png"/>Install in Dash</a></p>
  22. <p class="header-right">
  23. <form role="search" action="../search.json">
  24. <input type="text" placeholder="Search documentation" data-typeahead>
  25. </form>
  26. </p>
  27. </div>
  28. </header>
  29. <div class="content-wrapper">
  30. <p id="breadcrumbs">
  31. <a href="../index.html">SwiftTerm Reference</a>
  32. <img id="carat" src="../img/carat.png" />
  33. LocalProcessTerminalView Class Reference
  34. </p>
  35. </div>
  36. <div class="content-wrapper">
  37. <nav class="sidebar">
  38. <ul class="nav-groups">
  39. <li class="nav-group-name">
  40. <a href="../Classes.html">Classes</a>
  41. <ul class="nav-group-tasks">
  42. <li class="nav-group-task">
  43. <a href="../Classes/BufferLine.html">BufferLine</a>
  44. </li>
  45. <li class="nav-group-task">
  46. <a href="../Classes/Color.html">Color</a>
  47. </li>
  48. <li class="nav-group-task">
  49. <a href="../Classes/HeadlessTerminal.html">HeadlessTerminal</a>
  50. </li>
  51. <li class="nav-group-task">
  52. <a href="../Classes/ImageCell.html">ImageCell</a>
  53. </li>
  54. <li class="nav-group-task">
  55. <a href="../Classes/LocalProcess.html">LocalProcess</a>
  56. </li>
  57. <li class="nav-group-task">
  58. <a href="../Classes/LocalProcessTerminalView.html">LocalProcessTerminalView</a>
  59. </li>
  60. <li class="nav-group-task">
  61. <a href="../Classes/PseudoTerminalHelpers.html">PseudoTerminalHelpers</a>
  62. </li>
  63. <li class="nav-group-task">
  64. <a href="../Classes/Terminal.html">Terminal</a>
  65. </li>
  66. <li class="nav-group-task">
  67. <a href="../Classes/Terminal/MouseMode.html">– MouseMode</a>
  68. </li>
  69. <li class="nav-group-task">
  70. <a href="../Classes/Terminal/WindowManipulationCommand.html">– WindowManipulationCommand</a>
  71. </li>
  72. <li class="nav-group-task">
  73. <a href="../Classes/Terminal/BufferKind.html">– BufferKind</a>
  74. </li>
  75. <li class="nav-group-task">
  76. <a href="../Classes/TerminalAccessory.html">TerminalAccessory</a>
  77. </li>
  78. <li class="nav-group-task">
  79. <a href="../Classes/TerminalDebugView.html">TerminalDebugView</a>
  80. </li>
  81. <li class="nav-group-task">
  82. <a href="../Classes/TerminalView.html">TerminalView</a>
  83. </li>
  84. <li class="nav-group-task">
  85. <a href="../Classes/TerminalView.html">TerminalView</a>
  86. </li>
  87. </ul>
  88. </li>
  89. <li class="nav-group-name">
  90. <a href="../Enums.html">Enumerations</a>
  91. <ul class="nav-group-tasks">
  92. <li class="nav-group-task">
  93. <a href="../Enums/CursorStyle.html">CursorStyle</a>
  94. </li>
  95. <li class="nav-group-task">
  96. <a href="../Enums/ImageSizeRequest.html">ImageSizeRequest</a>
  97. </li>
  98. </ul>
  99. </li>
  100. <li class="nav-group-name">
  101. <a href="../Extensions.html">Extensions</a>
  102. <ul class="nav-group-tasks">
  103. <li class="nav-group-task">
  104. <a href="../Extensions/TerminalViewDelegate.html">TerminalViewDelegate</a>
  105. </li>
  106. <li class="nav-group-task">
  107. <a href="../Extensions/UIImage.html">UIImage</a>
  108. </li>
  109. </ul>
  110. </li>
  111. <li class="nav-group-name">
  112. <a href="../Protocols.html">Protocols</a>
  113. <ul class="nav-group-tasks">
  114. <li class="nav-group-task">
  115. <a href="../Protocols/LocalProcessDelegate.html">LocalProcessDelegate</a>
  116. </li>
  117. <li class="nav-group-task">
  118. <a href="../Protocols/LocalProcessTerminalViewDelegate.html">LocalProcessTerminalViewDelegate</a>
  119. </li>
  120. <li class="nav-group-task">
  121. <a href="../Protocols/TerminalDelegate.html">TerminalDelegate</a>
  122. </li>
  123. <li class="nav-group-task">
  124. <a href="../Protocols/TerminalImage.html">TerminalImage</a>
  125. </li>
  126. <li class="nav-group-task">
  127. <a href="../Protocols/TerminalViewDelegate.html">TerminalViewDelegate</a>
  128. </li>
  129. </ul>
  130. </li>
  131. <li class="nav-group-name">
  132. <a href="../Structs.html">Structures</a>
  133. <ul class="nav-group-tasks">
  134. <li class="nav-group-task">
  135. <a href="../Structs/Attribute.html">Attribute</a>
  136. </li>
  137. <li class="nav-group-task">
  138. <a href="../Structs/Attribute/Color.html">– Color</a>
  139. </li>
  140. <li class="nav-group-task">
  141. <a href="../Structs/CharData.html">CharData</a>
  142. </li>
  143. <li class="nav-group-task">
  144. <a href="../Structs/CharacterStyle.html">CharacterStyle</a>
  145. </li>
  146. <li class="nav-group-task">
  147. <a href="../Structs/TerminalOptions.html">TerminalOptions</a>
  148. </li>
  149. <li class="nav-group-task">
  150. <a href="../Structs/TinyAtom.html">TinyAtom</a>
  151. </li>
  152. </ul>
  153. </li>
  154. <li class="nav-group-name">
  155. <a href="../Typealiases.html">Type Aliases</a>
  156. <ul class="nav-group-tasks">
  157. <li class="nav-group-task">
  158. <a href="../Typealiases.html#/TTImage">TTImage</a>
  159. </li>
  160. <li class="nav-group-task">
  161. <a href="../Typealiases.html#/s:9SwiftTerm7TTImagea">TTImage</a>
  162. </li>
  163. </ul>
  164. </li>
  165. </ul>
  166. </nav>
  167. <article class="main-content">
  168. <section>
  169. <section class="section">
  170. <h1>LocalProcessTerminalView</h1>
  171. <div class="declaration">
  172. <div class="language">
  173. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">LocalProcessTerminalView</span> <span class="p">:</span> <span class="kt"><a href="../Classes/TerminalView.html">TerminalView</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/TerminalViewDelegate.html">TerminalViewDelegate</a></span><span class="p">,</span> <span class="kt"><a href="../Protocols/LocalProcessDelegate.html">LocalProcessDelegate</a></span></code></pre>
  174. </div>
  175. </div>
  176. <p><code>LocalProcessTerminalView</code> is an AppKit NSView that can be used to host a local process
  177. the process is launched inside a pseudo-terminal.</p>
  178. <p>Call the <code>startProcess</code> to launch the underlying process inside a pseudo terminal.</p>
  179. <p>Generally, for the <code>LocalProcessTerminalView</code> to be useful, you will want to disable the sandbox
  180. for your application, otherwise the underlying shell will not have access to much - not the majority of
  181. commands, not assorted places on the file systems and so on. For this, you need to disable for your
  182. target in &ldquo;Signing and Capabilities&rdquo; the sandbox entirely.</p>
  183. <p>Note: instances of <code>LocalProcessTerminalView</code> will set the <code><a href="../Classes/TerminalView.html">TerminalView</a></code>&lsquo;s <code>delegate</code>
  184. property and capture and consume the messages. The messages that are most likely needed for
  185. consumer applications are reposted to the <code><a href="../Protocols/LocalProcessTerminalViewDelegate.html">LocalProcessTerminalViewDelegate</a></code> in
  186. <code>processDelegate</code>. If you override the <code>delegate</code> directly, you might inadvertently break
  187. the internal working of <code>LocalProcessTerminalView</code>. If you must change the <code>delegate</code>
  188. make sure that you proxy the values in your implementation to the values set after initializing this instance</p>
  189. </section>
  190. <section class="section task-group-section">
  191. <div class="task-group">
  192. <ul>
  193. <li class="item">
  194. <div>
  195. <code>
  196. <a name="/c:@M@SwiftTerm@objc(cs)LocalProcessTerminalView(im)initWithFrame:"></a>
  197. <a name="//apple_ref/swift/Method/init(frame:)" class="dashAnchor"></a>
  198. <a class="token" href="#/c:@M@SwiftTerm@objc(cs)LocalProcessTerminalView(im)initWithFrame:">init(frame:<wbr>)</a>
  199. </code>
  200. </div>
  201. <div class="height-container">
  202. <div class="pointer-container"></div>
  203. <section class="section">
  204. <div class="pointer"></div>
  205. <div class="abstract">
  206. <p>Undocumented</p>
  207. </div>
  208. <div class="declaration">
  209. <h4>Declaration</h4>
  210. <div class="language">
  211. <p class="aside-title">Swift</p>
  212. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">override</span> <span class="nf">init</span><span class="p">(</span><span class="nv">frame</span><span class="p">:</span> <span class="kt">CGRect</span><span class="p">)</span></code></pre>
  213. </div>
  214. </div>
  215. </section>
  216. </div>
  217. </li>
  218. <li class="item">
  219. <div>
  220. <code>
  221. <a name="/c:@M@SwiftTerm@objc(cs)LocalProcessTerminalView(im)initWithCoder:"></a>
  222. <a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
  223. <a class="token" href="#/c:@M@SwiftTerm@objc(cs)LocalProcessTerminalView(im)initWithCoder:">init(coder:<wbr>)</a>
  224. </code>
  225. </div>
  226. <div class="height-container">
  227. <div class="pointer-container"></div>
  228. <section class="section">
  229. <div class="pointer"></div>
  230. <div class="abstract">
  231. <p>Undocumented</p>
  232. </div>
  233. <div class="declaration">
  234. <h4>Declaration</h4>
  235. <div class="language">
  236. <p class="aside-title">Swift</p>
  237. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">required</span> <span class="nf">init</span><span class="p">?(</span><span class="nv">coder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>
  238. </div>
  239. </div>
  240. </section>
  241. </div>
  242. </li>
  243. <li class="item">
  244. <div>
  245. <code>
  246. <a name="/s:9SwiftTerm24LocalProcessTerminalViewC15processDelegateAA0cdefH0_pSgvp"></a>
  247. <a name="//apple_ref/swift/Property/processDelegate" class="dashAnchor"></a>
  248. <a class="token" href="#/s:9SwiftTerm24LocalProcessTerminalViewC15processDelegateAA0cdefH0_pSgvp">processDelegate</a>
  249. </code>
  250. </div>
  251. <div class="height-container">
  252. <div class="pointer-container"></div>
  253. <section class="section">
  254. <div class="pointer"></div>
  255. <div class="abstract">
  256. <p>The <code>processDelegate</code> is used to deliver messages and information relevant t</p>
  257. </div>
  258. <div class="declaration">
  259. <h4>Declaration</h4>
  260. <div class="language">
  261. <p class="aside-title">Swift</p>
  262. <pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">processDelegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/LocalProcessTerminalViewDelegate.html">LocalProcessTerminalViewDelegate</a></span><span class="p">?</span></code></pre>
  263. </div>
  264. </div>
  265. </section>
  266. </div>
  267. </li>
  268. <li class="item">
  269. <div>
  270. <code>
  271. <a name="/s:9SwiftTerm24LocalProcessTerminalViewC11sizeChanged6source7newCols0J4RowsyAA0eF0C_S2itF"></a>
  272. <a name="//apple_ref/swift/Method/sizeChanged(source:newCols:newRows:)" class="dashAnchor"></a>
  273. <a class="token" href="#/s:9SwiftTerm24LocalProcessTerminalViewC11sizeChanged6source7newCols0J4RowsyAA0eF0C_S2itF">sizeChanged(source:<wbr>newCols:<wbr>newRows:<wbr>)</a>
  274. </code>
  275. </div>
  276. <div class="height-container">
  277. <div class="pointer-container"></div>
  278. <section class="section">
  279. <div class="pointer"></div>
  280. <div class="abstract">
  281. <p>This method is invoked to notify the client of the new columsn and rows that have been set by the UI</p>
  282. </div>
  283. <div class="declaration">
  284. <h4>Declaration</h4>
  285. <div class="language">
  286. <p class="aside-title">Swift</p>
  287. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">sizeChanged</span><span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Classes/TerminalView.html">TerminalView</a></span><span class="p">,</span> <span class="nv">newCols</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="nv">newRows</span><span class="p">:</span> <span class="kt">Int</span><span class="p">)</span></code></pre>
  288. </div>
  289. </div>
  290. </section>
  291. </div>
  292. </li>
  293. <li class="item">
  294. <div>
  295. <code>
  296. <a name="/s:9SwiftTerm24LocalProcessTerminalViewC03setE5Title6source5titleyAA0eF0C_SStF"></a>
  297. <a name="//apple_ref/swift/Method/setTerminalTitle(source:title:)" class="dashAnchor"></a>
  298. <a class="token" href="#/s:9SwiftTerm24LocalProcessTerminalViewC03setE5Title6source5titleyAA0eF0C_SStF">setTerminalTitle(source:<wbr>title:<wbr>)</a>
  299. </code>
  300. </div>
  301. <div class="height-container">
  302. <div class="pointer-container"></div>
  303. <section class="section">
  304. <div class="pointer"></div>
  305. <div class="abstract">
  306. <p>Invoke this method to notify the processDelegate of the new title for the terminal window</p>
  307. </div>
  308. <div class="declaration">
  309. <h4>Declaration</h4>
  310. <div class="language">
  311. <p class="aside-title">Swift</p>
  312. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">setTerminalTitle</span><span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Classes/TerminalView.html">TerminalView</a></span><span class="p">,</span> <span class="nv">title</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre>
  313. </div>
  314. </div>
  315. </section>
  316. </div>
  317. </li>
  318. <li class="item">
  319. <div>
  320. <code>
  321. <a name="/s:9SwiftTerm20TerminalViewDelegateP26hostCurrentDirectoryUpdate6source9directoryyAA0cD0C_SSSgtF"></a>
  322. <a name="//apple_ref/swift/Method/hostCurrentDirectoryUpdate(source:directory:)" class="dashAnchor"></a>
  323. <a class="token" href="#/s:9SwiftTerm20TerminalViewDelegateP26hostCurrentDirectoryUpdate6source9directoryyAA0cD0C_SSSgtF">hostCurrentDirectoryUpdate(source:<wbr>directory:<wbr>)</a>
  324. </code>
  325. </div>
  326. <div class="height-container">
  327. <div class="pointer-container"></div>
  328. <section class="section">
  329. <div class="pointer"></div>
  330. <div class="abstract">
  331. </div>
  332. <div class="declaration">
  333. <h4>Declaration</h4>
  334. <div class="language">
  335. <p class="aside-title">Swift</p>
  336. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">hostCurrentDirectoryUpdate</span><span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Classes/TerminalView.html">TerminalView</a></span><span class="p">,</span> <span class="nv">directory</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>
  337. </div>
  338. </div>
  339. </section>
  340. </div>
  341. </li>
  342. <li class="item">
  343. <div>
  344. <code>
  345. <a name="/s:9SwiftTerm24LocalProcessTerminalViewC4send6source4datayAA0eF0C_s10ArraySliceVys5UInt8VGtF"></a>
  346. <a name="//apple_ref/swift/Method/send(source:data:)" class="dashAnchor"></a>
  347. <a class="token" href="#/s:9SwiftTerm24LocalProcessTerminalViewC4send6source4datayAA0eF0C_s10ArraySliceVys5UInt8VGtF">send(source:<wbr>data:<wbr>)</a>
  348. </code>
  349. </div>
  350. <div class="height-container">
  351. <div class="pointer-container"></div>
  352. <section class="section">
  353. <div class="pointer"></div>
  354. <div class="abstract">
  355. <p>This method is invoked when input from the user needs to be sent to the client</p>
  356. </div>
  357. <div class="declaration">
  358. <h4>Declaration</h4>
  359. <div class="language">
  360. <p class="aside-title">Swift</p>
  361. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Classes/TerminalView.html">TerminalView</a></span><span class="p">,</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">ArraySlice</span><span class="o">&lt;</span><span class="kt">UInt8</span><span class="o">&gt;</span><span class="p">)</span></code></pre>
  362. </div>
  363. </div>
  364. </section>
  365. </div>
  366. </li>
  367. <li class="item">
  368. <div>
  369. <code>
  370. <a name="/s:9SwiftTerm24LocalProcessTerminalViewC14setHostLogging9directoryySSSg_tF"></a>
  371. <a name="//apple_ref/swift/Method/setHostLogging(directory:)" class="dashAnchor"></a>
  372. <a class="token" href="#/s:9SwiftTerm24LocalProcessTerminalViewC14setHostLogging9directoryySSSg_tF">setHostLogging(directory:<wbr>)</a>
  373. </code>
  374. </div>
  375. <div class="height-container">
  376. <div class="pointer-container"></div>
  377. <section class="section">
  378. <div class="pointer"></div>
  379. <div class="abstract">
  380. <p>Use this method to toggle the logging of data coming from the host, or pass nil to stop</p>
  381. </div>
  382. <div class="declaration">
  383. <h4>Declaration</h4>
  384. <div class="language">
  385. <p class="aside-title">Swift</p>
  386. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">setHostLogging</span><span class="p">(</span><span class="nv">directory</span><span class="p">:</span> <span class="kt">String</span><span class="p">?)</span></code></pre>
  387. </div>
  388. </div>
  389. </section>
  390. </div>
  391. </li>
  392. <li class="item">
  393. <div>
  394. <code>
  395. <a name="/s:9SwiftTerm20TerminalViewDelegateP8scrolled6source8positionyAA0cD0C_SdtF"></a>
  396. <a name="//apple_ref/swift/Method/scrolled(source:position:)" class="dashAnchor"></a>
  397. <a class="token" href="#/s:9SwiftTerm20TerminalViewDelegateP8scrolled6source8positionyAA0cD0C_SdtF">scrolled(source:<wbr>position:<wbr>)</a>
  398. </code>
  399. </div>
  400. <div class="height-container">
  401. <div class="pointer-container"></div>
  402. <section class="section">
  403. <div class="pointer"></div>
  404. <div class="abstract">
  405. </div>
  406. <div class="declaration">
  407. <h4>Declaration</h4>
  408. <div class="language">
  409. <p class="aside-title">Swift</p>
  410. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">scrolled</span><span class="p">(</span><span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Classes/TerminalView.html">TerminalView</a></span><span class="p">,</span> <span class="nv">position</span><span class="p">:</span> <span class="kt">Double</span><span class="p">)</span></code></pre>
  411. </div>
  412. </div>
  413. </section>
  414. </div>
  415. </li>
  416. <li class="item">
  417. <div>
  418. <code>
  419. <a name="/s:9SwiftTerm24LocalProcessTerminalViewC05startD010executable4args11environment8execNameySS_SaySSGAISgSSSgtF"></a>
  420. <a name="//apple_ref/swift/Method/startProcess(executable:args:environment:execName:)" class="dashAnchor"></a>
  421. <a class="token" href="#/s:9SwiftTerm24LocalProcessTerminalViewC05startD010executable4args11environment8execNameySS_SaySSGAISgSSSgtF">startProcess(executable:<wbr>args:<wbr>environment:<wbr>execName:<wbr>)</a>
  422. </code>
  423. </div>
  424. <div class="height-container">
  425. <div class="pointer-container"></div>
  426. <section class="section">
  427. <div class="pointer"></div>
  428. <div class="abstract">
  429. <p>Launches a child process inside a pseudo-terminal.</p>
  430. </div>
  431. <div class="declaration">
  432. <h4>Declaration</h4>
  433. <div class="language">
  434. <p class="aside-title">Swift</p>
  435. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">startProcess</span><span class="p">(</span><span class="nv">executable</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="s">"/bin/bash"</span><span class="p">,</span> <span class="nv">args</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span> <span class="nv">environment</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span> <span class="nv">execName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
  436. </div>
  437. </div>
  438. <div>
  439. <h4>Parameters</h4>
  440. <table class="graybox">
  441. <tbody>
  442. <tr>
  443. <td>
  444. <code>
  445. <em>executable</em>
  446. </code>
  447. </td>
  448. <td>
  449. <div>
  450. <p>The executable to launch inside the pseudo terminal, defaults to /bin/bash</p>
  451. </div>
  452. </td>
  453. </tr>
  454. <tr>
  455. <td>
  456. <code>
  457. <em>args</em>
  458. </code>
  459. </td>
  460. <td>
  461. <div>
  462. <p>an array of strings that is passed as the arguments to the underlying process</p>
  463. </div>
  464. </td>
  465. </tr>
  466. <tr>
  467. <td>
  468. <code>
  469. <em>environment</em>
  470. </code>
  471. </td>
  472. <td>
  473. <div>
  474. <p>an array of environment variables to pass to the child process, if this is null, this picks a good set of defaults from <code>Terminal.getEnvironmentVariables</code>.</p>
  475. </div>
  476. </td>
  477. </tr>
  478. <tr>
  479. <td>
  480. <code>
  481. <em>execName</em>
  482. </code>
  483. </td>
  484. <td>
  485. <div>
  486. <p>If provided, this is used as the Unix argv[0] parameter, otherwise, the executable is used as the args [0], this is used when the intent is to set a different process name than the file that backs it.</p>
  487. </div>
  488. </td>
  489. </tr>
  490. </tbody>
  491. </table>
  492. </div>
  493. </section>
  494. </div>
  495. </li>
  496. <li class="item">
  497. <div>
  498. <code>
  499. <a name="/s:9SwiftTerm24LocalProcessTerminalViewC17processTerminated_8exitCodeyAA0cD0C_s5Int32VSgtF"></a>
  500. <a name="//apple_ref/swift/Method/processTerminated(_:exitCode:)" class="dashAnchor"></a>
  501. <a class="token" href="#/s:9SwiftTerm24LocalProcessTerminalViewC17processTerminated_8exitCodeyAA0cD0C_s5Int32VSgtF">processTerminated(_:<wbr>exitCode:<wbr>)</a>
  502. </code>
  503. </div>
  504. <div class="height-container">
  505. <div class="pointer-container"></div>
  506. <section class="section">
  507. <div class="pointer"></div>
  508. <div class="abstract">
  509. <p>Implements the LocalProcessDelegate method.</p>
  510. </div>
  511. <div class="declaration">
  512. <h4>Declaration</h4>
  513. <div class="language">
  514. <p class="aside-title">Swift</p>
  515. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">processTerminated</span><span class="p">(</span><span class="n">_</span> <span class="nv">source</span><span class="p">:</span> <span class="kt"><a href="../Classes/LocalProcess.html">LocalProcess</a></span><span class="p">,</span> <span class="nv">exitCode</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">?)</span></code></pre>
  516. </div>
  517. </div>
  518. </section>
  519. </div>
  520. </li>
  521. <li class="item">
  522. <div>
  523. <code>
  524. <a name="/s:9SwiftTerm24LocalProcessTerminalViewC12dataReceived5sliceys10ArraySliceVys5UInt8VG_tF"></a>
  525. <a name="//apple_ref/swift/Method/dataReceived(slice:)" class="dashAnchor"></a>
  526. <a class="token" href="#/s:9SwiftTerm24LocalProcessTerminalViewC12dataReceived5sliceys10ArraySliceVys5UInt8VG_tF">dataReceived(slice:<wbr>)</a>
  527. </code>
  528. </div>
  529. <div class="height-container">
  530. <div class="pointer-container"></div>
  531. <section class="section">
  532. <div class="pointer"></div>
  533. <div class="abstract">
  534. <p>Implements the LocalProcessDelegate.dataReceived method</p>
  535. </div>
  536. <div class="declaration">
  537. <h4>Declaration</h4>
  538. <div class="language">
  539. <p class="aside-title">Swift</p>
  540. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">dataReceived</span><span class="p">(</span><span class="nv">slice</span><span class="p">:</span> <span class="kt">ArraySlice</span><span class="o">&lt;</span><span class="kt">UInt8</span><span class="o">&gt;</span><span class="p">)</span></code></pre>
  541. </div>
  542. </div>
  543. </section>
  544. </div>
  545. </li>
  546. <li class="item">
  547. <div>
  548. <code>
  549. <a name="/s:9SwiftTerm24LocalProcessTerminalViewC13getWindowSizeSo7winsizeVyF"></a>
  550. <a name="//apple_ref/swift/Method/getWindowSize()" class="dashAnchor"></a>
  551. <a class="token" href="#/s:9SwiftTerm24LocalProcessTerminalViewC13getWindowSizeSo7winsizeVyF">getWindowSize()</a>
  552. </code>
  553. </div>
  554. <div class="height-container">
  555. <div class="pointer-container"></div>
  556. <section class="section">
  557. <div class="pointer"></div>
  558. <div class="abstract">
  559. <p>Implements the LocalProcessDelegate.getWindowSize method</p>
  560. </div>
  561. <div class="declaration">
  562. <h4>Declaration</h4>
  563. <div class="language">
  564. <p class="aside-title">Swift</p>
  565. <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">getWindowSize</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="n">winsize</span></code></pre>
  566. </div>
  567. </div>
  568. </section>
  569. </div>
  570. </li>
  571. </ul>
  572. </div>
  573. </section>
  574. </section>
  575. <section id="footer">
  576. <p>&copy; 2021 <a class="link" href="https://tirania.org/" target="_blank" rel="external">Miguel de Icaza</a>. All rights reserved. (Last updated: 2021-04-28)</p>
  577. <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
  578. </section>
  579. </article>
  580. </div>
  581. </body>
  582. </div>
  583. </html>