bug#14350: 24.3; octave mode comment indentation

bug#14350: 24.3; octave mode comment indentation

[Leo Liu]

Hello Stefan,

Some user from the Octave community has noticed the following change:

x = 12;                         # abc abc abc abc abc abc abc abc abc
                                # abc abc abc

If you TAB in the second comment line, that line will be moved to column
0.

I tested the example in emacs 22.1 and the second comment is supposed to
be aligned to a certain column (similar to ; and ;; in lisp-mode). Will
you be able to bend smie to do this? Thanks.

Leo

bug#14350: 24.3; octave mode comment indentation

[Leo Liu]

On 2013-05-05 23:17 +0800, Leo Liu wrote:
> x = 12;                         # abc abc abc abc abc abc abc abc abc
>                                 # abc abc abc

matlab.el also does the comment alignment well. Stefan, do you think
this is possible to do with smie?

Leo

bug#14350: 24.3; octave mode comment indentation

[Stefan Monnier]

>> x = 12;                         # abc abc abc abc abc abc abc abc abc
>>                                 # abc abc abc
> matlab.el also does the comment alignment well. Stefan, do you think
> this is possible to do with smie?

Of course.  In the very worst case you can change (buffer-locally)
smie-indent-functions to add any ad-hoc rule.
But maybe this can be fixed globally in smie-indent-comment.


        Stefan

bug#14350: 24.3; octave mode comment indentation

[Leo Liu]

On 2013-05-11 03:57 +0800, Stefan Monnier wrote:
> Of course.  In the very worst case you can change (buffer-locally)
> smie-indent-functions to add any ad-hoc rule.
> But maybe this can be fixed globally in smie-indent-comment.

Thanks for the comment (did I just use a pun?).

Unfortunately I have little knowledge of smie so I have to rely on
others to get this to behave. Thanks in advance.

Leo

bug#14350: 24.3; octave mode comment indentation

[Stefan Monnier]

>> Of course.  In the very worst case you can change (buffer-locally)
>> smie-indent-functions to add any ad-hoc rule.
>> But maybe this can be fixed globally in smie-indent-comment.
> Thanks for the comment (did I just use a pun?).
> Unfortunately I have little knowledge of smie so I have to rely on
> others to get this to behave. Thanks in advance.

No, no, you don't.  smie-indent-functions is just a hook that runs
functions that come up with some indentation choice.  It basically sits
between line-indent-function and smie proper.  You can add your own
function which will not itself need to use anything from smie.
Look at its docstring.


        Stefan

bug#14350: 24.3; octave mode comment indentation

[Leo Liu]

On 2013-05-11 11:35 +0800, Stefan Monnier wrote:
> No, no, you don't.  smie-indent-functions is just a hook that runs
> functions that come up with some indentation choice.  It basically sits
> between line-indent-function and smie proper.  You can add your own
> function which will not itself need to use anything from smie.
> Look at its docstring.

I intend to fix the bug with this patch. Comments?

diff --git a/lisp/progmodes/octave.el b/lisp/progmodes/octave.el
index 780bb2f5..5d8186f5 100644
--- a/lisp/progmodes/octave.el
+++ b/lisp/progmodes/octave.el
@@ -414,6 +414,13 @@ (defun octave-smie-rules (kind token)
        ;; (if (smie-parent-p "switch") 4)
        0))))
 
+(defun octave-indent-comment ()
+  "A function for `smie-indent-functions'."
+  (save-excursion
+    (back-to-indentation)
+    (when (and (looking-at-p "\\s<") (not (looking-at-p "\\s<\\s<")))
+      (comment-choose-indent))))
+
 \f
 (defvar octave-font-lock-keywords
   (list
@@ -488,6 +495,7 @@ (define-derived-mode octave-mode prog-mode "Octave"
               :forward-token  #'octave-smie-forward-token
               :backward-token #'octave-smie-backward-token)
   (setq-local smie-indent-basic 'octave-block-offset)
+  (add-hook 'smie-indent-functions #'octave-indent-comment nil t)
 
   (setq-local smie-blink-matching-triggers
               (cons ?\; smie-blink-matching-triggers))

bug#14350: 24.3; octave mode comment indentation

[Leo Liu]

Fixed in trunk.