Compare commits
27 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 210a689cee | |||
| 2cd45c0750 | |||
| 19ad6abf83 | |||
| 62d651fc6c | |||
| 029efbbf5e | |||
| f7cdbf4882 | |||
| 82a9243e2b | |||
| 470c018828 | |||
| 435c338c8f | |||
| d31b8cb376 | |||
| 6ffeb39801 | |||
| 8169651729 | |||
| edcaebcf53 | |||
| 64c2e51104 | |||
| 227579d1e2 | |||
| 4eaf5b53c0 | |||
| 7e78bca810 | |||
| 1d6b086bfa | |||
| be4f2ae036 | |||
| bffab94715 | |||
| aefef92370 | |||
| d8671350a4 | |||
| fb15184848 | |||
| 3c93056416 | |||
| 71ff3d4260 | |||
| bce26d3a4b | |||
| 44120b7ebb |
4
.github/workflows/docs.yml
vendored
4
.github/workflows/docs.yml
vendored
@ -1,8 +1,8 @@
|
||||
name: Deploy documentation
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
push:
|
||||
branches: ["main"]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
51
.gitignore
vendored
51
.gitignore
vendored
@ -1,49 +1,2 @@
|
||||
# ---> C++
|
||||
# Prerequisites
|
||||
*.d
|
||||
|
||||
# Compiled Object files
|
||||
*.slo
|
||||
*.lo
|
||||
*.o
|
||||
*.obj
|
||||
|
||||
# Precompiled Headers
|
||||
*.gch
|
||||
*.pch
|
||||
|
||||
# Compiled Dynamic libraries
|
||||
*.so
|
||||
*.dylib
|
||||
*.dll
|
||||
|
||||
# Fortran module files
|
||||
*.mod
|
||||
*.smod
|
||||
|
||||
# Compiled Static libraries
|
||||
*.lai
|
||||
*.la
|
||||
*.a
|
||||
*.lib
|
||||
|
||||
# Executables
|
||||
*.exe
|
||||
*.out
|
||||
*.app
|
||||
|
||||
# Bazel
|
||||
bazel-*
|
||||
*.bazel*
|
||||
WORKSPACE.bazel
|
||||
BUILD.bazel
|
||||
|
||||
# Dirs
|
||||
bin
|
||||
obj
|
||||
lib
|
||||
doc
|
||||
cov
|
||||
|
||||
# IDE
|
||||
.vscode
|
||||
build*
|
||||
.cache
|
||||
|
||||
2
AUTHORS
2
AUTHORS
@ -1,5 +1,5 @@
|
||||
libbasen project authors:
|
||||
|
||||
commits | username
|
||||
70 | vSEK1RO
|
||||
90 | vSEK1RO
|
||||
|
||||
|
||||
2
Doxyfile
2
Doxyfile
@ -48,7 +48,7 @@ PROJECT_NAME = libbasen
|
||||
# could be handy for archiving the generated documentation or if some version
|
||||
# control system is used.
|
||||
|
||||
PROJECT_NUMBER = v1.0.1
|
||||
PROJECT_NUMBER = v1.1.0
|
||||
|
||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||
# for a project that appears at the top of each page and should give viewer a
|
||||
|
||||
827
LICENSE
827
LICENSE
@ -1,674 +1,165 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
GNU LESSER GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), 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 prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey 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;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU 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 that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
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.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
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.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
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 the public, 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
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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 3 of the License, 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, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program 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, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
||||
This version of the GNU Lesser General Public License incorporates
|
||||
the terms and conditions of version 3 of the GNU General Public
|
||||
License, supplemented by the additional permissions listed below.
|
||||
|
||||
0. Additional Definitions.
|
||||
|
||||
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||
General Public License.
|
||||
|
||||
"The Library" refers to a covered work governed by this License,
|
||||
other than an Application or a Combined Work as defined below.
|
||||
|
||||
An "Application" is any work that makes use of an interface provided
|
||||
by the Library, but which is not otherwise based on the Library.
|
||||
Defining a subclass of a class defined by the Library is deemed a mode
|
||||
of using an interface provided by the Library.
|
||||
|
||||
A "Combined Work" is a work produced by combining or linking an
|
||||
Application with the Library. The particular version of the Library
|
||||
with which the Combined Work was made is also called the "Linked
|
||||
Version".
|
||||
|
||||
The "Minimal Corresponding Source" for a Combined Work means the
|
||||
Corresponding Source for the Combined Work, excluding any source code
|
||||
for portions of the Combined Work that, considered in isolation, are
|
||||
based on the Application, and not on the Linked Version.
|
||||
|
||||
The "Corresponding Application Code" for a Combined Work means the
|
||||
object code and/or source code for the Application, including any data
|
||||
and utility programs needed for reproducing the Combined Work from the
|
||||
Application, but excluding the System Libraries of the Combined Work.
|
||||
|
||||
1. Exception to Section 3 of the GNU GPL.
|
||||
|
||||
You may convey a covered work under sections 3 and 4 of this License
|
||||
without being bound by section 3 of the GNU GPL.
|
||||
|
||||
2. Conveying Modified Versions.
|
||||
|
||||
If you modify a copy of the Library, and, in your modifications, a
|
||||
facility refers to a function or data to be supplied by an Application
|
||||
that uses the facility (other than as an argument passed when the
|
||||
facility is invoked), then you may convey a copy of the modified
|
||||
version:
|
||||
|
||||
a) under this License, provided that you make a good faith effort to
|
||||
ensure that, in the event an Application does not supply the
|
||||
function or data, the facility still operates, and performs
|
||||
whatever part of its purpose remains meaningful, or
|
||||
|
||||
b) under the GNU GPL, with none of the additional permissions of
|
||||
this License applicable to that copy.
|
||||
|
||||
3. Object Code Incorporating Material from Library Header Files.
|
||||
|
||||
The object code form of an Application may incorporate material from
|
||||
a header file that is part of the Library. You may convey such object
|
||||
code under terms of your choice, provided that, if the incorporated
|
||||
material is not limited to numerical parameters, data structure
|
||||
layouts and accessors, or small macros, inline functions and templates
|
||||
(ten or fewer lines in length), you do both of the following:
|
||||
|
||||
a) Give prominent notice with each copy of the object code that the
|
||||
Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
4. Combined Works.
|
||||
|
||||
You may convey a Combined Work under terms of your choice that,
|
||||
taken together, effectively do not restrict modification of the
|
||||
portions of the Library contained in the Combined Work and reverse
|
||||
engineering for debugging such modifications, if you also do each of
|
||||
the following:
|
||||
|
||||
a) Give prominent notice with each copy of the Combined Work that
|
||||
the Library is used in it and that the Library and its use are
|
||||
covered by this License.
|
||||
|
||||
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||
document.
|
||||
|
||||
c) For a Combined Work that displays copyright notices during
|
||||
execution, include the copyright notice for the Library among
|
||||
these notices, as well as a reference directing the user to the
|
||||
copies of the GNU GPL and this license document.
|
||||
|
||||
d) Do one of the following:
|
||||
|
||||
0) Convey the Minimal Corresponding Source under the terms of this
|
||||
License, and the Corresponding Application Code in a form
|
||||
suitable for, and under terms that permit, the user to
|
||||
recombine or relink the Application with a modified version of
|
||||
the Linked Version to produce a modified Combined Work, in the
|
||||
manner specified by section 6 of the GNU GPL for conveying
|
||||
Corresponding Source.
|
||||
|
||||
1) Use a suitable shared library mechanism for linking with the
|
||||
Library. A suitable mechanism is one that (a) uses at run time
|
||||
a copy of the Library already present on the user's computer
|
||||
system, and (b) will operate properly with a modified version
|
||||
of the Library that is interface-compatible with the Linked
|
||||
Version.
|
||||
|
||||
e) Provide Installation Information, but only if you would otherwise
|
||||
be required to provide such information under section 6 of the
|
||||
GNU GPL, and only to the extent that such information is
|
||||
necessary to install and execute a modified version of the
|
||||
Combined Work produced by recombining or relinking the
|
||||
Application with a modified version of the Linked Version. (If
|
||||
you use option 4d0, the Installation Information must accompany
|
||||
the Minimal Corresponding Source and Corresponding Application
|
||||
Code. If you use option 4d1, you must provide the Installation
|
||||
Information in the manner specified by section 6 of the GNU GPL
|
||||
for conveying Corresponding Source.)
|
||||
|
||||
5. Combined Libraries.
|
||||
|
||||
You may place library facilities that are a work based on the
|
||||
Library side by side in a single library together with other library
|
||||
facilities that are not Applications and are not covered by this
|
||||
License, and convey such a combined library under terms of your
|
||||
choice, if you do both of the following:
|
||||
|
||||
a) Accompany the combined library with a copy of the same work based
|
||||
on the Library, uncombined with any other library facilities,
|
||||
conveyed under the terms of this License.
|
||||
|
||||
b) Give prominent notice with the combined library that part of it
|
||||
is a work based on the Library, and explaining where to find the
|
||||
accompanying uncombined form of the same work.
|
||||
|
||||
6. Revised Versions of the GNU Lesser General Public License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU Lesser 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
|
||||
Library as you received it specifies that a certain numbered version
|
||||
of the GNU Lesser General Public License "or any later version"
|
||||
applies to it, you have the option of following the terms and
|
||||
conditions either of that published version or of any later version
|
||||
published by the Free Software Foundation. If the Library as you
|
||||
received it does not specify a version number of the GNU Lesser
|
||||
General Public License, you may choose any version of the GNU Lesser
|
||||
General Public License ever published by the Free Software Foundation.
|
||||
|
||||
If the Library as you received it specifies that a proxy can decide
|
||||
whether future versions of the GNU Lesser General Public License shall
|
||||
apply, that proxy's public statement of acceptance of any version is
|
||||
permanent authorization for you to choose that version for the
|
||||
Library.
|
||||
141
Makefile
141
Makefile
@ -1,141 +0,0 @@
|
||||
-l =
|
||||
|
||||
SHARED ?= false
|
||||
DEBUG ?= false
|
||||
USRDIR ?= /usr
|
||||
|
||||
.PHONY: build i install uni uninstall\
|
||||
tools library tests docs cov clean
|
||||
|
||||
LIB = basen
|
||||
OBJS =\
|
||||
hex\
|
||||
baseN\
|
||||
base58\
|
||||
base64\
|
||||
hash/sha256\
|
||||
|
||||
TOOLS =\
|
||||
|
||||
TESTS =\
|
||||
test-hex\
|
||||
test-baseN\
|
||||
test-base58\
|
||||
test-base64\
|
||||
hash/test-sha256\
|
||||
|
||||
ifeq (${origin CC}, default)
|
||||
CC = g++
|
||||
endif
|
||||
|
||||
CFLAGS = -std=c++23 -Wall -Wextra -Werror -Wno-unused-result -fPIC
|
||||
|
||||
ifneq (${DEBUG}, false)
|
||||
CFLAGS += -fsanitize=address,undefined -g -O0
|
||||
-g = -g
|
||||
else
|
||||
CFLAGS += -O3
|
||||
endif
|
||||
|
||||
ifneq (${SHARED}, false)
|
||||
CFLAGS += -Xlinker -rpath=${LIBDIR}
|
||||
-lLIB = -l:lib${LIB}${-g}.so
|
||||
else
|
||||
-lLIB = -l:lib${LIB}${-g}.a
|
||||
endif
|
||||
|
||||
SRCDIR = src
|
||||
INCDIR = include
|
||||
OBJDIR = obj
|
||||
BINDIR = bin
|
||||
LIBDIR = lib
|
||||
TESTDIR = test
|
||||
USRLIB = ${USRDIR}/lib
|
||||
USRBIN = ${USRDIR}/bin
|
||||
USRINC = ${USRDIR}/include
|
||||
DIRS =\
|
||||
${BINDIR}\
|
||||
${BINDIR}/hash\
|
||||
${OBJDIR}\
|
||||
${OBJDIR}/hash\
|
||||
${LIBDIR}\
|
||||
doc\
|
||||
cov
|
||||
|
||||
build: library tools
|
||||
|
||||
i: install
|
||||
install:\
|
||||
build\
|
||||
${USRINC}/${LIB}.hpp\
|
||||
${patsubst %, ${USRINC}/${LIB}/%.hpp, ${OBJS}}\
|
||||
${patsubst %, ${USRLIB}/lib${LIB}${-g}%, .so .a}\
|
||||
${patsubst %, ${USRBIN}/%${-g}, ${TOOLS}}
|
||||
|
||||
uni: uninstall
|
||||
uninstall:
|
||||
rm -f ${USRINC}/${LIB}.hpp
|
||||
rm -f ${patsubst %, ${USRINC}/${LIB}/%.hpp, ${OBJS}}
|
||||
rm -f ${patsubst %, ${USRLIB}/lib${LIB}${-g}%, .so .a}
|
||||
rm -f ${patsubst %, ${USRBIN}/%${-g}, ${TOOLS}}
|
||||
|
||||
docs:
|
||||
doxygen Doxyfile
|
||||
|
||||
cover: ${DIRS} ${patsubst %, ${BINDIR}/%${-g}-cov, ${TESTS}}
|
||||
rm -f **/*.gcda
|
||||
${patsubst %, ./${BINDIR}/%${-g}-cov;, ${TESTS}}
|
||||
gcovr --html-nested cov/index.html --txt --exclude-throw-branches
|
||||
|
||||
${OBJDIR}/%${-g}-cov.o: ${SRCDIR}/%.cpp ${INCDIR}/${LIB}/%.hpp
|
||||
${CC} -o $@ -c $< -I${INCDIR} ${-l} ${CFLAGS} --coverage
|
||||
|
||||
${BINDIR}/%${-g}-cov: ${TESTDIR}/%.cpp ${patsubst %, ${OBJDIR}/%${-g}-cov.o, ${OBJS}}
|
||||
${CC} -o $@ $^ -I${INCDIR} ${-l} -lgtest ${CFLAGS} --coverage
|
||||
|
||||
clean:
|
||||
rm -rf ${DIRS}
|
||||
|
||||
ifneq (${OBJS},)
|
||||
|
||||
library: ${DIRS} ${patsubst %, ${LIBDIR}/lib${LIB}${-g}%, .so .a}
|
||||
|
||||
${OBJDIR}/%${-g}.o: ${SRCDIR}/%.cpp ${INCDIR}/${LIB}/%.hpp
|
||||
${CC} -o $@ -c $< -I${INCDIR} ${-l} ${CFLAGS}
|
||||
|
||||
${LIBDIR}/lib${LIB}${-g}.so: ${patsubst %, ${OBJDIR}/%${-g}.o, ${OBJS}}
|
||||
${CC} -shared -o $@ $^
|
||||
|
||||
${LIBDIR}/lib${LIB}${-g}.a: ${patsubst %, ${OBJDIR}/%${-g}.o, ${OBJS}}
|
||||
ar rcs $@ $^
|
||||
|
||||
${USRINC}/%: ${INCDIR}/%
|
||||
install -Dm644 $< $@
|
||||
|
||||
${USRLIB}/lib${LIB}${-g}%: ${LIBDIR}/lib${LIB}${-g}%
|
||||
install -Dm755 $< $@
|
||||
|
||||
endif
|
||||
ifneq (${TOOLS},)
|
||||
|
||||
tools: library ${DIRS} ${patsubst %, ${BINDIR}/%${-g}, ${TOOLS}}
|
||||
|
||||
${BINDIR}/%${-g}: ${SRCDIR}/%.cpp ${patsubst %, ${OBJDIR}/%${-g}.o, ${OBJS}}
|
||||
${CC} -o $@ $< -I${INCDIR} -L${LIBDIR} ${-l} ${-lLIB} ${CFLAGS}
|
||||
|
||||
${USRBIN}/%${-g}: ${BINDIR}/%${-g}
|
||||
install -Dm755 $< $@
|
||||
|
||||
endif
|
||||
ifneq (${TESTS},)
|
||||
|
||||
tests: library ${DIRS} ${patsubst %, ${BINDIR}/%${-g}, ${TESTS}}
|
||||
${patsubst %, ./${BINDIR}/%${-g};, ${TESTS}}
|
||||
|
||||
${BINDIR}/%${-g}: ${TESTDIR}/%.cpp ${patsubst %, ${OBJDIR}/%${-g}.o, ${OBJS}}
|
||||
${CC} -o $@ $< -I${INCDIR} -L${LIBDIR} ${-l} ${-lLIB} -lgtest ${CFLAGS}
|
||||
|
||||
endif
|
||||
|
||||
${DIRS}:
|
||||
mkdir -p $@
|
||||
38
README.md
38
README.md
@ -1,6 +1,6 @@
|
||||
# libbasen
|
||||
|
||||
c++ encoding/decoding from arbitrary base
|
||||
c++20 encoding/decoding from arbitrary base
|
||||
|
||||
<a href="https://repology.org/project/libbasen/versions">
|
||||
<img src="https://repology.org/badge/tiny-repos/libbasen.svg" alt="Packaging status">
|
||||
@ -12,29 +12,41 @@ c++ encoding/decoding from arbitrary base
|
||||
## Contents
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Package](#package)
|
||||
- [Meson](#meson)
|
||||
- [Documentation](#documentation)
|
||||
- [Usage](#usage)
|
||||
- [Contributing](#contributing)
|
||||
|
||||
## Installation
|
||||
|
||||
Automatically from specified repositories:
|
||||
### Package
|
||||
|
||||
[](https://repology.org/project/libbasen/versions)
|
||||
|
||||
Manually using make:
|
||||
### Meson
|
||||
|
||||
For cli tool you should have [argparse](https://github.com/p-ranav/argparse) as make dependency.
|
||||
|
||||
```
|
||||
make -j $(nproc)
|
||||
sudo make i USRDIR=(Your installation dir)
|
||||
```
|
||||
Uninstall:
|
||||
```
|
||||
sudo make uni USRDIR=(Your installation dir)
|
||||
meson setup build --buildtype=release
|
||||
cd build
|
||||
meson install
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Available [here](https://vsek1ro.github.io/libbasen)
|
||||
|
||||
## Usage
|
||||
|
||||
libbasen package provides `basen` cli tool. Below are examples of use:
|
||||
```
|
||||
echo "hello world" | basen -t hex > encoded.data
|
||||
basen -t hex -d < encoded.data > decoded.data
|
||||
echo "arbitrary alphabet" | basen -a "0123ABCD"
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Main branch is under protection rules, so you should create pull request. After merging will be runned [authors.sh](https://github.com/vSEK1RO/libbasen/blob/main/authors.sh) for adding all contributors usernames and their number of commits to [AUTHORS](https://github.com/vSEK1RO/libbasen/blob/main/AUTHORS) file.
|
||||
@ -46,15 +58,17 @@ Now we would like to implement the following features:
|
||||
|
||||
For build with with debug flags:
|
||||
```
|
||||
make -j $(nproc) DEBUG=
|
||||
meson setup build-dev -Db_coverage=true
|
||||
cd build-dev
|
||||
meson compile
|
||||
```
|
||||
For build tests (needed gtest package as dependency):
|
||||
```
|
||||
make tests -j $(nproc) DEBUG=
|
||||
meson test
|
||||
```
|
||||
For generating coverage:
|
||||
```
|
||||
make cover -j $(nproc) DEBUG=
|
||||
ninja coverage
|
||||
```
|
||||
|
||||
[⬆️ Contents](#contents)
|
||||
|
||||
23
authors.sh
23
authors.sh
@ -1,20 +1,5 @@
|
||||
#!/bin/bash
|
||||
#!/usr/bin/env bash
|
||||
_D="$HOME/.cache/bash/deps.sh"; mkdir -p "$(dirname "$_D")" && [[ ! -f $_D ]] && wget -qO "$_D" https://static.sek1.ro/libs-bash/deps/index.sh; source "$_D"
|
||||
deps_source https://static.sek1.ro/libs-bash/dist/
|
||||
|
||||
RESPONSE=$(curl -L \
|
||||
-H "Accept: application/vnd.github+json" \
|
||||
-H "X-GitHub-Api-Version: 2022-11-28" \
|
||||
https://api.github.com/repos/vSEK1RO/libbasen/contributors)
|
||||
|
||||
LOGIN=$(echo "$RESPONSE" | sed -n /login/p | sed 's/ \"login\": \"//' | sed 's/\",//')
|
||||
CONTRIBUTIONS=$(echo "$RESPONSE" | sed -n /contributions/p | sed 's/ \"contributions\": //' | sed 's/,//')
|
||||
|
||||
IFS=$'\n' read -r -d '' -a arr1 <<< "$CONTRIBUTIONS"
|
||||
IFS=$'\n' read -r -d '' -a arr2 <<< "$LOGIN"
|
||||
|
||||
AUTHORS=$'libbasen project authors:\n\n'
|
||||
AUTHORS+=$(printf "%7s | %s" "commits" "username")$'\n'
|
||||
for ((i = 0; i < ${#arr1[@]}; i++)); do
|
||||
AUTHORS+=$(printf "%7s | %s" "${arr1[$i]}" "${arr2[$i]}")$'\n'
|
||||
done
|
||||
|
||||
echo "$AUTHORS" > AUTHORS
|
||||
dist_github_authors vSEK1RO libbasen > AUTHORS
|
||||
1
config.hpp.in
Normal file
1
config.hpp.in
Normal file
@ -0,0 +1 @@
|
||||
#define BASEN_VER_STR "@ver_str@"
|
||||
Submodule distrib/arch updated: a829d9746a...fb10835e09
@ -1,6 +1,7 @@
|
||||
#include <basen/base58.hpp>
|
||||
#include <basen/base64.hpp>
|
||||
#include <basen/baseN.hpp>
|
||||
#include <basen/Exception.hpp>
|
||||
#include <basen/hash/sha256.hpp>
|
||||
#include <basen/hex.hpp>
|
||||
|
||||
|
||||
43
include/basen/Exception.hpp
Normal file
43
include/basen/Exception.hpp
Normal file
@ -0,0 +1,43 @@
|
||||
#pragma once
|
||||
|
||||
#include <exception>
|
||||
#include <source_location>
|
||||
#include <string>
|
||||
#include <unordered_map>
|
||||
|
||||
namespace basen
|
||||
{
|
||||
class Exception : public std::exception
|
||||
{
|
||||
public:
|
||||
enum class Code
|
||||
{
|
||||
BASE,
|
||||
PADDING,
|
||||
CHECKSUM,
|
||||
OVERFLOW,
|
||||
LENGTH,
|
||||
OUT_OF_ALPH,
|
||||
ALPH_COLLISION
|
||||
};
|
||||
static const std::unordered_map<Code, std::string> messages;
|
||||
|
||||
Exception(Code code, const std::source_location &location = std::source_location::current());
|
||||
const char *what() const noexcept override
|
||||
{
|
||||
return _what.c_str();
|
||||
}
|
||||
inline const char *message() const noexcept
|
||||
{
|
||||
return messages.at(_code).c_str();
|
||||
}
|
||||
inline Code code() const noexcept
|
||||
{
|
||||
return _code;
|
||||
}
|
||||
|
||||
private:
|
||||
Code _code;
|
||||
std::string _what;
|
||||
};
|
||||
}
|
||||
@ -11,40 +11,74 @@ namespace base58
|
||||
* @brief bitcoin alphabet
|
||||
*/
|
||||
extern const char digits[59];
|
||||
extern const int8_t map[256];
|
||||
extern const uint8_t map[256];
|
||||
|
||||
bool isValid(const char *str, uint64_t str_size) noexcept;
|
||||
/**
|
||||
* @return checks what contains only alphabet chars
|
||||
* @warning doesn't validate checksum, use decodeCheck instead
|
||||
*/
|
||||
bool isValid(const char *str, size_t str_size) noexcept;
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @return checks what contains only alphabet chars
|
||||
* @warning doesn't validate checksum, use decodeCheck instead
|
||||
*/
|
||||
bool isValid(std::string_view str) noexcept;
|
||||
|
||||
/**
|
||||
* @throw std::overflow_error if if there is an overflow
|
||||
* @param data vector or span of data which you want to encode
|
||||
* @return estimated size after encoding (for non-powers of two it is obviously larger)
|
||||
* @throw basen::Exception(OVERFLOW) from baseN::sizeEncoded
|
||||
*/
|
||||
uint64_t sizeEncoded(std::span<const uint8_t> data) noexcept;
|
||||
uint64_t sizeDecoded(std::string_view str) noexcept;
|
||||
size_t sizeEncoded(std::span<const uint8_t> data);
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @return estimated size after decoding (for non-powers of two it is obviously larger)
|
||||
*/
|
||||
size_t sizeDecoded(std::string_view str) noexcept;
|
||||
|
||||
/**
|
||||
* @param data [in] pointer to data which you want encode
|
||||
* @param str [out] pointer to string for encoded data output
|
||||
* @return number of leading chars, which should be trimmed
|
||||
* @throw basen::Exception(OVERFLOW) from base58::sizeEncoded
|
||||
* @warning contain leading zeros, returns count of them
|
||||
*/
|
||||
uint64_t encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size) noexcept;
|
||||
std::string encode(std::span<const uint8_t> data) noexcept;
|
||||
size_t encode(const uint8_t *data, size_t data_size, char *str, size_t str_size);
|
||||
/**
|
||||
* @param data vector or span of data which you want to encode
|
||||
* @return encoded string
|
||||
* @throw basen::Exception(OVERFLOW) from base58::sizeEncoded
|
||||
*/
|
||||
std::string encode(std::span<const uint8_t> data);
|
||||
|
||||
/**
|
||||
* @param str [in] pointer to string which you want decode
|
||||
* @param data [out] pointer to data for encoded string output
|
||||
* @return number of leading chars, which should be trimmed
|
||||
* @throw basen::Exception(OUT_OF_ALPH) from baseN::decode
|
||||
* @warning contain leading zeros, returns count of them
|
||||
*/
|
||||
uint64_t decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size) noexcept;
|
||||
std::vector<uint8_t> decode(std::string_view str) noexcept;
|
||||
size_t decode(const char *str, size_t str_size, uint8_t *data, size_t data_size);
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @return decoded data
|
||||
* @throw basen::Exception(OUT_OF_ALPH) from baseN::decode
|
||||
*/
|
||||
std::vector<uint8_t> decode(std::string_view str);
|
||||
|
||||
/**
|
||||
* @param data vector or span of data which you want to encode
|
||||
* @return encoded string + 4 first bytes of double sha256
|
||||
* @throw basen::Exception(OVERFLOW) from base58::encode
|
||||
*/
|
||||
std::string encodeCheck(std::span<const uint8_t> data) noexcept;
|
||||
std::string encodeCheck(std::span<const uint8_t> data);
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @param str encoded string or string_view + 4 first bytes of double sha256
|
||||
* @return decoded data without 4 first bytes of double sha256
|
||||
* @throw std::logic_error checksum incorrect
|
||||
* @throw basen::Exception(OUT_OF_ALPH) from base58::decode
|
||||
* @throw basen::Exception(PADDING) if str size < 4
|
||||
* @throw basen::Exception(CHECKSUM) if checksum incorrect
|
||||
*/
|
||||
std::vector<uint8_t> decodeCheck(std::string_view str);
|
||||
}
|
||||
@ -8,30 +8,59 @@
|
||||
namespace base64
|
||||
{
|
||||
extern const char digits[65];
|
||||
extern const int8_t map[256];
|
||||
extern const uint8_t map[256];
|
||||
|
||||
bool isValid(const char *str, uint64_t str_size) noexcept;
|
||||
/**
|
||||
* @return checks what contains only alphabet chars and ends with no more than two '=' chars
|
||||
*/
|
||||
bool isValid(const char *str, size_t str_size) noexcept;
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @return checks what contains only alphabet chars and ends with no more than two '=' chars
|
||||
*/
|
||||
bool isValid(std::string_view str) noexcept;
|
||||
|
||||
/**
|
||||
* @throw std::overflow_error if if there is an overflow
|
||||
* @param data vector or span of data which you want to encode
|
||||
* @return exact size after encoding
|
||||
* @throw basen::Exception(OVERFLOW) if there is an overflow
|
||||
*/
|
||||
uint64_t sizeEncoded(std::span<const uint8_t> data);
|
||||
uint64_t sizeDecoded(std::string_view str) noexcept;
|
||||
size_t sizeEncoded(std::span<const uint8_t> data);
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @return exact size after decoding
|
||||
*/
|
||||
size_t sizeDecoded(std::string_view str) noexcept;
|
||||
|
||||
/**
|
||||
* @throw std::length_error if not enough allocated length
|
||||
* @warning contain leading zeros, returns count of them
|
||||
* @param data [in] pointer to data which you want encode
|
||||
* @param str [out] pointer to string for encoded data output
|
||||
* @throw basen::Exception(OVERFLOW) from base64::sizeEncoded
|
||||
* @throw basen::Exception(LENGTH) if not enough allocated length
|
||||
*/
|
||||
void encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size);
|
||||
std::string encode(std::span<const uint8_t> data) noexcept;
|
||||
void encode(const uint8_t *data, size_t data_size, char *str, size_t str_size);
|
||||
/**
|
||||
* @param data vector or span of data which you want to encode
|
||||
* @return encoded string
|
||||
* @throw basen::Exception(OVERFLOW) from base64::sizeEncoded
|
||||
* @throw basen::Exception(LENGTH) if not enough allocated length
|
||||
*/
|
||||
std::string encode(std::span<const uint8_t> data);
|
||||
|
||||
/**
|
||||
* @throw std::length_error if not enough allocated length
|
||||
* @throw std::logic_error if out of digits map
|
||||
* @throw std::logic_error if incorrect padding
|
||||
* @warning contain leading zeros, returns count of them
|
||||
* @param str [in] pointer to string which you want decode
|
||||
* @param data [out] pointer to data for encoded string output
|
||||
* @throw basen::Exception(LENGTH) if not enough allocated length
|
||||
* @throw basen::Exception(OUT_OF_ALPH) if out of digits map
|
||||
* @throw basen::Exception(PADDING) if incorrect padding
|
||||
*/
|
||||
void decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size);
|
||||
std::vector<uint8_t> decode(std::string_view str) noexcept;
|
||||
void decode(const char *str, size_t str_size, uint8_t *data, size_t data_size);
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @return decoded data
|
||||
* @throw basen::Exception(LENGTH) if not enough allocated length
|
||||
* @throw basen::Exception(OUT_OF_ALPH) if out of digits map
|
||||
* @throw basen::Exception(PADDING) if incorrect padding
|
||||
*/
|
||||
std::vector<uint8_t> decode(std::string_view str);
|
||||
}
|
||||
@ -8,95 +8,80 @@
|
||||
namespace baseN
|
||||
{
|
||||
/**
|
||||
* @param str [in] pointer to string
|
||||
* @param str_size
|
||||
* @param map int8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. -1 if there is no symbol
|
||||
* @return that string doesn't contain unnecessary symbols
|
||||
* @param digits [in] alphabet of encoding
|
||||
* @param map [out] uint8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. 255 if there is no symbol
|
||||
* @return map of alphabet of encoding
|
||||
* @throw basen::Exception(ALPH_COLLISION) if alphabet contain same chars
|
||||
*/
|
||||
bool isValid(const char *str, uint64_t str_size, const int8_t *map) noexcept;
|
||||
void digitsMap(const char *digits, uint8_t digits_size, uint8_t *map);
|
||||
/**
|
||||
* @param map map of alphabet of encoding, which is returned by baseN::digitsMap
|
||||
* @return checks what contains only alphabet chars
|
||||
*/
|
||||
bool isValid(const char *str, size_t str_size, const uint8_t *map) noexcept;
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @param map int8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. -1 if there is no symbol
|
||||
* @return that string doesn't contain unnecessary symbols
|
||||
* @param map map of alphabet of encoding, which is returned by baseN::digitsMap
|
||||
* @return checks what contains only alphabet chars
|
||||
*/
|
||||
bool isValid(std::string_view str, const int8_t *map) noexcept;
|
||||
bool isValid(std::string_view str, const uint8_t *map) noexcept;
|
||||
|
||||
/**
|
||||
* @param data vector or span of data which you want to encode
|
||||
* @param base from 1 to 255
|
||||
* @return estimated size after encoding
|
||||
* @param base radix of encoding from [2 to 254]
|
||||
* @return estimated size after encoding (obviously larger)
|
||||
* @throw basen::Exception(BASE) if base < 2 || base > 254
|
||||
*/
|
||||
uint64_t sizeEncoded(std::span<const uint8_t> data, uint8_t base);
|
||||
size_t sizeEncoded(std::span<const uint8_t> data, uint8_t base);
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @param base from 1 to 255
|
||||
* @param digits char[base] array of digits
|
||||
* @return estimated size after decoding
|
||||
* @throw std::overflow_error if if there is an overflow
|
||||
* @param base radix of encoding from [2 to 254]
|
||||
* @param digits alphabet of encoding
|
||||
* @return estimated size after decoding (obviously larger)
|
||||
* @throw basen::Exception(BASE) if base < 2 || base > 254
|
||||
* @throw basen::Exception(OVERFLOW) if if there is an overflow
|
||||
*/
|
||||
uint64_t sizeDecoded(std::string_view str, uint8_t base, const char *digits) noexcept;
|
||||
size_t sizeDecoded(std::string_view str, uint8_t base, const char *digits);
|
||||
|
||||
/**
|
||||
* @param data [in] pointer to data which you want encode
|
||||
* @param data_size
|
||||
* @param str [out] pointer to string for encoded data output
|
||||
* @param str_size
|
||||
* @param base from 1 to 255
|
||||
* @param digits char[base] array of digits
|
||||
* @code{cpp}
|
||||
* std::vector<uint8_t> data;
|
||||
* std::string str(baseN::sizeEncoded(data, 58), ' ');
|
||||
*
|
||||
* auto offset = baseN::encode(data.data(), data.size(), str.data(), str.size(), 58, base58::digits);
|
||||
* // deleting leading zeroes
|
||||
* str.erase(str.begin(), str.begin() + offset);
|
||||
* @endcode
|
||||
* @param base radix of encoding from [2 to 254]
|
||||
* @param digits alphabet of encoding
|
||||
* @return number of leading chars, which should be trimmed
|
||||
* @throw basen::Exception(BASE) if base < 2 || base > 254
|
||||
* @warning contain leading zeros, returns count of them
|
||||
*/
|
||||
uint64_t encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size, uint8_t base, const char *digits);
|
||||
size_t encode(const uint8_t *data, size_t data_size, char *str, size_t str_size, uint8_t base, const char *digits);
|
||||
/**
|
||||
* @param data vector or span of data which you want to encode
|
||||
* @param base from 1 to 255
|
||||
* @param digits char[base] array of digits
|
||||
* @code{cpp}
|
||||
* std::vector<uint8_t> data;
|
||||
* auto str = baseN::encode(data, 58, base58::digits);
|
||||
* @endcode
|
||||
* @param base radix of encoding from [2 to 254]
|
||||
* @param digits alphabet of encoding
|
||||
* @return encoded string
|
||||
* @throw basen::Exception(BASE) if base < 2 || base > 254
|
||||
*/
|
||||
std::string encode(std::span<const uint8_t> data, uint8_t base, const char *digits) noexcept;
|
||||
std::string encode(std::span<const uint8_t> data, uint8_t base, const char *digits);
|
||||
|
||||
/**
|
||||
* @param str [in] pointer to string which you want decode
|
||||
* @param str_size
|
||||
* @param data [out] pointer to data for encoded string output
|
||||
* @param data_size
|
||||
* @param base from 1 to 255
|
||||
* @param digits char[base] array of digits
|
||||
* @param map int8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. -1 if there is no symbol
|
||||
* @code{cpp}
|
||||
* std::string str;
|
||||
* std::vector<uint8_t> data(baseN::sizeDecoded(str, 58));
|
||||
*
|
||||
* auto offset = baseN::decode(str.data(), str.size(), data.data(), data.size(), 58, base58::digits, base58::map);
|
||||
* // deleting leading zeroes
|
||||
* data.erase(data.begin(), data.begin() + offset);
|
||||
* @endcode
|
||||
* @param base radix of encoding from [2 to 254]
|
||||
* @param digits alphabet of encoding
|
||||
* @param map map of alphabet of encoding, which is returned by baseN::digitsMap
|
||||
* @return number of leading chars, which should be trimmed
|
||||
* @throw basen::Exception(BASE) if base < 2 || base > 254
|
||||
* @throw basen::Exception(OUT_OF_ALPH) if out of alphabet
|
||||
* @warning contain leading zeros, returns count of them
|
||||
*/
|
||||
uint64_t decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size, uint8_t base, const char *digits, const int8_t *map);
|
||||
size_t decode(const char *str, size_t str_size, uint8_t *data, size_t data_size, uint8_t base, const char *digits, const uint8_t *map);
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @param base from 1 to 255
|
||||
* @param digits char[base] array of digits
|
||||
* @param map int8_t[256] array, where at an index equal to the value of the symbol is the index of this symbol in the digits array. -1 if there is no symbol
|
||||
* @code{cpp}
|
||||
* std::string str;
|
||||
* auto data = baseN::decode(str, 58, base58::digits, base58::map);
|
||||
* @endcode
|
||||
* @param base radix of encoding from [2 to 254]
|
||||
* @param digits alphabet of encoding
|
||||
* @param map map of alphabet of encoding, which is returned by baseN::digitsMap
|
||||
* @return decoded data
|
||||
* @throw basen::Exception(BASE) if base < 2 || base > 254
|
||||
* @throw basen::Exception(OUT_OF_ALPH) if out of alphabet
|
||||
*/
|
||||
std::vector<uint8_t> decode(std::string_view str, uint8_t base, const char *digits, const int8_t *map) noexcept;
|
||||
std::vector<uint8_t> decode(std::string_view str, uint8_t base, const char *digits, const uint8_t *map);
|
||||
}
|
||||
@ -6,6 +6,6 @@
|
||||
|
||||
namespace hash
|
||||
{
|
||||
void sha256(const uint8_t *data, uint64_t data_size, uint8_t *hash) noexcept;
|
||||
void sha256(const uint8_t *data, size_t data_size, uint8_t *hash) noexcept;
|
||||
std::vector<uint8_t> sha256(std::span<const uint8_t> data) noexcept;
|
||||
}
|
||||
@ -7,31 +7,62 @@
|
||||
|
||||
namespace hex
|
||||
{
|
||||
/**
|
||||
* @brief lower case chars
|
||||
*/
|
||||
extern const char digits[17];
|
||||
extern const int8_t map[256];
|
||||
extern const uint8_t map[256];
|
||||
|
||||
bool isValid(const char *str, uint64_t str_size) noexcept;
|
||||
/**
|
||||
* @return checks what contains only alphabet chars
|
||||
*/
|
||||
bool isValid(const char *str, size_t str_size) noexcept;
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @return checks what contains only alphabet chars
|
||||
*/
|
||||
bool isValid(std::string_view str) noexcept;
|
||||
|
||||
/**
|
||||
* @throw std::overflow_error if if there is an overflow
|
||||
* @param data vector or span of data which you want to encode
|
||||
* @return exact size after encoding
|
||||
* @throw basen::Exception(OVERFLOW) if there is an overflow
|
||||
*/
|
||||
uint64_t sizeEncoded(std::span<const uint8_t> data);
|
||||
uint64_t sizeDecoded(std::string_view str) noexcept;
|
||||
size_t sizeEncoded(std::span<const uint8_t> data);
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @return exact size after decoding
|
||||
*/
|
||||
size_t sizeDecoded(std::string_view str) noexcept;
|
||||
|
||||
/**
|
||||
* @throw std::length_error if not enough allocated length
|
||||
* @warning contain leading zeros, returns count of them
|
||||
* @param data [in] pointer to data which you want encode
|
||||
* @param str [out] pointer to string for encoded data output
|
||||
* @throw basen::Exception(OVERFLOW) from hex::sizeEncoded
|
||||
* @throw basen::Exception(LENGTH) if not enough allocated length
|
||||
*/
|
||||
void encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size);
|
||||
std::string encode(std::span<const uint8_t> data) noexcept;
|
||||
void encode(const uint8_t *data, size_t data_size, char *str, size_t str_size);
|
||||
/**
|
||||
* @param data vector or span of data which you want to encode
|
||||
* @return encoded string
|
||||
* @throw basen::Exception(OVERFLOW) from hex::sizeEncoded
|
||||
* @throw basen::Exception(LENGTH) if not enough allocated length
|
||||
*/
|
||||
std::string encode(std::span<const uint8_t> data);
|
||||
|
||||
/**
|
||||
* @throw std::length_error if not enough allocated length
|
||||
* @throw std::logic_error if out of digits map
|
||||
* @throw std::logic_error if str_size %2 != 0 (isn't hex)
|
||||
* @warning contain leading zeros, returns count of them
|
||||
* @param str [in] pointer to string which you want decode
|
||||
* @param data [out] pointer to data for encoded string output
|
||||
* @throw basen::Exception(LENGTH) if not enough allocated length
|
||||
* @throw basen::Exception(OUT_OF_ALPH) if out of digits map
|
||||
* @throw basen::Exception(PADDING) if str_size %2 != 0 (isn't hex)
|
||||
*/
|
||||
void decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size);
|
||||
std::vector<uint8_t> decode(std::string_view str) noexcept;
|
||||
void decode(const char *str, size_t str_size, uint8_t *data, size_t data_size);
|
||||
/**
|
||||
* @param str string or string_view which you want to decode
|
||||
* @throw basen::Exception(LENGTH) if not enough allocated length
|
||||
* @throw basen::Exception(OUT_OF_ALPH) if out of digits map
|
||||
* @throw basen::Exception(PADDING) if str_size %2 != 0 (isn't hex)
|
||||
*/
|
||||
std::vector<uint8_t> decode(std::string_view str);
|
||||
}
|
||||
1
include/meson.build
Normal file
1
include/meson.build
Normal file
@ -0,0 +1 @@
|
||||
install_subdir('.', install_dir: 'include', exclude_files: ['meson.build'])
|
||||
34
meson.build
Normal file
34
meson.build
Normal file
@ -0,0 +1,34 @@
|
||||
project(
|
||||
'basen',
|
||||
'cpp',
|
||||
version: '1.1.1',
|
||||
default_options: {
|
||||
'cpp_std': 'c++20',
|
||||
'cpp_args': '-Wall -Wextra -Werror -Wno-unused-result',
|
||||
},
|
||||
license: 'LGPL-3.0-only',
|
||||
license_files: 'LICENSE',
|
||||
meson_version: '>=1.10.0',
|
||||
)
|
||||
|
||||
configure_file(
|
||||
input: 'config.hpp.in',
|
||||
output: 'config.hpp',
|
||||
configuration: {'ver_str': meson.project_version()},
|
||||
)
|
||||
|
||||
include = include_directories('.', 'include')
|
||||
|
||||
subdir('include')
|
||||
subdir('src')
|
||||
|
||||
basen_dep = declare_dependency(
|
||||
link_with: libbasen,
|
||||
include_directories: include,
|
||||
)
|
||||
|
||||
if get_option('buildtype') == 'debug'
|
||||
subdir('test')
|
||||
endif
|
||||
|
||||
subdir('tools')
|
||||
29
src/Exception.cpp
Normal file
29
src/Exception.cpp
Normal file
@ -0,0 +1,29 @@
|
||||
#include <sstream>
|
||||
|
||||
#include <basen/Exception.hpp>
|
||||
|
||||
namespace basen
|
||||
{
|
||||
const std::unordered_map<Exception::Code, std::string> Exception::messages = {
|
||||
{Code::BASE, "incorrect base"},
|
||||
{Code::PADDING, "incorrect padding"},
|
||||
{Code::CHECKSUM, "incorrect checksum"},
|
||||
{Code::OVERFLOW, "overflow"},
|
||||
{Code::LENGTH, "not enough allocated length"},
|
||||
{Code::OUT_OF_ALPH, "out of alphabet"},
|
||||
{Code::ALPH_COLLISION, "alphabet contains same chars"},
|
||||
};
|
||||
Exception::Exception(Code code, const std::source_location &location)
|
||||
{
|
||||
_code = code;
|
||||
std::ostringstream oss;
|
||||
oss << "\033[34m"
|
||||
<< location.function_name()
|
||||
<< ':'
|
||||
<< location.line()
|
||||
<< ": \033[31mbasen::Exception:\n\t\033[0m"
|
||||
<< message()
|
||||
<< "\n";
|
||||
_what = oss.str();
|
||||
}
|
||||
}
|
||||
@ -2,32 +2,33 @@
|
||||
|
||||
#include <basen/base58.hpp>
|
||||
#include <basen/baseN.hpp>
|
||||
#include <basen/Exception.hpp>
|
||||
#include <basen/hash/sha256.hpp>
|
||||
|
||||
namespace base58
|
||||
{
|
||||
const char digits[] =
|
||||
"123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
|
||||
const int8_t map[] = {
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, -1, -1, -1, -1, -1, -1,
|
||||
-1, 9, 10, 11, 12, 13, 14, 15, 16, -1, 17, 18, 19, 20, 21, -1,
|
||||
22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, -1, -1, -1, -1, -1,
|
||||
-1, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, -1, 44, 45, 46,
|
||||
47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
const uint8_t map[] = {
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 0, 1, 2, 3, 4, 5, 6, 7, 8, 255, 255, 255, 255, 255, 255,
|
||||
255, 9, 10, 11, 12, 13, 14, 15, 16, 255, 17, 18, 19, 20, 21, 255,
|
||||
22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 255, 255, 255, 255, 255,
|
||||
255, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 255, 44, 45, 46,
|
||||
47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
//
|
||||
};
|
||||
bool isValid(const char *str, uint64_t str_size) noexcept
|
||||
bool isValid(const char *str, size_t str_size) noexcept
|
||||
{
|
||||
return baseN::isValid(str, str_size, map);
|
||||
}
|
||||
@ -35,31 +36,31 @@ namespace base58
|
||||
{
|
||||
return baseN::isValid(str, map);
|
||||
}
|
||||
uint64_t sizeEncoded(std::span<const uint8_t> data) noexcept
|
||||
size_t sizeEncoded(std::span<const uint8_t> data)
|
||||
{
|
||||
return baseN::sizeEncoded(data, 58);
|
||||
}
|
||||
uint64_t sizeDecoded(std::string_view str) noexcept
|
||||
size_t sizeDecoded(std::string_view str) noexcept
|
||||
{
|
||||
return baseN::sizeDecoded(str, 58, digits);
|
||||
}
|
||||
uint64_t encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size) noexcept
|
||||
size_t encode(const uint8_t *data, size_t data_size, char *str, size_t str_size)
|
||||
{
|
||||
return baseN::encode(data, data_size, str, str_size, 58, digits);
|
||||
}
|
||||
std::string encode(std::span<const uint8_t> data) noexcept
|
||||
std::string encode(std::span<const uint8_t> data)
|
||||
{
|
||||
return baseN::encode(data, 58, digits);
|
||||
}
|
||||
uint64_t decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size) noexcept
|
||||
size_t decode(const char *str, size_t str_size, uint8_t *data, size_t data_size)
|
||||
{
|
||||
return baseN::decode(str, str_size, data, data_size, 58, digits, map);
|
||||
}
|
||||
std::vector<uint8_t> decode(std::string_view str) noexcept
|
||||
std::vector<uint8_t> decode(std::string_view str)
|
||||
{
|
||||
return baseN::decode(str, 58, digits, map);
|
||||
}
|
||||
std::string encodeCheck(std::span<const uint8_t> data) noexcept
|
||||
std::string encodeCheck(std::span<const uint8_t> data)
|
||||
{
|
||||
std::vector<uint8_t> buff(data.begin(), data.end()), dhash;
|
||||
dhash = hash::sha256(hash::sha256(data));
|
||||
@ -69,11 +70,15 @@ namespace base58
|
||||
std::vector<uint8_t> decodeCheck(std::string_view str)
|
||||
{
|
||||
std::vector<uint8_t> buff(base58::decode(str));
|
||||
if (buff.size() < 4)
|
||||
{
|
||||
throw basen::Exception(basen::Exception::Code::PADDING);
|
||||
}
|
||||
std::span<uint8_t> data(buff.begin(), buff.end() - 4);
|
||||
std::span<uint8_t> dhash(buff.end() - 4, buff.end());
|
||||
if (!std::equal(dhash.begin(), dhash.end(), hash::sha256(hash::sha256(data)).begin()))
|
||||
{
|
||||
throw std::logic_error("base58::decodeCheck: checksum incorrect");
|
||||
throw basen::Exception(basen::Exception::Code::CHECKSUM);
|
||||
}
|
||||
return std::vector<uint8_t>(data.begin(), data.end());
|
||||
}
|
||||
|
||||
@ -4,31 +4,32 @@
|
||||
|
||||
#include <basen/base64.hpp>
|
||||
#include <basen/baseN.hpp>
|
||||
#include <basen/Exception.hpp>
|
||||
|
||||
namespace base64
|
||||
{
|
||||
const char digits[] =
|
||||
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
|
||||
const int8_t map[] = {
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, -1, -1, 63,
|
||||
52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, -1, -1, -1, -1,
|
||||
-1, 0, 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, -1, -1, -1, -1, -1,
|
||||
-1, 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, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
const uint8_t map[] = {
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 62, 255, 255, 255, 63,
|
||||
52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 255, 255, 255, 255, 255, 255,
|
||||
255, 0, 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, 255, 255, 255, 255, 255,
|
||||
255, 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, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
//
|
||||
};
|
||||
bool isValid(const char *str, uint64_t str_size) noexcept
|
||||
bool isValid(const char *str, size_t str_size) noexcept
|
||||
{
|
||||
return base64::isValid(std::string_view(str, str_size));
|
||||
}
|
||||
@ -43,37 +44,37 @@ namespace base64
|
||||
}
|
||||
return baseN::isValid(sv, map);
|
||||
}
|
||||
uint64_t sizeEncoded(std::span<const uint8_t> data)
|
||||
size_t sizeEncoded(std::span<const uint8_t> data)
|
||||
{
|
||||
uint64_t str_size = data.size() / 3;
|
||||
if (str_size > std::numeric_limits<uint64_t>::max() / 4)
|
||||
size_t str_size = data.size() / 3;
|
||||
if (str_size > std::numeric_limits<size_t>::max() / 4)
|
||||
{
|
||||
throw std::overflow_error("base64::sizeEncoded: overflow");
|
||||
throw basen::Exception(basen::Exception::Code::OVERFLOW);
|
||||
}
|
||||
str_size = str_size * 4 + (data.size() % 3 ? 4 : 0);
|
||||
return str_size;
|
||||
}
|
||||
uint64_t sizeDecoded(std::string_view str) noexcept
|
||||
size_t sizeDecoded(std::string_view str) noexcept
|
||||
{
|
||||
auto size = std::distance(str.begin(), std::find_if(str.rbegin(), str.rend(), [](char ch)
|
||||
{ return ch != '='; })
|
||||
.base());
|
||||
return size / 4 * 3 + (size % 4 ? size % 4 - 1 : 0);
|
||||
}
|
||||
void encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size)
|
||||
void encode(const uint8_t *data, size_t data_size, char *str, size_t str_size)
|
||||
{
|
||||
if (str_size < base64::sizeEncoded(std::span<const uint8_t>(data, data_size)))
|
||||
{
|
||||
throw std::length_error("base64::encode: not enough allocated length");
|
||||
throw basen::Exception(basen::Exception::Code::LENGTH);
|
||||
}
|
||||
for (uint64_t i = 0; i < data_size / 3; i++)
|
||||
for (size_t i = 0; i < data_size / 3; i++)
|
||||
{
|
||||
str[i * 4] = digits[data[i * 3] >> 2];
|
||||
str[i * 4 + 1] = digits[(data[i * 3] << 4 | data[i * 3 + 1] >> 4) & 0x3F];
|
||||
str[i * 4 + 2] = digits[(data[i * 3 + 1] << 2 | data[i * 3 + 2] >> 6) & 0x3F];
|
||||
str[i * 4 + 3] = digits[data[i * 3 + 2] & 0x3F];
|
||||
}
|
||||
uint64_t last_idx = data_size / 3 * 4;
|
||||
size_t last_idx = data_size / 3 * 4;
|
||||
switch (data_size % 3)
|
||||
{
|
||||
case 1:
|
||||
@ -85,58 +86,58 @@ namespace base64
|
||||
case 2:
|
||||
str[last_idx] = digits[data[data_size - 2] >> 2];
|
||||
str[last_idx + 1] = digits[(data[data_size - 2] << 4 | data[data_size - 1] >> 4) & 0x3F];
|
||||
str[last_idx + 2] = digits[data[data_size - 1] & 0x0F];
|
||||
str[last_idx + 2] = digits[data[data_size - 1] << 2 & 0x3F];
|
||||
str[last_idx + 3] = '=';
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
std::string encode(std::span<const uint8_t> data) noexcept
|
||||
std::string encode(std::span<const uint8_t> data)
|
||||
{
|
||||
std::string str(base64::sizeEncoded(data), ' ');
|
||||
base64::encode(data.data(), data.size(), str.data(), str.size());
|
||||
return str;
|
||||
}
|
||||
void decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size)
|
||||
void decode(const char *str, size_t str_size, uint8_t *data, size_t data_size)
|
||||
{
|
||||
std::string_view sv(str, str_size);
|
||||
if (data_size < base64::sizeDecoded(sv))
|
||||
{
|
||||
throw std::length_error("base64::decode: not enough allocated length");
|
||||
throw basen::Exception(basen::Exception::Code::LENGTH);
|
||||
}
|
||||
if (!base64::isValid(sv))
|
||||
{
|
||||
throw std::logic_error("base64::decode: out of digits map");
|
||||
throw basen::Exception(basen::Exception::Code::OUT_OF_ALPH);
|
||||
}
|
||||
auto size = std::distance(sv.begin(), std::find_if(sv.rbegin(), sv.rend(), [](char ch)
|
||||
{ return ch != '='; })
|
||||
.base());
|
||||
if (sv.size() % 4 != 0 || sv.size() - size > 2)
|
||||
{
|
||||
throw std::logic_error("base64::decode: incorrect padding");
|
||||
throw basen::Exception(basen::Exception::Code::PADDING);
|
||||
}
|
||||
for (auto i = 0; i < size / 4; i++)
|
||||
{
|
||||
data[i * 3] = map[(int8_t)str[i * 4]] << 2 | map[(int8_t)str[i * 4 + 1]] >> 4;
|
||||
data[i * 3 + 1] = map[(int8_t)str[i * 4 + 1]] << 4 | map[(int8_t)str[i * 4 + 2]] >> 2;
|
||||
data[i * 3 + 2] = map[(int8_t)str[i * 4 + 2]] << 6 | map[(int8_t)str[i * 4 + 3]];
|
||||
data[i * 3] = map[(uint8_t)str[i * 4]] << 2 | map[(uint8_t)str[i * 4 + 1]] >> 4;
|
||||
data[i * 3 + 1] = map[(uint8_t)str[i * 4 + 1]] << 4 | map[(uint8_t)str[i * 4 + 2]] >> 2;
|
||||
data[i * 3 + 2] = map[(uint8_t)str[i * 4 + 2]] << 6 | map[(uint8_t)str[i * 4 + 3]];
|
||||
}
|
||||
uint64_t last_idx = size / 4 * 3;
|
||||
size_t last_idx = size / 4 * 3;
|
||||
switch (size % 4)
|
||||
{
|
||||
case 2:
|
||||
data[last_idx] = map[(int8_t)str[size - 2]] << 2 | map[(int8_t)str[size - 1]] >> 4;
|
||||
data[last_idx] = map[(uint8_t)str[size - 2]] << 2 | map[(uint8_t)str[size - 1]] >> 4;
|
||||
break;
|
||||
case 3:
|
||||
data[last_idx] = map[(int8_t)str[size - 3]] << 2 | map[(int8_t)str[size - 2]] >> 4;
|
||||
data[last_idx + 1] = map[(int8_t)str[size - 2]] << 4 | map[(int8_t)str[size - 1]] >> 2;
|
||||
data[last_idx] = map[(uint8_t)str[size - 3]] << 2 | map[(uint8_t)str[size - 2]] >> 4;
|
||||
data[last_idx + 1] = map[(uint8_t)str[size - 2]] << 4 | map[(uint8_t)str[size - 1]] >> 2;
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
std::vector<uint8_t> decode(std::string_view str) noexcept
|
||||
std::vector<uint8_t> decode(std::string_view str)
|
||||
{
|
||||
std::vector<uint8_t> data(base64::sizeDecoded(str));
|
||||
base64::decode(str.data(), str.size(), data.data(), data.size());
|
||||
|
||||
@ -1,43 +1,67 @@
|
||||
#include <algorithm>
|
||||
#include <cmath>
|
||||
#include <limits>
|
||||
#include <stdexcept>
|
||||
|
||||
#include <basen/baseN.hpp>
|
||||
#include <basen/Exception.hpp>
|
||||
|
||||
static constexpr auto log256 = std::log(256);
|
||||
static constexpr auto log256 = 5.545177444479562;
|
||||
|
||||
namespace baseN
|
||||
{
|
||||
bool isValid(const char *str, uint64_t str_size, const int8_t *map) noexcept
|
||||
void digitsMap(const char *digits, uint8_t digits_size, uint8_t *map)
|
||||
{
|
||||
std::fill(map, map + 256, 255);
|
||||
for (uint8_t i = 0; i < digits_size; i++)
|
||||
{
|
||||
if (map[(uint8_t)digits[i]] != 255)
|
||||
{
|
||||
throw basen::Exception(basen::Exception::Code::ALPH_COLLISION);
|
||||
}
|
||||
map[(uint8_t)digits[i]] = i;
|
||||
}
|
||||
}
|
||||
bool isValid(const char *str, size_t str_size, const uint8_t *map) noexcept
|
||||
{
|
||||
return std::all_of(str, str + str_size, [map](char ch)
|
||||
{ return map[(int8_t)ch] != -1; });
|
||||
{ return map[(uint8_t)ch] != 255; });
|
||||
}
|
||||
bool isValid(std::string_view str, const int8_t *map) noexcept
|
||||
bool isValid(std::string_view str, const uint8_t *map) noexcept
|
||||
{
|
||||
return baseN::isValid(str.data(), str.size(), map);
|
||||
}
|
||||
uint64_t sizeEncoded(std::span<const uint8_t> data, uint8_t base)
|
||||
size_t sizeEncoded(std::span<const uint8_t> data, uint8_t base)
|
||||
{
|
||||
if (base < 2 || base > 254)
|
||||
{
|
||||
throw basen::Exception(basen::Exception::Code::BASE);
|
||||
}
|
||||
std::span<const uint8_t> dv(std::find_if(data.begin(), data.end(), [](uint8_t item)
|
||||
{ return item != 0; }),
|
||||
data.end());
|
||||
if (dv.size() > std::numeric_limits<uint64_t>::max() / log256)
|
||||
if (dv.size() > (double)std::numeric_limits<size_t>::max() / log256)
|
||||
{
|
||||
throw std::overflow_error("baseN::sizeEncoded: overflow");
|
||||
throw basen::Exception(basen::Exception::Code::OVERFLOW);
|
||||
}
|
||||
return dv.size() * log256 / std::log(base) + 1 + (data.size() - dv.size());
|
||||
}
|
||||
uint64_t sizeDecoded(std::string_view str, uint8_t base, const char *digits) noexcept
|
||||
size_t sizeDecoded(std::string_view str, uint8_t base, const char *digits)
|
||||
{
|
||||
if (base < 2 || base > 254)
|
||||
{
|
||||
throw basen::Exception(basen::Exception::Code::BASE);
|
||||
}
|
||||
std::string_view sv(std::find_if(str.begin(), str.end(), [digits](uint8_t ch)
|
||||
{ return ch != digits[0]; }),
|
||||
str.end());
|
||||
return sv.size() * std::log(base) / log256 + 1 + (str.size() - sv.size());
|
||||
}
|
||||
uint64_t encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size, uint8_t base, const char *digits)
|
||||
size_t encode(const uint8_t *data, size_t data_size, char *str, size_t str_size, uint8_t base, const char *digits)
|
||||
{
|
||||
if (base < 2 || base > 254)
|
||||
{
|
||||
throw basen::Exception(basen::Exception::Code::BASE);
|
||||
}
|
||||
std::vector<uint8_t> dv(std::find_if(data, data + data_size, [](uint8_t item)
|
||||
{ return item != 0; }),
|
||||
data + data_size);
|
||||
@ -74,27 +98,31 @@ namespace baseN
|
||||
}
|
||||
*sv_it++ = digits[div];
|
||||
}
|
||||
for (uint64_t i = 0; i < data_size - dv.size() && sv_it < sv.rend(); i++)
|
||||
for (size_t i = 0; i < data_size - dv.size() && sv_it < sv.rend(); i++)
|
||||
{
|
||||
*sv_it++ = digits[0];
|
||||
}
|
||||
return std::distance(sv_it, sv.rend());
|
||||
}
|
||||
std::string encode(std::span<const uint8_t> data, uint8_t base, const char *digits) noexcept
|
||||
std::string encode(std::span<const uint8_t> data, uint8_t base, const char *digits)
|
||||
{
|
||||
std::string str(baseN::sizeEncoded(data, base), ' ');
|
||||
uint64_t offset = baseN::encode(data.data(), data.size(), str.data(), str.size(), base, digits);
|
||||
size_t offset = baseN::encode(data.data(), data.size(), str.data(), str.size(), base, digits);
|
||||
str.erase(str.begin(), str.begin() + offset);
|
||||
return str;
|
||||
}
|
||||
uint64_t decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size, uint8_t base, const char *digits, const int8_t *map)
|
||||
size_t decode(const char *str, size_t str_size, uint8_t *data, size_t data_size, uint8_t base, const char *digits, const uint8_t *map)
|
||||
{
|
||||
if (base < 2 || base > 254)
|
||||
{
|
||||
throw basen::Exception(basen::Exception::Code::BASE);
|
||||
}
|
||||
std::string_view sv(std::find_if(str, str + str_size, [digits](char ch)
|
||||
{ return ch != digits[0]; }),
|
||||
str + str_size);
|
||||
if (!baseN::isValid(sv, map))
|
||||
{
|
||||
throw std::logic_error("baseN::decode: out of digits map");
|
||||
throw basen::Exception(basen::Exception::Code::OUT_OF_ALPH);
|
||||
}
|
||||
std::span<uint8_t> dv(data, data_size);
|
||||
auto sv_it = sv.begin();
|
||||
@ -105,17 +133,17 @@ namespace baseN
|
||||
if (sv.size() != 0)
|
||||
{
|
||||
quo_it_last++;
|
||||
*quo_it = map[(int8_t)*sv_it++];
|
||||
*quo_it = map[(uint8_t)*sv_it++];
|
||||
while (sv_it < sv.end())
|
||||
{
|
||||
div = map[(int8_t)*sv_it++];
|
||||
while (quo_it < quo_it_last && quo_it < dv.rend() - 1)
|
||||
div = map[(uint8_t)*sv_it++];
|
||||
while (quo_it < quo_it_last && quo_it < dv.rend())
|
||||
{
|
||||
div += *quo_it * base;
|
||||
*quo_it++ = div;
|
||||
div >>= 8;
|
||||
}
|
||||
if (div != 0)
|
||||
if (div != 0 && quo_it < dv.rend())
|
||||
{
|
||||
*quo_it++ = div;
|
||||
}
|
||||
@ -123,16 +151,16 @@ namespace baseN
|
||||
quo_it = dv.rbegin();
|
||||
}
|
||||
}
|
||||
for (uint64_t i = 0; i < str_size - sv.size() && quo_it_last < dv.rend(); i++)
|
||||
for (size_t i = 0; i < str_size - sv.size() && quo_it_last < dv.rend(); i++)
|
||||
{
|
||||
*quo_it_last++ = 0;
|
||||
}
|
||||
return std::distance(quo_it_last, dv.rend());
|
||||
}
|
||||
std::vector<uint8_t> decode(std::string_view str, uint8_t base, const char *digits, const int8_t *map) noexcept
|
||||
std::vector<uint8_t> decode(std::string_view str, uint8_t base, const char *digits, const uint8_t *map)
|
||||
{
|
||||
std::vector<uint8_t> data(baseN::sizeDecoded(str, base, digits));
|
||||
uint64_t offset = baseN::decode(str.data(), str.size(), data.data(), data.size(), base, digits, map);
|
||||
size_t offset = baseN::decode(str.data(), str.size(), data.data(), data.size(), base, digits, map);
|
||||
data.erase(data.begin(), data.begin() + offset);
|
||||
return data;
|
||||
}
|
||||
|
||||
@ -165,7 +165,7 @@ static void sha256_final(SHA256_CTX *ctx, uint8_t *hash)
|
||||
|
||||
namespace hash
|
||||
{
|
||||
void sha256(const uint8_t *data, uint64_t data_size, uint8_t *hash) noexcept
|
||||
void sha256(const uint8_t *data, size_t data_size, uint8_t *hash) noexcept
|
||||
{
|
||||
SHA256_CTX ctx;
|
||||
sha256_init(&ctx);
|
||||
|
||||
68
src/hex.cpp
68
src/hex.cpp
@ -1,32 +1,32 @@
|
||||
#include <limits>
|
||||
#include <stdexcept>
|
||||
|
||||
#include <basen/baseN.hpp>
|
||||
#include <basen/Exception.hpp>
|
||||
#include <basen/hex.hpp>
|
||||
|
||||
namespace hex
|
||||
{
|
||||
const char digits[] = "0123456789abcdef";
|
||||
const int8_t map[] = {
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, -1, -1, -1, -1, -1, -1,
|
||||
-1, 10, 11, 12, 13, 14, 15, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, 10, 11, 12, 13, 14, 15, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
|
||||
const uint8_t map[] = {
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 255, 255, 255, 255, 255, 255,
|
||||
255, 10, 11, 12, 13, 14, 15, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 10, 11, 12, 13, 14, 15, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255,
|
||||
//
|
||||
};
|
||||
bool isValid(const char *str, uint64_t str_size) noexcept
|
||||
bool isValid(const char *str, size_t str_size) noexcept
|
||||
{
|
||||
return baseN::isValid(str, str_size, map);
|
||||
}
|
||||
@ -34,56 +34,56 @@ namespace hex
|
||||
{
|
||||
return baseN::isValid(str, map);
|
||||
}
|
||||
uint64_t sizeEncoded(std::span<const uint8_t> data)
|
||||
size_t sizeEncoded(std::span<const uint8_t> data)
|
||||
{
|
||||
if (data.size() > std::numeric_limits<uint64_t>::max() / 2)
|
||||
if (data.size() > std::numeric_limits<size_t>::max() / 2)
|
||||
{
|
||||
throw std::overflow_error("hex::sizeEncoded: overflow");
|
||||
throw basen::Exception(basen::Exception::Code::OVERFLOW);
|
||||
}
|
||||
return data.size() * 2;
|
||||
}
|
||||
uint64_t sizeDecoded(std::string_view str) noexcept
|
||||
size_t sizeDecoded(std::string_view str) noexcept
|
||||
{
|
||||
return str.size() / 2;
|
||||
}
|
||||
void encode(const uint8_t *data, uint64_t data_size, char *str, uint64_t str_size)
|
||||
void encode(const uint8_t *data, size_t data_size, char *str, size_t str_size)
|
||||
{
|
||||
if (str_size < hex::sizeEncoded(std::span<const uint8_t>(data, data_size)))
|
||||
{
|
||||
throw std::length_error("hex::encode: not enough allocated length");
|
||||
throw basen::Exception(basen::Exception::Code::LENGTH);
|
||||
}
|
||||
for (uint64_t i = 0; i < data_size; i++)
|
||||
for (size_t i = 0; i < data_size; i++)
|
||||
{
|
||||
str[i * 2] = digits[data[i] >> 4];
|
||||
str[i * 2 + 1] = digits[data[i] & 0x0F];
|
||||
}
|
||||
}
|
||||
std::string encode(std::span<const uint8_t> data) noexcept
|
||||
std::string encode(std::span<const uint8_t> data)
|
||||
{
|
||||
std::string str(hex::sizeEncoded(data), ' ');
|
||||
hex::encode(data.data(), data.size(), str.data(), str.size());
|
||||
return str;
|
||||
}
|
||||
void decode(const char *str, uint64_t str_size, uint8_t *data, uint64_t data_size)
|
||||
void decode(const char *str, size_t str_size, uint8_t *data, size_t data_size)
|
||||
{
|
||||
if (str_size % 2 != 0)
|
||||
{
|
||||
throw std::logic_error("hex::decode: isn't hex");
|
||||
throw basen::Exception(basen::Exception::Code::PADDING);
|
||||
}
|
||||
if (data_size < hex::sizeDecoded(std::string_view(str, str_size)))
|
||||
{
|
||||
throw std::length_error("hex::decode: not enough allocated length");
|
||||
throw basen::Exception(basen::Exception::Code::LENGTH);
|
||||
}
|
||||
if (!hex::isValid(str, str_size))
|
||||
{
|
||||
throw std::logic_error("hex::decode: out of digits map");
|
||||
throw basen::Exception(basen::Exception::Code::OUT_OF_ALPH);
|
||||
}
|
||||
for (uint64_t i = 0; i * 2 < str_size; i++)
|
||||
for (size_t i = 0; i * 2 < str_size; i++)
|
||||
{
|
||||
data[i] = map[(int8_t)str[i * 2]] << 4 | map[(int8_t)str[i * 2 + 1]];
|
||||
data[i] = map[(uint8_t)str[i * 2]] << 4 | map[(uint8_t)str[i * 2 + 1]];
|
||||
}
|
||||
}
|
||||
std::vector<uint8_t> decode(std::string_view str) noexcept
|
||||
std::vector<uint8_t> decode(std::string_view str)
|
||||
{
|
||||
std::vector<uint8_t> data(hex::sizeDecoded(str));
|
||||
hex::decode(str.data(), str.size(), data.data(), data.size());
|
||||
|
||||
11
src/meson.build
Normal file
11
src/meson.build
Normal file
@ -0,0 +1,11 @@
|
||||
libbasen = library(
|
||||
'basen',
|
||||
'hex.cpp',
|
||||
'baseN.cpp',
|
||||
'base58.cpp',
|
||||
'base64.cpp',
|
||||
'Exception.cpp',
|
||||
'hash/sha256.cpp',
|
||||
include_directories: [include],
|
||||
install: true,
|
||||
)
|
||||
29
test/Exception.cpp
Normal file
29
test/Exception.cpp
Normal file
@ -0,0 +1,29 @@
|
||||
#include <basen/Exception.hpp>
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
TEST(Exception, Exception)
|
||||
{
|
||||
EXPECT_ANY_THROW(throw basen::Exception(basen::Exception::Code::BASE));
|
||||
}
|
||||
TEST(Exception, message)
|
||||
{
|
||||
try
|
||||
{
|
||||
throw basen::Exception(basen::Exception::Code::BASE);
|
||||
}
|
||||
catch (const basen::Exception &e)
|
||||
{
|
||||
EXPECT_STREQ(e.message(), "incorrect base");
|
||||
}
|
||||
}
|
||||
TEST(Exception, code)
|
||||
{
|
||||
try
|
||||
{
|
||||
throw basen::Exception(basen::Exception::Code::BASE);
|
||||
}
|
||||
catch (const basen::Exception &e)
|
||||
{
|
||||
EXPECT_EQ(uint32_t(e.code()), uint32_t(basen::Exception::Code::BASE));
|
||||
}
|
||||
}
|
||||
@ -1,6 +1,7 @@
|
||||
#include <utility>
|
||||
|
||||
#include <basen/base58.hpp>
|
||||
#include <basen/Exception.hpp>
|
||||
#include <basen/hex.hpp>
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
@ -18,18 +19,5 @@ TEST(base58, encodeCheck)
|
||||
TEST(base58, decodeCheck)
|
||||
{
|
||||
EXPECT_EQ(test.first, hex::encode(decodeCheck(test.second)));
|
||||
try
|
||||
{
|
||||
decodeCheck("incorrect");
|
||||
}
|
||||
catch (const std::exception &e)
|
||||
{
|
||||
EXPECT_STREQ(e.what(), "base58::decodeCheck: checksum incorrect");
|
||||
}
|
||||
}
|
||||
|
||||
int main(int argc, char **argv)
|
||||
{
|
||||
testing::InitGoogleTest(&argc, argv);
|
||||
return RUN_ALL_TESTS();
|
||||
EXPECT_THROW(decodeCheck("incorrect"), basen::Exception);
|
||||
}
|
||||
61
test/base64.cpp
Normal file
61
test/base64.cpp
Normal file
@ -0,0 +1,61 @@
|
||||
#include <utility>
|
||||
|
||||
#include <basen/base64.hpp>
|
||||
#include <basen/Exception.hpp>
|
||||
#include <basen/hex.hpp>
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
namespace base64 {
|
||||
|
||||
TEST(base64, isValid)
|
||||
{
|
||||
std::vector<std::pair<bool, std::string>> tests = {
|
||||
{true, "12=="},
|
||||
{true, "123="},
|
||||
{true, "1234"},
|
||||
{false, "1==="},
|
||||
{false, "?!*"},
|
||||
};
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, isValid(it.second));
|
||||
}
|
||||
std::vector<std::pair<std::string, std::string>> tests = {
|
||||
{"", ""},
|
||||
{"BKUEpQ==", "04a504a5"},
|
||||
{"aGVsbG8=", "68656c6c6f"},
|
||||
{"aGVsbG9v", "68656c6c6f6f"},
|
||||
};
|
||||
TEST(base64, encode)
|
||||
{
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, encode(hex::decode(it.second)));
|
||||
|
||||
std::vector<uint8_t> data = {0x74, 0x65, 0x73, 0x74};
|
||||
std::string str = "";
|
||||
EXPECT_THROW(encode(data.data(), std::numeric_limits<size_t>::max(), str.data(), str.size()), basen::Exception);
|
||||
EXPECT_THROW(encode(data.data(), data.size(), str.data(), str.size()), basen::Exception);
|
||||
EXPECT_NO_THROW(encode(data.data(), 0, str.data(), str.size()));
|
||||
}
|
||||
TEST(base64, encode_1e7)
|
||||
{
|
||||
std::vector<uint8_t> data(1e7);
|
||||
encode(data);
|
||||
}
|
||||
TEST(base64, decode)
|
||||
{
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(hex::encode(decode(it.first)), it.second);
|
||||
|
||||
std::vector<uint8_t> data = {0x61, 0x6e, 0x6f};
|
||||
EXPECT_THROW(decode("FFF", 3, data.data(), data.size()), basen::Exception);
|
||||
EXPECT_THROW(decode("!@#!", 4, data.data(), data.size()), basen::Exception);
|
||||
EXPECT_THROW(decode("FF==", 2, data.data(), 0), basen::Exception);
|
||||
EXPECT_NO_THROW(decode("", 0, data.data(), 0));
|
||||
}
|
||||
TEST(base64, decode_1e7)
|
||||
{
|
||||
std::string str(1e7, '0');
|
||||
decode(str);
|
||||
}
|
||||
|
||||
}
|
||||
85
test/baseN.cpp
Normal file
85
test/baseN.cpp
Normal file
@ -0,0 +1,85 @@
|
||||
#include <utility>
|
||||
|
||||
#include <basen/base58.hpp>
|
||||
#include <basen/baseN.hpp>
|
||||
#include <basen/Exception.hpp>
|
||||
#include <basen/hex.hpp>
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
namespace baseN {
|
||||
|
||||
TEST(baseN, digitsMap)
|
||||
{
|
||||
uint8_t map[256];
|
||||
digitsMap(base58::digits, 58, map);
|
||||
EXPECT_TRUE(std::equal(map, map + 256, base58::map));
|
||||
|
||||
EXPECT_THROW(digitsMap("11", 2, map), basen::Exception);
|
||||
}
|
||||
TEST(baseN, isValid)
|
||||
{
|
||||
std::vector<std::pair<bool, std::string>> tests = {
|
||||
{true, "123"},
|
||||
{false, "@#$"},
|
||||
};
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, isValid(it.second, base58::map));
|
||||
}
|
||||
TEST(baseN, sizeEncoded)
|
||||
{
|
||||
std::vector<std::pair<size_t, std::string>> tests = {
|
||||
{6, "12341234"},
|
||||
{5, "00000000"},
|
||||
};
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, sizeEncoded(hex::decode(it.second), 58));
|
||||
|
||||
EXPECT_THROW(sizeEncoded(hex::decode(""), 0), basen::Exception);
|
||||
}
|
||||
TEST(baseN, sizeDecoded)
|
||||
{
|
||||
std::vector<std::pair<size_t, std::string>> tests = {
|
||||
{3, "qwer"},
|
||||
{5, "1111"},
|
||||
};
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, sizeDecoded(it.second, 58, base58::digits));
|
||||
|
||||
EXPECT_THROW(sizeDecoded("", 0, base58::digits), basen::Exception);
|
||||
}
|
||||
std::vector<std::pair<std::string, std::string>> tests = {
|
||||
{"", ""},
|
||||
{"Ky", "044c"},
|
||||
{"KyK", "f94a"},
|
||||
{"KyKX", "387ae2"},
|
||||
{"KyKXa", "0ccbd755"},
|
||||
{"KyKXaa", "02e62ec963"},
|
||||
{"111KyKX", "000000387ae2"},
|
||||
{"4uqWDRyJZUpS6KKwLAiitndmv7TPFt2bfxVVfhJhgTn3Rh6aQtGHQY6PhhNDpCwSNU8a",
|
||||
"057902f9cebebb68879911002aae743280140a78c4a077405b057902f9cebebb68879911002aae743280140a78c4a077405b"},
|
||||
};
|
||||
TEST(baseN, encode)
|
||||
{
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, encode(hex::decode(it.second), 58, base58::digits));
|
||||
}
|
||||
TEST(baseN, encode_1e3)
|
||||
{
|
||||
std::vector<uint8_t> data(1e3);
|
||||
std::fill(data.begin(), data.end(), 1);
|
||||
encode(data, 58, base58::digits);
|
||||
}
|
||||
TEST(baseN, decode)
|
||||
{
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(hex::encode(decode(it.first, 58, base58::digits, base58::map)), it.second);
|
||||
|
||||
EXPECT_THROW(decode("!@#", 58, base58::digits, base58::map), basen::Exception);
|
||||
}
|
||||
TEST(baseN, decode_1e3)
|
||||
{
|
||||
std::string str(1e3, '2');
|
||||
decode(str, 58, base58::digits, base58::map);
|
||||
}
|
||||
|
||||
}
|
||||
@ -11,14 +11,8 @@ TEST(hash, sha256)
|
||||
TEST(hash, sha256_1e4)
|
||||
{
|
||||
std::vector<uint8_t> data(32);
|
||||
for (uint64_t i = 0; i < 1e4; i++)
|
||||
for (size_t i = 0; i < 1e4; i++)
|
||||
{
|
||||
sha256(data);
|
||||
}
|
||||
}
|
||||
|
||||
int main(int argc, char **argv)
|
||||
{
|
||||
testing::InitGoogleTest(&argc, argv);
|
||||
return RUN_ALL_TESTS();
|
||||
}
|
||||
@ -1,5 +1,6 @@
|
||||
#include <utility>
|
||||
|
||||
#include <basen/Exception.hpp>
|
||||
#include <basen/hex.hpp>
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
@ -20,8 +21,8 @@ TEST(hex, encode)
|
||||
EXPECT_EQ("74657374", encode(data));
|
||||
|
||||
std::string str = "";
|
||||
EXPECT_THROW(encode(data.data(), std::numeric_limits<uint64_t>::max(), str.data(), str.size()), std::overflow_error);
|
||||
EXPECT_THROW(encode(data.data(), data.size(), str.data(), str.size()), std::length_error);
|
||||
EXPECT_THROW(encode(data.data(), std::numeric_limits<size_t>::max(), str.data(), str.size()), basen::Exception);
|
||||
EXPECT_THROW(encode(data.data(), data.size(), str.data(), str.size()), basen::Exception);
|
||||
EXPECT_NO_THROW(encode(data.data(), 0, str.data(), str.size()));
|
||||
}
|
||||
TEST(hex, encode_1e7)
|
||||
@ -34,9 +35,9 @@ TEST(hex, decode)
|
||||
std::vector<uint8_t> data = {0x61, 0x6e, 0x6f};
|
||||
EXPECT_EQ(decode("616e6f"), data);
|
||||
|
||||
EXPECT_THROW(decode("FFF", 3, data.data(), data.size()), std::logic_error);
|
||||
EXPECT_THROW(decode("!@#!", 4, data.data(), data.size()), std::logic_error);
|
||||
EXPECT_THROW(decode("FF", 2, data.data(), 0), std::length_error);
|
||||
EXPECT_THROW(decode("FFF", 3, data.data(), data.size()), basen::Exception);
|
||||
EXPECT_THROW(decode("!@#!", 4, data.data(), data.size()), basen::Exception);
|
||||
EXPECT_THROW(decode("FF", 2, data.data(), 0), basen::Exception);
|
||||
EXPECT_NO_THROW(decode("", 0, data.data(), 0));
|
||||
}
|
||||
TEST(hex, decode_1e7)
|
||||
@ -44,9 +45,3 @@ TEST(hex, decode_1e7)
|
||||
std::string str(1e7, '0');
|
||||
decode(str);
|
||||
}
|
||||
|
||||
int main(int argc, char **argv)
|
||||
{
|
||||
testing::InitGoogleTest(&argc, argv);
|
||||
return RUN_ALL_TESTS();
|
||||
}
|
||||
14
test/meson.build
Normal file
14
test/meson.build
Normal file
@ -0,0 +1,14 @@
|
||||
gtest_dep = dependency('gtest', main: true)
|
||||
|
||||
test_exe = executable(
|
||||
'test_exe',
|
||||
'hex.cpp',
|
||||
'baseN.cpp',
|
||||
'base58.cpp',
|
||||
'base64.cpp',
|
||||
'Exception.cpp',
|
||||
'hash/sha256.cpp',
|
||||
dependencies: [basen_dep, gtest_dep],
|
||||
)
|
||||
|
||||
test('lib', test_exe)
|
||||
@ -1,64 +0,0 @@
|
||||
#include <utility>
|
||||
|
||||
#include <basen/base64.hpp>
|
||||
#include <basen/hex.hpp>
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
using namespace base64;
|
||||
|
||||
TEST(base64, isValid)
|
||||
{
|
||||
std::vector<std::pair<bool, std::string>> tests = {
|
||||
{true, "12=="},
|
||||
{true, "123="},
|
||||
{true, "1234"},
|
||||
{false, "1==="},
|
||||
{false, "?!*"},
|
||||
};
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, isValid(it.second));
|
||||
}
|
||||
std::vector<std::pair<std::string, std::string>> tests = {
|
||||
{"", ""},
|
||||
{"BKUEpQ==", "04a504a5"},
|
||||
{"BKUEpQA=", "04a504a500"},
|
||||
{"BKUEpQAA", "04a504a50000"},
|
||||
};
|
||||
TEST(base64, encode)
|
||||
{
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, encode(hex::decode(it.second)));
|
||||
|
||||
std::vector<uint8_t> data = {0x74, 0x65, 0x73, 0x74};
|
||||
std::string str = "";
|
||||
EXPECT_THROW(encode(data.data(), std::numeric_limits<uint64_t>::max(), str.data(), str.size()), std::overflow_error);
|
||||
EXPECT_THROW(encode(data.data(), data.size(), str.data(), str.size()), std::length_error);
|
||||
EXPECT_NO_THROW(encode(data.data(), 0, str.data(), str.size()));
|
||||
}
|
||||
TEST(base64, encode_1e7)
|
||||
{
|
||||
std::vector<uint8_t> data(1e7);
|
||||
encode(data);
|
||||
}
|
||||
TEST(base64, decode)
|
||||
{
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(hex::encode(decode(it.first)), it.second);
|
||||
|
||||
std::vector<uint8_t> data = {0x61, 0x6e, 0x6f};
|
||||
EXPECT_THROW(decode("FFF", 3, data.data(), data.size()), std::logic_error);
|
||||
EXPECT_THROW(decode("!@#!", 4, data.data(), data.size()), std::logic_error);
|
||||
EXPECT_THROW(decode("FF==", 2, data.data(), 0), std::length_error);
|
||||
EXPECT_NO_THROW(decode("" , 0, data.data(), 0));
|
||||
}
|
||||
TEST(base64, decode_1e7)
|
||||
{
|
||||
std::string str(1e7, '0');
|
||||
decode(str);
|
||||
}
|
||||
|
||||
int main(int argc, char **argv)
|
||||
{
|
||||
testing::InitGoogleTest(&argc, argv);
|
||||
return RUN_ALL_TESTS();
|
||||
}
|
||||
@ -1,74 +0,0 @@
|
||||
#include <utility>
|
||||
|
||||
#include <basen/base58.hpp>
|
||||
#include <basen/baseN.hpp>
|
||||
#include <basen/hex.hpp>
|
||||
#include <gtest/gtest.h>
|
||||
|
||||
using namespace baseN;
|
||||
|
||||
TEST(baseN, isValid)
|
||||
{
|
||||
std::vector<std::pair<bool, std::string>> tests = {
|
||||
{true, "123"},
|
||||
{false, "@#$"},
|
||||
};
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, isValid(it.second, base58::map));
|
||||
}
|
||||
TEST(baseN, sizeEncoded)
|
||||
{
|
||||
std::vector<std::pair<uint64_t, std::string>> tests = {
|
||||
{6, "12341234"},
|
||||
{5, "00000000"},
|
||||
};
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, sizeEncoded(hex::decode(it.second), 58));
|
||||
}
|
||||
TEST(baseN, sizeDecoded)
|
||||
{
|
||||
std::vector<std::pair<uint64_t, std::string>> tests = {
|
||||
{3, "qwer"},
|
||||
{5, "1111"},
|
||||
};
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, sizeDecoded(it.second, 58, base58::digits));
|
||||
}
|
||||
std::vector<std::pair<std::string, std::string>> tests = {
|
||||
{"", ""},
|
||||
{"Ky", "044c"},
|
||||
{"KyK", "f94a"},
|
||||
{"KyKX", "387ae2"},
|
||||
{"KyKXa", "0ccbd755"},
|
||||
{"KyKXaa", "02e62ec963"},
|
||||
{"111KyKX", "000000387ae2"},
|
||||
{"4uqWDRyJZUpS6KKwLAiitndmv7TPFt2bfxVVfhJhgTn3Rh6aQtGHQY6PhhNDpCwSNU8a",
|
||||
"057902f9cebebb68879911002aae743280140a78c4a077405b057902f9cebebb68879911002aae743280140a78c4a077405b"},
|
||||
};
|
||||
TEST(baseN, encode)
|
||||
{
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(it.first, encode(hex::decode(it.second), 58, base58::digits));
|
||||
}
|
||||
TEST(baseN, encode_1e3)
|
||||
{
|
||||
std::vector<uint8_t> data(1e3);
|
||||
std::fill(data.begin(), data.end(), 1);
|
||||
encode(data, 58, base58::digits);
|
||||
}
|
||||
TEST(baseN, decode)
|
||||
{
|
||||
for (auto it : tests)
|
||||
EXPECT_EQ(hex::encode(decode(it.first, 58, base58::digits, base58::map)), it.second);
|
||||
}
|
||||
TEST(baseN, decode_1e3)
|
||||
{
|
||||
std::string str(1e3, '2');
|
||||
decode(str, 58, base58::digits, base58::map);
|
||||
}
|
||||
|
||||
int main(int argc, char **argv)
|
||||
{
|
||||
testing::InitGoogleTest(&argc, argv);
|
||||
return RUN_ALL_TESTS();
|
||||
}
|
||||
156
tools/basen.cpp
Normal file
156
tools/basen.cpp
Normal file
@ -0,0 +1,156 @@
|
||||
#include <iostream>
|
||||
#include <unordered_map>
|
||||
|
||||
#include <argparse/argparse.hpp>
|
||||
|
||||
#include <basen.hpp>
|
||||
#include <config.hpp>
|
||||
|
||||
#ifdef _WIN32
|
||||
#include <io.h>
|
||||
#include <fcntl.h>
|
||||
#else
|
||||
#include <unistd.h>
|
||||
#endif
|
||||
|
||||
namespace basen
|
||||
{
|
||||
typedef std::string (*encoder_t)(std::span<const uint8_t>);
|
||||
typedef std::vector<uint8_t> (*decoder_t)(std::string_view);
|
||||
|
||||
const std::unordered_map<std::string, encoder_t> encoders = {
|
||||
{"base58", base58::encode},
|
||||
{"base58check", base58::encodeCheck},
|
||||
{"base64", base64::encode},
|
||||
{"hex", hex::encode},
|
||||
};
|
||||
const std::unordered_map<std::string, decoder_t> decoders = {
|
||||
{"base58", base58::decode},
|
||||
{"base58check", base58::decodeCheck},
|
||||
{"base64", base64::decode},
|
||||
{"hex", hex::decode},
|
||||
};
|
||||
|
||||
std::string getPipe()
|
||||
{
|
||||
std::string str;
|
||||
str.reserve(1024 * 1024);
|
||||
#ifdef _WIN32
|
||||
if (_isatty(_fileno(stdin)))
|
||||
#else
|
||||
if (isatty(fileno(stdin)))
|
||||
#endif
|
||||
{
|
||||
throw std::logic_error("should use pipe syntax ( | or < )");
|
||||
}
|
||||
else
|
||||
{
|
||||
char temp[4096];
|
||||
while (std::cin.read(temp, sizeof(temp)))
|
||||
{
|
||||
str.insert(str.end(), temp, temp + std::cin.gcount());
|
||||
}
|
||||
str.insert(str.end(), temp, temp + std::cin.gcount());
|
||||
}
|
||||
if (!str.empty() && str.back() == '\n')
|
||||
{
|
||||
str.erase(str.size() - 1);
|
||||
}
|
||||
return str;
|
||||
}
|
||||
uint8_t error(const std::string &str, argparse::ArgumentParser &program) noexcept
|
||||
{
|
||||
std::cerr << "\033[31merror:\t\033[0m"
|
||||
<< str << "\n\n"
|
||||
<< program << '\n';
|
||||
return 1;
|
||||
}
|
||||
}
|
||||
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
argparse::ArgumentParser program("basen", "1.1.0");
|
||||
program.add_argument("-t", "--type")
|
||||
.help("encoding type")
|
||||
.metavar("STRING")
|
||||
.choices("base58", "base58check", "base64", "hex");
|
||||
program.add_argument("-a", "--alphabet")
|
||||
.help("specify alphabet")
|
||||
.metavar("STRING");
|
||||
program.add_argument("-d", "--decode")
|
||||
.help("decode flag")
|
||||
.flag();
|
||||
program.add_argument("-v", "--version")
|
||||
.flag();
|
||||
try
|
||||
{
|
||||
program.parse_args(argc, argv);
|
||||
}
|
||||
catch (const std::exception &err)
|
||||
{
|
||||
return basen::error(err.what(), program);
|
||||
}
|
||||
if (program.is_used("-v")) {
|
||||
std::cout << BASEN_VER_STR << std::endl;
|
||||
return 0;
|
||||
}
|
||||
if (!program.is_used("-t") && !program.is_used("-a"))
|
||||
{
|
||||
return basen::error("either -t or -a should be provided", program);
|
||||
}
|
||||
if (program.is_used("-t") && program.is_used("-a"))
|
||||
{
|
||||
return basen::error("-t and -a cannot be used together", program);
|
||||
}
|
||||
std::string str;
|
||||
try
|
||||
{
|
||||
str = basen::getPipe();
|
||||
}
|
||||
catch (const std::exception &e)
|
||||
{
|
||||
return basen::error(e.what(), program);
|
||||
}
|
||||
try
|
||||
{
|
||||
if (program.is_used("-t"))
|
||||
{
|
||||
auto type = program.get<std::string>("-t");
|
||||
if (program.is_used("-d"))
|
||||
{
|
||||
auto data = (*basen::decoders.at(type))(str);
|
||||
std::for_each(data.begin(), data.end(), [](uint8_t item)
|
||||
{ std::cout << (char)item; });
|
||||
std::cout << '\n';
|
||||
}
|
||||
else
|
||||
{
|
||||
std::span<uint8_t> dv((uint8_t *)str.data(), str.size());
|
||||
std::cout << (*basen::encoders.at(type))(dv) << '\n';
|
||||
}
|
||||
}
|
||||
if (program.is_used("-a"))
|
||||
{
|
||||
auto alphabet = program.get<std::string>("-a");
|
||||
uint8_t map[256];
|
||||
baseN::digitsMap(alphabet.data(), alphabet.size(), map);
|
||||
if (program.is_used("-d"))
|
||||
{
|
||||
auto data = baseN::decode(str, alphabet.size(), alphabet.data(), map);
|
||||
std::for_each(data.begin(), data.end(), [](uint8_t item)
|
||||
{ std::cout << (char)item; });
|
||||
std::cout << '\n';
|
||||
}
|
||||
else
|
||||
{
|
||||
std::span<uint8_t> dv((uint8_t *)str.data(), str.size());
|
||||
std::cout << baseN::encode(dv, alphabet.size(), alphabet.data()) << '\n';
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (const basen::Exception &e)
|
||||
{
|
||||
return basen::error(e.message(), program);
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
8
tools/meson.build
Normal file
8
tools/meson.build
Normal file
@ -0,0 +1,8 @@
|
||||
argparse_dep = dependency('argparse')
|
||||
|
||||
executable(
|
||||
'basen',
|
||||
'basen.cpp',
|
||||
dependencies: [basen_dep, argparse_dep],
|
||||
install: true,
|
||||
)
|
||||
Reference in New Issue
Block a user