List of Lua [text.Baldanders.info]

NYAGOS 4.3 で GopherLua が採用される

2018-04-30T09:49:39+00:00

（正式版が出たので内容を更新した 2018-05-07）

NYAGOS 4.3 で Lua の Go 言語実装のひとつである GopherLua が採用された。

以下に変更点をまとめて紹介する。

Use Gopher-Lua instead of lua53.dll #300

nyagos with lua53.dll (mains.exe) can be built with cd mains ; go build

nyagos with no Lua (ngs.exe) can be built with cd ngs ; go build

Made nyagos.option.cleanup_buffer (default=false). When it is true, clean up console input buffer before readline.

set -o OPTION_NAME and set +o OPTION_NAME (=nyagos.option.OPTION_NAME= on Lua)

Buffer console-output ( go-colorable and bufio.Writer ) ^ Fix: Typing C-o looks to raise hang up until Enter or ESCAPE is typed (on 4.3beta) #303

Fix the library: go-box

Fix: chcp did not work. (chcp was aliaes to update memory of screen width)

Add ls -L which shows information for the file refernces rather than for the link it self. (because ls could not show the directories in OneDrive )

lua53.dll のかわりに Gopher-Lua を採用 #300

旧来の lua53.dll 版 nyagos (mains.exe) は cd mains ; go build でビルド可能

Lua無し版 nyagos (ngs.exe) は cd ngs ; go build でビルド可能

nyagos.option.cleanup_buffer を追加(デフォルトは false)。true の場合、一行入力の前にコンソールバッファをクリアする

set -o OPTION_NAME と set +o OPTION_NAME を新設(nyagos.option.OPTION_NAME= on Lua と等価)

コンソール出力をバッファリングするようにした ( go-colorable and bufio.Writer )

C-o を押すと Enter か Escape が押されるまでハングしたように見える不具合を修正

(ライブラリを修正: go-box)

chcp が動作しない不具合を修正 (同コマンドは画面幅取得のため別名定義していた)

シンボリックリンクの先を参照するオプション ls -L を追加（OneDrive内のディレクトリーが表示できなかったため）

via Release 4.3.0_0

起動時のバージョン表記は以下のようになる。

Nihongo Yet Another GOing Shell 4.3.0_2-amd64 by go1.10.2
Powered by GopherLua 0.1
(c) 2014-2018 NYAOS.ORG <http://www.nyaos.org>

私も以前 Lua の Go 言語実装についてちょろんと調べたことがあるのだが

Go 言語による Lua 実装を試してみた

このときは別のパッケージでしかも args などのグローバル変数の設定の仕方がよく分からなくて放置していたのだ（ゴメンペコン）。

Go 言語は組込み用途のコードも書けるので，そこに Lua エンジンを（Go 言語ネイティブで）組み込めるというのは意義が大きいと思う。例えば現在のツールの多くは設定情報を YAML や TOML などで記述するが， Lua で設定を記述できるのなら，ちょっとしたロジックを組み込むことも可能になる。実際に NYAGOS ではコマンドの alias に Lua コードを組み込むことができる。

NYAGOS で GopherLua を組み込んでくれるのなら，是非ソースコードも読んでノウハウを勉強したい。

【追記 2018-05-07】 4.3.0 にアップグレードして起動した際に

C:\Users\username\AppData\Roaming\NYAOS_ORG\amd64.nyagos.luac line:1(column:1) near '←':   Invalid token

と警告が出た。古いファイルなのかな？

この場合は C:\Users\username\AppData\Roaming\NYAOS_ORG フォルダの中身を掃除すればいいようだ。なお，このフォルダにある nyagos.history ファイルは名前の通りコマンド履歴なのでご注意を。

【追記 2018-05-07】 NYAGOS 4.3.0_1 がリリース

Release 4.3.0_1 · nyaosorg/nyagos · GitHub

不具合の修正のみ。

Fix: nyagos.d/start.lua did not worked because the member rawargs of alias-function’s argument was not implemented.

Fix: the return value of alias-function was not evaluted.

Fix: for the script in -e option, arg[] was not assinged.

Fix: On -f & -e option, warned as getRegInt: could not find shell in Lua instanc e

Fix: batchfile cound not return the value of exit /b as ERRORLEVEL

nyagos.d/start.lua が動作していなかった不具合を修正 (エイリアス関数の rawargs パラメータが実装されていなかった)

alias 関数の戻り値が評価されていなかった不具合を修正

-e オプションのスクリプト向けに、arg[] に引数が代入されていなかった

-e,-f オプションで、getRegInt: could not find shell in Lua instance が表示される不具合を修正

バッチファイルが exit /b の値を ERRORLEVEL として返せなかった不具合を修正

via Release 4.3.0_1

【追記 2018-05-07】 NYAGOS 4.3.0_2 がリリース

Release 4.3.0_2 · nyaosorg/nyagos · GitHub

不具合の修正のみ。

#305: Fix issue that user’s .nyagos was not loaded again (Thx! @erw7)

#305: ユーザの .nyagos が二回目以降ロードされない不具合を修正(Thx! @erw7)

via Release 4.3.0_2

【追記 2018-05-10】 NYAGOS 4.3.0_3 がリリース

Release 4.3.0_3 · nyaosorg/nyagos

不具合の修正。着々と改善されています。

Fix: forgot implement nyagos.setalias , nyagos.getalias (alias { CMD=XXX} did not work.)

Fix: that the element [0] of the table value returned by alias-function was not used as the new command name to evaluate.

Fix: doc/09-Build_*.md about how to download sourcefiles from github

nyagos.setalias, nyagos.getalias の実装が漏れており、alias { CMD=XXX} が動かなくなっていた

エイリアスの戻り値でテーブルが与えられた時、コマンド名として解釈すべき、要素[0]が使われていなかった不具合を修正

doc/09-Build_*.md: github からのソースダウンロード方法についてドキュメント更新

via Release 4.3.0_3

【追記 2018-05-13】 NYAGOS 4.3.0_4 がリリース

Release 4.3.0_4 · nyaosorg/nyagos

不具合の修正。着々と改善されています。

Fix: #309 nyagos.getkey() raised panic (Thx @nocd5)

Fix: error-message when command lnk’s target is not *.lnk nor exist.

Fix: the cursor blink was switched to off on the child process.

Fix: #309 nyagos.getkey() が使えない不具合を修正 (Thx @nocd5)

lnk コマンドの宛先が *.lnk でなかったり存在しなかった時のエラーメッセージを修正

子プロセスのカーソルがオフになってしまう不具合を修正

via Release 4.3.0_3

ブックマーク

バージョン間のコミット・ログを取得する

2018-03-06T09:58:09+00:00

GitHub でリリース・ドキュメントを書くことを考える。

Go 言語で書いたツールのバイナリ・リリース時は GoReleaser にお任せで全部やってくれるのだが，ソースコードやドキュメントのみのリリースの場合は自前でドキュメントを書く必要がある。このとき git log コマンドでコミット・ログを参照するのだが，滅多に使わないコマンドなので毎回 Google 先生のお世話になる。

今度忘れたときに Google 先生のお世話にならなくても済むよう覚え書きとして残しておく。

コミット・ログの収集

たとえば v0.6.0 と v0.7.0 の間のコミット・ログを markdown 形式で箇条書きにしたい場合はこうする。

$ git log "--pretty=format:- %s %h" v0.6.0..v0.7.0
- Merge pull request #3 from spiegel-im-spiegel/signal-subpackage 01a70c3
- Update Document 3fe7b80
- Add signal subpackage cfff012

この出力から “Merge” とか “typo” とかいった単語を含む行を除きたければ grep と組み合わせればよい。

$ git log "--pretty=format:- %s %h" v0.6.0..v0.7.0 | grep -v Merge
- Update Document 3fe7b80
- Add signal subpackage cfff012

なお pretty format に使える %s などのプレースホルダ等については以下が参考になる。

Git - pretty-formats Documentation

コマンドを NYAGOS の Alias として組み込む

NYAGOS には Lua で書いたコードを alias コマンドとして組み込めるという素敵な機能がある。そこで，先ほどの git log コマンドを NYAGOS の alias として組み込んでみる。具体的には .nyagos に以下の記述を追加する。

-- git log
nyagos.alias.gitlog = function(args)
    local form = "--pretty=format:- %s %h"
    if #args < 1 then
        nyagos.rawexec("git", "log", form)
    elseif #args == 1 then
        nyagos.rawexec("git", "log", form, args[1])
    elseif #args == 2 then
        nyagos.rawexec("git", "log", form, args[1]..".."..args[2])
    else
        nyagos.writerr("Usage: gitlog [[<from>] <to>]\n")
    end
end

これで gitlog コマンドができた。実際に動かしてみる。

$ gitlog v0.6.0 v0.7.0
- Merge pull request #3 from spiegel-im-spiegel/signal-subpackage 01a70c3
- Update Document 3fe7b80
- Add signal subpackage cfff012

$ gitlog v0.6.0 v0.7.0 | grep -v Merge
- Update Document 3fe7b80
- Add signal subpackage cfff012

よーし，うむうむ，よーし。

ブックマーク

Go 言語による Lua 実装を試してみた

2018-02-28T10:00:05+00:00

Lua 言語について調べてたら，たまたま Go 言語による VM とコンパイラの実装を見つけた。

milochristiansen/lua: A Lua 5.3 VM and compiler written in Go.

面白そうなのでちょろんと試してみた。

みんな大好き Hello World

まずは，みんな大好き Hello World から。

package main

import (
	"fmt"
	"os"
	"strings"

	"github.com/milochristiansen/lua"
	"github.com/milochristiansen/lua/lmodbase"
)

func main() {
	l := lua.NewState()

	err := l.Protect(func() {
		l.Push(lmodbase.Open)
		l.Call(0, 0)
	})
	if err != nil {
		fmt.Fprintln(os.Stderr, err)
		return
	}
	if err := l.LoadText(strings.NewReader("print(\"Hello Lua!\")"), "", 0); err != nil {
		fmt.Fprintln(os.Stderr, err)
		return
	}
	if err := l.PCall(0, 0); err != nil {
		fmt.Fprintln(os.Stderr, err)
		return
	}
}

これを実行すると Lua のスクリプト “print("Hello Lua!")” が実行され結果が標準出力に出力される。

$ go run hello.go
Hello Lua!

lua.State の中身

lua.NewState() 関数で生成される lua.State インスタンスの中身はこんな感じ。

// State is the central arbitrator of all Lua operations.
type State struct {
	// Output should be set to whatever writer you want to use for logging.
	// This is where the standard script functions like print will write their output.
	// If nil defaults to os.Stdout.
	Output io.Writer

	// Add a native stack trace to errors that have attached stack traces.
	NativeTrace bool

	registry *table
	global   *table // _G
	metaTbls [typeCount]*table

	stack *stack
}

lua.State.Output に適切な Writer をセットすることで print 関数の出力先を変更できる（nil なら標準出力に出力する）。

モジュールの読み込み

以下の部分でモジュールを読み込んでいる。

err := l.Protect(func() {
    l.Push(lmodbase.Open)
    l.Call(0, 0)
})

lua.State.Protect() 関数は，関数の実行で panic が発生した際に panic を止めて error を返している。

// Protect calls f inside an error handler. Use when you need to use API functions that may "raise errors" outside of
// other error handlers (such as PCall).
//
// Protect does the same cleanup PCall does, so it is safe to run code with Call inside a Protected function.
func (l *State) Protect(f func()) (err error) {
	defer l.Recover(0, false)(&err)

	f()

	return nil
}

lua/lmodbase はベースモジュールを格納するサブパッケージである。ちなみに print 関数はベース・モジュールに含まれるため，読み込まないと実行時エラーになる。

Value is not a function and has no __call meta method.

lua パッケージには他にも lua/lmodmath, lua/lmodpackage, lua/lmodstring, lua/lmodtable が用意されている。また，これらのサブパッケージを参考にすれば独自の拡張も可能になるだろう。

Lua スクリプトの読み込みと実行

以下の部分では Lua スクリプトの読み込みと実行を行っている。

if err := l.LoadText(strings.NewReader("print(\"Hello Lua!\")"), "", 0); err != nil {
    fmt.Fprintln(os.Stderr, err)
    return
}
if err := l.PCall(0, 0); err != nil {
    fmt.Fprintln(os.Stderr, err)
    return
}

lua.State.PCall() 関数は lua.State.Call() 関数をラップして panic 時の処理を加えている。

// PCall is exactly like Call, except instead of panicking when it encounters an error the
// error is cleanly recovered and returned.
//
// On error the stack is reset to the way it was before the call minus the function and it's arguments,
// the State may then be reused.
func (l *State) PCall(args, rtns int) (err error) {
	defer l.Recover(args+1, true)(&err)

	l.Call(args, rtns)
	return nil
}

lua.State.LoadText() 関数の代わりに lua.State.LoadBinary() 関数を使えばコンパイル済みのバイナリを読み込ませることもできるようだ。

Lua スクリプトファイルを読み込んで実行する

大体分かったところで Lua スクリプトファイルを読み込んで実行してみる。用意したファイルはフィボナッチ数を求めるスクリプト。

function fibonacciNumber(n)
	if n < 2 then
		return n
	end
	return fibonacciNumber(n - 2) + fibonacciNumber(n - 1)
end

print(fibonacciNumber(38))

スクリプトを読み込んで実行するコードはこんな感じ。

package main

import (
	"flag"
	"fmt"
	"io"
	"os"

	"github.com/milochristiansen/lua"
	"github.com/milochristiansen/lua/lmodbase"
	"github.com/milochristiansen/lua/lmodmath"
	"github.com/milochristiansen/lua/lmodpackage"
	"github.com/milochristiansen/lua/lmodstring"
	"github.com/milochristiansen/lua/lmodtable"
)

func Run(r io.Reader) error {
	l := lua.NewState()

	err := l.Protect(func() {
		l.Push(lmodbase.Open)
		l.Call(0, 0)

		l.Push(lmodmath.Open)
		l.Call(0, 0)

		l.Push(lmodpackage.Open)
		l.Call(0, 0)

		l.Push(lmodstring.Open)
		l.Call(0, 0)

		l.Push(lmodtable.Open)
		l.Call(0, 0)
	})
	if err != nil {
		return err
	}

	if err := l.LoadText(r, "", 0); err != nil {
		return err
	}
	if err := l.PCall(0, 0); err != nil {
		return err
	}
	return nil
}

func main() {
	flag.Parse()
	if flag.NArg() == 0 {
		fmt.Fprintln(os.Stderr, os.ErrInvalid)
		return
	}
	file, err := os.Open(flag.Arg(0))
	if err != nil {
		fmt.Fprintln(os.Stderr, err)
		return
	}
	defer file.Close()

	if err := Run(file); err != nil {
		fmt.Fprintln(os.Stderr, err)
		return
	}
}

これを実行するとこんな感じになった。

$ go run glua.go fibonacci.lua
39088169

うーん。引数を伴う場合はどうするんだろう。 arg みたいなのはないっぽいのでグローバル変数として自前でセットしないといけないかな？

まぁ，気が向いたらまた今度。

ブックマーク

inforno :: LuaのGo言語実装を公開しました : こちらは Lua 5.1 を Go 言語で実装している
- zetamatta/expect: expect for Command Prompt powered by GopherLua

参考図書

プログラミング言語Go (ADDISON-WESLEY PROFESSIONAL COMPUTING SERIES): Alan A.A. Donovan (著), Brian W. Kernighan (著), 柴田芳樹 (翻訳); 丸善出版 2016-06-20; 単行本（ソフトカバー）; 4621300253 (ASIN), 9784621300251 (EAN), 4621300253 (ISBN); 評価

著者のひとりは（あの「バイブル」とも呼ばれる）通称 “K&R” の K のほうである。この本は Go 言語の教科書と言ってもいいだろう。と思ったら絶版状態らしい（2025-01 現在）。復刊を望む！

reviewed by Spiegel on 2016-07-13 (powered by PA-APIv5)

Lua のモジュール

2016-01-04T13:44:13+00:00

NYAGOS 4.1.0_0 がリリースされた。主な変更点は ln コマンドが追加されたことのようだ。

Release 4.1.0_0 · nyaosorg/nyagos

ただ，私の場合はより切実な問題があって， -f オプションで Lua のスクリプトを実行させた場合に module() 関数が使えなくなった。 Lua は不案内なので知らなかったのだが module() 関数は Lua 5.2 で deprecated になっていたらしい。逆になんで今まで使えてたのかは分からない。

Luaのモジュールを穴が空くまで見つめてみる - プログラミングの魔物

module() 関数が使えないので require() で外部ファイルを呼び出すとファイル内の記述がそのまま実行される。

以前なら module1.lua に

module("module1", package.seeall)

function method1()
    return "Method 1"
end

function method2()
    return "Method 2"
end

と定義しておけば

require("module1")

nyagos.write(module1.method1().."\n")
nyagos.write(module1.method2().."\n")

と記述できた。もし同じように機能させたいなら module1.lua を

module1 = {}

module1.method1 = function()
    return "Method 1"
end

module1.method2 = function()
    return "Method 2"
end

と記述するのが一番簡単なようだ。 module1 を関数テーブルとして定義するわけだ。

あるいは module1.lua を

local module1 = {}

module1.method1 = function()
    return "Method 1"
end

module1.method2 = function()
    return "Method 2"
end

return module1

としておいて，呼び出し側を

local module1 = require("module1")

nyagos.write(module1.method1().."\n")
nyagos.write(module1.method2().."\n")

とすればグローバル領域を汚さずに済むだろう。

Lua Unofficial FAQ (uFAQ) : “1.37.2 Life after module()?” の項が参考になる
c++ - Using the ‘module’ function in Lua 5.2? - Stack Overflow
その４会得必須！Luaの真髄「テーブル」
第 4 回: Lua のオブジェクト指向について紹介する — WTOPIA v1.0 documentation
Luaのモジュール徹底解説（Lua 5.1〜5.3対応） - Qiita

NYAGOS 4.1-beta がリリース

2015-12-20T07:31:06+00:00

ここのところ忙しくしてたら，いつの間にか NYAGOS の 4.1-beta が出てた。 4.1 で大きく変わったのはコールバック関数の扱いのようだ。

クラッシュ回避のため、全てのLua のコールバック関数はそれぞれの Lua インスタンスを持つようにした。（つまり、.nyagos で定義されたグローバル変数は、全てのコールバック関数から見ることができなくなった）
コールバック関数と .nyagos 間で値を共有するため、テーブル share[] を作った

コールバック関数の挙動が変わったのは

この制限は、クラッシュ回避のため、コールバック関数ごとに別の Lua インスタンスを用意しているためです。エイリアス等は別の goroutine 内で呼ばれるのですが、4.0 では、この時同一の Lua インスタンスを使用していたため、時にスタックに矛盾が発生して、クラッシュすることがあったのです。

nyagosスクリプト解説 - CMD.EXEで化けさせず、nyagosの中だけプロンプトをカラー化より

ということらしい。

実は NYAGOS で表示するプロンプトは以下の記事を参考にオリジナルの %PROMPT% から変えている。

nyagosスクリプト解説 - CMD.EXEで化けさせず、nyagosの中だけプロンプトをカラー化 - Qiita

以前のプロンプト定義は以下のような感じだった。

-- Simple Prompt for CMD.EXE
set{
    PROMPT='$L'.. nyagos.getenv('COMPUTERNAME') .. ':$P$G$_$$$s'
}

-- Coloring Prompt for NYAGOS.exe
local prompter=nyagos.prompt
nyagos.prompt = function(this)
    return prompter('$e[36;40;1m'..this..'$e[37;1m')
end

この中の prompter がコールバック関数から見えなくなったということらしい。そこで以下のようにコードを変更するのだそうだ。

-- Simple Prompt for CMD.EXE
nyagos.env.prompt='$L'.. nyagos.getenv('COMPUTERNAME') .. ':$P$G$_$$$s'

-- Coloring Prompt for NYAGOS.exe
share.org_prompter=nyagos.prompt
nyagos.prompt = function(this)
    return share.org_prompter('$e[36;40;1m'..this..'$e[37;1m')
end

ポイントは share.org_prompter=nyagos.prompt の部分。オリジナルの nyagos.prompt() 関数を share[] テーブルに退避させている。

これでめでたく

C:\program\nyagos>nyagos.exe
Nihongo Yet Another GOing Shell 4.1-beta-amd64 Powered by go1.5.2 & Lua 5.3
Copyright (c) 2014,2015 HAYAMA_Kaoru and NYAOS.ORG
<VENUS:C:/program/nyagos>
$ ls
Doc/               lua53.dll          nyagos.lua*        specialfolders.js*
catalog.d/         makeicon.cmd*      nyole.dll
license.txt        nyagos.d/          readme.md
lnk.js*            nyagos.exe*        readme_ja.md
<VENUS:C:/program/nyagos>
$

と表示できるようになった（カラーでお見せできないのが残念です）¹。

実は私もプロンプトは折り返す派。開発環境ではフォルダがかなり深くなることがあり，既存の $P$G では見づらいのだ。まぁこれは Windows に限らないのだが。

参考

そういや昔の UNIX ワークステーションはホスト名に venus とか惑星名を付けてるところが多かったな。私がネットワーク管理者をしてた時はプロキシサーバに janus とか付けてた。若気の至りである（笑） ↩︎

NYAGOS で Lua

2015-11-02T12:41:54+00:00

前回， ConEmu とともに NYAGOS を導入したけど，今回は NYAGOS のセッティングを中心に。

NYAGOS の特徴のひとつに， Lua のエンジンを内蔵し解釈できる点がある。というか NYAGOS 自身が機能拡張を Lua で実装していて，ユーザも hackable に NYAGOS をカスタマイズできる。

また nyagos.exe を -f オプションを付けて起動すると Lua のソースファイルをスクリプトとして実行できる。たとえば以下のコード hello.lua を以下のように記述し

print "Hello World!"

nyagos.exe で実行すると

C:>nyagos.exe -f hello.lua
Hello World!

となる。

これだけだと大したことはないが， nyagos.exe でスクリプトを実行した場合は NYAGOS の Lua 拡張が使える。例えばカレント・フォルダを取得する getwd.lua を以下のように記述し

nyagos.write(nyagos.getwd().."\n")

nyagos.exe で実行すると

C:\Users\username>nyagos.exe -f getwd.lua
C:\Users\username

となる。

Lua 拡張についてはドキュメントを参照するとよいだろう。特筆すべきは alias 機能で，単純なコマンドの置き換えだけでなく

nyagos.alias.cmdname = function(args) ... end

のような形式で新しい内部コマンドを作成することもできる。

ところで nyagos.exe を普通に起動してプロンプトから ls -oF コマンドでファイルの一覧を表示させてみると，拡張子 .lua のファイルは実行可能ファイルになっていることが分かる¹。

実際に NYAGOS のプロンプト上で動かしてみよう。

$ hello.lua
Hello World!

おおっ，うまくいった。これで Lua スクリプトを NYAGOS 上でバッチファイルのように扱うことができる。

さぁて，これでいよいよもって Lua の勉強をしないといけなくなった。 Pascal 系の構文は目が滑るんだよなぁ。

ブックマーク

NYAGOS 作者による解説

Lua の解説

その他

拡張子 .lua とコマンドの関連付けは NYAGOS をインストールしたフォルダにある _nyagos ファイルに記述されている。 ↩︎
最近の Git for Windows は bash 関連のコマンドを Git\usr\bin フォルダに集めている。 git コマンドだけが必要なら Git\cmd フォルダにのみパスを通せばよい。 bash を使う場合は Git\bin フォルダにある bash.exe を起動するのが一番安全なようだ。 ↩︎

LuaTeX-ja に関する覚え書き

2015-09-26T16:32:49+00:00

（これは2014年9月12日に公開した記事を再構成したものです）

$\mathrm{Lua\TeX}$ では $\mathrm{pdf\TeX}$ と同等のことができ， DVI ファイルではなく PDF ファイルを直接出力する。なおかつ callback を記述することにより内部処理に割り込みをかけ機能拡張することが可能になっている。 $\mathrm{Lua\TeX}$-ja はこの機能拡張を使って日本語組版を $\mathrm{Lua\TeX}$ の上で実現する。

参考

pTeX からの主な変更点

和文フォントは(小塚明朝,IPA 明朝などの)実際のフォント，和文フォントメトリック(JFMと呼ぶ )の組である
日本語の文書中では改行はほとんどどこでも許されるので， $\mathrm{p\TeX}$ では和文文字直後の改行は無視される(スペースが入らない)ようになっていた。しかし， $\mathrm{Lua\TeX}$-ja では $\mathrm{Lua\TeX}$ の仕様のためにこの機能は完全には実装されていない
2つの和文文字の間や，和文文字と欧文文字の間に入るグルー/カーン(両者をあわせて JAglue と呼ぶ)の挿入処理が 0 から書き直されている
$\mathrm{Lua\TeX}$-ja では， $\mathrm{p\TeX}$ と同様に漢字・仮名を制御綴内に用いることができ， \西暦 などが正しく動作するようにしている。但し，制御綴中に使える和文文字が $\mathrm{p\TeX}$, $\mathrm{up\TeX}$ と全く同じではないことに注意すること

LuaTeX のバージョン（in TeX Live 2017）

$ lualatex -v
This is LuaTeX, Version 1.0.4 (TeX Live 2017/W32TeX)

Execute  'luatex --credits'  for credits and version details.

There is NO warranty. Redistribution of this software is covered by
the terms of the GNU General Public License, version 2 or (at your option)
any later version. For more information about these matters, see the file
named COPYING and the LuaTeX source.

LuaTeX is Copyright 2017 Taco Hoekwater and the LuaTeX Team.

TeX Live で最新版を取得するには

$ tlmgr update --self --all

などとする。

大雑把な解説

最初の一歩

最低限の $\mathrm{\LaTeX}$ 文書ファイルはこんな感じ。入力は UTF-8 で行う。

\documentclass{ltjsarticle}
% \usepackage{luatexja} % no need to use luatexja with ltjclasses or ltjsclasses classes

\begin{document}

\section{はじめてのLua\TeX-ja}

ちゃんとLua\TeX-jaで日本語が出るかな？

\subsection{出たかな？}

長い文章を入力するとちゃんと右端のところで折り返されるかな？
大丈夫そうな気がするけど．ちょっと不安だけど何事も挑戦だよね。

\end{document}

ltjsarticle クラスを用いるのであれば \usepackage{luatexja} の記述はなくても問題ない。

これで

> luatatex hoge.tex

で問題なく処理できる。

和文フォントの埋め込み

TeX Live 2020 からは既定で原ノ味フォントを埋め込むよう設定されている。明示的に和文フォントを埋め込む場合は luatexja-preset パッケージで書体単位でまとめてフォントを指定できる。

\usepackage[sourcehan]{luatexja-preset} %和文フォントに Source Han フォントを指定する

プリセットオプションは以下のとおり

kozuka-pro
kozuka-pr6
kozuka-pr6n
haranoaji ¹
hiragino-pro
hiragino-pron
morisawa-pro
morisawa-pr6n
yu-win （游明朝/游ゴシック; Win8.1 以降）
yu-osx （游明朝/游ゴシック; macOS）
ipa, ipaex, ms
ipa-hg, ipaex-hg, ms-hg （Office 付属フォントを利用）
moga-mobo
sourcehan ²
noembed （フォントを埋め込まない）

追加で以下のオプションも使用できる

nodeluxe: 明朝体・ゴシック体を各 1 ウェイトで使用する（規定値）
deluxe: 明朝体2ウェイト・ゴシック体3ウェイトと，丸ゴシック体を使用可能にする（otf パッケージ互換）
expert: 横組専用仮名を用いる（otf パッケージ互換）
bold: 「明朝の太字」をゴシック体の太字によって代替する（otf パッケージ互換）
90jis: 可能ならば 90JIS 字形を使う
jis2004: 可能ならば JIS2004 字形を使う
jis: jfm-jis.lua を JFM として用いる（JIS フォントメトリックに近い結果が得られる）
no-math: fontspec パッケージによる数式フォント置換が不都合な場合に指定する

graphicx および xcolor パッケージ

graphicx および xcolor パッケージはドライバ指定なしでOK。（自動検出される）

\usepackage{graphicx,xcolor}

明示的に指定するのであれば luatex を指定する³。

\usepackage[luatex]{graphicx,xcolor}

hyperref パッケージ

【2020-06-09 追記】 拙文「LuaLaTeX で PDF/A を構成する」で pdfx パッケージを使って PDA/A を構成するやり方を紹介している。むしろ pdfx パッケージを使うほうがオススメなのだが，以下の hyperref および hyperxmp パッケージを使ったやり方は当時の記念として残しておく。

hyperref パッケージも同様にドライバ指定なし大丈夫だが，そのままでは PDF の目次等が文字化けしてしまうので以下のパラメータを指定する。

\usepackage[pdfencoding=auto]{hyperref}

または

\usepackage[unicode=true]{hyperref}

更に pdfa オプションをつけると PDF/A-1b 準拠の PDF を出力する。

\usepackage[pdfencoding=auto,pdfa]{hyperref} % PDF/A compatible

hyperref パッケージでは PDF metadata 用に以下のオプションが指定できる。

baseurl
pdfauthor
pdfkeywords
pdflang
pdfproducer
pdfsubject
pdftitle

hyperxmp パッケージ

hyperxmp パッケージを使うと XMP（Extensible Metadata Platform）によるメタデータを埋め込むことができる。これは hyperref パッケージと組み合わせて使う。

\usepackage{hyperxmp} % XMP support with hyperref
\usepackage[pdfencoding=auto,pdfa]{hyperref} % PDF/A compatible

\hypersetup{% hyperref options (and metadata)
    pdflang={jp},
    pdftitle={はじめての LuaTeX-ja},
    pdfsubject={ちゃんとLuaTeX-jaで日本語が出るかな？},
    pdfauthor={Spiegel},
    pdfkeywords={LuaTeX-ja, PDF/A},
    pdfcopyright={Written by Spiegel on 2014,2017, and licensed under CC-BY.},
    pdflicenseurl={https://creativecommons.org/licenses/by/4.0/},
    pdfcontacturl={https://baldanders.info/},
    pdfcontactcity={Hiroshima},
    pdfcontactcountry={Japan},
    pdfcontactregion={JA},
    pdfcaptionwriter={Spiegel},
    baseurl={https://text.baldanders.info/remark/2015/luatex-ja/},
    draft=false,
    bookmarks=true,
    bookmarksnumbered=true,
    bookmarksopen=false,
    colorlinks=true,
    linkcolor=red,
    citecolor=green,
    filecolor=magenta,
    urlcolor=cyan
}

hyperxmp パッケージで追加されるパラメータは以下のとおり

pdfauthortitle
pdfcaptionwriter
pdfcontactaddress
pdfcontactcity
pdfcontactcountry
pdfcontactemail
pdfcontactphone
pdfcontactpostcode
pdfcontactregion
pdfcontacturl
pdfcopyright
pdflicenseurl
pdfmetalang （ない場合は pdflang を参照する）

どういうわけか hyperxmp パッケージを使ってもいわゆる「タグ入り PDF」として Adobe Reader で認識されない。 Evince では著作権情報は読み取れているみたい。

PDF property (Evince)

参考文献の管理

$\mathrm{bib\TeX}$, $\mathrm{bib\LaTeX}$ は $\mathrm{p\TeX}$, $\mathrm{up\TeX}$ で使っていたものを流用できる。ただし，入出力は UTF-8 になること。

\usepackage[backend=biber, style=numeric]{biblatex}
\addbibresource{refer.bib}

LuaLaTeX 用 .latexmkrc ファイルの準備

ぼくがかんがえたさいきょうの .latexmkrc ふぁいる

#!/usr/bin/env perl

# LaTeX commands
$pdflualatex         = 'lualatex %O -synctex=1 %S';
$latex               = 'uplatex %O -synctex=1 %S';
$latex_silent_switch = '-interaction=batchmode -c-style-errors';

# bibTeX commands
$bibtex    = 'upbibtex %O %B';
$biber     = 'biber %O --bblencoding=utf8 -u -U --output_safechars %B';
$makeindex = 'mendex %O -o %D %S';

# Device Driver
$dvipdf = 'dvipdfmx %O -z9 -V 7 -o %D %S';
$dvips  = 'dvips %O -z -f %S | convbkmk -u > %D';
$ps2pdf = 'ps2pdf14 -dPDFA -dPDFACompatibilityPolicy=1 -sProcessColorModel=DeviceCMYK %O %S %D';

# Typeset mode (generate a PDF)
$pdf_mode = 4; # 0: do not generate a pdf , 1: using $pdflatex , 2: using $ps2pdf , 3: using $dvipdf , 4: using $pdflualatex

# Other configuration
$pvc_view_file_via_temporary = 0;
$max_repeat = 5;
$clean_ext = "xmpdata";

最終形

pdfx パッケージを使った最終形のコードを組んでみた。

% XMPメタデータ
\RequirePackage{filecontents}
\begin{filecontents*}{\jobname.xmpdata}
  \Title{はじめてのLuaTeX-ja}
  \Author{Spiegel}
  \Language{ja-JP}
  \Keywords{LuaTeX-ja\sep PDF/A}
  \Subject{ちゃんとLuaTeX-jaで日本語が出るかな？}
  \Date{2020-06-08}
  \Copyright{Licensed under CC-BY}
  \CopyrightURL{https://creativecommons.org/licenses/by/4.0/}
\end{filecontents*}

\documentclass{ltjsarticle}
\usepackage[deluxe,nfssonly]{luatexja-preset} % TeX Live 2020 以降なら原の味フォントが既定
\renewcommand{\emph}[1]{\textsf{\textgt{#1}}} % 強調をゴシック体と Sans Serif に変更する

\usepackage[a-2u]{pdfx}   % PDF/A-2u を構成
\pdfvariable omitcidset=1 % LuaTeX で PDF/A-2 を作る際に必要

\title{\emph{はじめてのLua\TeX-ja}}
\author{Spiegel}
\date{2020-06-08}

\begin{document}

\maketitle

\section{はじめてのLua\TeX-ja}

ちゃんとLua\TeX-jaで日本語が出るかな？

\subsection{出たかな？}

長い文章を入力するとちゃんと右端のところで折り返されるかな？
大丈夫そうな気がするけど．ちょっと不安だけど何事も挑戦だよね．

\end{document}

ブックマーク

参考図書

[改訂第8版]LaTeX2ε美文書作成入門: 奥村晴彦 (著), 黒木裕介 (著); 技術評論社 2020-11-14; 大型本; 4297117126 (ASIN), 9784297117122 (EAN), 4297117126 (ISBN); 評価

2020年末に第8版が出てたのに気付かなかったよ。可能なら紙の本も買って常に側に置いておくのが吉。版元には PDF 版もある。

reviewed by Spiegel on 2021-09-05 (powered by PA-APIv5)

拙文「TeX Live 2020 で原ノ味フォントを使う」を参考にどうぞ。 ↩︎
源ノ明朝および源ノ角ゴシックの仕様例として「TeX 日本語環境で「源ノ」フォントを使ってみた」を参考にどうぞ。 ↩︎
$\mathrm{Lua\TeX}$ 0.95 以降では luatex.def ドライバが新設され，ドライバ依存のパッケージではこれを指定すればいいようになった。 ↩︎