From f62d201f0f6bc314148c2d4305bb6630333f187e Mon Sep 17 00:00:00 2001 From: Samuel Audet Date: Wed, 20 May 2020 16:41:26 +0900 Subject: [PATCH] Initial commit --- .gitignore | 2 + .travis.yml | 27 + CHANGELOG.md | 2 + LICENSE.txt | 572 ++++++++++++++++++ README.md | 81 +++ build.gradle | 128 ++++ samples/zlib/build.gradle | 37 ++ samples/zlib/build.sh | 50 ++ samples/zlib/settings.gradle | 11 + .../java/org/bytedeco/zlib/presets/zlib.java | 33 + .../test/java/org/bytedeco/zlib/UnitTest.java | 11 + settings.gradle | 1 + .../gradle/javacpp/BuildExecutor.java | 78 +++ .../bytedeco/gradle/javacpp/BuildPlugin.java | 138 +++++ .../bytedeco/gradle/javacpp/BuildTask.java | 232 +++++++ .../gradle/javacpp/BuildPluginTest.java | 46 ++ 16 files changed, 1449 insertions(+) create mode 100644 .gitignore create mode 100644 .travis.yml create mode 100644 CHANGELOG.md create mode 100644 LICENSE.txt create mode 100644 README.md create mode 100644 build.gradle create mode 100644 samples/zlib/build.gradle create mode 100755 samples/zlib/build.sh create mode 100644 samples/zlib/settings.gradle create mode 100644 samples/zlib/src/main/java/org/bytedeco/zlib/presets/zlib.java create mode 100644 samples/zlib/src/test/java/org/bytedeco/zlib/UnitTest.java create mode 100644 settings.gradle create mode 100644 src/main/java/org/bytedeco/gradle/javacpp/BuildExecutor.java create mode 100644 src/main/java/org/bytedeco/gradle/javacpp/BuildPlugin.java create mode 100644 src/main/java/org/bytedeco/gradle/javacpp/BuildTask.java create mode 100644 src/test/java/org/bytedeco/gradle/javacpp/BuildPluginTest.java diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5943f70 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +**/.gradle/** +**/build/** diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..b78740a --- /dev/null +++ b/.travis.yml @@ -0,0 +1,27 @@ +dist: xenial +before_cache: + - rm -f $HOME/.gradle/caches/modules-2/modules-2.lock + - rm -fr $HOME/.gradle/caches/*/plugin-resolution/ +cache: + directories: + - $HOME/.m2/repository/ + - $HOME/.gradle/caches/ + - $HOME/.gradle/wrapper/ +language: java +jdk: openjdk8 + +before_install: + - > + if [[ "$TRAVIS_PULL_REQUEST" != "false" ]]; then + export GRADLE_PUBLISH="publishToMavenLocal"; + elif [[ "$TRAVIS_BRANCH" != "release" ]]; then + export GRADLE_PUBLISH="publish"; + else + curl -L "https://drive.google.com/uc?export=download&id=$GDOWNLOAD_ID" -o $HOME/settings.tar.gz; + tar -xzf $HOME/settings.tar.gz -C $HOME; + export GNUPGHOME="$HOME/.gnupg/"; + export GRADLE_PUBLISH="publish"; + fi + +script: + - gradle build $GRADLE_PUBLISH diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..1ff4bce --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,2 @@ + +Initial release diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..c513065 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,572 @@ +You may use this work under the terms of either the Apache License, +Version 2.0, or the GNU General Public License (GPL), either version 2, +or any later version, with "Classpath" exception (details below). + +You don't have to do anything special to choose one license or the other +and you don't have to notify anyone which license you are using. You are +free to use this work in any project (even commercial projects) as long +as the copyright header is left intact. + +=============================================================================== + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +=============================================================================== + + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. 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. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the 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 a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE 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. + + 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 +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 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, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision 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, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This 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. + + +"CLASSPATH" EXCEPTION TO THE GPL + + Linking this library statically or dynamically with other modules is making + a combined work based on this library. Thus, the terms and conditions of + the GNU General Public License cover the whole combination. + + As a special exception, the copyright holders of this library give you + permission to link this library with independent modules to produce an + executable, regardless of the license terms of these independent modules, + and to copy and distribute the resulting executable under terms of your + choice, provided that you also meet, for each linked independent module, + the terms and conditions of the license of that module. An independent + module is a module which is not derived from or based on this library. If + you modify this library, you may extend this exception to your version of + the library, but you are not obligated to do so. If you do not wish to do + so, delete this exception statement from your version. diff --git a/README.md b/README.md new file mode 100644 index 0000000..8937413 --- /dev/null +++ b/README.md @@ -0,0 +1,81 @@ +Gradle JavaCPP +============== + +[![Gitter](https://badges.gitter.im/bytedeco/javacpp.svg)](https://gitter.im/bytedeco/javacpp) [![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.bytedeco/gradle-javacpp/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.bytedeco/gradle-javacpp) [![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/https/oss.sonatype.org/org.bytedeco/gradle-javacpp.svg)](http://bytedeco.org/builds/) [![Build Status](https://travis-ci.org/bytedeco/gradle-javacpp.svg?branch=master)](https://travis-ci.org/bytedeco/gradle-javacpp) + + +Introduction +------------ +Gradle JavaCPP offers plugins that make it easy to use [JavaCPP](https://github.com/bytedeco/javacpp) as part of the Gradle build system. + +Please feel free to ask questions on [the mailing list](http://groups.google.com/group/javacpp-project) if you encounter any problems with the software! I am sure it is far from perfect... + + +Required Software +----------------- +To use Gradle JavaCPP, you will need to download and install the following software: + + * An implementation of Java SE 8 or newer: + * OpenJDK http://openjdk.java.net/install/ or + * Oracle JDK http://www.oracle.com/technetwork/java/javase/downloads/ or + * IBM JDK http://www.ibm.com/developerworks/java/jdk/ + * A C++ compiler, out of which these have been tested: + * GNU C/C++ Compiler (Linux, etc.) http://gcc.gnu.org/ + * For Windows x86 and x64 http://mingw-w64.org/ + * LLVM Clang (Mac OS X, etc.) http://clang.llvm.org/ + * Microsoft C/C++ Compiler, part of Visual Studio https://visualstudio.microsoft.com/ + * https://docs.microsoft.com/en-us/cpp/build/walkthrough-compiling-a-native-cpp-program-on-the-command-line + * Gradle 5.0 or newer: https://gradle.org/releases/ + +To produce binary files for Android 4.0 or newer, you will also have to install: + + * Android NDK r7 or newer http://developer.android.com/ndk/downloads/ + +And similarly to target iOS, you will need to install either: + + * Gluon VM http://gluonhq.com/products/mobile/vm/ or + * RoboVM 1.x or newer http://robovm.mobidevelop.com/downloads/ + + +Getting Started +--------------- +To understand how [JavaCPP](https://github.com/bytedeco/javacpp) is meant to be used, one should first take a look at the [Mapping Recipes for C/C++ Libraries](https://github.com/bytedeco/javacpp/wiki/Mapping-Recipes), but a high-level overview of the [Basic Architecture](https://github.com/bytedeco/javacpp/wiki/Basic-Architecture) is also available to understand the bigger picture. + +Once comfortable enough with the command line interface, the build plugin for Gradle can be used to integrate easily that workflow as part of `build.gradle` as shown below. By default, it creates a `javacppJar` task that archives the native libraries into a separate JAR file and sets its classifier to `$javacppPlatform`, while excluding those files from the default `jar` task. To customize the behavior, there are properties and extensions that can be modified and whose documentation is available as part of the source code in these files: + * [`BuildTask.java`](src/main/java/org/bytedeco//gradle/javacpp/BuildTask.java) + * [`BuildPlugin.java`](src/main/java/org/bytedeco//gradle/javacpp/BuildPlugin.java) + +Fully functional sample projects are also provided in the [`samples`](samples) subdirectory and can be used as templates. + +```groovy +plugins { + id 'java-library' + id 'org.bytedeco.gradle-javacpp-build' version "$javacppVersion" +} + +dependencies { + api "org.bytedeco:javacpp:$javacppVersion" +} + +tasks.withType(org.bytedeco.gradle.javacpp.BuildTask) { + // set here default values for all build tasks below, typically just includePath and linkPath +} + +javacppBuildCommand { + // typically set here the buildCommand to the script that fills up includePath and linkPath +} + +javacppBuildParser { + // typically set here the classOrPackageNames to class names implementing InfoMap +} + +javacppBuildCompiler { + // typically set here boolean flags like copyLibs +} +``` + + +---- +Project lead: Samuel Audet [samuel.audet `at` gmail.com](mailto:samuel.audet at gmail.com) +Developer site: https://github.com/bytedeco/gradle-javacpp +Discussion group: http://groups.google.com/group/javacpp-project diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..6bbf186 --- /dev/null +++ b/build.gradle @@ -0,0 +1,128 @@ +plugins { + id 'java-library' + id 'java-gradle-plugin' + id 'maven-publish' + id 'signing' +} + +group = 'org.bytedeco' +version = '1.5.4-SNAPSHOT' + +repositories { + mavenLocal() + mavenCentral() + maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' } +} + +dependencies { + api "org.bytedeco:javacpp:$version" + testImplementation 'junit:junit:4.12' +} + +gradlePlugin { + plugins { + build { + id = 'org.bytedeco.gradle-javacpp-build' + implementationClass = 'org.bytedeco.gradle.javacpp.BuildPlugin' + } + } +} + +jar { + manifest { + attributes 'Implementation-Title': 'Gradle JavaCPP', + 'Implementation-Vendor': 'Bytedeco', + 'Implementation-Version': version, + 'Specification-Title': 'Gradle JavaCPP', + 'Specification-Vendor': 'Bytedeco', + 'Specification-Version': version + } +} + +javadoc { + options.memberLevel = JavadocMemberLevel.PRIVATE + options.links = ['https://docs.oracle.com/javase/8/docs/api', + 'https://docs.gradle.org/current/javadoc', + 'http://bytedeco.org/javacpp/apidocs', + 'http://junit.org/junit4/javadoc/4.12'] +} + +//java { +// withJavadocJar() +// withSourcesJar() +//} + +task javadocJar(type: Jar, dependsOn: javadoc) { + classifier = 'javadoc' + from javadoc.destinationDir +} + +task sourcesJar(type: Jar, dependsOn: classes) { + classifier = 'sources' + from sourceSets.main.allSource +} + +artifacts { + archives javadocJar + archives sourcesJar +} + +signing { + if (!version.endsWith('SNAPSHOT')) sign publishing.publications.mavenJava +} + +publishing { + publications { + mavenJava(MavenPublication) { + from components.java + artifact javadocJar + artifact sourcesJar + pom { + name = 'Gradle JavaCPP' + description = 'Gradle plugins to automate the build process of JavaCPP' + url = 'http://bytedeco.org/gradle-javacpp/' + licenses { + license { + name = 'Apache License, Version 2.0' + url = 'http://www.apache.org/licenses/LICENSE-2.0' + distribution = 'repo' + } + license { + name = 'GNU General Public License (GPL) version 2, or any later version' + url = 'http://www.gnu.org/licenses/' + distribution = 'repo' + } + license { + name = 'GPLv2 with Classpath exception' + url = 'http://www.gnu.org/software/classpath/license.html' + distribution = 'repo' + } + } + developers { + developer { + id = 'saudet' + name = 'Samuel Audet' + email = 'samuel.audet@gmail.com' + } + } + scm { + url = 'https://github.com/bytedeco/gradle-javacpp' + connection = 'scm:git:git://github.com/bytedeco/gradle-javacpp.git' + developerConnection = 'scm:git:ssh://git@github.com/bytedeco/gradle-javacpp.git' + } + } + } + } + repositories { + maven { + def releasesRepoUrl = 'https://oss.sonatype.org/service/local/staging/deploy/maven2/' + def snapshotsRepoUrl = 'https://oss.sonatype.org/content/repositories/snapshots/' + url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl + credentials { + username System.getenv('CI_DEPLOY_USERNAME') + password System.getenv('CI_DEPLOY_PASSWORD') + } + } + } +} + diff --git a/samples/zlib/build.gradle b/samples/zlib/build.gradle new file mode 100644 index 0000000..573f08f --- /dev/null +++ b/samples/zlib/build.gradle @@ -0,0 +1,37 @@ +plugins { + id 'java-library' + id 'org.bytedeco.gradle-javacpp-build' version '1.5.4-SNAPSHOT' +} + +group = 'org.bytedeco' +version = "1.2.11-$javacppVersion" + +repositories { + mavenLocal() + mavenCentral() + maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' } +} + +dependencies { + api "org.bytedeco:javacpp:$javacppVersion" +// api "org.bytedeco:javacpp:$javacppVersion:$javacppPlatform" + testImplementation 'junit:junit:4.12' +} + +tasks.withType(org.bytedeco.gradle.javacpp.BuildTask) { + includePath = ["$buildDir/$javacppPlatform/include"] + linkPath = ["$buildDir/$javacppPlatform/lib"] +} + +javacppBuildCommand { + buildCommand = ['bash', 'build.sh'] +} + +javacppBuildParser { + classOrPackageNames = ['org.bytedeco.zlib.presets.*'] +} + +javacppBuildCompiler { + copyLibs = true +} + diff --git a/samples/zlib/build.sh b/samples/zlib/build.sh new file mode 100755 index 0000000..334c135 --- /dev/null +++ b/samples/zlib/build.sh @@ -0,0 +1,50 @@ +#!/bin/bash +set -e + +mkdir -p build/$PLATFORM +cd build/$PLATFORM + +ZLIB_VERSION=1.2.11 +if [[ ! -e "zlib-$ZLIB_VERSION.tar.gz" ]]; then + curl -L "http://zlib.net/zlib-$ZLIB_VERSION.tar.gz" -o "zlib-$ZLIB_VERSION.tar.gz" +fi +echo "c3e5e9fdd5004dcb542feda5ee4f0ff0744628baf8ed2dd5d66f8ca1197cb1a1 zlib-$ZLIB_VERSION.tar.gz" | shasum -a 256 -c - + +echo "Decompressing archives..." +tar --totals -xf "zlib-$ZLIB_VERSION.tar.gz" +cd zlib-$ZLIB_VERSION + +case $PLATFORM in + linux-x86) + CC="gcc -m32 -fPIC" ./configure --prefix=.. --static + make -j $MAKEJ + make install + ;; + linux-x86_64) + CC="gcc -m64 -fPIC" ./configure --prefix=.. --static + make -j $MAKEJ + make install + ;; + macosx-x86_64) + ./configure --prefix=.. --static + make -j $MAKEJ + make install + ;; + windows-x86) + nmake -f win32/Makefile.msc zlib.lib + mkdir -p ../include ../lib + cp zconf.h zlib.h ../include/ + cp zlib.lib ../lib/ + ;; + windows-x86_64) + nmake -f win32/Makefile.msc zlib.lib + mkdir -p ../include ../lib + cp zconf.h zlib.h ../include/ + cp zlib.lib ../lib/ + ;; + *) + echo "Error: Platform \"$PLATFORM\" is not supported" + ;; +esac + +cd ../../.. diff --git a/samples/zlib/settings.gradle b/samples/zlib/settings.gradle new file mode 100644 index 0000000..ba35f37 --- /dev/null +++ b/samples/zlib/settings.gradle @@ -0,0 +1,11 @@ +pluginManagement { + repositories { + mavenLocal() + mavenCentral() + maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' } + } +} + +rootProject.name = 'zlib' + +gradle.rootProject { ext.javacppVersion = '1.5.4-SNAPSHOT' } diff --git a/samples/zlib/src/main/java/org/bytedeco/zlib/presets/zlib.java b/samples/zlib/src/main/java/org/bytedeco/zlib/presets/zlib.java new file mode 100644 index 0000000..092eb30 --- /dev/null +++ b/samples/zlib/src/main/java/org/bytedeco/zlib/presets/zlib.java @@ -0,0 +1,33 @@ +package org.bytedeco.zlib.presets; + +import org.bytedeco.javacpp.*; +import org.bytedeco.javacpp.annotation.*; +import org.bytedeco.javacpp.tools.*; + +@Properties( + value = { + @Platform(include = "", link = "z@.1#"), + @Platform(value = "windows", link = "zlib#") + }, + target = "org.bytedeco.zlib", + global = "org.bytedeco.zlib.global.zlib" +) +public class zlib implements InfoMapper { + static { Loader.checkVersion("org.bytedeco", "zlib"); } + + public void map(InfoMap infoMap) { + infoMap.put(new Info("ZEXTERN", "ZEXPORT", "z_const", "zlib_version").cppTypes().annotations()) + .put(new Info("FAR").cppText("#define FAR")) + .put(new Info("OF").cppText("#define OF(args) args")) + .put(new Info("Z_ARG").cppText("#define Z_ARG(args) args")) + .put(new Info("Byte", "Bytef", "charf").cast().valueTypes("byte").pointerTypes("BytePointer")) + .put(new Info("uInt", "uIntf").cast().valueTypes("int").pointerTypes("IntPointer")) + .put(new Info("uLong", "uLongf", "z_crc_t", "z_off_t", "z_size_t").cast().valueTypes("long").pointerTypes("CLongPointer")) + .put(new Info("z_off64_t").cast().valueTypes("long").pointerTypes("LongPointer")) + .put(new Info("voidp", "voidpc", "voidpf").valueTypes("Pointer")) + .put(new Info("gzFile_s").pointerTypes("gzFile")) + .put(new Info("gzFile").valueTypes("gzFile")) + .put(new Info("Z_LARGE64", "!defined(ZLIB_INTERNAL) && defined(Z_WANT64)").define(false)) + .put(new Info("inflateGetDictionary", "gzopen_w", "gzvprintf").skip()); + } +} diff --git a/samples/zlib/src/test/java/org/bytedeco/zlib/UnitTest.java b/samples/zlib/src/test/java/org/bytedeco/zlib/UnitTest.java new file mode 100644 index 0000000..c624220 --- /dev/null +++ b/samples/zlib/src/test/java/org/bytedeco/zlib/UnitTest.java @@ -0,0 +1,11 @@ +package org.bytedeco.zlib; + +import org.junit.Test; +import static org.bytedeco.zlib.global.zlib.*; + +public class UnitTest { + @Test public void test() { + System.out.println(zlibVersion().getString()); + } +} + diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..c19cfa3 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'gradle-javacpp' diff --git a/src/main/java/org/bytedeco/gradle/javacpp/BuildExecutor.java b/src/main/java/org/bytedeco/gradle/javacpp/BuildExecutor.java new file mode 100644 index 0000000..c7837e3 --- /dev/null +++ b/src/main/java/org/bytedeco/gradle/javacpp/BuildExecutor.java @@ -0,0 +1,78 @@ +/* + * Copyright (C) 2020 Samuel Audet + * + * Licensed either under the Apache License, Version 2.0, or (at your option) + * under the terms of the GNU General Public License as published by + * the Free Software Foundation (subject to the "Classpath" exception), + * either version 2, or any later version (collectively, the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * http://www.gnu.org/licenses/ + * http://www.gnu.org/software/classpath/license.html + * + * or as provided in the LICENSE.txt file that accompanied this code. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.bytedeco.gradle.javacpp; + +import java.io.File; +import java.io.IOException; +import java.util.List; +import java.util.Map; +import org.bytedeco.javacpp.tools.CommandExecutor; +import org.bytedeco.javacpp.tools.Logger; +import org.gradle.initialization.DefaultBuildCancellationToken; +import org.gradle.internal.concurrent.DefaultExecutorFactory; +import org.gradle.internal.concurrent.ManagedExecutor; +import org.gradle.internal.file.PathToFileResolver; +import org.gradle.process.internal.DefaultExecAction; + +/** + * Overrides use of ProcessBuilder with something that works within Gradle. + * + * @author Samuel Audet + */ +public class BuildExecutor extends CommandExecutor { + public BuildExecutor(Logger logger) { + super(logger); + } + + @Override public int executeCommand(List command, File workingDirectory, + Map environmentVariables) throws IOException, InterruptedException { + PathToFileResolver resolver = new PathToFileResolver() { + @Override public File resolve(Object path) { return (File)path; } + @Override public PathToFileResolver newResolver(File baseDir) { return this; } + @Override public boolean canResolveRelativePath() { return true; } + }; + ManagedExecutor executor = new DefaultExecutorFactory().create("BuildExecutor"); + try { + DefaultExecAction action = new DefaultExecAction(resolver, executor, new DefaultBuildCancellationToken()); + action.setCommandLine(command); + if (workingDirectory != null) { + action.workingDir(workingDirectory); + } else { + try { + action.workingDir(new File(".").getCanonicalFile()); + } catch (IOException ex) { + action.workingDir(new File(".").getAbsoluteFile()); + } + } + if (environmentVariables != null) { + for (Map.Entry e : environmentVariables.entrySet()) { + if (e.getKey() != null && e.getValue() != null) { + action.environment(e.getKey(), e.getValue()); + } + } + } + return action.execute().getExitValue(); + } finally { + executor.shutdownNow(); + } + } +} diff --git a/src/main/java/org/bytedeco/gradle/javacpp/BuildPlugin.java b/src/main/java/org/bytedeco/gradle/javacpp/BuildPlugin.java new file mode 100644 index 0000000..63d2a5b --- /dev/null +++ b/src/main/java/org/bytedeco/gradle/javacpp/BuildPlugin.java @@ -0,0 +1,138 @@ +/* + * Copyright (C) 2020 Samuel Audet + * + * Licensed either under the Apache License, Version 2.0, or (at your option) + * under the terms of the GNU General Public License as published by + * the Free Software Foundation (subject to the "Classpath" exception), + * either version 2, or any later version (collectively, the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * http://www.gnu.org/licenses/ + * http://www.gnu.org/software/classpath/license.html + * + * or as provided in the LICENSE.txt file that accompanied this code. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.bytedeco.gradle.javacpp; + +import java.io.File; +import java.io.IOException; +import java.util.Set; +import org.bytedeco.javacpp.Loader; +import org.gradle.api.Action; +import org.gradle.api.Project; +import org.gradle.api.Plugin; +import org.gradle.api.plugins.JavaPlugin; +import org.gradle.api.plugins.JavaPluginConvention; +import org.gradle.api.tasks.SourceSet; +import org.gradle.api.tasks.WriteProperties; +import org.gradle.api.tasks.bundling.Jar; +import org.gradle.api.tasks.compile.JavaCompile; + +/** + * This plugin defines the following extra properties: + *

    + *
  • "javacppPlatform", which defaults to {@link Loader.Detector#getPlatform()}, and + *
  • "javacppParserOutput", which defaults to "$buildDir/generated/sources/javacpp/"; + *

+ * + * and registers the following tasks: + *

    + *
  • "javacppBuildCommand" to execute {@link BuildTask#buildCommand}, + *
  • "javacppCompileJava" to compile classes needed by the parser, + *
  • "javacppBuildParser" to run the parser on these classes, + *
  • "javacppBuildCompiler" to generate and compile JNI code, + *
  • "javacppPomProperties" to write version information to pom.properties, and + *
  • "javacppJar" to archive the native libraries in a separate JAR file. + *

+ */ +public class BuildPlugin implements Plugin { + public void apply(Project project) { + if (!project.hasProperty("javacppPlatform")) { + project.getExtensions().getExtraProperties().set("javacppPlatform", Loader.Detector.getPlatform()); + } + if (!project.hasProperty("javacppParserOutput")) { + project.getExtensions().getExtraProperties().set("javacppParserOutput", new File(project.getBuildDir(), "generated/sources/javacpp/")); + } + + project.getPlugins().withType(JavaPlugin.class, new Action() { + public void execute(JavaPlugin javaPlugin) { + String platform = (String)project.findProperty("javacppPlatform"); + File parserOutput = (File)project.findProperty("javacppParserOutput"); + + JavaPluginConvention jc = project.getConvention().getPlugin(JavaPluginConvention.class); + SourceSet main = jc.getSourceSets().getByName("main"); + main.getJava().srcDir(parserOutput); + Set files = main.getOutput().getClassesDirs().getFiles(); + String[] paths = new String[files.size()]; + int n = 0; + for (File file : files) { + try { + paths[n++] = file.getCanonicalPath(); + } catch (IOException ex) { + paths[n++] = file.getAbsolutePath(); + } + } + + project.getTasks().register("javacppBuildCommand", BuildTask.class, task -> { + task.classPath = paths; + task.properties = platform; + task.classOrPackageNames = new String[0]; + }); + + project.getTasks().register("javacppCompileJava", JavaCompile.class, task -> { + task.setSource(main.getJava()); + task.setClasspath(main.getCompileClasspath()); + task.setDestinationDir(main.getJava().getOutputDir()); + task.dependsOn("javacppBuildCommand"); + }); + + project.getTasks().register("javacppBuildParser", BuildTask.class, task -> { + task.classPath = paths; + task.properties = platform; + task.outputDirectory = parserOutput; + task.dependsOn("javacppCompileJava"); + }); + + project.getTasks().getByName("compileJava").dependsOn("javacppBuildParser"); + + project.getTasks().register("javacppBuildCompiler", BuildTask.class, task -> { + task.classPath = paths; + task.properties = platform; + task.dependsOn("compileJava"); + }); + + project.getTasks().getByName("classes").dependsOn("javacppBuildCompiler"); + + project.getTasks().register("javacppPomProperties", WriteProperties.class, task -> { + Object group = project.findProperty("group"); + Object name = project.findProperty("name"); + Object version = project.findProperty("version"); + task.property("groupId", group); + task.property("artifactId", name); + task.property("version", version); + task.setOutputFile(new File(main.getOutput().getResourcesDir(), "META-INF/maven/" + group + "/" + name + "/pom.properties")); + }); + + Jar jarTask = (Jar)project.getTasks().getByName("jar"); + jarTask.dependsOn("javacppPomProperties"); + jarTask.exclude("**/" + platform + "/**"); + jarTask.finalizedBy("javacppJar"); + + Jar javacppJarTask = project.getTasks().create("javacppJar", Jar.class, task -> { + task.from(main.getOutput()); + task.setClassifier(platform); + task.include("**/" + platform + "/**"); + }); + + project.getArtifacts().add("archives", javacppJarTask); + } + }); + } +} diff --git a/src/main/java/org/bytedeco/gradle/javacpp/BuildTask.java b/src/main/java/org/bytedeco/gradle/javacpp/BuildTask.java new file mode 100644 index 0000000..7f61e2d --- /dev/null +++ b/src/main/java/org/bytedeco/gradle/javacpp/BuildTask.java @@ -0,0 +1,232 @@ +/* + * Copyright (C) 2020 Samuel Audet + * + * Licensed either under the Apache License, Version 2.0, or (at your option) + * under the terms of the GNU General Public License as published by + * the Free Software Foundation (subject to the "Classpath" exception), + * either version 2, or any later version (collectively, the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * http://www.gnu.org/licenses/ + * http://www.gnu.org/software/classpath/license.html + * + * or as provided in the LICENSE.txt file that accompanied this code. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.bytedeco.gradle.javacpp; + +import java.io.File; +import java.io.IOException; +import java.util.Arrays; +import java.util.Map; +import java.util.Properties; +import org.bytedeco.javacpp.Loader; +import org.bytedeco.javacpp.tools.Builder; +import org.bytedeco.javacpp.tools.Logger; +import org.bytedeco.javacpp.tools.ParserException; +import org.bytedeco.javacpp.tools.Slf4jLogger; +import org.gradle.api.DefaultTask; +import org.gradle.api.tasks.Classpath; +import org.gradle.api.tasks.Input; +import org.gradle.api.tasks.InputDirectory; +import org.gradle.api.tasks.InputFile; +import org.gradle.api.tasks.InputFiles; +import org.gradle.api.tasks.Optional; +import org.gradle.api.tasks.OutputDirectory; +import org.gradle.api.tasks.TaskAction; + +/** + * A Gradle task that wraps {@link Builder}. + */ +public class BuildTask extends DefaultTask { + /** Load user classes from classPath. */ + String[] classPath = null; + + /** Add the path to the "platform.includepath" property. */ + String[] includePath = null; + + /** Add the path to the "platform.includeresource" property. */ + String[] includeResource = null; + + /** Add the path to the "platform.buildpath" property. */ + String[] buildPath = null; + + /** Add the path to the "platform.buildresource" property. */ + String[] buildResource = null; + + /** Add the path to the "platform.linkpath" property. */ + String[] linkPath = null; + + /** Add the path to the "platform.linkresource" property. */ + String[] linkResource = null; + + /** Add the path to the "platform.preloadpath" property. */ + String[] preloadPath = null; + + /** Add the path to the "platform.preloadresource" property. */ + String[] preloadResource = null; + + /** Add the path to the "platform.resourcepath" property. */ + String[] resourcePath = null; + + /** Add the path to the "platform.executablepath" property. */ + String[] executablePath = null; + + /** Specify the character encoding used for input and output. */ + String encoding = null; + + /** Output all generated files to outputDirectory. */ + File outputDirectory = null; + + /** Output everything in a file named after given outputName. */ + String outputName = null; + + /** Delete all files from {@link #outputDirectory} before generating anything in it. */ + boolean clean = false; + + /** Generate .cpp files from Java interfaces if found, parsing from header files if not. */ + boolean generate = true; + + /** Compile and delete the generated .cpp files. */ + boolean compile = true; + + /** Delete generated C++ JNI files after compilation */ + boolean deleteJniFiles = true; + + /** Generate header file with declarations of callbacks functions. */ + boolean header = false; + + /** Copy to output directory dependent libraries (link and preload). */ + boolean copyLibs = false; + + /** Copy to output directory resources listed in properties. */ + boolean copyResources = false; + + /** Also create a JAR file named {@code -.jar}. */ + String jarPrefix = null; + + /** Load all properties from resource. */ + String properties = null; + + /** Load all properties from file. */ + File propertyFile = null; + + /** Set property keys to values. */ + Properties propertyKeysAndValues = null; + + /** Process only these classes or packages (suffixed with .* or .**). */ + String[] classOrPackageNames = null; + + /** Execute a build command instead of JavaCPP itself, and return. */ + String[] buildCommand = null; + + /** Add to Maven project source directory of Java files generated by buildCommand. */ + String[] targetDirectory = null; + + /** Set the working directory of the build subprocess. */ + File workingDirectory = null; + + /** Add environment variables to the compiler subprocess. */ + Map environmentVariables = null; + + /** Pass compilerOptions directly to compiler. */ + String[] compilerOptions = null; + + /** Skip the execution. */ + boolean skip = false; + + public BuildTask() { + // disable incremental builds until we get proper support for them + getOutputs().upToDateWhen(t -> { return false; } ); + } + + @Optional @Classpath + @InputFiles String[] getClassPath() { return classPath; } void setClassPath (String[] s) { classPath = s; } + @Optional @Input String[] getIncludePath() { return includePath; } void setIncludePath (String[] s) { includePath = s; } + @Optional @Input String[] getIncludeResource() { return includeResource; } void setIncludeResource(String[] s) { includeResource = s; } + @Optional @Input String[] getBuildPath() { return buildPath; } void setBuildPath (String[] s) { buildPath = s; } + @Optional @Input String[] getBuildResource() { return buildResource; } void setBuildResource (String[] s) { buildResource = s; } + @Optional @Input String[] getLinkPath() { return linkPath; } void setLinkPath (String[] s) { linkPath = s; } + @Optional @Input String[] getLinkResource() { return linkResource; } void setLinkResource (String[] s) { linkResource = s; } + @Optional @Input String[] getPreloadPath() { return preloadPath; } void setPreloadPath (String[] s) { preloadPath = s; } + @Optional @Input String[] getPreloadResource() { return preloadResource; } void setPreloadResource(String[] s) { preloadResource = s; } + @Optional @Input String[] getResourcePath() { return resourcePath; } void setResourcePath (String[] s) { resourcePath = s; } + @Optional @Input String[] getExecutablePath() { return executablePath; } void setExecutablePath (String[] s) { executablePath = s; } + @Optional @Input String getEncoding() { return encoding; } void setEncoding (String s) { encoding = s; } + @Optional + @OutputDirectory File getOutputDirectory() { return outputDirectory; } void setOutputDirectory(File f) { outputDirectory = f; } + @Optional @Input String getOutputName() { return outputName; } void setOutputName (String s) { outputName = s; } + @Input boolean getClean() { return clean; } void setClean (boolean b) { clean = b; } + @Input boolean getGenerate() { return generate; } void setGenerate (boolean b) { generate = b; } + @Input boolean getCompile() { return compile; } void setCompile (boolean b) { compile = b; } + @Input boolean getDeleteJniFiles() { return deleteJniFiles; } void setDeleteJniFiles (boolean b) { deleteJniFiles = b; } + @Input boolean getHeader() { return header; } void setHeader (boolean b) { header = b; } + @Input boolean getCopyLibs() { return copyLibs; } void setCopyLibs (boolean b) { copyLibs = b; } + @Input boolean getCopyResources() { return copyResources; } void setCopyResources (boolean b) { copyResources = b; } + @Optional @Input String getJarPrefix() { return jarPrefix; } void setJarPrefix (String s) { jarPrefix = s; } + @Optional @Input String getProperties() { return properties; } void setProperties (String s) { properties = s; } + @Optional @InputFile File getPropertyFile() { return propertyFile; } void setPropertyFile (File f) { propertyFile = f; } + @Optional @Input Properties getPropertyKeysAndValues() { return propertyKeysAndValues; } void setPropertyKeysAndValues(Properties p) { propertyKeysAndValues = p; } + @Optional @Input String[] getClassOrPackageNames() { return classOrPackageNames; } void setClassOrPackageNames (String[] s) { classOrPackageNames = s; } + @Optional @Input String[] getBuildCommand() { return buildCommand; } void setBuildCommand (String[] s) { buildCommand = s; } + @Optional @Input String[] getTargetDirectory() { return targetDirectory; } void setTargetDirectory (String[] s) { targetDirectory = s; } + @Optional + @InputDirectory File getWorkingDirectory() { return workingDirectory; } void setWorkingDirectory (File f) { workingDirectory = f; } + @Optional @Input Map getEnvironmentVariables() { return environmentVariables; } void setEnvironmentVariables (Map m) { environmentVariables = m; } + @Optional @Input String[] getCompilerOptions() { return compilerOptions; } void setCompilerOptions (String[] s) { compilerOptions = s; } + @Input boolean getSkip() { return skip; } void setSkip (boolean b) { skip = b; } + + @TaskAction public void build() throws IOException, ClassNotFoundException, NoClassDefFoundError, InterruptedException, ParserException { + Logger logger = new Slf4jLogger(Builder.class); + Builder builder = new Builder(logger) + .classPaths(getClassPath()) + .encoding(getEncoding()) + .outputDirectory(getOutputDirectory()) + .outputName(getOutputName()) + .clean(getClean()) + .generate(getGenerate()) + .compile(getCompile()) + .deleteJniFiles(getDeleteJniFiles()) + .header(getHeader()) + .copyLibs(getCopyLibs()) + .copyResources(getCopyResources()) + .jarPrefix(getJarPrefix()) + .properties(getProperties()) + .propertyFile(getPropertyFile()) + .properties(getPropertyKeysAndValues()) + .classesOrPackages(getClassOrPackageNames()) + .buildCommand(getBuildCommand()) + .workingDirectory(getWorkingDirectory()) + .environmentVariables(getEnvironmentVariables()) + .compilerOptions(getCompilerOptions()) + .commandExecutor(new BuildExecutor(logger)) + + .addProperty("platform.buildpath", getBuildPath()) + .addProperty("platform.buildresource", getBuildResource()) + .addProperty("platform.includepath", getIncludePath()) + .addProperty("platform.includeresource", getIncludeResource()) + .addProperty("platform.linkpath", getLinkPath()) + .addProperty("platform.linkresource", getLinkResource()) + .addProperty("platform.preloadpath", getPreloadPath()) + .addProperty("platform.preloadresource", getPreloadResource()) + .addProperty("platform.resourcepath", getResourcePath()) + .addProperty("platform.executablepath", getExecutablePath()); + + String extension = builder.getProperty("platform.extension"); + getLogger().info("Detected platform \"" + Loader.Detector.getPlatform() + "\""); + getLogger().info("Building for platform \"" + builder.getProperty("platform") + "\"" + + (extension != null && extension.length() > 0 ? " with extension \"" + extension + "\"" : "")); + + File[] outputFiles = builder.build(); + + if (getLogger().isDebugEnabled()) { + getLogger().debug("outputFiles: " + Arrays.deepToString(outputFiles)); + } + } +} diff --git a/src/test/java/org/bytedeco/gradle/javacpp/BuildPluginTest.java b/src/test/java/org/bytedeco/gradle/javacpp/BuildPluginTest.java new file mode 100644 index 0000000..148633b --- /dev/null +++ b/src/test/java/org/bytedeco/gradle/javacpp/BuildPluginTest.java @@ -0,0 +1,46 @@ +/* + * Copyright (C) 2020 Samuel Audet + * + * Licensed either under the Apache License, Version 2.0, or (at your option) + * under the terms of the GNU General Public License as published by + * the Free Software Foundation (subject to the "Classpath" exception), + * either version 2, or any later version (collectively, the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * http://www.gnu.org/licenses/ + * http://www.gnu.org/software/classpath/license.html + * + * or as provided in the LICENSE.txt file that accompanied this code. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.bytedeco.gradle.javacpp; + +import java.io.File; +import org.bytedeco.javacpp.Loader; +import org.gradle.testfixtures.ProjectBuilder; +import org.gradle.api.Project; +import org.junit.Test; +import static org.junit.Assert.*; + +public class BuildPluginTest { + @Test public void pluginRegistersATask() { + Project project = ProjectBuilder.builder().build(); + project.getPlugins().apply("java"); + project.getPlugins().apply("org.bytedeco.gradle-javacpp-build"); + + assertEquals(Loader.Detector.getPlatform(), project.findProperty("javacppPlatform")); + assertEquals(new File(project.getBuildDir(), "generated/sources/javacpp/"), project.findProperty("javacppParserOutput")); + assertNotNull(project.getTasks().findByName("javacppBuildCommand")); + assertNotNull(project.getTasks().findByName("javacppCompileJava")); + assertNotNull(project.getTasks().findByName("javacppBuildParser")); + assertNotNull(project.getTasks().findByName("javacppBuildCompiler")); + assertNotNull(project.getTasks().findByName("javacppPomProperties")); + assertNotNull(project.getTasks().findByName("javacppJar")); + } +}