From 4506f07987898b54429bc99686840d5ef083c5f6 Mon Sep 17 00:00:00 2001 From: Paul Dino Jones Date: Thu, 26 Jan 2023 20:16:21 +0000 Subject: [PATCH] Salut Gilles --- .gitignore | 3 + .gitmodules | 3 + CMakeLists.txt | 88 ++++ LICENSE.rst | 674 +++++++++++++++++++++++++ README.md | 45 ++ src/gilles/gameloop/CMakeLists.txt | 9 + src/gilles/gameloop/gameloop.c | 512 +++++++++++++++++++ src/gilles/gameloop/gameloop.h | 4 + src/gilles/gilles.c | 129 +++++ src/gilles/helper/CMakeLists.txt | 10 + src/gilles/helper/confighelper.c | 38 ++ src/gilles/helper/confighelper.h | 46 ++ src/gilles/helper/dirhelper.c | 202 ++++++++ src/gilles/helper/dirhelper.h | 12 + src/gilles/helper/parameters.c | 74 +++ src/gilles/helper/parameters.h | 44 ++ src/gilles/simulatorapi/CMakeLists.txt | 15 + src/gilles/simulatorapi/simapi | 1 + src/gilles/slog/CMakeLists.txt | 6 + src/gilles/slog/slog.c | 546 ++++++++++++++++++++ src/gilles/slog/slog.h | 195 +++++++ 21 files changed, 2656 insertions(+) create mode 100644 .gitignore create mode 100644 .gitmodules create mode 100644 CMakeLists.txt create mode 100644 LICENSE.rst create mode 100644 README.md create mode 100644 src/gilles/gameloop/CMakeLists.txt create mode 100644 src/gilles/gameloop/gameloop.c create mode 100644 src/gilles/gameloop/gameloop.h create mode 100644 src/gilles/gilles.c create mode 100644 src/gilles/helper/CMakeLists.txt create mode 100644 src/gilles/helper/confighelper.c create mode 100644 src/gilles/helper/confighelper.h create mode 100644 src/gilles/helper/dirhelper.c create mode 100644 src/gilles/helper/dirhelper.h create mode 100644 src/gilles/helper/parameters.c create mode 100644 src/gilles/helper/parameters.h create mode 100644 src/gilles/simulatorapi/CMakeLists.txt create mode 160000 src/gilles/simulatorapi/simapi create mode 100644 src/gilles/slog/CMakeLists.txt create mode 100644 src/gilles/slog/slog.c create mode 100644 src/gilles/slog/slog.h diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d4e9105 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +/build +/src/gilles/tags +/src/gilles/simulatorapi/simapi diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..020a34e --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "src/gilles/simulatorapi/simapi"] + path = src/gilles/simulatorapi/simapi + url = https://github.com/Spacefreak18/simapi diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..383fe51 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,88 @@ + +# minimum CMake version required for C++20 support, among other things +cmake_minimum_required(VERSION 3.15) + +# detect if gilles is being used as a sub-project of another CMake project +if(NOT DEFINED PROJECT_NAME) + set(GILLES_SUBPROJECT OFF) +else() + set(GILLES_SUBPROJECT ON) +endif() + + +SET_SOURCE_FILES_PROPERTIES( src/gilles.c PROPERTIES LANGUAGE C) +set(CMAKE_BUILD_TYPE Debug) + + +project(gilles) + + +add_subdirectory(src/gilles/gameloop) +add_subdirectory(src/gilles/simulatorapi) +add_subdirectory(src/gilles/helper) +add_subdirectory(src/gilles/slog) + +add_executable(gilles src/gilles/gilles.c) +target_link_libraries(gilles m ${LIBUSB_LIBRARY} ncurses argtable2 config gameloop helper slog simulatorapi) + + +# used for enabling additional compiler options if supported +include(CheckCXXCompilerFlag) + +function(enable_cxx_compiler_flag_if_supported flag) + message(STATUS "[gilles] Checking if compiler supports warning flag '${flag}'") + check_cxx_compiler_flag("${flag}" flag_supported) + if(flag_supported) + message(STATUS "[gilles] Enabling warning flag '${flag}'") + target_compile_options(gilles INTERFACE "${flag}") + endif() + unset(flag_supported CACHE) +endfunction() + +# enable a large amount of extra warnings, regardless of build mode +if (MSVC) # MSVC supports different warning options to GCC/Clang + enable_cxx_compiler_flag_if_supported("/W3") # set warning level 3 + # if tests are enabled, enable converting all warnings to errors too + if (ENABLE_TESTS) + # add_compile_options(/WX) + enable_cxx_compiler_flag_if_supported("/WX") + endif() +else() # GCC/Clang warning option + # NOTE: GCC and Clang support most of the same options, but neither supports all + # of the others'. By only enabling them if supported, we get graceful failure + # when trying to enable unsupported flags + # e.g. at the time of writing, GCC does not support -Wdocumentation + # + # enable all warnings about 'questionable constructs' + enable_cxx_compiler_flag_if_supported("-Wall") + # issue 'pedantic' warnings for strict ISO compliance + enable_cxx_compiler_flag_if_supported("-pedantic") + # enable 'extra' strict warnings + enable_cxx_compiler_flag_if_supported("-Wextra") + # enable sign conversion warnings + enable_cxx_compiler_flag_if_supported("-Wsign-conversion") + # enable warnings about mistakes in Doxygen documentation + enable_cxx_compiler_flag_if_supported("-Wdocumentation") + # if tests are enabled, enable converting all warnings to errors too + if (ENABLE_TESTS) + enable_cxx_compiler_flag_if_supported("-Werror") + # exclude the following kinds of warnings from being converted into errors + # unknown-pragma is useful to have as a warning but not as an error, if you have + # pragmas which are for the consumption of one compiler only + enable_cxx_compiler_flag_if_supported("-Wno-error=unknown-pragmas") + # unused variable and function warnings are helpful but we don't need them as errors + enable_cxx_compiler_flag_if_supported("-Wno-error=unused-function") + enable_cxx_compiler_flag_if_supported("-Wno-error=unused-variable") + enable_cxx_compiler_flag_if_supported("-Wno-error=unused-parameter") + enable_cxx_compiler_flag_if_supported("-Wno-error=unused-private-field") + enable_cxx_compiler_flag_if_supported("-Wno-error=unused-but-set-variable") + endif() +endif() + +# library +# unit tests --only enable if requested AND we're not building as a sub-project +if(ENABLE_TESTS AND NOT gilles_SUBPROJECT) + message(STATUS "[gilles] Unit Tests Enabled") + add_subdirectory(tests) + enable_testing() +endif() diff --git a/LICENSE.rst b/LICENSE.rst new file mode 100644 index 0000000..8ea16e4 --- /dev/null +++ b/LICENSE.rst @@ -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..a4b5ade --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Gilles +ncurses based telemetry monitor for racing sims + +## Features +- Updates at 120 frames per seconds. +- Modular design for support with various titles + +## Dependencies +- argtable2 +- libconfig +- slog (static) +- [wine-linux-shm-adapter](https://github.com/spacefreak18/wine-linux-shm-adapter) +- [simapi](https://github.com/spacefreak18/simapi) + +## Building +This code depends on the shared memory data headers in the simapi [repo](https://github.com/spacefreak18/simapi). When pulling lastest if the submodule does not download run: +``` +git submodule sync --recursive +git submodule update --init --recursive +``` +Then to compile simply: +``` +mkdir build; cd build +cmake .. +make +``` +## Testing + +### Static Analysis +``` + mkdir build; cd build + make clean + CFLAGS=-fanalyzer cmake .. + make +``` +### Valgrind +``` + cd build + valgrind -v --leak-check=full --show-leak-kinds=all --suppressions=../.valgrindrc ./gilles play +``` + +## ToDo + - GUI + - Actual telemetry to compare against self and other drivers + - much, much more diff --git a/src/gilles/gameloop/CMakeLists.txt b/src/gilles/gameloop/CMakeLists.txt new file mode 100644 index 0000000..b720e09 --- /dev/null +++ b/src/gilles/gameloop/CMakeLists.txt @@ -0,0 +1,9 @@ +set(gameloop_source_files + gameloop.c + gameloop.h +) + +set(LIBXML_INCLUDE_DIR /usr/include/libxml2) +include_directories("." ${LIBXML_INCLUDE_DIR}) + +add_library(gameloop STATIC ${gameloop_source_files}) diff --git a/src/gilles/gameloop/gameloop.c b/src/gilles/gameloop/gameloop.c new file mode 100644 index 0000000..d30dc91 --- /dev/null +++ b/src/gilles/gameloop/gameloop.c @@ -0,0 +1,512 @@ +#include +#include +#include +#include + +#include "gameloop.h" +#include "../helper/parameters.h" +#include "../helper/confighelper.h" +#include "../simulatorapi/simapi/simapi/simdata.h" +#include "../simulatorapi/simapi/simapi/simmapper.h" +#include "../slog/slog.h" + +#define DEFAULT_UPDATE_RATE 100 + +WINDOW* win1; +WINDOW* win2; +WINDOW* win3; +WINDOW* win4; + +int winx, winy; + +int win23y, win23x; + +void handle_winch(int sig) +{ + endwin(); + + refresh(); + clear(); + getmaxyx(stdscr, winx, winy); + win23y = winy/3; + win23x = winx/3; + win1 = newwin(winx,winy,0,0); + win2 = newwin(win23x,win23y,1,win23y-1); + win3 = newwin(win23x,win23y,1,win23y*2-1); + win4 = newwin(winx-win23x-2,winy-win23y,win23x+1,win23y-1); + refresh(); +} + +void rectangle(int y1, int x1, int y2, int x2) +{ + mvhline(y1, x1, 0, x2-x1); + mvhline(y2, x1, 0, x2-x1); + mvvline(y1, x1, 0, y2-y1); + mvvline(y1, x2, 0, y2-y1); + mvaddch(y1, x1, ACS_ULCORNER); + mvaddch(y2, x1, ACS_LLCORNER); + mvaddch(y1, x2, ACS_URCORNER); + mvaddch(y2, x2, ACS_LRCORNER); +} + +int curses_init() +{ + initscr(); + start_color(); + + init_pair(1,COLOR_GREEN,0); + init_pair(2,COLOR_YELLOW,0); + init_pair(3,COLOR_MAGENTA,0); + init_pair(4,COLOR_WHITE,0); + + getmaxyx(stdscr, winx, winy); + win1 = newwin(winx,winy,0,0); + win23y = winy/3; + win23x = winx/3; + win2 = newwin(win23x,win23y,1,win23y-1); + win3 = newwin(win23x,win23y,1,win23y*2-1); + win4 = newwin(winx-win23x-2,winy-win23y,win23x+1,win23y-1); + + wbkgd(win1,COLOR_PAIR(1)); + wbkgd(win2,COLOR_PAIR(1)); + wbkgd(win3,COLOR_PAIR(1)); + wbkgd(win4,COLOR_PAIR(1)); + + signal(SIGWINCH, handle_winch); + cbreak(); + noecho(); + + box(win1, 0, 0); + box(win2, 0, 0); + box(win3, 0, 0); + box(win4, 0, 0); +} + +int looper(Simulator simulator) +{ + + SimData* simdata = malloc(sizeof(SimData)); + SimMap* simmap = malloc(sizeof(SimMap)); + + int error = siminit(simdata, simmap, simulator); + + if (error != GILLES_ERROR_NONE) + { + slogf("Fatal error getting simulator data"); + return error; + } + + curses_init(); + + timeout(DEFAULT_UPDATE_RATE); + + int go = true; + while (go == true) + { + simdatamap(simdata, simmap, simulator); + + wclear(win1); + wclear(win2); + wclear(win3); + wclear(win4); + + { // window 1 car diagnostics + + char spacer[14]; + sprintf(spacer, "\n"); + waddstr(win1, spacer); + + sprintf(spacer, "\n"); + waddstr(win1, spacer); + + char speed[14]; + wbkgd(win1,COLOR_PAIR(1)); + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " Speed: "); + sprintf(speed, "%i\n", simdata->velocity); + wattrset(win1, COLOR_PAIR(2)); + waddstr(win1, speed); + + char rpm[14]; + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " RPM: "); + sprintf(rpm, "%i\n", simdata->rpms); + wattrset(win1, COLOR_PAIR(2)); + waddstr(win1, rpm); + + char gear[14]; + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " Gear: "); + sprintf(gear, "%i\n", simdata->gear); + wattrset(win1, COLOR_PAIR(2)); + waddstr(win1, gear); + + char gas[14]; + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " Gas: "); + sprintf(gas, "%f\n", simdata->gas); + wattrset(win1, COLOR_PAIR(2)); + waddstr(win1, gas); + + char brake[14]; + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " Brake: "); + sprintf(brake, "%f\n", simdata->brake); + wattrset(win1, COLOR_PAIR(2)); + waddstr(win1, brake); + + char fuel[14]; + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " Fuel: "); + sprintf(fuel, "%f\n", simdata->fuel); + wattrset(win1, COLOR_PAIR(2)); + waddstr(win1, fuel); + + sprintf(spacer, "\n"); + waddstr(win1, spacer); + + sprintf(spacer, "\n"); + waddstr(win1, spacer); + + sprintf(spacer, "\n"); + waddstr(win1, spacer); + + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " braketemp "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f", simdata->braketemp[0]); + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " braketemp "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f\n", simdata->braketemp[1]); + + sprintf(spacer, "\n"); + waddstr(win1, spacer); + + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " temp "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f", simdata->tyretemp[0]); + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " temp "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f\n", simdata->tyretemp[1]); + + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " pres "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f", simdata->tyrepressure[0]); + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " pres "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f\n", simdata->tyrepressure[1]); + + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " wear "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f", simdata->tyrewear[0]); + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " wear "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f\n", simdata->tyrewear[1]); + + sprintf(spacer, "\n"); + waddstr(win1, spacer); + + sprintf(spacer, "\n"); + waddstr(win1, spacer); + + sprintf(spacer, "\n"); + waddstr(win1, spacer); + + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " temp "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f", simdata->tyretemp[2]); + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " temp "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f\n", simdata->tyretemp[3]); + + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " pres "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f", simdata->tyrepressure[2]); + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " pres "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f\n", simdata->tyrepressure[3]); + + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " wear "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f", simdata->tyrewear[2]); + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " wear "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f\n", simdata->tyrewear[3]); + + sprintf(spacer, "\n"); + waddstr(win1, spacer); + + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " braketemp "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f", simdata->braketemp[0]); + wattrset(win1, COLOR_PAIR(1)); + wprintw(win1, " braketemp "); + wattrset(win1, COLOR_PAIR(2)); + wprintw(win1, "%.0f\n", simdata->braketemp[1]); + + wattrset(win1, COLOR_PAIR(1)); + rectangle(12, 12, 16, 16); // left front + rectangle(12, 18, 16, 22); // right front + rectangle(18, 12, 22, 16); // left rear + rectangle(18, 18, 22, 22); // right rear + } + + { // window 2 session info + + char spacer[14]; + sprintf(spacer, "\n"); + waddstr(win2, spacer); + + char airtemp[14]; + wbkgd(win2,COLOR_PAIR(1)); + wattrset(win2, COLOR_PAIR(1)); + wprintw(win2, " Air Temp: "); + sprintf(airtemp, "%.0f\n", simdata->airtemp); + wattrset(win2, COLOR_PAIR(2)); + waddstr(win2, airtemp); + + char airdensity[14]; + wattrset(win2, COLOR_PAIR(1)); + wprintw(win2, " Humidity: "); + sprintf(airdensity, "%.0f\n", simdata->airdensity); + wattrset(win2, COLOR_PAIR(2)); + waddstr(win2, airdensity); + + char tracktemp[14]; + wattrset(win2, COLOR_PAIR(1)); + wprintw(win2, " Track Temp: "); + sprintf(tracktemp, "%.0f\n", simdata->tracktemp); + wattrset(win2, COLOR_PAIR(2)); + waddstr(win2, tracktemp); + + char numlaps[14]; + wbkgd(win2,COLOR_PAIR(1)); + wattrset(win2, COLOR_PAIR(1)); + wprintw(win2, " Num Laps: "); + sprintf(numlaps, "%i\n", simdata->numlaps); + wattrset(win2, COLOR_PAIR(2)); + waddstr(win2, numlaps); + + char timeleft[14]; + int hours = simdata->timeleft/6000; + int minutes = simdata->timeleft/60 - (hours*6000); + int seconds = simdata->timeleft-((minutes*60)+(hours*6000)); + //int fraction = simdata->timeleft-(minutes*60000)-(seconds*1000); + wbkgd(win2, COLOR_PAIR(1)); + wattrset(win2, COLOR_PAIR(1)); + wprintw(win2, " Time Left: "); + sprintf(timeleft, "%02d:%02d:%02d\n", hours, minutes, seconds); + wattrset(win2, COLOR_PAIR(2)); + waddstr(win2, timeleft); + + char currenttime[14]; + hours = simdata->time/6000; + minutes = simdata->time/60 - (hours*6000); + seconds = simdata->time-((minutes*60)+(hours*6000)); + //fraction = simdata->time-(minutes*60000)-(seconds*1000); + wbkgd(win2, COLOR_PAIR(1)); + wattrset(win2, COLOR_PAIR(1)); + wprintw(win2, " Current Time: "); + sprintf(currenttime, "%02d:%02d:%02d\n", hours, minutes, seconds); + wattrset(win2, COLOR_PAIR(2)); + waddstr(win2, currenttime); + + wattrset(win2, COLOR_PAIR(1)); + } + + { // window 3 basic timing and scoring + + char spacer[14]; + sprintf(spacer, "\n"); + waddstr(win3, spacer); + + char car[14]; + wattrset(win3, COLOR_PAIR(1)); + wprintw(win3, " Car: "); + sprintf(car, "%s\n", simdata->car); + wattrset(win3, COLOR_PAIR(2)); + waddstr(win3, car); + + char track[14]; + wattrset(win3, COLOR_PAIR(1)); + wprintw(win3, " Track: "); + sprintf(track, "%s\n", simdata->track); + wattrset(win3, COLOR_PAIR(2)); + waddstr(win3, track); + + char driver[14]; + wattrset(win3, COLOR_PAIR(1)); + wprintw(win3, " Driver: "); + sprintf(driver, "%s\n", simdata->driver); + wattrset(win3, COLOR_PAIR(2)); + waddstr(win3, driver); + + char lap[14]; + wbkgd(win3,COLOR_PAIR(1)); + wattrset(win3, COLOR_PAIR(1)); + wprintw(win3, " Lap: "); + sprintf(lap, "%i\n", simdata->lap); + wattrset(win3, COLOR_PAIR(2)); + waddstr(win3, lap); + + char position[14]; + wattrset(win3, COLOR_PAIR(1)); + wprintw(win3, " Position: "); + sprintf(position, "%i\n", simdata->position); + wattrset(win3, COLOR_PAIR(2)); + waddstr(win3, position); + + char lastlap[14]; + int minutes = simdata->lastlap/60000; + int seconds = simdata->lastlap/1000-(minutes*60); + int fraction = simdata->lastlap-(minutes*60000)-(seconds*1000); + wattrset(win3, COLOR_PAIR(1)); + wprintw(win3, " Last Lap: "); + sprintf(lastlap, "%d:%02d:%02d\n", minutes, seconds, fraction); + wattrset(win3, COLOR_PAIR(2)); + waddstr(win3, lastlap); + + char bestlap[14]; + minutes = simdata->bestlap/60000; + seconds = simdata->bestlap/1000-(minutes*60); + fraction = simdata->bestlap-(minutes*60000)-(seconds*1000); + wattrset(win3, COLOR_PAIR(1)); + wprintw(win3, " Best Lap: "); + sprintf(bestlap, "%d:%02d:%02d\n", minutes, seconds, fraction); + wattrset(win3, COLOR_PAIR(2)); + waddstr(win3, bestlap); + + wattrset(win3, COLOR_PAIR(1)); + } + + { // window 4 live standings timing and scoring + char spacer[14]; + sprintf(spacer, "\n"); + waddstr(win4, spacer); + + wattrset(win4, COLOR_PAIR(4)); + wprintw(win4, " P "); + wprintw(win4, " Driver "); + wprintw(win4, " Car "); + wprintw(win4, " Laps "); + wprintw(win4, " Last "); + wprintw(win4, " Best "); + wprintw(win4, " Pit "); + wprintw(win4, "\n"); + + // figuring out how many and which entrants to display while respecting term size + // this will take some work and testing + int thisx, thisy; + getmaxyx(win4, thisx, thisy); + int maxcars = thisy/5; + int displaycars = maxcars; + if (simdata->numcars < maxcars) + { + displaycars = simdata->numcars; + } + for(int i=0; icars[i].pos) + break; + } + + wattrset(win4, COLOR_PAIR(2)); + wprintw(win4, " %02d ", simdata->cars[i].pos); + wprintw(win4, " %-20s ", simdata->cars[i].driver); + wprintw(win4, " %-20s ", simdata->cars[i].car); + wprintw(win4, " %d ", simdata->cars[i].lap); + + char clastlap[14]; + int lastlap = simdata->cars[i].lastlap; + int minutes = lastlap/60000; + int seconds = lastlap/1000-(minutes*60); + int fraction = lastlap-(minutes*60000)-(seconds*1000); + sprintf(clastlap, "%02d:%02d:%03d", minutes, seconds, fraction); + waddstr(win4, clastlap); + + wprintw(win4, " "); + + char cbestlap[14]; + int bestlap = simdata->cars[i].bestlap; + minutes = bestlap/60000; + seconds = bestlap/1000-(minutes*60); + fraction = bestlap-(minutes*60000)-(seconds*1000); + sprintf(cbestlap, "%02d:%02d:%03d", minutes, seconds, fraction); + waddstr(win4, cbestlap); + + if(simdata->cars[i].inpitlane == 0 && simdata->cars[i].inpit == 0) + { + wattrset(win4, COLOR_PAIR(1)); + wprintw(win4, " ontrack "); + } + else + { + if(simdata->cars[i].inpit > 0) + { + wprintw(win4, " pit "); + } + else + { + wprintw(win4, " pitlane "); + } + } + i = ihold; + wprintw(win4, "\n"); + } + wattrset(win4, COLOR_PAIR(1)); + } + + box(win1, 0, 0); + box(win2, 0, 0); + box(win3, 0, 0); + box(win4, 0, 0); + + wrefresh(win1); + wrefresh(win2); + wrefresh(win3); + wrefresh(win4); + + if (getch() == 'q') + { + go = false; + } + } + + wrefresh(win4); + delwin(win4); + endwin(); + + wrefresh(win3); + delwin(win3); + endwin(); + + wrefresh(win2); + delwin(win2); + endwin(); + + wrefresh(win1); + delwin(win1); + endwin(); + + free(simdata); + free(simmap); + + return 0; +} diff --git a/src/gilles/gameloop/gameloop.h b/src/gilles/gameloop/gameloop.h new file mode 100644 index 0000000..fbf8485 --- /dev/null +++ b/src/gilles/gameloop/gameloop.h @@ -0,0 +1,4 @@ +#include "../helper/parameters.h" +#include "../helper/confighelper.h" + +int looper (Simulator simulator); diff --git a/src/gilles/gilles.c b/src/gilles/gilles.c new file mode 100644 index 0000000..83efb32 --- /dev/null +++ b/src/gilles/gilles.c @@ -0,0 +1,129 @@ +#include +#include +#include +#include +#include +#include + +#include "gameloop/gameloop.h" +#include "helper/parameters.h" +#include "helper/dirhelper.h" +#include "helper/confighelper.h" +//#include "simulatorapi/simdata.h" +#include "slog/slog.h" + + + +int create_dir(char* dir) +{ + struct stat st = {0}; + if (stat(dir, &st) == -1) + { + mkdir(dir, 0700); + } +} + +char* create_user_dir(char* dirtype) +{ + char* home_dir_str = gethome(); + char* config_dir_str = ( char* ) malloc(1 + strlen(home_dir_str) + strlen(dirtype) + strlen("gilles/")); + strcpy(config_dir_str, home_dir_str); + strcat(config_dir_str, dirtype); + strcat(config_dir_str, "gilles/"); + + create_dir(config_dir_str); + free(config_dir_str); +} + + +int main(int argc, char** argv) +{ + + Parameters* p = malloc(sizeof(Parameters)); + GillesSettings* gs = malloc(sizeof(GillesSettings));; + + ConfigError ppe = getParameters(argc, argv, p); + if (ppe == E_SUCCESS_AND_EXIT) + { + goto cleanup_final; + } + gs->program_action = p->program_action; + + char* home_dir_str = gethome(); + create_user_dir("/.config/"); + create_user_dir("/.cache/"); + char* config_file_str = ( char* ) malloc(1 + strlen(home_dir_str) + strlen("/.config/") + strlen("gilles/gilles.config")); + char* cache_dir_str = ( char* ) malloc(1 + strlen(home_dir_str) + strlen("/.cache/gilles/")); + strcpy(config_file_str, home_dir_str); + strcat(config_file_str, "/.config/"); + strcpy(cache_dir_str, home_dir_str); + strcat(cache_dir_str, "/.cache/gilles/"); + strcat(config_file_str, "gilles/gilles.config"); + + slog_config_t slgCfg; + slog_config_get(&slgCfg); + slgCfg.eColorFormat = SLOG_COLORING_TAG; + slgCfg.eDateControl = SLOG_TIME_ONLY; + strcpy(slgCfg.sFileName, "gilles.log"); + strcpy(slgCfg.sFilePath, cache_dir_str); + slgCfg.nTraceTid = 0; + slgCfg.nToScreen = 1; + slgCfg.nUseHeap = 0; + slgCfg.nToFile = 1; + slgCfg.nFlush = 0; + slgCfg.nFlags = SLOG_FLAGS_ALL; + slog_config_set(&slgCfg); + if (p->verbosity_count < 2) + { + slog_disable(SLOG_TRACE); + } + if (p->verbosity_count < 1) + { + slog_disable(SLOG_DEBUG); + } + /* + slogi("Loading configuration file: %s", config_file_str); + config_t cfg; + config_init(&cfg); + config_setting_t* config_devices = NULL; + + Metric* m = malloc(sizeof(Metric)); + if (!config_read_file(&cfg, config_file_str)) + { + fprintf(stderr, "%s:%d - %s\n", config_error_file(&cfg), config_error_line(&cfg), config_error_text(&cfg)); + } + else + { + slogi("Openend raceengineer configuration file"); + config_devices = config_lookup(&cfg, "monitor"); + config_setting_t* config_device = config_setting_get_elem(config_devices, 0); + + + + config_setting_lookup_string(config_device, "name", &m->name); + + config_setting_lookup_string(config_device, "afile0", &m->afile0); + config_setting_lookup_string(config_device, "afile1", &m->afile1); + config_setting_lookup_string(config_device, "afile2", &m->afile2); + + config_setting_lookup_float(config_device, "thresh1", &m->thresh1); + config_setting_lookup_float(config_device, "thresh2", &m->thresh2); + } + */ + looper(1); + + free(config_file_str); + free(cache_dir_str); + + + +configcleanup: + //config_destroy(&cfg); + +cleanup_final: + free(gs); + free(p); + exit(0); +} + + diff --git a/src/gilles/helper/CMakeLists.txt b/src/gilles/helper/CMakeLists.txt new file mode 100644 index 0000000..1b12205 --- /dev/null +++ b/src/gilles/helper/CMakeLists.txt @@ -0,0 +1,10 @@ +set(helper_source_files + parameters.c + parameters.h + dirhelper.c + dirhelper.h + confighelper.c + confighelper.h +) + +add_library(helper STATIC ${helper_source_files}) diff --git a/src/gilles/helper/confighelper.c b/src/gilles/helper/confighelper.c new file mode 100644 index 0000000..8c63c82 --- /dev/null +++ b/src/gilles/helper/confighelper.c @@ -0,0 +1,38 @@ +#include +#include +#include +#include + + +#include "confighelper.h" + +#include "../slog/slog.h" + +int strtogame(const char* game, GillesSettings* gs) +{ + slogd("Checking for %s in list of supported simulators.", game); + if (strcmp(game, "ac") == 0) + { + slogd("Setting simulator to Assetto Corsa"); + gs->sim_name = SIMULATOR_ASSETTO_CORSA; + } + else + if (strcmp(game, "test") == 0) + { + slogd("Setting simulator to Test Data"); + gs->sim_name = SIMULATOR_GILLES_TEST; + } + else + { + slogi("%s does not appear to be a supported simulator.", game); + return GILLES_ERROR_INVALID_SIM; + } + return GILLES_ERROR_NONE; +} + + +int loadconfig(const char* config_file) +{ + return 0; +} + diff --git a/src/gilles/helper/confighelper.h b/src/gilles/helper/confighelper.h new file mode 100644 index 0000000..f3cc24b --- /dev/null +++ b/src/gilles/helper/confighelper.h @@ -0,0 +1,46 @@ +#ifndef _CONFIGHELPER_H +#define _CONFIGHELPER_H + +#include +#include + +#include + +#include "parameters.h" + +typedef enum +{ + SIMULATOR_GILLES_TEST = 0, + SIMULATOR_ASSETTO_CORSA = 1 +} +Simulator; + +typedef enum +{ + SIMULATOR_UPDATE_DEFAULT = 0, + SIMULATOR_UPDATE_RPMS = 1, + SIMULATOR_UPDATE_GEAR = 2, + SIMULATOR_UPDATE_PULSES = 3, + SIMULATOR_UPDATE_VELOCITY = 4, +} +SimulatorUpdate; + +typedef enum +{ + GILLES_ERROR_NONE = 0, + GILLES_ERROR_UNKNOWN = 1, + GILLES_ERROR_INVALID_SIM = 2, + GILLES_ERROR_NODATA = 4, +} +GillesError; + +typedef struct +{ + ProgramAction program_action; + Simulator sim_name; +} +GillesSettings; + +int strtogame(const char* game, GillesSettings* gs); + +#endif diff --git a/src/gilles/helper/dirhelper.c b/src/gilles/helper/dirhelper.c new file mode 100644 index 0000000..49b9ade --- /dev/null +++ b/src/gilles/helper/dirhelper.c @@ -0,0 +1,202 @@ +#include "dirhelper.h" + +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +#include + +char* gethome() +{ + char* homedir = getenv("HOME"); + return homedir; + + if (homedir != NULL) + { + printf("Home dir in enviroment"); + printf("%s\n", homedir); + } + + uid_t uid = getuid(); + struct passwd* pw = getpwuid(uid); + + if (pw == NULL) + { + printf("Failed\n"); + exit(EXIT_FAILURE); + } + + return pw->pw_dir; +} + +time_t get_file_creation_time(char* path) +{ + struct stat attr; + stat(path, &attr); + return attr.st_mtime; +} + +void delete_dir(char* path) +{ + + struct dirent* de; + DIR* dr = opendir(path); + + if (dr == NULL) + { + printf("Could not open current directory"); + } + + // Refer http://pubs.opengroup.org/onlinepubs/7990989775/xsh/readdir.html + while ((de = readdir(dr)) != NULL) + { + char* fullpath = ( char* ) malloc(1 + strlen(path) + strlen("/") + strlen(de->d_name)); + strcpy(fullpath, path); + strcat(fullpath, "/"); + strcat(fullpath, de->d_name); + unlink(fullpath); + free(fullpath); + } + closedir(dr); + rmdir(path); + +} + +void delete_oldest_dir(char* path) +{ + char* oldestdir = path; + + struct dirent* de; + DIR* dr = opendir(path); + + if (dr == NULL) + { + printf("Could not open current directory"); + } + + // Refer http://pubs.opengroup.org/onlinepubs/7990989775/xsh/readdir.html + char filename_qfd[100] ; + char* deletepath = NULL; + time_t tempoldest = 0; + while ((de = readdir(dr)) != NULL) + { + struct stat stbuf; + + if (strcmp(de->d_name, ".") == 0 || strcmp(de->d_name, "..") == 0) + { + continue; + } + + char* fullpath = ( char* ) malloc(1 + strlen(path) + strlen(de->d_name)); + strcpy(fullpath, path); + strcat(fullpath, de->d_name); + + stat(fullpath, &stbuf); + if (S_ISDIR(stbuf.st_mode)) + { + strcpy(fullpath, path); + strcat(fullpath, de->d_name); + if (tempoldest == 0) + { + tempoldest = get_file_creation_time(fullpath); + free(deletepath); + deletepath = strdup(fullpath); + } + else + { + time_t t = get_file_creation_time(fullpath); + double diff = tempoldest - t; + if (diff > 0) + { + tempoldest = t; + free(deletepath); + deletepath = strdup(fullpath); + } + } + + } + + free(fullpath); + } + closedir(dr); + delete_dir(deletepath); + free(deletepath); +} + +void restrict_folders_to_cache(char* path, int cachesize) +{ + int numfolders = 0; + + struct dirent* de; + DIR* dr = opendir(path); + + if (dr == NULL) + { + printf("Could not open current directory"); + } + + // Refer http://pubs.opengroup.org/onlinepubs/7990989775/xsh/readdir.html + while ((de = readdir(dr)) != NULL) + { + + if (strcmp(de->d_name, ".") == 0 || strcmp(de->d_name, "..") == 0) + { + continue; + } + + char* fullpath = ( char* ) malloc(1 + strlen(path) + strlen(de->d_name)); + strcpy(fullpath, path); + strcat(fullpath, de->d_name); + strcat(fullpath, "/"); + + struct stat stbuf; + stat(fullpath,&stbuf); + + if (S_ISDIR(stbuf.st_mode)) + { + numfolders++; + } + free(fullpath); + } + + while (numfolders >= cachesize) + { + delete_oldest_dir(path); + numfolders--; + } + closedir(dr); + +} + +bool does_directory_exist(char* path, char* dirname) +{ + struct dirent* de; + DIR* dr = opendir(path); + + if (dr == NULL) + { + printf("Could not open current directory"); + return false; + } + + // Refer http://pubs.opengroup.org/onlinepubs/7990989775/xsh/readdir.html + bool answer = false; + while ((de = readdir(dr)) != NULL) + { + if (strcmp(dirname,de->d_name) == 0) + { + answer = true; + } + } + + closedir(dr); + return answer; +} + diff --git a/src/gilles/helper/dirhelper.h b/src/gilles/helper/dirhelper.h new file mode 100644 index 0000000..a95ea4e --- /dev/null +++ b/src/gilles/helper/dirhelper.h @@ -0,0 +1,12 @@ +#ifndef _DIRHELPER_H +#define _DIRHELPER_H + +#include + +char* gethome(); +char* str2md5(const char* str, int length); +bool does_directory_exist(char* path, char* dirname); +void restrict_folders_to_cache(char* path, int cachesize); +void delete_dir(char* path); + +#endif diff --git a/src/gilles/helper/parameters.c b/src/gilles/helper/parameters.c new file mode 100644 index 0000000..2956c84 --- /dev/null +++ b/src/gilles/helper/parameters.c @@ -0,0 +1,74 @@ +#include "parameters.h" +#include +#include +#include + +#include + +#include +#include + +ConfigError getParameters(int argc, char** argv, Parameters* p) +{ + + ConfigError exitcode = E_SOMETHING_BAD; + + // set return structure defaults + p->program_action = 0; + p->max_revs = 0; + p->verbosity_count = 0; + + // setup argument handling structures + const char* progname = "csimtelem"; + + struct arg_lit* arg_verbosity1 = arg_litn("v","verbose", 0, 2, "increase logging verbosity"); + struct arg_lit* arg_verbosity2 = arg_litn("v","verbose", 0, 2, "increase logging verbosity"); + + struct arg_rex* cmd1 = arg_rex1(NULL, NULL, "play", NULL, REG_ICASE, NULL); + struct arg_str* arg_sim = arg_strn("s", "sim", "", 0, 1, NULL); + struct arg_lit* help = arg_litn(NULL,"help", 0, 1, "print this help and exit"); + struct arg_lit* vers = arg_litn(NULL,"version", 0, 1, "print version information and exit"); + struct arg_end* end = arg_end(20); + void* argtable[] = {cmd1,arg_sim,arg_verbosity1,help,vers,end}; + int nerrors; + + + + if (arg_nullcheck(argtable) != 0) + { + printf("%s: insufficient memory\n",progname); + goto cleanup; + } + + nerrors = arg_parse(argc,argv,argtable); + + if (nerrors==0) + { + p->program_action = A_PLAY; + p->sim_string = arg_sim->sval[0]; + p->verbosity_count = arg_verbosity1->count; + exitcode = E_SUCCESS_AND_DO; + } + + // interpret some special cases before we go through trouble of reading the config file + if (help->count > 0) + { + printf("Usage: %s\n", progname); + printf("\nReport bugs on the github github.com/spacefreak18/csimtelem.\n"); + exitcode = E_SUCCESS_AND_EXIT; + goto cleanup; + } + + if (vers->count > 0) + { + printf("%s Simulator Hardware Manager\n",progname); + printf("October 2022, Paul Dino Jones\n"); + exitcode = E_SUCCESS_AND_EXIT; + goto cleanup; + } + +cleanup: + arg_freetable(argtable,sizeof(argtable)/sizeof(argtable[0])); + return exitcode; + +} diff --git a/src/gilles/helper/parameters.h b/src/gilles/helper/parameters.h new file mode 100644 index 0000000..b3f3776 --- /dev/null +++ b/src/gilles/helper/parameters.h @@ -0,0 +1,44 @@ +#ifndef _PARAMETERS_H +#define _PARAMETERS_H + +typedef struct +{ + int program_action; + const char* sim_string; + const char* save_file; + int max_revs; + int granularity; + int verbosity_count; +} +Parameters; + +typedef enum +{ + A_PLAY = 0, + A_CONFIG_TACH = 1, + A_CONFIG_SHAKER = 2 +} +ProgramAction; + +typedef enum +{ + E_SUCCESS_AND_EXIT = 0, + E_SUCCESS_AND_DO = 1, + E_SOMETHING_BAD = 2 +} +ConfigError; + +ConfigError getParameters(int argc, char** argv, Parameters* p); + +struct _errordesc +{ + int code; + char* message; +} static errordesc[] = +{ + { E_SUCCESS_AND_EXIT, "No error and exiting" }, + { E_SUCCESS_AND_DO, "No error and continuing" }, + { E_SOMETHING_BAD, "Something bad happened" }, +}; + +#endif diff --git a/src/gilles/simulatorapi/CMakeLists.txt b/src/gilles/simulatorapi/CMakeLists.txt new file mode 100644 index 0000000..07abbb2 --- /dev/null +++ b/src/gilles/simulatorapi/CMakeLists.txt @@ -0,0 +1,15 @@ +set(simulatorapi_source_files + simapi/simapi/simmapper.c + simapi/simapi/simmapper.h + simapi/simapi/simdata.h + simapi/simapi/test.h + simapi/include/acdata.h + simapi/include/rf2data.h + simapi/simmap/basicmap.h + simapi/simmap/mapacdata.c + simapi/simmap/mapacdata.h + simapi/simapi/ac.h + simapi/simapi/rf2.h +) + +add_library(simulatorapi STATIC ${simulatorapi_source_files}) diff --git a/src/gilles/simulatorapi/simapi b/src/gilles/simulatorapi/simapi new file mode 160000 index 0000000..7573d60 --- /dev/null +++ b/src/gilles/simulatorapi/simapi @@ -0,0 +1 @@ +Subproject commit 7573d606e12511eefc0f8daf6b0b6c56c189162e diff --git a/src/gilles/slog/CMakeLists.txt b/src/gilles/slog/CMakeLists.txt new file mode 100644 index 0000000..9196925 --- /dev/null +++ b/src/gilles/slog/CMakeLists.txt @@ -0,0 +1,6 @@ +set(slog_source_files + slog.c + slog.h +) + +add_library(slog STATIC ${slog_source_files}) diff --git a/src/gilles/slog/slog.c b/src/gilles/slog/slog.c new file mode 100644 index 0000000..d67d87d --- /dev/null +++ b/src/gilles/slog/slog.c @@ -0,0 +1,546 @@ +/* + * The MIT License (MIT) + * + * Copyleft (C) 2015-2020 Sun Dro (f4tb0y@protonmail.com) + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE + */ + +#ifndef _GNU_SOURCE +#define _GNU_SOURCE +#endif + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "slog.h" + +#if !defined(__APPLE__) && !defined(DARWIN) && !defined(WIN32) +#include +#endif +#include + +#ifdef WIN32 +#include +#endif + +#ifndef PTHREAD_MUTEX_RECURSIVE +#define PTHREAD_MUTEX_RECURSIVE PTHREAD_MUTEX_RECURSIVE_NP +#endif + +typedef struct slog +{ + unsigned int nTdSafe:1; + pthread_mutex_t mutex; + slog_config_t config; +} slog_t; + +typedef struct XLogCtx +{ + const char* pFormat; + slog_flag_t eFlag; + slog_date_t date; + uint8_t nFullColor; + uint8_t nNewLine; +} slog_context_t; + +static slog_t g_slog; + +static void slog_sync_init(slog_t* pSlog) +{ + if (!pSlog->nTdSafe) + { + return; + } + pthread_mutexattr_t mutexAttr; + + if (pthread_mutexattr_init(&mutexAttr) || + pthread_mutexattr_settype(&mutexAttr, PTHREAD_MUTEX_RECURSIVE) || + pthread_mutex_init(&pSlog->mutex, &mutexAttr) || + pthread_mutexattr_destroy(&mutexAttr)) + { + printf("<%s:%d> %s: [ERROR] Can not initialize mutex: %d\n", + __FILE__, __LINE__, __FUNCTION__, errno); + + exit(EXIT_FAILURE); + } +} + +static void slog_lock(slog_t* pSlog) +{ + if (pSlog->nTdSafe && pthread_mutex_lock(&pSlog->mutex)) + { + printf("<%s:%d> %s: [ERROR] Can not lock mutex: %d\n", + __FILE__, __LINE__, __FUNCTION__, errno); + + exit(EXIT_FAILURE); + } +} + +static void slog_unlock(slog_t* pSlog) +{ + if (pSlog->nTdSafe && pthread_mutex_unlock(&pSlog->mutex)) + { + printf("<%s:%d> %s: [ERROR] Can not unlock mutex: %d\n", + __FILE__, __LINE__, __FUNCTION__, errno); + + exit(EXIT_FAILURE); + } +} + +static const char* slog_get_indent(slog_flag_t eFlag) +{ + slog_config_t* pCfg = &g_slog.config; + if (!pCfg->nIndent) + { + return SLOG_EMPTY; + } + + switch (eFlag) + { + case SLOG_NOTAG: + return SLOG_INDENT; + case SLOG_NOTE: + case SLOG_INFO: + case SLOG_WARN: + return SLOG_SPACE; + case SLOG_DEBUG: + case SLOG_TRACE: + case SLOG_FATAL: + case SLOG_ERROR: + default: + break; + } + + return SLOG_EMPTY; +} + +static const char* slog_get_tag(slog_flag_t eFlag) +{ + switch (eFlag) + { + case SLOG_NOTE: + return "note"; + case SLOG_INFO: + return "info"; + case SLOG_WARN: + return "warn"; + case SLOG_DEBUG: + return "debug"; + case SLOG_ERROR: + return "error"; + case SLOG_TRACE: + return "trace"; + case SLOG_FATAL: + return "fatal"; + default: + break; + } + + return NULL; +} + +static const char* slog_get_color(slog_flag_t eFlag) +{ + switch (eFlag) + { + case SLOG_NOTAG: + case SLOG_NOTE: + return SLOG_EMPTY; + case SLOG_INFO: + return SLOG_COLOR_GREEN; + case SLOG_WARN: + return SLOG_COLOR_YELLOW; + case SLOG_DEBUG: + return SLOG_COLOR_BLUE; + case SLOG_ERROR: + return SLOG_COLOR_RED; + case SLOG_TRACE: + return SLOG_COLOR_CYAN; + case SLOG_FATAL: + return SLOG_COLOR_MAGENTA; + default: + break; + } + + return SLOG_EMPTY; +} + +uint8_t slog_get_usec() +{ + struct timeval tv; + if (gettimeofday(&tv, NULL) < 0) + { + return 0; + } + return (uint8_t)(tv.tv_usec / 10000); +} + +void slog_get_date(slog_date_t* pDate) +{ + struct tm timeinfo; + time_t rawtime = time(NULL); +#ifdef WIN32 + localtime_s(&timeinfo, &rawtime); +#else + localtime_r(&rawtime, &timeinfo); +#endif + + pDate->nYear = timeinfo.tm_year + 1900; + pDate->nMonth = timeinfo.tm_mon + 1; + pDate->nDay = timeinfo.tm_mday; + pDate->nHour = timeinfo.tm_hour; + pDate->nMin = timeinfo.tm_min; + pDate->nSec = timeinfo.tm_sec; + pDate->nUsec = slog_get_usec(); +} + +static uint32_t slog_get_tid() +{ +#if defined(__APPLE__) || defined(DARWIN) || defined(WIN32) + return (uint32_t)pthread_self(); +#else + return syscall(__NR_gettid); +#endif +} + +static void slog_create_tag(char* pOut, size_t nSize, slog_flag_t eFlag, const char* pColor) +{ + slog_config_t* pCfg = &g_slog.config; + pOut[0] = SLOG_NUL; + + const char* pIndent = slog_get_indent(eFlag); + const char* pTag = slog_get_tag(eFlag); + + if (pTag == NULL) + { + snprintf(pOut, nSize, pIndent); + return; + } + + if (pCfg->eColorFormat != SLOG_COLORING_TAG) + { + snprintf(pOut, nSize, "<%s>%s", pTag, pIndent); + } + else + { + snprintf(pOut, nSize, "%s<%s>%s%s", pColor, pTag, SLOG_COLOR_RESET, pIndent); + } +} + +static void slog_create_tid(char* pOut, int nSize, uint8_t nTraceTid) +{ + if (!nTraceTid) + { + pOut[0] = SLOG_NUL; + } + else + { + snprintf(pOut, nSize, "(%u) ", slog_get_tid()); + } +} + +static void slog_display_message(const slog_context_t* pCtx, const char* pInfo, int nInfoLen, const char* pInput) +{ + slog_config_t* pCfg = &g_slog.config; + int nCbVal = 1; + + const char* pSeparator = nInfoLen > 0 ? pCfg->sSeparator : SLOG_EMPTY; + const char* pReset = pCtx->nFullColor ? SLOG_COLOR_RESET : SLOG_EMPTY; + const char* pNewLine = pCtx->nNewLine ? SLOG_NEWLINE : SLOG_EMPTY; + const char* pMessage = pInput != NULL ? pInput : SLOG_EMPTY; + + if (pCfg->logCallback != NULL) + { + size_t nLength = 0; + char* pLog = NULL; + + nLength += asprintf(&pLog, "%s%s%s%s%s", pInfo, pSeparator, pMessage, pReset, pNewLine); + if (pLog != NULL) + { + nCbVal = pCfg->logCallback(pLog, nLength, pCtx->eFlag, pCfg->pCallbackCtx); + free(pLog); + } + } + + if (pCfg->nToScreen && nCbVal > 0) + { + printf("%s%s%s%s%s", pInfo, pSeparator, pMessage, pReset, pNewLine); + if (pCfg->nFlush) + { + fflush(stdout); + } + } + + if (!pCfg->nToFile || nCbVal < 0) + { + return; + } + const slog_date_t* pDate = &pCtx->date; + + char sFilePath[SLOG_PATH_MAX + SLOG_NAME_MAX + SLOG_DATE_MAX]; + snprintf(sFilePath, sizeof(sFilePath), "%s/%s-%04d-%02d-%02d.log", + pCfg->sFilePath, pCfg->sFileName, pDate->nYear, pDate->nMonth, pDate->nDay); + + FILE* pFile = fopen(sFilePath, "a"); + if (pFile == NULL) + { + return; + } + + fprintf(pFile, "%s%s%s%s%s", pInfo, pSeparator, pMessage, pReset, pNewLine); + fclose(pFile); +} + +static int slog_create_info(const slog_context_t* pCtx, char* pOut, size_t nSize) +{ + slog_config_t* pCfg = &g_slog.config; + const slog_date_t* pDate = &pCtx->date; + + char sDate[SLOG_DATE_MAX + SLOG_NAME_MAX]; + sDate[0] = SLOG_NUL; + + if (pCfg->eDateControl == SLOG_TIME_ONLY) + { + snprintf(sDate, sizeof(sDate), "%02d:%02d:%02d.%03d ", + pDate->nHour,pDate->nMin, pDate->nSec, pDate->nUsec); + } + else + if (pCfg->eDateControl == SLOG_DATE_FULL) + { + snprintf(sDate, sizeof(sDate), "%04d.%02d.%02d-%02d:%02d:%02d.%03d ", + pDate->nYear, pDate->nMonth, pDate->nDay, pDate->nHour, + pDate->nMin, pDate->nSec, pDate->nUsec); + } + + char sTid[SLOG_TAG_MAX], sTag[SLOG_TAG_MAX]; + const char* pColorCode = slog_get_color(pCtx->eFlag); + const char* pColor = pCtx->nFullColor ? pColorCode : SLOG_EMPTY; + + slog_create_tid(sTid, sizeof(sTid), pCfg->nTraceTid); + slog_create_tag(sTag, sizeof(sTag), pCtx->eFlag, pColorCode); + return snprintf(pOut, nSize, "%s%s%s%s", pColor, sTid, sDate, sTag); +} + +static void slog_display_heap(const slog_context_t* pCtx, va_list args) +{ + size_t nBytes = 0; + char* pMessage = NULL; + char sLogInfo[SLOG_INFO_MAX]; + + nBytes += vasprintf(&pMessage, pCtx->pFormat, args); + va_end(args); + + if (pMessage == NULL) + { + printf("<%s:%d> %s%s %s: Can not allocate memory for input: errno(%d)\n", + __FILE__, __LINE__, SLOG_COLOR_RED, SLOG_COLOR_RESET, __FUNCTION__, errno); + + return; + } + + int nLength = slog_create_info(pCtx, sLogInfo, sizeof(sLogInfo)); + slog_display_message(pCtx, sLogInfo, nLength, pMessage); + if (pMessage != NULL) + { + free(pMessage); + } +} + +static void slog_display_stack(const slog_context_t* pCtx, va_list args) +{ + char sMessage[SLOG_MESSAGE_MAX]; + char sLogInfo[SLOG_INFO_MAX]; + + vsnprintf(sMessage, sizeof(sMessage), pCtx->pFormat, args); + int nLength = slog_create_info(pCtx, sLogInfo, sizeof(sLogInfo)); + slog_display_message(pCtx, sLogInfo, nLength, sMessage); +} + +void slog_display(slog_flag_t eFlag, uint8_t nNewLine, const char* pFormat, ...) +{ + slog_lock(&g_slog); + slog_config_t* pCfg = &g_slog.config; + + if ((SLOG_FLAGS_CHECK(g_slog.config.nFlags, eFlag)) && + (g_slog.config.nToScreen || g_slog.config.nToFile)) + { + slog_context_t ctx; + slog_get_date(&ctx.date); + + ctx.eFlag = eFlag; + ctx.pFormat = pFormat; + ctx.nNewLine = nNewLine; + ctx.nFullColor = pCfg->eColorFormat == SLOG_COLORING_FULL ? 1 : 0; + + void(*slog_display_args)(const slog_context_t* pCtx, va_list args); + slog_display_args = pCfg->nUseHeap ? slog_display_heap : slog_display_stack; + + va_list args; + va_start(args, pFormat); + slog_display_args(&ctx, args); + va_end(args); + } + + slog_unlock(&g_slog); +} + +size_t slog_version(char* pDest, size_t nSize, uint8_t nMin) +{ + size_t nLength = 0; + + /* Version short */ + if (nMin) + nLength = snprintf(pDest, nSize, "%d.%d.%d", + SLOG_VERSION_MAJOR, SLOG_VERSION_MINOR, SLOG_BUILD_NUM); + + /* Version long */ + else + nLength = snprintf(pDest, nSize, "%d.%d build %d (%s)", + SLOG_VERSION_MAJOR, SLOG_VERSION_MINOR, SLOG_BUILD_NUM, __DATE__); + + return nLength; +} + +void slog_config_get(slog_config_t* pCfg) +{ + slog_lock(&g_slog); + *pCfg = g_slog.config; + slog_unlock(&g_slog); +} + +void slog_config_set(slog_config_t* pCfg) +{ + slog_lock(&g_slog); + g_slog.config = *pCfg; + slog_unlock(&g_slog); +} + +void slog_enable(slog_flag_t eFlag) +{ + slog_lock(&g_slog); + + if (!SLOG_FLAGS_CHECK(g_slog.config.nFlags, eFlag)) + { + g_slog.config.nFlags |= eFlag; + } + + slog_unlock(&g_slog); +} + +void slog_disable(slog_flag_t eFlag) +{ + slog_lock(&g_slog); + + if (SLOG_FLAGS_CHECK(g_slog.config.nFlags, eFlag)) + { + g_slog.config.nFlags &= ~eFlag; + } + + slog_unlock(&g_slog); +} + +void slog_separator_set(const char* pFormat, ...) +{ + slog_lock(&g_slog); + slog_config_t* pCfg = &g_slog.config; + + va_list args; + va_start(args, pFormat); + + if (vsnprintf(pCfg->sSeparator, sizeof(pCfg->sSeparator), pFormat, args) <= 0) + { + pCfg->sSeparator[0] = ' '; + pCfg->sSeparator[1] = '\0'; + } + + va_end(args); + slog_unlock(&g_slog); +} + +void slog_indent(uint8_t nEnable) +{ + slog_lock(&g_slog); + g_slog.config.nIndent = nEnable; + slog_unlock(&g_slog); +} + +void slog_callback_set(slog_cb_t callback, void* pContext) +{ + slog_lock(&g_slog); + slog_config_t* pCfg = &g_slog.config; + pCfg->pCallbackCtx = pContext; + pCfg->logCallback = callback; + slog_unlock(&g_slog); +} + +void slog_init(const char* pName, uint16_t nFlags, uint8_t nTdSafe) +{ + /* Set up default values */ + slog_config_t* pCfg = &g_slog.config; + pCfg->eColorFormat = SLOG_COLORING_TAG; + pCfg->eDateControl = SLOG_TIME_ONLY; + pCfg->pCallbackCtx = NULL; + pCfg->logCallback = NULL; + pCfg->sSeparator[0] = ' '; + pCfg->sSeparator[1] = '\0'; + pCfg->sFilePath[0] = '.'; + pCfg->sFilePath[1] = '\0'; + pCfg->nTraceTid = 0; + pCfg->nToScreen = 1; + pCfg->nUseHeap = 0; + pCfg->nToFile = 0; + pCfg->nIndent = 0; + pCfg->nFlush = 0; + pCfg->nFlags = nFlags; + + const char* pFileName = (pName != NULL) ? pName : SLOG_NAME_DEFAULT; + snprintf(pCfg->sFileName, sizeof(pCfg->sFileName), "%s", pFileName); + +#ifdef WIN32 + // Enable color support + HANDLE hOutput = GetStdHandle(STD_OUTPUT_HANDLE); + DWORD dwMode = 0; + GetConsoleMode(hOutput, &dwMode); + dwMode |= ENABLE_PROCESSED_OUTPUT | ENABLE_VIRTUAL_TERMINAL_PROCESSING; + SetConsoleMode(hOutput, dwMode); +#endif + + /* Initialize mutex */ + g_slog.nTdSafe = nTdSafe; + slog_sync_init(&g_slog); +} + +void slog_destroy() +{ + g_slog.config.pCallbackCtx = NULL; + g_slog.config.logCallback = NULL; + + if (g_slog.nTdSafe) + { + pthread_mutex_destroy(&g_slog.mutex); + g_slog.nTdSafe = 0; + } +} \ No newline at end of file diff --git a/src/gilles/slog/slog.h b/src/gilles/slog/slog.h new file mode 100644 index 0000000..bb53e1e --- /dev/null +++ b/src/gilles/slog/slog.h @@ -0,0 +1,195 @@ +/* + * The MIT License (MIT) + * + * Copyleft (C) 2015-2020 Sun Dro (f4tb0y@protonmail.com) + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE + */ + +#ifndef __SLOG_H__ +#define __SLOG_H__ + +#ifdef __cplusplus +extern "C" { +#endif + +#include +#include + +/* SLog version information */ +#define SLOG_VERSION_MAJOR 1 +#define SLOG_VERSION_MINOR 8 +#define SLOG_BUILD_NUM 26 + +/* Supported colors */ +#define SLOG_COLOR_NORMAL "\x1B[0m" +#define SLOG_COLOR_RED "\x1B[31m" +#define SLOG_COLOR_GREEN "\x1B[32m" +#define SLOG_COLOR_YELLOW "\x1B[33m" +#define SLOG_COLOR_BLUE "\x1B[34m" +#define SLOG_COLOR_MAGENTA "\x1B[35m" +#define SLOG_COLOR_CYAN "\x1B[36m" +#define SLOG_COLOR_WHITE "\x1B[37m" +#define SLOG_COLOR_RESET "\033[0m" + +/* Trace source location helpers */ +#define SLOG_TRACE_LVL1(LINE) #LINE +#define SLOG_TRACE_LVL2(LINE) SLOG_TRACE_LVL1(LINE) +#define SLOG_THROW_LOCATION "[" __FILE__ ":" SLOG_TRACE_LVL2(__LINE__) "] " + +/* SLog limits (To be safe while avoiding dynamic allocations) */ +#define SLOG_MESSAGE_MAX 8196 +#define SLOG_VERSION_MAX 128 +#define SLOG_PATH_MAX 2048 +#define SLOG_INFO_MAX 512 +#define SLOG_NAME_MAX 256 +#define SLOG_DATE_MAX 64 +#define SLOG_TAG_MAX 32 +#define SLOG_COLOR_MAX 16 + +#define SLOG_FLAGS_CHECK(c, f) (((c) & (f)) == (f)) +#define SLOG_FLAGS_ALL 255 + +#define SLOG_NAME_DEFAULT "slog" +#define SLOG_NEWLINE "\n" +#define SLOG_INDENT " " +#define SLOG_SPACE " " +#define SLOG_EMPTY "" +#define SLOG_NUL '\0' + +typedef struct SLogDate +{ + uint16_t nYear; + uint8_t nMonth; + uint8_t nDay; + uint8_t nHour; + uint8_t nMin; + uint8_t nSec; + uint8_t nUsec; +} slog_date_t; + +uint8_t slog_get_usec(); +void slog_get_date(slog_date_t* pDate); + +/* Log level flags */ +typedef enum +{ + SLOG_NOTAG = (1 << 0), + SLOG_NOTE = (1 << 1), + SLOG_INFO = (1 << 2), + SLOG_WARN = (1 << 3), + SLOG_DEBUG = (1 << 4), + SLOG_TRACE = (1 << 5), + SLOG_ERROR = (1 << 6), + SLOG_FATAL = (1 << 7) +} slog_flag_t; + +typedef int(*slog_cb_t)(const char* pLog, size_t nLength, slog_flag_t eFlag, void* pCtx); + +/* Output coloring control flags */ +typedef enum +{ + SLOG_COLORING_DISABLE = 0, + SLOG_COLORING_TAG, + SLOG_COLORING_FULL +} slog_coloring_t; + +typedef enum +{ + SLOG_TIME_DISABLE = 0, + SLOG_TIME_ONLY, + SLOG_DATE_FULL +} slog_date_ctrl_t; + +#define slog(...) \ + slog_display(SLOG_NOTAG, 1, __VA_ARGS__) + +#define slogwn(...) \ + slog_display(SLOG_NOTAG, 0, __VA_ARGS__) + +#define slog_note(...) \ + slog_display(SLOG_NOTE, 1, __VA_ARGS__) + +#define slog_info(...) \ + slog_display(SLOG_INFO, 1, __VA_ARGS__) + +#define slog_warn(...) \ + slog_display(SLOG_WARN, 1, __VA_ARGS__) + +#define slog_debug(...) \ + slog_display(SLOG_DEBUG, 1, __VA_ARGS__) + +#define slog_error(...) \ + slog_display(SLOG_ERROR, 1, __VA_ARGS__) + +#define slog_trace(...) \ + slog_display(SLOG_TRACE, 1, SLOG_THROW_LOCATION __VA_ARGS__) + +#define slog_fatal(...) \ + slog_display(SLOG_FATAL, 1, SLOG_THROW_LOCATION __VA_ARGS__) + +/* Short name definitions */ +#define slogn(...) slog_note(__VA_ARGS__) +#define slogi(...) slog_info(__VA_ARGS__) +#define slogw(...) slog_warn(__VA_ARGS__) +#define slogd(...) slog_debug( __VA_ARGS__) +#define sloge(...) slog_error( __VA_ARGS__) +#define slogt(...) slog_trace(__VA_ARGS__) +#define slogf(...) slog_fatal(__VA_ARGS__) + +typedef struct SLogConfig +{ + slog_date_ctrl_t eDateControl; // Display output with date format + slog_coloring_t eColorFormat; // Output color format control + slog_cb_t logCallback; // Log callback to collect logs + void* pCallbackCtx; // Data pointer passed to log callback + + uint8_t nTraceTid; // Trace thread ID and display in output + uint8_t nToScreen; // Enable screen logging + uint8_t nUseHeap; // Use dynamic allocation + uint8_t nToFile; // Enable file logging + uint8_t nIndent; // Enable indentations + uint8_t nFlush; // Flush stdout after screen log + uint16_t nFlags; // Allowed log level flags + + char sSeparator[SLOG_NAME_MAX]; // Separator between info and log + char sFileName[SLOG_NAME_MAX]; // Output file name for logs + char sFilePath[SLOG_PATH_MAX]; // Output file path for logs +} slog_config_t; + +size_t slog_version(char* pDest, size_t nSize, uint8_t nMin); +void slog_config_get(slog_config_t* pCfg); +void slog_config_set(slog_config_t* pCfg); + +void slog_separator_set(const char* pFormat, ...); +void slog_callback_set(slog_cb_t callback, void* pContext); +void slog_indent(uint8_t nEnable); + +void slog_enable(slog_flag_t eFlag); +void slog_disable(slog_flag_t eFlag); + +void slog_init(const char* pName, uint16_t nFlags, uint8_t nTdSafe); +void slog_display(slog_flag_t eFlag, uint8_t nNewLine, const char* pFormat, ...); +void slog_destroy(); // Needed only if the slog_init() function argument nTdSafe > 0 + +#ifdef __cplusplus +} +#endif + +#endif /* __SLOG_H__ */ \ No newline at end of file