Whatpm/CSS/Cascade.pm

package Whatpm::CSS::Cascade;
use strict;

require Whatpm::CSS::Parser; ## NOTE: For property definitions.
require Whatpm::CSS::SelectorsSerializer;
use Scalar::Util qw/refaddr/;

## Cascading and value computations

sub new ($$) {
  my $self = bless {style_sheets => []}, shift;
  $self->{document} = shift;

  ## Device dependent font size parameters
  my @scale = (3/5, 3/4, 8/9, 1, 6/5, 3/2, 2/1, 3/1); ## From css3-fonts
  $self->{font_size}->[$_] = 16 * $scale[$_] for 0..$#scale;
  ## TODO: Provide better default
  $self->{get_smaller_font_size} = sub ($$) {
    #my ($self, $original_px) = @_;
    return $_[1] / 1.1;
  };
  ## TODO: Provide better default
  $self->{get_larger_font_size} = sub ($$) {
    #my ($self, $original_px) = @_;
    return $_[1] * 1.1;
  };

  return $self;
} # new

## NOTE: This version does not support dynamic addition --- style
## sheets must be added before any other operation.
## NOTE: The $ss argument must be a value that can be interpreted as
## an array reference of CSSStyleSheet objects.
## NOTE: |type| and |media| attributes are not accounted by this
## method (and any others in the class); CSSStyleSheet objects must
## be filtered before they are passed to this method.
sub add_style_sheets ($$) {
  my ($self, $ss) = @_;

  push @{$self->{style_sheets}}, @$ss;
} # add_style_sheets

## TODO: non-CSS presentation hints
## TODO: style=""

sub ___associate_rules ($) {
  my $self = shift;

  my $selectors_to_elements;

  for my $sheet (@{$self->{style_sheets}}) {
    ## TODO: @media
    ## TODO: @import
    ## TODO: style sheet sources

    for my $rule (@{$sheet->css_rules}) {
      next if $rule->type != 1; # STYLE_RULE

      my $elements_to_specificity = {};

      for my $selector (@{$$rule->{_selectors}}) {
        my $selector_str = Whatpm::CSS::SelectorsSerializer->serialize_test
            ([$selector]);
        unless ($selectors_to_elements->{$selector_str}) {
          $selectors_to_elements->{$selector_str}
              = $self->{document}->___query_selector_all ([$selector]);
        }
        next unless @{$selectors_to_elements->{$selector_str}};

        my $selector_specificity
            = Whatpm::CSS::SelectorsParser->get_selector_specificity
                ($selector);
        for (@{$selectors_to_elements->{$selector_str}}) {
          my $current_specificity = $elements_to_specificity->{refaddr $_};
          if (not defined $current_specificity or ## "*"-only case.
              $selector_specificity->[0] > $current_specificity->[0] or
              $selector_specificity->[1] > $current_specificity->[1] or
              $selector_specificity->[2] > $current_specificity->[2] or
              $selector_specificity->[3] > $current_specificity->[3]) {
            $elements_to_specificity->{refaddr $_} = $selector_specificity;
          }
        }
      }

      my $sd = $rule->style;
      for (keys %$elements_to_specificity) {
        push @{$self->{element_to_sds}->{$_} ||= []},
            [$sd, $elements_to_specificity->{$_}];
      }
    }
  }

  for my $eid (keys %{$self->{element_to_sds} or {}}) {
    $self->{element_to_sds}->{$eid} = [sort {
      $a->[1]->[0] <=> $b->[1]->[0] or
      $a->[1]->[1] <=> $b->[1]->[1] or
      $a->[1]->[2] <=> $b->[1]->[2] or 
      $a->[1]->[3] <=> $b->[1]->[3]
      ## NOTE: Perl |sort| is stable.
    } @{$self->{element_to_sds}->{$eid} or []}];
  }
} # associate_rules

sub get_cascaded_value ($$$) {
  my ($self, $element, $prop_name) = @_;
  return undef unless $Whatpm::CSS::Parser::Prop->{$prop_name};

  my $key = $Whatpm::CSS::Parser::Prop->{$prop_name}->{key};
  return undef unless defined $key; ## Shorthand property or some.

  my $value;
  for my $sds (reverse @{$self->{element_to_sds}->{refaddr $element} or []}) {
    my $vp = ${$sds->[0]}->{$key};
    if (defined $vp->[1] and $vp->[1] eq 'important') {
      return $vp->[0];
    } else {
      $value = $vp->[0] unless defined $value;
    }
  }

  return $value; # might be |undef|.
} # get_cascaded_value

sub get_specified_value ($$$) {
  my ($self, $element, $prop_name) = @_;

  ## TODO: Remove {specified_value} caching, once we implement most
  ## of CSS 2.1 properties and confirm that it makes almost non sence
  ## because of its duplication with {computed_value} caching.

  ## NOTE: |top| computation refers |bottom| and vice versa.
  ## |left| does |right| and vice versa.

  my $eid = refaddr $element;
  unless (exists $self->{specified_value}->{$eid}->{$prop_name}) {
    my $cascaded = $self->get_cascaded_value ($element, $prop_name);
    $self->{specified_value}->{$eid}->{$prop_name} = $cascaded;
    
    unless (defined $cascaded) {
      my $prop_def = $Whatpm::CSS::Parser::Prop->{$prop_name};
      if (defined $prop_def) {
        if ($prop_def->{inherited}) {
          my $parent_element = $element->manakai_parent_element;
          if (defined $parent_element) {
            $self->{specified_value}->{$eid}->{$prop_name}
                = $self->get_computed_value ($parent_element, $prop_name);
          } else {
            $self->{specified_value}->{$eid}->{$prop_name}
                = $prop_def->{initial};
          }
        } else {
          $self->{specified_value}->{$eid}->{$prop_name}
              = $prop_def->{initial};
        }
      } else {
        $self->{specified_value}->{$eid}->{$prop_name} = undef;
      }
    }
  }

  ## NOTE: Always |undef| for shorthand properties.

  return $self->{specified_value}->{$eid}->{$prop_name};
} # get_specified_value

sub get_specified_value_no_inherit ($$$) {
  my ($self, $element, $prop_name) = @_;

  my $specified = $self->get_specified_value ($element, $prop_name);
  if (defined $specified and $specified->[0] eq 'INHERIT') {
    ## ISSUE: CSS 2.1 does not say to resolve computed value of the parent.
    ## However, it is necessary for some cases (see
    ## <http://suika.fam.cx/gate/2005/sw/inherit>).  In addition,
    ## the initial value is not a computed value for some properties.
    my $parent_element = $element->manakai_parent_element;
    if (defined $parent_element) {
      $specified = $self->get_computed_value ($parent_element, $prop_name);
    } else {
      my $prop_def = $Whatpm::CSS::Parser::Prop->{$prop_name};
      $specified = $prop_def->{initial};
    }
    ## NOTE: Because of this handling, {compute} codes must be
    ## idempotent.
  }
  return $specified;
} # get_specified_value_no_inherit

sub get_computed_value ($$$) {
  my ($self, $element, $prop_name) = @_;

  my $eid = refaddr $element;
  unless (exists $self->{computed_value}->{$eid}->{$prop_name}) {
    my $prop_def = $Whatpm::CSS::Parser::Prop->{$prop_name};
    if (defined $prop_def) {
      if ($prop_def->{compute_multiple}) {
        $prop_def->{compute_multiple}->($self, $element, $eid, $prop_name);
      } else {
        my $specified = $self->get_specified_value_no_inherit
            ($element, $prop_name);
        $self->{computed_value}->{$eid}->{$prop_name}
            = $prop_def->{compute}->($self, $element, $prop_name, $specified);
      }
    } else {
      $self->{computed_value}->{$eid}->{$prop_name} = undef;
    }
  }

  ## NOTE: Always |undef| for shorthand properties.

  return $self->{computed_value}->{$eid}->{$prop_name};
} # get_computed_value

1;
## $Date: 2008/01/03 08:37:22 $
1	wakaba	1.1	package Whatpm::CSS::Cascade;
2	wakaba	1.4	use strict;
3	wakaba	1.1
4			require Whatpm::CSS::Parser; ## NOTE: For property definitions.
5			require Whatpm::CSS::SelectorsSerializer;
6			use Scalar::Util qw/refaddr/;
7
8			## Cascading and value computations
9
10			sub new ($$) {
11			my $self = bless {style_sheets => []}, shift;
12			$self->{document} = shift;
13	wakaba	1.8
14			## Device dependent font size parameters
15			my @scale = (3/5, 3/4, 8/9, 1, 6/5, 3/2, 2/1, 3/1); ## From css3-fonts
16			$self->{font_size}->[$_] = 16 * $scale[$_] for 0..$#scale;
17			## TODO: Provide better default
18			$self->{get_smaller_font_size} = sub ($$) {
19			#my ($self, $original_px) = @_;
20			return $_[1] / 1.1;
21			};
22			## TODO: Provide better default
23			$self->{get_larger_font_size} = sub ($$) {
24			#my ($self, $original_px) = @_;
25			return $_[1] * 1.1;
26			};
27
28	wakaba	1.1	return $self;
29			} # new
30
31			## NOTE: This version does not support dynamic addition --- style
32			## sheets must be added before any other operation.
33			## NOTE: The $ss argument must be a value that can be interpreted as
34			## an array reference of CSSStyleSheet objects.
35			## NOTE: \|type\| and \|media\| attributes are not accounted by this
36			## method (and any others in the class); CSSStyleSheet objects must
37			## be filtered before they are passed to this method.
38			sub add_style_sheets ($$) {
39			my ($self, $ss) = @_;
40
41			push @{$self->{style_sheets}}, @$ss;
42			} # add_style_sheets
43
44			## TODO: non-CSS presentation hints
45			## TODO: style=""
46
47			sub ___associate_rules ($) {
48			my $self = shift;
49
50			my $selectors_to_elements;
51
52			for my $sheet (@{$self->{style_sheets}}) {
53			## TODO: @media
54			## TODO: @import
55			## TODO: style sheet sources
56
57			for my $rule (@{$sheet->css_rules}) {
58			next if $rule->type != 1; # STYLE_RULE
59
60	wakaba	1.2	my $elements_to_specificity = {};
61
62			for my $selector (@{$$rule->{_selectors}}) {
63			my $selector_str = Whatpm::CSS::SelectorsSerializer->serialize_test
64			([$selector]);
65			unless ($selectors_to_elements->{$selector_str}) {
66			$selectors_to_elements->{$selector_str}
67			= $self->{document}->___query_selector_all ([$selector]);
68			}
69			next unless @{$selectors_to_elements->{$selector_str}};
70
71			my $selector_specificity
72			= Whatpm::CSS::SelectorsParser->get_selector_specificity
73			($selector);
74			for (@{$selectors_to_elements->{$selector_str}}) {
75			my $current_specificity = $elements_to_specificity->{refaddr $_};
76	wakaba	1.7	if (not defined $current_specificity or ## "*"-only case.
77			$selector_specificity->[0] > $current_specificity->[0] or
78	wakaba	1.2	$selector_specificity->[1] > $current_specificity->[1] or
79			$selector_specificity->[2] > $current_specificity->[2] or
80			$selector_specificity->[3] > $current_specificity->[3]) {
81			$elements_to_specificity->{refaddr $_} = $selector_specificity;
82			}
83			}
84			}
85
86			my $sd = $rule->style;
87			for (keys %$elements_to_specificity) {
88			push @{$self->{element_to_sds}->{$_} \|\|= []},
89			[$sd, $elements_to_specificity->{$_}];
90	wakaba	1.1	}
91			}
92			}
93
94	wakaba	1.2	for my $eid (keys %{$self->{element_to_sds} or {}}) {
95			$self->{element_to_sds}->{$eid} = [sort {
96			$a->[1]->[0] <=> $b->[1]->[0] or
97			$a->[1]->[1] <=> $b->[1]->[1] or
98			$a->[1]->[2] <=> $b->[1]->[2] or
99			$a->[1]->[3] <=> $b->[1]->[3]
100			## NOTE: Perl \|sort\| is stable.
101			} @{$self->{element_to_sds}->{$eid} or []}];
102			}
103	wakaba	1.1	} # associate_rules
104
105			sub get_cascaded_value ($$$) {
106			my ($self, $element, $prop_name) = @_;
107			return undef unless $Whatpm::CSS::Parser::Prop->{$prop_name};
108
109			my $key = $Whatpm::CSS::Parser::Prop->{$prop_name}->{key};
110	wakaba	1.3	return undef unless defined $key; ## Shorthand property or some.
111	wakaba	1.1
112	wakaba	1.2	my $value;
113			for my $sds (reverse @{$self->{element_to_sds}->{refaddr $element} or []}) {
114			my $vp = ${$sds->[0]}->{$key};
115			if (defined $vp->[1] and $vp->[1] eq 'important') {
116			return $vp->[0];
117			} else {
118			$value = $vp->[0] unless defined $value;
119			}
120	wakaba	1.1	}
121
122	wakaba	1.2	return $value; # might be \|undef\|.
123	wakaba	1.1	} # get_cascaded_value
124
125	wakaba	1.3	sub get_specified_value ($$$) {
126			my ($self, $element, $prop_name) = @_;
127
128			## TODO: Remove {specified_value} caching, once we implement most
129			## of CSS 2.1 properties and confirm that it makes almost non sence
130			## because of its duplication with {computed_value} caching.
131	wakaba	1.9
132			## NOTE: \|top\| computation refers \|bottom\| and vice versa.
133			## \|left\| does \|right\| and vice versa.
134
135	wakaba	1.3	my $eid = refaddr $element;
136			unless (exists $self->{specified_value}->{$eid}->{$prop_name}) {
137			my $cascaded = $self->get_cascaded_value ($element, $prop_name);
138			$self->{specified_value}->{$eid}->{$prop_name} = $cascaded;
139
140			unless (defined $cascaded) {
141			my $prop_def = $Whatpm::CSS::Parser::Prop->{$prop_name};
142			if (defined $prop_def) {
143			if ($prop_def->{inherited}) {
144			my $parent_element = $element->manakai_parent_element;
145			if (defined $parent_element) {
146			$self->{specified_value}->{$eid}->{$prop_name}
147			= $self->get_computed_value ($parent_element, $prop_name);
148			} else {
149			$self->{specified_value}->{$eid}->{$prop_name}
150			= $prop_def->{initial};
151			}
152			} else {
153			$self->{specified_value}->{$eid}->{$prop_name}
154			= $prop_def->{initial};
155			}
156			} else {
157			$self->{specified_value}->{$eid}->{$prop_name} = undef;
158			}
159			}
160			}
161
162			## NOTE: Always \|undef\| for shorthand properties.
163
164			return $self->{specified_value}->{$eid}->{$prop_name};
165			} # get_specified_value
166
167	wakaba	1.9	sub get_specified_value_no_inherit ($$$) {
168			my ($self, $element, $prop_name) = @_;
169
170			my $specified = $self->get_specified_value ($element, $prop_name);
171			if (defined $specified and $specified->[0] eq 'INHERIT') {
172			## ISSUE: CSS 2.1 does not say to resolve computed value of the parent.
173			## However, it is necessary for some cases (see
174			## <http://suika.fam.cx/gate/2005/sw/inherit>). In addition,
175			## the initial value is not a computed value for some properties.
176			my $parent_element = $element->manakai_parent_element;
177			if (defined $parent_element) {
178			$specified = $self->get_computed_value ($parent_element, $prop_name);
179			} else {
180			my $prop_def = $Whatpm::CSS::Parser::Prop->{$prop_name};
181			$specified = $prop_def->{initial};
182			}
183			## NOTE: Because of this handling, {compute} codes must be
184			## idempotent.
185			}
186			return $specified;
187			} # get_specified_value_no_inherit
188
189	wakaba	1.3	sub get_computed_value ($$$) {
190			my ($self, $element, $prop_name) = @_;
191
192			my $eid = refaddr $element;
193			unless (exists $self->{computed_value}->{$eid}->{$prop_name}) {
194			my $prop_def = $Whatpm::CSS::Parser::Prop->{$prop_name};
195			if (defined $prop_def) {
196	wakaba	1.9	if ($prop_def->{compute_multiple}) {
197			$prop_def->{compute_multiple}->($self, $element, $eid, $prop_name);
198			} else {
199			my $specified = $self->get_specified_value_no_inherit
200			($element, $prop_name);
201			$self->{computed_value}->{$eid}->{$prop_name}
202			= $prop_def->{compute}->($self, $element, $prop_name, $specified);
203	wakaba	1.4	}
204	wakaba	1.3	} else {
205			$self->{computed_value}->{$eid}->{$prop_name} = undef;
206			}
207			}
208
209			## NOTE: Always \|undef\| for shorthand properties.
210
211			return $self->{computed_value}->{$eid}->{$prop_name};
212			} # get_computed_value
213	wakaba	1.1
214			1;
215	wakaba	1.9	## $Date: 2008/01/03 08:37:22 $