Command line parameters and environment variables/fi: what changed

Revision 3 to 4. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		## Yleistä
2	2
3	3		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:
4	4
5		-	~~` fpc -Fudirectory -gh unit1.pas`~~
	5	+	```text
	6	+	fpc -Fudirectory -gh unit1.pas
	7	+	```
6	8
7	9		## Komentoriviparametrit
8	10
9	11		### Perustiedot
10	12
11	13		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ä.
12	14
13	15		``` pascal
14	16		program Project1;
15	17
16	18		{$mode objfpc}{$H+}
17	19
18	20		var
19	21		I: Integer;
20	22		begin
21	23		WriteLn('Program: ', ParamStr(0));
22	24		for I := 1 to ParamCount do
23	25		WriteLn('Param ', I, ': ', ParamStr(I));
24	26		end.
25	27		```
26	28
27	29		Esimerkiksi:
28	30
29		-	~~` $ /tmp/project1 -a`\~~
30		-	~~` Program: /tmp/project1`\~~
31		-	~~` Param 1: -a`~~
	31	+	``` pascal
	32	+	$ /tmp/project1 -a
	33	+	Program: /tmp/project1
	34	+	Param 1: -a
	35	+	```
32	36
33	37		### Käyttäjäystävällisyys
34	38
35	39		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	40
37	41		Jokainen LCL sovellus käyttää tätä automaattisesti. Sovelluksen luokkana on TCustomApplication.
38	42
39	43		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	44
41	45		#### Tarkista parameterit
42	46
43	47		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` .
44	48
45	49		``` pascal
46	50		if HasOption('h', 'help') then begin
47	51		WriteHelp;
48	52		Halt;
49	53		end;
50	54		```
51	55
52	56		Huomaa: LCL:n käytössä täytyy liittää alkuun `Application.` HasOption lauseen eteen. Esimerkiksi:
53	57
54	58		``` pascal
55	59		if Application.HasOption('h', 'help') then begin
56	60		WriteHelp;
57	61		Halt;
58	62		end;
59	63		```
60	64
61	65		``` pascal
62	66		// Jos halutaan tukea ainoastaan lyhyttä tapaa :
63	67		if HasOption('h', '') then ...
64	68
65	69		//Jos halutaan tukea ainoastaan pitkää tapaa :
66	70		if HasOption('help') then ...
67	71		```
68	72
69	73		#### Luetaan parameterin arvo
70	74
71	75		Kullekin parametrille voidaan antaa arvo. Esimerkiksi:
72	76
73		-	~~` project1 -f filename`~~
	77	+	```text
	78	+	project1 -f filename
	79	+	```
74	80
75	81		tai pidemmällä muodolla:
76	82
77		-	~~` project1 --file=filename`~~
	83	+	```text
	84	+	project1 --file=filename
	85	+	```
78	86
79	87		``` pascal
80	88		WriteLn('f=', GetOptionValue('f', 'file'));
81	89		```
82	90
83	91		Huomaa: jos saat virheilmoituksen Option at position 1 needs an argument : f. niin unohdettiin lisätä kutsu CheckOptions .
84	92
85	93		#### Tarkistetaan parametrien oikeellisuus
86	94
87	95		Komentoriviparametrit ovat vapaasti kirjoitettua tekstiä, jolloin käyttäjä voi helposti kirjoittaa virheitä. Parametrien syntaksin tarkistaminen on pakollista. Tähän voidaan käyttää [[doc:fcl/custapp/tcustomapplication.checkoptions.html\|CheckOptions]] 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.
88	96
89	97		Esimerkki:
90	98
91	99		``` pascal
92	100		ErrorMsg := CheckOptions('hf:', 'help file:');
93	101		```
94	102
95	103		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	104
97	105		## Ympäristömuuttujat
98	106
99	107		Kolme perustoimintoa ympäristömuuttujien kanssa työskentelyyn ovat: [GetEnvironmentVariable](http://www.freepascal.org/docs-html/rtl/sysutils/getenvironmentvariable.html)
100	108
101	109		[GetEnvironmentString](http://www.freepascal.org/docs-html/rtl/sysutils/getenvironmentstring.html)
102	110
103	111		[GetEnvironmentVariableCount](http://www.freepascal.org/docs-html/rtl/sysutils/getenvironmentvariablecount.html)
104	112
105	113		Esimerkki:
106	114
107	115		``` pascal
108	116		var
109	117		I: Integer;
110	118		begin
111	119		WriteLn('PATH = ' + GetEnvironmentVariable('PATH'));
112	120
113	121		WriteLn('All environment variables:');
114	122		for I := 0 to GetEnvironmentVariableCount - 1 do
115	123		WriteLn(GetEnvironmentString(I));
116	124		end.
117	125		```
118	126
119	127		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 "=".
120	128
121	129		``` pascal
122	130		var
123	131		I: Integer;
124	132		EnvVars: TStringList;
125	133		begin
126	134		EnvVars := TStringList.Create;
127	135		try
128	136		// Lataa kaikki ympäristömuuttujat string list :n
129	137		for I := 0 to GetEnvironmentVariableCount - 1 do
130	138		EnvVars.Add(GetEnvironmentString(I));
131	139
132	140		WriteLn('PATH = ' + EnvVars.Values['PATH']);
133	141
134	142		WriteLn('All environment variables:');
135	143		for I := 0 to EnvVars.Count - 1 do
136	144		WriteLn(EnvVars.Names[I] + ' = ' + EnvVars.ValueFromIndex[I]);
137	145		finally
138	146		EnvVars.Free;
139	147		end;
140	148		end.
141	149		```
142	150
143	151		Myös TApplication luokalla on metodi jolla saadaan kaikki ympäristömuuttujat kerralla TStrings list olioon.
144	152
145	153		``` pascal
146	154		var
147	155		EnvVars: TStringList;
148	156		begin
149	157		EnvVars := TStringList.Create;
150	158		try
151	159		Application.GetEnvironmentList(EnvVars);
152	160		...
153	161		finally
154	162		EnvVars.Free;
155	163		end;
156	164		end;
157	165		```
158	166
159	167		---
160	168		From the Free Pascal wiki, page "Command line parameters and environment variables/fi", as it stood on 2020-02-11 after a change by Trev, out of the wiki's dump of 2024-05-26. 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).

Back to history