commit dc0759ee63bf2134425f449255795bf74abbf06b Author: Diavolo Date: Mon Jun 5 13:53:35 2023 +0200 init diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..0d29dee --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,99 @@ +name: Build + +on: + push: + branches: + - "*" + pull_request: + branches: + - "*" + types: [opened, synchronize, reopened] + +concurrency: + group: ${{ github.ref }} + cancel-in-progress: true + +jobs: + build-win: + name: Build Windows + runs-on: windows-2022 + strategy: + fail-fast: false + matrix: + configuration: + - Debug + - Release + arch: + - x64 + include: + - arch: x64 + platform: x64 + steps: + - name: Check out files + uses: actions/checkout@v3.5.2 + with: + submodules: true + fetch-depth: 0 + lfs: false + + - name: Add msbuild to PATH + uses: microsoft/setup-msbuild@v1.3.1 + + - name: Generate project files + run: cmd /C call generate.bat + + - name: Set up problem matching + uses: ammaraskar/msvc-problem-matcher@master + + - name: Build ${{matrix.configuration}} ${{matrix.arch}} binaries + run: msbuild /m /v:minimal /p:Configuration=${{matrix.configuration}} /p:Platform=${{matrix.platform}} build/iw4-validator.sln + + - name: Upload ${{matrix.configuration}} ${{matrix.arch}} binaries + uses: actions/upload-artifact@v3.1.2 + with: + name: Windows ${{matrix.configuration}} ${{matrix.arch}} binaries + path: | + build/bin/${{matrix.arch}}/${{matrix.configuration}}/iw4-validator.exe + build/bin/${{matrix.arch}}/${{matrix.configuration}}/iw4-validator.pdb + + build-linux: + name: Build Linux + runs-on: ubuntu-latest + strategy: + fail-fast: false + matrix: + configuration: + - Debug + - Release + arch: + - x64 + include: + - configuration: Debug + config: debug + - configuration: Release + config: release + steps: + - name: Check out files + uses: actions/checkout@v3.5.2 + with: + submodules: true + fetch-depth: 0 + lfs: false + + - name: Generate project files + run: ./generate.sh + + - name: Set up problem matching + uses: ammaraskar/gcc-problem-matcher@master + + - name: Build ${{matrix.configuration}} ${{matrix.arch}} binaries + run: | + pushd build + make config=${{matrix.config}}_${{matrix.arch}} -j$(nproc) + + - name: Upload ${{matrix.configuration}} ${{matrix.arch}} binaries + uses: actions/upload-artifact@v3.1.2 + with: + name: Linux ${{matrix.configuration}} ${{matrix.arch}} binaries + path: | + build/bin/${{matrix.arch}}/${{matrix.configuration}}/iw4-validator diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..765fe0c --- /dev/null +++ b/.gitignore @@ -0,0 +1,147 @@ +### Windows + +# Windows image file caches +Thumbs.db +ehthumbs.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Shortcuts +*.lnk + +### OSX + +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear on external disk +.Spotlight-V100 +.Trashes + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### Visual Studio + +# User-specific files +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +build + +# Visual Studio 2015 cache/options directory +.vs/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +*_i.c +*_p.c +*_i.h +*.ilk +*.meta +*.obj +*.pch +*.pdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!*.[Cc]ache/ + +# Others +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.pfx +*.publishsettings + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm + +# SQL Server files +*.mdf +*.ldf + +### IDA +*.id0 +*.id1 +*.id2 +*.nam +*.til + +### Custom user files +# User scripts +user*.bat 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/README.md b/README.md new file mode 100644 index 0000000..a1d46e7 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +![license](https://img.shields.io/github/license/alterware/iw4-validator.svg) +[![build](https://github.com/alterware/iw4-validator/workflows/Build/badge.svg)](https://github.com/alterware/iw4-validator/actions) + +# AlterWare: iw4-validator + You may use this tool to validate client effects GSC files for the IW4 engine diff --git a/generate.bat b/generate.bat new file mode 100644 index 0000000..561de2a --- /dev/null +++ b/generate.bat @@ -0,0 +1,3 @@ +@echo off +git submodule update --init --recursive +tools\premake5 %* vs2022 diff --git a/generate.sh b/generate.sh new file mode 100755 index 0000000..9e96289 --- /dev/null +++ b/generate.sh @@ -0,0 +1,7 @@ +#!/bin/bash +git submodule update --init --recursive +if [ "$(uname)" == "Darwin" ]; then + ./tools/premake5-mac gmake2 +else + ./tools/premake5-linux gmake2 +fi diff --git a/premake5.lua b/premake5.lua new file mode 100644 index 0000000..14fd451 --- /dev/null +++ b/premake5.lua @@ -0,0 +1,90 @@ +workspace "iw4-validator" +startproject "iw4-validator" +location "./build" +objdir "%{wks.location}/obj" +targetdir "%{wks.location}/bin/%{cfg.platform}/%{cfg.buildcfg}" + +configurations {"Debug", "Release"} + +if os.istarget("darwin") then + platforms {"x64", "arm64"} +else + platforms {"x86", "x64"} +end + +filter "platforms:x86" + architecture "x86" +filter {} + +filter "platforms:x64" + architecture "x86_64" +filter {} + +filter "platforms:arm64" + architecture "ARM64" +filter {} + +filter {"language:C++", "toolset:not msc*"} + buildoptions "-std=c++20" +filter {} + +filter "toolset:msc*" + buildoptions "/std:c++20" +filter {} + +filter {"system:windows"} + systemversion "latest" +filter {} + +symbols "On" +staticruntime "On" +editandcontinue "Off" +warnings "Extra" +characterset "ASCII" + +if os.istarget("linux") or os.istarget("darwin") then + buildoptions "-pthread" + linkoptions "-pthread" +end + +if os.getenv("CI") then + defines "CI" +end + +flags {"NoIncrementalLink", "NoMinimalRebuild", "MultiProcessorCompile", "No64BitChecks"} + +filter "configurations:Release" + optimize "Speed" + defines "NDEBUG" + flags "FatalCompileWarnings" +filter {} + +filter "configurations:Debug" + optimize "Debug" + defines {"DEBUG", "_DEBUG"} +filter {} + +project "iw4-validator" +kind "ConsoleApp" +language "C++" + +targetname "iw4-validator" + +pchheader "std_include.hpp" +pchsource "src/std_include.cpp" + +files {"./src/**.hpp", "./src/**.cpp"} + +includedirs {"./src", "%{prj.location}/src"} + +filter {"system:windows", "toolset:not msc*"} + resincludedirs { + "%{_MAIN_SCRIPT_DIR}/src" + } +filter {} + +filter {"system:windows", "toolset:msc*"} + resincludedirs { + "$(ProjectDir)src" + } +filter {} diff --git a/src/component/console.cpp b/src/component/console.cpp new file mode 100644 index 0000000..e3adc9e --- /dev/null +++ b/src/component/console.cpp @@ -0,0 +1,248 @@ +#include "std_include.hpp" +#include "console.hpp" + +#ifdef _WIN32 +#define COLOR_LOG_INFO 11 +#define COLOR_LOG_WARN 14 +#define COLOR_LOG_ERROR 12 +#define COLOR_LOG_DEBUG 15 +#else +#define COLOR_LOG_INFO "\033[0;36m" +#define COLOR_LOG_WARN "\033[0;33m" +#define COLOR_LOG_ERROR "\033[0;31m" +#define COLOR_LOG_DEBUG "\033[0m" +#endif + +namespace console +{ + namespace + { + std::mutex signal_mutex; + std::function signal_callback; + +#ifdef _WIN32 +#define COLOR(win, posix) win + using color_type = WORD; +#else +#define COLOR(win, posix) posix + using color_type = const char*; +#endif + + const color_type color_array[] = + { + COLOR(0x8, "\033[0;90m"), // 0 - black + COLOR(0xC, "\033[0;91m"), // 1 - red + COLOR(0xA, "\033[0;92m"), // 2 - green + COLOR(0xE, "\033[0;93m"), // 3 - yellow + COLOR(0x9, "\033[0;94m"), // 4 - blue + COLOR(0xB, "\033[0;96m"), // 5 - cyan + COLOR(0xD, "\033[0;95m"), // 6 - pink + COLOR(0xF, "\033[0;97m"), // 7 - white + }; + +#ifdef _WIN32 + BOOL WINAPI handler(const DWORD signal) + { + if (signal == CTRL_C_EVENT && signal_callback) + { + signal_callback(); + } + + return TRUE; + } + +#else + void handler(int signal) + { + if (signal == SIGINT && signal_callback) + { + signal_callback(); + } + } +#endif + + std::string format(va_list* ap, const char* message) + { + static thread_local char buffer[0x1000]; + +#ifdef _WIN32 + const int count = vsnprintf_s(buffer, _TRUNCATE, message, *ap); +#else + const int count = vsnprintf(buffer, sizeof(buffer), message, *ap); +#endif + + if (count < 0) return {}; + return {buffer, static_cast(count)}; + } + +#ifdef _WIN32 + HANDLE get_console_handle() + { + return GetStdHandle(STD_OUTPUT_HANDLE); + } +#endif + + void set_color(const color_type color) + { +#ifdef _WIN32 + SetConsoleTextAttribute(get_console_handle(), color); +#else + printf("%s", color); +#endif + } + + bool apply_color(const std::string& data, const size_t index, const color_type base_color) + { + if (data[index] != '^' || (index + 1) >= data.size()) + { + return false; + } + + auto code = data[index + 1] - '0'; + if (code < 0 || code > 11) + { + return false; + } + + code = std::min(code, 7); // Everything above white is white + if (code == 7) + { + set_color(base_color); + } + else + { + set_color(color_array[code]); + } + + return true; + } + + void print_colored(const std::string& line, const color_type base_color) + { + lock _{}; + set_color(base_color); + + for (std::size_t i = 0; i < line.size(); ++i) + { + if (apply_color(line, i, base_color)) + { + ++i; + continue; + } + + std::putchar(line[i]); + } + + reset_color(); + } + } + + lock::lock() + { +#ifdef _WIN32 + _lock_file(stdout); +#else + flockfile(stdout); +#endif + } + + lock::~lock() + { +#ifdef _WIN32 + _unlock_file(stdout); +#else + funlockfile(stdout); +#endif + } + + void reset_color() + { + lock _{}; +#ifdef _WIN32 + SetConsoleTextAttribute(get_console_handle(), 7); +#else + printf("\033[0m"); +#endif + + fflush(stdout); + } + + void info(const char* message, ...) + { + va_list ap; + va_start(ap, message); + + const auto data = format(&ap, message); + print_colored("[+] " + data + "\n", COLOR_LOG_INFO); + + va_end(ap); + } + + void warn(const char* message, ...) + { + va_list ap; + va_start(ap, message); + + const auto data = format(&ap, message); + print_colored("[!] " + data + "\n", COLOR_LOG_WARN); + + va_end(ap); + } + + void error(const char* message, ...) + { + va_list ap; + va_start(ap, message); + + const auto data = format(&ap, message); + print_colored("[-] " + data + "\n", COLOR_LOG_ERROR); + + va_end(ap); + } + + void log(const char* message, ...) + { + va_list ap; + va_start(ap, message); + + const auto data = format(&ap, message); + print_colored("[*] " + data + "\n", COLOR_LOG_DEBUG); + + va_end(ap); + } + + void set_title(const std::string& title) + { + lock _{}; + +#ifdef _WIN32 + SetConsoleTitleA(title.data()); +#else + printf("\033]0;%s\007", title.data()); + fflush(stdout); +#endif + } + + signal_handler::signal_handler(std::function callback) + : std::lock_guard(signal_mutex) + { + signal_callback = std::move(callback); + +#ifdef _WIN32 + SetConsoleCtrlHandler(handler, TRUE); +#else + signal(SIGINT, handler); +#endif + } + + signal_handler::~signal_handler() + { +#ifdef _WIN32 + SetConsoleCtrlHandler(handler, FALSE); +#else + signal(SIGINT, SIG_DFL); +#endif + + signal_callback = {}; + } +} diff --git a/src/component/console.hpp b/src/component/console.hpp new file mode 100644 index 0000000..f655dd0 --- /dev/null +++ b/src/component/console.hpp @@ -0,0 +1,32 @@ +#pragma once + +namespace console +{ + class lock + { + public: + lock(); + ~lock(); + + lock(lock&&) = delete; + lock(const lock&) = delete; + lock& operator=(lock&&) = delete; + lock& operator=(const lock&) = delete; + }; + + void reset_color(); + + void info(const char* message, ...); + void warn(const char* message, ...); + void error(const char* message, ...); + void log(const char* message, ...); + + void set_title(const std::string& title); + + class signal_handler : std::lock_guard + { + public: + signal_handler(std::function callback); + ~signal_handler(); + }; +} diff --git a/src/component/map_rotation.cpp b/src/component/map_rotation.cpp new file mode 100644 index 0000000..130e2c3 --- /dev/null +++ b/src/component/map_rotation.cpp @@ -0,0 +1,72 @@ +#include + +#include + +#include "map_rotation.hpp" + +using namespace std::literals; + +namespace map_rotation +{ + rotation_data::rotation_data() + : index_(0) + { + } + + void rotation_data::randomize() + { + std::random_device rd; + std::mt19937 gen(rd()); + + std::ranges::shuffle(this->rotation_entries_, gen); + } + + void rotation_data::add_entry(const std::string& key, const std::string& value) + { + this->rotation_entries_.emplace_back(std::make_pair(key, value)); + } + + bool rotation_data::contains(const std::string& key, const std::string& value) const + { + return std::ranges::any_of(this->rotation_entries_, [&](const auto& entry) + { + return entry.first == key && entry.second == value; + }); + } + + bool rotation_data::empty() const noexcept + { + return this->rotation_entries_.empty(); + } + + std::size_t rotation_data::get_entries_size() const noexcept + { + return this->rotation_entries_.size(); + } + + rotation_data::rotation_entry& rotation_data::get_next_entry() + { + const auto index = this->index_; + ++this->index_ %= this->rotation_entries_.size(); + return this->rotation_entries_.at(index); + } + + void rotation_data::parse(const std::string& data) + { + const auto tokens = utils::string::split(data, ' '); + for (std::size_t i = 0; !tokens.empty() && i < (tokens.size() - 1); i += 2) + { + const auto& key = tokens[i]; + const auto& value = tokens[i + 1]; + + if (key == "map"s || key == "gametype"s) + { + this->add_entry(key, value); + } + else + { + throw map_rotation_parse_error(); + } + } + } +} diff --git a/src/component/map_rotation.hpp b/src/component/map_rotation.hpp new file mode 100644 index 0000000..b335e05 --- /dev/null +++ b/src/component/map_rotation.hpp @@ -0,0 +1,32 @@ +#pragma once + +namespace map_rotation +{ + struct map_rotation_parse_error : public std::exception + { + [[nodiscard]] const char* what() const noexcept override { return "Map Rotation Parse Error"; } + }; + + class rotation_data + { + public: + using rotation_entry = std::pair; + + rotation_data(); + + void randomize(); + + void add_entry(const std::string& key, const std::string& value); + + [[nodiscard]] bool contains(const std::string& key, const std::string& value) const; + [[nodiscard]] bool empty() const noexcept; + [[nodiscard]] std::size_t get_entries_size() const noexcept; + [[nodiscard]] rotation_entry& get_next_entry(); + + void parse(const std::string& data); + + private: + std::vector rotation_entries_; + std::size_t index_; + }; +} diff --git a/src/game/cg_client_side_effects_mp.cpp b/src/game/cg_client_side_effects_mp.cpp new file mode 100644 index 0000000..1c07653 --- /dev/null +++ b/src/game/cg_client_side_effects_mp.cpp @@ -0,0 +1,339 @@ +#include + +#include "component/console.hpp" + +#include "cg_client_side_effects_mp.hpp" +#include "q_shared.hpp" + +#define MAX_CLIENT_ENT_SOUNDS 1024 + +#define SKIP_LINE(buffer, text) \ + if (match_line_starting_with((buffer), (text))) \ + { \ + (buffer) = skip_line_starting_with((buffer), (text)); \ + } + +#define SKIP_TEXT(buffer, text) \ + (buffer) = skip_text((buffer), (text)); \ + if (!(buffer)) \ + { \ + return false; \ + } + +#define SKIP_TEXT_PTR(buffer, text) \ + (buffer) = skip_text((buffer), (text)); \ + if (!(buffer)) \ + { \ + return nullptr; \ + } + +#define SKIP_WHITE_SPACE(buffer) \ + (buffer) = skip_white_space((buffer)); \ + if (!(buffer)) \ + { \ + return false; \ + } + +#define SKIP_WHITE_SPACE_PTR(buffer) \ + (buffer) = skip_white_space((buffer)); \ + if (!(buffer)) \ + { \ + return nullptr; \ + } + +#define PARSE_STRING_PTR(buffer, out) \ + (buffer) = parse_string_finish((buffer), (out), sizeof(out)); \ + if (!(buffer)) \ + { \ + return nullptr; \ + } + +#define PARSE_VEC3_PTR(buffer, out) \ + (buffer) = parse_vec3_finish((buffer), (out)); \ + if (!(buffer)) \ + { \ + return nullptr; \ + } + +namespace game +{ + auto client_ent_sound_count = 0; + + // Just report back to the user if there are too many + void add_client_ent_sound(const float* origin, const char* sound_alias) + { + if (client_ent_sound_count == MAX_CLIENT_ENT_SOUNDS) + { + console::error("Unable to add %s at [%.2f, %.2f, %.2f]-> Too many client ent sounds. Reduce sounds or increase MAX_CLIENT_ENT_SOUNDS (%d).\n", + sound_alias, origin[0], origin[1], origin[2], MAX_CLIENT_ENT_SOUNDS); + return; + } + + ++client_ent_sound_count; + } + + const char* skip_text(const char* line, const char* skip_text) + { + char error_text[128]{}; + + if (std::strncmp(skip_text, line, std::strlen(skip_text)) != 0) + { + I_strncpyz(error_text, line, sizeof(error_text)); + console::error("Unexpected text '%s' when trying to find '%s' in map's effect file\n", error_text, skip_text); + return nullptr; + } + + return &line[std::strlen(skip_text)]; + } + + const char* skip_white_space(const char* line) + { + while (std::isspace(static_cast(*line))) + { + ++line; + } + + return line; + } + + const char* skip_line_starting_with(const char* line, const char* skip_line) + { + const auto* result = skip_text(line, skip_line); + if (!result) + { + return nullptr; + } + + for (auto i = *result; i != '\n'; i = *++result) + { + if (i == '\r' || i == '\0') + { + break; + } + } + + return skip_white_space(result); + } + + bool match_line_starting_with(const char* line, const char* start_line) + { + return std::strncmp(start_line, line, std::strlen(start_line)) == 0; + } + + const char* parse_string(const char* line, char* text, unsigned int buffer_size) + { + char error_text[128]{}; + + if (*line != '"') + { + I_strncpyz(error_text, line, sizeof(error_text)); + console::error("Expected a quoted string instead of '%s'\n"); + return nullptr; + } + + auto c = line[1]; + unsigned int i; + + for (i = 0; ((c != '\"' && (c != '\0')) && (i < buffer_size)); ++i) + { + text[i] = c; + c = line[i + 2]; + } + + if (i == buffer_size) + { + I_strncpyz(error_text, line, sizeof(error_text)); + console::error("String was longer than expected '%s'\n", error_text); + return nullptr; + } + + text[i] = '\0'; + return &line[i + 2]; + } + + const char* parse_string_finish(const char* line, char* text, unsigned int buffer_size) + { + line = parse_string(line, text, buffer_size); + if (!line) + { + return nullptr; + } + + for (auto i = *line; i != '\n'; i = *++line) + { + if (i == '\r' || i == '\0') + { + break; + } + } + + return skip_white_space(line); + } + + const char* parse_float_finish(const char* line, float* value) + { + char error_text[128]{}; + + if (std::sscanf(line, "%f", value) != 1) + { + I_strncpyz(error_text, line, sizeof(error_text)); + console::error("Expected a float instead of '%s'\n", error_text); + return nullptr; + } + + for (auto i = *line; i != '\n'; i = *++line) + { + if (i == '\r' || i == '\0') + { + break; + } + } + + return skip_white_space(line); + } + + const char* parse_vec3_finish(const char* line, float* origin) + { + char error_text[128]{}; + + if (std::sscanf(line, "%f, %f, %f", origin, origin + 1, origin + 2) != 3) + { + I_strncpyz(error_text, line, sizeof(error_text)); + console::error("Expected 3 floats instead of '%s'\n", error_text); + return nullptr; + } + + for (auto i = *line; i != '\n'; i = *++line) + { + if (i == '\r' || i == '\0') + { + break; + } + } + + return skip_white_space(line); + } + + const char* parse_sound(const char* line) + { + float origin[3], angles[3]; + char sound_alias[256]{}; + + SKIP_TEXT_PTR(line, "ent = createLoopSound();"); + + SKIP_WHITE_SPACE_PTR(line); + + SKIP_TEXT_PTR(line, "ent.v[ \"origin\" ] = ("); + PARSE_VEC3_PTR(line, origin); + + SKIP_TEXT_PTR(line, "ent.v[ \"angles\" ] = ("); + PARSE_VEC3_PTR(line, angles); + + SKIP_TEXT_PTR(line, "ent.v[ \"soundalias\" ] = "); + PARSE_STRING_PTR(line, sound_alias); + + add_client_ent_sound(origin, sound_alias); + return line; + } + + const char* parse_effect(const char* line) + { + float delay; + float origin[3], angles[3]; + char sound_alias[256]{}; + char fx_def_name[256]{}; + + SKIP_TEXT_PTR(line, "ent = createOneshotEffect( "); + PARSE_STRING_PTR(line, fx_def_name); + + SKIP_TEXT_PTR(line, "ent.v[ \"origin\" ] = ("); + PARSE_VEC3_PTR(line, origin); + + SKIP_TEXT_PTR(line, "ent.v[ \"angles\" ] = ("); + PARSE_VEC3_PTR(line, angles); + + SKIP_TEXT_PTR(line, "ent.v[ \"fxid\" ] = "); + PARSE_STRING_PTR(line, fx_def_name); + + SKIP_TEXT_PTR(line, "ent.v[ \"delay\" ] = "); + line = parse_float_finish(line, &delay); + if (!line) + { + return nullptr; + } + + if (match_line_starting_with(line, "ent.v[ \"soundalias\" ] = ")) + { + SKIP_TEXT_PTR(line, "ent.v[ \"soundalias\" ] = "); + PARSE_STRING_PTR(line, sound_alias); + + add_client_ent_sound(origin, sound_alias); + } + + // Skip FX registration code + + return line; + } + + bool parse_client_effects(const char* buffer) + { + char error_text[128]{}; + + // Header section + + SKIP_TEXT(buffer, "//_createfx generated. Do not touch!!"); + SKIP_WHITE_SPACE(buffer); + SKIP_TEXT(buffer, "#include common_scripts\\utility;"); + SKIP_WHITE_SPACE(buffer); + SKIP_TEXT(buffer, "#include common_scripts\\_createfx;"); + SKIP_WHITE_SPACE(buffer); + + // Fake GSC section + + SKIP_TEXT(buffer, "main()"); + SKIP_WHITE_SPACE(buffer); + SKIP_TEXT(buffer, "{"); + SKIP_WHITE_SPACE(buffer); + + SKIP_LINE(buffer, "//"); + + if (buffer) + { + while (*buffer != '}' && *buffer) + { + if (match_line_starting_with(buffer, "ent = createLoopSound();")) + { + buffer = parse_sound(buffer); + if (!buffer) + { + return false; + } + } + else if (match_line_starting_with(buffer, "ent = createOneshotEffect( ")) + { + buffer = parse_effect(buffer); + if (!buffer) + { + return false; + } + } + else + { + I_strncpyz(error_text, buffer, sizeof(error_text)); + console::error("Expected 'ent = createLoopSound();' or 'ent = createOneshotEffect' instead of '%s' in map's effect file\n", error_text); + return false; + } + } + } + + buffer = skip_line_starting_with(buffer, "}"); + if (buffer && *buffer) + { + I_strncpyz(error_text, buffer, sizeof(error_text)); + console::error("Unexpected data after parsing '%s' map's effect file\n", error_text); + return false; + } + + return true; + } +} diff --git a/src/game/cg_client_side_effects_mp.hpp b/src/game/cg_client_side_effects_mp.hpp new file mode 100644 index 0000000..647b034 --- /dev/null +++ b/src/game/cg_client_side_effects_mp.hpp @@ -0,0 +1,6 @@ +#pragma once + +namespace game +{ + bool parse_client_effects(const char* buffer); +} diff --git a/src/game/q_shared.cpp b/src/game/q_shared.cpp new file mode 100644 index 0000000..361d845 --- /dev/null +++ b/src/game/q_shared.cpp @@ -0,0 +1,39 @@ +#include + +#include "q_shared.hpp" + +namespace game +{ + void I_strncpyz(char* dest, const char* src, std::size_t dest_size) + { + assert(src); + assert(dest); + + if (!dest) + { + return; + } + + if (!src) + { + *dest = '\0'; + } + else + { + auto* p = reinterpret_cast(src - 1); + auto* q = reinterpret_cast(dest - 1); + auto n = dest_size + 1; + do + { + if (!--n) + { + break; + } + + *++q = *++p; + } while (*q); + + dest[dest_size - 1] = '\0'; + } + } +} diff --git a/src/game/q_shared.hpp b/src/game/q_shared.hpp new file mode 100644 index 0000000..a2dbb04 --- /dev/null +++ b/src/game/q_shared.hpp @@ -0,0 +1,6 @@ +#pragma once + +namespace game +{ + void I_strncpyz(char* dest, const char* src, std::size_t dest_size); +} diff --git a/src/main.cpp b/src/main.cpp new file mode 100644 index 0000000..cbafbcb --- /dev/null +++ b/src/main.cpp @@ -0,0 +1,125 @@ +#include "std_include.hpp" + +#include "component/console.hpp" +#include "component/map_rotation.hpp" + +#include "game/cg_client_side_effects_mp.hpp" + +#include + +namespace +{ + bool load_client_effects(const std::string& filename) + { + if (filename.empty()) + { + console::error("filename parameter is empty\n"); + return false; + } + + const auto data = utils::io::read_file(filename); + if (data.empty()) + { + console::error("'%s' is empty\n", filename.data()); + return false; + } + + return game::parse_client_effects(data.data()); + } + + bool load_map_rotation(const std::string& filename) + { + if (filename.empty()) + { + console::error("filename parameter is empty\n"); + return false; + } + + const auto data = utils::io::read_file(filename); + if (data.empty()) + { + console::error("'%s' is empty\n", filename.data()); + return false; + } + + try + { + map_rotation::rotation_data rotation_data; + rotation_data.parse(data); + } + catch (const std::exception& ex) + { + console::error("%s: '%s' contains invalid data!\n", ex.what(), filename.data()); + return false; + } + + console::info("Successfully parsed map rotation\n"); + return true; + } +} + +int unsafe_main(std::string&& prog, std::vector&& args) +{ + // Parse command-line flags (only increment i for matching flags) + for (auto i = args.begin(); i != args.end();) + { + if (*i == "-createfx") + { + ++i; + const auto filename = i != args.end() ? *i++ : std::string(); + console::info("Parsing createfx '%s'\n", filename.data()); + + if (!load_client_effects(filename)) + { + return EXIT_FAILURE; + } + } + else if (*i == "-map-rotation") + { + ++i; + const auto filename = i != args.end() ? *i++ : std::string(); + console::info("Parsing map rotation '%s'\n", filename.data()); + + if (!load_map_rotation(filename)) + { + return EXIT_FAILURE; + } + + } + else + { + console::info("X Labs IW4x validator tool\n" + "Usage: %s OPTIONS\n" + " -createfx \n" + " -fx \n" + " -map-rotation \n", + prog.data() + ); + + return EXIT_FAILURE; + } + } + + return EXIT_SUCCESS; +} + +int main(int argc, char* argv[]) +{ + console::set_title("X Labs IW4x-validator"); + console::log("Starting X Labs IW4x-validator"); + + try + { + std::string prog(argv[0]); + std::vector args; + + args.reserve(argc - 1); + args.assign(argv + 1, argv + argc); + return unsafe_main(std::move(prog), std::move(args)); + } + catch (const std::exception& ex) + { + console::error("Fatal error: %s\n", ex.what()); + return EXIT_FAILURE; + } +} diff --git a/src/std_include.cpp b/src/std_include.cpp new file mode 100644 index 0000000..3306de2 --- /dev/null +++ b/src/std_include.cpp @@ -0,0 +1 @@ +#include diff --git a/src/std_include.hpp b/src/std_include.hpp new file mode 100644 index 0000000..4132c95 --- /dev/null +++ b/src/std_include.hpp @@ -0,0 +1,41 @@ +#ifdef _WIN32 +#pragma once + +#define WIN32_LEAN_AND_MEAN +#define _CRT_SECURE_NO_WARNINGS + +#include + +#else + +#include +#include + +#endif + +// min and max is required by gdi, therefore NOMINMAX won't work +#ifdef max + #undef max +#endif + +#ifdef min + #undef min +#endif + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include diff --git a/src/utils/io.cpp b/src/utils/io.cpp new file mode 100644 index 0000000..2145539 --- /dev/null +++ b/src/utils/io.cpp @@ -0,0 +1,92 @@ +#include +#include "io.hpp" + +namespace utils +{ + namespace io + { + bool remove_file(const std::string& file) + { + return std::remove(file.data()) == 0; + } + + bool move_file(const std::string& src, const std::string& target) + { + return std::rename(src.data(), target.data()) == 0; + } + + bool file_exists(const std::string& file) + { + return std::ifstream(file).good(); + } + + bool write_file(const std::string& file, const std::string& data, const bool append) + { + auto mode = std::ios::binary | std::ofstream::out; + if (append) + { + mode |= std::ofstream::app; + } + + std::ofstream stream(file, mode); + + if (stream.is_open()) + { + stream.write(data.data(), static_cast(data.size())); + stream.close(); + return true; + } + + return false; + } + + std::string read_file(const std::string& file) + { + std::string data; + read_file(file, &data); + return data; + } + + bool read_file(const std::string& file, std::string* data) + { + if (!data) return false; + data->clear(); + + if (file_exists(file)) + { + std::ifstream stream(file, std::ios::binary); + if (!stream.is_open()) return false; + + stream.seekg(0, std::ios::end); + const std::streamsize size = stream.tellg(); + stream.seekg(0, std::ios::beg); + + if (size > -1) + { + data->resize(static_cast(size)); + stream.read(const_cast(data->data()), size); + stream.close(); + return true; + } + } + + return false; + } + + std::size_t file_size(const std::string& file) + { + if (file_exists(file)) + { + std::ifstream stream(file, std::ios::binary); + + if (stream.good()) + { + stream.seekg(0, std::ios::end); + return static_cast(stream.tellg()); + } + } + + return 0; + } + } +} diff --git a/src/utils/io.hpp b/src/utils/io.hpp new file mode 100644 index 0000000..529fd29 --- /dev/null +++ b/src/utils/io.hpp @@ -0,0 +1,17 @@ +#pragma once + +#include + +namespace utils +{ + namespace io + { + bool remove_file(const std::string& file); + bool move_file(const std::string& src, const std::string& target); + bool file_exists(const std::string& file); + bool write_file(const std::string& file, const std::string& data, bool append = false); + bool read_file(const std::string& file, std::string* data); + std::string read_file(const std::string& file); + std::size_t file_size(const std::string& file); + } +} diff --git a/src/utils/string.cpp b/src/utils/string.cpp new file mode 100644 index 0000000..8bcd7bb --- /dev/null +++ b/src/utils/string.cpp @@ -0,0 +1,41 @@ +#include +#include "string.hpp" + +namespace utils::string +{ + std::vector split(const std::string& s, const char delim) + { + std::stringstream ss(s); + std::string item; + std::vector elems; + + while (std::getline(ss, item, delim)) + { + elems.push_back(item); // elems.push_back(std::move(item)); // if C++11 + } + + return elems; + } + + std::string to_lower(const std::string& text) + { + std::string result; + std::ranges::transform(text, std::back_inserter(result), [](const unsigned char input) + { + return static_cast(std::tolower(input)); + }); + + return result; + } + + std::string to_upper(const std::string& text) + { + std::string result; + std::ranges::transform(text, std::back_inserter(result), [](const unsigned char input) + { + return static_cast(std::toupper(input)); + }); + + return result; + } +} diff --git a/src/utils/string.hpp b/src/utils/string.hpp new file mode 100644 index 0000000..56c65e3 --- /dev/null +++ b/src/utils/string.hpp @@ -0,0 +1,9 @@ +#pragma once + +namespace utils::string +{ + std::vector split(const std::string& s, char delim); + + std::string to_lower(const std::string& text); + std::string to_upper(const std::string& text); +} diff --git a/tools/premake5-linux b/tools/premake5-linux new file mode 100755 index 0000000..bcb51ce Binary files /dev/null and b/tools/premake5-linux differ diff --git a/tools/premake5-mac b/tools/premake5-mac new file mode 100755 index 0000000..48daa61 Binary files /dev/null and b/tools/premake5-mac differ diff --git a/tools/premake5.exe b/tools/premake5.exe new file mode 100644 index 0000000..1a637aa Binary files /dev/null and b/tools/premake5.exe differ