blob: 9447d0fbbaccf6560d7cf1ee68d9286b577e76c0 [file] [log] [blame]
<HTML><HEAD><META CONTENT="text/html; charset=UTF-8" HTTP-EQUIV="Content-Type"/><TITLE>EMMA Coverage Report</TITLE><STYLE TYPE="text/css"> TABLE,TD,TH {border-style:solid; border-color:black;} TD,TH {background:white;margin:0;line-height:100%;padding-left:0.5em;padding-right:0.5em;} TD {border-width:0 1px 0 0;} TH {border-width:1px 1px 1px 0;} TR TD.h {color:red;} TABLE {border-spacing:0; border-collapse:collapse;border-width:0 0 1px 1px;} P,H1,H2,H3,TH {font-family:verdana,arial,sans-serif;font-size:10pt;} TD {font-family:courier,monospace;font-size:10pt;} TABLE.hdft {border-spacing:0;border-collapse:collapse;border-style:none;} TABLE.hdft TH,TABLE.hdft TD {border-style:none;line-height:normal;} TABLE.hdft TH.tl,TABLE.hdft TD.tl {background:#6699CC;color:white;} TABLE.hdft TD.nv {background:#6633DD;color:white;} .nv A:link {color:white;} .nv A:visited {color:white;} .nv A:active {color:yellow;} TABLE.hdft A:link {color:white;} TABLE.hdft A:visited {color:white;} TABLE.hdft A:active {color:yellow;} .in {color:#356085;} TABLE.s TD {padding-left:0.25em;padding-right:0.25em;} TABLE.s TD.l {padding-left:0.25em;padding-right:0.25em;text-align:right;background:#F0F0F0;} TABLE.s TR.z TD {background:#FF9999;} TABLE.s TR.p TD {background:#FFFF88;} TABLE.s TR.c TD {background:#CCFFCC;} A:link {color:#0000EE;text-decoration:none;} A:visited {color:#0000EE;text-decoration:none;} A:hover {color:#0000EE;text-decoration:underline;} TABLE.cn {border-width:0 0 1px 0;} TABLE.s {border-width:1px 0 1px 1px;} TD.h {color:red;border-width:0 1px 0 0;} TD.f {border-width:0 1px 0 1px;} TD.hf {color:red;border-width:0 1px 0 1px;} TH.f {border-width:1px 1px 1px 1px;} TR.cis TD {background:#F0F0F0;} TR.cis TD {border-width:1px 1px 1px 0;} TR.cis TD.h {color:red;border-width:1px 1px 1px 0;} TR.cis TD.f {border-width:1px 1px 1px 1px;} TR.cis TD.hf {color:red;border-width:1px 1px 1px 1px;} TD.b {border-style:none;background:transparent;line-height:50%;} TD.bt {border-width:1px 0 0 0;background:transparent;line-height:50%;} TR.o TD {background:#F0F0F0;}TABLE.it {border-style:none;}TABLE.it TD,TABLE.it TH {border-style:none;}</STYLE></HEAD><BODY><TABLE CLASS="hdft" CELLSPACING="0" WIDTH="100%"><TR><TH CLASS="tl"><A HREF="http://www.eclemma.org/">EMMA</A> Coverage Report (generated Fri Feb 20 18:44:54 GMT 2009)</TH></TR><TR><TD CLASS="nv">[<A HREF="../xslUnitTestCoverage.html">all classes</A>][<A HREF="90.html">org.eclipse.wst.sse.ui.internal.taginfo</A>]</TD></TR></TABLE><H2>COVERAGE SUMMARY FOR SOURCE FILE [<SPAN CLASS="in">BestMatchHover.java</SPAN>]</H2><TABLE CELLSPACING="0" WIDTH="100%"><TR><TH>name</TH><TH>class, %</TH><TH>method, %</TH><TH>block, %</TH><TH>line, %</TH></TR><TR><TD>BestMatchHover.java</TD><TD>100% (1/1)</TD><TD CLASS="h">14%  (1/7)</TD><TD CLASS="h">4%   (6/152)</TD><TD CLASS="h">8%   (3/40)</TD></TR></TABLE><H3>COVERAGE BREAKDOWN BY CLASS AND METHOD</H3><TABLE CLASS="cn" CELLSPACING="0" WIDTH="100%"><TR><TH CLASS="f">name</TH><TH>class, %</TH><TH>method, %</TH><TH>block, %</TH><TH>line, %</TH></TR><TR><TD CLASS="b"> </TD><TD CLASS="b"> </TD><TD CLASS="b"> </TD><TD CLASS="b"> </TD><TD CLASS="b"> </TD></TR><TR CLASS="cis"><TD CLASS="f">class <A HREF="#0">BestMatchHover</A></TD><TD>100% (1/1)</TD><TD CLASS="h">14%  (1/7)</TD><TD CLASS="h">4%   (6/152)</TD><TD CLASS="h">8%   (3/40)</TD></TR><TR><TD CLASS="f"><A HREF="#0">BestMatchHover (ITextHover): void</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/9)</TD><TD CLASS="h">0%   (0/2)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#2">createTextHoversList (): List</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/46)</TD><TD CLASS="h">0%   (0/9)</TD></TR><TR><TD CLASS="f"><A HREF="#3">getHoverControlCreator (): IInformationControlCreator</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/13)</TD><TD CLASS="h">0%   (0/4)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#4">getHoverInfo (ITextViewer, IRegion): String</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/34)</TD><TD CLASS="h">0%   (0/9)</TD></TR><TR><TD CLASS="f"><A HREF="#5">getHoverRegion (ITextViewer, int): IRegion</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/34)</TD><TD CLASS="h">0%   (0/10)</TD></TR><TR CLASS="o"><TD CLASS="f"><A HREF="#6">getTextHovers (): List</A></TD><TD> </TD><TD CLASS="h">0%   (0/1)</TD><TD CLASS="h">0%   (0/10)</TD><TD CLASS="h">0%   (0/3)</TD></TR><TR><TD CLASS="f"><A HREF="#7">BestMatchHover (ITextHover []): void</A></TD><TD> </TD><TD>100% (1/1)</TD><TD>100% (6/6)</TD><TD>100% (3/3)</TD></TR></TABLE><P></P><TABLE CLASS="s" CELLSPACING="0" WIDTH="100%"><TR><TD CLASS="l">1</TD><TD>/*******************************************************************************</TD></TR><TR><TD CLASS="l">2</TD><TD> * Copyright (c) 2005, 2006 IBM Corporation and others.</TD></TR><TR><TD CLASS="l">3</TD><TD> * All rights reserved. This program and the accompanying materials</TD></TR><TR><TD CLASS="l">4</TD><TD> * are made available under the terms of the Eclipse Public License v1.0</TD></TR><TR><TD CLASS="l">5</TD><TD> * which accompanies this distribution, and is available at</TD></TR><TR><TD CLASS="l">6</TD><TD> * http://www.eclipse.org/legal/epl-v10.html</TD></TR><TR><TD CLASS="l">7</TD><TD> *</TD></TR><TR><TD CLASS="l">8</TD><TD> * Contributors:</TD></TR><TR><TD CLASS="l">9</TD><TD> *     IBM Corporation - initial API and implementation</TD></TR><TR><TD CLASS="l">10</TD><TD> *     Jens Lukowski/Innoopract - initial renaming/restructuring</TD></TR><TR><TD CLASS="l">11</TD><TD> *     </TD></TR><TR><TD CLASS="l">12</TD><TD> *******************************************************************************/</TD></TR><TR><TD CLASS="l">13</TD><TD>package org.eclipse.wst.sse.ui.internal.taginfo;</TD></TR><TR><TD CLASS="l">14</TD><TD> </TD></TR><TR><TD CLASS="l">15</TD><TD>import java.util.ArrayList;</TD></TR><TR><TD CLASS="l">16</TD><TD>import java.util.Iterator;</TD></TR><TR><TD CLASS="l">17</TD><TD>import java.util.List;</TD></TR><TR><TD CLASS="l">18</TD><TD> </TD></TR><TR><TD CLASS="l">19</TD><TD>import org.eclipse.jface.text.IInformationControlCreator;</TD></TR><TR><TD CLASS="l">20</TD><TD>import org.eclipse.jface.text.IRegion;</TD></TR><TR><TD CLASS="l">21</TD><TD>import org.eclipse.jface.text.ITextHover;</TD></TR><TR><TD CLASS="l">22</TD><TD>import org.eclipse.jface.text.ITextHoverExtension;</TD></TR><TR><TD CLASS="l">23</TD><TD>import org.eclipse.jface.text.ITextViewer;</TD></TR><TR><TD CLASS="l">24</TD><TD>import org.eclipse.wst.sse.ui.internal.Logger;</TD></TR><TR><TD CLASS="l">25</TD><TD> </TD></TR><TR><TD CLASS="l">26</TD><TD>/**</TD></TR><TR><TD CLASS="l">27</TD><TD> * Provides the best hover help documentation (by using other hover help</TD></TR><TR><TD CLASS="l">28</TD><TD> * processors) Priority of hover help processors is: ProblemHoverProcessor,</TD></TR><TR><TD CLASS="l">29</TD><TD> * TagInfoProcessor, AnnotationHoverProcessor</TD></TR><TR><TD CLASS="l">30</TD><TD> */</TD></TR><TR><TD CLASS="l">31</TD><TD>public class BestMatchHover implements ITextHover, ITextHoverExtension {</TD></TR><TR><TD CLASS="l">32</TD><TD>        private ITextHover fBestMatchHover; // current best match text hover</TD></TR><TR><TD CLASS="l">33</TD><TD>        private ITextHover[] fTagInfoHovers; // documentation/information hover</TD></TR><TR><TD CLASS="l"><A NAME="0">34</A></TD><TD>        private List fTextHovers; // list of text hovers to consider in best</TD></TR><TR><TD CLASS="l">35</TD><TD>        // match</TD></TR><TR><TD CLASS="l">36</TD><TD> </TD></TR><TR><TD CLASS="l"><A NAME="7">37</A></TD><TD>        public BestMatchHover(ITextHover infoTagHover) {</TD></TR><TR CLASS="z"><TD CLASS="l">38</TD><TD>                this(new ITextHover[]{infoTagHover});</TD></TR><TR CLASS="z"><TD CLASS="l">39</TD><TD>        }</TD></TR><TR><TD CLASS="l">40</TD><TD> </TD></TR><TR CLASS="c"><TD CLASS="l">41</TD><TD>        public BestMatchHover(ITextHover[] infoTagHovers) {</TD></TR><TR CLASS="c"><TD CLASS="l">42</TD><TD>                fTagInfoHovers = infoTagHovers;</TD></TR><TR CLASS="c"><TD CLASS="l">43</TD><TD>        }</TD></TR><TR><TD CLASS="l">44</TD><TD> </TD></TR><TR><TD CLASS="l">45</TD><TD>        /**</TD></TR><TR><TD CLASS="l">46</TD><TD>         * Create a list of text hovers applicable to this best match hover</TD></TR><TR><TD CLASS="l">47</TD><TD>         * processor</TD></TR><TR><TD CLASS="l"><A NAME="2">48</A></TD><TD>         * </TD></TR><TR><TD CLASS="l">49</TD><TD>         * @return List of ITextHover - in abstract class this is empty list</TD></TR><TR><TD CLASS="l">50</TD><TD>         */</TD></TR><TR><TD CLASS="l">51</TD><TD>        private List createTextHoversList() {</TD></TR><TR CLASS="z"><TD CLASS="l">52</TD><TD>                List hoverList = new ArrayList();</TD></TR><TR><TD CLASS="l">53</TD><TD>                // if currently debugging, then add the debug hover to the list of</TD></TR><TR><TD CLASS="l">54</TD><TD>                // best match</TD></TR><TR CLASS="z"><TD CLASS="l">55</TD><TD>                if (Logger.isTracing(DebugInfoHoverProcessor.TRACEFILTER)) {</TD></TR><TR CLASS="z"><TD CLASS="l">56</TD><TD>                        hoverList.add(new DebugInfoHoverProcessor());</TD></TR><TR><TD CLASS="l">57</TD><TD>                }</TD></TR><TR><TD CLASS="l">58</TD><TD> </TD></TR><TR CLASS="z"><TD CLASS="l">59</TD><TD>                hoverList.add(new ProblemAnnotationHoverProcessor());</TD></TR><TR><TD CLASS="l">60</TD><TD>                </TD></TR><TR CLASS="z"><TD CLASS="l">61</TD><TD>                if (fTagInfoHovers != null) {</TD></TR><TR CLASS="z"><TD CLASS="l">62</TD><TD>                        for (int i = 0; i &lt; fTagInfoHovers.length; i++) {</TD></TR><TR CLASS="z"><TD CLASS="l">63</TD><TD>                                hoverList.add(fTagInfoHovers[i]);</TD></TR><TR><TD CLASS="l">64</TD><TD>                        }</TD></TR><TR><TD CLASS="l">65</TD><TD>                }</TD></TR><TR CLASS="z"><TD CLASS="l">66</TD><TD>                hoverList.add(new AnnotationHoverProcessor());</TD></TR><TR CLASS="z"><TD CLASS="l"><A NAME="3">67</A></TD><TD>                return hoverList;</TD></TR><TR><TD CLASS="l">68</TD><TD>        }</TD></TR><TR><TD CLASS="l">69</TD><TD> </TD></TR><TR><TD CLASS="l">70</TD><TD>        public IInformationControlCreator getHoverControlCreator() {</TD></TR><TR CLASS="z"><TD CLASS="l">71</TD><TD>                IInformationControlCreator creator = null;</TD></TR><TR><TD CLASS="l">72</TD><TD> </TD></TR><TR CLASS="z"><TD CLASS="l">73</TD><TD>                if (fBestMatchHover instanceof ITextHoverExtension) {</TD></TR><TR CLASS="z"><TD CLASS="l">74</TD><TD>                        creator = ((ITextHoverExtension) fBestMatchHover).getHoverControlCreator();</TD></TR><TR><TD CLASS="l">75</TD><TD>                }</TD></TR><TR CLASS="z"><TD CLASS="l">76</TD><TD>                return creator;</TD></TR><TR><TD CLASS="l">77</TD><TD>        }</TD></TR><TR><TD CLASS="l">78</TD><TD> </TD></TR><TR><TD CLASS="l">79</TD><TD>        /*</TD></TR><TR><TD CLASS="l">80</TD><TD>         * (non-Javadoc)</TD></TR><TR><TD CLASS="l">81</TD><TD>         * </TD></TR><TR><TD CLASS="l"><A NAME="4">82</A></TD><TD>         * @see org.eclipse.jface.text.ITextHover#getHoverInfo(org.eclipse.jface.text.ITextViewer,</TD></TR><TR><TD CLASS="l">83</TD><TD>         *      org.eclipse.jface.text.IRegion)</TD></TR><TR><TD CLASS="l">84</TD><TD>         */</TD></TR><TR><TD CLASS="l">85</TD><TD>        public String getHoverInfo(ITextViewer viewer, IRegion hoverRegion) {</TD></TR><TR CLASS="z"><TD CLASS="l">86</TD><TD>                String displayText = null;</TD></TR><TR><TD CLASS="l">87</TD><TD> </TD></TR><TR><TD CLASS="l">88</TD><TD>                // already have a best match hover picked out from getHoverRegion call</TD></TR><TR CLASS="z"><TD CLASS="l">89</TD><TD>                if (fBestMatchHover != null) {</TD></TR><TR CLASS="z"><TD CLASS="l">90</TD><TD>                        displayText = fBestMatchHover.getHoverInfo(viewer, hoverRegion);</TD></TR><TR><TD CLASS="l">91</TD><TD>                }</TD></TR><TR><TD CLASS="l">92</TD><TD>                // either had no best match hover or best match hover returned null</TD></TR><TR CLASS="z"><TD CLASS="l">93</TD><TD>                if (displayText == null) {</TD></TR><TR><TD CLASS="l">94</TD><TD>                        // go through list of text hovers and return first display string</TD></TR><TR CLASS="z"><TD CLASS="l">95</TD><TD>                        Iterator i = getTextHovers().iterator();</TD></TR><TR CLASS="z"><TD CLASS="l">96</TD><TD>                        while ((i.hasNext()) &amp;&amp; (displayText == null)) {</TD></TR><TR CLASS="z"><TD CLASS="l">97</TD><TD>                                ITextHover hover = (ITextHover) i.next();</TD></TR><TR CLASS="z"><TD CLASS="l">98</TD><TD>                                displayText = hover.getHoverInfo(viewer, hoverRegion);</TD></TR><TR><TD CLASS="l">99</TD><TD>                        }</TD></TR><TR><TD CLASS="l">100</TD><TD>                }</TD></TR><TR CLASS="z"><TD CLASS="l">101</TD><TD>                return displayText;</TD></TR><TR><TD CLASS="l">102</TD><TD>        }</TD></TR><TR><TD CLASS="l">103</TD><TD> </TD></TR><TR><TD CLASS="l">104</TD><TD>        /*</TD></TR><TR><TD CLASS="l">105</TD><TD>         * (non-Javadoc)</TD></TR><TR><TD CLASS="l">106</TD><TD>         * </TD></TR><TR><TD CLASS="l"><A NAME="5">107</A></TD><TD>         * @see org.eclipse.jface.text.ITextHover#getHoverRegion(org.eclipse.jface.text.ITextViewer,</TD></TR><TR><TD CLASS="l">108</TD><TD>         *      int)</TD></TR><TR><TD CLASS="l">109</TD><TD>         */</TD></TR><TR><TD CLASS="l">110</TD><TD>        public IRegion getHoverRegion(ITextViewer viewer, int offset) {</TD></TR><TR CLASS="z"><TD CLASS="l">111</TD><TD>                IRegion hoverRegion = null;</TD></TR><TR><TD CLASS="l">112</TD><TD> </TD></TR><TR><TD CLASS="l">113</TD><TD>                // go through list of text hovers and return first hover region</TD></TR><TR CLASS="z"><TD CLASS="l">114</TD><TD>                ITextHover hover = null;</TD></TR><TR CLASS="z"><TD CLASS="l">115</TD><TD>                Iterator i = getTextHovers().iterator();</TD></TR><TR CLASS="z"><TD CLASS="l">116</TD><TD>                while ((i.hasNext()) &amp;&amp; (hoverRegion == null)) {</TD></TR><TR CLASS="z"><TD CLASS="l">117</TD><TD>                        hover = (ITextHover) i.next();</TD></TR><TR CLASS="z"><TD CLASS="l">118</TD><TD>                        hoverRegion = hover.getHoverRegion(viewer, offset);</TD></TR><TR><TD CLASS="l">119</TD><TD>                }</TD></TR><TR><TD CLASS="l">120</TD><TD> </TD></TR><TR><TD CLASS="l">121</TD><TD>                // store the text hover processor that found region</TD></TR><TR CLASS="z"><TD CLASS="l">122</TD><TD>                if (hoverRegion != null)</TD></TR><TR CLASS="z"><TD CLASS="l">123</TD><TD>                        fBestMatchHover = hover;</TD></TR><TR><TD CLASS="l">124</TD><TD>                else</TD></TR><TR CLASS="z"><TD CLASS="l">125</TD><TD>                        fBestMatchHover = null;</TD></TR><TR><TD CLASS="l">126</TD><TD> </TD></TR><TR CLASS="z"><TD CLASS="l"><A NAME="6">127</A></TD><TD>                return hoverRegion;</TD></TR><TR><TD CLASS="l">128</TD><TD>        }</TD></TR><TR><TD CLASS="l">129</TD><TD> </TD></TR><TR><TD CLASS="l">130</TD><TD>        private List getTextHovers() {</TD></TR><TR CLASS="z"><TD CLASS="l">131</TD><TD>                if (fTextHovers == null) {</TD></TR><TR CLASS="z"><TD CLASS="l">132</TD><TD>                        fTextHovers = createTextHoversList();</TD></TR><TR><TD CLASS="l">133</TD><TD>                }</TD></TR><TR CLASS="z"><TD CLASS="l">134</TD><TD>                return fTextHovers;</TD></TR><TR><TD CLASS="l">135</TD><TD>        }</TD></TR><TR><TD CLASS="l">136</TD><TD>}</TD></TR></TABLE><P></P><TABLE CLASS="hdft" CELLSPACING="0" WIDTH="100%"><TR><TD CLASS="nv">[<A HREF="../xslUnitTestCoverage.html">all classes</A>][<A HREF="90.html">org.eclipse.wst.sse.ui.internal.taginfo</A>]</TD></TR><TR><TD CLASS="tl"><A HREF="http://www.eclemma.org/support.html">EMMA 2.0.5312 EclEmma Fix 1</A> (C) Vladimir Roubtsov</TD></TR></TABLE></BODY></HTML>