CC:T improve window & term apis

Author: neumond

computercraft/back.lua

@@ -9,6 +9,7 @@ local _py = {
     coparams = {},
     modules = {},
     mcache = {},
+    temp = {},
 }
 
 if type(getfenv) == 'function' then
@@ -20,8 +21,7 @@ elseif type(_G) == 'table' then
 else
     error('E001: Can\'t get environment')
 end
--- TODO: rename temp to _pytemp
-_py.genv.temp = {}
+_py.genv.temp = _py.temp
 _py.genv._m = _py.modules
 
 if type(loadstring) == 'function' then
@@ -183,6 +183,10 @@ function _py.deserialize(stream)
         local slen = tonumber(stream.tostop('>'))
         local fn = assert(_py.loadstring(stream.fixed(slen)))
         return fn()
+    elseif tok == 'X' then
+        local slen = tonumber(stream.tostop('>'))
+        local key = stream.fixed(slen)
+        return _py.temp[key]
     elseif tok == '{' then
         local r = {}
         while true do

computercraft/lua.py

@@ -8,3 +8,8 @@
 class LuaExpr:
     def get_expr_code(self):
         raise NotImplementedError
+
+
+class TempObject:
+    def __init__(self, fid: bytes):
+        self._fid = fid

computercraft/oc/filesystem.py

@@ -164,18 +164,20 @@ def copy(fromPath: str, toPath: str) -> bool:
 
 
 class File(ContextObject):
+    CALL_OP = b':'
+
     def read(self, n: int) -> Optional[bytes]:
-        r = self._call(b':read', n)
+        r = self._call(b'read', n)
         r.check_nil_error(allow_nil_nil=True)
         return r.take_option_bytes()
 
     def seek(self, whence: str, offset: int = 0) -> int:
-        r = self._call(b':seek', whence, offset)
+        r = self._call(b'seek', whence, offset)
         r.check_nil_error()
         return r.take_int()
 
     def write(self, data: bytes) -> bool:
-        r = self._call(b':write', data)
+        r = self._call(b'write', data)
         r.check_nil_error()
         return r.take_bool()
 

computercraft/ser.py

@@ -52,6 +52,8 @@ def serialize(v: Any, encoding: str) -> bytes:
     elif isinstance(v, lua.LuaExpr):
         code = v.get_expr_code()
         return 'E{}>'.format(len(code)).encode('ascii') + code
+    elif isinstance(v, lua.TempObject):
+        return 'X{}>'.format(len(v._fid)).encode('ascii') + v._fid
     else:
         raise ValueError('Value can\'t be serialized: {}'.format(repr(v)))
 

computercraft/sess.py

@@ -15,7 +15,7 @@
 
 from greenlet import greenlet, getcurrent as get_current_greenlet
 
-from . import rproc, ser
+from . import rproc, ser, lua
 
 
 __all__ = (
@@ -211,32 +211,32 @@ def lua_context_object(
     try:
         yield fid
     finally:
+        f = finalizer_template.replace(b'{e}', b'temp[n]')
+        if f:
+            f += b';'  # important to not have ;;
         eval_lua(
-            b'local n=...;'
-            + finalizer_template.replace(b'{e}', b'temp[n]')
-            + b';temp[n]=nil', fid)
+            b'local n=...;' + f + b'temp[n]=nil', fid)
 
 
-class ContextObject:
-    # TODO: support serializing this object
-
-    def __init__(self, fid):
-        self._fid = fid
+class _TempObjectExt:
+    CALL_OP = b'.'
 
     def _call(self, method: bytes, *args):
         return eval_lua(
             b'return(function(n,...)return temp[n]'
+            + self.CALL_OP
             + method
             + b'(...);end)(...)', self._fid, *args)
 
 
-def eval_lua_method_factory(obj):
-    # TODO: remove this
-    # eval strings must be cacheable
-    def method(name, *params):
-        code = 'return ' + obj + name + '(...)'
-        return eval_lua(code, *params)
-    return method
+class ContextObject(_TempObjectExt, lua.TempObject):
+    pass
+
+
+class ReferenceObject(_TempObjectExt, lua.TempObject):
+    def __init__(self, lua_context_gen):
+        self._g = lua_context_gen  # keep the reference
+        self._fid = self._g.__enter__()
 
 
 class CCGreenlet:

computercraft/subapis/fs.py

@@ -31,7 +31,7 @@
 class SeekMixin:
     def seek(self, whence: str = None, offset: int = None) -> int:
         # whence: set, cur, end
-        rp = self._call(b'.seek', whence, offset)
+        rp = self._call(b'seek', whence, offset)
         rp.check_nil_error()
         return rp.take_int()
 
@@ -41,13 +41,13 @@ def _take(self, rp):
         raise NotImplementedError
 
     def read(self, count: int = 1) -> Optional[str]:
-        return self._take(self._call(b'.read', count))
+        return self._take(self._call(b'read', count))
 
     def readLine(self, withTrailing: bool = False) -> Optional[str]:
-        return self._take(self._call(b'.readLine', withTrailing))
+        return self._take(self._call(b'readLine', withTrailing))
 
     def readAll(self) -> Optional[str]:
-        return self._take(self._call(b'.readAll'))
+        return self._take(self._call(b'readAll'))
 
     def __iter__(self):
         return self
@@ -64,10 +64,10 @@ def _put(self, t):
         raise NotImplementedError
 
     def write(self, text: str) -> None:
-        return self._call(b'.write', self._put(text)).take_none()
+        return self._call(b'write', self._put(text)).take_none()
 
     def flush(self) -> None:
-        return self._call(b'.flush').take_none()
+        return self._call(b'flush').take_none()
 
 
 class ReadHandle(ReadMixin, ContextObject):

computercraft/subapis/term.py

@@ -2,7 +2,7 @@
 from typing import Tuple
 
 from .. import ser
-from ..sess import eval_lua, lua_context_object, ContextObject
+from ..sess import eval_lua, lua_context_object, ReferenceObject
 
 
 __all__ = (
@@ -25,8 +25,10 @@
     'setPaletteColor',
     'nativePaletteColor',
     'redirect',
-    # 'get_current_target',
-    # 'get_native_target',
+    'current',
+    'native',
+    'get_current_target',
+    'get_native_target',
 )
 
 
@@ -86,10 +88,6 @@ def setPaletteColor(self, colorID: int, r: float, g: float, b: float) -> None:
         return self._call(b'setPaletteColor', colorID, r, g, b).take_none()
 
 
-class TermTarget(ContextObject, TermMixin):
-    pass
-
-
 class _Proxy(TermMixin):
     def _call(self, method, *args):
         return eval_lua(b'G:term:M:' + method, *args)
@@ -122,6 +120,10 @@ def nativePaletteColor(colorID: int) -> Tuple[float, float, float]:
     return tuple(rp.take_number() for _ in range(3))
 
 
+class TermTarget(ReferenceObject, TermMixin):
+    pass
+
+
 @contextmanager
 def redirect(target: TermTarget):
     with lua_context_object(
@@ -132,11 +134,14 @@ def redirect(target: TermTarget):
         yield
 
 
-# TODO: implement
+def current() -> TermTarget:
+    return TermTarget(lua_context_object(b'term.current()', ()))
+
 
-# def get_current_target() -> TermTarget:
-#     return TermTarget('term.current()')
+def native() -> TermTarget:
+    return TermTarget(lua_context_object(b'term.native()', ()))
 
 
-# def get_native_target() -> TermTarget:
-#     return TermTarget('term.native()')
+# compat
+get_current_target = current
+get_native_target = native

computercraft/subapis/window.py

@@ -1,43 +1,37 @@
-from contextlib import contextmanager
 from typing import Tuple
 
-from ..sess import lua_context_object, ContextObject
+from ..sess import lua_context_object, ReferenceObject
 from .term import TermMixin, TermTarget
 
 
-__all__ = (
-    'create',
-)
+__all__ = ('create', )
 
 
-class TermWindow(ContextObject, TermMixin):
+class TermWindow(ReferenceObject, TermMixin):
     def setVisible(self, visibility: bool) -> None:
-        return self._call(b'.setVisible', visibility).take_none()
+        return self._call(b'setVisible', visibility).take_none()
 
     def redraw(self) -> None:
-        return self._call(b'.redraw').take_none()
+        return self._call(b'redraw').take_none()
 
     def restoreCursor(self) -> None:
-        return self._call(b'.restoreCursor').take_none()
+        return self._call(b'restoreCursor').take_none()
 
     def getPosition(self) -> Tuple[int, int]:
-        rp = self._call(b'.getPosition')
+        rp = self._call(b'getPosition')
         return tuple(rp.take_int() for _ in range(2))
 
     def reposition(self, x: int, y: int, width: int = None, height: int = None, parent: TermTarget = None) -> None:
-        return self._call('.reposition', x, y, width, height, parent).take_none()
+        return self._call(b'reposition', x, y, width, height, parent).take_none()
 
     def getLine(self, y: int) -> Tuple[str, bytes, bytes]:
-        rp = self._call(b'.getLine', y)
+        rp = self._call(b'getLine', y)
         return rp.take_string(), rp.take_bytes(), rp.take_bytes()
 
 
-@contextmanager
 def create(
     parentTerm: TermTarget, x: int, y: int, width: int, height: int, visible: bool = None,
 ) -> TermWindow:
-    with lua_context_object(
+    return TermWindow(lua_context_object(
         b'window.create(...)',
-        (parentTerm, x, y, width, height, visible),
-    ) as fid:
-        yield TermWindow(fid)
+        (parentTerm, x, y, width, height, visible)))

examples/test_window.py

@@ -0,0 +1,33 @@
+from cc import colors, term, os, window
+
+
+win = window.create(term.current(), 15, 5, 5, 5, False)
+assert win.getPosition() == (15, 5)
+assert win.getSize() == (5, 5)
+
+win.setBackgroundColor(colors.red)
+win.clear()
+win.setVisible(True)
+
+os.sleep(1)
+
+win.setVisible(False)
+win.setCursorPos(1, 1)
+win.setTextColor(colors.yellow)
+win.write('*********')
+win.setVisible(True)
+
+os.sleep(1)
+
+term.clear()
+
+os.sleep(1)
+
+win.redraw()
+assert win.getLine(1) == ('*****', b'44444', b'eeeee')
+
+# draws immediately
+win.reposition(21, 5)
+win.reposition(27, 5)
+
+print('Test finished successfully')