# Wyrażenia regularne

    Dodatek niniejszy zawiera krótkie, ale obejmujące większość zagadnień wprowadzenie do tajemniczego świata wyrażeń regularnych. Dokumentacja oparta jest na formacie wyrażeń regularnych stosowanych przez &kate;, która nie jest w pełni kompatybilna z wyrażeniami z języka perl lub polecenia  grep.

## Wprowadzenie

Wyrażenia regularne pozwalają na takie określenie możliwej zawartości przeszukiwanego tekstu, iż stosunkowo prosty program może określić, czy dany fragment pasuje, czy też nie, do poszukiwanego wzorca. Bardziej zaawansowane zastosowania wyrażeń regularnych pozwalają na przechowywanie i późniejsze wykorzystanie dopasowanych wzorców.

Przykładowo, załóżmy, że chcemy znaleźć wszystkie zdania w tekście, rozpoczynające się od słów: Henrik lub Pernille, po których następuje czasownik say.

Wykorzystując tradycyjny mechanizm wyszukiwania należałoby zacząć od znalezienia napisu Henrik z następującym po nim fragmentem sa czyli np: `Henrik sa`. Przeglądając znalezione teksty należałoby odrzucić te nie będące początkiem zdania oraz te, gdzie napis sa nie jest początkiem słów says, said itd. Następnie trzeba oczywiście powtórzyć te działania dla kolejnego nazwiska...

Za pomocą wyrażeń regularnych zadanie to może być wykonane za pomocą jednej operacji szukania i z dużo większą precyzją.

W wyrażeniu regularnym definiowane są reguły generalizujące poszukiwany fragment tekstu. W podanym przykładzie pożądany rezultat szukania można słownie opisać tak: Wyszukaj wiersz rozpoczynający się albo od słowa Henrik albo Pernille (przed którym występuje do 4 spacji lub znaków tabulacji), i następujący po nim tekst sa z końcówkami ys lub id. Można to osiągnąć za pomocą następującego wyrażenia regularnego:

`^[ \t]{0,4}(Henrik|Pernille) sa(ys|id)`

Powyższy przykład przedstawia cztery główne mechanizmy współczesnych wyrażeń regularnych:

- Wzorce

- Zakotwiczenia

- Kwantyfikatory

- Odwołania zwrotne

Znak karetki (`^`), rozpoczynający wyrażenie jest zakotwiczeniem oznaczającym, iż dopasowanie będzie możliwe tylko wtedy, jeżeli podany wzorzec znajdzie się na początku wiersza.

Napisy `[ \t]` oraz `(Henrik|Pernille) sa(ys|id)` to tzw. wzorce. Pierwszy określa klasę znaków, która będzie dopasowana do spacji lub tabulatora, drugi zawiera wzorzec składający się z podwzorca pasującego do napisu `Henrik` albo `Pernille`. Następnie poszukiwany jest fragment `sa`, a potem podwzorzec pasujący do napisów `ys` lub `id`.

Zapis `{0,4}` jest kwantyfikatorem oznaczającym, iż dopasowane zostaną co najmniej 0 lecz nie więcej niż 4 wystąpienia określonego wzorca.

Ponieważ oprogramowanie obsługi wyrażeń regularnych zawiera mechanizm odwołań zwrotnych, możliwe jest zachowanie całego dopasowanego fragmentu tekstu (określonego jako podwzorzec w nawiasach okrągłych), a następnie wykorzystanie tego fragmentu w dalszej części wyrażenia (w podanym przykładzie może to być dopasowane nazwisko lub ostatnia część czasownika).

Podsumowując, wprowadzone wyrażenie regularne będzie pasować do tekstu tam, i tylko tam, gdzie użytkownik tego wymaga.

Poniższe sekcje zawierają szczegółowe informacje o wykorzystaniu wzorców, klas znaków, zakotwiczeń, kwantyfikatorów i odwołań zwrotnych. W ostatniej części przedstawiono kilka pożytecznych przykładów wykorzystania wyrażeń regularnych.

## Wzorce

Wzorce mogą się składać ze znaków i klas znaków. Wzorce mogą zawierać podwzorce, czyli wzorce zamknięte w nawiasach okrągłych.

### Sekwencje specjalne

W definicji zarówno wzorców, jak i klas znaków, niektóre znaki mają specjalne znaczenie. Aby wyszukać te znaki w tekście, muszą być zapisane w postaci sekwencji specjalnej, tak aby program obsługi wyrażeń regularnych interpretował je jako znaki tekstu, a nie znaki sterujące procesem wyszukiwania.

Aby tego dokonać należy poprzedzić znak specjalny znakiem odwrotnego ukośnika (`\`).

Program obsługujący wyrażenia regularne pozwala zapisywać każdy znak w postaci sekwencji specjalnej, nawet taki, który nie ma żadnego specjalnego znaczenia. Na przykład zapisanie litery j w postaci sekwencji `\j` jest całkowicie poprawne i oznacza literę j. Jeżeli więc użytkownik nie jest pewny czy dany znak ma znaczenie specjalne czy też nie, to może go dla bezpieczeństwa zapisać w postaci sekwencji specjalnej.

Istnieje oczywiście również sekwencja specjalna dla określenia znaku odwrotnego ukośnika i jest to: `\\`.

### Skróty i klasy znaków

Klasa znaków to wyrażenie pasujące do jednego znaku wybranego z określonego zbioru znaków. W wyrażeniach regularnych klasy znaków są definiowane poprzez podanie zbioru znaków wewnątrz nawiasów kwadratowych `[]` lub poprzez użycie jednego ze skrótowych predefiniowanych klas znaków opisanych poniżej.

Proste klasy znaków zawierają listę znaków np.: `[abc]` (klasa pasuje do każdej z liter: a, b lub c) albo `[0123456789]` (klasa znaków pasująca do dowolnej cyfry).

Ponieważ litery i cyfry można ustawić w logicznym porządku, to możliwe jest zapisanie klas znaków w postaci zakresów znaków np.: `[a-c]` jest równoważne zapisowi `[abc]`, zaś `[0-9]` jest tożsame z zapisem `[0123456789]`. Dopuszczalne są różne kombinacje zakresów w definicji klas znaków np. `[a-fynot1-38]` jest całkowicie poprawne, i będzie pasować do jednego następujących znaków: a,b,c,d, e,f,y,n,o,t, 1,2,3 lub 8).

Duże litery i małe litery są różnymi znakami dla oprogramowania obsługi wyrażeń regularnych, aby więc określić wzorzec nie uwzględniający wielkości liter: a lub b należy zapisać go następująco: `[aAbB]`.

Możliwe jest oczywiście utworzenie negacji klasy znaków, która oznacza dopasowanie do wszystkich znaków oprócz tych określonych w klasie. Negacji klasy dokonuje się za pomocą znaku karetki(`^`), który musi stanowić pierwszy znak jej definicji:

`[^abc]` pasuje do każdego znaku z wyjątkiem liter :a, b lub c.

Oprócz znaków alfabetu zdefiniowane zostały skróty dla pewnych znaków specjalnych oraz najczęściej używanych klas znaków:

`\a`

- Pasuje do znaku ASCII dzwonka (BEL, 0x07).

`\f`

- Pasuje do znaku ASCII form feed (FF, 0x0C).

`\n`

- Pasuje do znaku ASCII line feed (LF, 0x0A, nowy wiersz w systemach UNIX).

`\r`

- Pasuje do znaku ASCII carriage return (CR, 0x0D).

`\t`

- Pasuje do znaku ASCII - tabulacja pozioma (HT, 0x09).

`\v`

- Pasuje do znaku ASCII tabulacja pionowa (VT, 0x0B).

`\xhhhh`

- Pasuje do znaku Unicode o numerze "hhhh" zapisanym w formacie szesnastkowym (w zakresie od 0x0000 do 0xFFFF). \0ooo (tzn.: \zero ooo) pasuje do znaku ASCII/Latin-1 o kodzie "ooo" w systemie ósemkowym (z zakresu od 0 do 0377).

`.` (kropka)

- Pasuje do każdego znaku (także do znaku końca wiersza).

`\d`

- Pasuje do cyfry, co jest tożsame z zapisem: `[0-9]`

`\D`

- Pasuje do znaku nie będącego cyfrą, co jest równoważne zapisom: `[^0-9]` lub `[^\d]`

`\s`

- Pasuje do znaku spacji lub innego tzw. białego znaku. Tożsame z: `[ \t\n\r]`

`\S`

- Dopasowuje znak nie będący spacją lub innym tzw. białym znakiem. Tożsame z: `[^ \t\n\r]` lub `[^\s]`

`\w`

- Pasuje do dowolnego elementu słowa - tzn. do dowolnej litery lub cyfry. Należy zwrócić uwagę, iż znak podkreślenia (`_`) nie zostanie dopasowany (co dzieje się np. w wyrażeniach regularnych Perl-a). Zapis ten równoważny jest klasie znaków: `[a-zA-Z0-9]`

`\W`

- Pasuje do wszystkich znaków nie będących literami bądź cyframi, co jest równoważne wyrażeniom `[^a-zA-Z0-9]` lub `[^\w]`

Skróty można wykorzystywać we własnych definicjach klas np. aby dopasować znak alfabetu, spację oraz kropkę można użyć wyrażenia: `[\w \.]`

Zapis klas znaków w notacji POSIX `[:<class name>:]` nie jest obecnie obsługiwany przez &kate;.

#### Znaki o specjalnym znaczeniu dla klas znaków

Następujące znaki mają specjalne znaczenie wewnątrz definicji klasy znaków []. Muszą one być zapisane w postaci sekwencji specjalnej, jeżeli użytkownik chce je umieścić jako element klasy:

`]`

- Znak kończący definicję klasy znaków. Musi być zapisany w postaci sekwencji specjalnej, jeżeli nie jest pierwszym znakiem klasy (może nastąpić po daszku ^ tzn. negacji klasy).

`^` (daszek)

- Oznacza negację klasy w przypadku, jeżeli jest na pierwszym miejscu jej definicji. Musi być zapisany w postaci sekwencji specjalnej w przypadku występowania jako pierwszy znak klasy.

`-` (minus)

- Oznacza zakres znaków w klasie. Zawsze musi być zapisany w postaci sekwencji specjalnej.

`\` (odwrotny ukośnik)

- Występuje tylko pod postacią sekwencji specjalnej.

### Alternatywa, czyli dopasowanie jednego z kilku wzorców

Jeżeli konieczne jest dopasowanie wyrażenia do jednego ze zbioru kilku alternatywnych wzorców, to należy je zapisać rozdzielając znakiem `|` (pionowej kreski).

Na przykład w celu odszukania w tekście słów John lub Harry należy użyć wyrażenia `John|Harry`.

### Podwzorce

Podwzorce, czyli wzorce zamknięte w nawiasach okrągłych, wykorzystywane są w wielu sytuacjach przy tworzeniu wyrażeń regularnych.

#### Definiowanie alternatyw

Można skorzystać z podwzorców do grupowania zbioru wzorców alternatywnych, składających się na inny wzorzec. Wzorce alternatywne rozdzielane są znakiem | (pionowej kreski).

Na przykład aby wyszukać jeden z trzech wyrazów: int, float lub double można użyć wzorca `int|float|double`. Jeżeli dodatkowo po każdym z tych wyrazów ma występować spacja i pewna liczba innych znaków to należy to wyrażenie zapisać jako podwzorzec w nawiasach okrągłych: `(int|float|double)\s+\w+`.

#### Przechwytywanie dopasowanego tekstu (odwołania zwrotne)

Wykorzystanie odwołań zwrotnych wymaga użycia podwzorca dla określenia części wzorca, którą system wyrażeń regularnych powinien przechwycić.

Przykładowo, jeżeli poszukiwane są dwa następujące po przecinku (i ew. spacji) powtórzenia tego samego słowa, to wyrażenie będzie miało postać `(\w+),\s*\1`. Podwzorzec `\w+` pasuje do zbitki liter lub cyfr zaś całe wyrażenie będzie dopasowane, jeżeli po tym podwzorcu wystąpi przecinek (spacja - 0 lub więcej), a następnie identyczna zbitka liter lub cyfr (zapis `\1` odwołuje się do przechwyconego pierwszego zapisanego w nawiasach podwzorca wyrażenia).

#### Zakotwiczenia w przód

Zakotwiczenie w przód to podwzorzec rozpoczynający się od znaków `?=` lub `?!`.

Na przykład, aby dopasować napis Bill, ale tylko wtedy, gdy nie następuje po nim napis Gates, można użyć wyrażenia: `Bill(?! Gates)`. Pasuje ono do napisów Bill Clinton oraz Billy the kid, ale ignoruje inne wystąpienia.

Podwzorce wykorzystane przy zakotwiczeniach nie są przechwytywane.

Więcej informacji w sekcji Zakotwiczenia

### Znaki specjalnego znaczenia wewnątrz wzorców

Następujące znaki mają specjalne znaczenie wewnątrz definicji wzorca. Muszą one być zapisane w postaci sekwencji specjalnej w przypadku ich wyszukiwania w tekście:

`\` (odwrotny ukośnik)

- Odwrotny ukośnik.

`^` (daszek)

- Zakotwiczenie do początku tekstu.

`$`

- Zakotwiczenie do końca tekstu.

`()` (lewy i prawy nawias)

- Oznaczenie podwzorca.

`{}` (lewy i prawy nawias klamrowy)

- Oznaczenie kwantyfikatora.

`[]` (lewy i prawy nawias kwadratowy)

- Oznaczenie klasy znaków.

`|` (pionowa kreska)

- Logiczne LUB. Rozdziela wzorce alternatywne.

`+` (znak plusa)

- Kwantyfikator, oznacza: "1 lub więcej" wystąpień.

`*` (gwiazdka)

- Kwantyfikator, oznacza: "0 lub więcej" wystąpień.

`?` (znak zapytania)

- Oznacza opcjonalność wzorca. Może być interpretowany jako kwantyfikator: 0 lub 1.

## Kwantyfikatory

Kwantyfikatory umożliwiają definiowanie wyrażeń regularnych, które dopasowują się do określonej liczby (zakresu) znaków, wzorców lub klas znaków.

Kwantyfikatory zapisywane są w nawiasach klamrowych (`{` oraz `}`) i mają postać: `{[minimalna liczba wystąpień][,[maksymalna liczba wystąpień]]}`

Wykorzystanie kwantyfikatorów zaprezentowano w poniższych przykładach:

`{1}`

- Dokładnie jedno wystąpienie

`{0,1}`

- Brak wystąpienia lub jedno wystąpienie

`{,1}`

- To co powyżej ale mniej pisania ;-)

`{5,10}`

- Co najmniej 5, ale nie więcej niż 10 wystąpień.

`{5,}`

- Co najmniej 5 wystąpień (brak górnego ograniczenia).

Dodatkowo możliwe jest wykorzystanie kilku skrótów:

`*` (gwiazdka)

- podobnie jak `{0,}`, wyszukuje dowolną liczbę wystąpień.

`+` (znak plusa)

- podobnie jak `{1,}`, wyszukuje co najmniej jedno wystąpienie.

`?` (znak zapytania)

- podobnie jak `{0,1}`, dopasowuje brak lub dokładnie jedno wystąpienie.

### Zachłanność

Jeżeli kwantyfikatory nie mają określonej maksymalnej liczby wystąpień, to wyrażenie jest dopasowywane do maksymalnej możliwej liczby wyszukiwanych wzorców. Zachowanie takie nazywane jest zachłannością kwantyfikatorów.

Współczesne oprogramowanie obsługujące wyrażenia regularne pozwala na wyłączenie zachłanności. W środowisku graficznym możliwość ta może być dostępna albo nie. Przykładowo, w oknie wyszukiwania pozwalającym na użycie wyrażeń regularnych, może znaleźć się pole wyboru o nazwie: Minimalne dopasowanie. Powinna też znaleźć się tam informacja, iż zachłanność jest zachowaniem domyślnym dla wyrażeń regularnych.

### Przykłady

Poniżej znajduje się kilka przykładów użycia kwantyfikatorów

`^\d{4,5}\s`

- Pasuje do cyfr napisu 1234 go oraz 12345 now ale nie pasuje do napisów 567 eleven albo 223459 somewhere

`\s+`

- Pasuje do jednej lub więcej spacji lub innych tzw. białych znaków

`(bla){1,}`

- Pasuje do wszystkich blablabla oraz bla w słowach blackbird lub tabla

`/?>`

- Pasuje do /> w <closeditem/> jak również do > w <openitem>.

## Zakotwiczenia

Zakotwiczenia pozwalają dopasowywać wzorce wyrażenia regularnego tylko wtedy, gdy spełnione są określone warunki.

Zakotwiczenie nie musi określać żadnego znaku do dopasowania. Bada ono raczej otoczenie potencjalnego dopasowania przed jego zatwierdzeniem. Na przykład zakotwiczenie granica słowa nie działa na zasadzie wyszukiwania znaków nie pasujących do słowa, ale zamiast tego sprawdza, czy kolejny znak nie jest znakim składającym się na słowo. Oznacza to, iż zakotwiczenie może zostać dopasowane tam, gdzie nie ma żadnego znaku (np. na końcu przeszukiwanego napisu).

Część zakotwiczeń właściwie nie posiada wzorca dopasowania, lecz zamiast tego wskazują część napisu nie stanowiącą rezultatu dopasowania całego wyrażenia.

Wyrażenia regularne opisane w tej dokumentacji pozwalają na użycie następujących zakotwiczeń:

`^` (daszek: początek tekstu)

- Określa początek przeszukiwanego tekstu.

  Wyrażenie `^Peter` spowoduje dopasowanie wzorca Peter dla tekstu Peter, hey! ale już nie dla tekstu: Hey, Peter!

`$` (koniec tekstu)

- Określa koniec przeszukiwanego tekstu.

  Wyrażenie `you\?$` będzie dopasowane do ostatniego "you" w tekście You didn't do that, did you?, ale już nie dla tekstu: You didn't do that, right?

`\b` (granica słowa)

- Określa sytuację gdy po jednej stronie jest element słowa, a po drugiej inny znak (nie będący elementem słowa).

  Funkcja przydatna do wykrywania końca słów. Jej użycie po dwóch stronach wzorca spowoduje dopasowanie tylko całych wyrazów. Wyrażenie `\bin\b` będzie dopasowane do in w tekście He came in through the window, ale nie do napisu in w słowie window.

`\B` (przeciwieństwo granicy słowa)

- Dopasowuje wzorzec wszędzie tam, gdzie \b nie spowoduje dopasowania.

  Oznacza to, iż będą wyszukiwane wzorce znajdujące się np. wewnątrz dłuższych wyrazów. Wyrażenie `\Bin\B` będzie dopasowane do "in" w słowie window, ale już nie do "in" w wyrazie integer, czy też napisie I'm in love.

`(?=PATTERN)` (Zakotwiczenie w przód)

- Zakotwiczenie w przód analizuje część napisu następującą po potencjalnym dopasowaniu. Zakotwiczenie w przód nie spowoduje dopasowania wzorca, jeżeli tekst następujący po nim nie pasuje do PATTERN (wzorca) zakotwiczenia. Należy podkreślić iż tekst, który pasuje do wzorca zakotwiczenia, nie będzie częścią rezultatu wyszukiwania.

  Wyrażenie `handy(?=\w)` dopasowane będzie do handy w słowie handyman ale już nie do napisu: That came in handy!

`(?!PATTERN)` (Negacja zakotwiczenia w przód)

- Zanegowane zakotwiczenie w przód nie dopuści dopasowania wzorca, jeżeli tekst następujący po nim pasuje do PATTERN (wzorca) zakotwiczenia.

  Wyrażenie `const \w+\b(?!\s*&)` pasuje do tekstu const char w napisie const char* foo ale już nie będzie pasować do const QString w const QString& bar ponieważ znak & pasuje do negacji zakotwiczenia w przód.