VirtualRunEnv is a generator that produces a launcher conanrunenv .bat or .sh script containing environment variables
of the run time environment.
The launcher contains the runtime environment information, anything that is necessary in the environment to actually run the compiled executables and applications. The information is obtained from:
self.runenv_infoof the dependencies corresponding to the
- Also automatically deduced from the
self.cpp_infodefinition of the package, to define
It can be used by name in conanfiles:
class Pkg(ConanFile): generators = "VirtualRunEnv"
And it can also be fully instantiated in the conanfile
from conan import ConanFile from conan.tools.env import VirtualRunEnv class Pkg(ConanFile): settings = "os", "compiler", "arch", "build_type" requires = "zlib/1.2.11", "bzip2/1.0.8" def generate(self): ms = VirtualRunEnv(self) ms.generate()
- conanrunenv-release-x86_64.(bat|sh): This file contains the actual definition of environment variables
like PATH, LD_LIBRARY_PATH, etc, and
runenv_infoof dependencies corresponding to the
hostcontext, and to the current installed configuration. If a repeated call is done with other settings, a different file will be created.
- conanrun.(bat|sh): Accumulates the calls to one or more other scripts to give one single convenient file
for all. This only calls the latest specific configuration one, that is, if
conan installis called first for Release build type, and then for Debug,
conanrun.(bat|sh)script will call the Debug one.
After the execution of one of those files, a new deactivation script will be generated, capturing the current
environment, so the environment can be restored when desired. The file will be named also following the
current active configuration, like
Calculates the environment variables of the runtime context and produces a conanrunenv .bat or .sh script
Parameters: conanfile – The current recipe object. Always use
Environmentobject containing the environment variables of the run context.
Environmentobject instance containing the obtained variables.
Parameters: scope – Scope to be used. Returns: An
EnvVarsinstance containing the computed environment variables.
Produces the launcher scripts activating the variables for the run context.
Parameters: scope – Scope to be used.