use strict;
use warnings;

package Games::Crossword::Puzzle::Cell;

=head1 NAME

Games::Crossword::Puzzle::Cell - one of those little square bits with a number

=head1 VERSION

version 0.001

  $Id: /my/cs/projects/Games-Crossword-Puzzle/trunk/lib/Games/Crossword/Puzzle/Cell.pm 31482 2007-04-27T13:49:10.009314Z rjbs  $

=cut

our $VERSION = '0.001';

use Carp ();

=head1 METHODS

=head2 new

  my $cell = Games::Crossword::Puzzle::Cell->new(\%arg);

You probably don't mean to use this directly.

Valid arguments are:

  across - the across clue
  down   - the down clue
  number - the cell's number
  value  - the value that belongs in the cell
  guess  - the value that a user has put into the cell

In the future, this may return a singleton for The Black Cell.

=cut

sub new {
  my ($class, $arg) = @_;

  my $data = {
    map { $_ => $arg->{$_} } qw(across down number value guess)
  };

  bless $data => $class;
}

=head2 across

=head2 down

These methods return the clues for the word beginning in this cell, if any.

=cut

sub across { $_[0]->{across} }
sub down   { $_[0]->{down} }

=head2 number

This method returns the cell's number, if it is numbered.

=cut

sub number { $_[0]->{number} }

=head2 value

This returns the value that should appear in the cell.  It returns undef for
black cells.

=cut

sub value  { $_[0]->{value} }

=head2 guess

This returns the value that has been filled into the cell by the user.  It
returns undef for black or empty cells.

=cut

sub guess  { $_[0]->{guess} }

=head1 COPYRIGHT & LICENSE

Copyright 2007 Ricardo SIGNES, all rights reserved.

This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.

=cut

1;