StringTools.hx 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205
  1. /*
  2. * Copyright (C)2005-2018 Haxe Foundation
  3. *
  4. * Permission is hereby granted, free of charge, to any person obtaining a
  5. * copy of this software and associated documentation files (the "Software"),
  6. * to deal in the Software without restriction, including without limitation
  7. * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  8. * and/or sell copies of the Software, and to permit persons to whom the
  9. * Software is furnished to do so, subject to the following conditions:
  10. *
  11. * The above copyright notice and this permission notice shall be included in
  12. * all copies or substantial portions of the Software.
  13. *
  14. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19. * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20. * DEALINGS IN THE SOFTWARE.
  21. */
  22. import php.*;
  23. @:coreApi class StringTools {
  24. public inline static function urlEncode( s : String ) : String {
  25. return Global.rawurlencode(s);
  26. }
  27. public inline static function urlDecode( s : String ) : String {
  28. return Global.urldecode(s);
  29. }
  30. public inline static function htmlEscape( s : String, ?quotes : Bool ) : String {
  31. return Global.htmlspecialchars(s, (quotes ? Const.ENT_QUOTES | Const.ENT_HTML401 : Const.ENT_NOQUOTES));
  32. }
  33. public inline static function htmlUnescape( s : String ) : String {
  34. return Global.htmlspecialchars_decode(s, Const.ENT_QUOTES);
  35. }
  36. public static function startsWith( s : String, start : String ) : Bool {
  37. return start == '' || Global.strpos(s, start) == 0;
  38. }
  39. public static function endsWith( s : String, end : String ) : Bool {
  40. return end == '' || Global.substr(s, -end.length) == end;
  41. }
  42. public static function isSpace( s : String, pos : Int ) : Bool {
  43. var c = s.charCodeAt( pos );
  44. return (c >= 9 && c <= 13) || c == 32;
  45. }
  46. public inline static function ltrim( s : String ) : String {
  47. return Global.ltrim(s);
  48. }
  49. public inline static function rtrim( s : String ) : String {
  50. return Global.rtrim(s);
  51. }
  52. public inline static function trim( s : String ) : String {
  53. return Global.trim(s);
  54. }
  55. public static function rpad( s : String, c : String, l : Int ) : String {
  56. if (c.length == 0 || s.length >= l) return s;
  57. var padLength = Math.ceil((l - s.length) / c.length) * c.length + s.length;
  58. return Global.str_pad(s, padLength, c, Const.STR_PAD_RIGHT);
  59. }
  60. public static function lpad( s : String, c : String, l : Int ) : String {
  61. if (c.length == 0 || s.length >= l) return s;
  62. var padLength = Math.ceil((l - s.length) / c.length) * c.length + s.length;
  63. return Global.str_pad(s, padLength, c, Const.STR_PAD_LEFT);
  64. }
  65. public static function replace( s : String, sub : String, by : String ) : String {
  66. if (sub == '') {
  67. return Global.implode(by, Global.str_split(s));
  68. }
  69. return Global.str_replace(sub, by, s);
  70. }
  71. public static function hex( n : Int, ?digits : Int ) : String {
  72. var s = Global.dechex(n);
  73. var len = 8;
  74. if (s.length > (null == digits ? len : (len = digits > len ? digits : len)))
  75. s = s.substr(-len);
  76. else if ( digits != null )
  77. s = lpad(s, '0', digits);
  78. return s.toUpperCase();
  79. }
  80. public static inline function fastCodeAt( s : String, index : Int ) : Int {
  81. return (s.length == index ? 0 : Global.ord((s:NativeString)[index]));
  82. }
  83. public static inline function isEof( c : Int ) : Bool {
  84. return c == 0;
  85. }
  86. /**
  87. Returns a String that can be used as a single command line argument
  88. on Unix.
  89. The input will be quoted, or escaped if necessary.
  90. */
  91. public static function quoteUnixArg(argument:String):String {
  92. // Based on cpython's shlex.quote().
  93. // https://hg.python.org/cpython/file/a3f076d4f54f/Lib/shlex.py#l278
  94. if (argument == "")
  95. return "''";
  96. if (!~/[^a-zA-Z0-9_@%+=:,.\/-]/.match(argument))
  97. return argument;
  98. // use single quotes, and put single quotes into double quotes
  99. // the string $'b is then quoted as '$'"'"'b'
  100. return "'" + replace(argument, "'", "'\"'\"'") + "'";
  101. }
  102. /**
  103. Character codes of the characters that will be escaped by `quoteWinArg(_, true)`.
  104. */
  105. public static var winMetaCharacters = [";".code, ",".code, " ".code, "(".code, ")".code, "%".code, "!".code, "^".code, "\"".code, "<".code, ">".code, "&".code, "|".code, "\n".code, "\r".code];
  106. /**
  107. Returns a String that can be used as a single command line argument
  108. on Windows.
  109. The input will be quoted, or escaped if necessary, such that the output
  110. will be parsed as a single argument using the rule specified in
  111. http://msdn.microsoft.com/en-us/library/ms880421
  112. Examples:
  113. ```
  114. quoteWinArg("abc") == "abc";
  115. quoteWinArg("ab c") == '"ab c"';
  116. ```
  117. */
  118. public static function quoteWinArg(argument:String, escapeMetaCharacters:Bool):String {
  119. // If there is no space, tab, back-slash, or double-quotes, and it is not an empty string.
  120. if (!~/^[^ \t\\"]+$/.match(argument)) {
  121. // Based on cpython's subprocess.list2cmdline().
  122. // https://hg.python.org/cpython/file/50741316dd3a/Lib/subprocess.py#l620
  123. var result = new StringBuf();
  124. var needquote = argument.indexOf(" ") != -1 || argument.indexOf("\t") != -1 || argument == "";
  125. if (needquote)
  126. result.add('"');
  127. var bs_buf = new StringBuf();
  128. for (i in 0...argument.length) {
  129. switch (argument.charCodeAt(i)) {
  130. case "\\".code:
  131. // Don't know if we need to double yet.
  132. bs_buf.add("\\");
  133. case '"'.code:
  134. // Double backslashes.
  135. var bs = bs_buf.toString();
  136. result.add(bs);
  137. result.add(bs);
  138. bs_buf = new StringBuf();
  139. result.add('\\"');
  140. case var c:
  141. // Normal char
  142. if (bs_buf.length > 0) {
  143. result.add(bs_buf.toString());
  144. bs_buf = new StringBuf();
  145. }
  146. result.addChar(c);
  147. }
  148. }
  149. // Add remaining backslashes, if any.
  150. result.add(bs_buf.toString());
  151. if (needquote) {
  152. result.add(bs_buf.toString());
  153. result.add('"');
  154. }
  155. argument = result.toString();
  156. }
  157. if (escapeMetaCharacters) {
  158. var result = new StringBuf();
  159. for (i in 0...argument.length) {
  160. var c = argument.charCodeAt(i);
  161. if (winMetaCharacters.indexOf(c) >= 0) {
  162. result.addChar("^".code);
  163. }
  164. result.addChar(c);
  165. }
  166. return result.toString();
  167. } else {
  168. return argument;
  169. }
  170. }
  171. }