From: "Jostein Kjønigsen" <jostein@secure.kjonigsen.net>
To: Eli Zaretskii <eliz@gnu.org>, Juri Linkov <juri@linkov.net>
Cc: emacs-devel@gnu.org, casouri@gmail.com, theo@thornhill.no
Subject: Re: toml-ts-mode: first draft
Date: Sun, 11 Dec 2022 20:56:33 +0100 [thread overview]
Message-ID: <0f74be1a-8502-ce66-6101-2b3f060295c5@secure.kjonigsen.net> (raw)
In-Reply-To: <83cz8pu9cr.fsf@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 676 bytes --]
On 11.12.2022 18:40, Eli Zaretskii wrote:
>> From: Juri Linkov <juri@linkov.net>
>> Cc: "Ergus via Emacs development discussions." <emacs-devel@gnu.org>, Yuan
>> Fu <casouri@gmail.com>, Theodor Thornhill <theo@thornhill.no>, Eli
>> Zaretskii <eliz@gnu.org>
>> Date: Sun, 11 Dec 2022 19:09:46 +0200
>>
>>> lisp/progmodes/toml-ts-mode.el
>> Why not lisp/textmodes/toml-ts-mode.el?
> I agree: conf-mode is in textmodes, so this new mode should be there
> as well.
That's an easy change.
Attached is a new patch which moves the code-file to lisp/textmodes/ and
also makes it derive from text-mode instead.
Are there any other changes I need to implement?
--
Jostein
[-- Attachment #2: 0003-Introduce-support-for-TOML-config-format.patch --]
[-- Type: text/x-patch, Size: 5573 bytes --]
From 5966f687aea8004fa4522514ed803e62e9e08af6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jostein=20Kj=C3=B8nigsen?= <jostein@kjonigsen.net>
Date: Sun, 11 Dec 2022 13:05:29 +0100
Subject: [PATCH 3/3] Introduce support for TOML config-format
This commit introduces support for the semi-popular TOML
config-format[1] through a new major-mode: toml-ts-mode.
I've read through the full spec[2], and from what I can see this
major-mode should provide correct syntax-highligting for every sort of
config-declaration which adheres to the specification.
Besides that it also adds support for basic tree-sitter based
navigation.
For the time being toml-ts-mode does NOT support imenu navigation,
but this is clearly something which can be added later.
[1] https://toml.io/en/
[2] https://toml.io/en/v1.0.0
---
admin/notes/tree-sitter/build-module/batch.sh | 1 +
lisp/textmodes/toml-ts-mode.el | 115 ++++++++++++++++++
2 files changed, 116 insertions(+)
create mode 100644 lisp/textmodes/toml-ts-mode.el
diff --git a/admin/notes/tree-sitter/build-module/batch.sh b/admin/notes/tree-sitter/build-module/batch.sh
index d45f37f4b64..73914125a8b 100755
--- a/admin/notes/tree-sitter/build-module/batch.sh
+++ b/admin/notes/tree-sitter/build-module/batch.sh
@@ -13,6 +13,7 @@ languages=
'rust'
'typescript'
'tsx'
+ 'toml'
)
for language in "${languages[@]}"
diff --git a/lisp/textmodes/toml-ts-mode.el b/lisp/textmodes/toml-ts-mode.el
new file mode 100644
index 00000000000..99717972bb5
--- /dev/null
+++ b/lisp/textmodes/toml-ts-mode.el
@@ -0,0 +1,115 @@
+;;; toml-ts-mode.el --- tree-sitter support for TOML -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2022 Free Software Foundation, Inc.
+
+;; Author : Jostein Kjønigsen <jostein@kjonigsen.net>
+;; Maintainer : Jostein Kjønigsen <jostein@kjonigsen.net>
+;; Created : December 2022
+;; Keywords : toml languages tree-sitter
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+;;
+
+;;; Code:
+
+(require 'treesit)
+
+(declare-function treesit-parser-create "treesit.c")
+(declare-function treesit-induce-sparse-tree "treesit.c")
+(declare-function treesit-node-start "treesit.c")
+(declare-function treesit-node-child-by-field-name "treesit.c")
+
+(defvar toml-ts-mode--font-lock-settings
+ (treesit-font-lock-rules
+ :language 'toml
+ :feature 'constant
+ '((boolean) @font-lock-constant-face)
+ :language 'toml
+ :feature 'delimiter
+ '((["="]) @font-lock-delimiter-face)
+ :language 'toml
+ :feature 'number
+ '((integer) @font-lock-number-face
+ (float) @font-lock-number-face
+ (local_date) @font-lock-number-face
+ (local_date_time) @font-lock-number-face
+ (local_time) @font-lock-number-face)
+ :language 'toml
+ :feature 'string
+ '((string) @font-lock-string-face)
+ :language 'toml
+ :feature 'escape-sequence
+ :override t
+ '((escape_sequence) @font-lock-escape-face)
+ :language 'toml
+ :feature 'pair
+ :override t ; Needed for overriding string face on keys.
+ '((comment) @font-lock-comment-face
+ (bare_key) @font-lock-property-face
+ (quoted_key) @font-lock-property-face
+ (table ("[" @font-lock-bracket-face
+ (_) @font-lock-type-face
+ "]" @font-lock-bracket-face))
+ (table_array_element ("[[" @font-lock-bracket-face
+ (_) @font-lock-type-face
+ "]]" @font-lock-bracket-face))
+ (table (quoted_key) @font-lock-type-face)
+ (table (dotted_key (quoted_key)) @font-lock-type-face))
+ :language 'toml
+ :feature 'error
+ :override t
+ '((ERROR) @font-lock-warning-face))
+ "Font-lock settings for TOML.")
+
+;;;###autoload
+(add-to-list 'auto-mode-alist '("\\.toml\\'" . toml-ts-mode))
+
+;;;###autoload
+(define-derived-mode toml-ts-mode text-mode "TOML"
+ "Major mode for editing TOML, powered by tree-sitter."
+ :group 'toml-mode
+
+ (unless (treesit-ready-p 'toml)
+ (error "Tree-sitter for TOML isn't avilable"))
+
+ (treesit-parser-create 'toml)
+
+ ;; Comments
+ (setq-local comment-start "# ")
+ (setq-local commend-end "")
+
+ ;; Navigation.
+ (setq-local treesit-defun-type-regexp
+ (rx (or "table" "table_array_element")))
+
+ ;; Font-lock.
+ (setq-local treesit-font-lock-settings toml-ts-mode--font-lock-settings)
+ (setq-local treesit-font-lock-feature-list
+ '((constant number pair string)
+ (escape-sequence)
+ (delimiter error)))
+
+ ;; Imenu.
+ ;; (setq-local imenu-create-index-function #'toml-ts-mode--imenu)
+ ;; (setq-local which-func-functions nil) ;; Piggyback on imenu
+
+ (treesit-major-mode-setup))
+
+(provide 'toml-ts-mode)
+
+;;; toml-ts-mode.el ends here
--
2.37.2
next prev parent reply other threads:[~2022-12-11 19:56 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-11 13:28 toml-ts-mode: first draft Jostein Kjønigsen
2022-12-11 17:09 ` Juri Linkov
2022-12-11 17:23 ` Jostein Kjønigsen
2022-12-11 17:40 ` Eli Zaretskii
2022-12-11 18:19 ` Stefan Kangas
2022-12-11 18:23 ` Eli Zaretskii
2022-12-11 21:43 ` Stefan Kangas
2022-12-12 3:28 ` Eli Zaretskii
2022-12-12 17:04 ` Juri Linkov
2022-12-11 19:56 ` Jostein Kjønigsen [this message]
2022-12-11 20:07 ` Eli Zaretskii
2022-12-11 20:31 ` Jostein Kjønigsen
2022-12-11 20:38 ` Eli Zaretskii
2022-12-11 20:49 ` Jostein Kjønigsen
2022-12-11 23:01 ` Yuan Fu
2022-12-12 13:10 ` Jostein Kjønigsen
2022-12-12 13:53 ` Theodor Thornhill
2022-12-12 20:41 ` Jostein Kjønigsen
2022-12-12 21:17 ` Randy Taylor
2022-12-13 20:43 ` Jostein Kjønigsen
2022-12-13 22:37 ` Randy Taylor
2022-12-14 8:40 ` Jostein Kjønigsen
2022-12-14 13:24 ` Randy Taylor
2022-12-14 18:53 ` toml-ts-mode (code-review done) Jostein Kjønigsen
2022-12-14 19:02 ` Theodor Thornhill
2022-12-14 20:37 ` Yuan Fu
2022-12-14 22:02 ` Jostein Kjønigsen
2022-12-15 2:24 ` Randy Taylor
2022-12-15 12:52 ` Jostein Kjønigsen
2022-12-15 13:22 ` Theodor Thornhill
2022-12-15 13:45 ` Jostein Kjønigsen
2022-12-15 14:22 ` Eli Zaretskii
2022-12-15 14:28 ` Jostein Kjønigsen
2022-12-13 10:45 ` toml-ts-mode: first draft Rudolf Schlatte
2022-12-13 13:20 ` Eli Zaretskii
2022-12-13 14:22 ` Rudi Schlatte
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=0f74be1a-8502-ce66-6101-2b3f060295c5@secure.kjonigsen.net \
--to=jostein@secure.kjonigsen.net \
--cc=casouri@gmail.com \
--cc=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=jostein@kjonigsen.net \
--cc=juri@linkov.net \
--cc=theo@thornhill.no \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).