Marek
Laane

    bald@starman.ee

Tõlge eesti keelde

# Süntaksi esiletõstmise kasutamine

## Ülevaade

Süntaksi esiletõstmine paneb redaktori automaatselt näitama teksti erinevates stiilides ja värvides vastavalt stringi funktsioonile failis. Rakenduse lähtetekstis võivad koodi juhtlaused olla näiteks rasvases kirjas, andmetüübid ja kommentaarid aga ülejäänud tekstist erinevat värvi. See hõlbustab märgatavalt teksti redigeerimist ning aitab autoril tõhusamalt ja tootlikumalt töötada.

Perli funktsioon, esitatud süntaksi esiletõstu kasutades.

Perli funktsioon, esitatud süntaksi esiletõstu kasutades.

Sama perli funktsioon ilma esiletõstuta.

Sama perli funktsioon ilma esiletõstuta.

Kumba kahest näitest on hõlpsam lugeda?

&kate; kasutab paindlikku, seadistatavat ja võimsat süntaksi esiletõstmise süsteemi ning ka tavalise distributsiooniga käib kaasas väga ulatuslik programmeerimis-, märke- ja skriptikeelte ning muude tekstifaili vormingute definitsioonide komplekt. Lisaks võid luua omaenda definitsioonid tavaliste &XML;-failide kujul.

&kate; tuvastab faili avamisel selle &MIME; tüübile tuginedes (mille määrab kindlaks faililaiend või kui seda ei ole, siis sisu) automaatselt sobiva süntaksi ja selle reeglid. Kui sinu arvates on valik valesti langetatud, võid kasutatava süntaksi määrata käsitsi menüüst Tööriistad Esiletõstmine.

Iga süntaksi esiletõstu määratluse stiilid ja värvid saab ise seada seadistustedialoogi leheküljel Tekstistiilide esiletõstmine, &MIME; tüübid aga, mille puhul esiletõstu kasutada, leheküljel Režiimid ja failitüübid.

Süntaksi esiletõstmine on mõeldud parandama korrektse teksti lugemist, kuid seda ei peaks kasutama teksti korrektsuse kontrollimiseks. Teksti süntaksi märkimine on sõltuvalt kasutatavast vormingust päris keeruline ettevõtmine ja mõnel juhul on süntaksireeglite autorid väga uhked, kui suudavad korrektselt esitada 98% tekstist, kuigi enamasti läheb sul vaja mõnda päris haruldast stiili, et näha mittekorrektset 2%.

Uusi või uuendatud süntaksi esiletõstu definitsioone saab alla laadida &kate; veebileheküljelt klõpsuga nupule Laadi esiletõstu failid alla... seadistustedialoogi leheküljel Režiimid ja failitüübid.

## &kate; süntaksi esiletõstmise süsteem

See sektsioon tutvustab põhjalikumalt &kate; süntaksi esiletõstmise mehhanismi. See on mõeldud neile, kes soovivad sellest rohkem teada saada või tahavad süntaksi definitsioone muuta või uusi luua.

### Kuidas see töötab

Kui sa faili avad, püüab &kate; redaktor kõigepealt tuvastada, millist süntaksi definitsooni antud faili puhul kasutada. Faili teksti lugedes, samuti ajal, mil sa seda redigeerid, analüüsib süntaksi esiletõstu süsteem teksti, kasutades selleks süntaksi definitsioonis antud määratlusi, ning märgistab erinevad kontekstid ja stiilid vastavalt reeglitele.

Dokumenti uue teksti kirjutamise ajal analüüsitakse ja märgistatakse see käigult, nii et kui kustutad märgi, mis tähistas mingi konteksti algust või lõppu, siis muutub vastavalt ka ümbritseva teksti stiil.

Süntaksi definitsioonid, mida &kate; kasutab esiletõstu süsteemis, on &XML;-failid, mis sisaldavad endas

- reegleid kontekstiblokkideks organiseeritud teksti rolli määramiseks

- märksõnade nimekirju

- stiilielementide definitsioone

Teksti analüüsides hinnatakse tuvastusreegleid vastavalt nende defineerimise järjekorrale ja kui mingi stringi algus vastab reeglile, siis kasutatakse vastavat konteksti. Alguspunktist liigutakse punkti, kus reegli kohaselt kontekst lõpeb, ning sealt algab reegli uus osa, mis võib olla erinevalt märgistatud.

### Reeglid

Tuvastusreeglid on esiletõstu tuvastamise tuum. Reegel on string, märk või regulaaravaldis, millega sobivuse osas teksti analüüsitaksegi. Selles sisaldub info, millist stiili kasutada sobiva tekstiosa puhul. Reegel võib lülitada süsteemi töökonteksti kas otseselt mainitud kontekstile või varem tekstis kasutatud kontekstile.

Reeglid on rühmitatud kontekstigruppidesse. Kontekstigruppi kasutatakse vormingu peamiste tekstiosiste jaoks, milleks võivad näiteks olla jutumärkides tekstistringid või kommenteeritud tekstiblokid. See tagab, et esiletõstu süsteem ei pea läbi lappama kõiki reegleid, kui seda ei ole vaja, ja et mõningaid järjestikusi märke tekstis võib tõlgendada erinevalt sõltuvalt hetkekontekstist.

Konteksti saab genereerida dünaamiliselt, mis lubab reeglites kasutada protsessipõhiseid andmeid.

### Kontekstistiilid ja võtmesõnad

Mõnes programmeerimiskeeles tõlgendab kompilaator (rakendus, mis teisendab lähtekoodi binaarkoodiks) täisarve teisiti kui ujukomaarve ning mõnikord võib esineda ka märke, mis omandavad eritähenduse, kui nad asuvad jutumärkide vahel. Sellisel juhul on mõttekas käsitleda neid ümbritsevast erinevalt, nii et neid saaks teksti lugedes hõlpsasti eristada. Seepärast võib süntaksi esiletõstmise süsteem käsitleda neid erikontekstina ja vastavalt ka märkida, isegi kui nad seda tegelikult ei ole.

Süntaksi definitsioon võib sisaldada nii palju stiile, kui vähegi on vaja katmaks vorminguelemente, mille tuvastamiseks ta mõeldud on.

Mitme vormingu puhul esinevad sõnade nimekirjad, mis esindavad erikontseptsiooni. Näiteks programmeerimiskeeltes on juhtlaused, andmetüübid ja keele sisseehitatud funktsioonid erinevad kontseptsioonid. &kate; süntaksi esiletõstu süsteem kasutab selliseid nimekirju tuvastamaks ja märkimaks tekstis sõnu, mis vastavad tekstivormingu kontseptsioonidele.

### Vaikestiilid

Kui avad &kate;s C++ lähtetekstifaili, &Java; lähtetekstifaili ja HTML-dokumendi, märkad, et kuigi vormingud on erinevad ja seepärast on erikohtlemise osaks saanud erinevad sõnad, on kasutatavad värvid ühesugused. Selle põhjuseks on asjaolu, et &kate; kasutab eelnevalt määratud vaikestiilide nimekirja, mida siis omakorda kasutavad konkreetsed süntaksi määratlused.

See võimaldab hõlpsasti tuvastada ühesuguseid kontseptsioone erinevate tekstivormingute puhul. Nii esinevad näiteks kommentaarid peaaegu igas programmeerimis-, skripti- või märkekeeles ja kui nende märkimiseks kasutatakse igas keeles ühesugust värvi, siis ei pea uut faili avades nägema vaeva nende leidmisega.

Kõik stiilid süntaksi definitsioonis kasutavad üht vaikestiili. Mõned süntaksi definitsioonid võivad kasutada rohkem stiile, kui neid on vaikimisi määratud, nii et kui kasutad tihti sellist vormingut, võiks olla nutikas tegu avada seadistustedialoog ja järele vaadata, kas mõningad kontseptsioonid kasutavad üht ja sama stiili. Näiteks on ainult üks vaikestiil stringide jaoks, kuid programmeerimiskeel Perl kasutab kaht tüüpi stringe, mistõttu esiletõstu saab parandada neile veidi erinevaid omadusi andes. Kõiki saadaolevaid vaikestiile selgitame veidi hiljem.

## Esiletõstu definitsiooni &XML;-vorming

### Ülevaade

See sektsioon annab ülevaate esiletõstu definitsiooni &XML;-vormingust, kirjeldades põhikomponente, nende tähendust ja kasutamist. Järgmises sektsioonis süüvitakse tuvastusreeglite olemusse.

Formaalne määratlus ehk DTD on salvestatud faili `language.dtd`, mis peaks olema paigaldatud kataloogi `$`KDEDIR`/share/apps/katepart/syntax`.

#### &kate; esiletõstu definitsiooni failide põhisektsioonid

Esiletõstu fail sisaldab päist, mis määrab ära XML-i versiooni ja doctype'i:

      <?xml version="1.0" encoding="UTF-8"?>
      <!DOCTYPE language SYSTEM "language.dtd">

Definitsioonifaili juureks on element `language`. Võimalikud atribuudid on järgmised:

  Nõutavad atribuudid:

  `name` määrab keele nime. Seda näeb ka menüüdes ja dialoogides.

  `section` määrab kategooria.

  `extensions` määrab faililaiendid, näiteks "*.cpp;*.h"

  Lisaatribuudid:

  `mimetype` seostab failid &MIME; tüübiga.

  `version` määrab definitsioonifaili versiooni.

  `kateversion` määrab viimase toetatud &kate; versiooni.

  `casesensitive` määrab, kas võtmesõnad on tõstutundlikud või mitte.

  `priority` on vajalik juhul, kui samu laiendeid kasutab mõni muu esiletõstu definitsiooni fail. Sel juhul saab eelistuse kõrgem prioriteet.

  `author` sisaldab autori nime ja tema e-posti aadressi.

  `license` sisaldab litsentsi (tavaliselt LGPL, Artistic, GPL vms.).

  `hidden` määrab, kas nimi esineb &kate; menüüs või mitte.

  Niisiis võib järgmine rida näha välja selline:

      <language name="C++" version="1.00" kateversion="2.4" section="Sources" extensions="*.cpp;*.h" />

Seejärel tuleb element `highlighting`, mis võib sisaldada endas elementi `list` ja kus peavad leiduma elemendid `contexts` ja `itemDatas`.

  Element `list` sisaldab võtmesõnade nimekirja. Antud juhul on võtmesõnadeks class ja const. Nimekirju võib lisada nii palju, kui neid parajasti vaja läheb.

  Element `contexts` sisaldab kõiki kontekste. Esimene kontekst on vaikimisi esiletõstu alguses. Kontekstis Tavaline tekst on kaks reeglit, millest üks sobitab võtmesõnade nimekirja nimega minginimi ja teine tuvastab jutumärgid ning lülitub kontekstile string. Reeglitest räägib lähemalt järgmine peatükk.

  Kolmas osa on element `itemDatas`. See sisaldab kõiki värvi- ja fondistiile, mida kontekstid ja reeglid vajavad. Antud näites on kasutusel `itemData` Tavaline tekst, String ja Võtmesõna.

      <highlighting>
          <list name="minginimi">
            <item> class </item>
            <item> const </item>
          </list>
          <contexts>
            <context attribute="Tavaline tekst" lineEndContext="#pop" name="Tavaline tekst" >
              <keyword attribute="Võtmesõna" context="#stay" String="minginimi" />
              <DetectChar attribute="String" context="string" char="&quot;" />
            </context>
            <context attribute="String" lineEndContext="#stay" name="string" >
              <DetectChar attribute="String" context="#pop" char="&quot;" />
            </context>
          </contexts>
          <itemDatas>
            <itemData name="Tavaline tekst" defStyleNum="dsNormal" />
            <itemData name="Võtmesõna" defStyleNum="dsVõtmesõna" />
            <itemData name="String" defStyleNum="dsString" />
          </itemDatas>
        </highlighting>

Esiletõstu definitsiooni viimane osa on mittekohustuslik sektsioon `general`. See võib sisaldada infot võtmesõnade, koodi voltimise, kommentaaride ja treppimise kohta.

  Sektsioon `comment` määrab, millise stringiga algab üherealine kommentaar. Määrata võib ka mitmerealise kommentaari, kasutades atribuuti multiLine koos lisaatribuudiga end. Seda kasutatakse siis, kui kasutaja tarvitab kommentaari lisamise/eemaldamise kiirklahvi.

  Sektsioon `keywords` määrab, kas võtmesõnade nimekirjad on tõstutundlikud või mitte. Teisi atribuute selgitame hiljem.

      <general>
          <comments>
            <comment name="singleLine" start="#"/>
          </comments>
          <keywords casesensitive="1"/>
        </general>
      </language>

### Sektsioonid üksikasjalikult

Selles osas kirjeldame kõiki saadaolevaid konteksti, 'itemData', võtmesõnade, kommentaaride, koodi voltimise ja treppimise atribuute.

Element `context` kuulub gruppi `contexts`. Kontekst määrab kontekstispetsiifilised reeglid, näiteks selle, mis juhtub siis, kui esiletõstu süsteem jõuab oma tegevuses rea lõppu. Võimalikud atribuudid on järgmised:

  `name` määrab konteksti nime. Reeglid kasutavad seda määramaks konteksti, millele lülituda, kui reegel sobib.

  `lineEndContext` määrab konteksti, millele esiletõstu süsteem lülitub rea lõppu jõudes. See võib olla mõne teise konteksti nimi, `#stay`, mis keelab konteksti vahetamise, või `#pop`, mis sunnib kontekstist loobuma. Võimalik on ka kasutada näiteks `#pop#pop#pop`, et kolm korda järjest kontekstist loobuda.

  `lineBeginContext` määrab konteksti, kui ette tuleb reaalgus. Vaikimisi #stay.

  `fallthrough` määrab, kas lülituda kontekstile, mille määrab fallthroughContext, kui ühtegi sobivat reeglit ei leita, või mitte. Vaikimisi väär (false).

  `fallthroughContext` määrab järgmise konteksti, kui ei leita ühtegi sobivat reeglit.

  `dynamic`: kui on tõene (true), jätab kontekst meelde dünaamiliste reeglite salvestatud stringid/kohatäitjad. Seda on vaja näiteks HERE-dokumentide jaoks. Vaikimisi väär (false).

Element `itemData` kuulub gruppi `itemDatas`. See määrab fondistiili ja värvid. Nii saab määrata ka omaenda stiilid ja värvid, kuid soovitatav oleks võimaluse korral siiski kasutada vaikestiile, et kasutaja näeks alati ka erinevates keeltes ühesuguseid värve. Vahel on siiski mõttekas ja vajalik värvide ja fontide atribuute muuta. Nõutav on atribuudi nimi ja defStyleNum, ülejäänud pole kohustuslikud. Võimalikud atribuudid on järgmised:

  `name` määrab itemData nime. Kontekstid ja reeglid kasutavad seda nime oma atribuudis atribuut itemData'le viidates.

  `defStyleNum` määrab kasutatava vaikestiili. Saadaolevaid vaikestiile tutvustame edaspidi.

  `color` määrab värvi. Sobiv vorming on '#rrggbb' või '#rgb'.

  `selColor` määrab valiku värvi.

  `italic`: kui on tõene (true), on tekst kaldkirjas.

  `bold`: kui on tõene (true), on tekst rasvases kirjas.

  `underline`: kui on tõene (true), on tekst allajoonitud.

  `strikeout`: kui on tõene (true), on tekst läbikriipsutatud.

Element `keywords` grupis `general` määrab võtmesõna omadused. Võimalikud atribuudid on järgmised:

  `casesensitive` võib olla tõene (true) või väär (false). Kui see on tõene, on kõik võtmesõnad tõstutundlikud.

  `weakDeliminator` on märkide nimekiri, mida ei kasutata sõnaeraldajana. Näiteks punkt `'.'` on sõnaeraldaja. Eeldusel, et võtmesõna atribuudis `list` sisaldab punkti, leitakse sobivus ainult siis, kui määrad punkti nõrgaks eraldajaks.

  `additionalDeliminator` määrab lisaeraldajad.

  `wordWrapDeliminator` määrab märgid, mille järel võib rida murda.

  Vaikimisi on eraldajateks ja sõnamurdmise eraldajateks märgid `.():!+,-<=>%&*/;?[]^{|}~\`, tühikumärk (`' '`) ja tabeldusmärk (`'\t'`).

Element `comment` grupis `comments` määrab kommentaari omadused, mida kasutatakse menüükäskude Tööriistad Kommentaar ja Tööriistad Kommentaari eemaldamine jaoks. Võimalikud atribuudid on järgmised:

  `name` on kas singleLine või multiLine. Kui valida multiLine, on vajalikud ka atribuudid end ja region.

  `start` määrab stringi, millega alustatakse kommentaari. C++ korral on see näiteks "/*".

  `end` määrab stringi, millega lõpetatakse kommentaar. C++ korral on see näiteks "*/".

  `region` on mitmerealise kokkuvolditava kommentaari nimi. Eeldusel, et su reeglites on beginRegion="Comment" ... endRegion="Comment", tuleb kasutada region="Comment". Sel juhul toimib kommentaari eemaldamine ka siis, kui sa ei vali kogu mitmerealise kommentaari teksti - lihtsalt kursor peab asuma mitmerealise kommentaari sees.

Element `folding` grupis `general` määrab koodivoltimise omadused. Võimalikud atribuudid on järgmised:

  `indentationsensitive`: kui see on tõene (true), lisatakse koodivoltimise markerid vastavalt treppimisele (näiteks skriptikeeles Python). Tavaliselt pole seda vaja ning vaikimisi ongi see väär (false).

Element `indentation` grupis `general` määrab, millist treppimist kasutada. Soovitatav on siiski seda elementi vältida, sest treppimine määratakse tavaliselt kas failitüüpi defineerides või režiimirida tekstifailile lisades. Kui see siiski määrata, sunnitakse kasutajale peale konkreetne treppimine, mis aga ei pruugi alati kuigi hästi sobida. Võimalikud atribuudid on järgmised:

  `mode` on treppimise nimi. Praegu on saada järgmised treppimised: tavaline, cstyle, haskell, lilypond, lisp, python, ruby ja xml.

### Saadaolevad vaikestiilid

Vaikestiile me lühidalt juba tutvustasime: need on eelnevalt määratud fondi- ja värvistiilid.

Seepärast loetleme siin lihtsalt saadaolevad vaikestiilid:

  `dsNormal` tavalise teksti jaoks.

  `dsKeyword` võtmesõnade jaoks.

  `dsDataType` andmetüüpide jaoks.

  `dsDecVal` murdarvväärtuste jaoks.

  `dsBaseN` väärtuste jaoks, mille aluseks ei ole 10.

  `dsFloat` ujukomaväärtuste jaoks.

  `dsChar` märkide jaoks.

  `dsString` stringide jaoks.

  `dsComment` kommentaaride jaoks.

  `dsOthers` 'muude asjade' jaoks.

  `dsAlert` hoiatuste jaoks.

  `dsFunction` funktsiooni väljakutsete jaoks.

  `dsRegionMarker` regiooni markerite jaoks.

  `dsError` vigade ja vigase süntaksi esiletõstmiseks.

## Esiletõstu tuvastamise reeglid

See sektsioon kirjeldab esiletõstu tuvastamise reegleid.

Iga reegel otsib sobivust null või enama märgi osas stringis, mida ta testib. Kui reegel leiab sobivuse, omistatakse sobivatele märkidele reeglis määratud stiil või atribuut ning reegel võib soovitada konteksti vahetamist.

Reegel näeb välja selline:

    <ReegliNimi atribuut="(identifikaator)" kontekst="(identifikaator)" [reegli spetsiifilised atribuudid] />

Atribuut identifitseerib nime või indeksi järgi stiili, mida kasutada sobivate märkide puhul, ning kontekst identifitseerib vajaliku konteksti.

Konteksti saab identifitseerida:

- identifikaatori järgi, mis on mingi teise konteksti nimi.

- korralduse järgi, mis annab mootorile käsu jääda praeguse konteksti juurde (`#stay`) või hüpata tagasi eelmisele stringis kasutatud kontekstile (`#pop`).

  Minemaks rohkem samme tagasi, võib võtmesõna #pop korrata: `#pop#pop#pop`

Mõnel reeglil võivad olla alamreeglid, mida kaalutakse siis ja ainult siis, kui põhireegel on sobivuse leidnud. Kogu sobivale stringile antakse põhireeglis määratud atribuut. Alamreegliga reegel näeb välja selline:

    <ReegliNimi (atribuudid)>
      <AlamreegliNimi (atribuudid) />
      ...
    </ReegliNimi>

Reegli spetsiifilised atribuudid on mitmekesised ja neid kirjeldatakse järgnevates sektsioonides.

### Üldatribuudid

Järgmised atribuudid on ühised kõigile reeglitele ja neid kasutatakse alati, kui esinevad `(üldatribuudid)`. Nõutavad atribuudid on attribute ja context, teised pole kohustuslikud.

- attribute: atribuut on seotud määratud itemData'ga.

- context: määrab konteksti, millele esiletõstu süsteem lülitub, kui reegel sobib.

- beginRegion: alustab koodivoltimise plokki. Vaikimisi määramata (unset).

- endRegion: lõpetab koodivoltimise ploki. Vaikimisi määramata (unset).

- lookAhead: kui on tõene (true), ei arvesta esiletõstu süsteem sobivuse pikkus. Vaikimisi väär (false).

- firstNonSpace: sobib ainult juhul, kui string on esimene mittetühimärk real. Vaikimisi väär (false).

- column: sobib ainult siis, kui veerg sobib. Vaikimisi määramata (unset).

### Dünaamilised reeglid

Mõned reeglid lubavad määrata lisaatribuudi `dynamic`, mis kasutab tõeväärtust (vaikimisi on see väär ehk false). Kui dynamic on tõene (true), võib reegel kasutada teksti esindavaid kohatäitjaid, mis sobivad regulaaravaldise reeglile, mis lülitub aktiivsele kontekstile oma atribuudiga `string` või `char`. Atribuudi `string` korral asendatakse kohatäitja %N (kus N on arv) vastava kohaga N väljakutsutavas regulaaravaldises. Atribuudi `char` korra peab kohatäitja olema arv N ja see asendatakse esimese märgiga vastavas kohas N väljakutsutavas regulaaravaldises. Kui reegel vähegi seda atribuuti lubab, sisaldub selles (dynamic).

- dynamic: võib olla tõene või väär ((true|false)).

### Reeglid üksikasjalikult

DetectChar

  Tuvastab üksikut konkreetset märki. Tavaliselt kasutatakse näiteks jutumärkides stringi alguse ja lõpu leidmiseks.

      <DetectChar char="(märk)" (üldatribuudid) (dynamic) />

  Atribuut `char` määrab otsitava märgi.

Detect2Chars

  Tuvastab kaks konkreetset märki määratud järjekorras.

      <Detect2Chars char="(märk)" char1="(märk)" (üldatribuudid) (dynamic) />

  Atribuut `char` defineerib esimese otsitava märgi, `char1` teise.

AnyChar

  Tuvastab ühe märgi konkreetsete märkide hulgast.

      <AnyChar String="(string)" (üldatribuudid) />

  Atribuut `String` määrab märgikogumi.

StringDetect

  Tuvastab täpse stringi.

      <StringDetect String="(string)" [insensitive="true|false;"] (üldatribuudid) (dynamic) />

  Atribuut `String` määrab otsitava stringi. Atribuut `insensitive` on vaikimisi `false` ning seda kasutab stringivõrdlusfunktsioon. Kui väärtus on `true`, kasutatakse tõstutundetut võrdlust.

StringDetect

  Täpse stringi tuvastamine, kuid lisaks on vajalik sõnapiir, nagu näiteks punkt `'.'` või tühimärk sõna algul ja lõpul. `\b<string>\b` võib käsitada regulaaravaldisena, kuid see on kiirem kui reegel `RegExpr`.

      <WordDetect String="(string)" [insensitive="true|false"] (üldatribuudid) (dynamic) />

  Atribuut `String` määrab otsitava stringi. Atribuut `insensitive` on vaikimisi `false` ning seda kasutab stringivõrdlusfunktsioon. Kui väärtus on `true`, kasutatakse tõstutundetut võrdlust.

  Alates Kate 3.5 (KDE 4.5)

RegExpr

  Otsib regulaaravaldise sobivust.

      <RegExpr String="(string)" [insensitive="true|false;"] [minimal="true|false"] (üldatribuudid) (dynamic) />

  Atribuut `String` määrab regulaaravaldise.

  `insensitive` on vaikimisi `false` ja seda kasutab regulaaravaldise mootor.

  `minimal` on vaikimisi `false` ja seda kasutab regulaaravaldise mootor.

  Kuna reeglid otsivad sobivust alati aktiivse stringi algusest, siis viitab regulaaravaldis, mille alguses seisab juurdelisamismärk (`^`), et reegel peab sobivust otsima ainult rea algusest.

  Täpsemat infot vaata peatükist Regulaaravaldised.

keyword

  Tuvastab võtmesõna määratud nimekirjast.

      <keyword String="(nimekirja nimi)" (üldatribuudid) />

  Atribuut `String` identifitseerib võtmesõnade nimekirja nime järgi. Sellise nimega nimekiri peab olemas olema.

Int

  Tuvastab täisarvu.

      <Int (üldatribuudid) (dynamic) />

  Sellel reeglil ei ole spetsiifilisi atribuute. Tihti kasutatakse alamreegleid, et tuvastada arvu järel `L` ja `U` kombinatsioone, mis osutavad programmikoodis täisarvu tüübile. Õigupoolest on alamreeglina lubatud kõik reeglid, kuid DTD lubab siiski ainult alamreeglit `StringDetect`.

  Järgnev näide otsib täisarve märgi 'L' järel.

      <Int attribute="Decimal" context="#stay" >
        <StringDetect attribute="Decimal" context="#stay" String="L" insensitive="true"/>
      </Int>

Float

  Tuvastab ujukomaarvu.

      <Float (üldatribuudid) />

  Sellel reeglil ei ole spetsiifilisi atribuute. `AnyChar` on lubatud alamreeglina ning tüüpiliselt kasutatakse seda kombinatsioonide tuvastamiseks (vaata võrdluseks reeglit `Int`).

HICOct

  Tuvastab kaheksandsüsteemis arvu.

      <HICOct (üldatribuudid) />

  Sellel reeglil ei ole spetsiifilisi atribuute.

HICHex

  Tuvastab kuueteistkümnendsüsteemis arvu.

      <HlCHex (üldatribuudid) />

  Sellel reeglil ei ole spetsiifilisi atribuute.

HICStringChar

  Tuvastab paomärgi.

      <HlCStringChar (üldatribuudid) />

  Sellel reeglil ei ole spetsiifilisi atribuute.

  See otsib sobivusi nähtamatutele märkidele, mida tihti programmikoodis kasutatakse, näiteks `\n` (uus rida) või `\t` (tabeldusmärk).

  Leitakse järgmised märgid, kui neile eelneb längkriips (`\`): `abefnrtv"'?\`. Lisaks leitakse kuueteistkümnendsüsteemis varjestatud arvud, näiteks `\xff`, ja kaheksandsüsteemis varjestatud arvud, näiteks `\033`.

HlCChar

  Tuvastab C märgi.

      <HlCChar (üldatribuudid) />

  Sellel reeglil ei ole spetsiifilisi atribuute.

  Leitakse ülakriipsude vahele võetud C märgid, näiteks `'c'`. Ülakriipsude vahel võib olla lihtne märk või ka varjestatud märk. Viimaste kohta vaata HlCStringChar.

RangeDetect

  Tuvastab stringi määratud algus- ja lõpumärgiga.

      <RangeDetect char="(märk)"  char1="(märk)" (üldatribuudid) />

  `char` määrab vahemikku alustava märgi ning `char1` seda lõpetava märgi.

  See on kasulik näiteks väiksemate jutumärkides stringides ja muu sellise leidmiseks, kuid tasub tähele panna, et esiletõstu mootor töötab korraga ühel real ega leia stringe, mis ulatuvad üle reapiiri.

LineContinue

  Tuvastab sobivused rea lõpus.

      <LineContinue (üldatribuudid) />

  Sellel reeglil ei ole spetsiifilisi atribuute.

  See reegel on abiks konteksti lülitamisel rea lõpus, kui viimane märk on längkriips (`'\'`). Seda vajab näiteks C/C++ makrode või stringide jätkamiseks.

IncludeRules

  Kaasatakse teise konteksti või keele/faili reeglid.

      <IncludeRules context="kontekstilink" [includeAttrib="true|false"] />

  Atribuut `context` määrab, milline kontekst kaasata.

  Kui see on lihtne string, kaasatakse aktiivsesse konteksti kõik defineeritud reeglid, näiteks:

      <IncludeRules context="teineKontekst" />

  Kui stringi alguses on `##`, otsib esiletõstu süsteem antud nimega keeledefinitsiooni, näiteks:

      <IncludeRules context="##C++" />

  Kui atribuut `includeAttrib` on tõene (true), muudetakse sihtatribuut lähteatribuudiks. Seda on vaja näiteks kommenteerimise jaoks, kui kaasatud kontekstis sobiv tekst on teistsuguse esiletõstuga kui algkontekstis.

DetectSpaces

  Tuvastab tühimärgid.

      <DetectSpaces (üldatribuudid) />

  Sellel reeglil ei ole spetsiifilisi atribuute.

  Seda on mõtet kasutada, kui tead, et eespool asub tühimärke, näiteks trepitud ridade alguses. Sel juhul jäetakse kõik tühimärgid korraga vahele, mitte ei hakata erinevaid reegleid läbi uurima.

DetectIdentifier

  Tuvastab identifikaatoristringid (regulaaravaldisena [a-zA-Z_][a-zA-Z0-9_]*).

      <DetectIdentifier (üldatribuudid) />

  Sellel reeglil ei ole spetsiifilisi atribuute.

  Seda on mõtet kasutada, kui soovid terve sõnastringi korraga vahele jätta, mitte lasta seda uurida mitmel reeglil.

### Nõuanded ja soovitused

Kui oled aru saanud, kuidas käib konteksti lülitamine, on juba lihtne hakata ise esiletõstu definitsioone kirjutama. Siiski tuleb alati hoolikalt kontrollida, millist reeglit millises olukorras kasutada. Regulaaravaldised on väga võimsad vahendid, kuid võrreldes teiste reeglitega suhteliselt aeglased. Niisiis tasuks silmas pidada järgmisi nõuandeid.

- Ainult kahe märgi sobivuse leidmiseks kasuta `Detect2Chars`, mitte `StringDetect`. Sama käib `DetectChar` kohta.

- Regulaaravaldisi on lihtne kasutada, kuid sageli saavutab sama tulemuse märksa kiiremini. Oletame, et soovid leida ainult märgi `'#'`, kui see on real esimene. Regulaaravaldis näeks välja nii:

      <RegExpr attribute="Macro" context="macro" String="^\s*#" />

  Sama tulemuse saavutab aga palju kiiremini nii:

      <DetectChar attribute="Macro" context="macro" char="#" firstNonSpace="true" />

  Kui soovid leida regulaaravaldise `'^#'` sobivuse, on samuti mõistlik kasutada `DetectChar`, lisades sellele atribuudi `column="0"`. Atribuut `column` võtab aluseks märkide arvu, pidades niisiis tabeldusmärki üheks märgiks.

- Konteksti saab lülitada ilma märke töötlemata. Eeldame, et soovid lülitada konteksti, kui esineb string `*/`, aga tahad seda stringi järgmises kontekstis töödelda. Alltoodud reegel leiab sobivuse ning atribuut `lookAhead` sunnib esiletõstu säilitama sobiva stringi järgmises kontekstis.

      <Detect2Chars attribute="Comment" context="#pop" char="*" char1="/" lookAhead="true" />

- Kui tead, et esineb palju tühimärke, kasuta `DetectSpaces`.

- Kasuta `DetectIdentifier`, mitte regulaaravaldist `'[a-zA-Z_]\w*'`.

- Kasuta võimaluse korral alati vaikestiile. Sel moel viibi kasutaja alati tuttavas keskkonnas.

- Uuri teisi XML-faile selgitamaks, kuidas teised on oma reegleid teostanud.

- XML-faile saab kontrollida käsuga `xmllint --dtdvalid language.dtd mySyntax.xml`.

- Sageli keerukaid regulaaravaldisi vajades võiks kasutada olemeid (ENTITIES). Näide:

      <?xml version="1.0" encoding="UTF-8"?>
      <!DOCTYPE language SYSTEM "language.dtd"
      [
              <!ENTITY myref    "[A-Za-z_:][\w.:_-]*">
      ]>

  Seejärel võid regulaaravaldise asemel kasutada &myref;.