Hoofdsecties van bestanden voor accentueringsdefinities van KatePart

Een bestand voor accentuering bevat een kop die de XML-versie instelt:

<?xml version="1.0" encoding="UTF-8"?>

De basis van het definitiebestand is het element language. Beschikbare attributen zijn:

Vereiste attributen:

name stelt de naam van de taal in. Het verschijnt nadien in de menu's en dialogen.

section specificeert de categorie.

extensions definieert bestandsextensies, zoals "*.cpp;*.h"

versie specificeert de huidige revisie van het definitiebestand in termen van een geheel getal. Wanneer u een geaccentueerd definitiebestand wijzigt, verzeker u ervan dat dit getal wordt verhoogt.

kateversion specificeert de laatst ondersteunde versie van KatePart.

Optionele attributen:

mimetype associeert ket MIME-type van bestanden.

casesensitive definieert of de sleutelwoorden gevoelig zijn voor hoofd- en kleine letters.

priority is nodig als een andere bestand met accentueringsdefinities dezelfde extensies gebruiken. De hogere prioriteit wint.

author bevat de naam van de auteur en zijn/haar e-mailadres.

license bevat de licentie, gewoonlijk de MIT licentie voor nieuwe bestanden met accentuering van syntaxis.

style bevat de geleverde taal en wordt gebruikt door de indenteerders voor het attribuut required-syntax-style.

indenter definieert welke indenteerder standaard gebruikt zal worden. Beschikbare indenterders zijn: ada, normal, cstyle, cmake, haskell, latex, lilypond, lisp, lua, pascal, python, replicode, ruby en xml.

hidden definieert of de naam moet verschijnen in de menu's van KatePart.

De volgende regel kan er als volgt uitzien:

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

Vervolgens komt het element highlighting, die het optionele element list bevat en de vereiste elementen contexts en itemDatas.

Elementen list bevatten een lijst met sleutelwoorden. In dit geval zijn de sleutelwoorden class en const. U mag zoveel elementen 'list' toevoegen als nodig is.

Sinds KDE Frameworks™ 5.53 kan een lijst sleutelwoorden uit een andere lijst of taal/bestand invoegen met gebruik van het element include. ## wordt gebruikt om de naam van de lijst en de naam van de taaldefinitie te scheiden, op dezelfde manier als in de regel IncludeRules. Dit is nuttig om duplicaten van lijsten met sleutelwoorden te vermijden, als u het nodig hebt om de sleutelwoorden van een andere taal/bestand in te voegen. De lijst anderenaam bevat het sleutelwoord str en alle sleutelwoorden van de lijst types, die behoren bij de taal ISO C++.

Het element contexts bevat alle contexten. De eerste context is per definitie het begin van de accentuering. Er zijn twee regels in de context Normal Text, die overeenkomt met de lijst sleutelwoorden met de naam somename en een regel die een aanhalingsteken detecteert en de context om schakelt naar String. Om meer over regels te leren, leest u het volgende hoofdstuk.

Het derde deel is het element itemDatas. Het bevat alle kleur- en lettertypestijlen nodig voor de contexten en regels. In dit voorbeeld worden itemData Normal Text, String en Keyword gebruikt.

<highlighting>
    <list name="eennaam">
      <item>class</item>
      <item>const</item>
    </list>
    <list name="othername">
      <item>str</item>
      <include>types##ISO C++</include>
    </list>
    <contexts>
      <context attribute="Normal Text" lineEndContext="#pop" name="Normal Text" >
        <keyword attribute="Keyword" context="#stay" String="eennaam" />
        <keyword attribute="Keyword" context="#stay" String="anderrnaam" />
        <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="Normal Text" defStyleNum="dsNormal" />
      <itemData name="Keyword" defStyleNum="dsKeyword" />
      <itemData name="String" defStyleNum="dsString" />
    </itemDatas>
  </highlighting>

Het laatste deel van een definitie voor accentuering is de optionele sectie general. Het mag informatie over sleutelwoorden, invouwen van code, commentaar, inspringen, lege regels en spellingcontrole bevatten.

De sectie comment definieert met welke tekenreeks een enkele regel commentaar wordt aangegeven. U kunt ook commentaar op meerdere regels definiëren met multiLine met het additionele attribuut end. Dit wordt gebruikt als de gebruiker op de bijbehorende sneltoets voor comment/uncomment drukt.

De sectie keywords definieert of lijsten met sleutelwoorden onderscheid maken tussen hoofd- en kleine letters. Andere attributen zullen later worden verklaard.

De andere secties, folding, emptyLines en spellchecking zijn gewoonlijk niet nodig en worden later uitgelegd.

<general>
    <comments>
      <comment name="singleLine" start="#"/>
      <comment name="multiLine" start="###" end="###" region="CommentFolding"/>
    </comments>
    <keywords casesensitive="1"/>
    <folding indentationsensitive="0"/>
    <emptyLines>
      <emptyLine regexpr="\s+"/>
      <emptyLine regexpr="\s*#.*"/>
    </emptyLines>
    <spellchecking>
      <encoding char="á" string="\'a"/>
      <encoding char="à" string="\`a"/>
    </spellchecking>
  </general>
</language>

Het element context behoort tot de groep contexts. Een context zelf definieert context specifieke regels zoals wat zou moeten gebeuren als het systeem voor accentuering het eind van een regel bereikt. Beschikbare attributen zijn:

name geeft de contextnaam aan. Regels zullen deze naam gebruiken om de context te specificeren om om te schakelen als de regel overeenkomt.

attribuut identificeert de te gebruiken stijl voor een teken wanneer geen regel overeenkomt of wanneer een regel geen attribuut specificeert. In het laatste geval zal het attribuut van de context gespecificeerd in de context van de regel worden gebruikt.

lineEndContext definieert de context waarnaar het systeem voor accentuering omschakelt als het einde van een regel wordt bereikt. Dit kan of de naam van een andere context zijn, #stay om de context niet om te schakelen (bijv.. niets doen) of #pop wat de oorzaak is van het verlaten van deze context. Het is mogelijk om bijvoorbeeld #pop#pop#pop te gebruiken om drie keer te poppen of zelfs #pop#pop!AndereContext om twee keer te poppen en om te schakelen naar de context genaamd AndereContext. Het is ook mogelijk om om te schakelen naar een context die behoort bij een andere taaldefinitie, op dezelfde manier als in de regels IncludeRules, bijv. SomeContext##JavaScript. Omschakelen van context wordt ook beschreven in de paragraaf met de naam “Detectieregels accentueren”. Standaard: #stay.

lineEmptyContext definieert de context als een lege regel wordt bereikt. De nomenclatuur van omschakelen van context is hetzelfde als eerder beschreven in lineEndContext. Standaard: #stay.

fallthroughContext specificeert de volgende context waarnaar om te schakelen als er geen regel overeenkomt. De nomenclatuur van context omschakelen is hetzelfde als eerder beschreven in lineEndContext. Standaard: #stay.

fallthrough definieert of het accentueringssysteem naar de context schakelt gespecificeerd in fallthroughContext als geen regel overeenkomt. Merk op dat sinds KDE Frameworks™ 5.62 dit attribuut is afgekeurd met voorkeur voor fallthroughContext, omdat als het attribuut fallthroughContext aanwezig is het impliciet wordt verstaan dat de waarde van fallthrough true is. Standaard: false.

noIndentationBasedFolding schakelt op inspringen gebaseerd invouwen in de context uit. Als dit invouwen niet is geactiveerd, is dit attribuut nutteloos. Dit is gedefinieerd in het element folding van de groep general. Standaard: false.

Het element itemData is in de groep itemDatas. Het definieert de lettertypestijl en kleuren. Het is dus mogelijk om uw eigen stijlen en kleuren te definiëren. Wij bevelen echter aan om, indien mogelijk, bij de standaard stijlen te blijven zodat de gebruiker altijd dezelfde zal zien in verschillende talen. Soms is er echter geen andere manier en is het noodzakelijk de kleur- en lettertypeattributen te wijzigen. De attributen naam en defStyleNum zijn vereist, de anderen zijn optioneel. Beschikbare attributen zijn:

name stelt de naam van het itemData in. Contexten en regels zullen deze naam in hun attribuut attribute gebruiken om naar een itemData te verwijzen.

defStyleNum definieert welke standaard stijl te gebruiken. Beschikbare standaard stijlen worden later in detail verklaard.

color definieert een kleur. Geldige formaten zijn '#rrggbb' of '#rgb'.

selColor definieert de selectiekleur.

italic indien true, de tekst zal cursief worden.

bold indien true, de tekst zal vet worden.

underline indien true, de tekst zal onderstreept worden.

strikeOut indien true, door de tekst zal een streep worden gezet.

spellChecking indien true, de tekst zal gecontroleerd worden op spelling.

Het element keywords in de groep general definieert sleutelwoordeigenschappen. Beschikbare attributen zijn:

casesensitive mag true of false zijn. Indien true, worden alle sleutelwoorden met onderscheid tussen hoofd- en kleine letters met elkaar vergeleken

weakDeliminator is een lijst met tekens die niet als scheiding tussen woorden werken. Bijvoorbeeld: de punt '.' is een scheider van woorden. Als een sleutelwoord in een list een punt bevat, dan zal die alleen overeenkomen als u de punt als een zwak scheidingsteken specificeert.

additionalDeliminator definieert extra scheidingstekens.

wordWrapDeliminator definieert tekens waarna een regel mag afbreken.

Standaard scheidingstekens en regelafbreektekens zijn de tekens .():!+,-<=>%&*/;?[]^{|}~\, spatie (' ') en tab ('\t').

Het element comment in de groep comments definieert eigenschappen van commentaar die gebruikt worden voor Hulpmiddelen → Commentaar,Hulpmiddelen → Commentaar omschakelen. Beschikbare attributen zijn:

name is ofwel singleLine of multiLine. Als u multiLine kiest zijn de attributen end en region vereist.

start definieert de gebruikte tekenreeks om commentaar te laten beginnen. In C++ zou dit "/*" zijn. Dit attribute is vereist voor de typen multiLine en singleLine.

end definieert de gebruikte tekenreeks om commentaar te laten eindigen. In C++ zou dit "*/" zijn. Alleen dit attribuut is beschikbaar en is vereist voor commentaar van het type multiLine.

region moet de naam van het opvouwbare multiregel commentaar. U hebt beginRegion="Comment" ... endRegion="Comment" in uw regels, u zou region="Comment" moeten gebruiken. Op deze manier werkt verwijderen zelfs als u niet alle tekst van het multiregel commentaar selecteert. De cursor hoeft alleen in het multiregel commentaar te staan. Dit attribuut is alleen beschikbaar voor het type multiLine.

positie definieert waar het commentaar op een enkele regel wordt ingevoegd. Standaard wordt het commentaar op een enkele regel geplaatst aan het begin van de regel op kolom 0, maar als u position="afterwhitespace" gebruikt wordt het commentaar ingevoegd rechts na voorloopwitruimte, voor het eerste niet-witruimteteken. Dit is nuttig om commentaar juist in te voegen in talen waar inspringen belangrijk is, zoals Python of YAML. Dit attribuut is optioneel en de enig mogelijke waarde is afterwhitespace.

Het element folding in de groep general definieert de eigenschappen van het invouwen van broncode. Beschikbare attributen zijn:

De markeringen voor code opvouwen, als indentationsensitive true is, zullen worden toegevoegd gebaseerd op inspringen, zoals in de scripttaal Python. Het is gewoonlijk niet nodig dit in te stellen omdat de standaard false is.

Het element emptyLine in de groep emptyLines definieert welke regels beschouwd moeten worden als lege regels. Dit biedt het wijzigen van het gedrag van het attribuut lineEmptyContext in de elementen context. Beschikbare attributen zijn:

regexpr definieert een reguliere expressie die behandeld zal worden als een lege regel. Standaard bevatten lege regels geen enkel teken, daarom voegt dit extra lege regels toe, als u, bijvoorbeeld, regels met spaties ook wil beschouwen als lege regels. In de meeste syntaxisdefinities is er geen noodzaak om dit attribuut in te zetten.

Het element encoding in de groep spellchecking definieert een codering van tekens voor spellingcontrole. Beschikbare attributen:

char is een gecodeerd teken.

string is een serie tekens die gecodeerd zullen worden als het teken char in de spellingcontrole. In de taal LaTeX, bijvoorbeeld, representeert de tekenreeks \"{A} het teken Ä.

Algemene standaard stijlen:

dsNormal, wanneer geen speciale accentuering is vereist.

dsKeyword, ingebouwde sleutelwoorden van taal.

dsFunction, functie-aanroepen en definities.

dsVariable, indien van toepassing: namen van variabelen (bijv. $eenVar in PHP/Perl).

dsControlFlow, sleutelwoorden voor flowcontrol zoals if, else, switch, break, return, yield, ...

dsOperator, operatoren zoals + - * / :: < >

dsFunction, ingebouwde functies, klassen en objecten.

dsExtension, gezamenlijke extensies, zoals Qt™-klassen en functies/macro's in C++ en Python.

dsPreprocessor, preprocessor statements of macro-definities.

dsAttribute, annotaties zoals @override en __declspec(...).

Standaard stijlen gerelateerd aan tekenreeksen

dsChar, enkele tekens, zoals 'x'.

dsSpecialChar, tekens met een speciale betekenis in tekenreeksen zoals escapes, substituties of regex-operatoren.

dsString, tekenreeksen zoals "hello world".

dsVerbatimString, letterlijke of raw-tekenreeksen zoals 'raw \backlash' in Perl, CoffeeScript en shells, evenals r'\raw' in Python.

dsSpecialString, SQL, regexes, HERE-docs, L^AT_EX math mode, ...

dsImport, import, include, require van modulen.

Standaard stijlen gerelateerd aan getallen:

dsDataType, ingebouwde typen gegevens zoals int, void, u64.

dsDecVal, decimale waarden.

dsBaseN, waarden met een andere basis dan 10.

dsFloat, drijvende-komma waarden.

dsConstant, ingebouwde en gebruikergedefineerde constanten zoals pi.

Standaard stijlen gerelateerd aan commentaar en documentatie:

dsComment, commentaar.

dsDocumentation, /** Documentatie commentaar */ of """docstrings""".

dsAnnotation, documentatiecommando's zoals @param, @brief.

dsCommentVar, de in bovenstaande commando's gebruikte namen van variabelen, zoals "foobar" in @param foobar.

dsRegionMarker, gebiedsmarkeringen zoals//BEGIN, //END in commentaar.

Andere standaard stijlen:

dsInformation, notities en tips zoals @note in doxygen.

dsWarning, waarschuwingen zoals @warning in doxygen.

dsAlert, speciale woorden zoals TODO, FIXME, XXXX.

dsError, accentuering van fouten en foute syntaxis.

dsOthers, wanneer niets anders past.

DetectChar

Detecteert een enkele specifiek teken. Gewoonlijk gebruikt, bijvoorbeeld om het einde van een tekenreeks tussen accenten of aanhalingstekens.

<DetectChar char="(teken)" (common attributes) (dynamic) />

Het attribuut char definieert het teken dat moet overeenkomen.

Detect2Chars

Detecteert twee specifieke tekens in een gedefinieerde volgorde.

<Detect2Chars char="(teken)" char1="(teken)" (gezamenlijke attributen) />

Het attribuut char definieert het eerste teken dat moet overeenkomen, char1 the tweede.

Deze regel is aanwezig voor historische redenen en voor leesbaarheid heeft het voorkeur om StringDetect te gebruiken.

AnyChar

Detecteer één teken van een set van gespecificeerde tekens.

<AnyChar String="(tekenreeks)" (common attributes) />

Het attribuut String definieert de set tekens.

StringDetect

Detecteert een exacte tekenreeks.

<StringDetect String="(tekenreeks)" [insensitive="true|false"] (common attributes) (dynamic) />

Het attribuut String definieert de overeen te komen tekenreeks. Het attribuut insensitive is standaard false en wordt doorgegeven aan de vergelijkingsfunctie van de tekenreeks. Als de waarde true is wordt 'insensitive' vergelijking gebruikt.

WordDetect

Detecteert een exacte tekenreeks maar vereist extra woordgrenzen zoals een punt '.' of witruimte aan het begin en eind van het woord. Denk aan \b<tekenreeks>\b in termen van een reguliere expressie, het is echter sneller dan de regel RegExpr.

<WordDetect String="(tekenreeks)" [insensitive="true|false"] (gezamenlijke attributen) (lokale scheidingstekens) />

Het attribuut String definieert de overeen te komen tekenreeks. Het attribuut insensitive is standaard false en wordt doorgegeven aan de vergelijkingsfunctie van de tekenreeks. Als de waarde true is wordt 'insensitive' vergelijking gebruikt.

Sinds: Kate 3.5 (KDE 4.5)

RegExpr

Komt overeen met een reguliere expressie.

<RegExpr String="(tekenreeks)" [insensitive="true|false"] [minimal="true|false"] (common attributes) (dynamic) />

Het attribuut String definieert de reguliere expressie.

insensitive is standaard false en wordt doorgegeven aan de engine voor de reguliere expressie.

minimal is standaard false en wordt doorgegeven aan de engine voor de reguliere expressie.

Omdat de regels altijd vergeleken worden met het begin van de huidige tekenreeks, zal een reguliere expressie die begint met een dakje (^) aangeven dat de regel alleen overeen moet komen met het begin van een regel.

Zie Reguliere expressies voor meer informatie hierover.

trefwoord

Detecteert een sleutelwoord uit een gespecificeerde lijst.

<keyword String="(lijstnaam)" (common attributes) (lokale scheidingstekens) />

Het attribuut String identificeert de lijst met sleutelwoorden met een naam. Een lijst met die naam moet bestaan.

Het systeem voor accentuering bewerkt sleutelwoordregels op een zeer geoptimaliseerde manier. Dit maakt het absoluut noodzakelijk dat elk te vinden sleutelwoord omgeven wordt door gedefinieerde scheidingstekens, ofwel impliciet (de standaard scheidingstekens) of expliciet gespecificeerd binnen de eigenschap additionalDeliminator van de sleutelwoord-tag.

Als een te vinden sleutelwoord een scheidingsteken moet bevatten, dan moet dit teken toegevoegd worden aan de eigenschap weakDeliminator van de sleutelwoord-tag. Dit teken zal dan zijn eigenschap scheidingsteken in alle sleutelwoord-regels verliezen. Het is ook mogelijk om het attribuut weakDeliminator van sleutelwoord te gebruiken zo dat deze wijziging alleen op deze regel van toepassing is.

Int

Een geheel getal detecteren (als de reguliere expressie \b[0-9]+).

<Int (gezamenlijke attributen) (lokale scheidingstekens) />

Deze regel heeft geen specifieke attributen.

Zwevend

Een drijvende kommagetal detecteren( als de reguliere expressie: (\b[0-9]+\.[0-9]*|\.[0-9]+)([eE][-+]?[0-9]+)?).

<Drijvende komma (gezamenlijke attributen) (lokale scheidingstekens) />

Deze regel heeft geen specifieke attributen.

HlCOct

Een octale representatie van een getal detecteren (als de reguliere expressie: \b0[0-7]+).

<HlCOct (gezamenlijke attributen) (lokale scheidingstekens) />

Deze regel heeft geen specifieke attributen.

HlCHex

Een hexadecimale representatie van een hexadecimaal getal (als de reguliere expressie: \b0[xX][0-9a-fA-F]+).

<HlCHex (gezamenlijke attributen) (lokale scheidingstekens) />

Deze regel heeft geen specifieke attributen.

HlCStringChar

Detecteer een escaped teken.

<HlCStringChar (common attributes) />

Deze regel heeft geen specifieke attributen.

Komt overeen met de letterlijke representatie van tekens, gewoonlijk gebruikt in programmacode, bijvoorbeeld \n (nieuwe-regel) of \t (TAB).

De volgende tekens zullen overeenkomen als ze volgen op een backslash (\): abefnrtv"'?\. Bovendien escaped hexadecimale getallen zoals bijvoorbeeld \xff en escaped octale getallen, zoals bijvoorbeeld \033 zullen overeenkomen.

HlCChar

Detecteer een C-teken.

<HlCChar (gezamenlijke attributen) />

Deze regel heeft geen specifieke attributen.

Komt overeen met een C-teken tussen accenten (Bijvoorbeeld: 'c'). De accenten kunnen een eenvoudig teken zijn of een escaped teken. Zie HlCStringChar voor overeenkomende reeksen van escaped tekens.

RangeDetect

Detecteert een tekenreeks met gedefinieerde begin- en eindtekens.

<RangeDetect char="(teken)"  char1="(teken)" (gezamenlijke attributen) />

char defines the character starting the range, char1 the character ending the range.

Bruikbaar om bijvoorbeeld kleine tekenreeksen of zoiets te detecteren, maar merk op dat de accentiëringsengine werkt op één regel tegelijk, hierdoor zullen tekenreeksen over meerdere regels niet gevonden worden.

LineContinue

Komt overeen met een gespecificeerd teken aan het eind van een regel.

<LineContinue (gezamenlijke attributen) [char="\"] />

char optioneel teken dat moet overeenkomen, standaard is de backslash ('\'). Nieuw sinds KDE 4.13.

Deze regel is bruikbaar voor het omschakelen van context aan het einde van een regel. Dit is bijvoorbeeld nodig in C/C++ om macro's of tekenreeksen door te laten lopen.

IncludeRules

Voeg regels in uit een ander context- of taalbestand.

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

Het attribuut context definieert welke context in te voegen.

Als het een eenvoudige tekenreeks is dan zijn alle gedefinieerde regels in de huidige context ingevoegd, bijvoorbeeld:

<IncludeRules context="anotherContext" />

Als de tekenreeks ## bevat zal het accentueringssysteem zoeken naar een context uit een andere taaldefinitie met de gegeven naam, bijvoorbeeld

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

zou de context String uit de accentueringsdefinitie van C++ invoegen.

Als attribuut includeAttrib true is, dan wijzigt het doelattribuut naar die van de bron. Dit is vereist om bijvoorbeeld het aanbrengen van commentaar te laten werken als tekst die overeenkomt met de ingevoegde context een verschillende accentuering is van de host-context.

DetectSpaces

Detecteert witruimte.

<DetectSpaces (gezamenlijke attributen) />

Deze regel heeft geen specifieke attributen.

Gebruik deze regel als u weet dat er verschillende witruimtes aankomen, bijvoorbeeld aan het begin van inspringende regels. Deze regel slaat alle witruimte in een keer over, in plaats van testen met meerdere regels en een voor een overslaan vanwege geen overeenkomst.

DetectIdentifier

Tekenreeksen voor een identifier detecteren (als de reguliere expressie: [a-zA-Z_][a-zA-Z0-9_]*).

<DetectIdentifier (gezamenlijke attributen) />

Deze regel heeft geen specifieke attributen.

Gebruik deze regel om een reeks woordtekens in een keer over te slaan, in plaats van deze te testen met meerdere regels en ze een voor een over te slaan omdat er geen overeenkomst is.