← Back
Editing: string-utils.go
GOOF----LE-8-2.0wA ] S 4 h� ] g guile� � g define-module*� � � g texinfo� g string-utils� � g filenameS� f texinfo/string-utils.scm� g importsS� g srfi� g srfi-13� � � g srfi-14� � � � g exportsS� g escape-special-chars� g transform-string� g expand-tabs� g center-string� g left-justify-string� g right-justify-string� g collapse-repeated-chars� g make-text-wrapper� g fill-string� g string->wrapped-lines� � g set-current-module� ! � " � #g open-output-string� $g char?� %g char=?� &g procedure?� 'g string?� (g string-index� )g boolean?� *g throw� +g bad-type� ,f 'expected #t, char, string, or procedure� -g display� .g string-length� /g substring� 0g string-for-each� 1g write-char� 2g get-output-string� 3g make-string� 4g string� 5g max� 6g string-append� 7g odd?� 8f � 9g char-set-complement� :g char-set:whitespace� ;g reverse� <g split-by-single-words� =g string-ref� >g end-of-sentence?� ?g line-widthS� @? �� Ag expand-tabs?S� BA �� Cg tab-widthS� DC �� Eg collapse-whitespace?S� FE �� Gg subsequent-indentS� HG �� Ig initial-indentS� JI �� Kg break-long-words?S� LK �� M@BDFHJL � Ng string-trim� Of � Pg string-join� Qf � Rg infix�C 5hx: � ]4 5 4" > " G #$% h c ]L 6 [ g c g filenamef texinfo/string-utils.scm� O �� O %�� C&'( h c ]L 6 [ g c g filenamef texinfo/string-utils.scm� S �� S %�� C) h [ ]L C S g c g filenamef texinfo/string-utils.scm� U �� C*+,- h k ]4L 5L 6 c g c g filenamef texinfo/string-utils.scm� X �� X ,�� X #�� C- h c ]LL 6 [ g c g filenamef texinfo/string-utils.scm� Y �� Y #�� C.-/01 h { ]4L 5$ L 6 L 6 s g c g filenamef texinfo/string-utils.scm� a �� b �� b �� d �� g �� C2 hX - - . , 3 # # 45 45$ O " F45$ " 545$ O " 45$ O " 4 5 45$ O " O $ 24 5�$ 44 5> " G " " 4O $ " $ " 4 5> " G $ 14 5�$ 44 5> " G " " 6% g str X g match? X g replace X g start X g end X g os # X g matcher � X g replacer � X g filenamef texinfo/string-utils.scm� ' �� M �� # M �� & N �� 0 N �� < P �� F N �� M R �� W N �� c T �� m N �� y V �� } V %�� V /�� � V �� � M �� � W �� � W �� � M �� � \ �� � \ �� � \ �� � \ �� � ] �� � ] �� � ] �� � ` �� � i �� j �� j �� ` �� ! m �� $ m �� + m �� / m �� 0 n �� 3 n �� B n �� X p �� ( X g nameg transform-string�g documentationf �Uses @var{match?} against each character in @var{str}, and performs a replacement on each character for which matches are found. @var{match?} may either be a function, a character, a string, or @code{#t}. If @var{match?} is a function, then it takes a single character as input, and should return @samp{#t} for matches. @var{match?} is a character, it is compared to each string character using @code{char=?}. If @var{match?} is a string, then any character in that string will be considered a match. @code{#t} will cause every character to be a match. If @var{replace} is a function, it is called with the matched character as an argument, and the returned value is sent to the output string via @samp{display}. If @var{replace} is anything else, it is sent through the output string via @samp{display}. Note that te replacement for the matched characters does not need to be a single character. That is what differentiates this function from @samp{string-map}, and what makes it useful for applications such as converting @samp{#\&} to @samp{"&"} in web page text. Some other functions in this module are just wrappers around common uses of @samp{transform-string}. Transformations not possible with this function should probably be done with regular expressions. If @var{start} and @var{end} are given, they control which portion of the string undergoes transformation. The entire input string is still output, though. So, if @var{start} is @samp{5}, then the first five characters of @var{str} will still appear in the returned string. @lisp ; these two are equivalent... (transform-string str #\space #\-) ; change all spaces to -'s (transform-string str (lambda (c) (char=? #\space c)) #\-) @end lisp� CR3 h( u - . , 3 # 4 56 m g str ' g tab-size ' g filenamef texinfo/string-utils.scm� r �� z �� ' x �� ' g nameg expand-tabs�g documentationf �Returns a copy of @var{str} with all tabs expanded to spaces. @var{tab-size} defaults to 8. Assuming tab size of 8, this is equivalent to: @lisp (transform-string str #\tab " ") @end lisp� CR$% h e ] L 6 ] g c g filenamef texinfo/string-utils.scm� � �� � $�� C( h e ]L 6 ] g c g filenamef texinfo/string-utils.scm� � �� � $�� C4 h e ]L 6 ] g c g filenamef texinfo/string-utils.scm� � �� � �� C h0 ) ] 45$ O " O O 6 ! g str , g special-chars , g escape-char , g filenamef texinfo/string-utils.scm� | �� � �� � �� , � �� , g nameg escape-special-chars�g documentationf GReturns a copy of @var{str} with all given special characters preceded by the given @var{escape-char}. @var{special-chars} can either be a single character, or a string consisting of all the special characters. @lisp ;; make a string regexp-safe... (escape-special-chars "***(Example String)***" "[]()/*." #\\) => "\\*\\*\\*\\(Example String\\)\\*\\*\\*" ;; also can escape a singe char... (escape-special-chars "richardt@@vzavenue.net" #\@@ #\@@) => "richardt@@@@vzavenue.net" @end lisp� CR.35%6748 h� � - . , 3 # P # # 4 5 44� � 55 4$ " 5$ " !44� � 5$ " 5 �$ C 4�5$ 4$ " 5" 6� g str � g width � g chr � g rchr � g len 0 � g lpad G � g rpad � � g filenamef texinfo/string-utils.scm� � �� * � �� 0 � �� 3 � �� 6 � �� = � +�� @ � !�� C � �� G � �� G � �� J � �� R � �� ^ � �� b � �� i � �� l � �� s � /�� v � %�� y � �� � �� � � �� � � �� � � �� � � �� � � )�� � � /�� � � )�� � � %�� � � >�� � � �� � � >�� � � Q�� � � �� " � g nameg center-string�g documentationf �Returns a copy of @var{str} centered in a field of @var{width} characters. Any needed padding is done by character @var{chr}, which defaults to @samp{#\space}. If @var{rchr} is provided, then the padding to the right will use it instead. See the examples below. left and @var{rchr} on the right. The default @var{width} is 80. The default @var{chr} and @var{rchr} is @samp{#\space}. The string is never truncated. @lisp (center-string "Richard Todd" 24) => " Richard Todd " (center-string " Richard Todd " 24 #\=) => "===== Richard Todd =====" (center-string " Richard Todd " 24 #\< #\>) => "<<<<< Richard Todd >>>>>" @end lisp� CR.356 hX H - . , 3 # P # 4 5 44� 55 �$ C 6 @ g str Q g width Q g chr Q g len ' Q g pad ; Q g filenamef texinfo/string-utils.scm� � �� ! � �� ' � �� * � �� - � �� 4 � �� 7 � �� ; � �� ; � �� B � �� F � �� Q � �� Q g nameg left-justify-string�g documentationf @code{left-justify-string str [width chr]}. Returns a copy of @var{str} padded with @var{chr} such that it is left justified in a field of @var{width} characters. The default @var{width} is 80. Unlike @samp{string-pad} from srfi-13, the string is never truncated.� CR.356 hX F - . , 3 # P # 4 5 44� 55 �$ C 6 > g str Q g width Q g chr Q g len ' Q g pad ; Q g filenamef texinfo/string-utils.scm� � �� ! � �� ' � �� * � �� - � �� 4 � �� 7 � �� ; � �� ; � �� B � �� F � �� Q � �� Q g nameg right-justify-string�g documentationf Returns a copy of @var{str} padded with @var{chr} such that it is right justified in a field of @var{width} characters. The default @var{width} is 80. The default @var{chr} is @samp{#\space}. Unlike @samp{string-pad} from srfi-13, the string is never truncated.� CR%% h@ � ]" N NC4 M5$ 4ML 5$ M�NML�C"���"��� � g c < g filenamef texinfo/string-utils.scm� � �� � �� � �� � �� � �� � �� � �� ) � �� , � &�� . � �� 3 � �� < C8 hX � - . , 3 # # 4 5$ A" HHO 6� g str X g chr X g num X g prev-chr 5 L g match-count 5 L g repeat-locator L X g filenamef texinfo/string-utils.scm� � �� � �� , � �� 5 � �� L � �� V � *�� X � �� X g nameg collapse-repeated-chars�g documentationf �Returns a copy of @var{str} with all repeated instances of @var{chr} collapsed down to at most @var{num} instances. The default value for @var{chr} is @samp{#\space}, and the default value for @var{num} is 1. @lisp (collapse-repeated-chars "H e l l o") => "H e l l o" (collapse-repeated-chars "H--e--l--l--o" #\-) => "H-e-l-l-o" (collapse-repeated-chars "H-e--l---l----o" #\- 2) => "H-e--l--l--o" @end lisp� CR9:(/; hp � ])45 " T4 5 $ ;4 5 $ 4 5� "���4 5�66 "��� � g str m g non-wschars m g ans c g index c g next-non-ws c g next-ws - ] g filenamef texinfo/string-utils.scm� � �� � �� � �� � �� � �� � �� " � �� # � �� - � �� 5 � �� 6 �� C �� M �� P �� [ �� ] �� c �� c � �� d � �� m � �� m g nameg split-by-single-words� C<R.= h@ T ] 4 5 �$ $.4 �5�$ .4 �5��CCC L g str 9 g len 9 g filenamef texinfo/string-utils.scm� �� �� �� �� �� �� #�� �� �� $ �� ' �� 0 (�� 2 �� 3 �� 4 �� 9 g nameg end-of-sentence?�g documentationf 6Return #t when STR likely denotes the end of sentence.� C>RM8% h e ] 6 ] g c g filenamef texinfo/string-utils.scm� D $�� D 0�� CN;.6>O/< hx ]1 H 4J 5K L$ 4J L5K " L$ 4J 5K " 4J 5K " ( �$ �" 6L45� �$ 4�5" � 45�$ Q�" 45" ,L$ "4 5$ 4 5" "���" "���� "��_ �$ �L "��AL$ 044 55�4 5��L "�� 45��L "���4 J 5L "��� g str r g ans H [ g words H [ g line H [ g count H [ g length-left � [ g next-word � [ g filenamef texinfo/string-utils.scm� B �� D �� D �� G �� H �� $ H �� . K �� / L �� 7 L �� < O �� D O �� H R �� N V �� T X �� X X �� ] Y �� e X �� h ^ �� o ] �� s _ �� w _ �� x ` �� } ` ,�� ` �� � a �� � ] �� � d �� � d �� � b �� � g �� � l �� � h �� � i �� � h �� � k �� � k ,�� � k �� � m �� � f �� � p �� � b �� � r �� r �� b �� { �� { .�� { �� ! { �� " } �� - ~ �� . } �� = { �� > � �� I � �� L � �� [ � �� [ R �� \ R �� ] S �� r R �� = r C hp | - / 0 3 # P # # # # # # O C t g line-width j g expand-tabs? j g tab-width j g collapse-whitespace? j g subsequent-indent j g initial-indent j g break-long-words? j g filenamef texinfo/string-utils.scm� �� A /�� K ,�� j g line-widthS �g expand-tabs?S �g tab-widthS �g collapse-whitespace?S �g subsequent-indentS �g initial-indentS �g break-long-words?S � g nameg make-text-wrapper�g documentationf �Returns a procedure that will split a string into lines according to the given parameters. @table @code @item #:line-width This is the target length used when deciding where to wrap lines. Default is 80. @item #:expand-tabs? Boolean describing whether tabs in the input should be expanded. Default is #t. @item #:tab-width If tabs are expanded, this will be the number of spaces to which they expand. Default is 8. @item #:collapse-whitespace? Boolean describing whether the whitespace inside the existing text should be removed or not. Default is #t. If text is already well-formatted, and is just being wrapped to fit in a different width, then set this to @samp{#f}. This way, many common text conventions (such as two spaces between sentences) can be preserved if in the original text. If the input text spacing cannot be trusted, then leave this setting at the default, and all repeated whitespace will be collapsed down to a single space. @item #:initial-indent Defines a string that will be put in front of the first line of wrapped text. Default is the empty string, ``''. @item #:subsequent-indent Defines a string that will be put in front of all lines of wrapped text, except the first one. Default is the empty string, ``''. @item #:break-long-words? If a single word is too big to fit on a line, this setting tells the wrapper what to do. Defaults to #t, which will break up long words. When set to #f, the line will be allowed, even though it is longer than the defined @code{#:line-width}. @end table The return value is a procedure of one argument, the input string, which returns a list of strings, where each element of the list is one line.� C R h � - 1 3 4? 6 � g str g kwargs g filenamef texinfo/string-utils.scm� � �� � �� � �� g nameg string->wrapped-lines�g documentationf 8@code{string->wrapped-lines str keywds ...}. Wraps the text given in string @var{str} according to the parameters provided in @var{keywds}, or the default setting if they are not given. Returns a list of strings representing the formatted lines. Valid keyword arguments are discussed in @code{make-text-wrapper}.� C RP QR h � - 1 3 4 ?6 � g str g kwargs g filenamef texinfo/string-utils.scm� � �� � �� � �� � �� � �� g nameg fill-string�g documentationf Wraps the text given in string @var{str} according to the parameters provided in @var{kwargs}, or the default setting if they are not given. Returns a single string with the wrapped text. Valid keyword arguments are discussed in @code{make-text-wrapper}.� C RC � g m , g filenamef texinfo/string-utils.scm� �� ' �� � r �� � | �� � � �� ; � �� � � �� $F � �� &g � �� ( �� 6O �� 8o � �� :o � �� :q C6
Save File
Cancel