gryf/pentadactyl-pm
1
0
Fork 0
mirror of https://github.com/gryf/pentadactyl-pm.git synced 2025-12-20 12:17:59 +01:00
Code Issues Projects Releases Wiki Activity

Use Files rather than strings in io.js where possible. Add some missing docs.

Browse Source
This commit is contained in:
Kris Maglione
2011-01-20 02:23:30 -05:00
parent 11f4ee5d58
commit 0ea2633593
4 changed files with 89 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
common/content/buffer.js
View File

@@ -1497,7 +1497,7 @@ var Buffer = Module("buffer", {
// if browser.download.useDownloadDir = false then the "Save As"
// dialog is used with this as the default directory
// TODO: if we're going to do this shouldn't it be done in setCWD or the value restored?
prefs.set("browser.download.lastDir", io.cwd);
prefs.set("browser.download.lastDir", io.cwd.path);
try {
var contentDisposition = content.QueryInterface(Ci.nsIInterfaceRequestor)

14
common/content/editor.js
View File

@@ -241,9 +241,21 @@ var Editor = Module("editor", {
return -1;
},
/**
* Edits the given file in the external editor as specified by the
* 'editor' option.
*
* @param {object|File|string} args An object specifying the file,
* line, and column to edit. If a non-object is specified, it is
* treated as the file parameter of the object.
* @param {boolean} blocking If true, this function does not return
* until the editor exits.
*/
editFileExternally: function (args, blocking) {
if (!isObject(args))
if (!isObject(args) || args instanceof File)
args = { file: args };
args.file = args.file.path || args.file;
let args = options.get("editor").format(args);
dactyl.assert(args.length >= 1, "No editor specified");

99
common/modules/io.jsm
View File

@@ -73,11 +73,9 @@ var IO = Module("io", {
* @returns {nsIFile[])
*/
getRuntimeDirectories: function getRuntimeDirectories(name) {
let dirs = modules.options["runtimepath"];
dirs = dirs.map(function (dir) File.joinPaths(dir, name, this.cwd), this)
.filter(function (dir) dir.exists() && dir.isDirectory() && dir.isReadable());
return dirs;
return modules.options.get("runtimepath").files
.map(function (dir) dir.child(name))
.filter(function (dir) dir.exists() && dir.isDirectory() && dir.isReadable());
},
// FIXME: multiple paths?
@@ -91,15 +89,15 @@ var IO = Module("io", {
* @param {boolean} all Whether all found files should be sourced.
*/
sourceFromRuntimePath: function sourceFromRuntimePath(paths, all) {
let dirs = modules.options["runtimepath"];
let dirs = modules.options.get("runtimepath").files;
let found = false;
dactyl.echomsg("Searching for " + paths.join(" ").quote() + " in " + modules.options.get("runtimepath").stringValue, 2);
outer:
for (let [, dir] in Iterator(dirs)) {
for (let [, path] in Iterator(paths)) {
let file = File.joinPaths(dir, path, this.cwd);
for (let dir in values(dirs)) {
for (let [,path] in Iterator(paths)) {
let file = dir.child(path);
dactyl.echomsg("Searching for " + file.path.quote(), 3);
@@ -206,9 +204,9 @@ var IO = Module("io", {
// NOTE: the directory could have been deleted underneath us so
// fallback to the process's CWD
if (dir.exists() && dir.isDirectory())
return dir.path;
return dir;
else
return this._processDir.path;
return this._processDir.clone();
},
/**
@@ -218,7 +216,7 @@ var IO = Module("io", {
* absolute path and is expanded by {@link #expandPath}.
*/
set cwd(newDir) {
newDir = newDir || "~";
newDir = newDir && newDir.path || newDir || "~";
if (newDir == "-") {
util.assert(this._oldcwd != null, "E186: No previous directory");
@@ -255,17 +253,17 @@ var IO = Module("io", {
/**
* Returns the first user RC file found in *dir*.
*
* @param {string} dir The directory to search.
* @param {File|string} dir The directory to search.
* @param {boolean} always When true, return a path whether
* the file exists or not.
* @default $HOME.
* @returns {nsIFile} The RC file or null if none is found.
*/
getRCFile: function (dir, always) {
dir = dir || "~";
dir = this.File(dir || "~");
let rcFile1 = File.joinPaths(dir, "." + config.name + "rc", this.cwd);
let rcFile2 = File.joinPaths(dir, "_" + config.name + "rc", this.cwd);
let rcFile1 = dir.child("." + config.name + "rc");
let rcFile2 = dir.child("_" + config.name + "rc");
if (util.OS.isWindows)
[rcFile1, rcFile2] = [rcFile2, rcFile1];
@@ -296,6 +294,13 @@ var IO = Module("io", {
return File(file);
},
/**
* Determines whether the given URL string resolves to a JAR URL and
* returns the matching nsIJARURI object if it does.
*
* @param {string} url The URL to check.
* @returns {nsIJARURI|null}
*/
isJarURL: function isJarURL(url) {
try {
let uri = util.newURI(url);
@@ -305,9 +310,16 @@ var IO = Module("io", {
return channel.URI.QueryInterface(Ci.nsIJARURI);
}
catch (e) {}
return false;
return null;
},
/**
* Returns a list of the contents of the given JAR file which are
* children of the given path.
*
* @param {nsIURI|string} file The URI of the JAR file to list.
* @param {string} path The prefix path to search.
*/
listJar: function listJar(file, path) {
file = util.getFile(file);
if (file) {
@@ -331,6 +343,17 @@ var IO = Module("io", {
return "";
},
/**
* Searches for the given executable file in the system executable
* file paths as specified by the PATH environment variable.
*
* On Windows, if the unadorned filename cannot be found, the
* extensions in the semicolon-separated list in the PATHSEP
* environment variable are successively appended to the original
* name and searched for in turn.
*
* @param {string} bin The name of the executable to find.
*/
pathSearch: function (bin) {
if (bin instanceof File || File.isAbsolutePath(bin))
return this.File(bin);
@@ -342,7 +365,8 @@ var IO = Module("io", {
for (let [, dir] in Iterator(dirs))
try {
dir = io.File(dir, true);
dir = this.File(dir, true);
let file = dir.child(bin);
if (file.exists())
return file;
@@ -365,7 +389,7 @@ var IO = Module("io", {
/**
* Runs an external program.
*
* @param {string} program The program to run.
* @param {File|string} program The program to run.
* @param {string[]} args An array of arguments to pass to *program*.
*/
run: function (program, args, blocking) {
@@ -432,11 +456,11 @@ var IO = Module("io", {
// TODO: implement 'shellredir'
if (util.OS.isWindows && !/sh/.test(shell.leafName)) {
command = "cd /D " + this.cwd + " && " + command + " > " + stdout.path + " 2>&1" + " < " + stdin.path;
command = "cd /D " + this.cwd.path + " && " + command + " > " + stdout.path + " 2>&1" + " < " + stdin.path;
var res = this.run(shell, shcf.split(/\s+/).concat(command), true);
}
else {
cmd.write("cd " + escape(this.cwd) + "\n" +
cmd.write("cd " + escape(this.cwd.path) + "\n" +
["exec", ">" + escape(stdout.path), "2>&1", "<" + escape(stdin.path),
escape(shell.path), shcf, escape(command)].join(" "));
res = this.run("/bin/sh", ["-e", cmd.path], true);
@@ -542,16 +566,16 @@ var IO = Module("io", {
// TODO: handle ../ and ./ paths
if (File.isAbsolutePath(arg)) {
io.cwd = arg;
dactyl.echomsg(io.cwd);
dactyl.echomsg(io.cwd.path);
}
else {
let dirs = modules.options["cdpath"];
for (let [, dir] in Iterator(dirs)) {
dir = File.joinPaths(dir, arg, io.cwd);
let dirs = modules.options.get("cdpath").files;
for (let dir in values(dirs)) {
dir = dir.child(arg);
if (dir.exists() && dir.isDirectory() && dir.isReadable()) {
io.cwd = dir.path;
dactyl.echomsg(io.cwd);
io.cwd = dir;
dactyl.echomsg(io.cwd.path);
return;
}
}
@@ -576,7 +600,7 @@ var IO = Module("io", {
commands.add(["pw[d]"],
"Print the current directory name",
function () { dactyl.echomsg(io.cwd); },
function () { dactyl.echomsg(io.cwd.path); },
{ argCount: "0" });
commands.add([config.name.replace(/(.)(.*)/, "mk$1[$2rc]")],
@@ -584,11 +608,10 @@ var IO = Module("io", {
function (args) {
dactyl.assert(args.length <= 1, "E172: Only one file name allowed");
let filename = args[0] || io.getRCFile(null, true).path;
let file = io.File(filename);
let file = io.File(args[0] || io.getRCFile(null, true));
dactyl.assert(!file.exists() || args.bang,
"E189: " + filename.quote() + " exists (add ! to override)");
"E189: " + file.path.quote() + " exists (add ! to override)");
// TODO: Use a set/specifiable list here:
let lines = [cmd.serialize().map(commands.commandToString, cmd) for (cmd in commands.iterator()) if (cmd.serialize)];
@@ -601,7 +624,7 @@ var IO = Module("io", {
file.write(lines.join("\n"));
}
catch (e) {
dactyl.echoerr("E190: Cannot open " + filename.quote() + " for writing");
dactyl.echoerr("E190: Cannot open " + file.path.quote() + " for writing");
dactyl.log("Could not write to " + file.path + ": " + e.message); // XXX
}
}, {
@@ -1000,11 +1023,19 @@ unlet s:cpo_save
options.add(["cdpath", "cd"],
"List of directories searched when executing :cd",
"stringlist", ["."].concat(services.environment.get("CDPATH").split(/[:;]/).filter(util.identity)).join(","),
{ setter: function (value) File.expandPathList(value) });
{
get files() this.value.map(function (path) File(path, modules.io.cwd))
.filter(function (dir) dir.exists()),
setter: function (value) File.expandPathList(value)
});
options.add(["runtimepath", "rtp"],
"List of directories searched for runtime files",
"stringlist", IO.runtimePath);
"stringlist", IO.runtimePath,
{
get files() this.value.map(function (path) File(path, modules.io.cwd))
.filter(function (dir) dir.exists())
});
options.add(["shell", "sh"],
"Shell to use for executing external commands with :! and :run",

14
common/modules/storage.jsm
View File

@@ -296,13 +296,13 @@ var File = Class("File", {
let expandedPath = File.expandPath(path);
if (!File.isAbsolutePath(expandedPath) && checkPWD)
file = File.joinPaths(checkPWD, expandedPath);
file = checkPWD.child(expandedPath);
else
file.initWithPath(expandedPath);
}
catch (e) {
util.reportError(e);
return File.DoesNotExist(e);
return File.DoesNotExist(path, e);
}
}
let self = XPCSafeJSObjectWrapper(file);
@@ -327,10 +327,15 @@ var File = Class("File", {
*/
child: function (name) {
let f = this.constructor(this);
f.append(name);
f.QueryInterface(Ci.nsILocalFile).appendRelativePath(name);
return f;
},
/**
* Returns a clone of this file.
*/
clone: function () File(this),
/**
* Reads this file's entire contents in "text" mode and returns the
* content as a string.
@@ -503,7 +508,8 @@ var File = Class("File", {
return f.path.substr(f.parent.path.length, 1);
}),
DoesNotExist: function (error) ({
DoesNotExist: function (path, error) ({
path: path,
exists: function () false,
__noSuchMethod__: function () { throw error || Error("Does not exist"); }
}),