work/ 0000775 0000000 0000000 00000000000 13667211331 006733 5 ustar work/.gitignore 0000664 0000000 0000000 00000000007 13667211331 010720 0 ustar *~
tmp
work/DEVELOPER-CERTIFICATE 0000664 0000000 0000000 00000002616 13667211331 011730 0 ustar Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
work/GPL-3 0000664 0000000 0000000 00000104513 13667211331 007444 0 ustar GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
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.
Copyright (C)
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 .
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:
Copyright (C)
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
.
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
.
work/Makefile 0000664 0000000 0000000 00000001416 13667211331 010375 0 ustar
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: GPL-3.0-or-later
# There is NO WARRANTY.
INSTALL ?= install
INSTALL_SCRIPT ?= $(INSTALL) -m 755
INSTALL_DATA ?= $(INSTALL) -m 644
prefix ?= /usr/local
p=chiark-tcl-applet
bindir=$(prefix)/bin
sharedir=$(prefix)/share/$p
SCRIPTS += xbatmon-simple-tray chiark-tcl-applet-wrapper
TCLLIBS += $(addsuffix .tcl, applet args subproc utils)
SEDDED_SCRIPTS= $(addprefix tmp/, $(SCRIPTS))
all: $(SEDDED_SCRIPTS)
tmp:
mkdir -p tmp
tmp/%: % tmp
sed '1,/^source/ s#^set lib \.#set lib $(sharedir)#' $* >$@
chmod +x $@
install: all
$(INSTALL) -d $(addprefix $(DESTDIR), $(bindir) $(sharedir))
$(INSTALL_SCRIPT) $(SEDDED_SCRIPTS) $(DESTDIR)$(bindir)
$(INSTALL_DATA) $(TCLLIBS) $(DESTDIR)$(sharedir)
clean:
rm -rf tmp
work/README 0000664 0000000 0000000 00000003444 13667211331 007620 0 ustar
Introduction
============
This package contains various code, mostly in Tcl, for making applets
(things that sit in your X11 "system tray".)
The only actually useful utility here right now is
xbatmon-simple-tray.
Legal information
=================
This package, chiark-tcl-applet, is
Copyright 2016-2020 Ian Jackson
chiark-tcl-applet 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 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 package as the file GPL-3.
If not, see https://www.gnu.org/.
Individual files generally contain the following tag in the copyright
notice, instead of the full licence grant text:
SPDX-License-Identifier: GPL-3.0-or-later
As is conventional, this should be read as a licence grant.
The Debian packaging files in the debian/ subdirectory are under a
more permissive licence - the MIT licence, debian/MIT-LICENCE, as
indicated in those files by:
SPDX-License-Identifier: MIT
(This is useful only if (parts of) these files are copied elsewhere,
since as provided by the GPL3, when the package is distributed as a
work as a whole, these files are covered by the GPL3.)
Contributions are accepted based on the git commit Signed-off-by
convention, by which the contributors' certify their contributions
according to the Developer Certificate of Origin version 1.1 - see
the file DEVELOPER-CERTIFICATE.
work/applet.tcl 0000664 0000000 0000000 00000021545 13667211331 010733 0 ustar # General purpose code for being a tray applet
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: GPL-3.0-or-later
# There is NO WARRANTY.
package require Tclx
package require tktray
#----- general machinery -----
# Interface:
#
# tk::tktray widget is called .i
#
# Tooltip:
#
# Caller may call
# applet::setup-tooltip ON-VISIBLE ON-INVISIBLE
# to make applet have a tooltip.
#
# ON-VISIBLE and ON-INVISIBLE will be globally eval'd
# when the tooltip becomes visible and invisible.
#
# Caller should call
# applet::tooltip-set TEXT-MAYBE-MULTILINE
# whenever they like.
#
# Button presses
#
# Caller may bind .i.i
#
# Alternatively caller may call applet::setup-button-menu $b
# which will generate a menu .m$b which the user can configure
# and which will automatically be posted and unposted etc.
# In this case the caller should arrange that all of their
# menus, when an item is selected, call
# applet::msel
#
# Icon:
#
# Caller should call:
# applet::setimage IMAGE
# as necessary.
#
# Alternatively of icon, it may provide other arrangements for
# using the provided subwindow. Such a caller should call
# applet::setup-subwindow ON-DESTROYING ON-READY
# Then the main code will call ON-DESTROYING just before
# destroying the inner window and recreating it, and
# [concat ON-READY [list ORIENTATION]]
# just after. The inner window to use is called .i.i.b.
#
# This uses variables, in the applet namespace,
# w h border_colour border_width deforient
# These should be set before setup-subwindow is called and not
# modified thereafter.
#
# The user of the subwindow machinery may call
# applet::subwindow-need-recreate
# if for any reason the inner window should be destroyed and recreated.
#
# Alternatively, it may request that a subprocess be spawned
# repeatedly with the xid of a suitable window.
# applet::setup-subproc GET-CMDLINE
# Then the main code will call [concat GET_CMDLINE [list XID ORIENTATION]]
# to get the command line to run.
#
# This also uses the same variables as setup-subwindow.
namespace eval applet {
proc become {} {
wm withdraw .
tktray::icon .i -class example
.i configure -docked 1
fconfigure stdout -buffering none
fconfigure stderr -buffering none
}
# used by both menus and tooltips
variable posted 0
variable tooltip_offset {9 9}
#----- menus -----
proc setup-button-menu {b} {
bind .i.i { applet::menubuttonpressed %b %X %Y }
menu .m$b -tearoff 0
}
proc menubuttonpressed {b x y} {
variable posted
tooltip-cancel
if {$posted == $b} {
debug::debug "unpost $posted toggle"
.m$posted unpost
set posted 0
} elseif {[winfo exists .m$b]} {
if {$posted} {
.m$posted unpost
debug::debug "unpost $posted other"
}
debug::debug "post $b"
set posted $b
.m$b post $x $y
}
}
proc msel {} {
variable posted
set posted 0
}
#----- tooltips -----
variable tooltip_on_vis {}
variable tooltip_on_invis {}
proc tooltip-starttimer {state x y} {
variable tooltip_after
variable posted
variable tooltip_inwindow
if {$state || $posted || !$tooltip_inwindow} { tooltip-cancel; return }
catch { after cancel $tooltip_after }
set tooltip_after [after 500 applet::tooltip-show $x $y]
}
proc tooltip-cancel {} {
variable tooltip_after
variable tooltip_on_invis
catch { after cancel $tooltip_after }
catch { unset $tooltip_after }
wm withdraw .tt
uplevel #0 $tooltip_on_invis
}
set tooltip_inwindow 0
proc tooltip-enter {state x y} {
variable tooltip_inwindow
set tooltip_inwindow 1
tooltip-starttimer $state $x $y
}
proc tooltip-leave {} {
variable tooltip_inwindow
set tooltip_inwindow 0
tooltip-cancel
}
proc setup-tooltip {on_vis on_invis} {
foreach v {vis invis} {
variable tooltip_on_$v [set on_$v]
}
bind .i { applet::tooltip-enter %s %X %Y }
bind .i { applet::tooltip-leave }
bind .i {
applet::tooltip-cancel
applet::tooltip-starttimer %s %X %Y
}
bind .i { applet::tooltip-starttimer %s %X %Y }
toplevel .tt -background black
wm withdraw .tt
wm overrideredirect .tt 1
label .tt.t -justify left -background {#EEE1B3}
pack .tt.t -padx 1 -pady 1
tooltip-set {}
}
proc tooltip-set {s} {
.tt.t configure -text $s
}
proc tooltip-show {x y} {
variable tooltip_on_vis
variable tooltip_offset
incr x [lindex $tooltip_offset 0]
incr y [lindex $tooltip_offset 1]
wm geometry .tt +$x+$y
wm deiconify .tt
raise .tt
uplevel #0 $tooltip_on_vis
}
#----- simple images -----
proc setimage {image} {
.i configure -image $image
}
#----- subwindow -----
variable subwindow_on_destroying
variable subwindow_on_ready
variable w 50
variable h 50
variable deforient horizontal
variable border_colour darkblue
variable border_width 1
variable tray_width X
variable tray_height X
variable orientation vertical
proc subwindow-need-recreate {evtype why} {
variable orientation
variable innerwindow_after
variable tray_width
variable tray_height
debug::debug "IW-EVENT $evtype $why [winfo reqwidth .i] [winfo reqheight .i] [winfo width .i] [winfo height .i] $orientation"
switch -exact $orientation {
horizontal { set szv height }
vertical { set szv width }
unknown { return }
}
set new_sz [winfo req$szv .i]
if {![string compare $new_sz [set tray_$szv]]} {
return
}
set tray_$szv $new_sz
# switch -exact -- $evtype 35 { return }
if {[info exists innerwindow_after]} return
set innerwindow_after [after idle applet::innerwindow-resetup]
}
proc innerwindow-resetup {} {
variable innerwindow_after
variable subwindow_on_destroying
variable subwindow_on_ready
variable border_colour
variable border_width
variable deforient
variable orientation
unset innerwindow_after
debug::debug RESETUP
if {![winfo exists .i.i]} return
destroy [frame .i.i.make-exist]
uplevel #0 $subwindow_on_destroying
catch { destroy .i.i.b }
set orientation [.i orientation]
debug::debug "orientation $orientation"
if {![string compare $orientation unknown]} {
set orientation $deforient
}
.i configure -image applet::innerwindow-ph-$orientation
frame .i.i.b -background $border_colour -bd $border_width
pack .i.i.b -fill both -side left -expand 1
uplevel #0 $subwindow_on_ready [list $orientation]
}
proc setup-subwindow {on_destroying on_ready} {
variable w
variable h
foreach v {on_destroying on_ready} {
variable subwindow_$v [set $v]
}
image create photo applet::innerwindow-ph-horizontal -width $w -height 2
image create photo applet::innerwindow-ph-vertical -width 2 -height $h
.i configure -image applet::innerwindow-ph-horizontal
destroy [frame .i.make-exist]
#destroy [frame .i.i.make-exist]
bind .i <> {
applet::subwindow-need-recreate %T "%T i=%i k=%K N=%N R=%R S=%S k=%k m=%m d=%d s=%s a=%a b=%b c=%c f=%f w,h=%w,%h o=%o p=%p t=%t x,y=%x,%y B=%B D=%D E=%E P=%P W=%W X,Y=%X,%Y"
}
}
#----- subprocess -----
variable subproc none
variable ratelimit {}
proc setup-subproc {get_cmdline} {
variable subproc_get_cmdline $get_cmdline
setup-subwindow applet::subproc-destroying applet::subproc-ready
}
proc subproc-destroying {} {
variable subproc
debug::debug "DESTROYING $subproc"
catch { destroy .i.i.b.c }
switch -exact $subproc {
none { }
old { }
default { kill $subproc; set subproc old }
}
}
proc subproc-ready {orientation} {
variable subproc
variable subproc_orientation $orientation
debug::debug "READY $subproc"
frame .i.i.b.c -container 1 -background orange
pack .i.i.b.c -fill both -side left -expand 1
switch -exact $subproc {
none {
run-child
}
old {
# wait for it to die
}
default {
error "unexpected state $subproc"
}
}
debug::debug "READY-done $subproc"
}
proc run-child {} {
variable subproc
variable ratelimit
variable subproc_get_cmdline
variable subproc_orientation
set id [winfo id .i.i.b.c]
set cmd [uplevel #0 $subproc_get_cmdline [list $id $subproc_orientation]]
debug::debug "RUN-CHILD $subproc"
set now [clock seconds]
lappend ratelimit $now
while {[lindex $ratelimit 0] < {$now - 10}} {
set ratelimit [lrange $ratelimit 1 end]
}
if {[llength $ratelimit] > 10} {
puts stderr "crashing repeatedly, quitting $ratelimit"
exit 127
}
set subproc none
set subproc [subproc::fork applet::child-died {
execl [lindex $cmd 0] [lrange $cmd 1 end]
}]
debug::debug "FORKED $subproc"
}
proc child-died {how how2} {
debug::debug "DIED $how $how2"
variable subproc
switch -exact $subproc {
old {
set subproc none
run-child
}
default {
set subproc none
subwindow-need-recreate child-died child-died
}
}
}
}
work/args.tcl 0000664 0000000 0000000 00000002465 13667211331 010402 0 ustar
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: GPL-3.0-or-later
# There is NO WARRANTY.
namespace eval args {
proc badusage {msg} {
puts stderr "bad usage: $msg"
exit 12
}
proc badoption {} {
variable lastarg
badusage "unknown option $lastarg"
}
proc next {} {
global argv
variable lastarg
if {![llength $argv]} { badusage "$lastarg needs a value" }
set arg [lindex $argv 0]
set argv [lrange $argv 1 end]
set lastarg $arg
}
proc next_num {} {
set arg [next]
variable lastarg
if {[catch { eval {$arg + 0} } emsg]} {
badusage "$lastargv value must be a number ($emsg)"
}
}
proc generalarg {arg} {
switch -exact -- $arg {
-width { set applet::w [next_num] }
-height { set applet::h [next_num] }
-horizontal - -vertical { set applet::deforient $arg }
-borderColour - -borderColor { set applet::border_colour [next] }
-borderWidth { set applet::border_width [next_num] }
-debug { debug::setup puts }
default { return 0 }
}
return 1
}
proc more {} {
global argv
if {![llength $argv]} { return 0 }
if {![regexp {^-} [lindex $argv 0]]} { return 0 }
return 1
}
proc next_special {va} {
upvar 1 $va arg
global argv
while {[more]} {
set arg [next]
if {[generalarg $arg]} continue
return 1
}
return 0
}
}
work/chiark-tcl-applet-wrapper 0000775 0000000 0000000 00000001757 13667211331 013655 0 ustar #!/usr/bin/wish -f
# -*- Tcl -*-
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: GPL-3.0-or-later
# There is NO WARRANTY.
# usage:
# chiark-tcl-applet-wrapper program arguments...
# will run
# program arguments... WINDOWID
# and program sbould put up an X11 window as a child of WINDOWID
#
# eg, for a silly example:
# .../example xterm -id
set lib .
source $lib/applet.tcl
source $lib/subproc.tcl
source $lib/utils.tcl
applet::become
set debug::debug puts
foreach b {1 3} {
applet::setup-button-menu $b
}
.m1 add command -command { applet::msel; puts hi } -label hi
.m3 add command -command { applet::msel; puts boo } -label boo
#image create bitmap ims -file gs_s.xbm
#image create bitmap ims -file /usr/share/ghostscript/8.71/lib/gs_s.xbm
#setimage ims
#setimage ims
applet::setup-tooltip { puts VIS } { puts INVIS }
applet::tooltip-set "line\nanother"
proc cmdline {id orientation} {
global argv
return [concat $argv $id]
}
applet::setup-subproc cmdline
work/debian/ 0000775 0000000 0000000 00000000000 13667211331 010155 5 ustar work/debian/.gitignore 0000664 0000000 0000000 00000000073 13667211331 012145 0 ustar .debhelper
*.substvars
chiark-tcl-applet
debhelper-*
files
work/debian/MIT-LICENCE 0000664 0000000 0000000 00000002156 13667211331 011575 0 ustar This licence applies only to the files in debian/*
Copyright 2020 Ian Jackson
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice (including the
next paragraph) shall be included in all copies or substantial
portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
work/debian/changelog 0000664 0000000 0000000 00000000704 13667211331 012030 0 ustar chiark-tcl-applet (1.0-2) unstable; urgency=medium
* chiark-tcl-applet-wrapper: Ship it and describe it a bit better
-- Ian Jackson Sun, 07 Jun 2020 17:16:25 +0100
chiark-tcl-applet (1.0-1) unstable; urgency=medium
* Initial release.
-- Ian Jackson Tue, 10 Mar 2020 15:14:47 +0000
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: MIT
# There is NO WARRANTY.
work/debian/compat 0000664 0000000 0000000 00000000003 13667211331 011354 0 ustar 12
work/debian/control 0000664 0000000 0000000 00000001526 13667211331 011564 0 ustar Source: chiark-tcl-applet
Build-Depends: debhelper (>= 12~)
Section: x11
Maintainer: Ian Jackson
Standards-Version: 4.5.0.0
Package: chiark-tcl-applet
Depends: wish, tk-tktray, chiark-utils-bin, ${misc:Depends}
Suggests: trayer | stalonetray
Architecture: all
Section: x11
Priority: optional
Description: Tray widget for battery monitor and other X11 programs
xbatmon-simple-tray is a battery status display, with useful
tooltip, which sits in your system tray.
.
There is also an wrapper script, chiark-tcl-applet-wrapper, which
can embed any X11 program in your system tray.
.
If you do not yet have an X11 system tray (eg because you are not
running a desktop environment with panel), consider trayer or
stalonetray.
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: MIT
# There is NO WARRANTY.
work/debian/copyright 0000664 0000000 0000000 00000003450 13667211331 012112 0 ustar Format: 1.0
Files: *
Copyright: 2016,2020 Ian Jackson
License: GPL-3+
License: GPL-3+
Legal information
=================
.
This package, chiark-tcl-applet, is
Copyright 2016-2020 Ian Jackson
.
chiark-tcl-applet 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 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 package as the file GPL-3.
If not, see https://www.gnu.org/.
.
Individual files generally contain the following tag in the copyright
notice, instead of the full licence grant text:
SPDX-License-Identifier: GPL-3.0-or-later
As is conventional, this should be read as a licence grant.
.
The Debian packaging files in the debian/ subdirectory are under a
more permissive licence - the MIT licence, debian/MIT-LICENCE, as
indicated in those files by:
SPDX-License-Identifier: MIT
(This is useful only if (parts of) these files are copied elsewhere,
since as provided by the GPL3, when the package is distributed as a
work as a whole, these files are covered by the GPL3.)
.
Contributions are accepted based on the git commit Signed-off-by
convention, by which the contributors' certify their contributions
according to the Developer Certificate of Origin version 1.1 - see
the file DEVELOPER-CERTIFICATE.
.
On Debian systems a copy of the GPLv3 can be found in
/usr/share/common-licenses/GPL-3
work/debian/copyright.head 0000664 0000000 0000000 00000000130 13667211331 013002 0 ustar Format: 1.0
Files: *
Copyright: 2016,2020 Ian Jackson
License: GPL-3+
License: GPL-3+
work/debian/copyright.tail 0000664 0000000 0000000 00000000134 13667211331 013036 0 ustar .
On Debian systems a copy of the GPLv3 can be found in
/usr/share/common-licenses/GPL-3
work/debian/rules 0000775 0000000 0000000 00000000617 13667211331 011241 0 ustar #!/usr/bin/make -f
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: MIT
# There is NO WARRANTY.
export prefix=/usr
%:
dh $@
debian/copyright: debian/copyright.head debian/copyright.tail \
README debian/rules
cat >$@.tmp debian/copyright.head
sed >>$@.tmp >$@.tmp debian/copyright.tail
mv -f $@.tmp $@
work/debian/source/ 0000775 0000000 0000000 00000000000 13667211331 011455 5 ustar work/debian/source/lintian-overrides 0000664 0000000 0000000 00000000202 13667211331 015030 0 ustar missing-debian-source-format
older-source-format 1.0
hyphen-in-native-debian-changelog-version
malformed-debian-changelog-version
work/subproc.tcl 0000664 0000000 0000000 00000002711 13667211331 011115 0 ustar
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: GPL-3.0-or-later
# There is NO WARRANTY.
package require Tclx
namespace eval subproc {
#----- general purpose subprocess handling -----
#
# One useful procedure:
# subprocess::fork ONDEATH INCHILD
# forks, evaluates INCHILD in the calling context but in the child
# and when the child dies evaluates [concat [list ONDEATH] W2 W3]
# where W2 and W3 are the 2nd and 3rd elements of the list returned
# by tclx's wait.
#
# INCHILD should not return; if it does or if it gets an error, the
# result is that the child gets a SIGKILL.
variable children
proc fork {ondeath inchild} {
variable children
global errorCode errorInfo
foreach f {stdout stderr} {
if {[catch { flush $f } emsg]} {
catch { bgerror $emsg }
}
}
set pid [::fork]
if {!$pid} {
if {[catch {
uplevel 1 $inchild
} emsg]} {
puts stderr "CHILD ERROR $emsg\n$errorCode\n$errorInfo\n"
}
kill KILL [id process]
}
set children($pid) $ondeath
return $pid
}
proc chld-handler {} {
variable children
while 1 {
if {[catch { set got [wait -nohang] }]} break
if {![llength $got]} break
manyset $got pid how how2
if {[info exists children($pid)]} {
set l $children($pid)
unset children($pid)
if {[catch {
uplevel #0 [concat [list $l] $how $how2]
} emsg]} {
catch { bgerror $emsg }
}
}
}
}
signal -restart trap CHLD { after idle subproc::chld-handler }
}
work/ttyacm-multiplex 0000775 0000000 0000000 00000017627 13667211331 012220 0 ustar #!/usr/bin/tclsh8.4
# -*- tcl -*-
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: GPL-3.0-or-later
# There is NO WARRANTY.
# This is unfinished attempt at a program to multiplex multiple
# clients all wanting to speak to a /dev/ttyACM GSM modem / GPS.
set expected_devs 3
proc debug {m} { puts "DEBUG $m" }
proc log {m} { puts "LOG $m" }
proc experror {m} {
error $m {} EXPECTED
}
proc find-devices {} {
global errorCode errorInfo devices expected_devs
set base /sys/class/tty
foreach candidate [glob -nocomplain -directory $base -tails ttyACM*] {
debug "candidate $candidate"
if {[catch { file link $base/$candidate/device } ltarget]} {
debug " readlink failed [lrange $errorCode 0 1]"
switch -glob $errorCode {
{POSIX EINVAL *} continue
{POSIX ENOENT *} continue
default { error "$ltarget \[$errorCode] $errorInfo $errorCode" }
}
}
if {![regexp {^(.*)\.(\d+)$} $ltarget dummy dbase interf]} {
debug " readlink bad target $ltarget"
continue
}
debug " approved $dbase $interf $candidate"
lappend devs($dbase) [list $interf $candidate]
}
set howmany [array size devs]
if {!$howmany} {
experror "no appropriate device(s) found"
}
if {$howmany > 1} {
experror "several appropriate device(s) found [array names $devs]"
}
set devices {}
foreach dev [lsort -index 0 -integer $devs([lindex [array names devs] 0])] {
lappend devices [lindex $dev 1]
}
if {[llength $devices] != $expected_devs} {
experror "wrong # devices ($devices), expected $expected"
}
}
proc create-dev-nodes {} {
global devices expected_devs
set ourdevs /dev/atmux
set ttyat ttyAT
for {set i 0} {$i < $expected_devs-1} {incr i} {
set new $ttyAT$i
file link -symbolic ../$device $ourdevs/.new.$new
file rename -force $ourdevs/.new.$new $ourdevs/$new
set wanted($new) 1
}
foreach candidate [glob -nocomplain -directory $ourdevs -tails ttyAT*] {
if {![info exists wanted($candidate)]} {
file remove $ourdevs/$candidate
}
}
}
proc reopen-our-device {} {
global devices dchan
set dchan [open /dev/[lindex $devices 1] r+]
fconfigure $dchan -blocking no -buffering line -translation {crlf cr}
read $dchan; # flush input
puts $dchan ATE0
flush $dchan
after 250
set result [read $dchan]
if {![regexp -line {^OK$} $result]} { experror "got [logquote $result]" }
fileevent $dchan readable chan-readable $dchan dchan "modem device"
}
proc devices {} {
find-devices
create-dev-nodes
reopen-our-device
}
proc dchan-failure {dummy} {
global dchan
if {[info exists dchan]} {
catch { close $dchan }
catch { unset dchan }
}
}
proc try-open-our-device {} {
global devices
if {[catch {
reopen-our-device
} emsg]} {
devfailure $emsg
return
}
sendout-async *TTYATMUX "*TTYATMUXDEVS [join $devices ,]"
sendout-async *TTYATMUX "*TTYATMUXOPEN"
}
proc trap-log {what body var} {
global errorCode errorInfo
upvar 1 $var result
set rc [catch {
uplevel 1 $body
} result]
switch -exact $rc {
1 {
switch -glob $errorCode {
{POSIX *} - EXPECTED { log "$what: $result" }
default {
log "unexpected: $what: $result"
foreach l [split $errorInfo "\n"] { log " $l" }
}
}
return 1
}
0 {
return 0
}
default {
return -code $rc -errorinfo $errorInfo \
-errorcode $errorCode $result
}
}
}
proc chan-readable {chan how what args} {
while 1 {
if {[trap-log "$what failure" {
gets $chan l
} r]} {
$how-failure $chan
return
}
if {$r<0} {
if {![eof $chan]} return
log "device eof"
$how-failure $chan
return
}
trap-log "error processing $what data" {
$how-line $l
} dummy
}
}
proc async-notif fixme this has wrong arguments
proc async-notif-or-resp-fixed {asid l} {
global current_command_asid
if {![string compare $asid $current_command_asid]} {
sync-reply $l
} else {
async-notif $asid $l
}
}
proc async-notif-creg {asid l} {
set ll [llength [split $l ,]]
switch -exact $ll {
4 { sync-reply $l }
3 {
async-notif {+CREG} 2 2 $l
async-notif {+CREG} 1 1 [lindex [split $l ,] 0]
}
2 { sync-reply $l }
1 {
async-notif {+CREG} 1 2 $l
}
default {
bad-data $l "async-notif-creg $ll"
}
}
}
proc async-control-max0 {c l allows} {
async-control-core $c $l $allows {
set wanted 0
} {
set tw 0
manyset $ca($c) tw
if {$tw} { set wanted 1 }
} {
set send $wanted
foreach allow $allows { lappend $send [lindex $allow 0] }
sync-subcommand $c "$cmd=[join $send ,]" async-updated-ok $c
}
}
proc async-control-cmer {c l allows} {
async-control-core $c $l $allows {
set send 0,0,0,0
} {
set mode 0; set ind 0
manyset $ca($c) mode keyp disp ind bfr
if {$mode==3 && $ind} { set send 3,0,0,1 }
} {
sync-subcommand $c "$cmd=$send" async-updated-ok $c
}
}
proc async-updated-ok
proc async-control-core {c l allows ubody_init ubody_perclient ubody_finish} {
global clients
uplevel 1 cmd cmd
if {[regexp {^(AT[^=?])\?$} $l dummy cmd]} {
sync-subcommand $c $l async-massage-result-subs $c $cmd
} elseif {[regexp {^(AT[^=?])=\?$} $l dummy cmd]} {
sync-subcommand $c $l async-massage-result-support $c $cmd $allows
} elseif {[regexp {^(AT[^=?])=([0-9,]+)$} $l dummy cmd values]} {
set values [split $values ,]
if {[llength $values] > [llength $allows]} {
bad-command "too many values"
return
}
while {[llength $values] < [llength $allows]} {
lappend values 0
}
foreach val $values allow $allows {
if {[lsearch -exact $allow $val]<0} {
bad-command "$val not in allowed $allow ($allows)"
return
}
}
uplevel 1 [list upvar #0 client_async/$cmd ca]
upvar #0 client_async/$cmd ca
set ca($c) $values
uplevel 1 $ubody_init
upvar 1 c uc
foreach uc [array names clients] {
uplevel 1 $ubody_perclient
}
uplevel 1 $ubody_finish
} else {
bad-command "unknown async control syntax"
}
}
proc set-client-echo {c yn} {
global client_echo
set client_echo($c) 0
client-command-complete $c OK
}
proc simple-command {c l} {
sync-subcommand $c $l simple-command-complete
}
proc client-command-complete
proc process-client-command {c nl} {
switch -regexp $l {
{^AT\+CREG\b} { async-control-max0 $c $l {{0 1 2}} }
{^AT\+CGREG\b} { async-control-max0 $c $l {{0 1 2}} }
{^AT\*ERINFO\b} { async-control-max0 $c $l {{0 1}} }
{^AT\+CGEREP\b} { async-control-max0 $c $l {{0 1 2} 0} }
{^AT\+CMER\b} { async-control-cmer $c $l {{0 3} 0 0 {0 1} 0} }
{^ATE0$} { set-client-echo $c 0 }
{^ATE1$} { set-client-echo $c 1 }
{^AT\+CFUN\b} { simple-command $c $l }
default { bad-command "unknown command" }
}
}
proc dchan-line {l} {
global cclient
switch -regexp $l {
{\+CREG:} { async-notif-creg +CREG $l }
{\+CGREG:} { async-notif-creg +CGREG $l }
{\*ERINFO:} { async-notif-or-resp-fixed *ERINFO $l }
{\+CGEV:} { async-notif +CGEREP $l }
{\+CIEV:} { async-notif +CMER $l }
default { syync-reply $l }
}
}
proc cchan-line {c l} {
lappend queue [list $c $l]
check-busy
}
proc sync-subcommand {c l args} {
global busy dchan
if {[info exists busy]} { error "already busy $busy; want $c $l $args" }
if {[trap-log "write device" { puts $dchan $l } dummy]} {
proc sync-reply {l} {
global busy
if {![info exists busy]} {
bad-data $l "unexpected sync reply"
return
}
eval $
proc check-busy {} {
global busy queue
while {![info exists busy] && [llength $queue]} {
manyset [lindex $queue 0] c l
set queue [lrange $queue 1 end]
if {[trap-log "process for $c [logquote $l]"] {
process-client-command $c $l
} dummy]} {
client-command-complete $c ERROR
}
}
}
proc client-command-complete {c l} {
if {[trap-log "write to $c" { puts $c $l } dummy]} {
client-failure $c
}
}
proc cchan-readable {
proc sendout-async
proc logquote
try-open-our-device
work/utils.tcl 0000664 0000000 0000000 00000001311 13667211331 010573 0 ustar
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: GPL-3.0-or-later
# There is NO WARRANTY.
proc manyset {list args} {
foreach val $list var $args {
upvar 1 $var my
set my $val
}
}
namespace eval debug {
# Debug:
#
# Caller may call
# debug::setup ON-DEBUG
# which will result in calls to [concat ON-DEBUG [list MESSAGE]]
# (or ON-DEBUG may be "" in which case messages are discarded)
#
# And caller may call
# debug::debug MSG
variable debug {}
proc debug {m} {
variable debug
if {![llength $debug]} return
set ns [uplevel 1 namespace current]
uplevel #0 $debug [list "DEBUG $ns $m"]
}
proc setup {d} {
variable debug $d
}
}
work/xbatmon-simple-tray 0000775 0000000 0000000 00000013023 13667211331 012574 0 ustar #!/usr/bin/wish -f
# -*- Tcl -*-
# Copyright 2016,2020 Ian Jackson
# SPDX-License-Identifier: GPL-3.0-or-later
# There is NO WARRANTY.
# usage:
# xbatmon-simple-tray
# [WISH-OPTIONS... [-- TRAY-EMBED-OPTIONS... [-- XBATMON-SIMPLE-OPTIONS...]]]
set lib .
source $lib/subproc.tcl
source $lib/utils.tcl
source $lib/args.tcl
source $lib/applet.tcl
proc cmdline {id orientation} {
global argv
return [concat [list xacpi-simple -into $id] $argv]
}
#----- tooltip generation -----
proc tt-invisible {} {
tt-noafter
applet::tooltip-set {}
}
proc tt-noafter {} {
global ttafter
catch { after cancel $ttafter }
catch { unset ttafter }
}
proc tt-show {} {
global ttafter
tt-noafter
set ttafter [after 500 tt-show]
applet::tooltip-set [tt-string]
}
proc append-energies {av energy power eunit punit fmt} {
upvar 1 o o
upvar 1 $av a
append o [format " ${fmt}%s / ${fmt}%s / ${fmt}%s ${fmt}%s" \
[expr { $a(${energy}_NOW) * 1e-6 }] $eunit \
[expr { $a(${energy}_FULL) * 1e-6 }] $eunit \
[expr { $a(${energy}_FULL_DESIGN) * 1e-6 }] $eunit \
[expr { $a(${power}_NOW) * 1e-6 }] $punit]
}
proc append-percents {qv} {
upvar 1 o o
upvar 1 $qv q
append o [format " %.0f%% (%.0f%%/%.0f%%)" \
[expr { $q(energy_NOW) * 100.0 / $q(energy_FULL_DESIGN) }] \
[expr { $q(energy_NOW) * 100.0 / $q(energy_FULL) }] \
[expr { $q(energy_FULL) * 100.0 / $q(energy_FULL_DESIGN) }]]
if {$q(power_NOW) < -1} {
set endpoint 0
} elseif {$q(power_NOW) > -1} {
set endpoint $q(energy_FULL)
}
if {[info exists endpoint]} {
set until [expr {($endpoint - $q(energy_NOW)) * 60.0/ $q(power_NOW)}]
if {$until < 72*60} {
append o [format " %.fmins" $until]
}
}
}
proc tt-string {} {
global errorInfo
set lines {}
if {[catch {
set dir /sys/class/power_supply
foreach f [glob -nocomplain -tails -directory $dir *] {
debug::debug "TT-INFO $f"
if {[catch {
set chan [open $dir/$f/uevent]
tt-info $chan
} info]} {
set info "error: $info"
debug::debug "$f $errorInfo"
}
lappend lines "$f: $info"
catch { close $chan }
catch { unset chan }
}
} emsg]} {
lappend lines "error scanning: $emsg"
debug::debug "scanning $errorInfo"
}
if {$nbatts} {
set o "Total: $nbatts present "
append o [join [lsort [array names states]] /]
append-energies tot energy power Wh W %.1f
append-percents tot
lappend lines $o
}
if {![llength $lines]} {
lappend lines "no power information"
}
return [join $lines "\n"]
}
proc compute {power energy factor punit eunit sign fmt} {
upvar 1 a a
upvar 1 q q
upvar 1 tot tot
upvar 1 o o
debug::debug "COMPUTE $power $energy $factor"
set energy_sign 1
set power_sign $sign
set entl {{energy NOW} {energy FULL} {energy FULL_DESIGN} {power NOW}}
foreach ent $entl {
manyset $ent pe k
set kq "${pe}_${k}"
set kv "[set $pe]_$k"
if {![info exists a($kv)]} { return 0 }
set a($kv) [expr {$a($kv) * [set "${pe}_sign"]}]
set q($kq) [expr {$a($kv) * $factor}]
}
debug::debug "COMPUTE OK [array names q]"
foreach ent $entl {
manyset $ent pe k
set kq "${pe}_${k}"
if {![info exists tot($kq)]} { set tot($kq) 0 }
set tot($kq) [expr {$tot($kq) + $q($kq)}]
}
append-energies a $energy $power $eunit $punit $fmt
append-percents q
return 1
}
proc tt-info {chan} {
upvar 1 tot tot
upvar 1 nbatts nbatts
upvar 1 states states
while {[gets $chan l] >= 0} {
if {[regexp {^POWER_SUPPLY_([A-Z0-9_]+)=(.*)$} $l dummy k v]} {
debug::debug " uevent ok $l"
set a($k) $v
} else {
debug::debug " uevent unk $l"
}
}
debug::debug "GOT [array names a]"
if {![info exists a(TYPE)]} {
set op {}
foreach k {ONLINE PRESENT} { append op [info exists a($k)] }
switch -exact $op {
10 { set a(TYPE) Mains }
01 { set a(TYPE) Battery }
default { error "no type and bad op $op" }
}
debug::debug " guessed type $a(TYPE) from ONLINE PRESENT $op"
}
set o "$a(TYPE)"
set nbatts 0
switch -exact -- $a(TYPE) {
Mains {
switch -exact -- $a(ONLINE) {
0 { append o " Offline" }
1 { append o " Online" }
default { append o " ?$o" }
}
}
Battery {
switch -exact -- $a(PRESENT) {
0 { append o " Absent"; return $o }
1 { append o " Present" }
default { apend o " ?$o" }
}
set sign 1
append o " "
switch -exact -- $a(STATUS) {
Charging { }
Discharging { set sign -1 }
default { append o "Status=" }
}
set states($a(STATUS)) 1
append o $a(STATUS)
foreach power {POWER CURRENT} energy {ENERGY CHARGE} \
punit {W A} eunit {Wh Ah} fmt {%.1f %.2f} {
switch -exact $power {
POWER { set factor 1.0 }
CURRENT { set factor [expr {$a(VOLTAGE_NOW) * 1e-6}] }
}
if {![compute $power $energy $factor \
$punit $eunit $sign $fmt]} continue
incr nbatts
}
}
}
return $o
}
#----- modes -----
proc mode/normal {} {
uplevel #0 { applet::become }
applet::setup-subproc cmdline
applet::setup-tooltip tt-show tt-invisible
}
proc mode/-tooltip-string {} {
puts [tt-string]
exit 0
}
#----- command line parsing -----
set mode normal
set usersettings $env(HOME)/.config/xbatmon-simple-tray
while {[args::next_special arg]} {
switch -exact -- $arg {
-- { break }
-tooltip-string { set mode $arg }
default { args::badoption }
}
}
if {[file exists $usersettings]} {
source $usersettings
}
mode/$mode