commit 0b4ccf161c4d9ddf130cb0e08c4a4c6fc9b6a007 Author: Maxim Likhachev Date: Wed Dec 18 20:54:22 2019 +0300 Vimtrospection v1.0 diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/CoC.md b/CoC.md new file mode 100644 index 0000000..55df6a7 --- /dev/null +++ b/CoC.md @@ -0,0 +1,7 @@ +# Go Fuck Yourself + +Offended? Go away. We don't need people who are offended because of a stranger on the internet. +Not offended? You're welcome to contribute. + +© Copyright 2015 [WTFCoC Consortium Committee](https://github.com/mniip/wtfcoc). + diff --git a/README.md b/README.md new file mode 100644 index 0000000..ca3875e --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# Vimtrospection + + _ _ _ _ + /\ /(_)_ __ ___ | |_ _ __ ___ ___ _ __ ___ ___| |_(_) ___ _ __ + \ \ / / | '_ ` _ \| __| '__/ _ \/ __| '_ \ / _ \/ __| __| |/ _ \| '_ \ + \ V /| | | | | | | |_| | | (_) \__ \ |_) | __/ (__| |_| | (_) | | | | + \_/ |_|_| |_| |_|\__|_| \___/|___/ .__/ \___|\___|\__|_|\___/|_| |_| + |_| + +## Описание + +Данный скрипт предназначен для получения статистики из дневника, ведущегося в +[vimwiki](https://github.com/vimwiki/vimwiki). + +## Основные функции + +- Индексная страница в виде календаря со ссылками на даты. +- Частотный список слов. +- Частотный список меток (`*[Tag 1, Tag 2]*`). +- Отображение используемых меток на временной шкале. +- Отображение всех TODO-элементов (`* [ ] TODO: text`) на одной странице. + +## Использование + +1. Указать пути к vimwiki в переменных пространства имён `options`. +2. Запустить сценарий: `$ vimtrospection.tcl`. + +----- + +### NB: Скрипт не разрабатывается и представляет ценность только как пример работы с vim и vimwiki при помощи языка Tcl. + +## Лицензия + Copyright (C) 2010-2019, Maxim Lihachev, + + 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 . + diff --git a/tests/all.tcl b/tests/all.tcl new file mode 100644 index 0000000..01a1fd1 --- /dev/null +++ b/tests/all.tcl @@ -0,0 +1,10 @@ +#!/usr/bin/env tclsh + +#Создан: Птн 22 Апр 2011 18:22:19 +#Изменён: Вск 07 Авг 2011 18:05:38 + +package require tcltest +set ::env(TEST) 1 + +tcltest::runAllTests + diff --git a/tests/base.test b/tests/base.test new file mode 100644 index 0000000..3ddec60 --- /dev/null +++ b/tests/base.test @@ -0,0 +1,10 @@ +#!/usr/bin/env tclsh + +#Создан: Вск 24 Апр 2011 20:16:09 +#Изменён: Вск 07 Авг 2011 18:05:41 + +source check.tcl +source ../vimtrospection.tcl + +tcltest::cleanupTests + diff --git a/tests/calendar.test b/tests/calendar.test new file mode 100644 index 0000000..e06e546 --- /dev/null +++ b/tests/calendar.test @@ -0,0 +1,10 @@ +#!/usr/bin/env tclsh + +#Создан: Вск 24 Апр 2011 20:16:09 +#Изменён: Вск 07 Авг 2011 18:05:44 + +source check.tcl +source ../vimtrospection.tcl + +tcltest::cleanupTests + diff --git a/tests/check.tcl b/tests/check.tcl new file mode 100644 index 0000000..7e6c92e --- /dev/null +++ b/tests/check.tcl @@ -0,0 +1,17 @@ +#!/usr/bin/env tclsh + +#Создан: Птн 22 Апр 2011 18:27:58 +#Изменён: Вск 07 Авг 2011 18:05:47 + +package require tcltest + +proc check {name description _where tests} { + foreach test [split $tests \n] { + #TODO: Пропуск комментариев + if {[regexp -all -- {\s*([^#].+)\s+~>\s+(.+)\s*$} $test -> exp results]} { + regsub -all -- {(\w+): } $results {-\1 } results + uplevel #1 " tcltest::test $name \{$description\} -body \{\n\t$name $exp\n\} $results " + } + } +} + diff --git a/tests/fs.test b/tests/fs.test new file mode 100644 index 0000000..1d6696b --- /dev/null +++ b/tests/fs.test @@ -0,0 +1,15 @@ +#!/usr/bin/env tclsh + +#Создан: Вск 24 Апр 2011 20:16:09 +#Изменён: Вск 07 Авг 2011 18:05:51 + +source check.tcl +source ../vimtrospection.tcl + +check fs::findWikiFiles {directory} where {} +check fs::readFile {filename} where {} +check fs::readAllFiles {files} where {} +check fs::saveToFile {filename data} where {} + +tcltest::cleanupTests + diff --git a/tests/list.test b/tests/list.test new file mode 100644 index 0000000..7058da3 --- /dev/null +++ b/tests/list.test @@ -0,0 +1,59 @@ +#!/usr/bin/env tclsh + +#Создан: Вск 24 Апр 2011 20:16:09 +#Изменён: Вск 07 Авг 2011 18:05:55 + +source check.tcl +source ../vimtrospection.tcl + +check list::head {list} where { + {} ~> result: {} + {1} ~> result: {1} + {1 2} ~> result: {1} + {1 2 3 4} ~> result: {1} + {{1 2} 3} ~> result: {1 2} +} + +check list::tail {list} where { + {} ~> result: {} + {1} ~> result: {} + {1 2} ~> result: {2} + {1 2 3 4} ~> result: {2 3 4} + {1 {2 3} 4} ~> result: {{2 3} 4} +} + +check list::group {list} where { + {} ~> result: {{{}}} + {1} ~> result: {1} + {1 2 3 4 5} ~> result: {1 2 3 4 5} + {1 2 2 3 3 3 4 4 4 4} ~> result: {1 {2 2} {3 3 3} {4 4 4 4}} + {1 2 2 3 3 2 3 4 3 3} ~> result: {1 {2 2} {3 3} 2 3 4 {3 3}} +} + +# countUniqueElements {a {b b} {c c c}} => {{a 1} {b 2} {c 3}} +check list::countUniqueElements {list} where { + {} ~> result: {} + {1} ~> result: {{1 1}} + {1 2 3} ~> result: {{1 1} {2 1} {3 1}} + {1 {2 2} {3 3 3}} ~> result: {{1 1} {2 2} {3 3}} + {a {b b} {c c c}} ~> result: {{a 1} {b 2} {c 3}} + {a {b c} {c d w}} ~> result: {{a 1} {b 2} {c 3}} +} + +check list::getMaxLength {list} where { + {} ~> result: 0 + {1} ~> result: 1 + {1 2 3} ~> result: 1 + {a b c d} ~> result: 1 + {a bb ccc} ~> result: 3 + {a bb {to big} ccc} ~> result: 6 +} + +# sortDownByKey {{c 40} {a 3} {b 100}} => {{b 100} {c 40} {a 3}} +# sortDownByKey {{c 40} {a 3} {b 100}} 0 => {{c 40} {b 100} {a 3}} +# check list::sortDownByKey {list {key 1}} { } + +# check list::wordList {string} { } + +tcltest::cleanupTests + diff --git a/tests/statistics.test b/tests/statistics.test new file mode 100644 index 0000000..e145882 --- /dev/null +++ b/tests/statistics.test @@ -0,0 +1,10 @@ +#!/usr/bin/env tclsh + +#Создан: Вск 24 Апр 2011 20:16:09 +#Изменён: Вск 07 Авг 2011 18:05:59 + +source check.tcl +source ../vimtrospection.tcl + +tcltest::cleanupTests + diff --git a/tests/string.test b/tests/string.test new file mode 100644 index 0000000..3b617d9 --- /dev/null +++ b/tests/string.test @@ -0,0 +1,10 @@ +#!/usr/bin/env tclsh + +#Создан: Вск 24 Апр 2011 20:16:09 +#Изменён: Вск 07 Авг 2011 18:06:01 + +source check.tcl +source ../vimtrospection.tcl + +tcltest::cleanupTests + diff --git a/tests/test.test b/tests/test.test new file mode 100644 index 0000000..efbc21d --- /dev/null +++ b/tests/test.test @@ -0,0 +1,108 @@ +#!/usr/bin/env tclsh + +#Создан: Чтв 09 Дек 2010 17:51:34 +#Изменён: Вск 24 Апр 2011 20:39:50 + +source testSuite.tcl +source check.tcl +source ../vimtrospection.tcl + +st::addproc todo? { + string +} where { + {{{{* [ ] TODO: КАТЕГОРИЯ: задача}}} -> 1} + {{{{* [X] TODO: КАТЕГОРИЯ: задача}}} -> 1} + + {{{{# [ ] TODO: КАТЕГОРИЯ: задача}}} -> 1} + {{{{# [X] TODO: КАТЕГОРИЯ: задача}}} -> 1} + + {{{{# [ ] TODO: задача}}} -> 0} + {{{{# [X] TODO: задача}}} -> 0} + + {{{{# [ ] TODO: задача}}} -> 0} + {{{{# [X] TODO: задача}}} -> 0} + + {{{{ * [ ] TODO: КАТЕГОРИЯ: задача}}} -> 1} + {{{{ * [X] TODO: КАТЕГОРИЯ: задача}}} -> 1} + + {{{{ # [ ] TODO: КАТЕГОРИЯ: задача}}} -> 1} + {{{{ # [X] TODO: КАТЕГОРИЯ: задача}}} -> 1} + + {{{{ # [ ] TODO: задача}}} -> 0} + {{{{ # [X] TODO: задача}}} -> 0} + + {{{{ # [ ] TODO: задача}}} -> 0} + {{{{ # [X] TODO: задача}}} -> 0} +} + +st::addproc timestamp? { + string +} where { + {{{{= Пятница, Декабрь 10 2010 =}}} -> 1} + {{{{= 17:54:48 =}}} -> 1} + + {{{{=Пятница, Декабрь 10 2010=}}} -> 0} + {{{{=17:54:48=}}} -> 0} +} + +st::addproc list::head { + list +} where { + {{{{}}} -> {}} + {{{{1}}} -> 1} + {{{{1 2 3 4}}} -> 1} +} + +st::addproc list::tail { + list +} where { + {{{{}}} -> {}} + {{{{1}}} -> {}} + {{{{1 2}}} -> {2}} + {{{{1 2 3 4}}} -> {2 3 4}} +} + +st::addproc list::group { + list +} where { + {{{{}}} -> {{{}}}} + {{{{1 2 3 4}}} -> {1 2 3 4}} + {{{{1 2 2 3 3 3 4 4 4 4}}} -> {1 {2 2} {3 3 3} {4 4 4 4}}} +} + +st::addproc list::countUniqueElements { + list +} where { + {{{{}}} -> {}} + {{{{a b c d}}} -> {{a 1} {b 1} {c 1} {d 1}}} + {{{{a {b b} {c c c} {d d d d}}}} -> {{a 1} {b 2} {c 3} {d 4}}} +} + +st::addproc list::sortDownByKey { + list + key +} where { + {{{{}}} -> {}} + {{{{} 0}} -> {}} + {{{{{a 3} {b 5} {c -3}}}} -> {{b 5} {a 3} {c -3}}} +} + +st::addproc string::realString? { + string +} where { + {{{{}}} -> 0} + {{{{ }}} -> 0} + {{{{100}}} -> 0} + {{{{строка текста}}} -> 1} +} + +st::addproc string::splitTags { + tags +} where { + {{{{}}} -> {}} + {{{{1,2,3}}} -> {1 2 3}} + {{{{tag 1, tag 2, tag3}}} -> {{Tag 1} {Tag 2} Tag3}} +} + +tcltest::cleanupTests + diff --git a/tests/testSuite.tcl b/tests/testSuite.tcl new file mode 100644 index 0000000..6985165 --- /dev/null +++ b/tests/testSuite.tcl @@ -0,0 +1,170 @@ +#!/usr/bin/env tclsh + +#Создан: Сбт 23 Окт 2010 22:31:17 +#Изменён: Сбт 27 Ноя 2010 11:13:35 + +#http://wiki.tcl.tk/20549 + +namespace eval st { + variable collect true ;# Flag to say whether to run tests + variable tests ;# Array of lists of tests to run, indexed on namespace + variable tol 1.0e-7 ;# Tolerance +} + + +#Настройка цвета +array set color { + NC "\033\[00m" + Blue "\033\[1;36m" + Yellow "\033\[1;33m" + Green "\033\[1;32m" + White "\033\[1;37m" + Red "\033\[1;31m" +} + +# name is the name of the proc +# annot is a free-form annotation area +# WORD is ignored and could be, for example: +# tests +# e.g. +# where +# +# tests are of the form args -> result +proc st::addproc {name annot WORD testlist} { + variable tests + variable collect + + set ns [uplevel 1 {namespace current}] + + if {$collect} { + lappend tests($ns) [list $name $testlist] + } +} + +proc st::off {} { + variable collect + set collect false +} + +proc st::on {} { + variable collect + set collect true +} + +# This will default to the default of 1.0e-7 if not specified +proc st::tolerance {{v 1.0e-7}} { + variable tol + + set tol $v +} + +proc st::print {} { + lassign [uplevel 1 st::run] Ntest Nfail errors + + puts "All tests:" + foreach error $errors { + lassign $error error call res expected + puts [format " %3s Call: %s" [incr testIndex] $call] + puts " Error: $error" + puts " Result: $res" + puts " Expected: $expected" + puts "" + } + + if {$Ntest == 1} { + set ntests "test" + } else { + set ntests "tests" + } + puts [format "%d %s run" $Ntest $ntests] + + if {$Ntest - $Nfail == 1} { + set ptests "test" + } else { + set ptests "tests" + } + puts [format "%d %s passed" [expr {$Ntest - $Nfail}] $ptests] + + if {$Ntest != 0} { + puts [format "%.1f%% pass rate" [expr {100 * (1 - double($Nfail)/$Ntest)}]] + } +} + +proc st::run {} { + variable tests + variable tol + + lassign {0 0} Ntest Nfail + + set ns [uplevel 1 {namespace current}] + + set errors {} + + if [info exists tests($ns)] { + foreach testset $tests($ns) { + lassign $testset name testlist + foreach testitem $testlist { + # R is a "relationship" + lassign $testitem arglist R expected + if [catch {uplevel 1 $name {*}$arglist} res] { + lappend errors [list \ + $res \ + "$ns\:\:$name $arglist" \ + "NA" \ + $expected + ] + incr Nfail + } else { + switch -- $R { + -> { + if {$res ne $expected} { + lappend errors [list \ + "$::color(Red)Result did not match expected value$::color(NC)" \ + "$ns\:\:$name $arglist" \ + $res \ + $expected \ + ] + incr Nfail + } else { + lappend errors [list \ + "$::color(Green)PASSED$::color(NC)" \ + "$ns\:\:$name $arglist" \ + $res \ + $expected \ + ] + } + } + ~ { + if {![string is double $res] || ![string is double $expected]} { + lappend errors [list \ + "$::color(Yellow)For ~, result and expected value should both be numbers$::color(NC)" \ + "$ns\:\:$name $arglist" \ + $res \ + "$expected \u00B1 $tol" \ + ] + incr Nfail + } elseif {abs($res - $expected) >= $tol} { + lappend errors [list \ + "$::color(Red)Result disagrees with expected value within tolerance of $tol$::color(NC)" \ + "$ns\:\:$name $arglist" \ + $res \ + "$expected \u00B1 $tol" \ + ] + incr Nfail + } else { + lappend errors [list \ + "$::color(Green)PASSED$::color(NC)" \ + "$ns\:\:$name $arglist" \ + $res \ + "$expected \u00B1 $tol" \ + ] + } + } + } + } + incr Ntest + } + } + } + return [list $Ntest $Nfail $errors] +} diff --git a/tests/vim.test b/tests/vim.test new file mode 100644 index 0000000..9d90def --- /dev/null +++ b/tests/vim.test @@ -0,0 +1,32 @@ +#!/usr/bin/env tclsh + +#Создан: Вск 24 Апр 2011 20:16:09 +#Изменён: Вск 07 Авг 2011 18:06:14 + +source check.tcl +source ../vimtrospection.tcl + +check vim::list {args} where { + {} ~> result: {[]} + 1 2 ~> result: {[1,2]} + 1 2 3 ~> result: {[1,2,3]} + a b c d ~> result: {[a,b,c,d]} +} + +check vim::ntuple {args} where { + {} ~> result: {{'': ''}} + 1 ~> result: {{'1': ''}} + 1 2 ~> result: {{'1': '2'}} + 1 2 3 ~> result: {{'1': '2', '3': ''}} + 1 2 3 4 ~> result: {{'1': '2', '3': '4'}} +} + +check vim::let {varName = varValue} where { + var = value ~> result: "let var = value" +} + +check vim::dumpOmniCompletionList {list} where { +} + +tcltest::cleanupTests + diff --git a/tests/vimwiki.test b/tests/vimwiki.test new file mode 100644 index 0000000..4ce4ae3 --- /dev/null +++ b/tests/vimwiki.test @@ -0,0 +1,134 @@ +#!/usr/bin/env tclsh + +#Создан: Вск 24 Апр 2011 20:16:09 +#Изменён: Вск 07 Авг 2011 18:06:17 + +source check.tcl +source ../vimtrospection.tcl + +check vimwiki::link {} where { + testurl.wiki ~> result: {[[testurl.wiki]]} + testurl.wiki {описание ссылки} ~> result: {[[testurl.wiki|описание ссылки]]} +} + +check vimwiki::setSurroundToString {} where { + == строка ~> result: {==строка==} + == строка { } ~> result: {== строка ==} + == строка {-} ~> result: {==-строка-==} +} + +check bold {} where { + {} ~> result: {**} + строка ~> result: {*строка*} + *строка* ~> constraints: knownBug result: {*строка*} +} + +check italic {} where { + {} ~> result: {__} + строка ~> result: {_строка_} + _строка_ ~> constraints: knownBug result: {_строка_} +} + +check vimwiki::header {} where { + 1 {} ~> result: {= =} + 2 {} ~> result: {== ==} + 3 {} ~> result: {=== ===} + 4 {} ~> result: {==== ====} + + 1 wiki-заголовок ~> result: {= wiki-заголовок =} + 2 wiki-заголовок ~> result: {== wiki-заголовок ==} + 3 wiki-заголовок ~> result: {=== wiki-заголовок ===} + 4 wiki-заголовок ~> result: {==== wiki-заголовок ====} + + -1 wiki-заголовок ~> constraints: knownBug result: {= wiki-заголовок =} + 0 wiki-заголовок ~> constraints: knownBug result: {= wiki-заголовок =} + -1 {} ~> constraints: knownBug result: {= =} + 0 {} ~> constraints: knownBug result: {= =} +} + +check h1 {} where { {} ~> result: {= =} } +check h1 {} where { {строка} ~> result: {= строка =} } +check h2 {} where { {} ~> result: {== ==} } +check h2 {} where { {строка} ~> result: {== строка ==} } +check h3 {} where { {} ~> result: {=== ===} } +check h3 {} where { {строка} ~> result: {=== строка ===} } +check h4 {} where { {} ~> result: {==== ====} } +check h4 {} where { {строка} ~> result: {==== строка ====} } + +check vimwiki::listItem {} where { + "элемент списка" ~> result: "* элемент списка" + "элемент списка" dot ~> result: "* элемент списка" + "элемент списка" enum ~> result: "# элемент списка" +} + +check vimwiki::list {} where { + {} ~> result: {} + {""} ~> result: {{* }} + {"строка 1"} ~> result: {{* строка 1}} + {"строка 1" "строка 2"} ~> result: {{* строка 1} {* строка 2}} + {"строка 1" "строка 2" "строка 3"} ~> result: {{* строка 1} {* строка 2} {* строка 3}} + {""} enum ~> result: {{# }} + {"строка 1"} enum ~> result: {{# строка 1}} + {"строка 1" "строка 2"} enum ~> result: {{# строка 1} {# строка 2}} + {"строка 1" "строка 2" "строка 3"} enum ~> result: {{# строка 1} {# строка 2} {# строка 3}} +} + +check vimwiki::todoItem {} where { + "элемент списка дел" ~> result: {* [ ] элемент списка дел} + "элемент списка дел" dot ~> result: {* [ ] элемент списка дел} + "элемент списка дел" enum ~> result: {# [ ] элемент списка дел} + "элемент списка дел" dot done ~> result: {* [X] элемент списка дел} + "элемент списка дел" enum done ~> result: {# [X] элемент списка дел} +} + +check vimwiki::todo {} where { + {} ~> result: {} + {""} ~> result: {{* [ ] }} + {"строка 1"} ~> result: {{* [ ] строка 1}} + {"строка 1" "строка 2"} ~> result: {{* [ ] строка 1} {* [ ] строка 2}} + {"строка 1" "строка 2" "строка 3"} ~> result: {{* [ ] строка 1} {* [ ] строка 2} {* [ ] строка 3}} + {""} enum ~> result: {{# [ ] }} + {"строка 1"} enum ~> result: {{# [ ] строка 1}} + {"строка 1" "строка 2"} enum ~> result: {{# [ ] строка 1} {# [ ] строка 2}} + {"строка 1" "строка 2" "строка 3"} enum ~> result: {{# [ ] строка 1} {# [ ] строка 2} {# [ ] строка 3}} + {""} dot done ~> result: {{* [X] }} + {"строка 1"} dot done ~> result: {{* [X] строка 1}} + {"строка 1" "строка 2"} dot done ~> result: {{* [X] строка 1} {* [X] строка 2}} + {"строка 1" "строка 2" "строка 3"} dot done ~> result: {{* [X] строка 1} {* [X] строка 2} {* [X] строка 3}} + {""} enum done ~> result: {{# [X] }} + {"строка 1"} enum done ~> result: {{# [X] строка 1}} + {"строка 1" "строка 2"} enum done ~> result: {{# [X] строка 1} {# [X] строка 2}} + {"строка 1" "строка 2" "строка 3"} enum done ~> result: {{# [X] строка 1} {# [X] строка 2} {# [X] строка 3}} +} + +check center {} where { + "" ~> result: " " + "строка по центру" ~> result: " строка по центру" +} + +check quote {} where { + "" ~> result: " " + "цитата" ~> result: " цитата" +} + +check vimwiki::code {} where { + "" ~> result: {\{\{\{\n\n\}\}\}} + "строка" ~> result: {\{\{\{\nстрока\n\}\}\}} + "строка" "tcl" ~> result: {\{\{\{class="brush:tcl"\nстрока\n\}\}\}} +} + +check tags? {} where { + {*[]*} ~> result: 0 + {{[tag1,tag2,tag3]}} ~> result: 0 + {{*tag1,tag2,tag3*}} ~> result: 0 + {{*tag1,tag2,tag3]*}} ~> result: 0 + {{*[tag1,tag2,tag3*}} ~> result: 0 + + {*[tag1,tag2,tag3]*} ~> result: 1 + {*[tag1, tag2, tag3]*} ~> result: 1 + { *[tag1,tag2,tag3]*} ~> result: 1 + { *[tag1, tag2, tag3]*} ~> result: 1 +} + +tcltest::cleanupTests + diff --git a/vimtrospection.tcl b/vimtrospection.tcl new file mode 100755 index 0000000..7575e6b --- /dev/null +++ b/vimtrospection.tcl @@ -0,0 +1,1382 @@ +#!/usr/bin/env tclsh + +#Создан: Чтв 09 Дек 2010 17:51:34 +#Изменён: ср 18 дек 2019 20:07:34 + +# +# Copyright (C) 2010-2019, Maxim Lihachev, +# +# 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, version 3. +# +# 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 . +# + +# ------------------------------------------------------------------------------ +# _ _ _ _ +# /\ /(_)_ __ ___ | |_ _ __ ___ ___ _ __ ___ ___| |_(_) ___ _ __ +# \ \ / / | '_ ` _ \| __| '__/ _ \/ __| '_ \ / _ \/ __| __| |/ _ \| '_ \ +# \ V /| | | | | | | |_| | | (_) \__ \ |_) | __/ (__| |_| | (_) | | | | +# \_/ |_|_| |_| |_|\__|_| \___/|___/ .__/ \___|\___|\__|_|\___/|_| |_| +# |_| +# +# ------------------------------------------------------------------------------ + +# TODO: Выполнение сторонних скриптов (концерты/театр/выставки/etc). +# TODO: Формирование today.html. +# TODO: Создание файла с концертами/спектаклями/выставками. +# TODO: Создание символических ссылок на audio/, images/. + +package require struct::list +package require fileutil + +# +# Настройки +# +namespace eval options { + set vimWikiDiaryWikiDirectory vimwiki/wiki/ЖЖ/Календарь/ + set vimWikiDiaryHtmlDirectory vimwiki/html/ЖЖ/Календарь/ + + #WARNINGS: ДИРЕКТОРИЯ ОЧИЩАЕТСЯ ПРИ КАЖДОМ ЗАПУСКЕ ПРОГРАММЫ! + set vimWikiDiaryStatistics vimwiki/html/ЖЖ/Календарь/statistics/ + + array set file { + INDEX index.wiki + BOOKS ../Книги/Прочитано.wiki + calendar months.wiki + + statistic_tags_html statistic_tags.html + statistic_tags_wiki statistic_tags.wiki + + statistic_words_html statistic_words.html + + timeline_html timeline.html + timeline_wiki timeline.wiki + } +} + +# +# Базовые процедуры, используемые в программе +# +namespace eval base { + proc any {args} { + expr {[join $args { || }]} + } + + proc not {exp} { + expr {!$exp} + } + + proc cmpLength {a b} { + expr {[string length $a] < [string length $b]} + } + + proc odd? {int} { + expr {($int % 2) != 0} + } + + proc filterMap {procFilter procMap data} { + struct::list filter [struct::list flatten \ + [struct::list map $data $procMap] \ + ] $procFilter + } +} + +# +# Структуры данных и синтаксические конструкции vim +# +namespace eval vim { + # Список в формате vim: [1, 2, 3...] + proc list {args} { + format {[%s]} [join $args ,] + } + + # Словарь в формате vim: { {'a': '1'}, {'b': '2'} } + proc ntuple {args} { + set result \{ + + set rest [lassign $args firstKey firstValue] + + append result [format {'%s': '%s'} $firstKey $firstValue] + + foreach {key value} $rest { + append result {, } [format {'%s': '%s'} $key $value] + } + + append result \} + } + + # Конструкция "let var = value" + proc let {varName = varValue} { + format "let %s = %s" $varName $varValue + } + + # Список автодополнения vim: + # + # let b:vimwiki_diary_tags = [{ + # { 'key 1': 'description' }, + # { 'key 2': 'description' } + # }] + # + proc dumpOmniCompletionList {list} { + set result {} + + foreach elem $list { + lassign $elem key description + append result [vim::ntuple $key $description] + } + + vim::let b:vimwiki_diary_tags = [vim::list $result] + } +} + +# +# Набор процедур, выполняющих разметку текста в формате VimWiki +# +namespace eval vimwiki { + # + # Процедура "оборачивает" строку подстрокой, помещая ее в начале + # и в конце строки и, при необходимости, используя строку-разделитель + # + # setSurroundToString "строка текста" "=" => "=строка текста=" + # setSurroundToString "строка текста" "=" { } => "= строка текста =" + # + proc setSurroundToString {substr string {sep {}}} { + format {%s%s%s%s%s} $substr $sep $string $sep $substr + } + + # + # Создание заголовка VimWiki. Заголовком в VimWiki считается строка, + # заключенная в "=". + # + # Всего существует 4 уровня заголовков, формируемых соответствующим + # количеством меток: + # * h1 - = header = + # * h2 - == header == + # * h3 - === header === + # * h4 - ==== header ==== + # + proc header {level string} { + setSurroundToString [string repeat "=" $level] $string { } + } + + interp alias {} h1 {} vimwiki::header 1 + interp alias {} h2 {} vimwiki::header 2 + interp alias {} h3 {} vimwiki::header 3 + interp alias {} h4 {} vimwiki::header 4 + + # Оформление блоков кода + # + # Без подсветки синтаксиса: + # {{{ + # фрагмент + # кода + # }}} + # + # С подсветкой синтаксиса: + # {{{class="brush:tcl" + # puts "Hello, World!" + # exit 0 + # }}} + # + # ?type? - используемый синтаксис + # + proc code {string {type {}}} { + format {\{\{\{%s\n%s\n\}\}\}} [expr { + $type eq "" ? "" : "class=\"brush:$type\"" + }] $string + + } + + # Создание блоков цитирования + interp alias {} quote {} format { %s} + + # Полужирное начертание текста + interp alias {} bold {} vimwiki::setSurroundToString "*" + + # Курсивное начертание текста + interp alias {} italic {} vimwiki::setSurroundToString "_" + + # Центрирование заголовков + interp alias {} center {} format { %s} + + # Комментарий vimwiki (%% string) + proc commentary {string} { + format "%s %s" {%%} $string + } + + # Оформление гиперссылок на страницы VimWiki в следующем формате: + # [[файл]] + # [[директория/файл]] + # [[файл|описание ссылки]] + # + # link diary.wiki => [[diary.wiki]] + # link diary.wiki Дневник => [[diary.wiki|Дневник]] + # + proc link {url {alt {}} {type {}}} { + format {[[%s%s]]} $url [expr { + $alt ne "" ? "[expr {$type eq {table} ? "\]\[" : "|"}]$alt" : "" + }] + } + + # + # Создание элемента маркированного списка + # + # Маркированный список может быть двух видов: + # Нумерованным: # строка текста + # Ненумерованным: * строка текста + # + proc listItem {item {markType dot}} { + format {%s %s} [expr {$markType eq "dot" ? "*" : "#"}] $item + } + + # Создание маркированного списка в формате VimWiki + # + # list {1 2 3} => {{* 1} {* 2} {* 3}} + # list {1 2 3} enum => {{# 1} {# 2} {# 3}} + # + proc list {items {markType dot}} { + struct::list mapfor item $items {listItem $item $markType} + } + + # + # Создание элемента списка дел в формате VimWiki: + # Нумерованный: # [ ] задача + # Ненумерованный: * [ ] задача + # + # todoItem задача => "* [ ] задача" + # todoItem задача enum => "# [ ] задача" + # todoItem задача dot done => "* [X] задача" + # todoItem задача enum done => "# [X] задача" + # + proc todoItem {item {markType dot} {status {}}} { + listItem [format "\[%s\] %s" [expr {$status eq "done" ? "X" : " "}] $item] $markType + } + + # + # Создание списка дел (задач) в формате VimWiki + # + # todo Item {1 2 3} => {{* [ ] 1} {* [ ] 2} {* [ ] 3}} + # todo Item {1 2 3} enum => {{# [ ] 1} {# [ ] 2} {# [ ] 3}} + # todo Item {1 2 3} dot done => {{* [X] 1} {* [X] 2} {* [X] 3}} + # todo {1 2 3} enum done => {{# [X] 1} {# [X] 2} {# [X] 3}} + # + proc todo {items {markType {dot}} {status {}}} { + struct::list mapfor item $items {todoItem $item $markType $status} + } + + # Проверка на метку + interp alias {} tags? {} regexp {^\s*\*\[(.+)\]\*\s*$} + + # Проверка на временной штамп + interp alias {} timestamp? {} regexp {^\s*=\s+(.+)\s+=.*$} + + # Проверка на элемент TODO: TODO/DONE/BOOKS + interp alias {} todo? {} regexp {^\s*[*#] \[[ X]\] (TODO|DONE|BOOKS):\s*([\w, ]+):\s*(.+)$} + + # Горизонтальная линия + proc hline {{full {}}} { + return "\n[string repeat - [expr {$full eq {} ? 5 : 80}]]\n" + } + + # + # Выравнивание строки текста по левому краю, по правому краю или + # по центру по заданной ширине + # + # align "строка" 10 => " строка " + # align "строка" 10 right => " строка " + # align "строка" 10 center => " строка " + # align "строка" 10 center {-} => "--строка--" + # + proc align {string width {justify {left}} {symbol { }}} { + set needSpaces [expr {$width - [string length $string]}] + + switch $justify { + left { return "$symbol$string[string repeat $symbol $needSpaces]" } + right { return "[string repeat $symbol $needSpaces]$string$symbol" } + center { + if {[base::odd? $needSpaces]} { + set count [expr {($needSpaces - 1) / 2}] + return "$symbol[setSurroundToString [string repeat $symbol $count] $string]" + } + + set count [expr {$needSpaces / 2}] + return "[setSurroundToString [string repeat $symbol $count] $string]" + } + } + } + + # Строка таблицы + proc tableRow {rowList columns width} { + set row {} + + for {set c [llength $rowList]; set n 0} {$c > 0} {incr c -${columns}} { + for {set i 0} {$i < $columns} {incr i; incr n} { + append row "|[align [lindex $rowList $n] $width left]" + } + append row "|\n" + } + return $row + } + + # Разделитель таблицы + proc tableDelim {columns width} { + set delim {|} + for {} {$columns > 0} {incr columns -1} { + append delim "[align {} $width center {-}]-+" + } + string replace $delim end end "|\n" + } + + # Таблица + proc table {tableTitle tableList columns} { + set width [expr {2 + [list::getMaxLength [concat $tableList $tableTitle]]}] + + set table {} + + if {$tableTitle ne {}} { + append table [tableRow $tableTitle $columns $width] + append table [tableDelim $columns $width] + } + + append table [tableRow $tableList $columns $width] + + return $table + } + + # Оглавление + proc toc {{title {}}} { + return "%toc $title" + } + + # Заголовок страницы (элемент [...]) + proc title {{title {}}} { + return "%title $title" + } + + # Создание страницы + proc page {args} { + if {[llength $args] % 2 == 0} { + error "vimwiki::page data" + } + + set content "" + foreach {element text} [lrange $args 0 end-1] { + if {[info procs $element] ne ""} { + append content [$element $text] "\n" + } else { + error "unknown vimwiki tag: $element" + } + } + append content "\n" [lindex $args end] + } + + # Метка, запрещающая экспортировать страницу в формат HTML + proc nohtml {args} { + return "%nohtml" + } + + # Экспорт в HTML-формат + proc 2HTML {wiki} { + exec vim -c VimwikiAll2HTML -c q $wiki 2> /dev/null + } +} + +# +# Процедуры для работы со списками +# +namespace eval list { + # Получение первого элемента списка + proc head {list} { + lindex $list 0 + } + + # Список без первого элемента + proc tail {list} { + lrange $list 1 end + } + + # + # Группировка подряд идущих одинаковых элементов списка + # + # group {1 2 2 3 3 3 4 4 4 4} => {1 {2 2} {3 3 3} {4 4 4 4}} + # + proc group {list} { + set groupedList {} + set lastItem [head $list] + set sublist [list $lastItem] + + foreach item [tail $list] { + if {$item eq $lastItem} { + lappend sublist $lastItem + } else { + lappend groupedList $sublist + + set lastItem $item + set sublist [list $item] + } + } + lappend groupedList $sublist + } + + # + # Подсчет количества уникальных элементов списка. + # + # countUniqueElements {a {b b} {c c c}} => {{a 1} {b 2} {c 3}} + # + proc countUniqueElements {list} { + struct::list mapfor l $list { + list [list::head $l] [llength $l] + } + } + + # Максимальная длина элемента списка + proc getMaxLength {list} { + string length [lindex [lsort -command base::cmpLength $list] 0] + } + + # + # Сортировка двумерного списка по ключу в порядке убывания. + # + # Сортировка осуществляется с помощью сравнений целых чисел. + # + # По умолчанию значение индекса равно 1 (сортировка по второму + # элементу списка - используется для пар {ключ значение}) + # + # + # sortDownByKey {{c 40} {a 3} {b 100}} => {{b 100} {c 40} {a 3}} + # sortDownByKey {{c 40} {a 3} {b 100}} 0 => {{c 40} {b 100} {a 3}} + # + proc sortDownByKey {list {key 1}} { + lsort -integer -decreasing -index $key $list + } + + # Список слов без пунктуации и служебных слов (см. realWord?) + proc wordList {string} { + base::filterMap string::realWord? string::removePunctuation [split $string] + } +} + +# +# Процедуры работы со словарями +# +namespace eval dict { + # Переименование ключа + proc renameKey {dict old new} { + upvar 1 $dict D + if {[dict exists $D $old]} { + dict set D $new [dict get $D $old] + dict unset D $old + } + } +} + +# +# Процедуры для работы со строками +# +namespace eval string { + # + # Проверка на "настоящую" строку, полезную для дальнейшего + # анализа. + # + # Настоящей строкой является непробельная строка. + # + # Пробельные строки: + # - содержащие только символы-разделители (пробел, табуляция...) + # - разметка блоков кода ({{{ | }}}) + # - горизонтальные линии (-----) + # - числа и знаки препинания + # + # realString? "строка текста" => 1 + # realString? " \t" => 0 + # realString? "100" => 0 + # + proc realString? {string} { + base::not [base::any [regexp {^\s*$} $string] \ + [regexp {\{\{\{|\}\}\}} $string] \ + [regexp {^-+$} $string] \ + [regexp {^\d+$} $string]] + } + + # Проверка на "настоящее", т.е. не служебное слово + proc realWord? {word} { + expr {[lsearch { + {} что я не как бы за под из раз это эта этот эти этими теми те та то и с в на мне меня все так по но + у уже еще так | о а же для себя себе чтобы + } [string tolower $word]] < 0} + } + + # + # Разделение меток на отдельные элементы. Первый символ + # каждого элемента переводится в верхний регистр, остальные - в нижний + # + # splitTags "tag1,tag2,tag3" => {tag1 tag2 tag3} + # + proc splitTags {tags} { + struct::list mapfor tag [split $tags ","] { + string totitle [string trim $tag] + } + } + + # Удаление знаков пунктуации + proc removePunctuation {string} { + regsub -all -- {\{|\}|\[|\]|\(|\)|\*|,|\.|:|\"|\'|`|\?|!|_|~|\\} $string {} newString + regsub -all -- {^\d+$} $newString {} newString + regsub -all -- {-$} $newString {} newString + regsub -all -- {^-} $newString {} newString + return [string trim $newString] + } + + # Транслитерация + set i18n_en { + \u0427 !C \u0428 !S \u0429 !T \u042A Q \u042C H \u042D !E \u042E !U + \u042F !A \u0401 !O \u0410 A \u0411 B \u0412 V \u0413 G \u0414 D + \u0415 E \u0416 !Z \u0417 Z \u0418 I \u0419 J \u041A K \u041B L + \u041C M \u041D N \u041E O \u041F P \u0420 R \u0421 S \u0422 T + \u0423 U \u0424 F \u0425 X \u0426 C \u042B Y \u0447 !c \u0448 !s + \u0449 !t \u044A q \u044C h \u044D !e \u044E !u \u044F !a \u0451 !o + \u0430 a \u0431 b \u0432 v \u0433 g \u0434 d \u0435 e \u0436 !z + \u0437 z \u0438 i \u0439 j \u043A k \u043B l \u043C m \u043D n + \u043E o \u043F p \u0440 r \u0441 s \u0442 t \u0443 u \u0444 f + \u0445 x \u0446 c \u044B y + } + + foreach {cyr lat} $string::i18n_en { lappend i18n_ru $lat $cyr } + + proc rus->lat {string} { + return [string map $string::i18n_en $string] + } + + proc lat->rus {string} { + return [string map $string::i18n_ru $string] + } + + # + # Функция создания встроенного документа, как cat < + # + # {2010(11) {12 14} 2011(01) 01} + # + proc create {filenames} { + set CALENDAR [dict create] + foreach file $filenames { + splitDate [file rootname [file tail $file]] -> year month day + dict lappend CALENDAR ${year}($month) $day + } + return $CALENDAR + } + + # + # Процедуры для работы с датами + # + namespace eval date { + # Изменение формата даты + proc format {date type {scanFormat {%Y-%m-%d}}} { + switch $type { + shortDay {set outputFormat %a} + fullDay {set outputFormat %A} + shortMonth {set outputFormat %b} + fullMonth {set outputFormat %B} + numDay {set outputFormat %u} + default {set outputFormat $scanFormat} + } + + # clock format [clock scan $date -format $scanFormat] -format $outputFormat -locale $::env(LC_NAME) + clock format [clock scan $date -format $scanFormat] -format $outputFormat -locale ru_RU + } + + # Текущая дата + proc current {{format {%Y-%m-%d [%H:%M:%S]}}} { + clock format [clock scan now] -format $format + } + + # Разделение даты в формате YYYY-MM-DD на составляющие + interp alias {} splitDate {} regexp -- {(\d{4})-(\d{2})(?:-(\d{2}))?} + } + + # + # Процедуры работы с месяцами + # + namespace eval month { + # + # Получение количества дней в указанном месяцу и годе. + # Учитывается високосный год. + # + proc days {month year} { + if {$month >= 12} { + incr year + set month 1 + } else { + set month [scan $month %d] + } + + clock format [clock scan "[incr month]/1/$year 1 day ago"] -format %d + } + + # Первый день месяца + proc firstDay {date} { + splitDate $date -> year month day + return "$year-$month-01" + } + + # Последний день месяца + proc lastDay {date} { + splitDate $date -> year month day + return "$year-$month-[calendar::month::days $month $year]" + } + } + + # + # Названия дней недели, соответствующие текущей локали. + # Строки возвращаются в верхнем регистре. + # + # localeWeek => {ПОНЕДЕЛЬНИК ВТОРНИК СРЕДА ЧЕТВЕРГ ПЯТНИЦА СУББОТА ВОСКРЕСЕНЬЕ} + # localeWeek short => {ПН ВТ СР ЧТ ПТ СБ ВС} + # + # TODO: Добавить определение первого дня недели в зависимости от локализации + # + proc localeWeek {{format full}} { + struct::list mapfor day {1 2 3 4 5 6 7} { + string toupper [date::format $day ${format}Day "%u"] + } + } + + # + # Формирование таблицы VimWiki, содержащей календарь за указанный + # год и месяц. Возможно указание списка дней, из которого будут + # сформированы ссылки на соответствующие страницы. + # + # Процедура правильно обрабатывает день начала месяца в соответствии + # с переданной датой. + # + # table 1988 2 => + # + # = Февраль 1988 = + # + # | ПН | ВТ | СР | ЧТ | ПТ | СБ | ВС | + # |-----+-----+-----+-----+-----+-----+-----| + # | 01 | 02 | 03 | 04 | 05 | 06 | 07 | + # | 08 | 09 | 10 | 11 | 12 | 13 | 14 | + # | 15 | 16 | 17 | 18 | 19 | 20 | 21 | + # | 22 | 23 | 24 | 25 | 26 | 27 | 28 | + # | 29 | | | | | | | + # + # table 2010 12 {6 13} => + # + # = Декабрь 2010 = + # + # | ПН | ВТ | СР | ЧТ | ПТ | СБ | ВС | + # |---------------------+----+----+----+----+----+----| + # | | | 1 | 2 | 3 | 4 | 5 | + # | [[2010-12-06][06]] | 7 | 8 | 9 | 10 | 11 | 12 | + # | [[2010-12-13][13]] | 14 | 15 | 16 | 17 | 18 | 19 | + # | 20 | 21 | 22 | 23 | 24 | 25 | 26 | + # | 27 | 28 | 29 | 30 | 31 | | | + # + proc table {year month {days {}}} { + # Заголовок календаря - текущий месяц и год + set table "\n[h1 "[string totitle \ + [date::format "${year}-${month}-01" fullMonth] \ + ] $year"]\n\n" + + set daysLinks [list::tail [lrepeat \ + [date::format "${year}-${month}-01" numDay] {}]] + + # Заполнение списка дат и ссылок на них + for {set day 1} {$day <= [month::days $month $year]} {incr day} { + set wikiDay [format "%02d" $day] + + # Формирование ссылки VimWiki при наличии дня в списке DAYS + if {[lsearch $days $wikiDay] >= 0} { + lappend daysLinks \ + [vimwiki::link \ + "${year}-${month}-${wikiDay}" \ + $wikiDay table] + } else { + lappend daysLinks $wikiDay + } + } + + append table [vimwiki::table [localeWeek short] $daysLinks 7] + } +} + +# +# Процедуры для работы с HTML-разметкой +# +namespace eval html { + # Ссылка на css + set vimwiki_css { + + } + + # + # Страница со списком наиболее часто используемых меток + # + namespace eval barchart { + # Шаблон страницы + set template(html) [string::<< { + + + + ${pageTitle} + + [subst ${html::vimwiki_css}] + [subst ${html::barchart::template(css)}] + + +

${pageTitle}

+
+ ${barchart(html)} +
+ + + } \t 2] + + # CSS + set template(css) [string::<< { + + } \t 2] + + # TODO: Ссылки: Метка -> Статистика по времени + proc make {pageTitle data} { + variable template + set barchart(css) "" + set barchart(html) "" + set maximumValue [lindex $data 0 1] + set index 0 + + foreach pair $data { + lassign $pair tag value + + set barWidth [expr {($value * 100 / $maximumValue) + 0.1}] + + append barchart(css) [format "\t\t#mk2 dd.p%s {width:%s%%;}\n" [incr index] $barWidth] + append barchart(html) [format "\t\t
%s) %s: %s
\n" $index $index $tag $value] + } + subst $template(html) + } + } + + # + # Облако меток + # + # + # [...] + # + # + proc makeTagsCloud {list} { + puts " + + + + + + " + foreach item [lsort -index 0 $list] { + lassign $item title count + set size [expr {$count + 15}] + + puts "$title" + } + puts "" + } + + # + # График изменения используемых меток + # + namespace eval timeplot { + variable index 0 + + array set generated { + html {} + css {} + css_vars {} + } + + array set graphColors { + 1 {\"#FFCCFF\" \"#FFCCFF\" \"#FFCCFF\"} + 2 {\"#3399FF\" \"#3399FF\" \"#3399FF\"} + } + + # + # JS: изменение масштаба + # + namespace eval function { + proc resize {} { + set timeplots "" + + for {set i 1} {$i <= $html::timeplot::index} {incr i} { + append timeplots "if (timeplot$i) timeplot${i}.repaint();\n" + } + + subst { + var resizeTimerID = null; + function onResize() { + if (resizeTimerID == null) { + resizeTimerID = window.setTimeout( + function() { + resizeTimerID = null; + ${timeplots} + }, 0); + } + }} + } + } + + # Шаблон страницы + set template { + + + Статистика по меткам + + ${html::vimwiki_css} + + + + + + + + + + + + + + $html::timeplot::generated(html) + + + } + + proc make {dataDirectory} { + foreach file [glob [file join $dataDirectory *_days.txt]] { + lappend files [list [fileutil::fullnormalize $file] [file size $file]] + } + + foreach file [list::sortDownByKey $files] { + lassign $file filename _size + + #TODO: Создавать один раз, а не для каждого файла + append html::timeplot::generated(css) [eventSource 1] "\n" + append html::timeplot::generated(css) [dataSource 1] "\n\n" + + append html::timeplot::generated(css) [eventSource 2] "\n" + append html::timeplot::generated(css) [dataSource 2] "\n\n" + + graph [readTag $filename] $filename + } + + append html::timeplot::generated(css) [html::timeplot::function::resize] + subst -nocommands $html::timeplot::template + } + + # Получение названия метки из строки в формате Vimwiki + proc readTag {filename} { + if {[catch {open $filename r} fileIN]} { + error $fileIN + } + set tag {} + regexp -- {^#TAG: (.*)$} [gets $fileIN] -> tag + + close $fileIN + return $tag + } + + # Построение графика + proc graph {args} { + variable index + incr index + + append html::timeplot::generated(css_vars) "var timeplot${index};\n" + + set files [list [lindex $args 0] [regsub {days} [lindex $args 1] {months}] {*}$args] + set plot [plotInfo $index {*}$files] + set create [create $index] + + set event 1 + + lappend labels [lindex $files 0] + foreach {title file} $files { + append html::timeplot::generated(css) [geometry $event] "\n" + append load [loadText $index $file $event] "\n" + incr event + } + append html::timeplot::generated(css) "\n\n" $plot + append html::timeplot::generated(css) "\n\n" $create + append html::timeplot::generated(css) "\n\n" $load + append html::timeplot::generated(html) [divBlock $index $labels 200px] + } + + # JS: создание графика + proc create {index} { + format "timeplot%s = Timeplot.create(document.getElementById(\"timeplot%s\"), plotInfo%s);" $index $index $index + } + + # JS: загрузка данных + proc loadText {index file event} { + format "timeplot%s.loadText(\"%s\", \" \", eventSource%s);" $index $file $event + } + + # DIV-контейнер для временной шкалы + proc divBlock {index labels {height 400px}} { + set block [format { +
+ } $index] + + foreach label $labels { + append block [span "color: #193441;" $label] + } + + append block [format { +
+
+ } $index $height] + } + + proc span {style text} { + format {

%s

} $style $text + } + + # JS: легенда временной шкалы + proc createPlotInfo {id dataSource valueGeometry {lineColor green} {fillColor #DEE5D1} {dotColor lightGreen}} { + format { + Timeplot.createPlotInfo({ + id: "%s%s", + dataSource: dataSource%s, + timeGeometry: timeGeometry, + valueGeometry: geometry%s, + lineColor: %s, + fillColor: %s, + dotColor: %s, + showValues: true + }),} $id $dataSource $dataSource $valueGeometry $lineColor $fillColor $dotColor + } + + proc eventSource {index} { + format {var eventSource%s = new Timeplot.DefaultEventSource();} $index + } + + proc dataSource {index} { + format {var dataSource%s = new Timeplot.ColumnSource(eventSource%s,1);} $index $index + } + + proc plotInfo {index args} { + set result [format {var plotInfo%s = [} $index] + + set id 1 + foreach {title file} $args { + append result [createPlotInfo $title $id $id {*}$html::timeplot::graphColors($id)] + incr id + } + + append result "\n\];" + } + + proc geometry {index} { + format { + var geometry%s = new Timeplot.DefaultValueGeometry({ + gridColor: gridColor, + axisLabelsPlacement: "left", + min: 0 + });} $index + } + } +} + +# +# Процедуры сбора и обработки статистических данных +# +namespace eval statistics { + # Сбор всей возможной статистики + proc getAllStatistics {directory {interface cli}} { + array set BOOKS {} + set TIMESTAMPS {} + set TAGS {} + set WORDS {} + array set TT {} + + set files [lsort [fs::findWikiFiles $directory]] + set result {} + + foreach file $files { + foreach string [struct::list filter [fs::readFile $file] string::realString?] { + if {[todo? $string -> status categories todo]} { + foreach category [split $categories ,] { + set wikiPageName [file tail [file rootname $file]] + dict lappend [set status]($category) [string range $wikiPageName 0 3] [list $wikiPageName $todo] + # dict lappend [set status] $category [list [file tail [file rootname $file]] $todo] + } + } elseif {[tags? $string -> tags]} { + lappend TAGS {*}[string::splitTags $tags] + lappend TT([file rootname [file tail $file]]) {*}[string::splitTags $tags] + } elseif {[timestamp? $string -> time]} { + lappend TIMESTAMPS $time + } else { + lappend WORDS {*}[list::wordList $string] + } + } + } + + # fs::saveToFile statistic_words_html [html::barchart::make [getStatisticsByWords $WORDS]] html + if {($interface eq "html") || ($interface eq "all")} { + tagsDayByDay TT $TAGS + + fs::saveToFile timeline_html \ + [html::timeplot::make $options::vimWikiDiaryStatistics] html + + fs::saveToFile timeline_wiki [vimwiki::page nohtml -- \ + "Данная статистика доступна только в HTML"] wiki + + fs::saveToFile statistic_tags_wiki [vimwiki::page \ + toc "Статистика" \ + title "Статистика" nohtml -- \ + commentary "Файл создан автоматически [calendar::date::current]" \ + [dumpWordStatistics [list2chart [getStatisticsByWords $TAGS]]]] + + fs::saveToFile statistic_tags_html \ + [html::barchart::make "Статистика по меткам" \ + [getStatisticsByWords $TAGS]] html + + fs::saveToFile calendar [vimwiki::page \ + toc "Календарь" \ + title "Календарь" \ + commentary "Файл создан автоматически [calendar::date::current]" \ + [dumpCalendar [calendar::create $files]]] + + fs::saveToFile BOOKS [vimwiki::page \ + title "Прочитано" \ + commentary "Файл создан автоматически [calendar::date::current]" \ + [dumpTODO BOOKS done]] + + # BUGS: Не работает, если есть открытые файлы vimwiki + vimwiki::2HTML $options::file(INDEX) + } + + # TODO: Переписать: string match + # TODO: Два раза анализируются данные. Сохранять вывод в переменную + if {($interface eq "cli") || ($interface eq "all")} { + puts [dumpCalendar [calendar::create $files]] + puts [dumpWordStatistics [list2chart [getStatisticsByWords $TAGS]]] + puts [dumpTODO BOOKS done] + # puts [dumpWordStatistics [list2chart [getStatisticsByWords $WORDS]]] + } + } + + # Метки по дням + proc tagsDayByDay {tags allTags} { + upvar 1 $tags TT + + array set TF {} + foreach date [lsort [array names TT]] { + regexp -- {((\d{4})-(\d{2}))-(\d{2})} $date -> yymm year month day + # set TD($yymm) [dict create] + + foreach pair [getStatisticsByWords $TT($date)] { + lassign $pair tag value + append TF($tag) [list $date $value] "\n" + + #Общее число записей по месяцам + dict incr TD($tag) $yymm $value + } + } + # !!! Удаление файлов с данными + file delete -force $options::vimWikiDiaryStatistics + + tagsByMonths $allTags [lsort [array names TT]] TD + + foreach file [array names TF] { + fileutil::writeFile [file join \ + $options::vimWikiDiaryStatistics \ + [string::rus->lat ${file}_days.txt]] \ + "#TAG: $file\n$TF($file)" + } + } + + # Метки по месяцам + proc tagsByMonths {allTags allDays array} { + # TODO: Переименовать переменные + upvar 1 $array TD + set timelineMonths [months $allDays] + + set firstDiaryDay [lindex $allDays 0] + set firstDiaryMonth [calendar::month::firstDay $firstDiaryDay] + + set lastDiaryDay [lindex $allDays end] + set lastDiaryMonth [calendar::month::lastDay $lastDiaryDay] + + foreach tag $allTags { + foreach dd $timelineMonths { + splitDate $dd -> year month day + + if {[set index [lsearch $TD($tag) $dd]] >= 0} { + set records [lindex $TD($tag) $index+1] + } else { + set records 0 + } + + dict set TDD($tag) $dd-01 $records + dict set TDD($tag) $dd-[calendar::month::days $month $year] $records + } + dict::renameKey TDD($tag) $firstDiaryMonth $firstDiaryDay + dict::renameKey TDD($tag) $lastDiaryMonth $lastDiaryDay + } + + foreach file [array names TDD] { + set r "#TAG: $file\n" + set f [file join $options::vimWikiDiaryStatistics [string::rus->lat ${file}_months.txt]] + foreach {date value} $TDD($file) { + append r "$date $value\n" + } + fileutil::writeFile $f $r + } + } + + # Удаление дней из дат + proc months {list} { + lsort -unique [struct::list mapfor date $list {string range $date 0 6}] + } + + # Индексная страница в виде календаря со ссылками на дни + proc dumpCalendar {calendar {reverse on}} { + # TODO: Переписать с помощью struct::stack, struct::queue для + # восходящего/нисходящего порядка календаря + set calendarString {} + + dict for {date days} $calendar { + regexp {^(\d{4})\((\d{2})\)$} $date -> year month + lappend calendarString [calendar::table $year $month $days] + } + + if {$reverse ne "off"} { + set calendarString [lreverse $calendarString] + } + + return [join $calendarString] + } + + # Список TODO + proc dumpTODO {wikiTodo {type {todo}}} { + set todoString "" + upvar $wikiTodo wikiTodoArray + + append todoString "[h1 [expr {$type eq {todo} ? {Задачи} : {Прочитано}}]]\n" + foreach wikiTodoCategory [lsort [array names wikiTodoArray]] { + append todoString "\t[h1 $wikiTodoCategory]\n" + foreach key [lsort [dict keys [set wikiTodoArray($wikiTodoCategory)]]] { + append todoString "[h1 $key]\n" + # append todoString "\n[vimwiki::todoItem $key dot $type]\n" + foreach todo [struct::list mapfor item [dict get [set wikiTodoArray($wikiTodoCategory)] $key] { + lassign $item file str + vimwiki::todoItem [vimwiki::link [file join $options::vimWikiDiaryHtmlDirectory $file] "<$file>: $str"] enum $type + }] { + append todoString "\t\t$todo\n" + } + append todoString "\n" + } + } + return $todoString + } + + # Статистика по используемым словам + proc dumpWordStatistics {l} { + set index 0 + set statistics {} + + foreach line $l { + append statistics [format "\t%4s. %s" [incr index] $line] "\n" + } + + return $statistics + } + + proc getStatisticsByWords {itemList} { + list::sortDownByKey [list::countUniqueElements [list::group [lsort $itemList]]] + } + + proc makeBar {item count {char {=}}} { + format "%-30s%3s: %s>" $item $count [string repeat $char [expr {$count / 2}]] + } + + proc list2chart {list} { + struct::list mapfor pair $list { makeBar {*}$pair } + } +} + +# ------------------------------------------------------------------------------ + +statistics::getAllStatistics $options::vimWikiDiaryWikiDirectory $::argv +