i3a 2.3.0__tar.gz → 2.4.0__tar.gz

i3a-2.4.0/.gitignore

@@ -0,0 +1,24 @@
+Pipfile.lock
+
+__pycache__/
+*.py[cod]
+*$py.class
+
+build/
+*.egg
+*.egg-info/
+.eggs
+
+.tox/
+.cache/
+.coverage
+coverage.xml
+htmlcov/
+
+src/i3a/_version.py
+
+tags
+.tags
+
+poetry.lock
+dist/*

{i3a-2.3.0 → i3a-2.4.0}/PKG-INFO

@@ -1,30 +1,20 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: i3a
-Version: 2.3.0
+Version: 2.4.0
 Summary: Automatic manager for i3 tiling
-Home-page: https://git.goral.net.pl/i3a.git
-License: GPL-3.0-or-later
-Author: Michal Goral
-Author-email: dev@goral.net.pl
-Requires-Python: >=3.7,<4.0
+Author-email: Michal Goral <dev@goral.net.pl>
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Natural Language :: English
 Classifier: Operating System :: POSIX
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Utilities
-Requires-Dist: i3ipc (>=2.2.1,<3.0.0)
-Requires-Dist: importlib-metadata (>=4.0,<5.0) ; python_version < "3.8"
-Project-URL: Repository, https://git.goral.net.pl/i3a.git
+Requires-Python: >=3.11
+Requires-Dist: i3ipc==2.2.1
 Description-Content-Type: text/markdown
 
 # i3a
@@ -153,8 +143,29 @@ will cycle so it must be escaped in configuration file:
 bindsym $mod+s exec "i3a-scale-cycle -f 1.0,1.5,2.0 -o HDMI-1 -o HDMI-2 --next"
 ```
 
+### i3a-trail
+
+Dynamically toggle trailmarks (a kind of special marks) on windows and use them
+to quickly cycle between trailmarks in the same groups. It's possible to have
+many different groups of trailmarks (trails) and windows may belong to many
+different groups.
+
+Use `i3a-trail new-trail|delete-trail|next-trail|previous-trail` create and
+activate trails. Use `i3a-trail mark` to add and remove trailmarks. Use
+`i3a-trail next|previous` to traverse marked windows.
+
+```
+bindsym $mod+grave exec i3a-trail mark
+bindsym $mod+Tab exec i3a-trail next
+bindsym $mod+Shift+Tab exec i3a-trail previous
+
+bindsym $mod+n exec i3a-trail new-trail
+bindsym $mod+Shift+n exec i3a-trail delete-trail
+bindsym $mod+bracketright exec i3a-trail next-trail
+bindsym $mod+bracketleft exec i3a-trail previous-trail
+```
+
 ## Installation
 
 - [PyPI](https://pypi.org/project/i3a/)
 - [AUR](https://aur.archlinux.org/packages/i3a/) (Arch Linux - unofficial)
-

{i3a-2.3.0 → i3a-2.4.0}/README.md

@@ -124,6 +124,28 @@ will cycle so it must be escaped in configuration file:
 bindsym $mod+s exec "i3a-scale-cycle -f 1.0,1.5,2.0 -o HDMI-1 -o HDMI-2 --next"
 ```
 
+### i3a-trail
+
+Dynamically toggle trailmarks (a kind of special marks) on windows and use them
+to quickly cycle between trailmarks in the same groups. It's possible to have
+many different groups of trailmarks (trails) and windows may belong to many
+different groups.
+
+Use `i3a-trail new-trail|delete-trail|next-trail|previous-trail` create and
+activate trails. Use `i3a-trail mark` to add and remove trailmarks. Use
+`i3a-trail next|previous` to traverse marked windows.
+
+```
+bindsym $mod+grave exec i3a-trail mark
+bindsym $mod+Tab exec i3a-trail next
+bindsym $mod+Shift+Tab exec i3a-trail previous
+
+bindsym $mod+n exec i3a-trail new-trail
+bindsym $mod+Shift+n exec i3a-trail delete-trail
+bindsym $mod+bracketright exec i3a-trail next-trail
+bindsym $mod+bracketleft exec i3a-trail previous-trail
+```
+
 ## Installation
 
 - [PyPI](https://pypi.org/project/i3a/)

i3a-2.4.0/justfile

@@ -0,0 +1,9 @@
+help:
+    just --list
+
+publish: 
+    uv build
+    uv publish
+
+clean:
+    rm -rf build

{i3a-2.3.0 → i3a-2.4.0}/pyproject.toml

@@ -1,12 +1,10 @@
-[build-system]
-requires = ["poetry-core>=1.0"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.poetry]
+[project]
 name = "i3a"
-version = "2.3.0"
+version = "2.4.0"
 description = "Automatic manager for i3 tiling"
-authors = ["Michal Goral <dev@goral.net.pl>"]
+authors = [
+    { name = "Michal Goral", email = "dev@goral.net.pl" }
+]
 license = "GPL-3.0-or-later"
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -19,17 +17,14 @@ classifiers = [
     "Topic :: Utilities",
 ]
 readme = "README.md"
-packages = [
-    { include = "i3a", from = "src" },
-]
 repository = "https://git.goral.net.pl/i3a.git"
 
-[tool.poetry.dependencies]
-python = "^3.7"
-i3ipc = "^2.2.1"
-importlib-metadata = {version = "^4.0", python = "<3.8"}
+requires-python = ">=3.11"
+dependencies = [
+    "i3ipc==2.2.1",
+]
 
-[tool.poetry.scripts]
+[project.scripts]
 i3a-master-stack = "i3a.master_stack:main"
 i3a-swallow = "i3a.swallow:main"
 i3a-move-to-empty = "i3a.move_to_empty:main"
@@ -37,3 +32,11 @@ i3a-swap = "i3a.swap:main"
 i3a-resize-compass = "i3a.resize_compass:main"
 i3a-scale-cycle = "i3a.scale_cycle:main"
 i3a-cycle-focus = "i3a.cycle_focus:main"
+i3a-trail = "i3a.trail:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/i3a"]

{i3a-2.3.0 → i3a-2.4.0}/src/i3a/master_stack.py

@@ -105,13 +105,21 @@ class Autotiler:
         master, stack = master_stack(tree, tree.find_focused())
 
         if master and not stack:
-            await self.cmd('[con_id="{}"] split horizontal'.format(master.id))
+            # move up: we have only 1 window, which previously could be a
+            # stack, but now we "reinterpret" it as a master. It might still be
+            # inside its parent virtual split-container and we don't want
+            # master to be inside any virtual container, because that could
+            # result in accumulating these over time. 'move up' breaks free
+            # from it.
+            await self.cmd('[con_id="{}"] move up, split horizontal'.format(master.id))
             return
 
         if not master and stack:
             await self.intermove(stack[0], 'move left')
             if len(stack) > 1:  # stack[0] becomes a new master, resize remains
                 await self.cmd('[con_id="{}"] resize set {} ppt 0 ppt'.format(stack[-1].id, self.args.stack_size))
+            elif len(stack) == 1:
+                await self.cmd('[con_id="{}"] move up'.format(stack[0]))
 
     async def _node_added(self, tree, e):
         master, stack = master_stack(tree, e.container, exclude_node=True)
@@ -124,7 +132,13 @@ class Autotiler:
             return
 
         if not stack:
-            await self.cmd('[con_id="{}"] split horizontal'.format(master.id))
+            # Split master.parent instead of master? Easy explanation: we don't
+            # want to split the container itself because this would create
+            # unnecessary parent split-container. Containers aren't
+            # automatically garbage collected so after closing a stack and
+            # creating a new one, yet another parent container would be
+            # created. Long sessions might accumulate quite a lot of them.
+            await self.cmd('[con_id="{}"] split horizontal'.format(master.parent.id))
             await self.make_stack(curr)
             await self.cmd('[con_id="{}"] resize set {} ppt 0 ppt'.format(curr.id, self.args.stack_size))
         else:

i3a-2.4.0/src/i3a/trail.py

@@ -0,0 +1,322 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+# Copyright (C) 2025 Michał Góral.
+
+import argparse
+import os
+import sys
+import tempfile
+from contextlib import suppress
+from dataclasses import dataclass, field
+from pathlib import Path
+from typing import Iterator
+
+from i3ipc import Connection
+
+from i3a import __version__ as version
+
+TRAYMARK = "__i3a_trail.{trailid}.{winid}"
+TRAYMARK_RE = r"^__i3a_trail\.{trailid}\.{winid}$"
+
+
+@dataclass
+class Trail:
+    _id: int
+    _winid: int = 0
+    _end: int = 0
+
+    @property
+    def id(self):
+        return self._id
+
+    @property
+    def winid(self):
+        return self._winid
+
+    @winid.setter
+    def winid(self, val: int):
+        assert val >= 0
+        self._end = max(self._end, val + 1)
+        self._winid = val
+
+    @property
+    def end(self):
+        return self._end
+
+    @end.setter
+    def end(self, val: int):
+        assert val == 0 or val > self._winid
+        self._end = val
+        self._winid = min(self._winid, val)
+
+    @property
+    def deleted(self):
+        return self._end == 0
+
+    def __iter__(self):
+        i = self.winid + 1
+        yield from range(i, self.end)
+        yield from range(0, i)
+
+    def __reversed__(self):
+        i = self.winid - 1
+        yield from range(i, -1, -1)
+        yield from range(self.end - 1, i, -1)
+
+
+# trail format:
+#   <current_trail>
+#   <trail-0-winid><space><trail-0-end>
+#   <trail-1-winid><space><trail-1-end>
+#   ...
+@dataclass
+class Db:
+    _tid: int = 0
+    _trails: list[Trail] = field(default_factory=list)
+
+    def __post_init__(self):
+        if self._tid > len(self._trails):
+            self._tid = 0
+
+    def trail(self, idx: int | None = None) -> Trail | None:
+        if idx is None:
+            idx = self._tid
+        if len(self._trails) <= idx:
+            return None
+        return self._trails[idx]
+
+    def add_trail(self, *args, **kwargs) -> Trail:
+        trail_id = len(self._trails)
+        self._trails.append(Trail(trail_id, *args, **kwargs))
+        return self._trails[-1]
+
+    def delete_trail(self, idx: int | None = None):
+        trail = self.trail(idx)
+        if trail:
+            trail.winid = 0
+            trail.end = 0
+
+    def seek(self, idx: int) -> Trail:
+        assert idx >= 0
+
+        for _ in range(idx - len(self._trails) + 1):
+            self.add_trail(0, 0)
+
+        self._tid = idx
+        return self._trails[self._tid]
+
+    def __iter__(self) -> Iterator[Trail]:
+        i = self._tid + 1
+        yield from self._trails[i:]
+        yield from self._trails[:i]
+
+    def __reversed__(self) -> Iterator[Trail]:
+        i = self._tid
+        yield from reversed(self._trails[:i])
+        yield from reversed(self._trails[i:])
+
+    def save(self, path: Path | None = None):
+        lines = [str(self._tid)]
+        for i, trail in enumerate(self._trails):
+            if trail.end == 0 and i > self._tid:
+                continue
+            lines.append(f"{trail.winid} {trail.end}")
+
+        text = "\n".join(lines) + "\n"
+        path = path or Db.dbpath()
+        path.write_text(text)
+
+    @staticmethod
+    def dbpath() -> Path:
+        tmpdir = tempfile.gettempdir()
+        uid = os.getuid()
+        sock = get_sockname()
+        return Path(tmpdir) / f"i3a-trail-{uid}-{sock}"
+
+    @classmethod
+    def from_file(cls, path: Path | None = None) -> "Db":
+        path = path or Db.dbpath()
+        lines = path.read_text().splitlines()
+        db = Db()
+        for line in lines[1:]:
+            winid, _, end = line.strip().partition(" ")
+            db.add_trail(int(winid), int(end))
+        db.seek(int(lines[0].strip()))
+        return db
+
+
+def get_sockname():
+    path = os.environ.get("I3SOCK", os.environ.get("SWAYSOCK", ""))
+    return os.path.splitext(os.path.basename(path))[0]
+
+
+def seek_next_trail(db: Db, iter_fn) -> Trail | None:
+    dbit = iter_fn(db)
+    for trail in dbit:
+        if not trail.deleted:
+            return db.seek(trail.id)
+    return None
+
+
+def find_mark_with_prefix(marks: list[str], prefix: str) -> str | None:
+    for m in marks:
+        if m.startswith(prefix):
+            return m
+    return None
+
+
+def get_winid_of_trail_from_marks(marks: list[str], trailid: int) -> int | None:
+    prefix = TRAYMARK.format(trailid=trailid, winid="")
+    mark = find_mark_with_prefix(marks, prefix)
+    if mark:
+        with suppress(ValueError):
+            return int(mark.split(".")[-1])
+    return None
+
+
+def jump_to_next_trailmark(db: Db, iter_fn) -> bool:
+    curr = db.trail()
+    if curr is None:
+        return False
+
+    i3 = Connection()
+    tree = i3.get_tree()
+
+    # set winid from mark of currently focused window to use it as a starting point
+    if focused := tree.find_focused():
+        focused_winid = get_winid_of_trail_from_marks(focused.marks, curr.id)
+        if focused_winid is not None:
+            curr.winid = focused_winid
+
+    trail_iterator = iter_fn(curr)
+
+    for winid in trail_iterator:
+        mk_re = TRAYMARK_RE.format(trailid=curr.id, winid=winid)
+        for container in tree.find_marked(mk_re):
+            if container.focused:
+                continue
+            repl = container.command("focus")
+            if repl[0].success:
+                curr.winid = winid
+                return True
+    return False
+
+
+def cmd_new_trail(args, db: Db):
+    trail = db.add_trail(0, 0)
+    db.seek(trail.id)
+    db.save(args.db)
+
+
+def cmd_delete_trail(args, db: Db):
+    curr = db.trail()
+    if curr:
+        i3 = Connection()
+        tree = i3.get_tree()
+        mk = TRAYMARK.format(trailid=curr.id, winid="")
+        mk_re = TRAYMARK_RE.format(trailid=curr.id, winid=".*")
+        for container in tree.find_marked(mk_re):
+            for mark in container.marks:
+                if mark.startswith(mk):
+                    container.command(f"mark --add --toggle {mark}")
+
+    db.delete_trail()
+    next_trail = seek_next_trail(db, reversed)
+    if not next_trail:
+        db.seek(0)
+
+    db.save(args.db)
+
+
+def cmd_next_trail(args, db: Db):
+    seek_next_trail(db, iter)
+    db.save(args.db)
+
+
+def cmd_prev_trail(args, db: Db):
+    seek_next_trail(db, reversed)
+    db.save(args.db)
+
+
+def cmd_mark(args, db: Db):
+    trail = db.trail()
+    if trail is None:
+        trail = db.add_trail()
+
+    i3 = Connection()
+    focused = i3.get_tree().find_focused()
+    if not focused:
+        sys.exit(1)
+
+    prefix = TRAYMARK.format(trailid=trail.id, winid="")
+    if to_remove := find_mark_with_prefix(focused.marks, prefix):
+        focused.command(f"mark --add --toggle {to_remove}")
+    else:
+        newmark = TRAYMARK.format(trailid=trail.id, winid=trail.end)
+        repl = focused.command(f"mark --add {newmark}")
+        if not repl[0].success:
+            sys.exit(1)
+        trail.winid = trail.end
+        db.save(args.db)
+
+
+def cmd_next(args, db: Db):
+    if not jump_to_next_trailmark(db, iter):
+        sys.exit(1)
+    db.save(args.db)
+
+
+def cmd_previous(args, db: Db):
+    if not jump_to_next_trailmark(db, reversed):
+        sys.exit(1)
+    db.save(args.db)
+
+
+def prepare_args():
+    parser = argparse.ArgumentParser(
+        description="i3a-trail - quick jump between window trailmarks"
+    )
+
+    sp = parser.add_subparsers(required=True)
+
+    new_trail_sp = sp.add_parser("new-trail", help="create new trail and use it")
+    new_trail_sp.set_defaults(func=cmd_new_trail)
+
+    delete_trail_sp = sp.add_parser(
+        "delete-trail", help="delete current trail and switch to the previous one"
+    )
+    delete_trail_sp.set_defaults(func=cmd_delete_trail)
+
+    next_trail_sp = sp.add_parser("next-trail", help="use next trail")
+    next_trail_sp.set_defaults(func=cmd_next_trail)
+
+    prev_trail_sp = sp.add_parser("previous-trail", help="use previous trail")
+    prev_trail_sp.set_defaults(func=cmd_prev_trail)
+
+    mark_sp = sp.add_parser(
+        "mark", help="toggle a trail mark on currently focused window"
+    )
+    mark_sp.set_defaults(func=cmd_mark)
+
+    next_sp = sp.add_parser("next", help="jump to the next window in current trail")
+    next_sp.set_defaults(func=cmd_next)
+
+    previous_sp = sp.add_parser(
+        "previous", help="jump to the previous window in current trail"
+    )
+    previous_sp.set_defaults(func=cmd_previous)
+
+    parser.add_argument("--db", help="path to trail marks database")
+    parser.add_argument("--version", action="version", version=f"%(prog)s {version}")
+
+    return parser.parse_args()
+
+
+def main():
+    args = prepare_args()
+    try:
+        db = Db.from_file(args.db)
+    except (IndexError, FileNotFoundError):
+        db = Db()
+
+    args.func(args, db)

i3a-2.4.0/tests/test_trail.py

@@ -0,0 +1,2 @@
+import i3a.trail as trail
+

i3a-2.4.0/uv.lock

@@ -0,0 +1,47 @@
+version = 1
+revision = 1
+requires-python = ">=3.11"
+
+[[package]]
+name = "i3a"
+version = "2.4.0"
+source = { editable = "." }
+dependencies = [
+    { name = "i3ipc" },
+]
+
+[package.metadata]
+requires-dist = [{ name = "i3ipc", specifier = "==2.2.1" }]
+
+[[package]]
+name = "i3ipc"
+version = "2.2.1"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "python-xlib" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/61/f3/dfab70c888d85d3e933ff4d6b351aaed0ae137a29c896e03e364de3bec94/i3ipc-2.2.1.tar.gz", hash = "sha256:e880d7d7147959ead5cb34764f08b97b41385b36eb8256e8af1ce163dbcccce8", size = 47760 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/de/30/294b07ddeccb58855c890c3ef3a951c3b0c1e2d089666d548b6a9edc39fb/i3ipc-2.2.1-py3-none-any.whl", hash = "sha256:c0b898223d50d42c90c818deb5033d1304c582755547dee7d15df3e3781bc690", size = 26591 },
+]
+
+[[package]]
+name = "python-xlib"
+version = "0.33"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "six" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/86/f5/8c0653e5bb54e0cbdfe27bf32d41f27bc4e12faa8742778c17f2a71be2c0/python-xlib-0.33.tar.gz", hash = "sha256:55af7906a2c75ce6cb280a584776080602444f75815a7aff4d287bb2d7018b32", size = 269068 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/fc/b8/ff33610932e0ee81ae7f1269c890f697d56ff74b9f5b2ee5d9b7fa2c5355/python_xlib-0.33-py2.py3-none-any.whl", hash = "sha256:c3534038d42e0df2f1392a1b30a15a4ff5fdc2b86cfa94f072bf11b10a164398", size = 182185 },
+]
+
+[[package]]
+name = "six"
+version = "1.17.0"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/94/e7/b2c673351809dca68a0e064b6af791aa332cf192da575fd474ed7d6f16a2/six-1.17.0.tar.gz", hash = "sha256:ff70335d468e7eb6ec65b95b99d3a2836546063f63acc5171de367e834932a81", size = 34031 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/b7/ce/149a00dd41f10bc29e5921b496af8b574d8413afcd5e30dfa0ed46c2cc5e/six-1.17.0-py2.py3-none-any.whl", hash = "sha256:4721f391ed90541fddacab5acf947aa0d3dc7d27b2e1e8eda2be8970586c3274", size = 11050 },
+]