[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/boxy eaf82b1 1/3: initial commit
|
From: |
ELPA Syncer |
|
Subject: |
[elpa] externals/boxy eaf82b1 1/3: initial commit |
|
Date: |
Mon, 4 Oct 2021 17:57:25 -0400 (EDT) |
branch: externals/boxy
commit eaf82b180475de5efd867f557aca9d08798205c6
Author: Tyler Grinn <tylergrinn@gmail.com>
Commit: Tyler Grinn <tylergrinn@gmail.com>
initial commit
---
.gitignore | 7 +
.gitlab-ci.yml | 45 ++
Eldev | 16 +
LICENSE | 674 ++++++++++++++++++
boxy.el | 1693 ++++++++++++++++++++++++++++++++++++++++++++
tests/boxy-test-edge.el | 234 ++++++
tests/boxy-test-margin.el | 153 ++++
tests/boxy-test-padding.el | 352 +++++++++
tests/boxy-test-setup.el | 19 +
tests/boxy-test-smoke.el | 167 +++++
10 files changed, 3360 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..1368abf
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+/dist
+*.elc
+
+# Added automatically by ‘eldev init’.
+/.eldev
+/Eldev-local
+
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
new file mode 100644
index 0000000..ea1c6fb
--- /dev/null
+++ b/.gitlab-ci.yml
@@ -0,0 +1,45 @@
+stages:
+ - build
+ - release
+
+package:
+ stage: build
+ image: silex/emacs:27
+ before_script:
+ - curl -fsSL https://raw.github.com/doublep/eldev/master/webinstall/eldev
| sh
+ - export PATH=$PATH:/root/.eldev/bin
+ script:
+ - eldev lint
+ - eldev compile -W
+ - eldev test
+ - eldev package
+ - eldev md5
+ artifacts:
+ paths:
+ - dist/
+
+release:
+ stage: release
+ only:
+ - tags
+ image: registry.gitlab.com/gitlab-org/release-cli:latest
+ dependencies:
+ - package
+ variables:
+ DIST_DIR: $CI_PROJECT_URL/-/jobs/$CI_JOB_ID/artifacts/raw/dist
+ FILENAME_BASE: $CI_PROJECT_NAME-$CI_COMMIT_TAG
+ release:
+ tag_name: $CI_COMMIT_TAG
+ description: $CI_COMMIT_DESCRIPTION
+ assets:
+ links:
+ - name: $FILENAME_BASE.el
+ url: $DIST_DIR/$FILENAME_BASE.el
+ - name: $FILENAME_BASE.md5
+ url: $DIST_DIR/$FILENAME_BASE.md5
+ script:
+ - echo Release job
+ artifacts:
+ paths:
+ - dist/
+ expire_in: never
diff --git a/Eldev b/Eldev
new file mode 100644
index 0000000..1f799d8
--- /dev/null
+++ b/Eldev
@@ -0,0 +1,16 @@
+; -*- mode: emacs-lisp; lexical-binding: t -*-
+
+(eldev-add-loading-roots 'test "tests")
+
+(eldev-defcommand
+ boxy-md5 (&rest _)
+ "Create md5 checksum of .tar and .el files in dist folder."
+ (mapc
+ (lambda (file)
+ (write-region
+ (secure-hash 'md5 file)
+ nil
+ (concat (file-name-sans-extension file) ".md5")))
+ (append
+ (directory-files eldev-dist-dir t "\\.tar\\'")
+ (directory-files eldev-dist-dir t "\\.el\\'"))))
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e72bfdd
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
\ No newline at end of file
diff --git a/boxy.el b/boxy.el
new file mode 100644
index 0000000..0804d9c
--- /dev/null
+++ b/boxy.el
@@ -0,0 +1,1693 @@
+;;; boxy.el --- Frontend for creating 3D diagrams -*- lexical-binding: t -*-
+
+;; Copyright (C) 2021 Free Software Foundation, Inc.
+
+;; Author: Tyler Grinn <tylergrinn@gmail.com>
+;; Version: 1.0.0
+;; File: boxy.el
+;; Package-Requires: ((emacs "26.1"))
+;; Keywords: tools
+;; URL: https://gitlab.com/tygrdev/boxy.el
+
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; Boxy provides an interface to create a 3D representation of
+;; boxes. Each box has a relationship with one other box. Multiple
+;; boxes can be related to one box. The relationship can be any of
+;; the following:
+;;
+;; - in
+;; - on
+;; - behind
+;; - on top of
+;; - in front of
+;; - above
+;; - below
+;; - to the right of
+;; - to the left of
+;;
+;; The relationship determines the ordering and structure of the
+;; resulting boxy diagram.
+;;
+;; Only boxes which have their :name slot set will be drawn to the
+;; buffer. Boxes without names still take up space and can have
+;; children, so can be used for grouping. All diagrams have one top
+;; level unnamed box called a `world'.
+;;
+;; Each box should have either a list of markers or an action
+;; function. When viewing a box that has a list of markers, the
+;; following keybindings are available:
+;;
+;; RET/mouse-1 - Jump to the first marker
+;; o - Open next marker in other window.
+;; Pressed multiple times, cycle through markers.
+;; M-RET - Open all markers as separate buffers.
+;; This will split the current window as needed.
+;;
+;; When viewing a box with an action function, RET and <mouse-1>
+;; will be bound to that function.
+;;
+;; Additionally, all boxes have the following keybindings defined:
+;;
+;; r - Jump to the box directly related to the current box.
+;; Repeated presses will eventually take you to the
+;; top level box.
+;; TAB - Cycle visibility of box's children
+;;
+;; See the class definition for `boxy-box' for all other available
+;; properties.
+;;
+;; To start, create an empty box named `world'.
+;;
+;; (let ((world (boxy-box)))
+;;
+;; Use the method `boxy-add-next' to add top-level boxes to the
+;; world, without relationships:
+;;
+;; (let ((cyprus (boxy-box :name "Cyprus"))
+;; (greece (boxy-box :name "Greece")))
+;; (boxy-add-next cyprus world)
+;; (boxy-add-next greece world)
+;;
+;; To ease the boxy renderer, use the :expand-siblings and
+;; :expand-children slots. These should be list of functions which
+;; take the current box as an argument and call `boxy-add-next' to
+;; add sibling boxes and children boxes respectively. Children
+;; boxes are defined as any box with a relationship of in, on,
+;; behind, in front of, or on top of. Sibling boxes are defined as
+;; any box with a relationship of above, below, to the left of, or
+;; to the right of.
+;;
+;; (object-add-to-list cyprus :expand-siblings
+;; '(lambda (box)
+;; (boxy-add-next
+;; (boxy-box :name "Lebanon" :rel "below")
+;; box)))
+;;
+;; The expansion slots will be called when the user toggles the
+;; box's visibility.
+;;
+;; The methods `boxy-merge' and `boxy-merge-into' should be
+;; used to merge boxes together. `boxy-merge' takes a list of
+;; boxes and merges them into one box. `boxy-merge-into' takes
+;; two boxes and merges the first into the second.
+;;
+;;; Code:
+
+;;;; Requirements
+
+(require 'eieio)
+(require 'cl-lib)
+
+;;;; Options
+
+(defgroup boxy nil
+ "Customization options for boxy"
+ :group 'applications)
+
+(defcustom boxy-default-margin-x 2
+ "Default horizontal margin to be used when displaying boxes."
+ :type 'number
+ :group 'boxy)
+
+(defcustom boxy-default-margin-y 1
+ "Default vertical margin to be used when displaying boxes."
+ :type 'number
+ :group 'boxy)
+
+(defcustom boxy-default-padding-x 2
+ "Default horizontal padding to be used when displaying boxes."
+ :type 'number
+ :group 'boxy)
+
+(defcustom boxy-default-padding-y 1
+ "Default vertical padding to be used when displaying boxes."
+ :type 'number
+ :group 'boxy)
+
+(defcustom boxy-flex-width 80
+ "When flexibly displaying boxes, try to keep width below this."
+ :type 'number
+ :group 'boxy)
+
+(defcustom boxy-default-visibility 2
+ "Default level to display boxes."
+ :type 'number
+ :group 'boxy)
+
+(defcustom boxy-tooltips t
+ "Show tooltips in a boxy diagram."
+ :type 'boolean
+ :group 'boxy)
+
+(defcustom boxy-tooltip-timeout 0.5
+ "Idle time before showing tooltip in a boxy diagram."
+ :type 'number
+ :group 'boxy)
+
+(defcustom boxy-tooltip-max-width 30
+ "Maximum width of all tooltips."
+ :type 'number
+ :group 'boxy)
+
+;;;; Faces
+
+(defface boxy-default nil
+ "Default face used in Boxy mode."
+ :group 'boxy)
+
+(defface boxy-primary nil
+ "Face for highlighting the name of a box."
+ :group 'boxy)
+
+(face-spec-set
+ 'boxy-primary
+ '((((background dark)) (:foreground "turquoise"))
+ (t (:foreground "dark cyan")))
+ 'face-defface-spec)
+
+(defface boxy-selected nil
+ "Face for the current box border under cursor."
+ :group 'boxy)
+
+(face-spec-set
+ 'boxy-selected
+ '((t :foreground "light slate blue"))
+ 'face-defface-spec)
+
+(defface boxy-rel nil
+ "Face for the box which is related to the box under the cursor."
+ :group 'boxy)
+
+(face-spec-set
+ 'boxy-rel
+ '((t :foreground "hot pink"))
+ 'face-defface-spec)
+
+(defface boxy-tooltip nil
+ "Face for tooltips in a boxy diagram."
+ :group 'boxy)
+
+(face-spec-set
+ 'boxy-tooltip
+ '((((background dark)) (:background "gray30" :foreground "gray"))
+ (t (:background "gainsboro" :foreground "dim gray")))
+ 'face-defface-spec)
+
+;;;; Constants
+
+(defconst boxy-relationships
+ '("in" "on" "behind" "in front of" "above" "below" "to the left of" "to the
right of" "on top of")
+ "List of available relationships for boxes.")
+
+(defconst boxy-children-relationships
+ '("in" "on" "behind" "in front of" "on top of")
+ "List of relationships which are rendered as children.")
+
+(defconst boxy-sibling-relationships
+ '("above" "below" "to the left of" "to the right of")
+ "List of relationships which are rendered as siblings.")
+
+(defconst boxy-flex-relationships
+ '("in" "on" "behind")
+ "List of relationships for which boxes are flexibly added to their parent.")
+
+;;;; Custom types
+
+(defun boxy-relationshipp (str)
+ "Return t if STR is a boxy relationship, nil otherwise."
+ (member str boxy-relationships))
+
+;;;; Boxy mode
+
+(defvar-local boxy--box-ring '()
+ "List of buffer positions of buttons in a boxy diagram.")
+
+(defvar-local boxy--world nil
+ "Current top-level box the buffer is displaying.")
+
+(defvar-local boxy--boxes '()
+ "All boxes currently in a boxy diagram.")
+
+(defvar-local boxy--header '()
+ "Current containers the buffer is displaying.")
+
+(defvar-local boxy--offset '(0 . 0)
+ "Current offset in row-column order for the boxy diagram.")
+
+(defvar-local boxy--visibility boxy-default-visibility
+ "Visibility of children in the current boxy diagram.")
+
+(defvar-local boxy--max-visibility 3
+ "Maximum visibility setting allowed when cycling all children.")
+
+(defvar-local boxy--default-margin-x boxy-default-margin-x
+ "Default horizontal margin to be used when displaying-boxes.")
+
+(defvar-local boxy--default-margin-y boxy-default-margin-y
+ "Default vertical margin to be used when displaying boxes.")
+
+(defvar-local boxy--default-padding-x boxy-default-padding-x
+ "Default horizontal padding to be used when displaying boxes.")
+
+(defvar-local boxy--default-padding-y boxy-default-padding-y
+ "Default vertical padding to be used when displaying boxes.")
+
+(defvar-local boxy--flex-width boxy-flex-width
+ "When flexibly displaying boxes, try to keep width below this.")
+
+(defvar-local boxy--default-visibility boxy-default-visibility
+ "Default level to display boxes.")
+
+(defvar-local boxy--tooltips boxy-tooltips
+ "Show tooltips in a boxy diagram.")
+
+(defvar-local boxy--tooltip-timeout boxy-tooltip-timeout
+ "Idle time before showing tooltip in a boxy diagram.")
+
+(defvar-local boxy--tooltip-max-width boxy-tooltip-max-width
+ "Maximum width of all tooltips.")
+
+(defvar-local boxy--default-face 'boxy-default
+ "Face to use when drawing boxes.")
+
+(defvar-local boxy--tooltip-face 'boxy-tooltip
+ "Face to use when drawing tooltips.")
+
+(defvar-local boxy--primary-face 'boxy-primary
+ "Face to use when highlighting a box's name.")
+
+(defvar-local boxy--selected-face 'boxy-selected
+ "Face to use for highlighting the currently selected box.")
+
+(defvar-local boxy--rel-face 'boxy-rel
+ "Face to use for highlighting the box directly related to the selected box.")
+
+(defun boxy-mode-cycle ()
+ "Cycle through buttons in the current boxy buffer."
+ (interactive)
+ (if-let ((pos (seq-find (lambda (pos) (> pos (point))) boxy--box-ring)))
+ (goto-char pos)))
+
+(defun boxy-mode-uncycle ()
+ "Cycle through buttons in the current boxy buffer in reverse."
+ (interactive)
+ (if-let ((pos (seq-find (lambda (pos) (< pos (point))) (reverse
boxy--box-ring))))
+ (goto-char pos)))
+
+(defun boxy-mode-cycle-down ()
+ "Cycle to the next button on the row below."
+ (interactive)
+ (let ((coords (cons (line-number-at-pos) (current-column))))
+ (goto-char (seq-reduce
+ (lambda (closest pos)
+ (goto-char pos)
+ (if (<= (line-number-at-pos) (car coords))
+ closest
+ (let* ((pos-coords (cons (line-number-at-pos)
(current-column)))
+ (pos-dist (sqrt (+ (expt (- (car pos-coords) (car
coords)) 2)
+ (expt (- (cdr pos-coords) (cdr
coords)) 2))))
+ (closest-coords (and (goto-char closest) (cons
(line-number-at-pos) (current-column))))
+ (closest-dist (sqrt (+ (expt (- (car
closest-coords) (car coords)) 2)
+ (expt (- (cdr
closest-coords) (cdr coords)) 2)))))
+ (if (< pos-dist closest-dist)
+ pos
+ closest))))
+ boxy--box-ring
+ (point-max)))))
+
+(defun boxy-mode-cycle-up ()
+ "Cycle to the next button on the row above."
+ (interactive)
+ (let ((coords (cons (line-number-at-pos) (current-column))))
+ (goto-char (seq-reduce
+ (lambda (closest pos)
+ (goto-char pos)
+ (if (>= (line-number-at-pos) (car coords))
+ closest
+ (let* ((pos-coords (cons (line-number-at-pos)
(current-column)))
+ (pos-dist (sqrt (+ (expt (- (car pos-coords) (car
coords)) 2)
+ (expt (- (cdr pos-coords) (cdr
coords)) 2))))
+ (closest-coords (and (goto-char closest) (cons
(line-number-at-pos) (current-column))))
+ (closest-dist (sqrt (+ (expt (- (car
closest-coords) (car coords)) 2)
+ (expt (- (cdr
closest-coords) (cdr coords)) 2)))))
+ (if (< pos-dist closest-dist)
+ pos
+ closest))))
+ boxy--box-ring
+ (point-min)))))
+
+(defun boxy-mode-cycle-visibility ()
+ "Cycle visibility on all children in the current buffer."
+ (interactive)
+ (setq boxy--visibility (mod (+ 1 boxy--visibility)
+ (+ 1 boxy--max-visibility)))
+ (if (= 0 boxy--visibility)
+ (setq boxy--visibility 1))
+ (cond
+ ((= 1 boxy--visibility) (message "OVERVIEW"))
+ ((= 2 boxy--visibility) (message "CONTENTS"))
+ ((= 3 boxy--visibility) (message "MORE CONTENTS")))
+ (boxy-mode-update-visibility)
+ (boxy-mode-redraw))
+
+(defun boxy-mode-redraw ()
+ "Redraw `boxy--world' in the current buffer."
+ (let ((inhibit-read-only t))
+ (erase-buffer)
+ (when boxy--header
+ (insert boxy--header)
+ (fill-paragraph)
+ (insert "\n"))
+ (setq boxy--offset (cons (- (line-number-at-pos)
+ 2
+ (* 2 (boxy--padding-y boxy--world)))
+ (- 0 1 (boxy--padding-x boxy--world))))
+ (boxy-draw boxy--world)
+ (boxy-mode-recalculate-box-ring)
+ (goto-char (point-max))
+ (insert "\n")
+ (goto-char (point-min))))
+
+(defun boxy-mode-reset-boxes ()
+ "Set `boxy--boxes' to be a list of all boxes in the current boxy diagram."
+ (setq boxy--boxes (boxy--get-all boxy--world)))
+
+(defun boxy-mode-recalculate-box-ring ()
+ "Recalculate the position of all boxes in `boxy--boxes'."
+ (setq boxy--box-ring
+ (seq-sort
+ '<
+ (seq-filter
+ 'identity
+ (mapcar
+ 'boxy--get-position
+ (seq-filter
+ (lambda (box) (boxy-is-visible box t))
+ boxy--boxes))))))
+
+(defun boxy-mode-update-visibility ()
+ "Update visibility of all boxes in `boxy--boxes'."
+ (boxy--update-visibility boxy--world)
+ (boxy-mode-reset-boxes)
+ (boxy--flex-adjust boxy--world boxy--world))
+
+(defun boxy-mode-make-dirty ()
+ "Clear all TOP LEFT WIDTH and HEIGHT coordinates from `boxy--boxes'."
+ (mapc
+ (lambda (box)
+ (if (slot-boundp box :top) (slot-makeunbound box :top))
+ (if (slot-boundp box :left) (slot-makeunbound box :left))
+ (if (slot-boundp box :width) (slot-makeunbound box :width))
+ (if (slot-boundp box :height) (slot-makeunbound box :height)))
+ boxy--boxes))
+
+(define-derived-mode boxy-mode special-mode
+ "Boxy"
+ "Mode for viewing an boxy diagram.
+
+The following commands are available:
+
+\\{boxy-mode-map}"
+ (let ((inhibit-message t))
+ (setq indent-tabs-mode nil)
+ (cursor-sensor-mode t)
+ (toggle-truncate-lines t)))
+
+(mapc
+ (lambda (key) (define-key boxy-mode-map (kbd (car key)) (cdr key)))
+ '(("TAB" . boxy-mode-cycle)
+ ("<right>" . boxy-mode-cycle)
+ ("C-f" . boxy-mode-cycle)
+ ("M-f" . boxy-mode-cycle)
+ ("f" . boxy-mode-cycle)
+ ("<left>" . boxy-mode-uncycle)
+ ("C-b" . boxy-mode-uncycle)
+ ("M-b" . boxy-mode-uncycle)
+ ("b" . boxy-mode-uncycle)
+ ("<up>" . boxy-mode-cycle-up)
+ ("C-p" . boxy-mode-cycle-up)
+ ("p" . boxy-mode-cycle-up)
+ ("<down>" . boxy-mode-cycle-down)
+ ("C-n" . boxy-mode-cycle-down)
+ ("n" . boxy-mode-cycle-down)
+ ("<backtab>" . boxy-mode-cycle-visibility)))
+
+
+(cl-defun boxy-pp (box
+ &key
+ (display-buffer-fn 'display-buffer-pop-up-window)
+ (visibility boxy-default-visibility)
+ (max-visibility 3)
+ select
+ header
+ (default-margin-x boxy-default-margin-x)
+ (default-margin-y boxy-default-margin-y)
+ (default-padding-x boxy-default-padding-x)
+ (default-padding-y boxy-default-padding-y)
+ (flex-width boxy-flex-width)
+ (tooltips boxy-tooltips)
+ (tooltip-timeout boxy-tooltip-timeout)
+ (tooltip-max-width boxy-tooltip-max-width)
+ (default-face 'boxy-default)
+ (primary-face 'boxy-primary)
+ (tooltip-face 'boxy-tooltip)
+ (rel-face 'boxy-rel)
+ (selected-face 'boxy-selected))
+ "Pretty print BOX in a popup buffer.
+
+If HEADER is passed in, it will be printed above the diagram.
+
+DISPLAY-BUFFER-FN is used to display the diagram, by
+default `display-buffer-pop-up-window'.
+
+If SELECT is non-nil, select the boxy window after displaying
+it.
+
+VISIBILITY is the initial visibility of children and
+MAX-VISIBILITY is the maximum depth to display when cycling
+visibility.
+
+DEFAULT-MARGIN-X, DEFAULT-MARGIN-Y, DEFAULT-PADDING-X and
+DEFAULT-PADDING-Y will be the fallback values to use if a box's
+margin and padding slots are not set.
+
+When adding boxes, boxy will try to keep the width below
+FLEX-WIDTH.
+
+If TOOLTIPS is nil, don't show any tooltips.
+
+TOOLTIP-TIMEOUT is the idle time to wait before showing a
+tooltip.
+
+TOOLTIP-MAX-WIDTH is the maximum width of a tooltip. Lines
+longer than this will be truncated.
+
+DEFAULT-FACE, PRIMARY-FACE, TOOLTIP-FACE, REL-FACE, and
+SELECTED-FACE can be set to change the appearance of the boxy
+diagram."
+ (when-let ((buffer (get-buffer "*Boxy*")))
+ (kill-buffer buffer)
+ (if-let ((window (get-buffer-window buffer t)))
+ (delete-window window)))
+ (let ((buffer (get-buffer-create "*Boxy*")))
+ (with-current-buffer buffer
+ (boxy-mode)
+ (setq boxy--header header)
+ (setq boxy--world box)
+ (setq boxy--visibility visibility)
+ (setq boxy--max-visibility max-visibility)
+ (setq boxy--default-margin-x default-margin-x)
+ (setq boxy--default-margin-y default-margin-y)
+ (setq boxy--default-padding-x default-padding-x)
+ (setq boxy--default-padding-y default-padding-y)
+ (setq boxy--flex-width flex-width)
+ (setq boxy--tooltips tooltips)
+ (setq boxy--tooltip-timeout tooltip-timeout)
+ (setq boxy--tooltip-max-width tooltip-max-width)
+ (setq boxy--default-face default-face)
+ (setq boxy--primary-face primary-face)
+ (setq boxy--tooltip-face tooltip-face)
+ (setq boxy--rel-face rel-face)
+ (setq boxy--selected-face selected-face)
+ (boxy-mode-update-visibility)
+ (boxy-mode-redraw)
+ (let* ((width (apply 'max (mapcar 'length (split-string (buffer-string)
"\n"))))
+ (height (count-lines (point-min) (point-max)))
+ (window (or (get-buffer-window buffer)
+ (display-buffer buffer
+ `(,display-buffer-fn
+ (window-width . ,width)
+ (window-height . ,height))))))
+ (if select (select-window window))))))
+
+
+;;;; Class definitions and public methods
+
+(defclass boxy-box ()
+ ((name :initarg :name
+ :type string
+ :documentation "The name of the box to be displayed. If
+not set, the box will not be drawn to the buffer.")
+ (rel :initarg :rel
+ :type boxy-relationship
+ :documentation "The relationship between this box and
+its rel-box. Must be a member of `boxy-relationships'")
+ (primary :initarg :primary
+ :initform nil
+ :type boolean
+ :documentation "Whether to apply the `boxy-primary'
+face to the box's name.")
+ (action :initarg :action
+ :type command
+ :documentation "A command executed when this box is
+clicked. If not set, use :markers.")
+ (markers :initarg :markers
+ :type list
+ :documentation "A list of buffer markers that this
+box should link back to when clicked.")
+ (tooltip :initarg :tooltip
+ :type string
+ :documentation "A tooltip to be displayed when the
+cursor is within the box's name.
+
+Each line will be truncated to `boxy-tooltip-max-width'")
+ (help-echo :initarg :help-echo
+ :type string
+ :documentation "A string to be displayed in the
+minibuffer when the cursor is within the box's name.")
+ (expand-siblings :initarg :expand-siblings
+ :type list
+ :initform '()
+ :documentation "A list of functions which add
+siblings to this box using the function `boxy-add-next'.")
+ (expand-children :initarg :expand-children
+ :type list
+ :initform '()
+ :documentation "A list of functions which add
+children to this box using the function `boxy-add-next'.")
+ (padding-x :initarg :padding-x
+ :type number
+ :documentation "Override default horizontal padding
+for this box and its children.")
+ (padding-y :initarg :padding-y
+ :type number
+ :documentation "Override default vertical padding
+for this box and its children.")
+ (margin-x :initarg :margin-x
+ :type number
+ :documentation "Override default horizontal margin
+for this box and its children.")
+ (margin-y :initarg :margin-y
+ :type number
+ :documentation "Override default vertical margin for
+this box and its children.")
+ (rel-box :initarg :rel-box
+ :type boxy-box
+ :documentation "The box directly related to this box.
+
+Usually set using the functions `boxy-add-next',
+`boxy-merge-boxes', or `boxy-merge-into'")
+ (display-rel :initarg :display-rel
+ :type string
+ :documentation "If relationship is changed during
+creation of the box, the original relationship
+will be saved here for display purposes.")
+ (display-rel-box :initarg :display-rel-box
+ :type boxy-box
+ :documentation "If the relationship is
+changed during the creation of the box, the original rel-box is
+saved here for display purposes.")
+ (x-order :initarg :x-order
+ :initform 0
+ :type number
+ :documentation "Relative horizontal ordering of box
+within its parent.")
+ (y-order :initarg :y-order
+ :initform 0
+ :type number
+ :documentation "Relative vertical ordering of box
+within its parent.")
+ (in-front :initarg :in-front
+ :initform nil
+ :type boolean
+ :documentation "Whether the box should be rendered
+in front of its parent box.")
+ (behind :initarg :behind
+ :initform nil
+ :type boolean
+ :documentation "Whether the box should be rendered as
+behind its parent box.")
+ (on-top :initarg :on-top
+ :initform nil
+ :type boolean
+ :documentation "Whether the box should be rendered as
+on top of its parent box.")
+ (parent :initarg :parent
+ :type boxy-box
+ :documentation "The parent of this box.")
+ (children :initarg :children
+ :initform '()
+ :type list
+ :documentation "The visible children of this box.")
+ (hidden-children :initarg :hidden-children
+ :initform '()
+ :type list
+ :documentation "The hidden children of this box.")
+ (level :initarg :level
+ :initform 0
+ :type number
+ :documentation "Number of nested generations this box
+is currently at.")
+ (top :initarg :top
+ :type number
+ :documentation "Calculated top row for this box.")
+ (left :initarg :left
+ :type number
+ :documentation "Calculated left column for this box.")
+ (width :initarg :width
+ :type number
+ :documentation "Calculated width of this box.")
+ (height :initarg :height
+ :type number
+ :documentation "Calculated height of this box.")
+ (flex :initarg :flex
+ :initform nil
+ :type boolean
+ :documentation "Whether or not this box should be
+flexibly added to its parent. Should not be set manually."))
+ "A representation of a box in 3D space.")
+
+(cl-defmethod boxy-merge (boxes)
+ "Merge BOXES into a single box."
+ (if (< (length boxes) 2)
+ (if (= 0 (length boxes))
+ (boxy-box)
+ (car boxes))
+ (let ((world (boxy-box)))
+ (while boxes
+ (boxy-merge-into (pop boxes) world))
+ world)))
+
+(cl-defmethod boxy-merge-into ((from boxy-box) (to boxy-box))
+ "Merge FROM box into TO box."
+ (let (match-found)
+ (mapc
+ (lambda (from-box)
+ (let ((match (boxy-find-matching from-box to)))
+ (while (and (not match) (slot-boundp from-box :rel-box))
+ (setq from-box (with-slots (rel-box) from-box rel-box))
+ (setq match (boxy-find-matching from-box to)))
+ (when match
+ (setq match-found t)
+ (boxy--add-matching from-box match))))
+ (boxy--primary-boxes from))
+ (unless match-found
+ (let ((all-from-children (boxy--get-children from 'all)))
+ (if (= 1 (length all-from-children))
+ (progn
+ (oset (car all-from-children) :flex t)
+ (boxy--add-child to (car all-from-children)))
+ (oset from :flex t)
+ (boxy--add-child to from))))))
+
+(cl-defmethod boxy-is-visible ((box boxy-box) &optional calculate)
+ "Determine if BOX is visible according to `boxy--visibility'.
+
+If CALCULATE, determine if the box has been expanded manually."
+ (if calculate
+ (if (not (slot-boundp box :parent))
+ t
+ (with-slots (parent) box
+ (seq-find
+ (lambda (sibling) (eq sibling box))
+ (boxy--get-children parent))))
+ (with-slots (level) box
+ (or (= 0 boxy--visibility)
+ (<= level boxy--visibility)))))
+
+
+(cl-defmethod boxy-jump-to-box ((box boxy-box))
+ "Jump cursor to the first character in the label of BOX."
+ (if (not (boxy-is-visible box t))
+ (let ((top (with-slots (parent) box parent)))
+ (boxy--cycle-children top)
+ (while (not (boxy-is-visible top t))
+ (setq top (with-slots (parent) top parent))
+ (boxy--cycle-children top))
+ (boxy-mode-reset-boxes)
+ (boxy--flex-adjust top (boxy--get-world top))
+ (boxy-mode-redraw)
+ (run-with-timer 0 nil
+ (lambda ()
+ (let ((top (boxy--get-top box))
+ (left (boxy--get-left box)))
+ (forward-line (- (+ (car boxy--offset) top 1
(boxy--padding-y box))
+ (line-number-at-pos)))
+ (move-to-column (+ (cdr boxy--offset) left 1
(boxy--padding-x box)))))))
+ (let ((top (boxy--get-top box))
+ (left (boxy--get-left box)))
+ (forward-line (- (+ (car boxy--offset) top 1 (boxy--padding-y box))
+ (line-number-at-pos)))
+ (move-to-column (+ (cdr boxy--offset) left 1 (boxy--padding-x box))))))
+
+
+(cl-defmethod boxy-find-matching ((search-box boxy-box) (world boxy-box))
+ "Find a box in WORLD with a matching name as SEARCH-BOX."
+ (when (slot-boundp search-box :name)
+ (with-slots ((search-name name)) search-box
+ (seq-find
+ (lambda (box)
+ (and (slot-boundp box :name)
+ (string= search-name
+ (with-slots (name) box name))))
+ (boxy--expand world)))))
+
+(cl-defmethod boxy-add-next ((next boxy-box)
+ (prev boxy-box)
+ &optional force-visible skip-next)
+ "Add NEXT to world according to its relationship to PREV.
+
+If FORCE-VISIBLE, show the box regardless of
+`boxy--visibility'
+
+If SKIP-NEXT, don't add expansion slots for boxes related to
+NEXT."
+ (if-let ((match (boxy-find-matching next prev)))
+ (boxy--add-matching next match)
+ (with-slots
+ (children
+ hidden-children
+ (prev-level level)
+ (prev-primary primary)
+ (prev-behind behind)
+ (prev-in-front in-front)
+ (prev-on-top on-top))
+ prev
+ (with-slots
+ (rel
+ rel-box
+ flex
+ display-rel
+ display-rel-box
+ (next-level level)
+ (next-behind behind)
+ (next-in-front in-front)
+ (next-on-top on-top))
+ next
+ (if (not (slot-boundp prev :parent))
+ (progn
+ (setq flex t)
+ (setq next-level (+ 1 prev-level))
+ (boxy--add-child prev next force-visible))
+ (let ((parent (with-slots (parent) prev parent)))
+ (if (slot-boundp next :display-rel-box)
+ (setq display-rel-box
+ (boxy-find-matching
+ display-rel-box
+ (boxy--get-world prev))))
+ (if (string= rel "on top of")
+ (setq next-on-top t))
+ (if (string= rel "in front of")
+ (setq next-in-front t))
+ (let* ((next-boxes (boxy--next next))
+ (partitioned (seq-group-by
+ (lambda (next-next)
+ (with-slots (rel) next-next
+ (if (member rel
boxy-children-relationships)
+ 'children
+ 'siblings)))
+ next-boxes))
+ (children-boxes (alist-get 'children partitioned))
+ (sibling-boxes (alist-get 'siblings partitioned))
+ update-visibility)
+ (if-let ((match (boxy-find-matching next prev)))
+ (boxy--add-matching next match)
+ (cond
+ ((member rel '("to the left of" "to the right of"))
+ (setq next-level prev-level)
+ (setq next-behind prev-behind)
+ (setq next-in-front prev-in-front)
+ (setq next-on-top prev-on-top))
+ ((member rel '("above" "below"))
+ (setq next-behind prev-behind)
+ (cond
+ ((and prev-in-front (string= rel "below"))
+ (setq update-visibility t)
+ (setq display-rel-box prev)
+ (while (with-slots (in-front) prev in-front)
+ (setq prev (with-slots (parent) prev parent)))
+ (setq parent (with-slots (parent) prev parent))
+ (setq next-level (with-slots (level) prev level)))
+ ((and prev-on-top (string= rel "above"))
+ (setq update-visibility t)
+ (setq display-rel-box prev)
+ (while (with-slots (on-top) prev on-top)
+ (setq prev (with-slots (parent) prev parent)))
+ (setq parent (with-slots (parent) prev parent))
+ (setq next-level (with-slots (level) prev level)))
+ ((and prev-on-top (string= rel "below"))
+ (setq update-visibility t)
+ (setq display-rel rel)
+ (setq display-rel-box prev)
+ (setq rel "in")
+ (setq prev parent)
+ (setq next-level (+ 1 (with-slots (level) prev level))))
+ (t
+ (setq next-level prev-level))))
+ ((or next-on-top next-in-front)
+ (setq next-level (+ 1 prev-level))
+ (setq next-behind prev-behind))
+ ((member rel '("in" "on"))
+ (setq flex t)
+ (setq next-behind prev-behind)
+ (setq next-level (+ 1 prev-level)))
+ ((string= rel "behind")
+ (setq flex t)
+ (setq next-level (+ 1 prev-level))
+ (setq next-behind t)))
+ (oset next :rel-box prev)
+ (if (member rel boxy-children-relationships)
+ (boxy--add-child prev next force-visible)
+ (boxy--add-child parent next force-visible))
+ (unless skip-next
+ (if children-boxes
+ (object-add-to-list next :expand-children
+ `(lambda (box)
+ (mapc
+ (lambda (child) (boxy-add-next
child box))
+ ',children-boxes))))
+ (if sibling-boxes
+ (object-add-to-list next :expand-siblings
+ `(lambda (box)
+ (mapc
+ (lambda (sibling)
+ (boxy-add-next sibling box t))
+ ',sibling-boxes))))
+ (if update-visibility (boxy--update-visibility
(boxy--get-world prev))))))))))))
+
+;;;; Drawing
+
+(cl-defmethod boxy-draw ((box boxy-box) &optional border-face)
+ "Insert an ascii drawing of BOX into the current buffer.
+
+If BORDER-FACE is non-nil, skip drawing children boxes and only
+update text properties on the border. If BORDER-FACE is t, use
+the `boxy-default' face, otherwise, use BORDER-FACE.
+
+Uses `boxy--offset' to determine row and column offsets."
+ (let (box-coords)
+ (with-slots
+ (name
+ behind
+ in-front
+ on-top
+ (dashed behind)
+ primary
+ markers
+ hidden-children
+ expand-children)
+ box
+ (when (slot-boundp box :name)
+ (let* ((top (+ (car boxy--offset) (boxy--get-top box)))
+ (left (+ (cdr boxy--offset) (boxy--get-left box)))
+ (width (boxy--get-width box))
+ (height (boxy--get-height box))
+ (double (or hidden-children expand-children))
+ (align-bottom (or in-front on-top)))
+ (cl-flet* ((draw (coords str)
+ (forward-line (- (car coords) (line-number-at-pos)))
+ (when (< (line-number-at-pos) (car coords))
+ (insert (make-string (- (car coords)
(line-number-at-pos)) ?\n)))
+ (move-to-column (cdr coords) t)
+ (if border-face
+ (put-text-property (point) (+ (length str)
(point))
+ 'face (if (eq border-face t)
+ boxy--default-face
+ border-face))
+ (put-text-property 0 (length str)
+ 'face boxy--default-face
+ str)
+ (insert str)
+ (let ((remaining-chars (- (save-excursion
(end-of-line) (current-column))
+ (current-column))))
+ (delete-char (min (length str)
remaining-chars)))))
+ (draw-name (coords str)
+ (when (not border-face)
+ (forward-line (- (car coords)
(line-number-at-pos)))
+ (when (< (line-number-at-pos) (car coords))
+ (insert (make-string (- (car coords)
(line-number-at-pos)) ?\n)))
+ (move-to-column (cdr coords) t)
+ (setq box-coords coords)
+ (put-text-property 0 (length str)
+ 'face (if primary
+
boxy--primary-face
+
boxy--default-face)
+ str)
+ (put-text-property 0 (length str)
+ 'cursor-sensor-functions
+ (list
(boxy-button-cursor-sensor box))
+ str)
+ (insert-button str
+ 'help-echo "Jump to first
occurence"
+ 'keymap
(boxy-button-create-keymap box))
+ (let ((remaining-chars (- (save-excursion
(end-of-line)
+
(current-column))
+ (current-column))))
+ (delete-char (min (length str)
remaining-chars))))))
+ (draw (cons top left)
+ (concat (cond ((and double dashed) "┏")
+ (double "╔")
+ (t "╭"))
+ (make-string (- width 2) (cond ((and double dashed)
#x2505)
+ (dashed #x254c)
+ (double #x2550)
+ (t #x2500)))
+ (cond ((and double dashed) "┓")
+ (double "╗")
+ (t "╮"))))
+ (if align-bottom
+ (draw (cons (+ top height) left)
+ (concat (cond ((and double dashed) "┸")
+ (double "╨")
+ (t "┴"))
+ (make-string (- width 2) (cond (dashed #x254c)
+ (t #x2500)))
+ (cond ((and double dashed) "┸")
+ (double "╨")
+ (t "┴"))))
+ (draw (cons (+ top height -1) left)
+ (concat (cond ((and double dashed) "┗")
+ (double "╚")
+ (t "╰"))
+ (make-string (- width 2) (cond ((and double
dashed) #x2505)
+ (dashed #x254c)
+ (double #x2550)
+ (t #x2500)))
+ (cond ((and double dashed) "┛")
+ (double "╝")
+ (t "╯")))))
+ (draw-name (cons (+ top 1 (boxy--padding-y box))
+ (+ left 1 (boxy--padding-x box)))
+ name)
+ (let ((r (+ top 1))
+ (c1 left)
+ (c2 (+ left width -1)))
+ (dotimes (_ (- height (if align-bottom 1 2)))
+ (draw (cons r c1) (cond ((and double dashed) "┇")
+ (dashed "╎")
+ (double "║")
+ (t "│")))
+ (draw (cons r c2) (cond ((and double dashed) "┇")
+ (dashed "╎")
+ (double "║")
+ (t "│")))
+ (setq r (+ r 1))))))))
+ (if border-face
+ (if box-coords (list box-coords) nil)
+ (apply 'append
+ (if box-coords (list box-coords) nil)
+ (mapcar
+ 'boxy-draw
+ (boxy--get-children box))))))
+
+(cl-defmethod boxy--get-width ((box boxy-box))
+ "Get the width of BOX."
+ (with-slots ((stored-width width)) box
+ (if (slot-boundp box :width)
+ stored-width
+ (let* ((margin (boxy--margin-x box))
+ (padding (boxy--padding-x box))
+ (base-width (+ 2 ; box walls
+ (* 2 padding)))
+ (width (+ base-width
+ (if (slot-boundp box :name)
+ (with-slots (name) box (length name))
+ 0)))
+ (children (boxy--get-children box)))
+ (if (not children)
+ (setq stored-width width)
+ (let* ((row-indices (cl-delete-duplicates
+ (mapcar
+ (lambda (child) (with-slots (y-order) child
y-order))
+ children)))
+ (rows (mapcar
+ (lambda (r)
+ (cl-delete-duplicates
+ (seq-filter
+ (lambda (child) (with-slots (y-order) child (= r
y-order)))
+ children)
+ :test #'(lambda (a b)
+ (and (slot-boundp a :name)
+ (slot-boundp b :name)
+ (string= (with-slots (name) a name)
+ (with-slots (name) b
name))))))
+ row-indices))
+ (children-width (apply 'max
+ (mapcar
+ (lambda (row)
+ (seq-reduce
+ (lambda (sum width)
+ (+ sum width margin))
+ (mapcar 'boxy--get-width row)
+ (* -1 margin)))
+ rows))))
+ (if (> width (+ (* 2 padding) children-width))
+ (setq stored-width width)
+ (setq stored-width (+ base-width children-width)))))))))
+
+(cl-defmethod boxy--get-on-top-height ((box boxy-box))
+ "Get the height of any boxes on top of BOX."
+ (apply 'max 0
+ (mapcar
+ 'boxy--get-on-top-height-helper
+ (seq-filter
+ (lambda (child) (with-slots (rel) child (and (slot-boundp child
:rel)
+ (string= rel "on top
of"))))
+ (boxy--get-children box)))))
+
+(cl-defmethod boxy--get-on-top-height-helper ((child boxy-box))
+ "Get the height of any boxes on top of CHILD, including child."
+ (with-slots (rel) child
+ (+
+ (boxy--get-height child)
+ (apply 'max 0
+ (mapcar
+ 'boxy--get-on-top-height-helper
+ (seq-filter
+ (lambda (grandchild)
+ (with-slots ((grandchild-rel rel)) grandchild
+ (and (slot-boundp grandchild :rel)
+ (string= "on top of" grandchild-rel))))
+ (boxy--get-children child)))))))
+
+(cl-defmethod boxy--get-height ((box boxy-box) &optional include-on-top)
+ "Get the height of BOX.
+
+If INCLUDE-ON-TOP is non-nil, also include height on top of box."
+ (let ((on-top-height (if include-on-top (boxy--get-on-top-height box) 0)))
+ (with-slots ((stored-height height) in-front on-top) box
+ (if (slot-boundp box :height)
+ (+ stored-height on-top-height)
+ (let* ((margin (boxy--margin-y box))
+ (padding (boxy--padding-y box))
+ (height (+ (if (or in-front on-top) -1 0)
+ 3 ; box walls + text
+ (* 2 padding)))
+ (children (seq-filter
+ (lambda (child) (with-slots (on-top) child (not
on-top)))
+ (boxy--get-children box))))
+ (if (not children)
+ (progn
+ (setq stored-height height)
+ (+ height on-top-height))
+ (let* ((row-indices (cl-delete-duplicates
+ (mapcar
+ (lambda (child) (with-slots (y-order) child
y-order))
+ children)))
+ (children-height (seq-reduce
+ (lambda (sum row)
+ (+ sum margin row))
+ (mapcar
+ (lambda (r)
+ (apply 'max 0
+ (mapcar
+ (lambda (child)
(boxy--get-height child t))
+ (seq-filter
+ (lambda (child)
+ (with-slots (y-order) child
(= r y-order)))
+ children))))
+ row-indices)
+ (* -1 margin))))
+
+ (setq stored-height (+ height children-height))
+ (+ stored-height on-top-height))))))))
+
+(cl-defmethod boxy--get-top ((box boxy-box))
+ "Get the top row index of BOX."
+ (with-slots ((stored-top top) on-top parent x-order y-order rel rel-box) box
+ (cond ((slot-boundp box :top) stored-top)
+ (on-top (- (boxy--get-top parent) (boxy--get-height box)))
+ (t
+ (let ((on-top-height (boxy--get-on-top-height box))
+ (margin (boxy--margin-y box))
+ (padding (boxy--padding-y box)))
+ (if (not (slot-boundp box :parent))
+ (setq stored-top (+ on-top-height margin))
+ (let* ((siblings (seq-filter
+ (lambda (sibling)
+ (with-slots (on-top in-front) sibling
+ (not (or on-top in-front))))
+ (boxy--get-children parent)))
+ (offset (+ 2 (* 2 padding)))
+ (top (+ on-top-height offset (boxy--get-top parent))))
+ (if-let* ((directly-above (seq-reduce
+ (lambda (above sibling)
+ (with-slots ((sibling-y
y-order)) sibling
+ (if (< sibling-y y-order)
+ (if above
+ (with-slots ((max-y
y-order)) (car above)
+ (if (> sibling-y
max-y)
+ (list sibling)
+ (if (= sibling-y
max-y)
+ (push sibling
above)
+ above)))
+ (list sibling))
+ above)))
+ siblings
+ '()))
+ (above-bottom (+ margin
+ (apply 'max
+ (mapcar
+ (lambda (sibling)
+ (+ (boxy--get-top
sibling)
+ (boxy--get-height
sibling)))
+ directly-above)))))
+ (setq stored-top (+ on-top-height above-bottom))
+ (setq stored-top top)))))))))
+
+(cl-defmethod boxy--get-left ((box boxy-box))
+ "Get the left column index of BOX."
+ (with-slots ((stored-left left) parent x-order y-order) box
+ (if (slot-boundp box :left)
+ stored-left
+ (let ((margin (boxy--margin-x box))
+ (padding (boxy--padding-x box)))
+ (if (not (slot-boundp box :parent))
+ (setq stored-left margin)
+ (let* ((left (+ 1
+ padding
+ (boxy--get-left parent)))
+ (to-the-left (seq-filter
+ (lambda (child)
+ (with-slots ((child-y y-order) (child-x
x-order)) child
+ (and (= y-order child-y)
+ (< child-x x-order))))
+ (boxy--get-children parent)))
+ (directly-left (and to-the-left
+ (seq-reduce
+ (lambda (max child)
+ (with-slots ((max-x x-order)) max
+ (with-slots ((child-x x-order)) child
+ (if (> child-x max-x)
+ child
+ max))))
+ to-the-left
+ (boxy-box :x-order -1.0e+INF)))))
+ (if directly-left
+ (setq stored-left (+ (boxy--get-left directly-left)
+ (boxy--get-width directly-left)
+ margin))
+ (with-slots (rel rel-box) box
+ (if (and (slot-boundp box :rel)
+ (or (string= "above" rel)
+ (string= "below" rel)))
+ (setq stored-left (boxy--get-left rel-box))
+ (setq stored-left left))))))))))
+
+;;;; Boxy mode buttons
+
+(cl-defmethod boxy-button-cursor-sensor ((box boxy-box))
+ "Create cursor functions for entering and leaving BOX."
+ (let (tooltip-timer)
+ (lambda (_window _oldpos dir)
+ (with-slots
+ ((actual-rel rel)
+ (actual-rel-box rel-box)
+ display-rel-box
+ display-rel
+ name
+ tooltip
+ help-echo)
+ box
+ (let* ((rel-box (and (slot-boundp box :rel-box)
+ (if (slot-boundp box :display-rel-box)
+ display-rel-box
+ actual-rel-box)))
+ (visible-rel-box rel-box))
+ (while (and visible-rel-box (not (boxy-is-visible visible-rel-box
t)))
+ (setq visible-rel-box (with-slots (parent) visible-rel-box
parent)))
+ (when (eq dir 'entered)
+ (save-excursion
+ (let ((inhibit-read-only t))
+ (if visible-rel-box (boxy-draw visible-rel-box
boxy--rel-face))
+ (boxy-draw box boxy--selected-face)))
+ (if (slot-boundp box :help-echo) (message help-echo))
+ (if (slot-boundp box :tooltip)
+ (setq tooltip-timer (boxy--tooltip tooltip))))
+ (when (eq dir 'left)
+ (save-excursion
+ (let ((inhibit-read-only t))
+ (if visible-rel-box (boxy-draw visible-rel-box t))
+ (boxy-draw box t)))
+ (when tooltip-timer
+ (cancel-timer tooltip-timer))))))))
+
+(cl-defmethod boxy-button-jump-other-window ((box boxy-box))
+ "Jump to location of link for BOX in other window."
+ (with-slots (markers) box
+ (lambda ()
+ (interactive)
+ (let ((first (car markers)))
+ (object-remove-from-list box :markers first)
+ (object-add-to-list box :markers first t))
+ (let* ((marker (car markers))
+ (buffer (marker-buffer marker))
+ (pos (marker-position marker)))
+ (save-selected-window
+ (switch-to-buffer-other-window buffer)
+ (goto-char pos))))))
+
+(cl-defmethod boxy-button-jump-to ((box boxy-box))
+ "Jump to the first occurrence of a link for BOX in the same window."
+ (with-slots (markers) box
+ (lambda ()
+ (interactive)
+ (let* ((marker (car markers))
+ (buffer (marker-buffer marker))
+ (pos (marker-position marker)))
+ (if-let ((window (get-buffer-window buffer)))
+ (select-window window)
+ (switch-to-buffer buffer))
+ (goto-char pos)))))
+
+(cl-defmethod boxy-button-jump-all ((box boxy-box))
+ "View all occurrences of links from BOX in the same window."
+ (with-slots (markers) box
+ (lambda ()
+ (interactive)
+ (let* ((size (/ (window-height) (length markers)))
+ (marker (car markers)))
+ (or (<= window-min-height size)
+ (error "To many buffers to visit simultaneously"))
+ (switch-to-buffer (marker-buffer marker))
+ (goto-char (marker-position marker))
+ (dolist (marker (cdr markers))
+ (select-window (split-window nil size))
+ (switch-to-buffer (marker-buffer marker))
+ (goto-char (marker-position marker)))))))
+
+(cl-defmethod boxy-button-jump-rel ((box boxy-box))
+ "Jump to the box directly related to BOX."
+ (with-slots (rel-box display-rel-box) box
+ (if (not (slot-boundp box :rel-box))
+ (lambda () (interactive))
+ (if (slot-boundp box :display-rel-box)
+ (lambda ()
+ (interactive)
+ (boxy-jump-to-box display-rel-box))
+ (lambda ()
+ (interactive)
+ (boxy-jump-to-box rel-box))))))
+
+(cl-defmethod boxy-button-cycle-children ((box boxy-box))
+ "Cycle visibility of children of BOX."
+ (lambda ()
+ (interactive)
+ (boxy--cycle-children box)
+ (boxy-mode-reset-boxes)
+ (let ((world (boxy--get-world box)))
+ (boxy--flex-adjust world world))
+ (boxy-mode-redraw)
+ (boxy-jump-to-box box)))
+
+(cl-defmethod boxy-button-create-keymap ((box boxy-box))
+ "Create a keymap for a button in Boxy mode.
+
+BOX is the box the button is being made for."
+ (easy-mmode-define-keymap
+ (mapcar
+ (lambda (key) (cons (kbd (car key)) (cdr key)))
+ (append
+ `(("TAB" . ,(boxy-button-cycle-children box))
+ ("r" . ,(boxy-button-jump-rel box)))
+ (if (slot-boundp box :action)
+ (with-slots (action) box
+ `(("<mouse-1>" . ,action)
+ ("RET" . ,action)))
+ (if (slot-boundp box :markers)
+ `(("o" . ,(boxy-button-jump-other-window box))
+ ("<mouse-1>" . ,(boxy-button-jump-to box))
+ ("RET" . ,(boxy-button-jump-to box))
+ ("M-RET" . ,(boxy-button-jump-all box)))))))))
+
+;;;; Private class methods
+
+(cl-defmethod boxy--expand-box ((box boxy-box))
+ "Expand all siblings and children of BOX."
+ (with-slots (children hidden-children expand-children) box
+ (let (fully-expanded)
+ (while (not fully-expanded)
+ (setq fully-expanded t)
+ (while expand-children
+ (setq fully-expanded nil)
+ (funcall (pop expand-children) box))
+ (if hidden-children (cl-rotatef children hidden-children))
+ (mapc
+ (lambda (child)
+ (with-slots (expand-siblings) child
+ (while expand-siblings
+ (setq fully-expanded nil)
+ (funcall (pop expand-siblings) child))))
+ children)))))
+
+(cl-defmethod boxy--cycle-children ((box boxy-box))
+ "Cycle visibility of children of BOX."
+ (with-slots (children hidden-children expand-children expanded parent) box
+ (if (or children hidden-children)
+ (cl-rotatef children hidden-children)
+ (boxy--expand-box box))))
+
+(cl-defmethod boxy--update-visibility ((box boxy-box))
+ "Update visibility of BOX based on `boxy--visibility'."
+ (with-slots (level children hidden-children expand-children) box
+ (if (not (boxy-is-visible box))
+ (if children (cl-rotatef children hidden-children))
+ (boxy--expand-box box))
+ (mapc 'boxy--update-visibility children)))
+
+(cl-defmethod boxy--get-position ((box boxy-box))
+ "Get the buffer position of the names of BOX and its children."
+ (when (slot-boundp box :name)
+ (boxy-jump-to-box box)
+ (point)))
+
+(cl-defmethod boxy--margin-x ((box boxy-box))
+ "Get the inherited property :margin-x from BOX."
+ (if (slot-boundp box :margin-x)
+ (with-slots (margin-x) box margin-x)
+ (if (slot-boundp box :parent)
+ (boxy--margin-x (with-slots (parent) box parent))
+ boxy--default-margin-x)))
+
+(cl-defmethod boxy--margin-y ((box boxy-box))
+ "Get the inherited property :margin-y from BOX."
+ (if (slot-boundp box :margin-y)
+ (with-slots (margin-y) box margin-y)
+ (if (slot-boundp box :parent)
+ (boxy--margin-y (with-slots (parent) box parent))
+ boxy--default-margin-y)))
+
+(cl-defmethod boxy--padding-x ((box boxy-box))
+ "Get the inherited property :padding-x from BOX."
+ (if (slot-boundp box :padding-x)
+ (with-slots (padding-x) box padding-x)
+ (if (slot-boundp box :parent)
+ (boxy--padding-x (with-slots (parent) box parent))
+ boxy--default-padding-x)))
+
+(cl-defmethod boxy--padding-y ((box boxy-box))
+ "Get the inherited property :padding-y from BOX."
+ (if (slot-boundp box :padding-y)
+ (with-slots (padding-y) box padding-y)
+ (if (slot-boundp box :parent)
+ (boxy--padding-y (with-slots (parent) box parent))
+ boxy--default-padding-y)))
+
+(cl-defmethod boxy--get-children ((box boxy-box) &optional arg)
+ "Get all visible children of BOX.
+
+If optional ARG is 'all, include hidden children.
+
+If optional ARG is 'hidden, only return hidden children"
+ (with-slots (children hidden-children) box
+ (cond
+ ((eq 'all arg)
+ (append children hidden-children))
+ ((eq 'hidden arg)
+ hidden-children)
+ (t
+ children))))
+
+(cl-defmethod boxy--add-child ((parent boxy-box)
+ (child boxy-box)
+ &optional force-visible)
+ "Add CHILD to PARENT according to its visibility.
+
+If FORCE-VISIBLE, always make CHILD visible in PARENT."
+ (oset child :parent parent)
+ (with-slots (children hidden-children) parent
+ (if hidden-children
+ (progn
+ (object-add-to-list parent :hidden-children child t)
+ (if (or force-visible (boxy-is-visible child))
+ (cl-rotatef children hidden-children)))
+ (if (or force-visible (boxy-is-visible child))
+ (object-add-to-list parent :children child t)
+ (object-add-to-list parent :hidden-children child t)))))
+
+(cl-defmethod boxy--get-world ((box boxy-box))
+ "Get the top most box related to BOX."
+ (with-slots (parent) box
+ (if (slot-boundp box :parent)
+ (boxy--get-world parent)
+ box)))
+
+(cl-defmethod boxy--primary-boxes ((box boxy-box))
+ "Get a list of boxes from BOX which have no further relatives."
+ (if (slot-boundp box :parent)
+ (if-let ((next-boxes (boxy--next box)))
+ (apply 'append (mapcar 'boxy--primary-boxes next-boxes))
+ (list box))
+ (apply 'append (mapcar 'boxy--primary-boxes (boxy--get-children box
'all)))))
+
+(cl-defmethod boxy--expand ((box boxy-box))
+ "Get a list of all boxes, including BOX, that are related to BOX."
+ (if (slot-boundp box :parent)
+ (apply 'append (list box) (mapcar 'boxy--expand (boxy--next box)))
+ (apply 'append (mapcar 'boxy--expand (boxy--get-children box 'all)))))
+
+(cl-defmethod boxy--get-all ((box boxy-box))
+ "Get all boxes, including BOX, that are children of BOX."
+ (apply 'append (list box) (mapcar 'boxy--get-all (boxy--get-children box
'all))))
+
+(cl-defmethod boxy--next ((box boxy-box) &optional exclude-children)
+ "Retrieve any boxes for which the :rel-box slot is BOX.
+
+If EXCLUDE-CHILDREN, only retrieve sibling boxes."
+ (let ((relatives (append (if exclude-children '() (boxy--get-children box
'all))
+ (if (slot-boundp box :parent)
+ (with-slots (parent) box
+ (boxy--get-children parent 'all))
+ '()))))
+ (seq-filter
+ (lambda (relative)
+ (with-slots (rel-box) relative
+ (and (slot-boundp relative :rel-box)
+ (eq rel-box box))))
+ relatives)))
+
+(cl-defmethod boxy--apply-level ((box boxy-box) level)
+ "Apply LEVEL to BOX and update all of its children."
+ (oset box :level level)
+ (mapc
+ (lambda (child) (boxy--apply-level child (+ 1 level)))
+ (boxy--get-children box 'all)))
+
+(cl-defmethod boxy--add-matching ((box boxy-box) (match boxy-box))
+ "Add relatives of BOX to MATCH."
+ (oset match :primary (or (with-slots (primary) match primary)
+ (with-slots (primary) box primary)))
+ (if (or (slot-boundp match :markers)
+ (slot-boundp box :markers))
+ (oset match :markers (append (and (slot-boundp match :markers)
+ (with-slots (markers) match markers))
+ (and (slot-boundp box :markers)
+ (with-slots (markers) box markers)))))
+ (if (not (slot-boundp match :action)) (slot-boundp box :action)
+ (oset match :action (with-slots (action) box action)))
+ (mapc
+ (lambda (next) (boxy-add-next next match))
+ (boxy--next box))
+ (oset match :expand-siblings (append (with-slots (expand-siblings) match
expand-siblings)
+ (with-slots (expand-siblings) box
expand-siblings)))
+ (oset match :expand-children (append (with-slots (expand-children) match
expand-children)
+ (with-slots (expand-children) box
expand-children))))
+
+(cl-defmethod boxy--position-box ((box boxy-box))
+ "Adjust BOX's position."
+ (with-slots (rel-box rel parent x-order y-order on-top in-front parent) box
+ (with-slots ((rel-y y-order) (rel-x x-order)) rel-box
+ (unless (boxy-find-matching box rel-box)
+ (if on-top
+ (setq y-order -1.0e+INF))
+ (if in-front
+ (setq y-order 1.0e+INF))
+ (cond
+ ((member rel '("to the left of" "to the right of"))
+ (setq y-order rel-y)
+ (if (string= rel "to the left of")
+ (setq x-order rel-x)
+ (setq x-order (+ 1 rel-x)))
+ (let ((row-siblings (seq-filter
+ (lambda (sibling)
+ (with-slots ((sibling-y y-order)) sibling
+ (= sibling-y rel-y)))
+ (boxy--get-children parent))))
+ (mapc
+ (lambda (sibling)
+ (with-slots ((sibling-x x-order)) sibling
+ (if (>= sibling-x x-order)
+ (setq sibling-x (+ 1 sibling-x)))))
+ row-siblings)))
+ ((member rel '("above" "below"))
+ (setq x-order rel-x)
+ (let ((sibling-y-orders (mapcar
+ (lambda (sibling) (with-slots (y-order)
sibling y-order))
+ (seq-filter
+ (lambda (sibling)
+ (with-slots (in-front on-top) sibling
+ (not (or in-front on-top))))
+ (boxy--get-children parent)))))
+ (if (string= rel "above")
+ (setq y-order (- (apply 'min 0 sibling-y-orders) 1))
+ (setq y-order (+ 1 (apply 'max 0 sibling-y-orders))))))
+ ((or on-top in-front)
+ (setq x-order (+ 1 (apply 'max 0
+ (mapcar
+ (lambda (child) (with-slots (x-order)
child x-order))
+ (seq-filter
+ (lambda (child)
+ (with-slots ((child-in-front in-front)
(child-on-top on-top)) child
+ (and (eq in-front child-in-front)
+ (eq on-top child-on-top))))
+ (boxy--get-children rel-box))))))))
+ (boxy--add-child parent box t)))))
+
+
+(cl-defmethod boxy--flex-add ((box boxy-box)
+ (parent boxy-box)
+ (world boxy-box))
+ "Add BOX to a PARENT box flexibly.
+
+This function ignores the :rel slot and adds BOX in such a way
+that the width of the WORLD is kept below `boxy--flex-width'
+characters if possible."
+ (let ((cur-width (boxy--get-width world)))
+ (boxy-mode-make-dirty)
+ (with-slots ((parent-level level) (parent-behind behind)) parent
+ (let* ((level (+ 1 parent-level))
+ (all-siblings (seq-filter
+ (lambda (sibling)
+ (with-slots (in-front on-top) sibling
+ (not (or in-front on-top))))
+ (boxy--get-children parent)))
+ (last-sibling (and all-siblings
+ (seq-reduce
+ (lambda (max sibling)
+ (with-slots ((max-x x-order) (max-y
y-order)) max
+ (with-slots ((sibling-x x-order)
(sibling-y y-order)) sibling
+ (if (> sibling-y max-y)
+ sibling
+ (if (and (= max-y sibling-y) (>
sibling-x max-x))
+ sibling
+ max)))))
+ all-siblings
+ (boxy-box :y-order -1.0e+INF)))))
+ (boxy--apply-level box level)
+ (boxy--add-child parent box t)
+ (boxy--flex-adjust box world)
+ (when last-sibling
+ (with-slots
+ ((last-sibling-y y-order)
+ (last-sibling-x x-order))
+ last-sibling
+ (oset box :y-order last-sibling-y)
+ (oset box :x-order (+ 1 last-sibling-x))
+ (let ((new-width (boxy--get-width world)))
+ (boxy-mode-make-dirty)
+ (when (and (> new-width cur-width) (> new-width
boxy--flex-width))
+ (oset box :y-order (+ 1 last-sibling-y))
+ (oset box :x-order 0)
+ (boxy--flex-adjust box world)))))))))
+
+(cl-defmethod boxy--flex-adjust ((box boxy-box) (world boxy-box))
+ "Adjust BOX x and y orders to try to fit WORLD within `boxy--flex-width'."
+ (with-slots (children) box
+ (let* ((partitioned (seq-group-by
+ (lambda (child)
+ (if (with-slots (flex) child flex)
+ 'flex
+ 'absolute))
+ children))
+ (flex-children (alist-get 'flex partitioned))
+ (other-children (alist-get 'absolute partitioned)))
+ (setq children '())
+ (boxy-mode-make-dirty)
+ (mapc
+ (lambda (flex-child)
+ (boxy--flex-add flex-child box world))
+ flex-children)
+ (mapc
+ (lambda (other-child)
+ (if (not (slot-boundp other-child :rel-box))
+ (boxy--flex-add other-child box world)
+ (boxy--position-box other-child)
+ (boxy--flex-adjust other-child world)))
+ other-children))))
+
+;;;; Utility expressions
+
+(defun boxy-fill-tooltip (str)
+ "Format STR so that each line fits within `boxy-tooltip-max-width'."
+ (with-temp-buffer
+ (insert str)
+ (let ((fill-column boxy-tooltip-max-width))
+ (fill-paragraph t))
+ (buffer-string)))
+
+(defun boxy--tooltip (content)
+ "Show popup tooltip with CONTENT after `boxy-tooltip-timeout' idle time."
+ (when (and boxy--tooltips (not (string-empty-p content)))
+ (let ((marker (point-marker)))
+ (run-with-idle-timer
+ boxy--tooltip-timeout nil
+ (lambda ()
+ (if (and (eq (marker-buffer marker)
+ (current-buffer))
+ (eq (marker-position marker)
+ (point)))
+ (boxy--tooltip-show content)))))))
+
+(defun boxy--tooltip-show (content)
+ "Show tooltip with CONTENT at point immediately."
+ (let* ((cur-line (line-number-at-pos))
+ (cur-column (current-column))
+ (min-line (save-excursion
+ (goto-char (window-start))
+ (line-number-at-pos)))
+ (max-column (+ (window-hscroll) (window-body-width)))
+ (rows (split-string content "\n"))
+ (height (length rows))
+ (width (+ 2 (min boxy--tooltip-max-width
+ (apply 'max 0 (mapcar 'length rows)))))
+ (top (if (< (- cur-line 2 height) min-line)
+ (+ cur-line 2)
+ (- cur-line 1 height)))
+ (left (if (> (+ cur-column width 1) max-column)
+ (- max-column width 1)
+ cur-column))
+ overlay overlays)
+ (dolist (str rows)
+ (let* ((pos (save-excursion
+ (forward-line (- top (line-number-at-pos)))
+ (let ((inhibit-read-only t))
+ (move-to-column left t))
+ (point)))
+ (remaining-chars (save-excursion
+ (goto-char pos)
+ (- (save-excursion
+ (end-of-line)
+ (current-column))
+ (current-column)))))
+ (setq str (format
+ (concat " %-" (number-to-string (- width 2)) "s ")
+ (truncate-string-to-width str boxy--tooltip-max-width nil
nil t)))
+ (when (= 0 remaining-chars)
+ (save-excursion (goto-char pos) (let ((inhibit-read-only t)) (insert
" ")))
+ (setq remaining-chars 1))
+ (setq overlay (make-overlay pos (+ pos (min remaining-chars width))))
+ (overlay-put overlay 'face boxy--tooltip-face)
+ (overlay-put overlay 'display `((margin nil) ,str))
+ (push overlay overlays)
+ (setq top (+ top 1))))
+ (save-excursion (boxy-mode-recalculate-box-ring))
+ (push (read-event nil) unread-command-events)
+ (mapc 'delete-overlay overlays)))
+
+(provide 'boxy)
+
+;;; boxy.el ends here
diff --git a/tests/boxy-test-edge.el b/tests/boxy-test-edge.el
new file mode 100644
index 0000000..e8d9f1f
--- /dev/null
+++ b/tests/boxy-test-edge.el
@@ -0,0 +1,234 @@
+;;; boxy-test-edge-cases.el --- Edge cases for boxy -*- lexical-binding: t -*-
+
+;; Copyright (C) 2021 Free Software Foundation, Inc.
+
+;; Author: Tyler Grinn <tylergrinn@gmail.com>
+
+;;; Code:
+
+;;;; Requirements
+
+(require 'boxy-test-setup)
+
+;;;; Tests
+
+(ert-deftest boxy-edge-above-on-top ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (on-top (boxy-box :name "on top" :rel "on top of"))
+ (above (boxy-box :name "above" :rel "above")))
+ (boxy-add-next thing world)
+ (boxy-add-next on-top thing)
+ (boxy-add-next above on-top)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮
+│above│
+╰─────╯
+ ╭──────╮
+ │on top│
+╭┴──────┴╮
+│thing │
+╰────────╯
+")))))
+
+(ert-deftest boxy-edge-above-on-top-on-top ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (on-top (boxy-box :name "on top" :rel "on top of"))
+ (on-top-on-top (boxy-box :name "on top on top" :rel "on top of"))
+ (above (boxy-box :name "above" :rel "above")))
+ (boxy-add-next thing world)
+ (boxy-add-next on-top thing)
+ (boxy-add-next on-top-on-top on-top)
+ (boxy-add-next above on-top-on-top)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮
+│above│
+╰─────╯
+ ╭─────────────╮
+ │on top on top│
+ ╭┴─────────────┴╮
+ │on top │
+╭┴───────────────┴╮
+│thing │
+╰─────────────────╯
+")))))
+
+(ert-deftest boxy-edge-below-on-top ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (on-top (boxy-box :name "on top" :rel "on top of"))
+ (below (boxy-box :name "below" :rel "below")))
+ (boxy-add-next thing world)
+ (boxy-add-next on-top thing)
+ (boxy-add-next below on-top)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+ ╭──────╮
+ │on top│
+╭┴──────┴╮
+│thing │
+│╭─────╮ │
+││below│ │
+│╰─────╯ │
+╰────────╯
+")))))
+
+(ert-deftest boxy-edge-below-on-top-on-top ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (on-top (boxy-box :name "on top" :rel "on top of"))
+ (on-top-on-top (boxy-box :name "on top on top" :rel "on top of"))
+ (below (boxy-box :name "below" :rel "below")))
+ (boxy-add-next thing world)
+ (boxy-add-next on-top thing)
+ (boxy-add-next on-top-on-top on-top)
+ (boxy-add-next below on-top-on-top)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+ ╭─────────────╮
+ │on top on top│
+ ╭┴─────────────┴╮
+ │on top │
+ │╭─────╮ │
+ ││below│ │
+ │╰─────╯ │
+╭┴───────────────┴╮
+│thing │
+╰─────────────────╯
+")))))
+
+(ert-deftest boxy-edge-below-in-front ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (in-front (boxy-box :name "in front" :rel "in front of"))
+ (below (boxy-box :name "below" :rel "below")))
+ (boxy-add-next thing world)
+ (boxy-add-next in-front thing)
+ (boxy-add-next below in-front)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭──────────╮
+│thing │
+│╭────────╮│
+││in front││
+╰┴────────┴╯
+
+╭─────╮
+│below│
+╰─────╯
+")))))
+
+(ert-deftest boxy-edge-below-in-front-in-front ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (in-front (boxy-box :name "in front" :rel "in front of"))
+ (in-front-in-front (boxy-box :name "in front in front" :rel "in front
of"))
+ (below (boxy-box :name "below" :rel "below")))
+ (boxy-add-next thing world)
+ (boxy-add-next in-front thing)
+ (boxy-add-next in-front-in-front in-front)
+ (boxy-add-next below in-front-in-front)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────────────────────╮
+│thing │
+│╭───────────────────╮│
+││in front ││
+││╭─────────────────╮││
+│││in front in front│││
+╰┴┴─────────────────┴┴╯
+
+╭─────╮
+│below│
+╰─────╯
+")))))
+
+(ert-deftest boxy-edge-above-in-front ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (in-front (boxy-box :name "in front" :rel "in front of"))
+ (above (boxy-box :name "above" :rel "above")))
+ (boxy-add-next thing world)
+ (boxy-add-next in-front thing)
+ (boxy-add-next above in-front)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭──────────╮
+│thing │
+│╭─────╮ │
+││above│ │
+│╰─────╯ │
+│╭────────╮│
+││in front││
+╰┴────────┴╯
+")))))
+
+(ert-deftest boxy-edge-above-in-front-in-front ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (in-front (boxy-box :name "in front" :rel "in front of"))
+ (in-front-in-front (boxy-box :name "in front in front" :rel "in front
of"))
+ (above (boxy-box :name "above" :rel "above")))
+ (boxy-add-next thing world)
+ (boxy-add-next in-front thing)
+ (boxy-add-next in-front-in-front in-front)
+ (boxy-add-next above in-front-in-front)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────────────────────╮
+│thing │
+│╭───────────────────╮│
+││in front ││
+││╭─────╮ ││
+│││above│ ││
+││╰─────╯ ││
+││╭─────────────────╮││
+│││in front in front│││
+╰┴┴─────────────────┴┴╯
+")))))
+
+(ert-deftest boxy-edge-merge-above-on-top ()
+ (let ((world-1 (boxy-box))
+ (thing-1 (boxy-box :name "thing" :margin-y 0))
+ (on-top-1 (boxy-box :name "on top" :rel "on top of"))
+ (world-2 (boxy-box))
+ (thing-2 (boxy-box :name "thing" :margin-y 0))
+ (on-top-2 (boxy-box :name "on top" :rel "on top of"))
+ (above (boxy-box :name "above" :rel "above")))
+ (boxy-add-next thing-1 world-1)
+ (boxy-add-next on-top-1 thing-1)
+ (boxy-add-next thing-2 world-2)
+ (boxy-add-next on-top-2 thing-2)
+ (boxy-add-next above on-top-2)
+ (boxy-pp (boxy-merge (list world-1 world-2)))
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮
+│above│
+╰─────╯
+ ╭──────╮
+ │on top│
+╭┴──────┴╮
+│thing │
+╰────────╯
+")))))
diff --git a/tests/boxy-test-margin.el b/tests/boxy-test-margin.el
new file mode 100644
index 0000000..b7ab4b6
--- /dev/null
+++ b/tests/boxy-test-margin.el
@@ -0,0 +1,153 @@
+;;; boxy-test-margin.el -- Margin tests for boxy -*- lexical-binding: t -*-
+
+;; Copyright (C) 2021 Free Software Foundation, Inc.
+
+;; Author: Tyler Grinn <tylergrinn@gmail.com>
+
+;;; Code:
+
+;;;; Requirements
+
+(require 'boxy-test-setup)
+
+;;;; Tests
+
+(ert-deftest boxy-margin-0-above ()
+ (let* ((world (boxy-box :margin-x 0 :margin-y 0))
+ (thing (boxy-box :name "thing"))
+ (above (boxy-box :name "above" :rel "above")))
+ (boxy-add-next thing world)
+ (boxy-add-next above thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "╭─────╮
+│above│
+╰─────╯
+╭─────╮
+│thing│
+╰─────╯
+")))))
+
+(ert-deftest boxy-margin-3-2-above ()
+ (let* ((world (boxy-box :margin-x 3 :margin-y 2))
+ (thing (boxy-box :name "thing"))
+ (above (boxy-box :name "above" :rel "above")))
+ (boxy-add-next thing world)
+ (boxy-add-next above thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+
+ ╭─────╮
+ │above│
+ ╰─────╯
+
+
+ ╭─────╮
+ │thing│
+ ╰─────╯
+")))))
+
+(ert-deftest boxy-margin-0-below ()
+ (let* ((world (boxy-box :margin-x 0 :margin-y 0))
+ (thing (boxy-box :name "thing"))
+ (below (boxy-box :name "below" :rel "below")))
+ (boxy-add-next thing world)
+ (boxy-add-next below thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "╭─────╮
+│thing│
+╰─────╯
+╭─────╮
+│below│
+╰─────╯
+")))))
+
+(ert-deftest boxy-margin-3-2-below ()
+ (let* ((world (boxy-box :margin-x 3 :margin-y 2))
+ (thing (boxy-box :name "thing"))
+ (below (boxy-box :name "below" :rel "below")))
+ (boxy-add-next thing world)
+ (boxy-add-next below thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+
+ ╭─────╮
+ │thing│
+ ╰─────╯
+
+
+ ╭─────╮
+ │below│
+ ╰─────╯
+")))))
+
+(ert-deftest boxy-margin-0-left ()
+ (let* ((world (boxy-box :margin-x 0 :margin-y 0))
+ (thing (boxy-box :name "thing"))
+ (left (boxy-box :name "left" :rel "to the left of")))
+ (boxy-add-next thing world)
+ (boxy-add-next left thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "╭────╮╭─────╮
+│left││thing│
+╰────╯╰─────╯
+")))))
+
+(ert-deftest boxy-margin-3-2-left ()
+ (let* ((world (boxy-box :margin-x 3 :margin-y 2))
+ (thing (boxy-box :name "thing"))
+ (left (boxy-box :name "left" :rel "to the left of")))
+ (boxy-add-next thing world)
+ (boxy-add-next left thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+
+ ╭────╮ ╭─────╮
+ │left│ │thing│
+ ╰────╯ ╰─────╯
+")))))
+
+(ert-deftest boxy-margin-0-right ()
+ (let* ((world (boxy-box :margin-x 0 :margin-y 0))
+ (thing (boxy-box :name "thing"))
+ (right (boxy-box :name "right" :rel "to the right of")))
+ (boxy-add-next thing world)
+ (boxy-add-next right thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "╭─────╮╭─────╮
+│thing││right│
+╰─────╯╰─────╯
+")))))
+
+(ert-deftest boxy-margin-3-2-right ()
+ (let* ((world (boxy-box :margin-x 3 :margin-y 2))
+ (thing (boxy-box :name "thing"))
+ (right (boxy-box :name "right" :rel "to the right of")))
+ (boxy-add-next thing world)
+ (boxy-add-next right thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+
+ ╭─────╮ ╭─────╮
+ │thing│ │right│
+ ╰─────╯ ╰─────╯
+")))))
+
+
+
+
diff --git a/tests/boxy-test-padding.el b/tests/boxy-test-padding.el
new file mode 100644
index 0000000..4b04d07
--- /dev/null
+++ b/tests/boxy-test-padding.el
@@ -0,0 +1,352 @@
+;;; boxy-test-padding.el -- Padding tests for boxy -*- lexical-binding: t -*-
+
+;; Copyright (C) 2021 Free Software Foundation, Inc.
+
+;; Author: Tyler Grinn <tylergrinn@gmail.com>
+
+;;; Code:
+
+;;;; Requirements
+
+(require 'boxy-test-setup)
+
+;;;; Tests
+
+(ert-deftest boxy-padding-0-above ()
+ (let* ((world (boxy-box :padding-x 0 :padding-y 0))
+ (thing (boxy-box :name "thing"))
+ (above (boxy-box :name "above" :rel "above")))
+ (boxy-add-next thing world)
+ (boxy-add-next above thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮
+│above│
+╰─────╯
+
+╭─────╮
+│thing│
+╰─────╯
+")))))
+
+(ert-deftest boxy-padding-3-2-above ()
+ (let* ((world (boxy-box :padding-x 3 :padding-y 2))
+ (thing (boxy-box :name "thing"))
+ (above (boxy-box :name "above" :rel "above")))
+ (boxy-add-next thing world)
+ (boxy-add-next above thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭───────────╮
+│ │
+│ │
+│ above │
+│ │
+│ │
+╰───────────╯
+
+╭───────────╮
+│ │
+│ │
+│ thing │
+│ │
+│ │
+╰───────────╯
+")))))
+
+(ert-deftest boxy-padding-0-below ()
+ (let* ((world (boxy-box :padding-x 0 :padding-y 0))
+ (thing (boxy-box :name "thing"))
+ (below (boxy-box :name "below" :rel "below")))
+ (boxy-add-next thing world)
+ (boxy-add-next below thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮
+│thing│
+╰─────╯
+
+╭─────╮
+│below│
+╰─────╯
+")))))
+
+(ert-deftest boxy-padding-3-2-below ()
+ (let* ((world (boxy-box :padding-x 3 :padding-y 2))
+ (thing (boxy-box :name "thing"))
+ (below (boxy-box :name "below" :rel "below")))
+ (boxy-add-next thing world)
+ (boxy-add-next below thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭───────────╮
+│ │
+│ │
+│ thing │
+│ │
+│ │
+╰───────────╯
+
+╭───────────╮
+│ │
+│ │
+│ below │
+│ │
+│ │
+╰───────────╯
+")))))
+
+(ert-deftest boxy-padding-0-left ()
+ (let* ((world (boxy-box :padding-x 0 :padding-y 0))
+ (thing (boxy-box :name "thing"))
+ (left (boxy-box :name "left" :rel "to the left of")))
+ (boxy-add-next thing world)
+ (boxy-add-next left thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭────╮╭─────╮
+│left││thing│
+╰────╯╰─────╯
+")))))
+
+(ert-deftest boxy-padding-3-2-left ()
+ (let* ((world (boxy-box :padding-x 3 :padding-y 2))
+ (thing (boxy-box :name "thing"))
+ (left (boxy-box :name "left" :rel "to the left of")))
+ (boxy-add-next thing world)
+ (boxy-add-next left thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭──────────╮╭───────────╮
+│ ││ │
+│ ││ │
+│ left ││ thing │
+│ ││ │
+│ ││ │
+╰──────────╯╰───────────╯
+")))))
+
+(ert-deftest boxy-padding-0-right ()
+ (let* ((world (boxy-box :padding-x 0 :padding-y 0))
+ (thing (boxy-box :name "thing"))
+ (right (boxy-box :name "right" :rel "to the right of")))
+ (boxy-add-next thing world)
+ (boxy-add-next right thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮╭─────╮
+│thing││right│
+╰─────╯╰─────╯
+")))))
+
+(ert-deftest boxy-padding-3-2-right ()
+ (let* ((world (boxy-box :padding-x 3 :padding-y 2))
+ (thing (boxy-box :name "thing"))
+ (right (boxy-box :name "right" :rel "to the right of")))
+ (boxy-add-next thing world)
+ (boxy-add-next right thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭───────────╮╭───────────╮
+│ ││ │
+│ ││ │
+│ thing ││ right │
+│ ││ │
+│ ││ │
+╰───────────╯╰───────────╯
+")))))
+
+(ert-deftest boxy-padding-0-in ()
+ (let* ((world (boxy-box :padding-x 0 :padding-y 0))
+ (thing (boxy-box :name "thing"))
+ (in (boxy-box :name "in" :rel "in")))
+ (boxy-add-next thing world)
+ (boxy-add-next in thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮
+│thing│
+│╭──╮ │
+││in│ │
+│╰──╯ │
+╰─────╯
+")))))
+
+(ert-deftest boxy-padding-3-2-in ()
+ (let* ((world (boxy-box :padding-x 3 :padding-y 2))
+ (thing (boxy-box :name "thing"))
+ (in (boxy-box :name "in" :rel "in")))
+ (boxy-add-next thing world)
+ (boxy-add-next in thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭────────────────╮
+│ │
+│ │
+│ thing │
+│ │
+│ │
+│ ╭────────╮ │
+│ │ │ │
+│ │ │ │
+│ │ in │ │
+│ │ │ │
+│ │ │ │
+│ ╰────────╯ │
+╰────────────────╯
+")))))
+
+(ert-deftest boxy-padding-0-behind ()
+ (let* ((world (boxy-box :padding-x 0 :padding-y 0))
+ (thing (boxy-box :name "thing"))
+ (behind (boxy-box :name "behind" :rel "behind")))
+ (boxy-add-next thing world)
+ (boxy-add-next behind thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭────────╮
+│thing │
+│╭╌╌╌╌╌╌╮│
+│╎behind╎│
+│╰╌╌╌╌╌╌╯│
+╰────────╯
+")))))
+
+(ert-deftest boxy-padding-3-2-behind ()
+ (let* ((world (boxy-box :padding-x 3 :padding-y 2))
+ (thing (boxy-box :name "thing"))
+ (behind (boxy-box :name "behind" :rel "behind")))
+ (boxy-add-next thing world)
+ (boxy-add-next behind thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭────────────────────╮
+│ │
+│ │
+│ thing │
+│ │
+│ │
+│ ╭╌╌╌╌╌╌╌╌╌╌╌╌╮ │
+│ ╎ ╎ │
+│ ╎ ╎ │
+│ ╎ behind ╎ │
+│ ╎ ╎ │
+│ ╎ ╎ │
+│ ╰╌╌╌╌╌╌╌╌╌╌╌╌╯ │
+╰────────────────────╯
+")))))
+
+(ert-deftest boxy-padding-0-in-front ()
+ (let* ((world (boxy-box :padding-x 0 :padding-y 0))
+ (thing (boxy-box :name "thing"))
+ (in-front (boxy-box :name "in front" :rel "in front of")))
+ (boxy-add-next thing world)
+ (boxy-add-next in-front thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭──────────╮
+│thing │
+│╭────────╮│
+││in front││
+╰┴────────┴╯
+")))))
+
+(ert-deftest boxy-padding-3-2-in-front ()
+ (let* ((world (boxy-box :padding-x 3 :padding-y 2))
+ (thing (boxy-box :name "thing"))
+ (in-front (boxy-box :name "in front" :rel "in front of")))
+ (boxy-add-next thing world)
+ (boxy-add-next in-front thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭──────────────────────╮
+│ │
+│ │
+│ thing │
+│ │
+│ │
+│ ╭──────────────╮ │
+│ │ │ │
+│ │ │ │
+│ │ in front │ │
+│ │ │ │
+│ │ │ │
+╰───┴──────────────┴───╯
+")))))
+
+
+(ert-deftest boxy-padding-0-on-top ()
+ (let* ((world (boxy-box :padding-x 0 :padding-y 0))
+ (thing (boxy-box :name "thing"))
+ (on-top (boxy-box :name "on top" :rel "on top of")))
+ (boxy-add-next thing world)
+ (boxy-add-next on-top thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+ ╭──────╮
+ │on top│
+╭┴──────┴╮
+│thing │
+╰────────╯
+")))))
+
+(ert-deftest boxy-padding-3-2-on-top ()
+ (let* ((world (boxy-box :padding-x 3 :padding-y 2))
+ (thing (boxy-box :name "thing"))
+ (on-top (boxy-box :name "on top" :rel "on top of")))
+ (boxy-add-next thing world)
+ (boxy-add-next on-top thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+ ╭────────────╮
+ │ │
+ │ │
+ │ on top │
+ │ │
+ │ │
+╭───┴────────────┴───╮
+│ │
+│ │
+│ thing │
+│ │
+│ │
+╰────────────────────╯
+")))))
+
+
+
+
+
+
diff --git a/tests/boxy-test-setup.el b/tests/boxy-test-setup.el
new file mode 100644
index 0000000..a669138
--- /dev/null
+++ b/tests/boxy-test-setup.el
@@ -0,0 +1,19 @@
+;;; boxy-test-setup.el --- Set up for boxy tests -*- lexical-binding: t -*-
+
+;; Copyright (C) 2021 Free Software Foundation, Inc.
+
+;; Author: Tyler Grinn <tylergrinn@gmail.com>
+
+;;; Code:
+
+(load-file "boxy.el")
+
+(setq boxy-default-margin-x 0)
+(setq boxy-default-margin-y 1)
+(setq boxy-default-padding-x 0)
+(setq boxy-default-padding-y 0)
+
+(provide 'boxy-test-setup)
+
+;;; boxy-test-setup.el ends here
+
diff --git a/tests/boxy-test-smoke.el b/tests/boxy-test-smoke.el
new file mode 100644
index 0000000..373579c
--- /dev/null
+++ b/tests/boxy-test-smoke.el
@@ -0,0 +1,167 @@
+;;; boxy-test-smoke.el -- Smoke tests for boxy -*- lexical-binding: t -*-
+
+;; Copyright (C) 2021 Free Software Foundation, Inc.
+
+;; Author: Tyler Grinn <tylergrinn@gmail.com>
+
+;;; Code:
+
+;;;; Requirements
+
+(require 'boxy-test-setup)
+
+;;;; Tests
+
+(ert-deftest boxy-smoke-in ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (in (boxy-box :name "in" :rel "in")))
+ (boxy-add-next thing world)
+ (boxy-add-next in thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮
+│thing│
+│╭──╮ │
+││in│ │
+│╰──╯ │
+╰─────╯
+")))))
+
+(ert-deftest boxy-smoke-on ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (on (boxy-box :name "on" :rel "on")))
+ (boxy-add-next thing world)
+ (boxy-add-next on thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮
+│thing│
+│╭──╮ │
+││on│ │
+│╰──╯ │
+╰─────╯
+")))))
+
+(ert-deftest boxy-smoke-behind ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (behind (boxy-box :name "behind" :rel "behind")))
+ (boxy-add-next thing world)
+ (boxy-add-next behind thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭────────╮
+│thing │
+│╭╌╌╌╌╌╌╮│
+│╎behind╎│
+│╰╌╌╌╌╌╌╯│
+╰────────╯
+")))))
+
+(ert-deftest boxy-smoke-in-front ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (in-front (boxy-box :name "in front" :rel "in front of")))
+ (boxy-add-next thing world)
+ (boxy-add-next in-front thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭──────────╮
+│thing │
+│╭────────╮│
+││in front││
+╰┴────────┴╯
+")))))
+
+(ert-deftest boxy-smoke-on-top ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (on-top (boxy-box :name "on top" :rel "on top of")))
+ (boxy-add-next thing world)
+ (boxy-add-next on-top thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+ ╭──────╮
+ │on top│
+╭┴──────┴╮
+│thing │
+╰────────╯
+")))))
+
+(ert-deftest boxy-smoke-above ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (above (boxy-box :name "above" :rel "above")))
+ (boxy-add-next thing world)
+ (boxy-add-next above thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮
+│above│
+╰─────╯
+╭─────╮
+│thing│
+╰─────╯
+")))))
+
+(ert-deftest boxy-smoke-below ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (below (boxy-box :name "below" :rel "below" :margin-y 0)))
+ (boxy-add-next thing world)
+ (boxy-add-next below thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮
+│thing│
+╰─────╯
+╭─────╮
+│below│
+╰─────╯
+")))))
+
+(ert-deftest boxy-smoke-right ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (right (boxy-box :name "right" :rel "to the right of")))
+ (boxy-add-next thing world)
+ (boxy-add-next right thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭─────╮╭─────╮
+│thing││right│
+╰─────╯╰─────╯
+")))))
+
+(ert-deftest boxy-smoke-left ()
+ (let* ((world (boxy-box))
+ (thing (boxy-box :name "thing" :margin-y 0))
+ (left (boxy-box :name "left" :rel "to the left of")))
+ (boxy-add-next thing world)
+ (boxy-add-next left thing)
+ (boxy-pp world)
+ (with-current-buffer (get-buffer "*Boxy*")
+ (should (string= (buffer-string)
+ "
+╭────╮╭─────╮
+│left││thing│
+╰────╯╰─────╯
+")))))