Hi fellow wiki editors!

To help newly registered users get more familiar with the wiki (and maybe older users too) there is now a {{Welcome to the wiki}} template. Have a look at it and feel free to add it to new users discussion pages (and perhaps your own).

I have tried to keep the template short, but meaningful. /Johan G

Difference between revisions of "Nasal library/os.path"

From FlightGear wiki
Jump to: navigation, search
(Doc append())
(Class: Doc concat())
Line 19: Line 19:
 
|param1 = path
 
|param1 = path
 
|param1text = Optional string specifying the filepath. If not given, the path will default to [[$FG_ROOT]]
 
|param1text = Optional string specifying the filepath. If not given, the path will default to [[$FG_ROOT]]
|example1 = var path = os.path.new();
+
|example1 = var path = os.path.new("C:/Windows"); # Windows filepath
print(path.realpath); # will print $FGROOT
+
|example2 = var path = os.path.new("C:/Windows"); # Windows filepath
+
 
# var path = os.path.new("/usr/bin/"); # Unix filepath
 
# var path = os.path.new("/usr/bin/"); # Unix filepath
 
print(path.realpath);
 
print(path.realpath);
Line 33: Line 31:
 
|param1text = Optional string specifying the filepath. If not given, the path will be set to [[$FG_ROOT]]
 
|param1text = Optional string specifying the filepath. If not given, the path will be set to [[$FG_ROOT]]
 
|example1 = var path = os.path.new("C:/Windows");
 
|example1 = var path = os.path.new("C:/Windows");
# var path = os.path.new("/usr/bin/"); # alternative Unix filepath
 
print(path.realpath);
 
path.set();
 
print(path.realpath); # will print $FG_ROOT
 
|example2 = var path = os.path.new("C:/Windows");
 
 
# var path = os.path.new("/usr/bin/"); # alternative Unix filepath
 
# var path = os.path.new("/usr/bin/"); # alternative Unix filepath
 
print(path.realpath);
 
print(path.realpath);
Line 50: Line 43:
 
|text = Appends a new part to the filepath.
 
|text = Appends a new part to the filepath.
 
|param1 = path
 
|param1 = path
|param1text = Optional string specifying the filepath. If not given, the resultant path will not change.
+
|param1text = Optional string specifying the new part to add to the filepath. If not given, the resultant path will not change.
 
|example1 = var path = os.path.new("C:/Windows");
 
|example1 = var path = os.path.new("C:/Windows");
# var path = os.path.new("/usr/"); # alternative Unix filepath
 
print(path.realpath);
 
path.append();
 
print(path.realpath); # the path will not change
 
|example2 = var path = os.path.new("C:/Windows");
 
 
# var path = os.path.new("/usr/"); # alternative Unix filepath
 
# var path = os.path.new("/usr/"); # alternative Unix filepath
 
print(path.realpath);
 
print(path.realpath);
 
path.append("Program Files");
 
path.append("Program Files");
# path.set("bin"); # alternative Unix filepath
+
# path.append("bin"); # alternative Unix filepath
 
print(path.realpath); # prints "C:/Windows/Program Files" or "/usr/bin"
 
print(path.realpath); # prints "C:/Windows/Program Files" or "/usr/bin"
 
}}
 
}}
  
 
==== concat() ====
 
==== concat() ====
 +
{{Nasal doc
 +
|syntax = os.path.concat([path]);
 +
|text = Appends a new part to the filepath.
 +
|param1 = path
 +
|param1text = Optional string specifying part to concat to the existing filepath. Note that this will simply add the string to the end of the path without adding a separator. If not given, the resultant path will not change.
 +
|example1 = var path = os.path.new("C:/Windows");
 +
# var path = os.path.new("/usr"); # alternative Unix filepath
 +
print(path.realpath);
 +
path.concat("/Program Files");
 +
# path.concat("/bin"); # alternative Unix filepath
 +
print(path.realpath); # prints "C:/Windows/Program Files" or "/usr/bin"
 +
}}
 +
 
==== exists() ====
 
==== exists() ====
 
==== canRead() ====
 
==== canRead() ====

Revision as of 17:13, 17 February 2018

This page contains documentation for the os.path namespace in Nasal. This namespace implements tools (from SGPath) for manipulating file paths. Everything in the geo namespace is sourced from flightgear/src/Scripting/NasalSGPath.cxx

Tip  Copy & paste the examples into your Nasal Console and execute them to see what they do.
Note  Everything here was added to FlightGear 3.0.

Class

os.path

A pseudo-class (actually a Nasal ghost). This is the main class that stores and allows manipulation of file paths. This is also integrated into the os.path.


new()

os.path.new([path]);

Constructor function. Returns a new os.path instance. Note that the path must not violate the rules for allowed paths.

path
Optional string specifying the filepath. If not given, the path will default to $FG_ROOT

Example

var path = os.path.new("C:/Windows"); # Windows filepath
# var path = os.path.new("/usr/bin/"); # Unix filepath
print(path.realpath);

set()

os.path.set([path]);

Sets the filepath. Note that the path must not violate the rules for allowed paths.

path
Optional string specifying the filepath. If not given, the path will be set to $FG_ROOT

Example

var path = os.path.new("C:/Windows");
# var path = os.path.new("/usr/bin/"); # alternative Unix filepath
print(path.realpath);
path.set("C:/Windows/Program Files");
# path.set("/usr/"); # alternative Unix filepath
print(path.realpath); # prints new path

append()

os.path.append([path]);

Appends a new part to the filepath.

path
Optional string specifying the new part to add to the filepath. If not given, the resultant path will not change.

Example

var path = os.path.new("C:/Windows");
# var path = os.path.new("/usr/"); # alternative Unix filepath
print(path.realpath);
path.append("Program Files");
# path.append("bin"); # alternative Unix filepath
print(path.realpath); # prints "C:/Windows/Program Files" or "/usr/bin"

concat()

os.path.concat([path]);

Appends a new part to the filepath.

path
Optional string specifying part to concat to the existing filepath. Note that this will simply add the string to the end of the path without adding a separator. If not given, the resultant path will not change.

Example

var path = os.path.new("C:/Windows");
# var path = os.path.new("/usr"); # alternative Unix filepath
print(path.realpath);
path.concat("/Program Files");
# path.concat("/bin"); # alternative Unix filepath
print(path.realpath); # prints "C:/Windows/Program Files" or "/usr/bin"

exists()

canRead()

canWrite()

isFile()

isDir()

isRelative()

isAbsolute()

isNull()

create_dir()

remove()

rename()

realpath

file

dir

base

file_base

extension

lower_extension

complete_lower_extension

str

mtime

Functions

desktop()

standardLocation()