Pull to refresh

Подсветка синтаксиса языка F# в gedit

Reading time11 min
Views1K

Введение


Создание подсветки синтаксиса для какого-либо языка в gedit, осуществляется с помощью библиотеки gtksourceview. В общем и целом работа по добавлению подсветки синтаксиса какого-либоязыка в gnome-edit состоит в написании файла с расширением .lang, который по сути является XML файлом, в которм хранится описание синтаксиса того или иного языка. Обычно .lang файлы, которые подерживает gtksourceview находятся в директории /usr/share/gtksourceview-2.0/language-specs/

Описание формата .lang файлов


Как и любой XML документ файл .lang состоит из корня и узлов исходящих из корня документа. В .lang корнем документа является тэг . Корневой тэг может содержать в себе следующие аттрибуты:

ID — Идентификатор описания. Используется для внешних ссылок на данный элемент и должен быть уникальным. Он может содержать буквы, цифры и знаки подчеркивания. В значении аттрибута ID, не должно использоваться букв в высоком регистре.

Name — Название языка предоставляемому пользователю.

Version — Версия формата. (GTKSOURСEVIEW использует 2.0)

Section — Определяет в какой секции меню будет находится язык: скриптовый, научный и др. (Для gedit меню)

Hidden — Hint, всплывающая подсказка для пользователя.

Все аттрибуты кроме hidden и section являются обязательными.

Так же корневой элемент может содержать в себе следующие элементы:

Metadata — элемент содержит в себе описание метаданных. Может содержать в себе элемент properties, который содержит один аттрибут. name, значение которго может быть:

Mimetypes — Содержит список медиа типов
Globs — расширение файлов языка
line-comment-start — используется для описание однострочных комментариев
block comment-start — используется для описания начала многострочных комментариев
block-comment-end — используется для описания начала многострочных комментариев
Styles — содержит описание сттилей используемых в текущем языке. Содержит один элемент — style

Style — описывает стиль который ассоциируется с каким-то конкретным ID. Содержит в себе 3 элемента:
ID — Идентификатор стиля
Name — Имя стиля
Map-to — Используется для отображения стиля с конкретными шрифтом и цветом.

Definitions — основной элемент корня, содержащий определение языка. Включает в себя один аттрибут:
ID — Идентификатор служащий для включения определнных регулярных выражений описывающий синтакиси языка

Сontext — наиболее важный элемент соддержащий описание синтаксиса. Может содержать в себе следующие элементы:
Start — содержит начальное регулярное выражение текущего контекста
End — содержит заканчивающийся регулярное выражение текущего контекста
Include — содержит в себе список контекстов

Так же элемент может содержать в себе следующие аттрибуты:

ID — уникальный идентификатор контекста
style-ref — стиль подсветки для данного контекста

Keyword — содержит ключевые слова для данного контекста.

Вот в принципе и все стандартные элементы, здесь приведены лишь базовые элементы gtksourceview.

Ну и на закуску .lang файл описывающий язык F#:

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

<language id="fsharp" _name="F#" version="2.0" _section="Sources">
 <metadata>
  <property name="mimetypes">text/x-fsharp</property>
  <property name="globs">*.fs;</property>
  <property name="line-comment-start">//</property>
  <property name="block-comment-start">(*</property>
  <property name="block-comment-end">*)</property>
 </metadata>
 <styles>
  <style id="comment" _name="Comment" map-to="def:comment"/>
  <style id="base-n-integer" _name="Base-N Integer" map-to="def:base-n-integer"/>
  <style id="floating-point" _name="Floating Point number" map-to="def:floating-point"/>
  <style id="decimal" _name="Decimal number" map-to="def:decimal"/>
  <style id="string" _name="String" map-to="def:string"/>
  <style id="keyword" _name="Keyword" map-to="def:keyword"/>
  <style id="meta-keyword" _name="Type, module or object keyword" map-to="def:keyword"/>
  <style id="fun-keyword" _name="Builtin-function keyword" map-to="def:keyword"/>
  <style id="type" _name="Data Type" map-to="def:type"/>
  <style id="label" _name="Labeled argument" map-to="def:type"/>
  <style id="poly-variant" _name="Polymorphic Variant" map-to="def:type"/>
  <style id="variant" _name="Variant Constructor" map-to="def:type"/>
  <style id="type-var" _name="Type Variable" map-to="def:type"/>
  <style id="module" _name="Module Path" map-to="def:type"/>
  <style id="escape" _name="Escaped Character" map-to="def:special-char"/>
  <style id="boolean" _name="Boolean value" map-to="def:boolean"/>
  <style id="preprocessor" _name="Preprocessor" map-to="def:preprocessor"/>
 </styles>
 <definitions>
  <define-regex id="cap-ident">\b[A-Z][A-Za-z0-9_']*</define-regex>
  <define-regex id="low-ident">\b[a-z][A-Za-z0-9_']*</define-regex>
  <define-regex id="char-esc">\\((\\|"|'|n|t|b|r)|[0-9]{3}|x[0-9a-fA-F]{2})</define-regex>
  <define-regex id="preproc-start">^\s*#\s*</define-regex>
  <define-regex id="symbolchar">[!#$%&*+./>=<?@:\\^|~-]</define-regex>

  <context id="escape-seq" style-ref="escape">
   <match>\%{char-esc}</match>
  </context> 

  <context id="line-comment" style-ref="comment" end-at-line-end="true">
   <start>//</start>
    <include>
     <context ref="def:in-line-comment"/>
    </include>
  </context>   

  <context id="multiline-comment" style-ref="comment">
   <start>\(\*</start>
   <end>\*\)</end>
    <include>
     <context ref="string"/>    
   <context ref="def:in-comment:*"/>
    </include>
  </context>

  <context id="preprocessor" style-ref="preprocessor" end-at-line-end="false">
   <start extended="true">
    \%{preproc-start}(if(n?def)?|else|endif|light|region|endregion)\b
   </start>
   <include>
    <context ref="def:line-continue" ignore-style="true"/>
    <context ref="string" ignore-style="true"/>
   </include>
  </context>

  <context id="if-false-comment" style-ref="comment">
   <start>\%{preproc-start}if\s*false\b</start>
   <end>\%{preproc-start}(endif|else|elif)\b</end>
    <include>
     <context id="if-in-if-false">
      <start>\%{preproc-start}if(n?def)?\b</start>
      <end>\%{preproc-start}endif\b</end>
       <include>
        <context ref="if-in-if-false"/>
        <context ref="def:in-comment"/>
       </include>
     </context>
     <context ref="def:in-comment"/>
    </include>
  </context>

  <context id="poly-variant" style-ref="poly-variant">
   <match>`\%{cap-ident}</match>
  </context>

  <context id="modpath" style-ref="module">
   <match>\%{cap-ident}(\.\%{cap-ident})*(?=\.)</match>
  </context>

  <context id="variant" style-ref="variant">
   <match>\%{cap-ident}</match>
  </context>

  <context id="string" style-ref="string">
   <start>"</start>
   <end>"</end>
    <include>
   <context ref="escape-seq"/>
    </include>
  </context>

  <context id="character-constant" style-ref="string">
   <match>('\%{char-esc}')|('[^\\']')</match>
  </context>

  <context id="type-var" style-ref="type-var">
   <match>'\%{low-ident}</match>
  </context>  

  <context id="boolean-constant" style-ref="boolean">
   <keyword>true</keyword>
   <keyword>false</keyword>
  </context>   

  <context id="keysymbol" style-ref="keyword">
   <prefix>(?<!\%{symbolchar})</prefix>
   <suffix>(?!\%{symbolchar})</suffix>  
    <keyword>\.\.</keyword>
    <keyword>::</keyword>
    <keyword>=</keyword>
    <keyword>@</keyword>
    <keyword>~</keyword>
    <keyword>-></keyword>
    <keyword>|</keyword>
    <keyword>:?</keyword>
    <keyword>:?></keyword>
    <keyword>^</keyword>
    <keyword><-</keyword>
    <keyword>&&</keyword>
    <keyword>&</keyword> 
   </context>

   <context id="keywords" style-ref="keyword">
    <keyword>abstract</keyword>
    <keyword>and</keyword>
    <keyword>as</keyword>
    <keyword>assert</keyword>
    <keyword>asr</keyword>
    <keyword>begin</keyword>
    <keyword>class</keyword>
    <keyword>default</keyword>
    <keyword>delegate</keyword>
    <keyword>do</keyword>
    <keyword>done</keyword>
    <keyword>downcast</keyword>
    <keyword>downto</keyword>
    <keyword>else</keyword>
    <keyword>end</keyword>
    <keyword>enum</keyword>
    <keyword>exception</keyword>
    <keyword>false</keyword>
    <keyword>finaly</keyword>
    <keyword>for</keyword>
    <keyword>fun</keyword>
    <keyword>function</keyword>
    <keyword>if</keyword>
    <keyword>in</keyword>
    <keyword>iherit</keyword>
    <keyword>interface</keyword>
    <keyword>land</keyword>
    <keyword>lazy</keyword>
    <keyword>let</keyword>
    <keyword>lor</keyword>
    <keyword>lsl</keyword>
    <keyword>lsr</keyword>    
    <keyword>lxor</keyword>
    <keyword>match</keyword>
    <keyword>member</keyword>
    <keyword>mod</keyword>
    <keyword>module</keyword>
    <keyword>mutable</keyword>
    <keyword>namespace</keyword>
    <keyword>new</keyword>
    <keyword>null</keyword>
    <keyword>of</keyword>
    <keyword>open</keyword>
    <keyword>or</keyword>
    <keyword>override</keyword>
    <keyword>sig</keyword>
    <keyword>static</keyword>
    <keyword>struct</keyword>
    <keyword>then</keyword>
    <keyword>to</keyword>
    <keyword>true</keyword>
    <keyword>try</keyword>
    <keyword>type</keyword>
    <keyword>val</keyword>
    <keyword>when</keyword>
    <keyword>inline</keyword>
    <keyword>upcast</keyword>
    <keyword>while</keyword>
    <keyword>with</keyword>
   </context>

  <!-- main context -->
   <context id="fsharp">
    <include>
     <context ref="keywords"/>
     <context ref="keysymbol"/>
     <context ref="boolean-constant"/>
     <context ref="arraylit"/>
     <context ref="character-constant"/>
     <context ref="string"/>
     <context ref="variant"/>
     <context ref="modpath"/>
     <context ref="poly-variant"/>
     <context ref="label"/>
     <context ref="line-comment"/>
     <context ref="multiline-comment"/>
     <context ref="type-var"/>
     <context ref="if-false-comment"/>
     <context ref="preprocessor"/>
    </include>
   </context>
  <!-- main context --> 
 </definitions>
</language>


* This source code was highlighted with Source Code Highlighter.


p.s. Официальный сайт GtkSourceView

p.p.s. Первый пост на Хабрахабр.

Tags:
Hubs:
Total votes 22: ↑21 and ↓1+20
Comments1

Articles