Biber::Output::base(3)

NAME
Biber::Output::base - base class for Biber output modules.

  new
    Initialize a Biber::Output::base object

  set_output_target_file
    Set the output target file of a Biber::Output::base object
    A convenience around set_output_target so we can keep track of the
    filename. Returns an IO::File object for the target

  get_output_target_file
  Get the output target file name

  set_output_target
    Set the output target of a Biber::Output::base object

  set_output_head
    Set the output head of a Biber::Output::base object
    $data could be anything - the caller is expected to know.

  set_output_tail
    Set the output tail of a Biber::Output::base object
    $data could be anything - the caller is expected to know.

  get_output_head
    Get the output head of a Biber::Output object
    $data could be anything - the caller is expected to know.
    Mainly used in debugging

  get_output_tail
    Get the output tail of a Biber::Output object
    $data could be anything - the caller is expected to know.
    Mainly used in debugging

  add_output_head
    Add to the head output data of a Biber::Output::base object
    The base class method just does a string append

  add_output_tail
    Add to the tail output data of a Biber::Output::base object
    The base class method just does a string append

  set_output_section
  Records the section object in the output object
  We need some information from this when writing the output

  get_output_section
  Retrieve the output section object

  get_output_entries
    Get the sorted order output data for all entries in a list as array ref
    Used really only in tests as it instantiates list dynamic information so
    we can see it in tests. As a result, we have to NFC() the result to mimic
    real output since UTF-8 output is assumed in most tests.

  get_output_macros
    Get the output macros for tool mode tests

  get_output_comments
    Get the output comments for tool mode tests

  clear_output_macros
    Clear the output macros

  clear_output_comments
    Clear the output comments

  get_output_entry
    Get the output data for a specific entry.
    Used really only in tests as it instantiates list dynamic information so
    we can see it in tests. As a result, we have to NFC() the result to mimic
    real output since UTF-8 output is assumed in most tests.

  set_output_entry
    Add an entry output to a Biber::Output::base object
    The base class method just does a dump

  create_output_misc
    Create the output for misc bits and pieces like preamble and closing
    macro call and add to output object.

  create_output_section
    Create the output from the sections data and push it into the
    output object.

  set_output_keyalias
  Set the output for a key which is an alias to another key

  set_output_undefkey
  Set the output for an undefined key

  output
    Generic base output method

AUTHORS
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-2012 Francois Charette and Philip Kime, all rights reserved. Copyright 2012-2025 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.