CMD argumenty

CMD argumenty sú argumenty programu, ktoré sa zadávajú v termináli pri jeho spustení. Slúžia na ovládanie správania sa programu z miesta jeho spustenia. Môžeme zadať ľubovoľný počet argumentov v ľubovoľnom tvare (okrem niektorých špeciálnych znakov, ktoré sú osobitne interpretované terminálom). Každý CMD argument je reprezentovaný ako C reťazec. Všetky CMD argumenty sú k dispozícii prostredníctvom poľa reťazcov argv, ktoré má dĺžku argc prvkov. Prvok argv[0] obsahuje cestu k spúšťanému programu. Ostatné prvky poľa argv predstavujú používateľom zadané CMD argumenty. Pole argv a jeho dĺžka argc sú parametrami hlavnej funkcie main.

Príklad spustenia programu s CMD argumentami v Linux termináli:

./program 123 abc "hello world"

Daný príklad ilustruje situáciu spustenia skompilovaného programu program v termináli so zadaním CMD argumentov. Jednotlivé argumenty sú vymenované v nasledovnom zozname.

• Prvok argv[0] obsahuje cestu k programu program.
• Prvok argv[1] obsahuje reťazec "123". Pozor, jedná sa o textovú reprezentáciu čísla.
• Prvok argv[2] obsahuje reťazec "abc".
• Prvok argv[3] obsahuje reťazec "hello world". Aj napriek tomu, že tento reťazec pozostáva z viacerých slov oddelených medzerou, je stále chápaný ako samostatný argument, nakoľko je uzatvorený v úvodzovkách.

V zdrojovom kóde vieme pristúpiť k CMD argumentom pomocou parametrov funkcie main.

int main(int argc, char* argv[])
{
    /*
        argc - pocet CMD argumentov
        argv - pole argumentov (technicky je to pole retazcov)
    */
    return 0;
} 

V tomto zadaní budeme rozlišovať tieto 3 typy CMD argumentov:

• Prepínače (z angl. options). Prepínačom rozumieme CMD argument v tvare -x, kde x je ľubovoľné písmeno. Prepínače budú reprezentovať príslušné operácie spracovania načítaného riadku textu.
• Parametre prepínačov. Prepínač môže mať stanovený aj svoj parameter, napr. -p abc, kde za prepínačom -p nasleduje jeho parameter abc.
• Non-option argumenty. Každý CMD argument, ktorý nepatrí ani do jednej z dvoch vyššie uvedených kategórií je považovaný za tzv. non-option argument. V našom prípade budú všetky non-option argumenty umiestnené až za všetkými prepínačmi a ich parametrami.

Program môžeme z terminálu spustiť s rôznymi prepínačmi a ich parametrami. Taktiež môžeme zadať prepínače v rôznom poradí. Treba sa vysporiadať aj so situáciami, kedy používateľ zadá neplatný prepínač alebo zabudne uviesť povinný parameter platného prepínača. Navyše, okrem prepínačov a ich parametrov vieme program spustiť aj so zvyšnými non-option argumentami.

Ukážka rôznych typov CMD argumentov:

./program -a -b param arg1 arg2 arg3

Popis zadaných CMD argumentov:

• -a je prepínač bez parametra
• -b je prepínač s parametrom param
• arg1, arg2 a arg3 sú non-option argumenty

Spracovanie CMD argumentov pomocou funkcie getopt

Celý proces rozpoznania prepínačov, ich parametrov a non-option argumentov sa dá jednoducho automatizovať pomocou knižničnej funkcie getopt. Funkcia getopt okrem iného odhaľuje aj situácie nesprávneho použitia prepínačov. Odporúčame preto využiť túto funkciu, ušetrí vám veľa nervov a času. Funkciu getopt je možné použiť len v Unix-like systémoch. Používatelia Windows musia mať preto na jej využitie nainštalované vývojové prostredie MinGW, Cygwin, MSYS2 alebo WSL a používať ním distribuovaný kompilátor GCC. Funkciu getopt je možné použiť po vložení hlavičkového súboru unistd.h.

Hlavička funkcie getopt:

int getopt(int argc, char *const argv[], const char *optstring);

• argc je počet CMD argumentov
• argv je pole CMD argumentov (každý argument je reťazec)
• optstring je reťazec špecifikujúci platné prepínače (t.j. také, ktoré váš program rozpoznáva) a taktiež uvádza, či dané prepínače majú parametre

Nasledujúci príklad demonštruje použitie funkcie getopt pri spracovaní CMD argumentov programu.

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>

int main(int argc, char *argv[]){

	// Poznamky ku 'getopt':

	// Retazec 'optstring' specifikuje platne prepinace programu.

	// Ak funkcia 'getopt' narazi na neplatny prepinac, vrati znak '?'.
	// Ak 'optstring' zacina znakom ':', vtedy 'getopt' vrati znak ':'
	// v pripade chybajuceho povinneho parametra prepinaca.

	// Ak je v 'optstringu' za pismenom prepinaca znak ':', znamena to,
	// ze dany prepinac ma povinny parameter.

	// Povinny parameter aktualneho prepinaca vieme ziskat cez globalny
	// smernik 'optarg'.

	// Ked su rozpoznane vsetky prepinace, funkcia 'getopt' vrati -1.
	// Ak zostali nejake non-option argumenty, tak prvy non-option argument
	// ma index dany globalnou premennou 'optind'.

	int opt;
	char* optstring = ":ab:c";

    while ((opt = getopt(argc, argv, optstring)) != -1) {
        switch (opt) {
            case 'a':
                printf("Prepinac -a\n");
                break;
            case 'b':
                printf("Prepinac -b a jeho povinny parameter %s\n",optarg);
                break;
            case 'c':
            	printf("Prepinac -c\n");
            	break;
            default: /* '?' alebo ':' */
                printf("Neplatny prepinac alebo chybajuci param. prepinaca\n");
                return 1;
        }
    }
    if(optind < argc){
    	for(int i=optind;i<argc;i++){
    		printf("Non-option CMD argument: %s\n",argv[i]);
    	}
    }

	return 0;
}

Skompilovaný program spustíme z terminálu v tvare:

./program -a -b ahoj -c slovo1 slovo2

Dostaneme nasledovný výstup:

Prepinac -a
Prepinac -b a jeho povinny parameter ahoj
Prepinac -c
Non-option CMD argument: slovo1
Non-option CMD argument: slovo2

Súvisiace zdroje:

• getopt - Linux manual page
• Using the getopt function
• Example of Parsing Arguments with getopt

Načítanie riadkov textu

Po spustení programu a rozpoznaní CMD argumentov začne textový procesor načítavať riadky textu. Na načítanie riadku odporúčame použiť knižničnú funkciu fgets. V zadaní bude platiť, že maximálna dĺžka načítaného riadku je 1 000 znakov (zahŕňa znaky riadku a znak nového riadku '\n'). Vzhľadom na toto obmedzenie si viete vo vašom programe vytvoriť pole s dostatočnou kapacitou, v ktorom bude uložený načítaný riadok. Nezabudnite však, že každý reťazec v jazyku C musí byť ukončený terminačným znakom '\0' a treba to brať do úvahy pri určovaní veľkosti poľa na reprezentáciu načítaného riadku.

Načítavanie riadkov bude prebiehať až dovtedy, pokiaľ používateľ nezadá prázdny riadok, t.j. reťazec, ktorý neobsahuje žiadne znaky (t.j. používateľ nič nenapíše, ale stlačí len Enter). V prípade funkcie fgets sa prázdny riadok prejaví ako načítaný reťazec, ktorý bude obsahovať len znak '\n'. Textový procesor po načítaní prázdneho riadku regulérne ukončí svoju činnosť a funkcia main vráti hodnotu 0.

Súvisiace zdroje:

• Funkcia fgets

Spracovanie riadkov textu

Textový procesor vykonáva nasledovné typy operácií s načítaným riadkom. Poradie operácií je pevne určené a nemení sa. Zadané prepínače pri spustení programu len určujú, ktorá z operácií sa vykoná.

1. Vstupné operácie (môžu sa kombinovať)
   • Predvolená vstupná operácia.
   • Prepínač -d
   • Prepínač -p
2. Case konverzie (nemôžu sa kombinovať)
   • Prepínač -u
   • Prepínač -l
3. Nahrádzanie slov (nemôžu sa kombinovať)
   • Prepínač -r (case-sensitive režim)
   • Prepínač -R (case-insensitive režim)

Algoritmus textového procesora vyjadrujúci poradie operácií spracovania riadku je znázornený na obrázku 1.

Ukončenie programu

Textový procesor končí svoju činnosť po načítaní prázdneho riadku. Funkcia main vtedy vráti hodnotu 0. Viac o načítaní prázdneho riadku nájdete v časti Načítanie riadkov textu.

Chybové situácie

Textový procesor môže naraziť na 2 chybové situácie:

• Situácia 1. Nastáva ak je program spustený s neplatným prepínačom (nie je v zozname známych prepínačov). Vtedy program musí skončiť bez akéhokoľvek výstupu a funkcia main vráti hodnotu 1.
• Situácia 2. Nastáva ak nie je zadaný povinný parameter prepínača -r alebo -R. Vtedy program musí skončiť bez akéhokoľvek výstupu a funkcia main vráti hodnotu 2.

1. Vstupné operácie

Tieto operácie slúžia na povolenie/zakázanie určitej skupiny znakov v načítanom riadku. Rozlišujeme 3 typy vstupných operácií. Operácie dané prepínačmi -d a -p sa môžu kombinovať.

• Predvolená vstupná operácia. Po načítaní vstupného riadku sa v ňom ponechajú len malé a veľké písmená anglickej abecedy a medzery. Ostatné znaky sa odfiltrujú. Táto operácia sa vykoná vždy.
• Prepínač -d. Pri zadaní tohto prepínača sa vo vstupnom riadku okrem predvolených znakov (písmená a medzery) ponechajú aj číslice. Na overenie, či je znak číslicou môžeme použiť knižničnú funkciu isdigit.
• Prepínač -p. Pri zadaní tohto prepínača sa vo vstupnom riadku okrem predvolených znakov (písmená a medzery) ponechajú aj interpunkčné znaky. Na overenie, či sa jedná o interpunkčný znak môžeme použiť knižničnú funkciu ispunct.

  Interpunkčné znaky sú:

  !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~

Príklad predvolenej vstupnej operácie

Ukážka obsahuje spustenie programu v termináli, načítaný riadok a pod ním vypísaný výsledok vstupnej operácie.

./program
!123Dnes+svieti.slnko456slovo slovo slovo?
Dnessvietislnkoslovo slovo slovo

Príklad operácie -d

Ukážka obsahuje spustenie programu v termináli, načítaný riadok a pod ním vypísaný výsledok vstupnej operácie.

./program -d
Pismena++a ***CISLA 123456 BUDU zachovane. T./e#s]t   96
Pismenaa CISLA 123456 BUDU zachovane Test   96

Príklad operácie -p

Ukážka obsahuje spustenie programu v termináli, načítaný riadok a pod ním vypísaný výsledok vstupnej operácie.

./program -p
---Interpunkcia+++ sa ne49o612dstran9i. <<<123456789>>>   a+r=c
---Interpunkcia+++ sa neodstrani. <<<>>>   a+r=c

Príklad kombinácie operácií -d a -p

Ukážka obsahuje spustenie programu v termináli, načítaný riadok a pod ním vypísaný výsledok vstupnej operácie.

./program -d -p
C9i,sl452a aj [i]nt95erp3unkci\a nez;;'96aniknu a 9 +    P
C9i,sl452a aj [i]nt95erp3unkci\a nez;;'96aniknu a 9 +    P

Súvisiace zdroje:

• Funkcia isdigit
• Funkcia ispunct

2. Case konverzie

Tieto operácie slúžia na konverziu načítaných písmen v riadku z veľkých na malé alebo opačne. Konverzie sa nesmú kombinovať (testovací softvér ani nebude testovať prípady kombinácie oboch operácií súčasne).

2.1 Lowercase

Lowercase konverzia sa vykoná len v prípade, že bol zadaný prepínač -l. Výsledkom lowercase konverzie je prevod všetkých veľkých písmen na malé. Ostatné znaky riadku zostanú nezmenené.

Príklady lowercase konverzie

Ukážky obsahujú spustenie programu v termináli, načítaný riadok a pod ním vypísaný výsledok lowercase konverzie.

./program -l
VELKE pismena 123. StRiEdAvE pIsMeNa_?     ABC--1--def
velke pismena  striedave pismena     abcdef

./program -d -p -l
***162AbCdeF PPPPP.W.+U+X    7Aa.
***162abcdef ppppp.w.+u+x    7aa.

2.2 Uppercase

Uppercase konverzia sa vykoná len v prípade, že bol zadaný prepínač -u. Výsledkom uppercase konverzie je prevod všetkých malých písmen na veľké. Ostatné znaky riadku zostanú nezmenené.

Príklady uppercase konverzie

Ukážky obsahujú spustenie programu v termináli, načítaný riadok a pod ním vypísaný výsledok uppercase konverzie.

./program -u
987 .-]AakfpWRsqb   aaa   TTT   ...p
 AAKFPWRSQB   AAA   TTT   P

./program -d -p -u
[[[male slovo]]]   111(((VELKE SLOVO)))999   ...  111 a 9d8T315w
[[[MALE SLOVO]]]   111(((VELKE SLOVO)))999   ...  111 A 9D8T315W

3. Nahrádzanie slov

Tieto operácie slúžia na nahradenie určených slov v riadku pomocou reťazca, ktorý bol zadaný ako parameter prepínača -r alebo -R. Tento parameter budeme označovať ako replace_string. Prepínače -r alebo -R sa nesmú kombinovať (testovací softvér ani nebude testovať prípady kombinácie oboch operácií súčasne).

Pri nahrádzaní slov sa očakáva, že používateľ môže pri spustení programu z terminálu zadať aj tzv. non-option argumenty (bližšie sú opísané v časti CMD argumenty). Množinu non-option argumentov budeme v tomto prípade označovať ako N.

3.1 Definícia slova

V zmysle tohto zadania budeme slovom označovať ľubovoľnú alfanumerickú postupnosť znakov, ktorá je oddelená od okolitého textu ne-alfanumerickými znakmi. Na zistenie, či je konkrétny znak alfanumerický môžete použiť knižničnú funkciu isalnum. Každý načítaný riadok textu vieme reprezentovať ako množinu slov W={w₁, w₂, w₃ ..., w_n}.

Poznámka: alfanumerická postupnosť je postupnosť obsahujúca len malé/veľké písmená a číslice.

Príklady reťazcov, ktoré sú považované za slová

hello
WORLD
123word
FANTASTIC777
1a2b3C
a
A
4

3.2 Case-sensitive režim

Vykoná sa ak je zadaný prepínač -r a jeho povinný parameter replace_string, pomocou ktorého nahrádzame slová v množine W. Počas tejto operácie postupne prechádzame slová v množine W zľava doprava a nahrádzame ich pomocou reťazca replace_string. Ostatné znaky riadku, ktoré netvoria slová zostávajú nezmenené. Podmienky kedy dochádza k nahradeniu slova a vysvetlenie ako samotné nahradenie prebieha sú uvedené nižšie.

Ukážka príkazu spustenia programu:

./program -r replace_string arg1 arg2 ar3

• CMD argument replace_string je povinným parametrom prepínača -r.
• CMD argumenty arg1, arg2 a arg3 predstavujú množinu N, t.j. non-option argumenty programu.

Ktoré slová v načítanom riadku sú nahradené pomocou reťazca replace_string?

• Ak je množina N neprázdna. Pre každé jedno slovo w_i v množine W hľadáme jeho case-sensitive predponu v množine N, t.j. zisťujeme, či množina N neobsahuje reťazec, ktorý by bol jeho case-sensitive predponou. Ak pre skúmané slovo w_i nájdeme case-sensitive predponu v množine N, potom dôjde k nahradeniu slova w_i pomocou reťazca replace_string.
• Ak je množina N prázdna. V tomto prípade nedochádza k hľadaniu predpony. Namiesto toho sa nahradí každé jedno slovo z množiny W pomocou replace_string.

Akým spôsobom prebieha nahrádzanie slova v riadku pomocou reťazca replace_string?

Postupne nahrádzame znaky skúmaného slova w_i znakmi reťazca replace_string. Musíme rešpektovať veľkosť písmen (z angl. case) v reťazci replace_string. Ak je replace_string kratší ako slovo w_i, nahradíme len príslušnú časť slova w_i a jeho zvyšok ponecháme nezmenený. Ak je replace_string dlhší ako slovo w_i, nahrádzanie prebieha len po koniec slova w_i.

Príklady prepínača -r

Ukážky obsahujú spustenie programu v termináli, načítaný riadok a pod ním vypísaný výsledok spracovania riadku pomocou prepínača -r.

Prípad, kedy je množina N prázdna.

./program -d -p -r PaPa123
:::Ahoj*** ako sa+dnes.mas?  alfanumericky+programatorsky OK123 ???
:::PaPa*** PaP Pa+PaPa.PaP?  PaPa123ericky+PaPa123atorsky PaPa1 ???

Prípad, kedy množina N obsahuje 1 reťazec.

./program -d -p -r 4GreaT4 Fix
fix FIxka Fixacia ohen 856 Fixinela Fix.Fix+Fix    Fixo*FixFixFixFix
fix FIxka 4GreaT4 ohen 856 4GreaT4a 4Gr.4Gr+4Gr    4Gre*4GreaT4ixFix

Prípad, kedy množina N obsahuje 3 reťazce.

./program -d -p -r heSlo123 pri Nie TRI
Priehrada.pri.pri666tomny.priNiest.Nieco.Nieco.niekto.TRI.TRIsto.TRI333
Priehrada.heS.heSlo123mny.heSlo123.heSlo.heSlo.niekto.heS.heSlo1.heSlo1

3.3 Case-insensitive režim

Vykoná sa ak je zadaný prepínač -R a jeho povinný parameter replace_string, pomocou ktorého nahrádzame slová v množine W. Počas tejto operácie postupne prechádzame slová v množine W zľava doprava a nahrádzame ich pomocou reťazca replace_string. Ostatné znaky riadku, ktoré netvoria slová zostávajú nezmenené. Podmienky kedy dochádza k nahradeniu slova a vysvetlenie ako samotné nahradenie prebieha sú uvedené nižšie.

Ukážka príkazu spustenia programu:

./program -R replace_string arg1 arg2 ar3

• CMD argument replace_string je povinným parametrom prepínača -R.
• CMD argumenty arg1, arg2 a arg3 predstavujú množinu N, t.j. non-option argumenty programu.

Ktoré slová v načítanom riadku sú nahradené pomocou reťazca replace_string?

• Ak je množina N neprázdna. Pre každé jedno slovo w_i v množine W hľadáme jeho case-insensitive predponu v množine N, t.j. zisťujeme, či množina N neobsahuje reťazec, ktorý by bol jeho case-insensitive predponou. Ak pre skúmané slovo w_i nájdeme case-insensitive predponu v množine N, potom dôjde k nahradeniu slova w_i pomocou reťazca replace_string.
• Ak je množina N prázdna. V tomto prípade nedochádza k hľadaniu predpony. Namiesto toho sa nahradí každé jedno slovo z množiny W pomocou replace_string.

Akým spôsobom prebieha nahrádzanie slova v riadku pomocou reťazca replace_string?

Postupne nahrádzame znaky skúmaného slova w_i znakmi reťazca replace_string. Pri alfabetických znakoch reťazca replace_string musíme nastaviť veľkosť nahradeného písmena tak, aby korešpondovala s veľkosťou písmena na rovnakej pozícii v slove w_i. Pri nahrádzaní numerických znakov v slove w_i alfabetickými z reťazca replace_string, zachovávame veľkosť písmen z reťazca replace_string.

Ak je replace_string kratší ako slovo w_i, nahradíme len príslušnú časť slova w_i a jeho zvyšok ponecháme nezmenený. Ak je replace_string dlhší ako slovo w_i, nahrádzanie prebieha len po koniec slova w_i.

Príklady prepínača -R

Ukážky obsahujú spustenie programu v termináli, načítaný riadok a pod ním vypísaný výsledok spracovania riadku pomocou prepínača -R.

Prípad, kedy je množina N prázdna.

./program -d -p -R REPlace555
M n SaTurDay hello 123 123456789 rePLace123 BriGhTNESS aAaaaaAa*bXbb.P6p
R r RePlaCe5 repla REP REPlace55 rePLace555 RepLaCE555 rEplacE5*rEpl.REp

Prípad, kedy množina N obsahuje 1 reťazec.

./program -d -p -R JakuBiSKO auto
auto AuTomatizacia213 AUTO automatika Australia aUtO1111 anglicko 456 aUtomobilka
jaku JaKubiskoacia213 JAKU jakubiskoa Australia jAkUBiSK anglicko 456 jAkubiskoka

Prípad, kedy množina N obsahuje 4 reťazce.

./program -d -p -R 12Havo sto D Pries 888
15 pRieStoR priemer dom STOkrat 888 8 Dvere d9r70+Stopka.percent
15 12haVooR priemer 12h 12Havot 12H 8 12hav 12hav+12havo.percent

Súvisiace zdroje, ktoré môžu pomôcť pri implementácii prepínačov -r a -R:

• Funkcia isalnum
• Funkcia strlen
• Funkcia strcpy
• Funkcia strncpy
• Funkcia strcmp
• Funkcia strncmp
• Funkcia strchr
• Funkcia strstr

Záznam zo seminára č. 6 (22. marec 2022)