| 1 |
--- |
| 2 |
# Copyright (C) 2009-2011 the original author or authors. |
| 3 |
# See the notice.md file distributed with this work for additional |
| 4 |
# information regarding copyright ownership. |
| 5 |
# |
| 6 |
# Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 |
# you may not use this file except in compliance with the License. |
| 8 |
# You may obtain a copy of the License at |
| 9 |
# |
| 10 |
# http://www.apache.org/licenses/LICENSE-2.0 |
| 11 |
# |
| 12 |
# Unless required by applicable law or agreed to in writing, software |
| 13 |
# distributed under the License is distributed on an "AS IS" BASIS, |
| 14 |
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 |
# See the License for the specific language governing permissions and |
| 16 |
# limitations under the License. |
| 17 |
title: HawtJNI |
| 18 |
--- name:overview pipeline:jade |
| 19 |
|
| 20 |
h1 HawtJNI #{project_version} |
| 21 |
|
| 22 |
| #{project_slogan} |
| 23 |
|
| 24 |
--- name:content pipeline:markdown |
| 25 |
|
| 26 |
HawtJNI is a code generator that produces the JNI code needed |
| 27 |
to implement java native methods. It is based on the |
| 28 |
[jnigen](http://www.eclipse.org/swt/jnigen.php) code generator that is |
| 29 |
part of the SWT Tools project which is used to generate all the JNI |
| 30 |
code which powers the eclipse platform. |
| 31 |
|
| 32 |
Features |
| 33 |
-------- |
| 34 |
|
| 35 |
* JNI code generated declaratively from annotations on your java code |
| 36 |
* Maven integration: |
| 37 |
* Generates JNI source code |
| 38 |
* Generates an autoconf and msbuild source project to build the |
| 39 |
native library. This gets attached to the Maven project as as |
| 40 |
the native source zip file. |
| 41 |
* Builds the native source tar for the current platform |
| 42 |
* Built native library is stored in a platform specific jar. This |
| 43 |
gets attached to the Maven project as a platform specific jar file. |
| 44 |
* [Runtime API](documentation/api/) to load the library. |
| 45 |
|
| 46 |
Introduction |
| 47 |
------------ |
| 48 |
|
| 49 |
There are many open source JNI code generators available, but if your |
| 50 |
performance sensitive, the code generator used by the eclipse SWT |
| 51 |
project is by far the best option. The biggest problem is that it was |
| 52 |
not developed to be reused by other projects. It was tightly coupled |
| 53 |
to producing the SWT JNI libraries and it could only be run within the |
| 54 |
eclipse platform. |
| 55 |
|
| 56 |
HawtJNI has taken that code generator and made it easier to use and |
| 57 |
accessible to more projects. |
| 58 |
|
| 59 |
|
| 60 |
Getting started |
| 61 |
--------------- |
| 62 |
|
| 63 |
For more information, checkout the |
| 64 |
[developer guide](documentation/developer-guide.html) |