Package com._1c.g5.v8.dt.debug.core.model

Interface IBslModuleLocator

  • public interface IBslModuleLocator
    BSL module locator locates BSL modules by BslModuleReference for debug purposes. 1C:Enterprise Runtime debug server operates with BslModuleReference as module reference and IBslModuleLocator allows to convert these references to actual BSL modules and vice versa.

    Clients may use IBslModuleLocator to get:

    • BslModuleReference by the BSL module workspace resource.
    • BSL module content or context def by the BslModuleReference.
    See Also:
    BslModuleReference

    • Method Detail

      • getReference

        BslModuleReference getReference​(org.eclipse.core.resources.IResource resource)
        Construct and return BSL module reference by the given resource. Resource must contain BSL module.
        Parameters:
        resource - the workspace resource to build BSL module reference for, cannot be null
        Returns:
        the BSL module reference, never null
        Throws:
        IllegalArgumentException - if given resource has no underlying BSL module

      • getModuleUri

        org.eclipse.emf.common.util.URI getModuleUri​(BslModuleReference moduleReference)
        Returns URI of BSL module for the given BSL module reference. Can return null, if module for the given BSL module reference not found.
        Parameters:
        moduleReference - the BSL module reference, cannot be null
        Returns:
        the URI of BSL module for the given BSL module reference, or null if module for this reference not found

      • getModule

        Module getModule​(org.eclipse.core.resources.IResource resource,
                 boolean forceDerivedStateComputation)
        Returns BSL module, found in the given resource. Resource must contain BSL module.
        Parameters:
        resource - the resource to get BSL module for, cannot be null
        forceDerivedStateComputation - whether need to force method to compute module derived state
        Returns:
        the BSL module, never null

      • getModule

        Module getModule​(BslModuleReference moduleReference,
                 boolean forceDerivedStateComputation)
        Returns actual BSL module for the given BSL module reference. Can return null if module for the given BSL module reference not found.
        Parameters:
        moduleReference - the BSL module reference, cannot be null
        forceDerivedStateComputation - whether need to force method to compute module derived state
        Returns:
        the BSL module for given BSL module reference or null, if module for this reference not found

      • getProxyModuleWithOwner

        Module getProxyModuleWithOwner​(org.eclipse.core.resources.IResource resource)
        Returns actual BSL proxy module with its owner by resource
        Parameters:
        resource - the workspace resource to create BSL proxy module for, cannot be null
        Returns:
        actual BSL proxy module with its owner by resource, never null. Returned object always will be proxy object with URI created by resource and feature BslPackage.Literals.MODULE__OWNER will be set

      • getModuleContext

        ContextDef getModuleContext​(BslModuleReference moduleReference)
        Returns actual BSL module context def for the given BSL module reference. Can return null if module for the given BSL module reference not found.

        NOTE: Derived state for found module will be computed during method execution.

        Parameters:
        moduleReference - the BSL module reference, cannot be null
        Returns:
        the BSL module content def for the given BSL module reference or null, if module for this reference not found

      • getModuleContext

        ContextDef getModuleContext​(Module module)
        Returns actual BSL module context def for the given BSL module. Can return null if module for the given BSL module not found.

        NOTE: Derived state for found module will be computed during method execution.

        Parameters:
        module - the BSL module, cannot be null
        Returns:
        the BSL module content def for the given BSL module reference or null, if not found