logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

String::Copyright - Representation of text-based copyright statements

Author

       Jonas Smedegaard "<dr@jones.dk>"

Bugs/Caveats/Etc

       String::Copyright operates on strings, not bytes.  Data encoded as UTF-8, Latin1 or other formats need to
       be decoded to strings before use.

       Only ASCII characters and © (copyright sign) are directly processed.

       If copyright sign is not detected or accents or multi-byte characters display wrong, then most likely the
       data was not decoded into a string.

       If ranges or lists of years are not tidied, then maybe it contained non-ASCII whitespace or digits.

Description

       String::Copyright identifies copyright statements in a string and serializes them in a normalized format.

Functions

       Exports one function: "copyright".  This module uses Exporter::Tiny to export functions, which allows for
       flexible import options; see the Exporter::Tiny documentation for details.

Name

       String::Copyright - Representation of text-based copyright statements

Options

       Options can be set as an argument to the 'use' statement.

   threshold,threshold_before,threshold_after
           use String::Copyright { threshold_after => 5 };

       Stop parsing after this many lines without copyright information, before or after having found any
       copyright information at all.  "threshold" sets both "threshold_before" and "threshold_after".

       By default unset: All lines are parsed.

   format(\&sub)
           use String::Copyright { format => \&GNU_style } };

           sub GNU_style {
               my ( $years, $owners ) = @_;

               return 'Copyright (C) ' . join '  ', $years || '', $owners || '';
           }

See Also

       •   Encode

       •   Exporter::Tiny

Synopsis

           use String::Copyright;

           my $copyright = copyright(<<'END');
           copr. © 1999,2000 Foo Barbaz <fb@acme.corp> and Acme Corp.
           Copyright (c) 2001,2004 Foo (work address) <foo@zorg.corp>
           Copyright 2003, Foo B. and friends
           © 2000, 2002 Foo Barbaz <foo@bar.baz>
           END

           print $copyright;

           # Copyright 1999-2000 Foo Barbaz <fb@acme.com> and Acme Corp.
           # Copyright 2000, 2002 Foo Barbaz and Acme Corp.
           # Copyright 2001, 2004 Foo (work address) <foo@zorg.org>
           # Copyright 2003 Foo B. and friends

Version

       Version 0.003014

See Also