CODEWITHSUNDEEP
xtext
fundagain
fundagain

Reputation: 398

Xtext validation across (unreferenced) files

I am struggling to validate (non-duplication) globally, across multiple files that do not explicitly reference each other.

Consider the standard initally-generated grammar

grammar org.xtext.example.mydsl.MyDsl with org.eclipse.xtext.common.Terminals

generate myDsl "http://www.xtext.org/example/mydsl/MyDsl"

Model:
    greetings+=Greeting*;

Greeting:
    'Hello' name=ID '!';

It is simple to validate that no file contains greeting for the same name.

package org.xtext.example.mydsl.validation

import org.eclipse.xtext.validation.Check
import org.xtext.example.mydsl.myDsl.Greeting
import org.xtext.example.mydsl.myDsl.Model
import org.xtext.example.mydsl.myDsl.MyDslPackage

class MyDslValidator extends AbstractMyDslValidator {

    public static val LOCALLY_DUPLICATE_NAME = 'LOCALLY_DUPLICATE_NAME'

    @Check
    def checkGreetingLocallyUnique(Greeting greeting) {
            for(greeting_ : (greeting.eContainer as Model).greetings) {
                if(greeting!==greeting_ && greeting.name==greeting_.name) {
                    warning('Greeting duplication', 
                    MyDslPackage.Literals.GREETING__NAME,
                    LOCALLY_DUPLICATE_NAME)
                }
            }
    }

}

The stub of the method is

@Check
def checkGreetingGloballyUnique(Greeting greeting) {
        for(greeting_ : /*???*/ ) {
            if(greeting!==greeting_ && greeting.name==greeting_.name) {
                warning('Global Greeting duplication', 
                MyDslPackage.Literals.GREETING__NAME,
                GLOBALLY_DUPLICATE_NAME)
            }
        }
}

Upvotes: 1

Views: 546

Answers (2)

fundagain
fundagain

Reputation: 398

After much hacking, I obtained the following.

public static val GLOBALLY_DUPLICATE_NAME = 'GLOBALLY_DUPLICATE_NAME'

@com.google.inject.Inject
IResourceDescriptions iResourceDescriptions
@Inject
Provider<XtextResourceSet> resourceSetProvider;

@Check
def checkGreetingGloballyUnique(Greeting greeting) {
    for (resourceDescriptions : iResourceDescriptions.allResourceDescriptions) {
        for (_greetingDescription : resourceDescriptions.getExportedObjectsByType(MyDslPackage.Literals.GREETING)) {

            val _greeting = resourceSetProvider.get.getEObject(_greetingDescription.EObjectURI, true) as Greeting

            // don't use equality, ALWAYS not equal!!

            if (greeting.eResource.URI != _greeting.eResource.URI) {
                // this means distinct files, all greetings in same file have same uri
                if (greeting.name == _greeting.name) {
                    warning('Global greeting duplication', MyDslPackage.Literals.GREETING__NAME,
                        LOCALLY_DUPLICATE_NAME)
                }
            }
        }
    }
}

Rewrite, based on @Christian Dietrich's comments, I have the following solution.

@Inject
    IContainer.Manager containerManager;
    @com.google.inject.Inject
    IResourceDescriptions resourceDescriptions
    @Inject
    Provider<XtextResourceSet> resourceSetProvider;

    @Check
    def checkGreetingGloballyUnique(Greeting greeting) {

        var greeting_description = resourceDescriptions.getResourceDescription(greeting.eResource.URI)
        var visibleContainers = containerManager.getVisibleContainers(greeting_description, resourceDescriptions)

        for (visibleContainer : visibleContainers) {
            for (_greetingDescription : visibleContainer.getExportedObjectsByType(MyDslPackage.Literals.GREETING)) {
                val _greeting = resourceSetProvider.get.getEObject(_greetingDescription.EObjectURI, true) as Greeting

                // don't use equality, ALWAYS greeting != _greeting !!
                if (greeting.eResource.URI != _greeting.eResource.URI) {
                    // this means distinct files, all greetings in same file have same uri
                    if (greeting.name == _greeting.name) {
                        warning('Global greeting duplication', MyDslPackage.Literals.GREETING__NAME,
                            GLOBALLY_DUPLICATE_NAME)
                    }
                }

            }
        }
    }

Upvotes: 2

Christian Dietrich
Christian Dietrich

Reputation: 11868

the easiest way for a local duplicate validation is to enable it in the workflow and regenerate the language (this does not check locally though)

        validator = {
            composedCheck = "org.eclipse.xtext.validation.NamesAreUniqueValidator"
        }

to search the index

@Inject
IContainer.Manager containermanager;

@Inject
ResourceDescriptionsProvider resourceDescriptionsProvider;

public .... getAllEntitiesFor( EObject eObject ) {
    ....
    IResourceDescriptions resourceDescriptions = resourceDescriptionsProvider.getResourceDescriptions( eObject.eResource() );
    IResourceDescription resourceDescription = resourceDescriptions.getResourceDescription( eObject.eResource().getURI() );
    List<IContainer> visiblecontainers = containermanager.getVisibleContainers( resourceDescription, resourceDescriptions );
    for (IContainer container : visiblecontainers) {
        for (IEObjectDescription eobjectDescription : container.getExportedObjects()) {
            EObject eObjectOrProxy = eobjectDescription.getEObjectOrProxy();
            .....
        }
    }
    ....
}

Upvotes: 3

Related Questions