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 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
|
package Biber::SortList;
use v5.24;
use strict;
use warnings;
use Biber::Utils;
use Biber::Constants;
use Digest::MD5 qw( md5_hex );
use List::Util qw( first );
=encoding utf-8
=head1 NAME
Biber::SortList - Biber::SortList objects
=head2 new
Initialize a Biber::SortList object
=cut
sub new {
my ($class, %params) = @_;
my $self = bless {%params}, $class;
return $self;
}
=head2 set_section
Sets the section of a sort list
=cut
sub set_section {
my $self = shift;
my $section = shift;
$self->{section} = lc($section);
return;
}
=head2 get_section
Gets the section of a sort list
=cut
sub get_section {
my $self = shift;
return $self->{section};
}
=head2 set_sortschemename
Sets the sortscheme name of a sort list
=cut
sub set_sortschemename {
my $self = shift;
my $ssn = shift;
$self->{sortschemename} = lc($ssn);
return;
}
=head2 get_sortschemename
Gets the sortschemename of a sort list
=cut
sub get_sortschemename {
my $self = shift;
return $self->{sortschemename};
}
=head2 set_sortnamekeyschemename
Sets the sortnamekeyscheme name of a sort list
=cut
sub set_sortnamekeyschemename {
my $self = shift;
my $snksn = shift;
$self->{sortnamekeyschemename} = lc($snksn);
return;
}
=head2 get_sortnamekeyschemename
Gets the sortnamekeyschemename of a sort list
=cut
sub get_sortnamekeyschemename {
my $self = shift;
return $self->{sortnamekeyschemename};
}
=head2 set_sortinit_collator
Sets the sortinit collator for this list
=cut
sub set_sortinit_collator {
my $self = shift;
$self->{sortinitcollator} = shift;;
return;
}
=head2 get_sortinit_collator
Gets the sortinit collator for this list
=cut
sub get_sortinit_collator {
my $self = shift;
return $self->{sortinitcollator};
}
=head2 get_labelprefix
Gets the labelprefix setting of a sort list
=cut
sub get_labelprefix {
my $self = shift;
return $self->{labelprefix};
}
=head2 set_labelprefix
Sets the labelprefix setting of a sort list
=cut
sub set_labelprefix {
my $self = shift;
my $pn = shift;
$self->{labelprefix} = $pn;
return
}
=head2 set_name
Sets the name of a sort list
=cut
sub set_name {
my $self = shift;
my $name = shift;
$self->{name} = $name;
return;
}
=head2 get_name
Gets the name of a sort list
=cut
sub get_name {
my $self = shift;
return $self->{name};
}
=head2 set_type
Sets the type of a sort list
=cut
sub set_type {
my $self = shift;
my $type = shift;
$self->{type} = lc($type);
return;
}
=head2 get_type
Gets the type of a section list
=cut
sub get_type {
my $self = shift;
return $self->{type};
}
=head2 set_keys
Sets the keys for the list
=cut
sub set_keys {
my ($self, $keys) = @_;
$self->{keys} = $keys;
return;
}
=head2 get_keys
Gets the keys for the list
=cut
sub get_keys {
my $self = shift;
return $self->{keys}->@*;
}
=head2 count_keys
Count the keys for the list
=cut
sub count_keys {
my $self = shift;
return $#{$self->{keys}} + 1;
}
=head2 get_listdata
Gets all of the list metadata
=cut
sub get_listdata {
my $self = shift;
return [ $self->{sortscheme},
$self->{sortnamekeyschemename},
$self->{labelprefix},
$self->{keys},
$self->{sortinitdata},
$self->{extrayeardata},
$self->{extraalphadata},
$self->{extratitledata},
$self->{extratitleyeardata},
$self->{sortdataschema} ];
}
=head2 set_extrayeardata_for_key
Saves extrayear field data for a key
=cut
sub set_extrayeardata_for_key {
my ($self, $key, $ed) = @_;
return unless defined($key);
$self->{extrayeardata}{$key} = $ed;
return;
}
=head2 set_extrayeardata
Saves extrayear field data for all keys
=cut
sub set_extrayeardata {
my ($self, $ed) = @_;
$self->{extrayeardata} = $ed;
return;
}
=head2 get_extrayeardata
Gets the extrayear field data for a key
=cut
sub get_extrayeardata {
my ($self, $key) = @_;
return unless defined($key);
return $self->{extrayeardata}{$key};
}
=head2 set_extratitledata_for_key
Saves extratitle field data for a key
=cut
sub set_extratitledata_for_key {
my ($self, $key, $ed) = @_;
return unless defined($key);
$self->{extratitledata}{$key} = $ed;
return;
}
=head2 set_extratitledata
Saves extratitle field data for all keys
=cut
sub set_extratitledata {
my ($self, $ed) = @_;
$self->{extratitledata} = $ed;
return;
}
=head2 get_extratitledata
Gets the extratitle field data for a key
=cut
sub get_extratitledata {
my ($self, $key) = @_;
return unless defined($key);
return $self->{extratitledata}{$key};
}
=head2 set_extratitleyeardata_for_key
Saves extratitleyear field data for a key
=cut
sub set_extratitleyeardata_for_key {
my ($self, $key, $ed) = @_;
return unless defined($key);
$self->{extratitleyeardata}{$key} = $ed;
return;
}
=head2 set_extratitleyeardata
Saves extratitleyear field data for all keys
=cut
sub set_extratitleyeardata {
my ($self, $ed) = @_;
$self->{extratitleyeardata} = $ed;
return;
}
=head2 get_extratitleyeardata
Gets the extratitleyear field data for a key
=cut
sub get_extratitleyeardata {
my ($self, $key) = @_;
return unless defined($key);
return $self->{extratitleyeardata}{$key};
}
=head2 set_extraalphadata_for_key
Saves extraalpha field data for a key
=cut
sub set_extraalphadata_for_key {
my ($self, $key, $ed) = @_;
return unless defined($key);
$self->{extraalphadata}{$key} = $ed;
return;
}
=head2 set_extraalphadata
Saves extraalpha field data for all keys
=cut
sub set_extraalphadata {
my ($self, $ed) = @_;
$self->{extraalphadata} = $ed;
return;
}
=head2 get_extraalphadata
Gets the extraalpha field data for a key
=cut
sub get_extraalphadata {
my ($self, $key) = @_;
return unless defined($key);
return $self->{extraalphadata}{$key};
}
=head2 get_sortdataschema
Gets the sortdata schema for a sortlist
=cut
sub get_sortdataschema {
my ($self) = @_;
return $self->{sortdataschema};
}
=head2 set_sortdataschema
Saves the sortdata schema for a sortlist
=cut
sub set_sortdataschema {
my ($self, $ss) = @_;
$self->{sortdataschema} = $ss;
return;
}
=head2 set_sortdata
Saves sorting data in a list for a key
=cut
sub set_sortdata {
my ($self, $key, $sd) = @_;
return unless defined($key);
$self->{sortdata}{$key} = $sd;
return;
}
=head2 get_sortdata
Gets the sorting data in a list for a key
=cut
sub get_sortdata {
my ($self, $key) = @_;
return unless defined($key);
return $self->{sortdata}{$key};
}
=head2 set_sortinitdata_for_key
Saves sortinit data for a specific key
=cut
sub set_sortinitdata_for_key {
my ($self, $key, $init) = @_;
return unless defined($key);
$self->{sortinitdata}{$key} = {init => $init};
return;
}
=head2 set_sortinitdata
Saves sortinit data for all keys
=cut
sub set_sortinitdata {
my ($self, $sid) = @_;
$self->{sortinitdata} = $sid;
return;
}
=head2 get_sortinit_for_key
Gets the sortinit in a list for a key
=cut
sub get_sortinit_for_key {
my ($self, $key) = @_;
return unless defined($key);
return $self->{sortinitdata}{$key}{init};
}
=head2 set_sortscheme
Sets the sortscheme of a list
=cut
sub set_sortscheme {
my $self = shift;
my $sortscheme = shift;
$self->{sortscheme} = $sortscheme;
return;
}
=head2 get_sortscheme
Gets the sortscheme of a list
=cut
sub get_sortscheme {
my $self = shift;
return $self->{sortscheme};
}
=head2 add_filter
Adds a filter to a list object
=cut
sub add_filter {
my $self = shift;
my ($filter) = @_;
push $self->{filters}->@*, $filter;
return;
}
=head2 get_filters
Gets all filters for a list object
=cut
sub get_filters {
my $self = shift;
return $self->{filters};
}
=head2 instantiate_entry
Do any dynamic information replacement for information
which varies in an entry between lists. This is information which
needs to be output to the .bbl for an entry but which is a property
of the sorting list and not the entry per se so it cannot be stored
statically in the entry and must be pulled from the specific list
when outputting the entry.
Currently this means:
* sortinit
* sortinithash
* extrayear
* extraalpha
* extratitle
* extratitleyear
* labelprefix
=cut
sub instantiate_entry {
my $self = shift;
my ($entry, $key, $format) = @_;
return '' unless $entry;
$format //= 'bbl'; # default
my $entry_string = $$entry;
# sortinit
my $sinit = $self->get_sortinit_for_key($key);
if (defined($sinit)) {
my $str;
if ($format eq 'bbl') {
$str = "\\field{sortinit}{$sinit}";
}
elsif ($format eq 'bblxml') {
$str = "<bbl:field name=\"sortinit\">$sinit</bbl:field>";
}
$entry_string =~ s|<BDS>SORTINIT</BDS>|$str|gxms;
}
else {# might not be defined if sortscheme returns nothing at all
$entry_string =~ s|^\s*<BDS>SORTINIT</BDS>\n||gxms;
}
# sortinithash
if (defined($sinit)) {
my $str;
# All Unicode::Collate operations are expensive so use a cache when possible
my $sinithash = md5_hex($self->{sortinitcollator}->viewSortKey($sinit));
if ($format eq 'bbl') {
$str = "\\field{sortinithash}{$sinithash}";
}
elsif ($format eq 'bblxml') {
$str = "<bbl:field name=\"sortinithash\">$sinithash</bbl:field>";
}
$entry_string =~ s|<BDS>SORTINITHASH</BDS>|$str|gxms;
}
else {# might not be defined if sortscheme returns nothing at all
$entry_string =~ s|^\s*<BDS>SORTINITHASH</BDS>\n||gxms;
}
# extrayear
if (my $e = $self->get_extrayeardata($key)) {
my $str;
if ($format eq 'bbl') {
$str = "\\field{extrayear}{$e}";
}
elsif ($format eq 'bblxml') {
$str = "<bbl:field name=\"extrayear\">$e</bbl:field>";
}
$entry_string =~ s|<BDS>EXTRAYEAR</BDS>|$str|gxms;
}
# extratitle
if (my $e = $self->get_extratitledata($key)) {
my $str;
if ($format eq 'bbl') {
$str = "\\field{extratitle}{$e}";
}
elsif ($format eq 'bblxml') {
$str = "<bbl:field name=\"extratitle\">$e</bbl:field>";
}
$entry_string =~ s|<BDS>EXTRATITLE</BDS>|$str|gxms;
}
# extratitle
if (my $e = $self->get_extratitleyeardata($key)) {
my $str;
if ($format eq 'bbl') {
$str = "\\field{extratitleyear}{$e}";
}
elsif ($format eq 'bblxml') {
$str = "<bbl:field name=\"extratitleyear\">$e</bbl:field>";
}
$entry_string =~ s|<BDS>EXTRATITLEYEAR</BDS>|$str|gxms;
}
# extraalpha
if (my $e = $self->get_extraalphadata($key)) {
my $str;
if ($format eq 'bbl') {
$str = "\\field{extraalpha}{$e}";
}
elsif ($format eq 'bblxml') {
$str = "<bbl:field name=\"extraalpha\">$e</bbl:field>";
}
$entry_string =~ s|<BDS>EXTRAALPHA</BDS>|$str|gxms;
}
# labelprefix
if (my $pn = $self->get_labelprefix($key)) {
my $str;
if ($format eq 'bbl') {
$str = "\\field{labelprefix}{$pn}";
}
elsif ($format eq 'bblxml') {
$str = "<bbl:field name=\"labelprefix\">$pn</bbl:field>";
}
$entry_string =~ s|<BDS>LABELPREFIX</BDS>|$str|gxms;
}
else {
$entry_string =~ s|^\s*<BDS>LABELPREFIX</BDS>\n||gxms;
}
return $entry_string;
}
1;
__END__
=head1 AUTHORS
François Charette, C<< <firmicus at ankabut.net> >>
Philip Kime C<< <philip at kime.org.uk> >>
=head1 BUGS
Please report any bugs or feature requests on our Github tracker at
L<https://github.com/plk/biber/issues>.
=head1 COPYRIGHT & LICENSE
Copyright 2009-2016 François Charette and Philip Kime, all rights reserved.
This module is free software. You can redistribute it and/or
modify it under the terms of the Artistic License 2.0.
This program is distributed in the hope that it will be useful,
but without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.
=cut
|