Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Src block/33font lock fontified missing #37

Merged
merged 8 commits into from
Aug 3, 2023
Merged

Src block/33font lock fontified missing #37

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
22fef60
Fixes #33. Noticeable lag when typing in larger code blocks
Jul 24, 2023
c0e445f
Addresses #33. Reduce formatting lag by `adoc-kwf-search`
Jul 26, 2023
47f5559
Addresses #33. Restart search in `adoc-kwf-std` at last prevented mat…
Jul 27, 2023
22191ba
Addresses #33. Re-introduce adoc-kw-delimited-block 2 because of fail…
Jul 27, 2023
41105ba
Addresses #33. Re-structure also `adoc-kw-replacement`.
Jul 29, 2023
dab8f2e
Merge branch 'master' into SrcBlock/33font-lock-fontified_missing
TobiasZawada Jul 29, 2023
3ab5480
Addresses #33. Remove the superfluous (setq found nil) in adoc-kw-rep…
Jul 29, 2023
7690cc8
[#33] Describe purpose of adoc-kwf-search
Aug 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 28 additions & 25 deletions adoc-mode.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1556,6 +1556,19 @@ Subgroups of returned regexp:


;;;; font lock keywords
(defsubst adoc-kwf-search (regexp &optional bound noerror count)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why kwf and not just kw?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because adoc-kwf-search does not return a font-lock keyword but it is an auxiliary Function much like adoc-kwf-std.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get this, but I'm struggling to understand what does kwf stands for. :-)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume that -kwf- stands for keyword function.
Those are functions that are used in the keyword generators -kw-.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, here it's not even a function, as I see it's being inlined. :-) Anyways, I don't feel strongly about this naming - I just find it somewhat confusing.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reasoning for the naming:

  1. Keep changes small
  2. Keep consistency

"Keyword search for Adoc.
Like `re-search-forward' with the same arguments
REGEXP, BOUND, NOERROR and COUNT.
If a match for REGEXP is found where the text property
`adoc-code-block' is non-nil continue the search."
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably you should also mention explicitly that the purpose of this is skip code in code blocks for performance reasons.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not only for performance reasons but also to prevent the adoc fontification within code blocks.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, this should be mentioned in the docstring as well then.

(let (ret)
(while (and
(setq ret (re-search-forward regexp bound noerror count))
(get-text-property (point) 'adoc-code-block)
(null (eobp))))
ret))

(defun adoc-kwf-std (end regexp &optional must-free-groups no-block-del-groups)
"Standard function for keywords
Intendent to be called from font lock keyword functions. END is
Expand All @@ -1564,10 +1577,9 @@ MUST-FREE-GROUPS a list of regexp group numbers which may not
match text that has an adoc-reserved text-property with a non-nil
value. Likewise, groups in NO-BLOCK-DEL-GROUPS may not contain
text having adoc-reserved set to symbol `block-del'."
(let ((found t) (prevented t) saved-point)
(let ((found t) (prevented t))
(while (and found prevented (<= (point) end) (not (eobp)))
(setq saved-point (point))
(setq found (re-search-forward regexp end t))
(setq found (adoc-kwf-search regexp end t))
(setq prevented
(and found
(or
Expand All @@ -1584,7 +1596,7 @@ text having adoc-reserved set to symbol `block-del'."
'adoc-reserved 'block-del)))
no-block-del-groups))))
(when (and found prevented (<= (point) end))
(goto-char (1+ saved-point))))
(goto-char (1+ (match-beginning 0)))))
(and found (not prevented))))

(defun adoc-kwf-attribute-list (end)
Expand Down Expand Up @@ -1679,7 +1691,7 @@ text having adoc-reserved set to symbol `block-del'."
;; matcher function
`(lambda (end)
(and adoc-enable-two-line-title
(re-search-forward ,(adoc-re-two-line-title del) end t)
(adoc-kwf-search ,(adoc-re-two-line-title del) end t)
(< (abs (- (length (match-string 2)) (length (match-string 3)))) 3)
(or (not (numberp adoc-enable-two-line-title))
(not (equal adoc-enable-two-line-title (length (match-string 2)))))
Expand Down Expand Up @@ -1754,7 +1766,7 @@ Concerning TYPE, LEVEL and SUB-TYPE see `adoc-re-llisti'."
`(list
;; matcher function
(lambda (end)
(and (re-search-forward "^[ \t]*\\(\\(?:CAUTION\\|WARNING\\|IMPORTANT\\|TIP\\|NOTE\\):\\)\\([ \t]+\\)" end t)
(and (adoc-kwf-search "^[ \t]*\\(\\(?:CAUTION\\|WARNING\\|IMPORTANT\\|TIP\\|NOTE\\):\\)\\([ \t]+\\)" end t)
(not (text-property-not-all (match-beginning 0) (match-end 0) 'adoc-reserved nil))))
;; highlighers
'(1 '(face adoc-complex-replacement-face adoc-reserved t))
Expand All @@ -1765,7 +1777,7 @@ Concerning TYPE, LEVEL and SUB-TYPE see `adoc-re-llisti'."
(list
;; matcher function
`(lambda (end)
(and (re-search-forward ,(adoc-re-verbatim-paragraph-sequence) end t)
(and (adoc-kwf-search ,(adoc-re-verbatim-paragraph-sequence) end t)
(not (text-property-not-all (match-beginning 0) (match-end 0) 'adoc-reserved nil))))
;; highlighers
'(1 '(face adoc-typewriter-face adoc-reserved t font-lock-multiline t))))
Expand Down Expand Up @@ -1889,18 +1901,11 @@ meta characters."
`(list
;; matcher function
(lambda (end)
(let ((found t) (prevented t) saved-point)
(while (and found prevented)
(setq saved-point (point))
(setq found
(re-search-forward ,regexp end t))
(setq prevented ; prevented is only meaningful wenn found is non-nil
(or
(not found) ; the following is only needed when found
(text-property-not-all (match-beginning 1) (match-end 1) 'adoc-reserved nil)))
(when (and found prevented)
(goto-char (+ saved-point 1))))
(when (and found (not prevented) adoc-insert-replacement ,replacement)
(let (found)
(while (and (setq found (adoc-kwf-search ,regexp end t))
(text-property-not-all (match-beginning 1) (match-end 1) 'adoc-reserved nil))
(goto-char (+ (match-beginning 0) 1)))
(when (and found adoc-insert-replacement ,replacement)
(let* ((s (cond
((stringp ,replacement)
,replacement)
Expand All @@ -1912,7 +1917,7 @@ meta characters."
(setq adoc-replacement-failed (not o))
(unless adoc-replacement-failed
(overlay-put o 'after-string s))))
(and found (not prevented))))
found))

;; highlighers
;; TODO: replacement instead warining face if resolver is not given
Expand All @@ -1931,7 +1936,7 @@ meta characters."
;; line beginning would also be underlined, which looks akward.
(defun adoc-flf-first-whites-fixed-width(end)
;; it makes no sense to do something with a blank line, so require at least one non blank char.
(and (re-search-forward "\\(^[ \t]+\\)[^ \t\n]" end t)
(and (adoc-kwf-search "\\(^[ \t]+\\)[^ \t\n]" end t)
;; don't replace a face with with adoc-align-face which already is a fixed with
;; font (most probably), because then it also won't look aligned
(text-property-not-all (match-beginning 1) (match-end 1) 'face 'adoc-typewriter-face)
Expand Down Expand Up @@ -2120,7 +2125,7 @@ Use this function as matching function MATCHER in `font-lock-keywords'."
(font-lock-append-text-property
start-src end-src+nl 'face 'adoc-native-code-face)
(add-text-properties
start-src end-src+nl '(font-lock-fontified t font-lock-multiline t))
start-src end-src+nl '(font-lock-fontified t font-lock-multiline t adoc-code-block t))
)))
t)))

Expand Down Expand Up @@ -2154,9 +2159,7 @@ Use this function as matching function MATCHER in `font-lock-keywords'."
(defun adoc-get-font-lock-keywords ()
"Return list of keywords for `adoc-mode'."
(list
;; Fontify code blocks first to mark these regions as fontified.
'(adoc-fontify-code-blocks)

'(adoc-fontify-code-blocks) ; listing
;; Asciidoc BUG: Lex.next has a different order than the following extract
;; from the documentation states.

Expand Down
17 changes: 17 additions & 0 deletions test/adoc-mode-test.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1026,6 +1026,23 @@ Don't use it for anything real.")
(cons "sub chapter 2.1" 262)))))
(kill-buffer "adoc-test")))

(ert-deftest adoctest-adoc-kw-replacement ()
(unwind-protect
(progn
(set-buffer (get-buffer-create "adoc-test"))
(erase-buffer)
(adoc-mode)
(let ((adoc-insert-replacement t))
(adoc-calc)
(insert "(C)")
(font-lock-flush)
(font-lock-ensure)
(should (string-equal (overlay-get (car (overlays-in (point) (point-max))) 'after-string) "©"))
)
)
(adoc-calc)
(kill-buffer "adoc-test")))

;; purpose
;; - ensure that the latest version, i.e. the one currently in buffer(s), of
;; adoc-mode and adoc-mode-test is used for the test
Expand Down
Loading