01: /*
02: * Spoon - http://spoon.gforge.inria.fr/
03: * Copyright (C) 2006 INRIA Futurs <renaud.pawlak@inria.fr>
04: *
05: * This software is governed by the CeCILL-C License under French law and
06: * abiding by the rules of distribution of free software. You can use, modify
07: * and/or redistribute the software under the terms of the CeCILL-C license as
08: * circulated by CEA, CNRS and INRIA at http://www.cecill.info.
09: *
10: * This program is distributed in the hope that it will be useful, but WITHOUT
11: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12: * FITNESS FOR A PARTICULAR PURPOSE. See the CeCILL-C License for more details.
13: *
14: * The fact that you are presently reading this means that you have had
15: * knowledge of the CeCILL-C license and that you accept its terms.
16: */
17:
18: package spoon.reflect.visitor;
19:
20: import java.util.Stack;
21:
22: import spoon.processing.Environment;
23: import spoon.processing.Severity;
24: import spoon.reflect.declaration.CtElement;
25:
26: /**
27: * This scanner checks that a program model is consistent whith regards to the
28: * parent elements (children must have the right parent). This class can be used
29: * to validate that a program transformation does not harm the model integrity,
30: * and also to automatically fix it when possible.
31: */
32: public class ModelConsistencyChecker extends CtScanner {
33:
34: boolean fixInconsistencies = false;
35:
36: Environment environment;
37:
38: Stack<CtElement> stack = new Stack<CtElement>();
39:
40: /**
41: * Creates a new model consistency checker.
42: *
43: * @param environment
44: * the environment where to report errors
45: * @param fixInconsistencies
46: * automatically fix the inconsitencies rather than reporting
47: * warnings (to report warnings, set this to false)
48: */
49: public ModelConsistencyChecker(Environment environment,
50: boolean fixInconsistencies) {
51: this .fixInconsistencies = fixInconsistencies;
52: this .environment = environment;
53: }
54:
55: /**
56: * Enters an element.
57: */
58: @Override
59: public void enter(CtElement element) {
60: if (!stack.isEmpty()) {
61: if (element.getParent() != stack.peek()) {
62: if (fixInconsistencies) {
63: element.setParent(stack.peek());
64: } else {
65: environment.report(null, Severity.WARNING,
66: "inconsistent parent for " + element);
67: }
68: }
69: }
70: stack.push(element);
71: }
72:
73: /**
74: * Exits an element.
75: */
76: @Override
77: protected void exit(CtElement e) {
78: stack.pop();
79: }
80:
81: }
|