├── .gitignore ├── LICENSE ├── README.md ├── __init__.py ├── bitutil.py ├── demos ├── pong.gif └── shell.gif ├── devices ├── __init__.py ├── filesystem.py ├── graphic.py ├── keyboard.py ├── pipeos.py └── text.py ├── pipevm.py ├── tests ├── _path.py ├── _testfs ├── bfponggen.py ├── pong.py └── sh.bf └── vm └── __init__.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 | # pipevm 2 | PipeVM is a binary protocol - and a Python implementation - of a Virtual Machine that can be controlled via stdin/stdout. 3 | 4 | It was heavily inspired by discussion in https://github.com/tomhea/flip-jump/discussions/154 about how to extend the capabilities of programming languages with limited I/O implementation (as most esolangs, for example, that can only read bytes from stdin and write bytes to stdout). 5 | 6 | # Devices 7 | This is a prototype implements 5 devices: 8 | * [devices/text.py](devices/text.py) - ASCII console with auto-scroll 9 | * [devices/graphic.py](devices/graphic.py) - 320x240 24-bits RGB graphic screen 10 | * [devices/keyboard.py](devices/keyboard.py) - A keyboard that can wait for a char (blocking) or return which key is pressed (non-blocking) 11 | * [devices/pipeos.py](devices/pipeos.py) - Miscellaneous methods, like a pseudorandom number generator; this probably won't exist in the final version 12 | * [devices/filesystem.py](devices/filesystem.py) - Interface to a real filesystem (chrooted), supporting ls, stat, read, write, mkdir, rm 13 | 14 | # Demo 15 | To demonstrate how it can be used, there are two main demos in the tests/ folder: 16 | 17 | ## [tests/bfponggen.py](tests/bfponggen.py) 18 | A (graphical) Pong implementation in brainfuck (the script is python because it's used to generate the brainfuck code) 19 | 20 | ![pong prototype in brainfuck](demos/pong.gif?raw=true "Pong prototype in Brainfuck") 21 | 22 | 23 | ## [tests/sh.bf](tests/sh.bf) 24 | A basic UNIX shell implementation with ls, echo (including redirecting output to a file), mkdir, rm and cat 25 | 26 | ![UNIX Shell prototype in brainfuck](demos/shell.gif?raw=true "UNIX Shell prototype in Brainfuck") 27 | 28 | 29 | ## Running 30 | 31 | To run the demos, you need to create a FIFO: 32 | 33 | `$ ff="/tmp/ff"; [ ! -p "$ff" ] && mkfifo "$ff";` 34 | 35 | And then execute the compiled (or interpreted) code like: 36 | 37 | `$ <"$ff" ./pipevm.py | /tmp/your_program >"$ff"` 38 | 39 | There are probably ways to make this work on Windows, but I haven't tried. 40 | Keep in mind that your program must output raw bytes, not UTF-8 encoded strings (unless you pipe it through `iconv -f utf-8 -t latin1`, but I wouldn't recommend that). 41 | 42 | 43 | # Sample usage 44 | Other than the demos above, simply writing to pipevm stdin can be used to see how it works. 45 | 46 | The echoed string can be cut short at any point (better results if it's before `\xff\x80` or `\xff\x81`) to see partial examples 47 | 48 | ``` 49 | $ echo -ne "text\xff\x81\x05\x00\x0a\x00\x32\x00\x05\x00\x1e\x70\x80\x90\xff\x80\xff\xff\x00hi\xff\x81\x00" | stdbuf -i0 -o0 -e0 python3 pipevm.py 50 | ^^^^ print "text" in text mode 51 | ^^^^^^^^ special char (switches to "command mode") followed by command 0x81, which switches device to device=1 (graphic screen) 52 | ^^^^ operation 5 (draw rectangle) 53 | ^^^^^^^^ 16 bits x (10) 54 | ^^^^^^^^ 16 bits y (50) 55 | ^^^^^^^^ 16 bits w (5) 56 | ^^^^^^^^ 16 bits h (30) 57 | ^^^^^^^^^^^^ 24 bits rgb (#708090) 58 | ^^^^^^^^ switches back to device=0 (text) 59 | ^^^^^^^^ send 0xff to text device (puts it in "command mode") 60 | ^^^^ send commmand 0x00 (clear screen) 61 | ^^ write "hi" 62 | ^^^^^^^^ switches to device=1 (graphic screen) 63 | ^^^ refresh 64 | ``` 65 | -------------------------------------------------------------------------------- /__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lestrozi/pipevm/0f788a0d4faba4caef1a8d72ec32ef949f627dc8/__init__.py -------------------------------------------------------------------------------- /bitutil.py: -------------------------------------------------------------------------------- 1 | import bitstring 2 | 3 | # work-around to make bitstring.BitStream actually lose the bits read 4 | # instead of just advancing the reading pointer 5 | class BitStream(bitstring.BitStream): 6 | def peek(self, fmt): 7 | # horrible, but the original peek() is defined 8 | # using read() and don't expect it to delete bits from 9 | # the beginning as my override does 10 | thisRead = self.read 11 | self.read = super().read 12 | v = super().peek(fmt) 13 | self.read = thisRead 14 | return v 15 | 16 | def read(self, n): 17 | c = super().read(n) 18 | del self[0:n] 19 | self.pos = 0 20 | return c 21 | -------------------------------------------------------------------------------- /demos/pong.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lestrozi/pipevm/0f788a0d4faba4caef1a8d72ec32ef949f627dc8/demos/pong.gif -------------------------------------------------------------------------------- /demos/shell.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lestrozi/pipevm/0f788a0d4faba4caef1a8d72ec32ef949f627dc8/demos/shell.gif -------------------------------------------------------------------------------- /devices/__init__.py: -------------------------------------------------------------------------------- 1 | from bitutil import BitStream 2 | 3 | class Device: 4 | def __init__(self, vm, outputBuffer, isByteAligned=True): 5 | self.vm = vm 6 | self.inputBuffer = BitStream() 7 | self.outputBuffer = outputBuffer 8 | 9 | def input(self, b): 10 | self.inputBuffer.append(b) 11 | self.consumeInput() 12 | 13 | def consumeInput(self): 14 | raise Exception("NOT IMPLEMENTED") 15 | 16 | def output(self, b): 17 | self.outputBuffer.append(b) 18 | -------------------------------------------------------------------------------- /devices/filesystem.py: -------------------------------------------------------------------------------- 1 | import os 2 | import time 3 | import sys 4 | sys.path.append('..') # ugh 5 | from pathlib import Path 6 | from bitutil import BitStream 7 | from devices import Device 8 | 9 | class Filesystem(Device): 10 | class Commands: 11 | LS = 0 12 | STAT = 1 13 | READ = 2 # no open/close required, at least for now 14 | WRITE = 3 # no open/close required, at least for now 15 | MKDIR = 4 16 | RM = 5 17 | 18 | def setRoot(self, root): 19 | self.root = root 20 | 21 | try: 22 | os.mkdir(root) 23 | except FileExistsError: 24 | pass 25 | 26 | def getNullTerminatedPath(self, start): 27 | zeroBytePos = None 28 | for i in range(start, len(self.inputBuffer), 8): 29 | if self.inputBuffer[i:i+8].uint == 0: 30 | zeroBytePos = i 31 | 32 | if zeroBytePos is None: 33 | return None, 0 34 | 35 | relative_path = self.inputBuffer[start:zeroBytePos].bytes.decode('utf-8') 36 | 37 | newPath = self.root + "/" + relative_path 38 | # raise exception if path traversal 39 | Path(newPath).resolve().relative_to(self.root).resolve() 40 | 41 | abs_path = str(Path(newPath).resolve()) 42 | 43 | return abs_path, (zeroBytePos-start) 44 | 45 | def consumeInput(self): 46 | # wait for at least 1 byte 47 | if len(self.inputBuffer) < 8: 48 | return 49 | 50 | # TODO: allow non-byte-aligned commands 51 | c = self.inputBuffer.peek(8).uint 52 | if c == self.Commands.LS: 53 | start = 8 54 | abs_path, pathLen = self.getNullTerminatedPath(start) 55 | if abs_path is None: 56 | return 57 | 58 | self.inputBuffer.read(8) 59 | self.inputBuffer.read(pathLen + 8) 60 | 61 | rel_path = abs_path[len(self.root):] 62 | print(f"ls {abs_path}", file=sys.stderr) 63 | for f in os.listdir(abs_path): 64 | p = str(Path(abs_path + "/" + f)) 65 | p = p[len(self.root):] 66 | self.output(BitStream((p.encode('utf-8') + bytes([0])))) 67 | self.output(BitStream(bytes([0]))) 68 | elif c == self.Commands.STAT: 69 | start = 8 70 | abs_path, pathLen = self.getNullTerminatedPath(start) 71 | if abs_path is None: 72 | return 73 | 74 | self.inputBuffer.read(8) 75 | self.inputBuffer.read(pathLen + 8) 76 | 77 | # for this version, only return size and if is dir; otherwise 78 | # (even if it doesn't exist) return is file 79 | # this is pretty bad, but it's just a prototype 80 | s = os.stat(abs_path) 81 | is_dir = os.path.isdir(abs_path) 82 | 83 | print(f"stat {abs_path}: {int(is_dir)} {s.st_size}", file=sys.stderr) 84 | self.output(BitStream(uint=int(is_dir), length=8)) 85 | self.output(BitStream(uint=s.st_size, length=32)) 86 | elif c == self.Commands.READ: 87 | if len(self.inputBuffer) < 8+32: 88 | return 89 | 90 | start = 8+32 91 | abs_path, pathLen = self.getNullTerminatedPath(start) 92 | if abs_path is None: 93 | return 94 | 95 | self.inputBuffer.read(8) 96 | readBytesLen = self.inputBuffer.read(32).uint 97 | self.inputBuffer.read(pathLen + 8) 98 | 99 | print(f"reading {readBytesLen} bytes from {abs_path}", file=sys.stderr) 100 | with open(abs_path, 'rb') as f: 101 | result = f.read(readBytesLen) 102 | self.output(BitStream(result)) 103 | 104 | # if eof, send a 0 byte in the end 105 | if len(result) < readBytesLen: 106 | self.output(BitStream(int=0, length=8)) 107 | elif c == self.Commands.WRITE: 108 | if len(self.inputBuffer) < 8+32: 109 | return 110 | 111 | start = 8+32 112 | abs_path, pathLen = self.getNullTerminatedPath(start) 113 | if abs_path is None: 114 | return 115 | 116 | writeBytesLen = self.inputBuffer[8:40].uint 117 | 118 | if len(self.inputBuffer) < 8+32+pathLen+8+8*writeBytesLen: 119 | return 120 | 121 | self.inputBuffer.read(8) 122 | self.inputBuffer.read(32) 123 | self.inputBuffer.read(pathLen + 8) 124 | b = self.inputBuffer.read(8*writeBytesLen) 125 | 126 | print(f"writing {writeBytesLen} bytes to {abs_path}", file=sys.stderr) 127 | with open(abs_path, 'wb') as f: 128 | f.write(b.bytes) 129 | 130 | # success (always) 131 | self.output(BitStream(int=0, length=8)) 132 | elif c == self.Commands.MKDIR: 133 | if len(self.inputBuffer) < 8: 134 | return 135 | 136 | start = 8 137 | abs_path, pathLen = self.getNullTerminatedPath(start) 138 | if abs_path is None: 139 | return 140 | 141 | self.inputBuffer.read(8) 142 | self.inputBuffer.read(pathLen + 8) 143 | 144 | try: 145 | print(f"mkdir {abs_path}", file=sys.stderr) 146 | os.mkdir(abs_path) 147 | except: 148 | self.output(BitStream(int=1, length=8)) 149 | 150 | # success 151 | self.output(BitStream(int=0, length=8)) 152 | elif c == self.Commands.RM: 153 | if len(self.inputBuffer) < 8: 154 | return 155 | 156 | start = 8 157 | abs_path, pathLen = self.getNullTerminatedPath(start) 158 | if abs_path is None: 159 | return 160 | 161 | self.inputBuffer.read(8) 162 | self.inputBuffer.read(pathLen + 8) 163 | 164 | try: 165 | print(f"trying to remove file {abs_path}", file=sys.stderr) 166 | os.remove(abs_path) 167 | self.output(BitStream(int=0, length=8)) 168 | return 169 | except: 170 | pass 171 | 172 | try: 173 | print(f"trying to remove dir {abs_path}", file=sys.stderr) 174 | os.rmdir(abs_path) 175 | except: 176 | self.output(BitStream(int=1, length=8)) 177 | 178 | self.output(BitStream(int=0, length=8)) 179 | else: 180 | raise Exception(f"Invalid command: {c}") 181 | -------------------------------------------------------------------------------- /devices/graphic.py: -------------------------------------------------------------------------------- 1 | import sys 2 | from devices import Device 3 | 4 | class Graphic(Device): 5 | class Commands: 6 | REFRESH = 0 7 | READ_PIXEL = 1 8 | WRITE_PIXEL = 2 9 | READ_RECT = 3 10 | WRITE_RECT = 4 11 | FILL_RECT = 5 12 | 13 | def consumeInput(self): 14 | # wait for at least 1 byte 15 | if len(self.inputBuffer) < 8: 16 | return 17 | 18 | # TODO: allow non-byte-aligned commands 19 | c = self.inputBuffer.peek(8).uint 20 | if c == self.Commands.REFRESH: 21 | self.vm.refreshGraphic() 22 | elif c == self.Commands.READ_PIXEL: 23 | raise Exception("Not implemented") 24 | elif c == self.Commands.WRITE_PIXEL: 25 | raise Exception("Not implemented") 26 | elif c == self.Commands.READ_RECT: 27 | raise Exception("Not implemented") 28 | elif c == self.Commands.WRITE_RECT: 29 | raise Exception("Not implemented") 30 | elif c == self.Commands.FILL_RECT: 31 | # x (16b), y (16b), w (16b), h (16b), color (24b) 32 | if len(self.inputBuffer) < 96: 33 | return 34 | 35 | c = self.inputBuffer.read(8).uint 36 | x = self.inputBuffer.read(16).uint 37 | y = self.inputBuffer.read(16).uint 38 | w = self.inputBuffer.read(16).uint 39 | h = self.inputBuffer.read(16).uint 40 | r = self.inputBuffer.read(8).hex 41 | g = self.inputBuffer.read(8).hex 42 | b = self.inputBuffer.read(8).hex 43 | rgb = f"#{r}{g}{b}" 44 | 45 | # TODO if debug 46 | print(x, y, w, h, r, g, b, rgb, file=sys.stderr) 47 | self.vm.drawRect(x, y, w, h, rgb) 48 | else: 49 | raise Exception(f"Invalid command: {c}") 50 | -------------------------------------------------------------------------------- /devices/keyboard.py: -------------------------------------------------------------------------------- 1 | import sys 2 | sys.path.append('..') # ugh 3 | from bitutil import BitStream 4 | from devices import Device 5 | 6 | class Keyboard(Device): 7 | class Commands: 8 | WAIT_CHAR = 0 9 | GET_KEYPRESSED = 1 10 | 11 | def consumeInput(self): 12 | # wait for at least 1 byte 13 | if len(self.inputBuffer) < 8: 14 | return 15 | 16 | # TODO: allow non-byte-aligned commands 17 | c = self.inputBuffer.peek(8).uint 18 | if c == self.Commands.WAIT_CHAR: 19 | print("Wait char", file=sys.stderr) 20 | 21 | c = self.vm.waitChar() 22 | self.output(BitStream(c.encode('latin-1'))) 23 | elif c == self.Commands.GET_KEYPRESSED: 24 | print("Get keypressed", file=sys.stderr) 25 | c = self.inputBuffer.read(8).uint 26 | 27 | # TODO: improve method to allow read special keys 28 | kp = self.vm.getKeyPressed() 29 | if kp == None: 30 | # for non-byte-aligned, just 1 or 2 bits might suffice 31 | # even for byte-aligned, other encodings are certainly better, 32 | # but this is enough for a prototype 33 | self.output(BitStream('0x00')) 34 | else: 35 | self.output(BitStream('0x01')) 36 | self.output(BitStream(kp.encode('latin-1'))) 37 | else: 38 | raise Exception(f"Invalid command: {c}") 39 | -------------------------------------------------------------------------------- /devices/pipeos.py: -------------------------------------------------------------------------------- 1 | import os 2 | import time 3 | import sys 4 | sys.path.append('..') # ugh 5 | from bitutil import BitStream 6 | from devices import Device 7 | 8 | class Os(Device): 9 | class Commands: 10 | DELAY_MS = 0 11 | RANDOM = 1 12 | 13 | def consumeInput(self): 14 | # wait for at least 1 byte 15 | if len(self.inputBuffer) < 8: 16 | return 17 | 18 | # TODO: allow non-byte-aligned commands 19 | c = self.inputBuffer.peek(8).uint 20 | if c == self.Commands.DELAY_MS: 21 | if len(self.inputBuffer) < 24: 22 | return 23 | 24 | self.inputBuffer.read(8).uint 25 | n = self.inputBuffer.read(16).uint 26 | 27 | time.sleep(n/1000) 28 | 29 | self.output(BitStream('0x00')) 30 | elif c == self.Commands.RANDOM: 31 | if len(self.inputBuffer) < 16: 32 | return 33 | 34 | self.inputBuffer.read(8).uint 35 | n = self.inputBuffer.read(8).uint 36 | 37 | # generate n pseudorandom number 38 | r = os.urandom(n) 39 | self.output(BitStream(r)) 40 | else: 41 | raise Exception(f"Invalid command: {c}") 42 | -------------------------------------------------------------------------------- /devices/text.py: -------------------------------------------------------------------------------- 1 | from devices import Device 2 | 3 | class Text(Device): 4 | SPECIAL_CHAR = 0xff 5 | 6 | class Commands: 7 | CLEAR_SCREEN = 0 8 | LOCATE = 1 9 | 10 | def consumeInput(self): 11 | # wait for at least 1 byte 12 | if len(self.inputBuffer) < 8: 13 | return 14 | 15 | c = self.inputBuffer.peek(8).uint 16 | if c == self.SPECIAL_CHAR: 17 | if len(self.inputBuffer) < 16: 18 | # wait for next token 19 | return 20 | 21 | c = self.inputBuffer[8:16].uint 22 | if c == self.Commands.CLEAR_SCREEN: 23 | c = self.inputBuffer.read(16) 24 | self.vm.clearText() 25 | elif c == self.Commands.LOCATE: 26 | raise Exception("Not implemented") 27 | else: 28 | raise Exception(f"Invalid command: {c}") 29 | elif c < 128: 30 | c = self.inputBuffer.read(8).uint 31 | self.vm.putc(chr(c)) 32 | else: 33 | raise Exception(f"Non-ASCII char to print: {c}") 34 | -------------------------------------------------------------------------------- /pipevm.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | from bitutil import BitStream 4 | from devices import text, graphic, keyboard, pipeos, filesystem 5 | from vm import Vm 6 | import fcntl 7 | import os 8 | import sys 9 | 10 | import time 11 | 12 | class PipeCmd: 13 | SPECIAL_CHAR = 0xff 14 | DEVICE_SELECTOR_CHAR = 0x80 15 | 16 | def __init__(self, vm): 17 | # TODO: CLI arguments: 18 | self.byteAligned = True 19 | self.bitDictionary = None #[48, 49] # bytes that represent bit-0 and bit-1 respectively 20 | # is ignored if byteAligned = True 21 | self.filesystemRoot = "/tmp/pipevm/" 22 | 23 | 24 | # for now, let all devices share the same outputBuffer 25 | self.outputBuffer = BitStream() 26 | 27 | self.vm = vm 28 | filesystemDevice = filesystem.Filesystem(vm, self.outputBuffer, self.byteAligned) 29 | filesystemDevice.setRoot(self.filesystemRoot) 30 | self.devices = [ 31 | text.Text(vm, self.outputBuffer, self.byteAligned), 32 | graphic.Graphic(vm, self.outputBuffer, self.byteAligned), 33 | keyboard.Keyboard(vm, self.outputBuffer, self.byteAligned), 34 | pipeos.Os(vm, self.outputBuffer, self.byteAligned), 35 | filesystemDevice, 36 | ] 37 | self.device = self.devices[0] 38 | self.inputBuffer = BitStream() 39 | 40 | fd = sys.stdin.fileno() 41 | fl = fcntl.fcntl(fd, fcntl.F_GETFL) 42 | fcntl.fcntl(fd, fcntl.F_SETFL, fl | os.O_NONBLOCK) 43 | 44 | while True: 45 | # FIXME: improve stdin/out handling loop 46 | 47 | # handle output (devices -> stdout) 48 | while len(self.outputBuffer) >= 8: 49 | c = self.outputBuffer.read(8) 50 | sys.stdout.buffer.raw.write(c.bytes) 51 | sys.stdout.buffer.raw.flush() 52 | 53 | # handle input (stdin -> devices) 54 | b = sys.stdin.buffer.raw.read(1) 55 | if b == b'' or b is None: 56 | continue 57 | print("EOF", file=sys.stderr) 58 | #quit() 59 | 60 | # FIXME 61 | time.sleep(0.001) 62 | 63 | # if bitDictionary is set, read input bytes as representing an individual bit 64 | if self.bitDictionary: 65 | if ord(b) == self.bitDictionary[0]: 66 | self.inputBuffer.append(BitStream(bin='0b0')) 67 | elif ord(b) == self.bitDictionary[1]: 68 | self.inputBuffer.append(BitStream(bin='0b1')) 69 | else: 70 | raise Exception(f"Invalid input byte representation of a bit: {ord(b)}") 71 | else: 72 | self.inputBuffer.append(BitStream(bytes=b, length=8)) 73 | 74 | # wait for at least 1 byte 75 | if len(self.inputBuffer) < 8: 76 | continue 77 | 78 | c = self.inputBuffer.peek(8).uint 79 | if c == self.SPECIAL_CHAR: 80 | if len(self.inputBuffer) < 16: 81 | # wait for next token 82 | continue 83 | 84 | c = self.inputBuffer.read(8).uint 85 | c = self.inputBuffer.read(8).uint 86 | if c == self.SPECIAL_CHAR: 87 | self.device.input(BitStream(uint=c, length=8)) 88 | elif (c >= self.DEVICE_SELECTOR_CHAR 89 | and c <= (self.DEVICE_SELECTOR_CHAR + len(self.devices))): 90 | deviceNum = c - self.DEVICE_SELECTOR_CHAR 91 | print(f"Selecting device {deviceNum}", file=sys.stderr) 92 | self.setDevice(deviceNum) 93 | else: 94 | raise Exception(f"Invalid command: {c}") 95 | else: 96 | bs = self.inputBuffer.read(8) 97 | self.device.input(bs) 98 | 99 | 100 | def setDevice(self, deviceNum): 101 | try: 102 | self.device = self.devices[deviceNum] 103 | except IndexError: 104 | raise Exception(f"Invalid device: {deviceNum}") 105 | 106 | 107 | def putc(self, c): 108 | sys.stdout.input(c) 109 | sys.stdout.flush() 110 | 111 | 112 | if __name__ == "__main__": 113 | vm = Vm() 114 | vm.waitReady() 115 | 116 | PipeCmd(vm) 117 | -------------------------------------------------------------------------------- /tests/_path.py: -------------------------------------------------------------------------------- 1 | from pathlib import Path 2 | 3 | root = "/tmp/pipevm" 4 | 5 | def getPath(p): 6 | newPath = root + "/" + p 7 | Path(newPath).resolve().relative_to(root).resolve() 8 | return str(Path(newPath).resolve()) 9 | 10 | def test(p, expected): 11 | try: 12 | assert getPath(p) == expected, f"getPath({p}) returned {getPath(p)} instead of {expected}" 13 | except Exception as e: 14 | if not isinstance(e, expected): 15 | raise Exception(f"got {e}, expected {expected}") 16 | 17 | 18 | test("/", "/tmp/pipevm") 19 | test("bla", "/tmp/pipevm/bla") 20 | test("/bla", "/tmp/pipevm/bla") 21 | test("//bla", "/tmp/pipevm/bla") 22 | test("../bla", ValueError) 23 | test("/../bla", ValueError) 24 | test("/bla/ble", "/tmp/pipevm/bla/ble") 25 | test("/bla/ble/..", "/tmp/pipevm/bla") 26 | test("/bla/ble/../", "/tmp/pipevm/bla") 27 | test("/bla/ble/../..", "/tmp/pipevm") 28 | test("/bla/ble/../../", "/tmp/pipevm") 29 | test("/bla/ble/../../..", ValueError) 30 | 31 | -------------------------------------------------------------------------------- /tests/_testfs: -------------------------------------------------------------------------------- 1 | $ echo -e "\xff\x84\x00.\x00" | ./pipevm.py 2 | Selecting device 4 3 | ls /tmp/pipevm 4 | barfoo 5 | 6 | $ echo -e "\xff\x84\x01foo\x00" | ./pipevm.py 7 | Selecting device 4 8 | stat /tmp/pipevm/foo 9 | 10 | $ echo -e "\xff\x84\x02\x00\x00\x00\x99foo\x00" | ./pipevm.py 11 | Selecting device 4 12 | reading 153 bytes from /tmp/pipevm/foo 13 | foobar1 14 | 15 | $ echo -ne "\xff\x84\x03\x00\x00\x00\x05zzz\x00abcde" | ./pipevm.py 16 | Selecting device 4 17 | writing 5 bytes to /tmp/pipevm/zzz 18 | 19 | $ echo -ne "\xff\x84\x04dir1\x00" | ./pipevm.py 20 | Selecting device 4 21 | mkdir /tmp/pipevm/dir1 22 | 23 | $ echo -ne "\xff\x84\x05dir1\x00" | ./pipevm.py 24 | Selecting device 4 25 | trying to remove file /tmp/pipevm/dir1 26 | trying to remove dir /tmp/pipevm/dir1 27 | 28 | $ echo -ne "\xff\x84\x05foo\x00" | ./pipevm.py 29 | Selecting device 4 30 | trying to remove file /tmp/pipevm/foo 31 | -------------------------------------------------------------------------------- /tests/bfponggen.py: -------------------------------------------------------------------------------- 1 | # pongff="/tmp/pongff"; [ ! -p "$pongff" ] && mkfifo "$pongff"; 2 | # rm -f /tmp/p; python3 bfponggen.py >/tmp/p.bf && python2.7 ~/bfc.py /tmp/p.bf && <"$pongff" ../pipevm.py | /tmp/p >"$pongff" 3 | 4 | import struct 5 | 6 | class BfGen(): 7 | def __init__(self, generators): 8 | self.labels = {} 9 | for i in range(len(generators)): 10 | self.labels[generators[i][0]] = i 11 | print(generators[i][1]) 12 | 13 | print() 14 | 15 | self.curPos = len(generators) - 9 # FIXME 16 | 17 | def moveToPos(self, goalPos): 18 | d = self.curPos - goalPos 19 | self.curPos -= d 20 | 21 | if d >= 0: 22 | return "<" * d 23 | 24 | return ">" * -d 25 | 26 | def output(self, s): 27 | result = "" 28 | label = "" 29 | 30 | for c in s: 31 | if c in '[]<>{}+-.,': 32 | if label: 33 | label = label.strip() 34 | v = self.moveToPos(self.labels[label]) 35 | result += v 36 | label = "" 37 | result += c 38 | else: 39 | label += c 40 | 41 | if label: 42 | label = label.strip() 43 | v = self.moveToPos(self.labels[label]) 44 | result += v 45 | 46 | print(result) 47 | 48 | 49 | generators = [ 50 | ('00', ">"), # 0 51 | ('01', "+>"), # 1 52 | ('05', "+++++>"), # 5 53 | ('paddle_size', ">+++++[<++++++>-]"), # 30 54 | ('paddle_right_x', ">++++++++[<++++++++>-]"), # 64 55 | ('paddle_right_y', ">>+>+>+[+>++[-<+++>]<<]>-[-<+<+>>]"), # 103 56 | ('paddle_left_y', ""), # 103 57 | ('ball_x0', ""), # 0 58 | ('ball_x1', ">+>+>+++[+>+[-<++++>]<<]>>"), # 158 59 | ('ball_y0', ">"), # 0 60 | ('ball_y1', ">+++++++++[<+++++++++++++>-]"), # 117 61 | ('ff', ">+>+>+>+[++>[-<++++>]<<]>[-<+>]"), # 255 62 | ('device', "++++[>++++<-]>[<++++++++>-]<+>"), # 129 63 | ('f0', ">+>+>+>+[++>+[-<+++>]<<]>[-<+>]"), # 240 64 | ('ball_direction_x', ""), # 0 (left) 65 | ('ball_direction_y', ">"), # 0 (top) 66 | ('mem0', ""), # 0 67 | ('mem1', ""), # 0 68 | ('mem2', ""), # 0 69 | ('mem3', ""), # 0 70 | ('mem4', ""), # 0 71 | ('mem5', ""), # 0 72 | ('mem6', ""), # 0 73 | ('mem7', ""), # 0 74 | ] 75 | 76 | bfgen = BfGen(generators) 77 | 78 | bfgen.output("ff.device.") 79 | 80 | # black screen # struct.pack(">BHHHHBBB", command, x, y, w, h, r, g, b) 81 | # paddle_right_x starts with [320 (width) - 256 (overflow)], but will later have 10 subtracted from it 82 | bfgen.output("05.00.00.00.00.01.paddle_right_x.00.f0.00.00.00.") 83 | 84 | # we don't need to save "320" anymore, decrease by 10 so it can be used as paddle_right_x 85 | bfgen.output("paddle_right_x----------") 86 | 87 | # draw left paddle 88 | bfgen.output("05.00.05.00.paddle_left_y.00.05.00.paddle_size.f0.f0.f0.") 89 | 90 | # draw right paddle 91 | bfgen.output("05.01.paddle_right_x.00.paddle_right_y.00.05.00.paddle_size.f0.f0.f0.") 92 | 93 | bfgen.output("05") 94 | 95 | bfgen.output("[") # main loop [ 96 | 97 | # delete ball 98 | bfgen.output("05.ball_x0.ball_x1.ball_y0.ball_y1.00.05.00.05.00.00.00.") 99 | 100 | # moves ball_x, handling over/underflow 101 | bfgen.output("ball_direction_x[-mem0+mem1+ball_direction_x]mem1[-ball_direction_x+mem1]+ball_x1-----[-mem0+ball_x1]mem0+++[mem1-]>") 102 | bfgen.output("[ball_y0+ball_x0[-ball_y0-ball_x0]ball_y0[-ball_x0+ball_y0]ball_x1+ball_x0[mem0+++++ball_x1-]>") 103 | bfgen.output("[mem0-----ball_x1-ball_y0]mem1-mem2]") 104 | bfgen.output("mem0---[-ball_x1+mem0]") 105 | 106 | bfgen.output("ball_direction_y[-mem0+ball_y1+ball_direction_y]mem0[-ball_direction_y+mem0]ball_y1-----") 107 | 108 | # reverse direction of ball_y if ball_y1 == 2 109 | bfgen.output("ball_y1[-mem0+mem2+ball_y1]mem1+") 110 | bfgen.output("mem2--[mem1-mem2[-]]") 111 | bfgen.output("mem1[-ball_direction_y++++++++++mem1]") 112 | bfgen.output("mem0[-ball_y1+mem0]") 113 | 114 | # reverse direction of ball_y if ball_y1 == 237 115 | bfgen.output("ball_y1[-mem0+mem2+ball_y1]mem1+") 116 | bfgen.output("mem2+++++++++++++++++++[mem1-mem2[-]]") 117 | bfgen.output("mem1[-ball_direction_y----------mem1]") 118 | bfgen.output("mem0[-ball_y1+mem0]") 119 | 120 | # check ball boundaries 121 | # mem0 = ball_x0-ball_x1, using ball_y0 as a buffer 122 | print("start boundaries check") 123 | bfgen.output("ball_x0[-ball_y0+mem1+ball_x0]ball_y0[-ball_x0+ball_y0]") 124 | bfgen.output("ball_x1[-ball_y0+mem5+ball_x1]ball_y0[-ball_x1+ball_y0]") 125 | bfgen.output("mem1+mem5[-mem6+mem7+mem5]mem6[-mem3+mem6]") 126 | print("check left boundary") 127 | # if mem0 == 13, reached left boundary 128 | bfgen.output("mem4+mem3-------------[mem4-]>") 129 | 130 | # algorithm (done in debugger, not converted here) to 131 | # bounce the ball if it hits the paddle or to reset 132 | # ball_x and ball_y to the center otherwise 133 | print(""" 134 | [ 135 | - 136 | copy ball_y to mem3 and paddle_left_y to mem4 137 | <<<<<<<<<<[-<+>>>>>>>>>>+<<<<<<<<<]<[->+<] 138 | <<<[->>>+>>>>>>>>>>>+<<<<<<<<<<<<<<]>>>[-<<<+>>>] 139 | >>>>>>>>>> 140 | if mem3 ge mem4 141 | [->-[>]<<]< (mem3 ends up = mem4 minus men3) 142 | [ 143 | then if mem3 ge 31 144 | >>>>+++++[<++++++>-]<+ 145 | <[->-[>]<<]< 146 | [then just clean up ->]< 147 | [else set mem0=1 ><<+>-]> 148 | ] 149 | >>[-]<<<[-]+< 150 | if mem0 eq 1 (ball hit left paddle) 151 | [ 152 | then change direction of the ball 153 | <<++++++++++>>- 154 | >-]> 155 | 156 | [< else reset ball_y 157 | >>[-]>>[-]<<<< 158 | <<<<<<[-]<<[-] 159 | +>+++[++>++[-<++++++>]<<]> 117 160 | [->+>+<<] 161 | <++++++++++[->++++<]>+>[-<+>] 158 162 | 163 | request a random char (ff 03 01 01 ff 01) 164 | >>.>++.>>[-]+..<<<.>--. 165 | >>->[-]>+>[-]>+>[-]>+>> 166 | read random char (mem6) and set mem1 and mem2 to (mem6 % 4) (in binary) 167 | ,[ 168 | - 169 | <<<< 170 | [-[<[-<->]<[->+<]+>>-->]>>[-]]<[<]>[-]<<++ 171 | >>+>> 172 | ]<<-<<-<<->> 173 | set the ball (x and y) directions based on mem1 and mem2 174 | [-<<<++++++++++>>>]<[-<<<++++++++++>>>] 175 | > 176 | ] 177 | >>> 178 | ] 179 | <<[-]<<[-]< 180 | """) 181 | 182 | bfgen.curPos = bfgen.labels["mem0"] 183 | 184 | # now repeat the check for mem0 = 47 (+256=303) (reached right boundary) 185 | bfgen.output("mem7[-mem0+mem7]") 186 | bfgen.output("mem1+mem0-----------------------------------------------[mem1-]>") 187 | bfgen.output("[ball_direction_x----------mem1-mem2]mem0[-]") 188 | bfgen.output("mem1[-]mem2[-]mem3[-]") 189 | print("end boundaries check") 190 | 191 | # draw new ball 192 | bfgen.output("05.ball_x0.ball_x1.ball_y0.ball_y1.00.05.00.05.f0.f0.00.") 193 | 194 | print("move right paddle (computer)") 195 | # move paddle_right_x 196 | bfgen.output("mem0+ball_direction_x[") # if ball_direction_x != 0 197 | 198 | bfgen.output("05.01.paddle_right_x.00.paddle_right_y.00.05.00.paddle_size.00.00.00.") 199 | 200 | # use ball_y0 as buffer to copy ball_y1 to mem2 and paddle_right_y to mem3 201 | bfgen.output("ball_y1[-ball_y0+mem2+ball_y1]ball_y0[-ball_y1+ball_y0]") 202 | bfgen.output("paddle_right_y[-ball_y0+mem3+paddle_right_y]ball_y0[-paddle_right_y+ball_y0]") 203 | # compare mem2 and mem3 204 | bfgen.output("mem5+mem3+++++++++++++++mem2[-mem3-[mem4]mem2]mem5") 205 | bfgen.curPos = bfgen.labels["mem4"] 206 | bfgen.output("[-") 207 | # mem2 >= mem3 208 | bfgen.output("paddle_right_x-----mem3") # must be 1 position before paddle_right_y 209 | bfgen.curPos = bfgen.labels["mem4"] 210 | 211 | bfgen.output("]mem5") 212 | 213 | # mem2 < mem3 214 | bfgen.output("[-") 215 | bfgen.output("paddle_right_y+++++mem5") 216 | 217 | bfgen.output("]mem3[-]mem2[-]") 218 | 219 | bfgen.output("05.01.paddle_right_x.00.paddle_right_y.00.05.00.paddle_size.f0.f0.f0.") 220 | bfgen.output("mem0-ball_direction_x[mem1+ball_direction_x-]") 221 | bfgen.output("]mem1[ball_direction_x+mem1-]mem0[-]") 222 | 223 | print("move left paddle (user input)") 224 | bfgen.output("ff.device+.-01.") # ff 02 01 (ff device command) 225 | bfgen.output("mem0,") # read char 226 | bfgen.output("mem0[,mem2+mem3+mem4+++[mem5[-mem4++++++mem5]mem3]") # if mem0 != 0, read another char and generate 115 ('s') 227 | bfgen.curPos = bfgen.labels["mem1"] 228 | bfgen.output("mem2[-mem0-mem2]mem1+mem0") 229 | bfgen.output("[----[>-]mem1[mem3+++++mem5+mem1-mem2]mem1[-]]") 230 | bfgen.output("mem2[mem5+++++>+]mem0[-]]") 231 | 232 | bfgen.output("ff.device.") 233 | 234 | bfgen.output("mem5[05.00.05.00.paddle_left_y.00.05.00.paddle_size.00.00.00.mem5[-]]") # delete left paddle 235 | bfgen.output("mem3[-paddle_left_y-mem2+mem3]") # paddle_left_y += mem3, set mem2 236 | bfgen.output("mem4[-paddle_left_y+mem2+mem4]") # paddle_left_y -= mem4, set mem2 237 | bfgen.output("mem2[05.00.05.00.paddle_left_y.00.05.00.paddle_size.f0.f0.f0.mem2[-]]") # redraw left paddle 238 | 239 | # draw right paddle 240 | bfgen.output("05.01.paddle_right_x.00.paddle_right_y.00.05.00.paddle_size.f0.f0.f0.") 241 | 242 | # return to initial position of the loop 243 | bfgen.output("05") 244 | 245 | bfgen.output("]") 246 | -------------------------------------------------------------------------------- /tests/pong.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import sys 4 | import struct 5 | 6 | w, h = 320, 240 7 | 8 | paddle_left_x = 10 9 | paddle_right_x = w - paddle_left_x 10 | paddle_w, paddle_h = 5, 30 11 | paddle_rgb = (254, 254, 254) 12 | paddle_movement = 10 13 | ball_x, ball_y = int(w/2), int(h/2) 14 | ball_w, ball_h = 5, 5 15 | ball_rgb = (254, 254, 0) 16 | ball_movement = 5 17 | ball_direction_x, ball_direction_y = -1, -1 18 | min_x, max_x = 10, w - 10 19 | min_y, max_y = 10, h - 10 20 | 21 | paddle_left_y = int(h/2) 22 | paddle_right_y = int(h/2) 23 | 24 | class Devices: 25 | TEXT = 0 26 | GRAPHIC = 1 27 | KEYBOARD = 2 28 | OS = 3 29 | 30 | 31 | def main(): 32 | global ball_x, ball_y, ball_direction_x, ball_direction_y 33 | 34 | sys.stdout.buffer.raw.write(switch_device(Devices.GRAPHIC)) 35 | 36 | # black screen 37 | sys.stdout.buffer.raw.write(draw_rectangle(0, 0, w, h, 0, 0, 0)) 38 | # draw left paddle 39 | sys.stdout.buffer.raw.write(draw_rectangle(paddle_left_x, int(paddle_left_y - paddle_h/2), paddle_w, paddle_h, *paddle_rgb)) 40 | # draw right paddle 41 | sys.stdout.buffer.raw.write(draw_rectangle(paddle_right_x, int(paddle_right_y - paddle_h/2), paddle_w, paddle_h, *paddle_rgb)) 42 | # draw ball 43 | sys.stdout.buffer.raw.write(move_ball(0, 0)) 44 | sys.stdout.flush() 45 | 46 | moves = 0 47 | sys.stdout.buffer.raw.write(switch_device(Devices.GRAPHIC)) 48 | while moves < 100: 49 | # device = GRAPHIC 50 | 51 | if check_ball_should_restart(): 52 | # delete ball 53 | sys.stdout.buffer.raw.write(draw_ball(ball_x, ball_y, (0, 0, 0))) 54 | ball_x, ball_y = int(w/2), int(h/2) 55 | 56 | sys.stdout.buffer.raw.write(switch_device(Devices.OS)) 57 | sys.stdout.buffer.raw.write(get_random(1)) 58 | sys.stdout.flush() 59 | c = sys.stdin.buffer.raw.read(1) 60 | ball_direction_x *= -(2 * (c[0] & 0x01) - 1) 61 | ball_direction_y *= -((c[0] & 0x02) - 1) 62 | sys.stdout.buffer.raw.write(switch_device(Devices.GRAPHIC)) 63 | 64 | # computer movement 65 | if ball_direction_x > 0 and paddle_right_y > ball_y: 66 | sys.stdout.buffer.raw.write(move_right_paddle_up()) 67 | elif ball_direction_x > 0 and paddle_right_y < ball_y: 68 | sys.stdout.buffer.raw.write(move_right_paddle_down()) 69 | 70 | sys.stdout.buffer.raw.write(move_ball(ball_movement*ball_direction_x, ball_movement*ball_direction_y)) 71 | sys.stdout.buffer.raw.write(move_ball(ball_movement*ball_direction_x, ball_movement*ball_direction_y)) 72 | 73 | sys.stdout.buffer.raw.write(switch_device(Devices.OS)) 74 | sys.stdout.buffer.raw.write(delay_ms(10)) 75 | sys.stdout.flush() 76 | # wait delay 77 | sys.stdin.buffer.raw.read(1) 78 | 79 | sys.stdout.buffer.raw.write(switch_device(Devices.KEYBOARD)) 80 | sys.stdout.buffer.raw.write(get_key_pressed()) 81 | sys.stdout.flush() 82 | 83 | v = sys.stdin.buffer.raw.read(1) 84 | if v == b'\x00': 85 | sys.stdout.buffer.raw.write(switch_device(Devices.GRAPHIC)) 86 | continue 87 | 88 | k = sys.stdin.buffer.raw.read(1) 89 | 90 | sys.stdout.buffer.raw.write(switch_device(Devices.GRAPHIC)) 91 | if k == b'w': 92 | sys.stdout.buffer.raw.write(move_left_paddle_up()) 93 | elif k == b's': 94 | sys.stdout.buffer.raw.write(move_left_paddle_down()) 95 | 96 | sys.stdout.flush() 97 | 98 | moves += 1 99 | 100 | def text(s): 101 | return s.encode('latin1') 102 | 103 | 104 | def switch_device(deviceNum): 105 | SPECIAL_CHAR = 0xff 106 | DEVICE_SELECTOR = 0x80 107 | return struct.pack(">BB", SPECIAL_CHAR, (DEVICE_SELECTOR+deviceNum)) 108 | 109 | 110 | def draw_rectangle(x, y, w, h, r, g, b): 111 | # FIXME: if any parameter is 0xff, they need to be escaped by another 0xff 112 | command = 5 113 | return struct.pack(">BHHHHBBB", command, x, y, w, h, r, g, b) 114 | 115 | def get_key_pressed(): 116 | command = 1 117 | return struct.pack(">B", command) 118 | 119 | def delay_ms(n): 120 | command = 0 121 | return struct.pack(">BH", command, n) 122 | 123 | def get_random(n): 124 | command = 1 125 | return struct.pack(">BB", command, n) 126 | 127 | def draw_ball(x, y, rgb): 128 | return draw_rectangle(int(x - ball_w/2), int(y - ball_h/2), ball_w, ball_h, *rgb) 129 | 130 | def move_ball(amount_x, amount_y): 131 | global ball_x, ball_y 132 | 133 | cmd = b'' 134 | # delete current ball 135 | cmd += draw_ball(ball_x, ball_y, (0, 0, 0)) 136 | 137 | ball_x += amount_x 138 | ball_y += amount_y 139 | # draw new ball 140 | cmd += draw_ball(ball_x, ball_y, ball_rgb) 141 | return cmd 142 | 143 | def move_paddle(paddle_x, paddle_y, direction_up): 144 | d = 1 if direction_up else -1; 145 | 146 | # delete top pixels 147 | cmd = draw_rectangle(paddle_x, int(paddle_y + d*paddle_h/2), paddle_w, paddle_movement, 0, 0, 0) 148 | # add top pixels 149 | cmd += draw_rectangle(paddle_x, int(paddle_y - d*paddle_h/2), paddle_w, paddle_movement, *paddle_rgb) 150 | 151 | return cmd 152 | 153 | def move_left_paddle_up(): 154 | global paddle_left_y 155 | 156 | if paddle_left_y - paddle_h/2 <= min_y: 157 | return b'' 158 | 159 | paddle_left_y = paddle_left_y - paddle_movement 160 | return move_paddle(paddle_left_x, paddle_left_y, True) 161 | 162 | def move_left_paddle_down(): 163 | global paddle_left_y 164 | 165 | if paddle_left_y + paddle_h/2 >= max_y: 166 | return b'' 167 | 168 | cmd = move_paddle(paddle_left_x, paddle_left_y, False) 169 | paddle_left_y = paddle_left_y + paddle_movement 170 | return cmd 171 | 172 | def move_right_paddle_up(): 173 | global paddle_right_y 174 | 175 | if paddle_right_y - paddle_h/2 <= min_y: 176 | return b'' 177 | 178 | paddle_right_y = paddle_right_y - paddle_movement 179 | return move_paddle(paddle_right_x, paddle_right_y, True) 180 | 181 | def move_right_paddle_down(): 182 | global paddle_right_y 183 | 184 | if paddle_right_y + paddle_h/2 >= max_y: 185 | return b'' 186 | 187 | cmd = move_paddle(paddle_right_x, paddle_right_y, False) 188 | paddle_right_y = paddle_right_y + paddle_movement 189 | return cmd 190 | 191 | def check_ball_should_restart(): 192 | global ball_direction_x, ball_direction_y 193 | 194 | if ball_x <= paddle_left_x: 195 | if ball_y > paddle_left_y - paddle_h/2 and ball_y < paddle_left_y + paddle_h/2: 196 | ball_direction_x *= -1 197 | else: 198 | return True 199 | 200 | if ball_x >= paddle_right_x: 201 | if ball_y > paddle_right_y - paddle_h/2 and ball_y < paddle_right_y + paddle_h/2: 202 | ball_direction_x *= -1 203 | else: 204 | return True 205 | 206 | if ball_y <= min_y or ball_y >= max_y: 207 | ball_direction_y *= -1 208 | 209 | return False 210 | 211 | if __name__ == "__main__": 212 | main() 213 | -------------------------------------------------------------------------------- /tests/sh.bf: -------------------------------------------------------------------------------- 1 | * invalid commands have undefined behavior 2 | * errors aren't handled (eg trying to delete a nonexisting file) 3 | 4 | echo {word} print word 5 | echo {word} >{path} print word to file 6 | ls {path} list files/dirs 7 | mkdir {path} mkdir path 8 | rm {path} remove file or empty dir 9 | cat {path} cat file 10 | 11 | in reality only the first letter is checked: 12 | "mkdir FOO" is equivalent to "monkeyFOO" for example 13 | 14 | 15 | {0} {255} {128} {1} {10} {32} {36}: 16 | >+>+>+>+[++>[-<++++>]<<]>> 17 | >+>+[+>++[-<+++++++>]<<]>[-<+>] 18 | +> 19 | ++++++++++> 20 | >>++++++++[<++++<++++>>-] 21 | <++++ 22 | 23 | 24 | >+sentinel 25 | >invalid command 26 | >rm 27 | >mkdir 28 | >ls 29 | >echo 30 | >cat 31 | 32 | +[ 33 | print prompt 34 | <<<<<<<[<] 35 | >.>. 36 | >>.>>.<. 37 | 38 | return to where we were before printing prompt 39 | [>]>>>>> 40 | read chars until char 10 (enter) is pressed 41 | [[<]<<<<<[<]>.>++.--<<.>[>]>>>>>[>],[<]<<<<<[<]>.>.[>]>>>>>[>]<.----------] 42 | 43 | <[<]++++++++[>+++++++++++<-]> 44 | [->-<] 45 | >[--[-------[-[-----[<]<]<]<]<]<+ 46 | <-[+<-] 47 | 48 | invalid >[-<<[->+>+<<]>[-<+>>+<]>---.+++++++++++++..[-] +>>>>>>[[-]>] -[+<-]] 49 | rm >[- switch to filesystem device & request rm and path <<<<<[<]>.>++++.---->++++.----[>]>>>>>>>>>>[++++++++++.>]. 50 | return cleaning <[[-]<] 51 | switch back to text device <<<<<<<<[<]>.>.[>] 52 | return to position >> 53 | read result and ignore ,[-] 54 | ] 55 | mkdir >[- switch to filesystem device & request mkdir and path <<<<<[<]>.>++++.---->+++.---[>]>>>>>>>>>>>>>[++++++++++.>]. 56 | return cleaning <[[-]<] 57 | switch back to text device <<<<<<<<[<]>.>.[>] 58 | return to position >>> 59 | read result and ignore ,[-] 60 | ] 61 | ls >[- switch to filesystem device & request ls and path <<<<<[<]>.>++++.----<<.>[>]>>>>>>>>>>[++++++++++.>]. 62 | zero path <[[-]<] 63 | switch back to text device <<<<<<<<[<]>.>.[>] 64 | sentinel+>>>> 65 | read zero terminated paths returned ,[ 66 | [>,]<[<]> 67 | read next path 68 | >[>]>>>, 69 | ] 70 | return to sentinel -[+<-]+> 71 | 72 | stat and print paths 73 | >>>[ 74 | <<< 75 | switch to filesystem device & request stat 76 | generate 255-. 77 | generate 132-[-->-<]>+++.>+.->[.>].<[<] 78 | switch back to text device -.+<----.[-]< 79 | read first byte of stat (isDir) ,[--->]>>>[<]<++++++++++[->+<<+++++++>] 80 | print isDir <.[-]> 81 | generate and print space ++++[-<++++++++>]<.> 82 | read and ignore higher bytes of size ,,, 83 | read lowest byte of size and treat it as a single decimal digit ,>[-<+++++>]<--print it.[-] 84 | print space <.[-]>>> 85 | [.>]> newline++++++++++.[-]>> 86 | ] 87 | return to sentinel zeroing cells -[[-]<-]+ 88 | return to initial position 89 | ->>>> 90 | ] 91 | echo >[>>>[>]>sentinel+++++[-<++++>]<++[<]>>>>[>----------------------]> 92 | [ 93 | found another space assume it's followed by a lessthan symbol [-] 94 | >[>]-. 97 | generate 132-[-->-<]>+++.<+++.--->[-] 98 | <+<]<] 99 | count and send writeLength<< [[->>+<<]>[-<+>]<+<]...>----.>> 100 | set a flag indicating we're writing to file <<<<<<+>>>>>> 101 | advance to filename [>]> 102 | print filename [++++++++++.>]. 103 | <[[-]<]<[<]<[-] 104 | >>[>]> 105 | ] 106 | <[-]<[<]>>>>>[++++++++++++++++++++++++++++++++.>]<[[-]<] 107 | return to known position -[+<-] 108 | <[ 109 | flag indicating we're writing to file is set 110 | expect to read the return value (and ignore it) ,[-] 111 | ]> 112 | ] 113 | cat >[- switch to filesystem device & request read and path <<<<<<<[<]>.>++++.---->+.---........++[>]>>>>>>>>>>>[++++++++++.>]. 114 | return cleaning <[[-]<] 115 | switch back to text device <<<<<<<<[<]>.>.[>] 116 | return to position >>>>>> 117 | while result print ,[.,] print newline ++++++++++.[-] 118 | ] 119 | >[-] 120 | 121 | reset sentinel <<<<<<<+>>>>>> 122 | + 123 | ] 124 | 125 | -------------------------------------------------------------------------------- /vm/__init__.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import threading 3 | import time 4 | import tkinter as tk 5 | import tkinter.scrolledtext as scrolledtext 6 | 7 | class Vm(threading.Thread): 8 | class Mode: 9 | TEXT = 0 10 | GRAPHIC = 1 11 | 12 | def __init__(self): 13 | self.mode = self.Mode.TEXT 14 | self.isReady = False 15 | self.keyPressed = None 16 | self.inBuf = None 17 | 18 | threading.Thread.__init__(self) 19 | self.start() 20 | 21 | def clearText(self): 22 | self.text.delete('1.0', tk.END) 23 | 24 | def putc(self, b): 25 | self.setMode(self.Mode.TEXT) 26 | 27 | self.text.insert('end', '%s' % b) 28 | self.text.see(tk.END) 29 | 30 | def drawRect(self, x, y, w, h, color): 31 | self.setMode(self.Mode.GRAPHIC) 32 | 33 | self.canvas.create_rectangle(x, y, x+w, y+h, fill=color, width=0) 34 | 35 | def refreshGraphic(self): 36 | self.setMode(self.Mode.GRAPHIC) 37 | 38 | self.canvas.update() 39 | 40 | def waitChar(self): 41 | # only initialize inBuf after the first waitChar call 42 | # (ie ignore previous keypresses) 43 | if self.inBuf is None: 44 | self.inBuf = [] 45 | 46 | k = '' 47 | while k == '': 48 | while not self.inBuf: 49 | time.sleep(0.01) 50 | 51 | k, self.inBuf = self.inBuf[0], self.inBuf[1:] 52 | 53 | if k == '': 54 | print(f"Got empty key", file=sys.stderr) 55 | 56 | 57 | # handle newline as char 10 58 | if k == '\x0D': 59 | k = '\x0A' 60 | 61 | print(f"Key pressed: {ord(k)}", file=sys.stderr) 62 | return k 63 | 64 | 65 | def onKeyPress(self, event): 66 | # only save keypresses to inBuf after it's initialized 67 | # FIXME: add mutex 68 | if self.inBuf is not None: 69 | self.inBuf.append(event.char) 70 | 71 | # TODO: add support for multiple keypress? 72 | self.keyPressed = event.char 73 | 74 | def onKeyRelease(self, event): 75 | # TODO: add support for multiple keypress? 76 | self.keyPressed = None 77 | 78 | def getKeyPressed(self): 79 | return self.keyPressed 80 | 81 | def setMode(self, mode): 82 | if mode == self.mode: 83 | return 84 | 85 | if mode == self.Mode.TEXT: 86 | self.canvas.pack_forget() 87 | self.text.pack() 88 | self.root.geometry(f"{self.text_width_height[0]}x{self.text_width_height[1]}") 89 | elif mode == self.Mode.GRAPHIC: 90 | self.text.pack_forget() 91 | self.canvas.pack() 92 | self.root.geometry(f"{self.canvas_height_width[0]}x{self.canvas_height_width[1]}") 93 | 94 | self.mode = mode 95 | 96 | def run(self): 97 | self.root = tk.Tk() 98 | 99 | self.text_rows_columns = (25, 80) 100 | self.canvas_height_width = (320, 240) 101 | 102 | self.text = scrolledtext.ScrolledText(self.root, background='black', foreground='white', font=('Courier', 16), height=self.text_rows_columns[0], width=self.text_rows_columns[1]) 103 | self.text.pack() 104 | self.text.update() 105 | self.text_width_height = (self.text.winfo_width(), self.text.winfo_height()) 106 | 107 | self.canvas = tk.Canvas(self.root, width=self.canvas_height_width[0], height=self.canvas_height_width[1]) 108 | self.canvas.pack() 109 | #self.canvas.scale(tk.ALL, 0, 0, 10.0, 10.0) 110 | 111 | self.root.bind('', self.onKeyPress) 112 | self.root.bind('', self.onKeyRelease) 113 | 114 | self.setMode(self.mode) 115 | self.isReady = True 116 | self.root.mainloop() 117 | 118 | def waitReady(self): 119 | while not self.isReady: 120 | continue 121 | --------------------------------------------------------------------------------