From 3db953a8facb17ab085f03f698f5f62324a1ea13 Mon Sep 17 00:00:00 2001 From: Walter Bender Date: Thu, 15 Mar 2012 14:19:46 +0000 Subject: new project --- diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..10926e8 --- /dev/null +++ b/COPYING @@ -0,0 +1,675 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. + diff --git a/DeductoActivity.py b/DeductoActivity.py new file mode 100644 index 0000000..f4d5941 --- /dev/null +++ b/DeductoActivity.py @@ -0,0 +1,433 @@ +# -*- coding: utf-8 -*- +#Copyright (c) 2012 Walter Bender + +# 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. +# +# You should have received a copy of the GNU General Public License +# along with this library; if not, write to the Free Software +# Foundation, 51 Franklin Street, Suite 500 Boston, MA 02110-1335 USA + + +import gtk + +from sugar.activity import activity +from sugar import profile +try: + from sugar.graphics.toolbarbox import ToolbarBox + _have_toolbox = True +except ImportError: + _have_toolbox = False + +if _have_toolbox: + from sugar.activity.widgets import ActivityToolbarButton + from sugar.activity.widgets import StopButton +from sugar.graphics.objectchooser import ObjectChooser + +from toolbar_utils import button_factory, label_factory, separator_factory +from utils import json_load, json_dump + +import telepathy +import dbus +from dbus.service import signal +from dbus.gobject_service import ExportedGObject +from sugar.presence import presenceservice +from sugar.presence.tubeconn import TubeConnection + +from gettext import gettext as _ + +from game import Game, LEVELS_TRUE, LEVELS_FALSE + +import logging +_logger = logging.getLogger('deducto-activity') + + +SERVICE = 'in.seeta.Deducto' +IFACE = SERVICE +PATH = '/in/seeta/DeductoActivity' + + +class DeductoActivity(activity.Activity): + """ Logic puzzle game """ + + def __init__(self, handle): + """ Initialize the toolbars and the game board """ + try: + super(DeductoActivity, self).__init__(handle) + except dbus.exceptions.DBusException, e: + _logger.error(str(e)) + + self.nick = profile.get_nick_name() + if profile.get_color() is not None: + self.colors = profile.get_color().to_string().split(',') + else: + self.colors = ['#A0FFA0', '#FF8080'] + + self.playing = True + self.level = 0 + self.correct = 0 + self.game_over = False + + self._setup_toolbars(_have_toolbox) + self._setup_dispatch_table() + + # Create a canvas + canvas = gtk.DrawingArea() + canvas.set_size_request(gtk.gdk.screen_width(), \ + gtk.gdk.screen_height()) + self.set_canvas(canvas) + canvas.show() + self.show_all() + + self._game = Game(canvas, parent=self, colors=self.colors) + self._setup_presence_service() + + if 'level' in self.metadata: + self.level = int(self.metadata['level']) + self.status.set_label(_('Resuming level %d') % (self.level + 1)) + self._game.show_random() + else: + self._game.new_game() + + def _setup_toolbars(self, have_toolbox): + """ Setup the toolbars. """ + + self.max_participants = 0 + + if have_toolbox: + toolbox = ToolbarBox() + + # Activity toolbar + activity_button = ActivityToolbarButton(self) + + toolbox.toolbar.insert(activity_button, 0) + activity_button.show() + + self.set_toolbar_box(toolbox) + toolbox.show() + self.toolbar = toolbox.toolbar + + else: + # Use pre-0.86 toolbar design + games_toolbar = gtk.Toolbar() + toolbox = activity.ActivityToolbox(self) + self.set_toolbox(toolbox) + toolbox.add_toolbar(_('Game'), games_toolbar) + toolbox.show() + toolbox.set_current_toolbar(1) + self.toolbar = games_toolbar + + self._new_game_button = button_factory( + 'new-game', self.toolbar, self._new_game_cb, + tooltip=_('Start a new game.')) + + if _have_toolbox: + separator_factory(toolbox.toolbar, False, True) + + self._true_button = button_factory( + 'true', self.toolbar, self._true_cb, + tooltip=_('The pattern matches the rule.')) + + self._false_button = button_factory( + 'false', self.toolbar, self._false_cb, + tooltip=_('The pattern does not match the rule.')) + + if _have_toolbox: + separator_factory(toolbox.toolbar, False, True) + + self._example_button = button_factory( + 'example', self.toolbar, self._example_cb, + tooltip=_('Explore some examples.')) + + self.status = label_factory(self.toolbar, '') + + if _have_toolbox: + separator_factory(toolbox.toolbar, True, False) + + self._gear_button = button_factory( + 'view-source', self.toolbar, + self._gear_cb, + tooltip=_('Load a custom level.')) + + if _have_toolbox: + stop_button = StopButton(self) + stop_button.props.accelerator = 'q' + toolbox.toolbar.insert(stop_button, -1) + stop_button.show() + + def _new_game_cb(self, button=None): + ''' Start a new game. ''' + self.game_over = False + self.correct = 0 + self.level = 0 + self._game.new_game() + + def _test_for_game_over(self): + ''' If we are at maximum levels, the game is over ''' + if self.level == self._game.max_levels: + self.status.set_label(_('Game over.')) + self.level = 0 + self.game_over = True + else: + self.status.set_label(_('Playing level %d') % (self.level + 1)) + self.correct = 0 + self._game.show_random() + + def _true_cb(self, button=None): + ''' Declare pattern true or show an example of a true pattern. ''' + if self.game_over: + self.status.set_label(_('Click on new game button to begin.')) + return + if self.playing: + if self._game.this_pattern: + self.correct += 1 + if self.correct == 5: + self.level += 1 + self._test_for_game_over() + self.metadata['level'] = str(self.level) + else: + self.status.set_label( + _('%d correct answers.') % (self.correct)) + self._game.show_random() + else: + self.status.set_label(_('Pattern was false.')) + self.correct = 0 + else: + self._game.show_true() + + def _false_cb(self, button=None): + ''' Declare pattern false or show an example of a false pattern. ''' + if self.game_over: + self.status.set_label(_('Click on new game button to begin.')) + return + if self.playing: + if not self._game.this_pattern: + self.correct += 1 + if self.correct == 5: + self.level += 1 + self._test_for_game_over() + else: + self.status.set_label( + _('%d correct answers.') % (self.correct)) + self._game.show_random() + else: + self.status.set_label(_('Pattern was true.')) + self.correct = 0 + else: + self._game.show_false() + + def _example_cb(self, button=None): + ''' Show examples or resume play of current level. ''' + if self.playing: + self._example_button.set_icon('resume-play') + self._example_button.set_tooltip(_('Resume play')) + self._true_button.set_tooltip( + _('Show a pattern that matches the rule.')) + self._false_button.set_tooltip( + _('Show a pattern that does not match the rule.')) + self.status.set_label( + _('Explore patterns with the ☑ and ☒ buttons')) + self.playing = False + else: + self._example_button.set_icon('example') + self._example_button.set_tooltip(_('Explore some examples.')) + self._true_button.set_tooltip( + _('The pattern matches the rule.')) + self._false_button.set_tooltip( + _('The pattern does not match the rule.')) + self.status.set_label(_('playing level %s') % (self.level)) + self.playing = True + self.correct = 0 + + def _gear_cb(self, button=None): + ''' Load a custom level. ''' + self.status.set_text( + _('Load a "True" pattern generator from the journal')) + self._chooser('org.laptop.Pippy', + self._load_python_code_from_journal) + if self._python_code is None: + return + LEVELS_TRUE.append(self._python_code) + self.status.set_text( + _('Load a "False" pattern generator from the journal')) + self._chooser('org.laptop.Pippy', + self._load_python_code_from_journal) + LEVELS_FALSE.append(self._python_code) + if self._python_code is None: + return + self.status.set_text(_('New level added')) + self._game.max_levels += 1 + + def _load_python_code_from_journal(self, dsobject): + ''' Read the Python code from the Journal object ''' + + self._python_code = None + try: + _logger.debug("opening %s " % dsobject.file_path) + file_handle = open(dsobject.file_path, "r") + self._python_code = file_handle.read() + file_handle.close() + except IOError: + _logger.debug("couldn't open %s" % dsobject.file_path) + + def _chooser(self, filter, action): + ''' Choose an object from the datastore and take some action ''' + chooser = None + try: + chooser = ObjectChooser(parent=self, what_filter=filter) + except TypeError: + chooser = ObjectChooser( + None, self, + gtk.DIALOG_MODAL | gtk.DIALOG_DESTROY_WITH_PARENT) + if chooser is not None: + try: + result = chooser.run() + if result == gtk.RESPONSE_ACCEPT: + dsobject = chooser.get_selected_object() + action(dsobject) + dsobject.destroy() + finally: + chooser.destroy() + del chooser + + # Collaboration-related methods + + def _setup_presence_service(self): + ''' Setup the Presence Service. ''' + self.pservice = presenceservice.get_instance() + self.initiating = None # sharing (True) or joining (False) + + owner = self.pservice.get_owner() + self.owner = owner + self._share = "" + self.connect('shared', self._shared_cb) + self.connect('joined', self._joined_cb) + + def _shared_cb(self, activity): + ''' Either set up initial share...''' + self._new_tube_common(True) + + def _joined_cb(self, activity): + ''' ...or join an exisiting share. ''' + self._new_tube_common(False) + + def _new_tube_common(self, sharer): + ''' Joining and sharing are mostly the same... ''' + if self._shared_activity is None: + _logger.debug("Error: Failed to share or join activity ... \ + _shared_activity is null in _shared_cb()") + return + + self.initiating = sharer + self.waiting_for_hand = not sharer + + self.conn = self._shared_activity.telepathy_conn + self.tubes_chan = self._shared_activity.telepathy_tubes_chan + self.text_chan = self._shared_activity.telepathy_text_chan + + self.tubes_chan[telepathy.CHANNEL_TYPE_TUBES].connect_to_signal( + 'NewTube', self._new_tube_cb) + + if sharer: + _logger.debug('This is my activity: making a tube...') + id = self.tubes_chan[telepathy.CHANNEL_TYPE_TUBES].OfferDBusTube( + SERVICE, {}) + else: + _logger.debug('I am joining an activity: waiting for a tube...') + self.tubes_chan[telepathy.CHANNEL_TYPE_TUBES].ListTubes( + reply_handler=self._list_tubes_reply_cb, + error_handler=self._list_tubes_error_cb) + self._game.set_sharing(True) + + def _list_tubes_reply_cb(self, tubes): + ''' Reply to a list request. ''' + for tube_info in tubes: + self._new_tube_cb(*tube_info) + + def _list_tubes_error_cb(self, e): + ''' Log errors. ''' + _logger.debug('Error: ListTubes() failed: %s' % (e)) + + def _new_tube_cb(self, id, initiator, type, service, params, state): + ''' Create a new tube. ''' + _logger.debug('New tube: ID=%d initator=%d type=%d service=%s \ +params=%r state=%d' % (id, initiator, type, service, params, state)) + + if (type == telepathy.TUBE_TYPE_DBUS and service == SERVICE): + if state == telepathy.TUBE_STATE_LOCAL_PENDING: + self.tubes_chan[ \ + telepathy.CHANNEL_TYPE_TUBES].AcceptDBusTube(id) + + tube_conn = TubeConnection(self.conn, + self.tubes_chan[telepathy.CHANNEL_TYPE_TUBES], id, \ + group_iface=self.text_chan[telepathy.CHANNEL_INTERFACE_GROUP]) + + self.chattube = ChatTube(tube_conn, self.initiating, \ + self.event_received_cb) + + def _setup_dispatch_table(self): + ''' Associate tokens with commands. ''' + self._processing_methods = { + 'n': [self._receive_new_game, 'get a new game grid'], + 'p': [self._receive_dot_click, 'get a dot click'], + } + + def event_received_cb(self, event_message): + ''' Data from a tube has arrived. ''' + if len(event_message) == 0: + return + try: + command, payload = event_message.split('|', 2) + except ValueError: + _logger.debug('Could not split event message %s' % (event_message)) + return + self._processing_methods[command][0](payload) + + def send_new_game(self): + ''' Send a new grid to all players ''' + self.send_event('n|%s' % (json_dump(self._game.save_game()))) + + def _receive_new_game(self, payload): + ''' Sharer can start a new game. ''' + (dot_list, move_list) = json_load(payload) + self._game.restore_game(dot_list, move_list) + + def send_dot_click(self, dot): + ''' Send a dot click to all the players ''' + self.send_event('p|%s' % (json_dump(dot))) + + def _receive_dot_click(self, payload): + ''' When a dot is clicked, everyone should change its color. ''' + dot = json_load(payload) + self._game.remote_button_press(dot) + + def send_event(self, entry): + ''' Send event through the tube. ''' + if hasattr(self, 'chattube') and self.chattube is not None: + self.chattube.SendText(entry) + + +class ChatTube(ExportedGObject): + ''' Class for setting up tube for sharing ''' + + def __init__(self, tube, is_initiator, stack_received_cb): + super(ChatTube, self).__init__(tube, PATH) + self.tube = tube + self.is_initiator = is_initiator # Are we sharing or joining activity? + self.stack_received_cb = stack_received_cb + self.stack = '' + + self.tube.add_signal_receiver(self.send_stack_cb, 'SendText', IFACE, + path=PATH, sender_keyword='sender') + + def send_stack_cb(self, text, sender=None): + if sender == self.tube.get_unique_name(): + return + self.stack = text + self.stack_received_cb(text) + + @signal(dbus_interface=IFACE, signature='s') + def SendText(self, text): + self.stack = text diff --git a/NEWS b/NEWS new file mode 100644 index 0000000..0d4925b --- /dev/null +++ b/NEWS @@ -0,0 +1,9 @@ +NEWS + +5 + +ENHANCEMENT: +* Rewritten from scratch to be more Sugar-like. + +TO DO: +* Sharing not yet enabled diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..9569f21 --- /dev/null +++ b/README.txt @@ -0,0 +1,29 @@ +Deducto is a learning activity to help children learn the art of +inductive logic through pattern recognition. + + +Inspiration + +The initial code of Deducto was written in Perl by Jon Orwant, who +wrote it as part of this doctorial thesis on EGGG, a game generation +language, under the guidance of Walter Bender. + +Walter then wrote a Javascript version for the web. + +The Deducto Activity was written by a team of engineers at SEETA +(http://seeta.in): Ashita Dadlani, Anisha Arora, Satyajeet Singh, and +Manusheel Gupta + +A Glade version of Deducto was developed by Assim Deodia, Vijay +Majumadar and Satyajeet Singh under the guidance of Manusheel Gupta +and Walter Bender. + +A Non-sugarized pygtk version of Deducto was developed by Naveen +Aggarwal and Pankhuri Gupta under the guidance of Manusheel Gupta and +Vijay Majumadar. + +This version was written by scratch by Walter in order to better match +the standard Sugar look and feel. + + + diff --git a/activity/activity-deducto.svg b/activity/activity-deducto.svg new file mode 100644 index 0000000..02a7c56 --- /dev/null +++ b/activity/activity-deducto.svg @@ -0,0 +1,27 @@ + + +]> + + + + + + + + + + + + + + diff --git a/activity/activity.info b/activity/activity.info new file mode 100644 index 0000000..b863940 --- /dev/null +++ b/activity/activity.info @@ -0,0 +1,8 @@ +[Activity] +name = Deducto +exec = sugar-activity DeductoActivity.DeductoActivity +bundle_id = in.seeta.Deducto +icon = activity-deducto +activity_version = 5 +show_launcher = yes +license=GPLv3 diff --git a/game.py b/game.py new file mode 100644 index 0000000..65338c5 --- /dev/null +++ b/game.py @@ -0,0 +1,495 @@ +# -*- coding: utf-8 -*- +#Copyright (c) 2012 Walter Bender + +# 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. +# +# You should have received a copy of the GNU General Public License +# along with this library; if not, write to the Free Software +# Foundation, 51 Franklin Street, Suite 500 Boston, MA 02110-1335 USA + + +LEVELS_TRUE = ['def generate_pattern(self):\n\ + # Level 1: Center dot is True\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + dot_list[12] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 2: Corners match\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + dot_list[4] = dot_list[0]\n\ + dot_list[20] = dot_list[0]\n\ + dot_list[24] = dot_list[0]\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 3: more than 12 True\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + def dot_sum(dot_list):\n\ + sum = 0\n\ + for i in dot_list:\n\ + sum += i\n\ + return sum\n\ + while dot_sum(dot_list) < 13:\n\ + dot_list[int(uniform(0, 25))] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 4: even number of True\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + def dot_sum(dot_list):\n\ + sum = 0\n\ + for i in dot_list:\n\ + sum += i\n\ + return sum\n\ + while dot_sum(dot_list) % 2 == 1:\n\ + dot_list[int(uniform(0, 25))] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 5: diagonal is True\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + if int(uniform(0, 2)) == 1:\n\ + dot_list[0] = 1\n\ + dot_list[6] = 1\n\ + dot_list[12] = 1\n\ + dot_list[18] = 1\n\ + dot_list[24] = 1\n\ + else:\n\ + dot_list[4] = 1\n\ + dot_list[8] = 1\n\ + dot_list[12] = 1\n\ + dot_list[16] = 1\n\ + dot_list[20] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 6: True above each False\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + for i in range(20):\n\ + j = 24 - i\n\ + if dot_list[j] == 0:\n\ + dot_list[j - 5] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 7: True in each row\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + def row_sum(dot_list, row):\n\ + sum = 0\n\ + for i in range(5):\n\ + sum += dot_list[row * 5 + i]\n\ + return sum\n\ + for y in range(5):\n\ + if row_sum(dot_list, y) == 0:\n\ + dot_list[y * 5 + int(uniform(0, 5))] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 8: True path to center\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + dot_list[12] = 1\n\ + paths = [[2, 7], [10, 11], [13, 14], [17, 22]]\n\ + n = int(uniform(0, 4))\n\ + dot_list[paths[n][0]] = 1\n\ + dot_list[paths[n][1]] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 9: more True on top half than on bottom half\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + def top_sum(dot_list):\n\ + sum = 0\n\ + for i in range(10):\n\ + sum += dot_list[i]\n\ + return sum\n\ + def bot_sum(dot_list):\n\ + sum = 0\n\ + for i in range(10):\n\ + sum += dot_list[i + 15]\n\ + return sum\n\ + while top_sum(dot_list) < (bot_sum(dot_list) + 1):\n\ + dot_list[int(uniform(0, 10))] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 10: smilely face\n\ + dot_list = []\n\ + parity = int(uniform(0, 2))\n\ + for i in range(25):\n\ + dot_list.append(parity)\n\ + dot_list[6] = 1 - parity\n\ + dot_list[8] = 1 - parity\n\ + dot_list[15] = 1 - parity\n\ + dot_list[19] = 1 - parity\n\ + dot_list[21] = 1 - parity\n\ + dot_list[22] = 1 - parity\n\ + dot_list[23] = 1 - parity\n\ + return dot_list\n' +] +LEVELS_FALSE = ['def generate_pattern(self):\n\ + # Level 1: Center dot is False\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + dot_list[12] = 0\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 2: Corners do not match\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + n = int(uniform(0, 3))\n\ + corner = [4, 20, 24]\n\ + dot_list[corner[n]] = 1 - dot_list[0]\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 3: less than 13 True\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + def dot_sum(dot_list):\n\ + sum = 0\n\ + for i in dot_list:\n\ + sum += i\n\ + return sum\n\ + while dot_sum(dot_list) > 12:\n\ + dot_list[int(uniform(0, 25))] = 0\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 4: odd number of True\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + def dot_sum(dot_list):\n\ + sum = 0\n\ + for i in dot_list:\n\ + sum += i\n\ + return sum\n\ + while dot_sum(dot_list) % 2 == 0:\n\ + dot_list[int(uniform(0, 25))] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 5: diagonal is True\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + if int(uniform(0, 2)) == 1:\n\ + dot_list[0] = 1\n\ + dot_list[6] = 1\n\ + dot_list[12] = 1\n\ + dot_list[18] = 1\n\ + dot_list[24] = 1\n\ + n = int(uniform(0, 5))\n\ + diagonal = [0, 6, 12, 18, 24]\n\ + dot_list[diagonal[n]] = 1 - dot_list[0]\n\ + else:\n\ + dot_list[4] = 1\n\ + dot_list[8] = 1\n\ + dot_list[12] = 1\n\ + dot_list[16] = 1\n\ + dot_list[20] = 1\n\ + n = int(uniform(0, 5))\n\ + diagonal = [4, 8, 12, 16, 20]\n\ + dot_list[diagonal[n]] = 1 - dot_list[0]\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 6: True to right of each False\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + for y in range(5):\n\ + for x in range(4):\n\ + j = y * 5 + x\n\ + if dot_list[j] == 0:\n\ + dot_list[j + 1] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 7: One row with no True\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + y = int(uniform(0, 5))\n\ + for i in range(5):\n\ + dot_list[y * 5 + i] = 0\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 8: No True path to center\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + dot_list[12] = 1\n\ + paths = [[2, 7], [10, 11], [13, 14], [17, 22]]\n\ + for n in range(4):\n\ + if int(uniform(0, 2)) == 1:\n\ + dot_list[paths[n][0]] = 1\n\ + dot_list[paths[n][1]] = 0\n\ + else:\n\ + dot_list[paths[n][0]] = 0\n\ + dot_list[paths[n][1]] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 9: more True on bottom half than on top half\n\ + dot_list = []\n\ + for i in range(25):\n\ + dot_list.append(int(uniform(0, 2)))\n\ + def top_sum(dot_list):\n\ + sum = 0\n\ + for i in range(10):\n\ + sum += dot_list[i]\n\ + return sum\n\ + def bot_sum(dot_list):\n\ + sum = 0\n\ + for i in range(10):\n\ + sum += dot_list[i + 15]\n\ + return sum\n\ + while (top_sum(dot_list) + 1) > bot_sum(dot_list):\n\ + dot_list[int(uniform(0, 10)) + 15] = 1\n\ + return dot_list\n', + 'def generate_pattern(self):\n\ + # Level 10: frowny face\n\ + dot_list = []\n\ + parity = int(uniform(0, 2))\n\ + for i in range(25):\n\ + dot_list.append(parity)\n\ + dot_list[6] = 1 - parity\n\ + dot_list[8] = 1 - parity\n\ + dot_list[16] = 1 - parity\n\ + dot_list[17] = 1 - parity\n\ + dot_list[18] = 1 - parity\n\ + dot_list[20] = 1 - parity\n\ + dot_list[24] = 1 - parity\n\ + return dot_list\n'] + + +import gtk +import cairo +import gobject + +from math import sqrt +from random import uniform + +import traceback + +from gettext import gettext as _ + +import logging +_logger = logging.getLogger('reflection-activity') + +try: + from sugar.graphics import style + GRID_CELL_SIZE = style.GRID_CELL_SIZE +except ImportError: + GRID_CELL_SIZE = 0 + +from sprites import Sprites, Sprite + +# Grid dimensions +GRID = 5 +WHITE = 2 +DOT_SIZE = 80 + + +class Game(): + + def __init__(self, canvas, parent=None, colors=['#A0FFA0', '#FF8080']): + self._activity = parent + self._colors = [colors[0]] + self._colors.append(colors[1]) + + self._canvas = canvas + if parent is not None: + parent.show_all() + self._parent = parent + + self._canvas.set_flags(gtk.CAN_FOCUS) + self._canvas.connect("expose-event", self._expose_cb) + + self._width = gtk.gdk.screen_width() + self._height = gtk.gdk.screen_height() - (GRID_CELL_SIZE * 1.5) + self._scale = self._width / (10 * DOT_SIZE * 1.2) + self._dot_size = int(DOT_SIZE * self._scale) + self._space = int(self._dot_size / 5.) + self.we_are_sharing = False + self.max_levels = len(LEVELS_TRUE) + self.this_pattern = False + + # Generate the sprites we'll need... + self._sprites = Sprites(self._canvas) + self._dots = [] + self._generate_grid() + + def _generate_grid(self): + ''' Make a new set of dots for a grid of size edge ''' + i = 0 + for y in range(GRID): + for x in range(GRID): + xoffset = int((self._width - GRID * self._dot_size - \ + (GRID - 1) * self._space) / 2.) + if i < len(self._dots): + self._dots[i].move( + (xoffset + x * (self._dot_size + self._space), + y * (self._dot_size + self._space) + self._space)) + else: + self._dots.append( + Sprite(self._sprites, + xoffset + x * (self._dot_size + self._space), + y * (self._dot_size + self._space) + self._space, + self._new_dot(self._colors[0]))) + self._dots[i].type = 0 + self._dots[-1].set_label_attributes(40) + i += 1 + + # and initialize a few variables we'll need. + self._all_clear() + + def _all_clear(self): + ''' Things to reinitialize when starting up a new game. ''' + self.show_random() + + def show_true(self): + dot_list = self._generate_pattern(LEVELS_TRUE[self._activity.level]) + for i in range(GRID * GRID): + self._dots[i].set_shape(self._new_dot(self._colors[dot_list[i]])) + self.this_pattern = True + + def show_false(self): + dot_list = self._generate_pattern(LEVELS_FALSE[self._activity.level]) + for i in range(GRID * GRID): + self._dots[i].set_shape(self._new_dot(self._colors[dot_list[i]])) + self.this_pattern = False + + def show_random(self): + ''' Fill the grid with a true or false pattern ''' + if int(uniform(0, 2)) == 0: + self.show_true() + else: + self.show_false() + + def _initiating(self): + return self._activity.initiating + + def new_game(self): + ''' Start a new game. ''' + + self._all_clear() + + if self.we_are_sharing: + _logger.debug('sending a new game') + self._parent.send_new_game() + + def set_sharing(self, share=True): + _logger.debug('enabling sharing') + self.we_are_sharing = share + + def _grid_to_dot(self, pos): + ''' calculate the dot index from a column and row in the grid ''' + return pos[0] + pos[1] * GRID + + def _dot_to_grid(self, dot): + ''' calculate the grid column and row for a dot ''' + return [dot % GRID, int(dot / GRID)] + + def _set_label(self, string): + ''' Set the label in the toolbar or the window frame. ''' + self._activity.status.set_label(string) + + def _generate_pattern(self, f): + ''' Run Python code passed as argument ''' + userdefined = {} + try: + exec f in globals(), userdefined + return userdefined['generate_pattern'](self) + except ZeroDivisionError, e: + self._set_label('Python zero-divide error: %s' % (str(e))) + except ValueError, e: + self._set_label('Python value error: %s' % (str(e))) + except SyntaxError, e: + self._set_label('Python syntax error: %s' % (str(e))) + except NameError, e: + self._set_label('Python name error: %s' % (str(e))) + except OverflowError, e: + self._set_label('Python overflow error: %s' % (str(e))) + except TypeError, e: + self._set_label('Python type error: %s' % (str(e))) + except: + self._set_label('Python error') + traceback.print_exc() + return None + + def _expose_cb(self, win, event): + self.do_expose_event(event) + + def do_expose_event(self, event): + ''' Handle the expose-event by drawing ''' + # Restrict Cairo to the exposed area + cr = self._canvas.window.cairo_create() + cr.rectangle(event.area.x, event.area.y, + event.area.width, event.area.height) + cr.clip() + # Refresh sprite list + self._sprites.redraw_sprites(cr=cr) + + def _destroy_cb(self, win, event): + gtk.main_quit() + + def _new_dot(self, color): + ''' generate a dot of a color color ''' + self._dot_cache = {} + if not color in self._dot_cache: + self._stroke = color + self._fill = color + self._svg_width = self._dot_size + self._svg_height = self._dot_size + pixbuf = svg_str_to_pixbuf( + self._header() + \ + self._circle(self._dot_size / 2., self._dot_size / 2., + self._dot_size / 2.) + \ + self._footer()) + + surface = cairo.ImageSurface(cairo.FORMAT_ARGB32, + self._svg_width, self._svg_height) + context = cairo.Context(surface) + context = gtk.gdk.CairoContext(context) + context.set_source_pixbuf(pixbuf, 0, 0) + context.rectangle(0, 0, self._svg_width, self._svg_height) + context.fill() + self._dot_cache[color] = surface + + return self._dot_cache[color] + + def _header(self): + return '\n' + + def _circle(self, r, cx, cy): + return '\n' + + def _footer(self): + return '\n' + + +def svg_str_to_pixbuf(svg_string): + """ Load pixbuf from SVG string """ + pl = gtk.gdk.PixbufLoader('svg') + pl.write(svg_string) + pl.close() + pixbuf = pl.get_pixbuf() + return pixbuf diff --git a/icons/example.svg b/icons/example.svg new file mode 100644 index 0000000..787b797 --- /dev/null +++ b/icons/example.svg @@ -0,0 +1,18 @@ + + + + + + + diff --git a/icons/false.svg b/icons/false.svg new file mode 100644 index 0000000..dab4ae2 --- /dev/null +++ b/icons/false.svg @@ -0,0 +1,6 @@ + + +]> + + \ No newline at end of file diff --git a/icons/new-game.svg b/icons/new-game.svg new file mode 100644 index 0000000..ba2a34a --- /dev/null +++ b/icons/new-game.svg @@ -0,0 +1,91 @@ + + + +image/svg+xml + + + + + + + + + + + + + \ No newline at end of file diff --git a/icons/resume-play.svg b/icons/resume-play.svg new file mode 100644 index 0000000..23610c9 --- /dev/null +++ b/icons/resume-play.svg @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/icons/true.svg b/icons/true.svg new file mode 100644 index 0000000..69e5a2a --- /dev/null +++ b/icons/true.svg @@ -0,0 +1,6 @@ + + +]> + + \ No newline at end of file diff --git a/po/Deducto.pot b/po/Deducto.pot new file mode 100644 index 0000000..48c3995 --- /dev/null +++ b/po/Deducto.pot @@ -0,0 +1,110 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER +# This file is distributed under the same license as the PACKAGE package. +# FIRST AUTHOR , YEAR. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: PACKAGE VERSION\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2012-03-15 10:18-0400\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"Language: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" + +#: activity/activity.info:2 +msgid "Deducto" +msgstr "" + +#: DeductoActivity.py:89 +#, python-format +msgid "Resuming level %d" +msgstr "" + +#: DeductoActivity.py:117 +msgid "Game" +msgstr "" + +#: DeductoActivity.py:124 +msgid "Start a new game." +msgstr "" + +#: DeductoActivity.py:131 DeductoActivity.py:237 +msgid "The pattern matches the rule." +msgstr "" + +#: DeductoActivity.py:135 DeductoActivity.py:239 +msgid "The pattern does not match the rule." +msgstr "" + +#: DeductoActivity.py:142 DeductoActivity.py:235 +msgid "Explore some examples." +msgstr "" + +#: DeductoActivity.py:152 +msgid "Load a custom level." +msgstr "" + +#: DeductoActivity.py:170 +msgid "Game over." +msgstr "" + +#: DeductoActivity.py:174 +#, python-format +msgid "Playing level %d" +msgstr "" + +#: DeductoActivity.py:181 DeductoActivity.py:203 +msgid "Click on new game button to begin." +msgstr "" + +#: DeductoActivity.py:192 DeductoActivity.py:213 +#, python-format +msgid "%d correct answers." +msgstr "" + +#: DeductoActivity.py:195 +msgid "Pattern was false." +msgstr "" + +#: DeductoActivity.py:216 +msgid "Pattern was true." +msgstr "" + +#: DeductoActivity.py:225 +msgid "Resume play" +msgstr "" + +#: DeductoActivity.py:227 +msgid "Show a pattern that matches the rule." +msgstr "" + +#: DeductoActivity.py:229 +msgid "Show a pattern that does not match the rule." +msgstr "" + +#: DeductoActivity.py:231 +msgid "Explore patterns with the ☑ and ☒ buttons" +msgstr "" + +#: DeductoActivity.py:240 +#, python-format +msgid "playing level %s" +msgstr "" + +#: DeductoActivity.py:247 +msgid "Load a \"True\" pattern generator from the journal" +msgstr "" + +#: DeductoActivity.py:254 +msgid "Load a \"False\" pattern generator from the journal" +msgstr "" + +#: DeductoActivity.py:260 +msgid "New level added" +msgstr "" diff --git a/setup.py b/setup.py new file mode 100755 index 0000000..e5026ee --- /dev/null +++ b/setup.py @@ -0,0 +1,32 @@ +#!/usr/bin/env python +import os +import sys + +if len(sys.argv) > 1 and '--no-sugar' == sys.argv[1]: + # Remove the argument from the stack so we don't cause problems + # for distutils + sys.argv.pop(1) + + import glob, os.path, string + from distutils.core import setup + + DATA_FILES = [ + ('icons', glob.glob('icons/*')), + ('images', glob.glob('images/*')), + ('/usr/share/applications', ['turtleart.desktop']) + ] + + setup (name = 'Turtle Art', + description = "A LOGO-like tool for teaching programming", + author = "Walter Bender", + author_email = "walter.bender@gmail.com", + version = '0.9.4', + packages = ['TurtleArt'], + scripts = ['turtleart'], + data_files = DATA_FILES, + ) +else: + from sugar.activity import bundlebuilder + + if __name__ == "__main__": + bundlebuilder.start() diff --git a/sprites.py b/sprites.py new file mode 100644 index 0000000..2b8bb55 --- /dev/null +++ b/sprites.py @@ -0,0 +1,459 @@ +# -*- coding: utf-8 -*- + +#Copyright (c) 2007-8, Playful Invention Company. +#Copyright (c) 2008-11 Walter Bender + +#Permission is hereby granted, free of charge, to any person obtaining a copy +#of this software and associated documentation files (the "Software"), to deal +#in the Software without restriction, including without limitation the rights +#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +#copies of the Software, and to permit persons to whom the Software is +#furnished to do so, subject to the following conditions: + +#The above copyright notice and this permission notice shall be included in +#all copies or substantial portions of the Software. + +#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +#THE SOFTWARE. + +''' + +sprites.py is a simple sprites library for managing graphics objects, +'sprites', on a gtk.DrawingArea. It manages multiple sprites with +methods such as move, hide, set_layer, etc. + +There are two classes: + +class Sprites maintains a collection of sprites +class Sprite manages individual sprites within the collection. + +Example usage: + # Import the classes into your program. + from sprites import Sprites Sprite + + # Create a new sprite collection associated with your widget + self.sprite_list = Sprites(widget) + + # Create a "pixbuf" (in this example, from SVG). + my_pixbuf = svg_str_to_pixbuf("...some svg code...") + + # Create a sprite at position x1, y1. + my_sprite = sprites.Sprite(self.sprite_list, x1, y1, my_pixbuf) + + # Move the sprite to a new position. + my_sprite.move((x1+dx, y1+dy)) + + # Create another "pixbuf". + your_pixbuf = svg_str_to_pixbuf("...some svg code...") + + # Create a sprite at position x2, y2. + your_sprite = sprites.Sprite(self.sprite_list, x2, y2, my_pixbuf) + + # Assign the sprites to layers. + # In this example, your_sprite will be on top of my_sprite. + my_sprite.set_layer(100) + your_sprite.set_layer(200) + + # Now put my_sprite on top of your_sprite. + my_sprite.set_layer(300) + + cr = self.window.cairo_create() + # In your activity's do_expose_event, put in a call to redraw_sprites + self.sprites.redraw_sprites(event.area, cairo_context) + +# method for converting SVG to a gtk pixbuf +def svg_str_to_pixbuf(svg_string): + pl = gtk.gdk.PixbufLoader('svg') + pl.write(svg_string) + pl.close() + pixbuf = pl.get_pixbuf() + return pixbuf + +''' + +import pygtk +pygtk.require('2.0') +import gtk +import pango +import pangocairo +import cairo + +class Sprites: + ''' A class for the list of sprites and everything they share in common ''' + + def __init__(self, widget): + ''' Initialize an empty array of sprites ''' + self.widget = widget + self.list = [] + self.cr = None + + def set_cairo_context(self, cr): + ''' Cairo context may be set or reset after __init__ ''' + self.cr = cr + + def get_sprite(self, i): + ''' Return a sprint from the array ''' + if i < 0 or i > len(self.list) - 1: + return(None) + else: + return(self.list[i]) + + def length_of_list(self): + ''' How many sprites are there? ''' + return(len(self.list)) + + def append_to_list(self, spr): + ''' Append a new sprite to the end of the list. ''' + self.list.append(spr) + + def insert_in_list(self, spr, i): + ''' Insert a sprite at position i. ''' + if i < 0: + self.list.insert(0, spr) + elif i > len(self.list) - 1: + self.list.append(spr) + else: + self.list.insert(i, spr) + + def remove_from_list(self, spr): + ''' Remove a sprite from the list. ''' + if spr in self.list: + self.list.remove(spr) + + def find_sprite(self, pos, inverse=False): + ''' Search based on (x, y) position. Return the 'top/first' one. ''' + list = self.list[:] + if not inverse: + list.reverse() + for spr in list: + if spr.hit(pos): + return spr + return None + + def redraw_sprites(self, area=None, cr=None): + ''' Redraw the sprites that intersect area. ''' + # I think I need to do this to save Cairo some work + if cr is None: + cr = self.cr + else: + self.cr = cr + if cr is None: + print 'sprites.redraw_sprites: no Cairo context' + return + for spr in self.list: + if area == None: + spr.draw(cr=cr) + else: + intersection = spr.rect.intersect(area) + if intersection.width > 0 or intersection.height > 0: + spr.draw(cr=cr) + + +class Sprite: + ''' A class for the individual sprites ''' + + def __init__(self, sprites, x, y, image): + ''' Initialize an individual sprite ''' + self._sprites = sprites + self.save_xy = (x, y) # remember initial (x, y) position + self.rect = gtk.gdk.Rectangle(int(x), int(y), 0, 0) + self._scale = [12] + self._rescale = [True] + self._horiz_align = ["center"] + self._vert_align = ["middle"] + self._fd = None + self._bold = False + self._italic = False + self._color = None + self._margins = [0, 0, 0, 0] + self.layer = 100 + self.labels = [] + self.cached_surfaces = [] + self._dx = [] # image offsets + self._dy = [] + self.type = None + self.set_image(image) + self._sprites.append_to_list(self) + + def set_image(self, image, i=0, dx=0, dy=0): + ''' Add an image to the sprite. ''' + while len(self.cached_surfaces) < i + 1: + self.cached_surfaces.append(None) + self._dx.append(0) + self._dy.append(0) + self._dx[i] = dx + self._dy[i] = dy + if isinstance(image, gtk.gdk.Pixbuf) or \ + isinstance(image, cairo.ImageSurface): + w = image.get_width() + h = image.get_height() + else: + w, h = image.get_size() + if i == 0: # Always reset width and height when base image changes. + self.rect.width = w + dx + self.rect.height = h + dy + else: + if w + dx > self.rect.width: + self.rect.width = w + dx + if h + dy > self.rect.height: + self.rect.height = h + dy + if isinstance(image, cairo.ImageSurface): + self.cached_surfaces[i] = image + else: # Convert to Cairo surface + surface = cairo.ImageSurface( + cairo.FORMAT_ARGB32, self.rect.width, self.rect.height) + context = cairo.Context(surface) + context = gtk.gdk.CairoContext(context) + context.set_source_pixbuf(image, 0, 0) + context.rectangle(0, 0, self.rect.width, self.rect.height) + context.fill() + self.cached_surfaces[i] = surface + + def move(self, pos): + ''' Move to new (x, y) position ''' + self.inval() + self.rect.x, self.rect.y = int(pos[0]), int(pos[1]) + self.inval() + + def move_relative(self, pos): + ''' Move to new (x+dx, y+dy) position ''' + self.inval() + self.rect.x += int(pos[0]) + self.rect.y += int(pos[1]) + self.inval() + + def get_xy(self): + ''' Return current (x, y) position ''' + return (self.rect.x, self.rect.y) + + def get_dimensions(self): + ''' Return current size ''' + return (self.rect.width, self.rect.height) + + def get_layer(self): + ''' Return current layer ''' + return self.layer + + def set_shape(self, image, i=0): + ''' Set the current image associated with the sprite ''' + self.inval() + self.set_image(image, i) + self.inval() + + def set_layer(self, layer=None): + ''' Set the layer for a sprite ''' + self._sprites.remove_from_list(self) + if layer is not None: + self.layer = layer + for i in range(self._sprites.length_of_list()): + if layer < self._sprites.get_sprite(i).layer: + self._sprites.insert_in_list(self, i) + self.inval() + return + self._sprites.append_to_list(self) + self.inval() + + def set_label(self, new_label, i=0): + ''' Set the label drawn on the sprite ''' + self._extend_labels_array(i) + if type(new_label) is str or type(new_label) is unicode: + # pango doesn't like nulls + self.labels[i] = new_label.replace("\0", " ") + else: + self.labels[i] = str(new_label) + self.inval() + + def set_margins(self, l=0, t=0, r=0, b=0): + ''' Set the margins for drawing the label ''' + self._margins = [l, t, r, b] + + def _extend_labels_array(self, i): + ''' Append to the labels attribute list ''' + if self._fd is None: + self.set_font('Sans') + if self._color is None: + self._color = (0., 0., 0.) + while len(self.labels) < i + 1: + self.labels.append(" ") + self._scale.append(self._scale[0]) + self._rescale.append(self._rescale[0]) + self._horiz_align.append(self._horiz_align[0]) + self._vert_align.append(self._vert_align[0]) + + def set_font(self, font): + ''' Set the font for a label ''' + self._fd = pango.FontDescription(font) + + def set_label_color(self, rgb): + ''' Set the font color for a label ''' + COLORTABLE = {'black': '#000000', 'white': '#FFFFFF', + 'red': '#FF0000', 'yellow': '#FFFF00', + 'green': '#00FF00', 'cyan': '#00FFFF', + 'blue': '#0000FF', 'purple': '#FF00FF', + 'gray': '#808080'} + if rgb.lower() in COLORTABLE: + rgb = COLORTABLE[rgb.lower()] + # Convert from '#RRGGBB' to floats + self._color = (int('0x' + rgb[1:3], 16) / 256., + int('0x' + rgb[3:5], 16) / 256., + int('0x' + rgb[5:7], 16) / 256.) + return + + def set_label_attributes(self, scale, rescale=True, horiz_align="center", + vert_align="middle", i=0): + ''' Set the various label attributes ''' + self._extend_labels_array(i) + self._scale[i] = scale + self._rescale[i] = rescale + self._horiz_align[i] = horiz_align + self._vert_align[i] = vert_align + + def hide(self): + ''' Hide a sprite ''' + self.inval() + self._sprites.remove_from_list(self) + + def restore(self): + ''' Restore a hidden sprite ''' + self.set_layer() + + def inval(self): + ''' Invalidate a region for gtk ''' + self._sprites.widget.queue_draw_area(self.rect.x, + self.rect.y, + self.rect.width, + self.rect.height) + + def draw(self, cr=None): + ''' Draw the sprite (and label) ''' + if cr is None: + print 'sprite.draw: no Cairo context.' + return + for i, surface in enumerate(self.cached_surfaces): + cr.set_source_surface(surface, + self.rect.x + self._dx[i], + self.rect.y + self._dy[i]) + cr.rectangle(self.rect.x + self._dx[i], + self.rect.y + self._dy[i], + self.rect.width, + self.rect.height) + cr.fill() + if len(self.labels) > 0: + self.draw_label(cr) + + def hit(self, pos): + ''' Is (x, y) on top of the sprite? ''' + x, y = pos + if x < self.rect.x: + return False + if x > self.rect.x + self.rect.width: + return False + if y < self.rect.y: + return False + if y > self.rect.y + self.rect.height: + return False + return True + + def draw_label(self, cr): + ''' Draw the label based on its attributes ''' + # Create a pangocairo context + cr = pangocairo.CairoContext(cr) + my_width = self.rect.width - self._margins[0] - self._margins[2] + if my_width < 0: + my_width = 0 + my_height = self.rect.height - self._margins[1] - self._margins[3] + for i in range(len(self.labels)): + pl = cr.create_layout() + pl.set_text(str(self.labels[i])) + self._fd.set_size(int(self._scale[i] * pango.SCALE)) + pl.set_font_description(self._fd) + w = pl.get_size()[0] / pango.SCALE + if w > my_width: + if self._rescale[i]: + self._fd.set_size( + int(self._scale[i] * pango.SCALE * my_width / w)) + pl.set_font_description(self._fd) + w = pl.get_size()[0] / pango.SCALE + else: + j = len(self.labels[i]) - 1 + while(w > my_width and j > 0): + pl.set_text( + "…" + self.labels[i][len(self.labels[i]) - j:]) + self._fd.set_size(int(self._scale[i] * pango.SCALE)) + pl.set_font_description(self._fd) + w = pl.get_size()[0] / pango.SCALE + j -= 1 + if self._horiz_align[i] == "center": + x = int(self.rect.x + self._margins[0] + (my_width - w) / 2) + elif self._horiz_align[i] == 'left': + x = int(self.rect.x + self._margins[0]) + else: # right + x = int(self.rect.x + self.rect.width - w - self._margins[2]) + h = pl.get_size()[1] / pango.SCALE + if self._vert_align[i] == "middle": + y = int(self.rect.y + self._margins[1] + (my_height - h) / 2) + elif self._vert_align[i] == "top": + y = int(self.rect.y + self._margins[1]) + else: # bottom + y = int(self.rect.y + self.rect.height - h - self._margins[3]) + cr.save() + cr.translate(x, y) + cr.set_source_rgb(self._color[0], self._color[1], self._color[2]) + cr.update_layout(pl) + cr.show_layout(pl) + cr.restore() + + def label_width(self): + ''' Calculate the width of a label ''' + cr = pangocairo.CairoContext(self._sprites.cr) + if cr is not None: + max = 0 + for i in range(len(self.labels)): + pl = cr.create_layout() + pl.set_text(self.labels[i]) + self._fd.set_size(int(self._scale[i] * pango.SCALE)) + pl.set_font_description(self._fd) + w = pl.get_size()[0] / pango.SCALE + if w > max: + max = w + return max + else: + return self.rect.width + + def label_safe_width(self): + ''' Return maximum width for a label ''' + return self.rect.width - self._margins[0] - self._margins[2] + + def label_safe_height(self): + ''' Return maximum height for a label ''' + return self.rect.height - self._margins[1] - self._margins[3] + + def label_left_top(self): + ''' Return the upper-left corner of the label safe zone ''' + return(self._margins[0], self._margins[1]) + + def get_pixel(self, pos, i=0): + ''' Return the pixel at (x, y) ''' + x = int(pos[0] - self.rect.x) + y = int(pos[1] - self.rect.y) + if x < 0 or x > (self.rect.width - 1) or \ + y < 0 or y > (self.rect.height - 1): + return(-1, -1, -1, -1) + + # create a new 1x1 cairo surface + cs = cairo.ImageSurface(cairo.FORMAT_RGB24, 1, 1); + cr = cairo.Context(cs) + cr.set_source_surface(self.cached_surfaces[i], -x, -y) + cr.rectangle(0,0,1,1) + cr.set_operator(cairo.OPERATOR_SOURCE) + cr.fill() + cs.flush() # ensure all writing is done + # Read the pixel + pixels = cs.get_data() + return (ord(pixels[2]), ord(pixels[1]), ord(pixels[0]), 0) + diff --git a/toolbar_utils.py b/toolbar_utils.py new file mode 100644 index 0000000..94e6883 --- /dev/null +++ b/toolbar_utils.py @@ -0,0 +1,164 @@ +# -*- coding: utf-8 -*- +# Copyright (c) 2011, Walter Bender + +# 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. +# +# You should have received a copy of the GNU General Public License +# along with this library; if not, write to the Free Software +# Foundation, 51 Franklin Street, Suite 500 Boston, MA 02110-1335 USA + + +import gtk + +from sugar.graphics.radiotoolbutton import RadioToolButton +from sugar.graphics.toolbutton import ToolButton +from sugar.graphics.combobox import ComboBox +from sugar.graphics.toolcombobox import ToolComboBox + + +def combo_factory(combo_array, toolbar, callback, cb_arg=None, + tooltip=None, default=None): + '''Factory for making a toolbar combo box''' + combo = ComboBox() + if tooltip is not None and hasattr(combo, 'set_tooltip_text'): + combo.set_tooltip_text(tooltip) + if cb_arg is not None: + combo.connect('changed', callback, cb_arg) + else: + combo.connect('changed', callback) + for i, selection in enumerate(combo_array): + combo.append_item(i, selection, None) + combo.show() + toolitem = gtk.ToolItem() + toolitem.add(combo) + if hasattr(toolbar, 'insert'): # the main toolbar + toolbar.insert(toolitem, -1) + else: # or a secondary toolbar + toolbar.props.page.insert(toolitem, -1) + toolitem.show() + if default is not None: + combo.set_active(combo_array.index(default)) + return combo + + +def entry_factory(default_string, toolbar, tooltip=None, max=3): + ''' Factory for adding a text box to a toolbar ''' + entry = gtk.Entry() + entry.set_text(default_string) + if tooltip is not None and hasattr(entry, 'set_tooltip_text'): + entry.set_tooltip_text(tooltip) + entry.set_width_chars(max) + entry.show() + toolitem = gtk.ToolItem() + toolitem.add(entry) + if hasattr(toolbar, 'insert'): # the main toolbar + toolbar.insert(toolitem, -1) + else: # or a secondary toolbar + toolbar.props.page.insert(toolitem, -1) + toolitem.show() + return entry + + +def button_factory(icon_name, toolbar, callback, cb_arg=None, tooltip=None, + accelerator=None): + '''Factory for making tooplbar buttons''' + button = ToolButton(icon_name) + if tooltip is not None: + button.set_tooltip(tooltip) + button.props.sensitive = True + if accelerator is not None: + button.props.accelerator = accelerator + if cb_arg is not None: + button.connect('clicked', callback, cb_arg) + else: + button.connect('clicked', callback) + if hasattr(toolbar, 'insert'): # the main toolbar + toolbar.insert(button, -1) + else: # or a secondary toolbar + toolbar.props.page.insert(button, -1) + button.show() + return button + + +def radio_factory(name, toolbar, callback, cb_arg=None, tooltip=None, + group=None): + ''' Add a radio button to a toolbar ''' + button = RadioToolButton(group=group) + button.set_named_icon(name) + if callback is not None: + if cb_arg is None: + button.connect('clicked', callback) + else: + button.connect('clicked', callback, cb_arg) + if hasattr(toolbar, 'insert'): # Add button to the main toolbar... + toolbar.insert(button, -1) + else: # ...or a secondary toolbar. + toolbar.props.page.insert(button, -1) + button.show() + if tooltip is not None: + button.set_tooltip(tooltip) + return button + + +def label_factory(toolbar, label_text, width=None): + ''' Factory for adding a label to a toolbar ''' + label = gtk.Label(label_text) + label.set_line_wrap(True) + if width is not None: + label.set_size_request(width, -1) # doesn't work on XOs + label.show() + toolitem = gtk.ToolItem() + toolitem.add(label) + if hasattr(toolbar, 'insert'): # the main toolbar + toolbar.insert(toolitem, -1) + else: # or a secondary toolbar + toolbar.props.page.insert(toolitem, -1) + toolitem.show() + return label + + +def separator_factory(toolbar, expand=False, visible=True): + ''' add a separator to a toolbar ''' + separator = gtk.SeparatorToolItem() + separator.props.draw = visible + separator.set_expand(expand) + if hasattr(toolbar, 'insert'): # the main toolbar + toolbar.insert(separator, -1) + else: # or a secondary toolbar + toolbar.props.page.insert(separator, -1) + separator.show() + + +def image_factory(image, toolbar, tooltip=None): + ''' Add an image to the toolbar ''' + img = gtk.Image() + img.set_from_pixbuf(image) + img_tool = gtk.ToolItem() + img_tool.add(img) + if tooltip is not None: + img.set_tooltip_text(tooltip) + if hasattr(toolbar, 'insert'): # the main toolbar + toolbar.insert(img_tool, -1) + else: # or a secondary toolbar + toolbar.props.page.insert(img_tool, -1) + img_tool.show() + return img + + +def spin_factory(default, min, max, callback, toolbar): + spin_adj = gtk.Adjustment(default, min, max, 1, 32, 0) + spin = gtk.SpinButton(spin_adj, 0, 0) + spin_id = spin.connect('value-changed', callback) + spin.set_numeric(True) + spin.show() + toolitem = gtk.ToolItem() + toolitem.add(spin) + if hasattr(toolbar, 'insert'): # the main toolbar + toolbar.insert(toolitem, -1) + else: + toolbar.props.page.insert(toolitem, -1) + toolitem.show() + return spin diff --git a/utils.py b/utils.py new file mode 100644 index 0000000..ffab831 --- /dev/null +++ b/utils.py @@ -0,0 +1,53 @@ +#Copyright (c) 2011 Walter Bender + +# 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. +# +# You should have received a copy of the GNU General Public License +# along with this library; if not, write to the Free Software +# Foundation, 51 Franklin Street, Suite 500 Boston, MA 02110-1335 USA + + +from StringIO import StringIO +try: + OLD_SUGAR_SYSTEM = False + import json + json.dumps + from json import load as jload + from json import dump as jdump +except (ImportError, AttributeError): + try: + import simplejson as json + from simplejson import load as jload + from simplejson import dump as jdump + except: + OLD_SUGAR_SYSTEM = True + + +def json_load(text): + """ Load JSON data using what ever resources are available. """ + if OLD_SUGAR_SYSTEM is True: + listdata = json.read(text) + else: + # strip out leading and trailing whitespace, nulls, and newlines + io = StringIO(text) + try: + listdata = jload(io) + except ValueError: + # assume that text is ascii list + listdata = text.split() + for i, value in enumerate(listdata): + listdata[i] = int(value) + return listdata + + +def json_dump(data): + """ Save data using available JSON tools. """ + if OLD_SUGAR_SYSTEM is True: + return json.write(data) + else: + _io = StringIO() + jdump(data, _io) + return _io.getvalue() -- cgit v0.9.1