| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You under the Apache License, Version 2.0 |
| * (the "License"); you may not use this file except in compliance with |
| * the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| * |
| */ |
| |
| package org.apache.tools.ant.taskdefs.optional.dotnet; |
| |
| import org.apache.tools.ant.Task; |
| import org.apache.tools.ant.BuildException; |
| import org.apache.tools.ant.Project; |
| import org.apache.tools.ant.util.FileUtils; |
| |
| import java.io.File; |
| |
| /** |
| * Import a COM type library into the .NET framework. |
| * <p> |
| * |
| * This task is a wrapper to .NET's tlbimport; it imports a tlb file to a NET assembly |
| * by generating a binary assembly (.dll) that contains all the binding |
| * metadata. It uses date timestamps to minimise rebuilds. |
| * <p> |
| * Example |
| * <pre> |
| * <importtypelib |
| * srcfile="xerces.tlb" |
| * destfile="xerces.dll" |
| * namespace="Apache.Xerces"/> |
| * </pre> |
| * @since Ant 1.6 |
| * @ant.task category="dotnet" |
| */ |
| public class ImportTypelib extends Task { |
| |
| private static final FileUtils FILE_UTILS = FileUtils.getFileUtils(); |
| |
| /** |
| * input file; precedes options |
| */ |
| private File srcFile; |
| |
| /** |
| * /out:file |
| */ |
| private File destFile; |
| |
| /** |
| * /namespace:[string] |
| */ |
| private String namespace; |
| |
| /** |
| * /sysarray |
| */ |
| private boolean useSysArray = false; |
| |
| /** |
| * /unsafe |
| */ |
| private boolean unsafe = false; |
| |
| /** |
| * extra commands? |
| */ |
| private String extraOptions = null; |
| |
| /** |
| * This method names the output file. |
| * |
| * This is an operation which is required to have been performed. |
| * @param destFile the output file. |
| */ |
| public void setDestFile(File destFile) { |
| this.destFile = destFile; |
| } |
| |
| /** |
| * This method sets what namespace the typelib is to be in. |
| * This is an operation which is required to have been performed. |
| * @param namespace the namespace to use. |
| */ |
| public void setNamespace(String namespace) { |
| this.namespace = namespace; |
| } |
| |
| /** |
| * This method sets which is the source .tlb file. |
| * This is an operation which is required to have been performed. |
| * @param srcFile the source file. |
| */ |
| public void setSrcFile(File srcFile) { |
| this.srcFile = srcFile; |
| } |
| |
| /** |
| * do you want unsafe code. |
| * @param unsafe a <code>boolean</code> value. |
| */ |
| public void setUnsafe(boolean unsafe) { |
| this.unsafe = unsafe; |
| } |
| |
| /** |
| * set this to map a COM SafeArray to the System.Array class |
| * @param useSysArray a <code>boolean</code> value. |
| */ |
| public void setUseSysArray(boolean useSysArray) { |
| this.useSysArray = useSysArray; |
| } |
| |
| /** |
| * set any extra options that are not yet supported by this task. |
| * @param extraOptions the options to use. |
| */ |
| public void setExtraOptions(String extraOptions) { |
| this.extraOptions = extraOptions; |
| } |
| |
| /** |
| * validation code |
| * @throws BuildException if validation failed |
| */ |
| protected void validate() |
| throws BuildException { |
| if (destFile == null) { |
| throw new BuildException("destination file must be specified"); |
| } |
| if (destFile.isDirectory()) { |
| throw new BuildException( |
| "destination file is a directory"); |
| } |
| if (srcFile == null || !srcFile.exists()) { |
| throw new BuildException( |
| "source file does not exist"); |
| } |
| if (srcFile.isDirectory()) { |
| throw new BuildException( |
| "source file is a directory"); |
| } |
| if (namespace == null) { |
| throw new BuildException("No namespace"); |
| } |
| } |
| |
| /** |
| * Test for disassembly being needed; use existence and granularity |
| * correct date stamps |
| * @return true iff a rebuild is required. |
| */ |
| private boolean isExecuteNeeded() { |
| if (!destFile.exists()) { |
| log("Destination file does not exist: a build is required", |
| Project.MSG_VERBOSE); |
| return true; |
| } |
| long sourceTime = srcFile.lastModified(); |
| long destTime = destFile.lastModified(); |
| if (sourceTime > (destTime + FILE_UTILS.getFileTimestampGranularity())) { |
| log("Source file is newer than the dest file: a rebuild is required", |
| Project.MSG_VERBOSE); |
| return true; |
| } else { |
| log("The output file is up to date", Project.MSG_VERBOSE); |
| return false; |
| } |
| |
| } |
| |
| |
| /** |
| * Create a typelib command |
| * @exception BuildException if something goes wrong with the build |
| */ |
| public void execute() throws BuildException { |
| log("This task is deprecated and will be removed in a future version\n" |
| + "of Ant. It is now part of the .NET Antlib:\n" |
| + "http://ant.apache.org/antlibs/dotnet/index.html", |
| Project.MSG_WARN); |
| validate(); |
| log("Importing typelib " + srcFile |
| + " to assembly " + destFile |
| + " in namespace " + namespace, Project.MSG_VERBOSE); |
| //rebuild unless the dest file is newer than the source file |
| if (!isExecuteNeeded()) { |
| return; |
| } |
| |
| NetCommand command = new NetCommand(this, "ImportTypelib", "tlbimp"); |
| command.setFailOnError(true); |
| command.addArgument(srcFile.toString()); |
| //fill in args |
| command.addArgument("/nologo"); |
| command.addArgument("/out:" + destFile); |
| command.addArgument("/namespace:", namespace); |
| if (useSysArray) { |
| command.addArgument("/sysarray"); |
| } |
| if (unsafe) { |
| command.addArgument("/unsafe"); |
| } |
| command.addArgument(extraOptions); |
| command.runCommand(); |
| } |
| } |