Executing External Programs/sk: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | + | ## Contents | |
| 2 | + | ||
| 3 | + | * 1 Úvod | |
| 4 | + | * 2 SysUtils.ExecuteProcess | |
| 5 | + | * 3 TProcess | |
| 6 | + | * 3.1 Jednoduchý príklad | |
| 7 | + | * 3.2 Vylepšený príklad | |
| 8 | + | * 3.3 Čítanie veľkého výstupu | |
| 9 | + | * 3.4 Použitie vstupu a výstupu z TProcess | |
| 10 | + | * 3.5 Pokyny pre použitie TProcess | |
| 11 | + | * 3.6 Príklad komunikácie s procesom aspell | |
| 12 | + | ||
| 1 | 13 | ## Úvod | |
| 2 | 14 | ||
| 3 | - | ||
| 15 | + | Je mnoho spôsobov ako spustiť externé programy. Zameriame sa na jeden z nich. | |
| 4 | 16 | ||
| 5 | 17 | ## SysUtils.ExecuteProcess | |
| 6 | 18 | ||
| 7 | - | ||
| 8 | - | ||
| 9 | - | ||
| 10 | - | ||
| 19 | + | najjednoduchší spôsob, ak nepotrebujete rúry (_pipes_) alebo žiadne formu ovládania je jednoducho použiť | |
| 11 | 20 | ``` | |
| 21 | + | SysUtils.ExecuteProcess('/full/path/to/binary',['arg1','arg2']); | |
| 22 | + | ``` | |
| 12 | 23 | ||
| 13 | 24 | ## TProcess | |
| 14 | 25 | ||
| 15 | - | ||
| 26 | + | Môžete použiť TProcess na spustenie externých programov. Výhody tohoto spôsobu sú: | |
| 16 | 27 | ||
| 17 | - | ||
| 18 | - | ||
| 28 | + | * Nezávislý na platforme | |
| 29 | + | * Schopnosť čítať zo stdin a stdout. | |
| 19 | 30 | ||
| 20 | - | ||
| 21 | - | ||
| 31 | + | **Poznámka** : TProcess nie je terminal/shell! Nemôžete priamo spustiť alebo presmerovať výstup pomocou operátorov ako "|", ">", "<", "&" atď. Možno získať rovnaký výsledok s TProcess pomocou Pascal, príklady nasledujú... | |
| 22 | 32 | ||
| 23 | 33 | ### Jednoduchý príklad | |
| 24 | - | ||
| 25 | - | ||
| 26 | - | ||
| 27 | - | ||
| 28 | - | ||
| 29 | - | ||
| 30 | - | ||
| 31 | - | ||
| 32 | - | ||
| 33 | - | ||
| 34 | - | ||
| 35 | - | ||
| 36 | - | ||
| 37 | - | ||
| 38 | - | ||
| 39 | - | ||
| 40 | - | ||
| 41 | - | ||
| 42 | - | ||
| 43 | - | ||
| 44 | - | ||
| 45 | - | ||
| 46 | - | ||
| 47 | - | ||
| 48 | - | ||
| 49 | - | ||
| 50 | - | ||
| 51 | - | ||
| 52 | - | ||
| 53 | - | ||
| 54 | - | ||
| 55 | - | ||
| 56 | - | ||
| 57 | - | ||
| 58 | - | ||
| 59 | - | ||
| 60 | - | ||
| 61 | 34 | ``` | |
| 35 | + | // Toto je ukážkový program ktorý vám ukáže ako | |
| 36 | + | // spustiť externý program. | |
| 37 | + | program launchprogram; | |
| 38 | + | ||
| 39 | + | // Tu si "použijeme" unity ktoré budeme potrebovať | |
| 40 | + | uses | |
| 41 | + | Classes, SysUtils, Process; | |
| 42 | + | ||
| 43 | + | // Toto je definícia premennej APRocess | |
| 44 | + | // typu "TProcess" | |
| 45 | + | var | |
| 46 | + | AProcess: TProcess; | |
| 47 | + | ||
| 48 | + | // Začiatok programu | |
| 49 | + | begin | |
| 50 | + | // Vytvoríme objekt TProcess | |
| 51 | + | // pridelíme ho do premennej AProcess | |
| 52 | + | AProcess := TProcess.Create(nil); | |
| 53 | + | ||
| 54 | + | // Povieme novému procesu aký príkaz má vykonať | |
| 55 | + | // Použime FPC prekladač | |
| 56 | + | AProcess.CommandLine := 'ppc386 -h'; | |
| 57 | + | ||
| 58 | + | // Definujeme nastavenie pre spustenie. | |
| 59 | + | // Toto nastavenie zaručí že náš program | |
| 60 | + | // nebude pokračovať až kým sa proces neskončí | |
| 61 | + | AProcess.Options := AProcess.Options + [poWaitOnExit]; | |
| 62 | + | ||
| 63 | + | // Teraz keď už proces vie čo má robiť | |
| 64 | + | // ho môžeme spustiť. | |
| 65 | + | AProcess.Execute; | |
| 66 | + | ||
| 67 | + | // Toto sa dosiahne až po skončení procesu. | |
| 68 | + | AProcess.Free; | |
| 69 | + | end. | |
| 70 | + | ``` | |
| 62 | 71 | ||
| 63 | - | ||
| 72 | + | To je všetko! Práve ste sa naučili ako spustit externý program použitím TProcess. | |
| 64 | 73 | ||
| 65 | - | ||
| 74 | + | To je všetko pekné, ale ako získam výstup spusteného programu? Tak sa na to pozrime, trochu rozšírime náš priklad. | |
| 66 | 75 | ||
| 67 | 76 | ### Vylepšený príklad | |
| 68 | - | ||
| 69 | - | ||
| 70 | - | ||
| 71 | - | ||
| 72 | - | ||
| 73 | - | ||
| 74 | - | ||
| 75 | - | ||
| 76 | - | ||
| 77 | - | ||
| 78 | - | ||
| 79 | - | ||
| 80 | - | ||
| 81 | - | ||
| 82 | - | ||
| 83 | - | ||
| 84 | - | ||
| 85 | - | ||
| 86 | - | ||
| 87 | - | ||
| 88 | - | ||
| 89 | - | ||
| 90 | - | ||
| 91 | - | ||
| 92 | - | ||
| 93 | - | ||
| 94 | - | ||
| 95 | - | ||
| 96 | - | ||
| 97 | - | ||
| 98 | - | ||
| 99 | - | ||
| 100 | - | ||
| 101 | - | ||
| 102 | - | ||
| 103 | - | ||
| 104 | - | ||
| 105 | - | ||
| 106 | - | ||
| 107 | - | ||
| 108 | - | ||
| 109 | - | ||
| 110 | - | ||
| 111 | - | ||
| 112 | - | ||
| 113 | - | ||
| 114 | - | ||
| 115 | - | ||
| 116 | - | ||
| 117 | - | ||
| 118 | - | ||
| 119 | - | ||
| 120 | - | ||
| 121 | - | ||
| 122 | - | ||
| 123 | - | ||
| 124 | 77 | ``` | |
| 78 | + | // Toto je ukážkový program ktorý vám ukáže ako | |
| 79 | + | // spustiť externý program. | |
| 80 | + | program launchprogram; | |
| 81 | + | ||
| 82 | + | // Tu si "použijeme" unity ktoré budeme potrebovať | |
| 83 | + | uses | |
| 84 | + | Classes, SysUtils, Process; | |
| 85 | + | ||
| 86 | + | // Toto je definícia premennej APRocess | |
| 87 | + | // typu "TProcess" | |
| 88 | + | // Teraz pridáme aj TStringList aby sme | |
| 89 | + | // mohli uložiť výstup procesu. | |
| 90 | + | var | |
| 91 | + | AProcess: TProcess; | |
| 92 | + | AStringList: TStringList; | |
| 93 | + | ||
| 94 | + | // Začiatok programu | |
| 95 | + | begin | |
| 96 | + | // Vytvoríme objekt TProcess | |
| 97 | + | // pridelíme ho do premennej AProcess | |
| 98 | + | AProcess := TProcess.Create(nil); | |
| 99 | + | ||
| 100 | + | // Vytvoríme TStringList a pridelíme ho | |
| 101 | + | AStringList := TStringList.Create; | |
| 102 | + | ||
| 103 | + | // Povieme novému procesu aký príkaz má vykonať | |
| 104 | + | // Použime FPC prekladač | |
| 105 | + | AProcess.CommandLine := 'ppc386 -h'; | |
| 106 | + | ||
| 107 | + | // Definujeme nastavenie pre spustenie. | |
| 108 | + | // Toto nastavenie zaručí že náš program | |
| 109 | + | // nebude pokračovať až kým sa proces neskončí | |
| 110 | + | // Zároveň ho nastavíme tak, aby sme mohli | |
| 111 | + | // čítať výstup. | |
| 112 | + | AProcess.Options := AProcess.Options + [poWaitOnExit, poUsePipes]; | |
| 113 | + | ||
| 114 | + | // Teraz keď už proces vie čo má robiť | |
| 115 | + | // ho môžeme spustiť. | |
| 116 | + | AProcess.Execute; | |
| 117 | + | ||
| 118 | + | // Toto sa dosiahne až po skončení procesu. | |
| 119 | + | ||
| 120 | + | // Teraz načítame výstup programu | |
| 121 | + | // do TStringListu. | |
| 122 | + | AStringList.LoadFromStream(AProcess.Output); | |
| 123 | + | ||
| 124 | + | // Uložíme výstup do súboru | |
| 125 | + | AStringList.SaveToFile('output.txt'); | |
| 126 | + | ||
| 127 | + | // Teraz keď je už výstup uložený | |
| 128 | + | // môžeme uvolniť objekty. | |
| 129 | + | AStringList.Free; | |
| 130 | + | AProcess.Free; | |
| 131 | + | end. | |
| 132 | + | ``` | |
| 125 | 133 | ||
| 126 | 134 | ### Čítanie veľkého výstupu | |
| 127 | 135 | ||
| 128 | - | ||
| 129 | - | ||
| 130 | - | ||
| 136 | + | V predchádzajúcom príklade sme čakali na ukončenie programu a potom sme čítali čo mal program zapísané do výstupu. Ale predstavte si, že program zapisuje na výstup veľké množstvo dát, rúra sa plní a volaný program čaká na jej vyprázdnenie (prečítanie). Ale volajúci program z rúry nečíta, pretože čaká na ukončenie volaného programu. Nastalo uviaznutie. | |
| 131 | 137 | ||
| 132 | - | ||
| 133 | - | ||
| 134 | - | ||
| 135 | - | ||
| 136 | - | ||
| 137 | - | ||
| 138 | - | ||
| 139 | - | ||
| 140 | - | ||
| 141 | - | ||
| 142 | - | ||
| 143 | - | ||
| 144 | - | ||
| 145 | - | ||
| 146 | - | ||
| 147 | - | ||
| 148 | - | ||
| 149 | - | ||
| 150 | - | ||
| 151 | - | ||
| 152 | - | ||
| 153 | - | ||
| 154 | - | ||
| 155 | - | ||
| 156 | - | ||
| 157 | - | ||
| 158 | - | ||
| 159 | - | ||
| 160 | - | ||
| 161 | - | ||
| 162 | - | ||
| 163 | - | ||
| 164 | - | ||
| 165 | - | ||
| 166 | - | ||
| 167 | - | ||
| 168 | - | ||
| 169 | - | ||
| 170 | - | ||
| 171 | - | ||
| 172 | - | ||
| 173 | - | ||
| 174 | - | ||
| 175 | - | ||
| 138 | + | Takže nasledujúci príklad nepoužíva poWaitOnExit, ale číta z výstupu, zatiaľ čo program stále beží. Výstup je uchovávaný v pamäťovom streame, ktorý môže byť neskôr použitý na prečítanie výstupu do TStringList. | |
| 139 | + | ``` | |
| 140 | + | program procoutlarge; | |
| 141 | + | { | |
| 142 | + | Copyright (c) 2004 by Marc Weustink | |
| 176 | 143 | ||
| 177 | - | ||
| 178 | - | ||
| 179 | - | ||
| 180 | - | ||
| 181 | - | ||
| 182 | - | ||
| 183 | - | ||
| 184 | - | ||
| 185 | - | ||
| 186 | - | ||
| 187 | - | ||
| 188 | - | ||
| 189 | - | ||
| 190 | - | ||
| 191 | - | ||
| 192 | - | ||
| 193 | - | ||
| 194 | - | ||
| 195 | - | ||
| 196 | - | ||
| 197 | - | ||
| 198 | - | ||
| 199 | - | ||
| 200 | - | ||
| 201 | - | ||
| 202 | - | ||
| 203 | - | ||
| 204 | - | ||
| 205 | - | ||
| 206 | - | ||
| 207 | - | ||
| 208 | - | ||
| 209 | - | ||
| 210 | - | ||
| 211 | - | ||
| 212 | - | ||
| 213 | - | ||
| 214 | - | ||
| 215 | - | ||
| 216 | - | ||
| 144 | + | Tento príklad je vytvorený v nádeji, že bude užitočný, | |
| 145 | + | ale BEZ AKEJKOĽVEK ZÁRUKY; dokonca bez implicitnej záruky | |
| 146 | + | MERCHANTABILITY alebo FITNESS FOR A PARTICULAR PURPOSE. | |
| 147 | + | } | |
| 148 | + | ||
| 149 | + | uses | |
| 150 | + | Classes, Process, SysUtils; | |
| 151 | + | ||
| 152 | + | const | |
| 153 | + | READ_BYTES = 2048; | |
| 154 | + | ||
| 155 | + | var | |
| 156 | + | S: TStringList; | |
| 157 | + | M: TMemoryStream; | |
| 158 | + | P: TProcess; | |
| 159 | + | n: LongInt; | |
| 160 | + | BytesRead: LongInt; | |
| 161 | + | ||
| 162 | + | begin | |
| 163 | + | // Nemôžeme tu použiť poWaitOnExit, lebo nepoznáme | |
| 164 | + | // veľkosť výstupu. V Linuxe je veľkosť | |
| 165 | + | // výstupnej rúry 2 kB. Ak je výstupných dátviac, | |
| 166 | + | // musíme dáta prečítať. To však nie je možné, keďže | |
| 167 | + | // sme čakajúci. Takže by tu nastalo uviaznutie. | |
| 168 | + | // | |
| 169 | + | // Na buferovanie výstupu použijeme dočasný Memorystream | |
| 170 | + | ||
| 171 | + | M := TMemoryStream.Create; | |
| 172 | + | BytesRead := 0; | |
| 173 | + | ||
| 174 | + | P := TProcess.Create(nil); | |
| 175 | + | P.CommandLine := 'ppc386 -va bogus.pp'; | |
| 176 | + | P.Options := [poUsePipes]; | |
| 177 | + | WriteLn('-- executing --'); | |
| 178 | + | P.Execute; | |
| 179 | + | while P.Running do | |
| 180 | + | begin | |
| 181 | + | // overenie, že máme dosť priestoru | |
| 182 | + | M.SetSize(BytesRead + READ_BYTES); | |
| 183 | + | ||
| 184 | + | // skús ho prečítať | |
| 185 | + | n := P.Output.Read((M.Memory + BytesRead)^, READ_BYTES); | |
| 186 | + | if n > 0 | |
| 187 | + | then begin | |
| 188 | + | Inc(BytesRead, n); | |
| 189 | + | Write('.') | |
| 190 | + | end | |
| 191 | + | else begin | |
| 192 | + | // žiadne dáta, počkať 100 ms | |
| 193 | + | Sleep(100); | |
| 194 | + | end; | |
| 195 | + | end; | |
| 196 | + | // čítať poslednú časť | |
| 197 | + | repeat | |
| 198 | + | // overenie, že máme dosť priestoru | |
| 199 | + | M.SetSize(BytesRead + READ_BYTES); | |
| 200 | + | // skús ho prečítať | |
| 201 | + | n := P.Output.Read((M.Memory + BytesRead)^, READ_BYTES); | |
| 202 | + | if n > 0 | |
| 203 | + | then begin | |
| 204 | + | Inc(BytesRead, n); | |
| 205 | + | Write('.'); | |
| 206 | + | end; | |
| 207 | + | until n <= 0; | |
| 208 | + | if BytesRead > 0 then WriteLn; | |
| 209 | + | M.SetSize(BytesRead); | |
| 210 | + | WriteLn('-- executed --'); | |
| 211 | + | ||
| 212 | + | S := TStringList.Create; | |
| 213 | + | S.LoadFromStream(M); | |
| 214 | + | WriteLn('-- linecount = ', S.Count, ' --'); | |
| 215 | + | for n := 0 to S.Count - 1 do | |
| 216 | + | begin | |
| 217 | + | WriteLn('| ', S[n]); | |
| 218 | + | end; | |
| 219 | + | WriteLn('-- end --'); | |
| 220 | + | S.Free; | |
| 221 | + | P.Free; | |
| 222 | + | M.Free; | |
| 223 | + | end. | |
| 217 | 224 | ``` | |
| 218 | 225 | ||
| 219 | 226 | ### Použitie vstupu a výstupu z TProcess | |
| 220 | 227 | ||
| 221 | - | ||
| 228 | + | Viz príklad processdemo na [Lazarus-CCR SVN](<https://lazarus-ccr.svn.sourceforge.net/svnroot/lazarus-ccr/examples/process>). | |
| 222 | 229 | ||
| 223 | 230 | ### Pokyny pre použitie TProcess | |
| 224 | 231 | ||
| 225 | - | ||
| 226 | - | ||
| 227 | - | ||
| 232 | + | Ak vytvárate cez platformný program, môžete zmeniť príkazový riadok v závislosti na OS, pomocou direktív "{$IFDEF}s" a "{$ENDIF}s". | |
| 228 | 233 | ||
| 229 | - | ||
| 230 | - | ||
| 231 | - | ||
| 232 | - | ||
| 233 | - | ||
| 234 | - | ||
| 235 | - | ||
| 236 | - | ||
| 237 | - | ||
| 238 | - | ||
| 239 | - | ||
| 234 | + | Príklad: | |
| 240 | 235 | ``` | |
| 236 | + | {...} | |
| 237 | + | AProcess:TProcess.Create(nil) | |
| 238 | + | {$IFDEF WIN32} | |
| 239 | + | AProcess.CommandLine := 'calc.exe'; //Windows Calc | |
| 240 | + | {$ENDIF} | |
| 241 | + | {$IFDEF LINUX} | |
| 242 | + | AProcess.CommandLine := 'kcalc'; //KDE Calc | |
| 243 | + | {$ENDIF} | |
| 244 | + | AProcess.Execute; //in alternative, you can use AProcess.Active:=True | |
| 245 | + | {...} | |
| 246 | + | ``` | |
| 241 | 247 | ||
| 242 | 248 | ### Príklad komunikácie s procesom aspell | |
| 243 | 249 | ||
| 244 | - | ||
| 250 | + | V zdrojovom kóde [pasdoc](<http://pasdoc.sourceforge.net/>) môžete nájsť dve unity, ktoré vykonávajú kontrolu pravopisu komunikáciou s bežiacim procesom aspell cez rúry: | |
| 245 | 251 | ||
| 246 | - | ||
| 247 | - | ||
| 252 | + | * [PasDoc_ProcessLineTalk.pas unit](<http://pasdoc.svn.sourceforge.net/viewvc/*checkout*/pasdoc/trunk/source/component/PasDoc_ProcessLineTalk.pas>) implementuje triedu TProcessLineTalk, potomka TProcess, ktorú možno jednoducho použiť na komunikáciu s ktorýmkoľvek procesom na báze riadok-po-riadku. | |
| 253 | + | * [PasDoc_Aspell.pas unit](<http://pasdoc.svn.sourceforge.net/viewvc/*checkout*/pasdoc/trunk/source/component/PasDoc_Aspell.pas>) implementuje triedu TAspellProcess, ktorá vykonáva kontrolu pravopisu pomocou základnej inštancie TProcessLineTalk pre spustenie aspell a komunikáciu so spusteným procesom aspell. | |
| 248 | 254 | ||
| 249 | 255 | Obe jednotky sú vcelku nezávislé od zvyšku zdrojového kódu pasdoc, takže môžu poslúžiť ako príklady skutočného použitia TProcess na spustenie a komunikáciu s inými programmi cez rúry. | |
| 250 | 256 | ||
| 251 | 257 | --- | |
| 252 | - | ||
| 258 | + | *From the Free Pascal wiki, page "Executing External Programs/sk", as the Internet Archive kept it on 2022-12-09. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* |
