Examples with MonitorBasedCancelIndicator org.eclipse.xtext.builder.MonitorBasedCancelIndicator used on opensource projects

Example 1 with MonitorBasedCancelIndicator

use of org.eclipse.xtext.builder.MonitorBasedCancelIndicator in project xtext-eclipse by eclipse.

the class ClusteringBuilderState method doUpdate.

/**
 * Actually do the build.
 *
 * @param buildData
 *            the data that should be considered for the update
 * @param newData
 *            the new resource descriptions as they are to be persisted (the new index after the build).
 *            Initially contains the old resource descriptions.
 * @param monitor
 *            The progress monitor
 * @return A list of deltas describing all changes made by the build.
 */
@Override
protected Collection<Delta> doUpdate(BuildData buildData, ResourceDescriptionsData newData, IProgressMonitor monitor) {
    // We assume that we have 101 ticks to work with:
    // 20 for writeNewResourceDescription
    // 1 for queueAffectedResources
    // 80 for updating and queueAffectedResources
    // Within the mentioned 80 ticks we assume that 2/3 is spent for updating and 1/3 for queueAffectedResources
    final SubMonitor progress = SubMonitor.convert(monitor, 101);
    // Step 1: Clean the set of deleted URIs. If any of them are also added, they're not deleted.
    final Set<URI> toBeDeleted = buildData.getAndRemoveToBeDeleted();
    // Step 2: Create a new state (old state minus the deleted resources). This, by virtue of the flag
    // NAMED_BUILDER_SCOPE in the resource set's load options
    // and a Guice binding, is the index that is used during the build; i.e., linking during the build will
    // use this. Once the build is completed, the persistable index is reset to the contents of newState by
    // virtue of the newMap, which is maintained in synch with this.
    ResourceSet resourceSet = buildData.getResourceSet();
    final CurrentDescriptions newState = new CurrentDescriptions(resourceSet, newData, buildData);
    buildData.getSourceLevelURICache().cacheAsSourceURIs(toBeDeleted);
    installSourceLevelURIs(buildData);
    // Step 3: Create a queue; write new temporary resource descriptions for the added or updated resources so that we can link
    // subsequently; put all the added or updated resources into the queue.
    writeNewResourceDescriptions(buildData, this, newState, progress.split(20));
    if (progress.isCanceled()) {
        throw new OperationCanceledException();
    }
    // in this set as potential candidates.
    for (final URI uri : toBeDeleted) {
        newData.removeDescription(uri);
    }
    final Set<URI> allRemainingURIs = Sets.newLinkedHashSet(newData.getAllURIs());
    allRemainingURIs.removeAll(buildData.getToBeUpdated());
    for (URI remainingURI : buildData.getAllRemainingURIs()) {
        allRemainingURIs.remove(remainingURI);
    }
    // TODO: consider to remove any entry from upstream projects and independent projects
    // from the set of remaining uris (template method or service?)
    // this should reduce the number of to-be-checked descriptions significantly
    // for common setups (large number of reasonable sized projects)
    // Our return value. It contains all the deltas resulting from this build.
    final Set<Delta> allDeltas = Sets.newHashSet();
    // Step 5: Put all resources depending on a deleted resource into the queue. Also register the deltas in allDeltas.
    if (!toBeDeleted.isEmpty()) {
        for (final URI uri : toBeDeleted) {
            final IResourceDescription oldDescription = this.getResourceDescription(uri);
            if (oldDescription != null) {
                allDeltas.add(new DefaultResourceDescriptionDelta(oldDescription, null));
            }
        }
    }
    // Add all pending deltas to all deltas (may be scheduled java deltas)
    Collection<Delta> pendingDeltas = buildData.getAndRemovePendingDeltas();
    allDeltas.addAll(pendingDeltas);
    queueAffectedResources(allRemainingURIs, this, newState, allDeltas, allDeltas, buildData, progress.split(1));
    installSourceLevelURIs(buildData);
    IProject currentProject = getBuiltProject(buildData);
    LoadOperation loadOperation = null;
    try {
        Queue<URI> queue = buildData.getURIQueue();
        loadOperation = crossLinkingResourceLoader.create(resourceSet, currentProject);
        loadOperation.load(queue);
        // Step 6: Iteratively got through the queue. For each resource, create a new resource description and queue all depending
        // resources that are not yet in the delta. Validate resources.
        final SubMonitor subProgress = progress.split(80);
        CancelIndicator cancelMonitor = new MonitorBasedCancelIndicator(progress);
        while (!queue.isEmpty()) {
            // heuristic: we multiply the size of the queue by 3 and spent 2 ticks for updating
            // and 1 tick for queueAffectedResources since we assume that loading etc. is
            // slower than queueAffectedResources.
            subProgress.setWorkRemaining((queue.size() + 1) * 3);
            int clusterIndex = 0;
            final List<Delta> changedDeltas = Lists.newArrayList();
            while (!queue.isEmpty()) {
                if (subProgress.isCanceled()) {
                    loadOperation.cancel();
                    throw new OperationCanceledException();
                }
                if (!clusteringPolicy.continueProcessing(resourceSet, null, clusterIndex)) {
                    break;
                }
                URI changedURI = null;
                URI actualResourceURI = null;
                Resource resource = null;
                Delta newDelta = null;
                try {
                    // Load the resource and create a new resource description
                    LoadResult loadResult = loadOperation.next();
                    changedURI = loadResult.getUri();
                    actualResourceURI = loadResult.getResource().getURI();
                    resource = addResource(loadResult.getResource(), resourceSet);
                    subProgress.subTask("Updating resource " + resource.getURI().lastSegment());
                    if (LOGGER.isDebugEnabled()) {
                        LOGGER.debug("Update resource description " + actualResourceURI);
                    }
                    queue.remove(changedURI);
                    if (toBeDeleted.contains(changedURI)) {
                        break;
                    }
                    buildLogger.log("indexing " + changedURI);
                    final IResourceDescription.Manager manager = getResourceDescriptionManager(actualResourceURI);
                    if (manager != null) {
                        // Resolve links here!
                        try {
                            EcoreUtil2.resolveLazyCrossReferences(resource, cancelMonitor);
                            final IResourceDescription description = manager.getResourceDescription(resource);
                            final IResourceDescription copiedDescription = BuilderStateUtil.create(description);
                            newDelta = manager.createDelta(this.getResourceDescription(actualResourceURI), copiedDescription);
                        } catch (OperationCanceledException e) {
                            loadOperation.cancel();
                            throw e;
                        } catch (WrappedException e) {
                            throw e;
                        } catch (RuntimeException e) {
                            LOGGER.error("Error resolving cross references on resource '" + actualResourceURI + "'", e);
                            throw new LoadOperationException(actualResourceURI, e);
                        }
                    }
                } catch (final WrappedException ex) {
                    if (ex instanceof LoadOperationException) {
                        changedURI = ((LoadOperationException) ex).getUri();
                    }
                    Throwable cause = ex.getCause();
                    boolean wasResourceNotFound = false;
                    if (cause instanceof CoreException) {
                        if (IResourceStatus.RESOURCE_NOT_FOUND == ((CoreException) cause).getStatus().getCode()) {
                            wasResourceNotFound = true;
                        }
                    }
                    if (changedURI == null) {
                        // $NON-NLS-1$
                        LOGGER.error("Error loading resource", ex);
                    } else {
                        queue.remove(changedURI);
                        if (toBeDeleted.contains(changedURI))
                            break;
                        if (!wasResourceNotFound)
                            // $NON-NLS-1$
                            LOGGER.error("Error loading resource from: " + changedURI.toString(), ex);
                        if (resource != null) {
                            resourceSet.getResources().remove(resource);
                        }
                        final IResourceDescription oldDescription = this.getResourceDescription(changedURI);
                        final IResourceDescription newDesc = newState.getResourceDescription(changedURI);
                        ResourceDescriptionImpl indexReadyDescription = newDesc != null ? BuilderStateUtil.create(newDesc) : null;
                        if ((oldDescription != null || indexReadyDescription != null) && oldDescription != indexReadyDescription) {
                            newDelta = new DefaultResourceDescriptionDelta(oldDescription, indexReadyDescription);
                        }
                    }
                }
                if (newDelta != null) {
                    allDeltas.add(newDelta);
                    clusterIndex++;
                    if (newDelta.haveEObjectDescriptionsChanged())
                        changedDeltas.add(newDelta);
                    // Make the new resource description known and update the map.
                    newState.register(newDelta);
                    // Validate now.
                    if (!buildData.isIndexingOnly()) {
                        try {
                            updateMarkers(newDelta, resourceSet, subProgress);
                        } catch (OperationCanceledException e) {
                            loadOperation.cancel();
                            throw e;
                        } catch (Exception e) {
                            LOGGER.error("Error validating " + newDelta.getUri(), e);
                        }
                    }
                }
                // 2 ticks for updating since updating makes 2/3 of the work
                subProgress.split(2);
            }
            loadOperation.cancel();
            queueAffectedResources(allRemainingURIs, this, newState, changedDeltas, allDeltas, buildData, subProgress.split(1));
            installSourceLevelURIs(buildData);
            if (queue.size() > 0) {
                loadOperation = crossLinkingResourceLoader.create(resourceSet, currentProject);
                loadOperation.load(queue);
            }
            // Release memory
            if (!queue.isEmpty() && !clusteringPolicy.continueProcessing(resourceSet, null, clusterIndex))
                clearResourceSet(resourceSet);
        }
    } finally {
        if (loadOperation != null)
            loadOperation.cancel();
        if (!progress.isCanceled())
            progress.done();
    }
    return allDeltas;
}

Example 2 with MonitorBasedCancelIndicator

use of org.eclipse.xtext.builder.MonitorBasedCancelIndicator in project n4js by eclipse.

the class ResourceLoadingStatistics method computeAndShowStatsForWorkspace.

/**
 * Computes and prints resource loading statistics for all N4JS[X] projects in the workspace.
 * <p>
 * For each N4JS[X] file in the workspace, this method will
 * <ol>
 * <li>create a new, empty resource set,
 * <li>load the file into this resource set and fully process it (parser, types builder, post-processing),
 * <li>count how many other files/resources were automatically loaded into the resource set and if they were loaded
 * from AST or from Xtext index,
 * <li>print statistics to the given stream.
 * </ol>
 */
public void computeAndShowStatsForWorkspace(PrintStream out, IProgressMonitor monitor) {
    final CancelIndicator cancelIndicator = new MonitorBasedCancelIndicator(monitor);
    // for proper progress reporting, first collect all URIs in all N4JS projects
    int uriCount = 0;
    final Map<IN4JSProject, List<URI>> urisPerProject = new LinkedHashMap<>();
    final Iterable<IN4JSProject> projects = n4jsCore.findAllProjects();
    for (IN4JSProject project : projects) {
        operationCanceledManager.checkCanceled(cancelIndicator);
        if (!isManagedByLibraryManager(project)) {
            final List<URI> uris = collectURIsToInvestigate(project);
            uriCount += uris.size();
            urisPerProject.put(project, uris);
        }
    }
    // now do the actual work: compute and show statistics for each project
    monitor.beginTask("Investigate projects in workspace ... ", uriCount);
    for (Entry<IN4JSProject, List<URI>> entry : urisPerProject.entrySet()) {
        operationCanceledManager.checkCanceled(cancelIndicator);
        final IN4JSProject project = entry.getKey();
        final List<URI> uris = entry.getValue();
        final List<FileLoadInfo> results = investigate(project, uris, out, monitor, false);
        out.println();
        out.println("SUMMARY:");
        out.println();
        FileLoadInfo.printReport(project, results, out);
    }
}

Example 3 with MonitorBasedCancelIndicator

use of org.eclipse.xtext.builder.MonitorBasedCancelIndicator in project n4js by eclipse.

the class ResourceLoadingStatistics method investigate.

private FileLoadInfo investigate(IN4JSProject project, URI fileURI, IProgressMonitor monitor) {
    final CancelIndicator cancelIndicator = new MonitorBasedCancelIndicator(monitor);
    operationCanceledManager.checkCanceled(cancelIndicator);
    final ResourceSet resSet = n4jsCore.createResourceSet(Optional.of(project));
    final N4JSResource res = (N4JSResource) resSet.createResource(fileURI);
    try {
        res.load(Collections.emptyMap());
    } catch (IOException e) {
        e.printStackTrace();
    }
    // trigger loading of AST
    res.getContents();
    res.resolveLazyCrossReferences(cancelIndicator);
    // now start counting what was loaded incidentally ...
    return investigate(resSet);
}