# -*- mode: Org -*-
# Copyright 2025 J. David Taylor
# 
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the “Software”), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# 
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
# 
# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
# 
#+OPTIONS: toc:nil num:nil html-postamble:nil
#+TITLE: ACL2 Bridge Python Bindings

* Demo

** Basics
This demo is a minimal ACL2 REPL using Python bindings for the ACL2 bridge.  It
will only accept a single S-expression on one line of input and does no syntax
checking.  In particular, keyword commands are unsupported.  ACL2 errors are
displayed without disrupting the REPL.

- ~acl2_bridge.Client~ :: Synchronous bindings
- ~acl2_bridge.AsyncClient~ :: Asynchronous bindings

** Setup
1. Make sure the ACL2 Bridge book is certified:
  `cert.pl $ACL2_SYSTEM_BOOKS/centaur/bridge/top`
2. Start ACL2 in a shell
3. Run ~(ld "demo.lsp")~ in ACL2
4. Run ~python demo.py~ (or ~python async_demo.py~) in another shell
5. Use ~^D~ to exit, the Bridge server will continue for other clients.
6. If demo.py or async_demo.py is ran with the flag --send-stop-on-eof, then the respective Python demo will send a (BRIDGE::STOP) message to the Bridge server when it exits.

** Manual Stop
You can also stop the bridge server (or send any s-expression) from the CLI:
```bash
sudo apt install netcat-openbsd
echo -e 'LISP 14\n(bridge::stop)' | nc -U demo-bridge
```

* Notes
- See the demo(s) and docstrings for usage.
- Only the Unix socket interface is implemented.  Adding security to the bridge
  protocol is a higher priority than adding a network interface for these Python
  bindings.
