Attachment #62436 for bug #136597

This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

View | Details | Raw Unified | Return to bug 136597
Collapse All | Expand All

Lines 52-58 Link Here

(-)a/ant.freeform/nbproject/project.xml (-1 / +1 lines)
52	<compile-dependency/>	52	<compile-dependency/>
53	<run-dependency>	53	<run-dependency>
54	<release-version>3</release-version>	54	<release-version>3</release-version>
55	<specification-version>3.11</specification-version>	55	<specification-version>3.31</specification-version>
56	</run-dependency>	56	</run-dependency>
57	</dependency>	57	</dependency>
58	<dependency>	58	<dependency>





package org.netbeans.modules.ant.freeform;

import java.io.File;
import java.io.IOException;
import java.text.Collator;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.regex.Pattern;
import javax.swing.event.ChangeListener;
import org.apache.tools.ant.module.api.AntProjectCookie;
import org.apache.tools.ant.module.api.support.TargetLister;
import org.netbeans.api.project.Project;
import org.netbeans.modules.ant.freeform.spi.HelpIDFragmentProvider;
import org.openide.ErrorManager;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.loaders.DataObject;
import org.openide.loaders.DataObjectNotFoundException;
import org.openide.xml.XMLUtil;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.ErrorHandler;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;

/**
 * Miscellaneous utilities.

    
    public static final ErrorManager err = ErrorManager.getDefault().getInstance("org.netbeans.modules.ant.freeform"); // NOI18N
    
    /**
     * Returns name of the Ant script represented by the given file object.
     * @param fo Ant script which name should be returned
     * @return name of the Ant script as specified in name attribute of
     *    project element or null if fo does not represent valid Ant script
     *    or the script is anonymous
     */
    public static String getAntScriptName(FileObject fo) {
        AntProjectCookie apc = getAntProjectCookie(fo);
        if (apc == null) {
            return null;
        }
        Element projEl = apc.getProjectElement();
        if (projEl == null) {
            return null;
        }
        String name = projEl.getAttribute("name"); // NOI18N
        // returns "" if no such attribute
        return name.length() > 0 ? name : null;
    }
    
    private static AntProjectCookie getAntProjectCookie(FileObject fo) {
        DataObject dob;
        try {
            dob = DataObject.find(fo);
        } catch (DataObjectNotFoundException ex) {
            Util.err.notify(ErrorManager.INFORMATIONAL, ex);
            return null;
        }
        assert dob != null;
        AntProjectCookie apc = dob.getCookie(AntProjectCookie.class);
        if (apc == null && /* #88430 */fo.isData()) {
            // Some file that *could* be an Ant script and just wasn't recognized
            // as such? Cf. also TargetLister.getAntProjectCookie, which has the
            // advantage of being inside the Ant module and therefore able to
            // directly instantiate AntProjectSupport.
            try {
                apc = forceParse(fo);
            } catch (IOException e) {
                err.notify(ErrorManager.INFORMATIONAL, e);
            } catch (SAXException e) {
                err.log("Parse error in " + fo + ": " + e);
            }
        }
        return apc;
    }

    private static final Pattern VALIDATION = Pattern.compile("([A-Za-z0-9])+"); // NOI18N
    
    public static String getMergedHelpIDFragments(Project p) {

        return result.toString();
    }
    
    /**
     * Returns sorted list of targets name of the Ant script represented by the
     * given file object.
     * @param fo Ant script which target names should be returned
     * @return sorted list of target names or null if fo does not represent 
     * valid Ant script
     */
    public static List<String> getAntScriptTargetNames(FileObject fo) {
        if (fo == null) {
            throw new IllegalArgumentException("Cannot call Util.getAntScriptTargetNames with null"); // NOI18N
        }
        AntProjectCookie apc = getAntProjectCookie(fo);
        if (apc == null) {
            return null;
        }
        Set<TargetLister.Target> allTargets;
        try {
            allTargets = TargetLister.getTargets(apc);
        } catch (IOException e) {
            err.notify(ErrorManager.INFORMATIONAL, e);
            return null;
        }
        SortedSet<String> targetNames = new TreeSet<String>(Collator.getInstance());
        for (TargetLister.Target target : allTargets) {
            if (target.isOverridden()) {
                // Cannot call it directly.
                continue;
            }
            if (target.isInternal()) {
                // Should not be called from outside.
                continue;
            }
            targetNames.add(target.getName());
        }
        return new ArrayList<String>(targetNames);
    }
    
    /**
     * Try to parse a (presumably XML) file even though it is not known to be an Ant script.
     */
    private static AntProjectCookie forceParse(FileObject fo) throws IOException, SAXException {
        Document doc = XMLUtil.parse(new InputSource(fo.getURL().toExternalForm()), false, true, new ErrH(), null);
        return new TrivialAntProjectCookie(fo, doc);
    }
    
    private static final class ErrH implements ErrorHandler {
        public ErrH() {}
        public void fatalError(SAXParseException exception) throws SAXException {
            throw exception;
        }
        public void error(SAXParseException exception) throws SAXException {
            throw exception;
        }
        public void warning(SAXParseException exception) throws SAXException {
            // ignore that
        }
    }
    
    private static final class TrivialAntProjectCookie implements AntProjectCookie.ParseStatus {
        
        private final FileObject fo;
        private final Document doc;
        
        public TrivialAntProjectCookie(FileObject fo, Document doc) {
            this.fo = fo;
            this.doc = doc;
        }

        public FileObject getFileObject() {
            return fo;
        }

        public File getFile() {
            return FileUtil.toFile(fo);
        }

        public Document getDocument() {
            return doc;
        }

        public Element getProjectElement() {
            return doc.getDocumentElement();
        }
        
        public boolean isParsed() {
            return true;
        }

        public Throwable getParseException() {
            return null;
        }

        public void addChangeListener(ChangeListener l) {}

        public void removeChangeListener(ChangeListener l) {}

    }
    
}




package org.netbeans.modules.ant.freeform.ui;

import java.io.File;
import java.io.IOException;
import java.text.MessageFormat;
import javax.swing.JFileChooser;
import javax.swing.event.ChangeListener;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import org.apache.tools.ant.module.api.support.AntScriptUtils;
import org.netbeans.api.project.FileOwnerQuery;
import org.netbeans.api.project.Project;
import org.netbeans.api.project.ProjectInformation;
import org.netbeans.modules.ant.freeform.Util;
import org.netbeans.spi.project.ui.support.ProjectChooser;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;

        }
        if (!antScriptValidityChecked) {
            FileObject fo = FileUtil.toFileObject(getAntScript());
            if (fo != null) {
                try {
                    AntScriptUtils.getCallableTargetNames(fo);
                    antScriptValidityChecked = true;
                } catch (IOException x) {/* failed */}
            }
            if (!antScriptValidityChecked) {
                return org.openide.util.NbBundle.getMessage(BasicProjectInfoPanel.class, "LBL_BasicProjectInfoPanel_Error_5");
            }
        }

            if (as.exists()) {
                FileObject fo = FileUtil.toFileObject(as);
                assert fo != null : as;
                String name = AntScriptUtils.getAntScriptName(fo);
                if (name != null) {
                    projectName.setText(name);
                    return;

Lines 44-55 Link Here

(-)a/ant.freeform/src/org/netbeans/modules/ant/freeform/ui/TargetMappingPanel.java (-2 / +9 lines)
44	import java.awt.Frame;	44	import java.awt.Frame;
45	import java.awt.event.ActionEvent;	45	import java.awt.event.ActionEvent;
46	import java.awt.event.ActionListener;	46	import java.awt.event.ActionListener;
		47	import java.io.IOException;
47	import java.util.ArrayList;	48	import java.util.ArrayList;
48	import java.util.Arrays;	49	import java.util.Arrays;
49	import java.util.Collections;	50	import java.util.Collections;
50	import java.util.Iterator;	51	import java.util.Iterator;
51	import java.util.List;	52	import java.util.List;
52	import java.util.StringTokenizer;	53	import java.util.StringTokenizer;
		54	import java.util.logging.Level;
		55	import java.util.logging.Logger;
53	import java.util.regex.Matcher;	56	import java.util.regex.Matcher;
54	import java.util.regex.Pattern;	57	import java.util.regex.Pattern;
55	import javax.swing.ComboBoxModel;	58	import javax.swing.ComboBoxModel;
Lines 60-67 Link Here
60	import javax.swing.JPanel;	63	import javax.swing.JPanel;
61	import javax.swing.WindowConstants;	64	import javax.swing.WindowConstants;
62	import javax.swing.table.AbstractTableModel;	65	import javax.swing.table.AbstractTableModel;
		66	import org.apache.tools.ant.module.api.support.AntScriptUtils;
63	import org.netbeans.modules.ant.freeform.FreeformProjectGenerator;	67	import org.netbeans.modules.ant.freeform.FreeformProjectGenerator;
64	import org.netbeans.modules.ant.freeform.Util;
65	import org.netbeans.modules.ant.freeform.spi.ProjectConstants;	68	import org.netbeans.modules.ant.freeform.spi.ProjectConstants;
66	import org.netbeans.modules.ant.freeform.spi.TargetDescriptor;	69	import org.netbeans.modules.ant.freeform.spi.TargetDescriptor;
67	import org.netbeans.spi.project.support.ant.AntProjectHelper;	70	import org.netbeans.spi.project.support.ant.AntProjectHelper;
Lines 131-137 Link Here
131	List<String> l = null;	134	List<String> l = null;
132	// #50933 - script can be null	135	// #50933 - script can be null
133	if (as != null) {	136	if (as != null) {
134	l = Util.getAntScriptTargetNames(as);	137	try {
		138	l = AntScriptUtils.getCallableTargetNames(as);
		139	} catch (IOException x) {
		140	Logger.getLogger(TargetMappingPanel.class.getName()).log(Level.INFO, "Cannot parse: " + as, x);
		141	}
135	}	142	}
136	if (l != null) {	143	if (l != null) {
137	setTargetNames(l, false);	144	setTargetNames(l, false);

Lines 43-52 Link Here

(-)a/ant.freeform/src/org/netbeans/modules/ant/freeform/ui/TargetMappingWizardPanel.java (-2 / +6 lines)
43		43
44	import java.awt.Component;	44	import java.awt.Component;
45	import java.io.File;	45	import java.io.File;
		46	import java.io.IOException;
46	import java.util.ArrayList;	47	import java.util.ArrayList;
47	import java.util.List;	48	import java.util.List;
48	import javax.swing.event.ChangeListener;	49	import javax.swing.event.ChangeListener;
49	import org.netbeans.modules.ant.freeform.Util;	50	import org.apache.tools.ant.module.api.support.AntScriptUtils;
50	import org.netbeans.modules.ant.freeform.spi.ProjectConstants;	51	import org.netbeans.modules.ant.freeform.spi.ProjectConstants;
51	import org.netbeans.modules.ant.freeform.spi.TargetDescriptor;	52	import org.netbeans.modules.ant.freeform.spi.TargetDescriptor;
52	import org.netbeans.modules.ant.freeform.spi.support.NewFreeformProjectSupport;	53	import org.netbeans.modules.ant.freeform.spi.support.NewFreeformProjectSupport;
Lines 109-115 Link Here
109	FileObject fo = FileUtil.toFileObject(f);	110	FileObject fo = FileUtil.toFileObject(f);
110	// Util.getAntScriptTargetNames can return null when script is	111	// Util.getAntScriptTargetNames can return null when script is
111	// invalid but first panel checks script validity so it is OK here.	112	// invalid but first panel checks script validity so it is OK here.
112	List<String> l = Util.getAntScriptTargetNames(fo);	113	List<String> l = null;
		114	try {
		115	l = AntScriptUtils.getCallableTargetNames(fo);
		116	} catch (IOException x) {/* ignore */}
113	// #47784 - update panel only once or when Ant script has changed	117	// #47784 - update panel only once or when Ant script has changed
114	if (targetNames == null \|\| !targetNames.equals(l)) {	118	if (targetNames == null \|\| !targetNames.equals(l)) {
115	targetNames = new ArrayList<String>(l);	119	targetNames = new ArrayList<String>(l);




import java.util.StringTokenizer;
import javax.swing.DefaultComboBoxModel;
import javax.swing.JPanel;
import org.apache.tools.ant.module.api.support.AntScriptUtils;
import org.netbeans.api.project.ProjectManager;
import org.netbeans.api.project.ProjectUtils;
import org.netbeans.modules.ant.freeform.Actions;
import org.netbeans.modules.ant.freeform.FreeformProject;
import org.netbeans.modules.ant.freeform.FreeformProjectGenerator;
import org.netbeans.spi.project.ActionProvider;
import org.openide.DialogDescriptor;
import org.openide.DialogDisplayer;
import org.openide.NotifyDescriptor;

    private void listTargets() {
        FileObject script = FreeformProjectGenerator.getAntScript(project.helper(), project.evaluator());
        if (script != null) {
            try {
                List<String> targets = AntScriptUtils.getCallableTargetNames(script);
                selectCombo.setModel(new DefaultComboBoxModel(targets.toArray(new String[targets.size()])));
                selectCombo.setSelectedItem("");
            } catch (IOException x) {/* ignore */}
        }
    }





<!-- ACTUAL CHANGES BEGIN HERE: -->

    <changes>

        <change id="AntScriptUtils">
            <api name="general"/>
            <summary>Added <code>AntScriptUtils</code></summary>
            <version major="3" minor="31"/>
            <date day="12" month="6" year="2008"/>
            <author login="jglick"/>
            <compatibility addition="yes"/>
            <description>
                <p>
                    Added a new convenience class for getting some common information from Ant scripts.
                </p>
            </description>
            <class package="org.apache.tools.ant.module.api.support" name="AntScriptUtils"/>
            <issue number="136597"/>
        </change>

        <change id="AntEvent-references">
            <api name="general"/>

Lines 39-45 Link Here

(-)a/o.apache.tools.ant.module/nbproject/project.properties (-1 / +1 lines)
39		39
40	javac.compilerargs=-Xlint:unchecked	40	javac.compilerargs=-Xlint:unchecked
41	javac.source=1.5	41	javac.source=1.5
42	spec.version.base=3.30.0	42	spec.version.base=3.31.0
43	compile.ant.jar=${ant.core.lib}	43	compile.ant.jar=${ant.core.lib}
44	src-bridge.cp.extra=build/classes:${compile.ant.jar}	44	src-bridge.cp.extra=build/classes:${compile.ant.jar}
45	extra.module.files=\	45	extra.module.files=\

Lines 83-89 Link Here

(-)a/o.apache.tools.ant.module/src/org/apache/tools/ant/module/api/support/ActionUtils.java (-1 / +1 lines)
83	if (targetNames != null && targetNames.length == 0) {	83	if (targetNames != null && targetNames.length == 0) {
84	throw new IllegalArgumentException("No targets supplied"); // NOI18N	84	throw new IllegalArgumentException("No targets supplied"); // NOI18N
85	}	85	}
86	AntProjectCookie apc = TargetLister.getAntProjectCookie(buildXml);	86	AntProjectCookie apc = AntScriptUtils.antProjectCookieFor(buildXml);
87	AntTargetExecutor.Env execenv = new AntTargetExecutor.Env();	87	AntTargetExecutor.Env execenv = new AntTargetExecutor.Env();
88	if (properties != null) {	88	if (properties != null) {
89	Properties p = execenv.getProperties();	89	Properties p = execenv.getProperties();




/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 *
 * Portions Copyrighted 2008 Sun Microsystems, Inc.
 */

package org.apache.tools.ant.module.api.support;

import java.io.IOException;
import java.text.Collator;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.WeakHashMap;
import org.apache.tools.ant.module.api.AntProjectCookie;
import org.apache.tools.ant.module.xml.AntProjectSupport;
import org.openide.filesystems.FileObject;
import org.openide.loaders.DataObject;
import org.openide.loaders.DataObjectNotFoundException;
import org.w3c.dom.Element;

/**
 * Convenience utilities for working with Ant scripts.
 * @since org.apache.tools.ant.module/3 3.31
 */
public class AntScriptUtils {

    private AntScriptUtils() {}

    /**
     * Loads a file believed to be an Ant script.
     * @param script a file assumed to be an Ant script
     * @return a handle for it (never null but may or may not be parsable)
     */
    public static AntProjectCookie antProjectCookieFor(FileObject script) {
        try {
            DataObject d = DataObject.find(script);
            AntProjectCookie apc = d.getCookie(AntProjectCookie.class);
            if (apc != null) {
                return apc;
            }
        } catch (DataObjectNotFoundException e) {
            assert false : e;
        }
        // AntProjectDataLoader probably not installed, e.g. from a unit test.
        // Or may not be recognized as an Ant script (e.g. root <project> element has no attributes).
        synchronized (antProjectCookies) {
            AntProjectCookie apc = antProjectCookies.get(script);
            if (apc == null) {
                apc = new AntProjectSupport(script);
                antProjectCookies.put(script, apc);
            }
            return apc;
        }
    }
    private static final Map<FileObject,AntProjectCookie> antProjectCookies = new WeakHashMap<FileObject,AntProjectCookie>();

    /**
     * Finds the name of an Ant script.
     * @param script Ant script to inspect
     * @return name of the Ant script as specified in the <code>name</code> attribute of
     *    the <code>project</code> element, or null if the file is not a valid Ant script
     *    or the script is anonymous
     */
    public static String getAntScriptName(FileObject script) {
        AntProjectCookie apc = antProjectCookieFor(script);
        Element projEl = apc.getProjectElement();
        if (projEl == null) {
            return null;
        }
        String name = projEl.getAttribute("name"); // NOI18N
        // returns "" if no such attribute
        return name.length() > 0 ? name : null;
    }

    /**
     * Finds the names of callable targets in an Ant script.
     * @param script Ant script to inspect
     * @return list of target names, sorted (by locale)
     * @throws IOException if the script cannot be inspected
     */
    public static List<String> getCallableTargetNames(FileObject script) throws IOException {
        AntProjectCookie apc = antProjectCookieFor(script);
        Set<TargetLister.Target> allTargets = TargetLister.getTargets(apc);
        SortedSet<String> targetNames = new TreeSet<String>(Collator.getInstance());
        for (TargetLister.Target target : allTargets) {
            if (target.isOverridden()) {
                // Cannot call it directly.
                continue;
            }
            if (target.isInternal()) {
                // Should not be called from outside.
                continue;
            }
            targetNames.add(target.getName());
        }
        return new ArrayList<String>(targetNames);
    }

}




import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.WeakHashMap;
import org.apache.tools.ant.module.AntSettings;
import org.apache.tools.ant.module.api.AntProjectCookie;
import org.apache.tools.ant.module.xml.AntProjectSupport;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.loaders.DataObject;
import org.openide.loaders.DataObjectNotFoundException;
import org.openide.util.NbCollections;
import org.openide.util.TopologicalSortException;
import org.openide.util.Union2;

                    if (file.canRead()) {
                        FileObject fileObj = FileUtil.toFileObject(file);
                        assert fileObj != null : file;
                        AntProjectCookie importedApc = AntScriptUtils.antProjectCookieFor(fileObj);
                        imports.add(new Script(this, importedApc, alreadyImported, propertyDefs, macroDefs));
                    } else {
                        String optionalS = el.getAttribute("optional"); // NOI18N

        }
        
    }

    /**
     * Try to find an AntProjectCookie for a file.
     */
    static AntProjectCookie getAntProjectCookie(FileObject fo) {
        try {
            DataObject d = DataObject.find(fo);
            AntProjectCookie apc = d.getCookie(AntProjectCookie.class);
            if (apc != null) {
                return apc;
            }
        } catch (DataObjectNotFoundException e) {
            assert false : e;
        }
        // AntProjectDataLoader probably not installed, e.g. from a unit test.
        synchronized (antProjectCookies) {
            AntProjectCookie apc = antProjectCookies.get(fo);
            if (apc == null) {
                apc = new AntProjectSupport(fo);
                antProjectCookies.put(fo, apc);
            }
            return apc;
        }
    }
    private static final Map<FileObject,AntProjectCookie> antProjectCookies = new WeakHashMap<FileObject,AntProjectCookie>();
    
}




import java.util.Map;
import javax.swing.event.ChangeListener;
import org.apache.tools.ant.module.api.AntProjectCookie;
import org.apache.tools.ant.module.api.support.AntScriptUtils;
import org.openide.execution.ExecutorTask;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.loaders.DataObject;
import org.openide.loaders.DataObjectNotFoundException;
import org.openide.util.ChangeSupport;

/**

        if (buildScript != null && buildScript.isFile()) {
            FileObject fo = FileUtil.toFileObject(buildScript);
            assert fo != null;
            return AntScriptUtils.antProjectCookieFor(fo);
                return DataObject.find(fo).getCookie(AntProjectCookie.class);
            } catch (DataObjectNotFoundException e) {
                assert false : e;
            }
        }
        return null;
    }

Lines 52-58 Link Here

(-)a/profiler.freeform/nbproject/project.xml (-1 / +1 lines)
52	<compile-dependency/>	52	<compile-dependency/>
53	<run-dependency>	53	<run-dependency>
54	<release-version>3</release-version>	54	<release-version>3</release-version>
55	<specification-version>3.27</specification-version>	55	<specification-version>3.31</specification-version>
56	</run-dependency>	56	</run-dependency>
57	</dependency>	57	</dependency>
58	<dependency>	58	<dependency>

Lines 54-58 Link Here

(-)a/profiler.freeform/src/org/netbeans/modules/profiler/freeform/Bundle.properties (-2 lines)
54	FreeFormProjectTypeProfiler_CreateNewTargetMsg=Please note that you have to create a <b>new</b> target for profiling, similar to the \"run\" target.<br>Click Help to get information about how to write the profiling targets.	54	FreeFormProjectTypeProfiler_CreateNewTargetMsg=Please note that you have to create a <b>new</b> target for profiling, similar to the \"run\" target.<br>Click Help to get information about how to write the profiling targets.
55	FreeFormProjectTypeProfiler_TargetBoxAccessName=List of targets defined in project build script.	55	FreeFormProjectTypeProfiler_TargetBoxAccessName=List of targets defined in project build script.
56	FreeFormProjectTypeProfiler_TargetBoxAccessDescr=Select target that will be used for profiling.	56	FreeFormProjectTypeProfiler_TargetBoxAccessDescr=Select target that will be used for profiling.
57
58	Util_ParseErrorMsg=Parse error in {0}\: {1}




import java.util.List;
import java.util.Properties;
import javax.swing.*;
import org.apache.tools.ant.module.api.support.AntScriptUtils;
import org.netbeans.modules.profiler.projectsupport.utilities.SourceUtils;
import org.netbeans.modules.profiler.utils.ProjectUtilities;
import org.openide.util.HelpCtx;

    private String selectProfilingTarget(final Project project, final FileObject buildScript, final int type,
            final String currentTarget) {
        final List targets = Util.getAntScriptTargets(buildScript);
        final List l;
        try {
            l = AntScriptUtils.getCallableTargetNames(buildScript);
        } catch (IOException x) {
            Profiler.getDefault().displayError(MessageFormat.format(ERROR_PARSING_BUILDFILE_MSG,
                    new Object[]{ProjectUtils.getInformation(project).getName()                    }));





import org.netbeans.api.project.Project;
import org.openide.ErrorManager;
import org.openide.filesystems.FileObject;
import org.openide.filesystems.FileUtil;
import org.openide.loaders.DataObject;
import org.openide.loaders.DataObjectNotFoundException;
import org.openide.util.NbBundle;
import org.openide.xml.XMLUtil;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.xml.sax.ErrorHandler;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import java.io.File;
import java.io.IOException;
import java.text.Collator;
import java.text.MessageFormat;
import java.util.*;
import org.apache.tools.ant.module.api.support.AntScriptUtils;


/**

 * @author Jesse Glick
 */
public final class Util {
    //~ Inner Classes ------------------------------------------------------------------------------------------------------------

    private static final class ErrH implements ErrorHandler {
        //~ Constructors ---------------------------------------------------------------------------------------------------------

        public ErrH() {
        }

        //~ Methods --------------------------------------------------------------------------------------------------------------

        public void error(final SAXParseException exception)
                   throws SAXException {
            throw exception;
        }

        public void fatalError(final SAXParseException exception)
                        throws SAXException {
            throw exception;
        }

        public void warning(final SAXParseException exception)
                     throws SAXException {
            // ignore that
        }
    }

    private static final class TrivialAntProjectCookie implements AntProjectCookie.ParseStatus {
        //~ Instance fields ------------------------------------------------------------------------------------------------------

        private final Document doc;
        private final FileObject fo;

        //~ Constructors ---------------------------------------------------------------------------------------------------------

        public TrivialAntProjectCookie(final FileObject fo, final Document doc) {
            this.fo = fo;
            this.doc = doc;
        }

        //~ Methods --------------------------------------------------------------------------------------------------------------

        public Document getDocument() {
            return doc;
        }

        public File getFile() {
            return FileUtil.toFile(fo);
        }

        public FileObject getFileObject() {
            return fo;
        }

        public Throwable getParseException() {
            return null;
        }

        public boolean isParsed() {
            return true;
        }

        public Element getProjectElement() {
            return doc.getDocumentElement();
        }

        public void addChangeListener(final ChangeListener l) {
        }

        public void removeChangeListener(final ChangeListener l) {
        }
    }

    //~ Static fields/initializers -----------------------------------------------------------------------------------------------

    // -----
    // I18N String constants
    private static final String PARSE_ERROR_MSG = NbBundle.getMessage(Util.class, "Util_ParseErrorMsg"); // NOI18N
                                                                                                         // -----
    public static final ErrorManager err = ErrorManager.getDefault().getInstance("org.netbeans.modules.profiler.freeform"); // NOI18N


    }

    //~ Methods ------------------------------------------------------------------------------------------------------------------

    /**
     * Returns name of the Ant script represented by the given file object.
     *
     * @param fo Ant script which name should be returned
     * @return name of the Ant script as specified in name attribute of
     *         project element or null if fo does not represent valid Ant script
     *         or the script is anonymous
     */
    public static String getAntScriptName(final FileObject fo) {
        final AntProjectCookie apc = getAntProjectCookie(fo);

        if (apc == null) {
            return null;
        }

        final Element projEl = apc.getProjectElement();

        if (projEl == null) {
            return null;
        }

        final String name = projEl.getAttribute("name"); // NOI18N
                                                         // returns "" if no such attribute

        return (name.length() > 0) ? name : null;
    }

    /**
     * Returns XML element representing the requested target or null if the target does not exist.

            throw new IllegalArgumentException("Cannot call Util.getAntScriptTargetNames with null"); // NOI18N
        }

        final AntProjectCookie apc = AntScriptUtils.antProjectCookieFor(fo);

        if (apc == null) {
            return null;
        }

        final Set /*TargetLister.Target*/ allTargets;


        return null;
    }

    /**
     * Returns sorted list of targets name of the Ant script represented by the
     * given file object.
     *
     * @param fo Ant script which target names should be returned
     * @return sorted list of target names or null if fo does not represent
     *         valid Ant script
     */
    public static List /*<String>*/ getAntScriptTargetNames(final FileObject fo) {
        final List targets = getAntScriptTargets(fo);
        final SortedSet targetNames = new TreeSet(Collator.getInstance());
        final Iterator it = targets.iterator();

        while (it.hasNext()) {
            targetNames.add(((TargetLister.Target) it.next()).getName());
        }

        return new ArrayList(targetNames);
    }

    public static List /*TargetLister.Target*/ getAntScriptTargets(final FileObject buildScript) {
        if (buildScript == null) {
            throw new IllegalArgumentException("Cannot call Util.getAntScriptTargetNames with null"); // NOI18N
        }

        final AntProjectCookie apc = AntScriptUtils.antProjectCookieFor(buildScript);

        if (apc == null) {
            return null;
        }

        final Set /*TargetLister.Target*/ allTargets;


        return org.netbeans.modules.ant.freeform.spi.support.Util.getDefaultAntScript(project);
    }

    private static AntProjectCookie getAntProjectCookie(final FileObject fo) {
        final DataObject dob;

        try {
            dob = DataObject.find(fo);
        } catch (DataObjectNotFoundException ex) {
            Util.err.notify(ErrorManager.INFORMATIONAL, ex);

            return null;
        }

        AntProjectCookie apc = (AntProjectCookie) dob.getCookie(AntProjectCookie.class);

        if ((apc == null) && fo.getMIMEType().equals("text/xml")) { // NOI18N
                                                                    // Some file that *could* be an Ant script and just wasn't recognized
                                                                    // as such? Cf. also TargetLister.getAntProjectCookie, which has the
                                                                    // advantage of being inside the Ant module and therefore able to
                                                                    // directly instantiate AntProjectSupport.

            try {
                apc = forceParse(fo);
            } catch (IOException e) {
                err.notify(ErrorManager.INFORMATIONAL, e);
            } catch (SAXException e) {
                err.log(MessageFormat.format(PARSE_ERROR_MSG, new Object[] { fo, e }));
            }
        }

        return apc;
    }

    /**
     * Try to parse a (presumably XML) file even though it is not known to be an Ant script.
     */
    private static AntProjectCookie forceParse(final FileObject fo)
                                        throws IOException, SAXException {
        final Document doc = XMLUtil.parse(new InputSource(fo.getURL().toExternalForm()), false, true, new ErrH(), null);

        return new TrivialAntProjectCookie(fo, doc);
    }
}

Return to bug 136597

Lines 41-74 Link Here

(-)a/ant.freeform/src/org/netbeans/modules/ant/freeform/Util.java (-165 lines)
41		41
42	package org.netbeans.modules.ant.freeform;	42	package org.netbeans.modules.ant.freeform;
43		43
44	import java.io.File;
45	import java.io.IOException;
46	import java.text.Collator;
47	import java.util.ArrayList;	44	import java.util.ArrayList;
48	import java.util.Collections;	45	import java.util.Collections;
49	import java.util.Iterator;	46	import java.util.Iterator;
50	import java.util.List;	47	import java.util.List;
51	import java.util.Set;
52	import java.util.SortedSet;
53	import java.util.TreeSet;
54	import java.util.regex.Pattern;	48	import java.util.regex.Pattern;
55	import javax.swing.event.ChangeListener;
56	import org.apache.tools.ant.module.api.AntProjectCookie;
57	import org.apache.tools.ant.module.api.support.TargetLister;
58	import org.netbeans.api.project.Project;	49	import org.netbeans.api.project.Project;
59	import org.netbeans.modules.ant.freeform.spi.HelpIDFragmentProvider;	50	import org.netbeans.modules.ant.freeform.spi.HelpIDFragmentProvider;
60	import org.openide.ErrorManager;	51	import org.openide.ErrorManager;
61	import org.openide.filesystems.FileObject;
62	import org.openide.filesystems.FileUtil;
63	import org.openide.loaders.DataObject;
64	import org.openide.loaders.DataObjectNotFoundException;
65	import org.openide.xml.XMLUtil;
66	import org.w3c.dom.Document;
67	import org.w3c.dom.Element;
68	import org.xml.sax.ErrorHandler;
69	import org.xml.sax.InputSource;
70	import org.xml.sax.SAXException;
71	import org.xml.sax.SAXParseException;
72		52
73	/**	53	/**
74	* Miscellaneous utilities.	54	* Miscellaneous utilities.
Lines 80-132 Link Here
80		60
81	public static final ErrorManager err = ErrorManager.getDefault().getInstance("org.netbeans.modules.ant.freeform"); // NOI18N	61	public static final ErrorManager err = ErrorManager.getDefault().getInstance("org.netbeans.modules.ant.freeform"); // NOI18N
82		62
83	/**
84	* Returns name of the Ant script represented by the given file object.
85	* @param fo Ant script which name should be returned
86	* @return name of the Ant script as specified in name attribute of
87	* project element or null if fo does not represent valid Ant script
88	* or the script is anonymous
89	*/
90	public static String getAntScriptName(FileObject fo) {
91	AntProjectCookie apc = getAntProjectCookie(fo);
92	if (apc == null) {
93	return null;
94	}
95	Element projEl = apc.getProjectElement();
96	if (projEl == null) {
97	return null;
98	}
99	String name = projEl.getAttribute("name"); // NOI18N
100	// returns "" if no such attribute
101	return name.length() > 0 ? name : null;
102	}
103
104	private static AntProjectCookie getAntProjectCookie(FileObject fo) {
105	DataObject dob;
106	try {
107	dob = DataObject.find(fo);
108	} catch (DataObjectNotFoundException ex) {
109	Util.err.notify(ErrorManager.INFORMATIONAL, ex);
110	return null;
111	}
112	assert dob != null;
113	AntProjectCookie apc = dob.getCookie(AntProjectCookie.class);
114	if (apc == null && /* #88430 */fo.isData()) {
115	// Some file that could be an Ant script and just wasn't recognized
116	// as such? Cf. also TargetLister.getAntProjectCookie, which has the
117	// advantage of being inside the Ant module and therefore able to
118	// directly instantiate AntProjectSupport.
119	try {
120	apc = forceParse(fo);
121	} catch (IOException e) {
122	err.notify(ErrorManager.INFORMATIONAL, e);
123	} catch (SAXException e) {
124	err.log("Parse error in " + fo + ": " + e);
125	}
126	}
127	return apc;
128	}
129
130	private static final Pattern VALIDATION = Pattern.compile("([A-Za-z0-9])+"); // NOI18N	63	private static final Pattern VALIDATION = Pattern.compile("([A-Za-z0-9])+"); // NOI18N
131		64
132	public static String getMergedHelpIDFragments(Project p) {	65	public static String getMergedHelpIDFragments(Project p) {
Lines 157-258 Link Here
157	return result.toString();	90	return result.toString();
158	}	91	}
159		92
160	/**
161	* Returns sorted list of targets name of the Ant script represented by the
162	* given file object.
163	* @param fo Ant script which target names should be returned
164	* @return sorted list of target names or null if fo does not represent
165	* valid Ant script
166	*/
167	public static List<String> getAntScriptTargetNames(FileObject fo) {
168	if (fo == null) {
169	throw new IllegalArgumentException("Cannot call Util.getAntScriptTargetNames with null"); // NOI18N
170	}
171	AntProjectCookie apc = getAntProjectCookie(fo);
172	if (apc == null) {
173	return null;
174	}
175	Set<TargetLister.Target> allTargets;
176	try {
177	allTargets = TargetLister.getTargets(apc);
178	} catch (IOException e) {
179	err.notify(ErrorManager.INFORMATIONAL, e);
180	return null;
181	}
182	SortedSet<String> targetNames = new TreeSet<String>(Collator.getInstance());
183	for (TargetLister.Target target : allTargets) {
184	if (target.isOverridden()) {
185	// Cannot call it directly.
186	continue;
187	}
188	if (target.isInternal()) {
189	// Should not be called from outside.
190	continue;
191	}
192	targetNames.add(target.getName());
193	}
194	return new ArrayList<String>(targetNames);
195	}
196
197	/**
198	* Try to parse a (presumably XML) file even though it is not known to be an Ant script.
199	*/
200	private static AntProjectCookie forceParse(FileObject fo) throws IOException, SAXException {
201	Document doc = XMLUtil.parse(new InputSource(fo.getURL().toExternalForm()), false, true, new ErrH(), null);
202	return new TrivialAntProjectCookie(fo, doc);
203	}
204
205	private static final class ErrH implements ErrorHandler {
206	public ErrH() {}
207	public void fatalError(SAXParseException exception) throws SAXException {
208	throw exception;
209	}
210	public void error(SAXParseException exception) throws SAXException {
211	throw exception;
212	}
213	public void warning(SAXParseException exception) throws SAXException {
214	// ignore that
215	}
216	}
217
218	private static final class TrivialAntProjectCookie implements AntProjectCookie.ParseStatus {
219
220	private final FileObject fo;
221	private final Document doc;
222
223	public TrivialAntProjectCookie(FileObject fo, Document doc) {
224	this.fo = fo;
225	this.doc = doc;
226	}
227
228	public FileObject getFileObject() {
229	return fo;
230	}
231
232	public File getFile() {
233	return FileUtil.toFile(fo);
234	}
235
236	public Document getDocument() {
237	return doc;
238	}
239
240	public Element getProjectElement() {
241	return doc.getDocumentElement();
242	}
243
244	public boolean isParsed() {
245	return true;
246	}
247
248	public Throwable getParseException() {
249	return null;
250	}
251
252	public void addChangeListener(ChangeListener l) {}
253
254	public void removeChangeListener(ChangeListener l) {}
255
256	}
257
258	}	93	}

Lines 106-111 Link Here

(-)a/o.apache.tools.ant.module/apichanges.xml (+16 lines)
106	<!-- ACTUAL CHANGES BEGIN HERE: -->	106	<!-- ACTUAL CHANGES BEGIN HERE: -->
107		107
108	<changes>	108	<changes>
		109
		110	<change id="AntScriptUtils">
		111	<api name="general"/>
		112	<summary>Added <code>AntScriptUtils</code></summary>
		113	<version major="3" minor="31"/>
		114	<date day="12" month="6" year="2008"/>
		115	<author login="jglick"/>
		116	<compatibility addition="yes"/>
		117	<description>
		118	<p>
		119	Added a new convenience class for getting some common information from Ant scripts.
		120	</p>
		121	</description>
		122	<class package="org.apache.tools.ant.module.api.support" name="AntScriptUtils"/>
		123	<issue number="136597"/>
		124	</change>
109		125
110	<change id="AntEvent-references">	126	<change id="AntEvent-references">
111	<api name="general"/>	127	<api name="general"/>

Line 0 Link Here

(-)a/o.apache.tools.ant.module/src/org/apache/tools/ant/module/api/support/AntScriptUtils.java (+136 lines)
		1	/*
		2	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
		3	*
		4	* Copyright 2008 Sun Microsystems, Inc. All rights reserved.
		5	*
		6	* The contents of this file are subject to the terms of either the GNU
		7	* General Public License Version 2 only ("GPL") or the Common
		8	* Development and Distribution License("CDDL") (collectively, the
		9	* "License"). You may not use this file except in compliance with the
		10	* License. You can obtain a copy of the License at
		11	* http://www.netbeans.org/cddl-gplv2.html
		12	* or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
		13	* specific language governing permissions and limitations under the
		14	* License. When distributing the software, include this License Header
		15	* Notice in each file and include the License file at
		16	* nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
		17	* particular file as subject to the "Classpath" exception as provided
		18	* by Sun in the GPL Version 2 section of the License file that
		19	* accompanied this code. If applicable, add the following below the
		20	* License Header, with the fields enclosed by brackets [] replaced by
		21	* your own identifying information:
		22	* "Portions Copyrighted [year] [name of copyright owner]"
		23	*
		24	* If you wish your version of this file to be governed by only the CDDL
		25	* or only the GPL Version 2, indicate your decision by adding
		26	* "[Contributor] elects to include this software in this distribution
		27	* under the [CDDL or GPL Version 2] license." If you do not indicate a
		28	* single choice of license, a recipient has the option to distribute
		29	* your version of this file under either the CDDL, the GPL Version 2 or
		30	* to extend the choice of license to its licensees as provided above.
		31	* However, if you add GPL Version 2 code and therefore, elected the GPL
		32	* Version 2 license, then the option applies only if the new code is
		33	* made subject to such option by the copyright holder.
		34	*
		35	* Contributor(s):
		36	*
		37	* Portions Copyrighted 2008 Sun Microsystems, Inc.
		38	*/
		39
		40	package org.apache.tools.ant.module.api.support;
		41
		42	import java.io.IOException;
		43	import java.text.Collator;
		44	import java.util.ArrayList;
		45	import java.util.List;
		46	import java.util.Map;
		47	import java.util.Set;
		48	import java.util.SortedSet;
		49	import java.util.TreeSet;
		50	import java.util.WeakHashMap;
		51	import org.apache.tools.ant.module.api.AntProjectCookie;
		52	import org.apache.tools.ant.module.xml.AntProjectSupport;
		53	import org.openide.filesystems.FileObject;
		54	import org.openide.loaders.DataObject;
		55	import org.openide.loaders.DataObjectNotFoundException;
		56	import org.w3c.dom.Element;
		57
		58	/**
		59	* Convenience utilities for working with Ant scripts.
		60	* @since org.apache.tools.ant.module/3 3.31
		61	*/
		62	public class AntScriptUtils {
		63
		64	private AntScriptUtils() {}
65
66	/**
67	* Loads a file believed to be an Ant script.
68	* @param script a file assumed to be an Ant script
69	* @return a handle for it (never null but may or may not be parsable)
70	*/
71	public static AntProjectCookie antProjectCookieFor(FileObject script) {
72	try {
73	DataObject d = DataObject.find(script);
74	AntProjectCookie apc = d.getCookie(AntProjectCookie.class);
75	if (apc != null) {
76	return apc;
77	}
78	} catch (DataObjectNotFoundException e) {
79	assert false : e;
80	}
81	// AntProjectDataLoader probably not installed, e.g. from a unit test.
82	// Or may not be recognized as an Ant script (e.g. root <project> element has no attributes).
83	synchronized (antProjectCookies) {
84	AntProjectCookie apc = antProjectCookies.get(script);
85	if (apc == null) {
86	apc = new AntProjectSupport(script);
87	antProjectCookies.put(script, apc);
88	}
89	return apc;
90	}
91	}
92	private static final Map<FileObject,AntProjectCookie> antProjectCookies = new WeakHashMap<FileObject,AntProjectCookie>();
93
94	/**
95	* Finds the name of an Ant script.
96	* @param script Ant script to inspect
97	* @return name of the Ant script as specified in the <code>name</code> attribute of
98	* the <code>project</code> element, or null if the file is not a valid Ant script
99	* or the script is anonymous
100	*/
101	public static String getAntScriptName(FileObject script) {
102	AntProjectCookie apc = antProjectCookieFor(script);
103	Element projEl = apc.getProjectElement();
104	if (projEl == null) {
105	return null;
106	}
107	String name = projEl.getAttribute("name"); // NOI18N
108	// returns "" if no such attribute
109	return name.length() > 0 ? name : null;
110	}
111
112	/**
113	* Finds the names of callable targets in an Ant script.
114	* @param script Ant script to inspect
115	* @return list of target names, sorted (by locale)
116	* @throws IOException if the script cannot be inspected
117	*/
118	public static List<String> getCallableTargetNames(FileObject script) throws IOException {
119	AntProjectCookie apc = antProjectCookieFor(script);
120	Set<TargetLister.Target> allTargets = TargetLister.getTargets(apc);
121	SortedSet<String> targetNames = new TreeSet<String>(Collator.getInstance());
122	for (TargetLister.Target target : allTargets) {
123	if (target.isOverridden()) {
124	// Cannot call it directly.
125	continue;
126	}
127	if (target.isInternal()) {
128	// Should not be called from outside.
129	continue;
130	}
131	targetNames.add(target.getName());
132	}
133	return new ArrayList<String>(targetNames);
134	}
135
136	}