Global functions

Table of Contents

1. New global functions in Rebol 2.5.6.3.1 (from 2.3.0.3.1)
      1.1. alter
      1.2. attempt
      1.3. build-attach-body
      1.4. build-markup
      1.5. component?
      1.6. construct
      1.7. context
      1.8. create-link
      1.9. decloak
      1.10. decode-url
      1.11. dispatch
      1.12. dump-obj
      1.13. eighth
      1.14. encloak
      1.15. extract
      1.16. free-boot
      1.17. get-env
      1.18. get-modes
      1.19. has
      1.20. link-app?
      1.21. link?
      1.22. maximum-of
      1.23. minimum-of
      1.24. native
      1.25. ninth
      1.26. remove-each
      1.27. run
      1.28. set-browser-path
      1.29. set-modes
      1.30. set-user-name
      1.31. seventh
      1.32. sign?
      1.33. sixth
      1.34. stats
      1.35. suffix?
      1.36. tenth
      1.37. to-action
      1.38. to-any-block
      1.39. to-any-function
      1.40. to-any-string
      1.41. to-any-type
      1.42. to-any-word
      1.43. to-context
      1.44. to-datatype
      1.45. to-end
      1.46. to-error
      1.47. to-function
      1.48. to-library
      1.49. to-local-file
      1.50. to-native
      1.51. to-number
      1.52. to-object
      1.53. to-op
      1.54. to-port
      1.55. to-rebol-file
      1.56. to-routine
      1.57. to-series
      1.58. to-struct
      1.59. to-symbol
      1.60. to-unset
2. Lost global functions in Rebol 2.5.6.3.1 (from 2.3.0.3.1)
      2.1. decode-cgi-query

1. New global functions in Rebol 2.5.6.3.1 (from 2.3.0.3.1)

1.1. alter

USAGE:

ALTER series value

DESCRIPTION:

If a value is not found in a series, append it; otherwise, remove it. 
ALTER is a function value.

ARGUMENTS:

series -- (Type: series port)
value -- (Type: any)

1.2. attempt

USAGE:

ATTEMPT value

DESCRIPTION:

Tries to evaluate and returns result or NONE on error. 
ATTEMPT is a function value.

ARGUMENTS:

value -- (Type: any)

1.3. build-attach-body

USAGE:

BUILD-ATTACH-BODY body files boundary

DESCRIPTION:

Return an email body with attached files. 
BUILD-ATTACH-BODY is a function value.

ARGUMENTS:

body -- The message body (Type: string)
files -- List of files to send [%file1.r [%file2.r "data"]] (Type: block)
boundary -- The boundary divider (Type: string)

1.4. build-markup

USAGE:

BUILD-MARKUP content /quiet

DESCRIPTION:

Return markup text replacing <%tags%> with their evaluated results. 
BUILD-MARKUP is a function value.

ARGUMENTS:

content -- (Type: string file url)

REFINEMENTS:

/quiet -- Do not show errors in the output.

1.5. component?

USAGE:

COMPONENT? name

DESCRIPTION:

Returns specific REBOL component info if enabled. 
COMPONENT? is a function value.

ARGUMENTS:

name -- (Type: word)

1.6. construct

USAGE:

CONSTRUCT block /with object

DESCRIPTION:

Creates an object, but without evaluating its specification. 
CONSTRUCT is a native value.

ARGUMENTS:

block -- Object specification block (Type: block)

REFINEMENTS:

/with -- Provide a default base object
    object -- (Type: object)

1.7. context

USAGE:

CONTEXT blk

DESCRIPTION:

Defines a unique (underived) object. 
CONTEXT is a function value.

ARGUMENTS:

blk -- Object variables and values. (Type: block)

1.8. create-link

USAGE:

CREATE-LINK source dest /start dir /note desc /args arg-str

DESCRIPTION:

Creates file links. 
CREATE-LINK is a native value.

ARGUMENTS:

source -- File to link to (Type: string file)
dest -- Name for new link (Type: string file)

REFINEMENTS:

/start
    dir -- Directory to start in (Windows) (Type: string file)
/note
    desc -- Link description text (Windows) (Type: string)
/args
    arg-str -- Provide command arguments (Type: string none)

1.9. decloak

USAGE:

DECLOAK data key /with

DESCRIPTION:

Descrambles the string scrambled by encloak. 
DECLOAK is a native value.

ARGUMENTS:

data -- String to descramble (modified) (Type: any-string)
key -- Key to use (Type: any-string)

REFINEMENTS:

/with -- Use key as-is (for speed, no hashing)

1.10. decode-url

USAGE:

DECODE-URL url

DESCRIPTION:

Decode a URL into an object. 
DECODE-URL is a function value.

ARGUMENTS:

url -- (Type: any)

1.11. dispatch

USAGE:

DISPATCH port-block

DESCRIPTION:

Wait for a block of ports. As events happen, dispatch port handler blocks. 
DISPATCH is a function value.

ARGUMENTS:

port-block -- Block of port handler pairs (port can be timeout too). (Type: block)

1.12. dump-obj

USAGE:

DUMP-OBJ obj /match pat

DESCRIPTION:

Returns a block of information about an object. 
DUMP-OBJ is a function value.

ARGUMENTS:

obj -- (Type: object)

REFINEMENTS:

/match -- Include only those that match a string or datatype
    pat -- (Type: any)

1.13. eighth

USAGE:

EIGHTH series

DESCRIPTION:

Returns the eight value of a series. 
EIGHTH is an action value.

ARGUMENTS:

series -- (Type: series port tuple)

1.14. encloak

USAGE:

ENCLOAK data key /with

DESCRIPTION:

Scrambles a string or binary based on a key. 
ENCLOAK is a native value.

ARGUMENTS:

data -- String to scramble (modified) (Type: any-string)
key -- Key to use (Type: any-string)

REFINEMENTS:

/with -- Use key as-is (for speed, no hashing)

1.15. extract

USAGE:

EXTRACT block width /index pos

DESCRIPTION:

Extracts a value from a series at regular intervals. 
EXTRACT is a function value.

ARGUMENTS:

block -- (Type: block hash)
width -- Size of each entry (the skip) (Type: integer)

REFINEMENTS:

/index -- Extract from an offset position
    pos -- The position (Type: any)

1.16. free-boot

USAGE:

FREE-BOOT

DESCRIPTION:

Called by any code that takes over bootstrap. 
FREE-BOOT is a function value.

1.17. get-env

USAGE:

GET-ENV var

DESCRIPTION:

Gets the value of an operating system environment variable. 
GET-ENV is a native value.

ARGUMENTS:

var -- Variable to lookup (Type: string)

1.18. get-modes

USAGE:

GET-MODES target modes

DESCRIPTION:

Returns mode settings for a port. 
GET-MODES is a native value.

ARGUMENTS:

target -- (Type: file url block port)
modes -- (Type: word block)

1.19. has

USAGE:

HAS locals body

DESCRIPTION:

A shortcut to define a function that has local variables but no arguments. 
HAS is a function value.

ARGUMENTS:

locals -- (Type: block)
body -- (Type: block)

1.20. link-app?

USAGE:

LINK-APP?

DESCRIPTION:

Tell whether a script is running under a Link application context. 
LINK-APP? is a function value.

1.21. link?

USAGE:

LINK?

DESCRIPTION:

Returns true if REBOL/Link capability is enabled. 
LINK? is a function value.

1.22. maximum-of

USAGE:

MAXIMUM-OF series /skip size /case

DESCRIPTION:

Finds the largest value in a series 
MAXIMUM-OF is a native value.

ARGUMENTS:

series -- Series to search (Type: series)

REFINEMENTS:

/skip -- Treat the series as records of fixed size
    size -- (Type: integer)
/case -- Perform case-sensitive comparisons

1.23. minimum-of

USAGE:

MINIMUM-OF series /skip size /case

DESCRIPTION:

Finds the smallest value in a series 
MINIMUM-OF is a native value.

ARGUMENTS:

series -- Series to search (Type: series)

REFINEMENTS:

/skip -- Treat the series as records of fixed size
    size -- (Type: integer)
/case -- Perform case-sensitive comparisons

1.24. native

USAGE:
NATIVE spec
DESCRIPTION:
(undocumented)
ARGUMENTS:
spec -- (Type: block)

1.25. ninth

USAGE:

NINTH series

DESCRIPTION:

Returns the ninth value of a series. 
NINTH is an action value.

ARGUMENTS:

series -- (Type: series port tuple)

1.26. remove-each

USAGE:

REMOVE-EACH 'word data body

DESCRIPTION:

Removes a value from a series for each block that returns TRUE. 
REMOVE-EACH is a native value.

ARGUMENTS:

word -- Word or block of words to set each time (will be local) (Type: get-word word block)
data -- The series to traverse (Type: series)
body -- Block to evaluate. Return TRUE to remove. (Type: block)

1.27. run

USAGE:

RUN file /as suffix

DESCRIPTION:

Runs the system application associated with a file. 
RUN is a native value.

ARGUMENTS:

file -- The file to open (file, URL) or command to run (string). (Type: file url string)

REFINEMENTS:

/as
    suffix -- (Type: string file)

1.28. set-browser-path

USAGE:

SET-BROWSER-PATH value

DESCRIPTION:

Path to default web browser. 
SET-BROWSER-PATH is a native value.

ARGUMENTS:

value -- The shell call string (Type: any-string)

1.29. set-modes

USAGE:

SET-MODES target modes

DESCRIPTION:

Changes mode settings for a port. 
SET-MODES is a native value.

ARGUMENTS:

target -- (Type: file url block port)
modes -- (Type: block)

1.30. set-user-name

USAGE:
SET-USER-NAME str
DESCRIPTION:
(undocumented)
ARGUMENTS:
str -- (Type: string)

1.31. seventh

USAGE:

SEVENTH series

DESCRIPTION:

Returns the seventh value of a series. 
SEVENTH is an action value.

ARGUMENTS:

series -- (Type: series port tuple event)

1.32. sign?

USAGE:

SIGN? number

DESCRIPTION:

Returns sign of number as 1, 0, or -1 (to use as multiplier). 
SIGN? is a function value.

ARGUMENTS:

number -- (Type: number money time)

1.33. sixth

USAGE:

SIXTH series

DESCRIPTION:

Returns the sixth value of a series. 
SIXTH is an action value.

ARGUMENTS:

series -- (Type: series port tuple event)

1.34. stats

USAGE:

STATS /pools /types /series /frames /recycle

DESCRIPTION:

System statistics.  Default is to return total memory used. 
STATS is a native value.

REFINEMENTS:

/pools -- Returns: width units free-units units-per-alloc segments mem-in-use
/types -- Returns: Datatype count
/series -- Returns: total blocks strings other avail free expansions
/frames -- Returns: total used unused free values-total
/recycle -- Returns: count series-total series-last frames-total frames-last ballast

1.35. suffix?

USAGE:

SUFFIX? path

DESCRIPTION:

Return the suffix (ext) of a filename or url, else NONE. 
SUFFIX? is a function value.

ARGUMENTS:

path -- (Type: any-string)

1.36. tenth

USAGE:

TENTH series

DESCRIPTION:

Returns the tenth value of a series. 
TENTH is an action value.

ARGUMENTS:

series -- (Type: series port tuple)

1.37. to-action

USAGE:
TO-ACTION value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.38. to-any-block

USAGE:
TO-ANY-BLOCK value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.39. to-any-function

USAGE:
TO-ANY-FUNCTION value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.40. to-any-string

USAGE:
TO-ANY-STRING value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.41. to-any-type

USAGE:
TO-ANY-TYPE value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.42. to-any-word

USAGE:
TO-ANY-WORD value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.43. to-context

USAGE:
TO-CONTEXT value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.44. to-datatype

USAGE:
TO-DATATYPE value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.45. to-end

USAGE:
TO-END value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.46. to-error

USAGE:
TO-ERROR value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.47. to-function

USAGE:
TO-FUNCTION value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.48. to-library

USAGE:
TO-LIBRARY value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.49. to-local-file

USAGE:

TO-LOCAL-FILE path

DESCRIPTION:

Converts a REBOL file path to the local system file path. 
TO-LOCAL-FILE is a native value.

ARGUMENTS:

path -- (Type: file string)

1.50. to-native

USAGE:
TO-NATIVE value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.51. to-number

USAGE:
TO-NUMBER value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.52. to-object

USAGE:
TO-OBJECT value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.53. to-op

USAGE:
TO-OP value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.54. to-port

USAGE:
TO-PORT value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.55. to-rebol-file

USAGE:

TO-REBOL-FILE path

DESCRIPTION:

Converts a local system file path to a REBOL file path. 
TO-REBOL-FILE is a native value.

ARGUMENTS:

path -- (Type: file string)

1.56. to-routine

USAGE:
TO-ROUTINE value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.57. to-series

USAGE:
TO-SERIES value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.58. to-struct

USAGE:
TO-STRUCT value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.59. to-symbol

USAGE:
TO-SYMBOL value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)

1.60. to-unset

USAGE:
TO-UNSET value
DESCRIPTION:
(undocumented)
ARGUMENTS:
value -- (Type: any)