Annotation of parser3/operators.txt, revision 1.261
1.260 moko 1: operators
2: ^eval(expression)[format] expressions, apart from the usual functions, supports:
3: #comments allowed
4: they work until the end of the line or the closing parenthesis
5: nested parentheses are allowed inside comments
6: among the non-obvious operators:
7: | bitwise XOR
8: || logical XOR
9: ~ bitwise negation
10: \ integer division 10\3=3
11: def checks if defined:
12: an empty string is not defined
13: an empty table is not defined
14: an empty hash is not defined
15: eq ne lt gt le ge for string comparison,
16: in "/dir/" to check if the current document is located in the specified directory
17: ["no expressions allowed inside; if you need a complex comparison, assign it to a variable"]
18: is 'type' to check the type of the left operand,
19: e.g., "is the method parameter not a hash?"
20: -f checks if a file exists on disk,
21: -d checks if a directory exists on disk,
22: a quoted string (double or single quotes) is treated as a string, unquoted text is a string until the nearest whitespace
23: numeric literals can be in hex format like 0xABC
24: priorities:
1.250 moko 25: /* logical */
26: %left "!||"
27: %left "||"
28: %left "&&"
1.260 moko 29: %left '<' '>' "<=" ">=" "lt" "gt" "le" "ge"
30: %left "==" "!=" "eq" "ne"
1.250 moko 31: %left "is" "def" "in" "-f" "-d"
32: %left '!'
1.1 paf 33:
1.259 moko 34: /* bitwise */
1.250 moko 35: %left '!|'
36: %left '|'
1.260 moko 37: %left '&'
1.250 moko 38: %left '~'
1.1 paf 39:
1.259 moko 40: /* numerical */
1.250 moko 41: %left '-' '+'
42: %left '*' '/' '%' '\\'
43: %left '~' /* negation: unary */
1.259 moko 44:
1.260 moko 45: literals:
1.250 moko 46: true
47: false
48:
1.260 moko 49: ^if(condition){then}{else}
50: ^if(condition1){yes}[(condition2){yes}[(condition3){yes}[...]]]{no}
51: unlimited number of additional conditions (elseif)
1.250 moko 52:
1.260 moko 53: ^switch[value]{^case[var1[;var2...]]{action}^case[DEFAULT]{default action}}
1.250 moko 54:
1.260 moko 55: ^while(condition){body}[[delimiter]|{delimiter executed before each non-empty non-first body}]
1.250 moko 56:
1.260 moko 57: ^for[i](0;4){body}[[delimiter]|{delimiter executed before each non-empty non-first body}]
1.250 moko 58:
59: ^try{
1.21 paf 60: ...
1.260 moko 61: ^throw[sql.connect[;vasya[;mistaken]]] // previously ^error[text]
1.250 moko 62: ^throw[
63: $.type[sql.connect]
1.260 moko 64: $.source[vasya]
65: $.comment[mistaken]
1.207 misha 66: ]
1.20 paf 67: ...
68: }{
1.207 misha 69: ^if($exception.type eq "sql"){
1.260 moko 70: $exception.handled(1|true) ^rem{flag that exception is handled}
1.21 paf 71: ....
72: }
1.207 misha 73: ^switch[$exception.type]{
1.21 paf 74: ^case[sql;mail]{
75: $exception.handled(1)
1.260 moko 76: code handling sql error
1.21 paf 77: $exception.type = sql.connect
1.260 moko 78: $exception.file $exception.lineno $exception.colno [if not disabled at compile time]
79: $exception.source = vasya
80: $exception.comment = mistaken
1.21 paf 81: }
1.194 misha 82: ^case[DEFAULT]{
1.260 moko 83: code handling another error
1.207 misha 84: ^throw[$exception] << re-throw // DON'T! It's default behaviour!
1.21 paf 85: }
86: }
1.20 paf 87: }
1.250 moko 88:
1.259 moko 89: ^break[]
1.260 moko 90: breaks the loop
1.259 moko 91: ^break(true|false)
1.260 moko 92: breaks the loop if true
1.259 moko 93:
94: ^continue[]
1.260 moko 95: breaks the current iteration of the loop
1.259 moko 96: ^continue(true|false)
1.260 moko 97: breaks the current iteration if true
1.259 moko 98:
99: ^return[]
1.260 moko 100: stops method execution
1.259 moko 101: ^return[value]
1.260 moko 102: assigns $result the value and stops method execution
1.250 moko 103:
1.260 moko 104: ^untaint[[as-is|file-spec|uri|http-header|mail-header|sql|js|json|parser-code|regex|xml|html|optimized-[as-is|xml|html]]]{code}
1.1 paf 105: default as-is
1.250 moko 106:
1.260 moko 107: ^taint[[lang]][code]
1.1 paf 108: default "just tainted, language unknown"
1.250 moko 109:
1.260 moko 110: ^apply-taint[[lang;]text]
111: applies transformations specified in the string, "indefinitely dirty" is considered as lang, producing a clean string
1.250 moko 112:
1.260 moko 113: ^process[[$caller.CLASS|$object|$CLASS:CLASS]]{string to be processed as code}[
114: $.main[what to rename @main to]
115: $.file[name of the file supposedly containing this text]
116: $.lineno(line number in the file from where this text originated, can be negative)
1.151 paf 117: ]
1.260 moko 118: ^process..[path][what to rename @main to]
119: by default, methods are compiled into $self [in case of operator, $self=$MAIN:CLASS]
1.250 moko 120:
1.260 moko 121: ^connect[protocol://connection-string]]{code with ^sql[...] calls}
1.254 moko 122: mysql://user:pass@{host[:port][, host[:port]]|[/unix/socket]}/database?
1.161 paf 123: ClientCharset=parser-charset << charset in which parser thinks client works
1.248 moko 124: charset=UTF-8&
1.1 paf 125: timeout=3&
1.210 misha 126: compress=0&
1.136 paf 127: named_pipe=1&
1.260 moko 128: multi_statements=1& allow executing more than one query in a single :sql{} request
1.254 moko 129: config_file=.my.cnf&
130: config_group=parser3& use group name from .my.cnf
1.136 paf 131: autocommit=1
1.260 moko 132: if autocommit is set to 0, it will perform commit/rollback
1.1 paf 133:
1.250 moko 134: pgsql://user:pass@{host[:port]|[local]}/database?
1.163 paf 135: client_encoding=win,[to-find-out]
136: &datestyle=ISO,SQL,Postgres,European,NonEuropean=US,German,DEFAULT=ISO
137: &ClientCharset=parser-charset << charset in which parser thinks client works
1.250 moko 138:
139: odbc://DSN=dsn^;UID=user^;PWD=password^;ClientCharset=parser-charset
1.162 paf 140: ClientCharset << charset in which parser thinks client works
1.250 moko 141:
142: sqlite://DBfile?
1.230 misha 143: ClientCharset=parser-charset& << charset in which parser thinks client works
144: autocommit=1
1.1 paf 145:
1.260 moko 146: to use ^connect, the $SQL table must be defined beforehand (recommended in the system configuration auto.p)
1.1 paf 147: #sql drivers
148: $SQL[
1.207 misha 149: $.drivers[^table::create{protocol driver client
1.259 moko 150: mysql $prefix/libparser3mysql.so libmysqlclient.so
151: pgsql $prefix/libparser3pgsql.so libpq.so
152: sqlite $prefix/libparser3sqlite.so sqlite3.so
1.257 moko 153: odbc parser3odbc.dll
1.1 paf 154: }]
155: ]
1.250 moko 156: ^rem{}
1.260 moko 157: a comment, removed at compile time
1.250 moko 158:
1.260 moko 159: ^cache[file](seconds){code}[{catch code}]
160: relative time assignment
161: caches the string resulting from the code execution for 'seconds' seconds
162: if 0 seconds, do not cache, and remove any existing old cache
163: in the catch code, $exception.handled[cache] ^rem{flag that exception is handled}
164: ^cache[file][expires date]{code}[{catch code}]
165: absolute time assignment
166: ^cache[file]
167: deletes the file [no error if it doesn't exist]
168: ^cache(seconds)
1.250 moko 169: ^cache[expires date]
1.260 moko 170: signals to the upper-level ^cache "reduce it to these many 'seconds'/'expires'"
171: ultimately: ^cache(0) cancels caching
1.259 moko 172: ^cache[]
1.260 moko 173: returns the current expires date
1.250 moko 174:
1.260 moko 175: each method has a local variable $result. If you put something in it,
176: that will be the method's result, not its body
1.250 moko 177:
1.260 moko 178: each method has a local variable $caller, containing the parent stack frame,
179: you can write to its local variables
1.250 moko 180:
1.260 moko 181: use(^use or @USE) searches for and includes a file:
182: 1. If the path starts with /, it is considered a path from the web root
183: 2. Relative to the current directory
184: 3. Relative to strings from the $MAIN:CLASS_PATH table, bottom-up
185: $MAIN:CLASS_PATH is a global string or table with a path or paths to a directory
186: with classes (from the web root), set it in the configuration auto.p
187:
188: A global table $CHARSETS[$.name[filename]]
189: defines which characters are considered what (whitespace, letter, etc.), as well as their Unicode
190: format: tab-delimited file, with a header:
1.250 moko 191: char white-space digit hex-digit letter word lowercase unicode1 unicode2
1.260 moko 192: A x x x a 0x0041 0xFF21
193: where char and lowercase can be letters or 0xCODES
194: if the character has a single Unicode representation equal to itself, you can omit unicode
195: UTF-8 is always available and is the default encoding for request and response
196: WARNING: the encoding name is case-insensitive
197:
198:
199: syntax
200: $name[new value]
201: $name(arithmetic expression of new value)
202: $name{code of new value}
203: $name whitespace or ${name}something - variable value
204: ^name parameters - call
205: $name.CLASS - class of the value
206: $name.CLASS_NAME - name of the class
207: $name[$.key[] () {}] - constructor of a hash variable with element $name.key
208: ^method[$.key[] () {}] - constructor of a hash parameter with element $parameter.key
209: $CLASS.name access a class variable
210:
211: the name ends before: space tab linefeed ; ] } ) " < > + * / % & | = ! ' , ?
212: i.e. you can do $name,aaaa
213: but if you need a character after the name, say -, then ${name}-
214:
215: in expressions, + and - are additional name boundaries
216:
217: you can access compound objects as: $name.subname where subname can be:
218: a string
219: a $variable
220: a string$variable
221: [code computing a string]
222: for example: $hash[$.age(88)] $get[$.field[age]] ^hash.[$get.field].format{%05d}
223:
224: parameters := one or more parameters
225: parameter :=
226: (arithmetic expression) evaluated multiple times inside the call,
227: | [code] evaluated once before the call,
228: | {code} evaluated zero or many times inside the call,
229: ';' are allowed, making multiple parameters in a single bracket
230:
1.250 moko 231:
232: void
1.260 moko 233: all methods present in the string class object are available, the result behaves as if it were an empty string
234: ^void:sql{query without result}{$.bind[see table::sql]}
1.250 moko 235:
236: int,double
1.260 moko 237: ^name.int[]
238: integer value
239: ^name.double[]
240: double value
241: ^name.bool[] ^name.bool(true|false)
242: boolean value
243: ^name.inc(how much +)
244: ^name.dec(how much -)
245: ^name.mul(how much *)
246: ^name.div(how much /)
247: ^name.mod(how much %)
248: ^name.format[format]
249: ^int/double:sql{query}[[$.limit(2) $.offset(4) $.default{0} $.bind[see table::sql]]]
250: the query result should be one column/one row
1.1 paf 251:
1.250 moko 252: string
1.260 moko 253: in expression
254: def value means "not empty?"
255: logical/numerical value equals an attempt to convert to double,
256: an empty string quietly converts to 0
257: example:
258: ^if(def $form:name) not empty?
259: ^if($user.isAlive) true? [auto-convert to number, not zero?]
260: ^string:sql{query}[[$.limit(1) $.offset(4) $.default{n/a} $.bind[see table::sql]]]
261: the query result should be one column/one row
262: ^string.int[] ^string.int(default)
263: integer value of the string, if conversion fails, default is taken
264: ^string.double[] ^string.double(default)
265: double value of the string, if conversion fails, default is taken
266: ^string.bool[] ^string.bool(default)
267: boolean value of the string, if conversion fails, default is taken
268: ^string.format[format] %d %.2f %02d...
269: ^string.match[string-pattern|regex-pattern][[search options]] $prematch $match $postmatch $1 $2...
270: search options:
1.21 paf 271: i CASELESS
272: x whitespace in regex ignored
1.260 moko 273: s singleline = $ matches end of entire text
274: m multiline = $ matches end of line[\n], not end of entire text
275: g find all occurrences, not just one
276: ' create columns prematch, match, postmatch
277: n return the number of matches instead of a table
278: U invert the meaning of the '?' modifier
279: ^string.match[string-pattern|regex-pattern][search options]{replacement}
280: additional search option:
281: g replace all occurrences, not just one
282: ^string.split[delimiter|regex][[lrhva]][[column name for vertical splitting]]
283: l left to right [default]
284: r right to left
285: h nameless table with keys 0, 1, 2, ...
286: v table of one column 'piece' or as provided [default]
287: a array
288: ^string.{l|r}split[delimiter] a table from the $piece column
289: kept for compatibility
290: ^string.upper|lower[]
291: ^string.length[]
292: ^string.mid(P[;N])
293: without N - "until the end of the string"
294: ^string.left(N), -1 returns the entire string
295: ^string.right(N)
296: ^string.pos[substring]
297: ^string.pos[substring](position from which to search)
298: <0 = not found
299: ^string.replace[$table_of_substitutions_string_to_string]
300: ^string.replace[$what;$to]
301: ^string.save[[append;]path]
302: ^string.save[path[;$.charset[in which encoding save] $.append(true)]]
303: saves the string to a file
304: ^string.trim[start|both|end|left|right[;chars]]
305: removes chars from the start/end/or both start and end
1.259 moko 306: default 'chars' = whitespace chars
1.260 moko 307: ^string.trim[chars]
308: removes chars from start and end
309: ^string.base64[ $.pad(bool) $.wrap(bool) $.url-safe(bool) ] encode
1.259 moko 310: ^string:base64[encoded[; $.pad(bool) $.strict(bool) $.url-safe(bool) ]] decode
1.260 moko 311: ^string.idna[]
312: IDNA encoding, supports Cyrillic domains
1.250 moko 313: ^string:idna[encoded]
1.260 moko 314: IDNA decoding, supports Cyrillic domains
315: ^string.js-escape[]
316: encoding for passing to JS (%uXXXX)
1.257 moko 317: ^string:js-unescape[escaped]
1.260 moko 318: decoding from js
1.257 moko 319: ^string:unescape[js|uri;escaped; $.charset[] ]
1.260 moko 320: decoding passed from js or uri
321: ^string.contains[key]
322: for compatibility with hashtable
1.255 moko 323:
1.251 moko 324: table
1.260 moko 325: in expression
326: logical value means "not empty?"
327: numerical value equals count[]
328: $table.field
329: $table.field[new value]
330: $table.fields
331: from a named table returns the current record as a Hash
332: ^table::create[[nameless]]{data}[[$.separator[^#09] $.encloser[]]]
1.251 moko 333: ^table::create[table][[$.limit(1) $.offset(5) $.offset[cur] $.reverse(1)]]
1.260 moko 334: clones the table
335: reverse - in reverse order
336: ^table::load[[nameless;]path[;options]]
337: if not nameless, column names are taken from the first line
338: empty lines, and lines in the first column containing '#' are ignored
1.251 moko 339: $.separator[^#09]
1.260 moko 340: $.encloser["] by default, none
1.251 moko 341: ^table::sql{query}[[$.limit(2) $.offset(4) $.bind[hash]]]
1.260 moko 342: bind associates variables in the query with their values
343: currently implemented only for oracle
344: in the query you need to write ":name"
345: in the bind parameter pass a hash from which the value is taken (or where it is written)
346: ^table.save[[nameless|append;]path[;options, see load]]
347: saves the table to a file
348: ^table.menu{body}[[delimiter]]
349: executes the body code for each row of the table
350: ^table.foreach[position;value]{body}[[delimiter]]
351: ^table.line[]
352: current table row, starting from 1
353: ^table.offset[]
354: offset of the current row from the start, starting from 0
355: ^table.offset[[whence]](5)
356: shifts whence=cur|set, without whence = cur
357: ^table.count[], ^table.count[rows]
358: number of rows in the table
359: ^table.count[columns]
360: number of columns
361: ^table.count[cells]
362: number of cells in the current row
363: ^table.sort{{string-key-maker}|(numeric-key-maker)}[{desc|asc}] default=asc
364: ^table.append{data}
365: ^table.append[ $.column_name[column_value] ]
366: ^table.insert{data} add a record at the current position
367: ^table.insert[ $.column_name[column_value] ]
368: ^table.delete[]
369: deletes the record at the current position
370: ^table.join[table][$.limit(1) $.offset(5) $.offset[cur]]
371: adds records from the table, tables must have the same structure
372: ^table.flip[]
373: returns the transposed version
374: ^table.locate[field;value][[$.limit(1) $.offset(5) $.offset[cur] $.reverse(1)]]
375: moves the current row if found. returns bool
376: ^table.locate(logical expression)[[$.limit(1) $.offset(5) $.offset[cur] $.reverse(1)]]
377: moves the current row if found. returns bool
378: ^table.hash{[field]|{code}|(expression)}[[value field(s)|table of value fields]{value code}][[$.distinct(1) $.distinct[tables] $.type[hash]]]
379: by default $hash.key value is a hash where value fields are keys
380: value fields may not be specified, then they are all columns including the key
381: if distinct is true, no error if duplicate keys
382: if distinct is tables, a hash of tables is created, containing rows with that key
383: $.type[string/table] changes the element value to a string (specify one column) or a table
384: ^table.columns[[column name]]
385: table of one column 'column' or as provided
386: ^table.cells[], ^table.cells(limit)
387: returns an array of cells of the current row
388: ^table.array[]
389: returns an array of hashes, each hash representing the data of one row
390: ^table.array[column]
391: returns an array of values from the specified column
392: ^table.array{code}
393: returns an array of results from executing the given code for each row
394: ^table.rename[column name;new column name] ^table.rename[ $.column_name[new column name] ...]
395: renames a column or multiple columns
396: $selected[^table.select(expression)]
397: a table from those columns and rows where the condition matched
1.86 paf 398: $adults[^man.select($man.age>=18)]
1.260 moko 399: ^table.color[color1;color2]
400: alternates color1 and color2 for each row
1.1 paf 401:
1.251 moko 402: hash
1.260 moko 403: in expression
404: logical value means "not empty?", a hash with _default is already not empty
405: numerical value equals count[]
406: $hash.key
407: _default - a special key, if defined,
408: then when accessing a non-existing key, _default value is returned
409: $hash.fields
410: returns $hash, making hash class more similar to table class
1.251 moko 411: ^hash::create[[|copy_from_hash|copy_from_hashfile]]
1.260 moko 412: creates a new hash, a copy of the old one
413: ^hash.add[term]
414: overwrites entries with the same name
415: ^hash.sub[subtracted]
416: ^hash.union[b]
417: union, same-named remain
418: ^hash.intersection[b][[$.order[self|arg]]]
419: intersection, new hash, order defines the element order (as in the source hash or parameter hash)
420: ^hash.intersects[b] = bool
421: ^hash::sql{query}[[$.distinct(1) $.limit(2) $.offset(4) $.type[hash|string|table]]]
422: results is hash(keys = values of the first column of the response) of hash(keys = names of the other columns), or
423: string = each element's value is a string (need exactly two columns), or
424: table = each element's value is a table
425: ^hash.keys[[name of key column]]
426: a table of one 'key' column or as provided
427: ^hash.count[]
428: ^hash.foreach[key;value]{body}[[delimiter]|{delimiter executed before each non-empty non-first body}]
429: ^hash.delete[key]
430: delete key
431: ^hash.contain[key]
432: checks if hash contains a key (bool)
433: ^hash.at[first|last][[key|value|hash]]
434: ^hash.at([-]N)[[key|value|hash]]
435: access specified elements of an ordered hash
436: ^hash.set[first|last;value]
437: ^hash.set([-+]N)[value]
438: sets the value of the specified ordered hash element
439: ^hash.rename[old_key;new_key]
440: ^hash.rename[ $.old_key[new_key] ...]
441: renames the specified hash keys
442: ^hash.sort[key;value]{{string-key-maker}|(numeric-key-maker)}[[desc|asc]] default=asc
443: $reversed_hash[^hash.reverse[]]
444: $selected[^hash.select[key;value](expression)[ $.limit(N) $.reverse(bool) $.default(bool) ]]
445: a hash of keys and values for which the condition is true
1.255 moko 446:
1.252 moko 447: hashfile
448: ^hashfile::open[filename]
1.260 moko 449: ^hashfile.clear[]
450: forget all
451: $hashfile.key[value]
452: put value
453: $hashfile.key[$.value[value] $.expires[VALUE]]
454: put value until expires
455: expires can be a date, or number of days (0days=forever)
456: $hashfile.key retrieve
457: ^hashfile.delete[key] delete key
458: ^hashfile.delete[] delete files containing data
459: ^hashfile.hash[]
460: convert to a regular hash
461: removing expired pairs along the way
462: ^hashfile.foreach[key;value]{body}[[delimiter]|{delimiter executed before each non-empty non-first body}]
463: ^hashfile.release[]
464: write data and release locks.
465: next access to elements will reopen automatically.
466: ^hashfile.cleanup[]
467: iterate all elements and delete expired ones.
1.132 paf 468:
1.260 moko 469: example:
1.170 paf 470: $sessions[^hashfile::open[/db/sessions]]
471: $sid[^math:uuid[]]
472: $sessions.$sid[$.value[$uid] $.expires(1)]
473: $uid[$sessions.$sid]
1.132 paf 474:
1.255 moko 475: array
1.260 moko 476: in expression
477: logical value means "not empty?"
478: numerical value equals count[]
479: $array.index, $array.(expression)
480: returns the value at the given index
481: $array.index[value], $array.(expression)[value]
482: assigns a value by index
483: $array[value;value;...]
484: creates an array with the given values
1.255 moko 485: ^array::create[]
1.260 moko 486: ^array::create[value;value;...]
487: creates an array with the given values or an empty array
488: ^array::copy[array or hash with numeric keys]
489: copies an array or a hash with numeric keys
490: ^array.add[array or hash with numeric keys]
491: adds elements from another array or hash, overwriting values for matching indexes
492: ^array.join[array or any hash]
493: appends elements from another array or hash to the end of the array
494: ^array.append[value;value;...]
495: appends elements to the end of the array
496: ^array.insert(index)[value;value;...]
497: inserts elements at the specified position in the array
498: ^array.left(n)
499: returns a new array of the first n elements
500: ^array.right(n)
501: returns a new array of the last n elements
502: ^array.mid(m;n)
503: returns a new array containing n initialized elements starting from position m
504: ^array.delete(index)
505: deletes an array element, leaving an empty spot
506: ^array.remove(index)
507: deletes an element and shifts subsequent elements to fill the gap
508: ^array.push[value]
509: adds an element to the end of the array
510: ^array.pop[]
511: returns the last element and removes it from the array
512: ^array.contain(index)
513: checks if an element exists at the given index (bool)
514: ^array::sql{query}[ $.sparse(false|true) $.distinct(false|true) $.limit(n) $.offset(n) $.type[hash|string|table] ]
515: creates an array based on a database query
516: $.sparse(false), default - create a normal array. Row values from the query are added sequentially
517: $.sparse(true) - create a sparse array. The first column must contain indexes
518: at which values will be placed (similar to ^hash::sql{})
519: result is an array of hash (keys=column names of the rest of the answer) or
520: string = each element's value is a string (need exactly two columns), or
521: table = each element's value is a table
522: ^array.keys[[column name for keys]]
523: a table of one 'key' column (or as provided) with the indexes of initialized elements
524: ^array.count[]
525: the number of initialized elements in the array
526: ^array.count[all]
527: the total number of elements, including uninitialized ones
528: ^array.foreach[index;value]{code}[[delimiter]|{delimiter executed before each non-empty non-first body}]
529: iterates over all initialized elements
530: ^array.for[index;value]{code}[[delimiter]|{delimiter executed before each non-empty non-first body}]
531: iterates over all elements
532: ^array.at[first|last][[key|value|hash]]
533: ^array.at([-]number)[[key|value|hash]]
534: accesses an array element by its ordinal number
535: ^array.set[first|last][value]
536: ^array.set([-]number)[value]
537: sets the value of an array element by ordinal number
538: ^array.compact[]
539: removes uninitialized elements
540: ^array.compact[undef]
541: removes uninitialized and empty elements
542: ^array.sort[key;value]{{string-key-maker}|(numeric-key-maker)}[[desc|asc]] default=asc
543: sorts the array
544: $reversed_array[^array.reverse[]]
545: returns a new array with elements in reverse order
546: $selected[^array.select[key;value](expression)[ $.limit(N) $.reverse(bool) ]]
547: selects array elements for which the condition is true
1.255 moko 548:
1.252 moko 549: form
1.260 moko 550: [the first element with the same name is taken from GET, then from POST]
551: $form:field
1.257 moko 552: string/file
553: $form:nameless
1.260 moko 554: field with a value from a nameless parameter "?value&...", "...&value&...", "...&value"
1.257 moko 555: $form:qtail
1.260 moko 556: string with the value after the second "?xxxxx" if there was no ',' [imap]
1.257 moko 557: $form:fields
1.260 moko 558: hash with all form fields
559: $form:elements.field
560: array with all values of the field - both string and file
561: $form:tables.field
562: table with one column "field" containing the values for multiple entries
563: $form:files.field
564: hash with file-type field values, keys - 0, 1, ..., value - file
1.257 moko 565: $form:imap
1.260 moko 566: a hash with keys 'x' and 'y' with ?1,2 suffixes when using server-side image map
1.1 paf 567:
1.252 moko 568: env
1.260 moko 569: $env:variable
570: $env:fields hash with environment variables
571: $env:PARSER_VERSION parser version
1.252 moko 572:
573: cookie
1.260 moko 574: $cookie:name read old or newly set cookie
575: $cookie:name[value] for 90 days
576: $cookie:name[$.value[value] $.expires[VALUE] $.secure(true) $.domain[domain name] $.httponly(true)]
577: the expires field value can be 'session', a date, or a number of days (0days=forever)
578: if it's a date, it will be converted to "Sun, 25-Aug-2002 12:03:45 GMT"
1.257 moko 579: $cookie:fields
1.260 moko 580: hash with all cookies
1.252 moko 581:
582: request
583: $request:query
584: $request:uri
585: $request:document-root
1.260 moko 586: directory relative to which paths are considered in parser, default = $env:DOCUMENT_ROOT
1.257 moko 587: $request:argv
1.260 moko 588: hash with command-line parameters. keys 0, 1, ... [0 - name of the processed file]
1.252 moko 589: $request:charset
1.260 moko 590: the source document encoding
591: used in upper/lower and match[][i]
592: WARNING: you must set $request/response:charset before using form class fields
1.257 moko 593: $request:method
1.260 moko 594: request method (GET|POST|PUT)
1.257 moko 595: $request:body
1.260 moko 596: POST-request body as text
1.257 moko 597: $request:body-file
1.260 moko 598: POST-request body as a file
1.257 moko 599: $request:body-charset
1.260 moko 600: POST-request encoding
1.257 moko 601: $request:headers
1.260 moko 602: hash with request headers (without HTTP_ prefix)
1.252 moko 603:
604: response
1.260 moko 605: $response:field[value] and can read old - $response:field
606: the value can be string or hash:
607: $value[abc] field: {abc}<<part
608: $attribute[zzz] field: abc; {attribute=zzz}<<part
609: field or attribute value can be string or date
610: if date, it will be converted to "Sun, 25-Aug-2002 12:03:45 GMT"
1.259 moko 611: $response:headers
1.260 moko 612: accumulated fields
1.259 moko 613: $response:body[DATA]
1.260 moko 614: replaces the standard response
1.259 moko 615: $response:download[DATA]
1.260 moko 616: replaces the standard response, sets a flag causing the browser to suggest download
1.252 moko 617: $response:status
1.260 moko 618: ^response:clear[] forget all set response fields
1.252 moko 619: $response:charset
1.260 moko 620: client encoding, i.e.:
621: 1) from which $form: fields will be transcoded after retrieval from browser
622: 2) into which the document will be transcoded before sending to browser
623: 3) into which URI language text will be transcoded
624: does not add anything to content-type; if needed, do it manually
625: WARNING: you must set $request/response:charset before using form class fields
1.1 paf 626:
1.252 moko 627: regex
1.260 moko 628: in expression
629: logical value is always true
630: numerical value is equal to the number of bytes of the compiled pattern
631: ^regex::create[pattern-string|regex][[search options]]
632: ^pattern.size[]
633: number of bytes of the compiled pattern
634: if the value is very large - it is worth consulting pcre documentation and possibly rewriting the pattern
635: ^pattern.study_size[]
636: size of the study-structure. if == 0 - the pattern cannot be "studied"
637: $pattern.pattern
638: the text of the pattern
639: $pattern.options
640: the string with the original text of the options
1.252 moko 641:
1.255 moko 642: reflection
1.260 moko 643: ^reflection:create[class;constructor[;pa[;ra[;ms]]]]
644: calls the specified class constructor (no more than 100 parameters)
645: ^reflection:create[ $.class[name] $.constructor[name] $.arguments[ $.1[pa] $.2[ra] $.3[ms] ] ]
646: calls the specified class constructor
1.258 moko 647: ^reflection:classes[]
1.260 moko 648: a hash of all classes. key = class name, value can be methoded (a class with methods) or void
649: ^reflection:class[object]
650: the class of the given object
651: ^reflection:class_name[object]
652: the class name of the given object
653: ^reflection:base[object]
654: the parent class of the given object
655: ^reflection:base_name[object]
656: the parent class name of the given object
657: ^reflection:class_by_name[class name]
658: obtains the class by name
659: ^reflection:class_alias[class name;new class name]
660: sets an alias for the specified class
661: ^reflection:def[class;class name]
662: checks if the class exists
663: ^reflection:methods[class]
664: a hash with a list of methods of the specified class, values are strings 'native' or 'parser'
665: ^reflection:method[class or object;method name]
666: returns the junction-method of the class or object
667: ^reflection:filename[object or class or method]
668: returns the filename where the object, class or method is defined
669: ^reflection:fields[class or object]
670: a hash with the list of static fields of the specified class or dynamic fields of the specified object
671: ^reflection:fields_reference[object]
672: an editable hash of the dynamic fields of the specified object
673: ^reflection:field[class or object;field name]
674: returns the value of the specified field of the class or object. getters are ignored.
675: ^reflection:copy[source;destination]
676: copies fields from one object or class to another
677: ^reflection:uid[class or object]
678: returns the identifier of the object or class
679: ^reflection:method_info[class;method]
680: a hash with parameters of the specified class method
681: $.inherited[class] name of the class where the method was defined (returned only if the method was defined in an ancestor)
682: $.overridden[class] name of the class where the method was defined (returned only if the method was defined in an ancestor)
683: for native classes a hash is returned:
684: .min_params(minimum required number of parameters)
685: .max_params(maximum possible number of parameters)
1.252 moko 686: .call_type[dynamic|static|any]
1.260 moko 687: for parser classes a hash is returned:
688: key is parameter number (0, 1, ...), value is parameter name
1.258 moko 689: ^reflection:dynamical[[object or class, caller if absent]]
1.260 moko 690: returns true if the method was called from a dynamic context when passing
691: a parameter returns true if a dynamic object was passed, false if a class
692: ^reflection:delete[class or object;variable name]
693: deletes the variable with the specified name in the specified class or object
694: ^reflection:is[element name;class name][[context]]
695: analogous to the 'is' operator, allowing to determine if the element is code.
696: ^reflection:tainting[[language|tainted|optimized];string]
697: a string in which each character of the original string corresponds to a character with a transformation code
1.258 moko 698: ^reflection:stack[ $.args(false/true) $.locals(false/true) $.limit(n) $.offset(o)]
1.260 moko 699: the current state of the method call stack in the parser
700: ^reflection:mixin[source; $.to[target] $.name[name] $.methods(true/false) $.fields(true/false) $.overwrite(false/true)]
701: copies methods and fields from one class to another
1.220 misha 702:
1.252 moko 703: mail
704: $mail.received=MESSAGE:
1.51 paf 705: .from
706: .reply-to
707: .subject
1.260 moko 708: .date of class date
1.51 paf 709: .message-id
710: .raw[
1.260 moko 711: .RAW_USER_HEADER_FIELD
1.51 paf 712: ]
1.260 moko 713: $.{text|html|file#}[ << numbered as in mail:send (text, text2, ...) (file, file2, ...)
1.51 paf 714: $.content-type[
715: $.value[{text|...|x-unknown}/{plain|html|...|x-unknown}]
1.260 moko 716: [$.charset[windows-1251]] << in which it arrived, now already transcoded
717: $.USER_DEFINED_HEADER_FIELD
1.51 paf 718: ]
719: $.description
720: $.content-id
721: $.content-md5
722: $.content-location
723: .raw[
1.260 moko 724: .RAW_USER_HEADER_FIELD
1.51 paf 725: ]
1.260 moko 726: $.value[string|FILE]
1.51 paf 727: ]
1.52 paf 728: $.message#[MESSAGE] (message, message2, ...)
1.51 paf 729:
1.252 moko 730: ^mail:send[
1.230 misha 731: $.options[-odd]
1.260 moko 732: unix: a string that will be added to the sendmail startup command
733: -odd means "quickly put in the queue without email checking"
734: win32: ignored
735: $.charset[the encoding of the headers and text blocks]
1.252 moko 736: $.any-header-field
1.51 paf 737: $.text[string]
738: $.text[
1.260 moko 739: $.any-header-field
740: $.value[string]
1.51 paf 741: ]
742: $.html{string}
743: $.html[
1.252 moko 744: $.any-header-field
1.51 paf 745: $.value{string}
746: ]
747: $.file#[FILE]
748: $.file#[
1.252 moko 749: $.any-header-field
1.51 paf 750: $value[FILE]
751: ]
752: ]
1.260 moko 753: if charset is specified, the email is transcoded to this charset
754: content-type.charset does not affect transcoding
755: after the part name a # number can follow
1.252 moko 756:
757: ^mail:send[
1.260 moko 758: # by default, matches the source encoding.
759: # sets the body encoding
1.252 moko 760: $.charset[windows-1251]
1.260 moko 761: # no default
1.252 moko 762: $.content-type[$.value[text/plain] $.charset[windows-1251]]
1.260 moko 763: $.from["vasya" <vasya@design.ru>]
764: $.to["petya" <petya@design.ru>]
765: $.subject[subject]
1.252 moko 766: $.body[
1.260 moko 767: text
1.51 paf 768: ]
1.252 moko 769: ]
770:
1.260 moko 771: ^mail:send[$.header-field[] $.charset[mail encoding] $.body[if body is not a string, but a hash, a multipart email is sent]]
772: if charset is specified, the email is transcoded to that charset
773: content-type.charset does not affect transcoding
774: after the part name, an integer can follow, parts go in numerical order.
775: if body is a string, then it's just the email text, no attachments.
776: if body is a hash, then these are parts, text blocks first, then attachments
777: this is the old format, supported for backward compatibility
778: if the part name begins with "text", it's a text block.
779: if the part name begins with "file", it's an attachment, format:
1.253 moko 780: $file[$.format[uue|base64] $.value[DATA] $.name[user-file-name]]
1.260 moko 781: important: for multipart do not specify content-type
1.252 moko 782:
1.1 paf 783: ^mail:send[
1.260 moko 784: # by default, matches the source encoding
785: # sets the body encoding
1.252 moko 786: $.charset[windows-1251]
1.260 moko 787: # no default
1.1 paf 788: $.content-type[$.value[text/plain] $.charset[windows-1251]]
1.260 moko 789: $.from["vasya" <vasya@design.ru>]
790: $.to["petya" <petya@design.ru>]
791: $.subject[subject]
1.1 paf 792: $.body[
1.260 moko 793: text
1.1 paf 794: ]
795: ]
1.252 moko 796:
1.1 paf 797: ^mail:send[
1.260 moko 798: $.from["vasya" <vasya@design.ru>]
799: $.to["petya" <petya@design.ru>]
800: $.subject[subject]
1.1 paf 801: $.body[
802: $.text[
1.260 moko 803: # sets the body encoding
1.1 paf 804: $.charset[windows-1251]
1.260 moko 805: # no default
1.1 paf 806: $.content-type[$.value[text/plain] $.charset[windows-1251]]
1.260 moko 807: $.body[words]
1.1 paf 808: ]
1.260 moko 809: # for convenience you can specify only one part, then it won't be multipart
1.189 misha 810: $.file[
1.259 moko 811: $.value[^file::load[my beloved.doc]]
812: $.name[my beloved.doc]
813: $.format[base64]
1.1 paf 814: ]
1.189 misha 815: $.file2[
1.259 moko 816: $.value[^file::load[my beloved.doc]]
817: $.name[my beloved.doc]
818: ]
1.1 paf 819: ]
820: ]
1.260 moko 821: under unix, the program with arguments is used, set by
822: $MAIL.sendmail[command]
823: if not specified, checks if /usr/sbin/sendmail or
824: /usr/lib/sendmail is available and if so, runs with "-t".
1.252 moko 825:
1.260 moko 826: under Windows, SMTP protocol is used, server is set by
1.21 paf 827: $MAIL.SMTP[smtp.domain.ru]
1.1 paf 828:
1.252 moko 829: image
1.260 moko 830: $image[^image::measure[DATA[; $.exif(bool) $.xmp(bool) $.xmp-charset[] $.video(bool) ]]]
831: checks the file extension case-insensitively
832: can measure gif, jpg, tiff, bmp, webp and mp4 (mov)
833: $image.exif << hash after measure jpeg with exif information and $.exif(true)
1.259 moko 834: $image.exif.DateTime & co
1.260 moko 835: [full list see https://exiftool.org/TagNames/EXIF.html]
836: numbers as int/double,
837: dates as date,
838: enumerations as hash with keys 0..count-1
839: $image.src .width .height
840: $image.line-width number=line width
841: $image.line-style string=line style '*** * '='*** * *** * *** * '
842: ^image.html[[hash]]
1.257 moko 843: <img ...>
1.260 moko 844: ^image::load[background.gif]
845: only gif so far
846: ^image::create(width X;height Y[;background color default white]])
847: ^image.line(x0;y0;x1;y1;0xffFFff)
848: ^image.fill(x;y;0xffFFff)
849: ^image.rectangle(x0;y0;x1;y1;0xffFFff)
850: ^image.bar(x0;y0;x1;y1;0xffFFff)
851: ^image.replace(hex-color1;hex-color2)[table x:y polygon_vertices]
852: ^image.polyline(color)[table x:y points]
853: ^image.polygon(color)[table x:y polygon_vertices]
854: ^image.polybar(color)[table x;y polygon_vertices]
855: ^image.font[set_of_letters;font_file.gif][(space_width[;char_width])]
856: the character height = image height/number of letters in the set
857: if char_width is specified, then monospaced, if 0, char_width = gif width
858: ^image.font[set_of_letters;font_file.gif;
859: $.space(space_width) // default = gif width
860: $.width(char_width) // see above, default proportional
861: $.spacing(letter_spacing) // default = 1
1.252 moko 862: ]
1.260 moko 863: ^image.text(x;y)[text] AS_IS
864: ^image.length[text] AS_IS
865: ^image.gif[optional filename]
866: encodes to FILE with content-type=image/gif the filename will be used by $response:download
867: ^image.arc(center x;center y;width;height;start in degrees;end in degrees;color)
868: ^image.sector(center x;center y;width;height;start in degrees;end in degrees;color)
869: ^image.circle(center x;center y;r;color)
870: ^image.copy[source](src x;src y;src w;src h;dst x;dst y[;dest w[;dest h[;tolerance]]])
871: if dest_w/dest_h are specified, resizes the piece
872: when reducing size, does resample
873: only suitable for simplifying low-color graphics like charts/pie,
874: not suitable for thumbnails
875: if dest_h is not specified, aspect ratio is kept
876: tolerance - a number [square distance in RGB space to the target color],
877: defining how greedy the color approximation from the palette is [default=150]
878: smaller - more accurate but colors run out quickly
879: larger - less accurate approximation, but covers a bigger part
880: ^image.pixel(x;y)[(color)]
881: get or set pixel color
1.1 paf 882:
1.253 moko 883: file
1.260 moko 884: $uploaded_file_from_post.name
885: $uploaded_file_from_post.size
886: $uploaded_file_from_post.text
887: ^file.save[text|binary;filename[;$.charset[which charset to save in]]]
888: ^file:delete[filename]
889: ^file:find[filename][{if not found}]
890: ^file:list[path[;pattern-string|pattern-regex]]
891: table with columns name dir
892: ^file:list[path;$.filter[pattern-string|pattern-regex] $.stat(true)]
893: table with columns name dir size [mca]date
894: ^file::load[text|binary;big.zip[;domain_press_release_2001_03_01.zip][;options]]
895: ^file::create[text|binary;filename;data]
896: ^file::create[text|binary;filename;data[;$.charset[charset of the created file] $.content-type[...]]]
897: ^file::create[string-or-file-content[;$.name[name] $.mode[text|binary] $.content-type[...] $.charset[...]]]
898: $loaded_file.size
899: $loaded_or_created_file.mode = text/binary
900: ^file::stat[filename]
901: $stated_or_loaded_file.size .adate .mdate .cdate
902: ^file::cgi[[text|binary;]filename[;env hash +options[;1cmd[;2line[;3ar[;4g[;5s]]]]]]]
903: any argument can be string or array of strings
904: the returned header is split into $fields
1.1 paf 905: $status
906: $stderr
1.260 moko 907: ^file::exec[[text|binary;]filename[;env hash[;1cmd[;2line[;3ar[;4g[;5s;...under unix max 50 args]]]]]]]
908: any argument can be string or array of strings
1.95 paf 909: options:
1.260 moko 910: $.stdin[text|file] if empty, disables automatic passing of HTTP-POST data
911: ^file:move[oldfilename;newfilename]
912: can rename and move directories [win32: but not across disk boundaries]
913: directories for dest are created with 775 permissions
914: source directory is removed if empty after move
915: ^file:copy[filename;copy_filename[; $.append(1) ]]
916: can only copy files
917: ^file:lock[filename]{code}
918: the file is created if necessary
919: locked
920: code executed
921: unlocked
922: ^file:dirname[/a/some.tar.gz|file]=/a (works like *nix command)
923: ^file:dirname[/a/b/|file]=/a (works like *nix command)
924: ^file:basename[/a/some.tar.gz|file]=some.tar.gz (like *nix)
925: ^file:basename[/a/b/|file]=b (like *nix)
1.257 moko 926: ^file:justname[/a/some.tar.gz|file]=some.tar
927: ^file:justext[/a/some.tar.gz|file]=gz
1.253 moko 928: /some/page.html: ^file:fullpath[a.gif] => /some/a.gif
1.260 moko 929: ^file.sql-string[]
930: inside ^connect gives a correctly escaped string that can be used in queries
931: ^file::sql{query}[[ $.name[filename_for_download] $.content-type[user content-type] ]]
932: the query result should be "one row".
933: columns:
934: first column - data
935: if second exists - filename
936: if third - content-type
937: ^file.base64[ $.pad(bool) $.wrap(bool) $.url-safe(bool) ]
1.258 moko 938: encode
1.260 moko 939: ^file:base64[filename[; $.pad(bool) $.wrap(bool) $.url-safe(bool) ]]
1.230 misha 940: encode
1.260 moko 941: ^file::base64[encoded string[; $.pad(bool) $.strict(bool) $.url-safe(bool) ]]
1.258 moko 942: decode
1.260 moko 943: ^file::base64[mode;filename;encoded string[; $.content-type[...] $.pad(bool) $.strict(bool) $.url-safe(bool) ]]
1.230 misha 944: decode
1.260 moko 945: ^file:crc32[filename]
946: calculates crc32 of the specified file
947: ^file.crc32[]
948: calculates crc32 of the object
949: ^file.md5[], ^file:md5[filename]
950: returns the file's digest, 16 bytes as a string,
951: bytes in hex, contiguous, lowercase
1.1 paf 952:
1.253 moko 953: math
954: $math:PI
955: ^math:round floor ceiling
956: ^math:trunc frac
957: ^math:abs sign
1.256 moko 958: ^math:exp log log10
959: ^math:sin asin cos acos tan atan atan2
1.253 moko 960: ^math:degrees radians
961: ^math:pow sqrt
1.260 moko 962: ^math:random(range_width)
963: ^math:convert[number|file](base-from;base-to)[[ $.format[string|file] ]]
964: ^math:convert[number|file][alphabet](base-to)[[ $.format[string|file] ]]
965: ^math:convert[number|file](base-from)[alphabet][[ $.format[string|file] ]]
966: converts a string or file with a number from one numeral system to another
967: the numeral system can be set by an alphabet, a number from 2 to 16 (equivalent to the alphabet 0123456789ABCDEF), or 256 (all ASCII characters)
1.254 moko 968: ^math:uuid[ $.lower(bool) $.solid(bool) ]
1.113 paf 969: 22C0983C-E26E-4169-BD07-77ECE9405BA5
1.260 moko 970: win32: uses cryptapi
971: unix: uses /dev/urandom,
972: if not present, /dev/random,
973: if not, rand
1.256 moko 974: ^math:uuid7[ $.lower(bool) $.solid(bool) ]
975: 0193CBF0-7898-7000-A391-AC513CC15658
976: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7
1.254 moko 977: ^math:uid64[ $.lower(bool) ]
1.253 moko 978: BA39BAB6340BE370
979: ^math:md5[string]
1.260 moko 980: returns the digest of the string, 16 bytes as a string,
981: bytes in hex, contiguous, lowercase
1.253 moko 982: ^math:crypt[password;salt]
1.260 moko 983: salt prefix $apr1$ triggers built-in MD5 algorithm,
984: if salt body is empty, it is generated randomly
985: $1$ calls the OS 'crypt' MD5 algorithm if supported.
986: for other salts see OS 'crypt' documentation.
1.253 moko 987: ^math:crc32[string]
1.260 moko 988: calculates crc32 of the string
1.253 moko 989: ^math:sha1[string]
1.260 moko 990: ^math:digest[[md5|sha1|sha256|sha512];string or file][[ $.format[hex|base64|file] $.hmac[key string|key file] ]]
991: combines the ability to use various cryptographic hashing algorithms.
992: $.hmac[key] for verifying the integrity of transmitted data
1.253 moko 993:
994: inet
995: ^inet:ntoa(long)
996: ^inet:aton[IP]
1.257 moko 997: ^inet:name2ip[name][[ $.ipv[4|6|any] $.table(true) ]]
1.260 moko 998: direct conversion of a name to an IP address
999: ^inet:ip2name[ip][ $.ipv[4|6|any] ]
1000: reverse conversion from IP address to name
1.257 moko 1001: ^inet:hostname[]
1.260 moko 1002: host name
1.1 paf 1003:
1.252 moko 1004: json
1.260 moko 1005: ^json:parse[-json-string-[;
1006: $.depth(maximum depth, default == 19)
1007: $.double(false) disable built-in parsing of floating-point numbers (enabled by default)
1008: in this case they will appear in the resulting object as strings
1009: $.int(false) disable built-in parsing of integers (enabled by default)
1010: in this case they will appear in the resulting object as strings
1011: $.distinct[first|last|all] how duplicate keys in objects are handled
1012: first - keep the first encountered element
1013: last - keep the last encountered element
1014: all - keep all elements. starting from the 2nd,
1015: they get numeric suffixes (key_2 etc)
1016: by default duplicate keys cause an exception
1017: $.object[method-junction] user method[key;object], called for all parsed
1018: objects and object keys; method returns a new object
1019: $.array[method-junction] user method called for arrays
1020: $.taint[taint language] sets the transformation language for all result strings
1.231 misha 1021: ]]
1.260 moko 1022: parses a json-string into a hash
1.252 moko 1023:
1024: ^json:string[system or user object[;
1.260 moko 1025: $.skip-unknown(false) disable exception and output 'null' when serializing objects of types
1026: other than void, bool, string, int, double, date, table, hash, and file
1027: $.indent(true) format the resulting string with indentation according to nesting depth
1.259 moko 1028: $.date[sql-string|gmt-string|iso-string|unix-timestamp]
1.260 moko 1029: date output format, default = sql-string
1.259 moko 1030: $.table[object|array|compact]
1.260 moko 1031: format for tables, default=object
1.231 misha 1032: object: [{"c1":"v11","c2":"v12",...},{"c1":"v21","c2":"v22",...},...]
1033: array: [["c1","c2",...] || null (for nameless),["v11","v12",...],...]
1.260 moko 1034: compact: ["v11" || ["v11","v12",...],...]
1035: $.file[text|base64|stat] output file content in the specified mode (by default file content
1036: is not included in output)
1037: $.xdoc[hash] parameters for converting xdoc to string (as in ^xdoc.string[])
1038: $.type[method-junction] any type can be output using a user method
1039: that must take 3 parameters: key, object of that type, and options
1040: of the ^json:string[] call
1041: $._default[method] user method, called to output all user-class objects.
1042: The method must take 3 parameters: key, object, and call options.
1043: $._default[method name] method name of a user method, if present it will be called for serialization
1044: $.void[null|string] undefined value will be output as null (default)
1045: or as an empty string
1.231 misha 1046: ]]
1.260 moko 1047: serializes a system or user object into a json-string
1.231 misha 1048:
1.253 moko 1049: date
1.260 moko 1050: date type can be used in expressions, substituting the number of days since epoch [1 January 1970 (UTC)], fractional
1051: the string value is in local time, numerically in UTC, range from 0000-00-00 00:00:00 to 9999-12-31 23:59:59
1052: by default the OS-defined timezone is used
1.259 moko 1053:
1.253 moko 1054: ^date::now[]
1.260 moko 1055: ^date::now(days offset)
1056: returns now+offset
1.257 moko 1057: ^date::today[]
1.260 moko 1058: date at 00:00:00 of the current day
1059: ^date::today(integer days offset)
1060: date at 00:00:00 of current day+offset
1061: ^date::create(days since epoch)
1.253 moko 1062: ^date::create(year;month[;day[;hour[;minute[;second[;TZ]]]]])
1.260 moko 1063: ^date::create[date in format %Y-%m-%d %H:%M:%S]
1064: convenient creation from a value from a database
1065: format1: %Y[-%m[-%d[ %H[:%M[:%S]]]]]
1066: format2: %H:%M[:%S]
1067: ^date::create[date in format %Y-%m-%dT%H:%M[:%S]TZ]
1068: for creation from ISO 8601 format
1069: TZ format: Z(UTC) or +-hour[:minute] (offset from UTC)
1.253 moko 1070: ^date::unix-timestamp()
1.260 moko 1071: ^date.unix-timestamp[]
1072: $date.year month day hour minute second weekday yearday(0...) daylightsaving TZ weekyear
1073: TZ="" << local zone
1074: $date.year month day hour minute second can be set to new values, others are read-only
1075: ^date.double[] ^date.int[]
1076: the number of days since epoch [1 January 1970 (UTC)], fractional or truncated
1077: ^date.roll[year|month|day](+-offset)
1078: shifts the date
1079: ^date.roll[TZ;New zone]
1080: says that the date is in such a timezone: affects .hour & Co
1081: ^date:roll[TZ;New zone]
1082: says that by default all dates are in that timezone
1083: ^date.sql-string[[datetime|date|time]]
1084: datetime or without parameter - %Y-%m-%d %H:%M:%S
1085: date - %Y-%m-%d
1086: time - %H:%M:%S
1087: where published='^date.sql-string[]'
1088: ^date:calendar[rus|eng](year;month)
1089: returns an unnamed table, columns: 0..6, week, year
1090: ^date:calendar[rus|eng](year;month;day)
1091: returns a named table, columns: year, month, day, weekday
1092: ^date:last-day(year;month)
1093: returns the last day of the month
1094: ^date.last-day[]
1095: returns the last day of $date's month
1096: ^date.gmt-string[]
1.259 moko 1097: Fri, 23 Mar 2001 09:32:23 GMT
1.260 moko 1098: ^date.iso-string[]
1.259 moko 1099: 2001-03-23T12:32:23+03
1.205 misha 1100:
1.260 moko 1101: console
1102: $console:timeout
1103: $console:line
1104: read/write string
1105:
1106: memory
1107: ^memory:compact[]
1108: collect garbage, freeing space for new data (warning: process memory is never released)
1109: useful before XSL transform
1110: ^memory:auto-compact(frequency)
1111: sets automatic garbage collection frequency, from 0 (off) up to 5 (max)
1112:
1113: status
1114: $status:sql
1115: cache table
1116: url time
1117: url time
1118: url time
1119: $status:stylesheet
1120: cache table
1121: file time
1122: file time
1123: file time
1124: $status:rusage hash
1125: utime user time used
1126: stime system time used
1127: maxrss max resident set size
1128: ixrss integral shared text memory size
1129: idrss integral unshared data size
1130: isrss integral unshared stack size
1131: tv_sec
1132: tv_usec
1133: $s[$status:rusage]
1134: ^s.tv_sec.format[%.0f].^s.tv_usec.format[%06.0f]
1135: $status:memory hash
1136: used
1137: includes some pages that were allocated but never written
1138: free
1139: ever_allocated_since_compact
1140: return the number of bytes allocated since the last collection
1141: ever_allocated_since_start
1142: return the total number of bytes [EVER(c)PAF] allocated in this process,
1143: never decreases
1144: $status:pid
1145: process id
1146: $status:tid
1147: thread id
1148: $status:mode
1149: working mode, cgi|console|mail|httpd|apache|isapi
1150: $status:log-filename
1151: path to parser3.log error log
1152:
1.1 paf 1153: xdoc(xnode)
1.253 moko 1154: $xdoc.search-namespaces hash, where keys=prefixes, values=urls
1155:
1.1 paf 1156: DOM1 attributes:
1.253 moko 1157: readonly attribute DocumentType doctype
1158: readonly attribute Element documentElement
1.1 paf 1159:
1160: DOM1 methods:
1.253 moko 1161: Element createElement(in DOMString tagName)
1162: DocumentFragment createDocumentFragment()
1163: Text createTextNode(in DOMString data)
1164: Comment createComment(in DOMString data)
1165: CDATASection createCDATASection(in DOMString data)
1166: ProcessingInstruction createProcessingInstruction(in DOMString target,in DOMString data)
1167: Attr createAttribute(in DOMString name)
1168: EntityReference createEntityReference(in DOMString name)
1169: NodeList getElementsByTagName(in DOMString tagname)
1.1 paf 1170:
1171: DOM2 some methods:
1.253 moko 1172: ^.getElementById[elementId] = xnode
1173: The DOM implementation must have information that says which attributes are of type ID.
1174: Attributes with the name "ID" are not of type ID unless so defined.
1175: Implementations that do not know whether attributes are of type ID or not
1.1 paf 1176: are expected to return null.
1177:
1.260 moko 1178: String encoding and default for $.encoding equals the current output page encoding, $response:charset
1.259 moko 1179:
1.1 paf 1180: ::sql{...}
1.260 moko 1181: ::create[[URI]]{<?xml?><string/>} old name 'set'
1.253 moko 1182: ::create[[URI]][qualifiedName]
1.260 moko 1183: URI default = disk path to requested document
1184: for directories a trailing / is mandatory
1.253 moko 1185: ::create[file] can be usable:
1186: $f[^file::load[binary;http://;some HTTP options here...]]
1187: $x[^xdoc::create[$f]]
1.260 moko 1188: ::load[file.xml[;options]]
1189: .transform[rules.xsl|xdoc][[params hash]] returns dom
1190: the template is cached, cache is updated if the template file date changes,
1191: or the date of "template_name.stamp" changes [stamp date check has priority]
1.1 paf 1192: <xsl:output
1.253 moko 1193: method = "xml" | "html" | "text"
1.259 moko 1194: version = nmtoken
1195: encoding = string
1.253 moko 1196: omit-xml-declaration = "yes" | "no"
1197: standalone = "yes" | "no"
1.259 moko 1198: cdata-section-elements = qnames
1.253 moko 1199: indent = "yes" | "no"
1.259 moko 1200: media-type = string />
1.260 moko 1201: parameters are passed as is, not xpath expressions
1.253 moko 1202:
1203: .string[[output options]]
1.260 moko 1204: .save[file.xml[;output options]] with header
1.253 moko 1205: .file[[output options]] = file
1.260 moko 1206: output options are identical to xsl:output attributes
1207: [exception: cdata-section-elements ignored]
1208: returns media-type when substituting $response:body[here]
1.1 paf 1209:
1.260 moko 1210: if the document is referenced as:
1.253 moko 1211: parser://method/param/to/that/method
1.260 moko 1212: then ^MAIN:method[/param/to/that/method] is used as the document
1213: [note: the parameter always comes with a leading /, even if there were no parameters]
1.144 paf 1214:
1.253 moko 1215: xnode
1.1 paf 1216: DOM1 attributes:
1.253 moko 1217: $node.nodeName
1218: $node.nodeValue
1219: read
1220: write
1221: $node.nodeType = int
1222: ELEMENT_NODE = 1
1223: ATTRIBUTE_NODE = 2
1224: TEXT_NODE = 3
1225: CDATA_SECTION_NODE = 4
1226: ENTITY_REFERENCE_NODE = 5
1227: ENTITY_NODE = 6
1228: PROCESSING_INSTRUCTION_NODE = 7
1229: COMMENT_NODE = 8
1230: DOCUMENT_NODE = 9
1231: DOCUMENT_TYPE_NODE = 10
1232: DOCUMENT_FRAGMENT_NODE = 11
1233: NOTATION_NODE = 12
1.1 paf 1234: $vasyaNode.type==$xnode:ELEMENT_NODE
1.253 moko 1235: $node.parentNode
1236: $node.childNodes = array of nodes
1237: $node.firstChild
1238: $node.lastChild
1239: $node.previousSibling
1240: $node.nextSibling
1241: $node.ownerDocument = xdoc
1242: $node.prefix
1243: $node.namespaceURI
1244: $element_node.attributes = hash of xnodes
1245: $element_node.tagName
1246: $attribute_node.specified = boolean
1247: true if the attribute received its value explicitly in the XML document,
1.259 moko 1248: or if a value was assigned programmatically with the setValue function.
1.253 moko 1249: false if the attribute value came from the default value declared in the document's DTD.
1250: $attribute_node.name
1251: $attribute_node.value
1.1 paf 1252: $text_node/cdata_node/comment_node.substringData
1.253 moko 1253: $pi_node.target = target of this processing instruction
1.259 moko 1254: XML defines this as the first token following the markup
1.1 paf 1255: that begins the processing instruction.
1.253 moko 1256: $pi_node.data = The content of this processing instruction
1.259 moko 1257: From the first non-whitespace character after the target
1.253 moko 1258: to the character immediately preceding the ?>.
1.1 paf 1259: document_node.
1260: readonly attribute DocumentType doctype
1.253 moko 1261: readonly attribute DOMImplementation implementation
1.1 paf 1262: readonly attribute Element documentElement
1263: document_type_node.
1.253 moko 1264: readonly attribute DOMString name
1.1 paf 1265: readonly attribute NamedNodeMap entities
1266: readonly attribute NamedNodeMap notations
1.253 moko 1267: notation_node.
1268: readonly attribute DOMString publicId
1269: readonly attribute DOMString systemId
1270:
1271: DOM1 node methods:
1272: Node insertBefore(in Node newChild,in Node refChild)
1273: Node replaceChild(in Node newChild,in Node oldChild)
1274: Node removeChild(in Node oldChild)
1275: Node appendChild(in Node newChild)
1276: boolean hasChildNodes()
1277: Node cloneNode(in boolean deep)
1278:
1279: DOM1 element methods:
1280: DOMString getAttribute(in DOMString name)
1281: void setAttribute(in DOMString name, in DOMString value) raises(DOMException)
1282: void removeAttribute(in DOMString name) raises(DOMException)
1283: Attr getAttributeNode(in DOMString name)
1284: Attr setAttributeNode(in Attr newAttr) raises(DOMException)
1285: Attr removeAttributeNode(in Attr oldAttr) raises(DOMException)
1286: NodeList getElementsByTagName(in DOMString name)
1287: void normalize()
1288:
1289: Introduced in DOM Level 2:
1290: Node importNode(in Node importedNode, in boolean deep) raises(DOMException)
1291: NodeList getElementsByTagNameNS(in DOMString namespaceURI, in DOMString localName)
1292: boolean hasAttributes()
1.1 paf 1293:
1.253 moko 1294: XPath:
1.260 moko 1295: ^node.select[xpath/query/expression] = array of nodes,
1.21 paf 1296: empty array if nothing found
1.253 moko 1297: ^node.selectSingle[xpath/query/expression] = first node if any
1298: ^node.selectBool[xpath/query/expression] = bool if any or die
1299: ^node.selectNumber[xpath/query/expression] = double if any or die
1300: ^node.selectString[xpath/query/expression] = string if any or die
1.1 paf 1301:
1.176 paf 1302: DATA::=string | file | hash
1.260 moko 1303: hash of the form
1.253 moko 1304: [
1.260 moko 1305: $.file[filename on disk]
1306: $.name[filename for user]
1.253 moko 1307: $.mdate[date]
1308: ]
1309:
1310: MAIN
1.260 moko 1311: this is the class automatically loaded from the configuration auto.p, a bunch of auto.p and the requested document:
1312: configuration auto.p
1.253 moko 1313: cgi:
1.260 moko 1314: 1. either full path from environment variable CGI_PARSER_SITE_CONFIG or next to parser binary
1.1 paf 1315: isapi: windows directory
1.253 moko 1316: apache module:
1.43 paf 1317: 1) ParserConfig [can be in .htaccess]
1.260 moko 1318: auto.p goes down from DOCUMENT_ROOT/ through the directory tree to the directory of the processed file, inclusive
1319: the class is assembled from all these files, subsequent ones become parents of the previous ones
1320: the name of the last loaded is MAIN, previous ones have no names
1321:
1322: after loading MAIN class, its @main[] is called
1323: the result is passed to its @postprocess[data] if($data is string) ...
1324: the result is then returned to the user
1.253 moko 1325:
1.260 moko 1326: if an error occurs and try is not specified, it can be nicely reported to the user by defining
1.253 moko 1327: @unhandled_exception[exception;stack]
1.260 moko 1328: $exception.type string "type of problem"
1329: $exception.file $exception.lineno $exception.colno file, line and position where the problem occurred [if not disabled at compile time]
1330: $exception.source line that caused the problem
1331: $exception.comment English comment
1332: stack table with columns file line name,
1333: in reverse order the names[name] and places[file line] of the operators/methods that caused the error.
1.253 moko 1334:
1.260 moko 1335: when loading a file (file::load, table::load, xdoc::load) you can specify such a filename:
1.253 moko 1336: http://domain/document[?params<<deprecated, use $.form[...]]
1.260 moko 1337: and possibly specify options:
1.253 moko 1338: $.method[GET|POST|HEAD]
1.260 moko 1339: $.timeout(3) << in seconds, default=2
1.253 moko 1340: $.cookies[
1.260 moko 1341: $.name[value]
1.253 moko 1342: ]
1343: $.headers[
1.260 moko 1344: $.field[value] << value format like $response:HEADER
1.253 moko 1345: ]
1.166 paf 1346: $.enctype[multipart/form-data]
1347: $.form[
1.253 moko 1348: $.field1[string]
1349: $.field2[^table::create{one_column_only^#0Avalue1^#0Avalue2}]
1.166 paf 1350: $.field3[file]
1351: ]
1.253 moko 1352: $.body[string|file]
1.260 moko 1353: default user-agent=parser3
1354: by default, getting http status != 200 >> creates http.status error, can be disabled by $.any-status(1)
1355: $.charset[default encoding of remote documents], if server returns content-type:charset - IT OVERRIDES
1356: $.response-charset[encoding of remote documents], not overridden by content-type:charset
1357: $.user[user]
1358: $.password[password]
1359: file::load writes additional fields
1360: FIELD:value (response field names in uppercase)
1361: tables << a hash of FIELD->table with a single column "value"
1362: in such tables you can get repeating headers, e.g. multiple set-cookies
1363: todo: make separate cookies
1364:
1365: system error types:
1366: parser.compile ^test[} compilation (unmatched bracket, ...)
1367: parser.runtime ^if(0). parameters (more/less than needed, wrong types, ...)
1.253 moko 1368: number.zerodivision ^eval(1/0) ^eval(1%0)
1369: number.format ^eval(abc*5)
1370: file.lock shared/exclusive lock error
1371: file.missing ^file:delete[delme] not found
1372: file.access ^table::load[.] no rights
1373: file.read ^file::load[...] error while reading file
1374: file.seek seek failed
1375: file.execute ^file::cgi[...] incorrect cgi header/can't execute
1376: image.format ^image::measure[index.html] not gif/jpg
1377: sql.connect ^connect[mysql://baduser:pass@host/db]{} not found/timeout
1378: sql.execute ^void:sql{select bad} syntax error
1.57 paf 1379: sql.duplicate
1380: sql.access
1381: sql.missing
1.253 moko 1382: xml ^xdoc::create{<forgot?>} any error in xml/xslt libs
1383: smtp.connect not found/timeout
1384: smtp.execute communication error
1.259 moko 1385: email.format hren tam@null.ru wrong email format (bad chars/empty)
1.253 moko 1386: email.send $MAIL.sendmail[/shit] sendmail not executable
1387: http.host ^file::load[http://notfound/there] host not found
1.259 moko 1388: http.connect ^file::load[http://not_accepting/there] host found, but does not accept connections
1389: http.timeout ^file::load[http://host/doc] load operation failed to complete in # seconds
1.253 moko 1390: http.response ^file::load[http://ok/there] host found, connection accepted, bad answer
1391: http.status ^file::load[http://ok/there] host found, connection accepted, status!=200
1392: date.range ^date::create(10000;1;1) date out of valid range
1.213 misha 1393:
1.260 moko 1394: if $SIGPIPE(1) is defined in MAIN, then if processing was interrupted by the user, a message
1395: about this is written to parser3.log
1.197 misha 1396:
1.260 moko 1397: if the method description explicitly contains the local variable result (there is also an implicit variable),
1398: then the code for outputting whitespace literals does not get into the final bytecode
1.261 ! moko 1399:
! 1400: $Id: operators.txt,v 1.58 2024/11/04 04:37:43 moko Exp $
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to operators.txt CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3