Initial commit
This commit is contained in:
@@ -0,0 +1,2 @@
|
||||
dist-newstyle
|
||||
p.vim
|
||||
@@ -0,0 +1,4 @@
|
||||
[submodule "libs/mruby"]
|
||||
path = libs/mruby
|
||||
url = https://github.com/mruby/mruby.git
|
||||
ignore = dirty
|
||||
@@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
@@ -0,0 +1,7 @@
|
||||
module Main (main) where
|
||||
|
||||
import WM.Core
|
||||
|
||||
main :: IO ()
|
||||
main = do
|
||||
run
|
||||
@@ -0,0 +1,59 @@
|
||||
module WM.Core where
|
||||
|
||||
import Control.Concurrent (threadDelay)
|
||||
import Foreign (Ptr)
|
||||
import System.Environment (getArgs)
|
||||
import WM.Mruby
|
||||
import WM.XKutu
|
||||
|
||||
data State = State
|
||||
{ mruby_pointer :: Ptr MrbState,
|
||||
running :: Bool
|
||||
}
|
||||
deriving (Show)
|
||||
|
||||
run :: IO ()
|
||||
run = do
|
||||
is_started <- deploy
|
||||
print is_started
|
||||
add_keybind 24 0
|
||||
w_id <- draw_rectangle 10 100 10 10 0x500070
|
||||
geom <- get_geometry w_id
|
||||
print geom
|
||||
screen_info <- get_screen
|
||||
print screen_info
|
||||
pointer_info <- get_pointer
|
||||
print pointer_info
|
||||
mrb <- mrb_open
|
||||
runRuby mrb runtimeRb
|
||||
handle_args mrb
|
||||
loop $ State mrb True
|
||||
mrb_close mrb
|
||||
|
||||
handle_args :: Ptr MrbState -> IO ()
|
||||
handle_args mrb = do
|
||||
args <- getArgs
|
||||
case args of
|
||||
[] -> pure ()
|
||||
["--script", file] -> do
|
||||
script <- readFile file
|
||||
runRuby mrb script
|
||||
_ -> putStrLn "unknown arguments"
|
||||
|
||||
handle_event :: Maybe Event -> State -> IO State
|
||||
handle_event Nothing state = pure state
|
||||
handle_event (Just ev) state
|
||||
| event_btn ev == 24 = pure state {running = False}
|
||||
| otherwise = do
|
||||
print ev
|
||||
pure state
|
||||
|
||||
loop :: State -> IO ()
|
||||
loop state
|
||||
| not (running state) = pure ()
|
||||
| otherwise = do
|
||||
flush
|
||||
threadDelay 10000
|
||||
ev <- next_event
|
||||
handle_event ev state
|
||||
>>= loop
|
||||
@@ -0,0 +1,32 @@
|
||||
{-# LANGUAGE CApiFFI #-}
|
||||
{-# LANGUAGE ForeignFunctionInterface #-}
|
||||
{-# LANGUAGE TemplateHaskell #-}
|
||||
|
||||
module WM.Mruby where
|
||||
|
||||
import Data.FileEmbed (embedFile)
|
||||
import Data.Text qualified as T
|
||||
import Data.Text.Encoding qualified as TE
|
||||
import Data.Text.Encoding.Error qualified as TEE
|
||||
import Foreign.C (CString, withCString)
|
||||
import Foreign.Ptr
|
||||
|
||||
runtimeRb :: String
|
||||
runtimeRb =
|
||||
T.unpack (TE.decodeUtf8With TEE.lenientDecode $(embedFile "./app/ruby/lib.rb"))
|
||||
|
||||
data MrbState
|
||||
|
||||
foreign import capi "mruby.h mrb_open"
|
||||
mrb_open :: IO (Ptr MrbState)
|
||||
|
||||
foreign import capi "mruby.h mrb_close"
|
||||
mrb_close :: Ptr MrbState -> IO ()
|
||||
|
||||
foreign import capi "mruby/compile.h mrb_load_string"
|
||||
c_mrb_load_string :: Ptr MrbState -> CString -> IO ()
|
||||
|
||||
runRuby :: Ptr MrbState -> String -> IO ()
|
||||
runRuby mrb code =
|
||||
withCString code $ \cstr ->
|
||||
c_mrb_load_string mrb cstr
|
||||
+219
@@ -0,0 +1,219 @@
|
||||
{-# LANGUAGE CApiFFI #-}
|
||||
{-# LANGUAGE ForeignFunctionInterface #-}
|
||||
|
||||
module WM.XKutu where
|
||||
|
||||
import Data.Int (Int16, Int32, Int8)
|
||||
import Data.Word (Word16, Word32)
|
||||
import Foreign (Ptr, Storable, alignment, alloca, peek, peekByteOff, poke, pokeByteOff, sizeOf)
|
||||
import Foreign.C.Types (CInt (CInt))
|
||||
|
||||
newtype XcbWindow = XcbWindow Word32
|
||||
deriving (Show, Storable)
|
||||
|
||||
data Geometry = Geometry
|
||||
{ geom_x :: Int16,
|
||||
geom_y :: Int16,
|
||||
geom_w :: Word16,
|
||||
geom_h :: Word16
|
||||
}
|
||||
deriving (Show)
|
||||
|
||||
instance Storable Geometry where
|
||||
sizeOf _ = 8
|
||||
alignment _ = alignment (undefined :: Word32)
|
||||
|
||||
peek ptr = do
|
||||
x <- peekByteOff ptr 0
|
||||
y <- peekByteOff ptr 2
|
||||
w <- peekByteOff ptr 4
|
||||
h <- peekByteOff ptr 6
|
||||
pure $ Geometry x y w h
|
||||
|
||||
poke ptr (Geometry x y w h) = do
|
||||
pokeByteOff ptr 0 x
|
||||
pokeByteOff ptr 2 y
|
||||
pokeByteOff ptr 4 w
|
||||
pokeByteOff ptr 6 h
|
||||
|
||||
data PointerInfo = PointerInfo
|
||||
{ pointer_info_x :: Int16,
|
||||
pointer_info_y :: Int16,
|
||||
pointer_info_w :: XcbWindow
|
||||
}
|
||||
deriving (Show)
|
||||
|
||||
instance Storable PointerInfo where
|
||||
sizeOf _ = 8
|
||||
alignment _ = alignment (undefined :: Word32)
|
||||
|
||||
peek ptr = do
|
||||
x <- peekByteOff ptr 0
|
||||
y <- peekByteOff ptr 2
|
||||
w <- peekByteOff ptr 4
|
||||
pure $ PointerInfo x y w
|
||||
|
||||
poke ptr (PointerInfo x y w) = do
|
||||
pokeByteOff ptr 0 x
|
||||
pokeByteOff ptr 2 y
|
||||
pokeByteOff ptr 4 w
|
||||
|
||||
data Event = Event
|
||||
{ event_type :: Int32,
|
||||
event_window :: XcbWindow,
|
||||
event_override_redirect :: Int8,
|
||||
event_btn :: Word32,
|
||||
event_x :: Int32,
|
||||
event_y :: Int32,
|
||||
event_height :: Word32,
|
||||
event_width :: Word32,
|
||||
event_state :: Word32,
|
||||
event_is_root :: Int8
|
||||
}
|
||||
deriving (Show)
|
||||
|
||||
instance Storable Event where
|
||||
sizeOf _ = 40
|
||||
alignment _ = alignment (undefined :: Word32)
|
||||
|
||||
peek ptr = do
|
||||
eventType <- peekByteOff ptr 0
|
||||
window <- peekByteOff ptr 4
|
||||
overrideRedirect <- peekByteOff ptr 8
|
||||
btn <- peekByteOff ptr 12
|
||||
x <- peekByteOff ptr 16
|
||||
y <- peekByteOff ptr 20
|
||||
height <- peekByteOff ptr 24
|
||||
width <- peekByteOff ptr 28
|
||||
state <- peekByteOff ptr 32
|
||||
isRoot <- peekByteOff ptr 36
|
||||
|
||||
pure $
|
||||
Event
|
||||
eventType
|
||||
(XcbWindow window)
|
||||
overrideRedirect
|
||||
btn
|
||||
x
|
||||
y
|
||||
height
|
||||
width
|
||||
state
|
||||
isRoot
|
||||
|
||||
poke ptr (Event eventType (XcbWindow window) overrideRedirect btn x y height width state isRoot) = do
|
||||
pokeByteOff ptr 0 eventType
|
||||
pokeByteOff ptr 4 window
|
||||
pokeByteOff ptr 8 overrideRedirect
|
||||
pokeByteOff ptr 12 btn
|
||||
pokeByteOff ptr 16 x
|
||||
pokeByteOff ptr 20 y
|
||||
pokeByteOff ptr 24 height
|
||||
pokeByteOff ptr 28 width
|
||||
pokeByteOff ptr 32 state
|
||||
pokeByteOff ptr 36 isRoot
|
||||
|
||||
foreign import capi "x_kutu.h value MOD"
|
||||
mOD_MASK :: CInt
|
||||
|
||||
foreign import capi "x_kutu.h value XCB_MOD_MASK_LOCK"
|
||||
cLK_MASK :: CInt
|
||||
|
||||
foreign import capi "x_kutu.h value XCB_MOD_MASK_2"
|
||||
nUM_MASK :: CInt
|
||||
|
||||
foreign import capi "x_kutu.h deploy"
|
||||
c_deploy :: IO CInt
|
||||
|
||||
deploy :: IO Bool
|
||||
deploy = (== 0) <$> c_deploy
|
||||
|
||||
foreign import capi "x_kutu.h flush"
|
||||
flush :: IO ()
|
||||
|
||||
foreign import capi "x_kutu.h cleanup"
|
||||
cleanup :: IO ()
|
||||
|
||||
foreign import capi "x_kutu.h add_keybind"
|
||||
add_keybind :: CInt -> CInt -> IO ()
|
||||
|
||||
foreign import capi "x_kutu.h add_mousebind"
|
||||
add_mousebind :: CInt -> CInt -> IO ()
|
||||
|
||||
foreign import capi "x_kutu.h get_focus"
|
||||
c_get_focus :: IO Word32
|
||||
|
||||
get_focus :: IO XcbWindow
|
||||
get_focus = XcbWindow <$> c_get_focus
|
||||
|
||||
foreign import capi "x_kutu.h get_root"
|
||||
c_get_root :: IO Word32
|
||||
|
||||
get_root :: IO XcbWindow
|
||||
get_root = XcbWindow <$> c_get_root
|
||||
|
||||
foreign import capi "x_kutu.h focus"
|
||||
focus :: XcbWindow -> IO ()
|
||||
|
||||
foreign import capi "x_kutu.h subscribe"
|
||||
subscribe :: XcbWindow -> IO ()
|
||||
|
||||
foreign import capi "x_kutu.h kill"
|
||||
kill :: XcbWindow -> IO ()
|
||||
|
||||
foreign import capi "x_kutu.h destroy"
|
||||
destroy :: XcbWindow -> IO ()
|
||||
|
||||
foreign import capi "x_kutu.h show"
|
||||
show :: XcbWindow -> IO ()
|
||||
|
||||
foreign import capi "x_kutu.h hide"
|
||||
hide :: XcbWindow -> IO ()
|
||||
|
||||
foreign import capi "x_kutu.h send_to_top"
|
||||
send_to_top :: XcbWindow -> IO ()
|
||||
|
||||
foreign import capi "x_kutu.h draw_rectangle"
|
||||
c_draw_rectangle :: CInt -> CInt -> CInt -> CInt -> Word32 -> IO Word32
|
||||
|
||||
draw_rectangle :: CInt -> CInt -> CInt -> CInt -> Word32 -> IO XcbWindow
|
||||
draw_rectangle x y w h c =
|
||||
XcbWindow <$> c_draw_rectangle x y w h c
|
||||
|
||||
foreign import capi "x_kutu.h get_geometry"
|
||||
c_get_geometry :: XcbWindow -> Ptr Geometry -> IO ()
|
||||
|
||||
get_geometry :: XcbWindow -> IO Geometry
|
||||
get_geometry win =
|
||||
alloca $ \ptr -> do
|
||||
c_get_geometry win ptr
|
||||
peek ptr
|
||||
|
||||
foreign import capi "x_kutu.h get_screen"
|
||||
c_get_screen :: Ptr Geometry -> IO ()
|
||||
|
||||
get_screen :: IO Geometry
|
||||
get_screen =
|
||||
alloca $ \ptr -> do
|
||||
c_get_screen ptr
|
||||
peek ptr
|
||||
|
||||
foreign import capi "x_kutu.h get_pointer"
|
||||
c_get_pointer :: Ptr PointerInfo -> IO ()
|
||||
|
||||
get_pointer :: IO PointerInfo
|
||||
get_pointer =
|
||||
alloca $ \ptr -> do
|
||||
c_get_pointer ptr
|
||||
peek ptr
|
||||
|
||||
foreign import capi "x_kutu.h next_event"
|
||||
c_next_event :: Ptr Event -> IO CInt
|
||||
|
||||
next_event :: IO (Maybe Event)
|
||||
next_event =
|
||||
alloca $ \ptr -> do
|
||||
ok <- c_next_event ptr
|
||||
if ok == 0
|
||||
then pure Nothing
|
||||
else Just <$> peek ptr
|
||||
+401
@@ -0,0 +1,401 @@
|
||||
// Self-header
|
||||
#include "x_kutu.h"
|
||||
|
||||
// Global variables
|
||||
// Connection to X server
|
||||
xcb_connection_t *conn;
|
||||
// Screen of the X server
|
||||
xcb_screen_t *scr;
|
||||
// Currently focused window
|
||||
xcb_window_t focuswin;
|
||||
|
||||
// Flush
|
||||
void flush(void) { xcb_flush(conn); }
|
||||
|
||||
// Cleanup function to close the X connection on exit
|
||||
void cleanup(void) {
|
||||
if (conn != NULL)
|
||||
xcb_disconnect(conn);
|
||||
}
|
||||
|
||||
// Keybind function to setup a key grab if the keycode is clicked along with the
|
||||
// MOD key
|
||||
void add_keybind(int key, int mod) {
|
||||
xcb_grab_key(conn, 0, scr->root, mod, key, XCB_GRAB_MODE_ASYNC,
|
||||
XCB_GRAB_MODE_ASYNC);
|
||||
}
|
||||
|
||||
// Mousebind function to setup a mouse button grab if the button is clicked
|
||||
// along with the MOD key
|
||||
void add_mousebind(int button, int mod) {
|
||||
xcb_grab_button(conn, 0, scr->root,
|
||||
XCB_EVENT_MASK_BUTTON_PRESS | XCB_EVENT_MASK_BUTTON_RELEASE,
|
||||
XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC, scr->root, XCB_NONE,
|
||||
button, mod);
|
||||
}
|
||||
|
||||
// Deploy function to initialize the X connection, set up event masks, and
|
||||
// prepare the window manager
|
||||
int deploy(void) {
|
||||
int mask;
|
||||
|
||||
// Start X connection and return -1 if it fails
|
||||
if (xcb_connection_has_error(conn = xcb_connect(NULL, NULL)))
|
||||
return -1;
|
||||
|
||||
// Define screen and focus window
|
||||
scr = xcb_setup_roots_iterator(xcb_get_setup(conn)).data;
|
||||
focuswin = scr->root;
|
||||
|
||||
// Setuup event masks
|
||||
mask = XCB_CW_EVENT_MASK;
|
||||
|
||||
uint32_t values[] = {XCB_EVENT_MASK_SUBSTRUCTURE_REDIRECT |
|
||||
XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY |
|
||||
XCB_EVENT_MASK_STRUCTURE_NOTIFY |
|
||||
XCB_EVENT_MASK_PROPERTY_CHANGE};
|
||||
|
||||
xcb_change_window_attributes_checked(conn, scr->root, mask, values);
|
||||
|
||||
xcb_flush(conn);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
// Set input focus to a window
|
||||
void focus(xcb_window_t win) {
|
||||
xcb_set_input_focus(conn, XCB_INPUT_FOCUS_POINTER_ROOT, win,
|
||||
XCB_CURRENT_TIME);
|
||||
focuswin = win;
|
||||
}
|
||||
|
||||
// Get the currently focused window
|
||||
xcb_window_t get_focus(void) { return focuswin; }
|
||||
|
||||
// Subscribe to events on a window
|
||||
void subscribe(xcb_window_t win) {
|
||||
uint32_t values[2];
|
||||
values[0] = XCB_EVENT_MASK_ENTER_WINDOW;
|
||||
values[1] = XCB_EVENT_MASK_SUBSTRUCTURE_NOTIFY;
|
||||
xcb_change_window_attributes(conn, win, XCB_CW_EVENT_MASK, values);
|
||||
}
|
||||
|
||||
// Kill a window
|
||||
void kill(xcb_window_t window) {
|
||||
xcb_intern_atom_cookie_t wm_protocols_cookie =
|
||||
xcb_intern_atom(conn, 1, 12, "WM_PROTOCOLS");
|
||||
xcb_intern_atom_cookie_t wm_delete_window_cookie =
|
||||
xcb_intern_atom(conn, 0, 16, "WM_DELETE_WINDOW");
|
||||
|
||||
xcb_intern_atom_reply_t *wm_protocols =
|
||||
xcb_intern_atom_reply(conn, wm_protocols_cookie, NULL);
|
||||
xcb_intern_atom_reply_t *wm_delete_window =
|
||||
xcb_intern_atom_reply(conn, wm_delete_window_cookie, NULL);
|
||||
|
||||
if (!wm_protocols || !wm_delete_window) {
|
||||
// fallback to force kill
|
||||
xcb_kill_client(conn, window);
|
||||
xcb_flush(conn);
|
||||
return;
|
||||
}
|
||||
|
||||
xcb_client_message_event_t ev = {0};
|
||||
ev.response_type = XCB_CLIENT_MESSAGE;
|
||||
ev.window = window;
|
||||
ev.type = wm_protocols->atom;
|
||||
ev.format = 32;
|
||||
ev.data.data32[0] = wm_delete_window->atom;
|
||||
ev.data.data32[1] = XCB_CURRENT_TIME;
|
||||
|
||||
xcb_send_event(conn, 0, window, XCB_EVENT_MASK_NO_EVENT, (char *)&ev);
|
||||
xcb_flush(conn);
|
||||
|
||||
free(wm_protocols);
|
||||
free(wm_delete_window);
|
||||
}
|
||||
|
||||
// Destroy a window
|
||||
void destroy(xcb_window_t win) { xcb_destroy_window(conn, win); }
|
||||
|
||||
// Show a window
|
||||
void show(xcb_window_t window) { xcb_map_window(conn, window); }
|
||||
|
||||
// Hide a window
|
||||
void hide(xcb_window_t window) { xcb_unmap_window(conn, window); }
|
||||
|
||||
// Bring a window to the top of the stack
|
||||
void send_to_top(xcb_window_t win) {
|
||||
uint32_t values[1] = {XCB_STACK_MODE_ABOVE};
|
||||
xcb_configure_window(conn, win, XCB_CONFIG_WINDOW_STACK_MODE, values);
|
||||
}
|
||||
|
||||
// Get the geometry of a window
|
||||
void get_geometry(xcb_window_t win, Geometry *out) {
|
||||
xcb_get_geometry_reply_t *geom =
|
||||
xcb_get_geometry_reply(conn, xcb_get_geometry(conn, win), NULL);
|
||||
|
||||
if (geom == NULL)
|
||||
return;
|
||||
|
||||
*out = (Geometry){
|
||||
.x = geom->x, .y = geom->y, .width = geom->width, .height = geom->height};
|
||||
|
||||
free(geom);
|
||||
}
|
||||
|
||||
// Get the current pointer position
|
||||
void get_pointer(PointerInfo *out) {
|
||||
xcb_query_pointer_reply_t *geom;
|
||||
geom = xcb_query_pointer_reply(conn, xcb_query_pointer(conn, scr->root), 0);
|
||||
*out = (PointerInfo){geom->root_x, geom->root_y, geom->child};
|
||||
free(geom);
|
||||
}
|
||||
|
||||
// Get the screen geometry
|
||||
void get_screen(Geometry *out) {
|
||||
*out = (Geometry){0, 0, scr->width_in_pixels, scr->height_in_pixels};
|
||||
}
|
||||
|
||||
// Warp the pointer to a specific position in a window
|
||||
// Can be used with get_geometry to warp to a specific position in a window (eg.
|
||||
// the center)
|
||||
void warp_pointer(xcb_window_t win, int x, int y) {
|
||||
xcb_warp_pointer(conn, XCB_NONE, win, 0, 0, 0, 0, x, y);
|
||||
}
|
||||
|
||||
// Move a window to a specific position
|
||||
void move_window(xcb_window_t win, int x, int y) {
|
||||
uint32_t values[2] = {x, y};
|
||||
xcb_configure_window(conn, win, XCB_CONFIG_WINDOW_X | XCB_CONFIG_WINDOW_Y,
|
||||
values);
|
||||
}
|
||||
|
||||
// Resize a window to specific dimensions
|
||||
void resize_window(xcb_window_t win, int width, int height) {
|
||||
uint32_t values[2] = {width, height};
|
||||
xcb_configure_window(
|
||||
conn, win, XCB_CONFIG_WINDOW_WIDTH | XCB_CONFIG_WINDOW_HEIGHT, values);
|
||||
}
|
||||
|
||||
xcb_size_hints_t get_wm_n_hints(xcb_window_t win) {
|
||||
xcb_size_hints_t hints;
|
||||
xcb_get_property_cookie_t cookie = xcb_icccm_get_wm_normal_hints(conn, win);
|
||||
xcb_icccm_get_wm_normal_hints_reply(conn, cookie, &hints, NULL);
|
||||
return hints;
|
||||
}
|
||||
|
||||
xcb_icccm_wm_hints_t get_wm_hints(xcb_window_t win) {
|
||||
xcb_get_property_cookie_t cookie = xcb_icccm_get_wm_hints(conn, win);
|
||||
xcb_icccm_wm_hints_t hints;
|
||||
xcb_icccm_get_wm_hints_reply(conn, cookie, &hints, NULL);
|
||||
return hints;
|
||||
}
|
||||
|
||||
char *get_wm_name(xcb_window_t win) {
|
||||
xcb_get_property_cookie_t cookie = xcb_icccm_get_wm_name(conn, win);
|
||||
xcb_icccm_get_text_property_reply_t reply;
|
||||
xcb_icccm_get_wm_name_reply(conn, cookie, &reply, NULL);
|
||||
return reply.name;
|
||||
}
|
||||
|
||||
uint8_t get_wm_transient_for(xcb_window_t win) {
|
||||
xcb_get_property_cookie_t cookie = xcb_icccm_get_wm_transient_for(conn, win);
|
||||
return xcb_icccm_get_wm_transient_for_reply(conn, cookie, &win, NULL);
|
||||
}
|
||||
|
||||
void set_wm_state(xcb_window_t win, int state) {
|
||||
xcb_intern_atom_cookie_t cookie =
|
||||
xcb_intern_atom(conn, 0, strlen("WM_STATE"), "WM_STATE");
|
||||
xcb_intern_atom_reply_t *reply = xcb_intern_atom_reply(conn, cookie, NULL);
|
||||
if (!reply)
|
||||
return;
|
||||
|
||||
xcb_atom_t WM_STATE = reply->atom;
|
||||
free(reply);
|
||||
|
||||
uint32_t data[2];
|
||||
data[0] = state;
|
||||
data[1] = XCB_WINDOW_NONE;
|
||||
|
||||
xcb_change_property(conn, XCB_PROP_MODE_REPLACE, win, WM_STATE, WM_STATE, 32,
|
||||
2, data);
|
||||
}
|
||||
|
||||
xcb_window_t draw_rectangle(int x, int y, int width, int height,
|
||||
uint32_t color) {
|
||||
// Get the screen
|
||||
const xcb_setup_t *setup = xcb_get_setup(conn);
|
||||
xcb_screen_iterator_t iter = xcb_setup_roots_iterator(setup);
|
||||
xcb_screen_t *screen = iter.data;
|
||||
|
||||
// Create an override-redirect window
|
||||
xcb_window_t win = xcb_generate_id(conn);
|
||||
uint32_t mask =
|
||||
XCB_CW_BACK_PIXEL | XCB_CW_OVERRIDE_REDIRECT | XCB_CW_EVENT_MASK;
|
||||
uint32_t values[3];
|
||||
values[0] = screen->black_pixel; // initial background pixel
|
||||
values[1] = 1; // override_redirect = true
|
||||
values[2] = XCB_EVENT_MASK_EXPOSURE; // we want exposure events
|
||||
|
||||
xcb_create_window(conn,
|
||||
XCB_COPY_FROM_PARENT, // depth
|
||||
win, // window ID
|
||||
screen->root, // parent
|
||||
x, y, // x, y
|
||||
width, height, // width, height
|
||||
0, // border width
|
||||
XCB_WINDOW_CLASS_INPUT_OUTPUT, screen->root_visual, mask,
|
||||
values);
|
||||
|
||||
// Map the window (make it visible)
|
||||
xcb_map_window(conn, win);
|
||||
|
||||
// Fill it with the solid color using a Graphics Context
|
||||
xcb_gcontext_t gc = xcb_generate_id(conn);
|
||||
uint32_t gc_values[] = {color, XCB_LINE_STYLE_SOLID};
|
||||
xcb_create_gc(conn, gc, win, XCB_GC_FOREGROUND | XCB_GC_LINE_STYLE,
|
||||
gc_values);
|
||||
|
||||
xcb_rectangle_t rect = {0, 0, width, height}; // relative to window
|
||||
xcb_poly_fill_rectangle(conn, win, gc, 1, &rect);
|
||||
|
||||
return win;
|
||||
}
|
||||
|
||||
xcb_window_t get_root(void) { return scr->root; }
|
||||
|
||||
void grab_pointer(xcb_window_t win) {
|
||||
xcb_grab_pointer(conn, 0, win,
|
||||
XCB_EVENT_MASK_BUTTON_RELEASE |
|
||||
XCB_EVENT_MASK_BUTTON_MOTION |
|
||||
XCB_EVENT_MASK_POINTER_MOTION_HINT,
|
||||
XCB_GRAB_MODE_ASYNC, XCB_GRAB_MODE_ASYNC, XCB_NONE, XCB_NONE,
|
||||
XCB_CURRENT_TIME);
|
||||
}
|
||||
|
||||
void ungrab_pointer(void) { xcb_ungrab_pointer(conn, XCB_CURRENT_TIME); }
|
||||
|
||||
// Wait for an event and return it as an Event structure
|
||||
// This function is blocking
|
||||
int next_event(Event *out) {
|
||||
xcb_generic_event_t *ev = xcb_poll_for_event(conn);
|
||||
Event ret = {0};
|
||||
|
||||
if (!ev)
|
||||
return 0;
|
||||
|
||||
switch (CLEANMASK(ev->response_type)) {
|
||||
|
||||
case XCB_CREATE_NOTIFY: {
|
||||
xcb_create_notify_event_t *e;
|
||||
e = (xcb_create_notify_event_t *)ev;
|
||||
ret.type = 1;
|
||||
ret.window = e->window;
|
||||
ret.override_redirect = e->override_redirect;
|
||||
} break;
|
||||
|
||||
case XCB_DESTROY_NOTIFY: {
|
||||
xcb_destroy_notify_event_t *e;
|
||||
e = (xcb_destroy_notify_event_t *)ev;
|
||||
ret.type = 2;
|
||||
ret.window = e->window;
|
||||
} break;
|
||||
|
||||
case XCB_ENTER_NOTIFY: {
|
||||
xcb_enter_notify_event_t *e;
|
||||
e = (xcb_enter_notify_event_t *)ev;
|
||||
ret.type = 3;
|
||||
ret.window = e->event;
|
||||
} break;
|
||||
|
||||
case XCB_MAP_NOTIFY: {
|
||||
xcb_map_notify_event_t *e;
|
||||
e = (xcb_map_notify_event_t *)ev;
|
||||
ret.type = 4;
|
||||
ret.window = e->window;
|
||||
ret.override_redirect = e->override_redirect;
|
||||
} break;
|
||||
|
||||
case XCB_MAP_REQUEST: {
|
||||
xcb_map_request_event_t *e;
|
||||
e = (xcb_map_request_event_t *)ev;
|
||||
ret.type = 5;
|
||||
ret.window = e->window;
|
||||
} break;
|
||||
|
||||
case XCB_BUTTON_PRESS: {
|
||||
xcb_button_press_event_t *e = (xcb_button_press_event_t *)ev;
|
||||
ret.type = 6;
|
||||
ret.window = e->child;
|
||||
ret.is_root = e->child == scr->root;
|
||||
ret.x = e->event_x;
|
||||
ret.y = e->event_y;
|
||||
ret.btn = e->detail;
|
||||
ret.state = e->state;
|
||||
} break;
|
||||
|
||||
case XCB_MOTION_NOTIFY: {
|
||||
xcb_motion_notify_event_t *e = (xcb_motion_notify_event_t *)ev;
|
||||
ret.type = 7;
|
||||
ret.x = e->event_x;
|
||||
ret.y = e->event_y;
|
||||
ret.state = e->state;
|
||||
} break;
|
||||
|
||||
case XCB_BUTTON_RELEASE: {
|
||||
xcb_button_release_event_t *e = (xcb_button_release_event_t *)ev;
|
||||
ret.type = 8;
|
||||
ret.x = e->event_x;
|
||||
ret.y = e->event_y;
|
||||
ret.btn = e->detail;
|
||||
} break;
|
||||
|
||||
case XCB_KEY_PRESS: {
|
||||
xcb_key_press_event_t *e;
|
||||
e = (xcb_key_press_event_t *)ev;
|
||||
ret.type = 9;
|
||||
ret.window = e->child;
|
||||
ret.btn = e->detail;
|
||||
ret.state = e->state;
|
||||
} break;
|
||||
|
||||
case XCB_KEY_RELEASE: {
|
||||
xcb_key_release_event_t *e;
|
||||
e = (xcb_key_release_event_t *)ev;
|
||||
ret.type = 10;
|
||||
ret.window = e->child;
|
||||
ret.btn = e->detail;
|
||||
ret.state = e->state;
|
||||
} break;
|
||||
|
||||
case XCB_UNMAP_NOTIFY: {
|
||||
xcb_unmap_notify_event_t *e;
|
||||
e = (xcb_unmap_notify_event_t *)ev;
|
||||
ret.type = 11;
|
||||
ret.window = e->window;
|
||||
} break;
|
||||
|
||||
case XCB_CONFIGURE_REQUEST: {
|
||||
xcb_configure_request_event_t *e = (xcb_configure_request_event_t *)ev;
|
||||
ret.type = 12;
|
||||
ret.window = e->window;
|
||||
ret.x = e->x;
|
||||
ret.y = e->y;
|
||||
ret.width = e->width;
|
||||
ret.height = e->height;
|
||||
} break;
|
||||
|
||||
case XCB_RESIZE_REQUEST: {
|
||||
xcb_resize_request_event_t *e = (xcb_resize_request_event_t *)ev;
|
||||
ret.type = 13;
|
||||
ret.window = e->window;
|
||||
ret.width = e->width;
|
||||
ret.height = e->height;
|
||||
} break;
|
||||
}
|
||||
|
||||
free(ev);
|
||||
*out = ret;
|
||||
|
||||
return 1;
|
||||
}
|
||||
+101
@@ -0,0 +1,101 @@
|
||||
#ifndef X_KUTU_H
|
||||
#define X_KUTU_H
|
||||
|
||||
// Standard headers
|
||||
#include <err.h>
|
||||
#include <stdint.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <unistd.h>
|
||||
|
||||
// XCB headers
|
||||
#include <xcb/xcb.h>
|
||||
#include <xcb/xcb_icccm.h>
|
||||
|
||||
// Macro to clean modifier masks
|
||||
#define CLEANMASK(m) ((m & ~0x80))
|
||||
|
||||
// Definitions for modifier keys
|
||||
#define SUPER XCB_MOD_MASK_4
|
||||
#define ALT XCB_MOD_MASK_1
|
||||
#define CTRL XCB_MOD_MASK_CONTROL
|
||||
#define SHIFT XCB_MOD_MASK_SHIFT
|
||||
|
||||
// Change this to change the modifier key you want to use
|
||||
#define MOD SUPER
|
||||
|
||||
// Forward declarations of global variables
|
||||
extern xcb_connection_t *conn;
|
||||
extern xcb_screen_t *scr;
|
||||
extern xcb_window_t focuswin;
|
||||
|
||||
// Geometry structure for rectangles and positions
|
||||
typedef struct Geometry {
|
||||
int16_t x;
|
||||
int16_t y;
|
||||
uint16_t width;
|
||||
uint16_t height;
|
||||
} Geometry;
|
||||
|
||||
typedef struct PointerInfo {
|
||||
int16_t x;
|
||||
int16_t y;
|
||||
uint32_t window;
|
||||
} PointerInfo;
|
||||
|
||||
// Event structure to represent various X events
|
||||
typedef struct Event {
|
||||
int32_t type;
|
||||
uint32_t window;
|
||||
int8_t override_redirect;
|
||||
uint32_t btn;
|
||||
int32_t x;
|
||||
int32_t y;
|
||||
uint32_t height;
|
||||
uint32_t width;
|
||||
uint32_t state;
|
||||
int8_t is_root;
|
||||
} Event;
|
||||
|
||||
// Function prototypes
|
||||
extern void flush(void);
|
||||
extern int deploy(void);
|
||||
extern void cleanup(void);
|
||||
|
||||
extern void add_keybind(int key, int mod);
|
||||
extern void add_mousebind(int button, int mod);
|
||||
|
||||
extern xcb_window_t get_focus(void);
|
||||
extern xcb_window_t get_root(void);
|
||||
|
||||
extern void focus(xcb_window_t win);
|
||||
extern void subscribe(xcb_window_t win);
|
||||
extern void kill(xcb_window_t window);
|
||||
extern void destroy(xcb_window_t win);
|
||||
extern void show(xcb_window_t window);
|
||||
extern void hide(xcb_window_t window);
|
||||
extern void send_to_top(xcb_window_t win);
|
||||
|
||||
extern void get_geometry(xcb_window_t win, Geometry *out);
|
||||
extern void get_screen(Geometry *out);
|
||||
extern void get_pointer(PointerInfo *out);
|
||||
|
||||
extern void warp_pointer(xcb_window_t win, int x, int y);
|
||||
extern void move_window(xcb_window_t win, int x, int y);
|
||||
extern void resize_window(xcb_window_t win, int width, int height);
|
||||
|
||||
extern xcb_size_hints_t get_wm_n_hints(xcb_window_t win);
|
||||
extern xcb_icccm_wm_hints_t get_wm_hints(xcb_window_t win);
|
||||
extern char *get_wm_name(xcb_window_t win);
|
||||
extern uint8_t get_wm_transient_for(xcb_window_t win);
|
||||
extern void set_wm_state(xcb_window_t win, int state);
|
||||
|
||||
extern xcb_window_t draw_rectangle(int x, int y, int width, int height,
|
||||
uint32_t color);
|
||||
|
||||
extern void grab_pointer(xcb_window_t win);
|
||||
extern void ungrab_pointer(void);
|
||||
|
||||
extern int next_event(Event *out);
|
||||
|
||||
#endif // X_KUTU_H
|
||||
@@ -0,0 +1 @@
|
||||
puts "hello from library"
|
||||
@@ -0,0 +1 @@
|
||||
puts "hello from ruby"
|
||||
Generated
+27
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"nodes": {
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1783776592,
|
||||
"narHash": "sha256-UgCQzxeWI75XM8G+hPrPh+MKzEPjG3SpAj7dtqSbksA=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "e7a3ca8092b61ff85b6a45bf863ea2b2d6a661b3",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "NixOS",
|
||||
"ref": "nixos-unstable",
|
||||
"repo": "nixpkgs",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"root": {
|
||||
"inputs": {
|
||||
"nixpkgs": "nixpkgs"
|
||||
}
|
||||
}
|
||||
},
|
||||
"root": "root",
|
||||
"version": 7
|
||||
}
|
||||
@@ -0,0 +1,64 @@
|
||||
{
|
||||
description = "KutuWM X11";
|
||||
|
||||
inputs = {
|
||||
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
|
||||
};
|
||||
|
||||
outputs =
|
||||
{ self, nixpkgs }:
|
||||
let
|
||||
systems = [
|
||||
"x86_64-linux"
|
||||
"x86_64-darwin"
|
||||
"aarch64-linux"
|
||||
"aarch64-darwin"
|
||||
];
|
||||
|
||||
forAllSystems =
|
||||
f:
|
||||
nixpkgs.lib.genAttrs systems (
|
||||
system:
|
||||
f (
|
||||
import nixpkgs {
|
||||
inherit system;
|
||||
}
|
||||
)
|
||||
);
|
||||
in
|
||||
{
|
||||
devShells = forAllSystems (pkgs: {
|
||||
default = pkgs.mkShell {
|
||||
packages = with pkgs; [
|
||||
clang-tools
|
||||
clang
|
||||
|
||||
gnumake
|
||||
ruby
|
||||
|
||||
haskellPackages.ghc
|
||||
haskellPackages.cabal-install
|
||||
haskellPackages.haskell-language-server
|
||||
|
||||
pkg-config
|
||||
|
||||
libxcb
|
||||
xcbutilwm
|
||||
];
|
||||
|
||||
LD_LIBRARY_PATH = pkgs.lib.makeLibraryPath [
|
||||
pkgs.libxcb
|
||||
pkgs.xcbutilwm
|
||||
];
|
||||
|
||||
shellHook = ''
|
||||
export CC=clang
|
||||
export CXX=clang++
|
||||
export LD=clang
|
||||
cabal --version
|
||||
ghc --version
|
||||
'';
|
||||
};
|
||||
});
|
||||
};
|
||||
}
|
||||
+46
@@ -0,0 +1,46 @@
|
||||
cabal-version: 3.14
|
||||
|
||||
name: kutu
|
||||
version: 0.1.0.0
|
||||
homepage: https://syedm.dev/kutu
|
||||
license: AGPL-3.0-only
|
||||
license-file: LICENSE
|
||||
author: Syed Daanish
|
||||
maintainer: me@syedm.dev
|
||||
-- copyright:
|
||||
category: System
|
||||
build-type: Simple
|
||||
|
||||
common warnings
|
||||
ghc-options: -Wall
|
||||
|
||||
executable kutu
|
||||
import: warnings
|
||||
|
||||
main-is: Main.hs
|
||||
|
||||
other-modules:
|
||||
WM.Core
|
||||
WM.XKutu
|
||||
WM.Mruby
|
||||
|
||||
build-depends: base, extra, bytestring, file-embed, text
|
||||
|
||||
hs-source-dirs: app
|
||||
|
||||
default-language: GHC2024
|
||||
|
||||
c-sources:
|
||||
app/c/x_kutu.c
|
||||
|
||||
include-dirs:
|
||||
app/c
|
||||
libs/mruby/build/host/include
|
||||
|
||||
extra-lib-dirs:
|
||||
libs/mruby/build/host/lib
|
||||
|
||||
extra-libraries:
|
||||
xcb
|
||||
xcb-icccm
|
||||
mruby
|
||||
@@ -0,0 +1,40 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -e
|
||||
|
||||
SCRIPT_DIR="$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
|
||||
OUTPUT_TMP=$(mktemp)
|
||||
OUTPUT="$SCRIPT_DIR/../../include/binding/ruby_compiled.h"
|
||||
|
||||
if test "$1" = "clean"; then
|
||||
rm -f "$OUTPUT"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
trap 'rm -f "$OUTPUT_TMP"' EXIT
|
||||
|
||||
mapfile -t FILES < <(find "$SCRIPT_DIR" -name "*.rb" | sort)
|
||||
|
||||
LATEST_FILE_TIME=$(for file in "${FILES[@]}"; do
|
||||
echo $(stat -c "%Y" "$file")
|
||||
done | sort -n | tail -1)
|
||||
|
||||
OUTPUT_TIME=$(stat -c "%Y" "$OUTPUT" 2>/dev/null || echo 0)
|
||||
|
||||
if test "$OUTPUT_TIME" -ge "$LATEST_FILE_TIME"; then
|
||||
echo "mgems is up to date."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
"$SCRIPT_DIR/../mruby/bin/mrbc" -o "$OUTPUT_TMP" "${FILES[@]}"
|
||||
|
||||
{
|
||||
echo "#ifndef MGEMS_H"
|
||||
echo "#define MGEMS_H"
|
||||
xxd -i -n mgems $OUTPUT_TMP \
|
||||
| sed -e 's/^unsigned char /constexpr unsigned char /' \
|
||||
-e 's/^unsigned int /constexpr unsigned int /'
|
||||
echo "#endif"
|
||||
} > "$OUTPUT"
|
||||
|
||||
echo "Compiled mgems!"
|
||||
+1010
File diff suppressed because it is too large
Load Diff
Submodule
+1
Submodule libs/mruby added at cb1cf9f08d
@@ -0,0 +1,112 @@
|
||||
firstly, why im interested in wm's citing i3 and awsome etc as my inspiration but the fact that using similar systems for a while now, and i wish to explore every part of the software everyone uses and doesnt even feel the existence of, and stuff (kinda short section)
|
||||
|
||||
then focusing on X11 in particular and not just WM in general, and how it has set itself as the standard for windowing on linux/bsd since a long time and how linux, bsd and previously even mac os's used this and even though wayland is challanging that as a new alternative how X11 is still more popular to an extent. also with focus on how it can also be used of ssh (all of this using research to back it up)
|
||||
|
||||
then research findings for the X11 windowing system and how all teh communication etc. happens and compositors and WM's and ssh access etc. (basically the mental model behind X11's philosofy, with diagrams maybe?)
|
||||
|
||||
and then about DE's and what DE's that work with X11 systems exist and how they exist to make utilizing a system easier and how people take it for granted with a little secion on trying to use a a system without any WM or DE to show how hard using such systems would be.
|
||||
|
||||
And then focusing on WM's and how they are supposed to work with X11's event system and how much control they have over windows
|
||||
|
||||
then continuing that with icccm and netwm standards and their history + why standards are getting messy over time or do not apply in all cases, for example they assume WM's will always have iconic, minimized and visible states etc. (with research findings of their histories)
|
||||
|
||||
then explaining how a WM is not that helpful on its own so we build some basic components to make a usable system
|
||||
- the components being, a simple info bar (kinda like polybar in terms of usage)
|
||||
- a menu thing similar to rofi (with simple searching) but in this case reused for a clipboard manager, command runner and emoji/unicode selection thing
|
||||
- and finally a notification daemon that just shows the title and body of a notification int the corner of teh screen and a little highlight in the bar
|
||||
(i can easily do the whole system and i kinda have built similar stuff b4 but im more worried about teh writeup than actual project)
|
||||
|
||||
---
|
||||
|
||||
This was kinda the preface section on X11 and WM's, now we do analysis of the project i chose itself.
|
||||
|
||||
---
|
||||
|
||||
starting with what im deciding to build to actually go through this, with a section comparing xcb and the X11 library and then other x11 tools like xrandr etc.
|
||||
|
||||
and here about other similar systems like i3, awsome, bspwm, the suckless one, and similar for minimalism, and also gnome and xcfe and why that would be out of scope for this but how these work with X11 with
|
||||
focus on the reparenting system that is standardised among these even though it is not stricly a rule needed.
|
||||
|
||||
and here focus on teh exact rules laid out by icccm and netwm and how much would be needed to get working and how much would be needed for full compliance which might not even be possible in certain situations
|
||||
|
||||
then a final concluding chart of what needs to be coded with diagrams of the system states and how they connect and teh data needed to be stored and ill be building a mostly tiling but with floating support and workspace divided system identical to i3. (basically a requirements list)
|
||||
|
||||
then actual implementation of the core WM with development logs of what im actually doing with screenshots errors, fixes and rewrites id have to do because of rending issues etc. (huge section here)
|
||||
|
||||
while using O notation to show what complexity every component has and maybe even one or 2 graphs of performance/space somparisions for teh sake of it
|
||||
|
||||
Then a sort of indev testing report of what works what changes i had to make to the initial requiremnts due to complexities arising etc.
|
||||
|
||||
---
|
||||
|
||||
and now for sections on each additional component
|
||||
|
||||
---
|
||||
|
||||
first the bar, research on common bars used in minimalist systems and comparisions with bars in like windows, feature wise. (also ones like polybar etc.)
|
||||
|
||||
and then a list of info i might need on the bar building on top of that section of what is commonly done
|
||||
|
||||
then a diagram of the flow of states etc. of teh code and what objects and stuff i need to do, with requirements i plan on fulfilling with the bar
|
||||
|
||||
then the actual implementation and logs etc. from that
|
||||
|
||||
---
|
||||
|
||||
Then i talk about abstaction and code reusablity
|
||||
|
||||
which i then exapnd on to talk about why i can reuse the same underlying system for command runner, clipboard and unicode selector, the fact that they all have a simple menu that can be sorted using searches and one can type a text at the top and hit enter to run it
|
||||
|
||||
---
|
||||
|
||||
then a log of building this menu and then using it to build those 3 sub systems
|
||||
|
||||
---
|
||||
|
||||
then teh notification daemon
|
||||
|
||||
- i first focus on research for dbus and how it works and how do i get the notification data from the apps in the first place
|
||||
|
||||
- then i focus on research behind existing notification systems like dunst etc.
|
||||
|
||||
---
|
||||
|
||||
tying it up together
|
||||
|
||||
---
|
||||
|
||||
here i can now show testing of the system and how it works and a little self evaluation on the implementation part of them first
|
||||
|
||||
and performance reports and any bugs etc. i was unable to address.
|
||||
|
||||
then i can show the integration of these components in a normal working situation while tying it up with the starting secion on trying to use a system without any WM, and showing how even with such a minimalistic setup we can work so much more efficiently than then
|
||||
|
||||
and then comparing what i built out with other ones liek xfce i3 and all in terms of how it turned out.
|
||||
|
||||
---
|
||||
|
||||
then a section on what i learnt from building this system and what i could do more and how it makes me appriciate windowing systems and parts of our computers that most people ignore while actively using
|
||||
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
|
||||
link dump:
|
||||
|
||||
https://linux-hardware.org/?view=os_display_server
|
||||
shows wayland overtaking x11, but only very recently
|
||||
|
||||
https://blog.davidedmundson.co.uk/blog/metrics-in-kde-are-they-useful/
|
||||
(shows 45% wayland and 55% x11) but a lot of older devices wouldnt switch as teh difference isnt as noticable, but for newer systems where wayland is default it was more like 80% wayland and 20% x11.
|
||||
|
||||
gnome has cut off x11 support entirely while being the most used de.
|
||||
|
||||
https://www.phoronix.com/review/x_wayland_situation
|
||||
|
||||
This explains teh problems of teh x11 system
|
||||
|
||||
https://www.linuxteck.com/x11-vs-wayland/?utm_source=chatgpt.com
|
||||
|
||||
wayland improvements for security, frame memory usage and fixing the tearing
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
Game Engine - With Mist a maze game
|
||||
|
||||
# What?
|
||||
|
||||
### The engine
|
||||
|
||||
- A high performance - low level game engine that provides abstactions for 2d games to be built on.
|
||||
|
||||
- A scene system
|
||||
- A scene is a set of scene elements used to create it,
|
||||
- For example, a scene for menu, for game over screen, and most importantly, for the main game scene.
|
||||
- A scene element can be one of,
|
||||
- A basic geometric shape
|
||||
- A text, with localization codes and text db
|
||||
- An image
|
||||
- A game world
|
||||
- A scripted element, for stuff like minimaps
|
||||
- each element has coordinates on screen and z ordering.
|
||||
- And they can handle clicks / keyboard events and have scripts attached to each.
|
||||
|
||||
- The bus
|
||||
- any event can be fired on the bus by any object and then used by other objects for actions like enemy attacking player or something,
|
||||
- they can be scoped with lifetime rules for tighter control and avoiding a event mess
|
||||
|
||||
- A game world is just the game world (everything is coordinates in the world map relative, and this object controls the camera), \
|
||||
and it can be defined as topdown or side (for z ordering rules).
|
||||
- everything is an entity
|
||||
- with specail entities for tiling spritesheets where a set of tiles can be defined and the engine will place the right kind of tile based on the scenario \
|
||||
(for example in a maze if i define a spritesheet with tiles for corner / edge peices and then tell the maze as a grid of cells with 1 for wall and 0 \
|
||||
for empty it will automatically place the correct tile from that list.)
|
||||
- and support for maze generation and solving algorithms, which can be used with tiling entity to create maze maps but also just usable for anything.
|
||||
|
||||
- Every entity is just a set of components added to it to form something in a game "world"
|
||||
- An entity joins together components to create an entity
|
||||
- Components are:
|
||||
1. Body
|
||||
- Shape (Dynamic or static)
|
||||
- Mass, physics interactions
|
||||
- Coordinates
|
||||
2. Spritesheet (state based or singleton)/(animated or static)
|
||||
- State based is for like player sprite can switch between states like facing direction etc.
|
||||
- It will have an api to load and manage game sprites with animations handled automatically.
|
||||
- The developer can define sprite locations for static and for dynamic a list of files or pixel \
|
||||
areas within a bitmap image for each animation frame and the fps of the animation.
|
||||
3. Render, only for those that dont use a Spritesheet
|
||||
- Can be used for rendering a box or other simple shapes / text for fine grained control, this is automatically handled if a spritesheet exists.
|
||||
4. Controlles
|
||||
- Can be used to connect a script to run on every game loop for this object (delta based)
|
||||
- Event Subscription
|
||||
- Can be used to subscribe to global / scoped events in the game event bus. (input can be handled through this or in update)
|
||||
5. Light
|
||||
- Light level info for fog light shader
|
||||
- In debug mode the collisions will be visible and other info like coords etc. logged for that game "world"
|
||||
|
||||
- It will have a physics engine for physics calculations like collisions, velocity, friction, forces, los, etc. attached to the game world
|
||||
- It applies to all objects with collision bodies
|
||||
- It has a center property that explains where the objects center is relative to the shape, and the size of the shape
|
||||
- it has a mass which shows its inertia
|
||||
- And they can be static or dynamic, rigid is used for walls and dynamic is for player / enemies etc. \
|
||||
with an api to simulate a force on a dynamic object, with collision handling with other static objects to stop it and with other dynamic \
|
||||
objects for firing collision events (for exmple checking if player collides with enemy)
|
||||
- it also has setting for adding gravity (added for side view games.), or defining friction force relative to a coefficient defined per object for texturing.
|
||||
- Calculations for interacting these objects in the world and updating their positions based on velocity / forces each game loop.
|
||||
|
||||
- Lighting support for fog based systems and shaders for common scenarios like clouds / fog and api to create custom shaders
|
||||
- A light system to render torches/light systems
|
||||
- With api to implement shaders for special effects
|
||||
- These are GPU accelerated shaders
|
||||
- owned by world
|
||||
|
||||
- An api for game "world" persistence. and generic data store.
|
||||
|
||||
- Normal classes / logic can be written outside and reused in the system.
|
||||
|
||||
- The scripting is done in mruby with most common ruby gems available. (the actual project will be in c++)
|
||||
- The scene can be defined and setup in a markup-style custom ruby DSL.
|
||||
|
||||
- And special predefined scenes for menu / settings types with settings having predefined settings for keybinds used.
|
||||
- And the godot style project settings where we can define key value pairs with datatype for value that can be used as globals. \
|
||||
and interfaced through autogenerated settings scene, or hidden but used as globals internally.
|
||||
|
||||
- And as a sample game implemented using it I will make mist.
|
||||
|
||||
### Mist - A maze game
|
||||
|
||||
- The main focus of the game is to show off all features of this engine.
|
||||
- It also focuses on maze generation and solving with choices to select different types of maze generation algorithms and solving ai for npc's
|
||||
- The main game has 4 modes
|
||||
1. _Classic_ - A finite maze is generated on world creation and player has to fight enemies, collect resources / weapons and find the exit to win
|
||||
2. _Tutorial_ - A smaller map with basic elements and npc's for player to inteact with and tooltips for helping them learn how the game works
|
||||
3. _Infinite_ - A maze is procedurally generated as the player walks using predefined seeds and memory optimizations to allow storing such information, \
|
||||
the goal is to get as far from spawn as possible without dying.
|
||||
4. _Editor Mode_ - A mode in which teh user controls the map itself and can test out various maze generation algorithms and place npcs / rooms and tweak \
|
||||
game rules to create custom game scenarios.
|
||||
|
||||
# Who?
|
||||
|
||||
- This game engine is targeted towards basic to intermediate indie developers trying out 2d game development for 2d open world like scenarios with \
|
||||
physics etc. (in both topdown or side view mode)
|
||||
- They can use the scene editor to make scene setups for all the visible stuff in teh game and then write scripts for behaviour of it using ruby syntax, \
|
||||
which is a high level OOP interpreted langauge with a low learning curve due to its simple to learn syntax, and tons of helper functions for rapid development.
|
||||
- It could be used by educators for teaching game development basics to students and getting hands on experience.
|
||||
- This engine also indirectly effects the gamers, the end users as they are the ones to feel any performance costs when enjoying the games.
|
||||
Executable
+11
@@ -0,0 +1,11 @@
|
||||
#!/usr/bin/env bash
|
||||
set -e
|
||||
|
||||
Xephyr :1 -screen 1280x720 &> /dev/null &
|
||||
pid=$!
|
||||
|
||||
trap "kill $pid" EXIT
|
||||
|
||||
sleep 1
|
||||
|
||||
DISPLAY=:1 cabal run exe:kutu -- --script $1
|
||||
Reference in New Issue
Block a user