use warnings;
use Carp;
+
+use base 'Class::Accessor::Grouped';
+
+__PACKAGE__->mk_group_accessors( simple => $_ ) for qw(
+ newline indent_string indent_amount colormap indentmap
+);
+
# Parser states for _recurse_parse()
use constant PARSE_TOP_LEVEL => 0;
use constant PARSE_IN_EXPR => 1;
sub _binary_op_keywords { @binary_op_keywords }
+my %indents = (
+ select => 0,
+ where => 1,
+ from => 1,
+ join => 1,
+ on => 2,
+ 'group by' => 1,
+);
+
+my %profiles = (
+ console => {
+ indent_string => ' ',
+ indent_amount => 2,
+ newline => "\n",
+ colormap => {},
+ indentmap => { %indents },
+ },
+ console_monochrome => {
+ indent_string => ' ',
+ indent_amount => 2,
+ newline => "\n",
+ colormap => {},
+ indentmap => { %indents },
+ },
+ html => {
+ indent_string => ' ',
+ indent_amount => 2,
+ newline => "<br />\n",
+ colormap => {
+ select => ['<span class="select">' , '</span>'],
+ where => ['<span class="where">' , '</span>'],
+ from => ['<span class="from">' , '</span>'],
+ join => ['<span class="join">' , '</span>'],
+ on => ['<span class="on">' , '</span>'],
+ 'group by' => ['<span class="group-by">', '</span>'],
+ },
+ indentmap => { %indents },
+ },
+ none => {
+ colormap => {},
+ indentmap => {},
+ },
+);
+
+eval {
+ require Term::ANSIColor;
+ $profiles{console}->{colormap} = {
+ select => [Term::ANSIColor::color('red'), Term::ANSIColor::color('reset')],
+ where => [Term::ANSIColor::color('green'), Term::ANSIColor::color('reset')],
+ from => [Term::ANSIColor::color('cyan'), Term::ANSIColor::color('reset')],
+ };
+};
+
+sub new {
+ my ($class, $args) = @_;
+
+ my $profile = delete $args->{profile} || 'none';
+ my $data = {%{$profiles{$profile}}, %{$args||{}}};
+
+ bless $data, $class
+}
+
sub parse {
- my $s = shift;
+ my ($self, $s) = @_;
# tokenize string, and remove all optional whitespace
my $tokens = [];
push @$tokens, $token if (length $token) && ($token =~ /\S/);
}
- my $tree = _recurse_parse($tokens, PARSE_TOP_LEVEL);
+ my $tree = $self->_recurse_parse($tokens, PARSE_TOP_LEVEL);
return $tree;
}
sub _recurse_parse {
- my ($tokens, $state) = @_;
+ my ($self, $tokens, $state) = @_;
my $left;
while (1) { # left-associative parsing
# nested expression in ()
if ($token eq '(' ) {
- my $right = _recurse_parse($tokens, PARSE_IN_PARENS);
- $token = shift @$tokens or croak "missing closing ')' around block " . unparse ($right);
- $token eq ')' or croak "unexpected token '$token' terminating block " . unparse ($right);
+ my $right = $self->_recurse_parse($tokens, PARSE_IN_PARENS);
+ $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] ];
# AND/OR
elsif ($token =~ /^ (?: OR | AND ) $/xi ) {
my $op = uc $token;
- my $right = _recurse_parse($tokens, PARSE_IN_EXPR);
+ my $right = $self->_recurse_parse($tokens, PARSE_IN_EXPR);
# Merge chunks if logic matches
if (ref $right and $op eq $right->[0]) {
# binary operator keywords
elsif (grep { $token =~ /^ $_ $/xi } @binary_op_keywords ) {
my $op = uc $token;
- my $right = _recurse_parse($tokens, PARSE_RHS);
+ my $right = $self->_recurse_parse($tokens, PARSE_RHS);
# A between with a simple LITERAL for a 1st RHS argument needs a
# rerun of the search to (hopefully) find the proper AND construct
if ($op eq 'BETWEEN' and $right->[0] eq 'LITERAL') {
unshift @$tokens, $right->[1][0];
- $right = _recurse_parse($tokens, PARSE_IN_EXPR);
+ $right = $self->_recurse_parse($tokens, PARSE_IN_EXPR);
}
$left = [$op => [$left, $right] ];
# expression terminator keywords (as they start a new expression)
elsif (grep { $token =~ /^ $_ $/xi } @expression_terminator_sql_keywords ) {
my $op = uc $token;
- my $right = _recurse_parse($tokens, PARSE_IN_EXPR);
+ my $right = $self->_recurse_parse($tokens, PARSE_IN_EXPR);
$left = $left ? [ $left, [$op => [$right] ]]
: [ $op => [$right] ];
}
# NOT (last as to allow all other NOT X pieces first)
elsif ( $token =~ /^ not $/ix ) {
my $op = uc $token;
- my $right = _recurse_parse ($tokens, PARSE_RHS);
+ my $right = $self->_recurse_parse ($tokens, PARSE_RHS);
$left = $left ? [ @$left, [$op => [$right] ]]
: [ $op => [$right] ];
}
# literal (eat everything on the right until RHS termination)
else {
- my $right = _recurse_parse ($tokens, PARSE_RHS);
- $left = $left ? [ $left, [LITERAL => [join ' ', $token, unparse($right)||()] ] ]
- : [ LITERAL => [join ' ', $token, unparse($right)||()] ];
+ my $right = $self->_recurse_parse ($tokens, PARSE_RHS);
+ $left = $left ? [ $left, [LITERAL => [join ' ', $token, $self->unparse($right)||()] ] ]
+ : [ LITERAL => [join ' ', $token, $self->unparse($right)||()] ];
}
}
}
+sub format_keyword {
+ my ($self, $keyword) = @_;
+
+ if (my $around = $self->colormap->{lc $keyword}) {
+ $keyword = "$around->[0]$keyword$around->[1]";
+ }
+
+ return $keyword
+}
+
+sub whitespace {
+ my ($self, $keyword, $depth) = @_;
+
+ my $before = '';
+ my $after = ' ';
+ if (defined $self->indentmap->{lc $keyword}) {
+ $before = $self->newline . $self->indent($depth + $self->indentmap->{lc $keyword});
+ }
+ $before = '' if $depth == 0 and lc $keyword eq 'select';
+ return [$before, $after];
+}
+
+sub indent { ($_[0]->indent_string||'') x ( ( $_[0]->indent_amount || 0 ) * $_[1] ) }
+
+sub _is_select {
+ my $tree = shift;
+ $tree = $tree->[0] while ref $tree;
+
+ defined $tree && lc $tree eq 'select';
+}
+
sub unparse {
- my $tree = shift;
+ my ($self, $tree, $depth) = @_;
+
+ $depth ||= 0;
if (not $tree ) {
return '';
}
- elsif (ref $tree->[0]) {
- return join (" ", map { unparse ($_) } @$tree);
+
+ my $car = $tree->[0];
+ my $cdr = $tree->[1];
+
+ if (ref $car) {
+ return join ('', map $self->unparse($_, $depth), @$tree);
}
- elsif ($tree->[0] eq 'LITERAL') {
- return $tree->[1][0];
+ elsif ($car eq 'LITERAL') {
+ return $cdr->[0];
}
- elsif ($tree->[0] eq 'PAREN') {
- return sprintf '(%s)', join (" ", map {unparse($_)} @{$tree->[1]});
+ elsif ($car eq 'PAREN') {
+ return '(' .
+ join(' ',
+ map $self->unparse($_, $depth + 2), @{$cdr}) .
+ (_is_select($cdr)?( $self->newline||'' ).$self->indent($depth + 1):'') . ')';
}
- elsif ($tree->[0] eq 'OR' or $tree->[0] eq 'AND' or (grep { $tree->[0] =~ /^ $_ $/xi } @binary_op_keywords ) ) {
- return join (" $tree->[0] ", map {unparse($_)} @{$tree->[1]});
+ elsif ($car eq 'OR' or $car eq 'AND' or (grep { $car =~ /^ $_ $/xi } @binary_op_keywords ) ) {
+ return join (" $car ", map $self->unparse($_, $depth), @{$cdr});
}
else {
- return sprintf '%s %s', $tree->[0], unparse ($tree->[1]);
+ my ($l, $r) = @{$self->whitespace($car, $depth)};
+ return sprintf "$l%s %s$r", $self->format_keyword($car), $self->unparse($cdr, $depth);
}
}
-sub format { unparse(parse(@_)) }
+sub format { my $self = shift; $self->unparse($self->parse(@_)) }
1;
+=pod
+
+=head1 SYNOPSIS
+
+ my $sqla_tree = SQL::Abstract::Tree->new({ profile => 'console' });
+
+ print $sqla_tree->format('SELECT * FROM foo WHERE foo.a > 2');
+
+ # SELECT *
+ # FROM foo
+ # WHERE foo.a > 2
+