Emacs-BGEX patch とは?

X 用 (X なら Cygwin でも MacOSX でも動きます!) FSF Emacs の背景拡張非公式パッチです。

Emacs-BGEX patch を適用すると背景に画像や色を指定できるようになります。

フレーム単位ではなく、バッファごとに異なる背景を指定することもできます。

かれこれ 15 年以上メンテナンスしています。

presentation_bgex_20080308_0_2.mp4 demo movie (15.6Mbytes)

仕様メモ

何かありましたら twitter @wachikun 、 wac@umiushi.org へのメイルなどお気軽にどうぞ。

News

(set-background-color "#d0b8a0")
(set-frame-parameter nil 'bg-image-enable-flag t)
(set-frame-parameter nil 'bg-fill-alpha 0.6)
(set-frame-parameter nil 'bg-image-filename "/Users/wac/.emacs.d/images/paper_1_1600x1200_color_2.png")

News ログ

install

インストールは非常に簡単です。次のような手順で導入します。

1. Emacs の source を展開
2. Emacs-BGEX patch を当てる
3. bgex.el の install
4. .emacs などの Emacs-BGEX 対応のための修正

example

まず BGEX archive と Emacs source を展開し、 patch を当てて build します。

$ cd /tmp
$ wget http://umiushi.org/~wac/bgex/patch-bgex_20110822_0-emacs-23.3a.tar.bz2
$ tar xf patch-bgex_20110822_0-emacs-23.3a.tar.bz2

$ wget http://ftp.gnu.org/pub/gnu/emacs/emacs-23.3a.tar.gz
$ tar xf emacs-23.3a.tar.bz2
$ cd emacs-23.3/src
$ patch < /tmp/patch-bgex_20110822_0-emacs-23.3a/patch-bgex_20110822_0-emacs-23.3a
$ cd ..
$ ./configure --prefix=YOUR-INSTALL-PATH && make -j2

bzr 版ならば、

$ cd /tmp
$ wget http://umiushi.org/~wac/bgex/patch-bgex_20110611_0-bzr-emacs-trunk.tar.bz2
$ tar xf patch-bgex_20110611_0-bzr-emacs-trunk.tar.bz2

$ cd YOUR-EMACS-PATH
$ bzr pull
$ cd src
$ patch < /tmp/patch-bgex_20110611_0-bzr-emacs-trunk/patch-bgex_20110611_0-bzr-emacs-trunk
$ cd ..
$ ./configure --prefix=YOUR-INSTALL-PATH && make -j2

bzr の場合タイミングによって patch が当たらないことが稀にありますが、ここ数年の実績では遅くとも 3 日以内に patch を更新できています。

bgex.el を load-path の通ったディレクトリにコピーします。

$ cp -av bgex.el YOUR-ELISP-PATH

まずテストのため background color を変更してみます。 .emacs を以下のように修正してください。

;; Emacs-BGEX patch
(add-to-list 'load-path "YOUR-ELISP-PATH")
(require 'bgex)
;; color
(when (boundp 'bgex-exist-p)
  (bgex-set-color-default "darkgreen" t)
  (bgex-set-color "*scratch*" 'bgex-identifier-type-buffer-name "skyblue"))

emacs 先ほどビルドしたものを起動しましょう。ビルドしてからカレントディレクトリを変更していなければ src/emacs で起動します。

.emacs を修正せずに src/emacs -Q で起動して、上のコードを *scratch* にコピーした方が問題が少ないかもしれません。

上の設定で Emacs を起動して background color が変わっていれば install は成功しています。次に image を指定するため、以下のように修正してみましょう。

指定する image は Emacs 側で対応している必要があります。 xpm/jpeg/png/gif あたりが使用できます。

;; color
;; (when (boundp 'bgex-exist-p)
;;   (bgex-set-color-default "darkgreen" t)
;;   (bgex-set-color "*scratch*" 'bgex-identifier-type-buffer-name "skyblue"))
;; image
(when (boundp 'bgex-exist-p)
  (bgex-set-image-default "YOUR-IMAGE-FILE-A")
  (bgex-set-image "*scratch*" 'bgex-identifier-type-buffer-name "YOUR-IMAGE-FILE-B" t))

あとは以下の .emacs 設定例で色々と調整してみてください。

.emacs 設定例

準備

load-path に含まれる場所へ bgex.el を置き、 .emacs に

;; Emacs-BGEX patch
(require 'bgex)

のように書いておきます。

フレームに背景画像を付ける

XEmacs の背景画像機能と似ています。 (boundp 'bgex-exist-p) で、 Emacs-BGEX patch が組み込まれているかどうかを調べることができます。

(when (boundp 'bgex-exist-p)
  (bgex-set-image-default "~/.emacs.d/images/background.xpm"))

このとき以下のような表示になります。

フレームに背景画像を付ける(色付き領域を背景に影響させる)

(when (boundp 'bgex-exist-p)
  (bgex-set-image-default "~/.emacs.d/images/background.xpm" t))

このとき以下のような表示になります。このモードは CPU とネットワークリソースを大量に消費します。色の計算式は SRC * DST / factor です 。

html-mode の(major-mode に対して)背景色を指定する(色付き領域を背景に影響させる)

(bgex-set-color "HTML" 'bgex-identifier-type-major-mode '(60000 40000 40000) t)

*scratch* の(バッファ名に対して)背景色を指定する

(bgex-set-color "*scratch*" 'bgex-identifier-type-buffer-name "skyblue")

*scratch* の(バッファ名に対して)背景画像を指定する

(bgex-set-image "*scratch*" 'bgex-identifier-type-buffer-name "~/tmp/bg.jpg")

XPM string で指定する

(when (boundp 'bgex-exist-p)
  (bgex-set-xpm-string "*scratch*" 'bgex-identifier-type-buffer-name "XPM string" t)
  (bgex-set-xpm-string-default "XPM string" t))

Emacs-BGEX patch を破棄する

(bgex-destroy-all)

作者の PC (falsion (MacBook (Core Duo 1.83GHz))) での設定

(when (boundp 'bgex-exist-p)
  (bgex-set-image-default "~/.emacs.d/images/.emacs22_back.xpm" t)
  (bgex-set-image "svn-status" 'bgex-identifier-type-major-mode "~/.emacs.d/images/w-cork12.jpg" t)
  (bgex-set-color "*YaDEV*glmm2-COMPILE*" 'bgex-identifier-type-buffer-name '(60000 50000 40000) t)
  (bgex-set-image "YaDEV-INTERFACE" 'bgex-identifier-type-major-mode "~/.emacs.d/images/w-surface04.jpg" t)
  (bgex-set-image "Buffer Menu" 'bgex-identifier-type-major-mode "~/.emacs.d/images/w-ca01.jpg" t)
  (bgex-set-color "Dired by name" 'bgex-identifier-type-major-mode '(60000 40000 40000) t)
  (bgex-set-color "Dired by date" 'bgex-identifier-type-major-mode '(40000 60000 40000) t)
  (bgex-set-image "C" 'bgex-identifier-type-major-mode "~/.emacs.d/images/w-ca05.jpg" t)
  (bgex-set-image "*scratch*" 'bgex-identifier-type-buffer-name "~/.emacs.d/images/w-sptit18.png" t))

背景が指定できて何が嬉しいの? 無駄じゃない?

バッファごとに背景が指定できると、バッファの意味や属性を modeline だけではなく背景色や画像で表現することができます。

その他にも例えば、

• 操作に注意が必要な重要なファイルを扱うバッファの背景色を変化させる
• dired のソートモードに応じて色を変化させてみる
• emacs-w3m の背景画像

などといった応用が考えられます。

っていうか楽しいじゃん。

Screenshot

画像をクリックすると大きな画像を表示します。

動作環境

Emacs-BGEX patch は以下の環境で動作確認しています。

history

2002 年

壁紙パッチを作成。 XEmacs のようにフレームに対するもののみ。

2003 年 2 月

壁紙パッチを元に Emacs-BGEX patch を作成。

2004 年

CVS HEAD 版を更新するだけのメンテナンスモードに。

2005 年 5 月

バッファ背景の再描画処理を見直した beta 版を追加。

2005 年 8 月

beta 版を current に。 21.2 のサポート打ち切り。(20050828_0)

2005 年 9 月

若干の機能拡張のあとメンテナンスモードに。(20050910_0, 20050921_0, 20050928_0)

2006 年 7 月

コンフリクト対策。(20060712_0)

2007 年 7 月

コンフリクト対策。(20070730_0)

2008 年 2 月

font backend 対策。(20080205_0, 20080206_0, 20080208_0, 20080218_0, 20080225_0)

2008 年 3 月

font backend 対応と一部の描画アルゴリズムを改良、不具合修正。(20080305_0, 20080309_0)

2008 年 5 月

コンフリクト対策。(20080515_0)

2008 年 8 月

不具合修正。(20080822_0)

2008 年 9 月

コンフリクト対策。(20080919_0)

2009 年 6 月

不具合修正、コンフリクト対策。(20090605_0, 20090624_0)

2009 年 10 月

不具合修正。(20091021_0)

2009 年 11 月

コンフリクト対策。(20091117_0, 20091123_0, 20091123_1)

2010 年 1 月

コンフリクト対策。(20100106_0)

2010 年 7 月

不具合修正、コンフリクト対策。(20100703_0, 20100705_3, 20100706_0, 20100708_0, 20100720_0, 20100720_1)

2011 年 1 月

struct emacs_globals 対策、コンフリクト対策。(20110119_0, 20110123_0)

2011 年 2 月

struct emacs_globals 対策、ハングアップ対策パッチの削除、最新のコードに対応。(20110210_0, 20110213_0, 20110215_0, 20110217_0)

2011 年 3 月

コンフリクト対策。(20110312_0)

2011 年 4 月

コンフリクト対策。(20110415_0, 20110417_0)

2011 年 6 月

コンフリクト対策。(20110611_0)

2011 年 8 月

23.3a に対応。(20110822_0)

2011 年 12 月

コンフリクト対策。(20111215_0)

2012 年 5 月

コンフリクト対策。(20120526_0)

2012 年 6 月

コンフリクト対策。(20120629_0)

2012 年 8 月

コンフリクト対策。(20120803_0, 20120806_0, 20120812_0, 20120820_0)

2012 年 9 月

コンフリクト対策、不具合修正。(20120906_0, 20120906_1, 20120916_0, 20120924_0, 20120926_0)

2012 年 12 月

コンフリクト対策。(20121216_0)

2013 年 3 月

コンフリクト対策。(20130327_0, 20130329_0)

2013 年 8 月

新 redisplay interface に対応、コンフリクト対策。(20130810_0, 20130829_0, 20130830_0)

2013 年 9 月

コンフリクト対策、不具合修正。(20130912_0, 20130916_0, 20130918_0, 20130919_0, 20130921_0)

2013 年 11 月

コンフリクト対策。(20131130_0)

2013 年 12 月

コンフリクト対策。(20131201_0, 20131202_0, 20131215_0)

2014 年 1 月

コンフリクト対策。(20140112_0)

2014 年 6 月

コンフリクト対策。(20140619_0, 20140623_0)

2014 年 7 月

コンフリクト対策。(20140728_0)

2014 年 11 月

コンフリクト対策。(20141115_0)

2014 年 12 月

コンフリクト対策。(20141223_0)

2015 年 1 月

コンフリクト対策。(20150126_0)

2015 年 2 月

コンフリクト対策。(20150213_0)

2015 年 5 月

コンフリクト対策、 24.5 対応。(20150515_0, patch-bgex_20150515_0-emacs-24.5.tar.xz, 20150527_0, 20150530_0)

2015 年 6 月

コンフリクト対策、 XPM string 対応。(20150608_0, 20150623_0)

2015 年 10 月

コンフリクト対策。(20151009_0, 20151022_0)

2015 年 11 月

コンフリクト対策。(20151113_0)

2016 年 2 月

コンフリクト対策。(20160201_0)

2016 年 11 月

ダブルバッファに対応。(20161103_0)

2017 年 4 月

コンフリクト対策、不具合修正。(20170413_0, 20170419_0, 20170422_0, 20170422_1)

2017 年 9 月

コンフリクト対策。(20170914_0)

2017 年 11 月

gcc5 対策。(20171104_0)

2018 年 8 月

コンフリクト対策。(20180812_0)

2019 年 1 月

最新のコードに対応、不具合修正。(20190130_0)

2019 年 4 月

最新のコードに対応。(20190428_0)

2019 年 5 月

最新のコードに対応。(20190511_0, 20190521_0, 20190523_0)

2019 年 6 月

最新のコードに対応。(20190609_0)

戻る