{ "info": { "author": "Alex Socha", "author_email": "alex@alexsocha.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# MIPS++ Programming Language\n[![Build Status](https://travis-ci.com/alexsocha/mipsplusplus.svg?branch=master)](https://travis-ci.com/alexsocha/mipsplusplus)\n[![PyPI version](https://badge.fury.io/py/mipsplusplus.svg)](https://badge.fury.io/py/mipsplusplus)\n\n\n\n**MIPS++** is a low-level programming language based on the [MIPS architecture](https://en.wikipedia.org/wiki/MIPS_architecture). Its purpose is to generate faithful MIPS assembly code using a clearer syntax, with a focus on optimization. It is also a superset of MIPS.\n\nCurrent features include arithmetic expressions, data types, register aliases (i.e. local variables), conditional jumps and arrays.\n\n## Usage\n\nInstalling:\n```\npip install mipsplusplus\n```\n\nCommand line:\n```\npython -m mipsplusplus path/to/source.mpp -o output.asm\n--comments 1 --registers \"$t0\" \"$t1\" \"$t1\"\n```\n\nPython:\n```python\nimport mipsplusplus\n\ncompiled = mipsplusplus.compile(lines=source.readlines(),\n comments=1, registers=['$t0', '$t1', '$t2'])\n```\n\n### Optional Parameters\n* **comments:** The level of commenting in the generated MIPS code.\n0 = None, 1 = Minimal, 2 = Almost every line. Defaults to 1.\n\n* **registers:** List of temporary registers (in order) for the compiler to use where necessary. These should not be used to store variables as they may be overridden. The compiler will indicate if more are required for any particular statement. Defaults to `[$t0, $t1, $t2]`.\n\n## Syntax Example\nThe following program converts a decimal number to an arbitrary base.\n```ruby\n.data\nbyte[30] digits\nstring numPrompt = \"Enter number: \"\nstring basePrompt = \"Enter base: \"\nstring convertedInfo = \"Converted: \"\n\n.text\n@alias $num = $t3, $base = $t4, $i = $t5\n\nprint numPrompt\n$num = input()\n\nprint basePrompt\n$base = input()\n\n$i = 0\ncalcLoop:\n digits[$i] = $num % $base\n $num = $num / $base\n\n $i = $i + 1\n goto calcLoop if $num > 0\n\nprint convertedInfo\nprintLoop:\n $i = $i - 1\n goto endPrintLoop if i < 0\n\n @alias $digit = $t3\n $digit = digits[$i]\n\n goto printAsChar if $digit > 9\n\n print $digit\n goto printLoop\n\n printAsChar:\n print (55 + $digit) as char\n goto printLoop\nendPrintLoop:\nexit\n```\n\n## Language Reference\n### Definitions\n```ruby\n.data\n# Numeric\nint x = 123456789 # 4 bytes\nshort y = -32000 # 2 bytes\nbyte z = 64 # 1 byte\nchar letter = 'C' # 1 byte\n\n# Addresses/arrays\nstring greeting = \"hello\"\nchar[20] name # Empty string with space for 20 characters\n\nint[] numbers = [20, -65, 42]\nbyte[30] byteArray\n\n.text\n# ...code\n```\n\n### Registers and Variables\n```ruby\n# Any register can be given an alias, which remains\n# for all following lines or until it is reassigned\n@alias $num = $t3, $array = $t4, $character = $t5\n\n# Direct register assignment\n$num = 42\n$character = 'K'\n\n# Loading from defined variables\n$num = x\n$array = numbers\n$character = letter\n\n# Saving to defined variables\nx = $num\nletter = 'M'\ny = letter # Uses ASCII value\n```\n\n### Operators\n```ruby\n# Standard\n$num = (x + y) / (z - 7)\n$num = neg $num * (y % 8)\n\n# Boolean logic\n$true = 1\n$false = 0\n$bool = not ($true and $false) nor $true xor ($true or $false)\n\n# Bitwise\n$num = (1 << 4) and ($num >> 1) # Zeros are shifted in\n$num = -8 >>> 2 # The sign bit is shifted in\n# Note that <<< is not an operator\n\n# Comparison\n$condition = z < 200\n# Note that this is the only comparison operator\n# which can be used in arbitrary expressions\n```\n\n### Addresses\n```ruby\n# Addresses\n$numAddress = addressof x # Requires explicit 'addressof' operator\n$stringAddress = greeting\n$arrayAddress = numbers\n\n$offsetAddress = $numbers + 4\n$offsetAddress = addressof $numbers[4] # Equivalent to previous line\n```\n\n### Arrays\n```ruby\n# Byte arrays\n$num = byteArray[3]\nbyteArray[4] = 42 + $num - z\n\n# Integer arrays\n# (indexes must be multiplied by the number\n# of bytes in the corresponding data type)\nnum = numbers[$index * 4] \nnumbers[24] = 32 # Sets the 6th element\n\n# Ambiguous arrays\n$array = someArray\n\n# - Explicit\n$num = $array[0] as int # Load value as int\n$array[4] as int = $num # Store value as int\n\n# - Implied\n$array[8] = 42 # Store int\n$array[9] = 42 as byte # Store byte\n$array[10] = $num + y + 3 # Store short\n$array[11] = $array[12] as char # Load and store char (byte)\n\n# - Combined\n$array1[13] as int = 6 * ($array2[$i * 2] as short) # Load short, store int\n$array3[14] = (22 - numbers[$i * 4]) as byte # Load int, store byte\n```\n\n### Control Flow\n```ruby\nlabel:\n # ...\n\n# Jumping to labels\ngoto label\ngotolink label # Return address is stored in $ra\n\n# Jumping to addresses in registers\n$storedLabel = label # (addressof label)\ngoto $storedLabel\n\n# Conditional jumps\n# (supports all comparison operators)\ngoto label if x > 9\ngoto label if $num + 4 != x\ngoto $storedLabel if $num % 7 <= x / y\ngoto $storedLabel if $condition1 and x < 8 # ($condition1 and x < 8) > 0\n\n# - With link (only < 0 and >= 0)\ngotolink label if $num < 0\ngotolink $storedLabel if $num >= 0\n```\n\n### System Functions\n```ruby\n# Printing\nprint $num\nprint greeting\nprint $character as char\n\n# Input integer\n$num = input()\nx = input() + 6\ninput() # Value is stored in $v0\n\n# Input string\ninputstr name\ninputstr addressof $array[8]\ninputstr $location, 40 # Max length 40\n\n# Memory allocation\naddress = alloc(50) # Alocate 50 bytes, store first address as int\n$array = alloc(20) + 4 # Offset by 4\nalloc(80) # Address is stored in $v0\n\n# Exit\nexit\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/alexsocha/mipsplusplus", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "mipsplusplus", "package_url": "https://pypi.org/project/mipsplusplus/", "platform": "", "project_url": "https://pypi.org/project/mipsplusplus/", "project_urls": { "Homepage": "https://github.com/alexsocha/mipsplusplus" }, "release_url": "https://pypi.org/project/mipsplusplus/0.0.1b4/", "requires_dist": null, "requires_python": "", "summary": "A low-level programming language based on the MIPS architecture.", "version": "0.0.1b4" }, "last_serial": 4171730, "releases": { "0.0.1b1": [ { "comment_text": "", "digests": { "md5": "48de42400e3a579ef78346e3b9462a50", "sha256": "7cfd3895e3d484a1bde2eb8af407a44d5636468cb5012ef8367b56061c31db04" }, "downloads": -1, "filename": "mipsplusplus-0.0.1b1-py3-none-any.whl", "has_sig": false, "md5_digest": "48de42400e3a579ef78346e3b9462a50", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15606, "upload_time": "2018-08-11T11:42:17", "url": "https://files.pythonhosted.org/packages/66/2c/87ca906d34b6f731ec596e6d2a73149a7817c0e66b3257cbc49789d3c75c/mipsplusplus-0.0.1b1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "992a7970767e51e5e2a0f06ca574e4d0", "sha256": "2cb5334a478be731e5ec1cfdf9ba4ee76b0d48aa03c487d0ec73e5bb84975168" }, "downloads": -1, "filename": "mipsplusplus-0.0.1b1.tar.gz", "has_sig": false, "md5_digest": "992a7970767e51e5e2a0f06ca574e4d0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 12963, "upload_time": "2018-08-11T11:42:19", "url": "https://files.pythonhosted.org/packages/8a/19/0e73af03bc68c1ce76d605aa07064582a83c346f4c2b64b000a61be61fc7/mipsplusplus-0.0.1b1.tar.gz" } ], "0.0.1b2": [ { "comment_text": "", "digests": { "md5": "2f58f3e0340429993f572b9245500fc3", "sha256": "1dd63115fdf6eee4876797be620bc9fd3ce5a90b842525b2838fb421f6a99f68" }, "downloads": -1, "filename": "mipsplusplus-0.0.1b2-py3-none-any.whl", "has_sig": false, "md5_digest": "2f58f3e0340429993f572b9245500fc3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 16997, "upload_time": "2018-08-12T12:32:07", "url": "https://files.pythonhosted.org/packages/61/4b/d0df53bc43f6117e05b553b8284a4d6d3af56c5d5962b3c7c9855c2aceea/mipsplusplus-0.0.1b2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6b54a5dab9384c71c99d230d61f7565f", "sha256": "663cfd4410640b0c33a974e04d6b0cf1e138b4254947d3f004888f3238fe8713" }, "downloads": -1, "filename": "mipsplusplus-0.0.1b2.tar.gz", "has_sig": false, "md5_digest": "6b54a5dab9384c71c99d230d61f7565f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15708, "upload_time": "2018-08-12T12:32:09", "url": "https://files.pythonhosted.org/packages/3f/d6/0ccf0b2b0678943dd4144780b5eba0f33a17cd0b24cb22e43f30d4ad66ec/mipsplusplus-0.0.1b2.tar.gz" } ], "0.0.1b3": [ { "comment_text": "", "digests": { "md5": "430536c8cd209753ef1731d8c7dcb806", "sha256": "de3fbd7fb2025626273ce49be817b6c17587e9e24045feaf03fed0e7a29b129d" }, "downloads": -1, "filename": "mipsplusplus-0.0.1b3-py3-none-any.whl", "has_sig": false, "md5_digest": "430536c8cd209753ef1731d8c7dcb806", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17012, "upload_time": "2018-08-13T06:45:26", "url": "https://files.pythonhosted.org/packages/f9/46/2f0be23ea50d2f9a0cefd9b9be30c2638dde0bf41c44d19eb8630485bd48/mipsplusplus-0.0.1b3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6eeb98712dec01c441fbf37fadf256d1", "sha256": "231051272bf78ef46c5287c64a7e33b3aa7cb466504b0e814686f27edc6b6218" }, "downloads": -1, "filename": "mipsplusplus-0.0.1b3.tar.gz", "has_sig": false, "md5_digest": "6eeb98712dec01c441fbf37fadf256d1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15728, "upload_time": "2018-08-13T06:45:29", "url": "https://files.pythonhosted.org/packages/f8/ea/adac1c8f50c5a7a1b2dac42420589701e64d12a0f42d3b6ac84619ff313c/mipsplusplus-0.0.1b3.tar.gz" } ], "0.0.1b4": [ { "comment_text": "", "digests": { "md5": "cf636ebb59e06d4578c3e6b1ef0edd0b", "sha256": "a9c25f60167ac39f2daac72e20682336d6726c42a24fe3ddb10faae5f990f059" }, "downloads": -1, "filename": "mipsplusplus-0.0.1b4-py3-none-any.whl", "has_sig": false, "md5_digest": "cf636ebb59e06d4578c3e6b1ef0edd0b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17069, "upload_time": "2018-08-15T04:26:30", "url": "https://files.pythonhosted.org/packages/05/7a/1e1735434aaa7fd9af0ebb30ee014ca04f9d6e7265f203d7c75c30d9ad12/mipsplusplus-0.0.1b4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b357cef79664e0e77730dc93b0621d74", "sha256": "de38fe3cdf5b92f05ec53aaa63fad0d0e89286019d70ae0d312b7f9060eab9ab" }, "downloads": -1, "filename": "mipsplusplus-0.0.1b4.tar.gz", "has_sig": false, "md5_digest": "b357cef79664e0e77730dc93b0621d74", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15787, "upload_time": "2018-08-15T04:26:31", "url": "https://files.pythonhosted.org/packages/1a/d7/9fec9acb430071929be1eed2e01942660243e8ebe44f2caf60479a3aa696/mipsplusplus-0.0.1b4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "cf636ebb59e06d4578c3e6b1ef0edd0b", "sha256": "a9c25f60167ac39f2daac72e20682336d6726c42a24fe3ddb10faae5f990f059" }, "downloads": -1, "filename": "mipsplusplus-0.0.1b4-py3-none-any.whl", "has_sig": false, "md5_digest": "cf636ebb59e06d4578c3e6b1ef0edd0b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 17069, "upload_time": "2018-08-15T04:26:30", "url": "https://files.pythonhosted.org/packages/05/7a/1e1735434aaa7fd9af0ebb30ee014ca04f9d6e7265f203d7c75c30d9ad12/mipsplusplus-0.0.1b4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b357cef79664e0e77730dc93b0621d74", "sha256": "de38fe3cdf5b92f05ec53aaa63fad0d0e89286019d70ae0d312b7f9060eab9ab" }, "downloads": -1, "filename": "mipsplusplus-0.0.1b4.tar.gz", "has_sig": false, "md5_digest": "b357cef79664e0e77730dc93b0621d74", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 15787, "upload_time": "2018-08-15T04:26:31", "url": "https://files.pythonhosted.org/packages/1a/d7/9fec9acb430071929be1eed2e01942660243e8ebe44f2caf60479a3aa696/mipsplusplus-0.0.1b4.tar.gz" } ] }