Changes for review

Author: LonelyCat124

doc/source/fparser2.rst

@@ -498,8 +498,11 @@ file was found but would fail if the include file was not found::
 Compiler/OpenMP Directive support
 ---------------------------------
 Most Fortran compilers support directives to enable compiler-specific
-functionality. Fparser will convert these into ``Directive`` nodes where
-possible.
+functionality. Fparser has an option to support converting these into
+``Directive`` nodes where possible. This option is ``process_directives``,
+and by default it is set to ``False``. For directives to be processed, the
+``ignore_comments`` must be also be ``False``, otherwise Fparser will ignore
+this option.
 
 The supported directives are those recognized by flang, ifx, ifort (``!dir$``),
 and gcc (``!gcc$``), as well as OpenMP directives (such as ``!$omp``

src/fparser/common/readfortran.py

@@ -554,22 +554,27 @@ class FortranReaderBase:
     :param mode: a FortranFormat object as returned by \
                  `sourceinfo.get_source_info()`
     :type mode: :py:class:`fparser.common.sourceinfo.Format`
-    :param bool isstrict: whether we are strictly enforcing fixed format.
-    :param bool ignore_comments: whether or not to discard comments. If
+    :param isstrict: whether we are strictly enforcing fixed format.
+    :param ignore_comments: whether or not to discard comments. If
         comments are not ignored, they will be added as special Comment node
         to the tree, and will therefore also be added to the output Fortran
         source code.
-    :param Optional[bool] include_omp_conditional_lines: whether or not the
+    :param include_omp_conditional_lines: whether or not the
         content of a line with an OMP sentinel is parsed or not. Default is
         False (in which case it is treated as a Comment).
+    :param process_directives: whether or not to process directives as
+        specialised Directive nodes. Default is False (in which case
+        directives are left as comments).
 
     The Fortran source is iterated by `get_single_line`,
     `get_next_line`, `put_single_line` methods.
 
     """
 
     def __init__(
-        self, source, mode, ignore_comments, include_omp_conditional_lines=False
+            self, source, mode: bool, ignore_comments: bool,
+            include_omp_conditional_lines: bool = False,
+            process_directives: bool = False
     ):
         self.source = source
         self._include_omp_conditional_lines = include_omp_conditional_lines
@@ -579,6 +584,10 @@ def __init__(
         # This value for ignore_comments can be overridden by using the
         # ignore_comments optional argument to e.g. get_single_line()
         self._ignore_comments = ignore_comments
+        if self._ignore_comments:
+            self.process_directives = False
+        else:
+            self.process_directives = process_directives
 
         self.filo_line = []  # used for un-consuming lines.
         self.fifo_item = []

src/fparser/two/Fortran2003.py

@@ -73,6 +73,8 @@
 import re
 import sys
 
+from typing import Union
+
 from fparser.common.splitline import string_replace_map
 from fparser.two import pattern_tools as pattern
 from fparser.common.readfortran import FortranReaderBase
@@ -136,21 +138,21 @@ class Directive(Base):
 
     subclass_names = []
     _directive_formats = [
-        "!$dir",
-        "!dir$",
-        "cdir$",
-        "!$omp",
-        "c$omp",
-        "*$omp",
-        "!$omx",
-        "c$omx",
-        "*$omx",
-        "!gcc$",
-        "!$ompx",
+        "!$dir",  # Generic directive
+        "!dir$",  # flang, ifx, ifort directives.
+        "cdir$",  # flang, ifx, ifort fixed format directive.
+        "!$omp",  # OpenMP directive
+        "c$omp",  # OpenMP fixed format directive
+        "*$omp",  # OpenMP fixed format directive
+        "!$omx",  # OpenMP fixed format directive
+        "c$omx",  # OpenMP fixed format directive
+        "*$omx",  # OpenMP fixed format directive
+        "!gcc$",  # GCC compiler directive
+        "!$ompx",  # OpenMP extension directive
     ]
 
     @show_result
-    def __new__(cls, string: str | FortranReaderBase, parent_cls=None):
+    def __new__(cls, string: Union[str, FortranReaderBase], parent_cls=None):
         """
         Create a new Directive instance.
 
@@ -164,11 +166,12 @@ def __new__(cls, string: str | FortranReaderBase, parent_cls=None):
 
         if isinstance(string, readfortran.Comment):
             # Directives must start with one of the specified directive
-            # formats.
+            # prefixes.
+            lower = string.comment.lower()
             if not (
                 any(
                     [
-                        string.comment.lower().startswith(prefix)
+                        lower.startswith(prefix)
                         for prefix in Directive._directive_formats
                     ]
                 )
@@ -195,7 +198,6 @@ def __new__(cls, string: str | FortranReaderBase, parent_cls=None):
                 return res
             # We didn't get a directive so put the item back in the FIFO
             reader.put_item(item)
-            return
         # We didn't get a directive
         return
 
@@ -277,17 +279,6 @@ def tostr(self):
         """
         return str(self.items[0])
 
-    def restore_reader(self, reader):
-        """
-        Undo the read of this comment by putting its content back
-        into the reader (which has a FIFO buffer)
-
-        :param reader: the reader instance to return the comment to
-        :type reader: :py:class:`fparser.readfortran.FortranReaderBase`
-        """
-        reader.put_item(self.item)
-
-
 def match_comment_or_include(reader):
     """Creates a comment, directive, or include object from the current line.
 
@@ -304,7 +295,9 @@ def match_comment_or_include(reader):
             or :py:class:`fparser.two.Fortran2003.Directive`
 
     """
-    obj = Directive(reader)
+    obj = None
+    if(reader.process_directives):
+        obj = Directive(reader)
     obj = Comment(reader) if not obj else obj
     obj = Include_Stmt(reader) if not obj else obj
     return obj