1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
|
"""
Mixin class for managing a stack of graphics state variables.
The contents of this module are internal to fpdf2, and not part of the public API.
They may change at any time without prior warning or any deprecation period,
in non-backward-compatible ways.
Usage documentation at: <https://py-pdf.github.io/fpdf2/Internals.html#graphicsstatemixin>
"""
from copy import copy
from dataclasses import dataclass, field, fields
from typing import TYPE_CHECKING, Any, Optional
from .drawing_primitives import (
ColorInput,
DeviceCMYK,
DeviceGray,
DeviceRGB,
convert_to_device_color,
)
from .enums import CharVPos, TextEmphasis, TextMode
from .fonts import CoreFont, FontFace, TTFFont
_DEFAULT_DRAW_COLOR = DeviceGray(0)
_DEFAULT_FILL_COLOR = DeviceGray(0)
_DEFAULT_TEXT_COLOR = DeviceGray(0)
@dataclass(slots=True)
class GraphicsState:
"""Mutable snapshot of the current graphics state for fragments and local contexts."""
draw_color: Optional[DeviceRGB | DeviceCMYK | DeviceGray] = _DEFAULT_DRAW_COLOR
fill_color: Optional[DeviceRGB | DeviceCMYK | DeviceGray] = _DEFAULT_FILL_COLOR
text_color: Optional[DeviceRGB | DeviceCMYK | DeviceGray] = _DEFAULT_TEXT_COLOR
underline: bool = False
strikethrough: bool = False
font_style: str = ""
font_stretching: float = 100
char_spacing: float = 0
font_family: str = ""
font_size_pt: float = 0
current_font: Optional[CoreFont | TTFFont] = None
current_font_is_set_on_page: bool = False
dash_pattern: dict[str, float] = field(
default_factory=lambda: dict(dash=0, gap=0, phase=0)
)
line_width: float = 0
text_mode: TextMode = TextMode.FILL
char_vpos: CharVPos = CharVPos.LINE
sub_scale: float = 0.7
sup_scale: float = 0.7
nom_scale: float = 0.75
denom_scale: float = 0.75
sub_lift: float = -0.15
sup_lift: float = 0.4
nom_lift: float = 0.2
denom_lift: float = 0.0
text_shaping: Optional[dict[str, Any]] = None
def copy(self) -> "GraphicsState":
new_state = copy(self)
new_state.text_shaping = copy(new_state.text_shaping)
return new_state
def as_kwargs(self) -> dict[str, Any]:
return {
state_field.name: getattr(self, state_field.name)
for state_field in fields(self)
}
StateStackType = GraphicsState
class GraphicsStateMixin:
"""Mixin class for managing a stack of graphics state variables.
To the subclassing library and its users, the variables look like
normal instance attributes. But by the magic of properties, we can
push and pop levels as needed, and users will always see and modify
just the current version.
This class is mixed in by fpdf.FPDF(), and is not meant to be used
directly by user code.
"""
DEFAULT_DRAW_COLOR = _DEFAULT_DRAW_COLOR
DEFAULT_FILL_COLOR = _DEFAULT_FILL_COLOR
DEFAULT_TEXT_COLOR = _DEFAULT_TEXT_COLOR
def __init__(self, *args: Any, **kwargs: Any) -> None:
self.__statestack: list[StateStackType] = [GraphicsState()]
super().__init__(*args, **kwargs)
def _push_local_stack(self, new: Optional[StateStackType] = None) -> StateStackType:
"Push a graphics state on the stack"
if new is None:
new = self._get_current_graphics_state()
self.__statestack.append(new)
return new
def _pop_local_stack(self) -> StateStackType:
"Pop the last graphics state on the stack"
return self.__statestack.pop()
def _get_current_graphics_state(self) -> StateStackType:
"Retrieve the current graphics state"
return self.__statestack[-1].copy()
def _is_current_graphics_state_nested(self) -> bool:
"Indicate if a nested graphics state is active"
return len(self.__statestack) > 1
@property
def draw_color(self) -> Optional[DeviceRGB | DeviceCMYK | DeviceGray]:
return self.__statestack[-1].draw_color
@draw_color.setter
def draw_color(
self,
v: Optional[ColorInput],
) -> None:
self.__statestack[-1].draw_color = (
None if v is None else convert_to_device_color(v)
)
@property
def fill_color(self) -> Optional[DeviceRGB | DeviceCMYK | DeviceGray]:
return self.__statestack[-1].fill_color
@fill_color.setter
def fill_color(
self,
v: Optional[ColorInput],
) -> None:
self.__statestack[-1].fill_color = (
None if v is None else convert_to_device_color(v)
)
@property
def text_color(self) -> Optional[DeviceRGB | DeviceCMYK | DeviceGray]:
return self.__statestack[-1].text_color
@text_color.setter
def text_color(
self,
v: Optional[ColorInput],
) -> None:
self.__statestack[-1].text_color = (
None if v is None else convert_to_device_color(v)
)
@property
def underline(self) -> bool:
return self.__statestack[-1].underline
@underline.setter
def underline(self, v: bool) -> None:
self.__statestack[-1].underline = v
@property
def strikethrough(self) -> bool:
return self.__statestack[-1].strikethrough
@strikethrough.setter
def strikethrough(self, v: bool) -> None:
self.__statestack[-1].strikethrough = v
@property
def font_style(self) -> str:
return self.__statestack[-1].font_style
@font_style.setter
def font_style(self, v: str) -> None:
self.__statestack[-1].font_style = v
@property
def font_stretching(self) -> float:
return self.__statestack[-1].font_stretching
@font_stretching.setter
def font_stretching(self, v: float) -> None:
self.__statestack[-1].font_stretching = v
@property
def char_spacing(self) -> float:
return self.__statestack[-1].char_spacing
@char_spacing.setter
def char_spacing(self, v: float) -> None:
self.__statestack[-1].char_spacing = v
@property
def font_family(self) -> str:
return self.__statestack[-1].font_family
@font_family.setter
def font_family(self, v: str) -> None:
self.__statestack[-1].font_family = v
@property
def font_size_pt(self) -> float:
return self.__statestack[-1].font_size_pt
@font_size_pt.setter
def font_size_pt(self, v: float) -> None:
self.__statestack[-1].font_size_pt = v
@property
def font_size(self) -> float:
if TYPE_CHECKING:
assert isinstance(self.k, float) # type: ignore[attr-defined]
return self.__statestack[-1].font_size_pt / self.k # type: ignore[attr-defined]
@font_size.setter
def font_size(self, v: float) -> None:
self.__statestack[-1].font_size_pt = v * self.k # type: ignore[attr-defined]
@property
def current_font(self) -> Optional[CoreFont | TTFFont]:
return self.__statestack[-1].current_font
@current_font.setter
def current_font(self, v: CoreFont | TTFFont) -> None:
self.__statestack[-1].current_font = v
@property
def current_font_is_set_on_page(self) -> bool:
return self.__statestack[-1].current_font_is_set_on_page
@current_font_is_set_on_page.setter
def current_font_is_set_on_page(self, v: bool) -> None:
self.__statestack[-1].current_font_is_set_on_page = v
@property
def dash_pattern(self) -> dict[str, float]:
return self.__statestack[-1].dash_pattern
@dash_pattern.setter
def dash_pattern(self, v: dict[str, float]) -> None:
self.__statestack[-1].dash_pattern = v
@property
def line_width(self) -> float:
return self.__statestack[-1].line_width
@line_width.setter
def line_width(self, v: float) -> None:
self.__statestack[-1].line_width = v
@property
def text_mode(self) -> TextMode:
return self.__statestack[-1].text_mode
@text_mode.setter
def text_mode(self, v: TextMode | str | int) -> None:
self.__statestack[-1].text_mode = TextMode.coerce(v)
@property
def char_vpos(self) -> CharVPos:
"""
Return vertical character position relative to line.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
if TYPE_CHECKING:
assert isinstance(self.__statestack[-1].char_vpos, CharVPos)
return self.__statestack[-1].char_vpos
@char_vpos.setter
def char_vpos(self, v: CharVPos | str) -> None:
"""
Set vertical character position relative to line.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
self.__statestack[-1].char_vpos = CharVPos.coerce(v)
@property
def sub_scale(self) -> float:
"""
Return scale factor for subscript text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
if TYPE_CHECKING:
assert isinstance(self.__statestack[-1].sub_scale, float)
return self.__statestack[-1].sub_scale
@sub_scale.setter
def sub_scale(self, v: float) -> None:
"""
Set scale factor for subscript text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
self.__statestack[-1].sub_scale = float(v)
@property
def sup_scale(self) -> float:
"""
Return scale factor for superscript text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
if TYPE_CHECKING:
assert isinstance(self.__statestack[-1].sup_scale, float)
return self.__statestack[-1].sup_scale
@sup_scale.setter
def sup_scale(self, v: float) -> None:
"""
Set scale factor for superscript text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
self.__statestack[-1].sup_scale = float(v)
@property
def nom_scale(self) -> float:
"""
Return scale factor for nominator text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
if TYPE_CHECKING:
assert isinstance(self.__statestack[-1].nom_scale, float)
return self.__statestack[-1].nom_scale
@nom_scale.setter
def nom_scale(self, v: float) -> None:
"""
Set scale factor for nominator text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
self.__statestack[-1].nom_scale = float(v)
@property
def denom_scale(self) -> float:
"""
Return scale factor for denominator text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
if TYPE_CHECKING:
assert isinstance(self.__statestack[-1].denom_scale, float)
return self.__statestack[-1].denom_scale
@denom_scale.setter
def denom_scale(self, v: float) -> None:
"""
Set scale factor for denominator text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
self.__statestack[-1].denom_scale = float(v)
@property
def sub_lift(self) -> float:
"""
Return lift factor for subscript text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
if TYPE_CHECKING:
assert isinstance(self.__statestack[-1].sub_lift, float)
return self.__statestack[-1].sub_lift
@sub_lift.setter
def sub_lift(self, v: float) -> None:
"""
Set lift factor for subscript text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
self.__statestack[-1].sub_lift = float(v)
@property
def sup_lift(self) -> float:
"""
Return lift factor for superscript text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
if TYPE_CHECKING:
assert isinstance(self.__statestack[-1].sup_lift, float)
return self.__statestack[-1].sup_lift
@sup_lift.setter
def sup_lift(self, v: float) -> None:
"""
Set lift factor for superscript text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
self.__statestack[-1].sup_lift = float(v)
@property
def nom_lift(self) -> float:
"""
Return lift factor for nominator text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
if TYPE_CHECKING:
assert isinstance(self.__statestack[-1].nom_lift, float)
return self.__statestack[-1].nom_lift
@nom_lift.setter
def nom_lift(self, v: float) -> None:
"""
Set lift factor for nominator text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
self.__statestack[-1].nom_lift = float(v)
@property
def denom_lift(self) -> float:
"""
Return lift factor for denominator text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
if TYPE_CHECKING:
assert isinstance(self.__statestack[-1].denom_lift, float)
return self.__statestack[-1].denom_lift
@denom_lift.setter
def denom_lift(self, v: float) -> None:
"""
Set lift factor for denominator text.
([docs](../TextStyling.html#subscript-superscript-and-fractional-numbers))
"""
self.__statestack[-1].denom_lift = float(v)
@property
def text_shaping(self) -> Optional[dict[str, Any]]:
return self.__statestack[-1].text_shaping
@text_shaping.setter
def text_shaping(self, v: Optional[dict[str, Any]]) -> None:
self.__statestack[-1].text_shaping = v
def font_face(self) -> FontFace:
"""
Return a `fpdf.fonts.FontFace` instance
representing a subset of properties of this GraphicsState.
"""
return FontFace(
family=self.font_family,
emphasis=TextEmphasis.coerce(self.font_style),
size_pt=self.font_size_pt,
color=(
self.text_color if self.text_color != self.DEFAULT_TEXT_COLOR else None
),
fill_color=(
self.fill_color if self.fill_color != self.DEFAULT_FILL_COLOR else None
),
)
__pdoc__ = {
"GraphicsStateMixin._push_local_stack": True,
"GraphicsStateMixin._pop_local_stack": True,
"GraphicsStateMixin._get_current_graphics_state": True,
"GraphicsStateMixin._is_current_graphics_state_nested": True,
}
|