--- /dev/null
+/** @file\r
+ File is HelpInfo class which is used to output the usage info. \r
+ \r
+Copyright (c) 2006, Intel Corporation\r
+All rights reserved. This program and the accompanying materials\r
+are licensed and made available under the terms and conditions of the BSD License\r
+which accompanies this distribution. The full text of the license may be found at\r
+http://opensource.org/licenses/bsd-license.php\r
+ \r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+**/\r
+\r
+package org.tianocore.context;\r
+\r
+import java.util.LinkedList;\r
+\r
+public class HelpInfo {\r
+\r
+ \r
+ /** \r
+ * output the tools usage guide\r
+ * @param no input parameter\r
+ * @return no return value\r
+ **/\r
+ public static void outputUsageInfo() {\r
+ System.out.printf("\n%s", DescripationString);\r
+ System.out.printf("\n%s", UsageInfoString);\r
+ System.out.printf("\n%s", DetailOfOptionString);\r
+\r
+ for (int i = 0; i < settingnum; i++) {\r
+ outputSubUsageInfo(UsageString[i], UsageStringInfo[i]);\r
+ }\r
+ \r
+ System.out.printf("\n%s", ExampleString);\r
+ }\r
+\r
+ /** \r
+ * output the usage info which bases on cmd option \r
+ * @param String str1 : the cmd option\r
+ * String str2 : the detail of cmd option\r
+ * @return no return value\r
+ **/\r
+ private static void outputSubUsageInfo(String str1, String str2) {\r
+ \r
+ splitString(str2);\r
+ System.out.printf("\n%4s %-30s %s", "", str1, List.get(0));\r
+ for (int i=1; i<List.size(); i++){\r
+ System.out.printf("\n%4s %-30s %s", "", "", List.get(i));\r
+ }\r
+ List.clear();\r
+ }\r
+\r
+ /** \r
+ * according to the output width, split the detail info \r
+ * @param String str :the detail info\r
+ * @return no return value\r
+ **/\r
+ private static void splitString(String str) {\r
+ int strlength = str.length();\r
+ if (strlength > MaxSrtingLength) {\r
+ String[] tokens = str.split("[ ]", 0);\r
+ String tempstr = null;\r
+ int templength = 0;\r
+ int start = 0;\r
+ int end = 0;\r
+ for (int i = 0; i < tokens.length; i++) {\r
+ if ((templength = end + tokens[i].length() + 1) < (MaxSrtingLength + start)) {\r
+ end = templength;\r
+ } else {\r
+ tempstr = str.substring(start, end);\r
+ List.add(tempstr);\r
+ start = end;\r
+ i = i - 1;\r
+ }\r
+ }\r
+ tempstr = str.substring(start, end - 1);\r
+ List.add(tempstr);\r
+ } else {\r
+ List.add(str);\r
+ }\r
+ }\r
+\r
+ \r
+ private static LinkedList<String> List = new LinkedList<String>();\r
+\r
+ private static final int MaxSrtingLength = 40;\r
+ \r
+ private static final int settingnum = 7;\r
+ \r
+ private static final String DescripationString = "The purpose of this tool is modifying the settings in target.txt";\r
+ \r
+ private static final String UsageInfoString = "Usage: ContextTool [-option1] [args] [-option2] [args] ...";\r
+\r
+ private static final String DetailOfOptionString = "Where options include:";\r
+ \r
+ private static final String ExampleString = "Example: ContextTool -a IA32 IA64 EBC -c Tools/Conf/tools_def.txt -t DEBUG -n GCC -p EdkNt32Pkg/Nt32.fpd -m 2\n";\r
+\r
+ private static final String HString = "-h";\r
+\r
+ private static final String HStringInfo = "print usage info";\r
+\r
+ private static final String AString = "-a <list of Arch>";\r
+\r
+ private static final String AStringInfo = "what kind of architechure is the binary target, such as IA32, IA64, X64, EBC, or ARM. Multiple values can be specified on a single line, using space to separate the values.";\r
+\r
+ private static final String CString = "-c <tool_definition_file.txt>";\r
+\r
+ private static final String CStringInfo = "Assign a txt file with the relative path to WORKSPACE, which specify the tools to use for the build and must be located in the path: WORKSPACE/Tools/Conf/. If no file is specified, the default filename is \"tools_def.txt\"";\r
+\r
+ private static final String NString = "-n <list of TagNames>";\r
+\r
+ private static final String NStringInfo = "Specify the TagName, such as GCC, MSFT, which are defined in the \"tool_definition_file.txt\"";\r
+\r
+ private static final String PString = "-p <*.fpd>";\r
+\r
+ private static final String PStringInfo = "Specify the WORKSPACE relative Path and Filename of platform FPD file that will be used for the build.";\r
+\r
+ private static final String TString = "-t <list of Build Targets>";\r
+\r
+ private static final String TStringInfo = "What kind of the version is the binary target, such as DEBUG, RELEASE. Multiple values can be specified on a single line, using space to separate the values.";\r
+\r
+ private static final String MString = "-m <num of Threads>";\r
+ \r
+ private static final String MStringInfo = "number should GE 0. 0 clears both MULTIPLE_THREAD and MAX_CONCURRENT_THREAD_NUMBER, others enable MULTIPLE_THREAD and set MAX_CONCURRENT_THREAD_NUMBER.";\r
+ \r
+ private static final String[] UsageString = { HString, AString, CString,\r
+ NString, PString, TString, MString };\r
+\r
+ private static final String[] UsageStringInfo = { HStringInfo, AStringInfo,\r
+ CStringInfo, NStringInfo, PStringInfo, TStringInfo, MStringInfo };\r
+}\r
projects / mirror_edk2.git / blobdiff