jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve documentation of strmisc (#16665)

Browse source 
Simplify examples
This commit is contained in:
konsumlamm 2021-01-11 10:53:15 +01:00 • committed by GitHub
commit 5897ed9d3d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

60
lib/pure/strmisc.nim
View file

@ -8,12 +8,12 @@
# #
## This module contains various string utility routines that are uncommonly ## This module contains various string utility routines that are uncommonly
## used in comparison to `strutils <strutils.html>`_. ## used in comparison to the ones in `strutils <strutils.html>`_.
import strutils import std/strutils
proc expandTabs*(s: string, tabSize: int = 8): string {.noSideEffect.} = func expandTabs*(s: string, tabSize: int = 8): string =
## Expand tab characters in `s` replacing them by spaces. ## Expands tab characters in `s`, replacing them by spaces.
## ##
## The amount of inserted spaces for each tab character is the difference ## The amount of inserted spaces for each tab character is the difference
## between the current column number and the next tab position. Tab positions ## between the current column number and the next tab position. Tab positions
@ -24,9 +24,7 @@ proc expandTabs*(s: string, tabSize: int = 8): string {.noSideEffect.} =
runnableExamples: runnableExamples:
doAssert expandTabs("\t", 4) == " " doAssert expandTabs("\t", 4) == " "
doAssert expandTabs("\tfoo\t", 4) == " foo " doAssert expandTabs("\tfoo\t", 4) == " foo "
doAssert expandTabs("\tfoo\tbar", 4) == " foo bar" doAssert expandTabs("a\tb\n\txy\t", 3) == "a b\n xy "
doAssert expandTabs("\tfoo\tbar\t", 4) == " foo bar "
doAssert expandTabs("ab\tcd\n\txy\t", 3) == "ab cd\n xy "
result = newStringOfCap(s.len + s.len shr 2) result = newStringOfCap(s.len + s.len shr 2)
var pos = 0 var pos = 0
@ -50,37 +48,39 @@ proc expandTabs*(s: string, tabSize: int = 8): string {.noSideEffect.} =
if c == '\l': if c == '\l':
pos = 0 pos = 0
proc partition*(s: string, sep: string, func partition*(s: string, sep: string,
right: bool = false): (string, string, string) right: bool = false): (string, string, string) =
{.noSideEffect.} = ## Splits the string at the first (if `right` is false)
## Split the string at the first or last occurrence of `sep` into a 3-tuple ## or last (if `right` is true) occurrence of `sep` into a 3-tuple.
## ##
## Returns a 3 string tuple of (beforeSep, `sep`, afterSep) or ## Returns a 3-tuple of strings, `(beforeSep, sep, afterSep)` or
## (`s`, "", "") if `sep` is not found and `right` is false or ## `(s, "", "")` if `sep` is not found and `right` is false or
## ("", "", `s`) if `sep` is not found and `right` is true ## `("", "", s)` if `sep` is not found and `right` is true.
##
## **See also:**
## * `rpartition proc <#rpartition,string,string>`_
runnableExamples: runnableExamples:
doAssert partition("foo:bar", ":") == ("foo", ":", "bar") doAssert partition("foo:bar:baz", ":") == ("foo", ":", "bar:baz")
doAssert partition("foobarbar", "bar") == ("foo", "bar", "bar") doAssert partition("foo:bar:baz", ":", right = true) == ("foo:bar", ":", "baz")
doAssert partition("foobarbar", "bank") == ("foobarbar", "", "") doAssert partition("foobar", ":") == ("foobar", "", "")
doAssert partition("foobarbar", "foo") == ("", "foo", "barbar") doAssert partition("foobar", ":", right = true) == ("", "", "foobar")
doAssert partition("foofoobar", "bar") == ("foofoo", "bar", "")
let position = if right: s.rfind(sep) else: s.find(sep) let position = if right: s.rfind(sep) else: s.find(sep)
if position != -1: if position != -1:
return (s[0 ..< position], sep, s[position + sep.len ..< s.len]) return (s[0 ..< position], sep, s[position + sep.len ..< s.len])
return if right: ("", "", s) else: (s, "", "") return if right: ("", "", s) else: (s, "", "")
proc rpartition*(s: string, sep: string): (string, string, string) func rpartition*(s: string, sep: string): (string, string, string) =
{.noSideEffect.} = ## Splits the string at the last occurrence of `sep` into a 3-tuple.
## Split the string at the last occurrence of `sep` into a 3-tuple
## ##
## Returns a 3 string tuple of (beforeSep, `sep`, afterSep) or ## Returns a 3-tuple of strings, `(beforeSep, sep, afterSep)` or
## ("", "", `s`) if `sep` is not found ## `("", "", s)` if `sep` is not found. This is the same as
## `partition(s, sep, right = true)`.
##
## **See also:**
## * `partition proc <#partition,string,string,bool>`_
runnableExamples: runnableExamples:
doAssert rpartition("foo:bar", ":") == ("foo", ":", "bar") doAssert rpartition("foo:bar:baz", ":") == ("foo:bar", ":", "baz")
doAssert rpartition("foobarbar", "bar") == ("foobar", "bar", "") doAssert rpartition("foobar", ":") == ("", "", "foobar")
doAssert rpartition("foobarbar", "bank") == ("", "", "foobarbar")
doAssert rpartition("foobarbar", "foo") == ("", "foo", "barbar")
doAssert rpartition("foofoobar", "bar") == ("foofoo", "bar", "")
return partition(s, sep, right = true) partition(s, sep, right = true)