jobj
A parser for the useful subset of the Wavefront OBJ file format.
Features
- Hand-written event-based recovering parser: Efficiently parse, accumulating errors along the way, without being tied to any particular AST types.
- High coverage test suite.
- OSGi-ready
- JPMS-ready
- ISC license.
Usage
Provide an implementation of the JOParserEventListenerType interface
to a JOParserType:
Path file;
JOParserEventListenerType listener;
InputStream stream;
final JOParserType p =
JOParser.newParserFromStream(
Optional.of(file),
stream,
listener
);
p.run();
The listener will receive parse events encountered during parsing of the
file.
Coverage
The only specification for the OBJ file format is an unofficial specification that appears to have been handed around for decades.
Most of the OBJ file format has no relevance to anything used in modern
computer graphics in 2024, but the format itself is often used as a
bare-minimum portable text format for distributing mesh data. This parser
attempts to capture the useful subset of data and makes no attempt to parse
the entirety of the OBJ format. It's practically guaranteed that the parser
will be missing the once piece of data you actually wanted to extract from the
.obj file you're parsing. Patches to increase format coverage are welcome.
Releases & Development Snapshots
Releases
You can subscribe to the atom feed to be notified of project releases.
The most recently released version of the package is 1.0.0.
1.0.0 Release (2024-05-11Z)
- Update junit:4.12 → 4.13.1.
- Update org.slf4j:slf4j-api:2.0.10 → 2.0.13.
- Update ch.qos.logback:logback-classic:1.4.14 → 1.5.6.
- Update args4j:args4j:2.33 → 2.37.
- Update com.io7m.jlexing:com.io7m.jlexing.core:3.1.0 → 3.2.0.
- Initial public release.
The compiled artifacts for the release (and all previous releases) are available on Maven Central.
Maven Modules
<dependency> <group>com.io7m.jobj</group> <artifactId>com.io7m.jobj.core</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.jobj</group> <artifactId>com.io7m.jobj.tests</artifactId> <version>1.0.0</version> </dependency><dependency> <group>com.io7m.jobj</group> <artifactId>com.io7m.jobj.tools</artifactId> <version>1.0.0</version> </dependency>
Previous Releases
The changelogs for the most recent previous releases are as follows:
0.3.0 Release (2017-11-16Z)
- Rename project. Use the new primogenitor POM and 2017 project conventions.
- All modules are now Java 9 modules. JDK 9 is now required. (Backwards incompatible)
- Removed dependency on com.io7m.jnull. (Backwards incompatible)
0.2.0 Release (2016-11-22Z)
- Updated to jlexing 0.2.0. This is an API breaking change. (Backwards incompatible)
0.1.1 Release (2016-08-16Z)
- Update Maven dependencies and plugins.
- The produced package is now an OSGi bundle.
0.1.0 Release (2015-12-18Z)
- Initial release.
Development Snapshots
At the time of writing, the current unstable development version of the package is 1.0.1-SNAPSHOT.
Development snapshots may be available in the Central Portal Snapshots repository. Snapshots are published to this repository every time the project is built by the project's continuous integration system, but snapshots do expire after around ninety days and so may or may not be available depending on when a build of the package was last triggered.
Manual
This project does not have any user manuals or other documentation beyond what might be present on the page above.
Sources
This project uses Git to manage source code.
Repository: https://www.github.com/io7m-com/jobj
$ git clone --recursive https://www.github.com/io7m-com/jobj
Issues
This project uses GitHub Issues to track issues.
License
Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.