cacamacs 0.0.4__py3-none-win_amd64.whl

cacamacs/__init__.py

@@ -0,0 +1 @@
+"""cacamacs — a small terminal text editor. See `ccm --help`."""

cacamacs/__main__.py

@@ -0,0 +1,40 @@
+"""Entry point for the `cacamacs` and `ccm` console scripts."""
+import os
+import sys
+from pathlib import Path
+
+_BUNDLE = Path(__file__).resolve().parent / "_bundle"
+
+
+def _layout():
+    """(executable, extensions_dir) — the Windows bundle is flat, the others are
+    bin/ + lib/ + share/."""
+    win = _BUNDLE / "ccm.exe"
+    if win.exists():
+        return win, _BUNDLE / "extensions"
+    return _BUNDLE / "bin" / "ccm", _BUNDLE / "share" / "ccm" / "extensions"
+
+
+def main() -> int:
+    exe, extensions = _layout()
+    if not exe.exists():
+        sys.exit(f"ccm: bundled binary is missing from {_BUNDLE} "
+                 f"(broken install — try reinstalling)")
+
+    env = dict(os.environ)
+    # setdefault, not assignment: an explicit CCM_BUILTIN_EXTENSIONS is how a
+    # user points ccm at their own grammars, and it must still win.
+    if extensions.is_dir():
+        env.setdefault("CCM_BUILTIN_EXTENSIONS", str(extensions))
+
+    argv = [str(exe), *sys.argv[1:]]
+    if os.name == "nt":
+        # execve on Windows returns control to the shell immediately, which
+        # would hand a live TUI a prompt it is fighting for; spawn and wait.
+        import subprocess
+        return subprocess.run(argv, env=env).returncode
+    os.execve(exe, argv, env)   # no return
+
+
+if __name__ == "__main__":
+    sys.exit(main())

cacamacs/_bundle/ccm-theme.example

@@ -0,0 +1,30 @@
+# cacamacs colour theme — copy to ~/.ccm/theme
+#
+# Syntax:  key = colour          (everything after a "  #" is a comment)
+#
+# Colours may be names (the 16 below), HTML hex (#rrggbb / #rgb), or rgb(r,g,b).
+# cacamacs renders the editor itself in up to 4096 colours (its presenter bypasses
+# libcaca's 16-colour output), so "background = #301934" is a real dark purple.
+# On a plain 16-colour terminal each colour falls back to the nearest of 16.
+#
+#   names:  run  ./demo.sh colors      colour range:  run  ./demo.sh truecolor
+#
+# Names: black red green yellow brown blue magenta(=purple) cyan white
+#        gray/lightgray darkgray(=brightblack)
+#        lightred lightgreen lightblue lightcyan lightmagenta brightyellow
+#        (light* also spell as bright*)
+
+# editor surface  (hex -> real colours via the presenter)
+background   = #1e1a2e        # a dark purple
+foreground   = #d0d0e0
+current_line = #2a2440        # highlight on the caret's line
+selection_fg = black
+selection_bg = #4a4a80
+
+# code colourization (syntax styles)
+comment  = #6a7a6a
+string   = #98c878
+number   = #80d0d0
+keyword  = #c890f0
+bracket  = #e0e0a0
+operator = #b0b0c0

cacamacs/_bundle/extensions/c-lang-0.0.1/language-configuration.json

@@ -0,0 +1,27 @@
+{
+  // A standard VSCode language-configuration.json. cacamacs reads the parts it
+  // can colourize from: comment delimiters, brackets and auto-closing quotes.
+  "comments": {
+    "lineComment": "//",
+    "blockComment": ["/*", "*/"]
+  },
+  "brackets": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"]
+  ],
+  "autoClosingPairs": [
+    { "open": "{", "close": "}" },
+    { "open": "[", "close": "]" },
+    { "open": "(", "close": ")" },
+    { "open": "\"", "close": "\"", "notIn": ["string"] },
+    { "open": "'", "close": "'", "notIn": ["string", "comment"] }
+  ],
+  "surroundingPairs": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"],
+    ["\"", "\""],
+    ["'", "'"]
+  ]
+}

cacamacs/_bundle/extensions/c-lang-0.0.1/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "c-lang",
+  "displayName": "C/C++ Language Basics",
+  "version": "0.0.1",
+  "engines": { "cacamacs": "*" },
+  "contributes": {
+    "languages": [
+      {
+        "id": "c",
+        "aliases": ["C"],
+        "extensions": [".c", ".h"],
+        "configuration": "./language-configuration.json"
+      },
+      {
+        "id": "cpp",
+        "aliases": ["C++", "Cpp"],
+        "extensions": [".cpp", ".cc", ".hpp"],
+        "configuration": "./language-configuration.json"
+      }
+    ],
+    "grammars": [
+      {
+        "language": "c",
+        "scopeName": "source.c",
+        "path": "./syntaxes/c.tmLanguage.json"
+      }
+    ]
+  }
+}

cacamacs/_bundle/extensions/c-lang-0.0.1/syntaxes/c.tmLanguage.json

@@ -0,0 +1,44 @@
+{
+  "scopeName": "source.c",
+  "name": "C",
+  "patterns": [
+    { "include": "#comments" },
+    { "include": "#keywords" },
+    { "include": "#types" },
+    { "include": "#strings" },
+    { "include": "#numbers" },
+    { "include": "#preprocessor" }
+  ],
+  "repository": {
+    "comments": {
+      "patterns": [
+        { "name": "comment.line.double-slash.c", "match": "//.*$" },
+        { "name": "comment.block.c", "begin": "/\\*", "end": "\\*/" }
+      ]
+    },
+    "keywords": {
+      "name": "keyword.control.c",
+      "match": "\\b(if|else|for|while|do|switch|case|default|break|continue|return|goto|sizeof|typedef|struct|union|enum)\\b"
+    },
+    "types": {
+      "name": "storage.type.c",
+      "match": "\\b(void|char|short|int|long|float|double|signed|unsigned|const|static|extern|register|volatile|inline|bool|size_t)\\b"
+    },
+    "strings": {
+      "patterns": [
+        { "name": "string.quoted.double.c", "begin": "\"", "end": "\"",
+          "patterns": [ { "name": "constant.character.escape.c", "match": "\\\\." } ] },
+        { "name": "string.quoted.single.c", "begin": "'", "end": "'",
+          "patterns": [ { "name": "constant.character.escape.c", "match": "\\\\." } ] }
+      ]
+    },
+    "numbers": {
+      "name": "constant.numeric.c",
+      "match": "\\b(0[xX][0-9a-fA-F]+|[0-9]+(\\.[0-9]+)?([eE][-+]?[0-9]+)?[fFuUlL]*)\\b"
+    },
+    "preprocessor": {
+      "name": "keyword.control.directive.c",
+      "match": "^\\s*#\\s*(include|define|undef|if|ifdef|ifndef|else|elif|endif|pragma|error)\\b"
+    }
+  }
+}

cacamacs/_bundle/extensions/python-0.0.1/language-configuration.json

@@ -0,0 +1,24 @@
+{
+  "comments": {
+    "lineComment": "#"
+  },
+  "brackets": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"]
+  ],
+  "autoClosingPairs": [
+    { "open": "{", "close": "}" },
+    { "open": "[", "close": "]" },
+    { "open": "(", "close": ")" },
+    { "open": "\"", "close": "\"" },
+    { "open": "'", "close": "'" }
+  ],
+  "surroundingPairs": [
+    ["{", "}"],
+    ["[", "]"],
+    ["(", ")"],
+    ["\"", "\""],
+    ["'", "'"]
+  ]
+}

cacamacs/_bundle/extensions/python-0.0.1/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "python-lang",
+  "displayName": "Python Language Basics",
+  "version": "0.0.1",
+  "engines": { "cacamacs": "*" },
+  "contributes": {
+    "languages": [
+      {
+        "id": "python",
+        "aliases": ["Python", "py"],
+        "extensions": [".py", ".pyw"],
+        "configuration": "./language-configuration.json"
+      }
+    ],
+    "grammars": [
+      {
+        "language": "python",
+        "scopeName": "source.python",
+        "path": "./syntaxes/python.tmLanguage.json"
+      }
+    ]
+  }
+}

cacamacs/_bundle/extensions/python-0.0.1/syntaxes/python.tmLanguage.json

@@ -0,0 +1,49 @@
+{
+  "scopeName": "source.python",
+  "name": "Python",
+  "patterns": [
+    { "include": "#comment" },
+    { "include": "#triple-string" },
+    { "include": "#string" },
+    { "include": "#keyword" },
+    { "include": "#builtin" },
+    { "include": "#decorator" },
+    { "include": "#number" }
+  ],
+  "repository": {
+    "comment": {
+      "name": "comment.line.number-sign.python",
+      "match": "#.*$"
+    },
+    "triple-string": {
+      "patterns": [
+        { "name": "string.quoted.triple.double.python", "begin": "\"\"\"", "end": "\"\"\"" },
+        { "name": "string.quoted.triple.single.python", "begin": "'''", "end": "'''" }
+      ]
+    },
+    "string": {
+      "patterns": [
+        { "name": "string.quoted.double.python", "begin": "\"", "end": "\"",
+          "patterns": [ { "name": "constant.character.escape.python", "match": "\\\\." } ] },
+        { "name": "string.quoted.single.python", "begin": "'", "end": "'",
+          "patterns": [ { "name": "constant.character.escape.python", "match": "\\\\." } ] }
+      ]
+    },
+    "keyword": {
+      "name": "keyword.control.python",
+      "match": "\\b(and|as|assert|async|await|break|class|continue|def|del|elif|else|except|finally|for|from|global|if|import|in|is|lambda|nonlocal|not|or|pass|raise|return|try|while|with|yield)\\b"
+    },
+    "builtin": {
+      "name": "constant.language.python",
+      "match": "\\b(True|False|None|self|cls|__init__|print|len|range|str|int|float|list|dict|set|tuple)\\b"
+    },
+    "decorator": {
+      "name": "entity.name.function.decorator.python",
+      "match": "^\\s*@[A-Za-z_][A-Za-z0-9_.]*"
+    },
+    "number": {
+      "name": "constant.numeric.python",
+      "match": "\\b(0[xX][0-9a-fA-F]+|[0-9]+\\.?[0-9]*)\\b"
+    }
+  }
+}

cacamacs-0.0.4.dist-info/METADATA

@@ -0,0 +1,112 @@
+Metadata-Version: 2.1
+Name: cacamacs
+Version: 0.0.4
+Summary: cacamacs — a small terminal text editor with Emacs key bindings
+Home-page: https://github.com/stricaud/ccm
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console :: Curses
+Classifier: Programming Language :: C
+Classifier: Topic :: Text Editors
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# ccm — cacamacs
+
+A small terminal text editor with Emacs key bindings, built on the
+[gtcaca](https://github.com/stricaud/gtcaca) libcaca TUI toolkit and its
+`editor` widget. It shows off the widget's colourization, folding, annotations,
+autocompletion, search/replace and a VSCode-style language-extension model.
+
+```sh
+ccm [file | directory] [language-configuration.json]
+```
+
+- A **file** opens in the editor.
+- A **directory** opens the file browser (also `C-x d`).
+- An optional explicit `language-configuration.json` forces that config.
+
+See [docs/README-cacamacs.md](https://github.com/stricaud/ccm/blob/main/docs/README-cacamacs.md) for the full key-binding
+reference and feature tour.
+
+> **History.** ccm started life as `apps/cacamacs` inside the gtcaca repo, where
+> a copy remains as a worked example of building an app on the toolkit. Active
+> development now happens here, against gtcaca as an ordinary external
+> dependency.
+
+## Install with pip
+
+Prebuilt binaries are published to PyPI for macOS (Apple Silicon), Linux
+(x86_64) and Windows (x86_64) — no compiler or Homebrew needed:
+
+```sh
+pip install cacamacs
+ccm            # or: cacamacs
+```
+
+PyPI is used purely as a binary channel (as `ruff`/`cmake`/`ninja` do): the
+wheel carries the compiled `ccm` and the `libgtcaca`/`libcaca`/`oniguruma`
+libraries it needs, made relocatable, plus the sample language extensions so
+syntax highlighting works out of the box. See [packaging/](packaging/) for how
+the per-platform wheels are built (`packaging/build.sh` → `packaging/wheel.py`,
+wired up in `.github/workflows/release.yml`, which publishes on a `v*` tag).
+
+## Building
+
+ccm consumes gtcaca like any third party would: install gtcaca first, then
+build ccm against it. gtcaca ships a `gtcaca.pc`, so pkg-config finds it.
+
+```sh
+# 1. install gtcaca (any one of these):
+brew install stricaud/tap/gtcaca         # Homebrew tap
+#   …or from a gtcaca checkout:  cmake -S . -B build && cmake --build build && sudo cmake --install build
+
+# 2. build ccm
+cmake -S . -B build
+cmake --build build
+
+# 3. run it
+./run.sh              # builds if needed, then runs build/ccm
+./run.sh path/to/file
+```
+
+Requirements: a C compiler, CMake ≥ 3.20, pkg-config, and an installed
+`gtcaca` (which pulls in `libcaca`).
+
+## Installing
+
+```sh
+sudo cmake --install build        # → /usr/local/bin/ccm, share/ccm/ccm-theme.example
+```
+
+### Self-contained macOS package
+
+`scripts/package-macos.sh` builds a `.pkg` that bundles `libgtcaca` and
+`libcaca` alongside `ccm` (rewritten to `@rpath`), so the installed editor needs
+neither Homebrew nor a system gtcaca:
+
+```sh
+scripts/package-macos.sh          # → ccm-<version>.pkg
+```
+
+Its postinstall seeds `~/.ccm/theme` from the bundled sample (never clobbering
+an existing one).
+
+## Configuration
+
+- **Colour theme** — copy [docs/ccm-theme.example](https://github.com/stricaud/ccm/blob/main/docs/ccm-theme.example) to
+  `~/.ccm/theme`. Comments in the file explain every key.
+- **Editor config** — copy [examples/config.json](https://github.com/stricaud/ccm/blob/main/examples/config.json) to
+  `~/.cacamacs/config.json` for tab size, indent, per-language overrides.
+- **Language extensions** — the VSCode-style grammar/config bundles under
+  [examples/extensions/](https://github.com/stricaud/ccm/blob/main/examples/extensions/) drive syntax colourization.
+
+## Layout
+
+```
+src/            editor sources (cacamacs.c, ui.c, edit.c, search.c, …)
+docs/           feature docs + the colour-theme sample
+examples/       config sample and language extensions
+scripts/        macOS packaging
+CMakeLists.txt  standalone build (finds gtcaca via pkg-config)
+run.sh          build-and-run helper
+```

cacamacs-0.0.4.dist-info/RECORD

@@ -0,0 +1,18 @@
+cacamacs/__init__.py,sha256=7CWiRZfSVMdJGvSRTHCgzEg5aAA4V1Ne7WG6rQgWTF8,67
+cacamacs/__main__.py,sha256=5cWBMkrlvS3X0H1Vb0lvZXaclRMXEoIcFBQ_mrOMdt0,1328
+cacamacs/_bundle/ccm-theme.example,sha256=bl1Qf2WoGCxWlVp3ALPKGHrN9hI-z4o06wL7SVB9kQs,1179
+cacamacs/_bundle/ccm.exe,sha256=1MhZqe80ThWRCEj0H5P7Xy1D1SmTqVujzF4ID0kETVs,324026
+cacamacs/_bundle/extensions/c-lang-0.0.1/language-configuration.json,sha256=2okCTSDQ1o5Mg1xHp7Hxl8Nfz7jG8EbULZ4U5HRd65Y,704
+cacamacs/_bundle/extensions/c-lang-0.0.1/package.json,sha256=2dLe0rMSFq7NmqhLtvbxmdbY4calqNM_D96taKxnS_I,676
+cacamacs/_bundle/extensions/c-lang-0.0.1/syntaxes/c.tmLanguage.json,sha256=YpDGf87d_GjCxjJ5_wtaQRPy4NC544FdbgGYX1TaSOA,1582
+cacamacs/_bundle/extensions/python-0.0.1/language-configuration.json,sha256=f_NwmLrhLeBwIgfVItjxX2ZBKb-Mii3-O4rIVH80peQ,454
+cacamacs/_bundle/extensions/python-0.0.1/package.json,sha256=0Wo8o8Jg-LZr-O-hryL9zjRjFKH2mF8shYHotvjc8tI,533
+cacamacs/_bundle/extensions/python-0.0.1/syntaxes/python.tmLanguage.json,sha256=sb8IvMo7XsxcxG6mT5PETZI1ay7Ut8P8mBYEFqln5QI,1783
+cacamacs/_bundle/libcaca-0.dll,sha256=Sre2nhVrd6dndiN603BU3JVY8Y3CzUqcKkKHqIEQArI,859225
+cacamacs/_bundle/libgtcaca.dll,sha256=rbXg7S3oaVhXVtZ3_lNKldk8tDn_eak2J7PIUnc4X1s,1326997
+cacamacs/_bundle/libonig-5.dll,sha256=AU5BeKEkLUXJ2XNAdxDpnyVOpXfnMElIN2cHSlAm_k4,613839
+cacamacs/_bundle/zlib1.dll,sha256=Ec2RFxdlzWXxwzYuPfZ-X1phimuIyM3siZuALq8cew0,127291
+cacamacs-0.0.4.dist-info/METADATA,sha256=d2y8fB87Rv9VdAhwQQMBIWgk-Ben-Net9JjjBR5m57M,4094
+cacamacs-0.0.4.dist-info/WHEEL,sha256=vYmcjJjApvQ91K9AH7yd4oij_XgNMLxLZeTDFBZ2jJA,105
+cacamacs-0.0.4.dist-info/entry_points.txt,sha256=UKgsBc5ohdFbe8Ek0vlm6w0IRNQRTT-X6OOj4HqnQEs,81
+cacamacs-0.0.4.dist-info/RECORD,,

cacamacs-0.0.4.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: cacamacs packaging/wheel.py
+Root-Is-Purelib: false
+Tag: py3-none-win_amd64

cacamacs-0.0.4.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+cacamacs = cacamacs.__main__:main
+ccm = cacamacs.__main__:main