Lua中如何使用 require 设置调用文件的环境?

是否有一种方法在Lua文件中调用require,并使调用它的文件的环境被设置?例如,如果我有一个定义在表中的领域特定语言(DSL)定义函数Root和Sequence,我可以在允许我像全局变量那样访问这些函数的模块中使用something like setfenv(1,dslEnv)吗?

我想要实现的目标是将此用作行为树DSL的一种方式,使我的定义文件看起来像这样(或尽可能接近):

require "behaviortrees"

return Root {
    Sequence {
        Leaf "leafname",
        Leaf "leafname"
    }
}

而不必明确地将Root,Sequence和Leaf带入范围,也不必限定名称,例如behaviortrees.Sequence。

简而言之,我正在试图使定义文件尽可能清洁,没有任何多余的行在树定义中阻碍。

点赞
用户88888888
用户88888888

在 Lua 5.2 中,_ENV 是一个本地变量,确定环境表。你可以改变任何函数的环境,基本上是代码块。

_ENV = behaviortrees;

另一种方法是自动复制每一个字段:

do
    _ENV = _ENV or _G;

    for k, v in next, behaviortrees do
        _ENV[k] = v;
    end
end

然而,手动本地化来自 behaviortrees 的每个字段可能更有效率。

2017-07-31 23:43:26
用户6834680
用户6834680

Module "behaviortrees.lua"

local behaviortrees = {
   -- 插入您的这些函数的代码
   Root     = function(...) ... end,
   Sequence = function(...) ... end,
   Leaf     = function(...) ... end,
}

-- 现在设置调用者的环境。 有两种方法可供选择:

-- 如果您希望使DSL环境与Lua全局变量隔离
-- (例如,在执行require“behaviortrees”后,将不会使用“require”和“print”函数)
setfenv(3, behaviortrees)
-- 或者
-- 如果您想保留所有全局变量以供DSL使用
setfenv(3, setmetatable(behaviortrees, {__index = getfenv(3)}))

主Lua程序:

require "behaviortrees"

return Root {
   Sequence {
      Leaf "leafname",
      Leaf "leafname"
   }
}
2017-08-01 06:50:08
用户3677376
用户3677376

我可以在模块中像 setfenv(1, dslEnv) 那样得到像全局变量那样访问那些函数的方法吗?

当然可以。你只需要找到正确的堆栈级别,而不是在 setfenv 中使用的 1。通常,您可以使用循环和 debug.getinfo 调用沿着堆栈上走,直到找到堆栈中的 require 函数,然后再移动一些,直到找到下一个主要块(以防某人在函数中调用 require)。这就是您必须使用 setfenv 的堆栈级别。但是我可以建议一个...

不同的方法

在 Lua 中,“require”是可插拔的。您可以将一个函数(称为搜索器)添加到 package.loaders 数组中,并在 require 尝试加载模块时调用它。假设您的所有 DSL 文件都具有 .bt 后缀而不是通常的 .lua。然后您将使用重新实现了普通 Lua 搜索器的不同之处,您将查找 .bt 文件而不是 .lua 文件,并且您将在由 loadfile 返回的函数 return 中调用 setfenv。像这样:

local function Root( x ) return x end
local function Sequence( x ) return x end
local function Leaf( x ) return x end

local delim = package.config:match( "^(.-)\n" ):gsub( "%%", "%%%%" )

local function searchpath( name, path )
  local pname = name:gsub( "%.", delim ):gsub( "%%", "%%%%" )
  local msg = {}
  for subpath in path:gmatch( "[^;]+" ) do
    local fpath = subpath:gsub( "%?", pname ):gsub("%.lua$", ".bt") -- replace suffix
    local f = io.open( fpath, "r" )
    if f then
      f:close()
      return fpath
    end
    msg[ #msg+1 ] = "\n\tno file '"..fpath.."'"
  end
  return nil, table.concat( msg )
end

local function bt_searcher( modname )
  assert( type( modname ) == "string" )
  local filename, msg = searchpath( modname, package.path )
  if not filename then
    return msg
  end
  local env = { -- create custom environment
    Root = Root,
    Sequence = Sequence,
    Leaf = Leaf,
  }
  local mod, msg = loadfile( filename )
  if not mod then
    error( "error loading module '"..modname.."' from file '"..filename..
           "':\n\t"..msg, 0 )
  end
  setfenv( mod, env ) -- set custom environment
  return mod, filename
end

table.insert( package.loaders, bt_searcher )

如果您将此放在一个模块中并从主程序中的 require 一次加载它,然后您可以使用自定义环境从 .bt 文件中 require 您的 DSL 文件,其位置与您放置您的 .lua 文件相同。您甚至不需要在 DSL 文件中使用 require("behaviortrees")。例如:

文件 xxx.bt:

return Root {
  Sequence {
    Leaf "leafname",
    Leaf "leafname"
  }
}

文件 main.lua:

#!/usr/bin/lua5.1
require( "behaviortrees" ) -- loads the Lua module above and adds to package.loaders
print( require( "xxx" ) ) -- loads xxx.bt (but an xxx Lua module would still take precedence)
2017-08-01 06:55:19