[mirror_edk2.git] / Tools / Java / Source / GenBuild / org / tianocore / build / toolchain / ToolChainMap.java

/** @file\r
ToolChainMap class\r
\r
ToolChainMap class is used for storing tool chain configurations.\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
\r
package org.tianocore.build.toolchain;\r
\r
import java.util.HashMap;\r
import java.util.Map;\r
import java.util.Set;\r
\r
/**\r
 ToolChainMap is a wrapper class for a generic Map class which uses ToolChainKey\r
 class as its key. It's used to store and retrieve tool chain configuration \r
 information.\r
 **/\r
public class ToolChainMap {\r
    //\r
    // From which part of key can be used to match "*"\r
    // \r
    private int matchLevel = ToolChainKey.keyLength - 2;\r
\r
    //\r
    // A Map object in which tool chain configuration information will be stored\r
    // \r
    private Map<ToolChainKey, String> map = null;\r
\r
    /**\r
       Public constructor. It just initializes the private Map object.\r
     **/\r
    public ToolChainMap() {\r
        this.map = new HashMap<ToolChainKey, String>();\r
    }\r
\r
    /**\r
       Wrapper function for Map.put(). It's used when default delimiter of\r
       ToolChainKey is not wanted and will be overrided by "delimiter" parameter.\r
\r
       @param key           Key string which is concatenated with "delimiter"\r
       @param delimiter     The delimiter string in the key string\r
       @param value         Value string associated with the "key"\r
       \r
       @retval String       The "value" string if the "key" is valid.\r
       @retval null         if the "key" is invalid\r
     **/\r
    public String put(String key, String delimiter, String value) {\r
        ToolChainKey toolChainKey;\r
\r
        try {\r
            toolChainKey = new ToolChainKey(key, delimiter);\r
        } catch (Exception e) {\r
            return null;\r
        }\r
        return (String)map.put(toolChainKey, value);\r
    }\r
\r
    /**\r
       Wrapper function for Map.put().\r
\r
       @param key           Key string which is concatenated with default "delimiter"\r
       @param value         Value string associated with the "key"\r
       \r
       @retval String       The "value" string if the "key" is valid.\r
       @retval null         if the "key" is invalid\r
     **/\r
    public String put(String key, String value) {\r
        ToolChainKey toolChainKey;\r
\r
        try {\r
            toolChainKey = new ToolChainKey(key);\r
        } catch (Exception e) {\r
            return null;\r
        }\r
        return (String)map.put(toolChainKey, value);\r
    }\r
\r
    /**\r
       Wrapper function for Map.put(). The key is given in the form of string\r
       array.\r
\r
       @param key           Key string array\r
       @param value         Value string associated with the "key"\r
       \r
       @retval String       The "value" string if the "key" is valid.\r
       @retval null         if the "key" is invalid\r
     **/\r
    public String put(String[] key, String value) {\r
        ToolChainKey toolChainKey;\r
\r
        try {\r
            toolChainKey = new ToolChainKey(key);\r
        } catch (Exception e) {\r
            return null;\r
        }\r
        return (String)map.put(toolChainKey, value);\r
    }\r
\r
    /**\r
       Wrapper function for Map.put(). The key is given in ToolChainKey class.\r
\r
       @param key           ToolChainKey class\r
       @param value         Value string associated with the "key"\r
       \r
       @retval String       The "value" string if the "key" is valid.\r
       @retval null         if the "key" is invalid\r
     **/\r
    public String put(ToolChainKey key, String value) {\r
        return (String)map.put(key, value);\r
    }\r
\r
    /**\r
       Wrapper function for Map.get().\r
\r
       @param key           Key string which is concatenated with default "delimiter"\r
       \r
       @return String\r
     **/\r
    public String get(String key) {\r
        ToolChainKey toolChainKey;\r
\r
        try {\r
            toolChainKey = new ToolChainKey(key);\r
        } catch (Exception e) {\r
            return null;\r
        }\r
        return get(toolChainKey);\r
    }\r
\r
    /**\r
       Wrapper function for Map.get(). It's used when default delimiter of\r
       ToolChainKey is not wanted and will be overrided by "delimiter" parameter.\r
\r
       @param key           Key string which is concatenated with "delimiter"\r
       @param delimiter     The delimiter string in the key string\r
       \r
       @return String\r
     **/\r
    public String get(String key, String delimiter) {\r
        ToolChainKey toolChainKey;\r
\r
        try {\r
            toolChainKey = new ToolChainKey(key, delimiter);\r
        } catch (Exception e) {\r
            return null;\r
        }\r
        return get(toolChainKey);\r
    }\r
\r
    /**\r
       Wrapper function for Map.get(). The key is given in the form of string\r
       array.\r
\r
       @param key           Key string array\r
       \r
       @return String\r
     **/\r
    public String get(String[] key) {\r
        ToolChainKey toolChainKey;\r
\r
        try {\r
            toolChainKey = new ToolChainKey(key);\r
        } catch (Exception e) {\r
            return null;\r
        }\r
        return get(toolChainKey);\r
    }\r
\r
    /**\r
       Wrapper function for Map.get(). The key is given in ToolChainKey class.\r
       All other form of get() method will eventually call this form of get. It\r
       will do real job of finding the value associated with the given key. Most\r
       of the job is to try to match the key with "wildcard".\r
\r
       @param key           ToolChainKey class\r
       \r
       @return String       The value associated with the key\r
     **/\r
    public String get(ToolChainKey key) {\r
        ///\r
        /// First, we'll try to get the value through the exact given key\r
        /// \r
        String result = map.get(key);\r
        if (result != null || map.containsKey(key)) {\r
            return result;\r
        }\r
\r
        ///\r
        /// If nothing is found, then, we'll try all possible keys combined with\r
        /// wildcard "*". In order not to change the original key value, we have\r
        /// to clone one for later use. \r
        /// \r
        String[] keySet = key.getKeySet();\r
        ToolChainKey tmpKey;\r
        try {\r
            tmpKey = new ToolChainKey(keySet);\r
        } catch (Exception e) {\r
            return null;\r
        }\r
\r
        ///\r
        /// In the current tool chain definition format (in name/value pair), \r
        /// there're five parts in the "name". The last part of the "name" must\r
        /// not be "wildcard". So we should start combining "*" from the fourth part.\r
        /// We'll try all the possible combinations until the value can be fetched.\r
        ///  \r
        /// The following code implements the logic which will try to use, for example,\r
        /// following key parts combinations sequentially to get the value.\r
        /// \r
        /// TARGET_TOOLCHAIN_ARCH_TOOLCODE_ATTRIBUTE\r
        /// TARGET_TOOLCHAIN_ARCH_*_ATTRIBUTE\r
        /// TARGET_TOOLCHAIN_*_TOOLCODE_ATTRIBUTE\r
        /// TARGET_TOOLCHAIN_*_*_ATTRIBUTE\r
        /// TARGET_*_ARCH_TOOLCODE_ATTRIBUTE\r
        /// TARGET_*_ARCH_*_ATTRIBUTE\r
        /// TARGET_*_*_TOOLCODE_ATTRIBUTE\r
        /// TARGET_*_*_*_ATTRIBUTE\r
        /// *_TOOLCHAIN_ARCH_TOOLCODE_ATTRIBUTE\r
        /// *_TOOLCHAIN_ARCH_*_ATTRIBUTE\r
        /// *_TOOLCHAIN_*_TOOLCODE_ATTRIBUTE\r
        /// *_TOOLCHAIN_*_*_ATTRIBUTE\r
        /// *_*_ARCH_TOOLCODE_ATTRIBUTE\r
        /// *_*_ARCH_*_ATTRIBUTE\r
        /// *_*_*_TOOLCODE_ATTRIBUTE\r
        /// *_*_*_*_ATTRIBUTE\r
        /// \r
\r
        //\r
        // level is used to control if all parts of "name" have been "wildcarded"\r
        // \r
        int level = matchLevel;\r
        while (level >= 0) {\r
            //\r
            // tmplevel is used to control if all parts of "name" between first\r
            // "*" and fourth name part have been "wildcarded".\r
            // \r
            int tmpLevel = level;\r
            while (tmpLevel >= level) {\r
                String[] tmpKeySet = tmpKey.getKeySet();\r
                try {\r
                    if (!tmpKeySet[tmpLevel].equals("*")) {\r
                        //\r
                        // If "tmplevel" part is not "*", set it to "*".\r
                        // For example, at first loop, the key will become\r
                        // TARGET_TOOLCHAIN_ARCH_*_ATTRIBUTE, and at next loop,\r
                        // become TARGET_TOOLCHAIN_*_ARCH_ATTRIBUTE\r
                        // \r
                        tmpKey.setKey("*", tmpLevel);\r
                        //\r
                        // We'll try all possible combinations between current\r
                        // part and the fourth part.\r
                        // \r
                        tmpLevel = matchLevel;\r
                    } else {\r
                        //\r
                        // Restore original value of key if "*" at "tmplevel"\r
                        // part of "name" has been checked\r
                        // \r
                        tmpKey.setKey(keySet[tmpLevel], tmpLevel);\r
                        //\r
                        // Try "*" at part left to "tmplevel" part of "name"\r
                        // \r
                        --tmpLevel;\r
                        continue;\r
                    }\r
                } catch (Exception e) {\r
                    return null;\r
                }\r
\r
                //\r
                // Try get the value from the map\r
                // \r
                result = map.get(tmpKey);\r
                if (result != null) {\r
                    //\r
                    // The map actually has no exact key as the given "key", \r
                    // putting it back into map can speed up the get() next time\r
                    // \r
                    map.put(key, result);\r
                    return result;\r
                }\r
            }\r
            ///\r
            /// If all possible combinations of "wildcard" between "level" and \r
            /// the fourth part of "name" have been tried, try the left part\r
            /// \r
            --level;\r
        }\r
\r
        //\r
        // The map actually has no exact key as the given "key", putting it back\r
        // into map can speed up the get() next time even we got nothing.\r
        // \r
        map.put(key, result);\r
        return result;\r
    }\r
\r
    /**\r
       Wrapper function for Map.size().\r
\r
       @return int  The size of map\r
     **/\r
    public int size() {\r
        return map.size();\r
    }\r
\r
    /**\r
       Wrapper function for Map.keySet().\r
\r
       @return Set<ToolChainKey>    A set of ToolChainKey objects\r
     */\r
    public Set<ToolChainKey> keySet() {\r
        return (Set<ToolChainKey>)map.keySet();\r
    }\r
}\r
\r
Commit	Line	Data
d2059d05	1	/** @file\r
	2	ToolChainMap class\r
	3	\r
	4	ToolChainMap class is used for storing tool chain configurations.\r
a29c47e0	5	\r
	6	Copyright (c) 2006, Intel Corporation\r
	7	All rights reserved. This program and the accompanying materials\r
	8	are licensed and made available under the terms and conditions of the BSD License\r
	9	which accompanies this distribution. The full text of the license may be found at\r
	10	http://opensource.org/licenses/bsd-license.php\r
	11	\r
	12	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	13	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	14	\r
d2059d05	15	**/\r
a29c47e0	16	\r
	17	package org.tianocore.build.toolchain;\r
	18	\r
	19	import java.util.HashMap;\r
	20	import java.util.Map;\r
	21	import java.util.Set;\r
	22	\r
d2059d05	23	/**\r
	24	ToolChainMap is a wrapper class for a generic Map class which uses ToolChainKey\r
	25	class as its key. It's used to store and retrieve tool chain configuration \r
	26	information.\r
	27	**/\r
a29c47e0	28	public class ToolChainMap {\r
d2059d05	29	//\r
	30	// From which part of key can be used to match "*"\r
	31	// \r
a29c47e0	32	private int matchLevel = ToolChainKey.keyLength - 2;\r
a29c47e0	33	\r
d2059d05	34	//\r
	35	// A Map object in which tool chain configuration information will be stored\r
	36	// \r
a29c47e0	37	private Map<ToolChainKey, String> map = null;\r
a29c47e0	38	\r
d2059d05	39	/**\r
	40	Public constructor. It just initializes the private Map object.\r
	41	**/\r
a29c47e0	42	public ToolChainMap() {\r
a29c47e0	43	this.map = new HashMap<ToolChainKey, String>();\r
	44	}\r
	45	\r
d2059d05	46	/**\r
	47	Wrapper function for Map.put(). It's used when default delimiter of\r
	48	ToolChainKey is not wanted and will be overrided by "delimiter" parameter.\r
	49	\r
	50	@param key Key string which is concatenated with "delimiter"\r
	51	@param delimiter The delimiter string in the key string\r
	52	@param value Value string associated with the "key"\r
	53	\r
	54	@retval String The "value" string if the "key" is valid.\r
	55	@retval null if the "key" is invalid\r
	56	**/\r
c773bec0	57	public String put(String key, String delimiter, String value) {\r
a29c47e0	58	ToolChainKey toolChainKey;\r
	59	\r
	60	try {\r
	61	toolChainKey = new ToolChainKey(key, delimiter);\r
	62	} catch (Exception e) {\r
c773bec0	63	return null;\r
a29c47e0	64	}\r
	65	return (String)map.put(toolChainKey, value);\r
	66	}\r
	67	\r
d2059d05	68	/**\r
	69	Wrapper function for Map.put().\r
	70	\r
	71	@param key Key string which is concatenated with default "delimiter"\r
	72	@param value Value string associated with the "key"\r
	73	\r
	74	@retval String The "value" string if the "key" is valid.\r
	75	@retval null if the "key" is invalid\r
	76	**/\r
c773bec0	77	public String put(String key, String value) {\r
a29c47e0	78	ToolChainKey toolChainKey;\r
	79	\r
	80	try {\r
	81	toolChainKey = new ToolChainKey(key);\r
	82	} catch (Exception e) {\r
c773bec0	83	return null;\r
a29c47e0	84	}\r
	85	return (String)map.put(toolChainKey, value);\r
	86	}\r
	87	\r
d2059d05	88	/**\r
	89	Wrapper function for Map.put(). The key is given in the form of string\r
	90	array.\r
	91	\r
	92	@param key Key string array\r
	93	@param value Value string associated with the "key"\r
	94	\r
	95	@retval String The "value" string if the "key" is valid.\r
	96	@retval null if the "key" is invalid\r
	97	**/\r
c773bec0	98	public String put(String[] key, String value) {\r
a29c47e0	99	ToolChainKey toolChainKey;\r
	100	\r
	101	try {\r
	102	toolChainKey = new ToolChainKey(key);\r
	103	} catch (Exception e) {\r
c773bec0	104	return null;\r
a29c47e0	105	}\r
	106	return (String)map.put(toolChainKey, value);\r
	107	}\r
	108	\r
d2059d05	109	/**\r
	110	Wrapper function for Map.put(). The key is given in ToolChainKey class.\r
	111	\r
	112	@param key ToolChainKey class\r
	113	@param value Value string associated with the "key"\r
	114	\r
	115	@retval String The "value" string if the "key" is valid.\r
	116	@retval null if the "key" is invalid\r
	117	**/\r
a29c47e0	118	public String put(ToolChainKey key, String value) {\r
	119	return (String)map.put(key, value);\r
	120	}\r
	121	\r
d2059d05	122	/**\r
	123	Wrapper function for Map.get().\r
	124	\r
	125	@param key Key string which is concatenated with default "delimiter"\r
	126	\r
	127	@return String\r
	128	**/\r
c773bec0	129	public String get(String key) {\r
a29c47e0	130	ToolChainKey toolChainKey;\r
	131	\r
	132	try {\r
	133	toolChainKey = new ToolChainKey(key);\r
	134	} catch (Exception e) {\r
c773bec0	135	return null;\r
a29c47e0	136	}\r
	137	return get(toolChainKey);\r
	138	}\r
	139	\r
d2059d05	140	/**\r
	141	Wrapper function for Map.get(). It's used when default delimiter of\r
	142	ToolChainKey is not wanted and will be overrided by "delimiter" parameter.\r
	143	\r
	144	@param key Key string which is concatenated with "delimiter"\r
	145	@param delimiter The delimiter string in the key string\r
	146	\r
	147	@return String\r
	148	**/\r
c773bec0	149	public String get(String key, String delimiter) {\r
a29c47e0	150	ToolChainKey toolChainKey;\r
	151	\r
	152	try {\r
	153	toolChainKey = new ToolChainKey(key, delimiter);\r
	154	} catch (Exception e) {\r
c773bec0	155	return null;\r
a29c47e0	156	}\r
	157	return get(toolChainKey);\r
	158	}\r
	159	\r
d2059d05	160	/**\r
	161	Wrapper function for Map.get(). The key is given in the form of string\r
	162	array.\r
	163	\r
	164	@param key Key string array\r
	165	\r
	166	@return String\r
	167	**/\r
c773bec0	168	public String get(String[] key) {\r
a29c47e0	169	ToolChainKey toolChainKey;\r
	170	\r
	171	try {\r
	172	toolChainKey = new ToolChainKey(key);\r
	173	} catch (Exception e) {\r
c773bec0	174	return null;\r
a29c47e0	175	}\r
	176	return get(toolChainKey);\r
	177	}\r
	178	\r
d2059d05	179	/**\r
	180	Wrapper function for Map.get(). The key is given in ToolChainKey class.\r
	181	All other form of get() method will eventually call this form of get. It\r
	182	will do real job of finding the value associated with the given key. Most\r
	183	of the job is to try to match the key with "wildcard".\r
	184	\r
	185	@param key ToolChainKey class\r
	186	\r
	187	@return String The value associated with the key\r
	188	**/\r
c773bec0	189	public String get(ToolChainKey key) {\r
d2059d05	190	///\r
	191	/// First, we'll try to get the value through the exact given key\r
	192	/// \r
a29c47e0	193	String result = map.get(key);\r
	194	if (result != null \|\| map.containsKey(key)) {\r
	195	return result;\r
	196	}\r
	197	\r
d2059d05	198	///\r
	199	/// If nothing is found, then, we'll try all possible keys combined with\r
	200	/// wildcard "*". In order not to change the original key value, we have\r
	201	/// to clone one for later use. \r
	202	/// \r
a29c47e0	203	String[] keySet = key.getKeySet();\r
	204	ToolChainKey tmpKey;\r
	205	try {\r
	206	tmpKey = new ToolChainKey(keySet);\r
	207	} catch (Exception e) {\r
c773bec0	208	return null;\r
a29c47e0	209	}\r
a29c47e0	210	\r
d2059d05	211	///\r
	212	/// In the current tool chain definition format (in name/value pair), \r
	213	/// there're five parts in the "name". The last part of the "name" must\r
	214	/// not be "wildcard". So we should start combining "*" from the fourth part.\r
	215	/// We'll try all the possible combinations until the value can be fetched.\r
	216	/// \r
	217	/// The following code implements the logic which will try to use, for example,\r
	218	/// following key parts combinations sequentially to get the value.\r
	219	/// \r
	220	/// TARGET_TOOLCHAIN_ARCH_TOOLCODE_ATTRIBUTE\r
	221	/// TARGET_TOOLCHAIN_ARCH_*_ATTRIBUTE\r
	222	/// TARGET_TOOLCHAIN_*_TOOLCODE_ATTRIBUTE\r
	223	/// TARGET_TOOLCHAIN___ATTRIBUTE\r
	224	/// TARGET_*_ARCH_TOOLCODE_ATTRIBUTE\r
	225	/// TARGET__ARCH__ATTRIBUTE\r
	226	/// TARGET___TOOLCODE_ATTRIBUTE\r
	227	/// TARGET___*_ATTRIBUTE\r
	228	/// *_TOOLCHAIN_ARCH_TOOLCODE_ATTRIBUTE\r
	229	/// _TOOLCHAIN_ARCH__ATTRIBUTE\r
	230	/// _TOOLCHAIN__TOOLCODE_ATTRIBUTE\r
	231	/// _TOOLCHAIN__*_ATTRIBUTE\r
	232	/// __ARCH_TOOLCODE_ATTRIBUTE\r
	233	/// __ARCH_*_ATTRIBUTE\r
	234	/// __*_TOOLCODE_ATTRIBUTE\r
	235	/// ____ATTRIBUTE\r
	236	/// \r
	237	\r
	238	//\r
	239	// level is used to control if all parts of "name" have been "wildcarded"\r
	240	// \r
a29c47e0	241	int level = matchLevel;\r
a29c47e0	242	while (level >= 0) {\r
d2059d05	243	//\r
	244	// tmplevel is used to control if all parts of "name" between first\r
	245	// "*" and fourth name part have been "wildcarded".\r
	246	// \r
a29c47e0	247	int tmpLevel = level;\r
	248	while (tmpLevel >= level) {\r
	249	String[] tmpKeySet = tmpKey.getKeySet();\r
	250	try {\r
	251	if (!tmpKeySet[tmpLevel].equals("*")) {\r
d2059d05	252	//\r
	253	// If "tmplevel" part is not "", set it to "".\r
	254	// For example, at first loop, the key will become\r
	255	// TARGET_TOOLCHAIN_ARCH_*_ATTRIBUTE, and at next loop,\r
	256	// become TARGET_TOOLCHAIN_*_ARCH_ATTRIBUTE\r
	257	// \r
a29c47e0	258	tmpKey.setKey("*", tmpLevel);\r
d2059d05	259	//\r
	260	// We'll try all possible combinations between current\r
	261	// part and the fourth part.\r
	262	// \r
a29c47e0	263	tmpLevel = matchLevel;\r
a29c47e0	264	} else {\r
d2059d05	265	//\r
	266	// Restore original value of key if "*" at "tmplevel"\r
	267	// part of "name" has been checked\r
	268	// \r
a29c47e0	269	tmpKey.setKey(keySet[tmpLevel], tmpLevel);\r
d2059d05	270	//\r
	271	// Try "*" at part left to "tmplevel" part of "name"\r
	272	// \r
a29c47e0	273	--tmpLevel;\r
	274	continue;\r
	275	}\r
	276	} catch (Exception e) {\r
c773bec0	277	return null;\r
a29c47e0	278	}\r
a29c47e0	279	\r
d2059d05	280	//\r
	281	// Try get the value from the map\r
	282	// \r
a29c47e0	283	result = map.get(tmpKey);\r
a29c47e0	284	if (result != null) {\r
d2059d05	285	//\r
	286	// The map actually has no exact key as the given "key", \r
	287	// putting it back into map can speed up the get() next time\r
	288	// \r
a29c47e0	289	map.put(key, result);\r
	290	return result;\r
	291	}\r
	292	}\r
d2059d05	293	///\r
	294	/// If all possible combinations of "wildcard" between "level" and \r
	295	/// the fourth part of "name" have been tried, try the left part\r
	296	/// \r
a29c47e0	297	--level;\r
	298	}\r
	299	\r
d2059d05	300	//\r
	301	// The map actually has no exact key as the given "key", putting it back\r
	302	// into map can speed up the get() next time even we got nothing.\r
	303	// \r
a29c47e0	304	map.put(key, result);\r
	305	return result;\r
	306	}\r
	307	\r
d2059d05	308	/**\r
	309	Wrapper function for Map.size().\r
	310	\r
	311	@return int The size of map\r
	312	**/\r
a29c47e0	313	public int size() {\r
	314	return map.size();\r
	315	}\r
	316	\r
d2059d05	317	/**\r
	318	Wrapper function for Map.keySet().\r
	319	\r
	320	@return Set<ToolChainKey> A set of ToolChainKey objects\r
	321	*/\r
a29c47e0	322	public Set<ToolChainKey> keySet() {\r
	323	return (Set<ToolChainKey>)map.keySet();\r
	324	}\r
a29c47e0	325	}\r
a29c47e0	326	\r