LocalProcessTerminalView.html 33 KB

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