Polished the build tools' screen output to be in a more coherent form
[mirror_edk2.git] / Tools / Source / FrameworkTasks / org / tianocore / framework / tasks / EfiCompressTask.java
1 /** @file
2 EfiCompressTask class.
3
4 EfiCompressTask is used to call EfiCompress.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 EfiCompressTask class.
31
32 EfiCompressTask is used to call EfiCompress.exe to strip input file.
33 **/
34 public class EfiCompressTask 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 * execute
52 *
53 * EfiCompressTask execute function is to assemble tool command line & execute
54 * tool command line
55 *
56 * @throws BuidException
57 */
58 public void execute() throws BuildException {
59
60 Project project = this.getOwningTarget().getProject();
61 //
62 // set Logger
63 //
64 FrameworkLogger logger = new FrameworkLogger(project, "eficompress");
65 EdkLog.setLogLevel(project.getProperty("env.LOGLEVEL"));
66 EdkLog.setLogger(logger);
67 //
68 // absolute path of efi tools
69 //
70 String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");
71 String command;
72 String argument;
73 if (path == null) {
74 command = "EfiCompress";
75 } else {
76 command = path + File.separatorChar + "EfiCompress";
77 }
78 //
79 // argument of tools
80 //
81 File file = new File(outputFile);
82 if (!file.isAbsolute() && (!this.outputDir.equalsIgnoreCase(""))) {
83 argument = inputFile + " " + outputDir + File.separatorChar
84 + outputFile;
85 } else {
86 argument = inputFile + " " + outputFile;
87 }
88 //
89 // return value of fwimage execution
90 //
91 int revl = -1;
92
93 try {
94 Commandline cmdline = new Commandline();
95 cmdline.setExecutable(command);
96 cmdline.createArgument().setLine(argument);
97
98 LogStreamHandler streamHandler = new LogStreamHandler(this,
99 Project.MSG_INFO, Project.MSG_WARN);
100 Execute runner = new Execute(streamHandler, null);
101
102 runner.setAntRun(project);
103 runner.setCommandline(cmdline.getCommandline());
104 //
105 // Set debug log information.
106 //
107 EdkLog.log(EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));
108 EdkLog.log(EdkLog.EDK_INFO, (new File(this.inputFile)).getName());
109
110 revl = runner.execute();
111
112 if (EFI_SUCCESS == revl) {
113 //
114 // command execution success
115 //
116 EdkLog.log(EdkLog.EDK_VERBOSE, "EfiCompress succeeded!");
117 } else {
118 //
119 // command execution fail
120 //
121 EdkLog.log(EdkLog.EDK_INFO, "ERROR = " + Integer.toHexString(revl));
122 throw new BuildException("Strip failed!");
123
124 }
125 } catch (Exception e) {
126 throw new BuildException(e.getMessage());
127 }
128 }
129
130 /**
131 * getInputFile
132 *
133 * This function is to get class member "inputFile".
134 *
135 * @return string of input file name.
136 */
137 public String getInputFile() {
138 return inputFile;
139 }
140
141 /**
142 * setComponentType
143 *
144 * This function is to set class member "inputFile".
145 *
146 * @param inputFile
147 * string of input file name.
148 */
149 public void setInputFile(String inputFile) {
150 this.inputFile = inputFile;
151 }
152
153 /**
154 * getOutputFile
155 *
156 * This function is to get class member "outputFile"
157 *
158 * @return outputFile string of output file name.
159 */
160 public String getOutputFile() {
161 return outputFile;
162 }
163
164 /**
165 * setOutputFile
166 *
167 * This function is to set class member "outputFile"
168 *
169 * @param outputFile
170 * string of output file name.
171 */
172 public void setOutputFile(String outputFile) {
173 this.outputFile = outputFile;
174 }
175
176 /**
177 * getOutputDir
178 *
179 * This function is to get class member "outputDir"
180 *
181 * @return outputDir string of output directory.
182 */
183 public String getOutputDir() {
184 return outputDir;
185 }
186
187 /**
188 * setOutputDir
189 *
190 * This function is to set class member "outputDir"
191 *
192 * @param outputDir
193 * string of output directory.
194 */
195 public void setOutputDir(String outputDir) {
196 this.outputDir = outputDir;
197 }
198 }