# HG changeset patch # User Goffi # Date 1293533598 -3600 # Node ID 1aeb3540aa49df950c0251cb5152e07f13eb8fad # Parent 5d0e497f73a207e91b88b62be5d5bf7dbd8c38d9 files reorganisation after project separation. new README, and COPYING files diff -r 5d0e497f73a2 -r 1aeb3540aa49 COPYING --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/COPYING Tue Dec 28 11:53:18 2010 +0100 @@ -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 -r 5d0e497f73a2 -r 1aeb3540aa49 COPYING.LESSER --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/COPYING.LESSER Tue Dec 28 11:53:18 2010 +0100 @@ -0,0 +1,165 @@ + GNU LESSER 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. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff -r 5d0e497f73a2 -r 1aeb3540aa49 README --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README Tue Dec 28 11:53:18 2010 +0100 @@ -0,0 +1,58 @@ +urwid-satext v0.1.0 +(c) Jérôme Poisson aka Goffi 2008, 2009, 2010 + +urwid-satext, or urwid SàT extensions, is a widgets library based on Urwid + + + +** LICENSE ** + +urwid-satext is free software: you can redistribute it and/or modify +it under the terms of the GNU Lesser General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +urwid-satext 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 Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public License +along with urwid-satext. If not, see . + + + + +** WTF ? ** +urwid-satext is a widgets based on top of the excellent Urwid (http://excess.org/urwid/) console user interface library. +It was originally made for the "Salut à Toi" project, an XMPP/Jabber multi-frontend client, but was eventually separated to be used by other urwid projects. + + +** Installation ** + +just type as root: +$ python setup.py install + +** What are the widgets provided ? ** + + +** How to use it ? ** + +You can see the documentation on http://wiki.goffi.org/wiki/urwid-satext . + +** Credit ** + +A big big thank to the authors/contributors of Urwid (http://excess.org/urwid/), of course. +Nothing would be possible without Python (http://www.python.org/), Gnu and the Free Software Foundation (http://www.gnu.org, http://www.fsf.org/), the Linux Kernel (http://www.kernel.org/), and the coder of the tools I use like Vim (http://www.vim.org/), Mercurial (http://www.selenic.com/mercurial/wiki/), or all the KDE stuff (http://www.kde.org/ and of course http://amarok.kde.org/), and also XFCE (http://www.xfce.org), etc. Thanks thanks thanks, thank to everybody in the Free (Libre) chain for making a part of the dream. + +If I forgot any credit (and I probably have), please contact me (mail below) to fix it. + + + + + +** Contact ** + +You can contact me on goffi@goffi.org +my blog (in french) is at http://www.goffi.org +urwid-satext wiki page is at http://wiki.goffi.org/wiki/urwid-satext , you will find there link to the latests release, the repository, etc. diff -r 5d0e497f73a2 -r 1aeb3540aa49 frontends/primitivus/custom_widgets.py --- a/frontends/primitivus/custom_widgets.py Tue Dec 28 09:37:08 2010 +0000 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,1020 +0,0 @@ -#!/usr/bin/python -# -*- coding: utf-8 -*- - -""" -Primitivus: a SAT frontend -Copyright (C) 2009, 2010 Jérôme Poisson (goffi@goffi.org) - -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 . -""" - -import urwid -from urwid.escape import utf8decode -from logging import debug, info, warning, error - -class Password(urwid.Edit): - """Edit box which doesn't show what is entered (show '*' or other char instead)""" - - def __init__(self, *args, **kwargs): - """Same args than Edit.__init__ with an additional keyword arg 'hidden_char' - @param hidden_char: char to show instead of what is actually entered: default '*' - """ - self.hidden_char=kwargs['hidden_char'] if kwargs.has_key('hidden_char') else '*' - self.__real_text='' - super(Password, self).__init__(*args, **kwargs) - - def set_edit_text(self, text): - self.__real_text = text - hidden_txt = len(text)*'*' - super(Password, self).set_edit_text(hidden_txt) - - def get_edit_text(self): - return self.__real_text - - def insert_text(self, text): - self._edit_text = self.__real_text - super(Password,self).insert_text(text) - - def render(self, size, focus=False): - return super(Password, self).render(size, focus) - -class AdvancedEdit(urwid.Edit): - """Edit box with some custom improvments - new chars: - - C-a: like 'home' - - C-e: like 'end' - - C-k: remove everything on the right of the cursor - - C-w: remove the word on the back - new behaviour: emit a 'click' signal when enter is pressed""" - signals = urwid.Edit.signals + ['click'] - - def setCompletionMethod(self, callback): - """Define method called when completion is asked - @callback: method with 2 arguments: - - the text to complete - - if there was already a completion, a dict with - - 'completed':last completion - - 'completion_pos': cursor position where the completion starts - - 'position': last completion cursor position - this dict must be used (and can be filled) to find next completion) - and which return the full text completed""" - self.completion_cb = callback - self.completion_data = {} - - def keypress(self, size, key): - #TODO: insert mode is not managed yet - if key == 'ctrl a': - key = 'home' - elif key == 'ctrl e': - key = 'end' - elif key == 'ctrl k': - self._delete_highlighted() - self.set_edit_text(self.edit_text[:self.edit_pos]) - elif key == 'ctrl w': - before = self.edit_text[:self.edit_pos] - pos = before.rstrip().rfind(" ")+1 - self.set_edit_text(before[:pos] + self.edit_text[self.edit_pos:]) - self.set_edit_pos(pos) - elif key == 'enter': - self._emit('click') - elif key == 'shift tab': - try: - before = self.edit_text[:self.edit_pos] - if self.completion_data: - if (not self.completion_data['completed'] - or self.completion_data['position'] != self.edit_pos - or not before.endswith(self.completion_data['completed'])): - self.completion_data.clear() - else: - before = before[:-len(self.completion_data['completed'])] - complet = self.completion_cb(before, self.completion_data) - self.completion_data['completed'] = complet[len(before):] - self.set_edit_text(complet+self.edit_text[self.edit_pos:]) - self.set_edit_pos(len(complet)) - self.completion_data['position'] = self.edit_pos - return - except AttributeError: - #No completion method defined - pass - return super(AdvancedEdit, self).keypress(size, key) - - -class SurroundedText(urwid.FlowWidget): - """Text centered on a repeated character (like a Divider, but with a text in the center)""" - - def __init__(self,text,car=utf8decode('─')): - self.text=text - self.car=car - - def rows(self,size,focus=False): - return self.display_widget(size, focus).rows(size, focus) - - def render(self, size, focus=False): - return self.display_widget(size, focus).render(size, focus) - - def display_widget(self, size, focus): - (maxcol,) = size - middle = (maxcol-len(self.text))/2 - render_text = middle * self.car + self.text + (maxcol - len(self.text) - middle) * self.car - return urwid.Text(render_text) - -class SelectableText(urwid.WidgetWrap): - """Text which can be selected with space""" - signals = ['change'] - - def __init__(self, text, align='left', header='', focus_attr='default_focus', selected_text=None, selected=False, data=None): - """@param text: same as urwid.Text's text parameter - @param align: same as urwid.Text's align parameter - @select_attr: attrbute to use when selected - @param selected: is the text selected ?""" - self.focus_attr = focus_attr - self.__selected = False - self.__was_focused = False - self.header = self.__valid_text(header) - self.default_txt = self.__valid_text(text) - urwid.WidgetWrap.__init__(self, urwid.Text("",align=align)) - self.setSelectedText(selected_text) - self.setState(selected) - - def __valid_text(self, text): - """Tmp method needed until dbus and urwid are more friends""" - if isinstance(text,basestring): - return unicode(text) - elif isinstance(text,tuple): - return (unicode(text[0]),text[1]) - elif isinstance(text,list): - for idx in range(len(text)): - elem = text[idx] - if isinstance(elem,basestring): - text[idx] = unicode(elem) - if isinstance(elem,tuple): - text[idx] = (unicode(elem[0]),elem[1]) - else: - warning (_('WARNING: unknown text type')) - return text - - def getValue(self): - if isinstance(self.default_txt,basestring): - return self.default_txt - list_attr = self.default_txt if isinstance(self.default_txt, list) else [self.default_txt] - txt = "" - for attr in list_attr: - if isinstance(attr,tuple): - txt+=attr[1] - else: - txt+=attr - return txt - - def get_text(self): - """for compatibility with urwid.Text""" - return self.getValue() - - def set_text(self, text): - """/!\ set_text doesn't change self.selected_txt !""" - self.default_txt = self.__valid_text(text) - self.setState(self.__selected,invisible=True) - - def setSelectedText(self, text=None): - """Text to display when selected - @text: text as in urwid.Text or None for default value""" - if text == None: - text = ('selected',self.getValue()) - self.selected_txt = self.__valid_text(text) - if self.__selected: - self.setState(self.__selected) - - - def __set_txt(self): - txt_list = [self.header] - txt = self.selected_txt if self.__selected else self.default_txt - if isinstance(txt,list): - txt_list.extend(txt) - else: - txt_list.append(txt) - self._w.base_widget.set_text(txt_list) - - - def setState(self, selected, invisible=False): - """Change state - @param selected: boolean state value - @param invisible: don't emit change signal if True""" - assert(type(selected)==bool) - self.__selected=selected - self.__set_txt() - self.__was_focused = False - self._invalidate() - if not invisible: - self._emit("change", self.__selected) - - def getState(self): - return self.__selected - - def selectable(self): - return True - - def keypress(self, size, key): - if key==' ' or key=='enter': - self.setState(not self.__selected) - else: - return key - - def mouse_event(self, size, event, button, x, y, focus): - if urwid.is_mouse_press(event) and button == 1: - self.setState(not self.__selected) - return True - - return False - - def render(self, size, focus=False): - attr_list = self._w.base_widget._attrib - if not focus: - if self.__was_focused: - self.__set_txt() - self.__was_focused = False - else: - if not self.__was_focused: - if not attr_list: - attr_list.append((self.focus_attr,len(self._w.base_widget.text))) - else: - for idx in range(len(attr_list)): - attr,attr_len = attr_list[idx] - if attr == None: - attr = self.focus_attr - attr_list[idx] = (attr,attr_len) - else: - if not attr.endswith('_focus'): - attr+="_focus" - attr_list[idx] = (attr,attr_len) - self._w.base_widget._invalidate() - self.__was_focused = True #bloody ugly hack :) - return self._w.render(size, focus) - -class ClickableText(SelectableText): - signals = SelectableText.signals + ['click'] - - def setState(self, selected, invisible=False): - super(ClickableText,self).setState(False,True) - if not invisible: - self._emit('click') - -class CustomButton(ClickableText): - - def __init__(self, label, on_press=None, user_data=None, left_border = "[ ", right_border = " ]"): - self.label = label - self.left_border = left_border - self.right_border = right_border - super(CustomButton, self).__init__([left_border, label, right_border]) - self.size = len(self.get_text()) - if on_press: - urwid.connect_signal(self, 'click', on_press, user_data) - - def getSize(self): - """Return representation size of the button""" - return self.size - - def get_label(self): - return self.label[1] if isinstance(self.label,tuple) else self.label - - def set_label(self, label): - self.label = label - self.set_text([self.left_border, label, self.right_border]) - -class GenericList(urwid.WidgetWrap): - signals = ['click','change'] - - def __init__(self, options, style=[], align='left', option_type = SelectableText, on_click=None, on_change=None, user_data=None): - """ - Widget managing list of string and their selection - @param options: list of strings used for options - @param style: list of string: - - 'single' if only one must be selected - - 'no_first_select' nothing selected when list is first displayed - - 'can_select_none' if we can select nothing - @param align: alignement of text inside the list - @param on_click: method called when click signal is emited - @param user_data: data sent to the callback for click signal - """ - self.single = 'single' in style - self.no_first_select = 'no_first_select' in style - self.can_select_none = 'can_select_none' in style - self.align = align - self.option_type = option_type - self.first_display = True - - if on_click: - urwid.connect_signal(self, 'click', on_click, user_data) - - if on_change: - urwid.connect_signal(self, 'change', on_change, user_data) - - self.content = urwid.SimpleListWalker([]) - self.list_box = urwid.ListBox(self.content) - urwid.WidgetWrap.__init__(self, self.list_box) - self.changeValues(options) - - def __onStateChange(self, widget, selected): - if self.single: - if not selected and not self.can_select_none: - #if in single mode, it's forbidden to unselect a value - widget.setState(True, invisible=True) - return - if selected: - self.unselectAll(invisible=True) - widget.setState(True, invisible=True) - self._emit("click") - - - def unselectAll(self, invisible=False): - for widget in self.content: - if widget.getState(): - widget.setState(False, invisible) - widget._invalidate() - - def deleteValue(self, value): - """Delete the first value equal to the param given""" - for widget in self.content: - if widget.getValue() == value: - self.content.remove(widget) - self._emit('change') - return - raise ValueError("%s ==> %s" % (str(value),str(self.content))) - - def getSelectedValue(self): - """Convenience method to get the value selected as a string in single mode, or None""" - values = self.getSelectedValues() - return values[0] if values else None - - def getAllValues(self): - """Return values of all items""" - return [widget.getValue() for widget in self.content] - - def getSelectedValues(self): - """Return values of selected items""" - result = [] - for widget in self.content: - if widget.getState(): - result.append(widget.getValue()) - return result - - def getDisplayWidget(self): - return self.list_box - - def changeValues(self, new_values): - """Change all value in one shot""" - if not self.first_display: - old_selected = self.getSelectedValues() - widgets = [] - for option in new_values: - widget = self.option_type(option, self.align) - if not self.first_display and option in old_selected: - widget.setState(True) - widgets.append(widget) - try: - urwid.connect_signal(widget, 'change', self.__onStateChange) - except NameError: - pass #the widget given doesn't support 'change' signal - self.content[:] = widgets - if self.first_display and self.single and new_values and not self.no_first_select: - self.content[0].setState(True) - display_widget = self.getDisplayWidget() - self._set_w(display_widget) - self._emit('change') - self.first_display = False - - def selectValue(self, value): - """Select the first item which has the given value""" - self.unselectAll() - idx = 0 - for widget in self.content: - if widget.getValue() == value: - widget.setState(True) - self.list_box.set_focus(idx) - return - idx+=1 - -class List(urwid.FlowWidget): - """FlowWidget list, same arguments as GenericList, with an additional one 'max_height'""" - signals = ['click','change'] - - def __init__(self, options, style=[], max_height=5, align='left', option_type = SelectableText, on_click=None, on_change=None, user_data=None): - self.genericList = GenericList(options, style, align, option_type, on_click, on_change, user_data) - self.max_height = max_height - - def selectable(self): - return True - - def keypress(self, size, key): - return self.displayWidget(size,True).keypress(size, key) - - def unselectAll(self, invisible=False): - return self.genericList.unselectAll(invisible) - - def deleteValue(self, value): - return self.genericList.deleteValue(value) - - def getSelectedValue(self): - return self.genericList.getSelectedValue() - - def getAllValues(self): - return self.genericList.getAllValues() - - def getSelectedValues(self): - return self.genericList.getSelectedValues() - - def changeValues(self, new_values): - return self.genericList.changeValues(new_values) - - def selectValue(self, value): - return self.genericList.selectValue(value) - - def render(self, size, focus=False): - return self.displayWidget(size, focus).render(size, focus) - - def rows(self, size, focus=False): - return self.displayWidget(size, focus).rows(size, focus) - - def displayWidget(self, size, focus): - list_size = sum([wid.rows(size, focus) for wid in self.genericList.content]) - height = min(list_size,self.max_height) or 1 - return urwid.BoxAdapter(self.genericList, height) - -## MISC ## - -class NotificationBar(urwid.WidgetWrap): - """Bar used to show misc information to user""" - signals = ['change'] - - def __init__(self): - self.waitNotifs = urwid.Text('') - self.message = ClickableText('') - urwid.connect_signal(self.message, 'click', lambda wid: self.showNext()) - self.progress = ClickableText('') - self.columns = urwid.Columns([('fixed',6,self.waitNotifs),self.message,('fixed',4,self.progress)]) - urwid.WidgetWrap.__init__(self, urwid.AttrMap(self.columns,'notifs')) - self.notifs = [] - - def __modQueue(self): - """must be called each time the notifications queue is changed""" - self.waitNotifs.set_text(('notifs',"(%i)" % len(self.notifs) if self.notifs else '')) - self._emit('change') - - def setProgress(self,percentage): - """Define the progression to show on the right side of the bar""" - if percentage == None: - self.progress.set_text('') - else: - self.progress.set_text(('notifs','%02i%%' % percentage)) - self._emit('change') - - def addPopUp(self, pop_up_widget): - """Add a popup to the waiting queue""" - self.notifs.append(('popup',pop_up_widget)) - self.__modQueue() - - def addMessage(self, message): - "Add a message to the notificatio bar" - if not self.message.get_text(): - self.message.set_text(('notifs',message)) - self._invalidate() - self._emit('change') - else: - self.notifs.append(('message',message)) - self.__modQueue() - - def showNext(self): - """Show next message if any, else delete current message""" - found = None - for notif in self.notifs: - if notif[0] == "message": - found = notif - break - if found: - self.notifs.remove(found) - self.message.set_text(('notifs',found[1])) - self.__modQueue() - else: - self.message.set_text('') - self._emit('change') - - def getNextPopup(self): - """Return next pop-up and remove it from the queue - @return: pop-up or None if there is no more in the queue""" - ret = None - for notif in self.notifs: - if notif[0] == 'popup': - ret = notif[1] - break - if ret: - self.notifs.remove(notif) - self.__modQueue() - return ret - - def isQueueEmpty(self): - return not bool(self.notifs) - - def canHide(self): - """Return True if there is now important information to show""" - return self.isQueueEmpty() and not self.message.get_text() and not self.progress.get_text() - - -class MenuBox(urwid.WidgetWrap): - """Show menu items of a category in a box""" - signals = ['click'] - - def __init__(self,parent,items): - self.parent = parent - self.selected = None - content = urwid.SimpleListWalker([ClickableText(('menuitem',text)) for text in items]) - for wid in content: - urwid.connect_signal(wid, 'click', self.onClick) - - self.listBox = urwid.ListBox(content) - menubox = urwid.LineBox(urwid.BoxAdapter(self.listBox,len(items))) - urwid.WidgetWrap.__init__(self,menubox) - - def getValue(self): - return self.selected - - def keypress(self, size, key): - if key=='up': - if self.listBox.get_focus()[1] == 0: - self.parent.keypress(size, key) - elif key=='left' or key=='right': - self.parent.keypress(size,'up') - self.parent.keypress(size,key) - return super(MenuBox,self).keypress(size,key) - - def mouse_event(self, size, event, button, x, y, focus): - if button == 3: - self.parent.keypress(size,'up') - return True - return super(MenuBox,self).mouse_event(size, event, button, x, y, focus) - - def onClick(self, wid): - self.selected = wid.getValue() - self._emit('click') - -class Menu(urwid.WidgetWrap): - - def __init__(self,loop, x_orig=0): - """Menu widget - @param loop: main loop of urwid - @param x_orig: absolute start of the abscissa - """ - self.loop = loop - self.menu_keys = [] - self.menu = {} - self.x_orig = x_orig - self.shortcuts = {} #keyboard shortcuts - self.save_bottom = None - col_rol = ColumnsRoller() - urwid.WidgetWrap.__init__(self, urwid.AttrMap(col_rol,'menubar')) - - def selectable(self): - return True - - def getMenuSize(self): - """return the current number of categories in this menu""" - return len(self.menu_keys) - - def setOrigX(self, orig_x): - self.x_orig = orig_x - - def __buildOverlay(self,menu_key,columns): - """Build the overlay menu which show menuitems - @param menu_key: name of the category - @colums: column number where the menubox must be displayed""" - max_len = 0 - for item in self.menu[menu_key]: - if len(item[0]) > max_len: - max_len = len(item[0]) - - self.save_bottom = self.loop.widget - menu_box = MenuBox(self,[item[0] for item in self.menu[menu_key]]) - urwid.connect_signal(menu_box, 'click', self.onItemClick) - - self.loop.widget = urwid.Overlay(urwid.AttrMap(menu_box,'menubar'),self.save_bottom,('fixed left', columns),max_len+2,('fixed top',1),None) - - def keypress(self, size, key): - if key == 'down': - key = 'enter' - elif key == 'up': - if self.save_bottom: - self.loop.widget = self.save_bottom - self.save_bottom = None - - return self._w.base_widget.keypress(size, key) - - def checkShortcuts(self, key): - for shortcut in self.shortcuts.keys(): - if key == shortcut: - category, item, callback = self.shortcuts[shortcut] - callback((category, item)) - return key - - def addMenu(self, category, item, callback, shortcut=None): - """Add a menu item, create the category if new - @param category: category of the menu (e.g. File/Edit) - @param item: menu item (e.g. new/close/about) - @callback: method to call when item is selected""" - if not category in self.menu.keys(): - self.menu_keys.append(category) - self.menu[category] = [] - button = CustomButton(('menubar',category), self.onCategoryClick, - left_border = ('menubar',"[ "), - right_border = ('menubar'," ]")) - self._w.base_widget.addWidget(button,button.getSize()) - self.menu[category].append((item, callback)) - if shortcut: - assert(shortcut not in self.shortcuts.keys()) - self.shortcuts[shortcut] = (category, item, callback) - - def onItemClick(self, widget): - category = self._w.base_widget.getSelected().get_label() - item = widget.getValue() - callback = None - for menu_item in self.menu[category]: - if item == menu_item[0]: - callback = menu_item[1] - break - if callback: - self.keypress(None,'up') - callback((category, item)) - - def onCategoryClick(self, button): - self.__buildOverlay(button.get_label(), - self.x_orig + self._w.base_widget.getStartCol(button)) - - -class MenuRoller(urwid.WidgetWrap): - - def __init__(self,menus_list): - """Create a MenuRoller - @param menus_list: list of tuple with (name, Menu_instance), name can be None - """ - assert (menus_list) - self.selected = 0 - self.name_list = [] - self.menus = {} - - self.columns = urwid.Columns([urwid.Text(''),urwid.Text('')]) - urwid.WidgetWrap.__init__(self, self.columns) - - for menu_tuple in menus_list: - name,menu = menu_tuple - self.addMenu(name, menu) - - def __showSelected(self): - """show menu selected""" - name_txt = u'\u21c9 '+self.name_list[self.selected]+u' \u21c7 ' - current_name = ClickableText(name_txt) - name_len = len(name_txt) - current_menu = self.menus[self.name_list[self.selected]] - current_menu.setOrigX(name_len) - self.columns.widget_list[0] = current_name - self.columns.column_types[0]=('fixed', name_len) - self.columns.widget_list[1] = current_menu - - def keypress(self, size, key): - if key=='up': - if self.columns.get_focus_column()==0 and self.selected > 0: - self.selected -= 1 - self.__showSelected() - elif key=='down': - if self.columns.get_focus_column()==0 and self.selected < len(self.name_list)-1: - self.selected += 1 - self.__showSelected() - elif key=='right': - if self.columns.get_focus_column()==0 and \ - (isinstance(self.columns.widget_list[1], urwid.Text) or \ - self.menus[self.name_list[self.selected]].getMenuSize()==0): - return #if we have no menu or the menu is empty, we don't go the right column - - return super(MenuRoller, self).keypress(size, key) - - def addMenu(self, name_param, menu): - name = name_param or '' - if name not in self.name_list: - self.name_list.append(name) - self.menus[name] = menu - if self.name_list[self.selected] == name: - self.__showSelected() #if we are on the menu, we update it - - def removeMenu(self, name): - if name in self.name_list: - self.name_list.remove(name) - if name in self.menus.keys(): - del self.menus[name] - self.selected = 0 - self.__showSelected() - - def checkShortcuts(self, key): - for menu in self.name_list: - key = self.menus[menu].checkShortcuts(key) - return key - - -## DIALOGS ## - -class GenericDialog(urwid.WidgetWrap): - - def __init__(self, widgets_lst, title, style=[], **kwargs): - frame_header = urwid.AttrMap(urwid.Text(title,'center'),'title') - - buttons = None - - if "OK/CANCEL" in style: - cancel_arg = [kwargs['cancel_value']] if kwargs.has_key('cancel_value') else [] - ok_arg = [kwargs['ok_value']] if kwargs.has_key('ok_value') else [] - buttons = [urwid.Button(_("Cancel"), kwargs['cancel_cb'], *cancel_arg), - urwid.Button(_("Ok"), kwargs['ok_cb'], *ok_arg)] - elif "YES/NO" in style: - yes_arg = [kwargs['yes_value']] if kwargs.has_key('yes_value') else [] - no_arg = [kwargs['no_value']] if kwargs.has_key('no_value') else [] - buttons = [urwid.Button(_("Yes"), kwargs['yes_cb'], *yes_arg), - urwid.Button(_("No"), kwargs['no_cb'], *no_arg)] - if "OK" in style: - ok_arg = [kwargs['ok_value']] if kwargs.has_key('ok_value') else [] - buttons = [urwid.Button(_("Ok"), kwargs['ok_cb'], *ok_arg)] - if buttons: - buttons_flow = urwid.GridFlow(buttons, max([len(button.get_label()) for button in buttons])+4, 1, 1, 'center') - body_content = urwid.SimpleListWalker(widgets_lst) - frame_body = urwid.ListBox(body_content) - frame = FocusFrame(frame_body, frame_header, buttons_flow if buttons else None, 'footer' if buttons else 'body') - decorated_frame = urwid.LineBox(frame) - urwid.WidgetWrap.__init__(self, decorated_frame) - - - -class InputDialog(GenericDialog): - """Dialog with an edit box""" - - def __init__(self, title, instrucions, style=['OK/CANCEL'], default_txt = '', **kwargs): - instr_wid = urwid.Text(instrucions+':') - edit_box = AdvancedEdit(edit_text=default_txt) - GenericDialog.__init__(self, [instr_wid,edit_box], title, style, ok_value=edit_box, **kwargs) - self._w.base_widget.set_focus('body') - -class ConfirmDialog(GenericDialog): - """Dialog with buttons for confirm or cancel an action""" - - def __init__(self, title, style=['YES/NO'], **kwargs): - GenericDialog.__init__(self, [], title, style, **kwargs) - -class Alert(GenericDialog): - """Dialog with just a message and a OK button""" - - def __init__(self, title, message, style=['OK'], **kwargs): - GenericDialog.__init__(self, [urwid.Text(message, 'center')], title, style, ok_value=None, **kwargs) - -## CONTAINERS ## - -class ColumnsRoller(urwid.FlowWidget): - - def __init__(self, widget_list = None, focus_column=0): - self.widget_list = widget_list or [] - self.focus_column = focus_column - self.__start = 0 - self.__next = False - - def addWidget(self, widget, width): - self.widget_list.append((width,widget)) - if len(self.widget_list) == 1: - self.set_focus(0) - - def getStartCol(self, widget): - """Return the column of the left corner of the widget""" - start_col = 0 - for wid in self.widget_list[self.__start:]: - if wid[1] == widget: - return start_col - start_col+=wid[0] - return None - - def selectable(self): - try: - return self.widget_list[self.focus_column][1].selectable() - except IndexError: - return False - - def keypress(self, size, key): - if key=='left': - if self.focus_column>0: - self.focus_column-=1 - self._invalidate() - return - if key=='right': - if self.focus_columnlen(self.widget_list)-1: - idx = len(self.widget_list)-1 - self.focus_column = idx - - def rows(self,size,focus=False): - return 1 - - def __calculate_limits(self, size): - (maxcol,) = size - _prev = _next = False - start_wid = 0 - end_wid = len(self.widget_list)-1 - - total_wid = sum([w[0] for w in self.widget_list]) - while total_wid > maxcol: - if self.focus_column == end_wid: - if not _prev: - total_wid+=1 - _prev = True - total_wid-=self.widget_list[start_wid][0] - start_wid+=1 - else: - if not _next: - total_wid+=1 - _next = True - total_wid-=self.widget_list[end_wid][0] - end_wid-=1 - - cols_left = maxcol - total_wid - self.__start = start_wid #we need to keep it for getStartCol - return _prev,_next,start_wid,end_wid,cols_left - - - def mouse_event(self, size, event, button, x, y, focus): - (maxcol,)=size - - if urwid.is_mouse_press(event) and button == 1: - _prev,_next,start_wid,end_wid,cols_left = self.__calculate_limits(size) - if x==0 and _prev: - self.keypress(size,'left') - return True - if x==maxcol-1 and _next: - self.keypress(size,'right') - return True - - current_pos = 1 if _prev else 0 - idx = 0 - while current_pos. -""" - -import urwid -import custom_widgets -from tools.jid import JID -import os, os.path -from xml.dom import minidom -from logging import debug, info, error -from time import time - -class PathEdit(custom_widgets.AdvancedEdit): - """AdvancedEdit with manage file paths""" - - def keypress(self, size, key): - if key == '~' and self.edit_pos==0: - expanded = os.path.expanduser('~') - self.set_edit_text(os.path.normpath(expanded+'/'+self.edit_text)) - self.set_edit_pos(len(expanded)+1) - elif key == 'ctrl w': - if self.edit_pos<2: - return - before = self.edit_text[:self.edit_pos] - pos = (before[:-1] if before.endswith('/') else before).rfind("/")+1 - self.set_edit_text(before[:pos] + self.edit_text[self.edit_pos:]) - self.set_edit_pos(pos) - return - else: - return super(PathEdit, self).keypress(size, key) - -class FilesViewer(urwid.WidgetWrap): - """List specialised for files""" - - def __init__(self, onPreviousDir, onDirClick, onFileClick): - self.path='' - self.key_cache = '' - self.key_time = time() - self.onPreviousDir = onPreviousDir - self.onDirClick = onDirClick - self.onFileClick = onFileClick - self.files_list = urwid.SimpleListWalker([]) - self.show_hidden = True - listbox = urwid.ListBox(self.files_list) - urwid.WidgetWrap.__init__(self, listbox) - - def keypress(self, size, key): - if key=='meta h': - #(un)hide hidden files - self.show_hidden = not self.show_hidden - self.showDirectory(self.path) - if key=='meta d': - #jump to directories - if self.files_list: - self._w.set_focus(0) - elif key=='meta f': - for idx in range(len(self.files_list)): - if isinstance(self.files_list[idx].base_widget,urwid.Divider): - if idx 2: - self.key_cache=key - else: - self.key_cache+=key - self.key_time = time() - for idx in range(len(self.files_list)): - if isinstance(self.files_list[idx],custom_widgets.ClickableText) and self.files_list[idx].get_text().lower().startswith(self.key_cache.lower()): - self._w.set_focus(idx) - break - else: - return self._w.keypress(size, key) - - def showDirectory(self, path): - self.path = path - del self.files_list[:] - directories = [] - files = [] - try: - for filename in os.listdir(path): - fullpath = os.path.join(path,filename) - if os.path.isdir(fullpath): - directories.append(filename) - else: - files.append(filename) - except OSError: - self.files_list.append(urwid.Text(("warning",_("Impossible to list directory")),'center')) - directories.sort() - files.sort() - if os.path.abspath(path)!='/' and os.path.abspath(path) != '//': - previous_wid = custom_widgets.ClickableText(('directory','..')) - urwid.connect_signal(previous_wid,'click',self.onPreviousDir) - self.files_list.append(previous_wid) - for directory in directories: - if directory.startswith('.') and not self.show_hidden: - continue - dir_wid = custom_widgets.ClickableText(('directory',directory)) - urwid.connect_signal(dir_wid,'click',self.onDirClick) - self.files_list.append(dir_wid) - self.files_list.append(urwid.AttrMap(urwid.Divider('-'),'separator')) - for filename in files: - if filename.startswith('.') and not self.show_hidden: - continue - file_wid = custom_widgets.ClickableText(filename) - urwid.connect_signal(file_wid,'click',self.onFileClick) - self.files_list.append(file_wid) - - - -class FileDialog(urwid.WidgetWrap): - - def __init__(self, ok_cb, cancel_cb, title=_("Please select a file"), style=[]): - """Create file dialog - @param title: title of the window/popup - @param style: NOT USED YET #FIXME - """ - self.ok_cb = ok_cb - self.__home_path = os.path.expanduser('~') - self.path_wid = PathEdit(_('Path: ')) - self.path_wid.setCompletionMethod(self._directory_completion) - urwid.connect_signal(self.path_wid, 'change', self.onPathChange) - header = urwid.Pile([self.path_wid, urwid.Divider(u'─')]) - bookm_list = urwid.SimpleListWalker([]) - self.bookmarks = list(self.getBookmarks()) - self.bookmarks.sort() - for bookmark in self.bookmarks: - if bookmark.startswith(self.__home_path): - bookmark="~"+bookmark[len(self.__home_path):] - book_wid = custom_widgets.ClickableText(bookmark) - urwid.connect_signal(book_wid, 'click', self.onBookmarkSelected) - bookm_list.append(book_wid) - bookm_wid = urwid.Frame(urwid.ListBox(bookm_list), urwid.AttrMap(urwid.Text(_('Bookmarks'),'center'),'title')) - self.files_wid = FilesViewer(self.onPreviousDir, self.onDirClick, self.onFileClick) - center_row = urwid.Columns([('weight',2,bookm_wid), - ('weight',8,custom_widgets.VerticalSeparator(self.files_wid))]) - - buttons = [] - buttons.append(custom_widgets.CustomButton(_('Cancel'),cancel_cb)) - max_len = max([button.getSize() for button in buttons]) - buttons_wid = urwid.GridFlow(buttons,max_len,1,0,'center') - main_frame = custom_widgets.FocusFrame(center_row, header, buttons_wid) - decorated = custom_widgets.LabelLine(main_frame, custom_widgets.SurroundedText(title)) - urwid.WidgetWrap.__init__(self, decorated) - self.path_wid.set_edit_text(os.getcwdu()) - - def _directory_completion(self, path, completion_data): - path=os.path.abspath(path) - if not os.path.isdir(path): - head,dir_start = os.path.split(path) - else: - head=path - dir_start='' - try: - filenames = os.listdir(head) - filenames.sort() - try: - start_idx=filenames.index(completion_data['last_dir'])+1 - if start_idx == len(filenames): - start_idx = 0 - except (KeyError,ValueError): - start_idx = 0 - for idx in range(start_idx,len(filenames)) + range(0,start_idx): - full_path = os.path.join(head,filenames[idx]) - if filenames[idx].lower().startswith(dir_start.lower()) and os.path.isdir(full_path): - completion_data['last_dir'] = filenames[idx] - return full_path - except OSError: - pass - return path - - def getBookmarks(self): - gtk_bookm = os.path.expanduser("~/.gtk-bookmarks") - kde_bookm = os.path.expanduser("~/.kde/share/apps/kfileplaces/bookmarks.xml") - bookmarks = set() - try: - with open(gtk_bookm) as gtk_fd: - for bm in gtk_fd.readlines(): - if bm.startswith("file:///"): - bookmarks.add(bm[7:].replace('\n','')) - except IOError: - info(_('No GTK bookmarks file found')) - pass - - try: - dom = minidom.parse(kde_bookm) - for elem in dom.getElementsByTagName('bookmark'): - bm = elem.getAttribute("href") - if bm.startswith("file:///"): - bookmarks.add(bm[7:]) - except IOError: - info(_('No KDE bookmarks file found')) - pass - - return bookmarks - - def onBookmarkSelected(self, button): - self.path_wid.set_edit_text(os.path.expanduser(button.get_text())) - - def onPathChange(self, edit, path): - if os.path.isdir(path): - self.files_wid.showDirectory(path) - - def onPreviousDir(self, wid): - path = os.path.abspath(self.path_wid.get_edit_text()) - if not os.path.isdir(path): - path = dirname(path) - self.path_wid.set_edit_text(os.path.split(path)[0]) - - def onDirClick(self, wid): - path = os.path.abspath(self.path_wid.get_edit_text()) - if not os.path.isdir(path): - path = dirname(path) - self.path_wid.set_edit_text(os.path.join(path,wid.get_text())) - - def onFileClick(self, wid): - self.ok_cb(os.path.abspath(os.path.join(self.files_wid.path,wid.get_text()))) diff -r 5d0e497f73a2 -r 1aeb3540aa49 urwid_satext/__init__.py diff -r 5d0e497f73a2 -r 1aeb3540aa49 urwid_satext/files_management.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/urwid_satext/files_management.py Tue Dec 28 11:53:18 2010 +0100 @@ -0,0 +1,233 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +""" +Primitivus: a SAT frontend +Copyright (C) 2009, 2010 Jérôme Poisson (goffi@goffi.org) + +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 . +""" + +import urwid +import sat_widgets +import os, os.path +from xml.dom import minidom +from logging import debug, info, error +from time import time + +class PathEdit(sat_widgets.AdvancedEdit): + """AdvancedEdit with manage file paths""" + + def keypress(self, size, key): + if key == '~' and self.edit_pos==0: + expanded = os.path.expanduser('~') + self.set_edit_text(os.path.normpath(expanded+'/'+self.edit_text)) + self.set_edit_pos(len(expanded)+1) + elif key == 'ctrl w': + if self.edit_pos<2: + return + before = self.edit_text[:self.edit_pos] + pos = (before[:-1] if before.endswith('/') else before).rfind("/")+1 + self.set_edit_text(before[:pos] + self.edit_text[self.edit_pos:]) + self.set_edit_pos(pos) + return + else: + return super(PathEdit, self).keypress(size, key) + +class FilesViewer(urwid.WidgetWrap): + """List specialised for files""" + + def __init__(self, onPreviousDir, onDirClick, onFileClick): + self.path='' + self.key_cache = '' + self.key_time = time() + self.onPreviousDir = onPreviousDir + self.onDirClick = onDirClick + self.onFileClick = onFileClick + self.files_list = urwid.SimpleListWalker([]) + self.show_hidden = True + listbox = urwid.ListBox(self.files_list) + urwid.WidgetWrap.__init__(self, listbox) + + def keypress(self, size, key): + if key=='meta h': + #(un)hide hidden files + self.show_hidden = not self.show_hidden + self.showDirectory(self.path) + if key=='meta d': + #jump to directories + if self.files_list: + self._w.set_focus(0) + elif key=='meta f': + for idx in range(len(self.files_list)): + if isinstance(self.files_list[idx].base_widget,urwid.Divider): + if idx 2: + self.key_cache=key + else: + self.key_cache+=key + self.key_time = time() + for idx in range(len(self.files_list)): + if isinstance(self.files_list[idx],sat_widgets.ClickableText) and self.files_list[idx].get_text().lower().startswith(self.key_cache.lower()): + self._w.set_focus(idx) + break + else: + return self._w.keypress(size, key) + + def showDirectory(self, path): + self.path = path + del self.files_list[:] + directories = [] + files = [] + try: + for filename in os.listdir(path): + fullpath = os.path.join(path,filename) + if os.path.isdir(fullpath): + directories.append(filename) + else: + files.append(filename) + except OSError: + self.files_list.append(urwid.Text(("warning",_("Impossible to list directory")),'center')) + directories.sort() + files.sort() + if os.path.abspath(path)!='/' and os.path.abspath(path) != '//': + previous_wid = sat_widgets.ClickableText(('directory','..')) + urwid.connect_signal(previous_wid,'click',self.onPreviousDir) + self.files_list.append(previous_wid) + for directory in directories: + if directory.startswith('.') and not self.show_hidden: + continue + dir_wid = sat_widgets.ClickableText(('directory',directory)) + urwid.connect_signal(dir_wid,'click',self.onDirClick) + self.files_list.append(dir_wid) + self.files_list.append(urwid.AttrMap(urwid.Divider('-'),'separator')) + for filename in files: + if filename.startswith('.') and not self.show_hidden: + continue + file_wid = sat_widgets.ClickableText(filename) + urwid.connect_signal(file_wid,'click',self.onFileClick) + self.files_list.append(file_wid) + + + +class FileDialog(urwid.WidgetWrap): + + def __init__(self, ok_cb, cancel_cb, title=_("Please select a file"), style=[]): + """Create file dialog + @param title: title of the window/popup + @param style: NOT USED YET #FIXME + """ + self.ok_cb = ok_cb + self.__home_path = os.path.expanduser('~') + self.path_wid = PathEdit(_('Path: ')) + self.path_wid.setCompletionMethod(self._directory_completion) + urwid.connect_signal(self.path_wid, 'change', self.onPathChange) + header = urwid.Pile([self.path_wid, urwid.Divider(u'─')]) + bookm_list = urwid.SimpleListWalker([]) + self.bookmarks = list(self.getBookmarks()) + self.bookmarks.sort() + for bookmark in self.bookmarks: + if bookmark.startswith(self.__home_path): + bookmark="~"+bookmark[len(self.__home_path):] + book_wid = sat_widgets.ClickableText(bookmark) + urwid.connect_signal(book_wid, 'click', self.onBookmarkSelected) + bookm_list.append(book_wid) + bookm_wid = urwid.Frame(urwid.ListBox(bookm_list), urwid.AttrMap(urwid.Text(_('Bookmarks'),'center'),'title')) + self.files_wid = FilesViewer(self.onPreviousDir, self.onDirClick, self.onFileClick) + center_row = urwid.Columns([('weight',2,bookm_wid), + ('weight',8,sat_widgets.VerticalSeparator(self.files_wid))]) + + buttons = [] + buttons.append(sat_widgets.CustomButton(_('Cancel'),cancel_cb)) + max_len = max([button.getSize() for button in buttons]) + buttons_wid = urwid.GridFlow(buttons,max_len,1,0,'center') + main_frame = sat_widgets.FocusFrame(center_row, header, buttons_wid) + decorated = sat_widgets.LabelLine(main_frame, sat_widgets.SurroundedText(title)) + urwid.WidgetWrap.__init__(self, decorated) + self.path_wid.set_edit_text(os.getcwdu()) + + def _directory_completion(self, path, completion_data): + path=os.path.abspath(path) + if not os.path.isdir(path): + head,dir_start = os.path.split(path) + else: + head=path + dir_start='' + try: + filenames = os.listdir(head) + filenames.sort() + try: + start_idx=filenames.index(completion_data['last_dir'])+1 + if start_idx == len(filenames): + start_idx = 0 + except (KeyError,ValueError): + start_idx = 0 + for idx in range(start_idx,len(filenames)) + range(0,start_idx): + full_path = os.path.join(head,filenames[idx]) + if filenames[idx].lower().startswith(dir_start.lower()) and os.path.isdir(full_path): + completion_data['last_dir'] = filenames[idx] + return full_path + except OSError: + pass + return path + + def getBookmarks(self): + gtk_bookm = os.path.expanduser("~/.gtk-bookmarks") + kde_bookm = os.path.expanduser("~/.kde/share/apps/kfileplaces/bookmarks.xml") + bookmarks = set() + try: + with open(gtk_bookm) as gtk_fd: + for bm in gtk_fd.readlines(): + if bm.startswith("file:///"): + bookmarks.add(bm[7:].replace('\n','')) + except IOError: + info(_('No GTK bookmarks file found')) + pass + + try: + dom = minidom.parse(kde_bookm) + for elem in dom.getElementsByTagName('bookmark'): + bm = elem.getAttribute("href") + if bm.startswith("file:///"): + bookmarks.add(bm[7:]) + except IOError: + info(_('No KDE bookmarks file found')) + pass + + return bookmarks + + def onBookmarkSelected(self, button): + self.path_wid.set_edit_text(os.path.expanduser(button.get_text())) + + def onPathChange(self, edit, path): + if os.path.isdir(path): + self.files_wid.showDirectory(path) + + def onPreviousDir(self, wid): + path = os.path.abspath(self.path_wid.get_edit_text()) + if not os.path.isdir(path): + path = dirname(path) + self.path_wid.set_edit_text(os.path.split(path)[0]) + + def onDirClick(self, wid): + path = os.path.abspath(self.path_wid.get_edit_text()) + if not os.path.isdir(path): + path = dirname(path) + self.path_wid.set_edit_text(os.path.join(path,wid.get_text())) + + def onFileClick(self, wid): + self.ok_cb(os.path.abspath(os.path.join(self.files_wid.path,wid.get_text()))) diff -r 5d0e497f73a2 -r 1aeb3540aa49 urwid_satext/sat_widgets.py --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/urwid_satext/sat_widgets.py Tue Dec 28 11:53:18 2010 +0100 @@ -0,0 +1,1020 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- + +""" +Primitivus: a SAT frontend +Copyright (C) 2009, 2010 Jérôme Poisson (goffi@goffi.org) + +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 . +""" + +import urwid +from urwid.escape import utf8decode +from logging import debug, info, warning, error + +class Password(urwid.Edit): + """Edit box which doesn't show what is entered (show '*' or other char instead)""" + + def __init__(self, *args, **kwargs): + """Same args than Edit.__init__ with an additional keyword arg 'hidden_char' + @param hidden_char: char to show instead of what is actually entered: default '*' + """ + self.hidden_char=kwargs['hidden_char'] if kwargs.has_key('hidden_char') else '*' + self.__real_text='' + super(Password, self).__init__(*args, **kwargs) + + def set_edit_text(self, text): + self.__real_text = text + hidden_txt = len(text)*'*' + super(Password, self).set_edit_text(hidden_txt) + + def get_edit_text(self): + return self.__real_text + + def insert_text(self, text): + self._edit_text = self.__real_text + super(Password,self).insert_text(text) + + def render(self, size, focus=False): + return super(Password, self).render(size, focus) + +class AdvancedEdit(urwid.Edit): + """Edit box with some custom improvments + new chars: + - C-a: like 'home' + - C-e: like 'end' + - C-k: remove everything on the right of the cursor + - C-w: remove the word on the back + new behaviour: emit a 'click' signal when enter is pressed""" + signals = urwid.Edit.signals + ['click'] + + def setCompletionMethod(self, callback): + """Define method called when completion is asked + @callback: method with 2 arguments: + - the text to complete + - if there was already a completion, a dict with + - 'completed':last completion + - 'completion_pos': cursor position where the completion starts + - 'position': last completion cursor position + this dict must be used (and can be filled) to find next completion) + and which return the full text completed""" + self.completion_cb = callback + self.completion_data = {} + + def keypress(self, size, key): + #TODO: insert mode is not managed yet + if key == 'ctrl a': + key = 'home' + elif key == 'ctrl e': + key = 'end' + elif key == 'ctrl k': + self._delete_highlighted() + self.set_edit_text(self.edit_text[:self.edit_pos]) + elif key == 'ctrl w': + before = self.edit_text[:self.edit_pos] + pos = before.rstrip().rfind(" ")+1 + self.set_edit_text(before[:pos] + self.edit_text[self.edit_pos:]) + self.set_edit_pos(pos) + elif key == 'enter': + self._emit('click') + elif key == 'shift tab': + try: + before = self.edit_text[:self.edit_pos] + if self.completion_data: + if (not self.completion_data['completed'] + or self.completion_data['position'] != self.edit_pos + or not before.endswith(self.completion_data['completed'])): + self.completion_data.clear() + else: + before = before[:-len(self.completion_data['completed'])] + complet = self.completion_cb(before, self.completion_data) + self.completion_data['completed'] = complet[len(before):] + self.set_edit_text(complet+self.edit_text[self.edit_pos:]) + self.set_edit_pos(len(complet)) + self.completion_data['position'] = self.edit_pos + return + except AttributeError: + #No completion method defined + pass + return super(AdvancedEdit, self).keypress(size, key) + + +class SurroundedText(urwid.FlowWidget): + """Text centered on a repeated character (like a Divider, but with a text in the center)""" + + def __init__(self,text,car=utf8decode('─')): + self.text=text + self.car=car + + def rows(self,size,focus=False): + return self.display_widget(size, focus).rows(size, focus) + + def render(self, size, focus=False): + return self.display_widget(size, focus).render(size, focus) + + def display_widget(self, size, focus): + (maxcol,) = size + middle = (maxcol-len(self.text))/2 + render_text = middle * self.car + self.text + (maxcol - len(self.text) - middle) * self.car + return urwid.Text(render_text) + +class SelectableText(urwid.WidgetWrap): + """Text which can be selected with space""" + signals = ['change'] + + def __init__(self, text, align='left', header='', focus_attr='default_focus', selected_text=None, selected=False, data=None): + """@param text: same as urwid.Text's text parameter + @param align: same as urwid.Text's align parameter + @select_attr: attrbute to use when selected + @param selected: is the text selected ?""" + self.focus_attr = focus_attr + self.__selected = False + self.__was_focused = False + self.header = self.__valid_text(header) + self.default_txt = self.__valid_text(text) + urwid.WidgetWrap.__init__(self, urwid.Text("",align=align)) + self.setSelectedText(selected_text) + self.setState(selected) + + def __valid_text(self, text): + """Tmp method needed until dbus and urwid are more friends""" + if isinstance(text,basestring): + return unicode(text) + elif isinstance(text,tuple): + return (unicode(text[0]),text[1]) + elif isinstance(text,list): + for idx in range(len(text)): + elem = text[idx] + if isinstance(elem,basestring): + text[idx] = unicode(elem) + if isinstance(elem,tuple): + text[idx] = (unicode(elem[0]),elem[1]) + else: + warning (_('WARNING: unknown text type')) + return text + + def getValue(self): + if isinstance(self.default_txt,basestring): + return self.default_txt + list_attr = self.default_txt if isinstance(self.default_txt, list) else [self.default_txt] + txt = "" + for attr in list_attr: + if isinstance(attr,tuple): + txt+=attr[1] + else: + txt+=attr + return txt + + def get_text(self): + """for compatibility with urwid.Text""" + return self.getValue() + + def set_text(self, text): + """/!\ set_text doesn't change self.selected_txt !""" + self.default_txt = self.__valid_text(text) + self.setState(self.__selected,invisible=True) + + def setSelectedText(self, text=None): + """Text to display when selected + @text: text as in urwid.Text or None for default value""" + if text == None: + text = ('selected',self.getValue()) + self.selected_txt = self.__valid_text(text) + if self.__selected: + self.setState(self.__selected) + + + def __set_txt(self): + txt_list = [self.header] + txt = self.selected_txt if self.__selected else self.default_txt + if isinstance(txt,list): + txt_list.extend(txt) + else: + txt_list.append(txt) + self._w.base_widget.set_text(txt_list) + + + def setState(self, selected, invisible=False): + """Change state + @param selected: boolean state value + @param invisible: don't emit change signal if True""" + assert(type(selected)==bool) + self.__selected=selected + self.__set_txt() + self.__was_focused = False + self._invalidate() + if not invisible: + self._emit("change", self.__selected) + + def getState(self): + return self.__selected + + def selectable(self): + return True + + def keypress(self, size, key): + if key==' ' or key=='enter': + self.setState(not self.__selected) + else: + return key + + def mouse_event(self, size, event, button, x, y, focus): + if urwid.is_mouse_press(event) and button == 1: + self.setState(not self.__selected) + return True + + return False + + def render(self, size, focus=False): + attr_list = self._w.base_widget._attrib + if not focus: + if self.__was_focused: + self.__set_txt() + self.__was_focused = False + else: + if not self.__was_focused: + if not attr_list: + attr_list.append((self.focus_attr,len(self._w.base_widget.text))) + else: + for idx in range(len(attr_list)): + attr,attr_len = attr_list[idx] + if attr == None: + attr = self.focus_attr + attr_list[idx] = (attr,attr_len) + else: + if not attr.endswith('_focus'): + attr+="_focus" + attr_list[idx] = (attr,attr_len) + self._w.base_widget._invalidate() + self.__was_focused = True #bloody ugly hack :) + return self._w.render(size, focus) + +class ClickableText(SelectableText): + signals = SelectableText.signals + ['click'] + + def setState(self, selected, invisible=False): + super(ClickableText,self).setState(False,True) + if not invisible: + self._emit('click') + +class CustomButton(ClickableText): + + def __init__(self, label, on_press=None, user_data=None, left_border = "[ ", right_border = " ]"): + self.label = label + self.left_border = left_border + self.right_border = right_border + super(CustomButton, self).__init__([left_border, label, right_border]) + self.size = len(self.get_text()) + if on_press: + urwid.connect_signal(self, 'click', on_press, user_data) + + def getSize(self): + """Return representation size of the button""" + return self.size + + def get_label(self): + return self.label[1] if isinstance(self.label,tuple) else self.label + + def set_label(self, label): + self.label = label + self.set_text([self.left_border, label, self.right_border]) + +class GenericList(urwid.WidgetWrap): + signals = ['click','change'] + + def __init__(self, options, style=[], align='left', option_type = SelectableText, on_click=None, on_change=None, user_data=None): + """ + Widget managing list of string and their selection + @param options: list of strings used for options + @param style: list of string: + - 'single' if only one must be selected + - 'no_first_select' nothing selected when list is first displayed + - 'can_select_none' if we can select nothing + @param align: alignement of text inside the list + @param on_click: method called when click signal is emited + @param user_data: data sent to the callback for click signal + """ + self.single = 'single' in style + self.no_first_select = 'no_first_select' in style + self.can_select_none = 'can_select_none' in style + self.align = align + self.option_type = option_type + self.first_display = True + + if on_click: + urwid.connect_signal(self, 'click', on_click, user_data) + + if on_change: + urwid.connect_signal(self, 'change', on_change, user_data) + + self.content = urwid.SimpleListWalker([]) + self.list_box = urwid.ListBox(self.content) + urwid.WidgetWrap.__init__(self, self.list_box) + self.changeValues(options) + + def __onStateChange(self, widget, selected): + if self.single: + if not selected and not self.can_select_none: + #if in single mode, it's forbidden to unselect a value + widget.setState(True, invisible=True) + return + if selected: + self.unselectAll(invisible=True) + widget.setState(True, invisible=True) + self._emit("click") + + + def unselectAll(self, invisible=False): + for widget in self.content: + if widget.getState(): + widget.setState(False, invisible) + widget._invalidate() + + def deleteValue(self, value): + """Delete the first value equal to the param given""" + for widget in self.content: + if widget.getValue() == value: + self.content.remove(widget) + self._emit('change') + return + raise ValueError("%s ==> %s" % (str(value),str(self.content))) + + def getSelectedValue(self): + """Convenience method to get the value selected as a string in single mode, or None""" + values = self.getSelectedValues() + return values[0] if values else None + + def getAllValues(self): + """Return values of all items""" + return [widget.getValue() for widget in self.content] + + def getSelectedValues(self): + """Return values of selected items""" + result = [] + for widget in self.content: + if widget.getState(): + result.append(widget.getValue()) + return result + + def getDisplayWidget(self): + return self.list_box + + def changeValues(self, new_values): + """Change all value in one shot""" + if not self.first_display: + old_selected = self.getSelectedValues() + widgets = [] + for option in new_values: + widget = self.option_type(option, self.align) + if not self.first_display and option in old_selected: + widget.setState(True) + widgets.append(widget) + try: + urwid.connect_signal(widget, 'change', self.__onStateChange) + except NameError: + pass #the widget given doesn't support 'change' signal + self.content[:] = widgets + if self.first_display and self.single and new_values and not self.no_first_select: + self.content[0].setState(True) + display_widget = self.getDisplayWidget() + self._set_w(display_widget) + self._emit('change') + self.first_display = False + + def selectValue(self, value): + """Select the first item which has the given value""" + self.unselectAll() + idx = 0 + for widget in self.content: + if widget.getValue() == value: + widget.setState(True) + self.list_box.set_focus(idx) + return + idx+=1 + +class List(urwid.FlowWidget): + """FlowWidget list, same arguments as GenericList, with an additional one 'max_height'""" + signals = ['click','change'] + + def __init__(self, options, style=[], max_height=5, align='left', option_type = SelectableText, on_click=None, on_change=None, user_data=None): + self.genericList = GenericList(options, style, align, option_type, on_click, on_change, user_data) + self.max_height = max_height + + def selectable(self): + return True + + def keypress(self, size, key): + return self.displayWidget(size,True).keypress(size, key) + + def unselectAll(self, invisible=False): + return self.genericList.unselectAll(invisible) + + def deleteValue(self, value): + return self.genericList.deleteValue(value) + + def getSelectedValue(self): + return self.genericList.getSelectedValue() + + def getAllValues(self): + return self.genericList.getAllValues() + + def getSelectedValues(self): + return self.genericList.getSelectedValues() + + def changeValues(self, new_values): + return self.genericList.changeValues(new_values) + + def selectValue(self, value): + return self.genericList.selectValue(value) + + def render(self, size, focus=False): + return self.displayWidget(size, focus).render(size, focus) + + def rows(self, size, focus=False): + return self.displayWidget(size, focus).rows(size, focus) + + def displayWidget(self, size, focus): + list_size = sum([wid.rows(size, focus) for wid in self.genericList.content]) + height = min(list_size,self.max_height) or 1 + return urwid.BoxAdapter(self.genericList, height) + +## MISC ## + +class NotificationBar(urwid.WidgetWrap): + """Bar used to show misc information to user""" + signals = ['change'] + + def __init__(self): + self.waitNotifs = urwid.Text('') + self.message = ClickableText('') + urwid.connect_signal(self.message, 'click', lambda wid: self.showNext()) + self.progress = ClickableText('') + self.columns = urwid.Columns([('fixed',6,self.waitNotifs),self.message,('fixed',4,self.progress)]) + urwid.WidgetWrap.__init__(self, urwid.AttrMap(self.columns,'notifs')) + self.notifs = [] + + def __modQueue(self): + """must be called each time the notifications queue is changed""" + self.waitNotifs.set_text(('notifs',"(%i)" % len(self.notifs) if self.notifs else '')) + self._emit('change') + + def setProgress(self,percentage): + """Define the progression to show on the right side of the bar""" + if percentage == None: + self.progress.set_text('') + else: + self.progress.set_text(('notifs','%02i%%' % percentage)) + self._emit('change') + + def addPopUp(self, pop_up_widget): + """Add a popup to the waiting queue""" + self.notifs.append(('popup',pop_up_widget)) + self.__modQueue() + + def addMessage(self, message): + "Add a message to the notificatio bar" + if not self.message.get_text(): + self.message.set_text(('notifs',message)) + self._invalidate() + self._emit('change') + else: + self.notifs.append(('message',message)) + self.__modQueue() + + def showNext(self): + """Show next message if any, else delete current message""" + found = None + for notif in self.notifs: + if notif[0] == "message": + found = notif + break + if found: + self.notifs.remove(found) + self.message.set_text(('notifs',found[1])) + self.__modQueue() + else: + self.message.set_text('') + self._emit('change') + + def getNextPopup(self): + """Return next pop-up and remove it from the queue + @return: pop-up or None if there is no more in the queue""" + ret = None + for notif in self.notifs: + if notif[0] == 'popup': + ret = notif[1] + break + if ret: + self.notifs.remove(notif) + self.__modQueue() + return ret + + def isQueueEmpty(self): + return not bool(self.notifs) + + def canHide(self): + """Return True if there is now important information to show""" + return self.isQueueEmpty() and not self.message.get_text() and not self.progress.get_text() + + +class MenuBox(urwid.WidgetWrap): + """Show menu items of a category in a box""" + signals = ['click'] + + def __init__(self,parent,items): + self.parent = parent + self.selected = None + content = urwid.SimpleListWalker([ClickableText(('menuitem',text)) for text in items]) + for wid in content: + urwid.connect_signal(wid, 'click', self.onClick) + + self.listBox = urwid.ListBox(content) + menubox = urwid.LineBox(urwid.BoxAdapter(self.listBox,len(items))) + urwid.WidgetWrap.__init__(self,menubox) + + def getValue(self): + return self.selected + + def keypress(self, size, key): + if key=='up': + if self.listBox.get_focus()[1] == 0: + self.parent.keypress(size, key) + elif key=='left' or key=='right': + self.parent.keypress(size,'up') + self.parent.keypress(size,key) + return super(MenuBox,self).keypress(size,key) + + def mouse_event(self, size, event, button, x, y, focus): + if button == 3: + self.parent.keypress(size,'up') + return True + return super(MenuBox,self).mouse_event(size, event, button, x, y, focus) + + def onClick(self, wid): + self.selected = wid.getValue() + self._emit('click') + +class Menu(urwid.WidgetWrap): + + def __init__(self,loop, x_orig=0): + """Menu widget + @param loop: main loop of urwid + @param x_orig: absolute start of the abscissa + """ + self.loop = loop + self.menu_keys = [] + self.menu = {} + self.x_orig = x_orig + self.shortcuts = {} #keyboard shortcuts + self.save_bottom = None + col_rol = ColumnsRoller() + urwid.WidgetWrap.__init__(self, urwid.AttrMap(col_rol,'menubar')) + + def selectable(self): + return True + + def getMenuSize(self): + """return the current number of categories in this menu""" + return len(self.menu_keys) + + def setOrigX(self, orig_x): + self.x_orig = orig_x + + def __buildOverlay(self,menu_key,columns): + """Build the overlay menu which show menuitems + @param menu_key: name of the category + @colums: column number where the menubox must be displayed""" + max_len = 0 + for item in self.menu[menu_key]: + if len(item[0]) > max_len: + max_len = len(item[0]) + + self.save_bottom = self.loop.widget + menu_box = MenuBox(self,[item[0] for item in self.menu[menu_key]]) + urwid.connect_signal(menu_box, 'click', self.onItemClick) + + self.loop.widget = urwid.Overlay(urwid.AttrMap(menu_box,'menubar'),self.save_bottom,('fixed left', columns),max_len+2,('fixed top',1),None) + + def keypress(self, size, key): + if key == 'down': + key = 'enter' + elif key == 'up': + if self.save_bottom: + self.loop.widget = self.save_bottom + self.save_bottom = None + + return self._w.base_widget.keypress(size, key) + + def checkShortcuts(self, key): + for shortcut in self.shortcuts.keys(): + if key == shortcut: + category, item, callback = self.shortcuts[shortcut] + callback((category, item)) + return key + + def addMenu(self, category, item, callback, shortcut=None): + """Add a menu item, create the category if new + @param category: category of the menu (e.g. File/Edit) + @param item: menu item (e.g. new/close/about) + @callback: method to call when item is selected""" + if not category in self.menu.keys(): + self.menu_keys.append(category) + self.menu[category] = [] + button = CustomButton(('menubar',category), self.onCategoryClick, + left_border = ('menubar',"[ "), + right_border = ('menubar'," ]")) + self._w.base_widget.addWidget(button,button.getSize()) + self.menu[category].append((item, callback)) + if shortcut: + assert(shortcut not in self.shortcuts.keys()) + self.shortcuts[shortcut] = (category, item, callback) + + def onItemClick(self, widget): + category = self._w.base_widget.getSelected().get_label() + item = widget.getValue() + callback = None + for menu_item in self.menu[category]: + if item == menu_item[0]: + callback = menu_item[1] + break + if callback: + self.keypress(None,'up') + callback((category, item)) + + def onCategoryClick(self, button): + self.__buildOverlay(button.get_label(), + self.x_orig + self._w.base_widget.getStartCol(button)) + + +class MenuRoller(urwid.WidgetWrap): + + def __init__(self,menus_list): + """Create a MenuRoller + @param menus_list: list of tuple with (name, Menu_instance), name can be None + """ + assert (menus_list) + self.selected = 0 + self.name_list = [] + self.menus = {} + + self.columns = urwid.Columns([urwid.Text(''),urwid.Text('')]) + urwid.WidgetWrap.__init__(self, self.columns) + + for menu_tuple in menus_list: + name,menu = menu_tuple + self.addMenu(name, menu) + + def __showSelected(self): + """show menu selected""" + name_txt = u'\u21c9 '+self.name_list[self.selected]+u' \u21c7 ' + current_name = ClickableText(name_txt) + name_len = len(name_txt) + current_menu = self.menus[self.name_list[self.selected]] + current_menu.setOrigX(name_len) + self.columns.widget_list[0] = current_name + self.columns.column_types[0]=('fixed', name_len) + self.columns.widget_list[1] = current_menu + + def keypress(self, size, key): + if key=='up': + if self.columns.get_focus_column()==0 and self.selected > 0: + self.selected -= 1 + self.__showSelected() + elif key=='down': + if self.columns.get_focus_column()==0 and self.selected < len(self.name_list)-1: + self.selected += 1 + self.__showSelected() + elif key=='right': + if self.columns.get_focus_column()==0 and \ + (isinstance(self.columns.widget_list[1], urwid.Text) or \ + self.menus[self.name_list[self.selected]].getMenuSize()==0): + return #if we have no menu or the menu is empty, we don't go the right column + + return super(MenuRoller, self).keypress(size, key) + + def addMenu(self, name_param, menu): + name = name_param or '' + if name not in self.name_list: + self.name_list.append(name) + self.menus[name] = menu + if self.name_list[self.selected] == name: + self.__showSelected() #if we are on the menu, we update it + + def removeMenu(self, name): + if name in self.name_list: + self.name_list.remove(name) + if name in self.menus.keys(): + del self.menus[name] + self.selected = 0 + self.__showSelected() + + def checkShortcuts(self, key): + for menu in self.name_list: + key = self.menus[menu].checkShortcuts(key) + return key + + +## DIALOGS ## + +class GenericDialog(urwid.WidgetWrap): + + def __init__(self, widgets_lst, title, style=[], **kwargs): + frame_header = urwid.AttrMap(urwid.Text(title,'center'),'title') + + buttons = None + + if "OK/CANCEL" in style: + cancel_arg = [kwargs['cancel_value']] if kwargs.has_key('cancel_value') else [] + ok_arg = [kwargs['ok_value']] if kwargs.has_key('ok_value') else [] + buttons = [urwid.Button(_("Cancel"), kwargs['cancel_cb'], *cancel_arg), + urwid.Button(_("Ok"), kwargs['ok_cb'], *ok_arg)] + elif "YES/NO" in style: + yes_arg = [kwargs['yes_value']] if kwargs.has_key('yes_value') else [] + no_arg = [kwargs['no_value']] if kwargs.has_key('no_value') else [] + buttons = [urwid.Button(_("Yes"), kwargs['yes_cb'], *yes_arg), + urwid.Button(_("No"), kwargs['no_cb'], *no_arg)] + if "OK" in style: + ok_arg = [kwargs['ok_value']] if kwargs.has_key('ok_value') else [] + buttons = [urwid.Button(_("Ok"), kwargs['ok_cb'], *ok_arg)] + if buttons: + buttons_flow = urwid.GridFlow(buttons, max([len(button.get_label()) for button in buttons])+4, 1, 1, 'center') + body_content = urwid.SimpleListWalker(widgets_lst) + frame_body = urwid.ListBox(body_content) + frame = FocusFrame(frame_body, frame_header, buttons_flow if buttons else None, 'footer' if buttons else 'body') + decorated_frame = urwid.LineBox(frame) + urwid.WidgetWrap.__init__(self, decorated_frame) + + + +class InputDialog(GenericDialog): + """Dialog with an edit box""" + + def __init__(self, title, instrucions, style=['OK/CANCEL'], default_txt = '', **kwargs): + instr_wid = urwid.Text(instrucions+':') + edit_box = AdvancedEdit(edit_text=default_txt) + GenericDialog.__init__(self, [instr_wid,edit_box], title, style, ok_value=edit_box, **kwargs) + self._w.base_widget.set_focus('body') + +class ConfirmDialog(GenericDialog): + """Dialog with buttons for confirm or cancel an action""" + + def __init__(self, title, style=['YES/NO'], **kwargs): + GenericDialog.__init__(self, [], title, style, **kwargs) + +class Alert(GenericDialog): + """Dialog with just a message and a OK button""" + + def __init__(self, title, message, style=['OK'], **kwargs): + GenericDialog.__init__(self, [urwid.Text(message, 'center')], title, style, ok_value=None, **kwargs) + +## CONTAINERS ## + +class ColumnsRoller(urwid.FlowWidget): + + def __init__(self, widget_list = None, focus_column=0): + self.widget_list = widget_list or [] + self.focus_column = focus_column + self.__start = 0 + self.__next = False + + def addWidget(self, widget, width): + self.widget_list.append((width,widget)) + if len(self.widget_list) == 1: + self.set_focus(0) + + def getStartCol(self, widget): + """Return the column of the left corner of the widget""" + start_col = 0 + for wid in self.widget_list[self.__start:]: + if wid[1] == widget: + return start_col + start_col+=wid[0] + return None + + def selectable(self): + try: + return self.widget_list[self.focus_column][1].selectable() + except IndexError: + return False + + def keypress(self, size, key): + if key=='left': + if self.focus_column>0: + self.focus_column-=1 + self._invalidate() + return + if key=='right': + if self.focus_columnlen(self.widget_list)-1: + idx = len(self.widget_list)-1 + self.focus_column = idx + + def rows(self,size,focus=False): + return 1 + + def __calculate_limits(self, size): + (maxcol,) = size + _prev = _next = False + start_wid = 0 + end_wid = len(self.widget_list)-1 + + total_wid = sum([w[0] for w in self.widget_list]) + while total_wid > maxcol: + if self.focus_column == end_wid: + if not _prev: + total_wid+=1 + _prev = True + total_wid-=self.widget_list[start_wid][0] + start_wid+=1 + else: + if not _next: + total_wid+=1 + _next = True + total_wid-=self.widget_list[end_wid][0] + end_wid-=1 + + cols_left = maxcol - total_wid + self.__start = start_wid #we need to keep it for getStartCol + return _prev,_next,start_wid,end_wid,cols_left + + + def mouse_event(self, size, event, button, x, y, focus): + (maxcol,)=size + + if urwid.is_mouse_press(event) and button == 1: + _prev,_next,start_wid,end_wid,cols_left = self.__calculate_limits(size) + if x==0 and _prev: + self.keypress(size,'left') + return True + if x==maxcol-1 and _next: + self.keypress(size,'right') + return True + + current_pos = 1 if _prev else 0 + idx = 0 + while current_pos