1f5f9ad68dbd7dfd87d625ff80b577d995e5ad59
[mirror_edk2.git] / Tools / Source / FrameworkTasks / org / tianocore / framework / tasks / StripTask.java
1 /** @file
2 StripTask class.
3
4 StripTask is used to call Strip.exe to strip input file.
5
6
7 Copyright (c) 2006, Intel Corporation
8 All rights reserved. This program and the accompanying materials
9 are licensed and made available under the terms and conditions of the BSD License
10 which accompanies this distribution. The full text of the license may be found at
11 http://opensource.org/licenses/bsd-license.php
12
13 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
14 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
15
16 **/
17 package org.tianocore.framework.tasks;
18
19 import java.io.File;
20
21 import org.apache.tools.ant.Task;
22 import org.apache.tools.ant.Project;
23 import org.apache.tools.ant.BuildException;
24 import org.apache.tools.ant.taskdefs.Execute;
25 import org.apache.tools.ant.taskdefs.LogStreamHandler;
26 import org.apache.tools.ant.types.Commandline;
27 import org.tianocore.logger.EdkLog;
28
29 /**
30 StripTask class.
31
32 StripTask is used to call Strip.exe to strip input file.
33 */
34 public class StripTask extends Task implements EfiDefine {
35 // /
36 // / input file
37 // /
38 private String inputFile = "";
39
40 // /
41 // / output file
42 // /
43 private String outputFile = "";
44
45 // /
46 // / output directory, this variable is added by jave wrap
47 // /
48 private String outputDir = "";
49
50
51 /**
52 * execute
53 *
54 * StripTask execute function is to assemble tool command line & execute
55 * tool command line
56 *
57 * @throws BuidException
58 */
59 public void execute() throws BuildException {
60
61 Project project = this.getOwningTarget().getProject();
62 //
63 // set Logger
64 //
65 FrameworkLogger logger = new FrameworkLogger(project, "edkStrip");
66 EdkLog.setLogLevel(project.getProperty("env.LOGLEVEL"));
67 EdkLog.setLogger(logger);
68 //
69 // absolute path of efi tools
70 //
71 String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");
72 String command;
73 String argument;
74 if (path == null) {
75 command = "strip";
76 } else {
77 command = path + File.separatorChar + "Strip";
78 }
79 //
80 // argument of tools
81 //
82 File file = new File(outputFile);
83 if (!file.isAbsolute() && (!this.outputDir.equalsIgnoreCase(""))) {
84 argument = inputFile + " " + outputDir + File.separatorChar
85 + outputFile;
86 } else {
87 argument = inputFile + " " + outputFile;
88 }
89 //
90 // return value of fwimage execution
91 //
92 int revl = -1;
93
94 try {
95 Commandline cmdline = new Commandline();
96 cmdline.setExecutable(command);
97 cmdline.createArgument().setLine(argument);
98
99 LogStreamHandler streamHandler = new LogStreamHandler(this,
100 Project.MSG_INFO, Project.MSG_WARN);
101 Execute runner = new Execute(streamHandler, null);
102
103 runner.setAntRun(project);
104 runner.setCommandline(cmdline.getCommandline());
105 //
106 // Set debug log information.
107 //
108 EdkLog.log(EdkLog.EDK_INFO, Commandline.toString(cmdline.getCommandline()));
109
110 revl = runner.execute();
111
112 if (EFI_SUCCESS == revl) {
113 //
114 // command execution success
115 //
116 EdkLog.log(EdkLog.EDK_INFO,"Strip succeeded!");
117 } else {
118 //
119 // command execution fail
120 //
121 EdkLog.log(EdkLog.EDK_ERROR, "Strip failed. (error="
122 + Integer.toHexString(revl) + ")");
123 throw new BuildException("Strip failed. (error="
124 + Integer.toHexString(revl) + ")");
125
126 }
127 } catch (Exception e) {
128 throw new BuildException(e.getMessage());
129 }
130 }
131
132 /**
133 * getInputFile
134 *
135 * This function is to get class member "inputFile".
136 *
137 * @return string of input file name.
138 */
139 public String getInputFile() {
140 return inputFile;
141 }
142
143 /**
144 * setComponentType
145 *
146 * This function is to set class member "inputFile".
147 *
148 * @param inputFile
149 * string of input file name.
150 */
151 public void setInputFile(String inputFile) {
152 this.inputFile = inputFile;
153 }
154
155 /**
156 * getOutputFile
157 *
158 * This function is to get class member "outputFile"
159 *
160 * @return outputFile string of output file name.
161 */
162 public String getOutputFile() {
163 return outputFile;
164 }
165
166 /**
167 * setOutputFile
168 *
169 * This function is to set class member "outputFile"
170 *
171 * @param outputFile
172 * string of output file name.
173 */
174 public void setOutputFile(String outputFile) {
175 this.outputFile = outputFile;
176 }
177
178 /**
179 * getOutputDir
180 *
181 * This function is to get class member "outputDir"
182 *
183 * @return outputDir string of output directory.
184 */
185 public String getOutputDir() {
186 return outputDir;
187 }
188
189 /**
190 * setOutputDir
191 *
192 * This function is to set class member "outputDir"
193 *
194 * @param outputDir
195 * string of output directory.
196 */
197 public void setOutputDir(String outputDir) {
198 this.outputDir = outputDir;
199 }
200 }