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