Home

Contribute

Source code


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

/*
Copyright (c) 2008 Arno Haase.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html

Contributors:
    Arno Haase - initial API and implementation
 */
package org.eclipose.xtend.middleend.plugins;

import java.util.List;

import org.eclipose.xtend.middleend.MiddleEnd;
import org.eclipse.xtend.backend.aop.AroundAdvice;
import org.eclipse.xtend.backend.common.FunctionDefContext;


/**
 * This interface is the common abstraction through which all handlers for different
 *  languages can contribute their middle ends.
 * 
 * @author Arno Haase (http://www.haase-consulting.com)
 */
public interface LanguageSpecificMiddleEnd {
    /**
     * This method is used to break the circular dependency between MiddleEnd and the
     *  language specific handlers. It is called by the MiddleEnd on creation.
     */
    void setMiddleEnd (MiddleEnd middleEnd);
    
    String getName ();
    
    /**
     * gives the middle end a way to declare if it can and wants to handle a given
     *  source file / resource. If and only if it returns true, it will be asked for
     *  the functions and advice provided in this resource.
     */
    boolean canHandle (String resourceName);
    
    /**
     * This method asks the middle end to parse a resource for which it declared
     *  that it is the appropriate handler, and return the functions contained therein.<br>
     *  
     * Implementations are encouraged to perform aggressive caching. The calling code
     *  takes care of re-initializing the middle end implementations as it deems fit by
     *  creating new instances of the contributed middle end implementation classes.
     */
    FunctionDefContext getContributedFunctions (String resourceName);
    
    /**
     * This method is the same as getContributedFunctions, except that it returns advice
     *  rather than functions. Since the semantics of advice depends on the order in which
     *  it is applied, this method returns a list rather than an arbitrary collection.
     */
    List<AroundAdvice> getContributedAdvice (String resourceName);
}