Command line parameters and environment variables/fi: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | - | ||
| 1 | + | ## Contents | |
| 2 | 2 | ||
| 3 | - | ||
| 3 | + | * 1 Yleistä | |
| 4 | + | * 2 Komentoriviparametrit | |
| 5 | + | * 2.1 Perustiedot | |
| 6 | + | * 2.2 Käyttäjäystävällisyys | |
| 7 | + | * 2.2.1 Tarkista parameterit | |
| 8 | + | * 2.2.2 Luetaan parameterin arvo | |
| 9 | + | * 2.2.3 Tarkistetaan parametrien oikeellisuus | |
| 10 | + | * 3 Ympäristömuuttujat | |
| 4 | 11 | ||
| 5 | - | ||
| 12 | + | ## Yleistä | |
| 6 | 13 | ||
| 14 | + | Kun ohjelma käynnistetään käyttäjä voi antaa komentoriviparametrejä ja asettaa ympäristömuuttujat. Esimerkiksi Free Pascal kääntäjä saa suurimman osan parametreistä komentorivin kautta: | |
| 15 | + | ``` | |
| 16 | + | fpc -Fudirectory -gh unit1.pas | |
| 17 | + | ``` | |
| 18 | + | ||
| 7 | 19 | ## Komentoriviparametrit | |
| 8 | 20 | ||
| 9 | 21 | ### Perustiedot | |
| 10 | 22 | ||
| 11 | - | ||
| 12 | - | ||
| 13 | - | ||
| 23 | + | Pascal ohjelmaa voi käyttää ParamStr ja ParamCount parametrien kautta. ParamStr (0) kertoo itse ohjelman nimen (ja polun _jos_ käyttöjärjestelmä tukee sitä). ParamStr (1) on ensimmäinen parametri. ParamCount on parametrien määrä. | |
| 24 | + | ``` | |
| 14 | 25 | program Project1; | |
| 15 | - | ||
| 16 | - | ||
| 17 | - | ||
| 18 | - | ||
| 19 | - | ||
| 20 | - | ||
| 21 | - | ||
| 22 | - | ||
| 23 | - | ||
| 24 | - | ||
| 26 | + | ||
| 27 | + | {$mode objfpc}{$H+} | |
| 28 | + | ||
| 29 | + | var | |
| 30 | + | I: Integer; | |
| 31 | + | begin | |
| 32 | + | WriteLn('Program: ', ParamStr(0)); | |
| 33 | + | for I := 1 to ParamCount do | |
| 34 | + | WriteLn('Param ', I, ': ', ParamStr(I)); | |
| 35 | + | end. | |
| 25 | 36 | ``` | |
| 26 | 37 | ||
| 27 | - | ||
| 28 | - | ||
| 29 | - | ||
| 30 | - | ||
| 31 | - | ||
| 38 | + | Esimerkiksi: | |
| 39 | + | ``` | |
| 40 | + | $ /tmp/project1 -a | |
| 41 | + | Program: /tmp/project1 | |
| 42 | + | Param 1: -a | |
| 43 | + | ``` | |
| 32 | 44 | ||
| 33 | 45 | ### Käyttäjäystävällisyys | |
| 34 | 46 | ||
| 35 | - | ||
| 47 | + | Hyvän ohjelman pitäisi antaa ohjeviestin, kun tarjotaan vääriä parametrejä ja sen pitäisi noudattaa yhteistä tapaa käyttää parametreja. FPC:n mukana tuleva käännösyksikkö unit custapp sisältää TCustomApplication luokan, joka tarjoaa toiminnot tarkistaa ja lukea parametrit helposti. Tietenkin voidaan käyttää parametreja suoraan: ParamStr ja ParamCount avulla. | |
| 36 | 48 | ||
| 37 | - | ||
| 49 | + | Jokainen LCL sovellus käyttää tätä automaattisesti. Sovelluksen luokkana on TCustomApplication. | |
| 38 | 50 | ||
| 39 | - | ||
| 51 | + | Jos haluat kirjoittaa "ei LCL"- ohjelman, niin luo Lazaruksessa uusi projekti tyyppiä 'komentorivisovellus (Console Application)'. Tämä luo tiedoston project1.lpr jossa on joitakin mukavia "herkkuja", joita lähes kaikki ohjelmat tarvitsevat. Siirry doRun metodiin. | |
| 40 | 52 | ||
| 41 | - | ||
| 53 | + | ||
| 42 | 54 | ||
| 43 | - | ||
| 55 | + | #### Tarkista parameterit | |
| 44 | 56 | ||
| 45 | - | ||
| 57 | + | TCustomApplication luokassa voit käyttää parametreja nimen mukaan. Esimerkiksi ohjelma jonka pitäisi tulostaa ohjeteksti kun käyttäjä antaa yleisesti käytössä olevan ohje parametrin ` -h ` . Parametri ` -h ` on parametrin ` --help` lyhyempi vaihtoehto. Voit testata, mitä tapahtuu kun ohjelma käynnistetään parametrillä ` -h ` tai ` --help` . | |
| 58 | + | ``` | |
| 46 | 59 | if HasOption('h', 'help') then begin | |
| 47 | - | ||
| 48 | - | ||
| 49 | - | ||
| 60 | + | WriteHelp; | |
| 61 | + | Halt; | |
| 62 | + | end; | |
| 50 | 63 | ``` | |
| 51 | 64 | ||
| 52 | - | ||
| 53 | - | ||
| 54 | - | ||
| 65 | + | Huomaa: LCL:n käytössä täytyy liittää alkuun `Application.` HasOption lauseen eteen. Esimerkiksi: | |
| 66 | + | ``` | |
| 55 | 67 | if Application.HasOption('h', 'help') then begin | |
| 56 | - | ||
| 57 | - | ||
| 58 | - | ||
| 68 | + | WriteHelp; | |
| 69 | + | Halt; | |
| 70 | + | end; | |
| 59 | 71 | ``` | |
| 60 | 72 | ||
| 61 | - | ||
| 62 | - | ||
| 63 | - | ||
| 73 | + | ||
| 64 | 74 | ||
| 65 | - | ||
| 66 | - | ||
| 67 | 75 | ``` | |
| 76 | + | // Jos halutaan tukea ainoastaan lyhyttä tapaa : | |
| 77 | + | if HasOption('h', '') then ... | |
| 78 | + | ||
| 79 | + | //Jos halutaan tukea ainoastaan pitkää tapaa : | |
| 80 | + | if HasOption('help') then ... | |
| 81 | + | ``` | |
| 68 | 82 | ||
| 69 | 83 | #### Luetaan parameterin arvo | |
| 70 | 84 | ||
| 71 | - | ||
| 72 | - | ||
| 73 | - | ||
| 74 | - | ||
| 75 | - | ||
| 76 | - | ||
| 77 | - | ||
| 85 | + | Kullekin parametrille voidaan antaa arvo. Esimerkiksi: | |
| 86 | + | ``` | |
| 87 | + | project1 -f filename | |
| 88 | + | ``` | |
| 78 | 89 | ||
| 79 | - | ||
| 90 | + | tai pidemmällä muodolla: | |
| 91 | + | ``` | |
| 92 | + | project1 --file=filename | |
| 93 | + | ``` | |
| 94 | + | ``` | |
| 80 | 95 | WriteLn('f=', GetOptionValue('f', 'file')); | |
| 81 | 96 | ``` | |
| 82 | 97 | ||
| 83 | - | ||
| 98 | + | Huomaa: jos saat virheilmoituksen _Option at position 1 needs an argument : f._ niin unohdettiin lisätä kutsu _CheckOptions_ . | |
| 84 | 99 | ||
| 85 | 100 | #### Tarkistetaan parametrien oikeellisuus | |
| 86 | 101 | ||
| 87 | - | ||
| 88 | - | ||
| 89 | - | ||
| 102 | + | Komentoriviparametrit ovat vapaasti kirjoitettua tekstiä, jolloin käyttäjä voi helposti kirjoittaa virheitä. Parametrien syntaksin tarkistaminen on pakollista. Tähän voidaan käyttää [CheckOptions](<http://lazarus-ccr.sourceforge.net/docs/fcl/custapp/tcustomapplication.checkoptions.html> "doc:fcl/custapp/tcustomapplication.checkoptions.html") menetelmää : Voidaan määritellä, mitkä parametrit ovat sallittuja, mitkä niistä tarvitsevat parametrin ja syntaksivirheen tapauksessa saatavan virheilmoituksen ja vaihtoehdot, jotka tulostetaan hyödyllisinä ja yksityiskohtaiset virheet. | |
| 90 | 103 | ||
| 91 | - | ||
| 104 | + | Esimerkki: | |
| 105 | + | ``` | |
| 92 | 106 | ErrorMsg := CheckOptions('hf:', 'help file:'); | |
| 93 | 107 | ``` | |
| 94 | 108 | ||
| 95 | - | ||
| 109 | + | Tämä sallii lyhyet optiot _-f value_ ja _-h_. Se tukee pitkiä vaihtoehtoja _\--help_ or _\--file= tiedostonimi_. Se ei salli _\--help_ joilla on arvo, eikä --file ilman arvoa. | |
| 96 | 110 | ||
| 97 | 111 | ## Ympäristömuuttujat | |
| 98 | 112 | ||
| 99 | - | ||
| 100 | - | ||
| 101 | - | ||
| 113 | + | Kolme perustoimintoa ympäristömuuttujien kanssa työskentelyyn ovat: [GetEnvironmentVariable](<http://www.freepascal.org/docs-html/rtl/sysutils/getenvironmentvariable.html>) | |
| 102 | 114 | ||
| 103 | - | ||
| 115 | + | [GetEnvironmentString](<http://www.freepascal.org/docs-html/rtl/sysutils/getenvironmentstring.html>) | |
| 104 | 116 | ||
| 105 | - | ||
| 117 | + | [GetEnvironmentVariableCount](<http://www.freepascal.org/docs-html/rtl/sysutils/getenvironmentvariablecount.html>) | |
| 106 | 118 | ||
| 107 | - | ||
| 119 | + | ||
| 120 | + | Esimerkki: | |
| 121 | + | ``` | |
| 108 | 122 | var | |
| 109 | - | ||
| 110 | - | ||
| 111 | - | ||
| 112 | - | ||
| 113 | - | ||
| 114 | - | ||
| 115 | - | ||
| 116 | - | ||
| 123 | + | I: Integer; | |
| 124 | + | begin | |
| 125 | + | WriteLn('PATH = ' + GetEnvironmentVariable('PATH')); | |
| 126 | + | ||
| 127 | + | WriteLn('All environment variables:'); | |
| 128 | + | for I := 0 to GetEnvironmentVariableCount - 1 do | |
| 129 | + | WriteLn(GetEnvironmentString(I)); | |
| 130 | + | end. | |
| 117 | 131 | ``` | |
| 118 | 132 | ||
| 119 | - | ||
| 120 | - | ||
| 121 | - | ||
| 133 | + | On myös mahdollista ladata kaikki ympäristömuuttujat TStringList objektiin ja niihin päästään helposti käsiksi nimi-arvo-parina. String list automaattisesti tottelee merkki erotinta, joka on oletuksena merkki "=". | |
| 134 | + | ``` | |
| 122 | 135 | var | |
| 123 | - | ||
| 124 | - | ||
| 125 | - | ||
| 126 | - | ||
| 127 | - | ||
| 128 | - | ||
| 129 | - | ||
| 130 | - | ||
| 131 | - | ||
| 132 | - | ||
| 133 | - | ||
| 134 | - | ||
| 135 | - | ||
| 136 | - | ||
| 137 | - | ||
| 138 | - | ||
| 139 | - | ||
| 140 | - | ||
| 136 | + | I: Integer; | |
| 137 | + | EnvVars: TStringList; | |
| 138 | + | begin | |
| 139 | + | EnvVars := TStringList.Create; | |
| 140 | + | try | |
| 141 | + | // Lataa kaikki ympäristömuuttujat string list :n | |
| 142 | + | for I := 0 to GetEnvironmentVariableCount - 1 do | |
| 143 | + | EnvVars.Add(GetEnvironmentString(I)); | |
| 144 | + | ||
| 145 | + | WriteLn('PATH = ' + EnvVars.Values['PATH']); | |
| 146 | + | ||
| 147 | + | WriteLn('All environment variables:'); | |
| 148 | + | for I := 0 to EnvVars.Count - 1 do | |
| 149 | + | WriteLn(EnvVars.Names[I] + ' = ' + EnvVars.ValueFromIndex[I]); | |
| 150 | + | finally | |
| 151 | + | EnvVars.Free; | |
| 152 | + | end; | |
| 153 | + | end. | |
| 141 | 154 | ``` | |
| 142 | 155 | ||
| 143 | - | ||
| 144 | - | ||
| 145 | - | ||
| 156 | + | Myös TApplication luokalla on metodi jolla saadaan kaikki ympäristömuuttujat kerralla TStrings list olioon. | |
| 157 | + | ``` | |
| 146 | 158 | var | |
| 147 | - | ||
| 148 | - | ||
| 149 | - | ||
| 150 | - | ||
| 151 | - | ||
| 152 | - | ||
| 153 | - | ||
| 154 | - | ||
| 155 | - | ||
| 156 | - | ||
| 159 | + | EnvVars: TStringList; | |
| 160 | + | begin | |
| 161 | + | EnvVars := TStringList.Create; | |
| 162 | + | try | |
| 163 | + | Application.GetEnvironmentList(EnvVars); | |
| 164 | + | ... | |
| 165 | + | finally | |
| 166 | + | EnvVars.Free; | |
| 167 | + | end; | |
| 168 | + | end; | |
| 157 | 169 | ``` | |
| 158 | 170 | ||
| 159 | 171 | --- | |
| 160 | - | ||
| 172 | + | *From the Free Pascal wiki, page "Command line parameters and environment variables/fi", as the Internet Archive kept it on 2022-10-04. 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).* |
