lib/LaTeX/TikZ/Set/Raw.pm

   1 package LaTeX::TikZ::Set::Raw;
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 LaTeX::TikZ::Set::Raw - A literal chunk of TikZ code.
   9
  10 =head1 VERSION
  11
  12 Version 0.02
  13
  14 =cut
  15
  16 our $VERSION = '0.02';
  17
  18 use LaTeX::TikZ::Interface;
  19 use LaTeX::TikZ::Functor;
  20
  21 use Mouse;
  22
  23 =head1 RELATIONSHIPS
  24
  25 This class consumes the L<LaTeX::TikZ::Set::Path> role, and as such implements the L</path> method.
  26
  27 =cut
  28
  29 with 'LaTeX::TikZ::Set::Path';
  30
  31 =head1 ATTRIBUTES
  32
  33 =head2 C<content>
  34
  35 The bare string the raw set is made of.
  36
  37 =cut
  38
  39 has 'content' => (
  40  is       => 'ro',
  41  isa      => 'Str',
  42  required => 1,
  43 );
  44
  45 =head1 METHODS
  46
  47 =head2 C<path>
  48
  49 =cut
  50
  51 sub path { $_[0]->content }
  52
  53 =head2 C<begin>
  54
  55 =cut
  56
  57 sub begin { undef }
  58
  59 =head2 C<end>
  60
  61 =cut
  62
  63 sub end { undef }
  64
  65 LaTeX::TikZ::Interface->register(
  66  raw => sub {
  67   shift;
  68
  69   __PACKAGE__->new(content => join ' ', @_);
  70  },
  71 );
  72
  73 LaTeX::TikZ::Functor->default_rule(
  74  (__PACKAGE__) => sub {
  75   my ($functor, $set, @args) = @_;
  76   $set->new(content => $set->content);
  77  }
  78 );
  79
  80 __PACKAGE__->meta->make_immutable;
  81
  82 =head1 SEE ALSO
  83
  84 L<LaTeX::TikZ>, L<LaTeX::TikZ::Set::Path>.
  85
  86 =head1 AUTHOR
  87
  88 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
  89
  90 You can contact me by mail or on C<irc.perl.org> (vincent).
  91
  92 =head1 BUGS
  93
  94 Please report any bugs or feature requests to C<bug-latex-tikz at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=LaTeX-TikZ>.
  95 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
  96
  97 =head1 SUPPORT
  98
  99 You can find documentation for this module with the perldoc command.
 100
 101     perldoc LaTeX::TikZ
 102
 103 =head1 COPYRIGHT & LICENSE
 104
 105 Copyright 2010 Vincent Pit, all rights reserved.
 106
 107 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 108
 109 =cut
 110
 111 1; # End of LaTeX::TikZ::Set::Raw