Created

Embed URL

HTTPS clone URL

SSH clone URL

You can clone with HTTPS or SSH.

Download Gist

CommonJS module for Jetpack for choosing and loading strings in an external editor.

View ext-editor.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
/**
* Module for using an external editor.
*
* Example where the user will be prompted for the path
* to their editor of choice. The callback is passed the
* entirety of the changed contents, whenever a change is
* detected.
*
* const extEditor = require("ext-editor");
*
* let editor = new extEditor.Editor();
*
* editor.launch("foo\nbar\nbaz\n", function(changedText) {
* console.log(changedText);
* });
*
* You can get the editor path as a string, after the user has chosen one:
*
* console.log(editor.editorPath);
*
* You can pass the editor path to the Editor constructor, so that
* applications can cache it, and the user is only prompted the
* initial time.
*
* let editor = new extEditor.Editor(stringPathToEditor);
*
*/
 
const { Ci, Cc, Cu } = require("chrome");
Cu.import("resource://gre/modules/Services.jsm", this);
 
function Editor(editorPath) {
this.editorPath = editorPath;
}
Editor.prototype = {
// string path to editor
editorPath: "",
 
// function callback to pass contents of file to when modified
onChangeHandler: null,
 
// interval to check temp file for modifications
watchFileInterval: 500,
 
// temp file (nsIFile)
_tempFile: null,
 
// last modified time
_lastModifiedTime: null,
 
// prompts user to select the editor application
// returns string path to editor, for caller to
// persist for later use.
choose: function choose() {
var fp = Cc["@mozilla.org/filepicker;1"].createInstance(Ci.nsIFilePicker);
fp.init(require("window-utils").activeWindow,
"Choose an editor...", Ci.nsIFilePicker.modeOpen);
fp.appendFilters(Ci.nsIFilePicker.filterAll | Ci.nsIFilePicker.filterText);
var rv = fp.show();
if (rv == Ci.nsIFilePicker.returnOK || rv == Ci.nsIFilePicker.returnReplace) {
this.editorPath = fp.file.path;
}
return null;
},
 
launch: function launch(value, onChangeHandler) {
if (!this.editorPath)
this.choose();
if (!this.editorPath)
throw new Error("Editor: editor path undefined");
if (!onChangeHandler)
throw new Error("Editor: no change handler callback passed to launch()");
 
this.onChangeHandler = onChangeHandler;
 
this._tempFile = this._openStringInEditor(value);
if (!this._tempFile || !this._tempFile.exists()) {
throw new Error("Editor unable to create temp file");
}
this._lastModifiedTime = this._tempFile.lastModifiedTime;
let self = this;
require("timer").setTimeout(function() self._watchFile(), this.watchFileInterval);
},
 
// opens the editor with the given string content.
// returns the nsIFile handle to the temp file.
// deletes the temp file when the external app exits.
_openStringInEditor: function _openStringInEditor(value) {
// For the mac, wrap with a call to "open".
var isOSX = Ci.nsIMacDockSupport && this.editorPath.slice(-4) === ".app";
var executable = (Cc["@mozilla.org/file/local;1"]
.createInstance(Ci.nsILocalFile));
executable.followLinks = true;
executable.initWithPath(isOSX ? "/usr/bin/open" : this.editorPath);
if (executable.exists()) {
let file = Services.dirsvc.get("TmpD", Ci.nsIFile);
file.append("jetpack.editor.tmp");
file.createUnique(Ci.nsIFile.NORMAL_FILE_TYPE, 0666);
 
let foStream = (Cc["@mozilla.org/network/file-output-stream;1"]
.createInstance(Ci.nsIFileOutputStream));
 
// use 0x02 | 0x10 to open file for appending.
foStream.init(file, 0x02 | 0x08 | 0x20, 0666, 0);
// write, create, truncate
// In a c file operation, we have no need to set file mode with or operation,
// directly using "r" or "w" usually.
foStream.write(value, value.length);
foStream.close();
try {
let process = (Cc["@mozilla.org/process/util;1"]
.createInstance(Ci.nsIProcess));
process.init(executable);
let args = [];
if (isOSX) args.push("-a", editor, file.path);
else args[0] = file.path;
let ret = process.run(false, args, args.length);
} catch (e) {
Cu.reportError(e);
throw new Error("Error running editor : " + e);
return null;
}
Cc["@mozilla.org/uriloader/external-helper-app-service;1"].
getService(Ci.nsPIExternalAppLauncher).
deleteTemporaryFileOnExit(file);
return file;
}
throw new Error(editor + " is not an executable");
},
 
// returns the contents of a file path as a string
_readFile: function _readFile(file) {
var fstream = (Cc["@mozilla.org/network/file-input-stream;1"]
.createInstance(Ci.nsIFileInputStream));
var sstream = (Cc["@mozilla.org/scriptableinputstream;1"]
.createInstance(Ci.nsIScriptableInputStream));
fstream.init(file, -1, 0, 0);
sstream.init(fstream);
 
var value = "";
var str = sstream.read(4096);
while (str) {
value += str;
str = sstream.read(4096);
}
 
sstream.close();
fstream.close();
return value;
},
 
// watches a file for modifications
_watchFile: function _watchFile() {
if (!this._tempFile || !this._tempFile.exists()) {
throw new Error("Editor: temp file was deleted or moved.");
return;
}
var time = this._tempFile.lastModifiedTime;
if (time > this._lastModifiedTime) {
this.onChangeHandler(this._readFile(this._tempFile));
this._lastModifiedTime = time;
}
let self = this;
require("timer").setTimeout(function() self._watchFile(), this.watchFileInterval);
}
}
 
exports.Editor = Editor;

hey,

which license do you use for this piece of code ?

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.