Data-Buffer-0.06000755001750001750 014703571474 12300 5ustar00timtim000000000000README100644001750001750 113314703571474 13237 0ustar00timtim000000000000Data-Buffer-0.06$Id: README,v 1.2 2001/03/22 20:23:03 btrott Exp $
This is Data::Buffer.
PREREQUISITES
None.
INSTALLATION
Data::Buffer installation is straightforward. If your cpan shell
is set up, you should just be able to do
% perl -MCPAN -e 'install Data::Buffer'
If you don't like that, you can download the distribution; the
latest version on CPAN can be found in
ftp://ftp.cpan.org/pub/CPAN/authors/id/B/BT/BTROTT/
Download it, unpack it, then build it as per the usual:
% perl Makefile.PL
% make && make test
Then install it:
% make install
Benjamin Trott / ben@rhumba.pair.com
Changes100644001750001750 217714703571474 13663 0ustar00timtim000000000000Data-Buffer-0.06$Id: Changes,v 1.6 2001/07/28 06:36:50 btrott Exp $
Revision history for Data::Buffer
0.06 -- Tue Oct 15 19:57:00 ADT 2024
- e020e72 Create .gitignore and MANIFEST.SKIP
- 7c00387 Forgot to update the Changes file
0.05 -- Mon Oct 14 14:46:56 ADT 2024
- 9f6ec5b Use Dist::Zilla for build
- 947604d Update Compyight Year
- cfe3102 (nextversion) Move tests to Test2::v0
- 783b591 Move to more modern structure
- 36ccff6 Initial Import of Data-Buffer-0.04
0.04 2001.07.27
- Added new_with_init.
- Added set_offset and reset_offset.
0.03 2001.07.13
- Fixed bug in get_int8 and put_int8; was using signed char ('c'),
should have been using unsigned char ('C').
- Added get_bytes and put_bytes; the first grabs a number of bytes
from the buffer and returns them, the latter appends bytes into
the buffer.
- Added extract, which grabs a piece of the buffer and returns a
new buffer containing that chunk, updating the offset in the
original buffer.
0.02 2001.05.02
- Fixed number of tests in test suite.
0.01 2001.03.01
- original version; created by h2xs 1.19
LICENSE100644001750001750 4653714703571474 13425 0ustar00timtim000000000000Data-Buffer-0.06This software is copyright (c) 2024 by Benjamin Trott .
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
Terms of the Perl programming language system itself
a) the GNU General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or
b) the "Artistic License"
--- The GNU General Public License, Version 1, February 1989 ---
This software is Copyright (c) 2024 by Benjamin Trott .
This is free software, licensed under:
The GNU General Public License, Version 1, February 1989
GNU GENERAL PUBLIC LICENSE
Version 1, February 1989
Copyright (C) 1989 Free Software Foundation, Inc.
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The license agreements of most software companies try to keep users
at the mercy of those companies. By contrast, our General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. The
General Public License applies to the Free Software Foundation's
software and to any other program whose authors commit to using it.
You can use it for your programs, too.
When we speak of free software, we are referring to freedom, not
price. Specifically, the General Public License is designed to make
sure that you have the freedom to give away or sell copies of free
software, that you receive source code or can get it if you want it,
that you can change the software or use pieces of it in new free
programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of a such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must tell them their rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any program or other work which
contains a notice placed by the copyright holder saying it may be
distributed under the terms of this General Public License. The
"Program", below, refers to any such program or work, and a "work based
on the Program" means either the Program or any work containing the
Program or a portion of it, either verbatim or with modifications. Each
licensee is addressed as "you".
1. You may copy and distribute verbatim copies of the Program's source
code as you receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice and
disclaimer of warranty; keep intact all the notices that refer to this
General Public License and to the absence of any warranty; and give any
other recipients of the Program a copy of this General Public License
along with the Program. You may charge a fee for the physical act of
transferring a copy.
2. You may modify your copy or copies of the Program or any portion of
it, and copy and distribute such modifications under the terms of Paragraph
1 above, provided that you also do the following:
a) cause the modified files to carry prominent notices stating that
you changed the files and the date of any change; and
b) cause the whole of any work that you distribute or publish, that
in whole or in part contains the Program or any part thereof, either
with or without modifications, to be licensed at no charge to all
third parties under the terms of this General Public License (except
that you may choose to grant warranty protection to some or all
third parties, at your option).
c) If the modified program normally reads commands interactively when
run, you must cause it, when started running for such interactive use
in the simplest and most usual way, to print or display an
announcement including an appropriate copyright notice and a notice
that there is no warranty (or else, saying that you provide a
warranty) and that users may redistribute the program under these
conditions, and telling the user how to view a copy of this General
Public License.
d) You may charge a fee for the physical act of transferring a
copy, and you may at your option offer warranty protection in
exchange for a fee.
Mere aggregation of another independent work with the Program (or its
derivative) on a volume of a storage or distribution medium does not bring
the other work under the scope of these terms.
3. You may copy and distribute the Program (or a portion or derivative of
it, under Paragraph 2) in object code or executable form under the terms of
Paragraphs 1 and 2 above provided that you also do one of the following:
a) accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of
Paragraphs 1 and 2 above; or,
b) accompany it with a written offer, valid for at least three
years, to give any third party free (except for a nominal charge
for the cost of distribution) a complete machine-readable copy of the
corresponding source code, to be distributed under the terms of
Paragraphs 1 and 2 above; or,
c) accompany it with the information you received as to where the
corresponding source code may be obtained. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form alone.)
Source code for a work means the preferred form of the work for making
modifications to it. For an executable file, complete source code means
all the source code for all modules it contains; but, as a special
exception, it need not include source code for modules which are standard
libraries that accompany the operating system on which the executable
file runs, or for standard header files or definitions files that
accompany that operating system.
4. You may not copy, modify, sublicense, distribute or transfer the
Program except as expressly provided under this General Public License.
Any attempt otherwise to copy, modify, sublicense, distribute or transfer
the Program is void, and will automatically terminate your rights to use
the Program under this License. However, parties who have received
copies, or rights to use copies, from you under this General Public
License will not have their licenses terminated so long as such parties
remain in full compliance.
5. By copying, distributing or modifying the Program (or any work based
on the Program) you indicate your acceptance of this license to do so,
and all its terms and conditions.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the original
licensor to copy, distribute or modify the Program subject to these
terms and conditions. You may not impose any further restrictions on the
recipients' exercise of the rights granted herein.
7. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of the license which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
the license, you may choose any version ever published by the Free Software
Foundation.
8. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
Appendix: How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to humanity, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest to
attach them to the start of each source file to most effectively convey
the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
Copyright (C) 19yy
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 1, or (at your option)
any later version.
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. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19xx name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the
appropriate parts of the General Public License. Of course, the
commands you use may be called something other than `show w' and `show
c'; they could even be mouse-clicks or menu items--whatever suits your
program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
program `Gnomovision' (a program to direct compilers to make passes
at assemblers) written by James Hacker.
, 1 April 1989
Ty Coon, President of Vice
That's all there is to it!
--- The Perl Artistic License 1.0 ---
This software is Copyright (c) 2024 by Benjamin Trott .
This is free software, licensed under:
The Perl Artistic License 1.0
The "Artistic License"
Preamble
The intent of this document is to state the conditions under which a
Package may be copied, such that the Copyright Holder maintains some
semblance of artistic control over the development of the package,
while giving the users of the package the right to use and distribute
the Package in a more-or-less customary fashion, plus the right to make
reasonable modifications.
Definitions:
"Package" refers to the collection of files distributed by the
Copyright Holder, and derivatives of that collection of files
created through textual modification.
"Standard Version" refers to such a Package if it has not been
modified, or has been modified in accordance with the wishes
of the Copyright Holder as specified below.
"Copyright Holder" is whoever is named in the copyright or
copyrights for the package.
"You" is you, if you're thinking about copying or distributing
this Package.
"Reasonable copying fee" is whatever you can justify on the
basis of media cost, duplication charges, time of people involved,
and so on. (You will not be required to justify it to the
Copyright Holder, but only to the computing community at large
as a market that must bear the fee.)
"Freely Available" means that no fee is charged for the item
itself, though there may be fees involved in handling the item.
It also means that recipients of the item may redistribute it
under the same conditions they received it.
1. You may make and give away verbatim copies of the source form of the
Standard Version of this Package without restriction, provided that you
duplicate all of the original copyright notices and associated disclaimers.
2. You may apply bug fixes, portability fixes and other modifications
derived from the Public Domain or from the Copyright Holder. A Package
modified in such a way shall still be considered the Standard Version.
3. You may otherwise modify your copy of this Package in any way, provided
that you insert a prominent notice in each changed file stating how and
when you changed that file, and provided that you do at least ONE of the
following:
a) place your modifications in the Public Domain or otherwise make them
Freely Available, such as by posting said modifications to Usenet or
an equivalent medium, or placing the modifications on a major archive
site such as uunet.uu.net, or by allowing the Copyright Holder to include
your modifications in the Standard Version of the Package.
b) use the modified Package only within your corporation or organization.
c) rename any non-standard executables so the names do not conflict
with standard executables, which must also be provided, and provide
a separate manual page for each non-standard executable that clearly
documents how it differs from the Standard Version.
d) make other distribution arrangements with the Copyright Holder.
4. You may distribute the programs of this Package in object code or
executable form, provided that you do at least ONE of the following:
a) distribute a Standard Version of the executables and library files,
together with instructions (in the manual page or equivalent) on where
to get the Standard Version.
b) accompany the distribution with the machine-readable source of
the Package with your modifications.
c) give non-standard executables non-standard names, and clearly
document the differences in manual pages (or equivalent), together
with instructions on where to get the Standard Version.
d) make other distribution arrangements with the Copyright Holder.
5. You may charge a reasonable copying fee for any distribution of this
Package. You may charge any fee you choose for support of this
Package. You may not charge a fee for this Package itself. However,
you may distribute this Package in aggregate with other (possibly
commercial) programs as part of a larger (possibly commercial) software
distribution provided that you do not advertise this Package as a
product of your own. You may embed this Package's interpreter within
an executable of yours (by linking); this shall be construed as a mere
form of aggregation, provided that the complete Standard Version of the
interpreter is so embedded.
6. The scripts and library files supplied as input to or produced as
output from the programs of this Package do not automatically fall
under the copyright of this Package, but belong to whoever generated
them, and may be sold commercially, and may be aggregated with this
Package. If such scripts or library files are aggregated with this
Package via the so-called "undump" or "unexec" methods of producing a
binary executable image, then distribution of such an image shall
neither be construed as a distribution of this Package nor shall it
fall under the restrictions of Paragraphs 3 and 4, provided that you do
not represent such an executable image as a Standard Version of this
Package.
7. C subroutines (or comparably compiled subroutines in other
languages) supplied by you and linked into this Package in order to
emulate subroutines and variables of the language defined by this
Package shall not be considered part of this Package, but are the
equivalent of input as in Paragraph 6, provided these subroutines do
not change the language in any way that would cause it to fail the
regression tests for the language.
8. Aggregation of this Package with a commercial distribution is always
permitted provided that the use of this Package is embedded; that is,
when no overt attempt is made to make this Package's interfaces visible
to the end user of the commercial distribution. Such use shall not be
construed as a distribution of this Package.
9. The name of the Copyright Holder may not be used to endorse or promote
products derived from this software without specific prior written permission.
10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
The End
dist.ini100644001750001750 155214703571474 14030 0ustar00timtim000000000000Data-Buffer-0.06name = Data-Buffer
author = Benjamin Trott / ben@rhumba.pair.com
license = Perl_5
abstract = Data::Buffer - Read/write buffer class
copyright_holder = Benjamin Trott
[Meta::Maintainers]
maintainer = Timothy Legge
[@Filter]
-bundle = @Basic
-remove = Readme
[Git::NextVersion]
first_version = 0.05 ; this is the default
version_by_branch = 0 ; this is the default
version_regexp = ^(0.\d+)$ ; this is the default
[OurPkgVersion]
[Prereqs]
[Prereqs/TestRequires]
Test2::V0 = 0
[GithubMeta]
remote = upstream
[NextRelease]
format = %v -- %{EEE MMM dd HH:mm:ss VVV yyyy}d
filename = Changes
[MetaJSON]
[Git::Tag]
tag_format = %V ; this is the default
tag_message = %V ; this is the default
[Git::Commit]
changelog = Changes ; this is the default
[Signature]
[SignReleaseNotes]
t000755001750001750 014703571474 12464 5ustar00timtim000000000000Data-Buffer-0.06test.t100644001750001750 774414703571474 14004 0ustar00timtim000000000000Data-Buffer-0.06/t# $Id: test.pl,v 1.7 2001/07/28 06:36:50 btrott Exp $
use strict;
use Test2::V0;
BEGIN { plan tests => 55 }
use vars qw( $loaded );
END { print "not ok 1\n" unless $loaded; }
use Data::Buffer;
$loaded++;
ok($loaded);
my $buffer = Data::Buffer->new;
ok($buffer, "New Buffer Created");
$buffer->put_str("foo");
ok($buffer->length == 7, "Buffer length is 7");
like($buffer->get_str, qr/foo/, "Buffer read is foo");
ok($buffer->offset == 7, "Buffer offset is 7");
$buffer->put_str(0);
ok($buffer->get_str == 0, "Buffer write read 0");
$buffer->put_int32(999999999);
ok($buffer->get_int32 == 999999999, "Buffer write read int32 999999999");
$buffer->put_int8(2);
ok($buffer->get_int8 == 2, "Buffer write read int8 2");
my $save_off = $buffer->offset;
$buffer->put_int16(9999);
ok($buffer->get_int16 == 9999, "Buffer write read int16 9999");
$buffer->put_char('a');
ok($buffer->get_char eq 'a', "Buffer write read char 'a'");
$buffer->put_chars("bar");
ok($buffer->get_char eq 'b', "Buffer wrote 'bar' read char 'b'");
ok($buffer->get_char eq 'a', "Buffer wrote 'bar' read char 'a'");
ok($buffer->get_char eq 'r', "Buffer wrote 'bar' read char 'r'");
$buffer->put_bytes("foobar", 5);
ok($buffer->get_bytes(5) eq "fooba", "Buffer wrote foobar read 5 bytes 'fooba'");
ok($buffer->offset == $buffer->length, "Buffer offset is length after read");
$buffer->set_offset($save_off);
ok($buffer->offset == $save_off, "set offset matches read offset");
my $buf2 = $buffer->extract(5);
ok($buf2->offset == 0, "New buffer from extract offset is 0");
ok($buf2->length == 5, "New buffer from extract length is 5");
ok($buf2->get_int16 == 9999, "New buffer contains int16 value 9999 from old buffer");
ok($buf2->get_bytes(3) eq 'aba', "New buffer contains bytes 'aba' from old buffer");
$buffer->insert_template;
my @data = $buffer->get_all;
ok(@data == 14, "template contains 14 items");
ok($data[0] eq "foo", "template item 1 is foo");
ok($data[1] == 0, "template item 2 is '0'");
ok($data[2] == 999999999, "template item 3 is '999999999'");
ok($data[3] == 2, "template item 4 is '2'");
ok($data[4] == 9999, "template item 5 is '9999'");
ok($data[5] eq 'a', "template item 6 is 'a'");
ok($data[6] eq 'b', "template item 7 is 'b'");
ok($data[7] eq 'a', "template item 8 is 'a'");
ok($data[8] eq 'r', "template item 9 is 'r'");
ok($data[9] eq 'f', "template item 10 is 'f'");
ok($data[10] eq 'o', "template item 11 is 'o'");
ok($data[11] eq 'o', "template item 12 is 'o'");
ok($data[12] eq 'b', "template item 13 is 'b'");
ok($data[13] eq 'a', "template item 14 is 'a'");
$buffer->empty;
ok($buffer->offset == 0, "Empty buffer sets offset to 0");
ok($buffer->length == 0, "Empty buffer length is 0");
like($buffer->bytes, qr//, "Empty buffer read bytes is empty");
like($buffer->template, qr//, "Empty buffer template is empty");
$buffer->append("foobar");
ok($buffer->length == 6, "Empty Buffer append 'foobar' length is 6");
like($buffer->bytes, qr/foobar/, "Read bytes 'foobar' from buffer");
$buffer->empty;
ok($buffer->length == 0, 'Empty buffer length is zero');
like($buffer->dump, qr//, "Buffer dump hex from empty buffer is empty");
$buffer->put_int16(129);
ok($buffer->get_int16 == 129, "Buffer write int16 '129' - read '129'");
like($buffer->dump, qr/00 81/, "Buffer dump hex from offset 0 matches");
like($buffer->dump(1), qr/81/, "Buffer dump hex index 1 from offset 0 matches");
$buf2 = Data::Buffer->new_with_init("foo");
ok($buf2, "new_with_init 'foo' created");
ok($buf2->length == 3, "new_with_init 'foo' - length is 3");
like($buf2->bytes, qr/foo/, "new_with_init 'foo' - matches 'foo'");
$buf2 = Data::Buffer->new_with_init("foo", "bar");
ok($buf2, "new_with_init 'foobar' created");
ok($buf2->length == 6, "new_with_init 'foobar' - length is 6");
like($buf2->bytes, qr/foobar/, "new_with_init 'foobar' - matches 'foobar'");
like($buf2->get_bytes(3), qr/foo/, "new_with_init 'foobar' - read 3 yytes matches 'foo'");
$buf2->reset_offset;
ok($buf2->offset == 0, "Reset buffer offset - offset is 0");
ok($buf2->length == 6, "Buffer 2 length is 6");
META.yml100644001750001750 137114703571474 13634 0ustar00timtim000000000000Data-Buffer-0.06---
abstract: 'Data::Buffer - Read/write buffer class'
author:
- 'Benjamin Trott / ben@rhumba.pair.com'
build_requires:
Test2::V0: '0'
configure_requires:
ExtUtils::MakeMaker: '0'
dynamic_config: 0
generated_by: 'Dist::Zilla version 6.032, CPAN::Meta::Converter version 2.150010'
license: perl
meta-spec:
url: http://module-build.sourceforge.net/META-spec-v1.4.html
version: '1.4'
name: Data-Buffer
resources:
homepage: https://github.com/perl-Crypt-OpenPGP/Data-Buffer
repository: https://github.com/perl-Crypt-OpenPGP/Data-Buffer.git
version: '0.06'
x_generated_by_perl: v5.38.2
x_maintainers:
- 'Timothy Legge '
x_serialization_backend: 'YAML::Tiny version 1.74'
x_spdx_expression: 'Artistic-1.0-Perl OR GPL-1.0-or-later'
MANIFEST100644001750001750 31514703571474 13471 0ustar00timtim000000000000Data-Buffer-0.06# This file was automatically generated by Dist::Zilla::Plugin::Manifest v6.032.
Changes
LICENSE
MANIFEST
MANIFEST.SKIP
META.json
META.yml
Makefile.PL
README
SIGNATURE
dist.ini
lib/Data/Buffer.pm
t/test.t
META.json100644001750001750 231414703571474 14002 0ustar00timtim000000000000Data-Buffer-0.06{
"abstract" : "Data::Buffer - Read/write buffer class",
"author" : [
"Benjamin Trott / ben@rhumba.pair.com"
],
"dynamic_config" : 0,
"generated_by" : "Dist::Zilla version 6.032, CPAN::Meta::Converter version 2.150010",
"license" : [
"perl_5"
],
"meta-spec" : {
"url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec",
"version" : 2
},
"name" : "Data-Buffer",
"prereqs" : {
"configure" : {
"requires" : {
"ExtUtils::MakeMaker" : "0"
}
},
"test" : {
"requires" : {
"Test2::V0" : "0"
}
}
},
"release_status" : "stable",
"resources" : {
"homepage" : "https://github.com/perl-Crypt-OpenPGP/Data-Buffer",
"repository" : {
"type" : "git",
"url" : "https://github.com/perl-Crypt-OpenPGP/Data-Buffer.git",
"web" : "https://github.com/perl-Crypt-OpenPGP/Data-Buffer"
}
},
"version" : "0.06",
"x_generated_by_perl" : "v5.38.2",
"x_maintainers" : [
"Timothy Legge "
],
"x_serialization_backend" : "Cpanel::JSON::XS version 4.38",
"x_spdx_expression" : "Artistic-1.0-Perl OR GPL-1.0-or-later"
}
SIGNATURE100644001750001750 434614703571474 13654 0ustar00timtim000000000000Data-Buffer-0.06This file contains message digests of all files listed in MANIFEST,
signed via the Module::Signature module, version 0.89.
To verify the content in this distribution, first make sure you have
Module::Signature installed, then type:
% cpansign -v
It will check each file's integrity, as well as the signature's
validity. If "==> Signature verified OK! <==" is not displayed,
the distribution may already have been compromised, and you should
not run its Makefile.PL or Build.PL.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: RIPEMD160
SHA256 5a1bfa2b95661a647f4427cc9f4ae6605d262d15fd23146d9bae6f222ac2ca90 Changes
SHA256 fc96d87c346aea24cd76d6ca8427e45efcbdcee4f8df43a694fcd2f79f9d2a20 LICENSE
SHA256 8cf5677712022e8ace1db8698759f9f6c1549ece295650ee8f76fe600890ae54 MANIFEST
SHA256 d0f4e76bd518407c9e27b9f225e980459bfc4edda979eba81acd647469c17103 MANIFEST.SKIP
SHA256 8c9ec00db2d4530861cd8635d57e18a162fa0a91d69653f5ee8c4d77ee4bb7d5 META.json
SHA256 244d23623952e30ee18c75c463f703c42d9d7a7ecf08c1d83e4a8c8f75ca86f7 META.yml
SHA256 7e99ee58a15b6ebe9cd27d46a2d36797cf34f348d5cbdf340ea39b60b02b9aea Makefile.PL
SHA256 4a3d6f7f5527c749b8dc0508a17eb51588402b051ed056e548b9a548fbca67cd README
SHA256 3dc2f180871a58964a122b5d64e483825ef0234dde0ba1023ea62752f8dcf96b dist.ini
SHA256 d1e7d63d95153e2b72a075030a87bc8e14d7aa2711360bd7247ac495cbea8ceb lib/Data/Buffer.pm
SHA256 22e84ba19589dd4734eb46f35b31dcba13cd14813ec87cb65ef4de18c8f8bc45 t/test.t
-----BEGIN PGP SIGNATURE-----
iQIzBAEBAwAdFiEEMguXHBCUSzAt6mNu1fh7LgYGpfkFAmcO8zwACgkQ1fh7LgYG
pfnn1Q/9FZoH+s2UA79TYrQbk7jcZbwMgSLbdr+2IH7SIzzs9nd1R/yZL02wicvo
EI2PGPP2Il8/iGJqDZGE3eW/nKKyTy9zVtwbgNAVli82bHjg294t2xerF9pwXmBB
WWDa1KAkZDcXs5WwqLbKUiBNHyVdsY3rr2j37duKrg/gLz5r8nOlg0oPczkTTxd+
i2sWLSQkFZ9pRAptlUwdXglxN31ERC8kqZXFC5i137RZk/cr+0jb1lcp0r1+6z8Q
d9f0sOKfYS+CiYgWCfDoXdQspBnUGSfBQembFBtndZKfm69IJWfjwrrrOFlOJRwA
9mQKFcsF1l0PtDfFj31CxL2fX1Ul60Au1+VD83oVyFYaN0EorT+v3ywOnWt+d9KR
1zFvPHflclOwVb7HrObBn7fZVBvjPr9C4ZMGtQZv7dhAg5RDIb5Dehv2yVTMvoky
oLGnJJpYIT92nC1/cZQihUCEGKn45HSrUdDj8ZSSebmAfnmbmwoiHr/axVODH2h7
Utw7BYAR8ZNbUD75BvUl0f7dtpdYyKemtJZvZcnVqXiWte8ietU+NjmnTOfImQRQ
qY73Zgt6+xymHBh4WvpfwEF/4v4mcw+SSCjuhY0Yh2sqJrwrv9skhzk7ZfHu7J+i
Dg8zDwl1afKEP1P06RbH0fSuALzZMn8DRZr0FxYbatjMhLbkaRQ=
=ci4x
-----END PGP SIGNATURE-----
Makefile.PL100644001750001750 166614703571474 14344 0ustar00timtim000000000000Data-Buffer-0.06# This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v6.032.
use strict;
use warnings;
use ExtUtils::MakeMaker;
my %WriteMakefileArgs = (
"ABSTRACT" => "Data::Buffer - Read/write buffer class",
"AUTHOR" => "Benjamin Trott / ben\@rhumba.pair.com",
"CONFIGURE_REQUIRES" => {
"ExtUtils::MakeMaker" => 0
},
"DISTNAME" => "Data-Buffer",
"LICENSE" => "perl",
"NAME" => "Data::Buffer",
"PREREQ_PM" => {},
"TEST_REQUIRES" => {
"Test2::V0" => 0
},
"VERSION" => "0.06",
"test" => {
"TESTS" => "t/*.t"
}
);
my %FallbackPrereqs = (
"Test2::V0" => 0
);
unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) {
delete $WriteMakefileArgs{TEST_REQUIRES};
delete $WriteMakefileArgs{BUILD_REQUIRES};
$WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs;
}
delete $WriteMakefileArgs{CONFIGURE_REQUIRES}
unless eval { ExtUtils::MakeMaker->VERSION(6.52) };
WriteMakefile(%WriteMakefileArgs);
MANIFEST.SKIP100644001750001750 1314703571474 14211 0ustar00timtim000000000000Data-Buffer-0.06^Release-*
Data000755001750001750 014703571474 13640 5ustar00timtim000000000000Data-Buffer-0.06/libBuffer.pm100644001750001750 2716214703571474 15577 0ustar00timtim000000000000Data-Buffer-0.06/lib/Data# $Id: Buffer.pm,v 1.9 2001/07/28 06:36:50 btrott Exp $
package Data::Buffer;
use strict;
use vars qw( $VERSION );
our $VERSION = '0.06'; # VERSION
sub new {
my $class = shift;
my %arg = @_;
bless { buf => "", offset => 0, template => "" }, $class;
}
sub new_with_init {
my $class = shift;
my $buf = $class->new;
$buf->append($_) for @_;
$buf;
}
sub extract {
my $buf = shift;
my($nbytes) = @_;
my $new = ref($buf)->new;
$new->append( $buf->get_bytes($nbytes) );
$new;
}
sub empty {
my $buf = shift;
$buf->{buf} = "";
$buf->{offset} = 0;
$buf->{template} = "";
}
sub set_offset { $_[0]->{offset} = $_[1] }
sub reset_offset { $_[0]->set_offset(0) }
sub insert_template {
my $buf = shift;
$buf->bytes(0, 0, $buf->{template} . chr(0));
}
sub append {
my $buf = shift;
$buf->{buf} .= $_[0];
}
sub bytes {
my $buf = shift;
my($off, $len, $rep) = @_;
$off ||= 0;
$len = length $buf->{buf} unless defined $len;
return defined $rep ?
substr($buf->{buf}, $off, $len, $rep) :
substr($buf->{buf}, $off, $len);
}
sub length { length $_[0]->{buf} }
sub offset { $_[0]->{offset} }
sub template { $_[0]->{template} }
sub dump {
my $buf = shift;
my @r;
for my $c (split //, $buf->bytes(@_)) {
push @r, sprintf "%02x", ord $c;
push @r, "\n" unless @r % 24;
}
join ' ', @r
}
sub get_all {
my $buf = shift;
my($tmpl, $data) = $buf->{buf} =~ /^([NYaCn\d]+)\0(.+)$/s or
die "Buffer $buf does not appear to contain a template";
my $b = __PACKAGE__->new;
$b->append($data);
my @tmpl = split //, $tmpl;
my @data;
while (@tmpl) {
my $el = shift @tmpl;
if ($el eq "N") {
next if $tmpl[0] eq "Y"; ## Peek ahead: is it a string?
push @data, $b->get_int32;
}
elsif ($el eq "n") {
push @data, $b->get_int16;
}
elsif ($el eq "C") {
push @data, $b->get_int8;
}
elsif ($el eq "a") {
my $len = shift @tmpl;
push @data, $b->get_char for 1..$len;
}
elsif ($el eq "Y") {
push @data, $b->get_str;
}
else {
die "Unrecognized template token: $el";
}
}
@data;
}
sub get_int8 {
my $buf = shift;
my $off = defined $_[0] ? shift : $buf->{offset};
$buf->{offset} += 1;
unpack "C", $buf->bytes($off, 1);
}
sub put_int8 {
my $buf = shift;
$buf->{buf} .= pack "C", $_[0];
$buf->{template} .= "C";
}
sub get_int16 {
my $buf = shift;
my $off = defined $_[0] ? shift : $buf->{offset};
$buf->{offset} += 2;
unpack "n", $buf->bytes($off, 2);
}
sub put_int16 {
my $buf = shift;
$buf->{buf} .= pack "n", $_[0];
$buf->{template} .= "n";
}
sub get_int32 {
my $buf = shift;
my $off = defined $_[0] ? shift : $buf->{offset};
$buf->{offset} += 4;
unpack "N", $buf->bytes($off, 4);
}
sub put_int32 {
my $buf = shift;
$buf->{buf} .= pack "N", $_[0];
$buf->{template} .= "N";
}
sub get_char {
my $buf = shift;
my $off = defined $_[0] ? shift : $buf->{offset};
$buf->{offset}++;
$buf->bytes($off, 1);
}
sub put_char {
my $buf = shift;
$buf->{buf} .= $_[0];
$buf->{template} .= "a" . CORE::length($_[0]);
}
sub get_bytes {
my $buf = shift;
my($nbytes) = @_;
my $d = $buf->bytes($buf->{offset}, $nbytes);
$buf->{offset} += $nbytes;
$d;
}
sub put_bytes {
my $buf = shift;
my($str, $nbytes) = @_;
$buf->{buf} .= $nbytes ? substr($str, 0, $nbytes) : $str;
$buf->{template} .= "a" . ($nbytes ? $nbytes : CORE::length($str));
}
*put_chars = \&put_char;
sub get_str {
my $buf = shift;
my $off = defined $_[0] ? shift : $buf->{offset};
my $len = $buf->get_int32;
$buf->{offset} += $len;
$buf->bytes($off+4, $len);
}
sub put_str {
my $buf = shift;
my $str = shift;
$str = "" unless defined $str;
$buf->put_int32(CORE::length($str));
$buf->{buf} .= $str;
$buf->{template} .= "Y";
}
1;
__END__
=head1 NAME
Data::Buffer - Read/write buffer class
=head1 SYNOPSIS
use Data::Buffer;
my $buffer = Data::Buffer->new;
## Add a 32-bit integer.
$buffer->put_int32(10932930);
## Get it back.
my $int = $buffer->get_int32;
=head1 DESCRIPTION
I implements a low-level binary buffer in which
you can get and put integers, strings, and other data.
Internally the implementation is based on C and C,
such that I is really a layer on top of those
built-in functions.
All of the I and I methods respect the
internal offset state in the buffer object. This means that
you should read data out of the buffer in the same order that
you put it in. For example:
$buf->put_int16(24);
$buf->put_int32(1233455);
$buf->put_int16(99);
$buf->get_int16; # 24
$buf->get_int32; # 1233455
$buf->get_int16; # 99
Of course, this assumes that you I the order of the data
items in the buffer. If your setup is such that your sending
and receiving processes won't necessarily know what's inside
the buffers they receive, take a look at the I
section.
=head1 USAGE
=head2 Data::Buffer->new
Creates a new buffer object and returns it. The buffer is
initially empty.
This method takes no arguments.
=head2 Data::Buffer->new_with_init(@strs)
Creates a new buffer object and appends to it each of the
octet strings in I<@strs>.
Returns the new buffer object.
=head2 $buffer->get_int8
Returns the next 8-bit integer from the buffer (which
is really just the ASCII code for the next character/byte
in the buffer).
=head2 $buffer->put_int8
Appends an 8-bit integer to the buffer (which is really
just the character corresponding to that integer, in
ASCII).
=head2 $buffer->get_int16
Returns the next 16-bit integer from the buffer.
=head2 $buffer->put_int16($integer)
Appends a 16-bit integer to the buffer.
=head2 $buffer->get_int32
Returns the next 32-bit integer from the buffer.
=head2 $buffer->put_int32($integer)
Appends a 32-bit integer to the buffer.
=head2 $buffer->get_char
More appropriately called I, perhaps, this
returns the next byte from the buffer.
=head2 $buffer->put_char($bytes)
Appends a byte (or a sequence of bytes) to the buffer.
There is no restriction on the length of the byte
string I<$bytes>; if it makes you uncomfortable to call
I to put multiple bytes, you can instead
call this method as I. It's the same thing.
=head2 $buffer->get_bytes($n)
Grabs I<$n> bytes from the buffer, where I<$n> is a positive
integer. Increments the internal offset state by I<$n>.
=head2 $buffer->put_bytes($bytes [, $n ])
Appends a sequence of bytes to the buffer; if I<$n> is
unspecified, appends the entire length of I<$bytes>.
Otherwise appends only the first I<$n> bytes of I<$bytes>.
=head2 $buffer->get_str
Returns the next "string" from the buffer. A string here
is represented as the length of the string (a 32-bit
integer) followed by the string itself.
=head2 $buffer->put_str($string)
Appends a string (32-bit integer length and the string
itself) to the buffer.
=head2 $buffer->extract($n)
Extracts the next I<$n> bytes from the buffer I<$buffer>,
increments the offset state in I<$buffer>, and returns a
new buffer object containing the extracted bytes.
=head1 TEMPLATE USAGE
Generally when you use I it's to communicate
with another process (perhaps a C program) that bundles up
its data into binary buffers. In those cases, it's very likely
that the data will be in some well-known order in the buffer:
in other words, it might be documented that a certain C program
creates a buffer containing:
=over 4
=item * an int8
=item * a string
=item * an int32
=back
In this case, you would presumably know about the order of the
data in the buffer, and you could extract it accordingly:
$buffer->get_int8;
$buffer->get_str;
$buffer->get_int32;
In other cases, however, there may not be a well-defined order
of data items in the buffer. This might be the case if you're
inventing your own protocol, and you want your binary buffers
to "know" about their contents. In this case, you'll want to
use the templating features of I.
When you use the I methods to place data in a buffer,
I keeps track of the types of data that you're
inserting in a template description of the buffer. This template
contains all of the information necessary for a process to
receive a buffer and extract the data in the buffer without
knowledge of the order of the items.
To use this feature, simply use the I method
after you've filled your buffer to completion. For example:
my $buffer = Data::Buffer->new;
$buffer->put_str("foo");
$buffer->put_int32(9999);
$buffer->insert_template;
## Ship off the buffer to another process.
The receiving process should then invoke the I method
on the buffer to extract all of the data:
my $buffer = Data::Buffer->new;
$buffer->append( $received_buffer_data );
my @data = $buffer->get_all;
@data will now contain two elements: C<"foo"> and C<9999>.
=head1 LOW-LEVEL METHODS
=head2 $buffer->append($bytes)
Appends raw data I<$bytes> to the end of the in-memory
buffer. Generally you don't need to use this method
unless you're initializing an empty buffer, because
when you need to add data to a buffer you should
generally use one of the I methods.
=head2 $buffer->empty
Empties out the buffer object.
=head2 $buffer->bytes([ $offset [, $length [, $replacement ]]])
Behaves exactly like the I built-in function,
except on the buffer I<$buffer>. Given no arguments,
I returns the entire buffer; given one argument
I<$offset>, returns everything from that position to
the end of the string; given I<$offset> and I<$length>,
returns the segment of the buffer starting at I<$offset>
and consisting of I<$length> bytes; and given all three
arguments, replaces that segment with I<$replacement>.
This is a very low-level method, and you generally
won't need to use it.
Also be warned that you should not intermix use of this
method with use of the I and I methods;
the latter classes of methods maintain internal state
of the buffer offset where arguments will be gotten from
and put, respectively. The I method gives no
thought to this internal offset state.
=head2 $buffer->length
Returns the length of the buffer object.
=head2 $buffer->offset
Returns the internal offset state.
If you insist on intermixing calls to I with calls
to the I and I methods, you'll probably
want to use this method to get some status on that
internal offset.
=head2 $buffer->set_offset($offset)
Sets the internal offset state to I<$offset>.
=head2 $buffer->reset_offset
Sets the internal offset state to 0.
=head2 $buffer->dump(@args)
Returns a hex dump of the buffer. The dump is of the I
buffer I<$buffer>; in other words, I doesn't respect the
internal offset pointer.
I<@args> is passed directly through to the I method,
which means that you can supply arguments to emulate support
of the internal offset:
my $dump = $buffer->dump($buffer->offset);
=head2 $buffer->insert_padding
A helper method: pads out the buffer so that the length
of the transferred packet will be evenly divisible by
8, which is a requirement of the SSH protocol.
=head1 AUTHOR & COPYRIGHTS
Benjamin Trott, ben@rhumba.pair.com
Except where otherwise noted, Data::Buffer is Copyright 2001 to 2024
Benjamin Trott. All rights reserved. Data::Buffer is free
software; you may redistribute it and/or modify it under
the same terms as Perl itself.
=cut