开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > 游戏 > 外挂编程 > 查看源码
Balanced.pm.svn-base
资源名称：openkore-2.0.7.zip　[点击查看]
上传用户：market2
上传日期：2018-11-18
资源大小：18786k
文件大小：66k
源码类别：

外挂编程

开发平台：

Windows_Unix

Balanced.pm.svn-base：源码内容
  1. # EXTRACT VARIOUSLY DELIMITED TEXT SEQUENCES FROM STRINGS.
  2. # FOR FULL DOCUMENTATION SEE Balanced.pod
  4. use 5.005;
  5. use strict;
  7. package Text::Balanced;
  9. use Exporter;
  10. use SelfLoader;
  11. use vars qw { $VERSION @ISA %EXPORT_TAGS };
  13. #use version; $VERSION = qv('2.0.0');
  14. $VERSION = '2.0.0';
  15. @ISA = qw ( Exporter );
  16.      
  17. %EXPORT_TAGS = ( ALL => [ qw(
  18. &extract_delimited
  19. &extract_bracketed
  20. &extract_quotelike
  21. &extract_codeblock
  22. &extract_variable
  23. &extract_tagged
  24. &extract_multiple
  26. &gen_delimited_pat
  27. &gen_extract_tagged
  29. &delimited_pat
  30.        ) ] );
  32. Exporter::export_ok_tags('ALL');
  34. # PROTOTYPES
  36. sub _match_bracketed($$$$$$);
  37. sub _match_variable($$);
  38. sub _match_codeblock($$$$$$$);
  39. sub _match_quotelike($$$$);
  41. # HANDLE RETURN VALUES IN VARIOUS CONTEXTS
  43. sub _failmsg {
  44. my ($message, $pos) = @_;
  45. $@ = bless { error=>$message, pos=>$pos }, "Text::Balanced::ErrorMsg";
  46. }
  48. sub _fail
  49. {
  50. my ($wantarray, $textref, $message, $pos) = @_;
  51. _failmsg $message, $pos if $message;
  52. return (undef,$$textref,undef) if $wantarray;
  53. return undef;
  54. }
  56. sub _succeed
  57. {
  58. $@ = undef;
  59. my ($wantarray,$textref) = splice @_, 0, 2;
  60. my ($extrapos, $extralen) = @_>18 ? splice(@_, -2, 2) : (0,0);
  61. my ($startlen, $oppos) = @_[5,6];
  62. my $remainderpos = $_[2];
  63. if ($wantarray)
  64. {
  65. my @res;
  66. while (my ($from, $len) = splice @_, 0, 2)
  67. {
  68. push @res, substr($$textref,$from,$len);
  69. }
  70. if ($extralen) { # CORRECT FILLET
  71. my $extra = substr($res[0], $extrapos-$oppos, $extralen, "n");
  72. $res[1] = "$extra$res[1]";
  73. eval { substr($$textref,$remainderpos,0) = $extra;
  74.        substr($$textref,$extrapos,$extralen,"n")} ;
  75. #REARRANGE HERE DOC AND FILLET IF POSSIBLE
  76. pos($$textref) = $remainderpos-$extralen+1; # RESET G
  77. }
  78. else {
  79. pos($$textref) = $remainderpos;     # RESET G
  80. }
  81. return @res;
  82. }
  83. else
  84. {
  85. my $match = substr($$textref,$_[0],$_[1]);
  86. substr($match,$extrapos-$_[0]-$startlen,$extralen,"") if $extralen;
  87. my $extra = $extralen
  88. ? substr($$textref, $extrapos, $extralen)."n" : "";
  89. eval {substr($$textref,$_[4],$_[1]+$_[5])=$extra} ; #CHOP OUT PREFIX & MATCH, IF POSSIBLE
  90. pos($$textref) = $_[4]; # RESET G
  91. return $match;
  92. }
  93. }
  95. # BUILD A PATTERN MATCHING A SIMPLE DELIMITED STRING
  97. sub gen_delimited_pat($;$)  # ($delimiters;$escapes)
  98. {
  99. my ($dels, $escs) = @_;
  100. return "" unless $dels =~ /S/;
  101. $escs = '\' unless $escs;
  102. $escs .= substr($escs,-1) x (length($dels)-length($escs));
  103. my @pat = ();
  104. my $i;
  105. for ($i=0; $i<length $dels; $i++)
  106. {
  107. my $del = quotemeta substr($dels,$i,1);
  108. my $esc = quotemeta substr($escs,$i,1);
  109. if ($del eq $esc)
  110. {
  111. push @pat, "$del(?:[^$del]*(?:(?:$del$del)[^$del]*)*)$del";
  112. }
  113. else
  114. {
  115. push @pat, "$del(?:[^$esc$del]*(?:$esc.[^$esc$del]*)*)$del";
  116. }
  117. }
  118. my $pat = join '|', @pat;
  119. return "(?:$pat)";
  120. }
  122. *delimited_pat = &gen_delimited_pat;
  125. # THE EXTRACTION FUNCTIONS
  127. sub extract_delimited (;$$$$)
  128. {
  129. my $textref = defined $_[0] ? $_[0] : $_;
  130. my $wantarray = wantarray;
  131. my $del  = defined $_[1] ? $_[1] : qq{'"`};
  132. my $pre  = defined $_[2] ? $_[2] : 's*';
  133. my $esc  = defined $_[3] ? $_[3] : qq{\};
  134. my $pat = gen_delimited_pat($del, $esc);
  135. my $startpos = pos $$textref || 0;
  136. return _fail($wantarray, $textref, "Not a delimited pattern", 0)
  137. unless $$textref =~ m/G($pre)($pat)/gc;
  138. my $prelen = length($1);
  139. my $matchpos = $startpos+$prelen;
  140. my $endpos = pos $$textref;
  141. return _succeed $wantarray, $textref,
  142. $matchpos, $endpos-$matchpos, # MATCH
  143. $endpos,   length($$textref)-$endpos, # REMAINDER
  144. $startpos, $prelen; # PREFIX
  145. }
  147. sub extract_bracketed (;$$$)
  148. {
  149. my $textref = defined $_[0] ? $_[0] : $_;
  150. my $ldel = defined $_[1] ? $_[1] : '{([<';
  151. my $pre  = defined $_[2] ? $_[2] : 's*';
  152. my $wantarray = wantarray;
  153. my $qdel = "";
  154. my $quotelike;
  155. $ldel =~ s/'//g and $qdel .= q{'};
  156. $ldel =~ s/"//g and $qdel .= q{"};
  157. $ldel =~ s/`//g and $qdel .= q{`};
  158. $ldel =~ s/q//g and $quotelike = 1;
  159. $ldel =~ tr/[](){}<>-377/[[(({{<</ds;
  160. my $rdel = $ldel;
  161. unless ($rdel =~ tr/[({</])}>/)
  162.         {
  163. return _fail $wantarray, $textref,
  164.      "Did not find a suitable bracket in delimiter: "$_[1]"",
  165.      0;
  166. }
  167. my $posbug = pos;
  168. $ldel = join('|', map { quotemeta $_ } split('', $ldel));
  169. $rdel = join('|', map { quotemeta $_ } split('', $rdel));
  170. pos = $posbug;
  172. my $startpos = pos $$textref || 0;
  173. my @match = _match_bracketed($textref,$pre, $ldel, $qdel, $quotelike, $rdel);
  175. return _fail ($wantarray, $textref) unless @match;
  177. return _succeed ( $wantarray, $textref,
  178.   $match[2], $match[5]+2, # MATCH
  179.   @match[8,9], # REMAINDER
  180.   @match[0,1], # PREFIX
  181. );
  182. }
  184. sub _match_bracketed($$$$$$) # $textref, $pre, $ldel, $qdel, $quotelike, $rdel
  185. {
  186. my ($textref, $pre, $ldel, $qdel, $quotelike, $rdel) = @_;
  187. my ($startpos, $ldelpos, $endpos) = (pos $$textref = pos $$textref||0);
  188. unless ($$textref =~ m/G$pre/gc)
  189. {
  190. _failmsg "Did not find prefix: /$pre/", $startpos;
  191. return;
  192. }
  194. $ldelpos = pos $$textref;
  196. unless ($$textref =~ m/G($ldel)/gc)
  197. {
  198. _failmsg "Did not find opening bracket after prefix: "$pre"",
  199.          pos $$textref;
  200. pos $$textref = $startpos;
  201. return;
  202. }
  204. my @nesting = ( $1 );
  205. my $textlen = length $$textref;
  206. while (pos $$textref < $textlen)
  207. {
  208. next if $$textref =~ m/G\./gcs;
  210. if ($$textref =~ m/G($ldel)/gc)
  211. {
  212. push @nesting, $1;
  213. }
  214. elsif ($$textref =~ m/G($rdel)/gc)
  215. {
  216. my ($found, $brackettype) = ($1, $1);
  217. if ($#nesting < 0)
  218. {
  219. _failmsg "Unmatched closing bracket: "$found"",
  220.  pos $$textref;
  221. pos $$textref = $startpos;
  222.         return;
  223. }
  224. my $expected = pop(@nesting);
  225. $expected =~ tr/({[</)}]>/;
  226. if ($expected ne $brackettype)
  227. {
  228. _failmsg qq{Mismatched closing bracket: expected "$expected" but found "$found"},
  229.  pos $$textref;
  230. pos $$textref = $startpos;
  231.         return;
  232. }
  233. last if $#nesting < 0;
  234. }
  235. elsif ($qdel && $$textref =~ m/G([$qdel])/gc)
  236. {
  237. $$textref =~ m/G[^\$1]*(?:\.[^\$1]*)*(Q$1E)/gsc and next;
  238. _failmsg "Unmatched embedded quote ($1)",
  239.  pos $$textref;
  240. pos $$textref = $startpos;
  241. return;
  242. }
  243. elsif ($quotelike && _match_quotelike($textref,"",1,0))
  244. {
  245. next;
  246. }
  248. else { $$textref =~ m/G(?:[a-zA-Z0-9]+|.)/gcs }
  249. }
  250. if ($#nesting>=0)
  251. {
  252. _failmsg "Unmatched opening bracket(s): "
  253. . join("..",@nesting)."..",
  254.          pos $$textref;
  255. pos $$textref = $startpos;
  256. return;
  257. }
  259. $endpos = pos $$textref;
  261. return (
  262. $startpos,  $ldelpos-$startpos, # PREFIX
  263. $ldelpos,   1, # OPENING BRACKET
  264. $ldelpos+1, $endpos-$ldelpos-2, # CONTENTS
  265. $endpos-1,  1, # CLOSING BRACKET
  266. $endpos,    length($$textref)-$endpos, # REMAINDER
  267.        );
  268. }
  270. sub _revbracket($)
  271. {
  272. my $brack = reverse $_[0];
  273. $brack =~ tr/[({</])}>/;
  274. return $brack;
  275. }
  277. my $XMLNAME = q{[a-zA-Z_:][a-zA-Z0-9_:.-]*};
  279. sub extract_tagged (;$$$$$) # ($text, $opentag, $closetag, $pre, %options)
  280. {
  281. my $textref = defined $_[0] ? $_[0] : $_;
  282. my $ldel    = $_[1];
  283. my $rdel    = $_[2];
  284. my $pre     = defined $_[3] ? $_[3] : 's*';
  285. my %options = defined $_[4] ? %{$_[4]} : ();
  286. my $omode   = defined $options{fail} ? $options{fail} : '';
  287. my $bad     = ref($options{reject}) eq 'ARRAY' ? join('|', @{$options{reject}})
  288.     : defined($options{reject})        ? $options{reject}
  289.     :  ''
  290.     ;
  291. my $ignore  = ref($options{ignore}) eq 'ARRAY' ? join('|', @{$options{ignore}})
  292.     : defined($options{ignore})        ? $options{ignore}
  293.     :  ''
  294.     ;
  296. if (!defined $ldel) { $ldel = '<w+(?:' . gen_delimited_pat(q{'"}) . '|[^>])*>'; }
  297. $@ = undef;
  299. my @match = _match_tagged($textref, $pre, $ldel, $rdel, $omode, $bad, $ignore);
  301. return _fail(wantarray, $textref) unless @match;
  302. return _succeed wantarray, $textref,
  303. $match[2], $match[3]+$match[5]+$match[7], # MATCH
  304. @match[8..9,0..1,2..7]; # REM, PRE, BITS
  305. }
  307. sub _match_tagged # ($$$$$$$)
  308. {
  309. my ($textref, $pre, $ldel, $rdel, $omode, $bad, $ignore) = @_;
  310. my $rdelspec;
  312. my ($startpos, $opentagpos, $textpos, $parapos, $closetagpos, $endpos) = ( pos($$textref) = pos($$textref)||0 );
  314. unless ($$textref =~ m/G($pre)/gc)
  315. {
  316. _failmsg "Did not find prefix: /$pre/", pos $$textref;
  317. goto failed;
  318. }
  320. $opentagpos = pos($$textref);
  322. unless ($$textref =~ m/G$ldel/gc)
  323. {
  324. _failmsg "Did not find opening tag: /$ldel/", pos $$textref;
  325. goto failed;
  326. }
  328. $textpos = pos($$textref);
  330. if (!defined $rdel)
  331. {
  332. $rdelspec = substr($$textref, $-[0], $+[0] - $-[0]);
  333. unless ($rdelspec =~ s/A([[(<{]+)($XMLNAME).*/ quotemeta "$1/$2". _revbracket($1) /oes)
  334. {
  335. _failmsg "Unable to construct closing tag to match: $rdel",
  336.  pos $$textref;
  337. goto failed;
  338. }
  339. }
  340. else
  341. {
  342. $rdelspec = eval "qq{$rdel}" || do {
  343. my $del;
  344. for (qw,~ ! ^ & * ) _ + - = } ] : " ; ' > . ? / | ',)
  345. { next if $rdel =~ /Q$_/; $del = $_; last }
  346. unless ($del) {
  347. use Carp;
  348. croak "Can't interpolate right delimiter $rdel"
  349. }
  350. eval "qq$del$rdel$del";
  351. };
  352. }
  354. while (pos($$textref) < length($$textref))
  355. {
  356. next if $$textref =~ m/G\./gc;
  358. if ($$textref =~ m/G(n[ t]*n)/gc )
  359. {
  360. $parapos = pos($$textref) - length($1)
  361. unless defined $parapos;
  362. }
  363. elsif ($$textref =~ m/G($rdelspec)/gc )
  364. {
  365. $closetagpos = pos($$textref)-length($1);
  366. goto matched;
  367. }
  368. elsif ($ignore && $$textref =~ m/G(?:$ignore)/gc)
  369. {
  370. next;
  371. }
  372. elsif ($bad && $$textref =~ m/G($bad)/gcs)
  373. {
  374. pos($$textref) -= length($1); # CUT OFF WHATEVER CAUSED THE SHORTNESS
  375. goto short if ($omode eq 'PARA' || $omode eq 'MAX');
  376. _failmsg "Found invalid nested tag: $1", pos $$textref;
  377. goto failed;
  378. }
  379. elsif ($$textref =~ m/G($ldel)/gc)
  380. {
  381. my $tag = $1;
  382. pos($$textref) -= length($tag); # REWIND TO NESTED TAG
  383. unless (_match_tagged(@_)) # MATCH NESTED TAG
  384. {
  385. goto short if $omode eq 'PARA' || $omode eq 'MAX';
  386. _failmsg "Found unbalanced nested tag: $tag",
  387.  pos $$textref;
  388. goto failed;
  389. }
  390. }
  391. else { $$textref =~ m/./gcs }
  392. }
  394. short:
  395. $closetagpos = pos($$textref);
  396. goto matched if $omode eq 'MAX';
  397. goto failed unless $omode eq 'PARA';
  399. if (defined $parapos) { pos($$textref) = $parapos }
  400. else       { $parapos = pos($$textref) }
  402. return (
  403. $startpos,    $opentagpos-$startpos, # PREFIX
  404. $opentagpos,  $textpos-$opentagpos, # OPENING TAG
  405. $textpos,     $parapos-$textpos, # TEXT
  406. $parapos,     0, # NO CLOSING TAG
  407. $parapos,     length($$textref)-$parapos, # REMAINDER
  408.        );
  410. matched:
  411. $endpos = pos($$textref);
  412. return (
  413. $startpos,    $opentagpos-$startpos, # PREFIX
  414. $opentagpos,  $textpos-$opentagpos, # OPENING TAG
  415. $textpos,     $closetagpos-$textpos, # TEXT
  416. $closetagpos, $endpos-$closetagpos, # CLOSING TAG
  417. $endpos,      length($$textref)-$endpos, # REMAINDER
  418.        );
  420. failed:
  421. _failmsg "Did not find closing tag", pos $$textref unless $@;
  422. pos($$textref) = $startpos;
  423. return;
  424. }
  426. sub extract_variable (;$$)
  427. {
  428. my $textref = defined $_[0] ? $_[0] : $_;
  429. return ("","","") unless defined $$textref;
  430. my $pre  = defined $_[1] ? $_[1] : 's*';
  432. my @match = _match_variable($textref,$pre);
  434. return _fail wantarray, $textref unless @match;
  436. return _succeed wantarray, $textref,
  437. @match[2..3,4..5,0..1]; # MATCH, REMAINDER, PREFIX
  438. }
  440. sub _match_variable($$)
  441. {
  442. #  $#
  443. #  $^
  444. #  $$
  445. my ($textref, $pre) = @_;
  446. my $startpos = pos($$textref) = pos($$textref)||0;
  447. unless ($$textref =~ m/G($pre)/gc)
  448. {
  449. _failmsg "Did not find prefix: /$pre/", pos $$textref;
  450. return;
  451. }
  452. my $varpos = pos($$textref);
  453.         unless ($$textref =~ m{G$s*(?!::)(d+|[][&`'+*./|,";%=~:?!@<>()-]|^[a-z]?)}gci)
  454. {
  455.     unless ($$textref =~ m/G(($#?|[*@%]|\&)+)/gc)
  456.     {
  457. _failmsg "Did not find leading dereferencer", pos $$textref;
  458. pos $$textref = $startpos;
  459. return;
  460.     }
  461.     my $deref = $1;
  463.     unless ($$textref =~ m/Gs*(?:::|')?(?:[_a-z]w*(?:::|'))*[_a-z]w*/gci
  464.      or _match_codeblock($textref, "", '{', '}', '{', '}', 0)
  465. or $deref eq '$#' or $deref eq '$$' )
  466.     {
  467. _failmsg "Bad identifier after dereferencer", pos $$textref;
  468. pos $$textref = $startpos;
  469. return;
  470.     }
  471. }
  473. while (1)
  474. {
  475. next if $$textref =~ m/Gs*(?:->)?s*[{]w+[}]/gc;
  476. next if _match_codeblock($textref,
  477.  qr/s*->s*(?:[_a-zA-Z]w+s*)?/,
  478.  qr/[({[]/, qr/[)}]]/,
  479.  qr/[({[]/, qr/[)}]]/, 0);
  480. next if _match_codeblock($textref,
  481.  qr/s*/, qr/[{[]/, qr/[}]]/,
  482.  qr/[{[]/, qr/[}]]/, 0);
  483. next if _match_variable($textref,'s*->s*');
  484. next if $$textref =~ m/Gs*->s*w+(?![{([])/gc;
  485. last;
  486. }
  488. my $endpos = pos($$textref);
  489. return ($startpos, $varpos-$startpos,
  490. $varpos,   $endpos-$varpos,
  491. $endpos,   length($$textref)-$endpos
  492. );
  493. }
  495. sub extract_codeblock (;$$$$$)
  496. {
  497. my $textref = defined $_[0] ? $_[0] : $_;
  498. my $wantarray = wantarray;
  499. my $ldel_inner = defined $_[1] ? $_[1] : '{';
  500. my $pre        = defined $_[2] ? $_[2] : 's*';
  501. my $ldel_outer = defined $_[3] ? $_[3] : $ldel_inner;
  502. my $rd         = $_[4];
  503. my $rdel_inner = $ldel_inner;
  504. my $rdel_outer = $ldel_outer;
  505. my $posbug = pos;
  506. for ($ldel_inner, $ldel_outer) { tr/[]()<>{}-377/[[((<<{{/ds }
  507. for ($rdel_inner, $rdel_outer) { tr/[]()<>{}-377/]]))>>}}/ds }
  508. for ($ldel_inner, $ldel_outer, $rdel_inner, $rdel_outer)
  509. {
  510. $_ = '('.join('|',map { quotemeta $_ } split('',$_)).')'
  511. }
  512. pos = $posbug;
  514. my @match = _match_codeblock($textref, $pre,
  515.      $ldel_outer, $rdel_outer,
  516.      $ldel_inner, $rdel_inner,
  517.      $rd);
  518. return _fail($wantarray, $textref) unless @match;
  519. return _succeed($wantarray, $textref,
  520. @match[2..3,4..5,0..1] # MATCH, REMAINDER, PREFIX
  521.        );
  523. }
  525. sub _match_codeblock($$$$$$$)
  526. {
  527. my ($textref, $pre, $ldel_outer, $rdel_outer, $ldel_inner, $rdel_inner, $rd) = @_;
  528. my $startpos = pos($$textref) = pos($$textref) || 0;
  529. unless ($$textref =~ m/G($pre)/gc)
  530. {
  531. _failmsg qq{Did not match prefix /$pre/ at"} .
  532.     substr($$textref,pos($$textref),20) .
  533.     q{..."},
  534.          pos $$textref;
  535. return; 
  536. }
  537. my $codepos = pos($$textref);
  538. unless ($$textref =~ m/G($ldel_outer)/gc) # OUTERMOST DELIMITER
  539. {
  540. _failmsg qq{Did not find expected opening bracket at "} .
  541.      substr($$textref,pos($$textref),20) .
  542.      q{..."},
  543.          pos $$textref;
  544. pos $$textref = $startpos;
  545. return;
  546. }
  547. my $closing = $1;
  548.    $closing =~ tr/([<{/)]>}/;
  549. my $matched;
  550. my $patvalid = 1;
  551. while (pos($$textref) < length($$textref))
  552. {
  553. $matched = '';
  554. if ($rd && $$textref =~ m#G(Q(?)E|Q(s?)E|Q(s)E)#gc)
  555. {
  556. $patvalid = 0;
  557. next;
  558. }
  560. if ($$textref =~ m/Gs*#.*/gc)
  561. {
  562. next;
  563. }
  565. if ($$textref =~ m/Gs*($rdel_outer)/gc)
  566. {
  567. unless ($matched = ($closing && $1 eq $closing) )
  568. {
  569. next if $1 eq '>'; # MIGHT BE A "LESS THAN"
  570. _failmsg q{Mismatched closing bracket at "} .
  571.      substr($$textref,pos($$textref),20) .
  572.      qq{...". Expected '$closing'},
  573.  pos $$textref;
  574. }
  575. last;
  576. }
  578. if (_match_variable($textref,'s*') ||
  579.     _match_quotelike($textref,'s*',$patvalid,$patvalid) )
  580. {
  581. $patvalid = 0;
  582. next;
  583. }
  586. # NEED TO COVER MANY MORE CASES HERE!!!
  587. if ($$textref =~ m#Gs*(?!$ldel_inner)
  588. ( [-+*x/%^&|.]=?
  589. | [!=]~
  590. | =(?!>)
  591. | (**|&&||||<<|>>)=?
  592. | split|grep|map|return
  593. | [([]
  594. )#gcx)
  595. {
  596. $patvalid = 1;
  597. next;
  598. }
  600. if ( _match_codeblock($textref, 's*', $ldel_inner, $rdel_inner, $ldel_inner, $rdel_inner, $rd) )
  601. {
  602. $patvalid = 1;
  603. next;
  604. }
  606. if ($$textref =~ m/Gs*$ldel_outer/gc)
  607. {
  608. _failmsg q{Improperly nested codeblock at "} .
  609.      substr($$textref,pos($$textref),20) .
  610.      q{..."},
  611.  pos $$textref;
  612. last;
  613. }
  615. $patvalid = 0;
  616. $$textref =~ m/Gs*(w+|[-=>]>|.|Z)/gc;
  617. }
  618. continue { $@ = undef }
  620. unless ($matched)
  621. {
  622. _failmsg 'No match found for opening bracket', pos $$textref
  623. unless $@;
  624. return;
  625. }
  627. my $endpos = pos($$textref);
  628. return ( $startpos, $codepos-$startpos,
  629.  $codepos, $endpos-$codepos,
  630.  $endpos,  length($$textref)-$endpos,
  631.        );
  632. }
  635. my %mods   = (
  636. 'none' => '[cgimsox]*',
  637. 'm' => '[cgimsox]*',
  638. 's' => '[cegimsox]*',
  639. 'tr' => '[cds]*',
  640. 'y' => '[cds]*',
  641. 'qq' => '',
  642. 'qx' => '',
  643. 'qw' => '',
  644. 'qr' => '[imsx]*',
  645. 'q' => '',
  646.      );
  648. sub extract_quotelike (;$$)
  649. {
  650. my $textref = $_[0] ? $_[0] : $_;
  651. my $wantarray = wantarray;
  652. my $pre  = defined $_[1] ? $_[1] : 's*';
  654. my @match = _match_quotelike($textref,$pre,1,0);
  655. return _fail($wantarray, $textref) unless @match;
  656. return _succeed($wantarray, $textref,
  657. $match[2], $match[18]-$match[2], # MATCH
  658. @match[18,19], # REMAINDER
  659. @match[0,1], # PREFIX
  660. @match[2..17], # THE BITS
  661. @match[20,21], # ANY FILLET?
  662.        );
  663. };
  665. sub _match_quotelike($$$$) # ($textref, $prepat, $allow_raw_match)
  666. {
  667. my ($textref, $pre, $rawmatch, $qmark) = @_;
  669. my ($textlen,$startpos,
  670.     $oppos,
  671.     $preld1pos,$ld1pos,$str1pos,$rd1pos,
  672.     $preld2pos,$ld2pos,$str2pos,$rd2pos,
  673.     $modpos) = ( length($$textref), pos($$textref) = pos($$textref) || 0 );
  675. unless ($$textref =~ m/G($pre)/gc)
  676. {
  677. _failmsg qq{Did not find prefix /$pre/ at "} .
  678.      substr($$textref, pos($$textref), 20) .
  679.      q{..."},
  680.          pos $$textref;
  681. return; 
  682. }
  683. $oppos = pos($$textref);
  685. my $initial = substr($$textref,$oppos,1);
  687. if ($initial && $initial =~ m|^["'`]|
  688.      || $rawmatch && $initial =~ m|^/|
  689.      || $qmark && $initial =~ m|^?|)
  690. {
  691. unless ($$textref =~ m/ Q$initialE [^\$initial]* (\.[^\$initial]*)* Q$initialE /gcsx)
  692. {
  693. _failmsg qq{Did not find closing delimiter to match '$initial' at "} .
  694.      substr($$textref, $oppos, 20) .
  695.      q{..."},
  696.  pos $$textref;
  697. pos $$textref = $startpos;
  698. return;
  699. }
  700. $modpos= pos($$textref);
  701. $rd1pos = $modpos-1;
  703. if ($initial eq '/' || $initial eq '?') 
  704. {
  705. $$textref =~ m/G$mods{none}/gc
  706. }
  708. my $endpos = pos($$textref);
  709. return (
  710. $startpos, $oppos-$startpos, # PREFIX
  711. $oppos, 0, # NO OPERATOR
  712. $oppos, 1, # LEFT DEL
  713. $oppos+1, $rd1pos-$oppos-1, # STR/PAT
  714. $rd1pos, 1, # RIGHT DEL
  715. $modpos, 0, # NO 2ND LDEL
  716. $modpos, 0, # NO 2ND STR
  717. $modpos, 0, # NO 2ND RDEL
  718. $modpos, $endpos-$modpos, # MODIFIERS
  719. $endpos,  $textlen-$endpos, # REMAINDER
  720.        );
  721. }
  723. unless ($$textref =~ m{G(b(?:m|s|qq|qx|qw|q|qr|tr|y)b(?=s*S)|<<)}gc)
  724. {
  725. _failmsg q{No quotelike operator found after prefix at "} .
  726.      substr($$textref, pos($$textref), 20) .
  727.      q{..."},
  728.          pos $$textref;
  729. pos $$textref = $startpos;
  730. return;
  731. }
  733. my $op = $1;
  734. $preld1pos = pos($$textref);
  735. if ($op eq '<<') {
  736. $ld1pos = pos($$textref);
  737. my $label;
  738. if ($$textref =~ m{G([A-Za-z_]w*)}gc) {
  739. $label = $1;
  740. }
  741. elsif ($$textref =~ m{ G ' ([^'\]* (?:\.[^'\]*)*) '
  742.      | G " ([^"\]* (?:\.[^"\]*)*) "
  743.      | G ` ([^`\]* (?:\.[^`\]*)*) `
  744.      }gcsx) {
  745. $label = $+;
  746. }
  747. else {
  748. $label = "";
  749. }
  750. my $extrapos = pos($$textref);
  751. $$textref =~ m{.*n}gc;
  752. $str1pos = pos($$textref)--;
  753. unless ($$textref =~ m{.*?n(?=Q$labelEn)}gc) {
  754. _failmsg qq{Missing here doc terminator ('$label') after "} .
  755.      substr($$textref, $startpos, 20) .
  756.      q{..."},
  757.  pos $$textref;
  758. pos $$textref = $startpos;
  759. return;
  760. }
  761. $rd1pos = pos($$textref);
  762.         $$textref =~ m{Q$labelEn}gc;
  763. $ld2pos = pos($$textref);
  764. return (
  765. $startpos, $oppos-$startpos, # PREFIX
  766. $oppos, length($op), # OPERATOR
  767. $ld1pos, $extrapos-$ld1pos, # LEFT DEL
  768. $str1pos, $rd1pos-$str1pos, # STR/PAT
  769. $rd1pos, $ld2pos-$rd1pos, # RIGHT DEL
  770. $ld2pos, 0, # NO 2ND LDEL
  771. $ld2pos, 0,                 # NO 2ND STR
  772. $ld2pos, 0,                 # NO 2ND RDEL
  773. $ld2pos, 0,                      # NO MODIFIERS
  774. $ld2pos, $textlen-$ld2pos, # REMAINDER
  775. $extrapos,      $str1pos-$extrapos, # FILLETED BIT
  776.        );
  777. }
  779. $$textref =~ m/Gs*/gc;
  780. $ld1pos = pos($$textref);
  781. $str1pos = $ld1pos+1;
  783. unless ($$textref =~ m/G(S)/gc) # SHOULD USE LOOKAHEAD
  784. {
  785. _failmsg "No block delimiter found after quotelike $op",
  786.          pos $$textref;
  787. pos $$textref = $startpos;
  788. return;
  789. }
  790. pos($$textref) = $ld1pos; # HAVE TO DO THIS BECAUSE LOOKAHEAD BROKEN
  791. my ($ldel1, $rdel1) = ("Q$1","Q$1");
  792. if ($ldel1 =~ /[[(<{]/)
  793. {
  794. $rdel1 =~ tr/[({</])}>/;
  795. defined(_match_bracketed($textref,"",$ldel1,"","",$rdel1))
  796. || do { pos $$textref = $startpos; return };
  797.         $ld2pos = pos($$textref);
  798.         $rd1pos = $ld2pos-1;
  799. }
  800. else
  801. {
  802. $$textref =~ /G$ldel1[^\$ldel1]*(\.[^\$ldel1]*)*$ldel1/gcs
  803. || do { pos $$textref = $startpos; return };
  804.         $ld2pos = $rd1pos = pos($$textref)-1;
  805. }
  807. my $second_arg = $op =~ /s|tr|y/ ? 1 : 0;
  808. if ($second_arg)
  809. {
  810. my ($ldel2, $rdel2);
  811. if ($ldel1 =~ /[[(<{]/)
  812. {
  813. unless ($$textref =~ /Gs*(S)/gc) # SHOULD USE LOOKAHEAD
  814. {
  815. _failmsg "Missing second block for quotelike $op",
  816.  pos $$textref;
  817. pos $$textref = $startpos;
  818. return;
  819. }
  820. $ldel2 = $rdel2 = "Q$1";
  821. $rdel2 =~ tr/[({</])}>/;
  822. }
  823. else
  824. {
  825. $ldel2 = $rdel2 = $ldel1;
  826. }
  827. $str2pos = $ld2pos+1;
  829. if ($ldel2 =~ /[[(<{]/)
  830. {
  831. pos($$textref)--; # OVERCOME BROKEN LOOKAHEAD 
  832. defined(_match_bracketed($textref,"",$ldel2,"","",$rdel2))
  833. || do { pos $$textref = $startpos; return };
  834. }
  835. else
  836. {
  837. $$textref =~ /[^\$ldel2]*(\.[^\$ldel2]*)*$ldel2/gcs
  838. || do { pos $$textref = $startpos; return };
  839. }
  840. $rd2pos = pos($$textref)-1;
  841. }
  842. else
  843. {
  844. $ld2pos = $str2pos = $rd2pos = $rd1pos;
  845. }
  847. $modpos = pos $$textref;
  849. $$textref =~ m/G($mods{$op})/gc;
  850. my $endpos = pos $$textref;
  852. return (
  853. $startpos, $oppos-$startpos, # PREFIX
  854. $oppos, length($op), # OPERATOR
  855. $ld1pos, 1, # LEFT DEL
  856. $str1pos, $rd1pos-$str1pos, # STR/PAT
  857. $rd1pos, 1, # RIGHT DEL
  858. $ld2pos, $second_arg, # 2ND LDEL (MAYBE)
  859. $str2pos, $rd2pos-$str2pos, # 2ND STR (MAYBE)
  860. $rd2pos, $second_arg, # 2ND RDEL (MAYBE)
  861. $modpos, $endpos-$modpos, # MODIFIERS
  862. $endpos, $textlen-$endpos, # REMAINDER
  863.        );
  864. }
  866. my $def_func = 
  867. [
  868. sub { extract_variable($_[0], '') },
  869. sub { extract_quotelike($_[0],'') },
  870. sub { extract_codeblock($_[0],'{}','') },
  871. ];
  873. sub extract_multiple (;$$$$) # ($text, $functions_ref, $max_fields, $ignoreunknown)
  874. {
  875. my $textref = defined($_[0]) ? $_[0] : $_;
  876. my $posbug = pos;
  877. my ($lastpos, $firstpos);
  878. my @fields = ();
  880. #for ($$textref)
  881. {
  882. my @func = defined $_[1] ? @{$_[1]} : @{$def_func};
  883. my $max  = defined $_[2] && $_[2]>0 ? $_[2] : 1_000_000_000;
  884. my $igunk = $_[3];
  886. pos $$textref ||= 0;
  888. unless (wantarray)
  889. {
  890. use Carp;
  891. carp "extract_multiple reset maximal count to 1 in scalar context"
  892. if $^W && defined($_[2]) && $max > 1;
  893. $max = 1
  894. }
  896. my $unkpos;
  897. my $func;
  898. my $class;
  900. my @class;
  901. foreach $func ( @func )
  902. {
  903. if (ref($func) eq 'HASH')
  904. {
  905. push @class, (keys %$func)[0];
  906. $func = (values %$func)[0];
  907. }
  908. else
  909. {
  910. push @class, undef;
  911. }
  912. }
  914. FIELD: while (pos($$textref) < length($$textref))
  915. {
  916. my ($field, $rem);
  917. my @bits;
  918. foreach my $i ( 0..$#func )
  919. {
  920. my $pref;
  921. $func = $func[$i];
  922. $class = $class[$i];
  923. $lastpos = pos $$textref;
  924. if (ref($func) eq 'CODE')
  925. { ($field,$rem,$pref) = @bits = $func->($$textref) }
  926. elsif (ref($func) eq 'Text::Balanced::Extractor')
  927. { @bits = $field = $func->extract($$textref) }
  928. elsif( $$textref =~ m/G$func/gc )
  929. { @bits = $field = defined($1)
  930.                                 ? $1
  931.                                 : substr($$textref, $-[0], $+[0] - $-[0])
  932.                     }
  933. $pref ||= "";
  934. if (defined($field) && length($field))
  935. {
  936. if (!$igunk) {
  937. $unkpos = $lastpos
  938. if length($pref) && !defined($unkpos);
  939. if (defined $unkpos)
  940. {
  941. push @fields, substr($$textref, $unkpos, $lastpos-$unkpos).$pref;
  942. $firstpos = $unkpos unless defined $firstpos;
  943. undef $unkpos;
  944. last FIELD if @fields == $max;
  945. }
  946. }
  947. push @fields, $class
  948. ? bless ($field, $class)
  949. : $field;
  950. $firstpos = $lastpos unless defined $firstpos;
  951. $lastpos = pos $$textref;
  952. last FIELD if @fields == $max;
  953. next FIELD;
  954. }
  955. }
  956. if ($$textref =~ /G(.)/gcs)
  957. {
  958. $unkpos = pos($$textref)-1
  959. unless $igunk || defined $unkpos;
  960. }
  961. }
  963. if (defined $unkpos)
  964. {
  965. push @fields, substr($$textref, $unkpos);
  966. $firstpos = $unkpos unless defined $firstpos;
  967. $lastpos = length $$textref;
  968. }
  969. last;
  970. }
  972. pos $$textref = $lastpos;
  973. return @fields if wantarray;
  975. $firstpos ||= 0;
  976. eval { substr($$textref,$firstpos,$lastpos-$firstpos)="";
  977.        pos $$textref = $firstpos };
  978. return $fields[0];
  979. }
  982. sub gen_extract_tagged # ($opentag, $closetag, $pre, %options)
  983. {
  984. my $ldel    = $_[0];
  985. my $rdel    = $_[1];
  986. my $pre     = defined $_[2] ? $_[2] : 's*';
  987. my %options = defined $_[3] ? %{$_[3]} : ();
  988. my $omode   = defined $options{fail} ? $options{fail} : '';
  989. my $bad     = ref($options{reject}) eq 'ARRAY' ? join('|', @{$options{reject}})
  990.     : defined($options{reject})        ? $options{reject}
  991.     :  ''
  992.     ;
  993. my $ignore  = ref($options{ignore}) eq 'ARRAY' ? join('|', @{$options{ignore}})
  994.     : defined($options{ignore})        ? $options{ignore}
  995.     :  ''
  996.     ;
  998. if (!defined $ldel) { $ldel = '<w+(?:' . gen_delimited_pat(q{'"}) . '|[^>])*>'; }
  1000. my $posbug = pos;
  1001. for ($ldel, $pre, $bad, $ignore) { $_ = qr/$_/ if $_ }
  1002. pos = $posbug;
  1004. my $closure = sub
  1005. {
  1006. my $textref = defined $_[0] ? $_[0] : $_;
  1007. my @match = Text::Balanced::_match_tagged($textref, $pre, $ldel, $rdel, $omode, $bad, $ignore);
  1009. return _fail(wantarray, $textref) unless @match;
  1010. return _succeed wantarray, $textref,
  1011. $match[2], $match[3]+$match[5]+$match[7], # MATCH
  1012. @match[8..9,0..1,2..7]; # REM, PRE, BITS
  1013. };
  1015. bless $closure, 'Text::Balanced::Extractor';
  1016. }
  1018. package Text::Balanced::Extractor;
  1020. sub extract($$) # ($self, $text)
  1021. {
  1022. &{$_[0]}($_[1]);
  1023. }
  1025. package Text::Balanced::ErrorMsg;
  1027. use overload '""' => sub { "$_[0]->{error}, detected at offset $_[0]->{pos}" };
  1029. 1;
  1031. __END__
  1033. =head1 NAME
  1035. Text::Balanced - Extract delimited text sequences from strings.
  1038. =head1 SYNOPSIS
  1040.  use Text::Balanced qw (
  1041. extract_delimited
  1042. extract_bracketed
  1043. extract_quotelike
  1044. extract_codeblock
  1045. extract_variable
  1046. extract_tagged
  1047. extract_multiple
  1049. gen_delimited_pat
  1050. gen_extract_tagged
  1051.        );
  1053.  # Extract the initial substring of $text that is delimited by
  1054.  # two (unescaped) instances of the first character in $delim.
  1056. ($extracted, $remainder) = extract_delimited($text,$delim);
  1059.  # Extract the initial substring of $text that is bracketed
  1060.  # with a delimiter(s) specified by $delim (where the string
  1061.  # in $delim contains one or more of '(){}[]<>').
  1063. ($extracted, $remainder) = extract_bracketed($text,$delim);
  1066.  # Extract the initial substring of $text that is bounded by
  1067.  # an XML tag.
  1069. ($extracted, $remainder) = extract_tagged($text);
  1072.  # Extract the initial substring of $text that is bounded by
  1073.  # a C<BEGIN>...C<END> pair. Don't allow nested C<BEGIN> tags
  1075. ($extracted, $remainder) =
  1076. extract_tagged($text,"BEGIN","END",undef,{bad=>["BEGIN"]});
  1079.  # Extract the initial substring of $text that represents a
  1080.  # Perl "quote or quote-like operation"
  1082. ($extracted, $remainder) = extract_quotelike($text);
  1085.  # Extract the initial substring of $text that represents a block
  1086.  # of Perl code, bracketed by any of character(s) specified by $delim
  1087.  # (where the string $delim contains one or more of '(){}[]<>').
  1089. ($extracted, $remainder) = extract_codeblock($text,$delim);
  1092.  # Extract the initial substrings of $text that would be extracted by
  1093.  # one or more sequential applications of the specified functions
  1094.  # or regular expressions
  1096. @extracted = extract_multiple($text,
  1097.       [ &extract_bracketed,
  1098. &extract_quotelike,
  1099. &some_other_extractor_sub,
  1100. qr/[xyz]*/,
  1101. 'literal',
  1102.       ]);
  1104. # Create a string representing an optimized pattern (a la Friedl)
  1105. # that matches a substring delimited by any of the specified characters
  1106. # (in this case: any type of quote or a slash)
  1108. $patstring = gen_delimited_pat(q{'"`/});
  1111. # Generate a reference to an anonymous sub that is just like extract_tagged
  1112. # but pre-compiled and optimized for a specific pair of tags, and consequently
  1113. # much faster (i.e. 3 times faster). It uses qr// for better performance on
  1114. # repeated calls, so it only works under Perl 5.005 or later.
  1116. $extract_head = gen_extract_tagged('<HEAD>','</HEAD>');
  1118. ($extracted, $remainder) = $extract_head->($text);
  1121. =head1 DESCRIPTION
  1123. The various C<extract_...> subroutines may be used to
  1124. extract a delimited substring, possibly after skipping a
  1125. specified prefix string. By default, that prefix is
  1126. optional whitespace (C</s*/>), but you can change it to whatever
  1127. you wish (see below).
  1129. The substring to be extracted must appear at the
  1130. current C<pos> location of the string's variable
  1131. (or at index zero, if no C<pos> position is defined).
  1132. In other words, the C<extract_...> subroutines I<don't>
  1133. extract the first occurrence of a substring anywhere
  1134. in a string (like an unanchored regex would). Rather,
  1135. they extract an occurrence of the substring appearing
  1136. immediately at the current matching position in the
  1137. string (like a C<G>-anchored regex would).
  1141. =head2 General behaviour in list contexts
  1143. In a list context, all the subroutines return a list, the first three
  1144. elements of which are always:
  1146. =over 4
  1148. =item [0]
  1150. The extracted string, including the specified delimiters.
  1151. If the extraction fails C<undef> is returned.
  1153. =item [1]
  1155. The remainder of the input string (i.e. the characters after the
  1156. extracted string). On failure, the entire string is returned.
  1158. =item [2]
  1160. The skipped prefix (i.e. the characters before the extracted string).
  1161. On failure, C<undef> is returned.
  1163. =back 
  1165. Note that in a list context, the contents of the original input text (the first
  1166. argument) are not modified in any way. 
  1168. However, if the input text was passed in a variable, that variable's
  1169. C<pos> value is updated to point at the first character after the
  1170. extracted text. That means that in a list context the various
  1171. subroutines can be used much like regular expressions. For example:
  1173. while ( $next = (extract_quotelike($text))[0] )
  1174. {
  1175. # process next quote-like (in $next)
  1176. }
  1179. =head2 General behaviour in scalar and void contexts
  1181. In a scalar context, the extracted string is returned, having first been
  1182. removed from the input text. Thus, the following code also processes
  1183. each quote-like operation, but actually removes them from $text:
  1185. while ( $next = extract_quotelike($text) )
  1186. {
  1187. # process next quote-like (in $next)
  1188. }
  1190. Note that if the input text is a read-only string (i.e. a literal),
  1191. no attempt is made to remove the extracted text.
  1193. In a void context the behaviour of the extraction subroutines is
  1194. exactly the same as in a scalar context, except (of course) that the
  1195. extracted substring is not returned.
  1197. =head2 A note about prefixes
  1199. Prefix patterns are matched without any trailing modifiers (C</gimsox> etc.)
  1200. This can bite you if you're expecting a prefix specification like
  1201. '.*?(?=<H1>)' to skip everything up to the first <H1> tag. Such a prefix
  1202. pattern will only succeed if the <H1> tag is on the current line, since
  1203. . normally doesn't match newlines.
  1205. To overcome this limitation, you need to turn on /s matching within
  1206. the prefix pattern, using the C<(?s)> directive: '(?s).*?(?=<H1>)'
  1209. =head2 C<extract_delimited>
  1211. The C<extract_delimited> function formalizes the common idiom
  1212. of extracting a single-character-delimited substring from the start of
  1213. a string. For example, to extract a single-quote delimited string, the
  1214. following code is typically used:
  1216. ($remainder = $text) =~ s/A('(\.|[^'])*')//s;
  1217. $extracted = $1;
  1219. but with C<extract_delimited> it can be simplified to:
  1221. ($extracted,$remainder) = extract_delimited($text, "'");
  1223. C<extract_delimited> takes up to four scalars (the input text, the
  1224. delimiters, a prefix pattern to be skipped, and any escape characters)
  1225. and extracts the initial substring of the text that
  1226. is appropriately delimited. If the delimiter string has multiple
  1227. characters, the first one encountered in the text is taken to delimit
  1228. the substring.
  1229. The third argument specifies a prefix pattern that is to be skipped
  1230. (but must be present!) before the substring is extracted.
  1231. The final argument specifies the escape character to be used for each
  1232. delimiter.
  1234. All arguments are optional. If the escape characters are not specified,
  1235. every delimiter is escaped with a backslash (C<>).
  1236. If the prefix is not specified, the
  1237. pattern C<'s*'> - optional whitespace - is used. If the delimiter set
  1238. is also not specified, the set C</["'`]/> is used. If the text to be processed
  1239. is not specified either, C<$_> is used.
  1241. In list context, C<extract_delimited> returns a array of three
  1242. elements, the extracted substring (I<including the surrounding
  1243. delimiters>), the remainder of the text, and the skipped prefix (if
  1244. any). If a suitable delimited substring is not found, the first
  1245. element of the array is the empty string, the second is the complete
  1246. original text, and the prefix returned in the third element is an
  1247. empty string.
  1249. In a scalar context, just the extracted substring is returned. In
  1250. a void context, the extracted substring (and any prefix) are simply
  1251. removed from the beginning of the first argument.
  1253. Examples:
  1255. # Remove a single-quoted substring from the very beginning of $text:
  1257. $substring = extract_delimited($text, "'", '');
  1259. # Remove a single-quoted Pascalish substring (i.e. one in which
  1260. # doubling the quote character escapes it) from the very
  1261. # beginning of $text:
  1263. $substring = extract_delimited($text, "'", '', "'");
  1265. # Extract a single- or double- quoted substring from the
  1266. # beginning of $text, optionally after some whitespace
  1267. # (note the list context to protect $text from modification):
  1269. ($substring) = extract_delimited $text, q{"'};
  1272. # Delete the substring delimited by the first '/' in $text:
  1274. $text = join '', (extract_delimited($text,'/','[^/]*')[2,1];
  1276. Note that this last example is I<not> the same as deleting the first
  1277. quote-like pattern. For instance, if C<$text> contained the string:
  1279. "if ('./cmd' =~ m/$UNIXCMD/s) { $cmd = $1; }"
  1281. then after the deletion it would contain:
  1283. "if ('.$UNIXCMD/s) { $cmd = $1; }"
  1285. not:
  1287. "if ('./cmd' =~ ms) { $cmd = $1; }"
  1290. See L<"extract_quotelike"> for a (partial) solution to this problem.
  1293. =head2 C<extract_bracketed>
  1295. Like C<"extract_delimited">, the C<extract_bracketed> function takes
  1296. up to three optional scalar arguments: a string to extract from, a delimiter
  1297. specifier, and a prefix pattern. As before, a missing prefix defaults to
  1298. optional whitespace and a missing text defaults to C<$_>. However, a missing
  1299. delimiter specifier defaults to C<'{}()[]E<lt>E<gt>'> (see below).
  1301. C<extract_bracketed> extracts a balanced-bracket-delimited
  1302. substring (using any one (or more) of the user-specified delimiter
  1303. brackets: '(..)', '{..}', '[..]', or '<..>'). Optionally it will also
  1304. respect quoted unbalanced brackets (see below).
  1306. A "delimiter bracket" is a bracket in list of delimiters passed as
  1307. C<extract_bracketed>'s second argument. Delimiter brackets are
  1308. specified by giving either the left or right (or both!) versions
  1309. of the required bracket(s). Note that the order in which
  1310. two or more delimiter brackets are specified is not significant.
  1312. A "balanced-bracket-delimited substring" is a substring bounded by
  1313. matched brackets, such that any other (left or right) delimiter
  1314. bracket I<within> the substring is also matched by an opposite
  1315. (right or left) delimiter bracket I<at the same level of nesting>. Any
  1316. type of bracket not in the delimiter list is treated as an ordinary
  1317. character.
  1319. In other words, each type of bracket specified as a delimiter must be
  1320. balanced and correctly nested within the substring, and any other kind of
  1321. ("non-delimiter") bracket in the substring is ignored.
  1323. For example, given the string:
  1325. $text = "{ an '[irregularly :-(] {} parenthesized >:-)' string }";
  1327. then a call to C<extract_bracketed> in a list context:
  1329. @result = extract_bracketed( $text, '{}' );
  1331. would return:
  1333. ( "{ an '[irregularly :-(] {} parenthesized >:-)' string }" , "" , "" )
  1335. since both sets of C<'{..}'> brackets are properly nested and evenly balanced.
  1336. (In a scalar context just the first element of the array would be returned. In
  1337. a void context, C<$text> would be replaced by an empty string.)
  1339. Likewise the call in:
  1341. @result = extract_bracketed( $text, '{[' );
  1343. would return the same result, since all sets of both types of specified
  1344. delimiter brackets are correctly nested and balanced.
  1346. However, the call in:
  1348. @result = extract_bracketed( $text, '{([<' );
  1350. would fail, returning:
  1352. ( undef , "{ an '[irregularly :-(] {} parenthesized >:-)' string }"  );
  1354. because the embedded pairs of C<'(..)'>s and C<'[..]'>s are "cross-nested" and
  1355. the embedded C<'E<gt>'> is unbalanced. (In a scalar context, this call would
  1356. return an empty string. In a void context, C<$text> would be unchanged.)
  1358. Note that the embedded single-quotes in the string don't help in this
  1359. case, since they have not been specified as acceptable delimiters and are
  1360. therefore treated as non-delimiter characters (and ignored).
  1362. However, if a particular species of quote character is included in the
  1363. delimiter specification, then that type of quote will be correctly handled.
  1364. for example, if C<$text> is:
  1366. $text = '<A HREF=">>>>">link</A>';
  1368. then
  1370. @result = extract_bracketed( $text, '<">' );
  1372. returns:
  1374. ( '<A HREF=">>>>">', 'link</A>', "" )
  1376. as expected. Without the specification of C<"> as an embedded quoter:
  1378. @result = extract_bracketed( $text, '<>' );
  1380. the result would be:
  1382. ( '<A HREF=">', '>>>">link</A>', "" )
  1384. In addition to the quote delimiters C<'>, C<">, and C<`>, full Perl quote-like
  1385. quoting (i.e. q{string}, qq{string}, etc) can be specified by including the
  1386. letter 'q' as a delimiter. Hence:
  1388. @result = extract_bracketed( $text, '<q>' );
  1390. would correctly match something like this:
  1392. $text = '<leftop: conj /and/ conj>';
  1394. See also: C<"extract_quotelike"> and C<"extract_codeblock">.
  1397. =head2 C<extract_variable>
  1399. C<extract_variable> extracts any valid Perl variable or
  1400. variable-involved expression, including scalars, arrays, hashes, array
  1401. accesses, hash look-ups, method calls through objects, subroutine calls
  1402. through subroutine references, etc.
  1404. The subroutine takes up to two optional arguments:
  1406. =over 4
  1408. =item 1.
  1410. A string to be processed (C<$_> if the string is omitted or C<undef>)
  1412. =item 2.
  1414. A string specifying a pattern to be matched as a prefix (which is to be
  1415. skipped). If omitted, optional whitespace is skipped.
  1417. =back
  1419. On success in a list context, an array of 3 elements is returned. The
  1420. elements are:
  1422. =over 4
  1424. =item [0]
  1426. the extracted variable, or variablish expression
  1428. =item [1]
  1430. the remainder of the input text,
  1432. =item [2]
  1434. the prefix substring (if any),
  1436. =back
  1438. On failure, all of these values (except the remaining text) are C<undef>.
  1440. In a scalar context, C<extract_variable> returns just the complete
  1441. substring that matched a variablish expression. C<undef> is returned on
  1442. failure. In addition, the original input text has the returned substring
  1443. (and any prefix) removed from it.
  1445. In a void context, the input text just has the matched substring (and
  1446. any specified prefix) removed.
  1449. =head2 C<extract_tagged>
  1451. C<extract_tagged> extracts and segments text between (balanced)
  1452. specified tags. 
  1454. The subroutine takes up to five optional arguments:
  1456. =over 4
  1458. =item 1.
  1460. A string to be processed (C<$_> if the string is omitted or C<undef>)
  1462. =item 2.
  1464. A string specifying a pattern to be matched as the opening tag.
  1465. If the pattern string is omitted (or C<undef>) then a pattern
  1466. that matches any standard XML tag is used.
  1468. =item 3.
  1470. A string specifying a pattern to be matched at the closing tag. 
  1471. If the pattern string is omitted (or C<undef>) then the closing
  1472. tag is constructed by inserting a C</> after any leading bracket
  1473. characters in the actual opening tag that was matched (I<not> the pattern
  1474. that matched the tag). For example, if the opening tag pattern
  1475. is specified as C<'{{w+}}'> and actually matched the opening tag 
  1476. C<"{{DATA}}">, then the constructed closing tag would be C<"{{/DATA}}">.
  1478. =item 4.
  1480. A string specifying a pattern to be matched as a prefix (which is to be
  1481. skipped). If omitted, optional whitespace is skipped.
  1483. =item 5.
  1485. A hash reference containing various parsing options (see below)
  1487. =back
  1489. The various options that can be specified are:
  1491. =over 4
  1493. =item C<reject =E<gt> $listref>
  1495. The list reference contains one or more strings specifying patterns
  1496. that must I<not> appear within the tagged text.
  1498. For example, to extract
  1499. an HTML link (which should not contain nested links) use:
  1501.         extract_tagged($text, '<A>', '</A>', undef, {reject => ['<A>']} );
  1503. =item C<ignore =E<gt> $listref>
  1505. The list reference contains one or more strings specifying patterns
  1506. that are I<not> be be treated as nested tags within the tagged text
  1507. (even if they would match the start tag pattern).
  1509. For example, to extract an arbitrary XML tag, but ignore "empty" elements:
  1511.         extract_tagged($text, undef, undef, undef, {ignore => ['<[^>]*/>']} );
  1513. (also see L<"gen_delimited_pat"> below).
  1516. =item C<fail =E<gt> $str>
  1518. The C<fail> option indicates the action to be taken if a matching end
  1519. tag is not encountered (i.e. before the end of the string or some
  1520. C<reject> pattern matches). By default, a failure to match a closing
  1521. tag causes C<extract_tagged> to immediately fail.
  1523. However, if the string value associated with <reject> is "MAX", then
  1524. C<extract_tagged> returns the complete text up to the point of failure.
  1525. If the string is "PARA", C<extract_tagged> returns only the first paragraph
  1526. after the tag (up to the first line that is either empty or contains
  1527. only whitespace characters).
  1528. If the string is "", the the default behaviour (i.e. failure) is reinstated.
  1530. For example, suppose the start tag "/para" introduces a paragraph, which then
  1531. continues until the next "/endpara" tag or until another "/para" tag is
  1532. encountered:
  1534.         $text = "/para line 1nnline 3n/para line 4";
  1536.         extract_tagged($text, '/para', '/endpara', undef,
  1537.                                 {reject => '/para', fail => MAX );
  1539.         # EXTRACTED: "/para line 1nnline 3n"
  1541. Suppose instead, that if no matching "/endpara" tag is found, the "/para"
  1542. tag refers only to the immediately following paragraph:
  1544.         $text = "/para line 1nnline 3n/para line 4";
  1546.         extract_tagged($text, '/para', '/endpara', undef,
  1547.                         {reject => '/para', fail => MAX );
  1549.         # EXTRACTED: "/para line 1n"
  1551. Note that the specified C<fail> behaviour applies to nested tags as well.
  1553. =back
  1555. On success in a list context, an array of 6 elements is returned. The elements are:
  1557. =over 4
  1559. =item [0]
  1561. the extracted tagged substring (including the outermost tags),
  1563. =item [1]
  1565. the remainder of the input text,
  1567. =item [2]
  1569. the prefix substring (if any),
  1571. =item [3]
  1573. the opening tag
  1575. =item [4]
  1577. the text between the opening and closing tags
  1579. =item [5]
  1581. the closing tag (or "" if no closing tag was found)
  1583. =back
  1585. On failure, all of these values (except the remaining text) are C<undef>.
  1587. In a scalar context, C<extract_tagged> returns just the complete
  1588. substring that matched a tagged text (including the start and end
  1589. tags). C<undef> is returned on failure. In addition, the original input
  1590. text has the returned substring (and any prefix) removed from it.
  1592. In a void context, the input text just has the matched substring (and
  1593. any specified prefix) removed.
  1596. =head2 C<gen_extract_tagged>
  1598. (Note: This subroutine is only available under Perl5.005)
  1600. C<gen_extract_tagged> generates a new anonymous subroutine which
  1601. extracts text between (balanced) specified tags. In other words,
  1602. it generates a function identical in function to C<extract_tagged>.
  1604. The difference between C<extract_tagged> and the anonymous
  1605. subroutines generated by
  1606. C<gen_extract_tagged>, is that those generated subroutines:
  1608. =over 4
  1610. =item * 
  1612. do not have to reparse tag specification or parsing options every time
  1613. they are called (whereas C<extract_tagged> has to effectively rebuild
  1614. its tag parser on every call);
  1616. =item *
  1618. make use of the new qr// construct to pre-compile the regexes they use
  1619. (whereas C<extract_tagged> uses standard string variable interpolation 
  1620. to create tag-matching patterns).
  1622. =back
  1624. The subroutine takes up to four optional arguments (the same set as
  1625. C<extract_tagged> except for the string to be processed). It returns
  1626. a reference to a subroutine which in turn takes a single argument (the text to
  1627. be extracted from).
  1629. In other words, the implementation of C<extract_tagged> is exactly
  1630. equivalent to:
  1632.         sub extract_tagged
  1633.         {
  1634.                 my $text = shift;
  1635.                 $extractor = gen_extract_tagged(@_);
  1636.                 return $extractor->($text);
  1637.         }
  1639. (although C<extract_tagged> is not currently implemented that way, in order
  1640. to preserve pre-5.005 compatibility).
  1642. Using C<gen_extract_tagged> to create extraction functions for specific tags 
  1643. is a good idea if those functions are going to be called more than once, since
  1644. their performance is typically twice as good as the more general-purpose
  1645. C<extract_tagged>.
  1648. =head2 C<extract_quotelike>
  1650. C<extract_quotelike> attempts to recognize, extract, and segment any
  1651. one of the various Perl quotes and quotelike operators (see
  1652. L<perlop(3)>) Nested backslashed delimiters, embedded balanced bracket
  1653. delimiters (for the quotelike operators), and trailing modifiers are
  1654. all caught. For example, in:
  1656.         extract_quotelike 'q # an octothorpe: # (not the end of the q!) #'
  1657.         
  1658.         extract_quotelike '  "You said, "Use sed"."  '
  1660.         extract_quotelike ' s{([A-Z]{1,8}.[A-Z]{3})} /L$1E/; '
  1662.         extract_quotelike ' tr/\/\\/\//ds; '
  1664. the full Perl quotelike operations are all extracted correctly.
  1666. Note too that, when using the /x modifier on a regex, any comment
  1667. containing the current pattern delimiter will cause the regex to be
  1668. immediately terminated. In other words:
  1670.         'm /
  1671.                 (?i)            # CASE INSENSITIVE
  1672.                 [a-z_]          # LEADING ALPHABETIC/UNDERSCORE
  1673.                 [a-z0-9]*       # FOLLOWED BY ANY NUMBER OF ALPHANUMERICS
  1674.            /x'
  1676. will be extracted as if it were:
  1678.         'm /
  1679.                 (?i)            # CASE INSENSITIVE
  1680.                 [a-z_]          # LEADING ALPHABETIC/'
  1682. This behaviour is identical to that of the actual compiler.
  1684. C<extract_quotelike> takes two arguments: the text to be processed and
  1685. a prefix to be matched at the very beginning of the text. If no prefix 
  1686. is specified, optional whitespace is the default. If no text is given,
  1687. C<$_> is used.
  1689. In a list context, an array of 11 elements is returned. The elements are:
  1691. =over 4
  1693. =item [0]
  1695. the extracted quotelike substring (including trailing modifiers),
  1697. =item [1]
  1699. the remainder of the input text,
  1701. =item [2]
  1703. the prefix substring (if any),
  1705. =item [3]
  1707. the name of the quotelike operator (if any),
  1709. =item [4]
  1711. the left delimiter of the first block of the operation,
  1713. =item [5]
  1715. the text of the first block of the operation
  1716. (that is, the contents of
  1717. a quote, the regex of a match or substitution or the target list of a
  1718. translation),
  1720. =item [6]
  1722. the right delimiter of the first block of the operation,
  1724. =item [7]
  1726. the left delimiter of the second block of the operation
  1727. (that is, if it is a C<s>, C<tr>, or C<y>),
  1729. =item [8]
  1731. the text of the second block of the operation 
  1732. (that is, the replacement of a substitution or the translation list
  1733. of a translation),
  1735. =item [9]
  1737. the right delimiter of the second block of the operation (if any),
  1739. =item [10]
  1741. the trailing modifiers on the operation (if any).
  1743. =back
  1745. For each of the fields marked "(if any)" the default value on success is
  1746. an empty string.
  1747. On failure, all of these values (except the remaining text) are C<undef>.
  1750. In a scalar context, C<extract_quotelike> returns just the complete substring
  1751. that matched a quotelike operation (or C<undef> on failure). In a scalar or
  1752. void context, the input text has the same substring (and any specified
  1753. prefix) removed.
  1755. Examples:
  1757.         # Remove the first quotelike literal that appears in text
  1759.                 $quotelike = extract_quotelike($text,'.*?');
  1761.         # Replace one or more leading whitespace-separated quotelike
  1762.         # literals in $_ with "<QLL>"
  1764.                 do { $_ = join '<QLL>', (extract_quotelike)[2,1] } until $@;
  1767.         # Isolate the search pattern in a quotelike operation from $text
  1769.                 ($op,$pat) = (extract_quotelike $text)[3,5];
  1770.                 if ($op =~ /[ms]/)
  1771.                 {
  1772.                         print "search pattern: $patn";
  1773.                 }
  1774.                 else
  1775.                 {
  1776.                         print "$op is not a pattern matching operationn";
  1777.                 }
  1780. =head2 C<extract_quotelike> and "here documents"
  1782. C<extract_quotelike> can successfully extract "here documents" from an input
  1783. string, but with an important caveat in list contexts.
  1785. Unlike other types of quote-like literals, a here document is rarely
  1786. a contiguous substring. For example, a typical piece of code using
  1787. here document might look like this:
  1789.         <<'EOMSG' || die;
  1790.         This is the message.
  1791.         EOMSG
  1792.         exit;
  1794. Given this as an input string in a scalar context, C<extract_quotelike>
  1795. would correctly return the string "<<'EOMSG'nThis is the message.nEOMSG",
  1796. leaving the string " || die;nexit;" in the original variable. In other words,
  1797. the two separate pieces of the here document are successfully extracted and
  1798. concatenated.
  1800. In a list context, C<extract_quotelike> would return the list
  1802. =over 4
  1804. =item [0]
  1806. "<<'EOMSG'nThis is the message.nEOMSGn" (i.e. the full extracted here document,
  1807. including fore and aft delimiters),
  1809. =item [1]
  1811. " || die;nexit;" (i.e. the remainder of the input text, concatenated),
  1813. =item [2]
  1815. "" (i.e. the prefix substring -- trivial in this case),
  1817. =item [3]
  1819. "<<" (i.e. the "name" of the quotelike operator)
  1821. =item [4]
  1823. "'EOMSG'" (i.e. the left delimiter of the here document, including any quotes),
  1825. =item [5]
  1827. "This is the message.n" (i.e. the text of the here document),
  1829. =item [6]
  1831. "EOMSG" (i.e. the right delimiter of the here document),
  1833. =item [7..10]
  1835. "" (a here document has no second left delimiter, second text, second right
  1836. delimiter, or trailing modifiers).
  1838. =back
  1840. However, the matching position of the input variable would be set to
  1841. "exit;" (i.e. I<after> the closing delimiter of the here document),
  1842. which would cause the earlier " || die;nexit;" to be skipped in any
  1843. sequence of code fragment extractions.
  1845. To avoid this problem, when it encounters a here document whilst
  1846. extracting from a modifiable string, C<extract_quotelike> silently
  1847. rearranges the string to an equivalent piece of Perl:
  1849.         <<'EOMSG'
  1850.         This is the message.
  1851.         EOMSG
  1852.         || die;
  1853.         exit;
  1855. in which the here document I<is> contiguous. It still leaves the
  1856. matching position after the here document, but now the rest of the line
  1857. on which the here document starts is not skipped.
  1859. To prevent <extract_quotelike> from mucking about with the input in this way
  1860. (this is the only case where a list-context C<extract_quotelike> does so),
  1861. you can pass the input variable as an interpolated literal:
  1863.         $quotelike = extract_quotelike("$var");
  1866. =head2 C<extract_codeblock>
  1868. C<extract_codeblock> attempts to recognize and extract a balanced
  1869. bracket delimited substring that may contain unbalanced brackets
  1870. inside Perl quotes or quotelike operations. That is, C<extract_codeblock>
  1871. is like a combination of C<"extract_bracketed"> and
  1872. C<"extract_quotelike">.
  1874. C<extract_codeblock> takes the same initial three parameters as C<extract_bracketed>:
  1875. a text to process, a set of delimiter brackets to look for, and a prefix to
  1876. match first. It also takes an optional fourth parameter, which allows the
  1877. outermost delimiter brackets to be specified separately (see below).
  1879. Omitting the first argument (input text) means process C<$_> instead.
  1880. Omitting the second argument (delimiter brackets) indicates that only C<'{'> is to be used.
  1881. Omitting the third argument (prefix argument) implies optional whitespace at the start.
  1882. Omitting the fourth argument (outermost delimiter brackets) indicates that the
  1883. value of the second argument is to be used for the outermost delimiters.
  1885. Once the prefix an dthe outermost opening delimiter bracket have been
  1886. recognized, code blocks are extracted by stepping through the input text and
  1887. trying the following alternatives in sequence:
  1889. =over 4
  1891. =item 1.
  1893. Try and match a closing delimiter bracket. If the bracket was the same
  1894. species as the last opening bracket, return the substring to that
  1895. point. If the bracket was mismatched, return an error.
  1897. =item 2.
  1899. Try to match a quote or quotelike operator. If found, call
  1900. C<extract_quotelike> to eat it. If C<extract_quotelike> fails, return
  1901. the error it returned. Otherwise go back to step 1.
  1903. =item 3.
  1905. Try to match an opening delimiter bracket. If found, call
  1906. C<extract_codeblock> recursively to eat the embedded block. If the
  1907. recursive call fails, return an error. Otherwise, go back to step 1.
  1909. =item 4.
  1911. Unconditionally match a bareword or any other single character, and
  1912. then go back to step 1.
  1914. =back
  1917. Examples:
  1919.         # Find a while loop in the text
  1921.                 if ($text =~ s/.*?whiles*{/{/)
  1922.                 {
  1923.                         $loop = "while " . extract_codeblock($text);
  1924.                 }
  1926.         # Remove the first round-bracketed list (which may include
  1927.         # round- or curly-bracketed code blocks or quotelike operators)
  1929.                 extract_codeblock $text, "(){}", '[^(]*';
  1932. The ability to specify a different outermost delimiter bracket is useful
  1933. in some circumstances. For example, in the Parse::RecDescent module,
  1934. parser actions which are to be performed only on a successful parse
  1935. are specified using a C<E<lt>defer:...E<gt>> directive. For example:
  1937.         sentence: subject verb object
  1938.                         <defer: {$::theVerb = $item{verb}} >
  1940. Parse::RecDescent uses C<extract_codeblock($text, '{}E<lt>E<gt>')> to extract the code
  1941. within the C<E<lt>defer:...E<gt>> directive, but there's a problem.
  1943. A deferred action like this:
  1945.                         <defer: {if ($count>10) {$count--}} >
  1947. will be incorrectly parsed as:
  1949.                         <defer: {if ($count>
  1951. because the "less than" operator is interpreted as a closing delimiter.
  1953. But, by extracting the directive using
  1954. S<C<extract_codeblock($text, '{}', undef, 'E<lt>E<gt>')>>
  1955. the '>' character is only treated as a delimited at the outermost
  1956. level of the code block, so the directive is parsed correctly.
  1958. =head2 C<extract_multiple>
  1960. The C<extract_multiple> subroutine takes a string to be processed and a 
  1961. list of extractors (subroutines or regular expressions) to apply to that string.
  1963. In an array context C<extract_multiple> returns an array of substrings
  1964. of the original string, as extracted by the specified extractors.
  1965. In a scalar context, C<extract_multiple> returns the first
  1966. substring successfully extracted from the original string. In both
  1967. scalar and void contexts the original string has the first successfully
  1968. extracted substring removed from it. In all contexts
  1969. C<extract_multiple> starts at the current C<pos> of the string, and
  1970. sets that C<pos> appropriately after it matches.
  1972. Hence, the aim of of a call to C<extract_multiple> in a list context
  1973. is to split the processed string into as many non-overlapping fields as
  1974. possible, by repeatedly applying each of the specified extractors
  1975. to the remainder of the string. Thus C<extract_multiple> is
  1976. a generalized form of Perl's C<split> subroutine.
  1978. The subroutine takes up to four optional arguments:
  1980. =over 4
  1982. =item 1.
  1984. A string to be processed (C<$_> if the string is omitted or C<undef>)
  1986. =item 2.
  1988. A reference to a list of subroutine references and/or qr// objects and/or
  1989. literal strings and/or hash references, specifying the extractors
  1990. to be used to split the string. If this argument is omitted (or
  1991. C<undef>) the list:
  1993.         [
  1994.                 sub { extract_variable($_[0], '') },
  1995.                 sub { extract_quotelike($_[0],'') },
  1996.                 sub { extract_codeblock($_[0],'{}','') },
  1997.         ]
  1999. is used.
  2002. =item 3.
  2004. An number specifying the maximum number of fields to return. If this
  2005. argument is omitted (or C<undef>), split continues as long as possible.
  2007. If the third argument is I<N>, then extraction continues until I<N> fields
  2008. have been successfully extracted, or until the string has been completely 
  2009. processed.
  2011. Note that in scalar and void contexts the value of this argument is 
  2012. automatically reset to 1 (under C<-w>, a warning is issued if the argument 
  2013. has to be reset).
  2015. =item 4.
  2017. A value indicating whether unmatched substrings (see below) within the
  2018. text should be skipped or returned as fields. If the value is true,
  2019. such substrings are skipped. Otherwise, they are returned.
  2021. =back
  2023. The extraction process works by applying each extractor in
  2024. sequence to the text string.
  2026. If the extractor is a subroutine it is called in a list context and is
  2027. expected to return a list of a single element, namely the extracted
  2028. text. It may optionally also return two further arguments: a string
  2029. representing the text left after extraction (like $' for a pattern
  2030. match), and a string representing any prefix skipped before the
  2031. extraction (like $` in a pattern match). Note that this is designed
  2032. to facilitate the use of other Text::Balanced subroutines with
  2033. C<extract_multiple>. Note too that the value returned by an extractor
  2034. subroutine need not bear any relationship to the corresponding substring
  2035. of the original text (see examples below).
  2037. If the extractor is a precompiled regular expression or a string,
  2038. it is matched against the text in a scalar context with a leading
  2039. 'G' and the gc modifiers enabled. The extracted value is either
  2040. $1 if that variable is defined after the match, or else the
  2041. complete match (i.e. $&).
  2043. If the extractor is a hash reference, it must contain exactly one element.
  2044. The value of that element is one of the
  2045. above extractor types (subroutine reference, regular expression, or string).
  2046. The key of that element is the name of a class into which the successful
  2047. return value of the extractor will be blessed.
  2049. If an extractor returns a defined value, that value is immediately
  2050. treated as the next extracted field and pushed onto the list of fields.
  2051. If the extractor was specified in a hash reference, the field is also
  2052. blessed into the appropriate class, 
  2054. If the extractor fails to match (in the case of a regex extractor), or returns an empty list or an undefined value (in the case of a subroutine extractor), it is
  2055. assumed to have failed to extract.
  2056. If none of the extractor subroutines succeeds, then one
  2057. character is extracted from the start of the text and the extraction
  2058. subroutines reapplied. Characters which are thus removed are accumulated and
  2059. eventually become the next field (unless the fourth argument is true, in which
  2060. case they are discarded).
  2062. For example, the following extracts substrings that are valid Perl variables:
  2064.         @fields = extract_multiple($text,
  2065.                                    [ sub { extract_variable($_[0]) } ],
  2066.                                    undef, 1);
  2068. This example separates a text into fields which are quote delimited,
  2069. curly bracketed, and anything else. The delimited and bracketed
  2070. parts are also blessed to identify them (the "anything else" is unblessed):
  2072.         @fields = extract_multiple($text,
  2073.                    [
  2074.                         { Delim => sub { extract_delimited($_[0],q{'"}) } },
  2075.                         { Brack => sub { extract_bracketed($_[0],'{}') } },
  2076.                    ]);
  2078. This call extracts the next single substring that is a valid Perl quotelike
  2079. operator (and removes it from $text):
  2081.         $quotelike = extract_multiple($text,
  2082.                                       [
  2083.                                         sub { extract_quotelike($_[0]) },
  2084.                                       ], undef, 1);
  2086. Finally, here is yet another way to do comma-separated value parsing:
  2088.         @fields = extract_multiple($csv_text,
  2089.                                   [
  2090.                                         sub { extract_delimited($_[0],q{'"}) },
  2091.                                         qr/([^,]+)(.*)/,
  2092.                                   ],
  2093.                                   undef,1);
  2095. The list in the second argument means:
  2096. I<"Try and extract a ' or " delimited string, otherwise extract anything up to a comma...">.
  2097. The undef third argument means:
  2098. I<"...as many times as possible...">,
  2099. and the true value in the fourth argument means
  2100. I<"...discarding anything else that appears (i.e. the commas)">.
  2102. If you wanted the commas preserved as separate fields (i.e. like split
  2103. does if your split pattern has capturing parentheses), you would
  2104. just make the last parameter undefined (or remove it).
  2107. =head2 C<gen_delimited_pat>
  2109. The C<gen_delimited_pat> subroutine takes a single (string) argument and
  2110.    > builds a Friedl-style optimized regex that matches a string delimited
  2111. by any one of the characters in the single argument. For example:
  2113.         gen_delimited_pat(q{'"})
  2115. returns the regex:
  2117.         (?:"(?:\"|(?!").)*"|'(?:\'|(?!').)*')
  2119. Note that the specified delimiters are automatically quotemeta'd.
  2121. A typical use of C<gen_delimited_pat> would be to build special purpose tags
  2122. for C<extract_tagged>. For example, to properly ignore "empty" XML elements
  2123. (which might contain quoted strings):
  2125.         my $empty_tag = '<(' . gen_delimited_pat(q{'"}) . '|.)+/>';
  2127.         extract_tagged($text, undef, undef, undef, {ignore => [$empty_tag]} );
  2130. C<gen_delimited_pat> may also be called with an optional second argument,
  2131. which specifies the "escape" character(s) to be used for each delimiter.
  2132. For example to match a Pascal-style string (where ' is the delimiter
  2133. and '' is a literal ' within the string):
  2135.         gen_delimited_pat(q{'},q{'});
  2137. Different escape characters can be specified for different delimiters.
  2138. For example, to specify that '/' is the escape for single quotes
  2139. and '%' is the escape for double quotes:
  2141.         gen_delimited_pat(q{'"},q{/%});
  2143. If more delimiters than escape chars are specified, the last escape char
  2144. is used for the remaining delimiters.
  2145. If no escape char is specified for a given specified delimiter, '' is used.
  2147. =head2 C<delimited_pat>
  2149. Note that C<gen_delimited_pat> was previously called C<delimited_pat>.
  2150. That name may still be used, but is now deprecated.
  2151.         
  2153. =head1 DIAGNOSTICS
  2155. In a list context, all the functions return C<(undef,$original_text)>
  2156. on failure. In a scalar context, failure is indicated by returning C<undef>
  2157. (in this case the input text is not modified in any way).
  2159. In addition, on failure in I<any> context, the C<$@> variable is set.
  2160. Accessing C<$@-E<gt>{error}> returns one of the error diagnostics listed
  2161. below.
  2162. Accessing C<$@-E<gt>{pos}> returns the offset into the original string at
  2163. which the error was detected (although not necessarily where it occurred!)
  2164. Printing C<$@> directly produces the error message, with the offset appended.
  2165. On success, the C<$@> variable is guaranteed to be C<undef>.
  2167. The available diagnostics are:
  2169. =over 4
  2171. =item  C<Did not find a suitable bracket: "%s">
  2173. The delimiter provided to C<extract_bracketed> was not one of
  2174. C<'()[]E<lt>E<gt>{}'>.
  2176. =item  C<Did not find prefix: /%s/>
  2178. A non-optional prefix was specified but wasn't found at the start of the text.
  2180. =item  C<Did not find opening bracket after prefix: "%s">
  2182. C<extract_bracketed> or C<extract_codeblock> was expecting a
  2183. particular kind of bracket at the start of the text, and didn't find it.
  2185. =item  C<No quotelike operator found after prefix: "%s">
  2187. C<extract_quotelike> didn't find one of the quotelike operators C<q>,
  2188. C<qq>, C<qw>, C<qx>, C<s>, C<tr> or C<y> at the start of the substring
  2189. it was extracting.
  2191. =item  C<Unmatched closing bracket: "%c">
  2193. C<extract_bracketed>, C<extract_quotelike> or C<extract_codeblock> encountered
  2194. a closing bracket where none was expected.
  2196. =item  C<Unmatched opening bracket(s): "%s">
  2198. C<extract_bracketed>, C<extract_quotelike> or C<extract_codeblock> ran 
  2199. out of characters in the text before closing one or more levels of nested
  2200. brackets.
  2202. =item C<Unmatched embedded quote (%s)>
  2204. C<extract_bracketed> attempted to match an embedded quoted substring, but
  2205. failed to find a closing quote to match it.
  2207. =item C<Did not find closing delimiter to match '%s'>
  2209. C<extract_quotelike> was unable to find a closing delimiter to match the
  2210. one that opened the quote-like operation.
  2212. =item  C<Mismatched closing bracket: expected "%c" but found "%s">
  2214. C<extract_bracketed>, C<extract_quotelike> or C<extract_codeblock> found
  2215. a valid bracket delimiter, but it was the wrong species. This usually
  2216. indicates a nesting error, but may indicate incorrect quoting or escaping.
  2218. =item  C<No block delimiter found after quotelike "%s">
  2220. C<extract_quotelike> or C<extract_codeblock> found one of the
  2221. quotelike operators C<q>, C<qq>, C<qw>, C<qx>, C<s>, C<tr> or C<y>
  2222. without a suitable block after it.
  2224. =item C<Did not find leading dereferencer>
  2226. C<extract_variable> was expecting one of '$', '@', or '%' at the start of
  2227. a variable, but didn't find any of them.
  2229. =item C<Bad identifier after dereferencer>
  2231. C<extract_variable> found a '$', '@', or '%' indicating a variable, but that
  2232. character was not followed by a legal Perl identifier.
  2234. =item C<Did not find expected opening bracket at %s>
  2236. C<extract_codeblock> failed to find any of the outermost opening brackets
  2237. that were specified.
  2239. =item C<Improperly nested codeblock at %s>
  2241. A nested code block was found that started with a delimiter that was specified
  2242. as being only to be used as an outermost bracket.
  2244. =item  C<Missing second block for quotelike "%s">
  2246. C<extract_codeblock> or C<extract_quotelike> found one of the
  2247. quotelike operators C<s>, C<tr> or C<y> followed by only one block.
  2249. =item C<No match found for opening bracket>
  2251. C<extract_codeblock> failed to find a closing bracket to match the outermost
  2252. opening bracket.
  2254. =item C<Did not find opening tag: /%s/>
  2256. C<extract_tagged> did not find a suitable opening tag (after any specified
  2257. prefix was removed).
  2259. =item C<Unable to construct closing tag to match: /%s/>
  2261. C<extract_tagged> matched the specified opening tag and tried to
  2262. modify the matched text to produce a matching closing tag (because
  2263. none was specified). It failed to generate the closing tag, almost
  2264. certainly because the opening tag did not start with a
  2265. bracket of some kind.
  2267. =item C<Found invalid nested tag: %s>
  2269. C<extract_tagged> found a nested tag that appeared in the "reject" list
  2270. (and the failure mode was not "MAX" or "PARA").
  2272. =item C<Found unbalanced nested tag: %s>
  2274. C<extract_tagged> found a nested opening tag that was not matched by a
  2275. corresponding nested closing tag (and the failure mode was not "MAX" or "PARA").
  2277. =item C<Did not find closing tag>
  2279. C<extract_tagged> reached the end of the text without finding a closing tag
  2280. to match the original opening tag (and the failure mode was not
  2281. "MAX" or "PARA").
  2286. =back
  2289. =head1 AUTHOR
  2291. Damian Conway (damian@conway.org)
  2294. =head1 BUGS AND IRRITATIONS
  2296. There are undoubtedly serious bugs lurking somewhere in this code, if
  2297. only because parts of it give the impression of understanding a great deal
  2298. more about Perl than they really do. 
  2300. Bug reports and other feedback are most welcome.
  2303. =head1 COPYRIGHT
  2305.  Copyright (c) 1997-2001, Damian Conway. All Rights Reserved.
  2306.  This module is free software. It may be used, redistributed
  2307.      and/or modified under the same terms as Perl itself.