@spec add_prefix(t(), t()) :: t()

Adds a prefix before each line of the data.

An important feature is that styling of the data will be saved for each line.

example

Example

iex> "first\nsecond" |> Owl.Data.tag(:red) |> Owl.Data.add_prefix(Owl.Data.tag("test: ", :yellow))
[
  [Owl.Data.tag("test: ", :yellow), Owl.Data.tag(["first"], :red)],
  "\n",
  [Owl.Data.tag("test: ", :yellow), Owl.Data.tag(["second"], :red)]
]

@spec chunk_every(data :: t(), count :: pos_integer()) :: [t()]

Returns list of t() containing count elements each.

example

Example

iex> Owl.Data.chunk_every(
...>   ["first second ", Owl.Data.tag(["third", Owl.Data.tag(" fourth", :blue)], :red)],
...>   7
...> )
[
  "first s",
  ["econd ", Owl.Data.tag(["t"], :red)],
  Owl.Data.tag(["hird", Owl.Data.tag([" fo"], :blue)], :red),
  Owl.Data.tag(["urth"], :blue)
]

@spec from_ansidata(IO.ANSI.ansidata()) :: t()

Transforms data from IO.ANSI.ansidata/0, replacing raw escape sequences with tags (see tag/2).

This makes it possible to use data formatted outside of Owl with other Owl modules, like Owl.Box.

The ansidata passed to this function must contain escape sequences as separate binaries, not concatenated with other data. For instance, the following will work:

iex> Owl.Data.from_ansidata(["", "hello"])
Owl.Data.tag("hello", :red)

Whereas this will not:

iex> Owl.Data.from_ansidata("hello")
"hello"

examples

Examples

iex> [[[[[[[] | ""] | ""], "hello"] | ""] | ""] | ""]
...> |> Owl.Data.from_ansidata()
Owl.Data.tag("hello", [:cyan_background, :red])

iex> [:red, "hello"] |> IO.ANSI.format() |> Owl.Data.from_ansidata()
Owl.Data.tag("hello", :red)

@spec length(t()) :: non_neg_integer()

Returns length of the data.

examples

Examples

iex> Owl.Data.length(["222"])
3

iex> Owl.Data.length([222])
1

iex> Owl.Data.length([[[]]])
0

iex> Owl.Data.length(["222", Owl.Data.tag(["333", "444"], :green)])
9

@spec lines(t()) :: [t()]

Splits data by new lines.

A special case of split/2.

example

Example

iex> Owl.Data.lines(["first\nsecond\n", Owl.Data.tag("third\nfourth", :red)])
["first", "second", Owl.Data.tag(["third"], :red), Owl.Data.tag(["fourth"], :red)]

@spec slice(t(), integer(), pos_integer()) :: t()

Returns a data starting at the offset start, and of the given length.

It is like String.slice/3 but for t/0.

examples

Examples

iex> Owl.Data.slice([Owl.Data.tag("Hello world", :red), Owl.Data.tag("!", :green)], 6, 7)
[Owl.Data.tag(["world"], :red), Owl.Data.tag(["!"], :green)]

iex> Owl.Data.slice(Owl.Data.tag("Hello world", :red), 20, 10)
[]

@spec split(t(), String.pattern() | Regex.t()) :: [t()]

Divides data into parts based on a pattern saving sequences for tagged data in new tags.

example

Example

iex> Owl.Data.split(["first second ", Owl.Data.tag("third fourth", :red)], " ")
["first", "second", Owl.Data.tag(["third"], :red), Owl.Data.tag(["fourth"], :red)]

iex> Owl.Data.split(["first   second ", Owl.Data.tag("third    fourth", :red)], ~r/ +/)
["first", "second", Owl.Data.tag(["third"], :red), Owl.Data.tag(["fourth"], :red)]

@spec tag(data, sequence() | [sequence()]) :: Owl.Tag.t(data) when data: t()

Builds a tag.

examples

Examples

iex> Owl.Data.tag(["hello ", Owl.Data.tag("world", :green), "!!!"], :red)
Owl.Data.tag(["hello ", Owl.Data.tag("world", :green), "!!!"], :red)

iex> Owl.Data.tag("hello world", [:green, :red_background])
Owl.Data.tag("hello world", [:green, :red_background])

@spec to_ansidata(t()) :: IO.ANSI.ansidata()

Transforms data to IO.ANSI.ansidata/0 format which can be consumed by IO module.

examples

Examples

iex> "hello" |> Owl.Data.tag([:red, :cyan_background]) |> Owl.Data.to_ansidata()
[[[[[[[] | ""] | ""], "hello"] | ""] | ""] | ""]

@spec truncate(t(), pos_integer()) :: t()

Truncates data, so the length of returning data is <= length.

Puts ellipsis symbol at the end if data was truncated.

examples

Examples

iex> Owl.Data.truncate([Owl.Data.tag("Hello", :red), Owl.Data.tag(" world!", :green)], 10)
[Owl.Data.tag(["Hello"], :red), Owl.Data.tag([" wor"], :green), "…"]

iex> Owl.Data.truncate("Hello", 10)
"Hello"

iex> Owl.Data.truncate("Hello", 4)
["Hel", "…"]

iex> Owl.Data.truncate("Hello", 5)
"Hello"

iex> Owl.Data.truncate("Hello", 1)
"…"

@spec unlines([t()]) :: [t()]

Creates a t/0 from an a list of t/0, it inserts new line characters between original elements.

examples

Examples

iex> Owl.Data.unlines(["a", "b", "c"])
["a", "\n", "b", "\n", "c"]

iex> ["first\nsecond\n", Owl.Data.tag("third\nfourth", :red)]
...> |> Owl.Data.lines()
...> |> Owl.Data.unlines()
...> |> Owl.Data.to_ansidata()
Owl.Data.to_ansidata(["first\nsecond\n", Owl.Data.tag("third\nfourth", :red)])

@spec untag(t()) :: iodata()

Removes information about sequences and keeps only content of the tag.

examples

Examples

iex> Owl.Data.tag("Hello", :red) |> Owl.Data.untag()
"Hello"

iex> Owl.Data.tag([72, 101, 108, 108, 111], :red) |> Owl.Data.untag()
'Hello'

iex> Owl.Data.tag(["Hello", Owl.Data.tag("world", :green)], :red) |> Owl.Data.untag()
["Hello", "world"]

iex> ["Hello ", Owl.Data.tag("world", :red), ["!"]] |> Owl.Data.untag()
["Hello ", "world", ["!"]]

@spec zip(t(), t()) :: t()

Zips corresponding lines into 1 line.

The zipping finishes as soon as either data completes.

examples

Examples

iex> Owl.Data.zip("a\nb\nc", "d\ne\nf")
[["a", "d"], "\n", ["b", "e"], "\n", ["c", "f"]]

iex> Owl.Data.zip("a\nb", "c")
[["a", "c"]]

iex> 1..3
...> |> Enum.map(&to_string/1)
...> |> Enum.map(&Owl.Box.new/1) |> Enum.reduce(&Owl.Data.zip/2) |> to_string()
"""
┌─┐┌─┐┌─┐
│3││2││1│
└─┘└─┘└─┘
""" |> String.trim_trailing()