Johan
Thelmén

    jth@home.se

Översättare

# Arbeta med syntaxfärgläggning

## Översikt

Syntaxfärgläggning är det som gör att editorn automatiskt visar text med olika stilar/färger, beroende på strängens funktion i relation till filens syfte. Till exempel i programkällkod, så kan kontrollsatser visas i fetstil, medan datatyper och kommentarer får annorlunda färg än resten av texten. Det här ökar textens läsbarhet väsentligt, och hjälper på så sätt författaren att vara effektivare och mer produktiv.

En funktion i Perl, som visas med syntaxfärgläggning.

En funktion i Perl, som visas med syntaxfärgläggning.

Samma kod utan syntaxfärgläggning.

Samma kod utan syntaxfärgläggning.

Av de två exemplen, vilket är lättast att läsa?

&kate; levereras med ett flexibelt, anpassningsbart och avancerat system för att göra syntaxfärgläggning, och standarddistributionen tillhandahåller definitioner för ett brett område av programspråk, formaterings- och skriptspråk samt andra textfilformat. Dessutom kan du tillhandahålla dina egna definitioner med enkla &XML;-filer.

&kate; detekterar automatiskt de riktiga syntaxreglerna när du öppnar en fil, baserat på filens &MIME;-typ, som avgörs av dess filändelse, eller om den inte har någon, dess innehåll. Skulle du råka ut för ett dåligt val, kan du ställa in syntaxen som används för hand med menyn Dokument Färgläggningsläge.

Stilarna och färgerna som används av varje syntaxfärgläggningsläge, samt vilken &MIME;-typ som det ska användas för, kan anpassas på sidan Färgläggning i inställningsdialogrutan.

Syntaxfärgläggning finns för att förbättra läsbarheten för riktig text, men du kan inte lita på att den validerar din text. Att markera text för syntax kan vara svårt, beroende på formatet som du använder, och i vissa fall är upphovsmännen till syntaxreglerna stolta om 98 procent av texten visas korrekt, även om du behöver en ovanlig stil för att se de felaktiga 2 procenten.

Du kan ladda ner uppdaterade eller nya definitioner av syntaxfärgläggning från &kate;s webbplats genom att klicka på knappen Ladda nerpå sidan Färgläggning i inställningsdialogrutan.

## &kate;s syntaxfärgläggningssystem

Det här avsnittet beskriver &kate;s syntaxfärgläggningsmekanism i mer detalj. Det är avsett för dig, om du vill veta mer om den, eller om du vill skapa och ändra syntaxdefinitioner.

### Hur det fungerar

Så fort du öppnar en fil, är en av de första sakerna som &kate;-editorn gör att avgöra vilken syntaxdefinition som ska användas för filen. När filens text läses in, och medan du skriver i den, så analyserar syntaxfärgläggningssystemet texten enligt reglerna som definieras i syntaxdefinitionen och markerar var i den som olika sammanhang och stilar börjar och slutar.

När du skriver in text i dokumentet, så analyseras och markeras den nya texten i farten, så att om du tar bort ett tecken som markeras som början eller slutet på ett sammanhang, så ändras stilen på den omgivande texten i enlighet med detta.

Syntaxdefinitioner som används av &kate;s syntaxfärgläggningssystem är &XML;-filer, som innehåller

- Regler för att detektera funktionen hos text, organiserade i sammanhangsblock

- Listor med nyckelord

- Definitioner av stilobjekt

När texten analyseras utvärderas detekteringsreglerna i den ordning som de definierades, och om början på den nuvarande strängen matchar en regel, så används motsvarande sammanhang. Startpunkten i texten flyttas till den sista punkten där regeln matchade, och en ny genomgång av reglerna sker, med början i sammanhanget som anges av den matchande regeln.

### Regler

Detekteringsreglerna är centrala för färgläggningsdetekteringssystemet. En regel är en sträng, ett tecken eller ett reguljärt uttryck som texten som ska analyseras matchas mot. Den innehåller information om vilken stil som ska användas för den delen av texten som matchar. Den kan byta arbetssammanhanget för systemet, antingen till ett sammanhang som anges explicit, eller till det föregående sammanhanget som användes av texten.

Reglerna organiseras i sammanhangsgrupper. En sammanhangsgrupp används för de huvudsakliga koncepten i formatets text, till exempel textsträngar inom citationstecken eller kommentarblock i programkällkod. Det här försäkrar att färgläggningssystemet inte behöver gå igenom alla regler när det inte är nödvändigt, och att vissa teckensekvenser i texten kan hanteras annorlunda beroende på det nuvarande sammanhanget.

### Sammanhangsstilar och nyckelord

I vissa programspråk, hanteras heltal annorlunda än flyttal av kompilatorn (programmet som översätter källkoden till körbart binärformat), och det kan finnas tecken som har en särskild mening i en sträng med citationstecken. I sådana fall är det vettigt att visa dem på ett annat sätt än omgivningen så att de är lätta att identifiera när texten läses. Så även om de inte representerar speciella sammanhang, så kan de betraktas som sådana av syntaxfärgläggningssystemet, så att de kan markeras för att visas på ett annorlunda sätt.

En syntaxdefinition kan innehålla så många stilar som krävs för att täcka koncepten i det format den används för.

I många format finns det en lista på ord som representerar ett speciellt koncept. Till exempel i programspråk, så är kontrollsatserna ett koncept, namn på datatyper ett annat, och inbyggda funktioner i språket ett tredje. &kate;s syntaxfärgläggningssystem kan använda sådana listor för att detektera och markera ord i texten för att visa koncepten för textformaten.

### Förvalda stilar

Om du öppnar en C++ källkodsfil, en Java källkodsfil och ett HTML-dokument i &kate;, så ser du att även om formaten är olika, och olika ord därför väljs för särskild behandling, så är färgerna som används samma. Det här beror på att &kate; har en fördefinierad lista på standardstilar, som används av varje individuell syntaxdefinition.

Det här gör det lätt att känna igen liknande koncept i olika textformat. Kommentarer finns till exempel i nästa alla program-, skript- eller formateringsspråk, och när de visas med samma stil i alla språk, behöver du inte stanna och tänka efter för att identifiera dem i texten.

Alla stilar i en syntaxdefinition använder en av standardstilarna. Några få syntaxdefinitioner använder fler stilar än det finns som standard, så om du ofta använder ett format, kan det vara värt att titta i inställningsdialogrutan för att se om några koncept använder samma stil. Det finns till exempel bara en standardstil för strängar, men eftersom programspråket Perl hanterar två sorters strängar, kan du utöka färgläggningen genom att ställa in dessa så att de skiljer sig något.

## &XML; formatet för syntaxfärgläggningsdefinitioner

### Översikt

Det här avsnittet är en översikt av färgläggningsdefinitionernas &XML;-format. Det beskriver huvudkomponenterna och deras betydelse och användning, och går djupare in i detaljerna för detekteringsreglerna.

Den formella definitionen, också kallad en DTD, lagras i filen `language.dtd` som ska finnas installerad på ditt system i katalogen `$`KDEDIR`/share/apps/kate/syntax`.

#### Huvudkomponenter i &kate;s färgläggningsdefinitioner

Sektionen General

  Sektionen General (allmänt) innehåller information om kommentarformat för språket som beskrivs, och definierar om nyckelord beror på skiftläget.

Highlighting

  Sektionen Highlighting (färgläggning) innehåller all data som krävs för att analysera och visa texten. Det här omfattar:

  ItemDatas

    Innehåller ItemData-element, som vart och ett definierar en stil.

  Nyckelordlistor

    Varje lista har ett namn, och kan innehålla hur många element som helst.

  Contexts

    Innehåller sammanhang, som återigen innehåller syntaxdetekteringsregler.

## Regler för syntaxdetektering

Den här sektionen beskriver reglerna för syntaxdetektering.

Varje regel kan matcha noll eller flera tecken i början av strängen som de ska testa. Om regeln matchar, så tilldelas de matchande tecknen stilen eller egenskapen som definieras av regeln. En regel kan också begära att det nuvarande sammanhanget byts.

Egenskap och sammanhang är gemensamma för alla regler.

En regel ser ut så här:

    <Regelnamn attribute="(identifierare)" context="(identifierare|ordning)" [regelspecifika egenskaper] />

Ordet attribute identifierar stilen som ska användas för tecken som matchar med namn eller index, och context identifierar sammanhanget som ska användas i fortsättningen.

Egenskapen kan antingen identifieras med namn, eller med sitt index, som börjar på noll, i gruppen ItemDatas.

Sammanhanget kan identifieras av:

- En identifierare, för närvarande bara ett index, som börjar på noll, i sammanhangsgruppen.

- En ordning som talar om att färgläggningen ska stanna kvar i det nuvarande sammanhanget (`#stay`), eller gå tillbaka till det föregående sammanhanget som använts i strängen (`#pop`).

  För att gå tillbaka flera steg, kan nyckelordet #pop upprepas: `#pop#pop#pop`

Vissa regler kan ha delregler, bara utvärderas om huvudregeln matchar. Hela den matchande strängen kommer att få egenskapen som definieras av huvudregeln. En regel med en delregel ser ut så här:

    <Regelnamn (egenskaper)>
      <Delregelnamn (egenskaper) />
      ...
    </Regelnamn>

Regelspecifika egenskaper varierar och beskrivs i följande lista.

### Reglerna i detalj

DetectChar

  Detektera ett enda specifikt tecken. Används ofta för att till exempel hitta slutet på strängar inom citationstecken.

      <DetectChar char="(tecken)" (gemensamma egenskaper) />

  Egenskapen `char` definierar tecknet som ska matchas.

Detect2Chars

  Detektera två angivna tecken i en definierad ordning.

      <Detect2Chars char="(tecken)" char1="(tecken)" (gemensamma egenskaper) />

  Egenskapen `char` definierar det första tecknet som ska matcha, `char1` det andra.

AnyChar

  Detektera ett tecken i en angiven teckenmängd.

      <AnyChar String="(sträng)" (gemensamma egenskaper) />

  Egenskapen `String` definierar teckenmängden.

StringDetect

  Detektera en sträng exakt.

      <StringDetect String="(sträng)" [insensitive="TRUE|FALSE;"] (gemensamma egenskaper) />

  Egenskapen `String` definierar strängen som ska matcha. Egenskapen `insensitive` (okänslig) är normalt `FALSE` (FALSK) och skickas med till strängjämförelsefunktionen. Om värdet är `TRUE` (SANT) så används en jämförelse som inte bryr sig om skiftläge.

RegExpr

  Matchar med ett reguljärt uttryck.

      <RegExpr String="(sträng)" [insensitive="TRUE|FALSE;"] [minimal="TRUE|FALSE"] (gemensamma egenskaper) />

  Egenskapen `String` definierar det reguljära uttrycket.

  Egenskapen `insensitive` (okänslig) är normalt `FALSE` (FALSK) och skickas med det reguljära uttrycket.

  Egenskapen `minimal` är normalt `FALSE` (FALSK) och skickas med det reguljära uttrycket.

  Eftersom reglerna alltid matchas mot början av den nuvarande strängen, så anger ett reguljärt uttryck som börjar med en hatt (`^`) att regeln bara ska matchas mot radens början.

  Se Reguljära uttryck för mer information om dem.

Keyword

  Detektera ett nyckelord från en angiven lista.

      <keyword String="(listnamn)" (gemensamma egenskaper) />

  Egenskapen `String` identifierar en lista på nyckelord med namn. En lista med det namnet måste finnas.

Int

  Detektera ett heltal.

      <Int (gemensamma egenskaper) />

  Den här regeln har inga specifika egenskaper. Delregler används typiskt för att detektera kombinationer av `L` och `U` efter talet, som anger heltalstypen i programkod.

Float

  Detektera ett flyttal.

      <Float (gemensamma egenskaper)
      />

  Den här regeln har inga specifika egenskaper.

HlCOct

  Detektera en oktal talrepresentation.

      <HlCOct (gemensamma egenskaper) />

  Den här regeln har inga specifika egenskaper.

HlCHex

  Detektera en hexadecimal talrepresentation.

      <Int (gemensamma egenskaper) />

  Den här regeln har inga specifika egenskaper.

HlCStringChar

  Detektera ett undantaget tecken.

      <HlCStringChar (gemensamma egenskaper)
      />

  Den här regeln har inga specifika egenskaper.

  Det matchar bokstavsrepresentationer av osynliga tecken som ofta används i programkod, till exempel `\n` (nyrad) eller `\t` (tabulator).

  Följande tecken matchar om de följer ett bakstreck (`\`): `abefnrtv"'?`. Dessutom matchar undantagna hexadecimala tal, som till exempel `\xff` och undantagna oktala tal, till exempel `\033`.

RangeDetect

  Detektera en sträng med definierade start- och sluttecken.

      <RangeDetect char="(tecken)"  char1="(tecken)" (gemensamma egenskaper) />

  `char` definierar tecknet som inleder intervallet, och `char1` tecknet som avslutar intervallet.

  Användbar för att till exempel detektera små strängar inom citationstecken och liknande, men observera att eftersom färgläggningen arbetar med en rad i taget, så hittar det här inte strängar som fortsätter på nästa rad.

LineContinue

  Matchar vid radens slut.

      <LineContinue (gemensamma egenskaper) />

  Den här regeln har inga specifika egenskaper.

  Den här regeln är användbar för att byta sammanhang vid radslut.