14 KiB

Raw Blame History

什么是 Emacs Application Framework (EAF)? English Version

EAF 是一个全新的图形应用框架，扩展Emacs的多媒体能力，最终达到 Live in Emacs 的目标。

EAF 应用展示

EAF是一个可编程扩展的框架，你可以开发自己的Qt5应用并集成在Emacs中。

浏览器	Markdown预览程序

图片浏览器	视频播放器

PDF阅读器	摄像头程序

二维码下载文件 (PC到手机)	二维码上传文件 (手机到PC)

无线文字传输程序	Org-Mode预览程序

终端模拟器	RSS阅读器

安装EAF

如果是Arch用户, 你可以直接安装emacs-eaf，并跳到第4步.
先确认系统中已经安装了 python3, 然后使用 pip3 安装EAF依赖库:

sudo pip3 install dbus-python python-xlib pyqt5 pyqtwebengine pymupdf grip qrcode feedparser aria2p

使用 git clone 下载这个仓库.
把EAF加入Emacs的 load-path, 然后在 ~/.emacs 中写入:

(require 'eaf)

如果你使用use-package, 下面有一个非常简单的配置文件供你参考:

(use-package eaf
  :load-path "~/.emacs.d/site-lisp/emacs-application-framework" ; Set to "/usr/share/emacs/site-lisp/eaf" if installed from AUR
  :custom
  (eaf-find-alternate-file-in-dired t)
  :config
  (eaf-bind-key scroll_up "RET" eaf-pdf-viewer-keybinding)
  (eaf-bind-key scroll_down_page "DEL" eaf-pdf-viewer-keybinding)
  (eaf-bind-key scroll_up "C-n" eaf-pdf-viewer-keybinding)
  (eaf-bind-key scroll_down "C-p" eaf-pdf-viewer-keybinding)
  (eaf-bind-key take_photo "p" eaf-camera-keybinding))

如果你要使用终端模拟器应用，请按照下面的方法安装配置 wetty:

# 安装wetty
sudo yarn global add wetty

# 确保wetty自动登录
ssh-keygen
cp ~/.ssh/id_rsa.pub ~/.ssh/authorized_keys

# 确保终端正常显示中文文件名
echo 'export LANG=zh_CN.UTF-8' >> ~/.bashrc

浏览器的下载功能依赖aria2, 还需要你额外安装 aria2 这个工具。

依赖列表说明

核心分类表示必备依赖，这些包必须安装好EAF才能工作，应用分类表示可选依赖，只有当你需要对应的应用时，你才需要安装这些依赖，当然我们推荐你把所有依赖都安装了，到你使用的时候就不用再次折腾。

包名	安装方式	分类	解释
pyqt5	pip3	核心	GUI图形库
dbus-python	pip3	核心	DBus库，用于在Emacs和Python进程间通讯
python-xlib	pip3	核心	X11的Python绑定，用于粘贴Qt5程序到Emacs Buffer区域
pyqtwebengine	pip3	核心	浏览器引擎
pymupdf	pip3	应用	PDF阅读器需要，用于解析PDF文件
grip	pip3	应用	Markdown预览程序需要，用于建立Markdown文件的HTML服务
qrcode	pip3	应用	文件传输模块需要，根据文件信息生成二维码
feedparser	pip3	应用	RSS阅读器需要，用于解析RSS/Atom信息
aria2p	pip3	应用	浏览器需要，用于发送下载请求给Aria2 Daemon
aria2	pacman	应用	浏览器需要，用于下载文件
wetty	yarn	应用	终端模拟器需要，通过浏览器来和本地tty交互

EAF应用启动命令

应用名称	启动命令
浏览器	`M-x eaf-open-browser` 在浏览器中打开或搜索
	`M-x eaf-open-browser-with-history` 搜索历史或者打开URL
HTML邮件渲染	`M-x eaf-open-mail-as-html` 在 `gnus`, `mu4e`, `notmuch` 等邮件客户端中执行
PDF阅读器	`M-x eaf-open` 输入PDF文件
视频播放器	`M-x eaf-open` 输入视频文件
图片浏览器	`M-x eaf-open` 输入图片文件
Markdown预览程序	`M-x eaf-open` 输入markdown文件
Org-mode预览程序	`M-x eaf-open` 输入org文件
摄像头程序	`M-x eaf-open-camera`
终端模拟器	`M-x eaf-open-terminal`
二维码下载文件	`M-x eaf-file-sender-qrcode` or `eaf-file-sender-qrcode-in-dired`
二维码上传文件	`M-x eaf-file-receiver-qrcode`
无线分享	`M-x eaf-open-airshare` 输入要分享给手机的字符串
RSS新闻阅读器	`M-x eaf-open-rss-reader`
演示程序	`M-x eaf-open-demo`

在dired文件管理器中，建议绑定按键到命令 eaf-open-this-from-dired ，它会自动用合适的EAF应用来打开文件。

注意：
EAF使用DBus的普通权限总线 (session bus), 请不要用 sudo 来启动EAF, root用户只能访问系统权限总线 (system bus)

Wiki

架构设计，按键绑定，自定义选项和任务列表等文档都写在Wiki

你还会在Wiki发现很多有用的技巧，比如Docker，Helm等，强烈建议使用EAF之前浏览一遍Wiki。

常用问题

EAF是怎么工作的？

EAF主要实现这几个功能：

利用X11的XReparent技术来实现PyQt应用进程的窗口粘贴到Emacs对应的Buffer区域
通过DBus IPC来实现Emacs进程和Python进程的控制指令和跨进程消息通讯
通过Qt5的QGraphicsScene来实现镜像窗口，以对应Emacs的Buffer/Window模型

EAF vs EXWM?

EAF和EXWM的共同点都是：“提升Emacs和别的程序的协作效率“
EXWM本身是一个X11窗口管理器，通过X11协议来控制Emacs和其他程序，但是EXWM只是管理其他程序，但是它并不会修改别的程序，比如它没法修改Chrome, PDF阅读器等GUI程序内在的行为
EAF本身不是一个窗口管理器，EAF只是依赖Emacs自身的窗口管理功能显示自己
EAF的目标是通过PyQt创造新的应用来扩展Emacs的多媒体能力，从Emacs本身的Buffer/Mode设计上看，它和你平常用的 xx-mode 插件没有啥区别，只是它用Qt来绘制内容，而不是Emacs自身的文本库来绘制内容
EAF通过造轮子的方式，把大多数程序员常用的应用写出来以后，达到Live in Emacs的最终目标
基于EAF的架构设计，我们可以通过Elisp来控制Python，JavaScript和其他命令行工具，实现多语言扩展Emacs的编程模型，在坚持Emacs黑客文化和Elisp社区兼容性的前提下，让Emacs的多媒体能力能够跟上时代的发展

EAF和EXWM在设计上是两个完全不同的项目，所以请大家多多学习X11和Qt的区别，理解技术的本质，避免无意义的比较和争论。

为什么EAF只能在Linux下工作？

核心开发者主要使用Manjaro Linux, 目前为止，核心开发者并不使用其他操作系统，比如MacOS， Windows， BSD
EAF跨进程窗口混合技术依赖Linux下的X11 XReparent技术，其他操作系统可能有类似的技术，但是核心开发者不熟悉其他操作系统的底层技术
DBus是Linux下专用的进程间通讯技术，其他操作系统可能无法支持DBus
Qt5的QGraphicsScene技术无法在MacOS下正常工作，也就无法实现Qt5应用的镜像窗口以支持Emacs的Buffer/Window模型

欢迎操作系统级别黑客移植EAF，目前为止，我知道的主要的迁移障碍就只有三个：XReparent, DBus, QGraphicsScene

为什么不支持Wayland?

EAF依赖X11的XReparent技术, Wayland并不支持跨进程窗口融合技术

我们推荐你使用KDE或者Xfce这两个桌面环境，他们对XReparent技术有很好的支持，其他的轻量级窗口管理器和平铺窗口管理器对XReparent技术的支持和键盘焦点处理不完备，没法很好的支持EAF，比如i3wm, awesome都无法使EAF正常工作。

`[EAF] 奔溃了怎么办？

请检查 *eaf* 这个窗口的内容，通常是EAF的Python依赖没有安装好，如果你确定依赖没有问题，请附带 *eaf* 窗口的内容给我们提交issue, 那里面有很多线索可以帮助我们排查问题。

"undefined symbol" 错误

如果你启动的时候发现 "undefined symbol" 错误, 并且你使用的是Arch系统，那肯定是因为Arch自身的bug，Arch系统每次升级以后, 重新使用pip3安装一次Python依赖包就可以解决这个问题:

sudo pip3 install dbus-python python-xlib pyqt5 pyqtwebengine pymupdf grip qrcode feedparser aria2p --force-reinstall

Github 个人访问标记干什么用的？

Markdown预览程序依赖grip, 你需要访问Github Personal access token去获取你个人的标记，然后通过下面的命令设置标记后，grip才能正常的工作：

(setq eaf-grip-token "yourtokencode")

如果不设置个人标记，Github会弹出 "超出使用次数" 的错误。

代理

可以通过下面设置来通过代理访问互联网：

(setq eaf-proxy-type "http")
(setq eaf-proxy-host "127.0.0.1")
(setq eaf-proxy-port "1080")

如果你使用Socks5代理，你可以设置代理类型为：

(setq eaf-proxy-type "socks5")

EAF社区

下面列表列展示了EAF社区的应用，如果我们遗漏你的应用，欢迎提交PR来加到下面列表中。

obr-viz: visualizing org-brain relationships using EAF

反馈问题

反馈安装和配置问题之前，请一定先阅读Wiki!!!

如果你遇到任何问题, 请先用命令 emacs -q 并只添加EAF配置，做一个对比测试，如果 emacs -q 的时候可以工作，请检查你个人的配置文件。

如果emacs -q环境下问题依旧，请到这里反馈。

加入我们

你想把Emacs开发成一个操作系统吗？

想要在Emacs里面生活的更舒适吗？

想要创建下一个激动人心的Emacs插件吗？

一起疯吧!

打赏

如果我的作品让你的生活充满快乐, 欢迎请我喝瓶啤酒, 哈哈哈哈

14 KiB Raw Blame History