| 1 | /***************************************************************************/
|
|---|
| 2 | /*** ***/
|
|---|
| 3 | /*** JsDoc: http://code.google.com/p/jsdoc-toolkit/w/list ***/
|
|---|
| 4 | /*** ***/
|
|---|
| 5 | /*** jsdoc -d=html/dimctrl scripts/doc/ ***/
|
|---|
| 6 | /*** ***/
|
|---|
| 7 | /***************************************************************************/
|
|---|
| 8 | /**
|
|---|
| 9 | * @fileOverview
|
|---|
| 10 | * Documentation of the native functions built into dimctrl's
|
|---|
| 11 | * global namespace.
|
|---|
| 12 | */
|
|---|
| 13 |
|
|---|
| 14 | /**
|
|---|
| 15 | * An associative array containing the user supplied arguments identical to arg.
|
|---|
| 16 | *
|
|---|
| 17 | * @static
|
|---|
| 18 | * @type Array
|
|---|
| 19 | *
|
|---|
| 20 | * @example
|
|---|
| 21 | * var value = $['name'];
|
|---|
| 22 | *
|
|---|
| 23 | */
|
|---|
| 24 | _global_.$ = [];
|
|---|
| 25 |
|
|---|
| 26 | /**
|
|---|
| 27 | * An associative array containing the user supplied arguments identical to $.
|
|---|
| 28 | *
|
|---|
| 29 | * @static
|
|---|
| 30 | * @type Array
|
|---|
| 31 | *
|
|---|
| 32 | * @example
|
|---|
| 33 | * for (var key in args)
|
|---|
| 34 | * dim.out("args["+key+"]="+args[key]);
|
|---|
| 35 | */
|
|---|
| 36 | _global_.arg = [];
|
|---|
| 37 |
|
|---|
| 38 |
|
|---|
| 39 | /**
|
|---|
| 40 | * Includes another java script.
|
|---|
| 41 | *
|
|---|
| 42 | * Note that it is literally included,
|
|---|
| 43 | * i.e. its code is executed as if it were at included at this
|
|---|
| 44 | * place of the current file.
|
|---|
| 45 | *
|
|---|
| 46 | * @param {String} [name="test"]
|
|---|
| 47 | * Name of the file to be included. The base directory is
|
|---|
| 48 | * the directory in which dimctrl was started.
|
|---|
| 49 | *
|
|---|
| 50 | * @param {String} [. . . ]
|
|---|
| 51 | * More files to be included
|
|---|
| 52 | *
|
|---|
| 53 | * @type Array
|
|---|
| 54 | *
|
|---|
| 55 | * @static
|
|---|
| 56 | *
|
|---|
| 57 | */
|
|---|
| 58 | _global_.include = function() { /* [native code] */ }
|
|---|
| 59 |
|
|---|
| 60 | /**
|
|---|
| 61 | * Forecefully exit the current script. This function can be called
|
|---|
| 62 | * from anywhere and will terminate the current script.
|
|---|
| 63 | *
|
|---|
| 64 | * The effect is the same than throwing a null expecption ("throw null;")
|
|---|
| 65 | * in the main thread. In every other thread or callback, the whole script
|
|---|
| 66 | * will terminate which is different from the behaviour of a null exception
|
|---|
| 67 | * which only terminates the corresponding thread.
|
|---|
| 68 | *
|
|---|
| 69 | * @static
|
|---|
| 70 | *
|
|---|
| 71 | */
|
|---|
| 72 | _global_.exit = function() { /* [native code] */ }
|
|---|
| 73 |
|
|---|
| 74 | /**
|
|---|
| 75 | *
|
|---|
| 76 | * @returns {String}
|
|---|
| 77 | * A string with the JavaScript V8 version is returned.
|
|---|
| 78 | *
|
|---|
| 79 | * @static
|
|---|
| 80 | *
|
|---|
| 81 | */
|
|---|
| 82 | _global_.version = function() { /* [native code] */ }
|
|---|
| 83 |
|
|---|
| 84 | /**
|
|---|
| 85 | * Reads a file as a whole.
|
|---|
| 86 | *
|
|---|
| 87 | * Files can be split into an array when reading the file. It is
|
|---|
| 88 | * important to note that no size check is done. So trying to read
|
|---|
| 89 | * a file larger than the available memory will most probably crash
|
|---|
| 90 | * the program. Strictly speaking only reading ascii fils make sense.
|
|---|
| 91 | * Also gzip'ed files are supported.
|
|---|
| 92 | *
|
|---|
| 93 | * Note that this is only meant for debugging purpose and should
|
|---|
| 94 | * not be usd in a production environment. Scripts should not
|
|---|
| 95 | * access any files by defaults. If external values have to be
|
|---|
| 96 | * provided arguments should be given to the script.
|
|---|
| 97 | *
|
|---|
| 98 | * @static
|
|---|
| 99 | *
|
|---|
| 100 | * @param {String} name
|
|---|
| 101 | * Name of the file to read. The base directory is the current
|
|---|
| 102 | * working directory
|
|---|
| 103 | *
|
|---|
| 104 | * @param {String} [delim=undefined]
|
|---|
| 105 | * A delimiter used to split the file into an array. If provided
|
|---|
| 106 | * it must be a String of length 1.
|
|---|
| 107 | *
|
|---|
| 108 | * @returns {String,Array[String]}
|
|---|
| 109 | * If no delimiter is given, a StringObject with the file (read
|
|---|
| 110 | * until \0) is returned. If a delimiter is given, an array
|
|---|
| 111 | * of Strings is returned, one for each chunk. Both objects
|
|---|
| 112 | * contain the property 'name' with the file name and the array
|
|---|
| 113 | * contains the property 'delim' with the used delimiter.
|
|---|
| 114 | *
|
|---|
| 115 | * @throws
|
|---|
| 116 | * <li> If number or type of arguments is wrong
|
|---|
| 117 | * <li> If there was an error reading the file, the system error is thrown
|
|---|
| 118 | *
|
|---|
| 119 | * @example
|
|---|
| 120 | * var string = File("fact++.rc");
|
|---|
| 121 | * var array = File("fact++.rc", "\n");
|
|---|
| 122 | */
|
|---|
| 123 | _global_.File = function() { /* [native code] */ }
|
|---|
