Merge branch 'master' into master

Author: zouhairDe

.github/workflows/python-package-develop.yml

@@ -23,7 +23,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
 
 
     steps:

.github/workflows/python-package.yml

@@ -27,8 +27,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macos-11]
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        os: [ubuntu-latest] # , macos-11]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
 
     steps:

README.md

@@ -8,7 +8,7 @@
 <br />
 
 <p align="center">
-  <img width="65%" align="center" src="./Img/final_back.png">
+  <img width="65%" align="center" src="./img/final_back.png">
 </p>
 
 # c_formatter_42
@@ -19,32 +19,32 @@ It's just for convenience.
 
 ## Installation
 
-Requires Python3.7+ (3.8, 3.9, 3.10, 3.11)
+Requires Python3.8+ (3.9, 3.10, 3.11, 3.12)
 
 ### From PyPI
 
-```console
-$ pip3 install c-formatter-42
-$ pip3 install --user c-formatter-42  # If you don't have root privileges
+```sh
+pip3 install c-formatter-42
+pip3 install --user c-formatter-42  # If you don't have root privileges
 ```
 
 ### From source
 
-```console
-$ git clone https://github.com/cacharle/c_formatter_42
-$ cd c_formatter_42
-$ pip3 install -e .
+```sh
+git clone https://github.com/cacharle/c_formatter_42
+cd c_formatter_42
+pip3 install -e .
 ```
 
 ## Usage
 
 ### Command line
 
-```console
-$ c_formatter_42 < file.c
-$ python3 -m c_formatter_42 < file.c  # If you get 'command not found' with the previous one
+```sh
+c_formatter_42 < file.c
+python3 -m c_formatter_42 < file.c  # If you get 'command not found' with the previous one
 
-$ c_formatter_42 --help
+c_formatter_42 --help
 usage: c_formatter_42 [-h] [-c] [FILE [FILE ...]]
 
 Format C source according to the norm
@@ -80,3 +80,23 @@ Check out the [`c_formatter_42.vim`](https://github.com/cacharle/c_formatter_42.
 ## Contributing
 
 Feel free to report issues or contribute. :)
+
+### Run the tests
+
+```sh
+pip3 install tox
+tox
+tox -e py311  # for a specific python version
+```
+
+### Deploy a new version
+
+```sh
+pip3 install bumpversion
+bumpversion [major|minor|patch]
+git push
+git push --tags
+```
+
+Go to: <https://github.com/dawnbeen/c_formatter_42/tags> and click on the tag you just created.
+Then click on `Create release from tag`, the pipeline will build and deploy that version for you.

c_formatter_42/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.2.8"

c_formatter_42/__main__.py

@@ -102,4 +102,4 @@ def main() -> int:
     return 0 if success else 1
 
 if __name__ == "__main__":
-    sys.exit(main())
+    sys.exit(main())

c_formatter_42/data/.clang-format

@@ -92,7 +92,7 @@ BreakBeforeTernaryOperators: true
 
 # ColumnLimit (unsigned)
 # The column limit.
-ColumnLimit: 0
+ColumnLimit: 1024
 
 
 # FixNamespaceComments (bool)

c_formatter_42/data/clang-format-darwin-arm64

@@ -10,63 +10,69 @@
 #                                                                              #
 # ############################################################################ #
 
+from __future__ import annotations
 
 import re
-from enum import Enum
+import typing
 
-from c_formatter_42.formatters import helper
+if typing.TYPE_CHECKING:
+    from typing import Literal
 
+from c_formatter_42.formatters import helper
 
-class Scope(Enum):
-    LOCAL = 0
-    GLOBAL = 1
+TYPEDECL_OPEN_REGEX = re.compile(
+    r"""^(?P<prefix>\s*(typedef\s+)?   # Maybe a typedef
+        (struct|enum|union))           # Followed by a struct, enum or union
+        \s*(?P<suffix>[a-zA-Z_]\w+)?$  # Name of the type declaration
+    """,
+    re.X,
+)
+TYPEDECL_CLOSE_REGEX = re.compile(
+    r"""^(?P<prefix>\})\s*             # Closing } followed by any amount of spaces
+        (?P<suffix>([a-zA-Z_]\w+)?;)$  # Name of the type (if typedef used)
+    """,
+    re.X,
+)
 
 
-def align_scope(content: str, scope: Scope) -> str:
+def align_scope(content: str, scope: Literal["local", "global"]) -> str:
     """Align content
     scope can be either local or global
       local:  for variable declarations in function
       global: for function prototypes
     """
 
     lines = content.split("\n")
-    aligned = []
     # select regex according to scope
-    if scope is Scope.LOCAL:
+    if scope == "local":
         align_regex = "^\t" r"(?P<prefix>{type})\s+" r"(?P<suffix>\**{decl};)$"
-    elif scope is Scope.GLOBAL:
+    elif scope == "global":
         align_regex = (
             r"^(?P<prefix>{type})\s+"
             r"(?P<suffix>({name}\(.*\)?;?)|({decl}(;|(\s+=\s+.*))))$"
         )
     align_regex = align_regex.format(
         type=helper.REGEX_TYPE, name=helper.REGEX_NAME, decl=helper.REGEX_DECL_NAME
     )
-    # get the lines to be aligned
-    matches = [re.match(align_regex, line) for line in lines]
+    lines_to_be_aligned = [re.match(align_regex, line) for line in lines]
     aligned = [
         (i, match.group("prefix"), match.group("suffix"))
-        for i, match in enumerate(matches)
+        for i, match in enumerate(lines_to_be_aligned)
         if match is not None
         and match.group("prefix") not in ["struct", "union", "enum"]
     ]
 
-    # global type declaration (struct/union/enum)
-    if scope is Scope.GLOBAL:
-        typedecl_open_regex = (
-            r"^(?P<prefix>\s*(typedef\s+)?(struct|enum|union))"
-            r"\s*(?P<suffix>[a-zA-Z_]\w+)?$"
-        )
-        typedecl_close_regex = r"^(?P<prefix>\})\s*(?P<suffix>([a-zA-Z_]\w+)?;)$"
+    # Global type declaration (struct/union/enum)
+    if scope == "global":
         in_type_scope = False
         for i, line in enumerate(lines):
-            m = re.match(typedecl_open_regex, line)
+            m = TYPEDECL_OPEN_REGEX.match(line)
             if m is not None:
                 in_type_scope = True
                 if m.group("suffix") is not None and "typedef" not in m.group("prefix"):
                     aligned.append((i, m.group("prefix"), m.group("suffix")))
                 continue
-            m = re.match(typedecl_close_regex, line)
+            m = TYPEDECL_CLOSE_REGEX.match(line)
             if m is not None:
                 in_type_scope = False
                 if line != "};":
@@ -83,27 +89,28 @@ def align_scope(content: str, scope: Scope) -> str:
                 if m is not None:
                     aligned.append((i, m.group("prefix"), m.group("suffix")))
 
-    # get the minimum alignment required for each line
+    # Minimum alignment required for each line
     min_alignment = max(
-        (len(prefix.replace("\t", " " * 4)) // 4 + 1 for _, prefix, _ in aligned),
-        default=1,
+        (len(prefix.expandtabs(4)) // 4 + 1 for _, prefix, _ in aligned), default=1
     )
     for i, prefix, suffix in aligned:
-        alignment = len(prefix.replace("\t", " " * 4)) // 4
+        alignment = len(prefix.expandtabs(4)) // 4
         lines[i] = prefix + "\t" * (min_alignment - alignment) + suffix
-        if scope is Scope.LOCAL:
-            lines[i] = "\t" + lines[i]
+        if scope == "local":
+            lines[i] = (
+                "\t" + lines[i]
+            )  # Adding one more indent for inside the type declaration
     return "\n".join(lines)
 
 
 @helper.locally_scoped
 def align_local(content: str) -> str:
     """Wrapper for align_scope to use local_scope decorator"""
-    return align_scope(content, scope=Scope.LOCAL)
+    return align_scope(content, scope="local")
 
 
 def align(content: str) -> str:
     """Align the content in global and local scopes"""
-    content = align_scope(content, scope=Scope.GLOBAL)
+    content = align_scope(content, scope="global")
     content = align_local(content)
     return content

c_formatter_42/formatters/align.py

@@ -10,19 +10,19 @@
 #                                                                              #
 # ############################################################################ #
 
+import contextlib
+import platform
 import subprocess
 import sys
-from contextlib import contextmanager
 from pathlib import Path
 
 import c_formatter_42.data
 
 CONFIG_FILENAME = Path(".clang-format")
-
 DATA_DIR = Path(c_formatter_42.data.__file__).parent
 
 
-@contextmanager
+@contextlib.contextmanager
 def _config_context():
     """Temporarly place .clang-format config file in the current directory
     If there already is a config in the current directory, it's backed up
@@ -48,7 +48,12 @@ def _config_context():
 if sys.platform == "linux":
     CLANG_FORMAT_EXEC = DATA_DIR / "clang-format-linux"
 elif sys.platform == "darwin":
-    CLANG_FORMAT_EXEC = DATA_DIR / "clang-format-darwin"
+    if platform.machine() == "arm64":
+        # macOS M1 or Apple Silicon
+        CLANG_FORMAT_EXEC = DATA_DIR / "clang-format-darwin-arm64"
+    elif platform.machine() == "x86_64":
+        # macOS Intel
+        CLANG_FORMAT_EXEC = DATA_DIR / "clang-format-darwin"
 elif sys.platform == "win32":
     CLANG_FORMAT_EXEC = DATA_DIR / "clang-format-win32.exe"
 else:

c_formatter_42/formatters/clang_format.py

@@ -1,32 +1,38 @@
-# ############################################################################ #
+# **************************************************************************** #
 #                                                                              #
 #                                                         :::      ::::::::    #
 #    helper.py                                          :+:      :+:    :+:    #
 #                                                     +:+ +:+         +:+      #
-#    By: cacharle <me@cacharle.xyz>                 +#+  +:+       +#+         #
+#    By: leo <leo@student.42.fr>                    +#+  +:+       +#+         #
 #                                                 +#+#+#+#+#+   +#+            #
 #    Created: 2020/10/04 11:38:00 by cacharle          #+#    #+#              #
-#    Updated: 2021/02/08 18:22:06 by charles          ###   ########.fr        #
+#    Updated: 2023/09/22 15:21:49 by leo              ###   ########.fr        #
 #                                                                              #
-# ############################################################################ #
+# **************************************************************************** #
+
+from __future__ import annotations
 
 import re
+import typing
+
+if typing.TYPE_CHECKING:
+    from typing import Callable
 
 # regex for a type
-REGEX_TYPE = r"(?!return)([a-z]+\s+)*[a-zA-Z_]\w*"
+REGEX_TYPE = r"(?!return|goto)([a-z]+\s+)*[a-zA-Z_]\w*"
 # regex for a c variable/function name
 REGEX_NAME = r"\**[a-zA-Z_*()]\w*"
 # regex for a name in a declaration context (with array and function ptr)
-REGEX_DECL_NAME = r"\(?{name}(\[.*\])*(\)\(.*\))?".format(name=REGEX_NAME)
+REGEX_DECL_NAME = r"\(?{name}(\[.*\])*(\s\=\s.*)?(\)\(.*\))?".format(name=REGEX_NAME)
 
 
-def locally_scoped(func):
+def locally_scoped(func: Callable[[str], str]) -> Callable[[str], str]:
     """Apply the formatter on every local scopes of the content"""
 
     def wrapper(content: str) -> str:
-        def get_replacement(match):
-            body = match.group("body").strip("\n")
-            result = func(body)
+        def replacement_func(match: re.Match) -> str:
+            result = func(match.group("body").strip("\n"))
+            # Edge case for functions with empty bodies (See PR#31)
             if result.strip() == "":
                 return ")\n{\n}\n"
             return ")\n{\n" + result + "\n}\n"
@@ -35,7 +41,7 @@ def get_replacement(match):
             # `*?` is the non greedy version of `*`
             # https://docs.python.org/3/howto/regex.html#greedy-versus-non-greedy
             r"\)\n\{(?P<body>.*?)\n\}\n".replace(r"\n", "\n"),
-            get_replacement,
+            replacement_func,
             content,
             flags=re.DOTALL,
         )