├── .gitignore ├── COPYING ├── README.md ├── demo1.py ├── demo2.py ├── demo3.py ├── demo4.py ├── demo5.py ├── demo6.py ├── setup.py └── textland ├── __init__.py ├── abc.py ├── bits.py ├── display.py ├── drawing.py ├── events.py ├── image.py └── keys.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.egg-info 2 | *.pyc 3 | __pycache__ 4 | build 5 | dist 6 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | TextLand 2 | ======== 3 | 4 | TextLand is a portable console textual frame-buffer-like display system. It 5 | offers portable character-attribute matrix and input event system. TextLand is 6 | not a widget library, it doesn't have concepts of windows, buttons or labels. 7 | Any widget library that can render to TextLand buffers can be used to build 8 | classical text widget applications. 9 | 10 | Example 11 | ======= 12 | 13 | See demos in the top-level directory 14 | 15 | Environment 16 | =========== 17 | 18 | TEXTLAND_DISPLAY can be set to one of the following strings: 19 | 20 | * ``curses`` (default): to use the ncurses interface 21 | * ``print``: to use portable printer 80x25 "display" 22 | * ``test``: to use a off-screen display that replays injected test events and 23 | records all the screens that were "displayed" 24 | 25 | Supported Platforms 26 | =================== 27 | 28 | Linux: 29 | Keyboard events, display resize events, no mouse events yet. Bold, 30 | underline and reverse video character attributes. Standard 16+8 colors 31 | available (foreground+background). 32 | 33 | Windows: 34 | Port is in the works, text display and console attributes work. Mouse 35 | events and resize events are in the works. 36 | 37 | OSX: 38 | Same as Linux with the exception of the display resize event which is not 39 | supported in the same way on the OSX curses library. Should be fixed later 40 | on but there is no active OSX developer yet. 41 | -------------------------------------------------------------------------------- /demo1.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # This file is part of textland. 3 | # 4 | # Copyright 2014 Canonical Ltd. 5 | # Written by: 6 | # Zygmunt Krynicki 7 | # 8 | # Textland is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License version 3, 10 | # as published by the Free Software Foundation. 11 | # 12 | # Textland is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Textland. If not, see . 19 | import argparse 20 | 21 | from textland import DrawingContext 22 | from textland import EVENT_KEYBOARD 23 | from textland import EVENT_RESIZE 24 | from textland import Event 25 | from textland import IApplication 26 | from textland import KeyboardData 27 | from textland import Size 28 | from textland import TextImage 29 | from textland import get_display 30 | 31 | 32 | class DemoApp(IApplication): 33 | 34 | def __init__(self): 35 | self.image = TextImage(Size(0, 0)) 36 | 37 | def consume_event(self, event: Event): 38 | if event.kind == EVENT_RESIZE: 39 | self.image = TextImage(event.data) # data is the new size 40 | elif event.kind == EVENT_KEYBOARD and event.data.key == 'q': 41 | raise StopIteration 42 | self.repaint(event) 43 | return self.image 44 | 45 | def repaint(self, event: Event): 46 | # Draw something on the image 47 | ctx = DrawingContext(self.image) 48 | ctx.fill('.') 49 | title = "TextLand Demo Application" 50 | ctx.move_to((self.image.size.width - len(title)) // 2, 0) 51 | ctx.print(title) 52 | ctx.print('=' * len(title)) 53 | ctx.move_to(0, 3) 54 | ctx.print("Type 'q' to quit") 55 | ctx.move_to(10, 10) 56 | ctx.print("Event: {}".format(event)) 57 | 58 | 59 | def main(): 60 | parser = argparse.ArgumentParser() 61 | parser.set_defaults(display=None) 62 | parser.add_argument( 63 | '--curses', 64 | help="Use curses for display", 65 | action="store_const", 66 | const="curses", 67 | dest="display") 68 | parser.add_argument( 69 | '--print', 70 | help="Use simple line printer for display", 71 | action="store_const", 72 | const="print", 73 | dest="display") 74 | parser.add_argument( 75 | "--test", 76 | help="Use test display (just for testing)", 77 | action="store_const", 78 | const="test", 79 | dest="display") 80 | ns = parser.parse_args() 81 | display = get_display(ns.display) 82 | if ns.display == 'test': 83 | display.inject_event(Event(EVENT_KEYBOARD, KeyboardData('x'))) 84 | display.inject_event(Event(EVENT_KEYBOARD, KeyboardData('y'))) 85 | display.inject_event(Event(EVENT_KEYBOARD, KeyboardData('q'))) 86 | display.run(DemoApp()) 87 | if ns.display == 'test': 88 | for frame, image in enumerate(display.screen_log, 1): 89 | print("Frame {}:".format(frame)) 90 | image.print_frame() 91 | 92 | 93 | if __name__ == "__main__": 94 | main() 95 | -------------------------------------------------------------------------------- /demo2.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # This file is part of textland. 3 | # 4 | # Copyright 2014 Canonical Ltd. 5 | # Written by: 6 | # Zygmunt Krynicki 7 | # 8 | # Textland is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License version 3, 10 | # as published by the Free Software Foundation. 11 | # 12 | # Textland is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Textland. If not, see . 19 | from textland import DrawingContext 20 | from textland import EVENT_KEYBOARD 21 | from textland import EVENT_RESIZE 22 | from textland import Event 23 | from textland import IApplication 24 | from textland import Size 25 | from textland import TextImage 26 | from textland import get_display 27 | 28 | 29 | class DemoApp(IApplication): 30 | 31 | def __init__(self): 32 | self.image = TextImage(Size(0, 0)) 33 | 34 | def consume_event(self, event: Event): 35 | if event.kind == EVENT_RESIZE: 36 | self.image = TextImage(event.data) # data is the new size 37 | elif event.kind == EVENT_KEYBOARD and event.data.key == 'q': 38 | raise StopIteration 39 | self.repaint(event) 40 | return self.image 41 | 42 | def repaint(self, event: Event): 43 | # Draw something on the image 44 | ctx = DrawingContext(self.image) 45 | ctx.fill('#') 46 | text = "1234567890" 47 | for i in range(min(self.image.size.width, self.image.size.height)): 48 | ctx.fill(text[i % len(text)]) 49 | ctx.clip_by(1, 1, -1, -1) 50 | 51 | 52 | def main(): 53 | display = get_display() 54 | display.run(DemoApp()) 55 | 56 | 57 | if __name__ == "__main__": 58 | main() 59 | -------------------------------------------------------------------------------- /demo3.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # This file is part of textland. 3 | # 4 | # Copyright 2014 Canonical Ltd. 5 | # Written by: 6 | # Zygmunt Krynicki 7 | # 8 | # Textland is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License version 3, 10 | # as published by the Free Software Foundation. 11 | # 12 | # Textland is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Textland. If not, see . 19 | 20 | from textland import DrawingContext 21 | from textland import EVENT_KEYBOARD 22 | from textland import EVENT_RESIZE 23 | from textland import Event 24 | from textland import IApplication 25 | from textland import Size 26 | from textland import TextImage 27 | from textland import get_display 28 | 29 | 30 | class DemoApp(IApplication): 31 | 32 | def __init__(self): 33 | self.image = TextImage(Size(0, 0)) 34 | 35 | def consume_event(self, event: Event): 36 | if event.kind == EVENT_RESIZE: 37 | self.image = TextImage(event.data) # data is the new size 38 | elif event.kind == EVENT_KEYBOARD and event.data.key == 'q': 39 | raise StopIteration 40 | self.repaint(event) 41 | return self.image 42 | 43 | def repaint(self, event: Event): 44 | # Draw something on the image 45 | ctx = DrawingContext(self.image) 46 | ctx.fill(' ') 47 | for y in range(self.image.size.height): 48 | ctx.move_to(0, y) 49 | if y % 10 == 0: 50 | ctx.print('---') 51 | if y > 0: 52 | ctx.move_to(4, y) 53 | ctx.print("{:-2d}".format(y)) 54 | else: 55 | ctx.print('-') 56 | text = "TextLand Ruler" 57 | ctx.move_to( 58 | (self.image.size.width - len(text)) // 2, 59 | self.image.size.height // 2) 60 | ctx.print(text) 61 | 62 | 63 | def main(): 64 | display = get_display() 65 | display.run(DemoApp()) 66 | 67 | 68 | if __name__ == "__main__": 69 | main() 70 | -------------------------------------------------------------------------------- /demo4.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # This file is part of textland. 3 | # 4 | # Copyright 2014 Canonical Ltd. 5 | # Written by: 6 | # Sylvain Pineau 7 | # 8 | # Textland is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License version 3, 10 | # as published by the Free Software Foundation. 11 | # 12 | # Textland is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Textland. If not, see . 19 | from textland import DrawingContext 20 | from textland import BRIGHT_GREEN 21 | from textland import EVENT_KEYBOARD 22 | from textland import EVENT_RESIZE 23 | from textland import Event 24 | from textland import IApplication 25 | from textland import RED 26 | from textland import REVERSE 27 | from textland import Size 28 | from textland import TextImage 29 | from textland import UNDERLINE 30 | from textland import get_display 31 | 32 | 33 | class DemoApp(IApplication): 34 | 35 | def __init__(self): 36 | self.image = TextImage(Size(0, 0)) 37 | 38 | def consume_event(self, event: Event): 39 | if event.kind == EVENT_RESIZE: 40 | self.image = TextImage(event.data) # data is the new size 41 | elif event.kind == EVENT_KEYBOARD and event.data.key == 'q': 42 | raise StopIteration 43 | self.repaint(event) 44 | return self.image 45 | 46 | def repaint(self, event: Event): 47 | # Draw something on the image 48 | ctx = DrawingContext(self.image) 49 | title = "TextLand Cell Character Attribute and Colors Demo Application" 50 | ctx.move_to((self.image.size.width - len(title)) // 2, 0) 51 | ctx.print(title) 52 | ctx.print('=' * len(title)) 53 | ctx.move_to(0, 3) 54 | ctx.attributes.fg = BRIGHT_GREEN 55 | ctx.attributes.bg = RED 56 | ctx.print("Type 'q' to quit") 57 | ctx.attributes.reset() 58 | ctx.move_to(10, 6) 59 | ctx.attributes.style = REVERSE 60 | ctx.print("REVERSE") 61 | ctx.move_to(10, 7) 62 | ctx.attributes.style = UNDERLINE 63 | ctx.print("UNDERLINE") 64 | ctx.move_to(10, 8) 65 | ctx.attributes.style = UNDERLINE | REVERSE 66 | ctx.print("BOTH") 67 | 68 | 69 | def main(): 70 | display = get_display() 71 | display.run(DemoApp()) 72 | 73 | 74 | if __name__ == "__main__": 75 | main() 76 | -------------------------------------------------------------------------------- /demo5.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # This file is part of textland. 3 | # 4 | # Copyright 2014 Canonical Ltd. 5 | # Written by: 6 | # Zygmunt Krynicki 7 | # 8 | # Textland is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License version 3, 10 | # as published by the Free Software Foundation. 11 | # 12 | # Textland is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Textland. If not, see . 19 | from textland import DrawingContext 20 | from textland import EVENT_KEYBOARD 21 | from textland import EVENT_RESIZE 22 | from textland import Event 23 | from textland import IApplication 24 | from textland import Size 25 | from textland import TextImage 26 | from textland import get_display 27 | 28 | 29 | class DemoApp(IApplication): 30 | 31 | def __init__(self): 32 | self.image = TextImage(Size(0, 0)) 33 | 34 | def consume_event(self, event: Event): 35 | if event.kind == EVENT_RESIZE: 36 | self.image = TextImage(event.data) # data is the new size 37 | elif event.kind == EVENT_KEYBOARD and event.data.key == 'q': 38 | raise StopIteration 39 | self.repaint(event) 40 | return self.image 41 | 42 | def repaint(self, event: Event): 43 | ctx = DrawingContext(self.image) 44 | ctx.border() 45 | 46 | 47 | def main(): 48 | display = get_display() 49 | display.run(DemoApp()) 50 | 51 | 52 | if __name__ == "__main__": 53 | main() 54 | -------------------------------------------------------------------------------- /demo6.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # This file is part of textland. 3 | # 4 | # Copyright 2014 Canonical Ltd. 5 | # Written by: 6 | # Zygmunt Krynicki 7 | # 8 | # Textland is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License version 3, 10 | # as published by the Free Software Foundation. 11 | # 12 | # Textland is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Textland. If not, see . 19 | from textland import DrawingContext 20 | from textland import EVENT_KEYBOARD 21 | from textland import EVENT_RESIZE 22 | from textland import Event 23 | from textland import IApplication 24 | from textland import Size 25 | from textland import TextImage 26 | from textland import get_display 27 | 28 | 29 | class DemoApp(IApplication): 30 | 31 | def __init__(self): 32 | self.image = TextImage(Size(0, 0)) 33 | 34 | def consume_event(self, event: Event): 35 | if event.kind == EVENT_RESIZE: 36 | self.image = TextImage(event.data) # data is the new size 37 | elif event.kind == EVENT_KEYBOARD and event.data.key == 'q': 38 | raise StopIteration 39 | self.repaint(event) 40 | return self.image 41 | 42 | def repaint(self, event: Event) -> None: 43 | ctx = DrawingContext(self.image) 44 | if self.image.size.width < 65 or self.image.size.height < 18: 45 | self._paint_resize_msg(ctx) 46 | else: 47 | self._paint_color_table(ctx) 48 | 49 | def _paint_color_table(self, ctx: DrawingContext) -> None: 50 | CELL_WIDTH = 4 51 | NUM_COLORS = 16 52 | for fg in range(NUM_COLORS): 53 | for bg in range(NUM_COLORS): 54 | ctx.attributes.reset() 55 | ctx.border( 56 | 0, self.image.size.width - (NUM_COLORS * CELL_WIDTH) - 1, 57 | 0, self.image.size.height - NUM_COLORS - 2) 58 | ctx.move_to(1 + fg * CELL_WIDTH, 1 + bg) 59 | ctx.attributes.fg = fg 60 | ctx.attributes.bg = bg 61 | ctx.print("{:X}+{:X}".format(fg, bg)) 62 | 63 | def _paint_resize_msg(self, ctx: DrawingContext) -> None: 64 | text = "Please enlarge this window" 65 | ctx.move_to( 66 | (self.image.size.width - len(text)) // 2, 67 | self.image.size.height // 2) 68 | ctx.print(text) 69 | 70 | 71 | def main(): 72 | display = get_display() 73 | display.run(DemoApp()) 74 | 75 | 76 | if __name__ == "__main__": 77 | main() 78 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # This file is part of textland. 3 | # 4 | # Copyright 2014 Canonical Ltd. 5 | # Written by: 6 | # Zygmunt Krynicki 7 | # 8 | # Textland is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License version 3, 10 | # as published by the Free Software Foundation. 11 | # 12 | # Textland is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Textland. If not, see . 19 | 20 | import os 21 | 22 | from setuptools import setup, find_packages 23 | 24 | base_dir = os.path.dirname(__file__) 25 | 26 | # Load the README.rst file relative to the setup file 27 | with open(os.path.join(base_dir, "README.md"), encoding="UTF-8") as stream: 28 | long_description = stream.read() 29 | 30 | 31 | setup( 32 | name="textland", 33 | version="0.1", 34 | url="https://github.com/zyga/textland", 35 | packages=find_packages(), 36 | author="Zygmunt Krynicki", 37 | author_email="zygmunt.krynicki@canonical.com", 38 | license="GPLv3", 39 | description="Like wayland, for text apps", 40 | long_description=long_description) 41 | -------------------------------------------------------------------------------- /textland/__init__.py: -------------------------------------------------------------------------------- 1 | # This file is part of textland. 2 | # 3 | # Copyright 2014 Canonical Ltd. 4 | # Written by: 5 | # Zygmunt Krynicki 6 | # 7 | # Textland is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 3, 9 | # as published by the Free Software Foundation. 10 | # 11 | # Textland is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Textland. If not, see . 18 | 19 | """ 20 | Text Land 21 | ========= 22 | """ 23 | 24 | __version__ = (0, 1, 0, "final", 0) 25 | 26 | __all__ = [ 27 | 'BLACK', 28 | 'BLUE', 29 | 'BRIGHT_BLACK', 30 | 'BRIGHT_BLUE', 31 | 'BRIGHT_CYAN', 32 | 'BRIGHT_GREEN', 33 | 'BRIGHT_MAGENTA', 34 | 'BRIGHT_RED', 35 | 'BRIGHT_WHITE', 36 | 'BRIGHT_YELLOW', 37 | 'CYAN', 38 | 'Cell', 39 | 'DrawingContext', 40 | 'EVENT_KEYBOARD', 41 | 'EVENT_MOUSE', 42 | 'EVENT_RESIZE', 43 | 'Event', 44 | 'GREEN', 45 | 'IApplication', 46 | 'IDisplay', 47 | 'KeyboardData', 48 | 'MAGENTA', 49 | 'MouseData', 50 | 'NORMAL', 51 | 'RED', 52 | 'REVERSE', 53 | 'Rect', 54 | 'Size', 55 | 'TestDisplay', 56 | 'TextAttributes', 57 | 'TextImage', 58 | 'UNDERLINE', 59 | 'WHITE', 60 | 'YELLOW', 61 | '__version__', 62 | 'get_display', 63 | ] 64 | 65 | from .abc import IApplication 66 | from .abc import IDisplay 67 | from .bits import Cell 68 | from .bits import Rect 69 | from .bits import Size 70 | from .display import TestDisplay 71 | from .display import get_display 72 | from .drawing import DrawingContext 73 | from .events import EVENT_KEYBOARD 74 | from .events import EVENT_MOUSE 75 | from .events import EVENT_RESIZE 76 | from .events import Event 77 | from .events import KeyboardData 78 | from .events import MouseData 79 | from .image import BLACK 80 | from .image import BLUE 81 | from .image import BRIGHT_BLACK 82 | from .image import BRIGHT_BLUE 83 | from .image import BRIGHT_CYAN 84 | from .image import BRIGHT_GREEN 85 | from .image import BRIGHT_MAGENTA 86 | from .image import BRIGHT_RED 87 | from .image import BRIGHT_WHITE 88 | from .image import BRIGHT_YELLOW 89 | from .image import CYAN 90 | from .image import GREEN 91 | from .image import MAGENTA 92 | from .image import NORMAL 93 | from .image import RED 94 | from .image import REVERSE 95 | from .image import TextAttributes 96 | from .image import TextImage 97 | from .image import UNDERLINE 98 | from .image import WHITE 99 | from .image import YELLOW 100 | -------------------------------------------------------------------------------- /textland/abc.py: -------------------------------------------------------------------------------- 1 | # This file is part of textland. 2 | # 3 | # Copyright 2014 Canonical Ltd. 4 | # Written by: 5 | # Zygmunt Krynicki 6 | # 7 | # Textland is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 3, 9 | # as published by the Free Software Foundation. 10 | # 11 | # Textland is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Textland. If not, see . 18 | 19 | from abc import abstractmethod, ABCMeta 20 | 21 | from .bits import Size 22 | from .events import Event 23 | from .image import TextImage 24 | 25 | 26 | class IApplication(metaclass=ABCMeta): 27 | """ 28 | Interface for all applications. 29 | 30 | Applications are simple objects that react to events by repainting 31 | their buffer. Each application has exactly one full-screen buffer. 32 | """ 33 | 34 | @abstractmethod 35 | def consume_event(self, event: Event) -> TextImage: 36 | """ 37 | Send an event to the controller. 38 | 39 | :param event: 40 | Event that the controller should handle 41 | 42 | This method is called whenever the application should react to an 43 | event. The application may raise StopIteration to ask the display to 44 | exit. 45 | """ 46 | 47 | 48 | # TODO: this is mis-named, rename it 49 | class IDisplay(metaclass=ABCMeta): 50 | """ 51 | Abstract display system. 52 | """ 53 | 54 | @abstractmethod 55 | def run(self, app: IApplication) -> None: 56 | """ 57 | Run forever, feeding events to the controller 58 | the controller can raise StopIteration to "quit" 59 | """ 60 | 61 | 62 | class IView(metaclass=ABCMeta): 63 | """ 64 | Work-in-progress on views that applications can use 65 | """ 66 | 67 | @abstractmethod 68 | def render(self, size: Size) -> TextImage: 69 | """ 70 | Render this view to a new image of the specified size 71 | """ 72 | -------------------------------------------------------------------------------- /textland/bits.py: -------------------------------------------------------------------------------- 1 | # This file is part of textland. 2 | # 3 | # Copyright 2014 Canonical Ltd. 4 | # Written by: 5 | # Zygmunt Krynicki 6 | # 7 | # Textland is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 3, 9 | # as published by the Free Software Foundation. 10 | # 11 | # Textland is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Textland. If not, see . 18 | 19 | from collections import namedtuple 20 | 21 | # Various sizing structs 22 | Cell = namedtuple('Cell', ['char', 'attributes']) 23 | Size = namedtuple('Size', ['width', 'height']) 24 | Offset = namedtuple('Offset', ['x', 'y']) 25 | Rect = namedtuple('Rect', ['x1', 'y1', 'x2', 'y2']) 26 | -------------------------------------------------------------------------------- /textland/display.py: -------------------------------------------------------------------------------- 1 | # This file is part of textland. 2 | # 3 | # Copyright 2014 Canonical Ltd. 4 | # Written by: 5 | # Zygmunt Krynicki 6 | # 7 | # Textland is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 3, 9 | # as published by the Free Software Foundation. 10 | # 11 | # Textland is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Textland. If not, see . 18 | 19 | from abc import abstractmethod 20 | from collections import deque 21 | from copy import deepcopy 22 | from os import getenv 23 | 24 | from . import keys 25 | from .abc import IApplication 26 | from .abc import IDisplay 27 | from .bits import Size 28 | from .events import EVENT_KEYBOARD, EVENT_RESIZE 29 | from .events import Event, KeyboardData 30 | from .image import BLACK 31 | from .image import REVERSE 32 | from .image import TextAttributes 33 | from .image import TextImage 34 | from .image import UNDERLINE 35 | from .image import WHITE 36 | 37 | 38 | class AbstractDisplay(IDisplay): 39 | """ 40 | Abstract display class. 41 | """ 42 | 43 | def run(self, app: IApplication) -> None: 44 | """ 45 | Run forever, feeding events to the controller 46 | the controller can raise StopIteration to "quit" 47 | """ 48 | # Tell the app abount the initial size 49 | size = self.get_display_size() 50 | try: 51 | image = app.consume_event(Event(EVENT_RESIZE, size)) 52 | self.display_image(image) 53 | except StopIteration: 54 | return 55 | # Then keep on running until the app raises StopIteration 56 | while True: 57 | try: 58 | # XXX: TestDisplay.wait_for_event() can raise StopIteration 59 | # but this is a hack that is not really applicable for curses 60 | event = self.wait_for_event() 61 | image = app.consume_event(event) 62 | except StopIteration as exc: 63 | if exc.args: 64 | return exc.args[0] 65 | else: 66 | break 67 | else: 68 | self.display_image(image) 69 | 70 | @abstractmethod 71 | def display_image(self, image: TextImage) -> None: 72 | """ 73 | Display the contents of the image on the screen 74 | """ 75 | 76 | @abstractmethod 77 | def get_display_size(self) -> Size: 78 | """ 79 | Get the current size of the display 80 | """ 81 | 82 | @abstractmethod 83 | def wait_for_event(self) -> Event: 84 | """ 85 | Get the next event, waiting for it to occur 86 | """ 87 | 88 | 89 | class PrintDisplay(AbstractDisplay): 90 | """ 91 | A display that uses regular print() and input() 92 | """ 93 | 94 | def __init__(self, size=Size(80, 25)): 95 | self.screen = TextImage(size) 96 | 97 | def display_image(self, image: TextImage) -> None: 98 | text_buffer = image.text_buffer 99 | width = self.screen.size.width 100 | height = self.screen.size.height 101 | print("/{}\\".format('=' * width)) 102 | for y in range(height): 103 | line = text_buffer[y * width: (y + 1) * width].tounicode() 104 | print("|{}|".format(line)) 105 | print("\\{}/".format('=' * width)) 106 | 107 | def get_display_size(self) -> Size: 108 | return self.screen.size 109 | 110 | _commands = { 111 | 'up': Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_UP)), 112 | 'down': Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_DOWN)), 113 | 'left': Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_LEFT)), 114 | 'right': Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_RIGHT)), 115 | '': Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_ENTER)), 116 | } 117 | 118 | def wait_for_event(self) -> Event: 119 | while True: 120 | text = input("TextLand> ") 121 | try: 122 | return self._commands[text] 123 | except KeyError: 124 | if len(text) == 1: 125 | return Event(EVENT_KEYBOARD, KeyboardData(text[0])) 126 | else: 127 | print("Type command name or exactly one letter") 128 | 129 | 130 | class CursesDisplay(AbstractDisplay): 131 | """ 132 | A display using python curses module 133 | """ 134 | 135 | def __init__(self): 136 | import curses 137 | self._curses = curses 138 | self._screen = None 139 | self._curses_attr = [0] * 0xffff 140 | 141 | def _pa_to_curses(self, pa: int) -> int: 142 | """ 143 | Translate cell attributes into supported curses attributes 144 | 145 | Bright mode is well explained in the ncurses FAQ (see: The standard 146 | and VT100 documentation refer to "Bold".): 147 | http://invisible-island.net/ncurses/ncurses.faq.html#problems_coloring 148 | 149 | Check urwid documentation for general terminal supports: 150 | http://urwid.org/manual/displayattributes.html#foreground-and-background-settings 151 | 152 | As curses only supports A_BOLD, bright backgrounds are not supported. 153 | Only ANSI escape codes ANSI supports backgound intensity, see: 154 | http://en.wikipedia.org/wiki/ANSI_escape_code 155 | 156 | Urwid documentation explains why bright background are bad: 157 | "Terminal support for bright background colors is spotty, and they 158 | generally should be avoided. If you are in a high-color mode you 159 | might have better luck using the high-color versions", see: 160 | http://urwid.org/manual/displayattributes.html#bright-background-colors 161 | """ 162 | fg, bg, style = TextAttributes.unpack(pa) 163 | curses_attr = 0 164 | if style == 0: 165 | curses_attr = self._curses.A_NORMAL 166 | if style & REVERSE: 167 | curses_attr |= self._curses.A_REVERSE 168 | if style & UNDERLINE: 169 | curses_attr |= self._curses.A_UNDERLINE 170 | if fg > 7: 171 | curses_attr |= self._curses.A_BOLD # Bright foreground colors 172 | fg -= 8 173 | if bg > 7: 174 | bg -= 8 # Bright backgrounds are not supported 175 | curses_attr |= self._curses.color_pair(self._pair_index(fg, bg)) 176 | return curses_attr 177 | 178 | def _pair_index(self, fg: int, bg: int) -> int: 179 | # XXX: Support the default colors (-1) 180 | #return (bg + 2) * 9 - fg - 2 181 | return bg * 8 + 7 - fg 182 | 183 | def run(self, app: IApplication) -> None: 184 | try: 185 | self._init_curses() 186 | return super().run(app) 187 | finally: 188 | self._fini_curses() 189 | 190 | def _init_curses(self): 191 | self._screen = self._curses.initscr() 192 | if self._curses.has_colors(): 193 | try: 194 | self._curses.start_color() 195 | self._setup_color_pairs() 196 | except self._curses.error: 197 | pass 198 | self._curses.noecho() 199 | self._curses.cbreak() 200 | self._screen.keypad(1) 201 | 202 | def _setup_color_pairs(self): 203 | """ 204 | Initialize all the color pairs based on the _pair_index() formula. 205 | To select the right color combination, we just need to use the right 206 | color pair number. 207 | """ 208 | # XXX: hardcode 8, since curses.COLORS could be larger than the 209 | # portable set of 64 color pairs 210 | for fg in range(8): 211 | for bg in range(8): 212 | if fg == WHITE and bg == BLACK: 213 | continue 214 | self._curses.init_pair(self._pair_index(fg, bg), fg, bg) 215 | self._curses_attr = [self._pa_to_curses(i) for i in range(0xffff)] 216 | 217 | def _fini_curses(self): 218 | if self._screen is not None: 219 | self._screen.keypad(0) 220 | self._curses.echo() 221 | self._curses.nocbreak() 222 | self._curses.endwin() 223 | 224 | def display_image(self, image: TextImage) -> None: 225 | width = image.size.width 226 | height = image.size.height 227 | for y in range(height - 1): 228 | for x in range(width): 229 | cell = image.get(x, y) 230 | self._screen.addstr( 231 | y, x, cell.char, self._curses_attr[cell.attributes]) 232 | y += 1 233 | for x in range(1, width): 234 | cell = image.get(x, y) 235 | self._screen.addstr( 236 | y, x - 1, cell.char, self._curses_attr[cell.attributes]) 237 | cell = image.get(0, y) 238 | self._screen.insstr( 239 | y, 0, cell.char, self._curses_attr[cell.attributes]) 240 | self._screen.refresh() 241 | 242 | def get_display_size(self) -> Size: 243 | y, x = self._screen.getmaxyx() 244 | return Size(x, y) 245 | 246 | def wait_for_event(self) -> Event: 247 | key_code = self._screen.getch() 248 | # throw away all typeaheads 249 | self._curses.flushinp() 250 | # XXX -1 is for OSX 251 | if key_code == self._curses.KEY_RESIZE or key_code == -1: 252 | return Event(EVENT_RESIZE, self.get_display_size()) 253 | elif key_code == self._curses.KEY_UP: 254 | return Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_UP)) 255 | elif key_code == self._curses.KEY_DOWN: 256 | return Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_DOWN)) 257 | elif key_code == self._curses.KEY_LEFT: 258 | return Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_LEFT)) 259 | elif key_code == self._curses.KEY_RIGHT: 260 | return Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_RIGHT)) 261 | elif key_code == ord(' '): 262 | return Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_SPACE)) 263 | elif key_code == ord('\n'): 264 | return Event(EVENT_KEYBOARD, KeyboardData(keys.KEY_ENTER)) 265 | else: 266 | return Event(EVENT_KEYBOARD, KeyboardData(chr(key_code))) 267 | 268 | 269 | class TestDisplay(AbstractDisplay): 270 | """ 271 | A display that records all images and replays pre-recorded events 272 | """ 273 | 274 | def __init__(self, size=Size(80, 25)): 275 | self.screen_log = [] 276 | self.size = size 277 | self.events = deque() 278 | 279 | def display_image(self, image: TextImage) -> None: 280 | self.screen_log.append(deepcopy(image)) 281 | 282 | def get_display_size(self) -> Size: 283 | return self.size 284 | 285 | def wait_for_event(self) -> Event: 286 | try: 287 | return self.events.popleft() 288 | except IndexError: 289 | raise StopIteration 290 | 291 | def inject_event(self, event: Event) -> None: 292 | """ 293 | Inject an event. 294 | 295 | Events are served in FIFO mode. 296 | """ 297 | self.events.append(event) 298 | 299 | 300 | def get_display(display=None) -> IDisplay: 301 | """ 302 | Get a ITextDisplay according to TEXTLAND_DISPLAY environment variable 303 | """ 304 | if display is None: 305 | display = getenv("TEXTLAND_DISPLAY", "curses") 306 | if display == "curses": 307 | try: 308 | return CursesDisplay() 309 | except ImportError: 310 | # Sized like that to fit 80x25 without any overflow 311 | return PrintDisplay(Size(77, 22)) 312 | elif display == "print": 313 | return PrintDisplay() 314 | elif display == "test": 315 | return TestDisplay() 316 | else: 317 | raise ValueError("Unsupported TEXTLAND_DISPLAY type") 318 | -------------------------------------------------------------------------------- /textland/drawing.py: -------------------------------------------------------------------------------- 1 | # This file is part of textland. 2 | # 3 | # Copyright 2014 Canonical Ltd. 4 | # Written by: 5 | # Zygmunt Krynicki 6 | # 7 | # Textland is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 3, 9 | # as published by the Free Software Foundation. 10 | # 11 | # Textland is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Textland. If not, see . 18 | 19 | from .bits import Offset, Rect 20 | from .image import TextImage, TextAttributes 21 | 22 | 23 | class DrawingContext: 24 | """ 25 | Context for simple text drawing 26 | """ 27 | 28 | def __init__(self, image: TextImage): 29 | self.image = image 30 | self.offset = Offset(0, 0) 31 | self.clip = Rect(0, 0, image.size.width, image.size.height) 32 | self.attributes = TextAttributes() 33 | 34 | def fill(self, c: str) -> None: 35 | packed_attr = self.attributes.packed 36 | for x in range(self.clip.x1, self.clip.x2): 37 | for y in range(self.clip.y1, self.clip.y2): 38 | self.image.put(x, y, c, packed_attr) 39 | 40 | def clip_to(self, x1: int, y1: int, x2: int, y2: int) -> None: 41 | self.clip = Rect(x1, y1, x2, y2) 42 | 43 | def clip_by(self, dx1: int, dy1: int, dx2: int, dy2: int) -> None: 44 | x1 = self.clip.x1 + dx1 45 | y1 = self.clip.y1 + dy1 46 | x2 = self.clip.x2 + dx2 47 | y2 = self.clip.y2 + dy2 48 | self.clip = Rect(x1, y1, x2, y2) 49 | 50 | def move_to(self, x: int, y: int) -> None: 51 | """ 52 | Move paint offset to the specified spot 53 | """ 54 | self.offset = Offset(x, y) 55 | 56 | def move_by(self, dx: int, dy: int) -> None: 57 | """ 58 | Move paint offset by the specified delta 59 | """ 60 | self.offset = Offset(self.offset.x + dx, self.offset.y + dy) 61 | 62 | def print(self, text: str) -> None: 63 | """ 64 | Print the specified text 65 | 66 | Multi-line strings are supported. The offset and clipping area 67 | is respected. Painting beyond the clipping area is ignored 68 | 69 | The offset is automatically adjusted to point 70 | to the end of the string. 71 | """ 72 | pa = self.attributes.packed 73 | for line in text.splitlines(): 74 | self._put_line(line, pa) 75 | self.move_by(0, 1) 76 | 77 | def border(self, lm=0, rm=0, tm=0, bm=0) -> None: 78 | """ 79 | Draw a border around the edges of the current cli. Each parameter 80 | specifies the margin to use for a specific side of the border. 81 | """ 82 | pa = self.attributes.packed 83 | self._put_x_y_c_pa(self.clip.x1 + lm, self.clip.y1 + tm, '┌', pa) 84 | self._put_x_y_c_pa(self.clip.x1 + lm, self.clip.y2 - 1 - bm, '└', pa) 85 | self._put_x_y_c_pa(self.clip.x2 - rm - 1, self.clip.y1 + tm, '┐', pa) 86 | self._put_x_y_c_pa( 87 | self.clip.x2 - rm - 1, self.clip.y2 - 1 - bm, '┘', pa) 88 | for x in range(self.clip.x1 + 1 + lm, self.clip.x2 - 1 - rm): 89 | self._put_x_y_c_pa(x, self.clip.y1 + tm, '─', pa) 90 | self._put_x_y_c_pa(x, self.clip.y2 - 1 - bm, '─', pa) 91 | for y in range(self.clip.y1 + 1 + tm, self.clip.y2 - 1 - bm): 92 | self._put_x_y_c_pa(self.clip.x1 + lm, y, '│', pa) 93 | self._put_x_y_c_pa(self.clip.x2 - rm - 1, y, '│', pa) 94 | 95 | def _put_line(self, text: str, pa: int) -> None: 96 | """ 97 | Print one line, respecting clipping and offset 98 | """ 99 | if "\n" in text: 100 | raise ValueError("should be without any newlines") 101 | for dx, c in enumerate(text): 102 | self._put_dx_dy_c_pa(dx, 0, c, pa) 103 | 104 | def _put_dx_dy_c_pa(self, dx: int, dy: int, c: str, pa: int) -> None: 105 | x = self.offset.x + dx 106 | y = self.offset.y + dy 107 | self._put_x_y_c_pa(x, y, c, pa) 108 | 109 | def _put_x_y_c_pa(self, x: int, y: int, c: str, pa: int) -> None: 110 | if (self.clip.x1 <= x < self.clip.x2 111 | and self.clip.y1 <= y < self.clip.y2): 112 | self.image.put(x, y, c, pa) 113 | -------------------------------------------------------------------------------- /textland/events.py: -------------------------------------------------------------------------------- 1 | # This file is part of textland. 2 | # 3 | # Copyright 2014 Canonical Ltd. 4 | # Written by: 5 | # Zygmunt Krynicki 6 | # 7 | # Textland is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 3, 9 | # as published by the Free Software Foundation. 10 | # 11 | # Textland is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Textland. If not, see . 18 | 19 | from collections import namedtuple 20 | 21 | # Input event 22 | Event = namedtuple('Event', ['kind', 'data']) 23 | 24 | # Data for Event.data 25 | KeyboardData = namedtuple('KeyboardData', ['key']) 26 | MouseData = namedtuple('MouseData', ['x', 'y', 'buttons']) 27 | 28 | # Constants for Event.kind 29 | EVENT_KEYBOARD = "keyboard" 30 | EVENT_MOUSE = "mouse" 31 | EVENT_RESIZE = "resize" 32 | -------------------------------------------------------------------------------- /textland/image.py: -------------------------------------------------------------------------------- 1 | # This file is part of textland. 2 | # 3 | # Copyright 2014 Canonical Ltd. 4 | # Written by: 5 | # Zygmunt Krynicki 6 | # Sylvain Pineau 7 | # 8 | # Textland is free software: you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License version 3, 10 | # as published by the Free Software Foundation. 11 | # 12 | # Textland is distributed in the hope that it will be useful, 13 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | # GNU General Public License for more details. 16 | # 17 | # You should have received a copy of the GNU General Public License 18 | # along with Textland. If not, see . 19 | 20 | from array import array 21 | 22 | from .bits import Cell, Size 23 | 24 | # ANSI color index 25 | ( 26 | BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE, 27 | BRIGHT_BLACK, BRIGHT_RED, BRIGHT_GREEN, BRIGHT_YELLOW, BRIGHT_BLUE, 28 | BRIGHT_MAGENTA, BRIGHT_CYAN, BRIGHT_WHITE 29 | ) = range(16) 30 | 31 | # Supported text styles. 32 | NORMAL = 0 # Normal (default style) 33 | REVERSE = 1 << 0 # Reverse background and foreground colors 34 | UNDERLINE = 1 << 1 # Underline mode 35 | 36 | 37 | class TextImage: 38 | """ 39 | A rectangular, mutable text image. 40 | 41 | The image supports NORMAL, REVERSE and UNDERLINE as per-cell attributes, 42 | the 8 colors described in the ANSI standard and the BOLD video attribute 43 | to render the foreground colors as bright (aka light or intensified). 44 | """ 45 | 46 | def __init__(self, size: Size): 47 | self.size = size 48 | self.width = self.size.width 49 | self.text_buffer = array('u') 50 | self.text_buffer.extend(' ' * size.width * size.height) 51 | self.attribute_buffer = array('H') # Unsigned short 52 | self.attribute_buffer.extend([0] * size.width * size.height) 53 | 54 | def put(self, x: int, y: int, c: str, pa: int) -> None: 55 | """ 56 | Put character *c* with attributes *pa* into cell at (*x*, *y*) 57 | 58 | :param x: 59 | X coordinate 60 | :param y: 61 | Y coordinate 62 | :param c: 63 | One character string 64 | :param pa: 65 | Packed attribute (up to uint16_t) 66 | """ 67 | assert 0 <= x < self.size.width 68 | assert 0 <= y < self.size.height 69 | offset = x + y * self.width 70 | self.text_buffer[offset] = c 71 | self.attribute_buffer[offset] = pa 72 | 73 | def get(self, x: int, y: int) -> Cell: 74 | """ 75 | Get a cell from (*x*, *y*) 76 | 77 | :param x: 78 | X coordinate 79 | :param y: 80 | Y coordinate 81 | :returns: 82 | Cell(c, pa) 83 | """ 84 | offset = x + y * self.width 85 | return Cell(self.text_buffer[offset], self.attribute_buffer[offset]) 86 | 87 | def print_frame(self) -> None: 88 | text_buffer = self.text_buffer 89 | width = self.size.width 90 | height = self.size.height 91 | print("/{}\\".format('=' * width)) 92 | for y in range(height): 93 | line = text_buffer[y * width: (y + 1) * width].tounicode() 94 | print("|{}|".format(line)) 95 | print("\\{}/".format('=' * width)) 96 | 97 | 98 | class TextAttributes: 99 | 100 | def __init__(self): 101 | self.fg = WHITE 102 | self.bg = BLACK 103 | self.style = NORMAL 104 | 105 | def reset(self): 106 | self.fg = WHITE 107 | self.bg = BLACK 108 | self.style = NORMAL 109 | 110 | @property 111 | def packed(self): 112 | return ((self.fg & 15) << 8) + ((self.bg & 15) << 4) + (self.style & 3) 113 | 114 | @staticmethod 115 | def unpack(pa: int) -> (int, int, int): 116 | """ 117 | Unpack packed attributes into (fg, bg, style) 118 | """ 119 | fg = (pa >> 8) & 15 120 | bg = (pa >> 4) & 15 121 | style = pa & 3 122 | return fg, bg, style 123 | -------------------------------------------------------------------------------- /textland/keys.py: -------------------------------------------------------------------------------- 1 | # This file is part of textland. 2 | # 3 | # Copyright 2014 Canonical Ltd. 4 | # Written by: 5 | # Zygmunt Krynicki 6 | # 7 | # Textland is free software: you can redistribute it and/or modify 8 | # it under the terms of the GNU General Public License version 3, 9 | # as published by the Free Software Foundation. 10 | # 11 | # Textland is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with Textland. If not, see . 18 | 19 | KEY_UP = "up" 20 | KEY_DOWN = "down" 21 | KEY_LEFT = "left" 22 | KEY_RIGHT = "right" 23 | KEY_ENTER = "enter" 24 | KEY_SPACE = "space" 25 | --------------------------------------------------------------------------------