mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2025-12-31 10:22:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9552 from recloser/strmisc-doc

Browse Source 
Add runnableExamples for strmisc procs and a better doc for expandTabs
This commit is contained in:
Andreas Rumpf
2018-12-12 16:32:09 +01:00
committed by GitHub
parent 9d81586879 e14f5025a2
commit 9f453592a4
1 changed files with 28 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
lib/pure/strmisc.nim
View File

@@ -16,7 +16,20 @@ import strutils
proc expandTabs*(s: string, tabSize: int = 8): string {.noSideEffect,
procvar.} =
## Expand tab characters in `s` by `tabSize` spaces
## Expand tab characters in `s` replacing them by spaces.
##
## The amount of inserted spaces for each tab character is the difference
## between the current column number and the next tab position. Tab positions
## occur every `tabSize` characters.
## The column number starts at 0 and is increased with every single character
## and inserted space, except for newline, which resets the column number
## back to 0.
runnableExamples:
doAssert expandTabs("\t", 4) == " "
doAssert expandTabs("\tfoo\t", 4) == " foo "
doAssert expandTabs("\tfoo\tbar", 4) == " foo bar"
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)
var pos = 0
@@ -48,6 +61,13 @@ proc partition*(s: string, sep: string,
## Returns a 3 string tuple of (beforeSep, `sep`, afterSep) or
## (`s`, "", "") if `sep` is not found and `right` is false or
## ("", "", `s`) if `sep` is not found and `right` is true
runnableExamples:
doAssert partition("foo:bar", ":") == ("foo", ":", "bar")
doAssert partition("foobarbar", "bar") == ("foo", "bar", "bar")
doAssert partition("foobarbar", "bank") == ("foobarbar", "", "")
doAssert partition("foobarbar", "foo") == ("", "foo", "barbar")
doAssert partition("foofoobar", "bar") == ("foofoo", "bar", "")
let position = if right: s.rfind(sep) else: s.find(sep)
if position != -1:
return (s[0 ..< position], sep, s[position + sep.len ..< s.len])
@@ -59,6 +79,13 @@ proc rpartition*(s: string, sep: string): (string, string, string)
##
## Returns a 3 string tuple of (beforeSep, `sep`, afterSep) or
## ("", "", `s`) if `sep` is not found
runnableExamples:
doAssert rpartition("foo:bar", ":") == ("foo", ":", "bar")
doAssert rpartition("foobarbar", "bar") == ("foobar", "bar", "")
doAssert rpartition("foobarbar", "bank") == ("", "", "foobarbar")
doAssert rpartition("foobarbar", "foo") == ("", "foo", "barbar")
doAssert rpartition("foofoobar", "bar") == ("foofoo", "bar", "")
return partition(s, sep, right = true)
when isMainModule: