From e6ae8456476ab74600419709d26f1e038ed4999b Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Thu, 12 Nov 2015 18:58:58 +0100 Subject: [PATCH 01/17] Added client API for Octave --- client-api/Octave/COPYING | 711 +++++++++++++++++++ client-api/Octave/DESCRIPTION | 22 + client-api/Octave/INDEX | 11 + client-api/Octave/NEWS | 7 + client-api/Octave/inst/+vibes/axisAuto.m | 32 + client-api/Octave/inst/+vibes/axisLabels.m | 37 + client-api/Octave/inst/+vibes/beginDrawing.m | 62 ++ client-api/Octave/inst/+vibes/drawBox.m | 44 ++ client-api/Octave/inst/+vibes/drawLine.m | 38 + client-api/Octave/inst/+vibes/endDrawing.m | 37 + client-api/Octave/inst/+vibes/newFigure.m | 36 + client-api/Octave/src/Makefile | 22 + client-api/Octave/src/__vibes__.cpp | 368 ++++++++++ 13 files changed, 1427 insertions(+) create mode 100644 client-api/Octave/COPYING create mode 100644 client-api/Octave/DESCRIPTION create mode 100644 client-api/Octave/INDEX create mode 100644 client-api/Octave/NEWS create mode 100644 client-api/Octave/inst/+vibes/axisAuto.m create mode 100644 client-api/Octave/inst/+vibes/axisLabels.m create mode 100644 client-api/Octave/inst/+vibes/beginDrawing.m create mode 100644 client-api/Octave/inst/+vibes/drawBox.m create mode 100644 client-api/Octave/inst/+vibes/drawLine.m create mode 100644 client-api/Octave/inst/+vibes/endDrawing.m create mode 100644 client-api/Octave/inst/+vibes/newFigure.m create mode 100644 client-api/Octave/src/Makefile create mode 100644 client-api/Octave/src/__vibes__.cpp diff --git a/client-api/Octave/COPYING b/client-api/Octave/COPYING new file mode 100644 index 0000000..579bd0c --- /dev/null +++ b/client-api/Octave/COPYING @@ -0,0 +1,711 @@ + The GNU General Public License. + Version 3, 29 June 2007 + + Copyright © 2007 Free Software Foundation, Inc. + + Everyone is permitted to copy and distribute verbatim copies of this + license document, but changing it is not allowed. + +Preamble +======== + +The GNU General Public License is a free, copyleft license for software +and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program—to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers’ and authors’ protection, the GPL clearly explains +that there is no warranty for this free software. For both users’ and +authors’ sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users’ freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + +TERMS AND CONDITIONS +==================== + + 0. Definitions. + + “This License” refers to version 3 of the GNU General Public + License. + + “Copyright” also means copyright-like laws that apply to other + kinds of works, such as semiconductor masks. + + “The Program” refers to any copyrightable work licensed under this + License. Each licensee is addressed as “you”. “Licensees” and + “recipients” may be individuals or organizations. + + To “modify” a work means to copy from or adapt all or part of the + work in a fashion requiring copyright permission, other than the + making of an exact copy. The resulting work is called a “modified + version” of the earlier work or a work “based on” the earlier work. + + A “covered work” means either the unmodified Program or a work + based on the Program. + + To “propagate” a work means to do anything with it that, without + permission, would make you directly or secondarily liable for + infringement under applicable copyright law, except executing it on + a computer or modifying a private copy. Propagation includes + copying, distribution (with or without modification), making + available to the public, and in some countries other activities as + well. + + To “convey” a work means any kind of propagation that enables other + parties to make or receive copies. Mere interaction with a user + through a computer network, with no transfer of a copy, is not + conveying. + + An interactive user interface displays “Appropriate Legal Notices” + to the extent that it includes a convenient and prominently visible + feature that (1) displays an appropriate copyright notice, and (2) + tells the user that there is no warranty for the work (except to + the extent that warranties are provided), that licensees may convey + the work under this License, and how to view a copy of this + License. If the interface presents a list of user commands or + options, such as a menu, a prominent item in the list meets this + criterion. + + 1. Source Code. + + The “source code” for a work means the preferred form of the work + for making modifications to it. “Object code” means any non-source + form of a work. + + A “Standard Interface” means an interface that either is an + official standard defined by a recognized standards body, or, in + the case of interfaces specified for a particular programming + language, one that is widely used among developers working in that + language. + + The “System Libraries” of an executable work include anything, + other than the work as a whole, that (a) is included in the normal + form of packaging a Major Component, but which is not part of that + Major Component, and (b) serves only to enable use of the work with + that Major Component, or to implement a Standard Interface for + which an implementation is available to the public in source code + form. A “Major Component”, in this context, means a major + essential component (kernel, window system, and so on) of the + specific operating system (if any) on which the executable work + runs, or a compiler used to produce the work, or an object code + interpreter used to run it. + + The “Corresponding Source” for a work in object code form means all + the source code needed to generate, install, and (for an executable + work) run the object code and to modify the work, including scripts + to control those activities. However, it does not include the + work’s System Libraries, or general-purpose tools or generally + available free programs which are used unmodified in performing + those activities but which are not part of the work. For example, + Corresponding Source includes interface definition files associated + with source files for the work, and the source code for shared + libraries and dynamically linked subprograms that the work is + specifically designed to require, such as by intimate data + communication or control flow between those subprograms and other + parts of the work. + + The Corresponding Source need not include anything that users can + regenerate automatically from other parts of the Corresponding + Source. + + The Corresponding Source for a work in source code form is that + same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of + copyright on the Program, and are irrevocable provided the stated + conditions are met. This License explicitly affirms your unlimited + permission to run the unmodified Program. The output from running + a covered work is covered by this License only if the output, given + its content, constitutes a covered work. This License acknowledges + your rights of fair use or other equivalent, as provided by + copyright law. + + You may make, run and propagate covered works that you do not + convey, without conditions so long as your license otherwise + remains in force. You may convey covered works to others for the + sole purpose of having them make modifications exclusively for you, + or provide you with facilities for running those works, provided + that you comply with the terms of this License in conveying all + material for which you do not control copyright. Those thus making + or running the covered works for you must do so exclusively on your + behalf, under your direction and control, on terms that prohibit + them from making any copies of your copyrighted material outside + their relationship with you. + + Conveying under any other circumstances is permitted solely under + the conditions stated below. Sublicensing is not allowed; section + 10 makes it unnecessary. + + 3. Protecting Users’ Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological + measure under any applicable law fulfilling obligations under + article 11 of the WIPO copyright treaty adopted on 20 December + 1996, or similar laws prohibiting or restricting circumvention of + such measures. + + When you convey a covered work, you waive any legal power to forbid + circumvention of technological measures to the extent such + circumvention is effected by exercising rights under this License + with respect to the covered work, and you disclaim any intention to + limit operation or modification of the work as a means of + enforcing, against the work’s users, your or third parties’ legal + rights to forbid circumvention of technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program’s source code as you + receive it, in any medium, provided that you conspicuously and + appropriately publish on each copy an appropriate copyright notice; + keep intact all notices stating that this License and any + non-permissive terms added in accord with section 7 apply to the + code; keep intact all notices of the absence of any warranty; and + give all recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, + and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to + produce it from the Program, in the form of source code under the + terms of section 4, provided that you also meet all of these + conditions: + + a. The work must carry prominent notices stating that you + modified it, and giving a relevant date. + + b. The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in + section 4 to “keep intact all notices”. + + c. You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable + section 7 additional terms, to the whole of the work, and all + its parts, regardless of how they are packaged. This License + gives no permission to license the work in any other way, but + it does not invalidate such permission if you have separately + received it. + + d. If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has + interactive interfaces that do not display Appropriate Legal + Notices, your work need not make them do so. + + A compilation of a covered work with other separate and independent + works, which are not by their nature extensions of the covered + work, and which are not combined with it such as to form a larger + program, in or on a volume of a storage or distribution medium, is + called an “aggregate” if the compilation and its resulting + copyright are not used to limit the access or legal rights of the + compilation’s users beyond what the individual works permit. + Inclusion of a covered work in an aggregate does not cause this + License to apply to the other parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms + of sections 4 and 5, provided that you also convey the + machine-readable Corresponding Source under the terms of this + License, in one of these ways: + + a. Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b. Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that + product model, to give anyone who possesses the object code + either (1) a copy of the Corresponding Source for all the + software in the product that is covered by this License, on a + durable physical medium customarily used for software + interchange, for a price no more than your reasonable cost of + physically performing this conveying of source, or (2) access + to copy the Corresponding Source from a network server at no + charge. + + c. Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, + and only if you received the object code with such an offer, + in accord with subsection 6b. + + d. Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to + the Corresponding Source in the same way through the same + place at no further charge. You need not require recipients + to copy the Corresponding Source along with the object code. + If the place to copy the object code is a network server, the + Corresponding Source may be on a different server (operated by + you or a third party) that supports equivalent copying + facilities, provided you maintain clear directions next to the + object code saying where to find the Corresponding Source. + Regardless of what server hosts the Corresponding Source, you + remain obligated to ensure that it is available for as long as + needed to satisfy these requirements. + + e. Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the + general public at no charge under subsection 6d. + + A separable portion of the object code, whose source code is + excluded from the Corresponding Source as a System Library, need + not be included in conveying the object code work. + + A “User Product” is either (1) a “consumer product”, which means + any tangible personal property which is normally used for personal, + family, or household purposes, or (2) anything designed or sold for + incorporation into a dwelling. In determining whether a product is + a consumer product, doubtful cases shall be resolved in favor of + coverage. For a particular product received by a particular user, + “normally used” refers to a typical or common use of that class of + product, regardless of the status of the particular user or of the + way in which the particular user actually uses, or expects or is + expected to use, the product. A product is a consumer product + regardless of whether the product has substantial commercial, + industrial or non-consumer uses, unless such uses represent the + only significant mode of use of the product. + + “Installation Information” for a User Product means any methods, + procedures, authorization keys, or other information required to + install and execute modified versions of a covered work in that + User Product from a modified version of its Corresponding Source. + The information must suffice to ensure that the continued + functioning of the modified object code is in no case prevented or + interfered with solely because modification has been made. + + If you convey an object code work under this section in, or with, + or specifically for use in, a User Product, and the conveying + occurs as part of a transaction in which the right of possession + and use of the User Product is transferred to the recipient in + perpetuity or for a fixed term (regardless of how the transaction + is characterized), the Corresponding Source conveyed under this + section must be accompanied by the Installation Information. But + this requirement does not apply if neither you nor any third party + retains the ability to install modified object code on the User + Product (for example, the work has been installed in ROM). + + The requirement to provide Installation Information does not + include a requirement to continue to provide support service, + warranty, or updates for a work that has been modified or installed + by the recipient, or for the User Product in which it has been + modified or installed. Access to a network may be denied when the + modification itself materially and adversely affects the operation + of the network or violates the rules and protocols for + communication across the network. + + Corresponding Source conveyed, and Installation Information + provided, in accord with this section must be in a format that is + publicly documented (and with an implementation available to the + public in source code form), and must require no special password + or key for unpacking, reading or copying. + + 7. Additional Terms. + + “Additional permissions” are terms that supplement the terms of + this License by making exceptions from one or more of its + conditions. Additional permissions that are applicable to the + entire Program shall be treated as though they were included in + this License, to the extent that they are valid under applicable + law. If additional permissions apply only to part of the Program, + that part may be used separately under those permissions, but the + entire Program remains governed by this License without regard to + the additional permissions. + + When you convey a copy of a covered work, you may at your option + remove any additional permissions from that copy, or from any part + of it. (Additional permissions may be written to require their own + removal in certain cases when you modify the work.) You may place + additional permissions on material, added by you to a covered work, + for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material + you add to a covered work, you may (if authorized by the copyright + holders of that material) supplement the terms of this License with + terms: + + a. Disclaiming warranty or limiting liability differently from + the terms of sections 15 and 16 of this License; or + + b. Requiring preservation of specified reasonable legal notices + or author attributions in that material or in the Appropriate + Legal Notices displayed by works containing it; or + + c. Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked + in reasonable ways as different from the original version; or + + d. Limiting the use for publicity purposes of names of licensors + or authors of the material; or + + e. Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f. Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified + versions of it) with contractual assumptions of liability to + the recipient, for any liability that these contractual + assumptions directly impose on those licensors and authors. + + All other non-permissive additional terms are considered “further + restrictions” within the meaning of section 10. If the Program as + you received it, or any part of it, contains a notice stating that + it is governed by this License along with a term that is a further + restriction, you may remove that term. If a license document + contains a further restriction but permits relicensing or conveying + under this License, you may add to a covered work material governed + by the terms of that license document, provided that the further + restriction does not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you + must place, in the relevant source files, a statement of the + additional terms that apply to those files, or a notice indicating + where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in + the form of a separately written license, or stated as exceptions; + the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly + provided under this License. Any attempt otherwise to propagate or + modify it is void, and will automatically terminate your rights + under this License (including any patent licenses granted under the + third paragraph of section 11). + + However, if you cease all violation of this License, then your + license from a particular copyright holder is reinstated (a) + provisionally, unless and until the copyright holder explicitly and + finally terminates your license, and (b) permanently, if the + copyright holder fails to notify you of the violation by some + reasonable means prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is + reinstated permanently if the copyright holder notifies you of the + violation by some reasonable means, this is the first time you have + received notice of violation of this License (for any work) from + that copyright holder, and you cure the violation prior to 30 days + after your receipt of the notice. + + Termination of your rights under this section does not terminate + the licenses of parties who have received copies or rights from you + under this License. If your rights have been terminated and not + permanently reinstated, you do not qualify to receive new licenses + for the same material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or + run a copy of the Program. Ancillary propagation of a covered work + occurring solely as a consequence of using peer-to-peer + transmission to receive a copy likewise does not require + acceptance. However, nothing other than this License grants you + permission to propagate or modify any covered work. These actions + infringe copyright if you do not accept this License. Therefore, + by modifying or propagating a covered work, you indicate your + acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically + receives a license from the original licensors, to run, modify and + propagate that work, subject to this License. You are not + responsible for enforcing compliance by third parties with this + License. + + An “entity transaction” is a transaction transferring control of an + organization, or substantially all assets of one, or subdividing an + organization, or merging organizations. If propagation of a + covered work results from an entity transaction, each party to that + transaction who receives a copy of the work also receives whatever + licenses to the work the party’s predecessor in interest had or + could give under the previous paragraph, plus a right to possession + of the Corresponding Source of the work from the predecessor in + interest, if the predecessor has it or can get it with reasonable + efforts. + + You may not impose any further restrictions on the exercise of the + rights granted or affirmed under this License. For example, you + may not impose a license fee, royalty, or other charge for exercise + of rights granted under this License, and you may not initiate + litigation (including a cross-claim or counterclaim in a lawsuit) + alleging that any patent claim is infringed by making, using, + selling, offering for sale, or importing the Program or any portion + of it. + + 11. Patents. + + A “contributor” is a copyright holder who authorizes use under this + License of the Program or a work on which the Program is based. + The work thus licensed is called the contributor’s “contributor + version”. + + A contributor’s “essential patent claims” are all patent claims + owned or controlled by the contributor, whether already acquired or + hereafter acquired, that would be infringed by some manner, + permitted by this License, of making, using, or selling its + contributor version, but do not include claims that would be + infringed only as a consequence of further modification of the + contributor version. For purposes of this definition, “control” + includes the right to grant patent sublicenses in a manner + consistent with the requirements of this License. + + Each contributor grants you a non-exclusive, worldwide, + royalty-free patent license under the contributor’s essential + patent claims, to make, use, sell, offer for sale, import and + otherwise run, modify and propagate the contents of its contributor + version. + + In the following three paragraphs, a “patent license” is any + express agreement or commitment, however denominated, not to + enforce a patent (such as an express permission to practice a + patent or covenant not to sue for patent infringement). To “grant” + such a patent license to a party means to make such an agreement or + commitment not to enforce a patent against the party. + + If you convey a covered work, knowingly relying on a patent + license, and the Corresponding Source of the work is not available + for anyone to copy, free of charge and under the terms of this + License, through a publicly available network server or other + readily accessible means, then you must either (1) cause the + Corresponding Source to be so available, or (2) arrange to deprive + yourself of the benefit of the patent license for this particular + work, or (3) arrange, in a manner consistent with the requirements + of this License, to extend the patent license to downstream + recipients. “Knowingly relying” means you have actual knowledge + that, but for the patent license, your conveying the covered work + in a country, or your recipient’s use of the covered work in a + country, would infringe one or more identifiable patents in that + country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or + arrangement, you convey, or propagate by procuring conveyance of, a + covered work, and grant a patent license to some of the parties + receiving the covered work authorizing them to use, propagate, + modify or convey a specific copy of the covered work, then the + patent license you grant is automatically extended to all + recipients of the covered work and works based on it. + + A patent license is “discriminatory” if it does not include within + the scope of its coverage, prohibits the exercise of, or is + conditioned on the non-exercise of one or more of the rights that + are specifically granted under this License. You may not convey a + covered work if you are a party to an arrangement with a third + party that is in the business of distributing software, under which + you make payment to the third party based on the extent of your + activity of conveying the work, and under which the third party + grants, to any of the parties who would receive the covered work + from you, a discriminatory patent license (a) in connection with + copies of the covered work conveyed by you (or copies made from + those copies), or (b) primarily for and in connection with specific + products or compilations that contain the covered work, unless you + entered into that arrangement, or that patent license was granted, + prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting + any implied license or other defenses to infringement that may + otherwise be available to you under applicable patent law. + + 12. No Surrender of Others’ Freedom. + + If conditions are imposed on you (whether by court order, agreement + or otherwise) that contradict the conditions of this License, they + do not excuse you from the conditions of this License. If you + cannot convey a covered work so as to satisfy simultaneously your + obligations under this License and any other pertinent obligations, + then as a consequence you may not convey it at all. For example, + if you agree to terms that obligate you to collect a royalty for + further conveying from those to whom you convey the Program, the + only way you could satisfy both those terms and this License would + be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have + permission to link or combine any covered work with a work licensed + under version 3 of the GNU Affero General Public License into a + single combined work, and to convey the resulting work. The terms + of this License will continue to apply to the part which is the + covered work, but the special requirements of the GNU Affero + General Public License, section 13, concerning interaction through + a network will apply to the combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new + versions of the GNU General Public License from time to time. Such + new versions will be similar in spirit to the present version, but + may differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the + Program specifies that a certain numbered version of the GNU + General Public License “or any later version” applies to it, you + have the option of following the terms and conditions either of + that numbered version or of any later version published by the Free + Software Foundation. If the Program does not specify a version + number of the GNU General Public License, you may choose any + version ever published by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future + versions of the GNU General Public License can be used, that + proxy’s public statement of acceptance of a version permanently + authorizes you to choose that version for the Program. + + Later license versions may give you additional or different + permissions. However, no additional obligations are imposed on any + author or copyright holder as a result of your choosing to follow a + later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY + APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE + COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” + WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, + INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE + RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. + SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL + NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN + WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES + AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR + DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR + CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE + THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA + BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD + PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER + PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF + THE POSSIBILITY OF SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided + above cannot be given local legal effect according to their terms, + reviewing courts shall apply local law that most closely + approximates an absolute waiver of all civil liability in + connection with the Program, unless a warranty or assumption of + liability accompanies a copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS +=========================== + +How to Apply These Terms to Your New Programs +============================================= + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least the +“copyright” line and a pointer to where the full notice is found. + + 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 . + + 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 . + + 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 . + diff --git a/client-api/Octave/DESCRIPTION b/client-api/Octave/DESCRIPTION new file mode 100644 index 0000000..6289cde --- /dev/null +++ b/client-api/Octave/DESCRIPTION @@ -0,0 +1,22 @@ +Name: vibes +Version: 0.2.0 +Date: 2015-11-12 +Author: Oliver Heimlich +Maintainer: ENSTA Bretagne Robotics +Title: Interface to VIBes, Visualizer for Intervals and Boxes +Description: VIBes is a visualization system that aims at providing people + working with interval methods a way to display results (boxes, pavings), + without worrying with GUI programming. It provides drawing functions + accessible from a lot of programming languages, without complex installation + and library dependencies. The main design goal of VIBes is to be + cross-platform, available from different programming languages, simple to + set-up, easy to port to a new language. + + VIBes consists in two parts: (1) the VIBes application that features viewing, + annotating and exporting figures, and (2) the VIBes API that enables your + program to communicate with the viewer in order to draw figures. + + This package integrates the VIBes API into Octave. The VIBes application + is required for operation and must be installed seperately. +Depends: octave (>= 4.0.0) +License: GPLv3+ diff --git a/client-api/Octave/INDEX b/client-api/Octave/INDEX new file mode 100644 index 0000000..ac73c82 --- /dev/null +++ b/client-api/Octave/INDEX @@ -0,0 +1,11 @@ +vibes >> VIBes' API for Octave +Connection - Starting and ending VIBes + vibes.beginDrawing + vibes.endDrawing +Figure and view management + vibes.newFigure + vibes.axisAuto + vibes.axisLabels +Drawing and editing functions + vibes.drawBox + vibes.drawLine diff --git a/client-api/Octave/NEWS b/client-api/Octave/NEWS new file mode 100644 index 0000000..d886a2b --- /dev/null +++ b/client-api/Octave/NEWS @@ -0,0 +1,7 @@ + VIBes' Client API for Octave + Summary of important user-visible changes + +Version 0.2.0 2015-11-12 +======================== + + • Initial release with compatibility for the Matlab client API diff --git a/client-api/Octave/inst/+vibes/axisAuto.m b/client-api/Octave/inst/+vibes/axisAuto.m new file mode 100644 index 0000000..81653fb --- /dev/null +++ b/client-api/Octave/inst/+vibes/axisAuto.m @@ -0,0 +1,32 @@ +## Copyright 2015 Oliver Heimlich +## +## This file is part of VIBes' API for Octave. +## +## VIBes' API for Octave 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. +## +## VIBes' API for Octave 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 VIBes' API for Octave. +## If not, see . + +## -*- texinfo -*- +## @documentencoding UTF-8 +## @deftypefn {Function File} {} vibes.axisAuto () +## Reset the view box to automatic mode in the VIBes viewer. +## @end deftypefn +function axisAuto () + +if (nargin != 0) + print_usage (); +endif + +__vibes__ ('axisAuto'); + +endfunction diff --git a/client-api/Octave/inst/+vibes/axisLabels.m b/client-api/Octave/inst/+vibes/axisLabels.m new file mode 100644 index 0000000..48fcc6c --- /dev/null +++ b/client-api/Octave/inst/+vibes/axisLabels.m @@ -0,0 +1,37 @@ +## Copyright 2015 Oliver Heimlich +## +## This file is part of VIBes' API for Octave. +## +## VIBes' API for Octave 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. +## +## VIBes' API for Octave 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 VIBes' API for Octave. +## If not, see . + +## -*- texinfo -*- +## @documentencoding UTF-8 +## @deftypefn {Function File} {} vibes.axisLabels (@var{label1}, @var{label2}, @dots{}) +## @deftypefnx {Function File} {} vibes.axisLabels (@{@var{label1}, @var{label2}, @dots{}@}) +## Set axis labels for the current VIBes figure. +## +## @deftypefnx {Function File} {} vibes.axisLabels (@{@var{label1}, @var{label2}, @dots{}@}, @var{figure}) +## Set axis labels for given VIBes figure. +## +## @end deftypefn +function axisLabels (varargin) + +if (nargin == 0) + print_usage (); +endif + +__vibes__ ('axisLabels', varargin{:}); + +endfunction diff --git a/client-api/Octave/inst/+vibes/beginDrawing.m b/client-api/Octave/inst/+vibes/beginDrawing.m new file mode 100644 index 0000000..f01dbbc --- /dev/null +++ b/client-api/Octave/inst/+vibes/beginDrawing.m @@ -0,0 +1,62 @@ +## Copyright 2015 Oliver Heimlich +## +## This file is part of VIBes' API for Octave. +## +## VIBes' API for Octave 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. +## +## VIBes' API for Octave 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 VIBes' API for Octave. +## If not, see . + +## -*- texinfo -*- +## @documentencoding UTF-8 +## @deftypefn {Function File} {} vibes.beginDrawing () +## @deftypefnx {Function File} {} vibes.beginDrawing (@var{filename}) +## Connect to the VIBes viewer to send data for plotting. This +## function must be called before using any other VIBes functions. +## +## Connection to VIBes is established via a file. Plotting commands for VIBes +## will be sent to the file and, asynchronously, interpreted by the VIBes +## viewer. Make sure that the VIBes viewer is started to see results of the +## plotting. +## +## @example +## @group +## vibes.beginDrawing +## vibes.drawBox (0, 1, 0, 1) +## vibes.endDrawing +## @end group +## @end example +## +## The target file is @code{.vibes.json} inside the user's home directory by +## default and may be changed with the optional @var{filename} parameter. +## +## @example +## @group +## vibes.beginDrawing simulation1.json +## vibes.drawBox (0, 1, 0, 1) +## vibes.endDrawing +## @end group +## @end example +## @seealso{vibes.endDrawing} +## @end deftypefn +function beginDrawing (filename) + +switch (nargin) + case 0 + __vibes__ ('beginDrawing'); + case 1 + __vibes__ ('beginDrawing', filename); + otherwise + print_usage (); +endswitch + +endfunction diff --git a/client-api/Octave/inst/+vibes/drawBox.m b/client-api/Octave/inst/+vibes/drawBox.m new file mode 100644 index 0000000..f1dac3f --- /dev/null +++ b/client-api/Octave/inst/+vibes/drawBox.m @@ -0,0 +1,44 @@ +## Copyright 2015 Oliver Heimlich +## +## This file is part of VIBes' API for Octave. +## +## VIBes' API for Octave 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. +## +## VIBes' API for Octave 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 VIBes' API for Octave. +## If not, see . + +## -*- texinfo -*- +## @documentencoding UTF-8 +## @deftypefn {Function File} {} vibes.drawBox (@var{box}) +## Plot a single box with pairs of lower bounds and upper bounds. The matrix +## @var{box} must be of size either @option{[2 @var{n}]} or +## @option{[@var{n} 2]}, where @var{n} is the number of axes. +## +## @deftypefnx {Function File} {} vibes.drawBox (@var{x_lb}, @var{x_ub}, @var{y_lb}, @var{y_ub}) +## @deftypefnx {Function File} {} vibes.drawBox (@var{x_lb}, @var{x_ub}, @var{y_lb}, @var{y_ub}, @var{z_lb}, @var{z_ub}) +## Plot a single box. +## +## @deftypefnx {Function File} {} vibes.drawBox (@dots{}, 'figure', @var{name}) +## Do the plotting inside a given VIBes figure +## +## @deftypefnx {Function File} {} vibes.drawBox (@dots{}, @var{format}) +## Customize the plotting using VIBes format strings. +## @end deftypefn +function drawBox (varargin) + +if (nargin == 0) + print_usage (); +endif + +__vibes__ ('drawBox', varargin{:}); + +endfunction diff --git a/client-api/Octave/inst/+vibes/drawLine.m b/client-api/Octave/inst/+vibes/drawLine.m new file mode 100644 index 0000000..9c562e2 --- /dev/null +++ b/client-api/Octave/inst/+vibes/drawLine.m @@ -0,0 +1,38 @@ +## Copyright 2015 Oliver Heimlich +## +## This file is part of VIBes' API for Octave. +## +## VIBes' API for Octave 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. +## +## VIBes' API for Octave 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 VIBes' API for Octave. +## If not, see . + +## -*- texinfo -*- +## @documentencoding UTF-8 +## @deftypefn {Function File} {} vibes.drawLine (@var{points}) +## Plot a line with coordinate points given as rows of a matrix. +## +## @deftypefn {Function File} {} vibes.drawLine (@dots{}, 'figure', @var{name}) +## Do the plotting inside a given VIBes figure +## +## @deftypefnx {Function File} {} vibes.drawLine (@dots{}, @var{format}) +## Customize the plotting using VIBes format strings. +## @end deftypefn +function drawLine (varargin) + +if (nargin == 0) + print_usage (); +endif + +__vibes__ ('drawLine', varargin{:}); + +endfunction diff --git a/client-api/Octave/inst/+vibes/endDrawing.m b/client-api/Octave/inst/+vibes/endDrawing.m new file mode 100644 index 0000000..da444a1 --- /dev/null +++ b/client-api/Octave/inst/+vibes/endDrawing.m @@ -0,0 +1,37 @@ +## Copyright 2015 Oliver Heimlich +## +## 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 . + +## -*- texinfo -*- +## @documentencoding UTF-8 +## @deftypefn {Function File} {} vibes.endDrawing () +## Disconnect from the VIBes viewer. This function should be called after any +## other VIBes functions to close the session. +## +## @example +## @group +## vibes.beginDrawing +## vibes.drawBox (0, 1, 0, 1) +## vibes.endDrawing +## @end group +## @end example +function endDrawing () + +if (nargin != 0) + print_usage (); +endif + +__vibes__ ('endDrawing'); + +endfunction diff --git a/client-api/Octave/inst/+vibes/newFigure.m b/client-api/Octave/inst/+vibes/newFigure.m new file mode 100644 index 0000000..3dfc489 --- /dev/null +++ b/client-api/Octave/inst/+vibes/newFigure.m @@ -0,0 +1,36 @@ +## Copyright 2015 Oliver Heimlich +## +## This file is part of VIBes' API for Octave. +## +## VIBes' API for Octave 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. +## +## VIBes' API for Octave 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 VIBes' API for Octave. +## If not, see . + +## -*- texinfo -*- +## @documentencoding UTF-8 +## @deftypefn {Function File} {} vibes.newFigure () +## @deftypefnx {Function File} {} vibes.newFigure (@var{name}) +## Create a new figure named @var{name}. +## @end deftypefn +function newFigure (name) + +switch (nargin) + case 0 + __vibes__ ('newFigure'); + case 1 + __vibes__ ('newFigure', name); + otherwise + print_usage (); +endswitch + +endfunction diff --git a/client-api/Octave/src/Makefile b/client-api/Octave/src/Makefile new file mode 100644 index 0000000..36ccc67 --- /dev/null +++ b/client-api/Octave/src/Makefile @@ -0,0 +1,22 @@ +SHELL = /bin/sh + +## Copyright 2015 Oliver Heimlich +## +## This file is part of VIBes' API for Octave. +## +## VIBes' API for Octave 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. +## +## VIBes' API for Octave 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 VIBes' API for Octave. +## If not, see . + +__vibes__.oct: __vibes__.cpp + $(MKOCTFILE) -o "$@" "$<" diff --git a/client-api/Octave/src/__vibes__.cpp b/client-api/Octave/src/__vibes__.cpp new file mode 100644 index 0000000..84c77d5 --- /dev/null +++ b/client-api/Octave/src/__vibes__.cpp @@ -0,0 +1,368 @@ +// Copyright 2015 Oliver Heimlich +// +// This file is part of VIBes' API for Octave. +// +// VIBes' API for Octave 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. +// +// VIBes' API for Octave 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 VIBes' API for Octave. +// If not, see . + +#include +#include + +// Ideally, the functions in this file would be split into several oct-files: +// +vibes/beginDrawing.oct +// +vibes/endDrawing.oct +// +vibes/... +// +// We would have to compile vibes.cpp as a shared library libvibes.so/.dll +// in order to get shared static variables in vibes.cpp working. Then, +// dynamically loading of the shared library would become difficult. To keep +// the loading mechanism simple, we use a single oct-file. +// +// It is not possible to define several external functions inside the oct-file, +// if they shall be called with the namespace mechanism (vibes.FUNCTION), +// because this is not supported by the autoload function. Thus, we create a +// single dispatcher function, which is called from several m-files: +// +vibes/beginDrawing.m +// +vibes/endDrawing.m +// +vibes/... +// +// This also simplifies installation of the package, because src/+folders are +// not supported by the pkg function and we would have to work around this in +// the Makefile during package installation. +#include "vibes.h" +#include "vibes.cpp" + +void __assertDrawing__ ( + const bool currentState = true, + const bool newState = true); + +void beginDrawing (const octave_value_list args) +{ + switch (args.length ()) + { + case 0: + __assertDrawing__ (false, true); + vibes::beginDrawing (); + break; + case 1: + if (args(0).is_string ()) + { + __assertDrawing__ (false, true); + vibes::beginDrawing (args(0).string_value ()); + } + else + error ("Connect expects a string as an argument"); + break; + default: + error ("beginDrawing: Wrong number of arguments"); + return; + } +} + +void endDrawing (const octave_value_list args) +{ + if (args.length () > 0) + { + error ("endDrawing: Wrong number of arguments"); + return; + } + __assertDrawing__ (true, false); + vibes::endDrawing (); +} + +// Internal function to make sure that the VIBes file handle is correctly +// initialized before using it. Otherwise vibes.cpp will produce segfaults +// because of missing checks in the code. +static bool lastDrawingState = false; +void __assertDrawing__ ( + const bool currentState, + const bool newState) +{ + // Did the user forget to call appropriate commands? + if (currentState != lastDrawingState) + if (lastDrawingState) + { + warning ("Please use vibes.endDrawing before vibes.beginDrawing"); + vibes::endDrawing (); + } + else + { + warning ("Please use vibes.beginDrawing before other VIBes commands"); + vibes::beginDrawing (); + } + + lastDrawingState = newState; +} + +void axisAuto (const octave_value_list args) +{ + if (args.length () > 0) + { + error ("axisAuto: Wrong number of arguments"); + return; + } + __assertDrawing__ (); + vibes::axisAuto (); +} + +void axisLabels (const octave_value_list args) +{ + if (args.length () == 0) + { + error ("axisLabels: Not enough arguments"); + return; + } + + __assertDrawing__ (); + std::vector labels; + std::string figureName; + if (args(0).is_cellstr ()) + { + // The first argument is a cellstr: use its contents as labels + const Array cellstr = args(0).cellstr_value (); + const octave_idx_type n = cellstr.numel (); + labels.reserve (n); + for (octave_idx_type i = 0; i < n; i++) + { + labels.push_back(cellstr.elem(i)); + } + + if (args.length () >= 2) + figureName = args(1).string_value (); + } + else + { + // Labels strings are directly provided as arguments + const octave_idx_type n = args.length (); + labels.reserve (n); + for (octave_idx_type i = 0; i < n; i++) + { + labels.push_back(args(i).string_value ()); + } + } + vibes::axisLabels (labels, figureName); +} + +void newFigure (const octave_value_list args) +{ + switch (args.length ()) + { + case 0: + __assertDrawing__ (); + vibes::newFigure (); + break; + case 1: + if (args(0).is_string ()) + { + __assertDrawing__ (); + vibes::newFigure (args(0).string_value ()); + } + else + error ("Figure expects a string as an argument"); + break; + default: + error ("newFigure: Wrong number of arguments"); + return; + } +} + +void drawBox (const octave_value_list args) +{ + if (args.length () == 0) + { + error ("drawBox: Not enough arguments"); + return; + } + + __assertDrawing__ (); + if (args(0).is_string ()) + { + error ("drawBox: First argument must contain numeric boundaries"); + return; + } + + std::vector coordinates; + octave_idx_type options_idx; + if ((args(0).rows () == 2 || args(0).columns () == 2) && + (args.length () == 1 || args(1).is_string ())) + { + // Single box, coordinates given in columns or rows + Matrix box = args(0).matrix_value (); + // Give precedence to coordinates in rows + if (box.columns () == 2) + box = box.transpose (); + + const octave_idx_type n = box.numel (); + coordinates.reserve (n); + // Add elements in the order x_lb, x_ub, y_lb, y_ub, z_lb, z_ub, ... + for (octave_idx_type i = 0; i < n; i ++) + { + coordinates.push_back (box.elem (i)); + } + options_idx = 1; + } + else + { + // Single boxes, boundaries given as seperate parameters + for (options_idx = 0; options_idx < args.length () && + ! args(options_idx).is_string (); options_idx ++) + { + coordinates.push_back (args(options_idx).scalar_value ()); + } + } + + vibes::Params params; + std::string format; + for (; options_idx < args.length (); options_idx ++) + { + if (! args(options_idx).is_string ()) + { + error ("drawBox: Parameter expected to be a string"); + return; + } + if (args(options_idx).string_value () == "figure") + { + options_idx ++; + if (options_idx < args.length () && + args(options_idx).is_string ()) + { + std::string figure = args(options_idx).string_value (); + params["figure"] = figure; + } + else + { + error ("drawBox: Missing argument after 'figure'"); + return; + } + } + else + format += args(options_idx).string_value (); + } + + vibes::drawBox(coordinates, format, params); +} + +void drawLine (const octave_value_list args) +{ + if (args.length () == 0) + { + error ("drawLine: Not enough arguments"); + return; + } + + __assertDrawing__ (); + if (args(0).is_string ()) + { + error ("drawLine: First argument must contain numeric boundaries"); + return; + } + + std::vector< std::vector > coordinates; + std::vector point; + const Matrix line = args(0).matrix_value (); + const octave_idx_type n = line.rows (); + const octave_idx_type m = line.columns (); + coordinates.reserve (n); + point.reserve (m); + for (octave_idx_type i = 0; i < n; i ++) + { + point.clear (); + for (octave_idx_type coordinate = 0; coordinate < m; coordinate ++) + { + point.push_back (line.elem (i, coordinate)); + } + coordinates.push_back (point); + } + + vibes::Params params; + std::string format; + for (octave_idx_type arg = 1; arg < args.length (); arg ++) + { + if (! args(arg).is_string ()) + { + error ("drawLine: Parameter expected to be a string"); + return; + } + if (args(arg).string_value () == "figure") + { + arg ++; + if (arg < args.length () && + args(arg).is_string ()) + { + std::string figure = args(arg).string_value (); + params["figure"] = figure; + } + else + { + error ("drawLine: Missing argument after 'figure'"); + return; + } + } + else + format += args(arg).string_value (); + } + + vibes::drawLine(coordinates, format, params); +} + +DEFUN_DLD (__vibes__, args, nargout, + "-*- texinfo -*-\n" + "@deftypefn {Loadable Function} {} __vibes__ (@var{function}, @dots{})\n" + "This internal function is a wrapper around VIBes' client API and " + "will be called by the public functions in the @code{+vibes} package.\n" + "\n" + "Please use @code{help vibes.@var{function}} for the documentation.\n" + "@end deftypefn" + ) +{ + const int nargin = args.length (); + if (nargin < 1 || ! args(0).is_string ()) + { + print_usage (); + return octave_value_list (); + } + + // This function is just a dispatcher for the other functions + const std::string f_name = args(0).string_value (); + const octave_value_list f_args = args.slice (1, args.length () - 1); + try + { + if (f_name == "drawBox") + drawBox (f_args); + else if (f_name == "drawLine") + drawLine (f_args); + else if (f_name == "axisAuto") + axisAuto (f_args); + else if (f_name == "axisLabels") + axisLabels (f_args); + else if (f_name == "beginDrawing") + beginDrawing (f_args); + else if (f_name == "endDrawing") + endDrawing (f_args); + else if (f_name == "newFigure") + newFigure (f_args); + else + error ("This particular VIBes function is not supported"); + } + catch (std::exception& e) + { + error (e.what ()); + } + catch (...) + { + error ("Exception occurred inside vibes client api"); + } + + return octave_value_list (); +} From 9ae9ab2e8b3681c6487a011237efed107f9e255d Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Thu, 12 Nov 2015 19:56:35 +0100 Subject: [PATCH 02/17] Added Makefile for Octave API --- client-api/Octave/.gitattributes | 3 + client-api/Octave/.gitignore | 5 ++ client-api/Octave/Makefile | 125 +++++++++++++++++++++++++++++++ 3 files changed, 133 insertions(+) create mode 100644 client-api/Octave/.gitattributes create mode 100644 client-api/Octave/.gitignore create mode 100644 client-api/Octave/Makefile diff --git a/client-api/Octave/.gitattributes b/client-api/Octave/.gitattributes new file mode 100644 index 0000000..2b1f21c --- /dev/null +++ b/client-api/Octave/.gitattributes @@ -0,0 +1,3 @@ +.* export-ignore +/Makefile export-ignore + diff --git a/client-api/Octave/.gitignore b/client-api/Octave/.gitignore new file mode 100644 index 0000000..f26770e --- /dev/null +++ b/client-api/Octave/.gitignore @@ -0,0 +1,5 @@ +vibes-*.tar.gz +vibes-html/** +fntest.log +octave-* + diff --git a/client-api/Octave/Makefile b/client-api/Octave/Makefile new file mode 100644 index 0000000..34ba37a --- /dev/null +++ b/client-api/Octave/Makefile @@ -0,0 +1,125 @@ +SHELL = /bin/sh + +## Copyright 2015 Oliver Heimlich +## +## This file is part of VIBes' API for Octave. +## +## VIBes' API for Octave 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. +## +## VIBes' API for Octave 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 VIBes' API for Octave. +## If not, see . + +CUT ?= cut +PACKAGE = $(shell grep "^Name: " DESCRIPTION | $(CUT) -f2 -d" ") +VERSION = $(shell grep "^Version: " DESCRIPTION | $(CUT) -f2 -d" ") +DATE = $(shell grep "^Date: " DESCRIPTION | $(CUT) -f2 -d" ") + +## +## Release Process +## +## Create a tarball distribution for the Octave package +## + +GZIP ?= gzip +RELEASE_TARBALL = $(PACKAGE)-$(VERSION).tar.gz + +.PHONY: dist +dist: $(RELEASE_TARBALL) + +$(RELEASE_TARBALL): ../../.git/index + @echo "Creating package release ..." + @# Export the current subdir of the source repository + @# This is only the Octave API + @git archive --output="$(PACKAGE)-$(VERSION).tar" --prefix="$(PACKAGE)-$(VERSION)/" HEAD + @# The C++ API must be bundled + @(cd ../C++/; git archive --output="$(shell pwd)/$(PACKAGE)-deps.tar" --prefix="$(PACKAGE)-$(VERSION)/" HEAD src) + @tar --concatenate --file="$(PACKAGE)-$(VERSION).tar" "$(PACKAGE)-deps.tar" + @$(GZIP) --best -f -k "$(PACKAGE)-$(VERSION).tar" + @rm "$(PACKAGE)-$(VERSION).tar" "$(PACKAGE)-deps.tar" + +## +## Local Install Process +## +## Do a local installation for testing in Octave, this will compile the package +## + +OCTAVE ?= octave +MKOCTFILE ?= mkoctfile -Wall +INSTALLED_PACKAGE_DIR = ~/octave/$(PACKAGE)-$(VERSION) +INSTALLED_PACKAGE = $(INSTALLED_PACKAGE_DIR)/packinfo/DESCRIPTION + +.PHONY: install +install: $(INSTALLED_PACKAGE) + +$(INSTALLED_PACKAGE): $(RELEASE_TARBALL) + @echo "Installing package in GNU Octave ..." + @$(OCTAVE) --no-gui --silent --eval "pkg install $<" + +## +## Publishing Process +## +## Also generate package documentation for the release +## + +HTML_DIR = $(PACKAGE)-html +HTML_TARBALL = $(HTML_DIR).tar.gz + +.PHONY: html release md5 +html: $(HTML_TARBALL) +release: $(RELEASE_TARBALL) $(HTML_TARBALL) md5 + +$(HTML_TARBALL): $(INSTALLED_PACKAGE) + @echo "Generating HTML documentation for the package ..." + @# Make sure that the generate_html package is present + @$(OCTAVE) --no-gui --silent \ + --eval "try;" \ + --eval "temp = pkg ('describe', 'generate_html');" \ + --eval "catch;" \ + --eval "pkg ('install', '-forge', 'generate_html');" \ + --eval "end_try_catch;" + @$(OCTAVE) --no-gui --silent \ + --eval "pkg load generate_html;" \ + --eval "options = get_html_options ('octave-forge');" \ + --eval "generate_package_html ('$(PACKAGE)', '$(HTML_DIR)', options)" + @tar --create --auto-compress --file "$@" "$(HTML_DIR)" + +md5: $(RELEASE_TARBALL) $(HTML_TARBALL) + @md5sum $^ + +## +## Testing Process +## +## Interactive shell with the package installed and loaded +## + +.PHONY: run + +run: $(INSTALLED_PACKAGE) + @echo "Run GNU Octave with the development version of the package" + @$(OCTAVE) --no-gui --silent --eval "pkg load $(PACKAGE)" --persist + @echo + +## +## Cleanup +## + +.PHONY: clean + +clean: + rm -f \ + "$(PACKAGE)-*.tar" \ + "$(PACKAGE)-*.tar.gz" \ + "$(HTML_DIR)" \ + "$(HTML_TARBALL)" \ + "fntests.log" \ + "octave-*" + From 0dc0b3367ff6cec8316065da3e506ceb3ad6fc0d Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Thu, 12 Nov 2015 20:18:07 +0100 Subject: [PATCH 03/17] Fixed documentation errors in Octave API --- client-api/Octave/inst/+vibes/axisLabels.m | 4 ++-- client-api/Octave/inst/+vibes/drawBox.m | 11 +++++++---- client-api/Octave/inst/+vibes/drawLine.m | 4 +++- client-api/Octave/inst/+vibes/endDrawing.m | 1 + 4 files changed, 13 insertions(+), 7 deletions(-) diff --git a/client-api/Octave/inst/+vibes/axisLabels.m b/client-api/Octave/inst/+vibes/axisLabels.m index 48fcc6c..e02135b 100644 --- a/client-api/Octave/inst/+vibes/axisLabels.m +++ b/client-api/Octave/inst/+vibes/axisLabels.m @@ -21,10 +21,10 @@ ## @deftypefn {Function File} {} vibes.axisLabels (@var{label1}, @var{label2}, @dots{}) ## @deftypefnx {Function File} {} vibes.axisLabels (@{@var{label1}, @var{label2}, @dots{}@}) ## Set axis labels for the current VIBes figure. +## @end deftypefn ## -## @deftypefnx {Function File} {} vibes.axisLabels (@{@var{label1}, @var{label2}, @dots{}@}, @var{figure}) +## @deftypefn {Function File} {} vibes.axisLabels (@{@var{label1}, @var{label2}, @dots{}@}, @var{figure}) ## Set axis labels for given VIBes figure. -## ## @end deftypefn function axisLabels (varargin) diff --git a/client-api/Octave/inst/+vibes/drawBox.m b/client-api/Octave/inst/+vibes/drawBox.m index f1dac3f..fdbf562 100644 --- a/client-api/Octave/inst/+vibes/drawBox.m +++ b/client-api/Octave/inst/+vibes/drawBox.m @@ -22,15 +22,18 @@ ## Plot a single box with pairs of lower bounds and upper bounds. The matrix ## @var{box} must be of size either @option{[2 @var{n}]} or ## @option{[@var{n} 2]}, where @var{n} is the number of axes. +## @end deftypefn ## -## @deftypefnx {Function File} {} vibes.drawBox (@var{x_lb}, @var{x_ub}, @var{y_lb}, @var{y_ub}) -## @deftypefnx {Function File} {} vibes.drawBox (@var{x_lb}, @var{x_ub}, @var{y_lb}, @var{y_ub}, @var{z_lb}, @var{z_ub}) +## @deftypefn {Function File} {} vibes.drawBox (@var{x_lb}, @var{x_ub}, @var{y_lb}, @var{y_ub}) +## @deftypefnx {Function File} {} vibes.drawBox (@var{x_lb}, @var{x_ub}, @var{y_lb}, @var{y_ub}, @var{z_lb}, @var{z_ub}) ## Plot a single box. +## @end deftypefn ## -## @deftypefnx {Function File} {} vibes.drawBox (@dots{}, 'figure', @var{name}) +## @deftypefn {Function File} {} vibes.drawBox (@dots{}, 'figure', @var{name}) ## Do the plotting inside a given VIBes figure +## @end deftypefn ## -## @deftypefnx {Function File} {} vibes.drawBox (@dots{}, @var{format}) +## @deftypefn {Function File} {} vibes.drawBox (@dots{}, @var{format}) ## Customize the plotting using VIBes format strings. ## @end deftypefn function drawBox (varargin) diff --git a/client-api/Octave/inst/+vibes/drawLine.m b/client-api/Octave/inst/+vibes/drawLine.m index 9c562e2..5aaa8ec 100644 --- a/client-api/Octave/inst/+vibes/drawLine.m +++ b/client-api/Octave/inst/+vibes/drawLine.m @@ -20,11 +20,13 @@ ## @documentencoding UTF-8 ## @deftypefn {Function File} {} vibes.drawLine (@var{points}) ## Plot a line with coordinate points given as rows of a matrix. +## @end deftypefn ## ## @deftypefn {Function File} {} vibes.drawLine (@dots{}, 'figure', @var{name}) ## Do the plotting inside a given VIBes figure +## @end deftypefn ## -## @deftypefnx {Function File} {} vibes.drawLine (@dots{}, @var{format}) +## @deftypefn {Function File} {} vibes.drawLine (@dots{}, @var{format}) ## Customize the plotting using VIBes format strings. ## @end deftypefn function drawLine (varargin) diff --git a/client-api/Octave/inst/+vibes/endDrawing.m b/client-api/Octave/inst/+vibes/endDrawing.m index da444a1..f6b1df7 100644 --- a/client-api/Octave/inst/+vibes/endDrawing.m +++ b/client-api/Octave/inst/+vibes/endDrawing.m @@ -26,6 +26,7 @@ ## vibes.endDrawing ## @end group ## @end example +## @end deftypefn function endDrawing () if (nargin != 0) From bda36820318dcae6574fad9249e66a758f75de0c Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Thu, 12 Nov 2015 20:28:43 +0100 Subject: [PATCH 04/17] Added release of Octave API to Travis script --- .travis.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index 1762304..f39849b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -19,13 +19,13 @@ install: - if [ $TRAVIS_OS_NAME == linux ]; then sudo sh /tmp/cmake-2.8.12.1-Linux-i386.sh --prefix=/usr/local/ --exclude-subdir --skip-license; fi before_script: - - cd viewer - - mkdir build - - cd build + - mkdir -p viewer/build - cmake --version - - cmake ../ + - (cd viewer/build && cmake ..) -script: make +script: + - make -C viewer/build + - make -C client-api/Octave os: - linux From cce28ab0bbff24ed3a22d01b7dada671ef26c74c Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Thu, 12 Nov 2015 20:46:29 +0100 Subject: [PATCH 05/17] Added compilation of Octave API to Travis script --- .travis.yml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.travis.yml b/.travis.yml index f39849b..135bf5e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,6 +6,7 @@ compiler: before_install: - if [ $TRAVIS_OS_NAME == linux ]; then sudo apt-add-repository --yes ppa:ubuntu-sdk-team/ppa; fi + - if [ $TRAVIS_OS_NAME == linux ]; then sudo add-apt-repository --yes ppa:octave/stable; fi - if [ $TRAVIS_OS_NAME == linux ]; then sudo apt-get update -qq > output; fi - if [ $TRAVIS_OS_NAME == osx ]; then brew update && brew install qt5 && export PATH=/usr/local/opt/qt5/bin:$PATH; fi @@ -13,6 +14,8 @@ install: - if [ $TRAVIS_OS_NAME == linux ]; then sudo apt-get install -qq qt5-default libqt5svg5-dev > output; fi # 32 bit compatibility (since CMake is a 32 bit bin) - if [ $TRAVIS_OS_NAME == linux ]; then sudo apt-get install -qq libc6:i386; fi +# Install Octave for test of client API + - if [ $TRAVIS_OS_NAME == linux ]; then sudo apt-get install -qq octave liboctave-dev; fi # Install CMake bin (32 bit) - if [ $TRAVIS_OS_NAME == linux ]; then wget --no-check-certificate -P /tmp http://www.cmake.org/files/v2.8/cmake-2.8.12.1-Linux-i386.sh; fi - if [ $TRAVIS_OS_NAME == linux ]; then chmod +rx /tmp/cmake-2.8.12.1-Linux-i386.sh; fi @@ -26,6 +29,10 @@ before_script: script: - make -C viewer/build - make -C client-api/Octave + - if [ $TRAVIS_OS_NAME == linux ]; then make -C client-api/Octave install; fi + +after_success: + - if [ $TRAVIS_OS_NAME == linux ]; then make -C client-api/Octave html; fi os: - linux From a9d0a69d5e15902b18eb81ae053fd264d20380c8 Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Thu, 12 Nov 2015 21:07:07 +0100 Subject: [PATCH 06/17] Fixed Travis build errors --- .travis.yml | 1 - client-api/Octave/Makefile | 4 ++-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 135bf5e..b708928 100644 --- a/.travis.yml +++ b/.travis.yml @@ -28,7 +28,6 @@ before_script: script: - make -C viewer/build - - make -C client-api/Octave - if [ $TRAVIS_OS_NAME == linux ]; then make -C client-api/Octave install; fi after_success: diff --git a/client-api/Octave/Makefile b/client-api/Octave/Makefile index 34ba37a..892d52a 100644 --- a/client-api/Octave/Makefile +++ b/client-api/Octave/Makefile @@ -43,8 +43,8 @@ $(RELEASE_TARBALL): ../../.git/index @# The C++ API must be bundled @(cd ../C++/; git archive --output="$(shell pwd)/$(PACKAGE)-deps.tar" --prefix="$(PACKAGE)-$(VERSION)/" HEAD src) @tar --concatenate --file="$(PACKAGE)-$(VERSION).tar" "$(PACKAGE)-deps.tar" - @$(GZIP) --best -f -k "$(PACKAGE)-$(VERSION).tar" - @rm "$(PACKAGE)-$(VERSION).tar" "$(PACKAGE)-deps.tar" + @$(GZIP) --best -f "$(PACKAGE)-$(VERSION).tar" + @rm -f "$(PACKAGE)-$(VERSION).tar" "$(PACKAGE)-deps.tar" ## ## Local Install Process From b996466bd06eb2354db20a591c62b87dd57d3929 Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Thu, 12 Nov 2015 22:46:28 +0100 Subject: [PATCH 07/17] Octave API: Added support for interval arithmetic libraries --- client-api/Octave/DESCRIPTION | 3 ++- client-api/Octave/Makefile | 2 +- client-api/Octave/inst/+vibes/drawBox.m | 23 +++++++++++++++++++++-- 3 files changed, 24 insertions(+), 4 deletions(-) diff --git a/client-api/Octave/DESCRIPTION b/client-api/Octave/DESCRIPTION index 6289cde..dc53801 100644 --- a/client-api/Octave/DESCRIPTION +++ b/client-api/Octave/DESCRIPTION @@ -17,6 +17,7 @@ Description: VIBes is a visualization system that aims at providing people program to communicate with the viewer in order to draw figures. This package integrates the VIBes API into Octave. The VIBes application - is required for operation and must be installed seperately. + is required for operation and must be installed seperately. Data types from + third-party interval arithmetic libraries for Octave are also supportd. Depends: octave (>= 4.0.0) License: GPLv3+ diff --git a/client-api/Octave/Makefile b/client-api/Octave/Makefile index 892d52a..4f7a818 100644 --- a/client-api/Octave/Makefile +++ b/client-api/Octave/Makefile @@ -115,7 +115,7 @@ run: $(INSTALLED_PACKAGE) .PHONY: clean clean: - rm -f \ + rm -rf \ "$(PACKAGE)-*.tar" \ "$(PACKAGE)-*.tar.gz" \ "$(HTML_DIR)" \ diff --git a/client-api/Octave/inst/+vibes/drawBox.m b/client-api/Octave/inst/+vibes/drawBox.m index fdbf562..5987248 100644 --- a/client-api/Octave/inst/+vibes/drawBox.m +++ b/client-api/Octave/inst/+vibes/drawBox.m @@ -19,9 +19,12 @@ ## -*- texinfo -*- ## @documentencoding UTF-8 ## @deftypefn {Function File} {} vibes.drawBox (@var{box}) -## Plot a single box with pairs of lower bounds and upper bounds. The matrix -## @var{box} must be of size either @option{[2 @var{n}]} or +## Plot a single box with pairs of lower bounds and upper bounds. +## +## The matrix @var{box} must be of size either @option{[2 @var{n}]} or ## @option{[@var{n} 2]}, where @var{n} is the number of axes. +## +## Alternatively @var{box} may be an interval vector. ## @end deftypefn ## ## @deftypefn {Function File} {} vibes.drawBox (@var{x_lb}, @var{x_ub}, @var{y_lb}, @var{y_ub}) @@ -42,6 +45,22 @@ function drawBox (varargin) print_usage (); endif +if (any (isa (varargin{1}, {'infsup', 'intval'}))) + varargin{1} = horzcat (vec (inf (varargin{1})), ... + vec (sup (varargin{1}))); + ## Stack multiple intervals into a common box + for i = 2 : nargin + if (any (isa (varargin{2}, {'infsup', 'intval'}))) + varargin = {vertcat(varargin{1}, ... + horzcat (vec (inf (varargin{2})), ... + vec (sup (varargin{2})))), ... + varargin{3:end}}; + else + break + endif + endfor +endif + __vibes__ ('drawBox', varargin{:}); endfunction From 16bd1c2416d68b1dec47c672d37d1d23a7970f7b Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Fri, 13 Nov 2015 06:19:17 +0100 Subject: [PATCH 08/17] Advertise Octave API in README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d88134d..781a9c8 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ The main design goal of VIBes is to be cross-platform, available from different VIBes consists in two parts: - the VIBes application that features viewing, annotating and exporting figures -- the VIBes API that enables your program to communicate with the viewer in order to draw figures from C, C++, Python, Matlab... +- the VIBes API that enables your program to communicate with the viewer in order to draw figures from C, C++, Python, Octave, Matlab... The use of a separate viewer application enables an easy set-up on every system. First, pre-built binaries of the VIBes viewer are provided for Windows, MacOS and Linux platforms (but you are free to build the viewer from sources). Then, the API consists only of a few files that have to be included in your program. From 0353c7ae346fbdd88cc1751bf0ffaa6a9d390ae3 Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Fri, 13 Nov 2015 07:34:05 +0100 Subject: [PATCH 09/17] Simplified Octave API distribution --- .travis.yml | 1 + client-api/Octave/.gitignore | 1 + client-api/Octave/Makefile | 20 ++++++++++---------- 3 files changed, 12 insertions(+), 10 deletions(-) diff --git a/.travis.yml b/.travis.yml index b708928..135bf5e 100644 --- a/.travis.yml +++ b/.travis.yml @@ -28,6 +28,7 @@ before_script: script: - make -C viewer/build + - make -C client-api/Octave - if [ $TRAVIS_OS_NAME == linux ]; then make -C client-api/Octave install; fi after_success: diff --git a/client-api/Octave/.gitignore b/client-api/Octave/.gitignore index f26770e..1f85430 100644 --- a/client-api/Octave/.gitignore +++ b/client-api/Octave/.gitignore @@ -1,4 +1,5 @@ vibes-*.tar.gz +vibes-bundle/** vibes-html/** fntest.log octave-* diff --git a/client-api/Octave/Makefile b/client-api/Octave/Makefile index 4f7a818..86397e7 100644 --- a/client-api/Octave/Makefile +++ b/client-api/Octave/Makefile @@ -37,14 +37,14 @@ dist: $(RELEASE_TARBALL) $(RELEASE_TARBALL): ../../.git/index @echo "Creating package release ..." - @# Export the current subdir of the source repository - @# This is only the Octave API - @git archive --output="$(PACKAGE)-$(VERSION).tar" --prefix="$(PACKAGE)-$(VERSION)/" HEAD @# The C++ API must be bundled - @(cd ../C++/; git archive --output="$(shell pwd)/$(PACKAGE)-deps.tar" --prefix="$(PACKAGE)-$(VERSION)/" HEAD src) - @tar --concatenate --file="$(PACKAGE)-$(VERSION).tar" "$(PACKAGE)-deps.tar" - @$(GZIP) --best -f "$(PACKAGE)-$(VERSION).tar" - @rm -f "$(PACKAGE)-$(VERSION).tar" "$(PACKAGE)-deps.tar" + @rm -rf "$(PACKAGE)-bundle" + @mkdir -p "$(PACKAGE)-bundle" + @git archive --format=tar --prefix="$(PACKAGE)-$(VERSION)/" HEAD | \ + (cd "$(PACKAGE)-bundle" && tar xf -) + @(cd ../C++/; git archive --format=tar --prefix="$(PACKAGE)-$(VERSION)/" HEAD src) | \ + (cd "$(PACKAGE)-bundle" && tar xf -) + @(cd "$(PACKAGE)-bundle" && tar czf "../$@" "$(PACKAGE)-$(VERSION)") ## ## Local Install Process @@ -116,10 +116,10 @@ run: $(INSTALLED_PACKAGE) clean: rm -rf \ - "$(PACKAGE)-*.tar" \ - "$(PACKAGE)-*.tar.gz" \ + $(PACKAGE)-*.tar.gz \ + "$(PACKAGE)-bundle" \ "$(HTML_DIR)" \ "$(HTML_TARBALL)" \ "fntests.log" \ - "octave-*" + octave-* From 8fc3f955265d747365085f1a1e344522127ade02 Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Fri, 13 Nov 2015 21:36:30 +0100 Subject: [PATCH 10/17] Genrate octave-api documentation for website --- client-api/Octave/Makefile | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/client-api/Octave/Makefile b/client-api/Octave/Makefile index 86397e7..1081385 100644 --- a/client-api/Octave/Makefile +++ b/client-api/Octave/Makefile @@ -88,8 +88,13 @@ $(HTML_TARBALL): $(INSTALLED_PACKAGE) --eval "end_try_catch;" @$(OCTAVE) --no-gui --silent \ --eval "pkg load generate_html;" \ - --eval "options = get_html_options ('octave-forge');" \ + --eval "options = get_html_options ('octave');" \ + --eval "options.overview_title = 'VIBes Client API for Octave';" \ + --eval "options.css = '/sylesheets/style.css';" \ + --eval "options.header = 'VIBes Client API for Octave - %title

%title

';" \ + --eval "options.footer = '';" \ --eval "generate_package_html ('$(PACKAGE)', '$(HTML_DIR)', options)" + @mv "$(HTML_DIR)/$(PACKAGE)" "$(HTML_DIR)/octave-api" @tar --create --auto-compress --file "$@" "$(HTML_DIR)" md5: $(RELEASE_TARBALL) $(HTML_TARBALL) From 3809000ccba143287b06610f3cf6fc2d7d7d857a Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Fri, 13 Nov 2015 21:59:02 +0100 Subject: [PATCH 11/17] Improved DESCRIPTION generation for octave-api * Use version number from C++ api * Use current date for release date * Shortened package description --- client-api/Octave/DESCRIPTION | 15 +++++---------- client-api/Octave/Makefile | 6 ++++-- 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/client-api/Octave/DESCRIPTION b/client-api/Octave/DESCRIPTION index dc53801..edadb90 100644 --- a/client-api/Octave/DESCRIPTION +++ b/client-api/Octave/DESCRIPTION @@ -1,16 +1,11 @@ Name: vibes -Version: 0.2.0 -Date: 2015-11-12 +Version: %VERSION% +Date: %DATE% Author: Oliver Heimlich Maintainer: ENSTA Bretagne Robotics Title: Interface to VIBes, Visualizer for Intervals and Boxes -Description: VIBes is a visualization system that aims at providing people - working with interval methods a way to display results (boxes, pavings), - without worrying with GUI programming. It provides drawing functions - accessible from a lot of programming languages, without complex installation - and library dependencies. The main design goal of VIBes is to be - cross-platform, available from different programming languages, simple to - set-up, easy to port to a new language. +Description: The VIBes API allows one to easily display results (boxes, pavings) + from interval methods. VIBes consists in two parts: (1) the VIBes application that features viewing, annotating and exporting figures, and (2) the VIBes API that enables your @@ -18,6 +13,6 @@ Description: VIBes is a visualization system that aims at providing people This package integrates the VIBes API into Octave. The VIBes application is required for operation and must be installed seperately. Data types from - third-party interval arithmetic libraries for Octave are also supportd. + third-party interval arithmetic libraries for Octave are also supported. Depends: octave (>= 4.0.0) License: GPLv3+ diff --git a/client-api/Octave/Makefile b/client-api/Octave/Makefile index 1081385..8257306 100644 --- a/client-api/Octave/Makefile +++ b/client-api/Octave/Makefile @@ -20,8 +20,8 @@ SHELL = /bin/sh CUT ?= cut PACKAGE = $(shell grep "^Name: " DESCRIPTION | $(CUT) -f2 -d" ") -VERSION = $(shell grep "^Version: " DESCRIPTION | $(CUT) -f2 -d" ") -DATE = $(shell grep "^Date: " DESCRIPTION | $(CUT) -f2 -d" ") +VERSION = $(shell grep "^/// \\\\version " ../C++/src/vibes.h | $(CUT) -f3 -d" " | sed -e "s/[^0-9.]//g") +DATE = $(shell date "+%Y-%m-%d") ## ## Release Process @@ -44,6 +44,8 @@ $(RELEASE_TARBALL): ../../.git/index (cd "$(PACKAGE)-bundle" && tar xf -) @(cd ../C++/; git archive --format=tar --prefix="$(PACKAGE)-$(VERSION)/" HEAD src) | \ (cd "$(PACKAGE)-bundle" && tar xf -) + @sed -i -e "s/%VERSION%/$(VERSION)/" "$(PACKAGE)-bundle/$(PACKAGE)-$(VERSION)/DESCRIPTION" + @sed -i -e "s/%DATE%/$(DATE)/" "$(PACKAGE)-bundle/$(PACKAGE)-$(VERSION)/DESCRIPTION" @(cd "$(PACKAGE)-bundle" && tar czf "../$@" "$(PACKAGE)-$(VERSION)") ## From 3afa02b88db297d07f61188640437af090d62e47 Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Fri, 13 Nov 2015 22:44:43 +0100 Subject: [PATCH 12/17] Added unit tests for octave-api --- .travis.yml | 4 +- client-api/Octave/.gitignore | 2 +- client-api/Octave/Makefile | 27 ++++++++++- client-api/Octave/inst/+vibes/axisAuto.m | 5 ++ client-api/Octave/inst/+vibes/axisLabels.m | 8 ++++ client-api/Octave/inst/+vibes/beginDrawing.m | 10 ++++ client-api/Octave/inst/+vibes/drawBox.m | 50 ++++++++++++++++++++ client-api/Octave/inst/+vibes/drawLine.m | 13 +++++ client-api/Octave/inst/+vibes/endDrawing.m | 5 ++ client-api/Octave/inst/+vibes/newFigure.m | 8 ++++ 10 files changed, 127 insertions(+), 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index 135bf5e..27b3ce7 100644 --- a/.travis.yml +++ b/.travis.yml @@ -15,7 +15,7 @@ install: # 32 bit compatibility (since CMake is a 32 bit bin) - if [ $TRAVIS_OS_NAME == linux ]; then sudo apt-get install -qq libc6:i386; fi # Install Octave for test of client API - - if [ $TRAVIS_OS_NAME == linux ]; then sudo apt-get install -qq octave liboctave-dev; fi + - if [ $TRAVIS_OS_NAME == linux ]; then sudo apt-get install -qq octave liboctave-dev libmpfr-dev; fi # Install CMake bin (32 bit) - if [ $TRAVIS_OS_NAME == linux ]; then wget --no-check-certificate -P /tmp http://www.cmake.org/files/v2.8/cmake-2.8.12.1-Linux-i386.sh; fi - if [ $TRAVIS_OS_NAME == linux ]; then chmod +rx /tmp/cmake-2.8.12.1-Linux-i386.sh; fi @@ -29,7 +29,7 @@ before_script: script: - make -C viewer/build - make -C client-api/Octave - - if [ $TRAVIS_OS_NAME == linux ]; then make -C client-api/Octave install; fi + - if [ $TRAVIS_OS_NAME == linux ]; then make -C client-api/Octave check; fi after_success: - if [ $TRAVIS_OS_NAME == linux ]; then make -C client-api/Octave html; fi diff --git a/client-api/Octave/.gitignore b/client-api/Octave/.gitignore index 1f85430..91870c9 100644 --- a/client-api/Octave/.gitignore +++ b/client-api/Octave/.gitignore @@ -1,6 +1,6 @@ vibes-*.tar.gz vibes-bundle/** vibes-html/** -fntest.log +fntests.log octave-* diff --git a/client-api/Octave/Makefile b/client-api/Octave/Makefile index 8257306..e16e903 100644 --- a/client-api/Octave/Makefile +++ b/client-api/Octave/Makefile @@ -105,16 +105,39 @@ md5: $(RELEASE_TARBALL) $(HTML_TARBALL) ## ## Testing Process ## -## Interactive shell with the package installed and loaded +## Interactive shell with the package installed and loaded / +## Non-interactive processing of integrated unit tests ## -.PHONY: run +.PHONY: run check +PUBLIC_FUNCTIONS = $(patsubst inst/%.m,%,$(wildcard inst/+vibes/*.m)) run: $(INSTALLED_PACKAGE) @echo "Run GNU Octave with the development version of the package" @$(OCTAVE) --no-gui --silent --eval "pkg load $(PACKAGE)" --persist @echo +check: $(INSTALLED_PACKAGE) + @echo "Testing package in GNU Octave ..." + @# Make sure that the interval package is present, some tests depend on this + @$(OCTAVE) --no-gui --silent \ + --eval "try;" \ + --eval "temp = pkg ('describe', 'interval');" \ + --eval "catch;" \ + --eval "pkg ('install', '-forge', 'interval');" \ + --eval "end_try_catch;" + @rm -f ~/.vibes.json + @$(OCTAVE) --no-gui --silent \ + --eval "pkg load $(PACKAGE);" \ + --eval "success = true;" \ + --eval "targets = strsplit ('$(PUBLIC_FUNCTIONS)', ' ');" \ + --eval "for target = targets;" \ + --eval "[n, nmax] = test (target{1}, 'verbose');" \ + --eval "success &= (n == nmax);" \ + --eval "endfor;" \ + --eval "exit (not (success));" + @cat ~/.vibes.json + ## ## Cleanup ## diff --git a/client-api/Octave/inst/+vibes/axisAuto.m b/client-api/Octave/inst/+vibes/axisAuto.m index 81653fb..48cd74d 100644 --- a/client-api/Octave/inst/+vibes/axisAuto.m +++ b/client-api/Octave/inst/+vibes/axisAuto.m @@ -30,3 +30,8 @@ function axisAuto () __vibes__ ('axisAuto'); endfunction + +%!test +%! vibes.beginDrawing +%! vibes.axisAuto +%! vibes.endDrawing diff --git a/client-api/Octave/inst/+vibes/axisLabels.m b/client-api/Octave/inst/+vibes/axisLabels.m index e02135b..acf33e2 100644 --- a/client-api/Octave/inst/+vibes/axisLabels.m +++ b/client-api/Octave/inst/+vibes/axisLabels.m @@ -35,3 +35,11 @@ function axisLabels (varargin) __vibes__ ('axisLabels', varargin{:}); endfunction + +%!shared +%! vibes.beginDrawing +%!test vibes.axisLabels ('x', 'y', 'z') +%!test vibes.axisLabels ({'x', 'y', 'z'}) +%!test vibes.axisLabels ({'a', 'b', 'c'}, 'alphabet') +%!shared +%! vibes.endDrawing diff --git a/client-api/Octave/inst/+vibes/beginDrawing.m b/client-api/Octave/inst/+vibes/beginDrawing.m index f01dbbc..aa84dbb 100644 --- a/client-api/Octave/inst/+vibes/beginDrawing.m +++ b/client-api/Octave/inst/+vibes/beginDrawing.m @@ -60,3 +60,13 @@ function beginDrawing (filename) endswitch endfunction + +%!test +%! vibes.beginDrawing +%! vibes.endDrawing +%!warning vibes.beginDrawing; vibes.beginDrawing; vibes.endDrawing +%!test +%! vibes.beginDrawing ('.vibes-custom.json') +%! assert (exist ('.vibes-custom.json', 'file')) +%! vibes.endDrawing +%! delete ('.vibes-custom.json') diff --git a/client-api/Octave/inst/+vibes/drawBox.m b/client-api/Octave/inst/+vibes/drawBox.m index 5987248..bf59465 100644 --- a/client-api/Octave/inst/+vibes/drawBox.m +++ b/client-api/Octave/inst/+vibes/drawBox.m @@ -64,3 +64,53 @@ function drawBox (varargin) __vibes__ ('drawBox', varargin{:}); endfunction + +%!shared x,y,z +%! vibes.beginDrawing +%! x = [ 0 2 ; ... +%! 7 22 ]; +%! y = [ 1 2 3 4 ; ... +%! 2 3 4 5 ]; +%! z = [ 1 2 ; ... +%! 3 4 ; ... +%! 5 6 ; ... +%! 7 8 ]; +%!test vibes.drawBox (x) +%!test vibes.drawBox (y) +%!test vibes.drawBox (z) +%!test vibes.drawBox (-1, 0, 1, 2) +%!test vibes.drawBox (-1, 0, 1, 2, 4, 5) +%!shared +%! vibes.endDrawing + +%!shared ix,iy,iz,dx,dy,dz,rx,ry,rz +%! pkg load interval +%! vibes.beginDrawing +%! x = [ 0 2 ; ... +%! 7 22 ]; +%! y = [ 1 2 3 4 ; ... +%! 2 3 4 5 ]; +%! z = [ 1 2 ; ... +%! 3 4 ; ... +%! 5 6 ; ... +%! 7 8 ]; +%! ix = infsup (x) +%! iy = infsup (y) +%! iz = infsup (z) +%! dx = infsupdec (x) +%! dy = infsupdec (y) +%! dz = infsupdec (z) +%! rx = infsup (x, x + 100) +%! ry = infsup (y, y + 100) +%! rz = infsup (z, z + 100) +%!test vibes.drawBox (ix) +%!test vibes.drawBox (iy) +%!test vibes.drawBox (iz) +%!test vibes.drawBox (dx) +%!test vibes.drawBox (dy) +%!test vibes.drawBox (dz) +%!test vibes.drawBox (rx) +%!test vibes.drawBox (ry) +%!test vibes.drawBox (rz) +%!shared +%! vibes.endDrawing diff --git a/client-api/Octave/inst/+vibes/drawLine.m b/client-api/Octave/inst/+vibes/drawLine.m index 5aaa8ec..30b3df1 100644 --- a/client-api/Octave/inst/+vibes/drawLine.m +++ b/client-api/Octave/inst/+vibes/drawLine.m @@ -38,3 +38,16 @@ function drawLine (varargin) __vibes__ ('drawLine', varargin{:}); endfunction + +%!shared x +%! vibes.beginDrawing +%! x = [ 0 0 ; ... +%! 1 1 ; ... +%! 2 2 ]; +%!test vibes.drawLine (x) +%!test vibes.drawLine (x, 'figure', 'foo') +%!test vibes.drawLine (x, 'red') +%!test vibes.drawLine (x, 'figure', 'bar', 'blue') +%!test vibes.drawLine (x, 'green', 'figure', 'baz') +%!shared +%! vibes.endDrawing diff --git a/client-api/Octave/inst/+vibes/endDrawing.m b/client-api/Octave/inst/+vibes/endDrawing.m index f6b1df7..95f3eaf 100644 --- a/client-api/Octave/inst/+vibes/endDrawing.m +++ b/client-api/Octave/inst/+vibes/endDrawing.m @@ -36,3 +36,8 @@ function endDrawing () __vibes__ ('endDrawing'); endfunction + +%!test +%! vibes.beginDrawing +%! vibes.endDrawing +%!warning vibes.endDrawing diff --git a/client-api/Octave/inst/+vibes/newFigure.m b/client-api/Octave/inst/+vibes/newFigure.m index 3dfc489..8ef61ee 100644 --- a/client-api/Octave/inst/+vibes/newFigure.m +++ b/client-api/Octave/inst/+vibes/newFigure.m @@ -34,3 +34,11 @@ function newFigure (name) endswitch endfunction + +%!shared +%! vibes.beginDrawing +%!test vibes.newFigure +%!test vibes.newFigure ('Foobar') +%!test vibes.newFigure +%!shared +%! vibes.endDrawing From 12013e1ecdafa1092788bd891276d39173d0303e Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Thu, 3 Dec 2015 19:55:21 +0100 Subject: [PATCH 13/17] drawBoxes.m: Added new function to Octave API --- client-api/Octave/inst/+vibes/drawBoxes.m | 54 +++++++++++++++++++++++ client-api/Octave/src/__vibes__.cpp | 39 ++++++++++++++++ 2 files changed, 93 insertions(+) create mode 100644 client-api/Octave/inst/+vibes/drawBoxes.m diff --git a/client-api/Octave/inst/+vibes/drawBoxes.m b/client-api/Octave/inst/+vibes/drawBoxes.m new file mode 100644 index 0000000..552fa4c --- /dev/null +++ b/client-api/Octave/inst/+vibes/drawBoxes.m @@ -0,0 +1,54 @@ +## Copyright 2015 Oliver Heimlich +## +## This file is part of VIBes' API for Octave. +## +## VIBes' API for Octave 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. +## +## VIBes' API for Octave 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 VIBes' API for Octave. +## If not, see . + +## -*- texinfo -*- +## @documentencoding UTF-8 +## @deftypefn {Function File} {} vibes.drawBoxes (@var{lb}, @var{ub}) +## @deftypefnx {Function File} {} vibes.drawBoxes (@var{x_lb}, @var{x_ub}, @var{y_lb}, @var{y_ub}) +## @deftypefnx {Function File} {} vibes.drawBoxes (@var{x_lb}, @var{x_ub}, @var{y_lb}, @var{y_ub}, @var{z_lb}, @var{z_ub}) +## Plot several boxes with pairs of lower bounds and upper bounds. +## +## The matrices @var{lb} and @var{ub} must be of compatible size +## @var{n}×@var{m}, where @var{n} is the number of dimensions of the boxes and +## @var{m} is the number of boxes to plot. +## @end deftypefn +## +## @deftypefn {Function File} {} vibes.drawBox (@var{boxes}) +## When @var{boxes} is an interval matrix, each column represents a box. +## @end deftypefn +## +## @deftypefn {Function File} {} vibes.drawBox (@dots{}, 'figure', @var{name}) +## Do the plotting inside a given VIBes figure +## @end deftypefn +## +## @deftypefn {Function File} {} vibes.drawBox (@dots{}, @var{format}) +## Customize the plotting using VIBes format strings. +## @end deftypefn +function drawBoxes (varargin) + +if (nargin == 0) + print_usage (); +endif + +if (any (isa (varargin{1}, {'infsup', 'intval'}))) + varargin = {inf(varargin{1}), sup(varargin{1})}; +endif + +__vibes__ ('drawBoxes', varargin{:}); + +endfunction diff --git a/client-api/Octave/src/__vibes__.cpp b/client-api/Octave/src/__vibes__.cpp index 84c77d5..d317ea0 100644 --- a/client-api/Octave/src/__vibes__.cpp +++ b/client-api/Octave/src/__vibes__.cpp @@ -253,6 +253,43 @@ void drawBox (const octave_value_list args) vibes::drawBox(coordinates, format, params); } +void drawBoxes (const octave_value_list args) +{ + if (args.length () == 0) + { + error ("drawBoxes: Not enough arguments"); + return; + } + + __assertDrawing__ (); + if (args(0).is_string ()) + { + error ("drawBoxes: First argument must contain numeric boundaries"); + return; + } + + const Matrix lb = args(0).matrix_value (); + const Matrix ub = args(1).matrix_value (); + + std::vector< std::vector > boxes; + const octave_idx_type n = lb.columns (); // TODO broadcasting + const octave_idx_type m = lb.rows (); + boxes.reserve (n); + for (octave_idx_type i = 0; i < n; i ++) + { + std::vector coordinates; + coordinates.reserve (2 * m); + for (octave_idx_type j = 0; j < m; j ++) + { + coordinates.push_back (lb.elem (j, i)); + coordinates.push_back (ub.elem (j, i)); + } + boxes.push_back (coordinates); + } + + vibes::drawBoxes(boxes); +} + void drawLine (const octave_value_list args) { if (args.length () == 0) @@ -340,6 +377,8 @@ DEFUN_DLD (__vibes__, args, nargout, { if (f_name == "drawBox") drawBox (f_args); + else if (f_name == "drawBoxes") + drawBoxes (f_args); else if (f_name == "drawLine") drawLine (f_args); else if (f_name == "axisAuto") From 80180b9e2ba8349cc2bbd127f27d23d17e7af5ae Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Wed, 22 Jun 2016 07:09:45 +0200 Subject: [PATCH 14/17] maint: Updated Octave API copyright dates --- client-api/Octave/Makefile | 2 +- client-api/Octave/inst/+vibes/axisAuto.m | 2 +- client-api/Octave/inst/+vibes/axisLabels.m | 2 +- client-api/Octave/inst/+vibes/beginDrawing.m | 2 +- client-api/Octave/inst/+vibes/drawBox.m | 2 +- client-api/Octave/inst/+vibes/drawBoxes.m | 2 +- client-api/Octave/inst/+vibes/drawLine.m | 2 +- client-api/Octave/inst/+vibes/endDrawing.m | 2 +- client-api/Octave/inst/+vibes/newFigure.m | 2 +- client-api/Octave/src/Makefile | 2 +- client-api/Octave/src/__vibes__.cpp | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) diff --git a/client-api/Octave/Makefile b/client-api/Octave/Makefile index e16e903..a0a4218 100644 --- a/client-api/Octave/Makefile +++ b/client-api/Octave/Makefile @@ -1,6 +1,6 @@ SHELL = /bin/sh -## Copyright 2015 Oliver Heimlich +## Copyright 2015-2016 Oliver Heimlich ## ## This file is part of VIBes' API for Octave. ## diff --git a/client-api/Octave/inst/+vibes/axisAuto.m b/client-api/Octave/inst/+vibes/axisAuto.m index 48cd74d..4883637 100644 --- a/client-api/Octave/inst/+vibes/axisAuto.m +++ b/client-api/Octave/inst/+vibes/axisAuto.m @@ -1,4 +1,4 @@ -## Copyright 2015 Oliver Heimlich +## Copyright 2015-2016 Oliver Heimlich ## ## This file is part of VIBes' API for Octave. ## diff --git a/client-api/Octave/inst/+vibes/axisLabels.m b/client-api/Octave/inst/+vibes/axisLabels.m index acf33e2..0d14b27 100644 --- a/client-api/Octave/inst/+vibes/axisLabels.m +++ b/client-api/Octave/inst/+vibes/axisLabels.m @@ -1,4 +1,4 @@ -## Copyright 2015 Oliver Heimlich +## Copyright 2015-2016 Oliver Heimlich ## ## This file is part of VIBes' API for Octave. ## diff --git a/client-api/Octave/inst/+vibes/beginDrawing.m b/client-api/Octave/inst/+vibes/beginDrawing.m index aa84dbb..d7f15eb 100644 --- a/client-api/Octave/inst/+vibes/beginDrawing.m +++ b/client-api/Octave/inst/+vibes/beginDrawing.m @@ -1,4 +1,4 @@ -## Copyright 2015 Oliver Heimlich +## Copyright 2015-2016 Oliver Heimlich ## ## This file is part of VIBes' API for Octave. ## diff --git a/client-api/Octave/inst/+vibes/drawBox.m b/client-api/Octave/inst/+vibes/drawBox.m index bf59465..4daf0d2 100644 --- a/client-api/Octave/inst/+vibes/drawBox.m +++ b/client-api/Octave/inst/+vibes/drawBox.m @@ -1,4 +1,4 @@ -## Copyright 2015 Oliver Heimlich +## Copyright 2015-2016 Oliver Heimlich ## ## This file is part of VIBes' API for Octave. ## diff --git a/client-api/Octave/inst/+vibes/drawBoxes.m b/client-api/Octave/inst/+vibes/drawBoxes.m index 552fa4c..18d2cbe 100644 --- a/client-api/Octave/inst/+vibes/drawBoxes.m +++ b/client-api/Octave/inst/+vibes/drawBoxes.m @@ -1,4 +1,4 @@ -## Copyright 2015 Oliver Heimlich +## Copyright 2015-2016 Oliver Heimlich ## ## This file is part of VIBes' API for Octave. ## diff --git a/client-api/Octave/inst/+vibes/drawLine.m b/client-api/Octave/inst/+vibes/drawLine.m index 30b3df1..f7d109a 100644 --- a/client-api/Octave/inst/+vibes/drawLine.m +++ b/client-api/Octave/inst/+vibes/drawLine.m @@ -1,4 +1,4 @@ -## Copyright 2015 Oliver Heimlich +## Copyright 2015-2016 Oliver Heimlich ## ## This file is part of VIBes' API for Octave. ## diff --git a/client-api/Octave/inst/+vibes/endDrawing.m b/client-api/Octave/inst/+vibes/endDrawing.m index 95f3eaf..65e5492 100644 --- a/client-api/Octave/inst/+vibes/endDrawing.m +++ b/client-api/Octave/inst/+vibes/endDrawing.m @@ -1,4 +1,4 @@ -## Copyright 2015 Oliver Heimlich +## Copyright 2015-2016 Oliver Heimlich ## ## 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 diff --git a/client-api/Octave/inst/+vibes/newFigure.m b/client-api/Octave/inst/+vibes/newFigure.m index 8ef61ee..f0d7ff2 100644 --- a/client-api/Octave/inst/+vibes/newFigure.m +++ b/client-api/Octave/inst/+vibes/newFigure.m @@ -1,4 +1,4 @@ -## Copyright 2015 Oliver Heimlich +## Copyright 2015-2016 Oliver Heimlich ## ## This file is part of VIBes' API for Octave. ## diff --git a/client-api/Octave/src/Makefile b/client-api/Octave/src/Makefile index 36ccc67..a3436a4 100644 --- a/client-api/Octave/src/Makefile +++ b/client-api/Octave/src/Makefile @@ -1,6 +1,6 @@ SHELL = /bin/sh -## Copyright 2015 Oliver Heimlich +## Copyright 2015-2016 Oliver Heimlich ## ## This file is part of VIBes' API for Octave. ## diff --git a/client-api/Octave/src/__vibes__.cpp b/client-api/Octave/src/__vibes__.cpp index d317ea0..592aeca 100644 --- a/client-api/Octave/src/__vibes__.cpp +++ b/client-api/Octave/src/__vibes__.cpp @@ -1,4 +1,4 @@ -// Copyright 2015 Oliver Heimlich +// Copyright 2015-2016 Oliver Heimlich // // This file is part of VIBes' API for Octave. // From 5c03dbb07f0a3ac84ef13c85ae52285e56566809 Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Wed, 22 Jun 2016 07:20:36 +0200 Subject: [PATCH 15/17] maint: NEWS: Prepeare release for Octave --- client-api/Octave/NEWS | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/client-api/Octave/NEWS b/client-api/Octave/NEWS index d886a2b..9373c05 100644 --- a/client-api/Octave/NEWS +++ b/client-api/Octave/NEWS @@ -1,7 +1,8 @@ VIBes' Client API for Octave Summary of important user-visible changes -Version 0.2.0 2015-11-12 +Version 0.2.0 2016-06-22 ======================== • Initial release with compatibility for the Matlab client API + • New function drawBoxes to draw a list of many boxes From 6127df2055a65bd51e56d38817c08bcdf904e979 Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Wed, 22 Jun 2016 07:45:25 +0200 Subject: [PATCH 16/17] maint: octave-api/DESCRIPTION: Clarified licensing with SPDX license IDs --- client-api/Octave/DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client-api/Octave/DESCRIPTION b/client-api/Octave/DESCRIPTION index edadb90..26d2405 100644 --- a/client-api/Octave/DESCRIPTION +++ b/client-api/Octave/DESCRIPTION @@ -15,4 +15,4 @@ Description: The VIBes API allows one to easily display results (boxes, pavings) is required for operation and must be installed seperately. Data types from third-party interval arithmetic libraries for Octave are also supported. Depends: octave (>= 4.0.0) -License: GPLv3+ +License: GPL-3.0+, MIT From 145094b45a115bcd1f60ca5f5f5c39e7845efc83 Mon Sep 17 00:00:00 2001 From: Oliver Heimlich Date: Wed, 22 Jun 2016 08:36:23 +0200 Subject: [PATCH 17/17] maint: octave-api/Makefile: Generate documentation for Octave Forge --- client-api/Octave/Makefile | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/client-api/Octave/Makefile b/client-api/Octave/Makefile index a0a4218..29d4fca 100644 --- a/client-api/Octave/Makefile +++ b/client-api/Octave/Makefile @@ -74,13 +74,16 @@ $(INSTALLED_PACKAGE): $(RELEASE_TARBALL) HTML_DIR = $(PACKAGE)-html HTML_TARBALL = $(HTML_DIR).tar.gz +FORGE_HTML_TARBALL = $(HTML_DIR)-forge.tar.gz -.PHONY: html release md5 +.PHONY: forge-html html release md5 +forge-html: $(FORGE_HTML_TARBALL) html: $(HTML_TARBALL) -release: $(RELEASE_TARBALL) $(HTML_TARBALL) md5 +release: $(RELEASE_TARBALL) $(FORGE_HTML_TARBALL) $(HTML_TARBALL) md5 $(HTML_TARBALL): $(INSTALLED_PACKAGE) - @echo "Generating HTML documentation for the package ..." + @echo "Generating HTML documentation for the package (GitHub) ..." + @$(RM) -r "$(HTML_DIR)" @# Make sure that the generate_html package is present @$(OCTAVE) --no-gui --silent \ --eval "try;" \ @@ -99,7 +102,23 @@ $(HTML_TARBALL): $(INSTALLED_PACKAGE) @mv "$(HTML_DIR)/$(PACKAGE)" "$(HTML_DIR)/octave-api" @tar --create --auto-compress --file "$@" "$(HTML_DIR)" -md5: $(RELEASE_TARBALL) $(HTML_TARBALL) +$(FORGE_HTML_TARBALL): $(INSTALLED_PACKAGE) + @echo "Generating HTML documentation for the package (Octave Forge) ..." + @$(RM) -r "$(HTML_DIR)" + @# Make sure that the generate_html package is present + @$(OCTAVE) --no-gui --silent \ + --eval "try;" \ + --eval "temp = pkg ('describe', 'generate_html');" \ + --eval "catch;" \ + --eval "pkg ('install', '-forge', 'generate_html');" \ + --eval "end_try_catch;" + @$(OCTAVE) --no-gui --silent \ + --eval "pkg load generate_html;" \ + --eval "options = get_html_options ('octave-forge');" \ + --eval "generate_package_html ('$(PACKAGE)', '$(HTML_DIR)', options)" + @tar --create --auto-compress --file "$@" "$(HTML_DIR)" + +md5: $(RELEASE_TARBALL) $(HTML_TARBALL) $(FORGE_HTML_TARBALL) @md5sum $^ ##