1 // Expose SGPath module to Nasal
3 // Copyright (C) 2013 The FlightGear Community
5 // This program is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU General Public License as
7 // published by the Free Software Foundation; either version 2 of the
8 // License, or (at your option) any later version.
10 // This program is distributed in the hope that it will be useful, but
11 // WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with this program; if not, write to the Free Software
17 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 #include "NasalSGPath.hxx"
24 #include <Main/globals.hxx>
25 #include <Main/util.hxx>
26 #include <simgear/misc/sg_path.hxx>
28 #include <simgear/nasal/cppbind/from_nasal.hxx>
29 #include <simgear/nasal/cppbind/to_nasal.hxx>
30 #include <simgear/nasal/cppbind/NasalHash.hxx>
31 #include <simgear/nasal/cppbind/Ghost.hxx>
34 typedef boost::shared_ptr<SGPath> SGPathRef;
35 typedef nasal::Ghost<SGPathRef> NasalSGPath;
37 SGPath::Permissions checkIORules(const SGPath& path)
39 SGPath::Permissions perm;
41 perm.read = !fgValidatePath(path.str(), false).empty();
42 perm.write = !fgValidatePath(path.str(), true ).empty();
47 // TODO make exposing such function easier...
51 static naRef f_new_path(const nasal::CallContext& ctx)
55 SGPathRef(new SGPath(ctx.getArg<std::string>(0), &checkIORules))
62 static naRef f_desktop(const nasal::CallContext& ctx)
66 SGPathRef(new SGPath(SGPath::desktop(SGPath(&checkIORules))))
70 //------------------------------------------------------------------------------
71 naRef initNasalSGPath(naRef globals, naContext c)
73 // This wraps most of the SGPath APIs for use by Nasal
74 // See: http://docs.freeflightsim.org/simgear/classSGPath.html
76 NasalSGPath::init("os.path")
77 .method("set", &SGPath::set)
78 .method("append", &SGPath::append)
79 .method("add", &SGPath::add)
80 .method("concat", &SGPath::concat)
82 .member("realpath", &SGPath::realpath)
83 .member("file", &SGPath::file)
84 .member("dir", &SGPath::dir)
85 .member("base", &SGPath::base)
86 .member("file_base", &SGPath::file_base)
87 .member("extension", &SGPath::extension)
88 .member("lower_extension", &SGPath::lower_extension)
89 .member("complete_lower_extension", &SGPath::complete_lower_extension)
90 .member("str", &SGPath::str)
91 .member("str_native", &SGPath::str_native)
92 .member("mtime", &SGPath::modTime)
94 .method("exists", &SGPath::exists)
95 .method("canRead", &SGPath::canRead)
96 .method("canWrite", &SGPath::canWrite)
97 .method("isFile", &SGPath::isFile)
98 .method("isDir", &SGPath::isDir)
99 .method("isRelative", &SGPath::isRelative)
100 .method("isAbsolute", &SGPath::isAbsolute)
101 .method("isNull", &SGPath::isNull)
103 .method("create_dir", &SGPath::create_dir)
104 .method("remove", &SGPath::remove)
105 .method("rename", &SGPath::rename);
107 nasal::Hash globals_module(globals, c),
108 path = globals_module.createHash("os")
111 path.set("new", f_new_path);
112 path.set("desktop", &f_desktop);