Library Reference

version 2.112.0

Internal API

If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page.Requires a signed-in GitHub account. This works well for small changes.If you'd like to make larger changes you may want to consider usinga local clone.

core.runtime

The runtime module exposes information specific to the D runtime code.

License:

Boost License 1.0

Authors:

Sean Kelly

Sourcecore/runtime.d

Documentationhttps://dlang.org/phobos/core_runtime.html

void*rt_loadLibrary(const char*name);

C interface for Runtime.loadLibrary

intrt_unloadLibrary(void*ptr);

C interface for Runtime.unloadLibrary, returns 1/0 instead of bool

intrt_init();

C interface for Runtime.initialize, returns 1/0 instead of bool

intrt_term();

C interface for Runtime.terminate, returns 1/0 instead of bool

structUnitTestResult;

This type is returned by the module unit test handler to indicate testing results.

size_texecuted;: Number of modules which were tested
size_tpassed;: Number of modules passed the unittests
boolrunMain;: Should the main function be run or not? This is ignored if any tests failed.
boolsummarize;: Should we print a summary of the results?
boolopCast(T : bool)() const;: Simple check for whether execution should continue after unit tests have been run. Works with legacy code that expected a bool return.
Returns:
true if execution should continue after testing is complete, false if not.
enum UnitTestResultpass;: Simple return code that says unit tests pass, and main should be run
enum UnitTestResultfail;: Simple return code that says unit tests failed.

aliasModuleUnitTester = bool function();

Legacy module unit test handler

aliasExtendedModuleUnitTester = UnitTestResult function();

Module unit test handler

structCArgs;

Stores the unprocessed arguments supplied when the process was started.

intargc;: The argument count.
char**argv;: The arguments as a C array of strings.

structRuntime;

This struct encapsulates all functionality related to the underlying runtime module for the calling context.

static boolinitialize();

Initializes the runtime. This call is to be used in instances where the standard program initialization process is not executed. This is most often in shared libraries or in libraries linked to a C program. If the runtime was already successfully initialized this returns true. Each call to initialize must be paired by a call toterminate.

Returns:

true if initialization succeeded or false if initialization failed.

static boolterminate();

Terminates the runtime. This call is to be used in instances where the standard program termination process will not be not executed. This is most often in shared libraries or in libraries linked to a C program. If the runtime was not successfully initialized the function returns false.

Returns:

true if termination succeeded or false if termination failed.

static @property string[]args();

Returns the arguments supplied when the process was started.

Returns:

The arguments supplied when this process was started.

static @nogc @property CArgscArgs();

Returns the unprocessed C arguments supplied when the process was started. Use this when you need to supply argc and argv to C libraries.

Returns:

ACArgs struct with the arguments supplied when this process was started.

Example

import core.runtime;// A C library function requiring char** argumentsextern(C)void initLibFoo(int argc,char** argv);void main(){auto args = Runtime.cArgs;    initLibFoo(args.argc, args.argv);}

void*loadLibrary()(scope const char[]name);

Locates a dynamic library with the supplied library name and dynamically loads it into the caller's address space. If the library contains a D runtime it will be integrated with the current runtime.

Parameters:

char[]name The name of the dynamic library to load.

Returns:

A reference to the library or null on error.

boolunloadLibrary()(void*p);

Unloads the dynamic library referenced by p. If this library contains a D runtime then any necessary finalization or cleanup of that runtime will be performed.

Parameters:

void*p A reference to the library to unload.

static @property voidtraceHandler(TraceHandlerh, Throwable.TraceDeallocatord = null);

Overrides the default trace mechanism with a user-supplied version. A trace represents the context from which an exception was thrown, and the trace handler will be called when this occurs. The pointer supplied to this routine indicates the base address from which tracing should occur. If the supplied pointer is null then the trace routine should determine an appropriate calling context from which to begin the trace.

If the deallocator is set, then it is called with the traceinfo when the exception is finalized. The deallocator is only set in the exception if the default handler is used to generate the trace info.

Parameters:

TraceHandler`h`	The new trace handler. Set to null to disable exception backtracing.
Throwable.TraceDeallocator`d`	The new trace deallocator. If non-null, this will be called on exception destruction with the trace info, only when the trace handler is used to generate TraceInfo.

static @property TraceHandlertraceHandler();

Gets the current trace handler.

Returns:

The current trace handler or null if none has been set.

static @property Throwable.TraceDeallocatortraceDeallocator();

Gets the current trace deallocator.

Returns:

The current trace deallocator or null if none has been set.

static @property voidcollectHandler(CollectHandlerh);

Overrides the default collect hander with a user-supplied version. This routine will be called for each resource object that is finalized in a non-deterministic manner--typically during a garbage collection cycle. If the supplied routine returns true then the object's dtor will called as normal, but if the routine returns false than the dtor will not be called. The default behavior is for all object dtors to be called.

Parameters:

CollectHandlerh The new collect handler. Set to null to use the default handler.

static @property CollectHandlercollectHandler();

Gets the current collect handler.

Returns:

The current collect handler or null if none has been set.

static @property voidextendedModuleUnitTester(ExtendedModuleUnitTesterh); static @property voidmoduleUnitTester(ModuleUnitTesterh);

Overrides the default module unit tester with a user-supplied version. This routine will be called once on program initialization. The return value of this routine indicates to the runtime whether the tests ran without error.

There are two options for handlers. Thebool version is deprecated but will be kept for legacy support. Returningtrue from the handler is equivalent to returningUnitTestResult.pass from the extended version. Returningfalse from the handler is equivalent to returningUnitTestResult.fail from the extended version.

See the documentation forUnitTestResult to see how you should set up the return structure.

See the documentation forrunModuleUnitTests for how the default algorithm works, or read the example below.

Parameters:

ExtendedModuleUnitTesterh The new unit tester. Set both to null to use the default unit tester.

Example

sharedstaticthis(){import core.runtime;    Runtime.extendedModuleUnitTester = &customModuleUnitTester;}UnitTestResult customModuleUnitTester(){import std.stdio;    writeln("Using customModuleUnitTester");// Do the same thing as the default moduleUnitTester:    UnitTestResult result;foreach (m; ModuleInfo)    {if (m)        {auto fp = m.unitTest;if (fp)            {                ++result.executed;try                {                    fp();                    ++result.passed;                }catch (Throwable e)                {                    writeln(e);                }            }        }    }if (result.executed != result.passed)    {        result.runMain =false;// don't run main        result.summarize =true;// print failure    }else    {        result.runMain =true;// all UT passed        result.summarize =false;// be quiet about it.    }return result;}

static @property ModuleUnitTestermoduleUnitTester();

Gets the current legacy module unit tester.

This property should not be used, but is supported for legacy purposes.

Note that if the extended unit test handler is set, this handler will be ignored.

Returns:

The current legacy module unit tester handler or null if none has been set.

static @property ExtendedModuleUnitTesterextendedModuleUnitTester();

Gets the current module unit tester.

This handler overrides any legacy module unit tester set by the moduleUnitTester property.

Returns:

The current module unit tester handler or null if none has been set.

voiddmd_coverSourcePath(stringpath);

Set source file path for coverage reports.

Parameters:

stringpath The new path name.