String.hx 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. /*
  2. * Copyright (c) 2005, The haXe Project Contributors
  3. * All rights reserved.
  4. * Redistribution and use in source and binary forms, with or without
  5. * modification, are permitted provided that the following conditions are met:
  6. *
  7. * - Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * - Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. *
  13. * THIS SOFTWARE IS PROVIDED BY THE HAXE PROJECT CONTRIBUTORS "AS IS" AND ANY
  14. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16. * DISCLAIMED. IN NO EVENT SHALL THE HAXE PROJECT CONTRIBUTORS BE LIABLE FOR
  17. * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  19. * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  20. * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22. * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  23. * DAMAGE.
  24. */
  25. /**
  26. The basic String class.
  27. **/
  28. extern class String {
  29. /**
  30. The number of characters in the String.
  31. **/
  32. var length(default,null) : Int;
  33. /**
  34. Creates a copy from a given String.
  35. **/
  36. function new(string:String) : Void;
  37. /**
  38. Returns an String where all characters have been uppercased.
  39. **/
  40. function toUpperCase() : String;
  41. /**
  42. Returns an String where all characters have been lowercased.
  43. **/
  44. function toLowerCase() : String;
  45. /**
  46. Returns the character at the given position.
  47. Returns the empty String if outside of String bounds.
  48. **/
  49. function charAt( index : Int) : String;
  50. /**
  51. Returns the character code at the given position.
  52. Returns [null] if outside of String bounds.
  53. **/
  54. function charCodeAt( index : Int) : Null<Int>;
  55. /**
  56. Returns the index of first occurence of [value]
  57. Returns [1-1] if [value] is not found.
  58. The optional [startIndex] parameter allows you to specify at which character to start searching.
  59. The position returned is still relative to the beginning of the string.
  60. **/
  61. function indexOf( str : String, ?startIndex : Int ) : Int;
  62. /**
  63. Similar to [indexOf] but returns the latest index.
  64. **/
  65. function lastIndexOf( str : String, ?startIndex : Int ) : Int;
  66. /**
  67. Split the string using the specified delimiter.
  68. **/
  69. function split( delimiter : String ) : Array<String>;
  70. /**
  71. Returns a part of the String, taking [len] characters starting from [pos].
  72. If [len] is not specified, it takes all the remaining characters.
  73. **/
  74. function substr( pos : Int, ?len : Int ) : String;
  75. /**
  76. Returns the String itself.
  77. **/
  78. function toString() : String;
  79. private function compareTo( anotherString : String ) : Int;
  80. private function codePointAt( idx : Int ) : Int;
  81. private function startsWith( str : String ) : Bool;
  82. private function endsWith( str : String ) : Bool;
  83. private function replace( sub : String, by : String ) : String;
  84. static function fromCharCode( code : Int ) : String;
  85. }