VLGal::Style - contains VLGal code style information

 TODO

package VLGal::Style;

use 5.006;
use strict;
use warnings;
use Error qw(:try);
use VLGal::Size;

# Singleton variable
our $SINGLETON = undef;

# Used by _value_is_allowed
our %ALLOW_ISA = (
    'size' => [ 'VLGal::Size' ],
);

# Used by _value_is_allowed
our %ALLOW_REF = (
);

# Used by _value_is_allowed
our %ALLOW_RX = (
);

# Used by _value_is_allowed
our %ALLOW_VALUE = (
    'table_order_dir' => {
        'n' => 1,
        'z' => 1,
    },
    'table_order_image' => {
        'n' => 1,
        'z' => 1,
    },
);

# Used by _initialize
our %DEFAULT_VALUE = (
    #'css_definition_file' => 'VLGal/lib/default.css file @INC',
    #'image_icon_folder' => 'VLGal/lib/icon-folder.png file @INC',
    #'image_icon_next_peer' => 'VLGal/lib/icon-next-peer.png file @INC',
    #'image_icon_next_seq' => 'VLGal/lib/icon-next-seq.png file @INC',
    #'image_icon_previous_peer' => 'VLGal/lib/icon-previous-peer.png file @INC',
    #'image_icon_previous_seq' => 'VLGal/lib/icon-previous-seq.png file @INC',
    'max_columns_dir' => 8,
    'max_columns_image' => 5,
    'size' => [
        VLGal::Size->new( {
            max_height => 90,
            max_width => 90,
        } ),
        VLGal::Size->new( {
            max_height => 600,
            max_width => 600,
        } ),
        VLGal::Size->new( {
            max_height => 800,
            max_width => 800,
        } ),
        VLGal::Size->new( {
            max_height => 1000,
            max_width => 1000,
        } ),
        VLGal::Size->new( {
            max_height => 0,
            max_width => 0,
        } ),
    ],
    'table_order_dir' => 'n',
    'table_order_image' => 'z',
);

# Library files
our %LIB_FILE = (
    css_definition_file => 'default.css',
    image_icon_folder => 'icon-folder.png',
    image_icon_next_peer => 'icon-next-peer.png',
    image_icon_next_seq => 'icon-next-seq.png',
    image_icon_previous_peer => 'icon-previous-peer.png',
    image_icon_previous_seq => 'icon-previous-seq.png',
);

# Package version
our ($VERSION) = '$Revision: 0.01 $' =~ /\$Revision:\s+([^\s]+)/;

sub new {
    my $class = shift;

    my $self = {};
    bless( $self, ( ref($class) || $class ) );
    return( $self->_initialize(@_) );
}

sub _initialize {
    my $self = shift;
    my $opt = defined($_[0]) ? shift : {};

    # Check $opt
    ref($opt) eq 'HASH' || throw Error::Simple("ERROR: VLGal::Style::_initialize, first argument must be 'HASH' reference.");

    # Check lib files
    &_check_lib_files($opt);

    # css_definition_file, SINGLE, with default value
    $self->set_css_definition_file( exists( $opt->{css_definition_file} ) ? $opt->{css_definition_file} : $DEFAULT_VALUE{css_definition_file} );

    # image_icon_folder, SINGLE, with default value
    $self->set_image_icon_folder( exists( $opt->{image_icon_folder} ) ? $opt->{image_icon_folder} : $DEFAULT_VALUE{image_icon_folder} );

    # image_icon_next_peer, SINGLE, with default value
    $self->set_image_icon_next_peer( exists( $opt->{image_icon_next_peer} ) ? $opt->{image_icon_next_peer} : $DEFAULT_VALUE{image_icon_next_peer} );

    # image_icon_next_seq, SINGLE, with default value
    $self->set_image_icon_next_seq( exists( $opt->{image_icon_next_seq} ) ? $opt->{image_icon_next_seq} : $DEFAULT_VALUE{image_icon_next_seq} );

    # image_icon_previous_peer, SINGLE, with default value
    $self->set_image_icon_previous_peer( exists( $opt->{image_icon_previous_peer} ) ? $opt->{image_icon_previous_peer} : $DEFAULT_VALUE{image_icon_previous_peer} );

    # image_icon_previous_seq, SINGLE, with default value
    $self->set_image_icon_previous_seq( exists( $opt->{image_icon_previous_seq} ) ? $opt->{image_icon_previous_seq} : $DEFAULT_VALUE{image_icon_previous_seq} );

    # max_columns_dir, SINGLE, with default value
    $self->set_max_columns_dir( exists( $opt->{max_columns_dir} ) ? $opt->{max_columns_dir} : $DEFAULT_VALUE{max_columns_dir} );

    # max_columns_image, SINGLE, with default value
    $self->set_max_columns_image( exists( $opt->{max_columns_image} ) ? $opt->{max_columns_image} : $DEFAULT_VALUE{max_columns_image} );

    # size, MULTI, with default value
    if ( exists( $opt->{size} ) ) {
        ref( $opt->{size} ) eq 'ARRAY' || throw Error::Simple("ERROR: VLGal::Style::_initialize, specified value for option 'size' must be an 'ARRAY' reference.");
        $self->set_size( @{ $opt->{size} } );
    }
    else {
        $self->set_size( @{ $DEFAULT_VALUE{size} } );
    }

    # table_order_dir, SINGLE, with default value
    $self->set_table_order_dir( exists( $opt->{table_order_dir} ) ? $opt->{table_order_dir} : $DEFAULT_VALUE{table_order_dir} );

    # table_order_image, SINGLE, with default value
    $self->set_table_order_image( exists( $opt->{table_order_image} ) ? $opt->{table_order_image} : $DEFAULT_VALUE{table_order_image} );

    # verbose, BOOLEAN
    exists( $opt->{verbose} ) && $self->set_verbose( $opt->{verbose} );

    # Return $self
    return($self);
}

sub _check_lib_files {
    my $opt = shift;

    # Check lib files
    foreach my $attr ( keys(%LIB_FILE) ) {
        # Do nothing if attribute in options
        $opt->{$attr} &&
            next;

        # Make file name
        my $def_fn = File::Spec->catfile( 'VLGal', 'lib', $LIB_FILE{$attr} );
        foreach my $dir ( @INC ) {
            # Make file name
            my $fs_name = File::Spec->catfile( $dir, $def_fn );

            # Check if file exists
            ( -f $fs_name ) ||
                next;

            # Set option
            $opt->{$attr} = $fs_name;
            last;
        }

        # Check if we have a file
        $opt->{$attr} ||
            throw Error::Simple("ERROR: VLGal::Style::_check_lib_files, failed to find file '$def_fn' in \@INC '@INC'.");
    }
}

sub _mk_size_basename {
    my $self = shift;

    # Make the precision
    my $p = length( scalar( $self->get_size() ) );

    # Make the size basenames
    my $i = 0;
    foreach my $size ( $self->get_size() ) {
        $i++;

        # Make basename and label
        if ( $size->get_max_height() && $size->get_max_width() ) {
            $size->set_basename( sprintf(
                "%0${p}d-%sx%s",
                $i,
                $size->get_max_width(),
                $size->get_max_width()
            ) );
            $size->set_label( sprintf(
                "%sx%s",
                $size->get_max_width(),
                $size->get_max_width()
            ) );
        }
        else {
            $size->set_basename('orig');
            $size->set_label('Original');
        }
    }
}

sub _value_is_allowed {
    my $name = shift;

    # Value is allowed if no ALLOW clauses exist for the named attribute
    if ( ! exists( $ALLOW_ISA{$name} ) && ! exists( $ALLOW_REF{$name} ) && ! exists( $ALLOW_RX{$name} ) && ! exists( $ALLOW_VALUE{$name} ) ) {
        return(1);
    }

    # At this point, all values in @_ must to be allowed
    CHECK_VALUES:
    foreach my $val (@_) {
        # Check ALLOW_ISA
        if ( ref($val) && exists( $ALLOW_ISA{$name} ) ) {
            foreach my $class ( @{ $ALLOW_ISA{$name} } ) {
                &UNIVERSAL::isa( $val, $class ) && next CHECK_VALUES;
            }
        }

        # Check ALLOW_REF
        if ( ref($val) && exists( $ALLOW_REF{$name} ) ) {
            exists( $ALLOW_REF{$name}{ ref($val) } ) && next CHECK_VALUES;
        }

        # Check ALLOW_RX
        if ( defined($val) && ! ref($val) && exists( $ALLOW_RX{$name} ) ) {
            foreach my $rx ( @{ $ALLOW_RX{$name} } ) {
                $val =~ /$rx/ && next CHECK_VALUES;
            }
        }

        # Check ALLOW_VALUE
        if ( ! ref($val) && exists( $ALLOW_VALUE{$name} ) ) {
            exists( $ALLOW_VALUE{$name}{$val} ) && next CHECK_VALUES;
        }

        # We caught a not allowed value
        return(0);
    }

    # OK, all values are allowed
    return(1);
}

sub exists_size {
    my $self = shift;

    # Count occurrences
    my $count = 0;
    foreach my $val1 (@_) {
        foreach my $val2 ( @{ $self->{VLGal_Style}{size} } ) {
            ( $val1 eq $val2 ) && $count ++;
        }
    }
    return($count);
}

sub get_css_definition_file {
    my $self = shift;

    return( $self->{VLGal_Style}{css_definition_file} );
}

sub get_image_icon_folder {
    my $self = shift;

    return( $self->{VLGal_Style}{image_icon_folder} );
}

sub get_image_icon_next_peer {
    my $self = shift;

    return( $self->{VLGal_Style}{image_icon_next_peer} );
}

sub get_image_icon_next_seq {
    my $self = shift;

    return( $self->{VLGal_Style}{image_icon_next_seq} );
}

sub get_image_icon_previous_peer {
    my $self = shift;

    return( $self->{VLGal_Style}{image_icon_previous_peer} );
}

sub get_image_icon_previous_seq {
    my $self = shift;

    return( $self->{VLGal_Style}{image_icon_previous_seq} );
}

sub get_max_columns_dir {
    my $self = shift;

    return( $self->{VLGal_Style}{max_columns_dir} );
}

sub get_max_columns_image {
    my $self = shift;

    return( $self->{VLGal_Style}{max_columns_image} );
}

sub get_size {
    my $self = shift;

    if ( scalar(@_) ) {
        my @ret = ();
        foreach my $i (@_) {
            push( @ret, $self->{VLGal_Style}{size}[ int($i) ] );
        }
        return(@ret);
    }
    else {
        # Return the full list
        return( @{ $self->{VLGal_Style}{size} } );
    }
}

sub get_table_order_dir {
    my $self = shift;

    return( $self->{VLGal_Style}{table_order_dir} );
}

sub get_table_order_image {
    my $self = shift;

    return( $self->{VLGal_Style}{table_order_image} );
}

sub instance {
    # Allow calls like:
    # - VLGal::Style::instance()
    # - VLGal::Style->instance()
    # - $variable->instance()
    if ( ref($_[0]) && &UNIVERSAL::isa( $_[0], 'VLGal::Style' ) ) {
        shift;
    }
    elsif ( ! ref($_[0]) && $_[0] eq 'VLGal::Style' ) {
        shift;
    }

    # If $SINGLETON is defined return it
    defined($SINGLETON) && return($SINGLETON);

    # Create the object and set $SINGLETON
    $SINGLETON = VLGal::Style->new(@_);

    # Return $SINGLETON
    return($SINGLETON);
}

sub is_verbose {
    my $self = shift;

    if ( $self->{VLGal_Style}{verbose} ) {
        return(1);
    }
    else {
        return(0);
    }
}

sub pop_size {
    my $self = shift;

    # Pop an element from the list
    return( pop( @{ $self->{VLGal_Style}{size} } ) );
}

sub push_size {
    my $self = shift;

    # Check if isas/refs/rxs/values are allowed
    &_value_is_allowed( 'size', @_ ) || throw Error::Simple("ERROR: VLGal::Style::push_size, one or more specified value(s) '@_' is/are not allowed.");

    # Push the list
    push( @{ $self->{VLGal_Style}{size} }, @_ );
}

sub set_css_definition_file {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'css_definition_file', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_css_definition_file, the specified value '$val' is not allowed.");

    # Assignment
    $self->{VLGal_Style}{css_definition_file} = $val;
}

sub set_idx_size {
    my $self = shift;
    my $idx = shift;
    my $val = shift;

    # Check if index is a positive integer or zero
    ( $idx == int($idx) ) || throw Error::Simple("ERROR: VLGal::Style::set_idx_size, the specified index '$idx' is not an integer.");
    ( $idx >= 0 ) || throw Error::Simple("ERROR: VLGal::Style::set_idx_size, the specified index '$idx' is not a positive integer or zero.");

    # Check if isas/refs/rxs/values are allowed
    &_value_is_allowed( 'size', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_idx_size, one or more specified value(s) '@_' is/are not allowed.");

    # Set the value in the list
    $self->{VLGal_Style}{size}[$idx] = $val;
}

sub set_image_icon_folder {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'image_icon_folder', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_image_icon_folder, the specified value '$val' is not allowed.");

    # Assignment
    $self->{VLGal_Style}{image_icon_folder} = $val;
}

sub set_image_icon_next_peer {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'image_icon_next_peer', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_image_icon_next_peer, the specified value '$val' is not allowed.");

    # Assignment
    $self->{VLGal_Style}{image_icon_next_peer} = $val;
}

sub set_image_icon_next_seq {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'image_icon_next_seq', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_image_icon_next_seq, the specified value '$val' is not allowed.");

    # Assignment
    $self->{VLGal_Style}{image_icon_next_seq} = $val;
}

sub set_image_icon_previous_peer {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'image_icon_previous_peer', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_image_icon_previous_peer, the specified value '$val' is not allowed.");

    # Assignment
    $self->{VLGal_Style}{image_icon_previous_peer} = $val;
}

sub set_image_icon_previous_seq {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'image_icon_previous_seq', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_image_icon_previous_seq, the specified value '$val' is not allowed.");

    # Assignment
    $self->{VLGal_Style}{image_icon_previous_seq} = $val;
}

sub set_max_columns_dir {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'max_columns_dir', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_max_columns_dir, the specified value '$val' is not allowed.");

    # Assignment
    $self->{VLGal_Style}{max_columns_dir} = $val;
}

sub set_max_columns_image {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'max_columns_image', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_max_columns_image, the specified value '$val' is not allowed.");

    # Assignment
    $self->{VLGal_Style}{max_columns_image} = $val;
}

sub set_num_size {
    my $self = shift;
    my $num = shift;

    # Check if index is an integer
    ( $num == int($num) ) || throw Error::Simple("ERROR: VLGal::Style::set_num_size, the specified number '$num' is not an integer.");

    # Call set_idx_size
    $self->set_idx_size( $num - 1, @_ );
}

sub set_size {
    my $self = shift;

    # Check if isas/refs/rxs/values are allowed
    &_value_is_allowed( 'size', @_ ) || throw Error::Simple("ERROR: VLGal::Style::set_size, one or more specified value(s) '@_' is/are not allowed.");

    # Set the list
    @{ $self->{VLGal_Style}{size} } = @_;
}

sub set_table_order_dir {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'table_order_dir', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_table_order_dir, the specified value '$val' is not allowed.");

    # Assignment
    $self->{VLGal_Style}{table_order_dir} = $val;
}

sub set_table_order_image {
    my $self = shift;
    my $val = shift;

    # Check if isa/ref/rx/value is allowed
    &_value_is_allowed( 'table_order_image', $val ) || throw Error::Simple("ERROR: VLGal::Style::set_table_order_image, the specified value '$val' is not allowed.");

    # Assignment
    $self->{VLGal_Style}{table_order_image} = $val;
}

sub set_verbose {
    my $self = shift;

    if (shift) {
        $self->{VLGal_Style}{verbose} = 1;
    }
    else {
        $self->{VLGal_Style}{verbose} = 0;
    }
}

sub shift_size {
    my $self = shift;

    # Shift an element from the list
    return( shift( @{ $self->{VLGal_Style}{size} } ) );
}

sub unshift_size {
    my $self = shift;

    # Check if isas/refs/rxs/values are allowed
    &_value_is_allowed( 'size', @_ ) || throw Error::Simple("ERROR: VLGal::Style::unshift_size, one or more specified value(s) '@_' is/are not allowed.");

    # Unshift the list
    unshift( @{ $self->{VLGal_Style}{size} }, @_ );
}

1;