Shell & multishell

Author: neumond

computercraft/lua.py

@@ -10,6 +10,14 @@ def get_expr_code(self):
         raise NotImplementedError
 
 
+class ArbLuaExpr(LuaExpr):
+    def __init__(self, code: str):
+        self._code = code
+
+    def get_expr_code(self):
+        return self._code
+
+
 def lua_string(v):
     return '"{}"'.format(
         v.replace('\\', '\\\\')

computercraft/subapis/multishell.py

@@ -1,5 +1,7 @@
+from typing import Optional
+
 from .base import BaseSubAPI
-from ..rproc import integer, string, nil, boolean
+from ..rproc import integer, nil, boolean, option_string
 
 
 class MultishellAPI(BaseSubAPI):
@@ -9,18 +11,16 @@ async def getCurrent(self) -> int:
     async def getCount(self) -> int:
         return integer(await self._send('getCount'))
 
-    async def launch(self, programPath: str, *args: str, environment: dict = None) -> int:
-        if environment is None:
-            environment = {}
+    async def launch(self, environment: dict, programPath: str, *args: str) -> int:
         return integer(await self._send('launch', environment, programPath, *args))
 
     async def setTitle(self, tabID: int, title: str):
         return nil(await self._send('setTitle', tabID, title))
 
-    async def getTitle(self, tabID: int) -> str:
-        return string(await self._send('getTitle', tabID))
+    async def getTitle(self, tabID: int) -> Optional[str]:
+        return option_string(await self._send('getTitle', tabID))
 
-    async def setFocus(self, tabID: int):
+    async def setFocus(self, tabID: int) -> bool:
         return boolean(await self._send('setFocus', tabID))
 
     async def getFocus(self) -> int:

computercraft/subapis/shell.py

@@ -1,7 +1,7 @@
-from typing import List, Dict
+from typing import List, Dict, Optional
 
 from .base import BaseSubAPI
-from ..rproc import nil, string, boolean, integer, array_string, fact_mono_dict
+from ..rproc import nil, string, boolean, integer, array_string, fact_mono_dict, option_string
 
 
 map_string_string = fact_mono_dict(string, string)
@@ -26,8 +26,8 @@ async def setPath(self, path: str):
     async def resolve(self, localPath: str) -> str:
         return string(await self._send('resolve', localPath))
 
-    async def resolveProgram(self, name: str) -> str:
-        return string(await self._send('resolveProgram', name))
+    async def resolveProgram(self, name: str) -> Optional[str]:
+        return option_string(await self._send('resolveProgram', name))
 
     async def aliases(self) -> Dict[str, str]:
         return map_string_string(await self._send('aliases'))
@@ -44,10 +44,13 @@ async def programs(self, showHidden: bool = None) -> List[str]:
     async def getRunningProgram(self) -> str:
         return string(await self._send('getRunningProgram'))
 
-    async def run(self, command: str, *args: List[str]):
+    async def run(self, command: str, *args: str) -> bool:
         return boolean(await self._send('run', command, *args))
 
-    async def openTab(self, command: str, *args: List[str]) -> int:
+    async def execute(self, command: str, *args: str) -> bool:
+        return boolean(await self._send('execute', command, *args))
+
+    async def openTab(self, command: str, *args: str) -> int:
         return integer(await self._send('openTab', command, *args))
 
     async def switchTab(self, tabID: int):
@@ -59,6 +62,11 @@ async def complete(self, prefix: str) -> List[str]:
     async def completeProgram(self, prefix: str) -> List[str]:
         return array_string(await self._send('completeProgram', prefix))
 
-    # TODO: autocomplete functions
-    # async def setCompletionFunction(self, path: str)
-    # async def getCompletionInfo(self) -> LuaTable
+    # these functions won't be implemented
+    # it's far better to keep this in lua code
+
+    # setCompletionFunction
+    # getCompletionInfo
+
+    # we can create callbacks to python code, but this will require
+    # connection to python, and will break the shell if python disconnects

testmod.py

@@ -1543,4 +1543,93 @@ async def test_pocket(api):
     await api.print('Test finished successfully')
 
 
+async def test_multishell(api):
+    from computercraft.subapis.multishell import MultishellAPI
+    tbl = await get_object_table(api, 'multishell')
+    assert get_class_table(MultishellAPI) == tbl
+
+    await step(api, 'Close all additional shells')
+
+    assert await api.multishell.getCount() == 1
+    assert await api.multishell.getCurrent() == 1
+    assert await api.multishell.getFocus() == 1
+    assert isinstance(await api.multishell.getTitle(1), str)
+
+    title = f'new title {random.randint(1, 1000000)}'
+    assert await api.multishell.setTitle(1, title) is None
+    assert await api.multishell.getTitle(1) == title
+
+    assert await api.multishell.setFocus(1) is True
+    assert await api.multishell.setFocus(0) is False
+    assert await api.multishell.setFocus(2) is False
+
+    assert await api.multishell.getTitle(2) is None
+
+    assert await api.multishell.launch({}, 'rom/programs/fun/hello.lua') == 2
+    assert isinstance(await api.multishell.getTitle(2), str)
+
+    await api.print('Test finished successfully')
+
+
+async def test_shell(api):
+    from computercraft.subapis.shell import ShellAPI
+    tbl = await get_object_table(api, 'shell')
+
+    del tbl['function']['setCompletionFunction']
+    del tbl['function']['getCompletionInfo']
+    assert get_class_table(ShellAPI) == tbl
+
+    assert await api.shell.complete('ls ro') == ['m/', 'm']
+    assert await api.shell.completeProgram('lu') == ['a']
+
+    ps = await api.shell.programs()
+    assert 'shutdown' in ps
+
+    als = await api.shell.aliases()
+    assert 'ls' in als
+    assert als['ls'] == 'list'
+    assert 'xls' not in als
+    assert await api.shell.setAlias('xls', 'list') is None
+    als = await api.shell.aliases()
+    assert 'xls' in als
+    assert als['xls'] == 'list'
+    assert await api.shell.clearAlias('xls') is None
+    als = await api.shell.aliases()
+    assert 'xls' not in als
+
+    assert await api.shell.getRunningProgram() == 'py'
+
+    assert await api.shell.resolveProgram('doesnotexist') is None
+    assert await api.shell.resolveProgram('hello') == 'rom/programs/fun/hello.lua'
+
+    assert await api.shell.dir() == ''
+    assert await api.shell.resolve('doesnotexist') == 'doesnotexist'
+    assert await api.shell.resolve('startup.lua') == 'startup.lua'
+    assert await api.shell.setDir('rom') is None
+    assert await api.shell.dir() == 'rom'
+    assert await api.shell.resolve('startup.lua') == 'rom/startup.lua'
+    assert await api.shell.setDir('') is None
+
+    assert isinstance(await api.shell.path(), str)
+    assert await api.shell.setPath(await api.shell.path()) is None
+
+    assert await api.shell.execute('hello') is True
+    assert await api.shell.run('hello') is True
+    assert await api.shell.execute('doesnotexist') is False
+    assert await api.shell.run('doesnotexist') is False
+
+    tab = await api.shell.openTab('hello')
+    assert isinstance(tab, int)
+
+    await step(api, f'Program has been launched in tab {tab}')
+
+    assert await api.shell.switchTab(tab) is None
+
+    await step(api, 'Computer will shutdown after test due to shell.exit')
+
+    assert await api.shell.exit() is None
+
+    await api.print('Test finished successfully')
+
+
 # vector won't be implemented, use python equivalent