Complete module header indentation issues

Author: sfavazza

sysver-bnf.el

@@ -120,7 +120,6 @@
   "Define a grammar for the language to be given to SMIE")
 
 ;; indentation rules
-(setq smie-indent-basic sysver-default-indent)            ; big to be sure it has an effect
 (defun sysver-smie-rules (kind token)
 
   ;; -----------------------------------------------------------------------------------------------
@@ -140,15 +139,15 @@
   ;; the following sequence of rules are always run in sequence until the first one returns non-nil
   (cond
    ;; default rules
-   ;; ('(:elem . args)  smie-indent-basic)
-   ;; ('(:elem . basic) smie-indent-basic)
+   ;; ('(:elem . args)  sysver-default-indent)
+   ;; ('(:elem . basic) sysver-default-indent)
    ((and (eq kind :elem) (equal token 'empty-line-token))
     0)
 
    ;; ----------------------------------------------------------------------------------------------
    ;; module structure
    ((and (eq kind :before) (member token `("(" ,smie-syntoken-params-start-list)))
-    smie-indent-basic)
+    sysver-default-indent)
    ((and (eq kind :before) (equal token ","))
     ;; align to the end of "#(" and "(" start-list-delimiters
     (save-excursion
@@ -176,11 +175,15 @@
    ;; loops (for, while)
 
    ;; case
+
+   ;; as all these rules are applied in order and the function exits as the first returns non-nil,
+   ;; here the default option is placed
+   ;; (t sysver-default-indent)
    )
 
   ;; (pcase (cons method arg)
   ;;   ('(:before . "endmodule") 0)
-  ;;   ('(:before . ";") smie-indent-basic)
+  ;;   ('(:before . ";") sysver-default-indent)
   ;;   )
   )
 

sysver.el

@@ -252,7 +252,8 @@ This is useful to let the user customize it via the customization options"
   ;; re-fontify current buffer as the defaults are directly changed
   (font-lock-refresh-defaults)
 
-  ;; set up indentation engine
+  ;; set up the indentation engine SMIE
+  (setq smie-indent-basic sysver-default-indent)
   (smie-setup sysver-smie-grammar #'sysver-smie-rules
               :forward-token #'sysver-forward-token
               :backward-token #'sysver-backward-token)

test/Makefile

@@ -23,4 +23,4 @@ test_files := $(wildcard *.el)
 all: $(test_files)
 
 $(test_files):
-	emacs -batch -l ../sysver.el -l ert -l $@ -f ert-run-tests-batch-and-exit
+	emacs -batch -L ../ -L . -l ert -l $@ -f ert-run-tests-batch-and-exit

test/sysver-indent.el

@@ -16,7 +16,10 @@
                                  (make-string indent-test ?\ ) "(param3, param4, param5)\n"
                                  "endmodule")
                         ,(concat "module a_module_name_id1 #(param0,\n"
-                                 (make-string (+ indent-test 2) ?\ ) "param1, param2)\n"
+                                 ;; The list of parameters after the first one in the previous line
+                                 ;; is indented to the parameter-list starting column.
+                                 (make-string (+ (length "module a_module_name_id0 ") 2) ?\ )
+                                 "param1, param2)\n" 
                                  (make-string indent-test ?\ ) "(param3, param4, param5)\n"
                                  "endmodule")
                         ,(concat "module a_module_name_id2\n"
@@ -43,7 +46,6 @@
           (setq current-string (pop strings))
           (with-temp-buffer
             (sysver-utc-environment
-
              current-string
 
              ;; set-up indentation parameters
@@ -53,4 +55,5 @@
              ((save-excursion
                 (indent-region (point-min) (point-max)))
               ;; verify
-              (should (equal (buffer-string) current-string))))))))))
+              (should (equal (buffer-substring-no-properties (point-min) (point-max))
+                             current-string))))))))))