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-2006 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: package org.netbeans.modules.php.editor.completion;
042:
043: import java.io.IOException;
044: import java.util.ArrayList;
045: import java.util.List;
046: import org.netbeans.modules.gsf.api.CompletionProposal;
047:
048: /**
049: * Implementation of the <code>CompletionResultProvider</code> for the foreign
050: * context (i.e. non-PHP context).
051: * <p><b>Note that this implementation is not synchronized.</b></p>
052: *
053: * @author Victor G. Vasilyev
054: */
055: public class ForeignScope extends ASTBasedProvider implements
056: CompletionResultProvider {
057:
058: protected final List<CompletionProposal> proposalList = new ArrayList<CompletionProposal>();
059:
060: /**
061: * Returns <code>true</code> iif the specified <code>context</code>
062: * is applicable for inserting opening PHP tag.
063: * E.g
064: * <p> ... some foreign code ...<br/>
065: * <b><?php</b> ... <b>?></b><br/>
066: * ... some foreign code ...
067: * </p>
068: * @param context
069: * @return <code>true</code> iif the specified <code>context</code>
070: * is applicable.
071: */
072: public boolean isApplicable(CodeCompletionContext context) {
073: init(context);
074: try {
075: assertPHPContext();
076: return false; // fault - PHP context is not applicable.
077: } catch (IOException ioe) {
078: return false; // fault - Document is not accesible.
079: } catch (Exception e) {
080: // OK. It is non-PHP context.
081: }
082: try {
083: assertMIMETypePHP();
084: return true;
085: } catch (Exception e) {
086: return false; // The specified context is outside of the PHP project.
087: }
088: }
089:
090: public List<CompletionProposal> getProposals(
091: final CodeCompletionContext context) {
092: checkContext(context);
093: proposalList.add(new PHPBlockItem(context));
094: return proposalList;
095: }
096:
097: protected void init(CodeCompletionContext context) {
098: assert context != null;
099: myContext = context;
100: proposalList.clear();
101: }
102:
103: }
|