summaryrefslogtreecommitdiff
path: root/Tools/Source/FrameworkTasks/org/tianocore/framework/tasks/ModifyInfTask.java
blob: e01b0404a8a6363ad2fd092c4ecfc1a09416cea7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
/** @file
 ModifyInfTask class.

 ModifyInfTask is used to call Modify.exe to generate inf file.


 Copyright (c) 2006, Intel Corporation
 All rights reserved. This program and the accompanying materials
 are licensed and made available under the terms and conditions of the BSD License
 which accompanies this distribution.  The full text of the license may be found at
 http://opensource.org/licenses/bsd-license.php

 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 **/
package org.tianocore.framework.tasks;

import java.io.File;

import org.apache.tools.ant.Task;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.taskdefs.Execute;
import org.apache.tools.ant.taskdefs.LogStreamHandler;
import org.apache.tools.ant.types.Commandline;

import org.tianocore.common.logger.EdkLog;

/**
  ModifyInfTask class.

  ModifyInfTask is used to call Modify.exe to generate inf file.
**/
public class ModifyInfTask extends Task implements EfiDefine {
    ///
    /// tool name
    ///
    private String toolName = "ModifyInf";

    ///
    /// input FV inf file
    ///
    private String inputFVInfFile = "";

    ///
    /// output FV inf file
    ///
    private String outputFVInfFile = "";

    ///
    /// pattern string
    ///
    private String patternStr = "";

	///
	///  Output dir
	///
	private String outputDir = "";

    /**
     * execute
     *
     * ModifyInfTask execute function is to assemble tool command line & execute
     * tool command line
     *
     * @throws BuidException
     */
    public void execute() throws BuildException {

        Project project = this.getOwningTarget().getProject();
        //
        // absolute path of efi tools
        //
        String path = project.getProperty("env.FRAMEWORK_TOOLS_PATH");
        String command;
        String argument;
        if (path == null) {
            command = toolName;
        } else {
            command = path + File.separatorChar + toolName;
        }
        //
        // argument of tools
        //
		File file = new File(outputFVInfFile);
        if (!file.isAbsolute() && (!this.outputDir.equalsIgnoreCase(""))) {
			argument = this.inputFVInfFile +
				       this.outputDir +
					   File.separatorChar +
					   this.outputFVInfFile +
					   this.patternStr;
		} else {
			argument = this.inputFVInfFile +
				       this.outputFVInfFile +
				       this.patternStr;
		}
        //
        // return value of fwimage execution
        //
        int revl = -1;

        try {
            Commandline cmdline = new Commandline();
            cmdline.setExecutable(command);
            cmdline.createArgument().setLine(argument);

            LogStreamHandler streamHandler = new LogStreamHandler(this,
                    Project.MSG_INFO, Project.MSG_WARN);
            Execute runner = new Execute(streamHandler, null);

            runner.setAntRun(project);
            runner.setCommandline(cmdline.getCommandline());
            //
            // Set debug log information.
            //
            EdkLog.log(this, EdkLog.EDK_VERBOSE, Commandline.toString(cmdline.getCommandline()));
            EdkLog.log(this, EdkLog.EDK_INFO, (new File(this.inputFVInfFile)).getName());
            revl = runner.execute();

            if (EFI_SUCCESS == revl) {
                //
                // command execution success
                //
                EdkLog.log(this, EdkLog.EDK_VERBOSE, "ModifyInfTask succeeded!");
            } else {
                //
                // command execution fail
                //
                EdkLog.log(this, EdkLog.EDK_INFO, "ERROR = " + Integer.toHexString(revl));
                throw new BuildException("ModifyInfTask failed!");
            }
        } catch (Exception e) {
            throw new BuildException(e.getMessage());
        }
    }

    /**
     * getinputFVInfFile
     *
     * This function is to get class member "inputFVInfFile".
     *
     * @return string of input inf file name.
     */
    public String getinputFVInfFile() {
        return this.inputFVInfFile;
    }

    /**
     * setinputFVInfFile
     *
     * This function is to set class member "inputFVInfFile".
     *
     * @param inputFile
     *            string of input inf file name.
     */
    public void setinputFVInfFile(String inputFVInfFileName) {
        this.inputFVInfFile= inputFVInfFileName + " ";
    }

    /**
     * getoutputFVInfFile
     *
     * This function is to get class member "outputFVInfFile"
     *
     * @return outputFVInfFile string of output inf file name.
     */
    public String getoutputFVInfFile() {
        return this.outputFVInfFile;
    }

    /**
     * setoutputFVInfFile
     *
     * This function is to set class member "outputFVInfFile"
     *
     * @param outputFVInfFile
     *            string of output  inf file name.
     */
    public void setoutputFVInfFile(String outputFVInfFileName) {
        this.outputFVInfFile = outputFVInfFileName  + " ";
    }

    /**
     * getpatternStr
     *
     * This function is to get class member "patternStr"
     *
     * @return patternStr string of pattern.
     */
    public String getpatternStr() {
        return this.patternStr;
    }

    /**
     * setpatternStr
     *
     * This function is to set class member "patternStr"
     *
     * @param patternStr
     *            string of patternStr.
     */
    public void setpatternStr(String patternStr) {
        this.patternStr = patternStr;
    }

	/**
     * getoutputDir
     *
     * This function is to get class member "outputDir"
     *
     * @return outputDir string of output directory.
     */
    public String getoutputDir() {
        return this.outputDir;
    }

    /**
     * setoutputDir
     *
     * This function is to set class member "outputDir"
     *
     * @param patternStr
     *            string of output directory.
     */
    public void setoutputDir(String outputDir) {
        this.outputDir = outputDir;
    }
}