marco
/
dc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

First upload

This commit is contained in:
Marco Cetica 2023-11-02 17:25:24 +01:00
commit 84a0704588
Signed by: marco
GPG Key ID: 45060A949E90D0FD
18 changed files with 2927 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
.gitignore vendored Normal file
View File

@ -0,0 +1,32 @@
# 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

BIN
.screen.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 227 KiB

674
LICENSE Normal file
View File

@ -0,0 +1,674 @@
GNU 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>.

40
Makefile Normal file
View File

@ -0,0 +1,40 @@
TARGET = dc
CC = g++
CXXFLAGS = -Wall -Wextra -Werror -pedantic-errors -fstack-protector-strong \
-D_FORTIFY_SOURCE=2 -Wformat-security -fsanitize=address -fsanitize=undefined \
-fstack-clash-protection -std=c++20
all: $(TARGET)
$(TARGET): main.o eval.a math.a stack.a macro.a
$(CC) $(CXXFLAGS) $^ -o $@
main.o: main.cpp
$(CC) $(CXXFLAGS) -c $< -o $@
eval.a: eval.o
ar rcs $@ $^
math.a: math.o
ar rcs $@ $^
stack.a: stack.o
ar rcs $@ $^
macro.a: macro.o
ar rcs $@ $^
eval.o: src/eval.cpp
$(CC) $(CXXFLAGS) -c -o $@ $<
math.o: src/math.cpp
$(CC) $(CXXFLAGS) -c -o $@ $<
stack.o: src/stack.cpp
$(CC) $(CXXFLAGS) -c -o $@ $<
macro.o: src/macro.cpp
$(CC) $(CXXFLAGS) -c -o $@ $<
clean:
rm -f *.o *.a src/*.gch $(TARGET)

208
README.md Normal file
View File

@ -0,0 +1,208 @@
# dc ![](https://github.com/ice-bit/dc/actions/workflows/dc.yml/badge.svg)
**dc** is an advanced, scientific and programmable RPN desktop calculator with macro support (re)written in C++.
By default, dc supports a wide range of arithmetical, trigonometrical and numerical functions.
Its capabilities can be further extended by writing user-defined programs using the embedded, turing-complete, macro system.
**dc** reads from the standard input, but it can also work with text files using the `-f` flag. Futhermore, you can decide to evaluate an expression
without opening the REPL by using the `-e` flag.
Operands are pushed onto the stack following the LIFO policy; operators, on the other hand, pop one or more values
from the stack and push back the result. By default **dc** is very quiet, in order to inquiry the stack you need to use one of the supported
options(see below).
`dc` can be invoked with the following command line options:
```
Usage of dc:
-e string
Evaluate an expression
-f string
Evaluate a file containing expressions
-v Show version information
```
![](.screen.png)
Some of the supported features are:
- Basic arithmetical operations(`+`, `-`, `*`, `/`, `^`, `%`);
- Scientific notation support(`5e3` -> `5000`);
- Trigonometrical functions(`sin`, `cos`, `tan`);
- Base conversion(printBin `pb`, printOctal `po`, printHex `px`);
- Factorial and constants(`!`, `pi`, `e`);
- Stack operations:
- Print top element(`p`, `P`);
- Clear the stack(`c`);
- Remove top element(`R`);
- Swap order of top two elements(`r`);
- Duplicate top element(`d`);
- Dump the whole stack(`f`);
- Registers:
- Store top element of the stack on register `X`(`sX` or `SX`);
- Load content of register `X` on top of the stack(`lX` or `LX`);
- Arrays:
- Store second-to-top of main stack into array `X` indexed by top-of-stack(`:X`);
- Pop top-of-stack and use it as an index for array `X`(`;X`);
- Macros:
- Define a new macro inside square brackets(`[ ]`);
- Executing a macro from the stack(`x`);
- Evaluate a macro by comparing top-of-head and second-of-head elements(`>X`, `<X`, `>=X`, `<=X`, `!=` where `X` is a register).
And much more. You can find the complete manual [here](https://github.com/ice-bit/dc/blob/master/man.md).
## Installation
`dc` is written in Rust. You can compile it by issuing the following command:
```sh
$> cargo build --verbose --release
```
You will find the output binary at:
```sh
$> target/release/dc
```
To run unit tests, instead, type:
```sh
$> cargo test --all
```
## Usage
dc can be used in three different ways:
1. From the interactive REPL(run it without any argument);
2. By evaluating an inline expression, i.e.
```sh
$> dc -e "5 5 + p"
```
3. By evaluating a text file, i.e.
```sh
$> cat foo
2 4 - # Evaluate 2 - 4
2 ^ # Evaluate x^2
p # Print the result(4)
$> dc -f foo
4
```
Below there are more examples.
1. Evaluate
$$\frac{-5 + \sqrt(25 - 16)}{2}$$
```
-5 25 16 - v + 2 / p
```
where `v` is the square root function
2. Evaluate
$$\frac{.5 + .9}{3^4}$$
```
.5 .9 + 3 4 ^ / p
```
3. Evaluate `10 + 5` inline(i.e. without opening the REPL):
```sh
$> dc -e "10 5 +"
```
4. Evaluate an expression from a file:
```sh
$> cat foo
5 5 +
2 d * v
f
$> dc -f ./foo
```
5. Evaluate
$$\sin(2\pi) + \cos(2\pi)$$
```
2 pi * sin 2 pi * cos + p
```
6. Swap top two elements using registers(you can also use the `r` command):
```sh
5 4 p # Load some values on the stack(output: 4)
sA sB # Pop values and store them into the registers 'A' and 'B'
lA lB # Push 'A' and 'B' content onto the stack
p # Print top element(output: 5)
```
7. Print out numbers from 1 through user-defined upper bound:
```sh
[ p 1 + d lN >L ] sL # Print numbers from 1 through 'N'
[ Enter limit: ] P # Ask user for limit 'N'
? 1 + sN # Read from stdin
c 1 lL x # Clear the stack, add lower bound, load and execute macro
```
8. Sum the first 36 natural numbers(😈), i.e.,
$$\sum_{i=1}^{37} i = 666$$
```sh
$> dc -e "36 [ d 1 - d 1 <F + ] d sF x p"
```
5. Prints the first 20 values of `n!`:
```
[ la 1 + d sa * p la 20 >y ] sy
0 sa 1
ly x
```
9. Computes the factorial of a given number:
```
[ ln 1 - sn ln la * sa ln 1 !=f ] sf
[ Enter value: ] P ? sn
ln sa
lf x
la p
```
10. Computes the Greatest Common Divisor(GCD) between two user-defined numbers `A` and `B`:
```
[ Enter A: ] P R ?
[ Enter B: ] P R ?
[ d Sa r La % d 0 <a ] d sa x +
[ GCD(A,B)= ] P R p
```
11. Computes the Least Common Multiple(LCM) between two user-defined numbers `A` and `B`:
```
[ Enter A: ] P R ? d sA
[ Enter B: ] P R ? d SA
[ d Sa r La % d 0 <a ] d sa x +
LA lA * r /
[ LCM(A,B)= ] P R p
```
12. Find the roots of a quadratic equation of the form:
$$ax^2 + bx + c = 0$$
with $$a,b,c \in \mathbb{R}, a \neq 0$$
using the formula
$$x_{1,2} = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$$
```sh
#!/usr/local/bin/dc -f
# GIVEN A QUADRATIC EQUATION OF THE FORM
# AX^2 + BX + C = 0
# COMPUTE ITS REAL ROOTS
# THIS PROGRAM DOES NOT WORK WITH CMPLX NUMBERS
# DEVELOPED BY MARCO CETICA 2023
#
[ Enter A: ] P ? sA
[ Enter B: ] P ? sB
[ Enter C: ] P ? sC
lB 2 ^ 4 lA lC * * - v sD
lB -1 * lD - lA # NEGATIVE DELTA
2 * / sS # FIRST SOLUTION
lB -1 * lD + lA # POSITIVE DELTA
2 * / SS # SECOND SOLUTION
[ X: ] P R lS p
[ Y: ] P R LS lS p
```
## License
[GPLv3](https://choosealicense.com/licenses/gpl-3.0/)

133
main.cpp Normal file
View File

@ -0,0 +1,133 @@
#include <iostream>
#include <getopt.h>
#include <vector>
#include <sstream>
#include <iterator>
#include <fstream>
#include "src/types.h"
#include "src/eval.h"
#include "src/macro.h" // for split static method
#define DC_VERSION "1.0.0"
void helper() {
std::cout << "RPN desktop calculator with macro support. Usage: \n"
<< "-e, --expression <EXPRESSION> | Evaluate an expression\n"
<< "-f, --file <FILE> | Evaluate a file\n"
<< "-h, --help | Show this helper\n"
<< "-V, --version | Show version" << std::endl;
}
int main(int argc, char **argv) {
int opt;
const char *short_opts = "e:f:hV";
std::string cli_expression = "";
std::string file_name = "";
std::string stdin_expression = "";
bool execute_expression = false;
bool execute_file = false;
stack_t stack;
std::unordered_map<char, Register> regs;
struct option long_opts[] = {
{"expression", required_argument, nullptr, 'e'},
{"file", required_argument, nullptr, 'f'},
{"help", no_argument, nullptr, 'h'},
{"version", no_argument, nullptr, 'V'},
{nullptr, 0, nullptr, 0}
};
while((opt = getopt_long(argc, argv, short_opts, long_opts, nullptr)) != -1) {
switch(opt) {
case 'e': {
cli_expression = std::string(optarg);
execute_expression = true;
}
break;
case 'f': {
file_name = std::string(optarg);
execute_file = true;
}
break;
case 'V': {
std::cout << "dc v" << DC_VERSION << std::endl;
return 0;
}
break;
default: case 'h': case ':': case '?': helper(); return 0;;
}
}
// Evaluate cli expression
if(execute_expression) {
// Split string expression into a vector
std::vector<std::string> tokens = Macro::split(cli_expression);
// Evaluate expression
Evaluate evaluator(tokens, regs, stack);
auto err = evaluator.eval();
// Handle errors
if(err != std::nullopt) {
std::cerr << err.value() << std::endl;
}
return 0;
} else if(execute_file) {
// Open file from disk
std::fstream source_file(file_name, std::ios::in | std::ios::binary);
if(source_file.fail()) {
std::cerr << "Cannot open source file \"" << file_name << "\"." << std::endl;
return 1;
}
// Read whole file into a buffer
std::stringstream buf;
buf << source_file.rdbuf();
// Execute file line by line
std::string line;
while(std::getline(buf, line, '\n')) {
// Ignore comments or empty lines
if(line.empty() || line.starts_with('#')) {
continue;
}
// Remove inline comments
auto comment_pos = line.find('#');
std::vector<std::string> tokens;
if(comment_pos != std::string::npos) {
// Convert only the first part of the line
tokens = Macro::split(line.substr(0, comment_pos));
} else {
// Otherwise, convert the whole string
tokens = Macro::split(line);
}
// Evaluate expression
Evaluate evaluator(tokens, regs, stack);
auto err = evaluator.eval();
// Handle errors
if(err != std::nullopt) {
std::cerr << err.value() << std::endl;
}
}
return 0;
}
// Otherwise, evaluate from stdin
while(std::getline(std::cin, stdin_expression)) {
// Split string expression into a vector
std::vector<std::string> tokens = Macro::split(stdin_expression);
// Evaluate expression
Evaluate evaluator(tokens, regs, stack);
auto err = evaluator.eval();
// Handle errors
if(err != std::nullopt) {
std::cerr << err.value() << std::endl;
}
}
return 0;
}

378
man.md Normal file
View File

@ -0,0 +1,378 @@
---
title: dc
section: 1
header: General Commands Manual
footer: Marco Cetica
date: October 16, 2023
---
# NAME
dc − RPN desktop calculator with macro support
# SYNOPSIS
```
Usage of dc:
-e string
Evaluate an expression
-f string
Evaluate a file
-v Show version information
```
# DESCRIPTION
**dc** is an advanced, scientific and programmable RPN desktop calculator with macro support (re)written in C++.
By default, dc supports a wide range of arithmetical, trigonometrical and numerical functions.
Its capabilities can be further extended by writing user-defined programs using the embedded, turing-complete, macro system.
**dc** uses the reverse polish notation(**RPN**) to parse mathematical expressions. Unlike the infix notation, where operators
are placed _between_ operands, the polish notation(also called prefix notation) places operators _before_ the operands. The **reverse**
polish notation takes this concept even further by placing the operators _after_ the operands. As an example, consider the following
infix expression:
```
(((5 + 4) * (3 - 2)) / 2)
```
In RPN, this would be:
```
2 5 4 + 3 2 - * r / p
```
Operands are pushed onto the stack following the LIFO policy; operators, on the other hand, pop one or more values
from the stack and push back the result. By default **dc** is very quiet, in order to inquiry the stack you need to use one of the supported
options(see below).
**dc** reads from the standard input, but it can also work with text files using the `-f` flag. Futhermore, you can decide to evaluate an expression
without opening the REPL by using the `-e` flag.
# ARCHITECTURE
As an advanced scientific calculator, **dc** has a complex architecture defined by the following two data structures:
1. The main stack;
2. The register.
The _register_ can also be extended as follows:
1. The register stack;
2. The register array.
The _main stack_ is the primary form of memory of this program. Every time you enter a number or execute a command, you are operating
within the main stack. The _main stack_ is virtually infinite and grows as much as needed; the _main stack_ is **public**, i.e. it is
shared between any **dc** command.
The **register** is an hash map-like abstract data type that allows users to operate on an _isolated_ environment formed by a _stack_
and an _array_. Each instance of the register is an ordered pair `(key, value)` where the _key_ is a character representing the name of the
register and the _value_ is a **private** instance of a stack and a **private** instance of an array. **dc** commands - exception made for registers, macro and array commands -
cannot operate directly on the auxiliary stack or on the auxiliary array. In order to use a value stored on an auxiliary stack, you need to pop it
and push it onto the main stack(see the register section).
Both the _main stack_ and the _auxiliary stack_ implement the same abstract data type, therefore any kind of data type supported by the main stack,
as well as any other property or feature supported by the main stack is also supported by the register's stack.
_Arrays_ are dynamic, homogeneous and private abstract data type associated with a register.
The underlying data type of a dc array is a hashmap where the index is represented by
the map's `key` and the associated value is represented by the map's `value`.
# TYPE SYSTEM
By default each value of any kind of stack is represented by a string. Each operation is in charge to type convert the value before and after
their invocation. The user can store both numerical and alphanumerical values on the stack. The latter using the _macro_ syntax(see below).
Arrays are homogeneous, thus the only supported data type is the `string`(the internal string type and not the **dc** one).
# COMMANDS
Below, there is a list of supported **dc** commands.
## Printing Commands
**p**
Prints the value on the top of the stack, without altering the stack. A newline is printed after the value.
**P**
Pops off the value on top of the stack, without altering the stack.
**f**
Prints the entire contents of the stack without altering anything.
## Arithmetic
**+**
Pops two values off the stack, adds them, and pushes the result.
**-**
Pops two values, subtracts the first one popped from the second one popped, and pushes the result.
**\***
Pops two values, multiplies them, and pushes the result.
**/**
Pops two values, divides the second one popped from the first one popped, and pushes the result.
**%**
Pops two values, computes the remainder of the division between the second one popped and the first one popped. Pushes back the result.
**~**
Pops two values, divides the second one popped from the first one popped. The quotient is pushed first, and the remainder is pushed next.
**^**
Pops two values and computes their exponentiated, using the first value popped as the exponent and the second popped as the base.
**|**
Pops three values and computes a modular exponentiation. The first value popped is used as the reduction modulus; this value must be
a non-zero integer. The second popped is used as the exponent; this value must be a non-negative number. The third value popped is the base
which gets exponentiated, which should also be an integer. This function computes the following modular equivalence: `c ≡ b^e (mod n)`
**v**
Pops one value, computes its square root, and pushes that.
**!**
Pops one value, computes its factorial, and pushes that.
**pi**
Pushes pi approximation
**e**
Pushes e approximation
## Trigonometrical
**sin**
Pops one value, computes its `sin`, and pushes that.
**cos**
Pops one value, computes its `cos`, and pushes that.
**tan**
Pops one value, computes its `tan`, and pushes that.
## Base Conversion
**pb**
Prints the value on top of the stack in base 2, without altering the stack. A newline is printed after the value.
**po**
Prints the value on top of the stack in base 8, without altering the stack. A newline is printed after the value.
**px**
Prints the value on top of the stack in base 16, without altering the stack. A newline is printed after the value.
## Stack Control
**c**
Clears the stack, rendering it empty.
**d**
Duplicates the value on the top of the stack, pushing another copy of it. Thus, `4 d * p` computes 4 squared and prints it.
**r**
Reverses the order of the top two values of the stack. This can also be accomplished with the sequence `Sa Sb La Lb`.
**R**
Pops the top-of-stack without printing it
## Register(Stack)
As mentioned before, **dc** supports an hashmap ADT called **register** represented by an ordered pair `(key, value)`.
A register maps the `key`(represented by a single character) with a `value`(represented by an auxiliary stack and a private array).
At least 256 registers are available. Below, you can see the supported operations on register's stack.
**s**`r`
Pop the value off the top of the (main) stack and store it into top of the stack of register _r_.
This overwrite the top of the stack and does **NOT** follow the LIFO policy.
**l**`r`
Copy the value in top of the stack of register _r_ and push it onto the main stack.
The value 0 is retrieved if the register is uninitialized. This does not alter the contents of _r_.
**S**`r`
Pop the value off the top of the (main) stack and push it onto the stack of register _r_.
The previous of the register becomes inaccessible, thus it follows the LIFO policy.
**L**`r`
Pop the value off the top of register _r_'s stack and push it onto the main stack. The previous value in register _r_'s stack, if any,
is now accessible via the **b**r command.
## Register(Array)
Arrays support random access through an index. You can store a value in an array and retrieve it later.
**:**`r`
Will pop the top two values off the stack. The second-to-top value will be stored in
the array `r`, indexed by the top-of-stack value.
**;**`r`
Pops the top-of-stack and uses it as an index into array `r`. The selected value
is then pushed onto the stack.
## Strings
_dc_ has a limited ability to operate on strings as well as on numbers; the only things you can do with strings are print them and execute them as macros (which means that the content of a string can executed as a _dc_ program). Any kind of stack can hold strings, and _dc_ always knows whether any given object is a string or a number.
Some commands such as arithmetic operations demand numbers as arguments and print errors if given strings.
Other commands can accept either a number or a string; for example, the **p** command can accept either and prints the object according to its type.
**[ characters ]**
Makes a string containing _characters_ (contained between balanced **\[** and **\]** characters), and pushes it on the stack. For example, **\[ Hello World \] P** prints the string **Hello World** (with no newline).
**x**
Pops a value off the stack and executes it as a macro. Normally it should be a string; if it is a number, it is simply pushed back onto the stack. For example, **\[ 1 p \] x** executes the macro **1 p** which pushes **1** on the stack and prints **1** on a separate line.
Macros are most often stored in register's stacks; **\[ 1 p \] sa** stores a macro to print **1** into register's stack **a**, and **la x** invokes this macro.
**\>**`r`
Pops two values off the stack and compares them assuming they are numbers, executing the contents of register _r_ as a macro if the original top-of-stack is greater. Thus, **1 2>a** will invoke register **a**’s contents and **2 1>a** will not.
**\=>**`r`
Similar but invokes the macro if the original top-of-stack is greater or equal to the second-to-top.
**<**`r`
Similar but invokes the macro if the original top-of-stack is less.
**<=**`r`
Similar but invokes the macro if the original top-of-stack is less or equal to the second-to-top.
**\=**`r`
Similar but invokes the macro if the two numbers popped are equal.
**!=**`r`
Similar but invokes the macro if the two numbers popped are not equal.
## Status Inquiry
**Z**
Pops a value off the stack, calculates the number of digits it has (or number of characters, if it is a string) and pushes that number.
**z**
Pushes the current stack depth: the number of objects on the stack before the execution of the **z** command.
## Miscellaneous
**q**
Exit with return code `0`.
**?**
Reads a line from the terminal and executes it. This command allows a macro to request input from the user.
# EXAMPLES
Below, there are some practical problems solved using **dc**.
1. Evaluate `(-5 + sqrt(25 - 16)) / 2`:
```
-5 25 16 - v + 2 / p
```
2. Evaluate `sin(2pi)+cos(2pi)`:
```
2 pi * sin 2 pi * cos + p
```
3. Loop from 1 to `n`, where `n` is a user-defined value:
```
[ p 1 + d lN >L ] sL # Print numbers from 1 through 'N'
[ Enter limit: ] P # Ask user for limit 'N'
? 1 + sN # Read from stdin
c 1 lL x # Clear the stack, add lower bound, load and execute macro
```
4. Sum the first `n` natural numbers, where `n` is a user-defined value:
```
[ Enter bound: ] P ?
[ d 1 - d 1 <F + ] d sF x p
```
5. Prints the first 20 values of `n!`:
```
[ la 1 + d sa * p la 20 >y ] sy
0 sa 1
ly x
```
6. Computes the factorial of a given number:
```
[ ln 1 - sn ln la * sa ln 1 !=f ] sf
[ Enter value: ] P ? sn
ln sa
lf x
la p
```
7. Computes the Greatest Common Divisor(GCD) between two user-defined numbers `A` and `B`:
```
[ Enter A: ] P R ?
[ Enter B: ] P R ?
[ d Sa r La % d 0 <a ] d sa x +
[ GCD(A,B)= ] P R p
```
8. Computes the Least Common Multiple(LCM) between two user-defined numbers `A` and `B`:
```
[ Enter A: ] P R ? d sA
[ Enter B: ] P R ? d SA
[ d Sa r La % d 0 <a ] d sa x +
LA lA * r /
[ LCM(A,B)= ] P R p
```
9. Find the roots of a quadratic equation
```
[ Enter A: ] P ? sA
[ Enter B: ] P ? sB
[ Enter C: ] P ? sC
lB 2 ^ 4 lA lC * * - v sD
lB -1 * lD - lA # NEGATIVE DELTA
2 * / sS # FIRST SOLUTION
lB -1 * lD + lA # POSITIVE DELTA
2 * / SS # SECOND SOLUTION
[ X: ] P R lS p
[ Y: ] P R LS lS p
```
# AUTHORS
The original version of the **dc** command was written by Robert Morris and Lorinda Cherry.
This version of **dc** is developed by Marco Cetica.
# BUGS
If you encounter any kind of problem, email me at [email@marcocetica.com](mailto:email@marcocetica.com) or open an issue at [https://github.com/ice-bit/dc](https://github.com/ice-bit/dc).

562
src/eval.cpp Normal file
View File

@ -0,0 +1,562 @@
#include "eval.h"
#include "math.h"
#include "stack.h"
#include "macro.h"
#include "is_num.h"
std::optional<std::string> Evaluate::eval() {
for(size_t idx = 0; idx < this->expr.size(); idx++) {
auto val = this->expr.at(idx);
std::optional<std::string> err = std::nullopt;
//
// NUMERICAL OPERATIONS
//
if(val == "+") {
IOperation *math = new Math(OPType::ADD);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "-") {
IOperation *math = new Math(OPType::SUB);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "*") {
IOperation *math = new Math(OPType::MUL);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val =="/") {
IOperation *math = new Math(OPType::DIV);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "%") {
IOperation *math = new Math(OPType::MOD);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "~") {
IOperation *math = new Math(OPType::DIV_MOD);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "|") {
IOperation *math = new Math(OPType::MOD_EXP);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "^") {
IOperation *math = new Math(OPType::EXP);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "v") {
IOperation *math = new Math(OPType::SQRT);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "sin") {
IOperation *math = new Math(OPType::SIN);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "cos") {
IOperation *math = new Math(OPType::COS);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "tan") {
IOperation *math = new Math(OPType::TAN);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "!") {
IOperation *math = new Math(OPType::FACT);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "pi") {
IOperation *math = new Math(OPType::PI);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
} else if(val == "e") {
IOperation *math = new Math(OPType::E);
err = math->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete math;
}
//
// STACK OPERATIONS
//
else if(val == "p") { // PRINT TOP ELEMENT OF STACK
IOperation *stack = new Stack(OPType::PCG);
err = stack->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete stack;
} else if(val == "P") { // PRINT TOP ELEMENT WITHOUT NEWLINE
IOperation *stack = new Stack(OPType::P);
err = stack->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete stack;
} else if(val == "c") { // CLEAR THE STACK
IOperation *stack = new Stack(OPType::CLR);
err = stack->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete stack;
} else if(val == "R") { // POP HEAD OF THE STACK WITHOUT PRINTING IT
IOperation *stack = new Stack(OPType::PH);
err = stack->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete stack;
} else if(val == "r") { // SWAP ORDER OF THE TWO TOP ELEMENTS
IOperation *stack = new Stack(OPType::SO);
err = stack->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete stack;
} else if(val == "d") { // DUPLICATE THE HEAD OF THE STACK
IOperation *stack = new Stack(OPType::DP);
err = stack->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete stack;
} else if(val == "f") { // PRINT THE WHOLE STACK
IOperation *stack = new Stack(OPType::PS);
err = stack->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete stack;
} else if(val == "Z") { // COMPUTE HEAD SIZE(NUM. OF CHARS/DIGITS)
IOperation *stack = new Stack(OPType::CH);
err = stack->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete stack;
} else if(val == "z") { // COMPUTE STACK SIZE
IOperation *stack = new Stack(OPType::CS);
err = stack->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete stack;
} else if(val == "x") { // EXECUTE MACRO
IOperation *macro = new Macro(OPType::EX, this->regs);
err = macro->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete macro;
} else if(val == "?") { // READ LINE FROM STDIN
IOperation *macro = new Macro(OPType::RI, this->regs);
err = macro->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete macro;
} else if(val == "q") { // QUIT GRACEFULLY
std::exit(0);
} else {
err = handle_special(val, idx, expr);
if(err != std::nullopt) {
return err;
}
}
}
return std::nullopt;
}
std::optional<std::string> Evaluate::handle_special(std::string val, size_t &idx, std::vector<std::string> &expr) {
std::optional<std::string> err = std::nullopt;
if(val.length() == 1 && val == "[") {
err = parse_macro(idx, expr);
} else if((val.length() == 2 || val.length() == 3) &&
(val.at(0) == '>' || val.at(0) == '<' ||
val.at(0) == '=' || val.at(0) == '!')) {
err = parse_macro_command(val);
} else if((val.length() == 2) &&
(val.at(0) == 's' || val.at(0) == 'S' ||
val.at(0) == 'l' || val.at(0) == 'L')) {
err = parse_register_command(val);
} else if((val.length() == 2) && (val.at(0) == ':' || val.at(0) == ';')) {
err = parse_array_command(val);
} else if(is_num<double>(val)) {
this->stack.push_back(val);
} else {
return "Unrecognized option";
}
return err;
}
std::optional<std::string> Evaluate::parse_macro(size_t &idx, std::vector<std::string> &expr) {
// A macro is any string surrounded by square brackets
std::string dc_macro = "";
bool closing_bracket = false;
// Scan next token
idx++;
// Parse the macro
while(idx < expr.size()) {
// Continue to parse until the clsoing square brackets
if(expr.at(idx) == "]") {
closing_bracket = true;
break;
}
// Otherwise append the token to the macro.
// If the macro is not empty, add some spacing
// before the new token
if(dc_macro.empty()) {
dc_macro += expr.at(idx);
} else {
dc_macro += ' ' + expr.at(idx);
}
// Go to the next token
idx++;
}
// Check if macro is properly formatted
if(!closing_bracket) {
return "Unbalanced parenthesis";
}
// Check if macro is empty
if(dc_macro.empty()) {
return "Empty macro";
}
// Push the macro back onto the stack
this->stack.push_back(dc_macro);
return std::nullopt;
}
std::optional<std::string> Evaluate::parse_macro_command(std::string val) {
// A macro command is a comparison symbol(>, <, =, >=, <=, !=)
// followed by a register name(e.g, >A)
// If command has length equal to three, then it's either '<=', '>=' or '!='
// Check if command is >=, <= or !=
std::string operation = "";
char dc_register = 0;
if(val.length() == 3) {
operation = val.substr(0, 2);
dc_register = val.at(2);
} else { // Otherwise it's either >, < or =
operation = val.at(0);
dc_register = val.at(1);
}
// Macro commands works as follow
// Pop two values off the stack and compares them assuming
// they are numbers. If top-of-stack is greater,
// execute register's content as a macro
std::optional<std::string> err = std::nullopt;
if(operation == ">") {
IOperation *macro = new Macro(OPType::CMP, Operator::GT, dc_register, this->regs);
err = macro->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete macro;
} else if(operation == "<") {
IOperation *macro = new Macro(OPType::CMP, Operator::LT, dc_register, this->regs);
err = macro->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete macro;
} else if(operation == "=") {
IOperation *macro = new Macro(OPType::CMP, Operator::EQ, dc_register, this->regs);
err = macro->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete macro;
} else if(operation == ">=") {
IOperation *macro = new Macro(OPType::CMP, Operator::GEQ, dc_register, this->regs);
err = macro->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete macro;
} else if(operation == "<=") {
IOperation *macro = new Macro(OPType::CMP, Operator::LEQ, dc_register, this->regs);
err = macro->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete macro;
} else if(operation == "!=") {
IOperation *macro = new Macro(OPType::CMP, Operator::NEQ, dc_register, this->regs);
err = macro->exec(this->stack);
if(err != std::nullopt) {
return err;
}
delete macro;
}
return err;
}
std::optional<std::string> Evaluate::parse_register_command(std::string val) {
// A register command has length equal to 2
// and starts either with 's', 'l'(i.e. "sX" or "lX")
// or with 'S' or 'L'(i.e., "SX", "LX")
if(val.at(0) == 's') {
// Check if main stack is empty
if(this->stack.empty()) {
return "This operation does not work on empty stack";
}
// Otherwise pop an element from main stack and store it into
// the register's top-of-the-stack. Any previous value gets overwritten
auto reg_name = val.at(1);
auto head = this->stack.back();
this->stack.pop_back();
// Always discard previous instance of the register
// i.e., initialize a new instance of register 'reg_name'
this->regs.insert(
std::make_pair(reg_name, Register{
std::vector<std::string>(),
std::unordered_map<int, std::string>()
})
);
// Populate register's 'reg_name' stack with top of main stack
this->regs[reg_name].stack.push_back(head);
} else if(val.at(0) == 'S') {
// An uppercase 'S' pops the top of the main stack and
// pushes it onto the stack of selected register.
// The previous value of the register's stack becomes
// inaccessible(i.e. it follows LIFO policy).
// Check if main stack is empty
if(this->stack.empty()) {
return "This operation does not work on empty stack";
}
auto reg_name = val.at(1);
auto head = this->stack.back();
this->stack.pop_back();
// If register's stack exist, push an element onto its stack
// otherwise allocate a new instance of the register
auto it = this->regs.find(reg_name);
if(it != this->regs.end()) { // Register exists
it->second.stack.push_back(head);
} else { // Register doesn't exist
this->regs[reg_name] = Register{
std::vector<std::string>{head},
std::unordered_map<int, std::string>()
};
}
} else if(val.at(0) == 'L') {
// An uppercase 'L' pops the top of the register's stack
// abd pushes it onto the main stack. The previous register's stack
// value, if any, is accessible via the lowercase 'l' command
auto reg_name = val.at(1);
// Check if register exists
if(this->regs.find(reg_name) == this->regs.end()) {
return std::string("Register '") + reg_name + std::string("' is undefined");
}
// Check if register's stack is empty
if(this->regs[reg_name].stack.empty()) {
return std::string("The stack of register '") + reg_name + std::string(" is empty");
}
// Otherwise, pop an element from the register's stack and push it onto the main stack
auto value = this->regs[reg_name].stack.back();
this->regs[reg_name].stack.pop_back();
this->stack.push_back(value);
} else {
// Otherwise retrieve the register name and push its value
// to the stack without altering the register's stack.
// If the register is empty, push '0' to the stack
auto reg_name = val.at(1);
// If register does not exists or its stack is empty, push '0' onto the main stack
auto it = this->regs.find(reg_name);
if(it == this->regs.end() || it->second.stack.empty()) {
this->stack.push_back("0");
return std::nullopt;
}
// Otherwise, peek an element from the register's stack and push it onto the main stack
auto value = this->regs[reg_name].stack.back();
this->stack.push_back(value);
}
return std::nullopt;
}
std::optional<std::string> Evaluate::parse_array_command(std::string val) {
// An array command has length equal to 2, starts
// with either ':'(store) or ';'(read) and ends with
// the register name(i.e., ':X' or ';X')
if(val.at(0) == ':') {
// An ':' command pops two values from the main stack. The second-to-top
// element will be stored in the array indexed by the top-of-stack.
auto reg_name = val.at(1);
// Check if the main stack has enough elements
if(this->stack.size() < 2) {
return "This operation requires two values";
}
// Extract two elements from the main stack
auto idx_str = this->stack.back();
this->stack.pop_back();
auto val = this->stack.back();
this->stack.pop_back();
// Check whether the index is an integer
if(!is_num<int>(idx_str)) {
return "Array index must be an integer";
}
// Otherwise convert it into an integer
auto idx = std::stoi(idx_str);
// If array exists, store 'p' at index 'i' on array 'r'
// If array does not exist, allocate a new array first
auto it = this->regs.find(reg_name);
if(it != this->regs.end()) { // Register exists
it->second.array.insert(std::pair<int, std::string>(idx, val));
} else { // Register doesn't exist
this->regs[reg_name] = Register{
std::vector<std::string>(),
std::unordered_map<int, std::string>{{idx, val}}
};
}
} else {
// An ';' command pops top-of-stack abd uses it as an index
// for the array. The selected value, if any, is pushed onto the stack
auto reg_name = val.at(1);
// Check if the main stack is empty
if(this->stack.empty()) {
return "This operation requires one value";
}
// Extract the index from the stack
auto idx_str = this->stack.back();
this->stack.pop_back();
// Check if index is an integer
if(!is_num<int>(idx_str)) {
return "Array index must be an integer";
}
// Otherwise, convert it to integer
auto idx = std::stoi(idx_str);
// Check if the array exists
if(this->regs.find(reg_name) == this->regs.end()) {
return std::string("Register '") + reg_name + std::string("' is undefined");
}
// Check if array is empty
if(this->regs[reg_name].array.empty()) {
return std::string("The array of register '") + reg_name + std::string("' is empty");
}
// Otherwise, use the index to retrieve the array element
// and to push it onto the main stack
auto reg_it = regs.find(reg_name);
auto arr_it = reg_it->second.array.find(idx);
if(arr_it != reg_it->second.array.end()) {
this->stack.push_back(arr_it->second);
} else {
return std::string("Cannot access ") + reg_name +
std::string("[") + std::to_string(idx) + std::string("]");
}
}
return std::nullopt;
}

27
src/eval.h Normal file
View File

@ -0,0 +1,27 @@
#pragma once
#include <string>
#include <vector>
#include <unordered_map>
#include <optional>
#include "types.h"
class Evaluate {
public:
Evaluate(std::vector<std::string> expr, std::unordered_map<char, Register> &regs, stack_t &stack)
: expr(expr), regs(regs), stack(stack) {}
Evaluate(std::unordered_map<char, Register> &regs, stack_t &stack)
: regs(regs), stack(stack) {}
std::optional<std::string> eval();
private:
std::optional<std::string> handle_special(std::string val, size_t &idx, std::vector<std::string> &expr);
std::optional<std::string> parse_macro(size_t &idx, std::vector<std::string> &expr);
std::optional<std::string> parse_macro_command(std::string val);
std::optional<std::string> parse_register_command(std::string val);
std::optional<std::string> parse_array_command(std::string val);
std::vector<std::string> expr;
std::unordered_map<char, Register> &regs;
stack_t &stack;
};

10
src/is_num.h Normal file
View File

@ -0,0 +1,10 @@
#pragma once
#include <sstream>
template <typename T>
bool is_num(const std::string &str) {
std::istringstream ss(str);
T number;
return (ss >> number) && ss.eof();
}

176
src/macro.cpp Normal file
View File

@ -0,0 +1,176 @@
#include <iostream>
#include <sstream>
#include <iterator>
#include <limits>
#include "eval.h"
#include "macro.h"
#include "is_num.h"
std::optional<std::string> Macro::exec(stack_t &stack) {
std::optional<std::string> err = std::nullopt;
switch(this->op_type) {
case OPType::EX: err = fn_execute(stack); break;
case OPType::CMP: err = fn_evaluate_macro(stack); break;
case OPType::RI: err = fn_read_input(stack); break;
default: break;
}
return err;
}
std::optional<std::string> Macro::fn_execute(stack_t &stack) {
// Check if stack has enough elements
if(stack.empty()) {
return "This operation does not work on empty stack";
}
// If the head of the stack is a string
// pop it and execute it as a macro
auto head = stack.back();
if(!is_num<double>(head)) {
stack.pop_back();
std::vector<std::string> tokens = split(head);
Evaluate evaluator(tokens, this->regs, stack);
auto err = evaluator.eval();
if(err != std::nullopt) {
return err;
}
}
return std::nullopt;
}
std::optional<std::string> Macro::fn_evaluate_macro(stack_t &stack) {
// Check whether the main stack has enough elements
if(stack.size() < 2) {
return "This operation requires two elements";
}
// Check whether the register's stack exists or not
if(this->regs.find(this->dc_register) == this->regs.end()) {
return "Null register";
}
// Extract macro and top two values of the stack
auto head_str = stack.back();
stack.pop_back();
auto second_str = stack.back();
stack.pop_back();
auto dc_macro = this->regs[this->dc_register].stack.back();
// Check if macro exists and if top two elements of main stack are numbers
if(!dc_macro.empty() && is_num<double>(head_str) && is_num<double>(second_str)) {
auto head = std::stod(head_str);
auto second = std::stod(second_str);
switch(this->op) {
case Operator::GT: {
if(head > second) {
std::vector<std::string> tokens = split(dc_macro);
Evaluate evaluator(tokens, this->regs, stack);
auto err = evaluator.eval();
if(err != std::nullopt) {
return err;
}
}
break;
}
case Operator::LT: {
if(head < second) {
std::vector<std::string> tokens = split(dc_macro);
Evaluate evaluator(tokens, this->regs, stack);
auto err = evaluator.eval();
if(err != std::nullopt) {
return err;
}
}
break;
}
case Operator::EQ: {
if(head == second) {
std::vector<std::string> tokens = split(dc_macro);
Evaluate evaluator(tokens, this->regs, stack);
auto err = evaluator.eval();
if(err != std::nullopt) {
return err;
}
}
break;
}
case Operator::GEQ: {
if(head >= second) {
std::vector<std::string> tokens = split(dc_macro);
Evaluate evaluator(tokens, this->regs, stack);
auto err = evaluator.eval();
if(err != std::nullopt) {
return err;
}
}
break;
}
case Operator::LEQ: {
if(head <= second) {
std::vector<std::string> tokens = split(dc_macro);
Evaluate evaluator(tokens, this->regs, stack);
auto err = evaluator.eval();
if(err != std::nullopt) {
return err;
}
}
break;
}
case Operator::NEQ: {
if(head != second) {
std::vector<std::string> tokens = split(dc_macro);
Evaluate evaluator(tokens, this->regs, stack);
auto err = evaluator.eval();
if(err != std::nullopt) {
return err;
}
}
break;
}
}
}
return std::nullopt;
}
std::optional<std::string> Macro::fn_read_input(stack_t &stack) {
// Read user input from stdin
std::string user_input = "";
std::cin >> user_input;
if(std::cin.fail()) {
return "Error while reading from stdin";
}
// Push the input onto the main stack and execute it as a macro
stack.push_back(user_input);
Evaluate evaluator(this->regs, stack);
auto err = evaluator.eval();
if(err != std::nullopt) {
return err;
}
return std::nullopt;
}
std::vector<std::string> Macro::split(std::string str) {
std::stringstream ss(str);
std::istream_iterator<std::string> begin(ss);
std::istream_iterator<std::string> end;
std::vector<std::string> vec(begin, end);
return vec;
}

27
src/macro.h Normal file
View File

@ -0,0 +1,27 @@
#pragma once
#include "operation.h"
enum class Operator {
GT, LT, EQ, GEQ, LEQ, NEQ
};
class Macro : public IOperation {
public:
Macro(OPType op_type, Operator op, char dc_register, std::unordered_map<char, Register> &regs)
: op_type(op_type), op(op), dc_register(dc_register), regs(regs) {}
Macro(OPType op_type, std::unordered_map<char, Register> &regs)
: op_type(op_type), regs(regs) {}
std::optional<std::string> exec(stack_t &stack) override;
static std::vector<std::string> split(std::string str);
private:
std::optional<std::string> fn_execute(stack_t &stack);
std::optional<std::string> fn_evaluate_macro(stack_t &stack);
std::optional<std::string> fn_read_input(stack_t &stack);
OPType op_type;
Operator op;
char dc_register;
std::unordered_map<char, Register> &regs;
};

459
src/math.cpp Normal file
View File

@ -0,0 +1,459 @@
#include <cmath>
#include "math.h"
#include "is_num.h"
std::optional<std::string> Math::exec(stack_t &stack) {
std::optional<std::string> err = std::nullopt;
switch(this->op_type) {
case OPType::ADD: err = fn_add(stack); break;
case OPType::SUB: err = fn_sub(stack); break;
case OPType::MUL: err = fn_mul(stack); break;
case OPType::DIV: err = fn_div(stack); break;
case OPType::MOD: err = fn_mod(stack); break;
case OPType::DIV_MOD: err = fn_div_mod(stack); break;
case OPType::MOD_EXP: err = fn_mod_exp(stack); break;
case OPType::EXP: err = fn_exp(stack); break;
case OPType::SQRT: err = fn_sqrt(stack); break;
case OPType::SIN: err = fn_sin(stack); break;
case OPType::COS: err = fn_cos(stack); break;
case OPType::TAN: err = fn_tan(stack); break;
case OPType::FACT: err = fn_fact(stack); break;
case OPType::PI: err = fn_pi(stack); break;
case OPType::E: err = fn_e(stack); break;
default: break;
}
return err;
}
std::optional<std::string> Math::fn_add(stack_t &stack) {
// Check if stack has enough elements
if(stack.size() < 2) {
return "'+' requires two operands";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto y = stack.at(len-1);
auto is_x_num = is_num<double>(x);
auto is_y_num = is_num<double>(y);
// Check whether both entries are numbers
if(is_x_num && is_y_num) {
auto lhs = std::stod(stack.back());
stack.pop_back();
auto rhs = std::stod(stack.back());
stack.pop_back();
// Push back the result as a string
stack.push_back(std::to_string(lhs + rhs));
} else {
return "'+' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_sub(stack_t &stack) {
// Check if stack has enough elements
if(stack.size() < 2) {
return "'-' requires two operands";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto y = stack.at(len-1);
auto is_x_num = is_num<double>(x);
auto is_y_num = is_num<double>(y);
// Check whether both entries are numbers
if(is_x_num && is_y_num) {
auto lhs = std::stod(stack.back());
stack.pop_back();
auto rhs = std::stod(stack.back());
stack.pop_back();
// Push back the result as a string
stack.push_back(std::to_string(-(lhs - rhs)));
} else {
return "'-' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_mul(stack_t &stack) {
// Check if stack has enough elements
if(stack.size() < 2) {
return "'*' requires two operands";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto y = stack.at(len-1);
auto is_x_num = is_num<double>(x);
auto is_y_num = is_num<double>(y);
// Check whether both entries are numbers
if(is_x_num && is_y_num) {
auto lhs = std::stod(stack.back());
stack.pop_back();
auto rhs = std::stod(stack.back());
stack.pop_back();
// Push back the result as a string
stack.push_back(std::to_string(lhs * rhs));
} else {
return "'*' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_div(stack_t &stack) {
// Check if stack has enough elements
if(stack.size() < 2) {
return "'/' requires two operands";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto y = stack.at(len-1);
auto is_x_num = is_num<double>(x);
auto is_y_num = is_num<double>(y);
// Check whether both entries are numbers
if(is_x_num && is_y_num) {
auto divisor = std::stod(stack.back());
stack.pop_back();
auto dividend = std::stod(stack.back());
stack.pop_back();
// Check whether divisor is equal to zero
if(divisor == (double)0) {
return "Cannot divide by zero";
}
// Push back the result as a string
stack.push_back(std::to_string(dividend / divisor));
} else {
return "'/' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_mod(stack_t &stack) {
// Check if stack has enough elements
if(stack.size() < 2) {
return "'%' requires two operands";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto y = stack.at(len-1);
auto is_x_num = is_num<double>(x);
auto is_y_num = is_num<double>(y);
// Check whether both entries are numbers
if(is_x_num && is_y_num) {
auto rhs = std::stod(stack.back());
stack.pop_back();
auto lhs = std::stod(stack.back());
stack.pop_back();
// Check whether divisor is equal to zero
if(rhs == (double)0) {
return "Cannot divide by zero";
}
// Push back the result as a string
stack.push_back(std::to_string((int)lhs % (int)rhs));
} else {
return "'%' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_div_mod(stack_t &stack) {
// Check if stack has enough elements
if(stack.size() < 2) {
return "'~' requires two operands";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto y = stack.at(len-1);
auto is_x_num = is_num<double>(x);
auto is_y_num = is_num<double>(y);
// Check whether both entries are numbers
if(is_x_num && is_y_num) {
auto divisor = std::stod(stack.back());
stack.pop_back();
auto dividend = std::stod(stack.back());
stack.pop_back();
// Check if divisor is not equal to zero
if(divisor != (double)0) {
auto quotient = std::trunc(dividend / divisor);
auto remainder = ((int)dividend % (int)divisor);
stack.push_back(std::to_string(quotient));
stack.push_back(std::to_string(remainder));
}
} else {
return "'~' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_mod_exp(stack_t &stack) {
// Check if stack has enough elements
if(stack.size() < 3) {
return "'|' requires three operands";
}
// Otherwise extract three elements from the stack.
// The first one is the modulus(n), the second one
// is the exponent(e) and the third one is the base(b)
auto len = stack.size()-1;
auto n = stack.at(len);
auto e = stack.at(len-1);
auto b = stack.at(len-2);
auto is_n_num = is_num<double>(n);
auto is_e_num = is_num<double>(e);
auto is_b_num = is_num<double>(b);
// This functions computes
// c ≡ b^e (mod n)
if(is_n_num && is_e_num && is_b_num) {
auto modulus = std::stoi(stack.back());
stack.pop_back();
auto exponent = std::stoi(stack.back());
stack.pop_back();
auto base = std::stoi(stack.back());
stack.pop_back();
if(modulus == 1) {
stack.push_back("0");
return std::nullopt;
} else if(modulus == 0) {
return "Modulus cannot be zero";
}
if(exponent < 0) {
return "Exponent cannot be negative";
}
auto c = 1;
for(auto i = 0; i < exponent; i++) {
c = (c * base) % modulus;
}
stack.push_back(std::to_string(c));
} else {
return "'|' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_exp(stack_t &stack) {
// Check if stack has enough elements
if(stack.size() < 2) {
return "'^' requires two operands";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto y = stack.at(len-1);
auto is_x_num = is_num<double>(x);
auto is_y_num = is_num<double>(y);
// Check whether both entries are numbers
if(is_x_num && is_y_num) {
auto exp = std::stod(stack.back());
stack.pop_back();
auto base = std::stod(stack.back());
stack.pop_back();
// Push back the result as a string
stack.push_back(std::to_string(pow(base, exp)));
} else {
return "'^' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_sqrt(stack_t &stack) {
// Check if stack has enough elements
if(stack.empty()) {
return "'v' requires one operand";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto is_x_num = is_num<double>(x);
// Check whether the entry is a number
if(is_x_num) {
auto x = std::stod(stack.back());
stack.pop_back();
if(x <= (double)0) {
return "'v' domain error";
}
// Push back the result as a string
stack.push_back(std::to_string(sqrt(x)));
} else {
return "'v' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_sin(stack_t &stack) {
// Check if stack has enough elements
if(stack.empty()) {
return "'sin' requires one operand";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto is_x_num = is_num<double>(x);
// Check whether the entry is a number
if(is_x_num) {
auto x = std::stod(stack.back());
stack.pop_back();
// Push back the result as a string
stack.push_back(std::to_string(sin(x)));
} else {
return "'sin' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_cos(stack_t &stack) {
// Check if stack has enough elements
if(stack.empty()) {
return "'cos' requires one operand";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto is_x_num = is_num<double>(x);
// Check whether the entry is a number
if(is_x_num) {
auto x = std::stod(stack.back());
stack.pop_back();
// Push back the result as a string
stack.push_back(std::to_string(cos(x)));
} else {
return "'cos' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_tan(stack_t &stack) {
// Check if stack has enough elements
if(stack.empty()) {
return "'tan' requires one operand";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto is_x_num = is_num<double>(x);
// Check whether the entry is a number
if(is_x_num) {
auto x = std::stod(stack.back());
stack.pop_back();
// Push back the result as a string
stack.push_back(std::to_string(tan(x)));
} else {
return "'tan' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_fact(stack_t &stack) {
// Check if stack has enough elements
if(stack.empty()) {
return "'!' requires one operand";
}
// Extract two entries from the stack
auto len = stack.size()-1;
auto x = stack.at(len);
auto is_x_num = is_num<double>(x);
// Check whether the entry is a number
if(is_x_num) {
unsigned long factorial = 1;
auto x = std::stod(stack.back());
stack.pop_back();
if(x == (double)0) {
factorial = 1;
}
for(size_t i = 2; i <= (size_t)x; i++) {
factorial *= i;
}
// Push back the result as a string
stack.push_back(std::to_string(factorial));
} else {
return "'!' requires numeric values";
}
return std::nullopt;
}
std::optional<std::string> Math::fn_pi(stack_t &stack) {
stack.push_back(std::to_string(std::numbers::pi));
return std::nullopt;
}
std::optional<std::string> Math::fn_e(stack_t &stack) {
stack.push_back(std::to_string(std::numbers::e));
return std::nullopt;
}

28
src/math.h Normal file
View File

@ -0,0 +1,28 @@
#pragma once
#include "operation.h"
class Math : public IOperation {
public:
Math(OPType op_type) : op_type(op_type) {}
std::optional<std::string> exec(stack_t &stack) override;
private:
std::optional<std::string> fn_add(stack_t &stack);
std::optional<std::string> fn_sub(stack_t &stack);
std::optional<std::string> fn_mul(stack_t &stack);
std::optional<std::string> fn_div(stack_t &stack);
std::optional<std::string> fn_mod(stack_t &stack);
std::optional<std::string> fn_div_mod(stack_t &stack);
std::optional<std::string> fn_mod_exp(stack_t &stack);
std::optional<std::string> fn_exp(stack_t &stack);
std::optional<std::string> fn_sqrt(stack_t &stack);
std::optional<std::string> fn_sin(stack_t &stack);
std::optional<std::string> fn_cos(stack_t &stack);
std::optional<std::string> fn_tan(stack_t &stack);
std::optional<std::string> fn_fact(stack_t &stack);
std::optional<std::string> fn_pi(stack_t &stack);
std::optional<std::string> fn_e(stack_t &stack);
OPType op_type;
};

20
src/operation.h Normal file
View File

@ -0,0 +1,20 @@
#pragma once
#include <optional>
#include "types.h"
class IOperation {
public:
virtual std::optional<std::string> exec(stack_t &stack) = 0;
virtual ~IOperation() = default;
};
enum class OPType {
// Numerical operations
ADD, SUB, MUL, DIV, MOD, DIV_MOD, MOD_EXP, EXP,
SQRT, SIN, COS, TAN, FACT, PI, E,
// Stack operations
PCG, P, CLR, PH, SO, DP, PS, CH, CS,
// Macro operations
EX, CMP, RI
};

123
src/stack.cpp Normal file
View File

@ -0,0 +1,123 @@
#include <iostream>
#include <algorithm>
#include "stack.h"
#include "is_num.h"
std::optional<std::string> Stack::exec(stack_t &stack) {
std::optional<std::string> err = std::nullopt;
switch(this->op_type) {
case OPType::PCG: err = fn_print(stack, true); break;
case OPType::P: err = fn_print(stack, false); break;
case OPType::CLR: stack.clear(); break;
case OPType::PH: fn_pop_head(stack); break;
case OPType::SO: fn_swap_xy(stack); break;
case OPType::DP: fn_dup_head(stack); break;
case OPType::PS: fn_print_stack(stack); break;
case OPType::CH: fn_head_size(stack); break;
case OPType::CS: fn_stack_size(stack); break;
default: break;
}
return err;
}
std::optional<std::string> Stack::fn_print(stack_t &stack, bool new_line) {
// Check if the stack is empty
if(stack.empty()) {
return "Cannot print empty stack";
}
if(new_line) {
std::cout << stack.back() << std::endl;
} else {
std::cout << stack.back();
}
return std::nullopt;
}
std::optional<std::string> Stack::fn_pop_head(stack_t &stack) {
// Check if stack is empty
if(stack.empty()) {
return "'R' does not work on empty stack";
}
stack.pop_back();
return std::nullopt;
}
std::optional<std::string> Stack::fn_swap_xy(stack_t &stack) {
// Check if the stack has enough elements
if(stack.size() < 2) {
return "'r' requires two elements";
}
// Swap top two elements
auto len = stack.size()-1;
auto x = stack.at(len);
stack.at(len) = stack.at(len-1);
stack.at(len-1) = x;
return std::nullopt;
}
std::optional<std::string> Stack::fn_dup_head(stack_t &stack) {
// Check if the stack has enough elements
if(stack.empty()) {
return "'d' requires one element";
}
auto head = stack.back();
stack.push_back(head);
return std::nullopt;
}
std::optional<std::string> Stack::fn_print_stack(stack_t &stack) {
for(auto it = stack.rbegin(); it != stack.rend(); it++) {
std::cout << *it << std::endl;
}
return std::nullopt;
}
std::optional<std::string> Stack::fn_head_size(stack_t &stack) {
// Check if the stack has enough elements
if(stack.empty()) {
return "'Z' does not work on empty stack";
}
// Take head of the stack
auto head = stack.back();
// If it's an integer, count its digits
if(is_num<int>(head)) {
auto num = std::stoi(head);
stack.pop_back();
size_t len = 0;
while(num > 0) {
num /= 10;
len++;
}
stack.push_back(std::to_string(len));
} else {
// Otherwise, treat the value as a string and count its length
stack.pop_back();
head.erase(std::remove(head.begin(), head.end(), '.'), head.end());
stack.push_back(std::to_string(head.length()));
}
return std::nullopt;
}
std::optional<std::string> Stack::fn_stack_size(stack_t &stack) {
stack.push_back(std::to_string(stack.size()));
return std::nullopt;
}

20
src/stack.h Normal file
View File

@ -0,0 +1,20 @@
#pragma once
#include "operation.h"
class Stack : public IOperation {
public:
Stack(OPType op_type) : op_type(op_type) {}
std::optional<std::string> exec(stack_t &stack) override;
private:
std::optional<std::string> fn_print(stack_t &stack, bool new_line);
std::optional<std::string> fn_pop_head(stack_t &stack);
std::optional<std::string> fn_swap_xy(stack_t &stack);
std::optional<std::string> fn_dup_head(stack_t &stack);
std::optional<std::string> fn_print_stack(stack_t &stack);
std::optional<std::string> fn_head_size(stack_t &stack);
std::optional<std::string> fn_stack_size(stack_t &stack);
OPType op_type;
};

10
src/types.h Normal file
View File

@ -0,0 +1,10 @@
#pragma once
#include <vector>
#include <string>
#include <unordered_map>
using stack_t = std::vector<std::string>;
typedef struct {
stack_t stack;
std::unordered_map<int, std::string> array;
} Register;