core/splitting/splitting-docs.factor

   1 USING: help.markup help.syntax sequences strings ;
   2 IN: splitting
   3
   4 ARTICLE: "sequences-split" "Splitting sequences"
   5 "Splitting sequences at occurrences of subsequences:"
   6 { $subsections
   7     ?head
   8     ?head-slice
   9     ?tail
  10     ?tail-slice
  11     split1
  12     split1-slice
  13     split1-last
  14     split1-last-slice
  15     split
  16 }
  17 "Splitting a string into lines:"
  18 { $subsections string-lines } ;
  19
  20 ABOUT: "sequences-split"
  21
  22 HELP: split1
  23 { $values { "seq" "a sequence" } { "subseq" "a sequence" } { "before" "a new sequence" } { "after" "a new sequence" } }
  24 { $description "Splits " { $snippet "seq" } " at the first occurrence of " { $snippet "subseq" } ", and outputs the pieces before and after the split. If " { $snippet "subseq" } " does not occur in " { $snippet "seq" } ", then " { $snippet "before" } " is just " { $snippet "seq" } " and " { $snippet "after" } " is " { $link f } "." } ;
  25
  26 HELP: split1-slice
  27 { $values { "seq" "a sequence" } { "subseq" "a sequence" } { "before-slice" slice } { "after-slice" slice } }
  28 { $description "Splits " { $snippet "seq" } " at the first occurrence of " { $snippet "subseq" } ", and outputs the pieces before and after the split as slices. If " { $snippet "subseq" } " does not occur in " { $snippet "seq" } ", then " { $snippet "before" } " is just " { $snippet "seq" } " and " { $snippet "after" } " is " { $link f } "." } ;
  29
  30 HELP: split1-last
  31 { $values { "seq" "a sequence" } { "subseq" "a sequence" } { "before" "a new sequence" } { "after" "a new sequence" } }
  32 { $description "Splits " { $snippet "seq" } " at the last occurrence of " { $snippet "subseq" } ", and outputs the pieces before and after the split. If " { $snippet "subseq" } " does not occur in " { $snippet "seq" } ", then " { $snippet "before" } " is just " { $snippet "seq" } " and " { $snippet "after" } " is " { $link f } "." } ;
  33
  34 HELP: split1-last-slice
  35 { $values { "seq" "a sequence" } { "subseq" "a sequence" } { "before-slice" slice } { "after-slice" slice } }
  36 { $description "Splits " { $snippet "seq" } " at the last occurrence of " { $snippet "subseq" } ", and outputs the pieces before and after the split as slices. If " { $snippet "subseq" } " does not occur in " { $snippet "seq" } ", then " { $snippet "before" } " is just " { $snippet "seq" } " and " { $snippet "after" } " is " { $link f } "." } ;
  37
  38 { split1 split1-slice split1-last split1-last-slice } related-words
  39
  40 HELP: split
  41 { $values { "seq" "a sequence" } { "separators" "a sequence" } { "pieces" "a new array" } }
  42 { $description "Splits " { $snippet "seq" } " at each occurrence of an element of " { $snippet "separators" } ", and outputs an array of pieces. The pieces do not include the elements along which the sequence was split." }
  43 { $examples { $example "USING: prettyprint splitting ;" "\"hello world-how are you?\" \" -\" split ." "{ \"hello\" \"world\" \"how\" \"are\" \"you?\" }" } } ;
  44
  45 HELP: ?head
  46 { $values { "seq" "a sequence" } { "begin" "a sequence" } { "newseq" "a new sequence" } { "?" "a boolean" } }
  47 { $description "Tests if " { $snippet "seq" } " starts with " { $snippet "begin" } ". If there is a match, outputs the subrange of " { $snippet "seq" } " excluding " { $snippet "begin" } ", and " { $link t } ". If there is no match, outputs " { $snippet "seq" } " and " { $link f } "." } ;
  48
  49 HELP: ?head-slice
  50 { $values { "seq" "a sequence" } { "begin" "a sequence" } { "newseq" slice } { "?" "a boolean" } }
  51 { $description "Like " { $link ?head } ", except the resulting sequence is a " { $link slice } "." } ;
  52
  53 HELP: ?tail
  54 { $values { "seq" "a sequence" } { "end" "a sequence" } { "newseq" "a new sequence" } { "?" "a boolean" } }
  55 { $description "Tests if " { $snippet "seq" } " ends with " { $snippet "end" } ". If there is a match, outputs the subrange of " { $snippet "seq" } " excluding " { $snippet "end" } ", and " { $link t } ". If there is no match, outputs " { $snippet "seq" } " and " { $link f } "." } ;
  56
  57 HELP: ?tail-slice
  58 { $values { "seq" "a sequence" } { "end" "a sequence" } { "newseq" slice } { "?" "a boolean" } }
  59 { $description "Like " { $link ?tail } ", except the resulting sequence is a " { $link slice } "." } ;
  60
  61 HELP: string-lines
  62 { $values { "str" string } { "seq" "a sequence of strings" } }
  63 { $description "Splits a string along line breaks." }
  64 { $examples
  65     { $example "USING: prettyprint splitting ;" "\"Hello\\r\\nworld\\n\" string-lines ." "{ \"Hello\" \"world\" \"\" }" }
  66 } ;