diff --git a/HSFW_management/99-edmund_hsfw.rules b/HSFW_management/99-edmund_hsfw.rules new file mode 100644 index 0000000..daadae6 --- /dev/null +++ b/HSFW_management/99-edmund_hsfw.rules @@ -0,0 +1 @@ +SUBSYSTEMS=="usb", ATTRS{idVendor}=="10c4", ATTRS{idProduct}=="82cd", MODE:="0666" diff --git a/HSFW_management/CMakeLists.txt b/HSFW_management/CMakeLists.txt new file mode 100644 index 0000000..49bfefe --- /dev/null +++ b/HSFW_management/CMakeLists.txt @@ -0,0 +1,114 @@ +cmake_minimum_required(VERSION 2.8) +set(PROJ HSFW_manage) +set(MINOR_VERSION "1") +set(MID_VERSION "0") +set(MAJOR_VERSION "0") +set(VERSION "${MAJOR_VERSION}.${MID_VERSION}.${MINOR_VERSION}") +# new policy for version control +if(POLICY CMP0048) + cmake_policy(SET CMP0048 OLD) +endif(POLICY CMP0048) + +enable_language(C) + +message("VERSION: ${VERSION}") +# default flags +set(CFLAGS -O2 -Wextra -Wall -Werror -W -std=gnu99) + +set(CMAKE_COLOR_MAKEFILE ON) + +# here is one of two variants: all .c in directory or .c files in list +aux_source_directory(${CMAKE_CURRENT_SOURCE_DIR} SOURCES) + +# cmake -DDEBUG=1 -> debugging +if(DEFINED DEBUG) + add_definitions(-DEBUG) +endif() + +# directory should contain dir locale/ru for gettext translations +set(LCPATH ${CMAKE_SOURCE_DIR}/locale/ru) + +if(NOT DEFINED LOCALEDIR) + if(DEFINED DEBUG) + set(LOCALEDIR ${CMAKE_CURRENT_SOURCE_DIR}/locale) + else() + set(LOCALEDIR ${CMAKE_INSTALL_PREFIX}/share/locale) + endif() +endif() + +###### pkgconfig ###### +# pkg-config modules (for pkg-check-modules) +set(MODULES libudev) +# find packages: +find_package(PkgConfig REQUIRED) +pkg_check_modules(${PROJ} REQUIRED ${MODULES}) +pkg_check_modules(USB libusb) +if(NOT USB_FOUND) + pkg_check_modules(USB REQUIRED libusb-1.0) +endif() + +project(${PROJ}) +# change wrong behaviour with install prefix +if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND CMAKE_INSTALL_PREFIX MATCHES "/usr/local") + message("Change default install path to /usr") + set(CMAKE_INSTALL_PREFIX "/usr") +endif() +message("Install dir prefix: ${CMAKE_INSTALL_PREFIX}") + +# gettext files +set(PO_FILE ${LCPATH}/messages.po) +set(MO_FILE ${LCPATH}/LC_MESSAGES/${PROJ}.mo) +set(RU_FILE ${LCPATH}/ru.po) + +# exe file +add_executable(${PROJ} ${SOURCES}) +# -I +include_directories(${${PROJ}_INCLUDE_DIRS} ${USB_INCLUDE_DIRS}) +# -L +link_directories(${${PROJ}_LIBRARY_DIRS} ${USB_LIBRARY_DIRS}) +# -D +add_definitions(${CFLAGS} -DLOCALEDIR=\"${LOCALEDIR}\" + -DPACKAGE_VERSION=\"${VERSION}\" -DGETTEXT_PACKAGE=\"${PROJ}\" + -DMINOR_VERSION=\"${MINOR_VERSION}\" -DMID_VERSION=\"${MID_VERSION}\" + -DMAJOR_VERSION=\"${MAJOR_VESION}\") +# -l +target_link_libraries(${PROJ} ${${PROJ}_LIBRARIES} ${USB_LIBRARIES}) + +# Installation of the program +INSTALL(FILES ${MO_FILE} DESTINATION "share/locale/ru/LC_MESSAGES") +INSTALL(TARGETS ${PROJ} DESTINATION "bin") + +###### gettext ###### +find_package(Gettext REQUIRED) +find_program(GETTEXT_XGETTEXT_EXECUTABLE xgettext) +if(NOT GETTEXT_XGETTEXT_EXECUTABLE OR NOT GETTEXT_MSGFMT_EXECUTABLE) + message(FATAL_ERROR "xgettext not found") +endif() +file(MAKE_DIRECTORY ${LCPATH}) +file(MAKE_DIRECTORY ${LCPATH}/LC_MESSAGES) + +add_custom_command( + OUTPUT ${PO_FILE} + WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} + COMMAND ${GETTEXT_XGETTEXT_EXECUTABLE} --from-code=utf-8 ${SOURCES} -c -k_ -kN_ -o ${PO_FILE} + COMMAND sed -i 's/charset=.*\\\\n/charset=koi8-r\\\\n/' ${PO_FILE} + COMMAND enconv ${PO_FILE} + DEPENDS ${SOURCES} +) + +# we need this to prewent ru.po & .mo from deleting by make clean +add_custom_command( + OUTPUT ${MO_FILE} + COMMAND ${GETTEXT_MSGFMT_EXECUTABLE} ${RU_FILE} -o ${MO_FILE} + DEPENDS ${RU_FILE} ru_file_updated +) + +add_custom_command( + OUTPUT ru_file_updated + COMMAND [ -f ${RU_FILE} ] && ${GETTEXT_MSGMERGE_EXECUTABLE} -Uis ${RU_FILE} ${PO_FILE} || cp ${PO_FILE} ${RU_FILE} + COMMAND ${CMAKE_COMMAND} -E touch ru_file_updated + BYPRODUCTS ${RU_FILE} + DEPENDS ${PO_FILE} +) + +add_custom_target(MO_FILE ALL DEPENDS ${MO_FILE}) diff --git a/HSFW_management/LICENSE b/HSFW_management/LICENSE new file mode 100644 index 0000000..70566f2 --- /dev/null +++ b/HSFW_management/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. + + {one line to give the program's name and a brief idea of what it does.} + Copyright (C) {year} {name of author} + + 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: + + {project} Copyright (C) {year} {fullname} + 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 +. \ No newline at end of file diff --git a/HSFW_management/Readme.md b/HSFW_management/Readme.md new file mode 100644 index 0000000..9c73f76 --- /dev/null +++ b/HSFW_management/Readme.md @@ -0,0 +1,3 @@ +Edmund Optics high-speed filter wheel management +================================================ + diff --git a/HSFW_management/cmdlnopts.c b/HSFW_management/cmdlnopts.c new file mode 100644 index 0000000..da25c2e --- /dev/null +++ b/HSFW_management/cmdlnopts.c @@ -0,0 +1,135 @@ +/* + * cmdlnopts.c - the only function that parse cmdln args and returns glob parameters + * + * Copyright 2013 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +#include +#include +#include +#include +#include +#include "cmdlnopts.h" +#include "usefull_macros.h" + +#define RAD 57.2957795130823 +#define D2R(x) ((x) / RAD) +#define R2D(x) ((x) * RAD) + +/* + * here are global parameters initialisation + */ +int help; +glob_pars G; + +int listNms = 0 // list names + ,gohome = 0 // first go home + ,reName = 0 // rename wheels/positions +; + + +// DEFAULTS +// default global parameters +glob_pars const Gdefault = { + NULL // wheelID + ,NULL // wheelName + ,0 // filterPos ( 0 - get current position) + ,NULL // filterName + ,NULL // filterId +}; + +/* + * Define command line options by filling structure: + * name has_arg flag val type argptr help +*/ +myoption cmdlnopts[] = { + /// "отобразить эту справку" + {"help", NO_ARGS, NULL, 'h', arg_int, APTR(&help), N_("show this help")}, + /// "буквенный идентификатор колеса" + {"wheel-id",NEED_ARG, NULL, 'W', arg_string, APTR(&G.wheelID), N_("letter wheel identificator")}, + /// "название колеса" + {"wheel-name",NEED_ARG, NULL, 'N', arg_string, APTR(&G.wheelName), N_("wheel name")}, + /// "номер позиции фильтра" + {"f-position",NEED_ARG, NULL, 'p', arg_int, APTR(&G.filterPos), N_("filter position number")}, + /// "название фильтра" + {"filter-name",NEED_ARG,NULL, 'n', arg_string, APTR(&G.filterName),N_("filter name")}, + /// "идентификатор фильтра, например, \"A3\"" + {"filter-id",NEED_ARG, NULL, 'i', arg_string, APTR(&G.filterId), N_("filter identificator like \"A3\"")}, + /// "список всех сохраненных имен" + {"list-all",NO_ARGS, &listNms,LIST_ALL,arg_none, NULL, N_("list all stored names")}, + /// "список имен только присутствующих устройств" + {"list", NO_ARGS, &listNms,LIST_PRES,arg_none,NULL, N_("list only present devices' names")}, + /// "переместиться в стартовую позицию" + {"home", NO_ARGS, NULL, 'H', arg_none, &gohome, N_("move to home position")}, + /// "переименовать сохраненные имена колес/фильтров" + {"rename", NO_ARGS, &reName,1, arg_none, NULL, N_("rename stored wheels/filters names")}, + end_option +}; + +/** + * Safely convert data from string to double + * + * @param num (o) - double number read from string + * @param str (i) - input string + * @return TRUE if success + */ +bool myatod(double *num, const char *str){ + double res; + char *endptr; + assert(str); + res = strtod(str, &endptr); + if(endptr == str || *str == '\0' || *endptr != '\0'){ + /// "Неправильный формат числа double!" + WARNX(_("Wrong double number format!")); + return FALSE; + } + *num = res; + return TRUE; +} + +/** + * Parse command line options and return dynamically allocated structure + * to global parameters + * @param argc - copy of argc from main + * @param argv - copy of argv from main + * @return allocated structure with global parameters + */ +glob_pars *parse_args(int argc, char **argv){ + int i, oldargc = argc - 1; + void *ptr; + ptr = memcpy(&G, &Gdefault, sizeof(G)); assert(ptr); + /// "Использование: %s [аргументы] [префикс выходного файла]\n\n\tГде [аргументы]:\n" + //change_helpstring(_("Usage: %s [args] [outfile prefix] [file list for group operations]\n\n\tWhere args are:\n")); + // parse arguments + parseargs(&argc, &argv, cmdlnopts); + if(help) showhelp(-1, cmdlnopts); + if(argc > 0){ + /// "Игнорируются параметры: " + WARNX(_("Ignore parameters:")); + for (i = 0; i < argc; i++){ + printf("%s\n", argv[i]); + } + } + if(argc == oldargc){ // no parameters given or given only wrong parameters + listNms = LIST_PRES; + /// "Не передано никаких аргументов, вывожу список подключенных устройств!" + WARNX(_("No arguments given, list all devices connected!")); + return &G; + } + return &G; +} + diff --git a/HSFW_management/cmdlnopts.h b/HSFW_management/cmdlnopts.h new file mode 100644 index 0000000..d5b794b --- /dev/null +++ b/HSFW_management/cmdlnopts.h @@ -0,0 +1,51 @@ +/* + * cmdlnopts.h - comand line options for parseargs + * + * Copyright 2013 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#pragma once +#ifndef __CMDLNOPTS_H__ +#define __CMDLNOPTS_H__ + +#include "parseargs.h" + +/* + * here are some typedef's for global data + */ +typedef struct{ + char *wheelID; // ID of wheel to work with + char *wheelName; // and/or its name + int filterPos; // position of filter + char *filterName; // and/or its name + char *filterId; // or full ID like "A2" +} glob_pars; + +// ids for "list all" & "list present" +#define LIST_ALL (1) +#define LIST_PRES (2) + +// default & global parameters +extern glob_pars const Gdefault; +extern int listNms, gohome, reName; + +extern glob_pars G; + +glob_pars *parse_args(int argc, char **argv); + +#endif // __CMDLNOPTS_H__ diff --git a/HSFW_management/hidmanage.c b/HSFW_management/hidmanage.c new file mode 100644 index 0000000..0c48f9b --- /dev/null +++ b/HSFW_management/hidmanage.c @@ -0,0 +1,99 @@ +/* + * hidmanage.c - manage HID devices + * + * Copyright 2016 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include +#include "usefull_macros.h" +#include "hidmanage.h" + +/** + * Find turrets present + * @param wheels (o) - if not NULL - list of wheels found (like "ABC") + * return amount of devices found + * + * WARNING! If there's more than one turret with wheels having same name + * access by wheel ID could lead undefined behaviour! + */ +int find_wheels(wheel_descr **wheels){ + struct udev *udev; + struct udev_enumerate *enumerate; + struct udev_list_entry *devices, *dev_list_entry; + wheel_descr *founded = NULL; + // Create the udev object + udev = udev_new(); + int N = 0; + if(!udev){ + ERR("Can't create udev"); + } + // Create a list of the devices in the 'hidraw' subsystem. + enumerate = udev_enumerate_new(udev); + udev_enumerate_add_match_subsystem(enumerate, "hidraw"); + udev_enumerate_scan_devices(enumerate); + devices = udev_enumerate_get_list_entry(enumerate); + // Check out each device found + udev_list_entry_foreach(dev_list_entry, devices){ + const char *path; + struct udev_device *dev; + path = udev_list_entry_get_name(dev_list_entry); + dev = udev_device_new_from_syspath(udev, path); + const char *devpath = udev_device_get_devnode(dev); + DBG("Device Node Path: %s", devpath); + dev = udev_device_get_parent_with_subsystem_devtype(dev, "usb", "usb_device"); + if(!dev){ + WARNX("Unable to find parent usb device for %s", devpath); + udev_device_unref(dev); + continue; + } + const char *vid, *pid; + vid = udev_device_get_sysattr_value(dev,"idVendor"); + pid = udev_device_get_sysattr_value(dev, "idProduct"); + DBG(" VID/PID: %s/%s", vid, pid); + if(strcmp(vid, W_VID) == 0 && strcmp(pid, W_PID) == 0){ + ++N; + if(!founded){ + founded = MALLOC(wheel_descr, 1); + }else{ + founded = realloc(founded, sizeof(wheel_descr)*N); + if(!founded) ERR("realloc"); + } + wheel_descr *curdev = &founded[N-1]; + int fd = open(devpath, O_RDWR|O_NONBLOCK); + if(fd < 0){ + /// "Не могу открыть %s" + WARN(_("Can't open %s"), devpath); + curdev->fd = -1; + }else + curdev->fd = fd; + DBG("%s %s", + udev_device_get_sysattr_value(dev,"manufacturer"), + udev_device_get_sysattr_value(dev,"product")); + curdev->serial = strdup(udev_device_get_sysattr_value(dev, "serial")); + DBG("serial: %s\n", curdev->serial); + } + udev_device_unref(dev); + } + // Free the enumerator object + udev_enumerate_unref(enumerate); + if(wheels){ + *wheels = founded; + }else + free(founded); + return N; +} diff --git a/HSFW_management/hidmanage.h b/HSFW_management/hidmanage.h new file mode 100644 index 0000000..5cb2295 --- /dev/null +++ b/HSFW_management/hidmanage.h @@ -0,0 +1,38 @@ +/* + * hidmanage.h - manage HID devices + * + * Copyright 2016 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +#pragma once +#ifndef __HIDMANAGE_H__ +#define __HIDMANAGE_H__ + +#define W_VID "10c4" +#define W_PID "82cd" + +typedef struct{ + int fd; + char *serial; + char ID; + char name[9]; + int maxpos; +} wheel_descr; + +int find_wheels(wheel_descr **wheels); + +#endif // __HIDMANAGE_H__ diff --git a/HSFW_management/hsfw.c b/HSFW_management/hsfw.c new file mode 100644 index 0000000..e22086c --- /dev/null +++ b/HSFW_management/hsfw.c @@ -0,0 +1,459 @@ +/* + * hsfw.c - functions for work with wheels + * + * Copyright 2016 Edward V. Emelianov + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include +#include +#include + +#include "cmdlnopts.h" +#include "usefull_macros.h" +#include "hsfw.h" +#include "hidmanage.h" + +// wheel Id & filter position given (if given by name - check names stored) +static int wheel_id = -1 // wheel ID given or found by name + ,filter_pos = -1 // filter position given or found by name + ,max_pos = -1 // max filter position allowed + ,wheel_fd = -1 // file descriptor of active wheel + ,HW_found = 0 // amount of wheels found +; + +static wheel_descr *wheel_chosen = NULL; // pointer to chosen wheel + +static wheel_descr *wheels = NULL; // array with descriptors of found devs + +char *get_filter_name(wheel_descr *wheel, int pos); +void list_hw(int show); +void rename_hw(); +void move_wheel(); +void set_cur_wheel(int idx); +int writereg(int fd, uint8_t *buf, int l); +int readreg(int fd, uint8_t *buf, int reg, int l); +void check_and_clear_err(int fd); +void go_home(int fd); +void list_props(_U_ int verblevl, wheel_descr *wheel); +int poll_regstatus(int fd, int msg); + +/** + * set variables pointing current wheel to wheels[idx] + */ +void set_cur_wheel(int idx){ + wheel_chosen = &wheels[idx]; + wheel_id = wheel_chosen->ID; + wheel_fd = wheel_chosen->fd; + max_pos = wheel_chosen->maxpos; +} + +/** + * Check command line arguments, find filters/wheels by name, find max positions & so on + */ +void check_args(){ + // here we fill value of wheel_id if no given and present only one turret + list_hw(listNms); // also exit if no HW found + if(listNms) return; + int i; + if(G.wheelID || G.filterId){ + char wID = (G.wheelID) ? *G.wheelID : *G.filterId; + if((wID < 'A' || wID > 'H') || (G.wheelID && strlen(G.wheelID) != 1)){ + /// "Идентификатор колеса должен быть буквой от \"A\" до \"H\"!" + ERRX(_("Wheel ID should be a letter from \"A\" to \"H\"!")); + } + wheel_id = wID; + DBG("wheel given by id: %c", wheel_id); + for(i = 0; i < HW_found; ++i){ + if(wheels[i].ID == wheel_id) + set_cur_wheel(i); + } + } + if(G.wheelName){ // find wheel by name given + if(G.wheelID){ + /// "Заданы и идентификатор, и имя колеса; попробуйте что-то одно!" + ERRX(_("You give both wheel ID and wheel name, try something one!")); + } + wheel_fd = -1; + for(i = 0; i < HW_found; ++i){ + if(strcmp(wheels[i].name, G.wheelName) == 0){ + set_cur_wheel(i); + break; + } + } + } + // if there's only one turret, fill wheel_id + if(wheel_id < 0 && HW_found == 1) + set_cur_wheel(0); + if(wheel_fd < 0 || !wheel_chosen){ + /// "Заданное колесо не обнаружено!" + ERRX(_("Given wheel not found!")); + } + if(gohome) return; + if(G.filterId){ // filter given by its id like "B3" + char *fid = G.filterId; + /// "Идентификатор фильтра состоит из буквы (колесо) и цифры (позиция)" + if(strlen(G.filterId) != 2 || fid[1] > '9' || fid[1] < '0') + ERRX(_("Filter ID is letter (wheel) and number (position)")); + filter_pos = fid[1] - '0'; + }else if(G.filterPos){ // filter given by numerical position + filter_pos = G.filterPos; + }else if(G.filterName){ // filter given by name - search it + for(i = 1; i <= max_pos; ++i){ + DBG("Search filter %s in pos %d (%s)", G.filterName, i, get_filter_name(wheel_chosen, i)); + if(strcmp(G.filterName, get_filter_name(wheel_chosen, i)) == 0){ + filter_pos = i; + break; + } + } + if(i > max_pos){ + /// "Фильтр %s не обнаружен" + ERRX(_("Filter %s not found!"), G.filterName); + } + }else{ + /// "Не задано никакого действия" + ERRX("No action given"); + } + if(filter_pos < 1 || filter_pos > max_pos){ + /// "Позиция фильтра должна быть числом от 1 до %d!" + ERRX(_("Filter position should be a number from 1 to %d!"), max_pos); + } + DBG("filter given by position: %d", filter_pos); +} + +/** + * write buf of length l to register & check answer + * return 0 if all OK + */ +int writereg(int fd, uint8_t *buf, int l){ + uint8_t reg = buf[0]; + //#if 0// + #ifdef EBUG + int i; + printf("Write reg %d:", reg); + for(i = 0; i < l; ++i) printf(" %02hhx", buf[i]); + printf("\n"); + #endif + if(ioctl(fd, HIDIOCSFEATURE(l), buf) < 0 || buf[0] != reg){ + /// "Ошибка отправки данных" + WARNX(_("Error sending data")); + return 1; + } + return 0; +} + +/** + * read register to buf & check answer + * return 0 if all OK + */ +int readreg(int fd, uint8_t *buf, int reg, int l){ + memset(buf, 0, l); + buf[0] = reg; + if(ioctl(fd, HIDIOCGFEATURE(l), buf) < 0 || buf[0] != reg){ + /// "Ошибка чтения данных" + WARNX(_("Error reading data")); + return 1; + } + //#if 0// + #ifdef EBUG + int i; + printf("Read reg %d:", reg); + for(i = 0; i < l; ++i) printf(" %02hhx", buf[i]); + printf("\n"); + #endif + return 0; +} + +/** + * Check error state and clear it if need + */ +void check_and_clear_err(int fd){ + int i, stat = 1; + uint8_t buf[REG_STATUS_LEN]; + for(i = 0; i < 10 && stat; ++i){ + stat = readreg(fd, buf, REG_STATUS, REG_STATUS_LEN); + if(stat) usleep(100000); + } + /// "Ошибка, количество попыток истекло" + if(i == 10) ERRX(_("Error, tries amount exceed")); + if(buf[1] != 0xff){ + if(buf[5]){ + /// "Ошибка No %d, сбрасываю" + //red(_("Error No %d, clear it"), buf[5]); + stat = 1; + for(i = 0; i < 10 && stat; ++i){ + memset(buf, 0, sizeof(buf)); + buf[0] = REG_CLERR; + stat = writereg(fd, buf, REG_CLERR_LEN); + usleep(100000); + if(!stat) stat = readreg(fd, buf, REG_STATUS, REG_STATUS_LEN); + if(!stat && buf[5]) stat = 1; + } + } + readreg(fd, buf, REG_STATUS, REG_STATUS_LEN); + if(buf[1] != 0xff){ + /// "Турель не инициализирована, движение в \"дом\"" + red(_("Turret isn't initialized, move home...")); + go_home(fd); + readreg(fd, buf, REG_STATUS, REG_STATUS_LEN); + } + } +} + +/** + * poll status register until moving stops + * @return current position + */ +int poll_regstatus(int fd, int msg){ + uint8_t buf[REG_STATUS_LEN]; + int i, stat = 1; + /// "Ожидание окончания движения" + if(msg) printf(_("Wait for end of moving ")); + for(i = 0; i < 300 && stat; ++i){ + stat = readreg(fd, buf, REG_STATUS, REG_STATUS_LEN); + if(!stat){ + if(buf[2] == 0xff || buf[3] == 0xff) stat = 1; + } + if(buf[5]){ + if(msg) printf("\n"); + /// "Произошла ошибка, повторите запуск" + ERRX(_("Error ocured, repeat again")); + } + usleep(50000); + if(msg) printf("."); fflush(stdout); + } + if(msg) printf("\n"); + return buf[4]; +} + +/** + * return statically allocated buffer with given filter name + * @param wheel - given wheel file structure + * @param pos - filter position (starts from 1) + */ +char *get_filter_name(wheel_descr *wheel, int pos){ + static uint8_t buf[REG_NAME_LEN]; + int fd = wheel->fd; + if(fd < 0) return NULL; + if(pos < 1 || pos > wheel->maxpos){ + /// "Заданная позиция вне диапазона 1..%d" + WARNX(_("Given position out of range 1..%d"), wheel->maxpos); + return NULL; + } + memset(buf, 0, sizeof(buf)); + buf[0] = REG_NAME; + buf[1] = FILTER_NAME; + buf[2] = wheel->ID; + buf[3] = pos; + if(writereg(fd, buf, REG_NAME_LEN)) return NULL; + if(readreg(fd, buf, REG_NAME, REG_NAME_LEN)) return NULL; + if(buf[2]) return NULL; + if(buf[6]){ + char *x = strchr((char*)&buf[6], ' '); + if(x) *x = 0; + return (char*) &buf[6]; + } + else return NULL; +} + +/** + * list properties of wheels & fill remain fields of struct wheel_descr + */ +void list_props(_U_ int verblevl, wheel_descr *wheel){ + uint8_t buf[REG_NAME_LEN]; + int fd = wheel->fd; + if(fd < 0){ + /// "Не могу открыть устройство" + WARNX(_("Can't open device")); + return; + } + check_and_clear_err(fd); + // get status of wheel + if(readreg(fd, buf, REG_INFO, REG_INFO_LEN)) return; + wheel->ID = buf[5]; + wheel->maxpos = buf[4]; + DBG("Wheel with id '%c' and maxpos %d", wheel->ID, wheel->maxpos); + char *getwname(int id){ + memset(buf, 0, sizeof(buf)); + buf[0] = REG_NAME; + buf[1] = WHEEL_NAME; + buf[2] = id; + if(writereg(fd, buf, REG_NAME_LEN)) return NULL; + if(readreg(fd, buf, REG_NAME, REG_NAME_LEN)) return NULL; + if(buf[6]){ + char *x = strchr((char*)&buf[6], ' '); + if(x) *x = 0; + return (char*)&buf[6]; + } + else return NULL; + } + if(verblevl == LIST_PRES || !verblevl){ // list only presented devices or not list + char *nm; + /// "\nСвойства подключенного колеса\n" + if(verblevl) green(_("\nConnected wheel properties\n")); + if(verblevl) printf("Wheel ID '%c'", wheel->ID); + nm = getwname(wheel->ID); + if(nm){ + strncpy(wheel->name, nm, 9); + if(verblevl) printf(", name '%s'", wheel->name); + } + if(verblevl) printf("\n\tFilters:\n"); + else return; + int i, m = wheel->maxpos + 1; + // now get filter names + for(i = 1; i < m; ++i){ + nm = get_filter_name(wheel, i); + printf("\t\tPOS %d", i); + if(nm) printf(" -- '%s'", nm); + printf("\n"); + } + } + if(verblevl != LIST_ALL) return; + // now list all things stored in memory of turret driver + int w; + /// "\nВсе записи EEPROM\n" + green(_("\nAll records from EEPROM\n")); + wheel_descr wl; + wl.fd = fd; + wl.maxpos = ABS_MAX_POS; + for(w = 'A'; w < 'I'; ++w){ + char *nm = getwname(w); + int f; + printf("Wheel ID '%c'", w); + if(nm) printf(" with name '%s'", nm); + printf("; filters:\n"); + wl.ID = w; + for(f = 1; f <= ABS_MAX_POS; ++f){ + nm = get_filter_name(&wl, f); + if(!nm){ + check_and_clear_err(fd); + memset(buf, 0, sizeof(buf)); + buf[0] = REG_NAME; + writereg(fd, buf, REG_NAME_LEN); + readreg(fd, buf, REG_NAME, REG_NAME_LEN); + break; + } + printf("\tPOS %d -- '%s'\n", f, nm); + } + } +} + +/** + * Check hardware present + * if 'show' != 0 show names found + */ +void list_hw(int show){ + int i; + if(show) DBG("show"); + HW_found = find_wheels(&wheels); + DBG("Found %d dev[s]", HW_found); + if(HW_found == 0){ + /// "Турели не обнаружены" + ERRX(_("No turrets found")); + } + for(i = 0; i < HW_found; ++i) + if(wheels[i].fd > 0) break; + if(i == HW_found){ + /// "Обнаружено %d турелей, но ни к одной нет прав доступа" + ERRX(_("Found %d turrets but have no access rights to any"), HW_found); + } + // read other wheel properties & list if show!=0 + for(i = 0; i < HW_found; ++i){ + list_props(show, &wheels[i]); + } +} + +void rename_hw(){ + FNAME(); + check_and_clear_err(wheel_fd); +} + +/** + * move wheel home + */ +void go_home(int fd){ + static int Nruns = 0; + /// "Зацикливание, попробуйте еще раз" + if(++Nruns > 10) ERRX(_("Cycling detected, try again")); + DBG("Wheel go home"); + poll_regstatus(fd, 0); // wait for last moving + uint8_t buf[REG_HOME_LEN]; + int i, stat = 1; + for(i = 0; i < 10 && stat; ++i){ + memset(buf, 0, REG_HOME_LEN); + buf[0] = REG_HOME; + stat = writereg(fd, buf, REG_HOME_LEN); + if(stat){usleep(100000); continue;} + if((stat = readreg(fd, buf, REG_HOME, REG_HOME_LEN))) continue; + if(buf[1] != 0xff){ + stat = 1; continue; + }else{ + readreg(fd, buf, REG_HOME, REG_HOME_LEN); + break; + } + } + if(i == 10) exit(1); + // now poll REG_STATUS + poll_regstatus(fd, 1); + check_and_clear_err(fd); +} + +void move_wheel(){ + DBG("Move wheel %c to pos %d", wheel_id, filter_pos); + if(wheel_fd < 0) return; + if(filter_pos == poll_regstatus(wheel_fd, 0)){ + /// "Уже в заданной позиции" + WARNX(_("Already at position")); + exit(0); + } + uint8_t buf[REG_GOTO_LEN]; + int i, stat = 1; + for(i = 0; i < 10 && stat; ++i){ + DBG("i=%d",i); + memset(buf, 0, REG_GOTO_LEN); + buf[0] = REG_GOTO; + buf[1] = filter_pos; + stat = writereg(wheel_fd, buf, REG_GOTO_LEN); + usleep(100000); + if(stat) continue; + if((stat = readreg(wheel_fd, buf, REG_GOTO, REG_GOTO_LEN))) continue; + if(buf[1] != 0xff){ + stat = 1; continue; + }else{ + readreg(wheel_fd, buf, REG_GOTO, REG_HOME_LEN); + break; + } + } + if(i == 10) exit(1); + poll_regstatus(wheel_fd, 1); + check_and_clear_err(wheel_fd); +} + +void process_args(){ + FNAME(); + if(wheel_id < 0) return; + if(gohome){ + go_home(wheel_fd); + return; + } + if(reName){ + rename_hw(); + return; + } + if(filter_pos < 0) return; + move_wheel(); +} diff --git a/HSFW_management/hsfw.h b/HSFW_management/hsfw.h new file mode 100644 index 0000000..6f6f6d5 --- /dev/null +++ b/HSFW_management/hsfw.h @@ -0,0 +1,52 @@ +/* + * hsfw.h - functions for work with wheels + * + * Copyright 2016 Edward V. Emelianov + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +#pragma once +#ifndef __HSFW_H__ +#define __HSFW_H__ + +#define REG_CLERR (0x02) +#define REG_CLERR_LEN (2) +#define REG_STATUS (0x0a) +#define REG_STATUS_LEN (6) +#define REG_INFO (0x0b) +#define REG_INFO_LEN (7) +#define REG_GOTO (0x14) +#define REG_GOTO_LEN (3) +#define REG_HOME (0x15) +#define REG_HOME_LEN (3) +#define REG_NAME (0x16) +#define REG_NAME_LEN (14) + +// absolute max position (for any wheel) +#define ABS_MAX_POS (8) + +enum name_cmd{ + RESTORE_DEFVALS = 1, + RENAME_FILTER, + FILTER_NAME, + RENAME_WHEEL, + WHEEL_NAME +}; + +void check_args(); +void process_args(); + +#endif // __HSFW_H__ diff --git a/HSFW_management/locale/ru/LC_MESSAGES/HSFW_manage.mo b/HSFW_management/locale/ru/LC_MESSAGES/HSFW_manage.mo new file mode 100644 index 0000000..b91c3b4 Binary files /dev/null and b/HSFW_management/locale/ru/LC_MESSAGES/HSFW_manage.mo differ diff --git a/HSFW_management/locale/ru/messages.po b/HSFW_management/locale/ru/messages.po new file mode 100644 index 0000000..232b898 --- /dev/null +++ b/HSFW_management/locale/ru/messages.po @@ -0,0 +1,265 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +# This file is distributed under the same license as the PACKAGE package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2016-05-13 20:47+0300\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=koi8-r\n" +"Content-Transfer-Encoding: 8bit\n" + +#. amount of pcount and/or scount wrong +#. / "Неправильный формат строки помощи" +#: /Big/Data/SAO/edmund_opt/HSFW_management/parseargs.c:56 +msgid "Wrong helpstring!" +msgstr "" + +#. / "Целое вне допустимого диапазона" +#: /Big/Data/SAO/edmund_opt/HSFW_management/parseargs.c:86 +msgid "Integer out of range" +msgstr "" + +#. / "Неправильный параметр: %s" +#: /Big/Data/SAO/edmund_opt/HSFW_management/parseargs.c:480 +#, c-format +msgid "Wrong parameter: %s" +msgstr "" + +#. / "%s: необходим аргумент!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/parseargs.c:485 +#, c-format +msgid "%s: argument needed!" +msgstr "" + +#. / "Неправильный аргумент \"%s\" параметра \"%s\"" +#: /Big/Data/SAO/edmund_opt/HSFW_management/parseargs.c:490 +#, c-format +msgid "Wrong argument \"%s\" of parameter \"%s\"" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:173 +msgid "No filename given!" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:175 +#, c-format +msgid "Can't open %s for reading" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:177 +#, c-format +msgid "Can't stat %s" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:180 +msgid "Mmap error for input" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:181 +msgid "Can't close mmap'ed file" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:190 +msgid "Can't munmap" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:214 +msgid "Can't setup console" +msgstr "" + +#. Get settings +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:283 +msgid "Can't get settings" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:293 +msgid "Can't set settings" +msgstr "" + +#. / "Не могу открыть %s" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hidmanage.c:80 +#, c-format +msgid "Can't open %s" +msgstr "" + +#. / "отобразить эту справку" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:61 +msgid "show this help" +msgstr "" + +#. / "буквенный идентификатор колеса" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:63 +msgid "letter wheel identificator" +msgstr "" + +#. / "название колеса" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:65 +msgid "wheel name" +msgstr "" + +#. / "номер позиции фильтра" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:67 +msgid "filter position number" +msgstr "" + +#. / "название фильтра" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:69 +msgid "filter name" +msgstr "" + +#. / "идентификатор фильтра, например, \"A3\"" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:71 +msgid "filter identificator like \"A3\"" +msgstr "" + +#. / "список всех сохраненных имен" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:73 +msgid "list all stored names" +msgstr "" + +#. / "список имен только присутствующих устройств" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:75 +msgid "list only present devices' names" +msgstr "" + +#. / "переместиться в стартовую позицию" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:77 +msgid "move to home position" +msgstr "" + +#. / "переименовать сохраненные имена колес/фильтров" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:79 +msgid "rename stored wheels/filters names" +msgstr "" + +#. / "Неправильный формат числа double!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:97 +msgid "Wrong double number format!" +msgstr "" + +#. / "Игнорируются параметры: " +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:122 +msgid "Ignore parameters:" +msgstr "" + +#. / "Не передано никаких аргументов, вывожу список подключенных устройств!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:130 +msgid "No arguments given, list all devices connected!" +msgstr "" + +#. / "Идентификатор колеса должен быть буквой от \"A\" до \"H\"!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:77 +msgid "Wheel ID should be a letter from \"A\" to \"H\"!" +msgstr "" + +#. / "Заданы и идентификатор, и имя колеса; попробуйте что-то одно!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:89 +msgid "You give both wheel ID and wheel name, try something one!" +msgstr "" + +#. / "Заданное колесо не обнаружено!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:104 +msgid "Given wheel not found!" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:111 +msgid "Filter ID is letter (wheel) and number (position)" +msgstr "" + +#. / "Фильтр %s не обнаружен" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:125 +#, c-format +msgid "Filter %s not found!" +msgstr "" + +#. / "Позиция фильтра должна быть числом от 1 до %d!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:133 +#, c-format +msgid "Filter position should be a number from 1 to %d!" +msgstr "" + +#. / "Ошибка отправки данных" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:153 +msgid "Error sending data" +msgstr "" + +#. / "Ошибка чтения данных" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:168 +msgid "Error reading data" +msgstr "" + +#. / "Ошибка, количество попыток истекло" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:192 +msgid "Error, tries amount exceed" +msgstr "" + +#. / "Турель не инициализирована, движение в \"дом\"" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:210 +msgid "Turret isn't initialized, move home..." +msgstr "" + +#. / "Ожидание окончания движения" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:225 +#, c-format +msgid "Wait for end of moving " +msgstr "" + +#. / "Произошла ошибка, повторите запуск" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:234 +msgid "Error ocured, repeat again" +msgstr "" + +#. / "Заданная позиция вне диапазона 1..%d" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:254 +#, c-format +msgid "Given position out of range 1..%d" +msgstr "" + +#. / "Не могу открыть устройство" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:281 +msgid "Can't open device" +msgstr "" + +#. / "\nСвойства подключенного колеса\n" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:307 +msgid "" +"\n" +"Connected wheel properties\n" +msgstr "" + +#. / "\nВсе записи EEPROM\n" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:329 +msgid "" +"\n" +"All records from EEPROM\n" +msgstr "" + +#. / "Турели не обнаружены" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:366 +msgid "No turrets found" +msgstr "" + +#. / "Обнаружено %d турелей, но ни к одной нет прав доступа" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:372 +#, c-format +msgid "Found %d turrets but have no access rights to any" +msgstr "" + +#. / "Зацикливание, попробуйте еще раз" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:391 +msgid "Cycling detected, try again" +msgstr "" + +#. / "Уже в заданной позиции" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:420 +msgid "Already at position" +msgstr "" diff --git a/HSFW_management/locale/ru/ru.po b/HSFW_management/locale/ru/ru.po new file mode 100644 index 0000000..99ae10f --- /dev/null +++ b/HSFW_management/locale/ru/ru.po @@ -0,0 +1,262 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +# This file is distributed under the same license as the PACKAGE package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "Project-Id-Version: PACKAGE VERSION\n" + "Report-Msgid-Bugs-To: \n" + "POT-Creation-Date: 2016-05-13 20:47+0300\n" + "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" + "Last-Translator: FULL NAME \n" + "Language-Team: LANGUAGE \n" + "Language: \n" + "MIME-Version: 1.0\n" + "Content-Type: text/plain; charset=koi8-r\n" + "Content-Transfer-Encoding: 8bit\n" + +#. / "\nВсе записи EEPROM\n" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:329 +msgid "\n" + "All records from EEPROM\n" +msgstr "" + +#. / "\nСвойства подключенного колеса\n" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:307 +msgid "\n" + "Connected wheel properties\n" +msgstr "" + +#. / "%s: необходим аргумент!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/parseargs.c:485 +#, c-format +msgid "%s: argument needed!" +msgstr "" + +#. / "Уже в заданной позиции" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:420 +msgid "Already at position" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:181 +msgid "Can't close mmap'ed file" +msgstr "" + +#. Get settings +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:283 +msgid "Can't get settings" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:190 +msgid "Can't munmap" +msgstr "" + +#. / "Не могу открыть %s" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hidmanage.c:80 +#, c-format +msgid "Can't open %s" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:175 +#, c-format +msgid "Can't open %s for reading" +msgstr "" + +#. / "Не могу открыть устройство" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:281 +msgid "Can't open device" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:293 +msgid "Can't set settings" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:214 +msgid "Can't setup console" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:177 +#, c-format +msgid "Can't stat %s" +msgstr "" + +#. / "Зацикливание, попробуйте еще раз" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:391 +msgid "Cycling detected, try again" +msgstr "" + +#. / "Произошла ошибка, повторите запуск" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:234 +msgid "Error ocured, repeat again" +msgstr "" + +#. / "Ошибка чтения данных" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:168 +msgid "Error reading data" +msgstr "" + +#. / "Ошибка отправки данных" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:153 +msgid "Error sending data" +msgstr "" + +#. / "Ошибка, количество попыток истекло" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:192 +msgid "Error, tries amount exceed" +msgstr "" + +#. / "Фильтр %s не обнаружен" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:125 +#, c-format +msgid "Filter %s not found!" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:111 +msgid "Filter ID is letter (wheel) and number (position)" +msgstr "" + +#. / "Позиция фильтра должна быть числом от 1 до %d!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:133 +#, c-format +msgid "Filter position should be a number from 1 to %d!" +msgstr "" + +#. / "Обнаружено %d турелей, но ни к одной нет прав доступа" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:372 +#, c-format +msgid "Found %d turrets but have no access rights to any" +msgstr "" + +#. / "Заданная позиция вне диапазона 1..%d" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:254 +#, c-format +msgid "Given position out of range 1..%d" +msgstr "" + +#. / "Заданное колесо не обнаружено!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:104 +msgid "Given wheel not found!" +msgstr "" + +#. / "Игнорируются параметры: " +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:122 +msgid "Ignore parameters:" +msgstr "" + +#. / "Целое вне допустимого диапазона" +#: /Big/Data/SAO/edmund_opt/HSFW_management/parseargs.c:86 +msgid "Integer out of range" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:180 +msgid "Mmap error for input" +msgstr "" + +#. / "Не передано никаких аргументов, вывожу список подключенных устройств!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:130 +msgid "No arguments given, list all devices connected!" +msgstr "" + +#: /Big/Data/SAO/edmund_opt/HSFW_management/usefull_macros.c:173 +msgid "No filename given!" +msgstr "" + +#. / "Турели не обнаружены" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:366 +msgid "No turrets found" +msgstr "" + +#. / "Турель не инициализирована, движение в \"дом\"" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:210 +msgid "Turret isn't initialized, move home..." +msgstr "" + +#. / "Ожидание окончания движения" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:225 +#, c-format +msgid "Wait for end of moving " +msgstr "" + +#. / "Идентификатор колеса должен быть буквой от \"A\" до \"H\"!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:77 +msgid "Wheel ID should be a letter from \"A\" to \"H\"!" +msgstr "" + +#. / "Неправильный аргумент \"%s\" параметра \"%s\"" +#: /Big/Data/SAO/edmund_opt/HSFW_management/parseargs.c:490 +#, c-format +msgid "Wrong argument \"%s\" of parameter \"%s\"" +msgstr "" + +#. / "Неправильный формат числа double!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:97 +msgid "Wrong double number format!" +msgstr "" + +#. amount of pcount and/or scount wrong +#. / "Неправильный формат строки помощи" +#: /Big/Data/SAO/edmund_opt/HSFW_management/parseargs.c:56 +msgid "Wrong helpstring!" +msgstr "" + +#. / "Неправильный параметр: %s" +#: /Big/Data/SAO/edmund_opt/HSFW_management/parseargs.c:480 +#, c-format +msgid "Wrong parameter: %s" +msgstr "" + +#. / "Заданы и идентификатор, и имя колеса; попробуйте что-то одно!" +#: /Big/Data/SAO/edmund_opt/HSFW_management/hsfw.c:89 +msgid "You give both wheel ID and wheel name, try something one!" +msgstr "" + +#. / "идентификатор фильтра, например, \"A3\"" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:71 +msgid "filter identificator like \"A3\"" +msgstr "" + +#. / "название фильтра" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:69 +msgid "filter name" +msgstr "" + +#. / "номер позиции фильтра" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:67 +msgid "filter position number" +msgstr "" + +#. / "буквенный идентификатор колеса" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:63 +msgid "letter wheel identificator" +msgstr "" + +#. / "список всех сохраненных имен" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:73 +msgid "list all stored names" +msgstr "" + +#. / "список имен только присутствующих устройств" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:75 +msgid "list only present devices' names" +msgstr "" + +#. / "переместиться в стартовую позицию" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:77 +msgid "move to home position" +msgstr "" + +#. / "переименовать сохраненные имена колес/фильтров" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:79 +msgid "rename stored wheels/filters names" +msgstr "" + +#. / "отобразить эту справку" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:61 +msgid "show this help" +msgstr "" + +#. / "название колеса" +#: /Big/Data/SAO/edmund_opt/HSFW_management/cmdlnopts.c:65 +msgid "wheel name" +msgstr "" diff --git a/HSFW_management/main.c b/HSFW_management/main.c new file mode 100644 index 0000000..dd9e807 --- /dev/null +++ b/HSFW_management/main.c @@ -0,0 +1,38 @@ +/* + * main.c + * + * Copyright 2016 Edward V. Emelianov + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +#include +#include "usefull_macros.h" +#include "cmdlnopts.h" +#include "hsfw.h" + +void signals(int signo){ + exit(signo); +} + + +int main(int argc, char **argv){ + initial_setup(); + parse_args(argc, argv); + check_args(); + process_args(); + return 0; +} + diff --git a/HSFW_management/parseargs.c b/HSFW_management/parseargs.c new file mode 100644 index 0000000..2f57be9 --- /dev/null +++ b/HSFW_management/parseargs.c @@ -0,0 +1,497 @@ +/* + * parseargs.c - parsing command line arguments & print help + * + * Copyright 2013 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include // printf +#include // getopt_long +#include // calloc, exit, strtoll +#include // assert +#include // strdup, strchr, strlen +#include // strcasecmp +#include // INT_MAX & so on +#include // gettext +#include // isalpha +#include "parseargs.h" +#include "usefull_macros.h" + +char *helpstring = "%s\n"; + +/** + * Change standard help header + * MAY consist ONE "%s" for progname + * @param str (i) - new format + */ +void change_helpstring(char *s){ + int pcount = 0, scount = 0; + char *str = s; + // check `helpstring` and set it to default in case of error + for(; pcount < 2; str += 2){ + if(!(str = strchr(str, '%'))) break; + if(str[1] != '%') pcount++; // increment '%' counter if it isn't "%%" + else{ + str += 2; // pass next '%' + continue; + } + if(str[1] == 's') scount++; // increment "%s" counter + }; + if(pcount > 1 || pcount != scount){ // amount of pcount and/or scount wrong + /// "Неправильный формат строки помощи" + ERRX(_("Wrong helpstring!")); + } + helpstring = s; +} + +/** + * Carefull atoll/atoi + * @param num (o) - returning value (or NULL if you wish only check number) - allocated by user + * @param str (i) - string with number must not be NULL + * @param t (i) - T_INT for integer or T_LLONG for long long (if argtype would be wided, may add more) + * @return TRUE if conversion sone without errors, FALSE otherwise + */ +static bool myatoll(void *num, char *str, argtype t){ + long long tmp, *llptr; + int *iptr; + char *endptr; + assert(str); + assert(num); + tmp = strtoll(str, &endptr, 0); + if(endptr == str || *str == '\0' || *endptr != '\0') + return FALSE; + switch(t){ + case arg_longlong: + llptr = (long long*) num; + *llptr = tmp; + break; + case arg_int: + default: + if(tmp < INT_MIN || tmp > INT_MAX){ + /// "Целое вне допустимого диапазона" + WARNX(_("Integer out of range")); + return FALSE; + } + iptr = (int*)num; + *iptr = (int)tmp; + } + return TRUE; +} + +// the same as myatoll but for double +// There's no NAN & INF checking here (what if they would be needed?) +static bool myatod(void *num, const char *str, argtype t){ + double tmp, *dptr; + float *fptr; + char *endptr; + assert(str); + tmp = strtod(str, &endptr); + if(endptr == str || *str == '\0' || *endptr != '\0') + return FALSE; + switch(t){ + case arg_double: + dptr = (double *) num; + *dptr = tmp; + break; + case arg_float: + default: + fptr = (float *) num; + *fptr = (float)tmp; + break; + } + return TRUE; +} + +/** + * Get index of current option in array options + * @param opt (i) - returning val of getopt_long + * @param options (i) - array of options + * @return index in array + */ +static int get_optind(int opt, myoption *options){ + int oind; + myoption *opts = options; + assert(opts); + for(oind = 0; opts->name && opts->val != opt; oind++, opts++); + if(!opts->name || opts->val != opt) // no such parameter + showhelp(-1, options); + return oind; +} + +/** + * reallocate new value in array of multiple repeating arguments + * @arg paptr - address of pointer to array (**void) + * @arg type - its type (for realloc) + * @return pointer to new (next) value + */ +void *get_aptr(void *paptr, argtype type){ + int i = 1; + void **aptr = *((void***)paptr); + if(aptr){ // there's something in array + void **p = aptr; + while(*p++) ++i; + } + size_t sz = 0; + switch(type){ + default: + case arg_none: + /// "Не могу использовать несколько параметров без аргументов!" + ERRX("Can't use multiple args with arg_none!"); + break; + case arg_int: + sz = sizeof(int); + break; + case arg_longlong: + sz = sizeof(long long); + break; + case arg_double: + sz = sizeof(double); + break; + case arg_float: + sz = sizeof(float); + break; + case arg_string: + sz = 0; + break; + /* case arg_function: + sz = sizeof(argfn *); + break;*/ + } + aptr = realloc(aptr, (i + 1) * sizeof(void*)); + *((void***)paptr) = aptr; + aptr[i] = NULL; + if(sz){ + aptr[i - 1] = malloc(sz); + }else + aptr[i - 1] = &aptr[i - 1]; + return aptr[i - 1]; +} + + +/** + * Parse command line arguments + * ! If arg is string, then value will be strdup'ed! + * + * @param argc (io) - address of argc of main(), return value of argc stay after `getopt` + * @param argv (io) - address of argv of main(), return pointer to argv stay after `getopt` + * BE CAREFUL! if you wanna use full argc & argv, save their original values before + * calling this function + * @param options (i) - array of `myoption` for arguments parcing + * + * @exit: in case of error this function show help & make `exit(-1)` + */ +void parseargs(int *argc, char ***argv, myoption *options){ + char *short_options, *soptr; + struct option *long_options, *loptr; + size_t optsize, i; + myoption *opts = options; + // check whether there is at least one options + assert(opts); + assert(opts[0].name); + // first we count how much values are in opts + for(optsize = 0; opts->name; optsize++, opts++); + // now we can allocate memory + short_options = calloc(optsize * 3 + 1, 1); // multiply by three for '::' in case of args in opts + long_options = calloc(optsize + 1, sizeof(struct option)); + opts = options; loptr = long_options; soptr = short_options; + // in debug mode check the parameters are not repeated +#ifdef EBUG + char **longlist = MALLOC(char*, optsize); + char *shortlist = MALLOC(char, optsize); +#endif + // fill short/long parameters and make a simple checking + for(i = 0; i < optsize; i++, loptr++, opts++){ + // check + assert(opts->name); // check name +#ifdef EBUG + longlist[i] = strdup(opts->name); +#endif + if(opts->has_arg){ + assert(opts->type != arg_none); // check error with arg type + assert(opts->argptr); // check pointer + } + if(opts->type != arg_none) // if there is a flag without arg, check its pointer + assert(opts->argptr); + // fill long_options + // don't do memcmp: what if there would be different alignment? + loptr->name = opts->name; + loptr->has_arg = (opts->has_arg < MULT_PAR) ? opts->has_arg : 1; + loptr->flag = opts->flag; + loptr->val = opts->val; + // fill short options if they are: + if(!opts->flag){ +#ifdef EBUG + shortlist[i] = (char) opts->val; +#endif + *soptr++ = opts->val; + if(loptr->has_arg) // add ':' if option has required argument + *soptr++ = ':'; + if(loptr->has_arg == 2) // add '::' if option has optional argument + *soptr++ = ':'; + } + } + // sort all lists & check for repeating +#ifdef EBUG + int cmpstringp(const void *p1, const void *p2){ + return strcmp(* (char * const *) p1, * (char * const *) p2); + } + int cmpcharp(const void *p1, const void *p2){ + return (int)(*(char * const)p1 - *(char *const)p2); + } + qsort(longlist, optsize, sizeof(char *), cmpstringp); + qsort(shortlist,optsize, sizeof(char), cmpcharp); + char *prevl = longlist[0], prevshrt = shortlist[0]; + for(i = 1; i < optsize; ++i){ + if(longlist[i]){ + if(prevl){ + if(strcmp(prevl, longlist[i]) == 0) ERRX("double long arguments: --%s", prevl); + } + prevl = longlist[i]; + } + if(shortlist[i]){ + if(prevshrt){ + if(prevshrt == shortlist[i]) ERRX("double short arguments: -%c", prevshrt); + } + prevshrt = shortlist[i]; + } + } +#endif + // now we have both long_options & short_options and can parse `getopt_long` + while(1){ + int opt; + int oindex = 0, optind = 0; // oindex - number of option in argv, optind - number in options[] + if((opt = getopt_long(*argc, *argv, short_options, long_options, &oindex)) == -1) break; + if(opt == '?'){ + opt = optopt; + optind = get_optind(opt, options); + if(options[optind].has_arg == NEED_ARG || options[optind].has_arg == MULT_PAR) + showhelp(optind, options); // need argument + } + else{ + if(opt == 0 || oindex > 0) optind = oindex; + else optind = get_optind(opt, options); + } + opts = &options[optind]; + if(opt == 0 && opts->has_arg == NO_ARGS) continue; // only long option changing integer flag + // now check option + if(opts->has_arg == NEED_ARG || opts->has_arg == MULT_PAR) + if(!optarg) showhelp(optind, options); // need argument + void *aptr; + if(opts->has_arg == MULT_PAR){ + aptr = get_aptr(opts->argptr, opts->type); + }else + aptr = opts->argptr; + bool result = TRUE; + // even if there is no argument, but argptr != NULL, think that optarg = "1" + if(!optarg) optarg = "1"; + switch(opts->type){ + default: + case arg_none: + if(opts->argptr) *((int*)aptr) += 1; // increment value + break; + case arg_int: + result = myatoll(aptr, optarg, arg_int); + break; + case arg_longlong: + result = myatoll(aptr, optarg, arg_longlong); + break; + case arg_double: + result = myatod(aptr, optarg, arg_double); + break; + case arg_float: + result = myatod(aptr, optarg, arg_float); + break; + case arg_string: + result = (*((void**)aptr) = (void*)strdup(optarg)); + break; + case arg_function: + result = ((argfn)aptr)(optarg); + break; + } + if(!result){ + showhelp(optind, options); + } + } + *argc -= optind; + *argv += optind; +} + +/** + * compare function for qsort + * first - sort by short options; second - sort arguments without sort opts (by long options) + */ +static int argsort(const void *a1, const void *a2){ + const myoption *o1 = (myoption*)a1, *o2 = (myoption*)a2; + const char *l1 = o1->name, *l2 = o2->name; + int s1 = o1->val, s2 = o2->val; + int *f1 = o1->flag, *f2 = o2->flag; + // check if both options has short arg + if(f1 == NULL && f2 == NULL){ // both have short arg + return (s1 - s2); + }else if(f1 != NULL && f2 != NULL){ // both don't have short arg - sort by long + return strcmp(l1, l2); + }else{ // only one have short arg -- return it + if(f2) return -1; // a1 have short - it is 'lesser' + else return 1; + } +} + +/** + * Show help information based on myoption->help values + * @param oindex (i) - if non-negative, show only help by myoption[oindex].help + * @param options (i) - array of `myoption` + * + * @exit: run `exit(-1)` !!! + */ +void showhelp(int oindex, myoption *options){ + int max_opt_len = 0; // max len of options substring - for right indentation + const int bufsz = 255; + char buf[bufsz+1]; + myoption *opts = options; + assert(opts); + assert(opts[0].name); // check whether there is at least one options + if(oindex > -1){ // print only one message + opts = &options[oindex]; + printf(" "); + if(!opts->flag && isalpha(opts->val)) printf("-%c, ", opts->val); + printf("--%s", opts->name); + if(opts->has_arg == 1) printf("=arg"); + else if(opts->has_arg == 2) printf("[=arg]"); + printf(" %s\n", _(opts->help)); + exit(-1); + } + // header, by default is just "progname\n" + printf("\n"); + if(strstr(helpstring, "%s")) // print progname + printf(helpstring, __progname); + else // only text + printf("%s", helpstring); + printf("\n"); + // count max_opt_len + do{ + int L = strlen(opts->name); + if(max_opt_len < L) max_opt_len = L; + }while((++opts)->name); + max_opt_len += 14; // format: '-S , --long[=arg]' - get addition 13 symbols + opts = options; + // count amount of options + int N; for(N = 0; opts->name; ++N, ++opts); + if(N == 0) exit(-2); + // Now print all help (sorted) + opts = options; + qsort(opts, N, sizeof(myoption), argsort); + do{ + int p = sprintf(buf, " "); // a little indent + if(!opts->flag) // .val is short argument + p += snprintf(buf+p, bufsz-p, "-%c, ", opts->val); + p += snprintf(buf+p, bufsz-p, "--%s", opts->name); + if(opts->has_arg == 1) // required argument + p += snprintf(buf+p, bufsz-p, "=arg"); + else if(opts->has_arg == 2) // optional argument + p += snprintf(buf+p, bufsz-p, "[=arg]"); + assert(p < max_opt_len); // there would be magic if p >= max_opt_len + printf("%-*s%s\n", max_opt_len+1, buf, _(opts->help)); // write options & at least 2 spaces after + ++opts; + }while(--N); + printf("\n\n"); + exit(-1); +} + +/** + * get suboptions from parameter string + * @param str - parameter string + * @param opt - pointer to suboptions structure + * @return TRUE if all OK + */ +bool get_suboption(char *str, mysuboption *opt){ + int findsubopt(char *par, mysuboption *so){ + int idx = 0; + if(!par) return -1; + while(so[idx].name){ + if(strcasecmp(par, so[idx].name) == 0) return idx; + ++idx; + } + return -1; // badarg + } + bool opt_setarg(mysuboption *so, int idx, char *val){ + mysuboption *soptr = &so[idx]; + bool result = FALSE; + void *aptr = soptr->argptr; + switch(soptr->type){ + default: + case arg_none: + if(soptr->argptr) *((int*)aptr) += 1; // increment value + result = TRUE; + break; + case arg_int: + result = myatoll(aptr, val, arg_int); + break; + case arg_longlong: + result = myatoll(aptr, val, arg_longlong); + break; + case arg_double: + result = myatod(aptr, val, arg_double); + break; + case arg_float: + result = myatod(aptr, val, arg_float); + break; + case arg_string: + result = (*((void**)aptr) = (void*)strdup(val)); + break; + case arg_function: + result = ((argfn)aptr)(val); + break; + } + return result; + } + char *tok; + bool ret = FALSE; + char *tmpbuf; + tok = strtok_r(str, ":,", &tmpbuf); + do{ + char *val = strchr(tok, '='); + int noarg = 0; + if(val == NULL){ // no args + val = "1"; + noarg = 1; + }else{ + *val++ = '\0'; + if(!*val || *val == ':' || *val == ','){ // no argument - delimeter after = + val = "1"; noarg = 1; + } + } + int idx = findsubopt(tok, opt); + if(idx < 0){ + /// "Неправильный параметр: %s" + WARNX(_("Wrong parameter: %s"), tok); + goto returning; + } + if(noarg && opt[idx].has_arg == NEED_ARG){ + /// "%s: необходим аргумент!" + WARNX(_("%s: argument needed!"), tok); + goto returning; + } + if(!opt_setarg(opt, idx, val)){ + /// "Неправильный аргумент \"%s\" параметра \"%s\"" + WARNX(_("Wrong argument \"%s\" of parameter \"%s\""), val, tok); + goto returning; + } + }while((tok = strtok_r(NULL, ":,", &tmpbuf))); + ret = TRUE; +returning: + return ret; +} diff --git a/HSFW_management/parseargs.h b/HSFW_management/parseargs.h new file mode 100644 index 0000000..b8351d9 --- /dev/null +++ b/HSFW_management/parseargs.h @@ -0,0 +1,124 @@ +/* + * parseargs.h - headers for parsing command line arguments + * + * Copyright 2013 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +#pragma once +#ifndef __PARSEARGS_H__ +#define __PARSEARGS_H__ + +#include // bool +#include + +#ifndef TRUE + #define TRUE true +#endif + +#ifndef FALSE + #define FALSE false +#endif + +// macro for argptr +#define APTR(x) ((void*)x) + +// if argptr is a function: +typedef bool(*argfn)(void *arg); + +/* + * type of getopt's argument + * WARNING! + * My function change value of flags by pointer, so if you want to use another type + * make a latter conversion, example: + * char charg; + * int iarg; + * myoption opts[] = { + * {"value", 1, NULL, 'v', arg_int, &iarg, "char val"}, ..., end_option}; + * ..(parse args).. + * charg = (char) iarg; + */ +typedef enum { + arg_none = 0, // no arg + arg_int, // integer + arg_longlong, // long long + arg_double, // double + arg_float, // float + arg_string, // char * + arg_function // parse_args will run function `bool (*fn)(char *optarg, int N)` +} argtype; + +/* + * Structure for getopt_long & help + * BE CAREFUL: .argptr is pointer to data or pointer to function, + * conversion depends on .type + * + * ATTENTION: string `help` prints through macro PRNT(), bu default it is gettext, + * but you can redefine it before `#include "parseargs.h"` + * + * if arg is string, then value wil be strdup'ed like that: + * char *str; + * myoption opts[] = {{"string", 1, NULL, 's', arg_string, &str, "string val"}, ..., end_option}; + * *(opts[1].str) = strdup(optarg); + * in other cases argptr should be address of some variable (or pointer to allocated memory) + * + * NON-NULL argptr should be written inside macro APTR(argptr) or directly: (void*)argptr + * + * !!!LAST VALUE OF ARRAY SHOULD BE `end_option` or ZEROS !!! + * + */ +typedef enum{ + NO_ARGS = 0, // first three are the same as in getopt_long + NEED_ARG = 1, + OPT_ARG = 2, + MULT_PAR +} hasarg; + +typedef struct{ + // these are from struct option: + const char *name; // long option's name + hasarg has_arg; // 0 - no args, 1 - nesessary arg, 2 - optionally arg, 4 - need arg & key can repeat (args are stored in null-terminated array) + int *flag; // NULL to return val, pointer to int - to set its value of val (function returns 0) + int val; // short opt name (if flag == NULL) or flag's value + // and these are mine: + argtype type; // type of argument + void *argptr; // pointer to variable to assign optarg value or function `bool (*fn)(char *optarg, int N)` + const char *help; // help string which would be shown in function `showhelp` or NULL +} myoption; + +/* + * Suboptions structure, almost the same like myoption + * used in parse_subopts() + */ +typedef struct{ + const char *name; + hasarg has_arg; + argtype type; + void *argptr; +} mysuboption; + +// last string of array (all zeros) +#define end_option {0,0,0,0,0,0,0} +#define end_suboption {0,0,0,0} + +extern const char *__progname; + +void showhelp(int oindex, myoption *options); +void parseargs(int *argc, char ***argv, myoption *options); +void change_helpstring(char *s); +bool get_suboption(char *str, mysuboption *opt); + +#endif // __PARSEARGS_H__ diff --git a/HSFW_management/usefull_macros.c b/HSFW_management/usefull_macros.c new file mode 100644 index 0000000..f97c181 --- /dev/null +++ b/HSFW_management/usefull_macros.c @@ -0,0 +1,327 @@ +/* + * usefull_macros.h - a set of usefull functions: memory, color etc + * + * Copyright 2013 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include "usefull_macros.h" + +/** + * function for different purposes that need to know time intervals + * @return double value: time in seconds + */ +double dtime(){ + double t; + struct timeval tv; + gettimeofday(&tv, NULL); + t = tv.tv_sec + ((double)tv.tv_usec)/1e6; + return t; +} + +/******************************************************************************\ + * Coloured terminal +\******************************************************************************/ +int globErr = 0; // errno for WARN/ERR + +// pointers to coloured output printf +int (*red)(const char *fmt, ...); +int (*green)(const char *fmt, ...); +int (*_WARN)(const char *fmt, ...); + +/* + * format red / green messages + * name: r_pr_, g_pr_ + * @param fmt ... - printf-like format + * @return number of printed symbols + */ +int r_pr_(const char *fmt, ...){ + va_list ar; int i; + printf(RED); + va_start(ar, fmt); + i = vprintf(fmt, ar); + va_end(ar); + printf(OLDCOLOR); + return i; +} +int g_pr_(const char *fmt, ...){ + va_list ar; int i; + printf(GREEN); + va_start(ar, fmt); + i = vprintf(fmt, ar); + va_end(ar); + printf(OLDCOLOR); + return i; +} +/* + * print red error/warning messages (if output is a tty) + * @param fmt ... - printf-like format + * @return number of printed symbols + */ +int r_WARN(const char *fmt, ...){ + va_list ar; int i = 1; + fprintf(stderr, RED); + va_start(ar, fmt); + if(globErr){ + errno = globErr; + vwarn(fmt, ar); + errno = 0; + globErr = 0; + }else + i = vfprintf(stderr, fmt, ar); + va_end(ar); + i++; + fprintf(stderr, OLDCOLOR "\n"); + return i; +} + +static const char stars[] = "****************************************"; +/* + * notty variants of coloured printf + * name: s_WARN, r_pr_notty + * @param fmt ... - printf-like format + * @return number of printed symbols + */ +int s_WARN(const char *fmt, ...){ + va_list ar; int i; + i = fprintf(stderr, "\n%s\n", stars); + va_start(ar, fmt); + if(globErr){ + errno = globErr; + vwarn(fmt, ar); + errno = 0; + globErr = 0; + }else + i = +vfprintf(stderr, fmt, ar); + va_end(ar); + i += fprintf(stderr, "\n%s\n", stars); + i += fprintf(stderr, "\n"); + return i; +} +int r_pr_notty(const char *fmt, ...){ + va_list ar; int i; + i = printf("\n%s\n", stars); + va_start(ar, fmt); + i += vprintf(fmt, ar); + va_end(ar); + i += printf("\n%s\n", stars); + return i; +} + +/** + * Run this function in the beginning of main() to setup locale & coloured output + */ +void initial_setup(){ + // setup coloured output + if(isatty(STDOUT_FILENO)){ // make color output in tty + red = r_pr_; green = g_pr_; + }else{ // no colors in case of pipe + red = r_pr_notty; green = printf; + } + if(isatty(STDERR_FILENO)) _WARN = r_WARN; + else _WARN = s_WARN; + // Setup locale + setlocale(LC_ALL, ""); + setlocale(LC_NUMERIC, "C"); +#if defined GETTEXT_PACKAGE && defined LOCALEDIR + bindtextdomain(GETTEXT_PACKAGE, LOCALEDIR); + textdomain(GETTEXT_PACKAGE); +#endif +} + +/******************************************************************************\ + * Memory +\******************************************************************************/ +/* + * safe memory allocation for macro ALLOC + * @param N - number of elements to allocate + * @param S - size of single element (typically sizeof) + * @return pointer to allocated memory area + */ +void *my_alloc(size_t N, size_t S){ + void *p = calloc(N, S); + if(!p) ERR("malloc"); + //assert(p); + return p; +} + +/** + * Mmap file to a memory area + * + * @param filename (i) - name of file to mmap + * @return stuct with mmap'ed file or die + */ +mmapbuf *My_mmap(char *filename){ + int fd; + char *ptr; + size_t Mlen; + struct stat statbuf; + if(!filename) ERRX(_("No filename given!")); + if((fd = open(filename, O_RDONLY)) < 0) + ERR(_("Can't open %s for reading"), filename); + if(fstat (fd, &statbuf) < 0) + ERR(_("Can't stat %s"), filename); + Mlen = statbuf.st_size; + if((ptr = mmap (0, Mlen, PROT_READ, MAP_PRIVATE, fd, 0)) == MAP_FAILED) + ERR(_("Mmap error for input")); + if(close(fd)) ERR(_("Can't close mmap'ed file")); + mmapbuf *ret = MALLOC(mmapbuf, 1); + ret->data = ptr; + ret->len = Mlen; + return ret; +} + +void My_munmap(mmapbuf *b){ + if(munmap(b->data, b->len)) + ERR(_("Can't munmap")); + FREE(b); +} + + +/******************************************************************************\ + * Terminal in no-echo mode +\******************************************************************************/ +static struct termios oldt, newt; // terminal flags +static int console_changed = 0; +// run on exit: +void restore_console(){ + if(console_changed) + tcsetattr(STDIN_FILENO, TCSANOW, &oldt); // return terminal to previous state + console_changed = 0; +} + +// initial setup: +void setup_con(){ + if(console_changed) return; + tcgetattr(STDIN_FILENO, &oldt); + newt = oldt; + newt.c_lflag &= ~(ICANON | ECHO); + if(tcsetattr(STDIN_FILENO, TCSANOW, &newt) < 0){ + WARN(_("Can't setup console")); + tcsetattr(STDIN_FILENO, TCSANOW, &oldt); + signals(0); //quit? + } + console_changed = 1; +} + +/** + * Read character from console without echo + * @return char readed + */ +int read_console(){ + int rb; + struct timeval tv; + int retval; + fd_set rfds; + FD_ZERO(&rfds); + FD_SET(STDIN_FILENO, &rfds); + tv.tv_sec = 0; tv.tv_usec = 10000; + retval = select(1, &rfds, NULL, NULL, &tv); + if(!retval) rb = 0; + else { + if(FD_ISSET(STDIN_FILENO, &rfds)) rb = getchar(); + else rb = 0; + } + return rb; +} + +/** + * getchar() without echo + * wait until at least one character pressed + * @return character readed + */ +int mygetchar(){ // getchar() without need of pressing ENTER + int ret; + do ret = read_console(); + while(ret == 0); + return ret; +} + + +/******************************************************************************\ + * TTY with select() +\******************************************************************************/ +static struct termio oldtty, tty; // TTY flags +static int comfd = -1; // TTY fd + +// run on exit: +void restore_tty(){ + if(comfd == -1) return; + ioctl(comfd, TCSANOW, &oldtty ); // return TTY to previous state + close(comfd); + comfd = -1; +} + +#ifndef BAUD_RATE +#define BAUD_RATE B9600 +#endif +// init: +void tty_init(char *comdev){ + DBG("\nOpen port...\n"); + if ((comfd = open(comdev,O_RDWR|O_NOCTTY|O_NONBLOCK)) < 0){ + WARN("Can't use port %s\n",comdev); + ioctl(comfd, TCSANOW, &oldtty); // return TTY to previous state + close(comfd); + signals(0); // quit? + } + DBG(" OK\nGet current settings... "); + if(ioctl(comfd,TCGETA,&oldtty) < 0){ // Get settings + WARN(_("Can't get settings")); + signals(0); + } + tty = oldtty; + tty.c_lflag = 0; // ~(ICANON | ECHO | ECHOE | ISIG) + tty.c_oflag = 0; + tty.c_cflag = BAUD_RATE|CS8|CREAD|CLOCAL; // 9.6k, 8N1, RW, ignore line ctrl + tty.c_cc[VMIN] = 0; // non-canonical mode + tty.c_cc[VTIME] = 5; + if(ioctl(comfd,TCSETA,&tty) < 0){ + WARN(_("Can't set settings")); + signals(0); + } + DBG(" OK\n"); +} +/** + * Read data from TTY + * @param buff (o) - buffer for data read + * @param length - buffer len + * @return amount of readed bytes + */ +size_t read_tty(uint8_t *buff, size_t length){ + ssize_t L = 0; + fd_set rfds; + struct timeval tv; + int retval; + FD_ZERO(&rfds); + FD_SET(comfd, &rfds); + tv.tv_sec = 0; tv.tv_usec = 50000; // wait for 50ms + retval = select(comfd + 1, &rfds, NULL, NULL, &tv); + if (!retval) return 0; + if(FD_ISSET(comfd, &rfds)){ + if((L = read(comfd, buff, length)) < 1) return 0; + } + return (size_t)L; +} + +int write_tty(uint8_t *buff, size_t length){ + ssize_t L = write(comfd, buff, length); + if((size_t)L != length){ + WARN("Write error!"); + return 1; + } + return 0; +} diff --git a/HSFW_management/usefull_macros.h b/HSFW_management/usefull_macros.h new file mode 100644 index 0000000..499aacf --- /dev/null +++ b/HSFW_management/usefull_macros.h @@ -0,0 +1,124 @@ +/* + * usefull_macros.h - a set of usefull macros: memory, color etc + * + * Copyright 2013 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#pragma once +#ifndef __USEFULL_MACROS_H__ +#define __USEFULL_MACROS_H__ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#if defined GETTEXT_PACKAGE && defined LOCALEDIR +/* + * GETTEXT + */ +#include +#define _(String) gettext(String) +#define gettext_noop(String) String +#define N_(String) gettext_noop(String) +#else +#define _(String) (String) +#define N_(String) (String) +#endif +#include +#include +#include +#include +#include +#include + + +// unused arguments with -Wall -Werror +#define _U_ __attribute__((__unused__)) + +/* + * Coloured messages output + */ +#define RED "\033[1;31;40m" +#define GREEN "\033[1;32;40m" +#define OLDCOLOR "\033[0;0;0m" + +/* + * ERROR/WARNING messages + */ +extern int globErr; +extern void signals(int sig); +#define ERR(...) do{globErr=errno; _WARN(__VA_ARGS__); signals(9);}while(0) +#define ERRX(...) do{globErr=0; _WARN(__VA_ARGS__); signals(9);}while(0) +#define WARN(...) do{globErr=errno; _WARN(__VA_ARGS__);}while(0) +#define WARNX(...) do{globErr=0; _WARN(__VA_ARGS__);}while(0) + +/* + * print function name, debug messages + * debug mode, -DEBUG + */ +#ifdef EBUG + #define FNAME() fprintf(stderr, "\n%s (%s, line %d)\n", __func__, __FILE__, __LINE__) + #define DBG(...) do{fprintf(stderr, "%s (%s, line %d): ", __func__, __FILE__, __LINE__); \ + fprintf(stderr, __VA_ARGS__); \ + fprintf(stderr, "\n");} while(0) +#else + #define FNAME() do{}while(0) + #define DBG(...) do{}while(0) +#endif //EBUG + +/* + * Memory allocation + */ +#define ALLOC(type, var, size) type * var = ((type *)my_alloc(size, sizeof(type))) +#define MALLOC(type, size) ((type *)my_alloc(size, sizeof(type))) +#define FREE(ptr) do{free(ptr); ptr = NULL;}while(0) + +double dtime(); + +// functions for color output in tty & no-color in pipes +extern int (*red)(const char *fmt, ...); +extern int (*_WARN)(const char *fmt, ...); +extern int (*green)(const char *fmt, ...); +void * my_alloc(size_t N, size_t S); +void initial_setup(); + +// mmap file +typedef struct{ + char *data; + size_t len; +} mmapbuf; +mmapbuf *My_mmap(char *filename); +void My_munmap(mmapbuf *b); + +void restore_console(); +void setup_con(); +int read_console(); +int mygetchar(); + +void restore_tty(); +void tty_init(char *comdev); +size_t read_tty(uint8_t *buff, size_t length); +int write_tty(uint8_t *buff, size_t length); + +#endif // __USEFULL_MACROS_H__ diff --git a/getopt/cmdlnopts/cmdlnopts.c b/getopt/cmdlnopts/cmdlnopts.c index 03eef5a..0d1f1d0 100644 --- a/getopt/cmdlnopts/cmdlnopts.c +++ b/getopt/cmdlnopts/cmdlnopts.c @@ -1,5 +1,5 @@ /* - * cmdlnopts.c - the only function that parce cmdln args and returns glob parameters + * cmdlnopts.c - the only function that parse cmdln args and returns glob parameters * * Copyright 2013 Edward V. Emelianoff * @@ -85,7 +85,7 @@ myoption cmdlnopts[] = { {"int-size",NEED_ARG, NULL, 'i', arg_int, APTR(&G.S_interp), "size of interpolated array of surface deviations"}, {"image-size",NEED_ARG,NULL, 'I', arg_int, APTR(&G.S_image), "resulting image size"}, {"N-photons",NEED_ARG,NULL, 'N', arg_int, APTR(&G.N_phot), "amount of photons falled to one pixel of matrix by one iteration"}, - // parameter with suboptions parsed directly in parceargs + // parameter with suboptions parsed directly in parseargs {"mir-parameters",NEED_ARG,NULL,'M', arg_function,APTR(&get_mir_par),MirPar}, // another variant of setting parameter without argument {"add-noice",NO_ARGS, &G.randMask,1, arg_none, NULL, "add random noice to mirror surface deviations"}, @@ -216,7 +216,7 @@ bool get_mirpars(void *arg, suboptions *V){ } /** - * functions of subargs parcing can looks as this + * functions of subargs parsing can looks as this */ /** * Parse string of mirror parameters (--mir-diam=...) @@ -236,13 +236,13 @@ bool get_mir_par(void *arg){ } /** - * Parce command line options and return dynamically allocated structure + * Parse command line options and return dynamically allocated structure * to global parameters * @param argc - copy of argc from main * @param argv - copy of argv from main * @return allocated structure with global parameters */ -glob_pars *parce_args(int argc, char **argv){ +glob_pars *parse_args(int argc, char **argv){ int i; void *ptr; ptr = memcpy(&G, &Gdefault, sizeof(G)); assert(ptr); @@ -251,7 +251,7 @@ glob_pars *parce_args(int argc, char **argv){ // format of help: "Usage: progname [args]\n" change_helpstring("Usage: %s [args]\n\n\tWhere args are:\n"); // parse arguments - parceargs(&argc, &argv, cmdlnopts); + parseargs(&argc, &argv, cmdlnopts); if(help) showhelp(-1, cmdlnopts); if(argc > 0){ G.rest_pars_num = argc; diff --git a/getopt/cmdlnopts/cmdlnopts.h b/getopt/cmdlnopts/cmdlnopts.h index f4b1719..72b92ab 100644 --- a/getopt/cmdlnopts/cmdlnopts.h +++ b/getopt/cmdlnopts/cmdlnopts.h @@ -23,7 +23,7 @@ #ifndef __CMDLNOPTS_H__ #define __CMDLNOPTS_H__ -#include "parceargs.h" +#include "parseargs.h" /* * here are some typedef's for global data @@ -56,6 +56,5 @@ extern glob_pars const Gdefault; extern mirPar const Mdefault; extern int rewrite_ifexists, verbose; -glob_pars *parce_args(int argc, char **argv); - +glob_pars *parse_args(int argc, char **argv); #endif // __CMDLNOPTS_H__ diff --git a/getopt/cmdlnopts/main.c b/getopt/cmdlnopts/main.c index 51cefce..2bdf07e 100644 --- a/getopt/cmdlnopts/main.c +++ b/getopt/cmdlnopts/main.c @@ -29,7 +29,11 @@ typedef struct{ } filterpars; -void parce_filter(char *pars){ +void signals(int signo){ + exit(signo); +} + +void parse_filter(char *pars){ filterpars params = { 0, 3, 3}; mysuboption filteropts[] = { {"type", NEED_ARG, arg_string, ¶ms.filtertype}, @@ -47,7 +51,7 @@ void parce_filter(char *pars){ int main(int argc, char **argv){ glob_pars *G = NULL; // default parameters see in cmdlnopts.c mirPar *M = NULL; // default mirror parameters - G = parce_args(argc, argv); + G = parse_args(argc, argv); M = G->Mirror; printf("Globals:\n"); if(!G->S_dev){ @@ -98,7 +102,7 @@ int main(int argc, char **argv){ int i = 0; while(*fpars){ printf("%d:\n", i++); - parce_filter(*fpars); + parse_filter(*fpars); ++fpars; } } diff --git a/getopt/cmdlnopts/parseargs.c b/getopt/cmdlnopts/parseargs.c new file mode 100644 index 0000000..2f57be9 --- /dev/null +++ b/getopt/cmdlnopts/parseargs.c @@ -0,0 +1,497 @@ +/* + * parseargs.c - parsing command line arguments & print help + * + * Copyright 2013 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include // printf +#include // getopt_long +#include // calloc, exit, strtoll +#include // assert +#include // strdup, strchr, strlen +#include // strcasecmp +#include // INT_MAX & so on +#include // gettext +#include // isalpha +#include "parseargs.h" +#include "usefull_macros.h" + +char *helpstring = "%s\n"; + +/** + * Change standard help header + * MAY consist ONE "%s" for progname + * @param str (i) - new format + */ +void change_helpstring(char *s){ + int pcount = 0, scount = 0; + char *str = s; + // check `helpstring` and set it to default in case of error + for(; pcount < 2; str += 2){ + if(!(str = strchr(str, '%'))) break; + if(str[1] != '%') pcount++; // increment '%' counter if it isn't "%%" + else{ + str += 2; // pass next '%' + continue; + } + if(str[1] == 's') scount++; // increment "%s" counter + }; + if(pcount > 1 || pcount != scount){ // amount of pcount and/or scount wrong + /// "Неправильный формат строки помощи" + ERRX(_("Wrong helpstring!")); + } + helpstring = s; +} + +/** + * Carefull atoll/atoi + * @param num (o) - returning value (or NULL if you wish only check number) - allocated by user + * @param str (i) - string with number must not be NULL + * @param t (i) - T_INT for integer or T_LLONG for long long (if argtype would be wided, may add more) + * @return TRUE if conversion sone without errors, FALSE otherwise + */ +static bool myatoll(void *num, char *str, argtype t){ + long long tmp, *llptr; + int *iptr; + char *endptr; + assert(str); + assert(num); + tmp = strtoll(str, &endptr, 0); + if(endptr == str || *str == '\0' || *endptr != '\0') + return FALSE; + switch(t){ + case arg_longlong: + llptr = (long long*) num; + *llptr = tmp; + break; + case arg_int: + default: + if(tmp < INT_MIN || tmp > INT_MAX){ + /// "Целое вне допустимого диапазона" + WARNX(_("Integer out of range")); + return FALSE; + } + iptr = (int*)num; + *iptr = (int)tmp; + } + return TRUE; +} + +// the same as myatoll but for double +// There's no NAN & INF checking here (what if they would be needed?) +static bool myatod(void *num, const char *str, argtype t){ + double tmp, *dptr; + float *fptr; + char *endptr; + assert(str); + tmp = strtod(str, &endptr); + if(endptr == str || *str == '\0' || *endptr != '\0') + return FALSE; + switch(t){ + case arg_double: + dptr = (double *) num; + *dptr = tmp; + break; + case arg_float: + default: + fptr = (float *) num; + *fptr = (float)tmp; + break; + } + return TRUE; +} + +/** + * Get index of current option in array options + * @param opt (i) - returning val of getopt_long + * @param options (i) - array of options + * @return index in array + */ +static int get_optind(int opt, myoption *options){ + int oind; + myoption *opts = options; + assert(opts); + for(oind = 0; opts->name && opts->val != opt; oind++, opts++); + if(!opts->name || opts->val != opt) // no such parameter + showhelp(-1, options); + return oind; +} + +/** + * reallocate new value in array of multiple repeating arguments + * @arg paptr - address of pointer to array (**void) + * @arg type - its type (for realloc) + * @return pointer to new (next) value + */ +void *get_aptr(void *paptr, argtype type){ + int i = 1; + void **aptr = *((void***)paptr); + if(aptr){ // there's something in array + void **p = aptr; + while(*p++) ++i; + } + size_t sz = 0; + switch(type){ + default: + case arg_none: + /// "Не могу использовать несколько параметров без аргументов!" + ERRX("Can't use multiple args with arg_none!"); + break; + case arg_int: + sz = sizeof(int); + break; + case arg_longlong: + sz = sizeof(long long); + break; + case arg_double: + sz = sizeof(double); + break; + case arg_float: + sz = sizeof(float); + break; + case arg_string: + sz = 0; + break; + /* case arg_function: + sz = sizeof(argfn *); + break;*/ + } + aptr = realloc(aptr, (i + 1) * sizeof(void*)); + *((void***)paptr) = aptr; + aptr[i] = NULL; + if(sz){ + aptr[i - 1] = malloc(sz); + }else + aptr[i - 1] = &aptr[i - 1]; + return aptr[i - 1]; +} + + +/** + * Parse command line arguments + * ! If arg is string, then value will be strdup'ed! + * + * @param argc (io) - address of argc of main(), return value of argc stay after `getopt` + * @param argv (io) - address of argv of main(), return pointer to argv stay after `getopt` + * BE CAREFUL! if you wanna use full argc & argv, save their original values before + * calling this function + * @param options (i) - array of `myoption` for arguments parcing + * + * @exit: in case of error this function show help & make `exit(-1)` + */ +void parseargs(int *argc, char ***argv, myoption *options){ + char *short_options, *soptr; + struct option *long_options, *loptr; + size_t optsize, i; + myoption *opts = options; + // check whether there is at least one options + assert(opts); + assert(opts[0].name); + // first we count how much values are in opts + for(optsize = 0; opts->name; optsize++, opts++); + // now we can allocate memory + short_options = calloc(optsize * 3 + 1, 1); // multiply by three for '::' in case of args in opts + long_options = calloc(optsize + 1, sizeof(struct option)); + opts = options; loptr = long_options; soptr = short_options; + // in debug mode check the parameters are not repeated +#ifdef EBUG + char **longlist = MALLOC(char*, optsize); + char *shortlist = MALLOC(char, optsize); +#endif + // fill short/long parameters and make a simple checking + for(i = 0; i < optsize; i++, loptr++, opts++){ + // check + assert(opts->name); // check name +#ifdef EBUG + longlist[i] = strdup(opts->name); +#endif + if(opts->has_arg){ + assert(opts->type != arg_none); // check error with arg type + assert(opts->argptr); // check pointer + } + if(opts->type != arg_none) // if there is a flag without arg, check its pointer + assert(opts->argptr); + // fill long_options + // don't do memcmp: what if there would be different alignment? + loptr->name = opts->name; + loptr->has_arg = (opts->has_arg < MULT_PAR) ? opts->has_arg : 1; + loptr->flag = opts->flag; + loptr->val = opts->val; + // fill short options if they are: + if(!opts->flag){ +#ifdef EBUG + shortlist[i] = (char) opts->val; +#endif + *soptr++ = opts->val; + if(loptr->has_arg) // add ':' if option has required argument + *soptr++ = ':'; + if(loptr->has_arg == 2) // add '::' if option has optional argument + *soptr++ = ':'; + } + } + // sort all lists & check for repeating +#ifdef EBUG + int cmpstringp(const void *p1, const void *p2){ + return strcmp(* (char * const *) p1, * (char * const *) p2); + } + int cmpcharp(const void *p1, const void *p2){ + return (int)(*(char * const)p1 - *(char *const)p2); + } + qsort(longlist, optsize, sizeof(char *), cmpstringp); + qsort(shortlist,optsize, sizeof(char), cmpcharp); + char *prevl = longlist[0], prevshrt = shortlist[0]; + for(i = 1; i < optsize; ++i){ + if(longlist[i]){ + if(prevl){ + if(strcmp(prevl, longlist[i]) == 0) ERRX("double long arguments: --%s", prevl); + } + prevl = longlist[i]; + } + if(shortlist[i]){ + if(prevshrt){ + if(prevshrt == shortlist[i]) ERRX("double short arguments: -%c", prevshrt); + } + prevshrt = shortlist[i]; + } + } +#endif + // now we have both long_options & short_options and can parse `getopt_long` + while(1){ + int opt; + int oindex = 0, optind = 0; // oindex - number of option in argv, optind - number in options[] + if((opt = getopt_long(*argc, *argv, short_options, long_options, &oindex)) == -1) break; + if(opt == '?'){ + opt = optopt; + optind = get_optind(opt, options); + if(options[optind].has_arg == NEED_ARG || options[optind].has_arg == MULT_PAR) + showhelp(optind, options); // need argument + } + else{ + if(opt == 0 || oindex > 0) optind = oindex; + else optind = get_optind(opt, options); + } + opts = &options[optind]; + if(opt == 0 && opts->has_arg == NO_ARGS) continue; // only long option changing integer flag + // now check option + if(opts->has_arg == NEED_ARG || opts->has_arg == MULT_PAR) + if(!optarg) showhelp(optind, options); // need argument + void *aptr; + if(opts->has_arg == MULT_PAR){ + aptr = get_aptr(opts->argptr, opts->type); + }else + aptr = opts->argptr; + bool result = TRUE; + // even if there is no argument, but argptr != NULL, think that optarg = "1" + if(!optarg) optarg = "1"; + switch(opts->type){ + default: + case arg_none: + if(opts->argptr) *((int*)aptr) += 1; // increment value + break; + case arg_int: + result = myatoll(aptr, optarg, arg_int); + break; + case arg_longlong: + result = myatoll(aptr, optarg, arg_longlong); + break; + case arg_double: + result = myatod(aptr, optarg, arg_double); + break; + case arg_float: + result = myatod(aptr, optarg, arg_float); + break; + case arg_string: + result = (*((void**)aptr) = (void*)strdup(optarg)); + break; + case arg_function: + result = ((argfn)aptr)(optarg); + break; + } + if(!result){ + showhelp(optind, options); + } + } + *argc -= optind; + *argv += optind; +} + +/** + * compare function for qsort + * first - sort by short options; second - sort arguments without sort opts (by long options) + */ +static int argsort(const void *a1, const void *a2){ + const myoption *o1 = (myoption*)a1, *o2 = (myoption*)a2; + const char *l1 = o1->name, *l2 = o2->name; + int s1 = o1->val, s2 = o2->val; + int *f1 = o1->flag, *f2 = o2->flag; + // check if both options has short arg + if(f1 == NULL && f2 == NULL){ // both have short arg + return (s1 - s2); + }else if(f1 != NULL && f2 != NULL){ // both don't have short arg - sort by long + return strcmp(l1, l2); + }else{ // only one have short arg -- return it + if(f2) return -1; // a1 have short - it is 'lesser' + else return 1; + } +} + +/** + * Show help information based on myoption->help values + * @param oindex (i) - if non-negative, show only help by myoption[oindex].help + * @param options (i) - array of `myoption` + * + * @exit: run `exit(-1)` !!! + */ +void showhelp(int oindex, myoption *options){ + int max_opt_len = 0; // max len of options substring - for right indentation + const int bufsz = 255; + char buf[bufsz+1]; + myoption *opts = options; + assert(opts); + assert(opts[0].name); // check whether there is at least one options + if(oindex > -1){ // print only one message + opts = &options[oindex]; + printf(" "); + if(!opts->flag && isalpha(opts->val)) printf("-%c, ", opts->val); + printf("--%s", opts->name); + if(opts->has_arg == 1) printf("=arg"); + else if(opts->has_arg == 2) printf("[=arg]"); + printf(" %s\n", _(opts->help)); + exit(-1); + } + // header, by default is just "progname\n" + printf("\n"); + if(strstr(helpstring, "%s")) // print progname + printf(helpstring, __progname); + else // only text + printf("%s", helpstring); + printf("\n"); + // count max_opt_len + do{ + int L = strlen(opts->name); + if(max_opt_len < L) max_opt_len = L; + }while((++opts)->name); + max_opt_len += 14; // format: '-S , --long[=arg]' - get addition 13 symbols + opts = options; + // count amount of options + int N; for(N = 0; opts->name; ++N, ++opts); + if(N == 0) exit(-2); + // Now print all help (sorted) + opts = options; + qsort(opts, N, sizeof(myoption), argsort); + do{ + int p = sprintf(buf, " "); // a little indent + if(!opts->flag) // .val is short argument + p += snprintf(buf+p, bufsz-p, "-%c, ", opts->val); + p += snprintf(buf+p, bufsz-p, "--%s", opts->name); + if(opts->has_arg == 1) // required argument + p += snprintf(buf+p, bufsz-p, "=arg"); + else if(opts->has_arg == 2) // optional argument + p += snprintf(buf+p, bufsz-p, "[=arg]"); + assert(p < max_opt_len); // there would be magic if p >= max_opt_len + printf("%-*s%s\n", max_opt_len+1, buf, _(opts->help)); // write options & at least 2 spaces after + ++opts; + }while(--N); + printf("\n\n"); + exit(-1); +} + +/** + * get suboptions from parameter string + * @param str - parameter string + * @param opt - pointer to suboptions structure + * @return TRUE if all OK + */ +bool get_suboption(char *str, mysuboption *opt){ + int findsubopt(char *par, mysuboption *so){ + int idx = 0; + if(!par) return -1; + while(so[idx].name){ + if(strcasecmp(par, so[idx].name) == 0) return idx; + ++idx; + } + return -1; // badarg + } + bool opt_setarg(mysuboption *so, int idx, char *val){ + mysuboption *soptr = &so[idx]; + bool result = FALSE; + void *aptr = soptr->argptr; + switch(soptr->type){ + default: + case arg_none: + if(soptr->argptr) *((int*)aptr) += 1; // increment value + result = TRUE; + break; + case arg_int: + result = myatoll(aptr, val, arg_int); + break; + case arg_longlong: + result = myatoll(aptr, val, arg_longlong); + break; + case arg_double: + result = myatod(aptr, val, arg_double); + break; + case arg_float: + result = myatod(aptr, val, arg_float); + break; + case arg_string: + result = (*((void**)aptr) = (void*)strdup(val)); + break; + case arg_function: + result = ((argfn)aptr)(val); + break; + } + return result; + } + char *tok; + bool ret = FALSE; + char *tmpbuf; + tok = strtok_r(str, ":,", &tmpbuf); + do{ + char *val = strchr(tok, '='); + int noarg = 0; + if(val == NULL){ // no args + val = "1"; + noarg = 1; + }else{ + *val++ = '\0'; + if(!*val || *val == ':' || *val == ','){ // no argument - delimeter after = + val = "1"; noarg = 1; + } + } + int idx = findsubopt(tok, opt); + if(idx < 0){ + /// "Неправильный параметр: %s" + WARNX(_("Wrong parameter: %s"), tok); + goto returning; + } + if(noarg && opt[idx].has_arg == NEED_ARG){ + /// "%s: необходим аргумент!" + WARNX(_("%s: argument needed!"), tok); + goto returning; + } + if(!opt_setarg(opt, idx, val)){ + /// "Неправильный аргумент \"%s\" параметра \"%s\"" + WARNX(_("Wrong argument \"%s\" of parameter \"%s\""), val, tok); + goto returning; + } + }while((tok = strtok_r(NULL, ":,", &tmpbuf))); + ret = TRUE; +returning: + return ret; +} diff --git a/getopt/cmdlnopts/parseargs.h b/getopt/cmdlnopts/parseargs.h new file mode 100644 index 0000000..b8351d9 --- /dev/null +++ b/getopt/cmdlnopts/parseargs.h @@ -0,0 +1,124 @@ +/* + * parseargs.h - headers for parsing command line arguments + * + * Copyright 2013 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ +#pragma once +#ifndef __PARSEARGS_H__ +#define __PARSEARGS_H__ + +#include // bool +#include + +#ifndef TRUE + #define TRUE true +#endif + +#ifndef FALSE + #define FALSE false +#endif + +// macro for argptr +#define APTR(x) ((void*)x) + +// if argptr is a function: +typedef bool(*argfn)(void *arg); + +/* + * type of getopt's argument + * WARNING! + * My function change value of flags by pointer, so if you want to use another type + * make a latter conversion, example: + * char charg; + * int iarg; + * myoption opts[] = { + * {"value", 1, NULL, 'v', arg_int, &iarg, "char val"}, ..., end_option}; + * ..(parse args).. + * charg = (char) iarg; + */ +typedef enum { + arg_none = 0, // no arg + arg_int, // integer + arg_longlong, // long long + arg_double, // double + arg_float, // float + arg_string, // char * + arg_function // parse_args will run function `bool (*fn)(char *optarg, int N)` +} argtype; + +/* + * Structure for getopt_long & help + * BE CAREFUL: .argptr is pointer to data or pointer to function, + * conversion depends on .type + * + * ATTENTION: string `help` prints through macro PRNT(), bu default it is gettext, + * but you can redefine it before `#include "parseargs.h"` + * + * if arg is string, then value wil be strdup'ed like that: + * char *str; + * myoption opts[] = {{"string", 1, NULL, 's', arg_string, &str, "string val"}, ..., end_option}; + * *(opts[1].str) = strdup(optarg); + * in other cases argptr should be address of some variable (or pointer to allocated memory) + * + * NON-NULL argptr should be written inside macro APTR(argptr) or directly: (void*)argptr + * + * !!!LAST VALUE OF ARRAY SHOULD BE `end_option` or ZEROS !!! + * + */ +typedef enum{ + NO_ARGS = 0, // first three are the same as in getopt_long + NEED_ARG = 1, + OPT_ARG = 2, + MULT_PAR +} hasarg; + +typedef struct{ + // these are from struct option: + const char *name; // long option's name + hasarg has_arg; // 0 - no args, 1 - nesessary arg, 2 - optionally arg, 4 - need arg & key can repeat (args are stored in null-terminated array) + int *flag; // NULL to return val, pointer to int - to set its value of val (function returns 0) + int val; // short opt name (if flag == NULL) or flag's value + // and these are mine: + argtype type; // type of argument + void *argptr; // pointer to variable to assign optarg value or function `bool (*fn)(char *optarg, int N)` + const char *help; // help string which would be shown in function `showhelp` or NULL +} myoption; + +/* + * Suboptions structure, almost the same like myoption + * used in parse_subopts() + */ +typedef struct{ + const char *name; + hasarg has_arg; + argtype type; + void *argptr; +} mysuboption; + +// last string of array (all zeros) +#define end_option {0,0,0,0,0,0,0} +#define end_suboption {0,0,0,0} + +extern const char *__progname; + +void showhelp(int oindex, myoption *options); +void parseargs(int *argc, char ***argv, myoption *options); +void change_helpstring(char *s); +bool get_suboption(char *str, mysuboption *opt); + +#endif // __PARSEARGS_H__ diff --git a/getopt/cmdlnopts/usefull_macros.c b/getopt/cmdlnopts/usefull_macros.c new file mode 100644 index 0000000..f97c181 --- /dev/null +++ b/getopt/cmdlnopts/usefull_macros.c @@ -0,0 +1,327 @@ +/* + * usefull_macros.h - a set of usefull functions: memory, color etc + * + * Copyright 2013 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#include "usefull_macros.h" + +/** + * function for different purposes that need to know time intervals + * @return double value: time in seconds + */ +double dtime(){ + double t; + struct timeval tv; + gettimeofday(&tv, NULL); + t = tv.tv_sec + ((double)tv.tv_usec)/1e6; + return t; +} + +/******************************************************************************\ + * Coloured terminal +\******************************************************************************/ +int globErr = 0; // errno for WARN/ERR + +// pointers to coloured output printf +int (*red)(const char *fmt, ...); +int (*green)(const char *fmt, ...); +int (*_WARN)(const char *fmt, ...); + +/* + * format red / green messages + * name: r_pr_, g_pr_ + * @param fmt ... - printf-like format + * @return number of printed symbols + */ +int r_pr_(const char *fmt, ...){ + va_list ar; int i; + printf(RED); + va_start(ar, fmt); + i = vprintf(fmt, ar); + va_end(ar); + printf(OLDCOLOR); + return i; +} +int g_pr_(const char *fmt, ...){ + va_list ar; int i; + printf(GREEN); + va_start(ar, fmt); + i = vprintf(fmt, ar); + va_end(ar); + printf(OLDCOLOR); + return i; +} +/* + * print red error/warning messages (if output is a tty) + * @param fmt ... - printf-like format + * @return number of printed symbols + */ +int r_WARN(const char *fmt, ...){ + va_list ar; int i = 1; + fprintf(stderr, RED); + va_start(ar, fmt); + if(globErr){ + errno = globErr; + vwarn(fmt, ar); + errno = 0; + globErr = 0; + }else + i = vfprintf(stderr, fmt, ar); + va_end(ar); + i++; + fprintf(stderr, OLDCOLOR "\n"); + return i; +} + +static const char stars[] = "****************************************"; +/* + * notty variants of coloured printf + * name: s_WARN, r_pr_notty + * @param fmt ... - printf-like format + * @return number of printed symbols + */ +int s_WARN(const char *fmt, ...){ + va_list ar; int i; + i = fprintf(stderr, "\n%s\n", stars); + va_start(ar, fmt); + if(globErr){ + errno = globErr; + vwarn(fmt, ar); + errno = 0; + globErr = 0; + }else + i = +vfprintf(stderr, fmt, ar); + va_end(ar); + i += fprintf(stderr, "\n%s\n", stars); + i += fprintf(stderr, "\n"); + return i; +} +int r_pr_notty(const char *fmt, ...){ + va_list ar; int i; + i = printf("\n%s\n", stars); + va_start(ar, fmt); + i += vprintf(fmt, ar); + va_end(ar); + i += printf("\n%s\n", stars); + return i; +} + +/** + * Run this function in the beginning of main() to setup locale & coloured output + */ +void initial_setup(){ + // setup coloured output + if(isatty(STDOUT_FILENO)){ // make color output in tty + red = r_pr_; green = g_pr_; + }else{ // no colors in case of pipe + red = r_pr_notty; green = printf; + } + if(isatty(STDERR_FILENO)) _WARN = r_WARN; + else _WARN = s_WARN; + // Setup locale + setlocale(LC_ALL, ""); + setlocale(LC_NUMERIC, "C"); +#if defined GETTEXT_PACKAGE && defined LOCALEDIR + bindtextdomain(GETTEXT_PACKAGE, LOCALEDIR); + textdomain(GETTEXT_PACKAGE); +#endif +} + +/******************************************************************************\ + * Memory +\******************************************************************************/ +/* + * safe memory allocation for macro ALLOC + * @param N - number of elements to allocate + * @param S - size of single element (typically sizeof) + * @return pointer to allocated memory area + */ +void *my_alloc(size_t N, size_t S){ + void *p = calloc(N, S); + if(!p) ERR("malloc"); + //assert(p); + return p; +} + +/** + * Mmap file to a memory area + * + * @param filename (i) - name of file to mmap + * @return stuct with mmap'ed file or die + */ +mmapbuf *My_mmap(char *filename){ + int fd; + char *ptr; + size_t Mlen; + struct stat statbuf; + if(!filename) ERRX(_("No filename given!")); + if((fd = open(filename, O_RDONLY)) < 0) + ERR(_("Can't open %s for reading"), filename); + if(fstat (fd, &statbuf) < 0) + ERR(_("Can't stat %s"), filename); + Mlen = statbuf.st_size; + if((ptr = mmap (0, Mlen, PROT_READ, MAP_PRIVATE, fd, 0)) == MAP_FAILED) + ERR(_("Mmap error for input")); + if(close(fd)) ERR(_("Can't close mmap'ed file")); + mmapbuf *ret = MALLOC(mmapbuf, 1); + ret->data = ptr; + ret->len = Mlen; + return ret; +} + +void My_munmap(mmapbuf *b){ + if(munmap(b->data, b->len)) + ERR(_("Can't munmap")); + FREE(b); +} + + +/******************************************************************************\ + * Terminal in no-echo mode +\******************************************************************************/ +static struct termios oldt, newt; // terminal flags +static int console_changed = 0; +// run on exit: +void restore_console(){ + if(console_changed) + tcsetattr(STDIN_FILENO, TCSANOW, &oldt); // return terminal to previous state + console_changed = 0; +} + +// initial setup: +void setup_con(){ + if(console_changed) return; + tcgetattr(STDIN_FILENO, &oldt); + newt = oldt; + newt.c_lflag &= ~(ICANON | ECHO); + if(tcsetattr(STDIN_FILENO, TCSANOW, &newt) < 0){ + WARN(_("Can't setup console")); + tcsetattr(STDIN_FILENO, TCSANOW, &oldt); + signals(0); //quit? + } + console_changed = 1; +} + +/** + * Read character from console without echo + * @return char readed + */ +int read_console(){ + int rb; + struct timeval tv; + int retval; + fd_set rfds; + FD_ZERO(&rfds); + FD_SET(STDIN_FILENO, &rfds); + tv.tv_sec = 0; tv.tv_usec = 10000; + retval = select(1, &rfds, NULL, NULL, &tv); + if(!retval) rb = 0; + else { + if(FD_ISSET(STDIN_FILENO, &rfds)) rb = getchar(); + else rb = 0; + } + return rb; +} + +/** + * getchar() without echo + * wait until at least one character pressed + * @return character readed + */ +int mygetchar(){ // getchar() without need of pressing ENTER + int ret; + do ret = read_console(); + while(ret == 0); + return ret; +} + + +/******************************************************************************\ + * TTY with select() +\******************************************************************************/ +static struct termio oldtty, tty; // TTY flags +static int comfd = -1; // TTY fd + +// run on exit: +void restore_tty(){ + if(comfd == -1) return; + ioctl(comfd, TCSANOW, &oldtty ); // return TTY to previous state + close(comfd); + comfd = -1; +} + +#ifndef BAUD_RATE +#define BAUD_RATE B9600 +#endif +// init: +void tty_init(char *comdev){ + DBG("\nOpen port...\n"); + if ((comfd = open(comdev,O_RDWR|O_NOCTTY|O_NONBLOCK)) < 0){ + WARN("Can't use port %s\n",comdev); + ioctl(comfd, TCSANOW, &oldtty); // return TTY to previous state + close(comfd); + signals(0); // quit? + } + DBG(" OK\nGet current settings... "); + if(ioctl(comfd,TCGETA,&oldtty) < 0){ // Get settings + WARN(_("Can't get settings")); + signals(0); + } + tty = oldtty; + tty.c_lflag = 0; // ~(ICANON | ECHO | ECHOE | ISIG) + tty.c_oflag = 0; + tty.c_cflag = BAUD_RATE|CS8|CREAD|CLOCAL; // 9.6k, 8N1, RW, ignore line ctrl + tty.c_cc[VMIN] = 0; // non-canonical mode + tty.c_cc[VTIME] = 5; + if(ioctl(comfd,TCSETA,&tty) < 0){ + WARN(_("Can't set settings")); + signals(0); + } + DBG(" OK\n"); +} +/** + * Read data from TTY + * @param buff (o) - buffer for data read + * @param length - buffer len + * @return amount of readed bytes + */ +size_t read_tty(uint8_t *buff, size_t length){ + ssize_t L = 0; + fd_set rfds; + struct timeval tv; + int retval; + FD_ZERO(&rfds); + FD_SET(comfd, &rfds); + tv.tv_sec = 0; tv.tv_usec = 50000; // wait for 50ms + retval = select(comfd + 1, &rfds, NULL, NULL, &tv); + if (!retval) return 0; + if(FD_ISSET(comfd, &rfds)){ + if((L = read(comfd, buff, length)) < 1) return 0; + } + return (size_t)L; +} + +int write_tty(uint8_t *buff, size_t length){ + ssize_t L = write(comfd, buff, length); + if((size_t)L != length){ + WARN("Write error!"); + return 1; + } + return 0; +} diff --git a/getopt/cmdlnopts/usefull_macros.h b/getopt/cmdlnopts/usefull_macros.h new file mode 100644 index 0000000..499aacf --- /dev/null +++ b/getopt/cmdlnopts/usefull_macros.h @@ -0,0 +1,124 @@ +/* + * usefull_macros.h - a set of usefull macros: memory, color etc + * + * Copyright 2013 Edward V. Emelianoff + * + * 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 2 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, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, + * MA 02110-1301, USA. + */ + +#pragma once +#ifndef __USEFULL_MACROS_H__ +#define __USEFULL_MACROS_H__ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#if defined GETTEXT_PACKAGE && defined LOCALEDIR +/* + * GETTEXT + */ +#include +#define _(String) gettext(String) +#define gettext_noop(String) String +#define N_(String) gettext_noop(String) +#else +#define _(String) (String) +#define N_(String) (String) +#endif +#include +#include +#include +#include +#include +#include + + +// unused arguments with -Wall -Werror +#define _U_ __attribute__((__unused__)) + +/* + * Coloured messages output + */ +#define RED "\033[1;31;40m" +#define GREEN "\033[1;32;40m" +#define OLDCOLOR "\033[0;0;0m" + +/* + * ERROR/WARNING messages + */ +extern int globErr; +extern void signals(int sig); +#define ERR(...) do{globErr=errno; _WARN(__VA_ARGS__); signals(9);}while(0) +#define ERRX(...) do{globErr=0; _WARN(__VA_ARGS__); signals(9);}while(0) +#define WARN(...) do{globErr=errno; _WARN(__VA_ARGS__);}while(0) +#define WARNX(...) do{globErr=0; _WARN(__VA_ARGS__);}while(0) + +/* + * print function name, debug messages + * debug mode, -DEBUG + */ +#ifdef EBUG + #define FNAME() fprintf(stderr, "\n%s (%s, line %d)\n", __func__, __FILE__, __LINE__) + #define DBG(...) do{fprintf(stderr, "%s (%s, line %d): ", __func__, __FILE__, __LINE__); \ + fprintf(stderr, __VA_ARGS__); \ + fprintf(stderr, "\n");} while(0) +#else + #define FNAME() do{}while(0) + #define DBG(...) do{}while(0) +#endif //EBUG + +/* + * Memory allocation + */ +#define ALLOC(type, var, size) type * var = ((type *)my_alloc(size, sizeof(type))) +#define MALLOC(type, size) ((type *)my_alloc(size, sizeof(type))) +#define FREE(ptr) do{free(ptr); ptr = NULL;}while(0) + +double dtime(); + +// functions for color output in tty & no-color in pipes +extern int (*red)(const char *fmt, ...); +extern int (*_WARN)(const char *fmt, ...); +extern int (*green)(const char *fmt, ...); +void * my_alloc(size_t N, size_t S); +void initial_setup(); + +// mmap file +typedef struct{ + char *data; + size_t len; +} mmapbuf; +mmapbuf *My_mmap(char *filename); +void My_munmap(mmapbuf *b); + +void restore_console(); +void setup_con(); +int read_console(); +int mygetchar(); + +void restore_tty(); +void tty_init(char *comdev); +size_t read_tty(uint8_t *buff, size_t length); +int write_tty(uint8_t *buff, size_t length); + +#endif // __USEFULL_MACROS_H__