SWI-Prolog の plOpenGL パッケージを LINUX に導入する手順


## きっかけ

Prolog で画像が動かせれば子供が喜ぶものができるかもしれないと思いました。
- Tcl/Tk 呼び出し（３０年くらい前の発想？）
- X プロトコルを直接実装する（そんな体力はない...）
- VRML や X3D のようなファイルを吐いて別プロセスで表示する
- WebGL に描画する JavaScript のプログラムと WebSocket かなにかでやりとりして描かせる
だとか考えているうちに、SWI-Prolog のパッケージとして plOpenGL というのがあるのを見つけました。

https://www.swi-prolog.org/pack/list?p=plOpenGL

SWI-Prolog 公式サイトにこうして載っているからにはこれがオススメに違いない、ということでまずはインストールして動かしてみます。

## インストール

というわけで、まずは作者の GitHub

https://github.com/sebity/plOpenGL

を見てみると何年も更新が止まっているようです。モジュールとして定義されているべきファイルがモジュールになっていなかったりします。自分で修正しようかとも思ったのですが、誰か既にやってくれているかも、と fork したプロジェクトを探してみると、比較的良さそうなものが下のものでした：

https://github.com/friguzzi/plOpenGL

適当なディレクトリにソースコード一式を持ってきます。

```bash
tadashi9e@_$ git clone https://github.com/friguzzi/plOpenGL
```

OpenGL を呼び出す C のソースコードがあって、パッケージインストール時にこれを共有ライブラリとしてコンパイルしてもらう必要があります。plOpenGL は SW-Prolog の Foreign Module の仕組みを使ってこのライブラリを呼び出します。

plOpenGL のディレクトリに makefile があります。

```bash
tadashi9e@_$ cd plOpenGL
tadashi9e@_/plOpenGL$ ls -F
c/          codeblocks_win/  examples/      makefile  prolog/
CHANGELOG*  COPYRIGHT*       LICENSE.LGPL*  pack.pl*  README.md*
tadashi9e@_/plOpenGL$ 
```

さて、makefile の中身を見ると、PACKSODIR という変数が使われているのに設定部分がありません。これは pack_install/1 が値を設定して make コマンドを呼び出してくれることになっているようです。しかし、実際にこのままで tgz に固めて pack_install してみても共有ライブラリはできません。

pack_install のソースを覗いてみると、'Makefile' があるかどうかで make コマンドを実行すべきか判断しています。'makefile' だとこの判定に失敗してしまうようです。

https://github.com/SWI-Prolog/swipl/blob/master/library/prolog_pack.pl

そこで、ファイル名を makefile から Makefile に直しておきます。

```bash
tadashi9e@_/plOpenGL$ mv makefile Makefile
tadashi9e@_/plOpenGL$ ls -F
c/          codeblocks_win/  examples/      Makefile  prolog/
CHANGELOG*  COPYRIGHT*       LICENSE.LGPL*  pack.pl*  README.md*
```

c/plOpenGL.c にある C++ スタイルのコメントも pack_install 時に文句を言われるので C スタイルのコメントに直して置きました。

pack_install/1 に与えられるように、 tar と gz で固めます。0.6.2 はバージョン番号で、pack.pl に書いてある値を使いました。

```bash
tadashi9e@_$  tar cf - plOpenGL | gzip > plOpenGL-0.6.2.tgz
```

swipl を起動して、固めたファイルを pack_install/1 でインストールします。

~~~prolog
?- pack_install('plOpenGL-0.6.2.tgz').

Create directory for packages
   (1) * /home/tadashi9e/lib/swipl/pack
   (2)   Cancel

Your choice? ←　ここで１をタイプする

% Using built-in specs.
% COLLECT_GCC=gcc
% Target: x86_64-linux-gnu
% Configured with: ../src/configure -v --with-pkgversion='Ubuntu 5.4.0-6ubuntu1~16.04.11' --with-bugurl=file:///usr/share/doc/gcc-5/README.Bugs --enable-languages=c,ada,c++,java,go,d,fortran,objc,obj-c++ --prefix=/usr --program-suffix=-5 --enable-shared --enable-linker-build-id --libexecdir=/usr/lib --without-included-gettext --enable-threads=posix --libdir=/usr/lib --enable-nls --with-sysroot=/ --enable-clocale=gnu --enable-libstdcxx-debug --enable-libstdcxx-time=yes --with-default-libstdcxx-abi=new --enable-gnu-unique-object --disable-vtable-verify --enable-libmpx --enable-plugin --with-system-zlib --disable-browser-plugin --enable-java-awt=gtk --enable-gtk-cairo --with-java-home=/usr/lib/jvm/java-1.5.0-gcj-5-amd64/jre --enable-java-home --with-jvm-root-dir=/usr/lib/jvm/java-1.5.0-gcj-5-amd64 --with-jvm-jar-dir=/usr/lib/jvm-exports/java-1.5.0-gcj-5-amd64 --with-arch-directory=amd64 --with-ecj-jar=/usr/share/java/eclipse-ecj.jar --enable-objc-gc --enable-multiarch --disable-werror --with-arch-32=i686 --with-abi=m64 --with-multilib-list=m32,m64,mx32 --enable-multilib --with-tune=generic --enable-checking=release --build=x86_64-linux-gnu --host=x86_64-linux-gnu --target=x86_64-linux-gnu
% Thread model: posix
% gcc version 5.4.0 20160609 (Ubuntu 5.4.0-6ubuntu1~16.04.11) 
% COLLECT_GCC_OPTIONS='-fno-strict-aliasing' '-pthread' '-Wdate-time' '-D' '_FORTIFY_SOURCE=2' '-fPIC' '-D' '_GNU_SOURCE' '-I' '/usr/include/ncursesw' '-I' '/usr/lib/swi-prolog/include' '-shared' '-ggdb' '-Wall' '-D' '__USE_FIXED_PROTOTYPES__' '-ansi' '-v' '-c' '-o' 'c/plOpenGL.o' '-mtune=generic' '-march=x86-64'
%  /usr/lib/gcc/x86_64-linux-gnu/5/cc1 -quiet -v -I /usr/include/ncursesw -I /usr/lib/swi-prolog/include -imultiarch x86_64-linux-gnu -D_REENTRANT -D _FORTIFY_SOURCE=2 -D _GNU_SOURCE -D __USE_FIXED_PROTOTYPES__ c/plOpenGL.c -quiet -dumpbase plOpenGL.c -mtune=generic -march=x86-64 -auxbase-strip c/plOpenGL.o -ggdb -Wdate-time -Wall -ansi -version -fno-strict-aliasing -fPIC -fstack-protector-strong -Wformat-security -o /tmp/ccqNQ62B.s
% GNU C89 (Ubuntu 5.4.0-6ubuntu1~16.04.11) version 5.4.0 20160609 (x86_64-linux-gnu)
% 	compiled by GNU C version 5.4.0 20160609, GMP version 6.1.0, MPFR version 3.1.4, MPC version 1.0.3
% GGC heuristics: --param ggc-min-expand=100 --param ggc-min-heapsize=131072
% ignoring nonexistent directory "/usr/local/include/x86_64-linux-gnu"
% ignoring nonexistent directory "/usr/lib/gcc/x86_64-linux-gnu/5/../../../../x86_64-linux-gnu/include"
% #include "..." search starts here:
% #include <...> search starts here:
%  /usr/include/ncursesw
%  /usr/lib/swi-prolog/include
%  /usr/lib/gcc/x86_64-linux-gnu/5/include
%  /usr/local/include
%  /usr/lib/gcc/x86_64-linux-gnu/5/include-fixed
%  /usr/include/x86_64-linux-gnu
%  /usr/include
% End of search list.
% GNU C89 (Ubuntu 5.4.0-6ubuntu1~16.04.11) version 5.4.0 20160609 (x86_64-linux-gnu)
% 	compiled by GNU C version 5.4.0 20160609, GMP version 6.1.0, MPFR version 3.1.4, MPC version 1.0.3
% GGC heuristics: --param ggc-min-expand=100 --param ggc-min-heapsize=131072
% Compiler executable checksum: 5f69ca549f086e2c3748f9d1423a4dee
% COLLECT_GCC_OPTIONS='-fno-strict-aliasing' '-pthread' '-Wdate-time' '-D' '_FORTIFY_SOURCE=2' '-fPIC' '-D' '_GNU_SOURCE' '-I' '/usr/include/ncursesw' '-I' '/usr/lib/swi-prolog/include' '-shared' '-ggdb' '-Wall' '-D' '__USE_FIXED_PROTOTYPES__' '-ansi' '-v' '-c' '-o' 'c/plOpenGL.o' '-mtune=generic' '-march=x86-64'
%  as -v -I /usr/include/ncursesw -I /usr/lib/swi-prolog/include --64 -o c/plOpenGL.o /tmp/ccqNQ62B.s
% GNU assembler version 2.26.1 (x86_64-linux-gnu) using BFD version (GNU Binutils for Ubuntu) 2.26.1
% COMPILER_PATH=/usr/lib/gcc/x86_64-linux-gnu/5/:/usr/lib/gcc/x86_64-linux-gnu/5/:/usr/lib/gcc/x86_64-linux-gnu/:/usr/lib/gcc/x86_64-linux-gnu/5/:/usr/lib/gcc/x86_64-linux-gnu/
% LIBRARY_PATH=/usr/lib/gcc/x86_64-linux-gnu/5/:/usr/lib/gcc/x86_64-linux-gnu/5/../../../x86_64-linux-gnu/:/usr/lib/gcc/x86_64-linux-gnu/5/../../../../lib/:/lib/x86_64-linux-gnu/:/lib/../lib/:/usr/lib/x86_64-linux-gnu/:/usr/lib/../lib/:/usr/lib/gcc/x86_64-linux-gnu/5/../../../:/lib/:/usr/lib/
% COLLECT_GCC_OPTIONS='-fno-strict-aliasing' '-pthread' '-Wdate-time' '-D' '_FORTIFY_SOURCE=2' '-fPIC' '-D' '_GNU_SOURCE' '-I' '/usr/include/ncursesw' '-I' '/usr/lib/swi-prolog/include' '-shared' '-ggdb' '-Wall' '-D' '__USE_FIXED_PROTOTYPES__' '-ansi' '-v' '-c' '-o' 'c/plOpenGL.o' '-mtune=generic' '-march=x86-64'
% Using built-in specs.
% COLLECT_GCC=gcc
% COLLECT_LTO_WRAPPER=/usr/lib/gcc/x86_64-linux-gnu/5/lto-wrapper
% Target: x86_64-linux-gnu
% Configured with: ../src/configure -v --with-pkgversion='Ubuntu 5.4.0-6ubuntu1~16.04.11' --with-bugurl=file:///usr/share/doc/gcc-5/README.Bugs --enable-languages=c,ada,c++,java,go,d,fortran,objc,obj-c++ --prefix=/usr --program-suffix=-5 --enable-shared --enable-linker-build-id --libexecdir=/usr/lib --without-included-gettext --enable-threads=posix --libdir=/usr/lib --enable-nls --with-sysroot=/ --enable-clocale=gnu --enable-libstdcxx-debug --enable-libstdcxx-time=yes --with-default-libstdcxx-abi=new --enable-gnu-unique-object --disable-vtable-verify --enable-libmpx --enable-plugin --with-system-zlib --disable-browser-plugin --enable-java-awt=gtk --enable-gtk-cairo --with-java-home=/usr/lib/jvm/java-1.5.0-gcj-5-amd64/jre --enable-java-home --with-jvm-root-dir=/usr/lib/jvm/java-1.5.0-gcj-5-amd64 --with-jvm-jar-dir=/usr/lib/jvm-exports/java-1.5.0-gcj-5-amd64 --with-arch-directory=amd64 --with-ecj-jar=/usr/share/java/eclipse-ecj.jar --enable-objc-gc --enable-multiarch --disable-werror --with-arch-32=i686 --with-abi=m64 --with-multilib-list=m32,m64,mx32 --enable-multilib --with-tune=generic --enable-checking=release --build=x86_64-linux-gnu --host=x86_64-linux-gnu --target=x86_64-linux-gnu
% Thread model: posix
% gcc version 5.4.0 20160609 (Ubuntu 5.4.0-6ubuntu1~16.04.11) 
% COMPILER_PATH=/usr/lib/gcc/x86_64-linux-gnu/5/:/usr/lib/gcc/x86_64-linux-gnu/5/:/usr/lib/gcc/x86_64-linux-gnu/:/usr/lib/gcc/x86_64-linux-gnu/5/:/usr/lib/gcc/x86_64-linux-gnu/
% LIBRARY_PATH=/usr/lib/gcc/x86_64-linux-gnu/5/:/usr/lib/gcc/x86_64-linux-gnu/5/../../../x86_64-linux-gnu/:/usr/lib/gcc/x86_64-linux-gnu/5/../../../../lib/:/lib/x86_64-linux-gnu/:/lib/../lib/:/usr/lib/x86_64-linux-gnu/:/usr/lib/../lib/:/usr/lib/gcc/x86_64-linux-gnu/5/../../../:/lib/:/usr/lib/
% COLLECT_GCC_OPTIONS='-fno-strict-aliasing' '-pthread' '-Wdate-time' '-D' '_FORTIFY_SOURCE=2' '-fPIC' '-D' '_GNU_SOURCE' '-I' '/usr/include/ncursesw' '-I' '/usr/lib/swi-prolog/include' '-ggdb' '-Wall' '-D' '__USE_FIXED_PROTOTYPES__' '-ansi' '-v' '-rdynamic' '-g' '-O2' '-fstack-protector-strong' '-Wformat=1' '-Werror=format-security' '-pthread' '-shared' '-o' 'lib/amd64/plOpenGL.so' '-mtune=generic' '-march=x86-64'
%  /usr/lib/gcc/x86_64-linux-gnu/5/collect2 -plugin /usr/lib/gcc/x86_64-linux-gnu/5/liblto_plugin.so -plugin-opt=/usr/lib/gcc/x86_64-linux-gnu/5/lto-wrapper -plugin-opt=-fresolution=/tmp/ccT17eaE.res -plugin-opt=-pass-through=-lgcc -plugin-opt=-pass-through=-lgcc_s -plugin-opt=-pass-through=-lpthread -plugin-opt=-pass-through=-lc -plugin-opt=-pass-through=-lgcc -plugin-opt=-pass-through=-lgcc_s --sysroot=/ --build-id --eh-frame-hdr -m elf_x86_64 --hash-style=gnu --as-needed -shared -z relro -o lib/amd64/plOpenGL.so /usr/lib/gcc/x86_64-linux-gnu/5/../../../x86_64-linux-gnu/crti.o /usr/lib/gcc/x86_64-linux-gnu/5/crtbeginS.o -L/usr/lib/gcc/x86_64-linux-gnu/5 -L/usr/lib/gcc/x86_64-linux-gnu/5/../../../x86_64-linux-gnu -L/usr/lib/gcc/x86_64-linux-gnu/5/../../../../lib -L/lib/x86_64-linux-gnu -L/lib/../lib -L/usr/lib/x86_64-linux-gnu -L/usr/lib/../lib -L/usr/lib/gcc/x86_64-linux-gnu/5/../../.. -Bsymbolic-functions -z relro c/plOpenGL.o -lGL -lglut -lGLU -lm -lgcc --as-needed -lgcc_s --no-as-needed -lpthread -lc -lgcc --as-needed -lgcc_s --no-as-needed /usr/lib/gcc/x86_64-linux-gnu/5/crtendS.o /usr/lib/gcc/x86_64-linux-gnu/5/../../../x86_64-linux-gnu/crtn.o
% gcc -fno-strict-aliasing -pthread -fPIC -Wdate-time -D_FORTIFY_SOURCE=2 -fPIC -D_GNU_SOURCE -I/usr/include/ncursesw -I"/usr/lib/swi-prolog/include" -shared -ggdb -Wall -D__USE_FIXED_PROTOTYPES__ -ansi -v   -c -o c/plOpenGL.o c/plOpenGL.c
% mkdir -p lib/amd64
% gcc -fno-strict-aliasing -pthread -fPIC -Wdate-time -D_FORTIFY_SOURCE=2 -fPIC -D_GNU_SOURCE -I/usr/include/ncursesw -I"/usr/lib/swi-prolog/include" -shared -ggdb -Wall -D__USE_FIXED_PROTOTYPES__ -ansi -v -rdynamic -Wl,-Bsymbolic-functions -Wl,-z,relro -g -O2 -fstack-protector-strong -Wformat -Werror=format-security -pthread   -shared -o lib/amd64/plOpenGL.so c/plOpenGL.o  -lGL -lglut -lGLU -lm 
% make: Nothing to be done for 'check'.
% make: Nothing to be done for 'install'.
true.

?- halt.
~~~

コンパイルに失敗する場合には、必要なライブラリが揃っているか調べてください。エラーメッセージを見て、ないと言われているファイルがあったら apt-file search や apt-cache search などで調べてインストールしてやりなおしてください。SWI-Prolog のパッケージは $HOME/lib/swipl/pack/plOpenGL/ ディレクトリ上にインストールされるので、失敗したらディレクトリごと消してしまえば何度でもやり直せます。
うまくインストールできれば、上記ディレクトリに lib/amd64/plOpenGL.so ができるはずです：

````bash
$ ls -F $HOME/lib/swipl/pack/plOpenGL/lib/amd64
plOpenGL.so*
````

私の場合にはビルドを成功させるために以下が必要でした：

````bash
$ sudo apt update
$ sudo apt install libgl1-mesa-dev
$ sudo apt install libglu1-mesa-dev
$ sudo apt install freeglut3-dev
 ````

## サンプルソースの実行

この状態で $HOME/lib/swipl/pack/plOpenGL/examples にあるサンプルソースが動くようになりました。

````bash
$ cd $HOME/lib/swipl/pack/plOpenGL/examples
$ swipl
?- [material].
true.

?- main.
call to glutInit
call to glutInitDisplayMode(16)
call to glutInitWindowSize(600,600)
call to glutCreateWindow(Material), id:1
glShadeModel(1d01)
glutDisplayFunc 0x7fb08768b700
glutReshapeFunc 0x7fb08768badf
````
こんなのが表示されます：
![Material.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/412308/f1b18925-cb74-47ca-d5b2-294a1c594983.png)

## 感想

SWI-Prolog のパッケージはよくできているので、きっと簡単にインストールできるに違いないと思いましたが、意外に苦労しました。examples にあるソースの半分くらい動かないので、まだ必要なライブラリが足りないのかもしれません。