imported>Fire at 04:24, 27 January 2021

2021-01-27T04:24:50Z

New page

<includeonly>{{二次利用|ja}}
{{used in system}}

このModuleはブール値、またはブール値風の文字列の入力を処理するための統一したインターフェースを提供します。Luaでは<code>true</code>と<code>false</code>といったブール値がありますが、ウィキテキストにおけるテンプレートでは"yes"、"no"など文字列でしか処理できません。このModuleはこれらの文字列を処理して、Luaで使用するためのブール値に変換します。また、<code>nil</code>と<code>false</code>を区別できるよう、<code>nil</code>の入力は<code>nil</code>として返します。このModuleはブール値、数字、テーブル、関数の入力も受け付けており、ブール値と<code>nil</code>として認識できなかった場合の返り値を指定することもできます。

== 書式 ==
<syntaxhighlight lang="lua">yesno(value, default)</syntaxhighlight>
<code>value</code>は処理される入力です。ブール値またはブール値風の文字列が入力された場合は<code>true</code>または<code>false</code>を返し、<code>nil</code>が入力された場合は<code>nil</code>を返し、それ以外の場合は<code>default</code>を返します。

== 使用法 ==
まず、Moduleをロードします。なお、このModuleはほかのLuaModuleでしか使用できません。テンプレートから使う場合は代わりに{{tl|yesno}}を使用してください。

<syntaxhighlight lang="lua">
local yesno = require('Module:Yesno')
</syntaxhighlight>

一部の入力値は必ず<code>true</code>を返し、一部は必ず<code>false</code>を返します。<code>nil</code>値は必ず<code>nil</code>を返します。

<syntaxhighlight lang="lua">
-- 必ずtrueを返す
yesno('yes')
yesno('y')
yesno('true')
yesno('t')
yesno('1')
yesno(1)
yesno(true)

-- 必ずfalseを返す
yesno('no')
yesno('n')
yesno('false')
yesno('f')
yesno('0')
yesno(0)
yesno(false)

-- nil値は必ずnil値を返す
yesno(nil)
</syntaxhighlight>

文字列はまず小文字に変換してから判別しています。

<syntaxhighlight lang="lua">
-- 必ずtrueを返す
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')

-- 必ずfalseを返す
yesno('No')
yesno('NO')
yesno('nO')
yesno('N')
yesno('fALsE')
</syntaxhighlight>

上記以外の入力の場合に返すdefault値を指定できます。指定しなかった場合は<code>nil</code>を返します。

<syntaxhighlight lang="lua">
-- nilを返す
yesno('foo')
yesno({})
yesno(5)
yesno(function() return 'This is a function.' end)

-- trueを返す
yesno('foo', true)
yesno({}, true)
yesno(5, true)
yesno(function() return 'This is a function.' end, true)

-- "bar"を返す
yesno('foo', 'bar')
yesno({}, 'bar')
yesno(5, 'bar')
yesno(function() return 'This is a function.' end, 'bar')
</syntaxhighlight>

空文字列でも同じ扱いです。
<syntaxhighlight lang="lua">
yesno('') -- nilを返す
yesno('', true) -- trueを返す
yesno('', 'bar') -- "bar"を返す
</syntaxhighlight>

ウィキテキストでは一般的には空文字列をfalseとして扱うが、Luaではtrueとして扱われます。本ModuleではLuaでの挙動を採用しているため、空文字列をfalseとして扱う必要がある場合は別に処理してください。

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
[[Category:Module]]

}}</includeonly>

Module:Yesno/doc - Revision history

imported>Fire at 04:24, 27 January 2021