| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>package org.apache.felix.ipojo.manipulator.metadata.annotation;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.apache.felix.ipojo.manipulator.Reporter;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.felix.ipojo.manipulator.metadata.annotation.registry.BindingRegistry;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.felix.ipojo.metadata.Attribute;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.felix.ipojo.metadata.Element;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.objectweb.asm.*;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.objectweb.asm.tree.ClassNode;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.objectweb.asm.tree.FieldNode;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.objectweb.asm.tree.MethodNode;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>/**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a><a name="line.32"></a> |
| <span class="sourceLineNo">033</span> */<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>public class ClassMetadataCollector extends ClassVisitor {<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span> /**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Binding's registry.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> private BindingRegistry registry;<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> /**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * Output information.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> private Reporter reporter;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Workbench where produced Elements will be merged and hierarchically organized.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private ComponentWorkbench workbench;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /**<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Class currently being analyzed.<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> */<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> private ClassNode node;<a name="line.54"></a> |
| <span class="sourceLineNo">055</span><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> private Element componentMetadata;<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> private Element instanceMetadata;<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> public ClassMetadataCollector(BindingRegistry registry, Reporter reporter) {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> super(Opcodes.ASM5);<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> this.registry = registry;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> this.reporter = reporter;<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> node = new ClassNode();<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> /**<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * Build metadata. May be {@literal null} if no "component type" was found.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> *<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * @return Build metadata. May be {@literal null} if no "component type" was found.<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> */<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public Element getComponentMetadata() {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> return componentMetadata;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> }<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> /**<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * Build instance metadata. May be {@literal null} if no "component type" was found.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @return Build metadata. May be {@literal null} if no "component type" was found.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public Element getInstanceMetadata() {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> return instanceMetadata;<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> }<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> @Override<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> node.visit(version, access, name, signature, superName, interfaces);<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> workbench = new ComponentWorkbench(registry, node);<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> }<a name="line.89"></a> |
| <span class="sourceLineNo">090</span><a name="line.90"></a> |
| <span class="sourceLineNo">091</span> /**<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * Visit class annotations.<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * This method detects @component and @provides annotations.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> *<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * @param desc : annotation descriptor.<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * @param visible : is the annotation visible at runtime.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @return the annotation visitor.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @see org.objectweb.asm.ClassVisitor#visitAnnotation(java.lang.String, boolean)<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> public AnnotationVisitor visitAnnotation(String desc, boolean visible) {<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> // Return the visitor to be executed (may be null)<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> return registry.selection(workbench)<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> .type(this, node)<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> .annotatedWith(desc)<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> .get();<a name="line.106"></a> |
| <span class="sourceLineNo">107</span><a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Visit a field.<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * Call the field collector visitor.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> *<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @param access : field access.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @param name : field name<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param desc : field descriptor<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param signature : field signature<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @param value : field value (static field only)<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> * @return the field visitor.<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> * @see org.objectweb.asm.ClassVisitor#visitField(int, java.lang.String, java.lang.String, java.lang.String,<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> * java.lang.Object)<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> */<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> public FieldVisitor visitField(int access, String name, String desc, String signature, Object value) {<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> return new FieldMetadataCollector(workbench, new FieldNode(access, name, desc, signature, value));<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> }<a name="line.125"></a> |
| <span class="sourceLineNo">126</span><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> /**<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * Visit a method.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * Call the method collector visitor.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> *<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @param access : method access<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @param name : method name<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @param desc : method descriptor<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @param signature : method signature<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * @param exceptions : method exceptions<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @return the Method Visitor.<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @see org.objectweb.asm.ClassVisitor#visitMethod(int, java.lang.String, java.lang.String, java.lang.String, java.lang.String[])<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> */<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> return new MethodMetadataCollector(workbench, new MethodNode(access, name, desc, signature, exceptions), reporter);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span><a name="line.142"></a> |
| <span class="sourceLineNo">143</span> /**<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> * End of the visit : compute final elements.<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> *<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> * @see org.objectweb.asm.ClassVisitor#visitEnd()<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> */<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> @Override<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> public void visitEnd() {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> // Only process real class (no annotations, no interfaces)<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> if (!(is(Opcodes.ACC_ANNOTATION) || is(Opcodes.ACC_INTERFACE) || is(Opcodes.ACC_ABSTRACT))) {<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> if (workbench.getRoot() == null) {<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> // No 'top-level' element has been contributed<a name="line.153"></a> |
| <span class="sourceLineNo">154</span><a name="line.154"></a> |
| <span class="sourceLineNo">155</span> if (!workbench.getElements().isEmpty()) {<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> // There are other annotation's contribution on this type (additional handler declaration/configuration)<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> // That means that there is a missing 'component type' annotation<a name="line.157"></a> |
| <span class="sourceLineNo">158</span><a name="line.158"></a> |
| <span class="sourceLineNo">159</span> reporter.warn("Class %s has not been marked as a component type (no @Component, @Handler, " +<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> "...). It will be ignored by the iPOJO manipulator.",<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> workbench.getType().getClassName()<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> );<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> return;<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> } // else: no root and no elements<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> return;<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> }<a name="line.166"></a> |
| <span class="sourceLineNo">167</span><a name="line.167"></a> |
| <span class="sourceLineNo">168</span> componentMetadata = workbench.build();<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> instanceMetadata = workbench.getInstance();<a name="line.169"></a> |
| <span class="sourceLineNo">170</span><a name="line.170"></a> |
| <span class="sourceLineNo">171</span> // If we have an instance declared and the component metadata has a name, we update the component's attribute<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> // of the instance (https://issues.apache.org/jira/browse/FELIX-4052).<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> if (componentMetadata != null && componentMetadata.containsAttribute("name") && instanceMetadata != null) {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> // Update the component attribute<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> instanceMetadata.addAttribute(new Attribute("component", componentMetadata.getAttribute("name")));<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> }<a name="line.176"></a> |
| <span class="sourceLineNo">177</span><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> }<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> private boolean is(int flags) {<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> return (node.access & flags) == flags;<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> }<a name="line.183"></a> |
| <span class="sourceLineNo">184</span><a name="line.184"></a> |
| <span class="sourceLineNo">185</span>}<a name="line.185"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
