GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  BIBER::UTILS (3)

.ds Aq ’

NAME

Biber::Utils - Various utility subs used in Biber

CONTENTS

EXPORT

All functions are exported by default.

FUNCTIONS

    locate_biber_file



  Searches for a file by

  The exact path if the filename is absolute
  In the input_directory, if defined
  In the output_directory, if defined
  Relative to the current directory
  In the same directory as the control file
  Using kpsewhich, if available



    biber_warn



    Wrapper around various warnings bits and pieces
    Logs a warning, add warning to the list of .bbl warnings and optionally
    increments warning count in Biber object, if present



    biber_error



    Wrapper around error logging
    Forces an exit.



    makenamesid

Given a Biber::Names object, return an underscore normalised concatenation of all of the full name strings.

    makenameid

Given a Biber::Name object, return an underscore normalised concatenation of the full name strings.

    latex_recode_output



  Tries to convert UTF-8 to TeX macros in passed string



    strip_noinit



  Removes elements which are not to be considered during initials generation
  in names



    strip_nosort



  Removes elements which are not to be used in sorting a name from a string



    normalise_string_label

Remove some things from a string for label generation, like braces. It also decodes LaTeX character macros into Unicode as this is always safe when normalising strings for sorting since they don’t appear in the output.

    normalise_string_sort

Removes LaTeX macros, and all punctuation, symbols, separators and control characters, as well as leading and trailing whitespace for sorting strings. It also decodes LaTeX character macros into Unicode as this is always safe when normalising strings for sorting since they don’t appear in the output.

    normalise_string

Removes LaTeX macros, and all punctuation, symbols, separators and control characters, as well as leading and trailing whitespace for sorting strings. Only decodes LaTeX character macros into Unicode if output is UTF-8

    normalise_string_common



  Common bit for normalisation



    normalise_string_hash



  Normalise strings used for hashes. We collapse LaTeX macros into a vestige
  so that hashes are unique between things like:

  Smith
  {\v S}mith

  we replace macros like this to preserve their vestiges:

  \v S -> v:
  \" -> 34:



    normalise_string_underscore



  Like normalise_string, but also substitutes ~ and whitespace with underscore.



    escape_label



  Escapes a few special character which might be used in labels



    unescape_label



  Unscapes a few special character which might be used in label but which need
  sorting without escapes



    reduce_array

reduce_array(\@a, \@b) returns all elements in @a that are not in @b

    remove_outer



    Remove surrounding curly brackets:
        {string} -> string



    add_outer



    Add surrounding curly brackets:
        string -> {string}



    ucinit



    upper case of initial letters in a string



    is_undef



    Checks for undefness of arbitrary things, including
    composite method chain calls which dont reliably work
    with defined() (see perldoc for defined())
    This works because we are just testing the value passed
    to this sub. So, for example, this is randomly unreliable
    even if the resulting value of the arg to defined() is "undef":

    defined($thing->method($arg)->method)

    wheras:

    is_undef($thing->method($arg)->method)

    works since we only test the return value of all the methods
    with defined()



    is_def



    Checks for definedness in the same way as is_undef()



    is_undef_or_null



    Checks for undef or nullness (see is_undef() above)



    is_def_and_notnull



    Checks for def and unnullness (see is_undef() above)



    is_def_and_null



    Checks for def and nullness (see is_undef() above)



    is_null



    Checks for nullness



    is_notnull



    Checks for notnullness



    is_notnull_scalar



    Checks for notnullness of a scalar



    is_notnull_array



    Checks for notnullness of an array (passed by ref)



    is_notnull_hash



    Checks for notnullness of an hash (passed by ref)



    is_notnull_object



    Checks for notnullness of an object (passed by ref)



    stringify_hash



    Turns a hash into a string of keys and values



    normalise_utf8



  Normalise any UTF-8 encoding string immediately to exactly what we want
  We want the strict perl utf8 "UTF-8"



    inits



   We turn the initials into an array so we can be flexible with them later
   The tie here is used only so we know what to split on. We dont want to make
   any typesetting decisions in Biber, like what to use to join initials so on
   output to the .bbl, we only use BibLaTeX macros.



    join_name



  Replace all join typsetting elements in a name part (space, ties) with BibLaTeX macros
  so that typesetting decisions are made in BibLaTeX, not hard-coded in Biber



    filter_entry_options



    Process any per_entry option transformations which are necessary



    imatch



    Do an interpolating (neg)match using a match RE and a string passed in as variables



    ireplace



    Do an interpolating match/replace using a match RE, replacement RE
    and string passed in as variables



    validate_biber_xml



  Validate a biber/biblatex XML metadata file against an RNG schema



    process_entry_options



    Set per-entry options



    parse_date



  Simple parse of ISO8601 dates because not decent module exists for this that
  doesnt default the missing components



    biber_decode_utf8



    Perform NFD form conversion as well as UTF-8 conversion. Used to normalize
    bibtex input as the T::B interface doesnt allow a neat whole file slurping.



    out



  Output to target. Outputs NFC UTF-8 if output is UTF-8



    locale2bcp47



  Map babel/polyglossia language options to a sensible CLDR (bcp47) locale default
  Return input string if there is no mapping



    bcp472locale



  Map CLDR (bcp47) locale to a babel/polyglossia locale
  Return input string if there is no mapping



    rangelen



  Calculate the length of a range field
  Range fields are an array ref of two-element array refs [range_start, range_end]
  range_end can be be empty for open-ended range or undef
  Deals with Unicode and ASCII roman numerals via the magic of Unicode NFKD form

  m-n -> [m, n]
  m   -> [m, undef]
  m-  -> [m, ]
  -n  -> [, n]
  -   -> [, undef]



AUTHOR

Franc\k:,ois Charette, <firmicus at ankabut.net> Philip Kime <philip at kime.org.uk>

BUGS

Please report any bugs or feature requests on our Github tracker at <https://github.com/plk/biber/issues>.

COPYRIGHT & LICENSE

Copyright 2009-2015 Franc\k:,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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 BIBER::UTILS (3) 2016-04-05

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.