aboutsummaryrefslogtreecommitdiff
path: root/modules/string
diff options
context:
space:
mode:
authorStuart Sierra <mail@stuartsierra.com>2010-08-07 16:41:53 -0400
committerStuart Sierra <mail@stuartsierra.com>2010-08-07 16:41:53 -0400
commita6a92b9b3d2bfd9a56e1e5e9cfba706d1aeeaae5 (patch)
treef1f3da9887dc2dc557df3282b0bcbd4d701ec593 /modules/string
parente7930c85290f77815cdb00a60604feedfa2d0194 (diff)
Split all namespaces into sub-modules.
* Examples and tests have not been copied over. * Clojure test/compile phases are commented out in parent POM. * May require installing parent POM before full build.
Diffstat (limited to 'modules/string')
-rw-r--r--modules/string/pom.xml16
-rw-r--r--modules/string/src/main/clojure/clojure/contrib/string.clj382
2 files changed, 398 insertions, 0 deletions
diff --git a/modules/string/pom.xml b/modules/string/pom.xml
new file mode 100644
index 00000000..8978a33f
--- /dev/null
+++ b/modules/string/pom.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http//www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+ http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+ <parent>
+ <groupId>org.clojure.contrib</groupId>
+ <artifactId>parent</artifactId>
+ <version>1.3.0-SNAPSHOT</version>
+ <relativePath>../parent</relativePath>
+ </parent>
+ <artifactId>string</artifactId>
+ <dependencies>
+ </dependencies>
+</project> \ No newline at end of file
diff --git a/modules/string/src/main/clojure/clojure/contrib/string.clj b/modules/string/src/main/clojure/clojure/contrib/string.clj
new file mode 100644
index 00000000..0042f710
--- /dev/null
+++ b/modules/string/src/main/clojure/clojure/contrib/string.clj
@@ -0,0 +1,382 @@
+;;; string.clj -- functional string utilities for Clojure
+
+;; by Stuart Sierra, http://stuartsierra.com/
+;; January 26, 2010
+
+;; Copyright (c) Stuart Sierra, 2010. All rights reserved. The use
+;; and distribution terms for this software are covered by the Eclipse
+;; Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
+;; which can be found in the file epl-v10.html at the root of this
+;; distribution. By using this software in any fashion, you are
+;; agreeing to be bound by the terms of this license. You must not
+;; remove this notice, or any other, from this software.
+
+;; DEPRECATED in 1.2: Many functions have moved to clojure.string.
+
+(ns ^{:author "Stuart Sierra"
+ :doc "This is a library of string manipulation functions. It
+ is intented as a replacement for clojure.contrib.string.
+
+ You cannot (use 'clojure.contrib.string) because it defines
+ functions with the same names as functions in clojure.core.
+ Instead, do (require '[clojure.contrib.string :as s])
+ or something similar.
+
+ Goals:
+ 1. Be functional
+ 2. Most significant argument LAST, to work with ->>
+ 3. At least O(n) performance for Strings of length n
+
+ Some ideas are borrowed from
+ http://github.com/francoisdevlin/devlinsf-clojure-utils/"}
+ clojure.contrib.string
+ (:refer-clojure :exclude (take replace drop butlast partition
+ contains? get repeat reverse partial))
+ (:import (java.util.regex Pattern)))
+
+
+(defmacro dochars
+ "bindings => [name string]
+
+ Repeatedly executes body, with name bound to each character in
+ string. Does NOT handle Unicode supplementary characters (above
+ U+FFFF)."
+ [bindings & body]
+ (assert (vector bindings))
+ (assert (= 2 (count bindings)))
+ ;; This seems to be the fastest way to iterate over characters.
+ `(let [^String s# ~(second bindings)]
+ (dotimes [i# (.length s#)]
+ (let [~(first bindings) (.charAt s# i#)]
+ ~@body))))
+
+
+(defmacro docodepoints
+ "bindings => [name string]
+
+ Repeatedly executes body, with name bound to the integer code point
+ of each Unicode character in the string. Handles Unicode
+ supplementary characters (above U+FFFF) correctly."
+ [bindings & body]
+ (assert (vector bindings))
+ (assert (= 2 (count bindings)))
+ (let [character (first bindings)
+ string (second bindings)]
+ `(let [^String s# ~string
+ len# (.length s#)]
+ (loop [i# 0]
+ (when (< i# len#)
+ (let [~character (.charAt s# i#)]
+ (if (Character/isHighSurrogate ~character)
+ (let [~character (.codePointAt s# i#)]
+ ~@body
+ (recur (+ 2 i#)))
+ (let [~character (int ~character)]
+ ~@body
+ (recur (inc i#))))))))))
+
+(defn codepoints
+ "Returns a sequence of integer Unicode code points in s. Handles
+ Unicode supplementary characters (above U+FFFF) correctly."
+ [^String s]
+ (let [len (.length s)
+ f (fn thisfn [^String s i]
+ (when (< i len)
+ (let [c (.charAt s i)]
+ (if (Character/isHighSurrogate c)
+ (cons (.codePointAt s i) (thisfn s (+ 2 i)))
+ (cons (int c) (thisfn s (inc i)))))))]
+ (lazy-seq (f s 0))))
+
+(defn ^String escape
+ "Returns a new String by applying cmap (a function or a map) to each
+ character in s. If cmap returns nil, the original character is
+ added to the output unchanged."
+ {:deprecated "1.2"}
+ [cmap ^String s]
+ (let [buffer (StringBuilder. (.length s))]
+ (dochars [c s]
+ (if-let [r (cmap c)]
+ (.append buffer r)
+ (.append buffer c)))
+ (.toString buffer)))
+
+(defn blank?
+ "True if s is nil, empty, or contains only whitespace."
+ {:deprecated "1.2"}
+ [^String s]
+ (every? (fn [^Character c] (Character/isWhitespace c)) s))
+
+(defn ^String take
+ "Take first n characters from s, up to the length of s."
+ [n ^String s]
+ (if (< (count s) n)
+ s
+ (.substring s 0 n)))
+
+(defn ^String drop
+ "Drops first n characters from s. Returns an empty string if n is
+ greater than the length of s."
+ [n ^String s]
+ (if (< (count s) n)
+ ""
+ (.substring s n)))
+
+(defn ^String butlast
+ "Returns s without the last n characters. Returns an empty string
+ if n is greater than the length of s."
+ [n ^String s]
+ (if (< (count s) n)
+ ""
+ (.substring s 0 (- (count s) n))))
+
+(defn ^String tail
+ "Returns the last n characters of s."
+ [n ^String s]
+ (if (< (count s) n)
+ s
+ (.substring s (- (count s) n))))
+
+(defn ^String repeat
+ "Returns a new String containing s repeated n times."
+ [n ^String s]
+ (apply str (clojure.core/repeat n s)))
+
+(defn ^String reverse
+ "Returns s with its characters reversed."
+ {:deprecated "1.2"}
+ [^String s]
+ (.toString (.reverse (StringBuilder. s))))
+
+(defn replace-str
+ "Replaces all instances of substring a with b in s."
+ {:deprecated "1.2"}
+ [^String a ^String b ^String s]
+ (.replace s a b))
+
+(defn replace-char
+ "Replaces all instances of character a with character b in s."
+ {:deprecated "1.2"}
+ [^Character a ^Character b ^String s]
+ (.replace s a b))
+
+(defn replace-re
+ "Replaces all matches of re with replacement in s."
+ {:deprecated "1.2"}
+ [re replacement ^String s]
+ (.replaceAll (re-matcher re s) replacement))
+
+(defn replace-by
+ "Replaces all matches of re in s with the result of
+ (f (re-groups the-match))."
+ {:deprecated "1.2"}
+ [re f ^String s]
+ (let [m (re-matcher re s)]
+ (let [buffer (StringBuffer. (.length s))]
+ (loop []
+ (if (.find m)
+ (do (.appendReplacement m buffer (f (re-groups m)))
+ (recur))
+ (do (.appendTail m buffer)
+ (.toString buffer)))))))
+
+(defn replace-first-str
+ "Replace first occurance of substring a with b in s."
+ {:deprecated "1.2"}
+ [^String a ^String b ^String s]
+ (.replaceFirst (re-matcher (Pattern/quote a) s) b))
+
+(defn replace-first-re
+ "Replace first match of re in s."
+ {:deprecated "1.2"}
+ [^Pattern re ^String replacement ^String s]
+ (.replaceFirst (re-matcher re s) replacement))
+
+(defn replace-first-by
+ "Replace first match of re in s with the result of
+ (f (re-groups the-match))."
+ {:deprecated "1.2"}
+ [^Pattern re f ^String s]
+ (let [m (re-matcher re s)]
+ (let [buffer (StringBuffer.)]
+ (if (.find m)
+ (let [rep (f (re-groups m))]
+ (.appendReplacement m buffer rep)
+ (.appendTail m buffer)
+ (str buffer))))))
+
+(defn partition
+ "Splits the string into a lazy sequence of substrings, alternating
+ between substrings that match the patthern and the substrings
+ between the matches. The sequence always starts with the substring
+ before the first match, or an empty string if the beginning of the
+ string matches.
+
+ For example: (partition #\"[a-z]+\" \"abc123def\")
+ returns: (\"\" \"abc\" \"123\" \"def\")"
+ [^Pattern re ^String s]
+ (let [m (re-matcher re s)]
+ ((fn step [prevend]
+ (lazy-seq
+ (if (.find m)
+ (cons (.subSequence s prevend (.start m))
+ (cons (re-groups m)
+ (step (+ (.start m) (count (.group m))))))
+ (when (< prevend (.length s))
+ (list (.subSequence s prevend (.length s)))))))
+ 0)))
+
+(defn ^String join
+ "Returns a string of all elements in coll, separated by
+ separator. Like Perl's join."
+ {:deprecated "1.2"}
+ [^String separator coll]
+ (apply str (interpose separator coll)))
+
+(defn ^String chop
+ "Removes the last character of string, does nothing on a zero-length
+ string."
+ [^String s]
+ (let [size (count s)]
+ (if (zero? size)
+ s
+ (subs s 0 (dec (count s))))))
+
+(defn ^String chomp
+ "Removes all trailing newline \\n or return \\r characters from
+ string. Note: String.trim() is similar and faster.
+ Deprecated in 1.2. Use clojure.string/trim-newline"
+ {:deprecated "1.2"}
+ [^String s]
+ (replace-re #"[\r\n]+$" "" s))
+
+(defn ^String swap-case
+ "Changes upper case characters to lower case and vice-versa.
+ Handles Unicode supplementary characters correctly. Uses the
+ locale-sensitive String.toUpperCase() and String.toLowerCase()
+ methods."
+ [^String s]
+ (let [buffer (StringBuilder. (.length s))
+ ;; array to make a String from one code point
+ ^"[I" array (make-array Integer/TYPE 1)]
+ (docodepoints [c s]
+ (aset-int array 0 c)
+ (if (Character/isLowerCase c)
+ ;; Character.toUpperCase is not locale-sensitive, but
+ ;; String.toUpperCase is; so we use a String.
+ (.append buffer (.toUpperCase (String. array 0 1)))
+ (.append buffer (.toLowerCase (String. array 0 1)))))
+ (.toString buffer)))
+
+(defn ^String capitalize
+ "Converts first character of the string to upper-case, all other
+ characters to lower-case."
+ {:deprecated "1.2"}
+ [^String s]
+ (if (< (count s) 2)
+ (.toUpperCase s)
+ (str (.toUpperCase ^String (subs s 0 1))
+ (.toLowerCase ^String (subs s 1)))))
+
+(defn ^String ltrim
+ "Removes whitespace from the left side of string.
+ Deprecated in 1.2. Use clojure.string/triml."
+ {:deprecated "1.2"}
+ [^String s]
+ (replace-re #"^\s+" "" s))
+
+(defn ^String rtrim
+ "Removes whitespace from the right side of string.
+ Deprecated in 1.2. Use clojure.string/trimr."
+ {:deprecated "1.2"}
+ [^String s]
+ (replace-re #"\s+$" "" s))
+
+(defn split-lines
+ "Splits s on \\n or \\r\\n."
+ {:deprecated "1.2"}
+ [^String s]
+ (seq (.split #"\r?\n" s)))
+
+;; borrowed from compojure.string, by James Reeves, EPL 1.0
+(defn ^String map-str
+ "Apply f to each element of coll, concatenate all results into a
+ String."
+ [f coll]
+ (apply str (map f coll)))
+
+;; borrowed from compojure.string, by James Reeves, EPL 1.0
+(defn grep
+ "Filters elements of coll by a regular expression. The String
+ representation (with str) of each element is tested with re-find."
+ [re coll]
+ (filter (fn [x] (re-find re (str x))) coll))
+
+(defn as-str
+ "Like clojure.core/str, but if an argument is a keyword or symbol,
+ its name will be used instead of its literal representation.
+
+ Example:
+ (str :foo :bar) ;;=> \":foo:bar\"
+ (as-str :foo :bar) ;;=> \"foobar\"
+
+ Note that this does not apply to keywords or symbols nested within
+ data structures; they will be rendered as with str.
+
+ Example:
+ (str {:foo :bar}) ;;=> \"{:foo :bar}\"
+ (as-str {:foo :bar}) ;;=> \"{:foo :bar}\" "
+ ([] "")
+ ([x] (if (instance? clojure.lang.Named x)
+ (name x)
+ (str x)))
+ ([x & ys]
+ ((fn [^StringBuilder sb more]
+ (if more
+ (recur (. sb (append (as-str (first more)))) (next more))
+ (str sb)))
+ (new StringBuilder ^String (as-str x)) ys)))
+
+
+;;; WRAPPERS
+
+;; The following functions are simple wrappers around java.lang.String
+;; functions. They are included here for completeness, and for use
+;; when mapping over a collection of strings.
+
+(defn ^String upper-case
+ "Converts string to all upper-case."
+ {:deprecated "1.2"}
+ [^String s]
+ (.toUpperCase s))
+
+(defn ^String lower-case
+ "Converts string to all lower-case."
+ {:deprecated "1.2"}
+ [^String s]
+ (.toLowerCase s))
+
+(defn split
+ "Splits string on a regular expression. Optional argument limit is
+ the maximum number of splits."
+ {:deprecated "1.2"}
+ ([^Pattern re ^String s] (seq (.split re s)))
+ ([^Pattern re limit ^String s] (seq (.split re s limit))))
+
+(defn ^String trim
+ "Removes whitespace from both ends of string."
+ {:deprecated "1.2"}
+ [^String s]
+ (.trim s))
+
+(defn ^String substring?
+ "True if s contains the substring."
+ [substring ^String s]
+ (.contains s substring))
+
+(defn ^String get
+ "Gets the i'th character in string."
+ {:deprecated "1.2"}
+ [^String s i]
+ (.charAt s i))
+