Repository: dawnbeen/c_formatter_42 Branch: master Commit: f5ad83fbb8f0 Files: 39 Total size: 122.0 KB Directory structure: gitextract_hw75i0ju/ ├── .github/ │ └── workflows/ │ ├── python-package-develop.yml │ ├── python-package.yml │ └── python-publish.yml ├── .gitignore ├── LICENSE ├── README.md ├── c_formatter_42/ │ ├── __init__.py │ ├── __main__.py │ ├── data/ │ │ ├── .clang-format │ │ ├── __init__.py │ │ ├── clang-format-darwin │ │ ├── clang-format-darwin-arm64 │ │ └── clang-format-linux │ ├── formatters/ │ │ ├── __init__.py │ │ ├── align.py │ │ ├── clang_format.py │ │ ├── helper.py │ │ ├── hoist.py │ │ ├── line_breaker.py │ │ ├── misc.py │ │ ├── preprocessor_directive.py │ │ └── return_type_single_tab.py │ └── run.py ├── docs/ │ ├── Makefile │ ├── make.bat │ └── source/ │ ├── conf.py │ └── index.rst ├── requirements-dev.txt ├── setup.cfg ├── setup.py ├── tests/ │ ├── formatters/ │ │ ├── test_align.py │ │ ├── test_clang_format.py │ │ ├── test_hoist.py │ │ ├── test_line_breaker.py │ │ ├── test_misc.py │ │ ├── test_preprocessor_directive.py │ │ └── test_return_type_single_tab.py │ └── test_run.py └── tox.ini ================================================ FILE CONTENTS ================================================ ================================================ FILE: .github/workflows/python-package-develop.yml ================================================ # This workflow will install Python dependencies, run tests and lint with a variety of Python versions # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions name: CI-Dev on: push: branches: [ develop ] paths-ignore: - 'License' - 'README.md' pull_request: branches: [ develop ] paths-ignore: - 'License' - 'README.md' jobs: build: runs-on: ${{ matrix.os }} strategy: fail-fast: false matrix: os: [ubuntu-latest] python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"] steps: - uses: actions/checkout@v2 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v2 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -m pip install --upgrade pip python -m pip install -r requirements-dev.txt if [ -f requirements.txt ]; then pip install -r requirements.txt; fi python -m pip install -e . - name: Check formatted with black run: | black --check c_formatter_42 tests - name: Lint with flake8 run: | flake8 c_formatter_42 flake8 --extend-ignore=W191,E101,E501 tests - name: Test with pytest run: | pytest -vvv - name: Static type checking with mypy run: | mypy c_formatter_42 ================================================ FILE: .github/workflows/python-package.yml ================================================ # This workflow will install Python dependencies, run tests and lint with a variety of Python versions # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions name: CI on: push: branches: [ master ] paths-ignore: - 'setup.py' - 'setup.cfg' - 'requirements-dev.txt' - 'MANIFEST.in' - 'Img/' - 'License' - 'README.md' pull_request: branches: [ master ] paths-ignore: - 'License' - 'README.md' jobs: build: runs-on: ${{ matrix.os }} strategy: fail-fast: false matrix: os: [ubuntu-latest] # , macos-11] python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"] steps: - uses: actions/checkout@v2 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v2 with: python-version: ${{ matrix.python-version }} - name: Install dependencies run: | python -m pip install --upgrade pip python -m pip install -r requirements-dev.txt if [ -f requirements.txt ]; then pip install -r requirements.txt; fi python -m pip install -e . - name: Check formatted with black run: | black --check c_formatter_42 tests - name: Lint with flake8 run: | flake8 c_formatter_42 flake8 --extend-ignore=W191,E101,E501 tests - name: Test with pytest run: | pytest -vvv - name: Static type checking with mypy run: | mypy c_formatter_42 ================================================ FILE: .github/workflows/python-publish.yml ================================================ # This workflow will upload a Python Package using Twine when a release is created # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries # This workflow uses actions that are not certified by GitHub. # They are provided by a third-party and are governed by # separate terms of service, privacy policy, and support # documentation. name: CD on: release: types: [published] jobs: deploy: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 - name: Set up Python uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies run: | python -m pip install --upgrade pip pip install build - name: Build package run: python -m build - name: Publish package uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 with: user: __token__ password: ${{ secrets.PYPI_API_TOKEN }} ================================================ FILE: .gitignore ================================================ __pycache__ tags .tox/ *egg-info dist/ build/ docs/build/ .coverage /.venv /debug /.vimspector.json .vscode ================================================ FILE: LICENSE ================================================ GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program 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 for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . ================================================ FILE: README.md ================================================

PyPI version


# c_formatter_42 C language prettier that conforms to 42 norm v3. I know you are already a good human norm. It's just for convenience. ## Installation Requires Python3.8+ (3.9, 3.10, 3.11, 3.12) ### With pipx (recommanded) ```sh pipx run c-formatter-42 ``` ### With pip ```sh pip3 install c-formatter-42 pip3 install --user c-formatter-42 # If you don't have root privileges ``` If you're on Ubuntu 22.04 or newer (or any Debian-based system with PEP 668 enabled), you might see an error like: `error: externally-managed-environment` To fix this, add the `--break-system-packages` flag: ```sh pip3 install --break-system-packages c-formatter-42 ``` ### From source ```sh git clone https://github.com/cacharle/c_formatter_42 cd c_formatter_42 pip3 install -e . ``` ## Usage ### Command line ```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 usage: c_formatter_42 [-h] [-c] [FILE [FILE ...]] Format C source according to the norm positional arguments: FILE File to format inplace, if no file is provided read STDIN optional arguments: -h, --help show this help message and exit -c, --confirm Ask confirmation before overwriting any file ``` ## Plugins / Extensions ### Vim Check out the [`c_formatter_42.vim`](https://github.com/cacharle/c_formatter_42.vim) plugin. This plugin automatically installs the `c_formatter_42` package using pip. ### Visual Studio Code 1. Install `c_formatter_42` 1. Install the [`keyhr.42-c-format`](https://marketplace.visualstudio.com/items?itemName=keyhr.42-c-format) extension 1. Set `keyhr.42-c-format` as the default formatter for C files in `.vscode/settings.json` ```json { "[c]": { "editor.defaultFormatter": "keyhr.42-c-format" } } ``` ## 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: 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. ================================================ FILE: c_formatter_42/__init__.py ================================================ __version__ = "0.2.8" ================================================ FILE: c_formatter_42/__main__.py ================================================ #!/usr/bin/env python3 # ############################################################################ # # # # ::: :::::::: # # main.py :+: :+: :+: # # +:+ +:+ +:+ # # By: cacharle +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2020/10/04 09:53:21 by cacharle #+# #+# # # Updated: 2020/10/04 09:53:21 by cacharle ### ########.fr # # # # ############################################################################ # import argparse import sys from c_formatter_42.run import run_all def main() -> int: arg_parser = argparse.ArgumentParser( prog="c_formatter_42", description="Format C source according to the norm", formatter_class=argparse.RawTextHelpFormatter, ) arg_parser.add_argument( "-c", "--confirm", action="store_true", help="Ask confirmation before overwriting any file", ) arg_parser.add_argument( "filepaths", metavar="FILE", nargs="*", help="File to format inplace, if no file is provided read STDIN", ) args = arg_parser.parse_args() if len(args.filepaths) == 0: content = sys.stdin.read() print(run_all(content), end="") return 0 for filepath in args.filepaths: try: with open(filepath, "r") as file: content = file.read() if args.confirm: result = input(f"Are you sure you want to overwrite {filepath}?[y/N]") if result != "y": continue print(f"Writing to {filepath}") with open(filepath, "w") as file: file.write(run_all(content)) except OSError as e: print(f"Error: {e.filename}: {e.strerror}", file=sys.stderr) return 1 return 0 if __name__ == "__main__": sys.exit(main()) ================================================ FILE: c_formatter_42/data/.clang-format ================================================ --- # BasedOnStyle: LLVM --- # Language (LanguageKind) # Language, this format style is targeted at. # LK_Cpp (in configuration: Cpp) Should be used for C, C++, ObjectiveC, ObjectiveC++. Language: Cpp # TabWidth (unsigned) # The number of columns used for tab stops. TabWidth: 4 # IndentWidth (unsigned) # The number of columns to use for indentation. IndentWidth: 4 # TODO: If it can be enabled with tabs instead of spaces, it can fit 42 norm. # AlignConsecutiveDeclarations (bool) # If true, aligns consecutive declarations. # Ex) # int aaaa = 12; # float b = 23; # std::string ccc = 23; # AlignConsecutiveDeclarations: false # UseTab (UseTabStyle) # The way to use tab characters in the resulting file. # UT_ForContinuationAndIndentation (in configuration: ForContinuationAndIndentation) Use tabs only for line continuation and indentation. # UT_Always (in configuration: Always) Use tabs whenever we need to fill whitespace that spans at least from one tab stop to the next one. UseTab: ForContinuationAndIndentation # SpaceBeforeParens (SpaceBeforeParensOptions) # Defines in which cases to put a space before opening parentheses. # SBPO_ControlStatements (in configuration: ControlStatements) Put a space before opening parentheses only after control statement keywords (for/if/while...). SpaceBeforeParens: ControlStatements # AllowShortFunctionsOnASingleLine (ShortFunctionStyle) # Dependent on the value, int f() { return 0; } can be put on a single line. # SFS_None (in configuration: None) Never merge functions into a single line. AllowShortFunctionsOnASingleLine: None # Options for aligning backslashes in escaped newlines. # ENAS_Left (in configuration: Left) Align escaped newlines as far left as possible. AlignEscapedNewlines: Left # Dependent on the value, while (true) { continue; } can be put on a single line. # SBS_Never (in configuration: Never) Never merge blocks into a single line. AllowShortBlocksOnASingleLine: Never # If true, if (a) return; can be put on a single line. # SIS_Never (in configuration: Never) Never put short ifs on the same line. AllowShortIfStatementsOnASingleLine: Never # AlwaysBreakAfterDefinitionReturnType (DefinitionReturnTypeBreakingStyle) # The function definition return type breaking style to use. This option is deprecated and is retained for backwards compatibility. # DRTBS_None (in configuration: None) Break after return type automatically. PenaltyReturnTypeOnItsOwnLine is taken into account. AlwaysBreakAfterReturnType: None # AlwaysBreakBeforeMultilineStrings (bool) # If true, always break before multiline string literals. AlwaysBreakBeforeMultilineStrings: false # BinPackArguments (bool) # If false, a function call’s arguments will either be all on the same line or will have one line each. BinPackArguments: false # BinPackParameters (bool) # If false, a function declaration’s or function definition’s parameters will either all be on the same line or will have one line each. BinPackParameters: false # BreakBeforeBraces (BraceBreakingStyle) # The brace breaking style to use. # BS_Allman (in configuration: Allman) Always break before braces. BreakBeforeBraces: Allman # BreakBeforeTernaryOperators (bool) # If true, ternary operators will be placed after line breaks. BreakBeforeTernaryOperators: true # ColumnLimit (unsigned) # The column limit. ColumnLimit: 1024 # FixNamespaceComments (bool) # If true, clang-format adds missing namespace end comments and fixes invalid existing ones. # FixNamespaceComments: false # IncludeBlocks (IncludeBlocksStyle) # Dependent on the value, multiple #include blocks can be sorted as one and divided based on category. # IBS_Merge (in configuration: Merge) Merge multiple #include blocks together and sort as one. IncludeBlocks: Merge # KeepEmptyLinesAtTheStartOfBlocks (bool) # If true, the empty line at the start of blocks is kept. KeepEmptyLinesAtTheStartOfBlocks: false # MaxEmptyLinesToKeep (unsigned) # The maximum number of consecutive empty lines to keep. MaxEmptyLinesToKeep: 1 # PointerAlignment (PointerAlignmentStyle) # Pointer and reference alignment style. # PAS_Right (in configuration: Right) Align pointer to the right. PointerAlignment: Right # PenaltyBreakBeforeFirstCallParameter (unsigned) # The penalty for breaking a function call after call(. PenaltyBreakBeforeFirstCallParameter: 1 # PenaltyBreakString (unsigned) # The penalty for each line break introduced inside a string literal. PenaltyBreakString: 1 # PenaltyExcessCharacter (unsigned) # The penalty for each character outside of the column limit. PenaltyExcessCharacter: 10 PenaltyReturnTypeOnItsOwnLine: 100 # SpaceAfterCStyleCast (bool) # If true, a space is inserted after C style casts. SpaceAfterCStyleCast: false # SpaceBeforeAssignmentOperators (bool) # If false, spaces will be removed before assignment operators. SpaceBeforeAssignmentOperators: true # SpaceBeforeSquareBrackets (bool) # If true, spaces will be before [. Lambdas will not be affected. Only the first [ will get a space added. SpaceBeforeSquareBrackets: false # SpaceInEmptyParentheses (bool) # If true, spaces may be inserted into (). SpaceInEmptyParentheses: false # SpacesInCStyleCastParentheses (bool) # If true, spaces may be inserted into C style casts. SpacesInCStyleCastParentheses: false # SpacesInParentheses (bool) # If true, spaces will be inserted after ( and before ). SpacesInParentheses: false # SpacesInSquareBrackets (bool) # If true, spaces will be inserted after [ and before ]. Lambdas without arguments or unspecified size array declarations will not be affected. SpacesInSquareBrackets: false AlignOperands: false Cpp11BracedListStyle: true #InsertTrailingCommas: Wrapped # vim:ft=yaml ================================================ FILE: c_formatter_42/data/__init__.py ================================================ ================================================ FILE: c_formatter_42/formatters/__init__.py ================================================ ================================================ FILE: c_formatter_42/formatters/align.py ================================================ # ############################################################################ # # # # ::: :::::::: # # align.py :+: :+: :+: # # +:+ +:+ +:+ # # By: cacharle +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2020/10/04 09:56:31 by cacharle #+# #+# # # Updated: 2021/02/11 20:13:11 by charles ### ########.fr # # # # ############################################################################ # from __future__ import annotations import re import typing if typing.TYPE_CHECKING: from typing import Literal from c_formatter_42.formatters import helper TYPEDECL_OPEN_REGEX = re.compile( r"""^(?P\s*(typedef\s+)? # Maybe a typedef (struct|enum|union)) # Followed by a struct, enum or union \s*(?P[a-zA-Z_]\w+)?$ # Name of the type declaration """, re.X, ) TYPEDECL_CLOSE_REGEX = re.compile( r"""^(?P\})\s* # Closing } followed by any amount of spaces (?P([a-zA-Z_]\w+)?;)$ # Name of the type (if typedef used) """, re.X, ) 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") # select regex according to scope if scope == "local": align_regex = "^\t" r"(?P{type})\s+" r"(?P\**{decl};)$" elif scope == "global": align_regex = ( r"^(?P{type})\s+" r"(?P({name}\(.*\)?;?)|({decl}(;|(\s+=\s+.*))))$" ) align_regex = align_regex.format( type=helper.REGEX_TYPE, name=helper.REGEX_NAME, decl=helper.REGEX_DECL_NAME ) 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(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 == "global": in_type_scope = False for i, line in enumerate(lines): 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 = TYPEDECL_CLOSE_REGEX.match(line) if m is not None: in_type_scope = False if line != "};": aligned.append((i, m.group("prefix"), m.group("suffix"))) continue if in_type_scope: m = re.match( r"^(?P\s+{type})\s+" r"(?P\**{decl};)$".format( type=helper.REGEX_TYPE, decl=helper.REGEX_DECL_NAME ), line, ) if m is not None: aligned.append((i, m.group("prefix"), m.group("suffix"))) # Minimum alignment required for each line min_alignment = max( (len(prefix.expandtabs(4)) // 4 + 1 for _, prefix, _ in aligned), default=1 ) for i, prefix, suffix in aligned: alignment = len(prefix.expandtabs(4)) // 4 lines[i] = prefix + "\t" * (min_alignment - alignment) + suffix 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="local") def align(content: str) -> str: """Align the content in global and local scopes""" content = align_scope(content, scope="global") content = align_local(content) return content ================================================ FILE: c_formatter_42/formatters/clang_format.py ================================================ # ############################################################################ # # # # ::: :::::::: # # clang_format.py :+: :+: :+: # # +:+ +:+ +:+ # # By: cacharle +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2020/10/04 10:40:07 by cacharle #+# #+# # # Updated: 2021/02/25 20:46:18 by cacharle ### ########.fr # # # # ############################################################################ # import contextlib import platform import subprocess import sys from pathlib import Path import c_formatter_42.data CONFIG_FILENAME = Path(".clang-format") DATA_DIR = Path(c_formatter_42.data.__file__).parent @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 then put back in place after clang-format is done running """ config_path = DATA_DIR / CONFIG_FILENAME previous_config = None try: CONFIG_FILENAME.symlink_to(config_path) except FileExistsError: if not CONFIG_FILENAME.is_symlink(): previous_config = CONFIG_FILENAME.read_text() CONFIG_FILENAME.unlink() CONFIG_FILENAME.symlink_to(config_path) try: yield finally: CONFIG_FILENAME.unlink() if previous_config is not None: CONFIG_FILENAME.write_text(previous_config) if sys.platform == "linux": CLANG_FORMAT_EXEC = DATA_DIR / "clang-format-linux" elif sys.platform == "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: raise NotImplementedError("Your platform is not supported") def clang_format(content: str) -> str: """Wrapper around clang-format Pass content on stdin and return stdout. The clang-format executable is selected according to the platform, this is to keep the same version of clang-format accross all setup. """ with _config_context(): process = subprocess.Popen( [CLANG_FORMAT_EXEC, "-style=file"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE, ) out, err = process.communicate(input=content.encode()) if process.returncode != 0: # pragma: no cover raise RuntimeError(f"clang-format error: {err.decode()}") return out.decode() ================================================ FILE: c_formatter_42/formatters/helper.py ================================================ # **************************************************************************** # # # # ::: :::::::: # # helper.py :+: :+: :+: # # +:+ +:+ +:+ # # By: leo +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2020/10/04 11:38:00 by cacharle #+# #+# # # 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|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}(\[.*\])*(\s\=\s.*)?(\)\(.*\))?".format(name=REGEX_NAME) 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 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" return re.sub( # `*?` is the non greedy version of `*` # https://docs.python.org/3/howto/regex.html#greedy-versus-non-greedy r"\)\n\{(?P.*?)\n\}\n".replace(r"\n", "\n"), replacement_func, content, flags=re.DOTALL, ) return wrapper ================================================ FILE: c_formatter_42/formatters/hoist.py ================================================ # **************************************************************************** # # # # ::: :::::::: # # hoist.py :+: :+: :+: # # +:+ +:+ +:+ # # By: leo +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2020/10/04 11:16:28 by cacharle #+# #+# # # Updated: 2023/09/22 16:16:01 by leo ### ########.fr # # # # **************************************************************************** # import re import c_formatter_42.formatters.helper as helper DECLARATION_REGEX = re.compile( r"^\s*{t}\s+{d};$".format(t=helper.REGEX_TYPE, d=helper.REGEX_DECL_NAME) ) @helper.locally_scoped def hoist(content: str) -> str: r"""Hoist local variable and split assigned declaration Assignment splitting: { { int a = 1; => int a; a = 1; } } Variable hoisting: { { puts("bonjour"); int a; int a; => char b; char b; puts("bonjour"); } } Only one empty line after declarations { { int a; int a; char b; puts("bonjour"); -> puts("bonjour"); char b; } } """ input_lines = content.split("\n") lines = [] # Split assignment for line in input_lines: m = re.match( r"^(?P\s+)" r"(?P{t})\s+" r"(?P{d})\s+=\s+" r"(?P.+);$".format(t=helper.REGEX_TYPE, d=helper.REGEX_DECL_NAME), line, ) # If line is a declaration + assignment on the same line, # create 2 new lines, one for the declaration and one for the assignment # NOTE: edge case for array declarations which can't be hoisted (See #56) if ( m is not None and re.match(r".*\[.*\].*", m.group("name")) is None and re.match(r"\s*(const|static)\s.*", line) is None ): lines.append(f"\t{m.group('type')}\t{m.group('name')};") lines.append( "{}{} = {};".format( m.group("indent"), m.group("name").replace("*", ""), # replace '*' for pointers m.group("value"), ) ) else: lines.append(line) # Split declarations from body and remove empty lines declarations = [line for line in lines if DECLARATION_REGEX.match(line) is not None] body = [line for line in lines if line not in declarations and line != ""] lines = declarations if len(declarations) != 0: lines.append("") lines.extend(body) return "\n".join(lines) ================================================ FILE: c_formatter_42/formatters/line_breaker.py ================================================ import re from c_formatter_42.formatters import helper def line_breaker(content: str, column_limit: int = 80) -> str: lines = content.split("\n") lines = [insert_break(line, column_limit) for line in lines] return "\n".join(lines) def insert_break(line: str, column_limit: int) -> str: if line_length(line) <= column_limit: return line # Break at all breakable spaces (space after comma or space before binary # operators or logical AND or OR) breakable_space_pattern = r"((?<=,) | (?=[+\-*/%]|\|\||&&)(?!\*+\S|\+\+|\-\-))" line = re.sub(breakable_space_pattern, "\n", line) segments = line.split("\n") line_indent_level = indent_level(line) nest_indent_level = additional_nest_indent_level(line) # Join as many segments as it doesn't exceed line length limit line = segments[0] current_line_length = line_length(segments[0]) for segment in segments[1:]: current_line_length += line_length(segment) + 1 if current_line_length > column_limit: tabulation = "\t" * ( line_indent_level + additional_indent_level(line, nest_indent_level) ) line = ("\n" + tabulation).join([line, segment]) current_line_length = line_length(tabulation + segment) else: line = " ".join([line, segment]) return line def parenthesis_depth(s: str) -> int: paren_depth = 0 # sq == single quote # dq == double quote is_surrounded_sq = False is_surrounded_dq = False for c in s: if c == "'" and not is_surrounded_dq: is_surrounded_sq = not is_surrounded_sq elif c == '"' and not is_surrounded_sq: is_surrounded_dq = not is_surrounded_dq elif c == "(" and not is_surrounded_sq and not is_surrounded_dq: paren_depth += 1 elif c == ")" and not is_surrounded_sq and not is_surrounded_dq: paren_depth -= 1 return paren_depth # The additional indent level increases in proportion to the corresponding parentheses depth # # Examples: # ----------------------------------------------------------------------------------- # foo() * bar() * baz() # ~~~~~~~~~~~~~^~~~~~~~ When line breaks here, # foo() * bar() # > * baz() Next line should be indented with 1 tab (default) # ----------------------------------------------------------------------------------- # foo(bar() * baz()) # ~~~~~~~~~^~~~~~~~~ When line breaks here, # foo(bar() # > * baz()) Next line should be indented with 1 tab (paren depth is 1) # ----------------------------------------------------------------------------------- # (foo(bar() * baz())) # ~~~~~~~~~~^~~~~~~~~~ When line breaks here, # (foo(bar() # > > * baz())) Next line should be indented with 2 tabs (paren depth is 2) # ----------------------------------------------------------------------------------- def additional_indent_level(s: str, nest_indent_level: int = 0) -> int: paren_depth = parenthesis_depth(s) return nest_indent_level + paren_depth if paren_depth > 0 else 1 def additional_nest_indent_level(line: str) -> int: # An exceptional rule for variable assignment # https://github.com/42School/norminette/blob/921b5e22d991591f385e1920f7e7ee5dcf71f3d5/norminette/rules/check_assignation_indent.py#L59 is_assignation = False is_surrounded_sq = False is_surrounded_dq = False for index, c in enumerate(line): if c == "'" and not is_surrounded_dq: is_surrounded_sq = not is_surrounded_sq elif c == '"' and not is_surrounded_sq: is_surrounded_dq = not is_surrounded_dq is_assignation = ( c == "=" and not is_surrounded_sq and not is_surrounded_dq and parenthesis_depth(line[:index]) == 0 ) if is_assignation: break return 1 if is_assignation else 0 def line_length(line: str) -> int: return len(line.expandtabs(4)) def indent_level(line: str) -> int: # An exceptional rule for function declaration # https://github.com/42School/norminette/blob/921b5e22d991591f385e1920f7e7ee5dcf71f3d5/norminette/rules/check_assignation_indent.py#L61 align_pattern = r"^(static\s+)?{type}\s+{name}\((.|\n)*?\);$" align_pattern = align_pattern.format(type=helper.REGEX_TYPE, name=helper.REGEX_NAME) if re.match(align_pattern, line): last_tab_index = line.rfind("\t") if last_tab_index == -1: return 0 return line_length(line[: last_tab_index + 1]) // 4 return line.count("\t") ================================================ FILE: c_formatter_42/formatters/misc.py ================================================ # ############################################################################ # # # # ::: :::::::: # # misc.py :+: :+: :+: # # +:+ +:+ +:+ # # By: charles +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2021/02/07 14:39:26 by charles #+# #+# # # Updated: 2021/02/07 21:16:03 by charles ### ########.fr # # # # ############################################################################ # import re def parenthesize_return(content: str) -> str: return re.sub( r"return\s+(?!;)(?!\(.*\);)(?P\(?.*?)\s*;", lambda match: f"return ({match.group('value').strip()});", content, re.DOTALL, ) def space_before_semi_colon(content: str) -> str: return re.sub( r"(?Preturn|break|continue);", lambda match: match.group("keyword") + " ;", content, ) def remove_multiline_condition_space(content: str) -> str: return re.sub( r"(?P\t+) {1,3}(?P.*)", lambda match: f"{match.group('tabs')}\t{match.group('rest')}", content, ) def insert_void(content: str) -> str: return re.sub( r"(?P[0-9a-zA-Z_]+\t+\**[0-9a-zA-Z_]*\s*)\(\s*\)", lambda match: f"{match.group('funcdef')}(void)", content, ) ================================================ FILE: c_formatter_42/formatters/preprocessor_directive.py ================================================ # ############################################################################ # # # # ::: :::::::: # # preprocessor_directive.py :+: :+: :+: # # +:+ +:+ +:+ # # By: charles +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2021/02/07 15:40:37 by charles #+# #+# # # Updated: 2021/02/07 16:21:25 by charles ### ########.fr # # # # ############################################################################ # import re def preprocessor_directive(content: str) -> str: lines = content.split("\n") directive_regex = r"^\#\s*(?P[a-z]+)\s?(?P.*)$" directive_lines = [re.match(directive_regex, line) for line in lines] idented = [ (i, match.group("name"), match.group("rest")) for i, match in enumerate(directive_lines) if match is not None ] indent = 0 for i, directive_name, directive_rest in idented: if directive_name in ["elif", "else", "endif"]: indent -= 1 lines[i] = "#" + (" " * indent) + directive_name + " " + directive_rest lines[i] = lines[i].strip() if directive_name in ["if", "ifdef", "ifndef", "elif", "else", "endif"]: indent += 1 if directive_name == "endif": indent -= 1 # If newline doesn't follows preprocessor part, insert one (See PR#44) try: lastline_index = idented[-1][0] if lines[lastline_index + 1] != "": lines.insert(lastline_index + 1, "") except IndexError: pass return "\n".join(lines) ================================================ FILE: c_formatter_42/formatters/return_type_single_tab.py ================================================ # ############################################################################ # # # # ::: :::::::: # # return_type_single_tab.py :+: :+: :+: # # +:+ +:+ +:+ # # By: charles +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2022/01/09 10:28:30 by charles #+# #+# # # Updated: 2022/01/09 10:28:30 by charles ### ########.fr # # # # ############################################################################ # import re from c_formatter_42.formatters import helper def return_type_single_tab(content: str) -> str: lines = content.split("\n") aligned = [] align_regex = r"^(?P{type})\s+" r"(?P{name}\(.*\)?[^;])$" align_regex = align_regex.format( type=helper.REGEX_TYPE, name=helper.REGEX_NAME, decl=helper.REGEX_DECL_NAME ) matches = [re.match(align_regex, line) for line in lines] aligned = [ (i, match.group("prefix"), match.group("suffix")) for i, match in enumerate(matches) if match is not None and match.group("prefix") not in ["struct", "union", "enum"] ] for i, prefix, suffix in aligned: lines[i] = f"{prefix}\t{suffix}" return "\n".join(lines) ================================================ FILE: c_formatter_42/run.py ================================================ # ############################################################################ # # # # ::: :::::::: # # run.py :+: :+: :+: # # +:+ +:+ +:+ # # By: cacharle +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2020/10/09 18:15:09 by cacharle #+# #+# # # Updated: 2021/02/11 20:12:15 by charles ### ########.fr # # # # ############################################################################ # from c_formatter_42.formatters.align import align from c_formatter_42.formatters.clang_format import clang_format from c_formatter_42.formatters.hoist import hoist from c_formatter_42.formatters.line_breaker import line_breaker from c_formatter_42.formatters.misc import ( insert_void, parenthesize_return, remove_multiline_condition_space, space_before_semi_colon, ) from c_formatter_42.formatters.preprocessor_directive import preprocessor_directive from c_formatter_42.formatters.return_type_single_tab import return_type_single_tab def run_all(content: str) -> str: """Run all formatters""" content = clang_format(content) content = preprocessor_directive(content) content = remove_multiline_condition_space(content) content = parenthesize_return(content) content = space_before_semi_colon(content) content = hoist(content) content = align(content) content = return_type_single_tab(content) content = insert_void(content) content = line_breaker(content) return content ================================================ FILE: docs/Makefile ================================================ # Minimal makefile for Sphinx documentation # # You can set these variables from the command line, and also # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build SOURCEDIR = source BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) .PHONY: help Makefile # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) ================================================ FILE: docs/make.bat ================================================ @ECHO OFF pushd %~dp0 REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) set SOURCEDIR=source set BUILDDIR=build if "%1" == "" goto help %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( echo. echo.The 'sphinx-build' command was not found. Make sure you have Sphinx echo.installed, then set the SPHINXBUILD environment variable to point echo.to the full path of the 'sphinx-build' executable. Alternatively you echo.may add the Sphinx directory to PATH. echo. echo.If you don't have Sphinx installed, grab it from echo.http://sphinx-doc.org/ exit /b 1 ) %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% goto end :help %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% :end popd ================================================ FILE: docs/source/conf.py ================================================ # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('.')) # -- Project information ----------------------------------------------------- project = "c_formatter_42" copyright = "2021, dawnbeen" author = "dawnbeen" # The full version, including alpha/beta/rc tags release = "1.0" # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = "python" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [] # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = "alabaster" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] ================================================ FILE: docs/source/index.rst ================================================ .. c_formatter_42 documentation master file, created by sphinx-quickstart on Sat Feb 27 19:28:53 2021. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. Welcome to c_formatter_42's documentation! ========================================== .. toctree:: :maxdepth: 2 :caption: Contents: Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` ================================================ FILE: requirements-dev.txt ================================================ pytest pytest-clarity pytest-cov pytest-timeout pytest-cov pytest-timeout six pytest-clarity mypy mypy-extensions flake8 flake8-comprehensions tox black isort ================================================ FILE: setup.cfg ================================================ [bumpversion] current_version = 0.2.8 tag = true commit = true [bumpversion:file:setup.cfg] [bumpversion:file:c_formatter_42/__init__.py] parse = __version__ = (?P\d+)\.(?P\d+)\.(?P\d+) [metadata] name = c_formatter_42 version = 0.2.8 description = formatting tool complient with 42 school's norm long_description = file: README.md long_description_content_type = text/markdown url = https://github.com/dawnbeen/c_formatter_42 project_urls = Tracker = https://github.com/dawnbeen/c_formatter_42/issues classifiers = Programming Language :: Python :: 3.7 Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.9 Programming Language :: Python :: 3.10 Programming Language :: Python :: 3.11 Programming Language :: Python :: 3.12 Programming Language :: C Intended Audience :: Developers Environment :: Console Operating System :: Microsoft :: Windows Operating System :: MacOS Operating System :: POSIX :: Linux [options] packages = find: python_requires = >=3.7 [options.package_data] * = data/* data/.* [options.exclude_package_data] c_formatter_42 = test_* [options.entry_points] console_scripts = c_formatter_42 = c_formatter_42.__main__:main [flake8] ignore = E221,W503,E241 select = E,F,W,C4,N max-line-length = 100 [mypy] check_untyped_defs = true disallow_incomplete_defs = true [tool:pytest] testpaths = tests addopts = --cov=c_formatter_42 --cov-report=term-missing [coverage:run] source = c_formatter_42 [coverage:report] exclude_lines = pragma: no cover sys.platform NotImplementedError [tool:isort] profile = black ================================================ FILE: setup.py ================================================ # -*- coding: utf-8 -*- import os import sys import setuptools sys.path.insert(0, os.path.join(os.path.dirname(__file__), "c_formatter_42")) # noqa setuptools.setup() ================================================ FILE: tests/formatters/test_align.py ================================================ # **************************************************************************** # # # # ::: :::::::: # # test_align.py :+: :+: :+: # # +:+ +:+ +:+ # # By: leo +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2020/10/04 12:19:45 by cacharle #+# #+# # # Updated: 2023/09/23 11:06:39 by leo ### ########.fr # # # # **************************************************************************** # import pytest from c_formatter_42.formatters.align import align, align_local, align_scope def test_align_global_basic(): output = """\ int\t\tfoo(); char\tbar(); """ assert output == align_scope( """\ int foo(); char bar(); """, scope="global", ) assert output == align_scope( """\ int\t\t\t\t\t\tfoo(); char bar(); """, scope="global", ) assert output == align_scope( """\ int\t\t\t \t\t\tfoo(); char \t bar(); """, scope="global", ) assert output == align_scope( """\ int\t\t\t \t\t\tfoo(); char \t bar(); """, scope="global", ) def test_align_local_basic(): output = """ int foo() { \tint\t\tfoo; \tchar\tbar; } """ assert output == align_local( """ int foo() { \tint foo; \tchar bar; } """ ) assert output == align_local( """ int foo() { \tint\t\t\t\t\t\tfoo; \tchar bar; } """ ) assert output == align_local( """ int foo() { \tint\t\t\t \t\t\tfoo; \tchar \t bar; } """ ) assert output == align_local( """ int foo() { \tint\t\t\t \t\t\tfoo; \tchar \t bar; } """ ) def test_align_global_prototypes_basic(): input = """ int a(); int b(); int \t\t\t\tc(); int\t\t\t\t d(); int e(); int \t\t\t\t\t\tf(); int \t\tg(); char a(); char b(); char c(); char d(); char\t\t\t\te(); char\tf(); char\t\t\t\t\t\t\tg(); uint64_t\t\t\t\t\ta(); uint64_t b(); uint64_t c(); uint64_t\t\t\t\t\t\t\t\t\t\td(); uint64_t\t\t\t\t\t\t\t\t\t\t\te(); uint64_t f(); uint64_t\tg(); """ output = """ int\t\t\ta(); int\t\t\tb(); int\t\t\tc(); int\t\t\td(); int\t\t\te(); int\t\t\tf(); int\t\t\tg(); char\t\ta(); char\t\tb(); char\t\tc(); char\t\td(); char\t\te(); char\t\tf(); char\t\tg(); uint64_t\ta(); uint64_t\tb(); uint64_t\tc(); uint64_t\td(); uint64_t\te(); uint64_t\tf(); uint64_t\tg(); """ assert output == align(input) def test_align_local_multiple_functions(): input = """ int\t\t\t\t\t\t\t\t\t\tf() { \tint a = 0; } int\t\t\t g() { \tint a; \tint b; \tint a; \tint a; \tchar a; } char\t\t\t\t\t\t\t\t\ta() { \tint a; \tint b; \tint a; \tint a; \tchar a; \tuint64_t a; } char\t\t\t\tf() { \tt_very_looooooooooooooooooooooooooooooooooooooooooooooong yo; \tint i; } char g() { } uint64_t a() { } uint64_t\t\t\tb() { } """ output = """ int\t\t\tf() { \tint\ta = 0; } int\t\t\tg() { \tint\t\ta; \tint\t\tb; \tint\t\ta; \tint\t\ta; \tchar\ta; } char\t\ta() { \tint\t\t\ta; \tint\t\t\tb; \tint\t\t\ta; \tint\t\t\ta; \tchar\t\ta; \tuint64_t\ta; } char\t\tf() { \tt_very_looooooooooooooooooooooooooooooooooooooooooooooong\tyo; \tint\t\t\t\t\t\t\t\t\t\t\t\t\t\t\ti; } char\t\tg() { } uint64_t\ta() { } uint64_t\tb() { } """ assert output == align(input) def test_align_prototypes_type_spaces(): input = """ unsigned foo(); unsigned int foo(); long foo(); long long foo(); long long int foo(); static long long int foo(); static short short int foo(); static short int foo(); """ output = """ unsigned\t\t\t\tfoo(); unsigned int\t\t\tfoo(); long\t\t\t\t\tfoo(); long long\t\t\t\tfoo(); long long int\t\t\tfoo(); static long long int\tfoo(); static short short int\tfoo(); static short int\t\tfoo(); """ assert output == align(input) def test_align_local_type_spaces(): input = """ int qq() { \tunsigned foo; \tunsigned int foo; \tlong foo; \tlong long foo; \tlong long int foo; \tstatic long long int foo; \tstatic short short int foo; \tstatic short int foo; \tregister long long int foo; \tvolatile short short int foo; } """ output = """ int\tqq() { \tunsigned\t\t\t\t\tfoo; \tunsigned int\t\t\t\tfoo; \tlong\t\t\t\t\t\tfoo; \tlong long\t\t\t\t\tfoo; \tlong long int\t\t\t\tfoo; \tstatic long long int\t\tfoo; \tstatic short short int\t\tfoo; \tstatic short int\t\t\tfoo; \tregister long long int\t\tfoo; \tvolatile short short int\tfoo; } """ assert output == align(input) def test_align_local_type_array(): input = """ int qq() { \tunsigned foo[2]; \tunsigned int foo[2][2]; \tlong foo[BUFFER_SIZE]; \tlong long foo[A][B][C]; \tlong long int foo[A][B][C]; \tstatic long long int foo[A][B][C][A][B][C][A][B][C][A][B][C][A][B][C][A][B][C][A][B][C][A][B]; \tstatic short short int foo[1][2][3][1][2][3][1][2][3][1][2][3][1][2][3][1][2][3][1][2][3][1]; \tregister long long int foo[10000000000000000000000000000000000000000]; \tvolatile short short int foo[AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA]; \tvolatile short short int foo[TEST + 1]; \tvolatile short short int foo[TEST - 1]; \tvolatile short short int foo[TEST * 1]; \tvolatile short short int foo[TEST / 1]; \tvolatile short short int foo[TEST == 0 ? 1 : 0]; } """ output = """ int\tqq() { \tunsigned\t\t\t\t\tfoo[2]; \tunsigned int\t\t\t\tfoo[2][2]; \tlong\t\t\t\t\t\tfoo[BUFFER_SIZE]; \tlong long\t\t\t\t\tfoo[A][B][C]; \tlong long int\t\t\t\tfoo[A][B][C]; \tstatic long long int\t\tfoo[A][B][C][A][B][C][A][B][C][A][B][C][A][B][C][A][B][C][A][B][C][A][B]; \tstatic short short int\t\tfoo[1][2][3][1][2][3][1][2][3][1][2][3][1][2][3][1][2][3][1][2][3][1]; \tregister long long int\t\tfoo[10000000000000000000000000000000000000000]; \tvolatile short short int\tfoo[AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA]; \tvolatile short short int\tfoo[TEST + 1]; \tvolatile short short int\tfoo[TEST - 1]; \tvolatile short short int\tfoo[TEST * 1]; \tvolatile short short int\tfoo[TEST / 1]; \tvolatile short short int\tfoo[TEST == 0 ? 1 : 0]; } """ assert output == align(input) def test_align_ptr_type(): input = """ int *ptr() { \tint *a; \tint ******a; \tint *****************a; \tchar *****************a; } int ***********ptr(); char ***********ptr(char ********************a); uint64_t ***********ptr(char ********************a); """ output = """ int\t\t\t*ptr() { \tint\t\t*a; \tint\t\t******a; \tint\t\t*****************a; \tchar\t*****************a; } int\t\t\t***********ptr(); char\t\t***********ptr(char ********************a); uint64_t\t***********ptr(char ********************a); """ assert output == align(input) def test_align_function_ptr(): input = """ int qa() { \tint *(*func)(int a, int b); \tint (*func2)(int, int); \tvoid (*func2)(int, int); \tunsigned long long int (*func2)(); \tunsigned long long int (*func2)(void*); \tunsigned long long int (*func2)(void**********); } """ output = """ int\tqa() { \tint\t\t\t\t\t\t*(*func)(int a, int b); \tint\t\t\t\t\t\t(*func2)(int, int); \tvoid\t\t\t\t\t(*func2)(int, int); \tunsigned long long int\t(*func2)(); \tunsigned long long int\t(*func2)(void*); \tunsigned long long int\t(*func2)(void**********); } """ assert output == align(input) def test_align_function_ptr_array(): input = """ int qa() { \tint *(*func[2])(int a, int b); \tint (*func2[A])(int, int); \tvoid (*func2[11111111111110000000000000000000])(int, int); \tunsigned long long int (*func2[aaaaaaaaaaaaaaaaaaaaaaaaaa])(); } """ output = """ int\tqa() { \tint\t\t\t\t\t\t*(*func[2])(int a, int b); \tint\t\t\t\t\t\t(*func2[A])(int, int); \tvoid\t\t\t\t\t(*func2[11111111111110000000000000000000])(int, int); \tunsigned long long int\t(*func2[aaaaaaaaaaaaaaaaaaaaaaaaaa])(); } """ assert output == align(input) def test_align_global_variable(): input = """ int g_a = 1; char f(); """ output = """ int\t\tg_a = 1; char\tf(); """ assert output == align(input) def test_align_number_label(): input = """ uint64_t foo64() { \tuint64_t foo64; \tc5 foo65; } """ output = """ uint64_t\tfoo64() { \tuint64_t\tfoo64; \tc5\t\t\tfoo65; } """ assert output == align(input) def test_align_underscore(): input = """ ____ ___() { \t______ __fgffd234__; \t_ ____; } """ output = """ ____\t___() { \t______\t__fgffd234__; \t_\t\t____; } """ print(align(input)) assert output == align(input) def test_align_struct(): input = """ struct s_bonjour { \tint a; \tchar b; }; int f(); """ output = """ struct\t\ts_bonjour { \tint\t\ta; \tchar\tb; }; int\t\t\tf(); """ assert output == align(input) def test_align_enum(): input = """ enum e_bonjour { \tBONJOUR_A, \tBONJOUR_B, }; int f(); """ output = """ enum\te_bonjour { \tBONJOUR_A, \tBONJOUR_B, }; int\t\tf(); """ assert output == align(input) def test_align_union(): input = """ union u_bonjour { \tint a; \tchar b; }; int f(); """ output = """ union\t\tu_bonjour { \tint\t\ta; \tchar\tb; }; int\t\t\tf(); """ assert output == align(input) def test_align_typedef(): input = """ typedef struct s_bonjour { \tint a; \tchar b; } t_bonjour; int f(); """ output = """ typedef struct s_bonjour { \tint\t\ta; \tchar\tb; }\t\t\tt_bonjour; int\t\t\tf(); """ assert output == align(input) input = """ typedef enum e_bonjour { \tBONJOUR_A, \tBONJOUR_B, } t_bonjour; int f(); """ output = """ typedef enum e_bonjour { \tBONJOUR_A, \tBONJOUR_B, }\tt_bonjour; int\tf(); """ assert output == align(input) input = """ typedef union u_bonjour { \tint a; \tchar b; } t_bonjour; int f(); """ output = """ typedef union u_bonjour { \tint\t\ta; \tchar\tb; }\t\t\tt_bonjour; int\t\t\tf(); """ assert output == align(input) def test_align_typedef_anonymous(): input = """ typedef struct { \tint a; \tchar b; } t_bonjour; int f(); """ output = """ typedef struct { \tint\t\ta; \tchar\tb; }\t\t\tt_bonjour; int\t\t\tf(); """ assert output == align(input) input = """ typedef enum { \tBONJOUR_A, \tBONJOUR_B, } t_bonjour; int f(); """ output = """ typedef enum { \tBONJOUR_A, \tBONJOUR_B, }\tt_bonjour; int\tf(); """ assert output == align(input) input = """ typedef union { \tint a; \tchar b; } t_bonjour; int f(); """ output = """ typedef union { \tint\t\ta; \tchar\tb; }\t\t\tt_bonjour; int\t\t\tf(); """ assert output == align(input) @pytest.mark.skip() def test_align_nested_typedecl(): input = """ struct s_bonjour { \tint a; \tchar b; \tunion \t{ \t\tint a; \t\tchar b; \t} u; }; int f(); """ output = """ struct\t\t\ts_bonjour { \tint\t\t\ta; \tchar\t\tb; \tunion \t{ \t\tint\t\ta; \t\tchar\tb; \t}\t\t\tu; }; int\t\t\t\tf(); """ assert output == align(input) def test_align_struct_field_array(): input = """ struct s_bonjour { \tint a[1]; \tchar b[0][1][2][ASDF + 1]; }; int f(); """ output = """ struct\t\ts_bonjour { \tint\t\ta[1]; \tchar\tb[0][1][2][ASDF + 1]; }; int\t\t\tf(); """ assert output == align(input) def test_align_struct_field_func_ptr(): input = """ struct s_bonjour { \tint *(*a[1])(int); \tchar (*b[0][1][2][ASDF])(int a, char buf[2048], t_type); }; int f(); """ output = """ struct\t\ts_bonjour { \tint\t\t*(*a[1])(int); \tchar\t(*b[0][1][2][ASDF])(int a, char buf[2048], t_type); }; int\t\t\tf(); """ assert output == align(input) def test_align_struct_field_array_func_ptr(): input = """ struct s_bonjour { \tint *(*a[1])(int); \tchar (*b[0][1][2][ASDF])(int a, char buf[2048], t_type); }; int f(); """ output = """ struct\t\ts_bonjour { \tint\t\t*(*a[1])(int); \tchar\t(*b[0][1][2][ASDF])(int a, char buf[2048], t_type); }; int\t\t\tf(); """ assert output == align(input) def test_align_struct_singleton(): input = """ struct s_bonjour; int f(); char f2(); """ output = """ struct s_bonjour; int\t\tf(); char\tf2(); """ assert output == align(input) def test_align_union_singleton(): input = """ union s_bonjour; int f(); char f2(); """ output = """ union s_bonjour; int\t\tf(); char\tf2(); """ assert output == align(input) def test_align_enum_singleton(): input = """ enum s_bonjour; int f(); char f2(); """ output = """ enum s_bonjour; int\t\tf(); char\tf2(); """ assert output == align(input) def test_align_multiline_func_decl(): input = """ t_parsed *parse_pipeline(t_tok_lst *input) static t_parsed *st_parse_op_build( \t\t\tt_parsed *left, t_parsed *right, enum e_tok sep_tag) """ output = """ t_parsed\t\t*parse_pipeline(t_tok_lst *input) static t_parsed\t*st_parse_op_build( \t\t\tt_parsed *left, t_parsed *right, enum e_tok sep_tag) """ assert output == align(input) def test_align_global_array(): input = """ static char *g_sep_str_lookup[] = {}; static t_parsed *st_parse_op_build(t_parsed *left) """ output = """ static char\t\t*g_sep_str_lookup[] = {}; static t_parsed\t*st_parse_op_build(t_parsed *left) """ assert output == align(input) def test_align_func_typedef(): input = """ typedef void *(*t_routine)(void *arg); unsigned long long int foo(); int bar(); """ output = """ typedef void\t\t\t*(*t_routine)(void *arg); unsigned long long int\tfoo(); int\t\t\t\t\t\tbar(); """ assert output == align(input) def test_align_array_initialization(): input = """ int\ta; static int\txs[4] = {1, 2, 3, 4}; """ output = """ int\t\t\ta; static int\txs[4] = {1, 2, 3, 4}; """ assert output == align(input) ================================================ FILE: tests/formatters/test_clang_format.py ================================================ # ############################################################################ # # # # ::: :::::::: # # test_clang_format.py :+: :+: :+: # # +:+ +:+ +:+ # # By: cacharle +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2020/10/05 07:37:20 by cacharle #+# #+# # # Updated: 2021/02/25 19:10:23 by cacharle ### ########.fr # # # # ############################################################################ # import os import tempfile from contextlib import contextmanager from pathlib import Path import pytest from c_formatter_42.formatters.clang_format import clang_format def test_clang_format_missing_closing_delimiter(): assert clang_format("int main() {") == "int main()\n{" assert clang_format("int main() { int fd[2; }") == "int main()\n{ int fd[2;\n}" def test_clang_format_gibberish(): assert ( clang_format("qwasfjkahskluhiouhcjkvzhxcklhvklxzhv") == "qwasfjkahskluhiouhcjkvzhxcklhvklxzhv" ) assert ( clang_format("qwa()sfahskl{}[]uhcjkvzhxcklhv[]xzhv") == "qwa() sfahskl{}[] uhcjkvzhxcklhv[] xzhv" ) def test_clang_format_empty(): assert clang_format("") == "" # def test_clang_format_dont_join_lines(): # input = """ # if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa # \t|| bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb # \t|| cccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc) # """ # output = """ # if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa || # \tbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb || # \tcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc) # """ # assert clang_format(input) == output # # input = """ # if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa || # \tbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb || # \tcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc) # """ # assert clang_format(input) == input # def test_clang_format_non_array_assignment_packing(): input = """ static char *g_sep_str_lookup[] = { \t[TAG_END] = ";", \t[TAG_OR] = "||", \t[TAG_REDIR_IN] = "<", \t[TAG_REDIR_APPEND] = ">>", \t[TAG_PARENT_CLOSE] = ")", \t[TAG_AND] = "&&", \t[TAG_PIPE] = "|", \t[TAG_REDIR_OUT] = ">", \t[TAG_PARENT_OPEN] = "(", }; """ assert clang_format(input) == input @contextmanager def change_temp_dir_context(): tempdir = tempfile.mkdtemp("c_formatter_42") current = Path.cwd() os.chdir(tempdir) yield os.chdir(current) @pytest.fixture def clang_format_config_path(): return Path(".clang-format") def test_clang_format_config_file_no_existing_config( tmp_path, clang_format_config_path ): os.chdir(tmp_path) assert not clang_format_config_path.exists() assert clang_format("int main() { return 0; }") == "int main()\n{\n\treturn 0;\n}" assert not clang_format_config_path.exists() def test_clang_format_config_file_existing_config(tmp_path, clang_format_config_path): os.chdir(tmp_path) clang_format_config_path.write_text("bonjour") assert clang_format("int main() { return 0; }") == "int main()\n{\n\treturn 0;\n}" assert clang_format_config_path.exists() assert clang_format_config_path.read_text() == "bonjour" ================================================ FILE: tests/formatters/test_hoist.py ================================================ # **************************************************************************** # # # # ::: :::::::: # # test_hoist.py :+: :+: :+: # # +:+ +:+ +:+ # # By: leo +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2020/10/04 12:29:07 by cacharle #+# #+# # # Updated: 2023/09/23 10:55:14 by leo ### ########.fr # # # # **************************************************************************** # import pytest from c_formatter_42.formatters.hoist import hoist def scoped(s): return "int foo()\n{\n" + s + "\n}\n" def test_assignment_splitting(): output = scoped("\tint\ta;\n\n\ta = 1;") assert output == hoist(scoped("\tint a = 1;")) assert output == hoist(scoped("\tint a = 1;")) assert output == hoist(scoped("\tint a = 1;")) assert output == hoist(scoped("\tint a\t\t\t\t\t\t\t\t= 1;")) assert output == hoist(scoped("\tint a =\t\t\t\t\t\t\t\t1;")) assert output == hoist(scoped("\tint a\t\t \t\t\t\t= 1;")) assert output == hoist(scoped("\tint a =\t\t\t \t\t\t1;")) def test_hoist(): output = scoped("int a;\n\nfoo();\nbar();") assert output == hoist(scoped("foo();\nbar();\nint a;")) assert output == hoist(scoped("foo();\nint a;\nbar();")) def test_remove_empty_line(): input = """ int foo() { \tint\ta; \ta = 1; \tputs("bonjour"); } """ output = """ int foo() { \tint\ta; \ta = 1; \tputs("bonjour"); } """ assert output == hoist(input) input = """ int foo() { \tputs("bonjour"); } """ output = """ int foo() { \tputs("bonjour"); } """ assert output == hoist(input) input = """ int foo() { \tint a = 1; \tputs("bonjour"); } """ output = """ int foo() { \tint\ta; \ta = 1; \tputs("bonjour"); } """ assert output == hoist(input) def test_hoist_pointer(): input = """ int foo() { \tint *a = 1; } """ output = """ int foo() { \tint\t*a; \ta = 1; } """ assert output == hoist(input) def test_hoist_ex(): output = """\ void *foo() { if () return NULL; } """ assert output == hoist( """\ void *foo() { if () return NULL; } """ ) # TODO test on weird types output = """\ void foo() { \tt_list\t*bar; \tbar = (t_list *)malloc(sizeof(t_list) * (count_elements(baz) + 1)); } """ assert output == hoist( """\ void foo() { \tt_list\t*bar = (t_list *)malloc(sizeof(t_list) * (count_elements(baz) + 1)); } """ ) def test_hoist_empty_function(): input = """ void empty_function(void) { } int **function() { \tint **tab = malloc(4 * sizeof(int *)); \tint i = -1; \twhile (++i < 4) \t{ \t\ttab[i] = malloc(4 * sizeof(int)); \t\tint j = -1; \t\twhile (++j < 4) \t\t\ttab[i][j] = i * j; \t} \treturn (tab); } """ output = """ void empty_function(void) { } int **function() { \tint\t**tab; \tint\ti; \tint\tj; \ttab = malloc(4 * sizeof(int *)); \ti = -1; \twhile (++i < 4) \t{ \t\ttab[i] = malloc(4 * sizeof(int)); \t\tj = -1; \t\twhile (++j < 4) \t\t\ttab[i][j] = i * j; \t} \treturn (tab); } """ assert output == hoist(input) def test_hoist_initializations(): input = """ void foo(void) { \tint a = 2; \tstatic int\txs[4] = {1, 2, 3, 4}; \tconst int\tb = 2; \tlong int\tc = 2; } """ output = """ void foo(void) { \tint\ta; \tstatic int\txs[4] = {1, 2, 3, 4}; \tconst int\tb = 2; \tlong int\tc; \ta = 2; \tc = 2; } """ assert output == hoist(input) @pytest.mark.skip() def test_hoist_array(): pass @pytest.mark.skip() def test_hoist_func_ptr(): pass ================================================ FILE: tests/formatters/test_line_breaker.py ================================================ from c_formatter_42.formatters.line_breaker import ( additional_indent_level, indent_level, line_breaker, ) def test_line_indent_depth_basic_1(): input = """\ \t\t\tlooooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 """ assert 3 == indent_level(input) def test_line_indent_depth_basic_2(): input = """\ looooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 """ assert 0 == indent_level(input) def test_line_indent_depth_basic_3(): input = """\ \t\t\t + 2 + 2 + 2\t """ assert 4 == indent_level(input) def test_line_indent_depth_basic_4(): input = """\ static\tint\t\ttest(); """ assert 4 == indent_level(input) def test_line_indent_depth_basic_5(): input = """\ static void\tst_merge_fields_in_curr(char *strs[3], t_tok_lst **curr, t_tok_lst *fields); """ assert 3 == indent_level(input) def test_additional_indent_level_1(): input = """\ static void\tst_merge_fields_in_curr(char *strs[3], t_tok_lst **curr, t_tok_lst *fields); """ assert 1 == additional_indent_level(input) def test_insert_line_break_basic_1(): output = """\ \t\t\tlooooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 \t\t\t\t+ 2 + 2 + 2; """ assert output == line_breaker( """\ \t\t\tlooooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2; """ ) def test_insert_line_break_basic_2(): output = """\ looooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2; """ assert output == line_breaker( """\ looooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2; """ ) def test_insert_line_break_basic_3(): output = """\ \t\t\t\treturn (fooooooooooooooooooooooooo(a, b, cccccccccccc, \t\t\t\t\t\tddddddddddddd, eeeeeeeeeeeeeeee, fffffffffffffff, \t\t\t\t\t\tgggggggggggg, hhhhhhhhhhhhhhhhhh)); """ assert output == line_breaker( """\ \t\t\t\treturn (fooooooooooooooooooooooooo(a, b, cccccccccccc, ddddddddddddd, eeeeeeeeeeeeeeee, fffffffffffffff, gggggggggggg, hhhhhhhhhhhhhhhhhh)); """ ) def test_insert_line_break_basic_4(): output = """\ void\t\tlooooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 \t\t\t+ 2 + 2 + 2; """ assert output == line_breaker( """\ void\t\tlooooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2; """ ) def test_insert_line_break_basic_5(): output = """\ int\t\tlooooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 \t\t\t+ 2 + 2; """ assert output == line_breaker( """\ int\t\tlooooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2; """ ) def test_insert_line_break_basic_6(): output = """\ int\tlooooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 \t\t+ 2 + 2; """ assert output == line_breaker( """\ int\tlooooooooooooooooooooooong = 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2 + 2; """ ) def test_insert_line_break_basic_7(): output = """\ hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh hhhhhhhhhhhhhhhh """ assert output == line_breaker( """\ hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh hhhhhhhhhhhhhhhh """ ) def test_insert_line_break_basic_8(): output = """\ hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh hhhhhhhhhhhhhhh """ assert output == line_breaker( """\ hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh hhhhhhhhhhhhhhh """ ) def test_insert_line_break_basic_9(): output = """\ hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh \t+ hhhhhhhhhhhhhh """ assert output == line_breaker( """\ hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh + hhhhhhhhhhhhhh """ ) def test_insert_line_break_basic_10(): output = "aaaa\n\t+ b" assert output == line_breaker("aaaa + b", 7) def test_insert_line_break_basic_11(): output = "aaaa\n\t- b" assert output == line_breaker("aaaa - b", 7) def test_insert_line_break_basic_12(): output = "aaaa\n\t* b" assert output == line_breaker("aaaa * b", 7) def test_insert_line_break_basic_13(): output = "aaaa\n\t/ b" assert output == line_breaker("aaaa / b", 7) def test_insert_line_break_basic_14(): output = "aaaa\n\t% b" assert output == line_breaker("aaaa % b", 7) def test_insert_line_break_basic_15(): output = "aaaa\n\t+ *b" assert output == line_breaker("aaaa + *b", 7) def test_insert_line_break_basic_16(): output = "aaaa\n\t+ b*" assert output == line_breaker("aaaa + b*", 7) def test_insert_line_break_basic_17(): output = "aaaa\n\t* *b" assert output == line_breaker("aaaa * *b", 7) def test_insert_line_break_basic_18(): output = "aaaa\n\t* b*" assert output == line_breaker("aaaa * b*", 7) def test_insert_line_break_basic_19(): output = "aaaa*\n\t* b" assert output == line_breaker("aaaa* * b", 7) def test_insert_line_break_basic_20(): output = "*aaaa\n\t* b" assert output == line_breaker("*aaaa * b", 7) def test_insert_line_break_basic_21(): output = ",\n\taaaa *b" assert output == line_breaker(", aaaa *b", 7) def test_insert_line_break_basic_22(): output = ",\n\taaaa* b" assert output == line_breaker(", aaaa* b", 7) def test_insert_line_break_basic_23(): output = "foooooo(bar\n\t* baz)" assert output == line_breaker("foooooo(bar * baz)", 7) def test_insert_line_break_basic_24(): output = "foo = foooooo(bar\n\t\t* baz);" assert output == line_breaker("foo = foooooo(bar * baz);", 18) def test_insert_line_break_basic_25(): output = "foo[i] = foooooo(bar\n\t\t* baz);" assert output == line_breaker("foo[i] = foooooo(bar * baz);", 21) def test_insert_line_break_basic_26(): output = '"EXT = TXT" + foooooo(bar\n\t* baz);' assert output == line_breaker('"EXT = TXT" + foooooo(bar * baz);', 27) def test_insert_line_break_basic_27(): input = ( '((t_cast *)it->content)->name = get_name((t_cast *)it->content, "EXT=TXT");' ) output = """((t_cast *)it->content)->name = get_name((t_cast *)it->content, \t\t\"EXT=TXT\");""" assert output == line_breaker(input, 64) def test_insert_line_break_long_function_declaration(): input = """ static void\tst_merge_fields_in_curr(char *strs[3], t_tok_lst **curr, t_tok_lst *fields); """ output = """ static void\tst_merge_fields_in_curr(char *strs[3], t_tok_lst **curr, \t\t\t\tt_tok_lst *fields); """ assert line_breaker(input) == output def test_insert_line_break_long_function_declaration_with_parens(): input = """ static void\tst_merge_fields_in_curr(char *strs[3], t_tok_lst **curr, void (*del)(void *)); """ output = """ static void\tst_merge_fields_in_curr(char *strs[3], t_tok_lst **curr, \t\t\t\tvoid (*del)(void *)); """ assert line_breaker(input) == output def test_insert_line_break_control_statement_1(): input = """\ \twhile (true + false) """ output = """\ \twhile (true \t\t+ false) """ assert line_breaker(input, 7) == output def test_insert_line_break_control_statement_2(): input = """\ \tif (true + false) """ output = """\ \tif (true \t\t+ false) """ assert line_breaker(input, 5) == output ================================================ FILE: tests/formatters/test_misc.py ================================================ # ############################################################################ # # # # ::: :::::::: # # test_misc.py :+: :+: :+: # # +:+ +:+ +:+ # # By: cacharle +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2020/10/05 14:53:05 by cacharle #+# #+# # # Updated: 2021/02/11 20:27:44 by charles ### ########.fr # # # # ############################################################################ # from c_formatter_42.formatters.misc import ( insert_void, parenthesize_return, remove_multiline_condition_space, space_before_semi_colon, ) def test_run_space_before_semi_colon(): assert "return ;" == space_before_semi_colon("return ;") assert "break ;" == space_before_semi_colon("break ;") assert "continue ;" == space_before_semi_colon("continue ;") def test_run_parenthesize_return_1(): assert "return (a);" == parenthesize_return("return a;") assert "return (a);" == parenthesize_return("return \n\na;") assert "return (a);" == parenthesize_return("return a\n\n;") assert "return (a);" == parenthesize_return("return \na\n;") assert "return (a);" == parenthesize_return("return a ;") assert "return (a);" == parenthesize_return("return \t\ta\t ;") assert "return (a);" == parenthesize_return("return a\n\t\n ;") assert "return (foo());" == parenthesize_return("return foo();") assert "return (foo());" == parenthesize_return("return \n\nfoo();") assert "return (foo());" == parenthesize_return("return foo()\n\n;") assert "return (foo());" == parenthesize_return("return \nfoo()\n;") assert "return;" == parenthesize_return("return;") assert "return ;" == parenthesize_return("return ;") assert "return ();" == parenthesize_return("return ();") assert "return (bar(a++ + ++b[34]);" == parenthesize_return( "return bar(a++ + ++b[34];" ) assert "return (func(a, b));" == parenthesize_return("return func(a, b);") assert "return ((void *)p);" == parenthesize_return("return (void *)p;") assert "\t\treturn (NULL);" == parenthesize_return("\t\treturn NULL;") def test_run_parenthesize_return_2(): output = """\ return ; return (NULL); """ assert output == parenthesize_return( """\ return ; return NULL; """ ) def test_run_space_in_condition(): input = """ while (input != NULL && input->tag & TAG_IS_STR && \t input->tag & TAG_STICK && \t input->next != NULL && input->next->tag & TAG_IS_STR) """ output = """ while (input != NULL && input->tag & TAG_IS_STR && \t\tinput->tag & TAG_STICK && \t\tinput->next != NULL && input->next->tag & TAG_IS_STR) """ assert output == remove_multiline_condition_space(input) input = """ while (input != NULL && input->tag & TAG_IS_STR && \t input->tag & TAG_STICK && \t input->next != NULL && input->next->tag & TAG_IS_STR) """ output = """ while (input != NULL && input->tag & TAG_IS_STR && \t\tinput->tag & TAG_STICK && \t\tinput->next != NULL && input->next->tag & TAG_IS_STR) """ assert output == remove_multiline_condition_space(input) input = """ while (input != NULL && input->tag & TAG_IS_STR && \t input->tag & TAG_STICK && \t input->next != NULL && input->next->tag & TAG_IS_STR) """ output = """ while (input != NULL && input->tag & TAG_IS_STR && \t\tinput->tag & TAG_STICK && \t\tinput->next != NULL && input->next->tag & TAG_IS_STR) """ assert output == remove_multiline_condition_space(input) def test_insert_void(): assert "int main()" == insert_void("int main()") assert "void func ( )" == insert_void("void func ( )") assert "int\tmain(void)" == insert_void("int\tmain()") assert "void\tfunc (void)" == insert_void("void\tfunc ( )") assert "void\t\tfunc (void)" == insert_void("void\t\tfunc ( )") assert "void\t\t*func (void)" == insert_void("void\t\t*func ( )") assert "\t(void *)foo()" == insert_void("\t(void *)foo()") assert "\tfoo()" == insert_void("\tfoo()") ================================================ FILE: tests/formatters/test_preprocessor_directive.py ================================================ # ############################################################################ # # # # ::: :::::::: # # test_preprocessor_directive.py :+: :+: :+: # # +:+ +:+ +:+ # # By: charles +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2021/02/07 15:52:25 by charles #+# #+# # # Updated: 2021/02/11 20:27:53 by charles ### ########.fr # # # # ############################################################################ # from c_formatter_42.formatters.preprocessor_directive import preprocessor_directive def test_preprocessor_directive_ifdef(): input = """ #ifdef foo #define foo 1 #endif """ output = """ #ifdef foo # define foo 1 #endif """ assert output == preprocessor_directive(input) def test_preprocessor_directive_ifndef(): input = """ #ifndef foo #define foo 1 #endif """ output = """ #ifndef foo # define foo 1 #endif """ assert output == preprocessor_directive(input) def test_preprocessor_directive_if(): input = """ #if foo #define foo 1 #endif """ output = """ #if foo # define foo 1 #endif """ assert output == preprocessor_directive(input) def test_preprocessor_directive_if_else(): input = """ #if foo #define foo 1 #else #define foo 2 #endif """ output = """ #if foo # define foo 1 #else # define foo 2 #endif """ assert output == preprocessor_directive(input) def test_preprocessor_directive_if_elif_else(): input = """ #if foo #define foo 1 #elif t1 #define foo 2 #elif t2 #define foo 3 #elif t3 #define foo 4 #else #define foo 5 #endif """ output = """ #if foo # define foo 1 #elif t1 # define foo 2 #elif t2 # define foo 3 #elif t3 # define foo 4 #else # define foo 5 #endif """ assert output == preprocessor_directive(input) def test_preprocessor_directive_random_indent(): input = """ # if foo #define foo 1 # elif t1 # define foo 2 # elif t2 # define foo 3 # elif t3 # define foo 4 # else #define foo 5 # endif """ output = """ #if foo # define foo 1 #elif t1 # define foo 2 #elif t2 # define foo 3 #elif t3 # define foo 4 #else # define foo 5 #endif """ assert output == preprocessor_directive(input) def test_preprocessor_directive_nested(): input = """ #if foo #define a 1 #if bar #define b 2 #else #define c 3 #endif #elif baz #define d 4 #elif baz #define e 5 #else #define f 6 #endif """ output = """ #if foo # define a 1 # if bar # define b 2 # else # define c 3 # endif #elif baz # define d 4 #elif baz # define e 5 #else # define f 6 #endif """ assert output == preprocessor_directive(input) def test_preprocessor_directive_nested_10(): input = """ #if a #if b #if c #if d #if e #if f #if g #if h #if i #if j #define foo 1 #endif #endif #endif #endif #endif #endif #endif #endif #endif #endif """ output = """ #if a # if b # if c # if d # if e # if f # if g # if h # if i # if j # define foo 1 # endif # endif # endif # endif # endif # endif # endif # endif # endif #endif """ assert output == preprocessor_directive(input) def test_preprocessor_1(): input = """ #include "libft.h" void *ft_function(char c) """ output = """ #include "libft.h" void *ft_function(char c) """ assert output == preprocessor_directive(input) assert output == preprocessor_directive(preprocessor_directive(input)) ================================================ FILE: tests/formatters/test_return_type_single_tab.py ================================================ # ############################################################################ # # # # ::: :::::::: # # test_return_type_single_tab.py :+: :+: :+: # # +:+ +:+ +:+ # # By: charles +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2022/01/09 10:28:30 by charles #+# #+# # # Updated: 2022/01/09 10:28:30 by charles ### ########.fr # # # # ############################################################################ # import pytest from c_formatter_42.formatters.return_type_single_tab import return_type_single_tab def test_return_type_single_tab_basic(): output = """\ int\tfoo() char\tbar() """ assert output == return_type_single_tab( """\ int foo() char bar() """ ) assert output == return_type_single_tab( """\ int\t\t\t\t\t\tfoo() char bar() """ ) assert output == return_type_single_tab( """\ int\t\t\t \t\t\tfoo() char \t bar() """ ) assert output == return_type_single_tab( """\ int\t\t\t \t\t\tfoo() char \t bar() """ ) @pytest.mark.parametrize( "content", [ """ int foo(); char bar(); """, """ int\t\t\t\t\t\tfoo(); char bar(); """, """ int\t\t\t \t\t\tfoo(); char \t bar(); """, """ int\t\t\t \t\t\tfoo(); char \t bar(); """, ], ) def test_return_type_single_tab_no_prototype(content): assert content == return_type_single_tab(content) def test_return_type_single_tab_no_func_typedef(): input = """ typedef void\t\t\t\t\t*(*t_routine)(void *arg); unsigned long long int foo(); int foo(); """ assert input == return_type_single_tab(input) ================================================ FILE: tests/test_run.py ================================================ # **************************************************************************** # # # # ::: :::::::: # # test_run.py :+: :+: :+: # # +:+ +:+ +:+ # # By: yaassila +#+ +:+ +#+ # # +#+#+#+#+#+ +#+ # # Created: 2021/02/08 19:56:48 by charles #+# #+# # # Updated: 2023/08/31 14:00:00 by yaassila ### ########.fr # # # # **************************************************************************** # import pytest from c_formatter_42.run import run_all @pytest.mark.skip() def test_run_align_break_column_max(): input = """ typedef struct\t\t\ts_tok_lst { \tchar\t\t\t\t*content; \tstruct s_tok_lst\t*next; \tenum e_tok\t\t\ttag; }\t\t\t\t\t\tt_tok_lst; t_tok_lst\t\t\t\t*tok_lst_new(enum e_tok tag, char *content); t_tok_lst\t\t\t\t*tok_lst_new_until( \t\t\t\t\t\t\tenum e_tok tag, char *content, size_t n); t_tok_lst\t\t\t\t*tok_lst_push_front( \t\t\t\t\t\t\tt_tok_lst **tokens, t_tok_lst *pushed); t_tok_lst\t\t\t\t*tok_lst_uncons(t_tok_lst **tokens); """ output = """ typedef struct\t\t\ts_tok_lst { \tchar\t\t\t\t*content; \tstruct s_tok_lst\t*next; \tenum e_tok\t\t\ttag; }\t\t\t\t\t\tt_tok_lst; t_tok_lst\t\t\t\t*tok_lst_new(enum e_tok tag, char *content); t_tok_lst\t\t\t\t*tok_lst_new_until(enum e_tok tag, \t\t\t\t\t\t\t\t\t\t\tchar *content, \t\t\t\t\t\t\t\t\t\t\tsize_t n); t_tok_lst\t\t\t\t*tok_lst_push_front(t_tok_lst **tokens, \t\t\t\t\t\t\t\t\t\t\tt_tok_lst *pushed); t_tok_lst\t\t\t\t*tok_lst_uncons(t_tok_lst **tokens); """ assert output == run_all(input) def test_run_func_decl_single_tab_and_global_aligned(): pass def test_run_long_aligned_func_decl(): # This function declaration is already aligned and should not be modified input = """ typedef struct s_foo { \tlong int\tbar; }\t\t\t\tt_foo; long int\t\tfoooooooooooooooooooooooooooooo(t_foo *foooooooo1, \t\t\t\t\tt_foo *foooooooo2, int barrrrrrrr1, int barrrrrrrr2); """ assert input == run_all(input) def test_basic(): input = """ int main(int argc, char*argv[]){ return 0; } """ output = """ int\tmain(int argc, char *argv[]) { return (0); } """ assert output == run_all(input) @pytest.mark.timeout(15) def test_function_call_in_comment(): input = """ #include "libft.h" /* The bzero() function erases the data in the n bytes of the memory starting at the location pointed to by s, by writing zeros (bytes containing '\\0') to that area. The explicit_bzero() function performs the same task as bzero(). It differs from bzero() in that it guarantees that compiler optimizations will not remove the erase operation if the compiler deduces that the operation is "un-necessary". */ void bzero(void *s, size_t n) { unsigned char *ptr_s; } """ run_all(input) ================================================ FILE: tox.ini ================================================ [tox] envlist = python3.8,python3.9,python3.10,python3.11,python3.12 distshare = {env:XDG_CACHE_HOME}/tox/distshare [testenv] deps = flake8 mypy pytest isort commands_pre = pip install -e . pip install -r requirements-dev.txt commands = black --check c_formatter_42 tests isort --check c_formatter_42 tests flake8 c_formatter_42 mypy c_formatter_42 pytest -vvv