2012-09-13 13:19:40 +04:00
|
|
|
|
# coding: utf8
|
|
|
|
|
"""
|
2012-09-16 12:25:02 +04:00
|
|
|
|
weasyprint.backgrounds
|
2012-09-13 13:19:40 +04:00
|
|
|
|
----------------------
|
|
|
|
|
|
2014-01-10 18:27:02 +04:00
|
|
|
|
:copyright: Copyright 2011-2014 Simon Sapin and contributors, see AUTHORS.
|
2012-09-13 13:19:40 +04:00
|
|
|
|
:license: BSD, see LICENSE for details.
|
|
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
from __future__ import division, unicode_literals
|
|
|
|
|
|
|
|
|
|
from collections import namedtuple
|
2013-04-03 19:26:46 +04:00
|
|
|
|
from itertools import cycle
|
2012-09-13 13:19:40 +04:00
|
|
|
|
|
|
|
|
|
from ..formatting_structure import boxes
|
2013-04-03 20:15:32 +04:00
|
|
|
|
from . import replaced
|
2013-06-05 20:56:57 +04:00
|
|
|
|
from .percentages import resolve_radiii_percentages
|
2012-09-13 13:19:40 +04:00
|
|
|
|
|
|
|
|
|
|
2013-04-03 19:26:46 +04:00
|
|
|
|
Background = namedtuple('Background', 'color, layers, image_rendering')
|
2013-03-31 01:49:47 +04:00
|
|
|
|
BackgroundLayer = namedtuple(
|
|
|
|
|
'BackgroundLayer',
|
|
|
|
|
'image, size, position, repeat, unbounded, '
|
2013-06-06 18:21:45 +04:00
|
|
|
|
'painting_area, positioning_area, rounded_box')
|
2012-09-13 13:19:40 +04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def box_rectangle(box, which_rectangle):
|
|
|
|
|
if which_rectangle == 'border-box':
|
|
|
|
|
return (
|
|
|
|
|
box.border_box_x(),
|
|
|
|
|
box.border_box_y(),
|
|
|
|
|
box.border_width(),
|
|
|
|
|
box.border_height(),
|
|
|
|
|
)
|
|
|
|
|
elif which_rectangle == 'padding-box':
|
|
|
|
|
return (
|
|
|
|
|
box.padding_box_x(),
|
|
|
|
|
box.padding_box_y(),
|
|
|
|
|
box.padding_width(),
|
|
|
|
|
box.padding_height(),
|
|
|
|
|
)
|
|
|
|
|
else:
|
|
|
|
|
assert which_rectangle == 'content-box', which_rectangle
|
|
|
|
|
return (
|
|
|
|
|
box.content_box_x(),
|
|
|
|
|
box.content_box_y(),
|
|
|
|
|
box.width,
|
|
|
|
|
box.height,
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def layout_box_backgrounds(page, box, get_image_from_uri):
|
|
|
|
|
"""Fetch and position background images."""
|
2013-06-06 17:58:00 +04:00
|
|
|
|
# Resolve percentages in border-radius properties
|
|
|
|
|
resolve_radiii_percentages(box)
|
|
|
|
|
|
2012-09-13 13:19:40 +04:00
|
|
|
|
for child in box.all_children():
|
|
|
|
|
layout_box_backgrounds(page, child, get_image_from_uri)
|
|
|
|
|
|
|
|
|
|
style = box.style
|
|
|
|
|
if style.visibility == 'hidden':
|
|
|
|
|
box.background = None
|
|
|
|
|
return
|
|
|
|
|
|
2013-04-04 17:33:15 +04:00
|
|
|
|
images = [get_image_from_uri(value) if type_ == 'url' else value
|
|
|
|
|
for type_, value in style.background_image]
|
2013-01-23 19:52:47 +04:00
|
|
|
|
color = style.get_color('background_color')
|
2013-03-19 21:29:58 +04:00
|
|
|
|
if color.alpha == 0 and not any(images):
|
2012-09-13 13:19:40 +04:00
|
|
|
|
box.background = None
|
|
|
|
|
return
|
|
|
|
|
|
2013-04-03 19:26:46 +04:00
|
|
|
|
box.background = Background(
|
|
|
|
|
color=color, image_rendering=style.image_rendering, layers=[
|
2013-07-26 19:26:30 +04:00
|
|
|
|
layout_background_layer(box, page, style.image_resolution, *layer)
|
2013-04-03 19:26:46 +04:00
|
|
|
|
for layer in zip(images, *map(cycle, [
|
|
|
|
|
style.background_size,
|
|
|
|
|
style.background_clip,
|
|
|
|
|
style.background_repeat,
|
|
|
|
|
style.background_origin,
|
|
|
|
|
style.background_position,
|
|
|
|
|
style.background_attachment]))])
|
|
|
|
|
|
|
|
|
|
|
2013-04-03 19:46:14 +04:00
|
|
|
|
def percentage(value, refer_to):
|
|
|
|
|
"""Return the evaluated percentage value, or the value unchanged."""
|
2013-04-03 20:15:32 +04:00
|
|
|
|
if value == 'auto':
|
|
|
|
|
return value
|
|
|
|
|
elif value.unit == 'px':
|
2013-04-03 19:46:14 +04:00
|
|
|
|
return value.value
|
|
|
|
|
else:
|
|
|
|
|
assert value.unit == '%'
|
|
|
|
|
return refer_to * value.value / 100
|
|
|
|
|
|
|
|
|
|
|
2013-07-26 19:26:30 +04:00
|
|
|
|
def layout_background_layer(box, page, resolution, image, size, clip, repeat,
|
|
|
|
|
origin, position, attachment):
|
2013-04-03 19:46:14 +04:00
|
|
|
|
|
|
|
|
|
if box is not page:
|
|
|
|
|
painting_area = box_rectangle(box, clip)
|
2013-12-10 16:33:17 +04:00
|
|
|
|
if clip == 'border-box':
|
|
|
|
|
rounded_box = box.rounded_border_box()
|
|
|
|
|
elif clip == 'padding-box':
|
|
|
|
|
rounded_box = box.rounded_padding_box()
|
|
|
|
|
else:
|
|
|
|
|
assert clip == 'content-box', clip
|
|
|
|
|
rounded_box = box.rounded_content_box()
|
2013-04-03 19:46:14 +04:00
|
|
|
|
else:
|
|
|
|
|
painting_area = 0, 0, page.margin_width(), page.margin_height()
|
2013-12-10 16:33:17 +04:00
|
|
|
|
# XXX: how does border-radius work on pages?
|
2013-12-10 16:16:55 +04:00
|
|
|
|
rounded_box = box.rounded_border_box()
|
2013-04-03 19:46:14 +04:00
|
|
|
|
|
2013-07-26 19:26:30 +04:00
|
|
|
|
if image is None or 0 in image.get_intrinsic_size(1):
|
2013-04-03 19:46:14 +04:00
|
|
|
|
return BackgroundLayer(
|
|
|
|
|
image=None, unbounded=(box is page), painting_area=painting_area,
|
|
|
|
|
size='unused', position='unused', repeat='unused',
|
2013-06-06 18:21:45 +04:00
|
|
|
|
positioning_area='unused', rounded_box=box.rounded_border_box())
|
2013-04-03 19:46:14 +04:00
|
|
|
|
|
|
|
|
|
if attachment == 'fixed':
|
|
|
|
|
# Initial containing block
|
|
|
|
|
positioning_area = box_rectangle(page, 'content-box')
|
|
|
|
|
else:
|
|
|
|
|
positioning_area = box_rectangle(box, origin)
|
|
|
|
|
|
|
|
|
|
positioning_x, positioning_y, positioning_width, positioning_height = (
|
|
|
|
|
positioning_area)
|
|
|
|
|
painting_x, painting_y, painting_width, painting_height = (
|
|
|
|
|
painting_area)
|
|
|
|
|
|
2013-04-03 20:15:32 +04:00
|
|
|
|
if size == 'cover':
|
|
|
|
|
image_width, image_height = replaced.cover_constraint_image_sizing(
|
|
|
|
|
positioning_width, positioning_height, image.intrinsic_ratio)
|
|
|
|
|
elif size == 'contain':
|
|
|
|
|
image_width, image_height = replaced.contain_constraint_image_sizing(
|
|
|
|
|
positioning_width, positioning_height, image.intrinsic_ratio)
|
2013-04-03 19:46:14 +04:00
|
|
|
|
else:
|
2013-04-03 20:15:32 +04:00
|
|
|
|
size_width, size_height = size
|
2013-07-26 19:26:30 +04:00
|
|
|
|
iwidth, iheight = image.get_intrinsic_size(resolution)
|
2013-04-03 20:15:32 +04:00
|
|
|
|
image_width, image_height = replaced.default_image_sizing(
|
2013-07-26 19:26:30 +04:00
|
|
|
|
iwidth, iheight, image.intrinsic_ratio,
|
2013-04-03 20:15:32 +04:00
|
|
|
|
percentage(size_width, positioning_width),
|
|
|
|
|
percentage(size_height, positioning_height),
|
|
|
|
|
positioning_width, positioning_height)
|
2013-04-03 19:46:14 +04:00
|
|
|
|
|
|
|
|
|
origin_x, position_x, origin_y, position_y = position
|
|
|
|
|
ref_x = positioning_width - image_width
|
|
|
|
|
ref_y = positioning_height - image_height
|
|
|
|
|
position_x = percentage(position_x, ref_x)
|
|
|
|
|
position_y = percentage(position_y, ref_y)
|
|
|
|
|
if origin_x == 'right':
|
|
|
|
|
position_x = ref_x - position_x
|
|
|
|
|
if origin_y == 'bottom':
|
|
|
|
|
position_y = ref_y - position_y
|
|
|
|
|
|
|
|
|
|
repeat_x, repeat_y = repeat
|
|
|
|
|
|
|
|
|
|
if repeat_x == 'round':
|
|
|
|
|
n_repeats = max(1, round(positioning_width / image_width))
|
|
|
|
|
new_width = positioning_width / n_repeats
|
|
|
|
|
position_x = 0 # Ignore background-position for this dimension
|
|
|
|
|
if repeat_y != 'round' and size[1] == 'auto':
|
|
|
|
|
image_height *= new_width / image_width
|
|
|
|
|
image_width = new_width
|
|
|
|
|
if repeat_y == 'round':
|
|
|
|
|
n_repeats = max(1, round(positioning_height / image_height))
|
|
|
|
|
new_height = positioning_height / n_repeats
|
|
|
|
|
position_y = 0 # Ignore background-position for this dimension
|
|
|
|
|
if repeat_x != 'round' and size[0] == 'auto':
|
|
|
|
|
image_width *= new_height / image_height
|
|
|
|
|
image_height = new_height
|
|
|
|
|
|
2013-04-03 19:26:46 +04:00
|
|
|
|
return BackgroundLayer(
|
|
|
|
|
image=image,
|
2013-04-03 19:46:14 +04:00
|
|
|
|
size=(image_width, image_height),
|
|
|
|
|
position=(position_x, position_y),
|
2013-04-03 19:26:46 +04:00
|
|
|
|
repeat=repeat,
|
|
|
|
|
unbounded=(box is page),
|
2013-04-03 19:46:14 +04:00
|
|
|
|
painting_area=painting_area,
|
2013-06-05 20:56:57 +04:00
|
|
|
|
positioning_area=positioning_area,
|
2013-12-10 16:16:55 +04:00
|
|
|
|
rounded_box=rounded_box)
|
2012-09-13 13:19:40 +04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def set_canvas_background(page):
|
|
|
|
|
"""Set a ``canvas_background`` attribute on the PageBox,
|
|
|
|
|
with style for the canvas background, taken from the root elememt
|
|
|
|
|
or a <body> child of the root element.
|
|
|
|
|
|
|
|
|
|
See http://www.w3.org/TR/CSS21/colors.html#background
|
|
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
assert not isinstance(page.children[0], boxes.MarginBox)
|
|
|
|
|
root_box = page.children[0]
|
|
|
|
|
chosen_box = root_box
|
2013-03-19 21:29:58 +04:00
|
|
|
|
if root_box.element_tag.lower() == 'html' and root_box.background is None:
|
2012-09-13 13:19:40 +04:00
|
|
|
|
for child in root_box.children:
|
|
|
|
|
if child.element_tag.lower() == 'body':
|
|
|
|
|
chosen_box = child
|
|
|
|
|
break
|
|
|
|
|
|
|
|
|
|
if chosen_box.background:
|
2013-06-06 17:58:00 +04:00
|
|
|
|
painting_area = box_rectangle(page, 'padding-box')
|
2012-09-13 13:19:40 +04:00
|
|
|
|
page.canvas_background = chosen_box.background._replace(
|
2013-03-19 21:29:58 +04:00
|
|
|
|
# TODO: shouldn’t background-clip be considered here?
|
2013-03-31 01:49:47 +04:00
|
|
|
|
layers=[
|
2013-06-06 17:58:00 +04:00
|
|
|
|
l._replace(painting_area=painting_area)
|
2013-03-31 01:49:47 +04:00
|
|
|
|
for l in chosen_box.background.layers])
|
2012-09-13 13:19:40 +04:00
|
|
|
|
chosen_box.background = None
|
|
|
|
|
else:
|
|
|
|
|
page.canvas_background = None
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
def layout_backgrounds(page, get_image_from_uri):
|
|
|
|
|
layout_box_backgrounds(page, page, get_image_from_uri)
|
|
|
|
|
set_canvas_background(page)
|