4284

Committed 17 Dec 2024 11:50AM UTC coverage: 77.673% (-0.02%) from 77.694%

Build # 4284

Build Type

push

github

Committed by

adangel

Commit Message

[java] Fix #2996 - CommentSize/CommentContent suppression (#4939)

Merge pull request #4939 from oowekyala:issue2996-commentsize-suppression

Run Details

17306 of 23228 branches covered (74.5%)

Branch coverage included in aggregate %.

68 of 89 new or added lines in 11 files covered. (76.4%)

2 existing lines in 1 file now uncovered.

38084 of 48084 relevant lines covered (79.2%)

0.8 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/impl/javacc/AbstractJjtreeNode.java

/*
 * BSD-style license; for more info see http://pmd.sourceforge.net/license.html
 */

package net.sourceforge.pmd.lang.ast.impl.javacc;

import net.sourceforge.pmd.lang.ast.Node;
import net.sourceforge.pmd.lang.ast.impl.AbstractNode;
import net.sourceforge.pmd.lang.document.FileLocation;
import net.sourceforge.pmd.lang.document.TextRegion;
import net.sourceforge.pmd.util.StringUtil;

/**
 * Base class for node produced by JJTree. JJTree specific functionality
 * present on the API of {@link Node} and {@link AbstractNode} has been
 * moved here for 7.0.0 (e.g. jjtClose methods).
 */
public abstract class AbstractJjtreeNode<B extends AbstractJjtreeNode<B, N>, N extends JjtreeNode<N>> extends AbstractNode<B, N> implements JjtreeNode<N> {
    protected final int id;
    private JavaccToken firstToken;
    private JavaccToken lastToken;

    private String image;

    /**
     * The id is an index in the constant names array generated by jjtree,
     * it must be set to some value that depends on the node type, not some
     * arbitrary "1" or "2", and not necessarily a unique value.
     */
    protected AbstractJjtreeNode(int id) {
        super();
        this.id = id;
    }

    @Override
    // @Deprecated // todo deprecate, will change tree dump tests (#4787)
    public String getImage() {
        return image;
    }

    protected void setImage(String image) {
        this.image = image;
    }

    @Override
    public final TextRegion getTextRegion() {
        return TextRegion.fromBothOffsets(getFirstToken().getStartOffset(),
                                          getLastToken().getEndOffset());
    }

    @Override
    public final int compareLocation(Node other) {
        if (other instanceof JjtreeNode<?>) {
            return getTextRegion().compareTo(((JjtreeNode<?>) other).getTextRegion());
        }
        return super.compareLocation(other);
    }

    /**
     * This method is called after the node has been made the current node. It
     * indicates that child nodes can now be added to it.
     */
    protected void jjtOpen() {
        // to be overridden
    }

    /**
     * This method is called after all the child nodes have been added.
     */
    protected void jjtClose() {
        // to be overridden
    }

    @Override // override to make it protected
    protected void addChild(B child, int index) {
        super.addChild(child, index);
    }


    @Override
    protected void insertChild(B child, int index) {
        super.insertChild(child, index);
        fitTokensToChildren(index);
    }

    /**
     * Ensures that the first (resp. last) token of this node is before
     * (resp. after) the first (resp. last) token of the child at the
     * given index. The index
     */
    protected void fitTokensToChildren(int index) {
        if (index == 0) {
            enlargeLeft(getChild(index).getFirstToken());
        }
        if (index == getNumChildren()) {
            enlargeRight(getChild(index).getLastToken());
        }
    }

    protected void enlargeLeft(JavaccToken childFst) {
        JavaccToken thisFst = this.getFirstToken();

        if (childFst.compareTo(thisFst) < 0) {
            this.setFirstToken(childFst);
        }
    }

    private void enlargeRight(JavaccToken childLast) {
        JavaccToken thisLast = this.getLastToken();

        if (childLast.compareTo(thisLast) > 0) {
            this.setLastToken(childLast);
        }
    }

    @Override
    public JavaccToken getFirstToken() {
        return firstToken;
    }

    @Override
    public JavaccToken getLastToken() {
        return lastToken;
    }

    // the super methods query line & column, which we want to avoid

    protected void setLastToken(JavaccToken token) {
        this.lastToken = token;
    }

    protected void setFirstToken(JavaccToken token) {
        this.firstToken = token;
    }

    /**
     * This toString implementation is only meant for debugging purposes.
     */
    @Override
    public String toString() {
        FileLocation loc = getReportLocation();
        return "!debug only! [" + getXPathNodeName() + ":" + loc.getStartPos().toDisplayStringWithColon() + "]"
            + StringUtil.elide(getText().toString(), 150, "(truncated)");
    }
}

1	/*
2	* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
3	*/
4
5	package net.sourceforge.pmd.lang.ast.impl.javacc;
6
7	import net.sourceforge.pmd.lang.ast.Node;
8	import net.sourceforge.pmd.lang.ast.impl.AbstractNode;
9	import net.sourceforge.pmd.lang.document.FileLocation;
10	import net.sourceforge.pmd.lang.document.TextRegion;
11	import net.sourceforge.pmd.util.StringUtil;
12
13	/**
14	* Base class for node produced by JJTree. JJTree specific functionality
15	* present on the API of {@link Node} and {@link AbstractNode} has been
16	* moved here for 7.0.0 (e.g. jjtClose methods).
17	*/
18	public abstract class AbstractJjtreeNode<B extends AbstractJjtreeNode<B, N>, N extends JjtreeNode<N>> extends AbstractNode<B, N> implements JjtreeNode<N> {
19	protected final int id;
20	private JavaccToken firstToken;
21	private JavaccToken lastToken;
22
23	private String image;
24
25	/**
26	* The id is an index in the constant names array generated by jjtree,
27	* it must be set to some value that depends on the node type, not some
28	* arbitrary "1" or "2", and not necessarily a unique value.
29	*/
30	protected AbstractJjtreeNode(int id) {
31	super();	×
32	this.id = id;	×
33	}	×
34
35	@Override
36	// @Deprecated // todo deprecate, will change tree dump tests (#4787)
37	public String getImage() {
38	return image;	×
39	}
40
41	protected void setImage(String image) {
42	this.image = image;	×
43	}	×
44
45	@Override
46	public final TextRegion getTextRegion() {
47	return TextRegion.fromBothOffsets(getFirstToken().getStartOffset(),	×
48	getLastToken().getEndOffset());	×
49	}
50
51	@Override
52	public final int compareLocation(Node other) {
53	if (other instanceof JjtreeNode<?>) {	×
54	return getTextRegion().compareTo(((JjtreeNode<?>) other).getTextRegion());	×
55	}
56	return super.compareLocation(other);	×
57	}
58
59	/**
60	* This method is called after the node has been made the current node. It
61	* indicates that child nodes can now be added to it.
62	*/
63	protected void jjtOpen() {
64	// to be overridden
65	}	×
66
67	/**
68	* This method is called after all the child nodes have been added.
69	*/
70	protected void jjtClose() {
71	// to be overridden
72	}	×
73
74	@Override // override to make it protected
75	protected void addChild(B child, int index) {
76	super.addChild(child, index);	×
77	}	×
78
79
80	@Override
81	protected void insertChild(B child, int index) {
82	super.insertChild(child, index);	×
83	fitTokensToChildren(index);	×
84	}	×
85
86	/**
87	* Ensures that the first (resp. last) token of this node is before
88	* (resp. after) the first (resp. last) token of the child at the
89	* given index. The index
90	*/
91	protected void fitTokensToChildren(int index) {
92	if (index == 0) {	×
NEW 93	enlargeLeft(getChild(index).getFirstToken());	×
94	}
95	if (index == getNumChildren()) {	×
NEW 96	enlargeRight(getChild(index).getLastToken());	×
97	}
98	}	×
99
100	protected void enlargeLeft(JavaccToken childFst) {
101	JavaccToken thisFst = this.getFirstToken();	×
102
UNCOV 103	if (childFst.compareTo(thisFst) < 0) {	×
104	this.setFirstToken(childFst);	×
105	}
106	}	×
107
108	private void enlargeRight(JavaccToken childLast) {
109	JavaccToken thisLast = this.getLastToken();	×
110
UNCOV 111	if (childLast.compareTo(thisLast) > 0) {	×
112	this.setLastToken(childLast);	×
113	}
114	}	×
115
116	@Override
117	public JavaccToken getFirstToken() {
118	return firstToken;	×
119	}
120
121	@Override
122	public JavaccToken getLastToken() {
123	return lastToken;	×
124	}
125
126	// the super methods query line & column, which we want to avoid
127
128	protected void setLastToken(JavaccToken token) {
129	this.lastToken = token;	×
130	}	×
131
132	protected void setFirstToken(JavaccToken token) {
133	this.firstToken = token;	×
134	}	×
135
136	/**
137	* This toString implementation is only meant for debugging purposes.
138	*/
139	@Override
140	public String toString() {
141	FileLocation loc = getReportLocation();	×
142	return "!debug only! [" + getXPathNodeName() + ":" + loc.getStartPos().toDisplayStringWithColon() + "]"	×
143	+ StringUtil.elide(getText().toString(), 150, "(truncated)");	×
144	}
145	}

pmd / pmd / 4284

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous