Class StringListBuffer

source/binding/Python/maa/buffer.py:118–245

字符串列表缓冲区 / String list buffer 用于在 Python 和 C API 之间传递字符串列表数据。 Used to pass string list data between Python and C API.

class StringListBuffer:
    """字符串列表缓冲区 / String list buffer

    用于在 Python 和 C API 之间传递字符串列表数据。
    Used to pass string list data between Python and C API.
    """

    _handle: MaaStringListBufferHandle
    _own: bool

    def __init__(self, handle: Optional[MaaStringListBufferHandle] = None):
        self._set_api_properties()

        if handle:
            self._handle = handle
            self._own = False
        else:
            self._handle = Library.framework().MaaStringListBufferCreate()
            self._own = True

        if not self._handle:
            raise RuntimeError("Failed to create string list buffer.")

    def __del__(self):
        if self._handle and self._own:
            Library.framework().MaaStringListBufferDestroy(self._handle)

    def get(self) -> list[str]:
        """获取字符串列表 / Get string list

        Returns:
            List[str]: 字符串列表 / String list
        """
        count = Library.framework().MaaStringListBufferSize(self._handle)
        result: list[str] = []
        for i in range(count):
            buff = Library.framework().MaaStringListBufferAt(self._handle, i)
            s = StringBuffer(buff).get()
            result.append(s)
        return result

    def set(self, value: list[str]) -> bool:
        """设置字符串列表 / Set string list

        Args:
            value: 字符串列表 / String list

        Returns:
            bool: 是否成功 / Whether successful
        """
        self.clear()
        for s in value:
            if not self.append(s):
                return False
        return True

    def append(self, value: str) -> bool:
        """追加字符串 / Append string