First cut at the documentation

[perl/modules/LaTeX-TikZ.git] / lib / LaTeX / TikZ / Set.pm

diff --git a/lib/LaTeX/TikZ/Set.pm b/lib/LaTeX/TikZ/Set.pm
index dcaab09494b69c2971e619e21a787f9e19c757da..505dfec1a823712e0ce06477ed39a186d4416a5c 100644 (file)
--- a/lib/LaTeX/TikZ/Set.pm
+++ b/lib/LaTeX/TikZ/Set.pm
@@ -15,38 +15,135 @@ Version 0.01
 
 our $VERSION = '0.01';
 
-use LaTeX::TikZ::Set::Mod;
+use Scope::Guard ();
+
+use LaTeX::TikZ::Scope;
 
 use LaTeX::TikZ::Tools;
 
 use Any::Moose 'Role';
 
+=head1 ATTRIBUTES
+
+=head2 C<mods>
+
+Returns the list of the L<LaTeX::TikZ::Mod> objects associated with the current set.
+
+=cut
+
+has '_mods' => (
+ is       => 'ro',
+ isa      => 'Maybe[ArrayRef[LaTeX::TikZ::Mod]]',
+ init_arg => 'mods',
+ default  => sub { [ ] },
+ lazy     => 1,
+);
+
+sub mods { @{$_[0]->_mods} }
+
+=head1 METHODS
+
+This method is required by the interface :
+
+=over 4
+
+=item *
+
+C<draw>
+
+=back
+
+=cut
+
 requires qw(
  draw
 );
 
-sub mod {
- my $set = $_[0];
+=head2 C<mod @mods>
 
- return $set unless @_ > 1;
+Apply the given list of L<LaTeX::TikZ::Mod> objects to the current set.
 
- # If $set is already a Tikz::Set::Mod object, the overridden method is
- # called instead. This ensures that you can't have two T::S::M objects in a
- # row.
+=cut
 
- # Prepend a new set with the mods
- my $new = LaTeX::TikZ::Set::Mod->new(
-  set  => $set,
-  mods => [ @_[1 .. $#_] ],
- );
+my $ltm_tc  = LaTeX::TikZ::Tools::type_constraint('LaTeX::TikZ::Mod');
+my $ltml_tc = LaTeX::TikZ::Tools::type_constraint('LaTeX::TikZ::Mod::Layer');
+my $ltmc_tc = LaTeX::TikZ::Tools::type_constraint('LaTeX::TikZ::Mod::Clip');
+
+sub mod {
+ my $set = shift;
 
- $_[0] = $new unless defined wantarray;
+ my @mods = map $ltm_tc->coerce($_), @_;
+ $ltm_tc->assert_valid($_) for @mods;
 
- $new;
+ push @{$set->_mods}, @mods;
+
+ $set;
 }
 
-my $ltml_tc = LaTeX::TikZ::Tools::type_constraint('LaTeX::TikZ::Mod::Layer');
-my $ltmc_tc = LaTeX::TikZ::Tools::type_constraint('LaTeX::TikZ::Mod::Clip');
+{
+ our %mods;
+ our $last_mod = 0;
+
+ around 'draw' => sub {
+  my ($orig, $set, $tikz) = @_;
+
+  local $last_mod = $last_mod;
+
+  # Save a deep copy
+  my %saved_idx = map { $_ => $#{$mods{$_}} } keys %mods;
+  my $guard     = Scope::Guard->new(sub {
+   for (keys %mods) {
+    if (exists $saved_idx{$_}) {
+     $#{$mods{$_}} = $saved_idx{$_};
+    } else {
+     delete $mods{$_};
+    }
+   }
+  });
+
+  my (@mods, $last_layer);
+MOD:
+  for my $mod ($set->mods) {
+   my $is_layer = $ltml_tc->check($mod);
+   $last_layer  = $mod if $is_layer;
+   my $tag = $mod->tag;
+   my $old = $mods{$tag} || [];
+   for (@$old) {
+    next MOD if $_->[0]->cover($mod);
+   }
+   push @{$mods{$tag}}, [ $mod, $last_mod++, $is_layer ];
+   push @mods,          $mod;
+  }
+
+  if ($last_layer) {
+   # Clips and mods don't propagate through layers. Hence if a layer is set,
+   # force their reuse.
+   @mods = $last_layer;
+   push @mods, map $_->[0],
+                sort { $a->[1] <=> $b->[1] }
+                 grep !$_->[2],
+                  map @$_,
+                   values %mods;
+  }
+
+  my $body = $set->$orig($tikz);
+
+  if (@mods) {
+   $body = LaTeX::TikZ::Scope->new
+                             ->mod(map $_->apply($tikz), @mods)
+                             ->body($body);
+  }
+
+  $body;
+ };
+}
+
+=head2 C<layer $layer>
+
+Puts the current set in the corresponding layer.
+This is a shortcut for C<< $set->mod(Tikz->layer($layer)) >>.
+
+=cut
 
 sub layer {
  return $_[0] unless @_ > 1;
@@ -59,12 +156,19 @@ sub layer {
  )
 }
 
+=head2 C<clip $path>
+
+Clips the current set by the path given by C<$path>.
+This is a shortcut for C<< $set->mod(Tikz->clip($path)) >>.
+
+=cut
+
 sub clip {
  return $_[0] unless @_ > 1;
 
  $_[0]->mod(
   map {
-   $ltmc_tc->check($_) ? $_ : LaTeX::TikZ::Mod::Clip->new($_)
+   $ltmc_tc->check($_) ? $_ : LaTeX::TikZ::Mod::Clip->new(clip => $_)
   } @_[1 .. $#_]
  )
 }