OpenEuphoria

8.47 Euphoria Information

8.47.1 Build Type Constants

8.47.1.1 is_developmental

include euphoria/info.e
namespace info
public constant is_developmental

Is this build a developmental build?

8.47.1.2 is_release

include euphoria/info.e
namespace info
public constant is_release

Is this build a release build?

8.47.2 Numeric Version Information

8.47.3 Compiled Platform Information

8.47.3.1 platform_name

include euphoria/info.e
namespace info
public function platform_name()

Get the platform name

Returns:

A sequence, containing the platform name, i.e. Windows, Linux, FreeBSD or OS X.

8.47.3.2 version

include euphoria/info.e
namespace info
public function version()

Get the version, as an integer, of the host Euphoria

Returns:

An integer, representing Major, Minor and Patch versions. Version 4.0.0 will return 40000, 4.0.1 will return 40001, 5.6.2 will return 50602, 5.12.24 will return 512624, etc...

8.47.3.3 version_major

include euphoria/info.e
namespace info
public function version_major()

Get the major version of the host Euphoria

Returns:

An integer, representing the Major version number. Version 4.0.0 will return 4, version 5.6.2 will return 5, etc...

8.47.3.4 version_minor

include euphoria/info.e
namespace info
public function version_minor()

Get the minor version of the hosting Euphoria

Returns:

An integer, representing the Minor version number. Version 4.0.0 will return 0, 4.1.0 will return 1, 5.6.2 will return 6, etc...

8.47.3.5 version_patch

include euphoria/info.e
namespace info
public function version_patch()

Get the patch version of the hosting Euphoria

Returns:

An integer, representing the Path version number. Version 4.0.0 will return 0, 4.0.1 will return 1, 5.6.2 will return 2, etc...

8.47.3.6 version_node

include euphoria/info.e
namespace info
public function version_node(integer full = 0)

Get the source code node id of the hosting Euphoria

Parameters:

• full - If TRUE, the full node id is returned. If FALSE only the first 12 characters of the node id is returned. Typically the short node id is considered unique.

Returns:

A text sequence, containing the source code management systems node id that globally identifies the executing Euphoria.

8.47.3.7 version_revision

include euphoria/info.e
namespace info
public function version_revision()

Get the source code revision of the hosting Euphoria

Returns:

A text sequence, containing the source code management systems revision number that the executing Euphoria was built from.

8.47.3.8 version_date

include euphoria/info.e
namespace info
public function version_date(integer full = 0)

Get the compilation date of the hosting Euphoria

Parameters:

• full - Standard return value is a string formatted as CCYY-MM-DD. However, if this is a development build or the full parameter is TRUE (1), then the result will be formatted as CCYY-MM-DD HH:MM:SS.

Returns:

A text sequence containing the commit date of the the associated SCM revision.

The date/time is UTC.

8.47.4 String Version Information

8.47.4.1 version_type

include euphoria/info.e
namespace info
public function version_type()

Get the type version of the hosting Euphoria

Returns:

A sequence, representing the Type version string. Version 4.0.0 alpha 1 will return alpha 1. 4.0.0 beta 2 will return beta 2. 4.0.0 final, or release, will return release.

8.47.4.2 version_string

include euphoria/info.e
namespace info
public function version_string(integer full = 0)

Get a normal version string

Parameters:

1. full - Return full version information regardless of developmental/production status.

Returns:

A #sequence, representing the entire version information in one string. The amount of detail you get depends on if this version of Euphoria has been compiled as a developmental version (more detailed version information) or if you have indicated TRUE for the full argument.

Example return values

• "4.0.0 alpha 3 (ab8e98ab3ce4,2010-11-18)"
• "4.0.0 release (8d8874dc9e0a, 2010-12-22)"
• "4.1.5 development (12332:e8d8787af7de, 2011-07-18 12:55:03)"

8.47.4.3 version_string_short

include euphoria/info.e
namespace info
public function version_string_short()

Get a short version string

Returns:

A sequence, representing the Major, Minor and Patch all in one string.

Example return values:

• "4.0.0"
• "4.0.2"
• "5.6.2"

8.47.4.4 version_string_long

include euphoria/info.e
namespace info
public function version_string_long(integer full = 0)

Get a long version string

Parameters:

1. full - Return full version information regardless of developmental/production status.

Returns:

A #sequence, representing the entire version information in one string. The amount of detail you get depends on if this version of Euphoria has been compiled as a developmental version (more detailed version information) or if you have indicated TRUE for the full argument.

Example return values

• "4.0.0 alpha 3 (ab8e98ab3ce4,2010-11-18) for Windows"
• "4.0.0 release (8d8874dc9e0a, 2010-12-22) for Linux"
• "4.1.5 development (12332:e8d8787af7de, 2011-07-18 12:55:03) for OS X"

8.47.5 Copyright Information

8.47.5.1 euphoria_copyright

include euphoria/info.e
namespace info
public function euphoria_copyright()

Get the copyright statement for Euphoria

Returns:

A sequence, containing 2 sequences: product name and copyright message

Example 1:

sequence info = euphoria_copyright()
-- info = {
--     "Euphoria v4.0.0 alpha 3",
--     "Copyright (c) XYZ, ABC\n" &
--     "Copyright (c) ABC, DEF"
-- }

8.47.5.2 pcre_copyright

include euphoria/info.e
namespace info
public function pcre_copyright()

Get the copyright statement for PCRE.

Returns:

A sequence, containing 2 sequences: product name and copyright message.

See Also:

euphoria_copyright()

8.47.5.3 all_copyrights

include euphoria/info.e
namespace info
public function all_copyrights()

Get all copyrights associated with this version of Euphoria.

Returns:

A sequence, of product names and copyright messages.

{
    { ProductName, CopyrightMessage },
    { ProductName, CopyrightMessage },
    ...
}

8.47.6 Timing Information

8.47.6.1 start_time

include euphoria/info.e
namespace info
public function start_time()

Euphoria start time.

This time represents the time Euphoria itself started. This time is recorded before any of the users code is opened, parsed or executed. It can provide accurate timing information as to how long it takes for your application to go from start time to usable time.

Returns:

An atom representing the start time of Euphoria itself

8.47.7 Configure Information

8.47.7.1 include_paths

<built-in> function include_paths(integer convert)

Returns the list of include paths, in the order in which they are searched

Parameters:

1. convert : an integer, nonzero to include converted path entries that were not validated yet.

Returns:

A sequence, of strings, each holding a fully qualified include path.

Comments:

convert is checked only under Windows. If a path has accented characters in it, then it may or may not be valid to convert those to the OEM code page. Setting convert to a nonzero value will force conversion for path entries that have accents and which have not been checked to be valid yet. The extra entries, if any, are returned at the end of the returned sequence.

The paths are ordered in the order they are searched:

1. current directory
2. configuration file,
3. command line switches,
4. EUINC
5. a default based on EUDIR.

Example 1:

sequence s = include_paths(0)
-- s might contain
{
  "/usr/euphoria/tests",
  "/usr/euphoria/include",
  "./include",
  "../include"
}

See Also:

eu.cfg, include, option_switches