Description Niels Brouwers 2015-09-24 05:32:59 EDT

When an XtextResource is saved by Sirius, the Xtext formatter is not being invoked. 

In our situation, users use either the textual representation implemented with Xtext or graphical representations implemented with Sirius to maintain the model. Our rationale is that whenever the user uses the textual editor, formatting of the document can be customized to the needs of the user. However, when switching to the graphical editor, customization of the formatter plays no role so we would have format the resource always by invoking the Xtext formatter on the resource. Furthermore, we persist the model to text to ease textual diff/merge. Also for this reason invoking the formatter by default is required.

I've implemented the functionality to always format a XtextResource when it's being saved by Sirius by overriding the XtextSavingPolicy class that's contained within the Xtext integration feature:

public class XtextSavingPolicy implements SavingPolicy {

    private final SavingPolicy delegate;

    /**
     * Create the saving policy.
     * 
     * @param delegate
     *            the delegate which is going to be called for the save
     *            operations, but with Xtext specific options.
     */
    public XtextSavingPolicy(SavingPolicy delegate) {
        this.delegate = delegate;
    }

    @Override
    public Collection<Resource> save(Iterable<Resource> resourcesToSave, Map<?, ?> options, IProgressMonitor monitor) {
        Map<Object, Object> newOptions = Maps.newHashMap();
        if (options != null) {
            newOptions.putAll(options);
        }
        
        // added format option to make sure the XtextResource is formatted during the save.
        newOptions.putAll(SaveOptions.newBuilder().noValidation().format().getOptions().toOptionsMap());
        return delegate.save(resourcesToSave, newOptions, monitor);
    }

}

My proposal is to add this option by default in the XtextSavingPolicy shipped with the Xtext integration feature.