More fixes for Fypp / FORD compatibility

don't align Fypp directives and FORD comments in Fortran continuation
lines

Author: pseewald

fortran_tests/after/test_fypp.f90

@@ -318,3 +318,12 @@ end function maxRelError_${RANK}$_${PREC}$
 
 end module errorcalc
 
+! tests for fypp directives inside Fortran continuation lines
+call test(arg1, &
+          ${a if a  > b else b}$, arg3, &
+ #:if c>d
+          c, &
+ #:else
+          d, &
+ #:endif
+          arg4)

fortran_tests/before/test_fypp.f90

@@ -321,3 +321,12 @@ end function maxRelError_${RANK}$_${PREC}$
 
 end module errorcalc
 
+! tests for fypp directives inside Fortran continuation lines
+call test(arg1,&
+   ${a if a  > b else b}$, arg3, &
+ #:if c>d
+   c,&
+ #:else
+   d,&
+ #:endif
+   arg4)

fortran_tests/test_results/expected_results

@@ -2025,7 +2025,7 @@ cp2k/src/spglib_f08.F : 73ca32b9888bfbb3d6aa83400ef1f06a6e75c757229b8f08c6006ada
 cp2k/src/subsys/molecule_kind_list_types.F : c7bea1daf80996474c7cb28b37bcca100438e7786c5407ccab2de600790d78d6
 cp2k/src/subsys/molecule_list_types.F : 8710f953acb71f2a06a6330db825f4ccdfd7967d5ba04a5227b41a44f02cb4cd
 cp2k/src/subsys/molecule_types.F : 3cd84f819410634c322cb7c3625597fd1460f4df7d08dcd8c1f1c860effb696e
-test_fypp.f90 : 640604e591b2711e08b52b48dc91bc6653e66b541f1551d5de60770418c3ad23
+test_fypp.f90 : 9202d61e58959ad8c80db6afefa9007fbf9b72b306547337d6ba628c13eb2ca5
 wannier90/pwscf/post_v6.2.1/pw2wannier90.f90 : 319c6b563bbd5e69c666ed9cd972540abbbde70d17708064d9aae19f25d5a217
 wannier90/pwscf/v3.2.3/pw2wannier90.f90 : 42dba4a02d1257912baf939d57bc75aa9e412da619ea0c5413199167ede7efe6
 wannier90/pwscf/v3.2.3/wannier.f90 : c4d7d9c40d3459f837283474545ddcb922a776ddfb6f30866c9402351d2047bc

fprettify/__init__.py

@@ -1061,10 +1061,10 @@ def reformat_ffile(infile, outfile, impose_indent=True, indent_size=3, strict_in
             f_line, lines)
         f_line, lines, label = preprocess_labels(f_line, lines)
 
-        lines, do_format, prev_indent, is_blank, is_fypp, is_ford = preprocess_line(
+        lines, do_format, prev_indent, is_blank, is_special = preprocess_line(
             f_line, lines, comments, orig_filename, stream.line_nr)
 
-        if is_fypp or is_ford:
+        if is_special[0]:
             indent_special = 3
 
         if prev_indent and indent_special == 0:
@@ -1100,7 +1100,7 @@ def reformat_ffile(infile, outfile, impose_indent=True, indent_size=3, strict_in
                     f_line, whitespace, whitespace_dict, linebreak_pos, ampersand_sep,
                     orig_filename, stream.line_nr, auto_format)
 
-                lines = append_comments(lines, comment_lines)
+                lines = append_comments(lines, comment_lines, is_special)
 
             # target indent for next line
             rel_indent = req_indents[nfl] if nfl < len(req_indents) else 0
@@ -1111,6 +1111,13 @@ def reformat_ffile(infile, outfile, impose_indent=True, indent_size=3, strict_in
                     stream.line_nr, manual_lines_indent)
                 indent = indenter.get_lines_indent()
 
+            # use actual indents if line is special
+            if any(is_special):
+                for pos, line in enumerate(lines):
+                    if is_special[pos]:
+                        indent[pos] = len(line) - len(line.lstrip(' '))
+                        lines[pos] = line.lstrip(' ')
+
             lines, indent = prepend_ampersands(lines, indent, pre_ampersand)
 
         lines = remove_trailing_whitespace(lines)
@@ -1208,26 +1215,30 @@ def preprocess_line(f_line, lines, comments, filename, line_nr):
     is_blank = False
     prev_indent = False
     do_format = False
-    is_fypp = False
-    is_ford = False
+
+    # is_special: special directives that should not be treated as Fortran
+    # currently supported: fypp preprocessor directives or comments for FORD documentation
+    is_special = [False]*len(lines)
+
+    for pos, line in enumerate(lines):
+        line_strip = line.lstrip()
+        is_special[pos] = FYPP_LINE_RE.search(line_strip) or line_strip.startswith('!!')
+
+    # if first line is special, all lines should be special
+    if is_special[0]: is_special = [True]*len(lines)
 
     if EMPTY_RE.search(f_line):  # empty lines including comment lines
         if any(comments):
             if lines[0].startswith(' '):
                 # indent comment lines only if they were not indented before.
                 prev_indent = True
-            line_strip = lines[0].lstrip()
-            is_fypp = FYPP_LINE_RE.search(line_strip)
-            is_ford = line_strip.startswith('!!')
         else:
             is_blank = True
-        if not is_fypp and not is_ford:
-            lines = [l.strip(' ') for l in lines]
-
+        lines = [l.strip(' ') if not is_special[n] else l for n, l in enumerate(lines)]
     else:
         do_format = True
 
-    return [lines, do_format, prev_indent, is_blank, is_fypp, is_ford]
+    return [lines, do_format, prev_indent, is_blank, is_special]
 
 
 def pass_defaults_to_next_line(f_line):
@@ -1261,12 +1272,12 @@ def prepend_ampersands(lines, indent, pre_ampersand):
     return [lines, indent]
 
 
-def append_comments(lines, comment_lines):
+def append_comments(lines, comment_lines, is_special):
     """append comments to lines"""
     for pos, (line, comment) in enumerate(zip(lines, comment_lines)):
         if pos < len(lines) - 1:
             has_nl = True  # has next line
-            if not line.strip(): comment = comment.lstrip()
+            if not line.strip() and not is_special[pos]: comment = comment.lstrip()
         else:
             has_nl = not re.search(EOL_SC, line)
         lines[pos] = lines[pos].rstrip(' ') + comment + '\n' * has_nl

fprettify/tests/__init__.py

@@ -428,12 +428,18 @@ def test_ford(self):
         instring =  ("   a = b\n"
                      "     !!  ford docu\n"
                      "b=c\n"
-                     "  !! ford docu"
+                     "  !! ford docu\n"
+                     "subroutine test(a,b,&\n"
+                     "  !! ford docu\n"
+                     "  c, d, e)"
                      )
         outstring = ("   a = b\n"
                      "     !!  ford docu\n"
                      "   b = c\n"
-                     "  !! ford docu"
+                     "  !! ford docu\n"
+                     "   subroutine test(a, b, &\n"
+                     "  !! ford docu\n"
+                     "                   c, d, e)"
                      )
 
         self.assert_fprettify_result([], instring, outstring)