blob: 877259e8d8487dcfb8afa5d9c3335c3f8147f63f [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.pattern;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.lang.reflect.Method;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.lang.reflect.Modifier;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.util.ArrayList;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.util.Iterator;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.LinkedHashMap;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.List;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Map;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Objects;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.Logger;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.util.PluginManager;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.util.PluginType;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.util.SystemNanoClock;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.util.Strings;<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>/**<a name="line.36"></a>
<span class="sourceLineNo">037</span> * Most of the work of the {@link org.apache.logging.log4j.core.layout.PatternLayout} class is delegated to the<a name="line.37"></a>
<span class="sourceLineNo">038</span> * PatternParser class.<a name="line.38"></a>
<span class="sourceLineNo">039</span> * &lt;p&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span> * It is this class that parses conversion patterns and creates a chained list of {@link PatternConverter<a name="line.40"></a>
<span class="sourceLineNo">041</span> * PatternConverters}.<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>public final class PatternParser {<a name="line.43"></a>
<span class="sourceLineNo">044</span> static final String DISABLE_ANSI = "disableAnsi";<a name="line.44"></a>
<span class="sourceLineNo">045</span> static final String NO_CONSOLE_NO_ANSI = "noConsoleNoAnsi";<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Escape character for format specifier.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> private static final char ESCAPE_CHAR = '%';<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> /**<a name="line.52"></a>
<span class="sourceLineNo">053</span> * The states the parser can be in while parsing the pattern.<a name="line.53"></a>
<span class="sourceLineNo">054</span> */<a name="line.54"></a>
<span class="sourceLineNo">055</span> private enum ParserState {<a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * Literal state.<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> LITERAL_STATE,<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span> /**<a name="line.61"></a>
<span class="sourceLineNo">062</span> * In converter name state.<a name="line.62"></a>
<span class="sourceLineNo">063</span> */<a name="line.63"></a>
<span class="sourceLineNo">064</span> CONVERTER_STATE,<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /**<a name="line.66"></a>
<span class="sourceLineNo">067</span> * Dot state.<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> DOT_STATE,<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> /**<a name="line.71"></a>
<span class="sourceLineNo">072</span> * Min state.<a name="line.72"></a>
<span class="sourceLineNo">073</span> */<a name="line.73"></a>
<span class="sourceLineNo">074</span> MIN_STATE,<a name="line.74"></a>
<span class="sourceLineNo">075</span><a name="line.75"></a>
<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
<span class="sourceLineNo">077</span> * Max state.<a name="line.77"></a>
<span class="sourceLineNo">078</span> */<a name="line.78"></a>
<span class="sourceLineNo">079</span> MAX_STATE;<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span> private static final int BUF_SIZE = 32;<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> private static final int DECIMAL = 10;<a name="line.86"></a>
<span class="sourceLineNo">087</span><a name="line.87"></a>
<span class="sourceLineNo">088</span> private final Configuration config;<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> private final Map&lt;String, Class&lt;PatternConverter&gt;&gt; converterRules;<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
<span class="sourceLineNo">093</span> * Constructor.<a name="line.93"></a>
<span class="sourceLineNo">094</span> *<a name="line.94"></a>
<span class="sourceLineNo">095</span> * @param converterKey<a name="line.95"></a>
<span class="sourceLineNo">096</span> * The type of converters that will be used.<a name="line.96"></a>
<span class="sourceLineNo">097</span> */<a name="line.97"></a>
<span class="sourceLineNo">098</span> public PatternParser(final String converterKey) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> this(null, converterKey, null, null);<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> /**<a name="line.102"></a>
<span class="sourceLineNo">103</span> * Constructor.<a name="line.103"></a>
<span class="sourceLineNo">104</span> *<a name="line.104"></a>
<span class="sourceLineNo">105</span> * @param config<a name="line.105"></a>
<span class="sourceLineNo">106</span> * The current Configuration.<a name="line.106"></a>
<span class="sourceLineNo">107</span> * @param converterKey<a name="line.107"></a>
<span class="sourceLineNo">108</span> * The key to lookup the converters.<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @param expected<a name="line.109"></a>
<span class="sourceLineNo">110</span> * The expected base Class of each Converter.<a name="line.110"></a>
<span class="sourceLineNo">111</span> */<a name="line.111"></a>
<span class="sourceLineNo">112</span> public PatternParser(final Configuration config, final String converterKey, final Class&lt;?&gt; expected) {<a name="line.112"></a>
<span class="sourceLineNo">113</span> this(config, converterKey, expected, null);<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> /**<a name="line.116"></a>
<span class="sourceLineNo">117</span> * Constructor.<a name="line.117"></a>
<span class="sourceLineNo">118</span> *<a name="line.118"></a>
<span class="sourceLineNo">119</span> * @param config<a name="line.119"></a>
<span class="sourceLineNo">120</span> * The current Configuration.<a name="line.120"></a>
<span class="sourceLineNo">121</span> * @param converterKey<a name="line.121"></a>
<span class="sourceLineNo">122</span> * The key to lookup the converters.<a name="line.122"></a>
<span class="sourceLineNo">123</span> * @param expectedClass<a name="line.123"></a>
<span class="sourceLineNo">124</span> * The expected base Class of each Converter.<a name="line.124"></a>
<span class="sourceLineNo">125</span> * @param filterClass<a name="line.125"></a>
<span class="sourceLineNo">126</span> * Filter the returned plugins after calling the plugin manager.<a name="line.126"></a>
<span class="sourceLineNo">127</span> */<a name="line.127"></a>
<span class="sourceLineNo">128</span> public PatternParser(final Configuration config, final String converterKey, final Class&lt;?&gt; expectedClass,<a name="line.128"></a>
<span class="sourceLineNo">129</span> final Class&lt;?&gt; filterClass) {<a name="line.129"></a>
<span class="sourceLineNo">130</span> this.config = config;<a name="line.130"></a>
<span class="sourceLineNo">131</span> final PluginManager manager = new PluginManager(converterKey);<a name="line.131"></a>
<span class="sourceLineNo">132</span> manager.collectPlugins(config == null ? null : config.getPluginPackages());<a name="line.132"></a>
<span class="sourceLineNo">133</span> final Map&lt;String, PluginType&lt;?&gt;&gt; plugins = manager.getPlugins();<a name="line.133"></a>
<span class="sourceLineNo">134</span> final Map&lt;String, Class&lt;PatternConverter&gt;&gt; converters = new LinkedHashMap&lt;&gt;();<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> for (final PluginType&lt;?&gt; type : plugins.values()) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> try {<a name="line.137"></a>
<span class="sourceLineNo">138</span> @SuppressWarnings("unchecked")<a name="line.138"></a>
<span class="sourceLineNo">139</span> final Class&lt;PatternConverter&gt; clazz = (Class&lt;PatternConverter&gt;) type.getPluginClass();<a name="line.139"></a>
<span class="sourceLineNo">140</span> if (filterClass != null &amp;&amp; !filterClass.isAssignableFrom(clazz)) {<a name="line.140"></a>
<span class="sourceLineNo">141</span> continue;<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span> final ConverterKeys keys = clazz.getAnnotation(ConverterKeys.class);<a name="line.143"></a>
<span class="sourceLineNo">144</span> if (keys != null) {<a name="line.144"></a>
<span class="sourceLineNo">145</span> for (final String key : keys.value()) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> if (converters.containsKey(key)) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> LOGGER.warn("Converter key '{}' is already mapped to '{}'. " +<a name="line.147"></a>
<span class="sourceLineNo">148</span> "Sorry, Dave, I can't let you do that! Ignoring plugin [{}].",<a name="line.148"></a>
<span class="sourceLineNo">149</span> key, converters.get(key), clazz);<a name="line.149"></a>
<span class="sourceLineNo">150</span> } else {<a name="line.150"></a>
<span class="sourceLineNo">151</span> converters.put(key, clazz);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span> }<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span> } catch (final Exception ex) {<a name="line.155"></a>
<span class="sourceLineNo">156</span> LOGGER.error("Error processing plugin " + type.getElementName(), ex);<a name="line.156"></a>
<span class="sourceLineNo">157</span> }<a name="line.157"></a>
<span class="sourceLineNo">158</span> }<a name="line.158"></a>
<span class="sourceLineNo">159</span> converterRules = converters;<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> public List&lt;PatternFormatter&gt; parse(final String pattern) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return parse(pattern, false, false, false);<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> public List&lt;PatternFormatter&gt; parse(final String pattern, final boolean alwaysWriteExceptions,<a name="line.166"></a>
<span class="sourceLineNo">167</span> final boolean noConsoleNoAnsi) {<a name="line.167"></a>
<span class="sourceLineNo">168</span> return parse(pattern, alwaysWriteExceptions, false, noConsoleNoAnsi);<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> public List&lt;PatternFormatter&gt; parse(final String pattern, final boolean alwaysWriteExceptions,<a name="line.171"></a>
<span class="sourceLineNo">172</span> final boolean disableAnsi, final boolean noConsoleNoAnsi) {<a name="line.172"></a>
<span class="sourceLineNo">173</span> final List&lt;PatternFormatter&gt; list = new ArrayList&lt;&gt;();<a name="line.173"></a>
<span class="sourceLineNo">174</span> final List&lt;PatternConverter&gt; converters = new ArrayList&lt;&gt;();<a name="line.174"></a>
<span class="sourceLineNo">175</span> final List&lt;FormattingInfo&gt; fields = new ArrayList&lt;&gt;();<a name="line.175"></a>
<span class="sourceLineNo">176</span><a name="line.176"></a>
<span class="sourceLineNo">177</span> parse(pattern, converters, fields, disableAnsi, noConsoleNoAnsi, true);<a name="line.177"></a>
<span class="sourceLineNo">178</span><a name="line.178"></a>
<span class="sourceLineNo">179</span> final Iterator&lt;FormattingInfo&gt; fieldIter = fields.iterator();<a name="line.179"></a>
<span class="sourceLineNo">180</span> boolean handlesThrowable = false;<a name="line.180"></a>
<span class="sourceLineNo">181</span><a name="line.181"></a>
<span class="sourceLineNo">182</span> for (final PatternConverter converter : converters) {<a name="line.182"></a>
<span class="sourceLineNo">183</span> if (converter instanceof NanoTimePatternConverter) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> // LOG4J2-1074 Switch to actual clock if nanosecond timestamps are required in config.<a name="line.184"></a>
<span class="sourceLineNo">185</span> // LOG4J2-1248 set config nanoclock<a name="line.185"></a>
<span class="sourceLineNo">186</span> if (config != null) {<a name="line.186"></a>
<span class="sourceLineNo">187</span> config.setNanoClock(new SystemNanoClock());<a name="line.187"></a>
<span class="sourceLineNo">188</span> }<a name="line.188"></a>
<span class="sourceLineNo">189</span> }<a name="line.189"></a>
<span class="sourceLineNo">190</span> LogEventPatternConverter pc;<a name="line.190"></a>
<span class="sourceLineNo">191</span> if (converter instanceof LogEventPatternConverter) {<a name="line.191"></a>
<span class="sourceLineNo">192</span> pc = (LogEventPatternConverter) converter;<a name="line.192"></a>
<span class="sourceLineNo">193</span> handlesThrowable |= pc.handlesThrowable();<a name="line.193"></a>
<span class="sourceLineNo">194</span> } else {<a name="line.194"></a>
<span class="sourceLineNo">195</span> pc = new LiteralPatternConverter(config, Strings.EMPTY, true);<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span><a name="line.197"></a>
<span class="sourceLineNo">198</span> FormattingInfo field;<a name="line.198"></a>
<span class="sourceLineNo">199</span> if (fieldIter.hasNext()) {<a name="line.199"></a>
<span class="sourceLineNo">200</span> field = fieldIter.next();<a name="line.200"></a>
<span class="sourceLineNo">201</span> } else {<a name="line.201"></a>
<span class="sourceLineNo">202</span> field = FormattingInfo.getDefault();<a name="line.202"></a>
<span class="sourceLineNo">203</span> }<a name="line.203"></a>
<span class="sourceLineNo">204</span> list.add(new PatternFormatter(pc, field));<a name="line.204"></a>
<span class="sourceLineNo">205</span> }<a name="line.205"></a>
<span class="sourceLineNo">206</span> if (alwaysWriteExceptions &amp;&amp; !handlesThrowable) {<a name="line.206"></a>
<span class="sourceLineNo">207</span> final LogEventPatternConverter pc = ExtendedThrowablePatternConverter.newInstance(config, null);<a name="line.207"></a>
<span class="sourceLineNo">208</span> list.add(new PatternFormatter(pc, FormattingInfo.getDefault()));<a name="line.208"></a>
<span class="sourceLineNo">209</span> }<a name="line.209"></a>
<span class="sourceLineNo">210</span> return list;<a name="line.210"></a>
<span class="sourceLineNo">211</span> }<a name="line.211"></a>
<span class="sourceLineNo">212</span><a name="line.212"></a>
<span class="sourceLineNo">213</span> /**<a name="line.213"></a>
<span class="sourceLineNo">214</span> * Extracts the converter identifier found at the given start position.<a name="line.214"></a>
<span class="sourceLineNo">215</span> * &lt;p&gt;<a name="line.215"></a>
<span class="sourceLineNo">216</span> * After this function returns, the variable i will point to the first char after the end of the converter<a name="line.216"></a>
<span class="sourceLineNo">217</span> * identifier.<a name="line.217"></a>
<span class="sourceLineNo">218</span> * &lt;/p&gt;<a name="line.218"></a>
<span class="sourceLineNo">219</span> * &lt;p&gt;<a name="line.219"></a>
<span class="sourceLineNo">220</span> * If i points to a char which is not a character acceptable at the start of a unicode identifier, the value null is<a name="line.220"></a>
<span class="sourceLineNo">221</span> * returned.<a name="line.221"></a>
<span class="sourceLineNo">222</span> * &lt;/p&gt;<a name="line.222"></a>
<span class="sourceLineNo">223</span> *<a name="line.223"></a>
<span class="sourceLineNo">224</span> * @param lastChar<a name="line.224"></a>
<span class="sourceLineNo">225</span> * last processed character.<a name="line.225"></a>
<span class="sourceLineNo">226</span> * @param pattern<a name="line.226"></a>
<span class="sourceLineNo">227</span> * format string.<a name="line.227"></a>
<span class="sourceLineNo">228</span> * @param start<a name="line.228"></a>
<span class="sourceLineNo">229</span> * current index into pattern format.<a name="line.229"></a>
<span class="sourceLineNo">230</span> * @param convBuf<a name="line.230"></a>
<span class="sourceLineNo">231</span> * buffer to receive conversion specifier.<a name="line.231"></a>
<span class="sourceLineNo">232</span> * @param currentLiteral<a name="line.232"></a>
<span class="sourceLineNo">233</span> * literal to be output in case format specifier in unrecognized.<a name="line.233"></a>
<span class="sourceLineNo">234</span> * @return position in pattern after converter.<a name="line.234"></a>
<span class="sourceLineNo">235</span> */<a name="line.235"></a>
<span class="sourceLineNo">236</span> private static int extractConverter(final char lastChar, final String pattern, final int start,<a name="line.236"></a>
<span class="sourceLineNo">237</span> final StringBuilder convBuf, final StringBuilder currentLiteral) {<a name="line.237"></a>
<span class="sourceLineNo">238</span> int i = start;<a name="line.238"></a>
<span class="sourceLineNo">239</span> convBuf.setLength(0);<a name="line.239"></a>
<span class="sourceLineNo">240</span><a name="line.240"></a>
<span class="sourceLineNo">241</span> // When this method is called, lastChar points to the first character of the<a name="line.241"></a>
<span class="sourceLineNo">242</span> // conversion word. For example:<a name="line.242"></a>
<span class="sourceLineNo">243</span> // For "%hello" lastChar = 'h'<a name="line.243"></a>
<span class="sourceLineNo">244</span> // For "%-5hello" lastChar = 'h'<a name="line.244"></a>
<span class="sourceLineNo">245</span> // System.out.println("lastchar is "+lastChar);<a name="line.245"></a>
<span class="sourceLineNo">246</span> if (!Character.isUnicodeIdentifierStart(lastChar)) {<a name="line.246"></a>
<span class="sourceLineNo">247</span> return i;<a name="line.247"></a>
<span class="sourceLineNo">248</span> }<a name="line.248"></a>
<span class="sourceLineNo">249</span><a name="line.249"></a>
<span class="sourceLineNo">250</span> convBuf.append(lastChar);<a name="line.250"></a>
<span class="sourceLineNo">251</span><a name="line.251"></a>
<span class="sourceLineNo">252</span> while (i &lt; pattern.length() &amp;&amp; Character.isUnicodeIdentifierPart(pattern.charAt(i))) {<a name="line.252"></a>
<span class="sourceLineNo">253</span> convBuf.append(pattern.charAt(i));<a name="line.253"></a>
<span class="sourceLineNo">254</span> currentLiteral.append(pattern.charAt(i));<a name="line.254"></a>
<span class="sourceLineNo">255</span> i++;<a name="line.255"></a>
<span class="sourceLineNo">256</span> }<a name="line.256"></a>
<span class="sourceLineNo">257</span><a name="line.257"></a>
<span class="sourceLineNo">258</span> return i;<a name="line.258"></a>
<span class="sourceLineNo">259</span> }<a name="line.259"></a>
<span class="sourceLineNo">260</span><a name="line.260"></a>
<span class="sourceLineNo">261</span> /**<a name="line.261"></a>
<span class="sourceLineNo">262</span> * Extract options.<a name="line.262"></a>
<span class="sourceLineNo">263</span> *<a name="line.263"></a>
<span class="sourceLineNo">264</span> * @param pattern<a name="line.264"></a>
<span class="sourceLineNo">265</span> * conversion pattern.<a name="line.265"></a>
<span class="sourceLineNo">266</span> * @param start<a name="line.266"></a>
<span class="sourceLineNo">267</span> * start of options.<a name="line.267"></a>
<span class="sourceLineNo">268</span> * @param options<a name="line.268"></a>
<span class="sourceLineNo">269</span> * array to receive extracted options<a name="line.269"></a>
<span class="sourceLineNo">270</span> * @return position in pattern after options.<a name="line.270"></a>
<span class="sourceLineNo">271</span> */<a name="line.271"></a>
<span class="sourceLineNo">272</span> private static int extractOptions(final String pattern, final int start, final List&lt;String&gt; options) {<a name="line.272"></a>
<span class="sourceLineNo">273</span> int i = start;<a name="line.273"></a>
<span class="sourceLineNo">274</span> while (i &lt; pattern.length() &amp;&amp; pattern.charAt(i) == '{') {<a name="line.274"></a>
<span class="sourceLineNo">275</span> i++; // skip opening "{"<a name="line.275"></a>
<span class="sourceLineNo">276</span> final int begin = i; // position of first real char<a name="line.276"></a>
<span class="sourceLineNo">277</span> int depth = 1; // already inside one level<a name="line.277"></a>
<span class="sourceLineNo">278</span> while (depth &gt; 0 &amp;&amp; i &lt; pattern.length()) {<a name="line.278"></a>
<span class="sourceLineNo">279</span> final char c = pattern.charAt(i);<a name="line.279"></a>
<span class="sourceLineNo">280</span> if (c == '{') {<a name="line.280"></a>
<span class="sourceLineNo">281</span> depth++;<a name="line.281"></a>
<span class="sourceLineNo">282</span> } else if (c == '}') {<a name="line.282"></a>
<span class="sourceLineNo">283</span> depth--;<a name="line.283"></a>
<span class="sourceLineNo">284</span> // TODO(?) maybe escaping of { and } with \ or %<a name="line.284"></a>
<span class="sourceLineNo">285</span> }<a name="line.285"></a>
<span class="sourceLineNo">286</span> i++;<a name="line.286"></a>
<span class="sourceLineNo">287</span> } // while<a name="line.287"></a>
<span class="sourceLineNo">288</span><a name="line.288"></a>
<span class="sourceLineNo">289</span> if (depth &gt; 0) { // option not closed, continue with pattern after closing bracket<a name="line.289"></a>
<span class="sourceLineNo">290</span> i = pattern.lastIndexOf('}');<a name="line.290"></a>
<span class="sourceLineNo">291</span> if (i == -1 || i &lt; start) {<a name="line.291"></a>
<span class="sourceLineNo">292</span> // if no closing bracket could be found or there is no closing bracket behind the starting<a name="line.292"></a>
<span class="sourceLineNo">293</span> // character of our parsing process continue parsing after the first opening bracket<a name="line.293"></a>
<span class="sourceLineNo">294</span> return begin;<a name="line.294"></a>
<span class="sourceLineNo">295</span> }<a name="line.295"></a>
<span class="sourceLineNo">296</span> return i + 1;<a name="line.296"></a>
<span class="sourceLineNo">297</span> }<a name="line.297"></a>
<span class="sourceLineNo">298</span><a name="line.298"></a>
<span class="sourceLineNo">299</span> options.add(pattern.substring(begin, i - 1));<a name="line.299"></a>
<span class="sourceLineNo">300</span> } // while<a name="line.300"></a>
<span class="sourceLineNo">301</span><a name="line.301"></a>
<span class="sourceLineNo">302</span> return i;<a name="line.302"></a>
<span class="sourceLineNo">303</span> }<a name="line.303"></a>
<span class="sourceLineNo">304</span><a name="line.304"></a>
<span class="sourceLineNo">305</span> /**<a name="line.305"></a>
<span class="sourceLineNo">306</span> * Parse a format specifier.<a name="line.306"></a>
<span class="sourceLineNo">307</span> *<a name="line.307"></a>
<span class="sourceLineNo">308</span> * @param pattern<a name="line.308"></a>
<span class="sourceLineNo">309</span> * pattern to parse.<a name="line.309"></a>
<span class="sourceLineNo">310</span> * @param patternConverters<a name="line.310"></a>
<span class="sourceLineNo">311</span> * list to receive pattern converters.<a name="line.311"></a>
<span class="sourceLineNo">312</span> * @param formattingInfos<a name="line.312"></a>
<span class="sourceLineNo">313</span> * list to receive field specifiers corresponding to pattern converters.<a name="line.313"></a>
<span class="sourceLineNo">314</span> * @param noConsoleNoAnsi<a name="line.314"></a>
<span class="sourceLineNo">315</span> * do not do not output ANSI escape codes if {@link System#console()}<a name="line.315"></a>
<span class="sourceLineNo">316</span> * @param convertBackslashes if {@code true}, backslash characters are treated as escape characters and character<a name="line.316"></a>
<span class="sourceLineNo">317</span> * sequences like "\" followed by "t" (backslash+t) are converted to special characters like '\t' (tab).<a name="line.317"></a>
<span class="sourceLineNo">318</span> */<a name="line.318"></a>
<span class="sourceLineNo">319</span> public void parse(final String pattern, final List&lt;PatternConverter&gt; patternConverters,<a name="line.319"></a>
<span class="sourceLineNo">320</span> final List&lt;FormattingInfo&gt; formattingInfos, final boolean noConsoleNoAnsi,<a name="line.320"></a>
<span class="sourceLineNo">321</span> final boolean convertBackslashes) {<a name="line.321"></a>
<span class="sourceLineNo">322</span> parse(pattern, patternConverters, formattingInfos, false, noConsoleNoAnsi, convertBackslashes);<a name="line.322"></a>
<span class="sourceLineNo">323</span> }<a name="line.323"></a>
<span class="sourceLineNo">324</span><a name="line.324"></a>
<span class="sourceLineNo">325</span> /**<a name="line.325"></a>
<span class="sourceLineNo">326</span> * Parse a format specifier.<a name="line.326"></a>
<span class="sourceLineNo">327</span> *<a name="line.327"></a>
<span class="sourceLineNo">328</span> * @param pattern<a name="line.328"></a>
<span class="sourceLineNo">329</span> * pattern to parse.<a name="line.329"></a>
<span class="sourceLineNo">330</span> * @param patternConverters<a name="line.330"></a>
<span class="sourceLineNo">331</span> * list to receive pattern converters.<a name="line.331"></a>
<span class="sourceLineNo">332</span> * @param formattingInfos<a name="line.332"></a>
<span class="sourceLineNo">333</span> * list to receive field specifiers corresponding to pattern converters.<a name="line.333"></a>
<span class="sourceLineNo">334</span> * @param disableAnsi<a name="line.334"></a>
<span class="sourceLineNo">335</span> * do not output ANSI escape codes<a name="line.335"></a>
<span class="sourceLineNo">336</span> * @param noConsoleNoAnsi<a name="line.336"></a>
<span class="sourceLineNo">337</span> * do not do not output ANSI escape codes if {@link System#console()}<a name="line.337"></a>
<span class="sourceLineNo">338</span> * @param convertBackslashes if {@code true}, backslash characters are treated as escape characters and character<a name="line.338"></a>
<span class="sourceLineNo">339</span> * sequences like "\" followed by "t" (backslash+t) are converted to special characters like '\t' (tab).<a name="line.339"></a>
<span class="sourceLineNo">340</span> */<a name="line.340"></a>
<span class="sourceLineNo">341</span> public void parse(final String pattern, final List&lt;PatternConverter&gt; patternConverters,<a name="line.341"></a>
<span class="sourceLineNo">342</span> final List&lt;FormattingInfo&gt; formattingInfos, final boolean disableAnsi,<a name="line.342"></a>
<span class="sourceLineNo">343</span> final boolean noConsoleNoAnsi, final boolean convertBackslashes) {<a name="line.343"></a>
<span class="sourceLineNo">344</span> Objects.requireNonNull(pattern, "pattern");<a name="line.344"></a>
<span class="sourceLineNo">345</span><a name="line.345"></a>
<span class="sourceLineNo">346</span> final StringBuilder currentLiteral = new StringBuilder(BUF_SIZE);<a name="line.346"></a>
<span class="sourceLineNo">347</span><a name="line.347"></a>
<span class="sourceLineNo">348</span> final int patternLength = pattern.length();<a name="line.348"></a>
<span class="sourceLineNo">349</span> ParserState state = ParserState.LITERAL_STATE;<a name="line.349"></a>
<span class="sourceLineNo">350</span> char c;<a name="line.350"></a>
<span class="sourceLineNo">351</span> int i = 0;<a name="line.351"></a>
<span class="sourceLineNo">352</span> FormattingInfo formattingInfo = FormattingInfo.getDefault();<a name="line.352"></a>
<span class="sourceLineNo">353</span><a name="line.353"></a>
<span class="sourceLineNo">354</span> while (i &lt; patternLength) {<a name="line.354"></a>
<span class="sourceLineNo">355</span> c = pattern.charAt(i++);<a name="line.355"></a>
<span class="sourceLineNo">356</span><a name="line.356"></a>
<span class="sourceLineNo">357</span> switch (state) {<a name="line.357"></a>
<span class="sourceLineNo">358</span> case LITERAL_STATE:<a name="line.358"></a>
<span class="sourceLineNo">359</span><a name="line.359"></a>
<span class="sourceLineNo">360</span> // In literal state, the last char is always a literal.<a name="line.360"></a>
<span class="sourceLineNo">361</span> if (i == patternLength) {<a name="line.361"></a>
<span class="sourceLineNo">362</span> currentLiteral.append(c);<a name="line.362"></a>
<span class="sourceLineNo">363</span><a name="line.363"></a>
<span class="sourceLineNo">364</span> continue;<a name="line.364"></a>
<span class="sourceLineNo">365</span> }<a name="line.365"></a>
<span class="sourceLineNo">366</span><a name="line.366"></a>
<span class="sourceLineNo">367</span> if (c == ESCAPE_CHAR) {<a name="line.367"></a>
<span class="sourceLineNo">368</span> // peek at the next char.<a name="line.368"></a>
<span class="sourceLineNo">369</span> switch (pattern.charAt(i)) {<a name="line.369"></a>
<span class="sourceLineNo">370</span> case ESCAPE_CHAR:<a name="line.370"></a>
<span class="sourceLineNo">371</span> currentLiteral.append(c);<a name="line.371"></a>
<span class="sourceLineNo">372</span> i++; // move pointer<a name="line.372"></a>
<span class="sourceLineNo">373</span><a name="line.373"></a>
<span class="sourceLineNo">374</span> break;<a name="line.374"></a>
<span class="sourceLineNo">375</span><a name="line.375"></a>
<span class="sourceLineNo">376</span> default:<a name="line.376"></a>
<span class="sourceLineNo">377</span><a name="line.377"></a>
<span class="sourceLineNo">378</span> if (currentLiteral.length() != 0) {<a name="line.378"></a>
<span class="sourceLineNo">379</span> patternConverters.add(new LiteralPatternConverter(config, currentLiteral.toString(),<a name="line.379"></a>
<span class="sourceLineNo">380</span> convertBackslashes));<a name="line.380"></a>
<span class="sourceLineNo">381</span> formattingInfos.add(FormattingInfo.getDefault());<a name="line.381"></a>
<span class="sourceLineNo">382</span> }<a name="line.382"></a>
<span class="sourceLineNo">383</span><a name="line.383"></a>
<span class="sourceLineNo">384</span> currentLiteral.setLength(0);<a name="line.384"></a>
<span class="sourceLineNo">385</span> currentLiteral.append(c); // append %<a name="line.385"></a>
<span class="sourceLineNo">386</span> state = ParserState.CONVERTER_STATE;<a name="line.386"></a>
<span class="sourceLineNo">387</span> formattingInfo = FormattingInfo.getDefault();<a name="line.387"></a>
<span class="sourceLineNo">388</span> }<a name="line.388"></a>
<span class="sourceLineNo">389</span> } else {<a name="line.389"></a>
<span class="sourceLineNo">390</span> currentLiteral.append(c);<a name="line.390"></a>
<span class="sourceLineNo">391</span> }<a name="line.391"></a>
<span class="sourceLineNo">392</span><a name="line.392"></a>
<span class="sourceLineNo">393</span> break;<a name="line.393"></a>
<span class="sourceLineNo">394</span><a name="line.394"></a>
<span class="sourceLineNo">395</span> case CONVERTER_STATE:<a name="line.395"></a>
<span class="sourceLineNo">396</span> currentLiteral.append(c);<a name="line.396"></a>
<span class="sourceLineNo">397</span><a name="line.397"></a>
<span class="sourceLineNo">398</span> switch (c) {<a name="line.398"></a>
<span class="sourceLineNo">399</span> case '0':<a name="line.399"></a>
<span class="sourceLineNo">400</span> // a '0' directly after the % sign indicates zero-padding<a name="line.400"></a>
<span class="sourceLineNo">401</span> formattingInfo = new FormattingInfo(formattingInfo.isLeftAligned(), formattingInfo.getMinLength(),<a name="line.401"></a>
<span class="sourceLineNo">402</span> formattingInfo.getMaxLength(), formattingInfo.isLeftTruncate(), true);<a name="line.402"></a>
<span class="sourceLineNo">403</span> break;<a name="line.403"></a>
<span class="sourceLineNo">404</span><a name="line.404"></a>
<span class="sourceLineNo">405</span> case '-':<a name="line.405"></a>
<span class="sourceLineNo">406</span> formattingInfo = new FormattingInfo(true, formattingInfo.getMinLength(),<a name="line.406"></a>
<span class="sourceLineNo">407</span> formattingInfo.getMaxLength(), formattingInfo.isLeftTruncate(), formattingInfo.isZeroPad());<a name="line.407"></a>
<span class="sourceLineNo">408</span> break;<a name="line.408"></a>
<span class="sourceLineNo">409</span><a name="line.409"></a>
<span class="sourceLineNo">410</span> case '.':<a name="line.410"></a>
<span class="sourceLineNo">411</span> state = ParserState.DOT_STATE;<a name="line.411"></a>
<span class="sourceLineNo">412</span> break;<a name="line.412"></a>
<span class="sourceLineNo">413</span><a name="line.413"></a>
<span class="sourceLineNo">414</span> default:<a name="line.414"></a>
<span class="sourceLineNo">415</span><a name="line.415"></a>
<span class="sourceLineNo">416</span> if (c &gt;= '0' &amp;&amp; c &lt;= '9') {<a name="line.416"></a>
<span class="sourceLineNo">417</span> formattingInfo = new FormattingInfo(formattingInfo.isLeftAligned(), c - '0',<a name="line.417"></a>
<span class="sourceLineNo">418</span> formattingInfo.getMaxLength(), formattingInfo.isLeftTruncate(), formattingInfo.isZeroPad());<a name="line.418"></a>
<span class="sourceLineNo">419</span> state = ParserState.MIN_STATE;<a name="line.419"></a>
<span class="sourceLineNo">420</span> } else {<a name="line.420"></a>
<span class="sourceLineNo">421</span> i = finalizeConverter(c, pattern, i, currentLiteral, formattingInfo, converterRules,<a name="line.421"></a>
<span class="sourceLineNo">422</span> patternConverters, formattingInfos, disableAnsi, noConsoleNoAnsi, convertBackslashes);<a name="line.422"></a>
<span class="sourceLineNo">423</span><a name="line.423"></a>
<span class="sourceLineNo">424</span> // Next pattern is assumed to be a literal.<a name="line.424"></a>
<span class="sourceLineNo">425</span> state = ParserState.LITERAL_STATE;<a name="line.425"></a>
<span class="sourceLineNo">426</span> formattingInfo = FormattingInfo.getDefault();<a name="line.426"></a>
<span class="sourceLineNo">427</span> currentLiteral.setLength(0);<a name="line.427"></a>
<span class="sourceLineNo">428</span> }<a name="line.428"></a>
<span class="sourceLineNo">429</span> } // switch<a name="line.429"></a>
<span class="sourceLineNo">430</span><a name="line.430"></a>
<span class="sourceLineNo">431</span> break;<a name="line.431"></a>
<span class="sourceLineNo">432</span><a name="line.432"></a>
<span class="sourceLineNo">433</span> case MIN_STATE:<a name="line.433"></a>
<span class="sourceLineNo">434</span> currentLiteral.append(c);<a name="line.434"></a>
<span class="sourceLineNo">435</span><a name="line.435"></a>
<span class="sourceLineNo">436</span> if (c &gt;= '0' &amp;&amp; c &lt;= '9') {<a name="line.436"></a>
<span class="sourceLineNo">437</span> // Multiply the existing value and add the value of the number just encountered.<a name="line.437"></a>
<span class="sourceLineNo">438</span> formattingInfo = new FormattingInfo(formattingInfo.isLeftAligned(), formattingInfo.getMinLength()<a name="line.438"></a>
<span class="sourceLineNo">439</span> * DECIMAL + c - '0', formattingInfo.getMaxLength(), formattingInfo.isLeftTruncate(), formattingInfo.isZeroPad());<a name="line.439"></a>
<span class="sourceLineNo">440</span> } else if (c == '.') {<a name="line.440"></a>
<span class="sourceLineNo">441</span> state = ParserState.DOT_STATE;<a name="line.441"></a>
<span class="sourceLineNo">442</span> } else {<a name="line.442"></a>
<span class="sourceLineNo">443</span> i = finalizeConverter(c, pattern, i, currentLiteral, formattingInfo, converterRules,<a name="line.443"></a>
<span class="sourceLineNo">444</span> patternConverters, formattingInfos, disableAnsi, noConsoleNoAnsi, convertBackslashes);<a name="line.444"></a>
<span class="sourceLineNo">445</span> state = ParserState.LITERAL_STATE;<a name="line.445"></a>
<span class="sourceLineNo">446</span> formattingInfo = FormattingInfo.getDefault();<a name="line.446"></a>
<span class="sourceLineNo">447</span> currentLiteral.setLength(0);<a name="line.447"></a>
<span class="sourceLineNo">448</span> }<a name="line.448"></a>
<span class="sourceLineNo">449</span><a name="line.449"></a>
<span class="sourceLineNo">450</span> break;<a name="line.450"></a>
<span class="sourceLineNo">451</span><a name="line.451"></a>
<span class="sourceLineNo">452</span> case DOT_STATE:<a name="line.452"></a>
<span class="sourceLineNo">453</span> currentLiteral.append(c);<a name="line.453"></a>
<span class="sourceLineNo">454</span> switch (c) {<a name="line.454"></a>
<span class="sourceLineNo">455</span> case '-':<a name="line.455"></a>
<span class="sourceLineNo">456</span> formattingInfo = new FormattingInfo(formattingInfo.isLeftAligned(), formattingInfo.getMinLength(),<a name="line.456"></a>
<span class="sourceLineNo">457</span> formattingInfo.getMaxLength(),false, formattingInfo.isZeroPad());<a name="line.457"></a>
<span class="sourceLineNo">458</span> break;<a name="line.458"></a>
<span class="sourceLineNo">459</span><a name="line.459"></a>
<span class="sourceLineNo">460</span> default:<a name="line.460"></a>
<span class="sourceLineNo">461</span><a name="line.461"></a>
<span class="sourceLineNo">462</span> if (c &gt;= '0' &amp;&amp; c &lt;= '9') {<a name="line.462"></a>
<span class="sourceLineNo">463</span> formattingInfo = new FormattingInfo(formattingInfo.isLeftAligned(), formattingInfo.getMinLength(),<a name="line.463"></a>
<span class="sourceLineNo">464</span> c - '0', formattingInfo.isLeftTruncate(), formattingInfo.isZeroPad());<a name="line.464"></a>
<span class="sourceLineNo">465</span> state = ParserState.MAX_STATE;<a name="line.465"></a>
<span class="sourceLineNo">466</span> } else {<a name="line.466"></a>
<span class="sourceLineNo">467</span> LOGGER.error("Error occurred in position " + i + ".\n Was expecting digit, instead got char \"" + c<a name="line.467"></a>
<span class="sourceLineNo">468</span> + "\".");<a name="line.468"></a>
<span class="sourceLineNo">469</span><a name="line.469"></a>
<span class="sourceLineNo">470</span> state = ParserState.LITERAL_STATE;<a name="line.470"></a>
<span class="sourceLineNo">471</span> }<a name="line.471"></a>
<span class="sourceLineNo">472</span> }<a name="line.472"></a>
<span class="sourceLineNo">473</span><a name="line.473"></a>
<span class="sourceLineNo">474</span> break;<a name="line.474"></a>
<span class="sourceLineNo">475</span><a name="line.475"></a>
<span class="sourceLineNo">476</span> case MAX_STATE:<a name="line.476"></a>
<span class="sourceLineNo">477</span> currentLiteral.append(c);<a name="line.477"></a>
<span class="sourceLineNo">478</span><a name="line.478"></a>
<span class="sourceLineNo">479</span> if (c &gt;= '0' &amp;&amp; c &lt;= '9') {<a name="line.479"></a>
<span class="sourceLineNo">480</span> // Multiply the existing value and add the value of the number just encountered.<a name="line.480"></a>
<span class="sourceLineNo">481</span> formattingInfo = new FormattingInfo(formattingInfo.isLeftAligned(), formattingInfo.getMinLength(),<a name="line.481"></a>
<span class="sourceLineNo">482</span> formattingInfo.getMaxLength() * DECIMAL + c - '0', formattingInfo.isLeftTruncate(), formattingInfo.isZeroPad());<a name="line.482"></a>
<span class="sourceLineNo">483</span> } else {<a name="line.483"></a>
<span class="sourceLineNo">484</span> i = finalizeConverter(c, pattern, i, currentLiteral, formattingInfo, converterRules,<a name="line.484"></a>
<span class="sourceLineNo">485</span> patternConverters, formattingInfos, disableAnsi, noConsoleNoAnsi, convertBackslashes);<a name="line.485"></a>
<span class="sourceLineNo">486</span> state = ParserState.LITERAL_STATE;<a name="line.486"></a>
<span class="sourceLineNo">487</span> formattingInfo = FormattingInfo.getDefault();<a name="line.487"></a>
<span class="sourceLineNo">488</span> currentLiteral.setLength(0);<a name="line.488"></a>
<span class="sourceLineNo">489</span> }<a name="line.489"></a>
<span class="sourceLineNo">490</span><a name="line.490"></a>
<span class="sourceLineNo">491</span> break;<a name="line.491"></a>
<span class="sourceLineNo">492</span> } // switch<a name="line.492"></a>
<span class="sourceLineNo">493</span> }<a name="line.493"></a>
<span class="sourceLineNo">494</span><a name="line.494"></a>
<span class="sourceLineNo">495</span> // while<a name="line.495"></a>
<span class="sourceLineNo">496</span> if (currentLiteral.length() != 0) {<a name="line.496"></a>
<span class="sourceLineNo">497</span> patternConverters.add(new LiteralPatternConverter(config, currentLiteral.toString(), convertBackslashes));<a name="line.497"></a>
<span class="sourceLineNo">498</span> formattingInfos.add(FormattingInfo.getDefault());<a name="line.498"></a>
<span class="sourceLineNo">499</span> }<a name="line.499"></a>
<span class="sourceLineNo">500</span> }<a name="line.500"></a>
<span class="sourceLineNo">501</span><a name="line.501"></a>
<span class="sourceLineNo">502</span> /**<a name="line.502"></a>
<span class="sourceLineNo">503</span> * Creates a new PatternConverter.<a name="line.503"></a>
<span class="sourceLineNo">504</span> *<a name="line.504"></a>
<span class="sourceLineNo">505</span> * @param converterId<a name="line.505"></a>
<span class="sourceLineNo">506</span> * converterId.<a name="line.506"></a>
<span class="sourceLineNo">507</span> * @param currentLiteral<a name="line.507"></a>
<span class="sourceLineNo">508</span> * literal to be used if converter is unrecognized or following converter if converterId contains extra<a name="line.508"></a>
<span class="sourceLineNo">509</span> * characters.<a name="line.509"></a>
<span class="sourceLineNo">510</span> * @param rules<a name="line.510"></a>
<span class="sourceLineNo">511</span> * map of stock pattern converters keyed by format specifier.<a name="line.511"></a>
<span class="sourceLineNo">512</span> * @param options<a name="line.512"></a>
<span class="sourceLineNo">513</span> * converter options.<a name="line.513"></a>
<span class="sourceLineNo">514</span> * @param disableAnsi<a name="line.514"></a>
<span class="sourceLineNo">515</span> * do not output ANSI escape codes<a name="line.515"></a>
<span class="sourceLineNo">516</span> * @param noConsoleNoAnsi<a name="line.516"></a>
<span class="sourceLineNo">517</span> * do not do not output ANSI escape codes if {@link System#console()}<a name="line.517"></a>
<span class="sourceLineNo">518</span> * @return converter or null.<a name="line.518"></a>
<span class="sourceLineNo">519</span> */<a name="line.519"></a>
<span class="sourceLineNo">520</span> private PatternConverter createConverter(final String converterId, final StringBuilder currentLiteral,<a name="line.520"></a>
<span class="sourceLineNo">521</span> final Map&lt;String, Class&lt;PatternConverter&gt;&gt; rules, final List&lt;String&gt; options, final boolean disableAnsi,<a name="line.521"></a>
<span class="sourceLineNo">522</span> final boolean noConsoleNoAnsi) {<a name="line.522"></a>
<span class="sourceLineNo">523</span> String converterName = converterId;<a name="line.523"></a>
<span class="sourceLineNo">524</span> Class&lt;PatternConverter&gt; converterClass = null;<a name="line.524"></a>
<span class="sourceLineNo">525</span><a name="line.525"></a>
<span class="sourceLineNo">526</span> if (rules == null) {<a name="line.526"></a>
<span class="sourceLineNo">527</span> LOGGER.error("Null rules for [" + converterId + ']');<a name="line.527"></a>
<span class="sourceLineNo">528</span> return null;<a name="line.528"></a>
<span class="sourceLineNo">529</span> }<a name="line.529"></a>
<span class="sourceLineNo">530</span> for (int i = converterId.length(); i &gt; 0 &amp;&amp; converterClass == null; i--) {<a name="line.530"></a>
<span class="sourceLineNo">531</span> converterName = converterName.substring(0, i);<a name="line.531"></a>
<span class="sourceLineNo">532</span> converterClass = rules.get(converterName);<a name="line.532"></a>
<span class="sourceLineNo">533</span> }<a name="line.533"></a>
<span class="sourceLineNo">534</span><a name="line.534"></a>
<span class="sourceLineNo">535</span> if (converterClass == null) {<a name="line.535"></a>
<span class="sourceLineNo">536</span> LOGGER.error("Unrecognized format specifier [" + converterId + ']');<a name="line.536"></a>
<span class="sourceLineNo">537</span> return null;<a name="line.537"></a>
<span class="sourceLineNo">538</span> }<a name="line.538"></a>
<span class="sourceLineNo">539</span><a name="line.539"></a>
<span class="sourceLineNo">540</span> if (AnsiConverter.class.isAssignableFrom(converterClass)) {<a name="line.540"></a>
<span class="sourceLineNo">541</span> options.add(DISABLE_ANSI + '=' + disableAnsi);<a name="line.541"></a>
<span class="sourceLineNo">542</span> options.add(NO_CONSOLE_NO_ANSI + '=' + noConsoleNoAnsi);<a name="line.542"></a>
<span class="sourceLineNo">543</span> }<a name="line.543"></a>
<span class="sourceLineNo">544</span> // Work around the regression bug in Class.getDeclaredMethods() in Oracle Java in version &gt; 1.6.0_17:<a name="line.544"></a>
<span class="sourceLineNo">545</span> // http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6815786<a name="line.545"></a>
<span class="sourceLineNo">546</span> final Method[] methods = converterClass.getDeclaredMethods();<a name="line.546"></a>
<span class="sourceLineNo">547</span> Method newInstanceMethod = null;<a name="line.547"></a>
<span class="sourceLineNo">548</span> for (final Method method : methods) {<a name="line.548"></a>
<span class="sourceLineNo">549</span> if (Modifier.isStatic(method.getModifiers())<a name="line.549"></a>
<span class="sourceLineNo">550</span> &amp;&amp; method.getDeclaringClass().equals(converterClass)<a name="line.550"></a>
<span class="sourceLineNo">551</span> &amp;&amp; method.getName().equals("newInstance")<a name="line.551"></a>
<span class="sourceLineNo">552</span> &amp;&amp; areValidNewInstanceParameters(method.getParameterTypes())) {<a name="line.552"></a>
<span class="sourceLineNo">553</span> if (newInstanceMethod == null) {<a name="line.553"></a>
<span class="sourceLineNo">554</span> newInstanceMethod = method;<a name="line.554"></a>
<span class="sourceLineNo">555</span> } else if (method.getReturnType().equals(newInstanceMethod.getReturnType())) {<a name="line.555"></a>
<span class="sourceLineNo">556</span> LOGGER.error("Class " + converterClass + " cannot contain multiple static newInstance methods");<a name="line.556"></a>
<span class="sourceLineNo">557</span> return null;<a name="line.557"></a>
<span class="sourceLineNo">558</span> }<a name="line.558"></a>
<span class="sourceLineNo">559</span> }<a name="line.559"></a>
<span class="sourceLineNo">560</span> }<a name="line.560"></a>
<span class="sourceLineNo">561</span> if (newInstanceMethod == null) {<a name="line.561"></a>
<span class="sourceLineNo">562</span> LOGGER.error("Class " + converterClass + " does not contain a static newInstance method");<a name="line.562"></a>
<span class="sourceLineNo">563</span> return null;<a name="line.563"></a>
<span class="sourceLineNo">564</span> }<a name="line.564"></a>
<span class="sourceLineNo">565</span><a name="line.565"></a>
<span class="sourceLineNo">566</span> final Class&lt;?&gt;[] parmTypes = newInstanceMethod.getParameterTypes();<a name="line.566"></a>
<span class="sourceLineNo">567</span> final Object[] parms = parmTypes.length &gt; 0 ? new Object[parmTypes.length] : null;<a name="line.567"></a>
<span class="sourceLineNo">568</span><a name="line.568"></a>
<span class="sourceLineNo">569</span> if (parms != null) {<a name="line.569"></a>
<span class="sourceLineNo">570</span> int i = 0;<a name="line.570"></a>
<span class="sourceLineNo">571</span> boolean errors = false;<a name="line.571"></a>
<span class="sourceLineNo">572</span> for (final Class&lt;?&gt; clazz : parmTypes) {<a name="line.572"></a>
<span class="sourceLineNo">573</span> if (clazz.isArray() &amp;&amp; clazz.getName().equals("[Ljava.lang.String;")) {<a name="line.573"></a>
<span class="sourceLineNo">574</span> final String[] optionsArray = options.toArray(new String[options.size()]);<a name="line.574"></a>
<span class="sourceLineNo">575</span> parms[i] = optionsArray;<a name="line.575"></a>
<span class="sourceLineNo">576</span> } else if (clazz.isAssignableFrom(Configuration.class)) {<a name="line.576"></a>
<span class="sourceLineNo">577</span> parms[i] = config;<a name="line.577"></a>
<span class="sourceLineNo">578</span> } else {<a name="line.578"></a>
<span class="sourceLineNo">579</span> LOGGER.error("Unknown parameter type " + clazz.getName() + " for static newInstance method of "<a name="line.579"></a>
<span class="sourceLineNo">580</span> + converterClass.getName());<a name="line.580"></a>
<span class="sourceLineNo">581</span> errors = true;<a name="line.581"></a>
<span class="sourceLineNo">582</span> }<a name="line.582"></a>
<span class="sourceLineNo">583</span> ++i;<a name="line.583"></a>
<span class="sourceLineNo">584</span> }<a name="line.584"></a>
<span class="sourceLineNo">585</span> if (errors) {<a name="line.585"></a>
<span class="sourceLineNo">586</span> return null;<a name="line.586"></a>
<span class="sourceLineNo">587</span> }<a name="line.587"></a>
<span class="sourceLineNo">588</span> }<a name="line.588"></a>
<span class="sourceLineNo">589</span><a name="line.589"></a>
<span class="sourceLineNo">590</span> try {<a name="line.590"></a>
<span class="sourceLineNo">591</span> final Object newObj = newInstanceMethod.invoke(null, parms);<a name="line.591"></a>
<span class="sourceLineNo">592</span><a name="line.592"></a>
<span class="sourceLineNo">593</span> if (newObj instanceof PatternConverter) {<a name="line.593"></a>
<span class="sourceLineNo">594</span> currentLiteral.delete(0, currentLiteral.length() - (converterId.length() - converterName.length()));<a name="line.594"></a>
<span class="sourceLineNo">595</span><a name="line.595"></a>
<span class="sourceLineNo">596</span> return (PatternConverter) newObj;<a name="line.596"></a>
<span class="sourceLineNo">597</span> }<a name="line.597"></a>
<span class="sourceLineNo">598</span> LOGGER.warn("Class {} does not extend PatternConverter.", converterClass.getName());<a name="line.598"></a>
<span class="sourceLineNo">599</span> } catch (final Exception ex) {<a name="line.599"></a>
<span class="sourceLineNo">600</span> LOGGER.error("Error creating converter for " + converterId, ex);<a name="line.600"></a>
<span class="sourceLineNo">601</span> }<a name="line.601"></a>
<span class="sourceLineNo">602</span><a name="line.602"></a>
<span class="sourceLineNo">603</span> return null;<a name="line.603"></a>
<span class="sourceLineNo">604</span> }<a name="line.604"></a>
<span class="sourceLineNo">605</span><a name="line.605"></a>
<span class="sourceLineNo">606</span> /** LOG4J2-2564: Returns true if all method parameters are valid for injection. */<a name="line.606"></a>
<span class="sourceLineNo">607</span> private static boolean areValidNewInstanceParameters(Class&lt;?&gt;[] parameterTypes) {<a name="line.607"></a>
<span class="sourceLineNo">608</span> for (Class&lt;?&gt; clazz : parameterTypes) {<a name="line.608"></a>
<span class="sourceLineNo">609</span> if (!clazz.isAssignableFrom(Configuration.class)<a name="line.609"></a>
<span class="sourceLineNo">610</span> &amp;&amp; !(clazz.isArray() &amp;&amp; "[Ljava.lang.String;".equals(clazz.getName()))) {<a name="line.610"></a>
<span class="sourceLineNo">611</span> return false;<a name="line.611"></a>
<span class="sourceLineNo">612</span> }<a name="line.612"></a>
<span class="sourceLineNo">613</span> }<a name="line.613"></a>
<span class="sourceLineNo">614</span> return true;<a name="line.614"></a>
<span class="sourceLineNo">615</span> }<a name="line.615"></a>
<span class="sourceLineNo">616</span><a name="line.616"></a>
<span class="sourceLineNo">617</span> /**<a name="line.617"></a>
<span class="sourceLineNo">618</span> * Processes a format specifier sequence.<a name="line.618"></a>
<span class="sourceLineNo">619</span> *<a name="line.619"></a>
<span class="sourceLineNo">620</span> * @param c<a name="line.620"></a>
<span class="sourceLineNo">621</span> * initial character of format specifier.<a name="line.621"></a>
<span class="sourceLineNo">622</span> * @param pattern<a name="line.622"></a>
<span class="sourceLineNo">623</span> * conversion pattern<a name="line.623"></a>
<span class="sourceLineNo">624</span> * @param start<a name="line.624"></a>
<span class="sourceLineNo">625</span> * current position in conversion pattern.<a name="line.625"></a>
<span class="sourceLineNo">626</span> * @param currentLiteral<a name="line.626"></a>
<span class="sourceLineNo">627</span> * current literal.<a name="line.627"></a>
<span class="sourceLineNo">628</span> * @param formattingInfo<a name="line.628"></a>
<span class="sourceLineNo">629</span> * current field specifier.<a name="line.629"></a>
<span class="sourceLineNo">630</span> * @param rules<a name="line.630"></a>
<span class="sourceLineNo">631</span> * map of stock pattern converters keyed by format specifier.<a name="line.631"></a>
<span class="sourceLineNo">632</span> * @param patternConverters<a name="line.632"></a>
<span class="sourceLineNo">633</span> * list to receive parsed pattern converter.<a name="line.633"></a>
<span class="sourceLineNo">634</span> * @param formattingInfos<a name="line.634"></a>
<span class="sourceLineNo">635</span> * list to receive corresponding field specifier.<a name="line.635"></a>
<span class="sourceLineNo">636</span> * @param disableAnsi<a name="line.636"></a>
<span class="sourceLineNo">637</span> * do not output ANSI escape codes<a name="line.637"></a>
<span class="sourceLineNo">638</span> * @param noConsoleNoAnsi<a name="line.638"></a>
<span class="sourceLineNo">639</span> * do not do not output ANSI escape codes if {@link System#console()}<a name="line.639"></a>
<span class="sourceLineNo">640</span> * @param convertBackslashes if {@code true}, backslash characters are treated as escape characters and character<a name="line.640"></a>
<span class="sourceLineNo">641</span> * sequences like "\" followed by "t" (backslash+t) are converted to special characters like '\t' (tab).<a name="line.641"></a>
<span class="sourceLineNo">642</span> * @return position after format specifier sequence.<a name="line.642"></a>
<span class="sourceLineNo">643</span> */<a name="line.643"></a>
<span class="sourceLineNo">644</span> private int finalizeConverter(final char c, final String pattern, final int start,<a name="line.644"></a>
<span class="sourceLineNo">645</span> final StringBuilder currentLiteral, final FormattingInfo formattingInfo,<a name="line.645"></a>
<span class="sourceLineNo">646</span> final Map&lt;String, Class&lt;PatternConverter&gt;&gt; rules, final List&lt;PatternConverter&gt; patternConverters,<a name="line.646"></a>
<span class="sourceLineNo">647</span> final List&lt;FormattingInfo&gt; formattingInfos, final boolean disableAnsi, final boolean noConsoleNoAnsi,<a name="line.647"></a>
<span class="sourceLineNo">648</span> final boolean convertBackslashes) {<a name="line.648"></a>
<span class="sourceLineNo">649</span> int i = start;<a name="line.649"></a>
<span class="sourceLineNo">650</span> final StringBuilder convBuf = new StringBuilder();<a name="line.650"></a>
<span class="sourceLineNo">651</span> i = extractConverter(c, pattern, i, convBuf, currentLiteral);<a name="line.651"></a>
<span class="sourceLineNo">652</span><a name="line.652"></a>
<span class="sourceLineNo">653</span> final String converterId = convBuf.toString();<a name="line.653"></a>
<span class="sourceLineNo">654</span><a name="line.654"></a>
<span class="sourceLineNo">655</span> final List&lt;String&gt; options = new ArrayList&lt;&gt;();<a name="line.655"></a>
<span class="sourceLineNo">656</span> i = extractOptions(pattern, i, options);<a name="line.656"></a>
<span class="sourceLineNo">657</span><a name="line.657"></a>
<span class="sourceLineNo">658</span> final PatternConverter pc = createConverter(converterId, currentLiteral, rules, options, disableAnsi,<a name="line.658"></a>
<span class="sourceLineNo">659</span> noConsoleNoAnsi);<a name="line.659"></a>
<span class="sourceLineNo">660</span><a name="line.660"></a>
<span class="sourceLineNo">661</span> if (pc == null) {<a name="line.661"></a>
<span class="sourceLineNo">662</span> StringBuilder msg;<a name="line.662"></a>
<span class="sourceLineNo">663</span><a name="line.663"></a>
<span class="sourceLineNo">664</span> if (Strings.isEmpty(converterId)) {<a name="line.664"></a>
<span class="sourceLineNo">665</span> msg = new StringBuilder("Empty conversion specifier starting at position ");<a name="line.665"></a>
<span class="sourceLineNo">666</span> } else {<a name="line.666"></a>
<span class="sourceLineNo">667</span> msg = new StringBuilder("Unrecognized conversion specifier [");<a name="line.667"></a>
<span class="sourceLineNo">668</span> msg.append(converterId);<a name="line.668"></a>
<span class="sourceLineNo">669</span> msg.append("] starting at position ");<a name="line.669"></a>
<span class="sourceLineNo">670</span> }<a name="line.670"></a>
<span class="sourceLineNo">671</span><a name="line.671"></a>
<span class="sourceLineNo">672</span> msg.append(Integer.toString(i));<a name="line.672"></a>
<span class="sourceLineNo">673</span> msg.append(" in conversion pattern.");<a name="line.673"></a>
<span class="sourceLineNo">674</span><a name="line.674"></a>
<span class="sourceLineNo">675</span> LOGGER.error(msg.toString());<a name="line.675"></a>
<span class="sourceLineNo">676</span><a name="line.676"></a>
<span class="sourceLineNo">677</span> patternConverters.add(new LiteralPatternConverter(config, currentLiteral.toString(), convertBackslashes));<a name="line.677"></a>
<span class="sourceLineNo">678</span> formattingInfos.add(FormattingInfo.getDefault());<a name="line.678"></a>
<span class="sourceLineNo">679</span> } else {<a name="line.679"></a>
<span class="sourceLineNo">680</span> patternConverters.add(pc);<a name="line.680"></a>
<span class="sourceLineNo">681</span> formattingInfos.add(formattingInfo);<a name="line.681"></a>
<span class="sourceLineNo">682</span><a name="line.682"></a>
<span class="sourceLineNo">683</span> if (currentLiteral.length() &gt; 0) {<a name="line.683"></a>
<span class="sourceLineNo">684</span> patternConverters<a name="line.684"></a>
<span class="sourceLineNo">685</span> .add(new LiteralPatternConverter(config, currentLiteral.toString(), convertBackslashes));<a name="line.685"></a>
<span class="sourceLineNo">686</span> formattingInfos.add(FormattingInfo.getDefault());<a name="line.686"></a>
<span class="sourceLineNo">687</span> }<a name="line.687"></a>
<span class="sourceLineNo">688</span> }<a name="line.688"></a>
<span class="sourceLineNo">689</span><a name="line.689"></a>
<span class="sourceLineNo">690</span> currentLiteral.setLength(0);<a name="line.690"></a>
<span class="sourceLineNo">691</span><a name="line.691"></a>
<span class="sourceLineNo">692</span> return i;<a name="line.692"></a>
<span class="sourceLineNo">693</span> }<a name="line.693"></a>
<span class="sourceLineNo">694</span>}<a name="line.694"></a>
</pre>
</div>
</body>
</html>