6 | assert(m>0); 7 | assert(n>=0 && n<100, "passed bad n"); 8 |
13 | Interp.conf({nDebug:true});
14 |
5 | var me = 'Me', cnt = 9;
6 | format('Help %s = %d!', me, cnt);
7 |
12 | format('Help '+me+' = '+cnt+'!');
13 |
20 | format('Help %-20s = %d!', me, cnt);
21 |
5 | var x = 1;
6 | include('dir/foo.js');
7 | foo(x);
8 |
9 |
10 | During the evaluation of the include, the current include directory is temporarily changed to that
11 | of the include files path. The include file may also include other files, up to a
12 | maximum of 100 (configurable).
13 |
14 | Include may also be given an array of files, as in:
15 |
16 | 17 | include(['foo.js','bar.js']); 18 |
13 | #define JSI_LITE_ONLY
14 | #include "jsi.c"
15 | int main() {
16 | Jsi_DString dStr = {"Hello World"};
17 | Jsi_Hash* hPtr = Jsi_HashNew(NULL,0);
18 | }
19 | iSqlite
13 | 14 |Ledger
15 | 16 | 17 | -------------------------------------------------------------------------------- /tests/string.js: -------------------------------------------------------------------------------- 1 | /* 2 | =!EXPECTSTART!= 3 | the original string 4 | the original string 5 | he original string 6 | g 7 | 8 | tri 9 | 10 | a 11 | 4 12 | -1 13 | 6 14 | 16 15 | A 16 | d 17 | 2 18 | 6 19 | =!EXPECTEND!= 20 | */ 21 | 22 | var a = "the original string"; 23 | 24 | puts(a.substr()); 25 | puts(a.substr(false)); 26 | puts(a.substr(1)); 27 | puts(a.substr(-1, 1)); 28 | 29 | puts(a.substr(2, -1)); 30 | puts(a.substr(-5, 3)); 31 | puts(a.substr(100, 0)); 32 | puts(a.substr(10, 1)); 33 | 34 | puts(a.indexOf("ori")); 35 | puts(a.indexOf("swer")); 36 | puts(a.indexOf("i")); 37 | puts(a.indexOf("i", 9)); 38 | puts(String.fromCharCode(65)); 39 | var s = 'abcdabcd'; 40 | puts(s.charAt(3)); 41 | puts(s.indexOf('cd')); 42 | puts(s.lastIndexOf('cd')); 43 | 44 | -------------------------------------------------------------------------------- /www/c-hash.wiki: -------------------------------------------------------------------------------- 1 |
8 | int isNew;
9 | Jsi_Hash *tbl = Jsi_HashNew(interp, JSI_KEYS_STRING, NULL);
10 | hPtr = Jsi_HashEntryCreate(tbl, "foo", &isNew);
11 | Jsi_HashEntrySet(hPtr, 99);
12 | Jsi_HashSet(tbl, "bar", 100);
13 | Jsi_HashSearch search;
14 | for (hPtr = Jsi_HashEntryFirst(tbl, &search);
15 | hPtr != NULL; hPtr = Jsi_HashEntryNext(&search)) {
16 | key = Jsi_HashKeyGet(hPtr);
17 | int n = Jsi_HashValueGet(hPtr);
18 | }
19 |
8 | static Jsi_CmdSpec dateCmds[] = {
9 | { "now", DateNowCmd, NULL, 0, 1, "?flags?", .help="Return current time in ms since unix epoch (1970)" },
10 | { "format", DateFormatCmd, NULL, 1, 3, "num,?format,flags?", .help="Format time" },
11 | { "parse", DateParseCmd, NULL, 1, 2, "string,?flags?", .help="Parse time string and return time in ms since 1970" },
12 | { NULL, NULL, }
13 | };
14 |
15 | Jsi_SetupCmdSpecs(interp, "Date", dateCmds, NULL, JSI_CMDSPEC_NOTOBJ);
16 | | Method | Description |
|---|---|
| alarm(secs) | Setup alarm in seconds |
| callback(func,sig) | Setup callback handler for signal |
| default(?sig,sig,...?) | Set named signals to default action |
| handle(?sig,sig,...?) | Set named signals to handle action |
| ignore(?sig,sig,...?) | Set named signals to ignore action |
| kill(pid?,sig?) | Send signal to process id (default SIGTERM) |
| names() | Return names of all signals |
'+s+'
\n');}; 6 | hdrs('Main'); 7 | ?> 8 | Welcome to the Jsi sample web application. 9 | 10 | What are some reasons for using Jsi: 11 |-
12 | '+xx[i]+'');
16 | ?>
17 |
5 |
console.log(str)
6 | 7 | The console.log method simply outputs a string to stderr. 8 | 9 |10 |
puts(str)
11 | 12 | The puts method outputs a string to stdout. 13 | With 1 or 0 arguments a newline is appended. 14 | 15 |
16 | puts("Hello World");
17 | puts("Hello"," World\n");
18 | 23 | if (puts === undefined) 24 | var puts = console.log.bind(console); 25 |
28 |
console.input()
29 | 30 | User input can be obtained using console.input(): 31 | 32 |
33 | puts("Enter your name: ", "");
34 | var str = console.input();
35 | 38 |
console.args
39 | 40 | Program arguments are available using console.args: 41 | 42 |
43 | for (var i in console.args) {
44 | puts(console.args[i]);
45 | }
46 | Geany
4 | 5 | [http://www.geany.org|Geany] is a convenient editor to use with Jsish. 6 | To enable file completion in Geany, copy tools/geany/filetypes.javascript to 7 | ~/.config/geany/filedefs/. Then edit /usr/share/geany/filetype_extensions.conf and 8 | add "*.jsi" to Javascript. 9 | Finally, keep the file tools/protos.jsi open in the editor so Geany knows 10 | how to complete Jsi functions. 11 | 12 | Geany can be setup to navigate 13 | through Jsi's gcc style scripting errors: 14 | 15 | * Start by editing any file ending in the suffix .jsi. 16 | * From the Geany Build menu, select Set Build Commands. 17 | * Click on the first blank label in Javascript and enter Jsish. 18 | * In the command section enter the pathspec to jsish, eg. $HOME/bin/jsish %f 19 | * Click Ok 20 | 21 | Now hit F8 to run the script. Upon errors, you should be able to navigate to the 22 | highlighted lines, and see warnings in the bottom pane. 23 | 24 | 25 |Vim
26 | Here is how to setup vim: 27 | 28 |29 | :set makeprg=jsish\ % 30 | :copen 31 |
36 | :make 37 |
4 | 5 | Jsi: Embeddable Javascript 6 | 7 |
8 | [http://pdqi.com/jsi|Jsi] is a small javascript interpreter implemented in C that 9 | provides built-in support for [./js-sqlite.wiki|Sqlite], [./js-websocket.wiki|WebSockets], 10 | [./js-json.wiki|JSON] and a [./js-zvfs.wiki|Zip filesystem]. 11 | It is used for creating [./zeroinstall.wiki|standalone] desktop web-database applications 12 | or for embedding in other applications. 13 | 14 | * [./getstarted.wiki|Jsi In 5 Minutes or Less] 15 | * [./reference.wiki|Language Reference] 16 | * [./jsindex.wiki|Topic Index] 17 | 18 |Example Applications
19 | 20 | The Jsi distribution comes with several demo applications designed to 21 | showcase it's power and functionality: 22 | 23 | * [app/sqliteui.wiki|SqliteUI]: a user interface to Sqlite. 24 | * [app/ledgerjs.wiki|LedgerJS]: an accounting program. 25 | 26 |Rationale
27 | 28 | For desktop web-application development, there many alternatives 29 | but none of these 30 | deliver the range of functionality in Jsi, with anything approching it's small form-factor. 31 | 32 | For a description of the rationale 33 | behind Jsi, including comparisons against alternatives such as 34 | NodeJs, Lua, Tcl and LAMP (Linux/Apache/MySql/PHP), 35 | [./rationale.wiki|click here]. 36 | 37 | -------------------------------------------------------------------------------- /jsiBool.c: -------------------------------------------------------------------------------- 1 | #ifndef JSI_LITE_ONLY 2 | #ifndef JSI_AMALGAMATION 3 | #include "jsiInt.h" 4 | #endif 5 | 6 | static int BooleanConstructor(Jsi_Interp *interp, Jsi_Value *args, Jsi_Value *_this, 7 | Jsi_Value **ret, Jsi_Func *funcPtr) 8 | { 9 | if (Jsi_FunctionIsConstructor(funcPtr)) { 10 | int nv = 0; 11 | if (Jsi_ValueGetLength(interp, args) > 0) { 12 | Jsi_Value *v = Jsi_ValueArrayIndex(interp, args, 0); 13 | if (v) { 14 | nv = Jsi_ValueIsTrue(interp, v); 15 | } 16 | } 17 | _this->d.obj->ot = JSI_OT_BOOL; 18 | _this->d.obj->d.val = nv; 19 | return JSI_OK; 20 | } 21 | if (Jsi_ValueGetLength(interp, args) > 0) { 22 | Jsi_Value *v = Jsi_ValueArrayIndex(interp, args, 0); 23 | if (v) { 24 | Jsi_ValueMakeBool(interp, *ret, Jsi_ValueIsTrue(interp, v)); 25 | return JSI_OK; 26 | } 27 | } 28 | Jsi_ValueMakeBool(interp, *ret, 0); 29 | return JSI_OK; 30 | } 31 | 32 | static Jsi_CmdSpec booleanCmds[] = { 33 | { "Boolean", BooleanConstructor, 0, 1, "?bool?", .help="Boolean constructor", .flags=JSI_CMD_IS_CONSTRUCTOR }, 34 | { NULL, .help="A Boolean object" } 35 | }; 36 | 37 | int jsi_BooleanInit(Jsi_Interp *interp) 38 | { 39 | interp->Boolean_prototype = Jsi_CommandCreateSpecs(interp, "Boolean", booleanCmds, NULL, 0); 40 | return JSI_OK; 41 | } 42 | #endif 43 | 44 | -------------------------------------------------------------------------------- /www/js-websocket.wiki: -------------------------------------------------------------------------------- 1 |Description
4 | 5 | The WebSocket extension uses libwebsockets to implement 6 | bidirectional socket communication with a web browser. 7 | Used in conjunction with [./js-sqlite.wiki|Sqlite] and [./js-json.wiki|JSON], 8 | web browser based applications are easy to implement. 9 | 10 |Example
11 | 12 | The following creates a client and server using Websockets. 13 | First the server file ws.js: 14 | 15 |
16 | function ws_input(data, id) {
17 | puts("ws_input: "+ id +": "+data);
18 | };
19 |
20 | var ws = new Websocket({callback:ws_input});
21 | var msg = { str:"whos there?", cnt:0 };
22 | while (true) {
23 | sys.update(1);
24 | if ((msg.cnt++ % 10) == 0)
25 | ws.send(JSON.stringify(msg));
26 | }
27 |
32 | function wsc_input(data) {
33 | puts("wsc_input: "+data);
34 | };
35 |
36 | var ws = new Websocket({client:true, callback:wsc_input});
37 | var msg = { str:"knock knock", cnt:0 };
38 |
39 | while (true) {
40 | msg.cnt++;
41 | ws.send(JSON.stringify(msg));
42 | sys.update(1);
43 | }
44 | 49 | jsish ws.js & 50 | jsish wsc.js 51 |
");
12 | puts("\nGeneral");
13 | var dat,title;
14 | for (var i in flst.sort()) {
15 | if (flst[i] == "jsindex.wiki") continue;
16 | if (flst[i] == "index.wiki") continue;
17 | dat = file.read(flst[i]);
18 | title = dat.match(' | ");
24 | puts("\nScript");
25 | var dat,title, ttl;
26 | for (var i in jlst.sort()) {
27 | dat = file.read(jlst[i]);
28 | title = dat.match(' | ");
34 | puts("\nC-API");
35 | for (var i in clst.sort()) {
36 | dat = file.read(clst[i]);
37 | title = dat.match(' |
Description
3 | The purpose of autoload is to enable dynamic loading of commands upon their first invocation. 4 | We implement this by setting the object jsiIndex with a string script value to evaluate. 5 | For example, given this file myfunc.js: 6 | 7 |
8 | puts("LOADING");
9 | function double(n) { return n*2; };
10 | function half(n) { return n/2; };
11 |
16 | var jsiIndex = {
17 | double : 'include("myfunc.js");',
18 | half : 'include("myfunc.js");'
19 | };
20 | //...
21 | double(4);
22 | half(4);
23 | Multiple jsiIndex's
26 | 27 | If jsiIndex is set in more than one place, we would want to be a bit more careful 28 | not to overwrite a previous definition. Here is one way to achieve this: 29 | 30 |
31 | if (!jsiIndex) { var jsiIndex = {}; };
32 | jsiIndex.myfunc = 'include("myfunc.js");';
33 |
34 | // and in another file ...
35 |
36 | if (!jsiIndex) { var jsiIndex = {}; };
37 | jsiIndex.yourfunc = 'include("myfunc.js");';
38 | Object Methods
42 | 43 | The jsiIndex works only for simple commands. Loading of object methods can be setup as follows: 44 | 45 |
46 | var jsipp = {
47 | dir : info.scriptdir(),
48 | parse : function(arg) { include(file.join(jsipp.dir,"jsipp.js")); return jsipp.parse(arg); }
49 | };
50 |
2 |
3 | General 4 | * Building 5 | * Editors 6 | * JSI In 5 Minutes or Less 7 | * Input/Output 8 | * License 9 | * Reference 10 | * Using Jsi 11 | * Zero Install 12 | |
13 |
14 | Script 15 | * Assert 16 | * Autoload 17 | * Errors 18 | * Events 19 | * Exec 20 | * Files 21 | * Format 22 | * include 23 | * Interp 24 | * JSON 25 | * Signal 26 | * Sqlite 27 | * Threads 28 | * Websocket 29 | * Zvfs 30 | |
31 |
32 | C-API 33 | * Commands 34 | * DStrings 35 | * Extensions 36 | * Hashes 37 | * JSI_LITE 38 | * JSON 39 | * Options 40 | * Sqlite 41 | * Trees 42 | |
Description
6 | JSON (JavaScript Object Notation) is an open standard format that 7 | uses human-readable text to transmit data objects consisting of attribute–value pairs. 8 | It is the primary means of exchanging data with web-browsers. 9 | 10 | The JSON object provides the following methods: 11 | 12 |stringify(obj)
13 | 14 | The stringify() method converts a javascript data object to a string: 15 | 16 |
17 | var obj = { a:1, b:2, c:"able", d:[ 1, 2, 3 ] };
18 | var str = JSON.stringify(obj);
19 | //RETURNS: '{"a":1, "b":2, "c":"able", "d":[1,2,3]}';
20 | parse(str)
23 | 24 | The parse() method converts a string into javascript data: 25 | 26 |
27 | var str = '{"a":1, "b":2, "c":"able", "d":[1,2,3]}';
28 | var obj = JSON.parse(str);
29 | //RETURNS: { a:1, b:2, c:"able", d:[ 1, 2, 3 ] }
30 | parseNS(str)
34 | 35 | parseNS is a permissive or non-strict implementation of parse(). 36 | Permissive mode does not require quoting of names. 37 | 38 |
39 | var str = '{a:1, b:2, c:"able", d:[1,2,3]}';
40 | var obj = JSON.parseNS(str);
41 | Caveats
46 | * the current JSI implementation of JSON lacks support for UTF8. 47 | * the underlying parser is not a validating parser. 48 | -------------------------------------------------------------------------------- /www/js-events.wiki: -------------------------------------------------------------------------------- 1 |Description
4 | Ecmascript lets you schedule events using setTimeout/setInterval/clearInterval. 5 | In Jsi, this is extended with info.event() to allow querying pending events, 6 | and sys.update() to service events: 7 | 8 |
9 | function foo() {
10 | puts("FOO: "+ i++);
11 | if (i>=3) exit(0);
12 | }
13 | var i=0, id = setInterval(foo,1000);
14 | var evs = info.event();
15 | for (var i in evs) {
16 | puts('EV('+i+'): ' + info.event(evs[i]).toString());
17 | }
18 | sys.update();
19 |
24 | EV(0): { builtin:false, count:0, initial:1000, once:false, type:"timer", when:1000 }
25 | FOO: 0
26 | FOO: 1
27 | FOO: 2
28 | sys.update(?mintime|options?)
31 | 32 | Process events until minTime milliseconds exceeded, or forever if -1. 33 | Default minTime is 0. With a positive mintime, a sleep occurs between each event check pass. 34 | The returned value is the number of events processed. 35 | 36 |Option Description maxEvents Maximum number of events to process maxPasses Maximum passes through event queue minTime Minimum milliseconds before returning, or -1 to loop forever sleep Sleep time between event checks in milliseconds
info.event(?id?)
45 | 46 | List events or info for 1 event (created with setTimeout/setInterval). 47 | With no args, returns list of all outstanding events. With one arg, returns info for the given event id. 48 | -------------------------------------------------------------------------------- /tests/prototypes.js: -------------------------------------------------------------------------------- 1 | /* 2 | =!EXPECTSTART!= 3 | { } 4 | should be {} 5 | { a:123 } 6 | should be { a:123 } 7 | 123 8 | should be 123 9 | shot 10 | should be shot 11 | { a:123 } 12 | should be { a:123 } 13 | 6 14 | should be 6 15 | ZhangSan 16 | 18 17 | defaultName 18 | true 19 | false 20 | =!EXPECTEND!= 21 | */ 22 | 23 | puts(Object.prototype); 24 | puts(" should be {}"); 25 | 26 | Object.prototype.a = 123; 27 | //Object.prototype = 123; 28 | 29 | puts(Object.prototype); 30 | puts(" should be { a:123 }"); 31 | 32 | var a = { b:1, c:2 }; 33 | puts(a.a); 34 | puts(" should be 123"); 35 | a.a = 'shot'; 36 | puts(a.a); 37 | puts(" should be shot"); 38 | 39 | puts(Object.prototype); 40 | puts(" should be { a:123 }"); 41 | 42 | Number.prototype.fock = function() { 43 | puts(this / 2); 44 | }; 45 | 46 | var x = 12; 47 | 48 | x.fock(); 49 | puts(" should be 6"); 50 | 51 | function Person(name, sex) { 52 | this.name = name; 53 | this.sex = sex; 54 | }; 55 | 56 | Person.prototype = { 57 | getName: function() { 58 | return this.name; 59 | }, 60 | getSex: function() { 61 | return this.sex; 62 | }, 63 | age: 18 64 | }; 65 | 66 | function Employee(name, sex, employeeID) { 67 | this.name = name; 68 | this.sex = sex; 69 | this.employeeID = employeeID; 70 | }; 71 | 72 | Employee.prototype = new Person("defaultName", "defaultSex"); 73 | Employee.prototype.getEmployeeID = function() { 74 | return this.employeeID; 75 | }; 76 | 77 | var zhang = new Employee("ZhangSan", "man", "1234"); 78 | puts(zhang.getName()); // "ZhangSan 79 | puts(zhang.age); //18 80 | delete zhang.name; 81 | puts(zhang.name); //defaultName 82 | 83 | function f() {} 84 | function g() {} 85 | g.prototype = new f(); 86 | var h = new g(); 87 | puts(g.prototype.isPrototypeOf(h)); 88 | puts(g.prototype.isPrototypeOf(f)); 89 | -------------------------------------------------------------------------------- /www/getstarted.wiki: -------------------------------------------------------------------------------- 1 |Embedding JSI in C
4 | 5 | The file "jsi.c" contains the entire source for Jsi amalgamated into a single, standalone file. 6 | This provides a convenient way to embed Jsi into any C application. 7 | 8 | Simply extract "jsi.c" from 9 | [http://pdqi.com/downloads/jsish-1.1.0/jsi_single_src.zip|jsi_single_src.zip], 10 | and include this file directly into your 11 | source file, eg. 12 |
13 | #include "jsi.c"
14 |
15 | int main(int argc, char *argv[])
16 | {
17 | Jsi_Interp *interp = Jsi_InterpCreate(NULL, argc, argv, 0);
18 | Jsi_EvalString(interp, "for (var i=1; i<=3; i++) puts('TEST: '+i);", 0);
19 | //...
20 | }
21 | The Shell: jsish
24 | 25 | If you just want to give "jsish" a test drive, 26 | linux and windows binaries can be downloaded from [http://pdqi.com/downloads/jsish-1.1.0/]. 27 | Here is a [./usingjsi.wiki|brief tutorial on their use]. 28 | 29 |Get Source Using Fossil
30 | 31 | Jsi development is maintained within a [http://www.fossil-scm.org|fossil] repository. Once 32 | the "fossil" command is installed, Jsi can be pulled down thus: 33 | 34 |35 | fossil clone http://pdqi.com/cgi-bin/cgiwrap/pdqi/jsi.cgi jsi.fossil 36 | mkdir jsi 37 | cd jsi 38 | fossil open ../jsi.fossil 39 | cd jsi 40 |
Getting Source Without Fossil
45 | 46 | If you can't (or don't want to use fossil) you can visit [http://pdqi.com/jsi] 47 | and login as anonymous. Then navigate to Files and it will let you download a zip (or tar ball). 48 | Note however, that this approach makes it harder to get updates. 49 | 50 |Email Contact
51 | 52 |
.
53 |
--------------------------------------------------------------------------------
/www/js-errors.wiki:
--------------------------------------------------------------------------------
1 | Try/Catch
4 | 5 | in Jsi (unlike EcmaScript) try will pass a string to catch upon error, not an object eg. 6 | 7 |
8 | try { badcall(); } catch(e) { puts("Note e is a string: "+e); }
9 | Error Diagnostics
12 | 13 | Upon error, Jsi does not generate tracebacks. Instead a gcc style warning 14 | containing the file and line number is output. 15 | For example: 16 | 17 |18 | var x = 1; 19 | foo(x) 20 |
24 | /home/user/myjsi/foo.js:2: error: 'foo', sub-commands are: Array Boolean Date File 25 | Function Interp JSON Math Number Object RegExp Sqlite String Websocket alert 26 | assert clearInterval console decodeURI encodeURI exit file format include info 27 | isFinite isNaN load parseFloat parseInt puts quote setInterval setTimeout signal 28 | sys util zvfs. 29 |
Enumerated Methods
38 | 39 | Similarly an objects sub-methods will be enumerated: 40 | 41 |42 | # info.xx() 43 | error: 'info', sub-commands are: cmds data error events executable funcs named platform revisions script vars version. (at or near string "xx") 44 |
Displayed Arguments
47 | 48 | And arguments to builtin methods part of the diagnostic: 49 | 50 |51 | # format() 52 | error: missing args, expected "format(format?,arg,arg?)" 53 |
6 |
Writing
7 | 8 | To create a zip archive simpy use: 9 |
10 | zvfs.create('arch.zip', file.glob('*.js'))
11 | 14 |
Reading
15 | Jsi can mount .zip files as local filesystem: 16 | 17 |
18 | var dir = zvfs.mount('arch.zip');
19 | file.glob('*', dir);
20 | 24 |
Executing
25 | 26 | If a zip archive contains the file "main.jsi" at the toplevel, 27 | Jsi can run it, eg: 28 | 29 |30 | # jsish arch.zip 31 |
38 |
Zero-Install
39 | 40 | It is also possible to zip "main.jsi and other files directly onto the end of the jsish binary itself. 41 | This converts jsish into a Zero-Install application. 42 | 43 | As above, main.jsi will be sourced automatically and jsish exits upon completion. 44 | 45 | One way to create a Zero-Install application is to use: 46 | 47 |48 | make jsize 49 |
54 | cp jsish jsize 55 | tools/mkjsize.js create jsize zipdir 56 |
Description
4 | 5 | The JSON C API is provided by just two extern functions, whose use should be fairly intuitive. 6 | 7 |
8 | enum { JSI_JSON_STRICT=1, JSI_JSON_STRKEYS=2 }; /* flags */
9 |
10 | extern int Jsi_JSONParse(Jsi_Interp *interp, const char *js, Jsi_Value *ret, int flags);
11 | extern int Jsi_JSONParseFmt(Jsi_Interp *interp, Jsi_Value *ret, const char *fmt, ...);
12 | Simplifying C with JSON
21 | 22 | JSON can be enlisted to reduce C-code complexity, particularly when writing commands 23 | that return objects and/or arrays. 24 | While the wisdom of using JSON this way may seem counter-intuitive, 25 | the JSON parser handles this quite efficiently. 26 | 27 | For example, suppose we want to create an object with a couple of values: 28 | 29 |30 | Jsi_Obj *nobj = Jsi_ObjectNew(interp); 31 | Jsi_ValueMakeObject(interp, ret, nobj); 32 | Jsi_ObjInsertFromValue( interp, nobj, Jsi_ValueNewStringKey(interp, "file"), 33 | Jsi_ValueNewStringKey(interp, file)); 34 | Jsi_ObjInsertFromValue( interp, nobj, Jsi_ValueNewStringKey(interp, "line"), 35 | Jsi_ValueNewNumber(interp, line)); 36 |
41 | sprintf(buf, "{file:\"%s\", line:%d}", file, line);
42 | return Jsi_JSONParse(interp, buf, ret, 0);
43 |
48 | Jsi_JSONParseFmt(interp, ret, buf, "{ a: [ {x:%d, y:%d}, {x:%d, y:[%d,%d,%d]}] }",a,b,c,d,e,f);
49 |
55 | "{\"os\":\"%s\", \"platform\":\"%s\", \"hasThreads\":%s, \"pointerSize\":%d, "
56 | Sub-Interps
62 | 63 | Any data sent between sub-[./js-interp.wiki|interps] will first be converted to/from JSON. 64 | This because all data objects are private to an interp. 65 | 66 | -------------------------------------------------------------------------------- /www/usingjsi.wiki: -------------------------------------------------------------------------------- 1 |
6 | ./jsish
7 | # var a = [1,2,3];
8 | # for (var i in a) { puts(a[i]); }
9 | 1
10 | 2
11 | 3
12 | ...
13 | 20 | jsish -e 'var i = 0; while (i++<10) puts(i);' 21 |22 | 23 |
Command Options
24 | 25 | Various commands in Jsi can take an options object containing properties to parametrize behaviour. For example: 26 | 27 |
28 | var db = new Sqlite('/tmp/testsql.db',{maxStmts:1000, readonly:true});
29 | db.conf( {debug:1} );
30 | puts( db.conf() );
31 |
32 |
33 | In the case of object commands, a conf() method provides access to options after creation.
34 | Introspection
35 |
36 | There are several levels of introspection built-in to Jsi. The conf() method above is one example. Another is apparent upon and invalid method invocation, eg:
37 |
38 | 39 | # info.xxx() 40 | error: 'info', sub-commands are: cmds data error event executable funcs interp 41 | keywords named platform revisions script vars version. (at or near "xxx") 42 |
47 | # info.cmds() 48 | [ "Array", "Boolean", "File", "Function", "Interp", "JSON", "Math", "Number", 49 | "Object", "RegExp", "Sqlite", "String", "Websocket", "assert", "clearInterval", 50 | "console", "decodeURI", "encodeURI", "exit", "file", "include", "info", 51 | "isFinite", "isNaN", "load", "parseFloat", "parseInt", "puts", "quote", 52 | "setInterval", "setTimeout", "signal", "sprintf", "sys", "zvfs" ] 53 |
Doing More
56 | 57 | All built-in Jsi commands (as well as their options) are documented in the Reference. 58 | 59 |Executable Scripts
60 | 61 | To make a script executable (under unix) the first line of a Jsi script should start with #!, eg: 62 | 63 |64 | cat > myargs <
rlwrap
75 | 76 | If you are running the statically compiled Linux version, 77 | you can use rlwrap to provide command-line editing: 78 | 79 |80 | rlwrap ./jsish 81 |
Limitations
84 | 85 | A return is not supported within a try/catch. 86 | 87 | -------------------------------------------------------------------------------- /www/js-files.wiki: -------------------------------------------------------------------------------- 1 |new File
7 | A File object can be created for reading and/or writing individual files. 8 | Generally an object is instantiated to open the file and then read/write operations are performed. 9 | 10 |
11 | var f = new File('tests/filetest.txt');
12 | if (f) {
13 | while((n = f.gets())!=undefined) {
14 | puts(n);
15 | }
16 | } else console.log('Can not open tests/filetest.txt');
17 | File
20 | 21 | Synopsis: new File(file,?mode?) 22 | Commands for accessing File objects. 23 | Methods 24 | 25 | The following methods are available in "File": 26 | 27 || Method | Description |
|---|---|
| close() | close the file |
| eof() | Return true if read to end-of-file |
| filename() | Get file name |
| gets() | Get one line of input |
| mode() | Get file mode used with open |
| open(file,?mode?) | Open the file (after close) |
| puts(str) | Write one line of output |
| read() | Read entire file into object |
file.*
40 | 41 | The file sub-methods are used for accessing various attributes and information on files where just basic IO is not necessarily the goal. 42 | 43 |
44 | file.mkdir('XX1');
45 | file.mkdir('XX1/AA');
46 | file.mkdir('XX1/BB');
47 | file.rename('XX1/BB','XX1/CC.txt');
48 | puts(file.glob(null,'XX1').sort());
49 | puts(file.dirname('XX1/AA'));
50 | puts(file.rootname('XX1/CC.txt'));
51 | puts(file.tail('XX1/CC.txt'));
52 | puts(file.type('XX1/CC.txt'));
53 | puts(file.extension('XX1/CC.txt'));
54 | //puts(file.realpath('XX1/CC.txt'));
55 | puts(file.writable('XX1/CC.txt'));
56 | puts(file.readable('XX1/CC.txt'));
57 | puts(file.exists('XX1/CC.txt'));
58 | puts(file.isdir('XX1/CC.txt'));
59 | puts(file.isfile('XX1/CC.txt'));
60 | file.remove('XX1',true);
61 | 66 | [ "AA", "CC.txt" ] 67 | XX1 68 | XX1/CC 69 | CC.txt 70 | directory 71 | .txt 72 | true 73 | true 74 | true 75 | true 76 | false 77 | file 78 |
File.glob
82 | 83 | The file glob method returns an array of matching files. 84 | With no arguments (or null) returns all files/directories in current directory. 85 | If first argument is a pattern (either a glob or regexp) just files are returned. 86 | If second argument is a string, it denotes the directory to search in. 87 | If second argument is a function, this function is called with each path. 88 | Otherwise second argument is a set of options. 89 | 90 |
91 | file.glob();
92 | file.glob("*.c");
93 | file.glob(/^jsi.*\.c$/);
94 | file.glob('*','tests');
95 | file.glob('*.js',{dir:'tests', recurse:true});
96 | Embedding C
5 | 6 |7 | make USERSRC=demo 8 |
Dynamic Extensions
11 | 12 | If libjsi.so is being used on your system, you can load shared libraries into Jsi using the load() command. 13 | Or they can be statically compiled in. Basically, all that is required is defining a C function 14 | Jsi_InitXXXX to handle the initialization on load. 15 | 16 | Following is a brief but complete shared library example for Linux. 17 | Given the file user/demo.c: 18 | 19 |
20 | #include "jsi.h"
21 |
22 | JSI_EXTENSION_INI
23 |
24 | Jsi_CmdProcDecl(DemoCmd) {
25 | int i, n = Jsi_ValueGetLength(interp, args);
26 | printf("demo called with %d args\n", n);
27 | for (i=0; i
48 | cc -g -Wall -DJSI_USE_STUBS -I. -shared -fpic user/demo.c -o user/demo.so
49 | ./jsish
50 | load('user/demo.so');
51 | Static API Access
54 | 55 | Usually an extension would want to access the Jsi API to create commands, etc. 56 | Here is the sample dyn.c extension included with the distribution: 57 | 58 |
59 | #include "jsi.h"
60 |
61 | Jsi_CmdProcDecl(DynCmd) {
62 | puts("dyn called");
63 | return JSI_OK;
64 | }
65 |
66 | int Jsi_Initdyn(Jsi_Interp *interp) {
67 | puts("LOADED DYN");
68 | Jsi_CommandCreate(interp, "dyn", DynCmd, NULL);
69 | return JSI_OK;
70 | }
71 | Dynamic API Access
75 | 76 | To load the above dynamically requires using, a shared library version of Jsi (jsish), 77 | and the -ljsi option be added to the link line. Essentially, this requires installing 78 | the shared version of Jsi onto your system. 79 | Builtins 80 | 81 | JSI comes with the following builtin extensions. 82 | 83 | # Sqlite A small database engine 84 | # WebSockets Direct communication with web browsers 85 | # Zvfs A Zip virtual file system 86 | 87 | Although JSI can be compiled without these extensions, they generally come already compiled-in so 88 | that web application development is ready to go 89 | 90 |91 | $ time ./jsish tests/prime.js 92 | Have native helper: false 93 | 1999 2999 4999 8999 94 | 95 | real 0m0.384s 96 | user 0m0.376s 97 | sys 0m0.004s 98 | 99 | $ make prime.so 100 | cc -g -Wall -I. -shared -fpic user/prime.c -o prime.so 101 | $ time ./jsish tests/prime.js 102 | Have native helper: true 103 | 1999 2999 4999 8999 104 | 105 | real 0m0.169s 106 | user 0m0.164s 107 | sys 0m0.004s 108 |
7 | The MIT License (MIT) 8 | 9 | Copyright (c) 2013 Peter MacDonald 10 | 11 | Permission is hereby granted, free of charge, to any person obtaining a copy 12 | of this software and associated documentation files (the "Software"), to deal 13 | in the Software without restriction, including without limitation the rights 14 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 15 | copies of the Software, and to permit persons to whom the Software is 16 | furnished to do so, subject to the following conditions: 17 | 18 | The above copyright notice and this permission notice shall be included in 19 | all copies or substantial portions of the Software. 20 | 21 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 22 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 23 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 24 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 25 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 26 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 27 | THE SOFTWARE. 28 |
Libwebsockets
34 | 35 | If you are linking in websocket support (the default) the following license 36 | also applies: 37 | 38 |39 | Jsi source bundles a version of Libwebockets, which is covered by LGPL, with an additional clause allowing static linking. Here is the preamble: 40 | Libwebsockets and included programs are provided under the terms of the GNU 41 | Library General Public License (LGPL) 2.1, with the following exceptions: 42 | 43 | 1) Static linking of programs with the libwebsockets library does not 44 | constitute a derivative work and does not require the author to provide 45 | source code for the program, use the shared libwebsockets libraries, or 46 | link their program against a user-supplied version of libwebsockets. 47 | 48 | If you link the program to a modified version of libwebsockets, then the 49 | changes to libwebsockets must be provided under the terms of the LGPL in 50 | sections 1, 2, and 4. 51 | 52 | 2) You do not have to provide a copy of the libwebsockets license with 53 | programs that are linked to the libwebsockets library, nor do you have to 54 | identify the libwebsockets license in your program or documentation as 55 | required by section 6 of the LGPL. 56 | 57 | However, programs must still identify their use of libwebsockets. The 58 | following example statement can be included in user documentation to 59 | satisfy this requirement: 60 | 61 | "[program] is based in part on the work of the libwebsockets project 62 | (http://libwebsockets.org)" 63 | 64 | GNU LESSER GENERAL PUBLIC LICENSE 65 | Version 2.1, February 1999 66 | ... 67 |
Others
73 | 74 | Other software including sqlite, miniz, jsmn, etc are either public domain, BSD or MIT compatible. 75 | 76 | 77 | -------------------------------------------------------------------------------- /tools/testjs.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Driver for jsi test programs. 3 | # Runs *.js files in tests/ and compares output to EXPECTSTART/END in file comment. 4 | RUNVALG=0 5 | QUIET=0 6 | LOUD=0 7 | JSISH=./jsish 8 | INPSTR="input\ntest\nabc@gmail.com\n" 9 | USESTR="Usage: testjs.sh [-loud|-quiet|-memcheck]JSI ERROR
"; 120 | this.rc += e; 121 | this.rc += '\n\n'+this.errs+""; 122 | } 123 | } 124 | if (this.delInterp) { 125 | delete this.interp; 126 | this.interp = null; 127 | } 128 | return this.rc; 129 | }; 130 | 131 | 132 | if (info.isInvoked()) { 133 | puts(jsi_invokeCmd('jsi_wpp')); 134 | } 135 | 136 | -------------------------------------------------------------------------------- /tests/sqlite.js: -------------------------------------------------------------------------------- 1 | /* 2 | =!EXPECTSTART!= 3 | B=1, A=99 4 | B=2, A=95 5 | B=3, A=91 6 | [ { a:99, b:1 }, { a:95, b:2 }, { a:91, b:3 } ] 7 | CONF: { bindWarn:false, debug:0, errorCnt:0, execOpts:{ callback:null, cdata:null, headers:false, limit:0, mapundef:false, mode:"rows", nocache:false, nullvalue:null, separator:null, table:null, width:undefined }, forceInt:false, maxStmts:1000, mutex:"default", name:"", nocreate:false, readonly:false, trace:[ ], vfs:null } 8 | 95 9 | EXECING: select * from foo; 10 | [ { a:99, b:1 }, { a:95, b:2 }, { a:91, b:3 } ] 11 | EXECING: select * from foo; 12 | 99|1 13 | 95|2 14 | 91|3 15 | EXECING: select * from foo; 16 | a|b 17 | 99|1 18 | 95|2 19 | 91|3 20 | EXECING: select * from foo; 21 |
3 |
Description
4 | 5 | The method sys.exec(cmd?,option?) execute an operating system command and returns the result, eg. 6 | 7 |
8 | sys.exec('ls -l');
9 | sys.exec(['ls','-l','/tmp']);
10 | sys.exec('ls -l > /tmp/ls.txt', false);
11 | 21 |
Details
22 | 23 | This command treats its arguments as the specification of one or more UNIX commands to execute as 24 | subprocesses. The commands take the form of a standard shell pipeline; | arguments separate commands 25 | in the pipeline and cause standard output of the preceding command to be piped into standard input 26 | of the next command (or |& for both standard output and standard error). 27 | 28 | Under normal conditions the result of the exec command consists of the standard output produced 29 | by the last command in the pipeline. 30 | 31 | If any of the commands in the pipeline exit abnormally or are killed or suspended, 32 | then exec will return an error and the error message will include the pipeline’s output 33 | followed by error messages describing the abnormal terminations. 34 | 35 | If any of the commands writes to its standard error file, then exec will return an error, 36 | and the error message will include the pipeline’s output, followed by messages about abnormal 37 | terminations (if any), followed by the standard error output. 38 | 39 | If the last character of the result or error message is a newline then that character is deleted 40 | from the result or error message for consistency with normal Tcl return values. 41 | 42 | An arg may have one of the following special forms: 43 |-
45 |
46 |
- >filename 47 |
- The standard output of the last command in the pipeline is redirected to the file. 48 | In this situation exec will normally return an empty string. 49 | 50 | 51 |
- >>filename 52 |
- As above, but append to the file. 53 | 54 | 55 |
- >@fileId 56 |
- The standard output of the last command in the pipeline is redirected to the given (writable) 57 | File object. In this situation exec will normally return an empty string. 58 | 59 | 60 |
- 2>filename 61 |
- The standard error of the last command in the pipeline is redirected to the file. 62 | 63 | 64 |
- 2>>filename 65 |
- As above, but append to the file. 66 | 67 |
- 2>@fileId 68 |
- The standard error of the last command in the pipeline is redirected to the given (writable) File object. 69 | 70 | 71 |
- 2>@1 72 |
- The standard error of the last command in the pipeline is redirected to the same file descriptor 73 | as the standard output. 74 | 75 | 76 |
- >&filename 77 |
- Both the standard output and standard error of the last command in the pipeline is redirected to the file. 78 | 79 | 80 |
- >>&filename 81 |
- As above, but append to the file. 82 | 83 | 84 |
- <filename 85 |
- The standard input of the first command in the pipeline is taken from the file. 86 | 87 | 88 |
- <<string 89 |
- The standard input of the first command is taken as the given immediate value. 90 | 91 | 92 |
- <@fileId 93 |
- The standard input of the first command in the pipeline is taken from the given (readable) file descriptor. 94 | 95 | 96 |
Linux
3 | 4 | In order to build Jsi on Linux, a few packages need to be installed. 5 | On Ubuntu we do this: 6 | 7 |8 | sudo apt-get install build-essential bison cmake libreadline-dev 9 |
Build Options
14 | 15 | Jsi does not use configure. 16 | Instead, various build options are controled via make command-line options: 17 | 18 || Option | Description |
|---|---|
| EXTSRC=name | Root name of a .c file to build in as a user extension |
| EXTNAME=name | User extension name for above (if different) |
| NOSQLITE=1 | Exclude sqlite support |
| NOWEBSOCK=1 | Exclude websockets |
| USEMUSL=1 | Static, zero dependancy build with Musl-libc |
| USEMINIZ=1 | Use the miniz compression extension, instead of builtin -lz |
| WIN=1 | Cross-compile to Windows binary |
| ZIPDIR=name | Directory to zip to end of binary jsiz (default dir is zdir) |
34 | make NOWEBSOCK=1 35 |
Windows
38 | 39 | To build for Windows, first install the Mingw32 package on Linux: 40 | 41 |42 | sudo apt-get install gcc-mingw32 43 |
48 | make WIN=1 49 |
Static Build
57 | 58 | A static build is useful when you need a standalone executable with no external dependancies. 59 | 60 | To create a static image, Jsi uses the Musl library. 61 | 62 | The first step is to download [http://www.musl-libc.org|Musl] and unpack it. 63 | Then change to the musl dir and: 64 | 65 |66 | ./configure --prefix=$HOME/usr && make install 67 |
73 | echo '#define __P(x) x' > ~/usr/include/sys/cdefs.h 74 | echo '#include' > ~/usr/include/zlib.h 75 | cp -pr miniz ~/usr/include/ 76 |
81 | make USEMUSL=1 82 |
Basic Extension
89 | 90 | The following steps detail a simple way to add your own code to Jsi. Code is placed in the user directory, 91 | and make invoked with the EXTSRC=name argument. The named code gets linked into the Jsi build. 92 | Example 93 | 94 | The sample extension user/demo.c included with the Jsi distribution. 95 | It simply creates a new javascript method demo() that echo's its arguments. 96 | 97 |
98 | #include "jsi.h"
99 |
100 | Jsi_CmdProcDecl(DemoCmd) {
101 | int i, n = Jsi_ValueGetLength(interp, args);
102 | printf("demo called with %d args\n", n);
103 | for (i=0; i120 | make EXTSRC=demo 121 |
Multi-method Object Extension
125 | 126 | Sometimes in javascript it is desirable to create a new object with a number of related methods, 127 | rather than just single commands. This is achieved by registering a table of methods. 128 | 129 | The sample extension user/demos.c comes included with the 130 | Jsi distribution does this: 131 | 132 |
133 | #include "jsi.h"
134 |
135 | Jsi_CmdProcDecl(DemoCmd) {
136 | int i, n = Jsi_ValueGetLength(interp, args);
137 | printf("demo called with %d args\n", n);
138 | for (i=0; i160 | make EXTSRC=demos 161 |
Options for "'+nam+'"
\n'; 11 | rv += "\nThe following options are available for \""+nam+"\"\n\n"; 12 | rv += "| Option | Type | Description | Default |
|---|---|---|---|
| "+ci.name+" | "+ci.type+" | "+ help +" | "+ (ci.init?ci.init:'') +' |
\n'; 34 | rv += 'Return to top\n'; 35 | rv += '\n\n
'+cinf.name+'
\n\n'; 36 | rv += sprintf("Synopsis: %s(%s)\n\n", cinf.name, cinf.argStr); 37 | if (cinf.help) 38 | rv += cinf.help+".\n\n"; 39 | if (cinf.info) 40 | rv += cinf.info+'\n\n'; 41 | if (cinf.options != NULL) { 42 | rv += DumpOpts(cinf.options, cinf.name, false); 43 | } 44 | rv += '\n'; 45 | return rv+'\n'; 46 | } 47 | function LinkOpts(astr,name) { 48 | var ii; 49 | if ((ii=astr.indexOf('options'))<0) 50 | return astr; 51 | var ss = ''; 52 | if (ii>0) 53 | ss += astr.slice(0, ii); 54 | ss += "options"; 55 | ss += astr.slice(ii+7); 56 | return ss; 57 | } 58 | 59 | function DumpObj(tinf) { 60 | var hasconf, ro = '', rv = '', ci, cnam = tinf.name, cmds = info.cmds(cnam+'.*'); 61 | index += "
\n'; 64 | rv += 'Return to top\n'; 65 | rv += '\n\n
'+cnam+'
\n\n'; 66 | rv += "Synopsis:"; 67 | if (tinf.constructor) { 68 | rv += 'new '+cnam+"("+tinf.argStr+")\n\n"; 69 | } else { 70 | rv += cnam+".method(...)\n\n"; 71 | } 72 | rv += ""; 73 | if (tinf.help) 74 | rv += tinf.help+".\n\n"; 75 | if (tinf.info) 76 | rv += tinf.info+'\n\n'; 77 | rv += '\n
Methods
\n'; 78 | rv += "\nThe following methods are available in \""+cnam+"\":\n\n"; 79 | rv += "| Method | Description |
|---|---|
| new "+cnam+"("+aastr+") | "+conhelp+' |
| "+nam+"("+aastr+") | "+conhelp+' |
- ";
125 |
126 | for (var i in lst) {
127 | tinf = info.cmds(lst[i]);
128 | switch (tinf.type) {
129 | case 'object':
130 | rv += DumpObj(tinf);
131 | break;
132 | case 'command':
133 | rv += DumpCmd(tinf);
134 | break;
135 | default:
136 | throw("bad id");
137 | continue;
138 | }
139 | }
140 | rv += "";
141 | index + "