Doc

Author: easycoder

EasyCoder.tar.gz

@@ -2240,6 +2240,7 @@ const EasyCoder_Core = {
 			if (command.name) {
 				const symbolRecord = program.getSymbolRecord(command.name);
 				EasyCoder.scripts[symbolRecord.program].exit();
+				symbolRecord.program = null;
 			} else {
 				return 0;
 			}

easycoder/easycoder-min.js

@@ -510,6 +510,34 @@ const EasyCoder_Browser = {
 		}
 	},
 
+	Focus: {
+
+		compile: (compiler) => {
+			const lino = compiler.getLino();
+			if (compiler.nextIsSymbol()) {
+				const symbol = compiler.getToken();
+				compiler.next();
+				compiler.addCommand({
+					domain: `browser`,
+					keyword: `focus`,
+					lino,
+					symbol
+				});
+				return true;
+			}
+			compiler.addWarning(`Unrecognised syntax in 'focus'`);
+			return false;
+		},
+
+		run: (program) => {
+			const command = program[program.pc];
+			const symbol = program.getSymbolRecord(command.symbol);
+			const element = symbol.element[symbol.index];
+			element.focus();
+			return command.pc + 1;
+		}
+	},
+
 	FORM: {
 
 		compile: (compiler) => {
@@ -2347,6 +2375,8 @@ const EasyCoder_Browser = {
 			return EasyCoder_Browser.FIELDSET;
 		case `file`:
 			return EasyCoder_Browser.FILE;
+		case `focus`:
+			return EasyCoder_Browser.Focus;
 		case `form`:
 			return EasyCoder_Browser.FORM;
 		case `fullscreen`:

easycoder/easycoder.js

@@ -219,6 +219,11 @@
       "syntax": "request fullscreen [exit]",
       "description": "This manages fullscreen mode, where the content of the document occupies the entire screen with now browser element being visible.%0a%0aThis feature allows **_EasyCoder_** to be used for display systems where the whole screen is used, with no title bar or other window furniture visible.%0a%0aNote that if you go into fullscreen mode you may need to provide some means of returning, as the browser Back button will not be visible.",
       "examples": "request fullscreen%0arequest fullscreen exit"
+    },
+    "focus": {
+      "syntax": "focus [element]",
+      "description": "Requests the focus to be applied to the field whose name is given.",
+      "examples": "focus NameField%0afocus OKButton"
     }
   },
   "values": {

js/plugins/browser.js

@@ -242,11 +242,6 @@
       "description": "Returns one integer ~m:value~ modulo another, which is to say, the remainder after dividing the former by the latter.",
       "examples": "put Count modulo 10 into Count"
     },
-    "the index of": {
-      "syntax": "the index of",
-      "description": "The (numeric) value of the current index of a named array variable. This is the value set by ~l:index!index {variable} to ...~.",
-      "examples": "put the index of Button into Index"
-    },
     "property": {
       "syntax": "property {name} of {JSON string}",
       "description": "~m:property~ is used to access an item in a JSON structure. In _**EasyCoder**_, JSON objects are ~dq~stringified~dq~ and kept in plain text variables. When you request a ~m:property~ from such an object it is first parsed then the requested property is extracted for you. See also ~l:element~ and ~l:set|k!set property~.",
@@ -278,8 +273,8 @@
       "examples": "put tan X radius R into Length"
     },
     "left": {
-      "syntax": "left {count} of {Text}",
-      "description": "returns the leftmost ~m:{count}~ characters of ~m:{Text}~.%0a",
+      "syntax": "left {count} of {text}",
+      "description": "returns the leftmost ~m:{count}~ characters of ~m:{text}~.%0a",
       "examples": "put left 5 of Text into Prefix"
     },
     "right": {
@@ -293,9 +288,9 @@
       "examples": "put from 8 of Sentence into Phrase%0aput from X to Y of `the quick brown fox` into Extract"
     },
     "position": {
-      "syntax": "the position of [the last] {needle} in {haystack}",
-      "description": "returns the position in ~m:{haystack}~ of either the first or the last occurrence of ~m:{needle}~, where both ~m:{needle}~ and ~m:{haystack}~ are text values.%0a%0aIf ~m:{needle}~ is not contained in ~m:{haystack}~ the value ~m:-1~ is returned.%0a",
-      "examples": "put the position of `fox` in `The quick brown fox jumps over the lazy dog` into Pos (Pos=16)%0aput the position of the last `dot` in `dot dot dot` into P (P=8)"
+      "syntax": "the position [nocase] of [the last] {needle} in {haystack}",
+      "description": "returns the position in ~m:{haystack}~ of either the first or the last occurrence of ~m:{needle}~, where both ~m:{needle}~ and ~m:{haystack}~ are text values.%0a%0aIf ~m:{needle}~ is not contained in ~m:{haystack}~ the value ~m:-1~ is returned.%0a%0aIf the optional ~m:nocase~ is given the match is done with case ignored.%0a",
+      "examples": "put the position of `fox` in `The quick brown fox jumps over the lazy dog` into Pos (Pos=16)%0aput the position nocase of the last `dot` in `Dot dot Dot` into P (P=8)"
     },
     "decode": {
       "syntax": "decode {variable}",
@@ -345,6 +340,26 @@
       "syntax": "date {value}",
       "description": "Returns the timestamp of a given date - the number of seconds since the epoch (January 1, 1970).%0a%0aThe value returned will depend on the format given. The first example above returns 1561420800000, which is the UTC value for the date given, but the second and third return values for the local timezone. The last one returns GMT (which is the same as UTC).%0a%0aSee also ~l:today~, ~l:now~ and ~l:format~.",
       "examples": "put date `2019-06-25` into TheDate%0aput date `2019-06-25 00:00:00` into TheDate%0aput date `Tuesday June 25 2019` into TheDate%0aput date `Tuesday June 25 2019 GMT` into TheDate"
+    },
+    "char[acter]": {
+      "syntax": "char[acter] {index} of {value}",
+      "description": "Extracts a single character from a string. Both ~m:index~ and ~m:value~ can be either symbols or values.",
+      "examples": "put char N of Text into C%0aprint character 5 of ~dq~helpful~dq~ --> ~dq~u~dq~"
+    },
+    "split": {
+      "syntax": "split {value} on {value} giving/into {variable}",
+      "description": "Splits a value into an array of parts on the given separator. If no separator is given the separator is set to a newline.%0a%0aThe result is an array variable.",
+      "examples": "split Text into Lines%0asplit CSV on `,` giving Items%0asplit `1,2,3,4,5` on Comma into Numbers"
+    },
+    "index of": {
+      "syntax": "the index of",
+      "description": "The (numeric) value of the current index of a named array variable. This is the value set by ~l:index!index {variable} to ...~.",
+      "examples": "put the index of Button into Index"
+    },
+    "length of": {
+      "syntax": "length of {value}",
+      "description": "Measures a text variable.",
+      "examples": "put the length of Name into Length"
     }
   },
   "conditions": {
@@ -354,9 +369,9 @@
       "examples": "if EditorModule is not running goto StartEditor"
     },
     "numeric": {
-      "syntax": "numeric",
+      "syntax": "[not] numeric",
       "description": "Tests if a value is numeric",
-      "examples": "if TheValue is numeric ..."
+      "examples": "if TheValue is numeric ...%0aif char N of Value is not numeric ..."
     },
     "even": {
       "syntax": "even",

resources/doc/browser.json

@@ -30,24 +30,14 @@
       "description": "This renames a property in a JSON object.",
       "examples": "json rename `mail` to `email` in Details"
     },
-    "rest get": {
-      "syntax": "rest get {variable} from {endpoint} [or ...]",
-      "description": "This issues a REST GET request to the named ~m:endpoint~, giving it the ~l:variable|k|core~ to receive the contents of the request. If there is an error and the ~m:or~ clause has been provided this will be executed, allowing you to take appropriate actions, otherwise the error will be unrecoverable and the program will stop. See also ~l:rest post~.%0a%0aThe REST server comes with a selection of useful endpoints but in many cases you will need to add new ones for the tables you add to the database. The server has an extension mechanism; you will find a file called ~m:rest-local.php~ in the top-level ~m:resources~ folder of your WordPress installation. Use this to add functionality; don~sq~t alter the main REST server as it will be overwritten in a future update to _**EasyCoder**_.",
-      "examples": "rest get Record from `_/ec_users/25 or%0abegin%0a  alert `Couldn~sq~t retrieve data`%0a  stop%0aend"
-    },
-    "rest post": {
-      "syntax": "rest post [{value}] to {endpoint} [giving {variable}] [or ...]",
-      "description": "This issues a REST POST request to the named ~m:endpoint~, giving it the ~m:value~ as a JSON string. You can optionally collect the response from the server by using ~m:giving~. If there is an error and the ~m:or~ clause has been provided this will be executed, allowing you to take appropriate actions, otherwise the error will be unrecoverable and the program will stop. See also ~l:rest get~.%0a%0aIf the request is entirely contained in the URL you can omit the ~m:{value}~.%0a%0aThe REST server comes with a selection of useful endpoints and you can add new ones for extra tables you add to the database. The server has an extension mechanism; you will find a file called ~m:rest-local.php~ in the top-level ~m:resources~ folder of your WordPress installation. Use this to add functionality; don~sq~t alter the main REST server as it will be overwritten in future updates to _**EasyCoder**_.",
-      "examples": "rest post MyData to `_/ec_markers` giving Response%0aor begin%0a  alert the error%0a  step%0aend%0arest post to `_/ec_test/dummy`"
-    },
     "json sort": {
       "syntax": "json sort {list}",
       "description": "Sorts the contents of a list into ascending alphabetical order.",
       "examples": "json sort MyList"
     },
     "json split": {
       "syntax": "json split {item} [on {separator}] into {variable}",
-      "description": "Splits a variable into an array of parts on the given separator. If no separator is given the separator is set to a newline (\n).",
+      "description": "Splits a variable into an array of parts on the given separator. If no separator is given the separator is set to a newline (%0a).",
       "examples": "json split Paragraph into Lines%0ajson split Text on `~` into Tokens"
     }
   },

resources/doc/core.json

@@ -3,7 +3,7 @@
     "rest get": {
       "syntax": "rest get {variable} from {endpoint} [or ...]",
       "description": "This issues a REST GET request to the named ~m:endpoint~, giving it the ~l:variable|k|core~ to receive the contents of the request. If there is an error and the ~m:or~ clause has been provided this will be executed, allowing you to take appropriate actions, otherwise the error will be unrecoverable and the program will stop. See also ~l:rest post~.%0a%0aThe REST server comes with a selection of useful endpoints but in many cases you will need to add new ones for the tables you add to the database. The server has an extension mechanism; you will find a file called ~m:rest-local.php~ in the top-level ~m:resources~ folder of your WordPress installation. Use this to add functionality; don~sq~t alter the main REST server as it will be overwritten in a future update to _**EasyCoder**_.",
-      "examples": "rest get Record from `/resources/users/25 or%0abegin%0a  alert `Couldn~sq~t retrieve data`%0a  stop%0aend"
+      "examples": "rest get Record from `_/ec_users/25 or%0abegin%0a  alert `Couldn~sq~t retrieve data`%0a  stop%0aend"
     },
     "rest post": {
       "syntax": "rest post [{value}] to {endpoint} [giving {variable}] [or ...]",