Google Git
Sign in
apache / logging-site / a4f88a44f9ece0268ea2d36ba57a00f2b881cabc / . / content / log4j / 2.13.0 / log4j-core / xref / org / apache / logging / log4j / core / util / JsonUtils.html
blob: 0fd18af0965ab364f49c3a4675f599142bc5f446 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>JsonUtils xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/logging/log4j/core/util/JsonUtils.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.util;
<a class="jxr_linenumber" name="L18" href="#L18">18</a>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_javadoccomment"> * This class is borrowed from &lt;a href="https://github.com/FasterXML/jackson-core"&gt;Jackson&lt;/a&gt;.</em>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/logging/log4j/core/util/JsonUtils.html">JsonUtils</a> {
<a class="jxr_linenumber" name="L23" href="#L23">23</a>
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] HC = <span class="jxr_string">"0123456789ABCDEF"</span>.toCharArray();
<a class="jxr_linenumber" name="L25" href="#L25">25</a>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * Read-only encoding table for first 128 Unicode code points (single-byte UTF-8 characters).</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * Value of 0 means "no escaping"; other positive values that value is character</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * to use after backslash; and negative values that generic (backslash - u)</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * escaping is to be used.</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong>[] ESC_CODES;
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <strong class="jxr_keyword">static</strong> {
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong>[] table = <strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">int</strong>[128];
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_comment">// Control chars need generic escape sequence</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; 32; ++i) {
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_comment">// 04-Mar-2011, tatu: Used to use "-(i + 1)", replaced with constant</em>
<a class="jxr_linenumber" name="L38" href="#L38">38</a> table[i] = -1;
<a class="jxr_linenumber" name="L39" href="#L39">39</a> }
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_comment">/* Others (and some within that range too) have explicit shorter</em>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_comment"> * sequences</em>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L43" href="#L43">43</a> table['&quot;'] = '&quot;';
<a class="jxr_linenumber" name="L44" href="#L44">44</a> table['&#92;&#92;'] = '&#92;&#92;';
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_comment">// Escaping of slash is optional, so let's not add it</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> table[0x08] = 'b';
<a class="jxr_linenumber" name="L47" href="#L47">47</a> table[0x09] = 't';
<a class="jxr_linenumber" name="L48" href="#L48">48</a> table[0x0C] = 'f';
<a class="jxr_linenumber" name="L49" href="#L49">49</a> table[0x0A] = 'n';
<a class="jxr_linenumber" name="L50" href="#L50">50</a> table[0x0D] = 'r';
<a class="jxr_linenumber" name="L51" href="#L51">51</a> ESC_CODES = table;
<a class="jxr_linenumber" name="L52" href="#L52">52</a> }
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Temporary buffer used for composing quote/escape sequences</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">static</strong> ThreadLocal&lt;<strong class="jxr_keyword">char</strong>[]&gt; _qbufLocal = <strong class="jxr_keyword">new</strong> ThreadLocal&lt;&gt;();
<a class="jxr_linenumber" name="L58" href="#L58">58</a>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">char</strong>[] getQBuf() {
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">char</strong>[] _qbuf = _qbufLocal.get();
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">if</strong> (_qbuf == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L62" href="#L62">62</a> _qbuf = <strong class="jxr_keyword">new</strong> <strong class="jxr_keyword">char</strong>[6];
<a class="jxr_linenumber" name="L63" href="#L63">63</a> _qbuf[0] = '&#92;&#92;';
<a class="jxr_linenumber" name="L64" href="#L64">64</a> _qbuf[2] = '0';
<a class="jxr_linenumber" name="L65" href="#L65">65</a> _qbuf[3] = '0';
<a class="jxr_linenumber" name="L66" href="#L66">66</a>
<a class="jxr_linenumber" name="L67" href="#L67">67</a> _qbufLocal.set(_qbuf);
<a class="jxr_linenumber" name="L68" href="#L68">68</a> }
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">return</strong> _qbuf;
<a class="jxr_linenumber" name="L70" href="#L70">70</a> }
<a class="jxr_linenumber" name="L71" href="#L71">71</a>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * Quote text contents using JSON standard quoting, and append results to a supplied {@link StringBuilder}.</em>
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">void</strong> quoteAsString(<strong class="jxr_keyword">final</strong> CharSequence input, <strong class="jxr_keyword">final</strong> StringBuilder output) {
<a class="jxr_linenumber" name="L76" href="#L76">76</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] qbuf = getQBuf();
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> escCodeCount = ESC_CODES.length;
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">int</strong> inPtr = 0;
<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> inputLen = input.length();
<a class="jxr_linenumber" name="L80" href="#L80">80</a>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">outer</strong>:
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">while</strong> (inPtr &lt; inputLen) {
<a class="jxr_linenumber" name="L83" href="#L83">83</a> tight_loop:
<a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">while</strong> (<strong class="jxr_keyword">true</strong>) {
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> c = input.charAt(inPtr);
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">if</strong> (c &lt; escCodeCount &amp;&amp; ESC_CODES[c] != 0) {
<a class="jxr_linenumber" name="L87" href="#L87">87</a> <strong class="jxr_keyword">break</strong> tight_loop;
<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
<a class="jxr_linenumber" name="L89" href="#L89">89</a> output.append(c);
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">if</strong> (++inPtr &gt;= inputLen) {
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">break</strong> <strong class="jxr_keyword">outer</strong>;
<a class="jxr_linenumber" name="L92" href="#L92">92</a> }
<a class="jxr_linenumber" name="L93" href="#L93">93</a> }
<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_comment">// something to escape; 2 or 6-char variant?</em>
<a class="jxr_linenumber" name="L95" href="#L95">95</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> d = input.charAt(inPtr++);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> escCode = ESC_CODES[d];
<a class="jxr_linenumber" name="L97" href="#L97">97</a> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> length = (escCode &lt; 0)
<a class="jxr_linenumber" name="L98" href="#L98">98</a> ? _appendNumeric(d, qbuf)
<a class="jxr_linenumber" name="L99" href="#L99">99</a> : _appendNamed(escCode, qbuf);
<a class="jxr_linenumber" name="L100" href="#L100">100</a>
<a class="jxr_linenumber" name="L101" href="#L101">101</a> output.append(qbuf, 0, length);
<a class="jxr_linenumber" name="L102" href="#L102">102</a> }
<a class="jxr_linenumber" name="L103" href="#L103">103</a> }
<a class="jxr_linenumber" name="L104" href="#L104">104</a>
<a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> _appendNumeric(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> value, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] qbuf) {
<a class="jxr_linenumber" name="L106" href="#L106">106</a> qbuf[1] = 'u';
<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_comment">// We know it's a control char, so only the last 2 chars are non-0</em>
<a class="jxr_linenumber" name="L108" href="#L108">108</a> qbuf[4] = HC[value &gt;&gt; 4];
<a class="jxr_linenumber" name="L109" href="#L109">109</a> qbuf[5] = HC[value &amp; 0xF];
<a class="jxr_linenumber" name="L110" href="#L110">110</a> <strong class="jxr_keyword">return</strong> 6;
<a class="jxr_linenumber" name="L111" href="#L111">111</a> }
<a class="jxr_linenumber" name="L112" href="#L112">112</a>
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> _appendNamed(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> esc, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong>[] qbuf) {
<a class="jxr_linenumber" name="L114" href="#L114">114</a> qbuf[1] = (<strong class="jxr_keyword">char</strong>) esc;
<a class="jxr_linenumber" name="L115" href="#L115">115</a> <strong class="jxr_keyword">return</strong> 2;
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a>
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 1999&#x2013;2019 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>