diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
new file mode 100644
index 0000000..43f6eab
--- /dev/null
+++ b/.github/workflows/build.yml
@@ -0,0 +1,60 @@
+name: Application Build
+
+on:
+ workflow_call:
+
+permissions:
+ contents: write
+
+jobs:
+ linux-build:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Install tar
+ run: sudo apt install -y tar
+
+ - name: build
+ run: make build DEPLOY=True
+
+ - name: Create tarball
+ run: ( cd build/linux ; tar -acvf ../../application-linux.tar.gz ./* )
+
+ - name: Store Linux build
+ uses: actions/upload-artifact@v4
+ with:
+ name: linux-build
+ path: ./application-linux.tar.gz
+
+ windows-build_x86:
+ runs-on: windows-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Config MSYS2 for UCRT64
+ uses: msys2/setup-msys2@v2
+ with:
+ msystem: UCRT64
+ update: true
+ install: >-
+ make
+ gcc
+ zip
+
+ - name: Build
+ shell: msys2 {0}
+ run: |
+ make build DEPLOY=True
+
+ - name: Compress build into zip archive
+ shell: msys2 {0}
+ run: ( cd build/windows ; zip -r ../../application-windows.zip ./* )
+
+ - name: Store Windows build
+ uses: actions/upload-artifact@v4
+ with:
+ name: windows-build
+ path: ./application-windows.zip
\ No newline at end of file
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
new file mode 100644
index 0000000..9405c74
--- /dev/null
+++ b/.github/workflows/deploy.yml
@@ -0,0 +1,42 @@
+name: Application Deployment
+
+on:
+ push:
+ branches: [ "main" ]
+
+permissions:
+ contents: write
+
+jobs:
+ build:
+ uses: ./.github/workflows/build.yml
+
+
+ deployement:
+ runs-on: ubuntu-latest
+ needs: build
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Get linux tarball
+ uses: actions/download-artifact@v4
+ with:
+ name: linux-build
+ path: ./
+
+ - name: Get windows zip archive
+ uses: actions/download-artifact@v4
+ with:
+ name: windows-build
+ path: ./
+
+ - name: Create the release
+ uses: ncipollo/release-action@v1
+ with:
+ artifacts: "./application-windows.zip,./application-linux.tar.gz"
+ commit: ${{ github.event.head_commit.id }}
+ generateReleaseNotes: true
+ makeLatest: true
+ name: "${{ github.event.repository.name }} - ${{ github.event.head_commit.message }}"
+ tag: "v${{ github.event.head_commit.id }}"
\ No newline at end of file
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
new file mode 100644
index 0000000..ca09202
--- /dev/null
+++ b/.github/workflows/test.yml
@@ -0,0 +1,58 @@
+name: Test battery
+
+on: [ pull_request ]
+
+permissions:
+ contents: write
+
+jobs:
+ pre-build:
+ name: Pre Build Check
+ strategy:
+ matrix:
+ os: [ubuntu-latest, windows-latest]
+ runs-on: ${{ matrix.os }}
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Tests
+ run: make test
+
+ build:
+ name: Check Build Chain
+ uses: ./.github/workflows/build.yml
+
+ post-build-linux:
+ name: Post Build Check On Linux
+ needs: build
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Get linux tarball
+ uses: actions/download-artifact@v4
+ with:
+ name: linux-build
+ path: ./
+
+ - name: Tests
+ run: echo insert post build tests here
+
+ post-build-windows:
+ name: Post Build Check On Windows
+ needs: build
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Get windows zip archive
+ uses: actions/download-artifact@v4
+ with:
+ name: windows-build
+ path: ./
+
+ - name: Tests
+ run: echo insert post build tests here
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 2c0823b..a858557 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,8 +1,8 @@
-#environnement related
+#~ environnement related
.git/
.vscode/
-#binaries
+#~ binaries
**.o
**.dll
**.lib
@@ -10,17 +10,15 @@
**.so
bin/**
-#files generated from makefile
-**.dep
+#build files
+build/**
+!build/assets/**
-#ignore all dist files except for the static content (all files in subfolders are presumed static content, otherwise specify the concerned files here)
-dist/*
-!dist/*/
-!dist/*/*
-
-#dev folders
+#~ dev folders
temp/**
test/**
#! put test files you want to be shared with others here
+#~ exceptions
+
!**.gitkeep
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f288702
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ 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
+.
diff --git a/Makefile b/Makefile
index a3f27a5..6fe9406 100644
--- a/Makefile
+++ b/Makefile
@@ -1,157 +1,115 @@
-#enables the makefile secondary expansion
-.SECONDEXPANSION:
-
-#~ VARIABLES
-
-#^ constants
-BIN_DIR:=./bin
-DIST_DIR:=./dist
-SRC_DIR:=./src
-SRC_EXT:=c
-HDR_EXT:=h
-OBJ_EXT:=o
-DEP_FILE:=.dep
-C:=gcc
-NODE_ARGS_FILE:=$(C).flags
-
-DEBUG_FLAGS:=-g3
-BUILD_FLAGS:=-s -O3
-
-#^ System dependent variables
-LIB_EXT:=
-DOTEXE:=
-IMP_LIB_EXT:=
-CFLAGS:=
-ifeq ($(OS),Windows_NT)
- DOTEXE+=.exe
- LIB_EXT+=dll
- IMP_LIB_EXT+=lib
- CFLAGS+=-mwindows
-else
- LIB_EXT+=so
- DOTEXE+=
- IMP_LIB_EXT+=a
-endif
-
-#^ Command specific variables
-
-ifeq ($(firstword $(MAKECMDGOALS)),build)
- CFLAGS+=$(BUILD_FLAGS)
-else
- CFLAGS+=$(DEBUG_FLAGS)
-endif
-
-#^ Processed variables
-
-EXEC_NODES:=$(shell ./scripts/getnodes.sh -E $(SRC_DIR))
-LIB_NODES:=$(shell ./scripts/getnodes.sh -L $(SRC_DIR))
-
-EXECS:=$(foreach node,$(EXEC_NODES),$(BIN_DIR)/$(shell basename $(node))$(DOTEXE))
-LIBS:=$(foreach node,$(LIB_NODES),$(BIN_DIR)/$(shell basename $(node)).$(LIB_EXT))
-
-DEP_FILES:=$(EXEC_NODES:%/=%/$(DEP_FILE)) $(LIB_NODES:%/=%/$(DEP_FILE))
-
-INCLUDE_DIRS_DIRECTIVE:=$(foreach node,$(LIB_NODES) $(EXEC_NODES),-I$(node))
-
-#~ MAIN RULES
-.PHONY: all reset debug eod_%_eod node_%
-
-all: $(DEP_FILES) $(EXECS)
-
-debug:
- @echo no debug script in debug recipe
-
-clean:
- @echo "deleting $(OBJ_EXT) files from $(BIN_DIR)..."
- @rm -f $(BIN_DIR)/*.$(OBJ_EXT)
- @echo "Done !"
-
-
-reset:
- @echo "deleting everything from $(BIN_DIR)..."
- @echo "deleting dependencies files..."
- @rm -f $(BIN_DIR)/* !.gitkeep
- @rm -f $(DEP_FILES)
- @echo "Done !"
-
-_buildreset:
- @echo "deleting binaries from $(DIST_DIR)..."
- @rm -f $(DIST_DIR)/*$(DOTEXE)
- @rm -f $(DIST_DIR)/*.$(LIB_EXT)
- @echo "Done !"
-
-build: _buildreset reset all clean
- @echo "copying output to $(DIST_DIR)..."
- @cp -f $(BIN_DIR)/*$(DOTEXE) $(DIST_DIR) 2>/dev/null || :
- @cp -f $(BIN_DIR)/*.$(LIB_EXT) $(DIST_DIR) 2>/dev/null || :
- @echo "Done !"
- @echo ""
- @echo "-------- BUILDING COMPLETE --------"
-
-
-#~ NODES SHENANIGANS
-
-#^ executable nodes
-$(EXECS): $(BIN_DIR)/%$(DOTEXE): $$(wildcard $(SRC_DIR)/$$*/*.$(SRC_EXT)) $$(wildcard $(SRC_DIR)/$$*/*.$(HDR_EXT)) $$(shell [ "$$(shell cat $(SRC_DIR)/$$*/$(DEP_FILE) 2> /dev/null)" != "" ] && cat $(SRC_DIR)/$$*/$(DEP_FILE) 2> /dev/null || echo "eod_$(SRC_DIR)/$$*/_eod")
- @echo
- @echo "------------- EXECUTABLE NODE PROCESSING START : $@ -------------"
- @echo "processed dependencies : $(foreach dep,$(filter-out eod_$(SRC_DIR)/$*/_eod,$^),$(patsubst %$(HDR_EXT),,$(patsubst %$(SRC_EXT),,$(dep))))"
- $(C) -o $@ $(wildcard $(SRC_DIR)/$*/*.$(SRC_EXT)) $(foreach file,$(foreach dep,$(filter-out eod_$(SRC_DIR)/$*/_eod,$^),$(patsubst %$(HDR_EXT),,$(patsubst %$(SRC_EXT),,$(dep)))),$(BIN_DIR)/$(file).$(LIB_EXT).$(IMP_LIB_EXT)) @$(SRC_DIR)/$*/$(NODE_ARGS_FILE) $(INCLUDE_DIRS_DIRECTIVE) $(CFLAGS)
- @echo "Done !"
-
-#^ library/binary nodes
-$(LIBS): $(BIN_DIR)/%.$(LIB_EXT): $$(wildcard $(SRC_DIR)/$$*/*.$(SRC_EXT)) $$(wildcard $(SRC_DIR)/$$*/*.$(HDR_EXT)) $$(shell [ "$$(shell cat $(SRC_DIR)/$$*/$(DEP_FILE) 2> /dev/null)" != "" ] && cat $(SRC_DIR)/$$*/$(DEP_FILE) 2> /dev/null || echo "eod_$(SRC_DIR)/$$*/_eod")
- @echo
- @echo "------------- LIBRARY/BINARY NODE PROCESSING START : $@ -------------"
- @echo "processed dependencies : $(foreach dep,$(filter-out eod_$(SRC_DIR)/$*/_eod,$^),$(patsubst %$(HDR_EXT),,$(patsubst %$(SRC_EXT),,$(dep))))"
- @if [ -d $(SRC_DIR)/$*/bin/ ]; then \
- cp -f $(SRC_DIR)/$*/bin/$(shell basename $@) $@ ; \
- cp -f $(SRC_DIR)/$*/bin/$(shell basename $@.$(IMP_LIB_EXT)) $@.$(IMP_LIB_EXT) ; \
- else \
- ( cd $(SRC_DIR)/$* ; $(C) -c $(foreach file,$(wildcard $(SRC_DIR)/$*/*.$(SRC_EXT)),$(shell basename $(file))) @$(NODE_ARGS_FILE) $(foreach dir,$(INCLUDE_DIRS_DIRECTIVE),$(dir:-I%=-I../../%)) $(CFLAGS)) ; \
- mv $(SRC_DIR)/$*/$(shell basename $(subst .$(LIB_EXT),.$(OBJ_EXT),$@)) $(subst .$(LIB_EXT),.$(OBJ_EXT),$@) ; \
- $(C) -shared -o $@ $(subst .$(LIB_EXT),.$(OBJ_EXT),$@) -Wl,--out-implib,$@.$(IMP_LIB_EXT) $(CFLAGS); \
- fi;
- @echo "Done !"
-
-#^ dependencies files
-#checks for includes in all c files of a node, keep only the ones that correspond to other nodes from the project and write them all in a file
-# also checks if a node is a binary node (binaries are to be downloaded and put in the bin/ folder of the node) and if so, checks if all the required binaries are in it
-$(DEP_FILES): %/$(DEP_FILE): $$(wildcard $$(subst /$(DEP_FILE),,$$@)/*.$(SRC_EXT))
- @echo "building $@..."
- @if ! [ -d ./$(dir $@)bin/ ]; then \
- echo $(filter-out $(shell basename $(basename $@)),$(filter $(foreach node,$(EXEC_NODES) $(LIB_NODES),$(shell basename $(node))),$(foreach file,$(shell grep -sh "#include" . $^ | grep "." | sed 's/#include //' | sed 's/ //g'),$(basename $(shell basename $(file)))))) > $@ ; \
- elif ! [ -f ./$(dir $@)bin/dependencies.lnk ]; then \
- echo "Error, no binary dependencies file nor source code in node $@" ;\
- else \
- for f in $$(tail -n+2 ./$(dir $@)bin/dependencies.lnk) ; do\
- if ! [ -f ./$(dir $@)bin/$$f ]; then \
- echo "Node $@ is dependent of file ./$(dir $@)bin/$$f which is missing, check the url in ./$(dir $@)bin/dependencies.lnk to download it"; \
- start $$(head -n 1 ./$(dir $@)bin/dependencies.lnk); \
- echo "Missing file, exiting..."; \
- exit 1; \
- fi \
- done \
- fi;
- @echo "Done !"
-
-#^ Node to file
-$(foreach node,$(EXEC_NODES),$(shell basename $(node))): %: $(BIN_DIR)/%$(DOTEXE)
-$(foreach node,$(LIB_NODES),$(shell basename $(node))): %: $(BIN_DIR)/%.$(LIB_EXT) #$(BIN_DIR)/%.$(IMP_LIB_EXT)
-
-#^ Endpoint node from a dependency perspective
-$(foreach node,$(EXEC_NODES) $(LIB_NODES),eod_$(node)_eod): %:
- @echo "$(subst eod_,,$(subst _eod,,$@)) does not have a dependencies (.dep) file, assuming end-of-dep node"
-
-#~ NODE CREATOR
-
-
-node_% node_e_%:
- @./scripts/create-node.sh -S$(SRC_DIR) $*
-
-node_l_%:
- @./scripts/create-node.sh -L -S$(SRC_DIR) $*
-
-node_b_%:
- @./scripts/create-node.sh -B -S$(SRC_DIR) $*
-
+include vars.mk
+
+.PHONY: debug all build reset clean cr rc $(OFILES)
+
+#~ RECIPES
+debug:
+ @echo "No debug script in ./Makefile"
+
+test:
+ @echo "No test script in ./Makefile"
+
+all: $(OFILES) $(LIBS) $(EXECS)
+
+build: rc
+ $(MAKE) all
+ $(MAKE) clean
+ cp -r ./$(BINDIR)/* $(BUILDDIR) ||:
+ $(IMPLIBCLEANUP)
+ cp -r ./$(ASSETDIR)/* $(BUILDDIR) ||:
+ rm -r ./$(BINDIR)/* ||:
+
+reset:
+ rm -r ./$(BINDIR)/* 2>/dev/null ||:
+ rm -r ./$(BUILDDIR)/* 2>/dev/null ||:
+
+clean:
+ @echo "cleaning up library and executable nodes..."
+ @rm -f $(foreach node,$(ENODES) $(LNODES),$(node)/*.$(DEPEXT) $(node)/*.$(PPFEXT) $(node)/*.$(ASMEXT) $(node)/*.$(OBJEXT))
+
+ @for node in $(ONODES) ; do \
+ if [ $$($(MAKE) -qC $$node clean 2>/dev/null 1>&2 ||: && echo $$?) -eq 1 ]; then \
+ echo "cleaning up $$node..."; \
+ $(MAKE) -C $$node clean ; \
+ fi \
+ done
+
+cr: rc
+rc: reset clean
+
+#make the files in the bin folder
+$(EXECS) $(LIBS): %: $(BINDIR)/%
+
+#implibs are created at the same time as their corresponding dynamic library
+$(call format_lib,%).$(SLFEXT): $(call format_lib,%)
+
+#^ executables linking
+$(foreach exe,$(EXECS),$(BINDIR)/$(exe)): $$(call libexec-to-obj,$$@,%$(DOTEXE))
+ @echo "building $@ dependencies : $(EDEP)"
+ $(if $(EDEP),$(MAKE) $(EDEP))
+ @echo "linking $^ along $(EDEP) into $@"
+ $(CC) -o $@ $^ $(call link-deps,$(EDEP)) $(call NFLAGS, $(LINKING_STEP_FLAG_ID)) $(LFLAGS)
+
+#^ libraries linking
+$(foreach lib,$(LIBS),$(BINDIR)/$(lib)): $$(call libexec-to-obj,$$@,$(call format_lib,%))
+ @echo "building $@ dependencies : $(LDEP)"
+ $(if $(LDEP),$(MAKE) $(LDEP),@echo no dep to build)
+ @echo "linking $^ along $(LDEP) into $@"
+ $(CC) -shared -o $@ $^ $(call link-deps,$(LDEP)) $(call NFLAGS, $(LINKING_STEP_FLAG_ID)) $(LFLAGS) $(CREATEIMPLIB)
+
+
+#^ object files assembling
+%.$(OBJEXT): %.$(ASMEXT)
+ @echo "Assembling $< into $@"
+ $(CC) -c -o $@ $< $(call NFLAGS, $(ASSEMBLING_STEP_FLAG_ID)) $(ASMFLAGS)
+
+#assembly files compiling
+%.$(ASMEXT): %.$(PPFEXT)
+ @echo "Compiling $< into $@"
+ $(CC) -S -o $@ $< $(call NFLAGS, $(COMPILING_STEP_FLAG_ID)) $(CMPFLAGS)
+
+#preprocessed file preprocessing :)
+%.$(PPFEXT): %.$(DEPEXT) $$(call getppfdep,$$@) # getppfdep usefull when dep file already exists to determine wether to remake it or not
+ @echo "deps : $^ $(shell cat $<)"
+ @echo "Pre-processing $(shell cat $<) into $@"
+ $(CC) -E -o $@ $(firstword $(shell cat $<)) $(call NFLAGS, $(PREPROCESSING_STEP_FLAG_ID)) $(PPFLAGS) -D$(shell echo '$(notdir $(patsubst %/,%,$(dir $*)))_EXPORT' | tr '[:lower:]' '[:upper:]')
+
+#dependency file creation
+%.$(DEPEXT): %.$(SRCEXT)
+ @echo "Fetching dependencies for $<"
+ $(CC) -MM $< $(call NFLAGS, $(DEPENDENCY_STEP_FLAG_ID)) $(PPFLAGS) | sed -z 's/ \\\n//g' | cut -f 2 -d ':' | cut -c2- > $@
+
+#catch-all rule for source and header files
+%.$(SRCEXT) %.$(HDREXT): ;
+
+#Ofiles :
+$(OFILES): %: $$(shell $(MAKE) -C$$(dir $$@) -qp 2> /dev/null | grep -w "__DEPS:=" | cut -c8-)
+ @if [ $$($(MAKE) -C$(dir $@) $$(basename $@) -n 2>/dev/null 1>&2 ||: && echo $$?) -eq 0 ]; then \
+ echo "building $@ externally" ; \
+ $(MAKE) -C$(dir $@) $$(basename $@); \
+ else \
+ echo "Error : no rule found for $$(basename $@) in $(dir $@)" ; \
+ false ; \
+ fi
+
+
+
+#~ OTHERS
+
+#node creation
+__nl_%:
+ @./$(SCRIPTDIR)/createnode.sh -L ./$(SRCDIR)/$(patsubst __nl_%,%,$@)
+
+__ne_%:
+ @./$(SCRIPTDIR)/createnode.sh -E ./$(SRCDIR)/$(patsubst __ne_%,%,$@)
+
+__no_%:
+ @./$(SCRIPTDIR)/createnode.sh -O ./$(SRCDIR)/$(patsubst __no_%,%,$@)
+
+#*checks if all required scripts are present
+ifeq (,$(wildcard $(SCRIPTDIR)/getnodes.sh))
+$(error Required shell script not found in script directory ($(SCRIPTDIR)) : getnodes.sh)
+endif
+ifeq (,$(wildcard $(SCRIPTDIR)/createnode.sh))
+$(error Required shell script not found in script directory ($(SCRIPTDIR)) : createnode.sh)
+endif
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d4006d3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,211 @@
+# C-template
+
+This is a template intended for multi-purpose C projects, that can easily be modified for C++.
+
+## Installation
+
+Clone the repo :
+```bash
+git clone https://github.com/Bitwise-re/c-template.git
+```
+Or using ssh :
+```bash
+git clone git@github.com:Bitwise-re/c-template.git
+```
+
+Then delete history :
+```bash
+rm -r .git
+git init
+```
+
+> [!TIP]
+> You can also click on `use this template` on the repo page to create a new repo based on this template.
+
+
+## Project Structure
+
+```
+/
+├── .github/
+| └── workflows
+| ├── build.yml
+| ├── deploy.yml
+| └── test.yml
+├── bin/
+├── build/
+| ├── assets/
+| ├── linux/
+| └── windows/
+├── scripts/
+| ├── createnode.sh
+| └── getnodes.sh
+├── src/
+│ └── app/
+| ├── main.c
+| └── flags.gcc
+├── temp/
+├── templates/
+| ├── lib.c
+| ├── lib.h
+| ├── main.c
+| └── onode.mk
+├── test/
+├── LICENSE
+├── Makefile
+├── README.md
+└── vars.mk
+```
+
+### Descriptions
+
+- `.github/` : Holds the repo files (workflows, issue templates, ...).
+- `bin/` : Holds the binaries created by make (.exe, .dll, .dll.a, .so, ...).
+- `build` : Holds the final product in the directory corresponding to the os used to build. The assets folder holds static files common to all os.
+- `scripts` : Holds the different shell scripts used by makefile.
+- `src` : Holds the source code organized in [nodes](#the-nodes).
+- `temp` : Holds temporary files used for developping without risking them to be uploaded to the repo.
+- `templates` : Holds templates for the [script to create nodes](./scripts/createnodes.sh)
+- `test` : Holds the testfiles use for quick tests like syntax or linking.
+- `LICENSE` : The project's license
+- `Makefile` : The main makefile, contains the recipes for the project
+- `vars.mk` : The project's makefile containing all variables and functions, can be safely imported by other makefiles (in [other nodes](#the-nodes) for instance)
+
+
+## Usage
+
+### The Nodes
+
+The source folder is structured by nodes, there are 3 types of node :
+- __Other node__ \
+Other nodes are custom nodes holding their own Makefile which should include 3 specific variables : \
+`__FILES` -> holds the files built by this node.\
+`__DEPS` -> holds the files on which depend the files above.\
+`__IMPL_LINK` -> How to implement the node's files in the linking step of another file which depend on those files. \
+A node containing a Makefile is processed as an *Other node*.
+
+- __Executable node__ \
+Executable nodes hold the source code for an executable.
+A node containing a main.c file is processed as an *Executable node*.
+- __Library node__ \
+Library nodes are holding source code for shared libraries (`.dll` on windows and `.so` on linux).
+Any node which isn't an *Executable node* nor an *Other node* is processed as a *Library node*.
+
+### The Makefiles
+
+There are 2 main Makefiles in this template : [./Makefile](https://github.com/Bitwise-re/c-template/blob/main/Makefile) wich holds the recipes and [./vars.mk](https://github.com/Bitwise-re/c-template/blob/main/vars.mk) which holds all structure related variables as well as functions for the recipes.
+
+Project structure, extensions used and flags for each step of the build chain can be found in [./vars.mk](https://github.com/Bitwise-re/c-template/blob/main/vars.mk).
+
+> [!TIP]
+> While the flags for each step of the build chain are the same for every node, you can add flags for the linking step by adding them in `{step_id}.flags`, where *step_id* can be found in [./vars.mk](https://github.com/Bitwise-re/c-template/blob/main/vars.mk).. Each flags with the prefix W_ will be used for windows builds and L_ for linux builds.
+
+### Adding files to be built
+
+To add an executable, just create a new subfolder in `./src/`containing a `main.c` file.
+Same for adding a file with custom build process : just create a new subfolder in `./src/` containing a `Makefile`.
+To add a library, create a new subfolder in `./src/` with source code in it.
+To add ressources/assets to be directly inserted in the final product's root folder, put them in `./build/assets`.
+
+> [!TIP]
+> To add new nodes, the main Makefile provides recipes :
+> | Node Type | Command |
+> | --- | --- |
+> | Executable | make \__ne\_{node_name} |
+> | Library | make \__nl\_{node_name} |
+> | Other | make \__no\_{node_name} |
+
+## The build process
+
+```mermaid
+flowchart TD;
+ START((make build)) --> RC@{ shape: procs, label: "Clean/Reset"}
+ RC --> MKA@{ shape: procs, label: "make all" }
+ MKA --> CLN@{ shape: procs, label: "Clean" }
+ CLN --> CPB@{ shape: proc, label: "Copy binaries to build folder" }
+ CPB --> CLI@{ shape: proc, label: "Remove import libraries from build folder" }
+ CLI --> CPA@{ shape: proc, label: "Copy assets to build folder" }
+ CPA --> CLB@{ shape: proc, label: "Empty bin folder" }
+ CLB --> END@{ shape: double-circle, label: "Done" }
+ CLN -..-> RCG_CLN@{ shape: f-circ, label: "Clean" }
+ subgraph RCG [ Clean/Reset ]
+ RCG_START((make cr)) --> RCG_BIN@{ shape: proc, label: "Empty bin directory" }
+ RCG_BIN --> RCG_BLD@{ shape: proc, label: "Empty build directory" }
+ RCG_BLD --> RCG_CLN
+ RCG_CLN --> RCG_FEN@{ shape: hex, label: "For each Executable and Library node" }
+ RCG_FEN -->|Next| RCG_DLD@{ shape: proc, label: "Delete dependency files" }
+ RCG_DLD --> RCG_DLI@{ shape: proc, label: "Delete pre-processor files" }
+ RCG_DLI --> RCG_DLA@{ shape: proc, label: "Delete assembly files" }
+ RCG_DLA --> RCG_DLO@{ shape: proc, label: "Delete object files" }
+ RCG_DLO --> RCG_FEN
+ RCG_FEN ---->|Done| RCG_FEON@{ shape: hex, label: "For each Other node" }
+ RCG_FEON -->|Next| RCG_CON@{ shape: procs, label: "Execute 'make clean' in the node" }
+ RCG_CON --> RCG_FEON
+ RCG_FEON -->|Done| RCG_END@{ shape: double-circle, label: "Done" }
+ end
+ subgraph MKA_G [ make all ]
+ MKA_START((make all)) --> MKA_FEN@{ shape: hex, label: "For each Node" }
+ MKA_FEN -->|Next| MKA_INO@{ shape: diamond, label: "Is it an Other node ?" }
+ MKA_INO -->|Yes| MKA_BON@{ shape: procs, label: "Build Other node" }
+ MKA_INO -->|No| MKA_BDN@{ shape: procs, label: "Build Executable/Library node" }
+ MKA_FEN ---->|Done| MKA_END@{ shape: double-circle, label: "Done" }
+
+ subgraph MKO [ Build an Other node ]
+ MKO_START(("make %")) --> MKO_GTN@{ shape: proc, label: "Get associated node" }
+ MKO_GTN --> MKO_GTD@{ shape: proc, label: "Get dependencies from the node's Makefile" }
+ MKO_GTD --> MKO_BDD@{ shape: procs, label: "Build dependencies" }
+ MKO_BDD --> MKO_BLD@{ shape: procs, label: "Execute 'make %' in the node" }
+ MKO_BLD --> MKO_END@{ shape: double-circle, label: "Done" }
+ end
+ subgraph MKN [ Build a Library/Executable node ]
+ MKN_START(("make %(.exe) / %.so(.dll)")) --> MKN_GTN@{ shape: proc, label: "Get associated node" }
+ MKN_GTN --> MKN_FEF@{ shape: hex, label: "For each source file (.c)" }
+ MKN_FEF -->|Next| MKN_CDF@{ shape: proc, label: "Create dependency file" }
+ MKN_CDF --> MKN_CIF@{ shape: proc, label: "Create pre-processor file" }
+ MKN_CIF --> MKN_CAF@{ shape: proc, label: "Create assembly file" }
+ MKN_CAF --> MKN_COB@{ shape: proc, label: "Create object file" }
+ MKN_COB --> MKN_FEF
+ MKN_FEF -->|Done| MKN_DEP@{ shape: proc, label: "Get dependencies from the node's dep files" }
+ MKN_DEP --> MKN_BDD@{ shape: procs, label: "Build dependencies" }
+ MKN_BDD --> MKN_LNK@{ shape: proc, label: "Link object files and dependencies into %" }
+ MKN_LNK --> MKN_END@{ shape: double-circle, label: "Done" }
+ end
+ MKA_BON -..-> MKO_START
+ MKA_BDN -..-> MKN_START
+ MKO_BDD -..-> MKA_START
+ MKN_BDD -..-> MKA_START
+ MKN_END -..-> MKA_FEN
+ MKO_END -..-> MKA_FEN
+ end
+ RC -..-> RCG_START
+
+ MKA -..-> MKA_START
+```
+
+## Included Github Workflows
+
+This templates comes with Github Workflows.
+- Test :
+ Triggered on PR, used to verify modifications to important branches does not bring bugs.
+ Passes the code through a series of tests, including the whole buildling process, in different environnements.
+- Build :
+ Triggered on demand by other workflows, covers the whole building process for the linux and windows app.
+- Deploy :
+ Triggered by a push on the main branch, calls the build process and package the output into a release.
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.
+
+> [!CAUTION]
+> Please make sure to update tests as appropriate.
+
+## License
+
+This project is under [GNU 3 License](https://github.com/Bitwise-re/c-template/blob/main/LICENSE)
+
+
+
+
+
diff --git a/build/assets/.gitkeep b/build/assets/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/build/linux/.gitkeep b/build/linux/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/build/other/.gitkeep b/build/other/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/build/windows/.gitkeep b/build/windows/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/scripts/create-node.sh b/scripts/create-node.sh
deleted file mode 100644
index 999fc05..0000000
--- a/scripts/create-node.sh
+++ /dev/null
@@ -1,70 +0,0 @@
-#!/bin/bash
-# script used to create a node
-# -E, -B and -L are used to specify the node type (executable, binary or library), default is executable
-# the name of the node follow the type directive
-# -S is used to specify the folder in which the nodes shall be created, default is ./
-# Caution : -S./dir/ is not the same as -S ./dir/
-#
-#
-#
-# create-node simulation -S -> creates a executable node named "simulation" in ./
-# create-node -E simulation_console -S./src/ simulation_windows -> creates executable nodes named "simulation_console" in ./ and "simulation_windows" in ./src/
-# create-node -B -S./worlds/ -L dimension1 dimension2 -E universe -> creates binary nodes named "dimension1" and "dimension2" as well as a executable node named "universe" in ./worlds/
-
-execs=""
-bins=""
-libs=""
-dir="./"
-type=0 # 0->exec | 1->lib
-
-for cmd in $@; do
- case $cmd in
- "-E")
- type=0;;
- "-L")
- type=1;;
- "-B")
- type=2;;
- "-S"*)
- dir=${cmd/#-S};;
- *)
- case $type in
- 2)
- bins="$bins $dir/$cmd";;
- 1)
- libs="$libs $dir/$cmd";;
- *)
- execs="$execs $dir/$cmd";;
- esac
- esac
-done
-
-if [ "$libs" == "" ] && [ "$execs" == "" ] && [ "$bins" == "" ]; then
- echo "Error : expected a node name"
- exit 2
-fi
-
-for node in $execs; do
- mkdir -p "$node"
- touch "$node/main.c"
- touch "$node/main.h"
- touch "$node/gcc.flags"
- echo "Created executable node : $node"
-done
-
-for node in $bins; do
- mkdir -p "$node/bin"
- touch "$node/bin/dependencies.lnk"
- touch "$node/$(basename $node).h"
- echo "Created binary node : $node"
-done
-
-for node in $libs; do
- mkdir -p "$node"
- touch "$node/$(basename $node).c"
- touch "$node/$(basename $node).h"
- touch "$node/gcc.flags"
- echo "Created library node : $node"
-done
-
-echo "Operations successfully terminated !"
\ No newline at end of file
diff --git a/scripts/createnode.sh b/scripts/createnode.sh
new file mode 100755
index 0000000..c363d73
--- /dev/null
+++ b/scripts/createnode.sh
@@ -0,0 +1,31 @@
+#!/bin/bash
+
+if ! [ 2 -eq $# ]; then
+ echo "Error: Invalid number of arguments."
+ exit 2
+fi
+
+if ! [[ "-E -L -O" =~ ( |^)$1( |$) ]]; then
+ echo "Error: Unknown argument '$1'."
+ exit 2
+fi
+
+case $1 in
+ "-O")
+ echo "creating library node $2..."
+ mkdir -p $2
+ cp ./templates/onode.mk ./$2/Makefile
+ ;;
+ "-E")
+ echo "creating library node $2..."
+ mkdir -p $2
+ cp ./templates/main.c ./$2/
+ ;;
+ "-L")
+ echo "creating library node $2..."
+ mkdir -p $2
+ cp ./templates/lib.c ./$2/
+ cp ./templates/lib.h ./$2/
+ ;;
+esac
+echo "Done"
diff --git a/scripts/getnodes.sh b/scripts/getnodes.sh
old mode 100644
new mode 100755
index b1e23a6..b0b77ff
--- a/scripts/getnodes.sh
+++ b/scripts/getnodes.sh
@@ -1,40 +1,72 @@
#!/bin/bash
# Script used to get all nodes from a folder
-# Nodes returned can be either executable nodes (-E) or library nodes (-L), default is -E
-# $1 is the folder to search for nodes in
-# Example : ./scripts/getnodes ./src/
+# Nodes returned can be either executable nodes (-E), library nodes (-L), or other nodes (-O)
+# $2 is the folder to search for nodes in
+# Example : ./scripts/getnodes.sh -E ./src/
# will return all nodes that contains source code for an executable in the directory ./src/
-# Whereas : ./scripts/getnodes -L ./src2/
+# Whereas : ./scripts/getnodes.sh -L ./src2/
# will return all nodes that contains source code for a library in the directory ./src2/
#
-# NOTE : The term "node" refers to a subfolder containing source code for either executables (executable nodes) or libraries (library nodes)
+# NOTE : The term "node" refers to a subfolder of $2
+#
+# CLASSIFICATION :
+# Nodes are classified "other" when they contain a makefile of their own at their root (protocol for other nodes is to use this makefile instead of the one for libraries or executables).
+# Nodes are classified "executable" when they contain a file named main, whatever its extension is.
+# Leftover nodes are classified "library".
+#
+# HELP : If $1 is -h, displays this message
+
+
+# -h to diplay help message
+if [ "-h" == "$1" ]; then
+ head -n 19 $0 | tail -n 18 | cut -c 5-
+ exit 0
+fi
+
+# checks if there is 2 args (filter and folder)
+if ! [ 2 -eq $# ]; then
+ echo "Error: Invalid number of arguments."
+ exit 2
+fi
+
+# checks if filter is valid
+if ! [[ "-E -L -O" =~ ( |^)$1( |$) ]]; then
+ echo "Error: Unknown argument '$1.'"
+ exit 2
+fi
-if [ 2 -gt $# ]; then
- echo "Error: Invalid number of arguments"
+# checks if search folder exists
+if ! [ -d $2 ]; then
+ echo "Error: $2 is not a valid directory."
exit 2
fi
-nodes=""
-condition=""
+#empty the node vars
+Enodes=""
+Lnodes=""
+Onodes=""
+
+for dir in $(echo $2/*/); do
+ # if makefile, then other node
+ if [ -f $dir/Makefile ] || [ -f $dir/makefile ] || [ -f $dir/GNUmakefile ]; then
+ Onodes="$Onodes $dir"
+ elif [ -n "$(ls $dir | grep -w main)" ]; then
+ Enodes="$Enodes $dir"
+ else
+ Lnodes="$Lnodes $dir"
+ fi
+done
+
case $1 in
+ "-L")
+ echo $Lnodes ;;
"-E")
- condition="main.c";;
- "-L");;
+ echo $Enodes ;;
+ "-O")
+ echo $Onodes ;;
*)
- echo "Error: Invalid argument: $1"
- exit 2;;
+ echo "Critical Error : Unexpected branching"
+ exit 1 ;;
esac
-for dir in $@; do
- if [ $dir = $1 ]; then continue; fi
- if ! [ -d $dir ] || ! [ "$(ls -A $dir)" ]; then
- continue
- fi
- for subdir in $(echo $dir/*/); do
- if [ "$(ls -l $subdir | grep main.c | tail -c 7)" = "$condition" ]; then
- nodes="$nodes $subdir"
- fi
- done
-done
-
-echo $nodes
\ No newline at end of file
+exit 0
\ No newline at end of file
diff --git a/src/.gitkeep b/src/.gitkeep
new file mode 100644
index 0000000..e69de29
diff --git a/src/app/lnk.flags b/src/app/lnk.flags
new file mode 100644
index 0000000..ab09ebf
--- /dev/null
+++ b/src/app/lnk.flags
@@ -0,0 +1 @@
+W_-mconsole
\ No newline at end of file
diff --git a/src/app/main.c b/src/app/main.c
new file mode 100644
index 0000000..af6388e
--- /dev/null
+++ b/src/app/main.c
@@ -0,0 +1,6 @@
+#include
+
+int main(){
+ printf("Hello World !\n");
+ return 0;
+}
diff --git a/templates/lib.c b/templates/lib.c
new file mode 100644
index 0000000..d028761
--- /dev/null
+++ b/templates/lib.c
@@ -0,0 +1,7 @@
+#include "lib.h"
+#include
+
+int libfun(){
+ printf("Hello From Library !");
+ return 0;
+}
diff --git a/templates/lib.h b/templates/lib.h
new file mode 100644
index 0000000..4158c35
--- /dev/null
+++ b/templates/lib.h
@@ -0,0 +1,10 @@
+#ifndef __lib_h_
+#define __lib_h_
+
+#ifndef LIBAPI
+# define LIBAPI extern
+#endif //LIBAPI
+
+LIBAPI int libfun();
+
+#endif //__lib_h_
diff --git a/templates/main.c b/templates/main.c
new file mode 100644
index 0000000..a9437ab
--- /dev/null
+++ b/templates/main.c
@@ -0,0 +1,6 @@
+#include
+
+int main(){
+ printf("Hello World !");
+ return 0;
+}
diff --git a/templates/onode.mk b/templates/onode.mk
new file mode 100644
index 0000000..d99c734
--- /dev/null
+++ b/templates/onode.mk
@@ -0,0 +1,5 @@
+include ../../vars.mk
+
+__FILES:=
+__DEPS:=
+__IMPL_LINK:=
diff --git a/vars.mk b/vars.mk
new file mode 100644
index 0000000..7119309
--- /dev/null
+++ b/vars.mk
@@ -0,0 +1,104 @@
+
+#~ MAKEFILE SPECIAL TARGETS
+
+#enables the makefile secondary expansion
+.SECONDEXPANSION: ;
+#disable implicit rules
+.SUFFIXES: ;
+#prevent make from deleting intermediates files
+.SECONDARY: ;
+
+#~ software
+CC:=gcc
+
+#~ architecture
+
+#directories
+SRCDIR:=./src
+BINDIR:=./bin
+SCRIPTDIR:=./scripts
+BUILDDIR:=./build/other
+ASSETDIR:=./build/assets/
+ifeq ($(OS),Windows_NT)
+ BUILDDIR:=./build/windows
+else
+ BUILDDIR:=./build/linux
+endif
+
+#extensions
+HDREXT:=h
+SRCEXT:=c
+DEPEXT:=d
+PPFEXT:=i
+ASMEXT:=s
+OBJEXT:=o
+SLFEXT:=a
+ifeq ($(OS),Windows_NT)
+ DOTEXE:=.exe
+ format_lib=$(1).dll
+else
+ DOTEXE:=
+ format_lib=lib$(1).so
+endif
+
+#transform a library or executable file -$(1)- into the object files produced by this node, using a special formatting for each type of file -$(2)-
+libexec-to-obj = $(patsubst %.c,%.o,$(wildcard $(SRCDIR)/$(patsubst $(2),%,$(notdir $(1)))/*.$(SRCEXT)))
+
+#get all the header files included
+define getppfdep
+$(shell cat $(patsubst %.$(PPFEXT),%.$(DEPEXT),$(1)) 2> /dev/null ||:)
+endef
+
+#create the produced files from a node, for each type of node
+node-to-execs=$(foreach node,$(1),$(shell basename $(node))$(DOTEXE))
+node-to-libs=$(foreach node,$(1),$(call format_lib,$(shell basename $(node))))
+node-to-ofiles=$(foreach node,$(1),$(foreach file,$(shell $(MAKE) -C$(node) -qp 2> /dev/null | grep -w "__FILES :=" | grep -vw "node-to-ofiles" | cut -c12-),$(node)/$(file)))
+
+#create the dependencies for and from an object file
+obj-dep=$(filter-out $(2),$(foreach dfile,$(shell find ./$(dir $(1))/ -name '*.$(DEPEXT)'),$(foreach dep,$(shell cat $(dfile) 2>/dev/null ||:),$(filter $(EXECS),$(call node-to-execs, $(dir $(dep)))) $(filter $(LIBS),$(call node-to-libs, $(dir $(dep)))) $(filter $(OFILES),$(call node-to-ofiles, ./$(dir $(dep)))))))
+
+#dependency formulas
+EDEP = $(call obj-dep,$(call libexec-to-obj,$@,%$(DOTEXE)),$(notdir $@))
+LDEP = $(call obj-dep,$(call libexec-to-obj,$@,$(call format_lib,%)),$(notdir $@))
+
+#generates all the files to link against from EDEP or LDEP -$(1)-
+pre-link-deps = $(foreach dep,$(filter $(LIBS),$(1)),$(call LINKLIB,$(dep))) $(foreach dep,$(filter-out $(LIBS) $(EXECS),$(1)),$(shell $(MAKE) -C$(dir $(dep)) -qp 2> /dev/null | grep -w "__IMPL_LINK :=" | grep -vw "link-deps" | cut -c15-))
+ifeq ($(OS),Windows_NT)
+link-deps = $(foreach file,$(call pre-link-deps,$(1)),$(BINDIR)/$(file))
+else
+link-deps = $(call pre-link-deps,$(1))
+endif
+
+#^ nodes
+LNODES:=$(shell ./scripts/getnodes.sh -L $(SRCDIR) 2> /dev/null ||:)
+ENODES:=$(shell ./scripts/getnodes.sh -E $(SRCDIR) 2> /dev/null ||:)
+ONODES:=$(shell ./scripts/getnodes.sh -O $(SRCDIR) 2> /dev/null ||:)
+ANODES:=$(LNODES) $(ENODES) $(ONODES)
+
+EXECS:=$(call node-to-execs,$(ENODES))
+LIBS:=$(call node-to-libs,$(LNODES))
+OFILES:=$(call node-to-ofiles,$(ONODES))
+
+#^flags
+PPFLAGS:=-I$(SRCDIR) $(foreach node,$(ANODES),-I$(node))
+CMPFLAGS:=-g -Wall -fPIC
+ifeq ($(OS),Windows_NT)
+ PREFLAG:=W_
+ LFLAGS:=-Lbin -mwindows -Wl,-rpath='$${ORIGIN}'
+ CREATEIMPLIB=-Wl,--out-implib,$@.$(SLFEXT)
+ LINKLIB=$(1).$(SLFEXT)
+ IMPLIBCLEANUP:=echo "removing build-purpose files..." && rm ./$(BUILDDIR)/$(call LINKLIB,$(call format_lib,*)) 2>/dev/null ||:
+else
+ PREFLAG:=L_
+ LFLAGS:=-Lbin -Wl,-rpath='$${ORIGIN}'
+ LINKLIB=-l$(patsubst $(call format_lib,%),%,$(1))
+endif
+LINKING_STEP_FLAG_ID:=lnk
+ASSEMBLING_STEP_FLAG_ID:=asm
+COMPILING_STEP_FLAG_ID:=cpl
+PREPROCESSING_STEP_FLAG_ID:=pp
+DEPENDENCY_STEP_FLAG_ID:=dep
+NFLAGS_lnk=$(patsubst $(PREFLAG)%,%,$(filter $(PREFLAG)%,$(shell echo $$(cat $(dir $^)/$(1).flags 2>/dev/null ||:))))
+
+Vdebug:
+ @echo No debug recipe in vars.mk