tomo-Text.lines.3

(39 lines)
   1 '\" t
   2 .\" Copyright (c) 2025 Bruce Hill
   3 .\" All rights reserved.
   4 .\"
   5 .TH Text.lines 3 2025-11-29 "Tomo man-pages"
   6 .SH NAME
   7 Text.lines \- get list of lines
   8 .SH LIBRARY
   9 Tomo Standard Library
  10 .SH SYNOPSIS
  11 .nf
  12 .BI Text.lines\ :\ func(text:\ Text\ ->\ [Text])
  13 .fi
  14 .SH DESCRIPTION
  15 Splits the text into a list of lines of text, preserving blank lines, ignoring trailing newlines, and handling `\r\n` the same as `\n`.
  16 
  17 
  18 .SH ARGUMENTS
  19 
  20 .TS
  21 allbox;
  22 lb lb lbx
  23 l l l.
  24 Name	Type	Description
  25 text	Text	The text to be split into lines. 
  26 .TE
  27 .SH RETURN
  28 A list of substrings resulting from the split.
  29 
  30 .SH EXAMPLES
  31 .EX
  32 assert "one\[rs]ntwo\[rs]nthree".lines() == ["one", "two", "three"]
  33 assert "one\[rs]ntwo\[rs]nthree\[rs]n".lines() == ["one", "two", "three"]
  34 assert "one\[rs]ntwo\[rs]nthree\[rs]n\[rs]n".lines() == ["one", "two", "three", ""]
  35 assert "one\[rs]r\[rs]ntwo\[rs]r\[rs]nthree\[rs]r\[rs]n".lines() == ["one", "two", "three"]
  36 assert "".lines() == []
  37 .EE
  38 .SH SEE ALSO
  39 .BR Tomo-Text (3)