added tool to sort includes

Author: dougxc

bin/sort_includes.py

@@ -0,0 +1,136 @@
+# Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+#
+# This code is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 2 only, as
+# published by the Free Software Foundation.
+#
+# This code is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+# version 2 for more details (a copy is included in the LICENSE file that
+# accompanied this code).
+#
+# You should have received a copy of the GNU General Public License version
+# 2 along with this work; if not, write to the Free Software Foundation,
+# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+#
+# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+# or visit www.oracle.com if you need additional information or have any
+# questions.
+
+import re
+import os
+import argparse
+from pathlib import Path
+
+include_line = r'^ *#include *(<[^>]+>|"[^"]+")[^\n]*$\n'
+includes_pattern = f"{include_line}(?:(?:^$\\n)*{include_line})*"
+if_pattern = r'(?P<if>^ *#(if|ifdef|ifndef)[^\n]*$\n)'
+endif_pattern = r'(?P<endif>^ *#endif[^\n]*$\n)'
+
+conditional_pattern = f"{if_pattern}(?P<includes>{includes_pattern}){endif_pattern}"
+sys_include_prefix_pattern = r' *#include[^\n<]*<'
+
+includes_re = re.compile(f'{includes_pattern}|{conditional_pattern}', re.MULTILINE)
+
+def sorted_includes(block):
+    """
+    Sorts the include statements in `block`.
+
+    :param block: source code chunk containing 1 or more include statements
+    :return: `block` with the include statements sorted and a blank line
+             between user and sys includes
+    """
+
+    # Replace blank lines with an include string that sorts after user
+    # includes but before sys includes
+    lines = [line if line else "#include <!!!!>" for line in block.splitlines()]
+
+    # Sort lines and undo blank line replacement
+    lines = [line.replace("#include <!!!!>", "") for line in sorted(lines)]
+
+    # Join sorted lines back into a block
+    block = "\n".join(lines) + "\n"
+
+    # Add missing blank link line between user and sys includes
+    m = re.search(sys_include_prefix_pattern, block)
+    if m and m.start() != 0 and block[m.start() - 1] != "\n":
+        block = block[0:m.start()] + "\n" + block[m.start():]
+
+    return block
+
+def sort_includes(path, args):
+    """
+    Processes the C++ source file in `path` to sort its include statements.
+
+    :param path: a Path object for a C++ source file
+    :param args: command line configuration
+    :return: True if sorting changes were made, False otherwise
+    """
+    source = path.read_text()
+    prefix = None
+    suffix = None
+
+    unconditional_includes = []
+    conditional_includes = []
+    last = None
+
+    for m in includes_re.finditer(source):
+        if prefix is None:
+            prefix = source[0:m.start()]
+            suffix = ""
+        else:
+            suffix += source[last.end():m.start()]
+        if m.group("if"):
+            conditional_includes.append(m)
+        else:
+            unconditional_includes.append(m)
+        last = m
+
+    if prefix:
+        suffix += source[last.end():]
+        new_source = prefix + sorted_includes("".join((f"{m.group()}" for m in unconditional_includes)))
+        for m in conditional_includes:
+            new_source += m.group("if")
+            new_source += sorted_includes(m.group("includes"))
+            new_source += m.group("endif")
+        new_source += suffix
+    else:
+        new_source = source
+
+    if new_source != source:
+        sorted_path = path if args.update else path.with_name(path.name + ".sorted")
+        sorted_path.write_text(new_source)
+        if args.verbose:
+            print(f"Sorted includes in {path}")
+        return True
+    return False
+
+if __name__ == "__main__":
+    p = argparse.ArgumentParser(usage='%(prog)s dir...')
+    p.add_argument("-v", "--verbose", action="store_true", help="verbose execution")
+    p.add_argument("--update", action="store_true", help="update in-situ instead of writing modifications to files with '.sorted' suffix")
+    p.add_argument("file", help="C++ file or directory containing C++ files", nargs="+")
+
+    args = p.parse_args()
+
+    modified = 0
+    files = []
+    for name in args.file:
+        arg = Path(name)
+        if arg.is_file():
+            files.append(arg)
+        else:
+            for dirpath, dirnames, filenames in os.walk(arg):
+                for filename in filenames:
+                    path = Path(dirpath).joinpath(filename)
+                    if path.suffix in (".cpp", "hpp"):
+                        files.append(path)
+
+    for path in files:
+        if sort_includes(path, args):
+            modified += 1
+
+    print(f"Processed {len(files)} files, modified {modified}.")
+    raise SystemExit(modified)