001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.cnd.modelimpl.parser.apt;
043:
044: import java.io.File;
045: import java.io.IOException;
046: import java.util.Stack;
047: import org.netbeans.modules.cnd.apt.structure.APTFile;
048: import org.netbeans.modules.cnd.apt.structure.APTInclude;
049: import org.netbeans.modules.cnd.apt.support.APTHandlersSupport;
050: import org.netbeans.modules.cnd.apt.support.APTIncludeHandler;
051: import org.netbeans.modules.cnd.apt.support.APTPreprocHandler;
052: import org.netbeans.modules.cnd.apt.support.APTWalker;
053: import org.netbeans.modules.cnd.modelimpl.csm.core.FileImpl;
054: import org.netbeans.modules.cnd.modelimpl.csm.core.ProjectBase;
055:
056: /**
057: * special walker to restore preprocessor state from include stack
058: * @author Vladimir Voskresensky
059: */
060: public class APTRestorePreprocStateWalker extends
061: APTProjectFileBasedWalker {
062: private final String interestedFile;
063: private final Stack/*<IncludeInfo>*/inclStack;
064: private final APTIncludeHandler.IncludeInfo stopDirective;
065: private final boolean searchInterestedFile;
066:
067: /** Creates a new instance of APTRestorePreprocStateWalker */
068: public APTRestorePreprocStateWalker(ProjectBase base, APTFile apt,
069: FileImpl file, APTPreprocHandler preprocHandler,
070: Stack/*<IncludeInfo>*/inclStack, String interestedFile) {
071: super (base, apt, file, preprocHandler);
072: this .searchInterestedFile = true;
073: this .interestedFile = interestedFile;
074: this .inclStack = inclStack;
075: assert (!inclStack.empty());
076: this .stopDirective = (APTIncludeHandler.IncludeInfo) this .inclStack
077: .pop();
078: assert (stopDirective != null);
079: }
080:
081: /** Creates a new instance of APTRestorePreprocStateWalker */
082: public APTRestorePreprocStateWalker(ProjectBase base, APTFile apt,
083: FileImpl file, APTPreprocHandler preprocHandler) {
084: super (base, apt, file, preprocHandler);
085: this .searchInterestedFile = false;
086: this .interestedFile = null;
087: this .inclStack = null;
088: this .stopDirective = null;
089: }
090:
091: protected FileImpl includeAction(ProjectBase inclFileOwner,
092: String inclPath, int mode, APTInclude apt)
093: throws IOException {
094: FileImpl csmFile = null;
095: boolean foundDirective = false;
096: if (searchInterestedFile) {
097: // check if stop directive is met
098: if (apt.getToken().getLine() == stopDirective
099: .getIncludeDirectiveLine()) {
100: if (inclPath.equals(stopDirective.getIncludedPath())) {
101: foundDirective = true;
102: } else {
103: // we restored by incorrect include stack, see comment to this.visit()
104: APTHandlersSupport
105: .invalidatePreprocHandler(getPreprocHandler());
106: super .stop();
107: return null;
108: }
109: }
110: }
111: try {
112: csmFile = inclFileOwner.getFile(new File(inclPath));
113: if (csmFile == null) {
114: // this might happen if the file has been just deleted from project
115: return null;
116: }
117: if (foundDirective) {
118: // we met candidate to stop on #include directive
119: assert inclStack != null;
120: // look if it the real target or target is in sub-#include
121: if (!inclStack.empty()) {
122: // this is not the target
123: // need to continue restoring in sub-#includes
124: APTFile aptLight = inclFileOwner
125: .getAPTLight(csmFile);
126: if (aptLight != null) {
127: APTWalker walker = new APTRestorePreprocStateWalker(
128: getStartProject(), aptLight, csmFile,
129: getPreprocHandler(), inclStack,
130: interestedFile);
131: walker.visit();
132: } else {
133: // expected #included file was deleted
134: csmFile = null;
135: }
136: }
137: } else {
138: // usual gathering macro map without check on #include directives
139: APTFile aptLight = inclFileOwner.getAPTLight(csmFile);
140: if (aptLight != null) {
141: APTWalker walker = new APTRestorePreprocStateWalker(
142: getStartProject(), aptLight, csmFile,
143: getPreprocHandler());
144: walker.visit();
145: } else {
146: // expected #included file was deleted
147: csmFile = null;
148: }
149: }
150: } finally {
151: if (foundDirective) {
152: // we restored everything. Time to stop
153: // but do not clear includes way => no popInclude
154: super .stop();
155: } else {
156: getIncludeHandler().popInclude();
157: }
158: }
159: return csmFile;
160: }
161:
162: @Override
163: public void visit() {
164: super .visit();
165: if (searchInterestedFile && !super .isStopped()) {
166: // For now we don't escalate changes to library headers which means
167: // you can get get obsolete preprocessor state for library headers.
168: // In those cases library headers should be "presented" in their
169: // natural state with preprocessor state got from project properties only
170: APTHandlersSupport
171: .invalidatePreprocHandler(getPreprocHandler());
172: // See IZ119620, IZ120478
173: }
174: }
175:
176: }
|