xref: /freebsd/contrib/kyua/utils/fs/lua_module.hpp (revision f7c32ed617858bcd22f8d1b03199099d50125721)
1 // Copyright 2011 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file utils/fs/lua_module.hpp
30 /// Lua bindings for the utils::fs module.
31 ///
32 /// When the fs module is bound to Lua, the module has the concept of a "start
33 /// directory".  The start directory is the directory used to qualify all
34 /// relative paths, and is provided at module binding time.
35 
36 #if !defined(UTILS_FS_LUA_MODULE_HPP)
37 #define UTILS_FS_LUA_MODULE_HPP
38 
39 #include <lutok/state.hpp>
40 
41 #include "utils/fs/path.hpp"
42 
43 namespace utils {
44 namespace fs {
45 
46 
47 void open_fs(lutok::state&);
48 void open_fs(lutok::state&, const fs::path&);
49 
50 
51 }  // namespace fs
52 }  // namespace utils
53 
54 #endif  // !defined(UTILS_FS_LUA_MODULE_HPP)
55