X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FSQL%2FAbstract%2FTree.pm;h=0c45aa0347cdf12ec07a7f1949398231030b89f3;hb=0769ac0e4022d40ded0dff13abe292d4867c9d09;hp=c5abe2877140980807aabced6946a1951feca1a5;hpb=bc4820853ac72f9a564e40f7b8fbe76d05c8cbbd;p=dbsrgits%2FSQL-Abstract.git diff --git a/lib/SQL/Abstract/Tree.pm b/lib/SQL/Abstract/Tree.pm index c5abe28..0c45aa0 100644 --- a/lib/SQL/Abstract/Tree.pm +++ b/lib/SQL/Abstract/Tree.pm @@ -4,8 +4,14 @@ use strict; use warnings; use Carp; -use List::Util; -use Hash::Merge; +use Hash::Merge qw//; + +use base 'Class::Accessor::Grouped'; + +__PACKAGE__->mk_group_accessors( simple => $_ ) for qw( + newline indent_string indent_amount colormap indentmap fill_in_placeholders + placeholder_surround +); my $merger = Hash::Merge->new; @@ -25,26 +31,27 @@ $merger->specify_behavior({ ARRAY => sub { [ values %{$_[0]}, @{$_[1]} ] }, HASH => sub { Hash::Merge::_merge_hashes( $_[0], $_[1] ) }, }, -}, 'My Behavior' ); +}, 'SQLA::Tree Behavior' ); -use base 'Class::Accessor::Grouped'; - -__PACKAGE__->mk_group_accessors( simple => $_ ) for qw( - newline indent_string indent_amount colormap indentmap fill_in_placeholders -); # Parser states for _recurse_parse() use constant PARSE_TOP_LEVEL => 0; use constant PARSE_IN_EXPR => 1; use constant PARSE_IN_PARENS => 2; use constant PARSE_RHS => 3; +use constant PARSE_IN_FUNC => 4; + +my $op_look_ahead = '(?: (?= [\s\)\(\;] ) | \z)'; +my $op_look_behind = '(?: (?<= [\s\)\(] ) | \A )'; +my $quote_left = qr/[\`\'\"\[]/; +my $quote_right = qr/[\`\'\"\]]/; # These SQL keywords always signal end of the current expression (except inside # of a parenthesized subexpression). -# Format: A list of strings that will be compiled to extended syntax (ie. +# Format: A list of strings that will be compiled to extended syntax ie. # /.../x) regexes, without capturing parentheses. They will be automatically -# anchored to word boundaries to match the whole token). -my @expression_terminator_sql_keywords = ( +# anchored to op boundaries (excluding quotes) to match the whole token. +my @expression_start_keywords = ( 'SELECT', 'UPDATE', 'INSERT \s+ INTO', @@ -53,8 +60,8 @@ my @expression_terminator_sql_keywords = ( 'SET', '(?: (?: - (?: \b (?: LEFT | RIGHT | FULL ) \s+ )? - (?: \b (?: CROSS | INNER | OUTER ) \s+ )? + (?: (?: LEFT | RIGHT | FULL ) \s+ )? + (?: (?: CROSS | INNER | OUTER ) \s+ )? )? JOIN )', @@ -75,35 +82,45 @@ my @expression_terminator_sql_keywords = ( 'ROW_NUMBER \s* \( \s* \) \s+ OVER', ); +my $exp_start_re = join ("\n\t|\n", @expression_start_keywords ); +$exp_start_re = qr/ $op_look_behind (?i: $exp_start_re ) $op_look_ahead /xo; + # These are binary operator keywords always a single LHS and RHS # * AND/OR are handled separately as they are N-ary # * so is NOT as being unary # * BETWEEN without paranthesis around the ANDed arguments (which # makes it a non-binary op) is detected and accomodated in # _recurse_parse() -my $stuff_around_mathops = qr/[\w\s\`\'\"\)]/; -my @binary_op_keywords = ( - ( map - { - ' ^ ' . quotemeta ($_) . "(?= \$ | $stuff_around_mathops ) ", - " (?<= $stuff_around_mathops)" . quotemeta ($_) . "(?= \$ | $stuff_around_mathops ) ", - } - (qw/< > != <> = <= >=/) - ), - ( map - { '\b (?: NOT \s+)?' . $_ . '\b' } - (qw/IN BETWEEN LIKE/) - ), -); -my $tokenizer_re_str = join("\n\t|\n", - ( map { '\b' . $_ . '\b' } @expression_terminator_sql_keywords, 'AND', 'OR', 'NOT'), - @binary_op_keywords, +# this will be included in the $binary_op_re, the distinction is interesting during +# testing as one is tighter than the other, plus mathops have different look +# ahead/behind (e.g. "x"="y" ) +my @math_op_keywords = (qw/ < > != <> = <= >= /); +my $math_re = join ("\n\t|\n", map + { "(?: (?<= [\\w\\s] | $quote_right ) | \\A )" . quotemeta ($_) . "(?: (?= [\\w\\s] | $quote_left ) | \\z )" } + @math_op_keywords ); +$math_re = qr/$math_re/xo; + +sub _math_op_re { $math_re } + -my $tokenizer_re = qr/ \s* ( $tokenizer_re_str | \( | \) | \? ) \s* /xi; +my $binary_op_re = '(?: NOT \s+)? (?:' . join ('|', qw/IN BETWEEN R?LIKE/) . ')'; +$binary_op_re = "(?: $op_look_behind (?i: $binary_op_re ) $op_look_ahead ) \n\t|\n $math_re"; +$binary_op_re = qr/$binary_op_re/xo; -sub _binary_op_keywords { @binary_op_keywords } +sub _binary_op_re { $binary_op_re } + + +my $tokenizer_re = join("\n\t|\n", + $exp_start_re, + $binary_op_re, + "$op_look_behind (?i: AND|OR|NOT ) $op_look_ahead", + (map { quotemeta $_ } qw/( ) ? */), +); + +#this one *is* capturing +$tokenizer_re = qr/ \s* ( $tokenizer_re ) \s* /x; my %indents = ( select => 0, @@ -125,14 +142,43 @@ my %indents = ( my %profiles = ( console => { fill_in_placeholders => 1, + placeholder_surround => ['?/', ''], indent_string => ' ', indent_amount => 2, newline => "\n", colormap => {}, indentmap => { %indents }, + + eval { require Term::ANSIColor } + ? do { + my $c = \&Term::ANSIColor::color; + ( + placeholder_surround => [$c->('black on_cyan'), $c->('reset')], + colormap => { + select => [$c->('red'), $c->('reset')], + 'insert into' => [$c->('red'), $c->('reset')], + update => [$c->('red'), $c->('reset')], + 'delete from' => [$c->('red'), $c->('reset')], + + set => [$c->('cyan'), $c->('reset')], + from => [$c->('cyan'), $c->('reset')], + + where => [$c->('green'), $c->('reset')], + values => [$c->('yellow'), $c->('reset')], + + join => [$c->('magenta'), $c->('reset')], + 'left join' => [$c->('magenta'), $c->('reset')], + on => [$c->('blue'), $c->('reset')], + + 'group by' => [$c->('yellow'), $c->('reset')], + 'order by' => [$c->('yellow'), $c->('reset')], + } + ); + } : (), }, console_monochrome => { fill_in_placeholders => 1, + placeholder_surround => ['?/', ''], indent_string => ' ', indent_amount => 2, newline => "\n", @@ -141,6 +187,7 @@ my %profiles = ( }, html => { fill_in_placeholders => 1, + placeholder_surround => ['', ''], indent_string => ' ', indent_amount => 2, newline => "
\n", @@ -167,29 +214,6 @@ my %profiles = ( }, ); -eval { - require Term::ANSIColor; - $profiles{console}->{colormap} = { - select => [Term::ANSIColor::color('red'), Term::ANSIColor::color('reset')], - 'insert into' => [Term::ANSIColor::color('red'), Term::ANSIColor::color('reset')], - update => [Term::ANSIColor::color('red'), Term::ANSIColor::color('reset')], - 'delete from' => [Term::ANSIColor::color('red'), Term::ANSIColor::color('reset')], - - set => [Term::ANSIColor::color('cyan'), Term::ANSIColor::color('reset')], - from => [Term::ANSIColor::color('cyan'), Term::ANSIColor::color('reset')], - - where => [Term::ANSIColor::color('green'), Term::ANSIColor::color('reset')], - values => [Term::ANSIColor::color('yellow'), Term::ANSIColor::color('reset')], - - join => [Term::ANSIColor::color('magenta'), Term::ANSIColor::color('reset')], - 'left join' => [Term::ANSIColor::color('magenta'), Term::ANSIColor::color('reset')], - on => [Term::ANSIColor::color('blue'), Term::ANSIColor::color('reset')], - - 'group by' => [Term::ANSIColor::color('yellow'), Term::ANSIColor::color('reset')], - 'order by' => [Term::ANSIColor::color('yellow'), Term::ANSIColor::color('reset')], - }; -}; - sub new { my $class = shift; my $args = shift || {}; @@ -224,11 +248,13 @@ sub _recurse_parse { or ($state == PARSE_IN_PARENS && $lookahead eq ')') or - ($state == PARSE_IN_EXPR && grep { $lookahead =~ /^ $_ $/xi } ('\)', @expression_terminator_sql_keywords ) ) + ($state == PARSE_IN_EXPR && $lookahead =~ qr/ ^ (?: $exp_start_re | \) ) $ /x ) or - ($state == PARSE_RHS && grep { $lookahead =~ /^ $_ $/xi } ('\)', @expression_terminator_sql_keywords, @binary_op_keywords, 'AND', 'OR', 'NOT' ) ) + ($state == PARSE_RHS && $lookahead =~ qr/ ^ (?: $exp_start_re | $binary_op_re | (?i: AND | OR | NOT ) | \) ) $ /x ) + or + ($state == PARSE_IN_FUNC && $lookahead ne '(') ) { - return $left; + return $left||(); } my $token = shift @$tokens; @@ -239,8 +265,8 @@ sub _recurse_parse { $token = shift @$tokens or croak "missing closing ')' around block " . $self->unparse($right); $token eq ')' or croak "unexpected token '$token' terminating block " . $self->unparse($right); - $left = $left ? [@$left, [PAREN => [$right] ]] - : [PAREN => [$right] ]; + $left = $left ? [$left, [PAREN => [$right||()] ]] + : [PAREN => [$right||()] ]; } # AND/OR elsif ($token =~ /^ (?: OR | AND ) $/xi ) { @@ -256,7 +282,7 @@ sub _recurse_parse { } } # binary operator keywords - elsif (grep { $token =~ /^ $_ $/xi } @binary_op_keywords ) { + elsif ( $token =~ /^ $$binary_op_re $ /x ) { my $op = uc $token; my $right = $self->_recurse_parse($tokens, PARSE_RHS); @@ -270,20 +296,27 @@ sub _recurse_parse { $left = [$op => [$left, $right] ]; } # expression terminator keywords (as they start a new expression) - elsif (grep { $token =~ /^ $_ $/xi } @expression_terminator_sql_keywords ) { + elsif ( $token =~ / ^ $exp_start_re $ /x ) { my $op = uc $token; my $right = $self->_recurse_parse($tokens, PARSE_IN_EXPR); $left = $left ? [ $left, [$op => [$right] ]] - : [ $op => [$right] ]; + : [ $op => [$right] ]; } - # NOT (last as to allow all other NOT X pieces first) - elsif ( $token =~ /^ not $/ix ) { + # NOT + elsif ( $token =~ /^ NOT $/ix ) { my $op = uc $token; my $right = $self->_recurse_parse ($tokens, PARSE_RHS); $left = $left ? [ @$left, [$op => [$right] ]] : [ $op => [$right] ]; } + # generic function + elsif (@$tokens && $tokens->[0] eq '(') { + my $right = $self->_recurse_parse($tokens, PARSE_IN_FUNC); + + $left = $left ? [ $left, [ $token => [$right||()] ]] + : [ $token => [$right||()] ]; + } # literal (eat everything on the right until RHS termination) else { my $right = $self->_recurse_parse ($tokens, PARSE_RHS); @@ -310,7 +343,7 @@ my %starters = ( 'delete from' => 1, ); -sub whitespace { +sub pad_keyword { my ($self, $keyword, $depth) = @_; my $before = ''; @@ -330,14 +363,15 @@ sub _is_key { defined $tree && defined $self->indentmap->{lc $tree}; } -sub _fill_in_placeholder { +sub fill_in_placeholder { my ($self, $bindargs) = @_; if ($self->fill_in_placeholders) { my $val = pop @{$bindargs} || ''; + my ($left, $right) = @{$self->placeholder_surround}; $val =~ s/\\/\\\\/g; $val =~ s/'/\\'/g; - return qq('$val') + return qq('$left$val$right') } return '?' } @@ -347,19 +381,25 @@ sub unparse { $depth ||= 0; - if (not $tree ) { + if (not $tree or not @$tree) { return ''; } - my $car = $tree->[0]; - my $cdr = $tree->[1]; + my ($car, $cdr) = @{$tree}[0,1]; + + if (! defined $car or (! ref $car and ! defined $cdr) ) { + require Data::Dumper; + Carp::confess( sprintf ( "Internal error - malformed branch at depth $depth:\n%s", + Data::Dumper::Dumper($tree) + ) ); + } if (ref $car) { return join ('', map $self->unparse($_, $bindargs, $depth), @$tree); } elsif ($car eq 'LITERAL') { if ($cdr->[0] eq '?') { - return $self->_fill_in_placeholder($bindargs) + return $self->fill_in_placeholder($bindargs) } return $cdr->[0]; } @@ -369,11 +409,11 @@ sub unparse { map $self->unparse($_, $bindargs, $depth + 2), @{$cdr}) . ($self->_is_key($cdr)?( $self->newline||'' ).$self->indent($depth + 1):'') . ') '; } - elsif ($car eq 'OR' or $car eq 'AND' or (grep { $car =~ /^ $_ $/xi } @binary_op_keywords ) ) { + elsif ($car eq 'AND' or $car eq 'OR' or $car =~ / ^ $binary_op_re $ /x ) { return join (" $car ", map $self->unparse($_, $bindargs, $depth), @{$cdr}); } else { - my ($l, $r) = @{$self->whitespace($car, $depth)}; + my ($l, $r) = @{$self->pad_keyword($car, $depth)}; return sprintf "$l%s %s$r", $self->format_keyword($car), $self->unparse($cdr, $bindargs, $depth); } } @@ -403,6 +443,8 @@ sub format { my $self = shift; $self->unparse($self->parse($_[0]), $_[1]) } $args = { profile => 'console', # predefined profile to use (default: 'none') fill_in_placeholders => 1, # true for placeholder population + placeholder_surround => # The strings that will be wrapped around + [GREEN, RESET], # populated placeholders if the above is set indent_string => ' ', # the string used when indenting indent_amount => 2, # how many of above string to use for a single # indent level @@ -437,3 +479,71 @@ use the profile and override the parts that you don't like. Takes C<$sql> and C<\@bindargs>. Returns a formatting string based on the string passed in + +=head2 parse + + $sqlat->parse('SELECT * FROM bar WHERE x = ?') + +Returns a "tree" representing passed in SQL. Please do not depend on the +structure of the returned tree. It may be stable at some point, but not yet. + +=head2 unparse + + $sqlat->parse($tree_structure, \@bindargs) + +Transform "tree" into SQL, applying various transforms on the way. + +=head2 format_keyword + + $sqlat->format_keyword('SELECT') + +Currently this just takes a keyword and puts the C stuff around it. +Later on it may do more and allow for coderef based transforms. + +=head2 pad_keyword + + my ($before, $after) = @{$sqlat->pad_keyword('SELECT')}; + +Returns whitespace to be inserted around a keyword. + +=head2 fill_in_placeholder + + my $value = $sqlat->fill_in_placeholder(\@bindargs) + +Removes last arg from passed arrayref and returns it, surrounded with +the values in placeholder_surround, and then surrounded with single quotes. + +=head2 indent + +Returns as many indent strings as indent amounts times the first argument. + +=head1 ACCESSORS + +=head2 colormap + +See L + +=head2 fill_in_placeholders + +See L + +=head2 indent_amount + +See L + +=head2 indent_string + +See L + +=head2 indentmap + +See L + +=head2 newline + +See L + +=head2 placeholder_surround + +See L +