From b10037a1c1f8dae213f4857414784e113b17902f Mon Sep 17 00:00:00 2001 From: Mark Raynsford Date: Sat, 4 May 2024 10:33:20 +0000 Subject: [PATCH] Eliminate jstructural Affects: https://github.com/io7m-com/.github/issues/2 --- README.in | 43 ++++ README.md | 44 ++++ com.io7m.jeucreader.documentation/pom.xml | 215 ------------------ .../src/main/assembly/documentation.xml | 20 -- .../documentation/Documentation.java | 30 --- .../documentation/package-info.java | 22 -- .../io7m/jeucreader/documentation/brand.xml | 9 - .../documentation/documentation.css | 73 ------ .../documentation/documentation.xml | 124 ---------- com.io7m.jeucreader.tests/pom.xml | 5 +- pom.xml | 8 - src/site/resources/documentation.xml | 7 +- 12 files changed, 93 insertions(+), 507 deletions(-) create mode 100644 README.in delete mode 100644 com.io7m.jeucreader.documentation/pom.xml delete mode 100644 com.io7m.jeucreader.documentation/src/main/assembly/documentation.xml delete mode 100644 com.io7m.jeucreader.documentation/src/main/java/com/io7m/jeucreader/documentation/Documentation.java delete mode 100644 com.io7m.jeucreader.documentation/src/main/java/com/io7m/jeucreader/documentation/package-info.java delete mode 100644 com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/brand.xml delete mode 100644 com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/documentation.css delete mode 100644 com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/documentation.xml diff --git a/README.in b/README.in new file mode 100644 index 0000000..dc5e886 --- /dev/null +++ b/README.in @@ -0,0 +1,43 @@ + +## jeucreader + +The `jeucreader` package provides an interface for reading Unicode codepoints +one at a time. + +## Features + +* Unicode codepoint reader interface. +* High coverage test suite. +* Written in pure Java 21 with no dependencies. +* [OSGi-ready](https://www.osgi.org/) +* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System) +* ISC license. + +## Motivation + +For some reason, Java does not expose any interface to read individual Unicode +codepoints from any kind of I/O stream. It _does_ provide methods to, for +example, read text into a `String` and then iterate over the codepoints of +the `String`. + +The `jeucreader` package attempts to provide this missing functionality. + +## Usage + +Given a `java.io.Reader r`, instantiate a `UnicodeCharacterReaderType` and +use it to read individual codepoints: + +``` +Reader r; + +try (var u = UnicodeCharacterReader.newReader(r)) { + int c0 = u.readCodePoint(); + int c1 = u.readCodePoint(); + int c2 = u.readCodePoint(); + ... +} +``` + +On consuming malformed text, the reader may raise subtypes of `IOException` +such as `InvalidSurrogatePair`, `MissingLowSurrogate`, `OrphanLowSurrogate`, +and etc. diff --git a/README.md b/README.md index 441a6da..2939dff 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,47 @@ jeucreader | OpenJDK (Temurin) LTS | Linux | [![Build (OpenJDK (Temurin) LTS, Linux)](https://img.shields.io/github/actions/workflow/status/io7m-com/jeucreader/main.linux.temurin.lts.yml)](https://www.github.com/io7m-com/jeucreader/actions?query=workflow%3Amain.linux.temurin.lts)| | OpenJDK (Temurin) Current | Windows | [![Build (OpenJDK (Temurin) Current, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/jeucreader/main.windows.temurin.current.yml)](https://www.github.com/io7m-com/jeucreader/actions?query=workflow%3Amain.windows.temurin.current)| | OpenJDK (Temurin) LTS | Windows | [![Build (OpenJDK (Temurin) LTS, Windows)](https://img.shields.io/github/actions/workflow/status/io7m-com/jeucreader/main.windows.temurin.lts.yml)](https://www.github.com/io7m-com/jeucreader/actions?query=workflow%3Amain.windows.temurin.lts)| + +## jeucreader + +The `jeucreader` package provides an interface for reading Unicode codepoints +one at a time. + +## Features + +* Unicode codepoint reader interface. +* High coverage test suite. +* Written in pure Java 21 with no dependencies. +* [OSGi-ready](https://www.osgi.org/) +* [JPMS-ready](https://en.wikipedia.org/wiki/Java_Platform_Module_System) +* ISC license. + +## Motivation + +For some reason, Java does not expose any interface to read individual Unicode +codepoints from any kind of I/O stream. It _does_ provide methods to, for +example, read text into a `String` and then iterate over the codepoints of +the `String`. + +The `jeucreader` package attempts to provide this missing functionality. + +## Usage + +Given a `java.io.Reader r`, instantiate a `UnicodeCharacterReaderType` and +use it to read individual codepoints: + +``` +Reader r; + +try (var u = UnicodeCharacterReader.newReader(r)) { + int c0 = u.readCodePoint(); + int c1 = u.readCodePoint(); + int c2 = u.readCodePoint(); + ... +} +``` + +On consuming malformed text, the reader may raise subtypes of `IOException` +such as `InvalidSurrogatePair`, `MissingLowSurrogate`, `OrphanLowSurrogate`, +and etc. + diff --git a/com.io7m.jeucreader.documentation/pom.xml b/com.io7m.jeucreader.documentation/pom.xml deleted file mode 100644 index 134a2a8..0000000 --- a/com.io7m.jeucreader.documentation/pom.xml +++ /dev/null @@ -1,215 +0,0 @@ - - - - 4.0.0 - - com.io7m.jeucreader - com.io7m.jeucreader - 3.0.1-SNAPSHOT - - com.io7m.jeucreader.documentation - - jar - com.io7m.jeucreader.documentation - Easy unicode character reader (Documentation) - https://www.io7m.com/software/jeucreader - - - true - - - - - ${project.groupId} - com.io7m.jeucreader.core - ${project.version} - - - - org.osgi - org.osgi.annotation.bundle - provided - - - org.osgi - org.osgi.annotation.versioning - provided - - - - com.io7m.primogenitor - com.io7m.primogenitor.support - - - - - - - - org.apache.maven.plugins - maven-resources-plugin - - - copy-documentation-resources - - copy-resources - - generate-resources - - ${project.build.directory}/documentation/ - - - src/main/resources/com/io7m/jeucreader/documentation/ - true - - - - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - - unpack-sources - package - - unpack-dependencies - - - module-info.java - ${project.groupId} - sources - false - ${project.build.directory}/javadoc-sources - - - - make-classpath - package - - build-classpath - - - ${project.build.directory}/javadoc-classpath - - - - - - - - com.io7m.jstructural - io7m-jstructural-maven-plugin - - - make-documentation-single - prepare-package - - transform - - - ${project.build.directory}/documentation/documentation.xml - ${project.build.directory}/documentation/ - ${project.build.directory}/documentation/brand.xml - XHTML_SINGLE - - - - make-documentation-multi - prepare-package - - transform - - - ${project.build.directory}/documentation/documentation.xml - ${project.build.directory}/documentation/ - ${project.build.directory}/documentation/brand.xml - XHTML_MULTI - - - - - - - - org.codehaus.mojo - exec-maven-plugin - - - javadoc - - java - - package - - com.io7m.primogenitor.support.TrivialJavadoc - - ${project.build.directory}/javadoc-sources - ${project.build.directory}/javadoc-classpath - ${project.build.directory}/documentation/apidocs - ${project.build.directory}/javadoc-log.txt - ${project.build.directory}/javadoc-options - - - - - - - - - org.apache.maven.plugins - maven-assembly-plugin - - - src/main/assembly/documentation.xml - - - - - make-assembly - package - - single - - - false - - - - - - - - - org.codehaus.mojo - truezip-maven-plugin - false - - - copy-site-documentation - - copy - - site - - true - - - ${project.build.directory}/${project.name}-${project.version}.zip/${project.name}-${project.version}/ - - ${project.parent.build.directory}/minisite/documentation/ - - - - - - - - - diff --git a/com.io7m.jeucreader.documentation/src/main/assembly/documentation.xml b/com.io7m.jeucreader.documentation/src/main/assembly/documentation.xml deleted file mode 100644 index b888871..0000000 --- a/com.io7m.jeucreader.documentation/src/main/assembly/documentation.xml +++ /dev/null @@ -1,20 +0,0 @@ - - documentation - ${project.name}-${project.version} - - zip - - - - ${project.build.directory}/documentation - / - - - ${project.build.directory}/site/apidocs - /apidocs - - - diff --git a/com.io7m.jeucreader.documentation/src/main/java/com/io7m/jeucreader/documentation/Documentation.java b/com.io7m.jeucreader.documentation/src/main/java/com/io7m/jeucreader/documentation/Documentation.java deleted file mode 100644 index 548241a..0000000 --- a/com.io7m.jeucreader.documentation/src/main/java/com/io7m/jeucreader/documentation/Documentation.java +++ /dev/null @@ -1,30 +0,0 @@ -/* - * Copyright © 2017 Mark Raynsford https://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. - */ - -package com.io7m.jeucreader.documentation; - -/** - * Marker class for looking up files by resource. - */ - -public final class Documentation -{ - private Documentation() - { - throw new AssertionError("Unreachable code"); - } -} - diff --git a/com.io7m.jeucreader.documentation/src/main/java/com/io7m/jeucreader/documentation/package-info.java b/com.io7m.jeucreader.documentation/src/main/java/com/io7m/jeucreader/documentation/package-info.java deleted file mode 100644 index f1eb253..0000000 --- a/com.io7m.jeucreader.documentation/src/main/java/com/io7m/jeucreader/documentation/package-info.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright © 2017 Mark Raynsford https://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. - */ - -/** - * Documentation. - */ - -package com.io7m.jeucreader.documentation; - diff --git a/com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/brand.xml b/com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/brand.xml deleted file mode 100644 index c391a15..0000000 --- a/com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/brand.xml +++ /dev/null @@ -1,9 +0,0 @@ - -
-
- io7m -
-
- ${project.parent.name} ${project.version} -
-
\ No newline at end of file diff --git a/com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/documentation.css b/com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/documentation.css deleted file mode 100644 index 04af663..0000000 --- a/com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/documentation.css +++ /dev/null @@ -1,73 +0,0 @@ -.st200_table th { padding-right: 1em; } -.st200_table td { padding-right: 1em; } - -.brand -{ - font-size: 75%; - font-family: monospace; -} - -.brand_left -{ - float: left; -} - -.brand_right -{ - text-align: right; -} - -.package -{ - font-family: monospace; - font-weight: bold; -} - -.term -{ - font-style: italic; -} - -.attribute, -.class, -.command, -.constant, -.element, -.expression, -.file, -.keyword, -.symbol, -.type, -.variable -{ - font-family: monospace; -} - -.example, .license, .terminal -{ - font-family: monospace; - border: 1px solid #ccc; - padding-top: 1.0em; - padding-left: 1.0em; - padding-bottom: 1.0em; - margin-top: 1.2em; - overflow: auto; -} - -.dependencies table td -{ - padding-right: 3.0em; - font-family: monospace; - font-size: 9pt; -} - -.platforms table td -{ - padding-right: 2.0em; -} -.platforms table tbody, -.platforms table thead -{ - font-size: 8pt; - font-family: monospace; -} diff --git a/com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/documentation.xml b/com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/documentation.xml deleted file mode 100644 index 8c77cfc..0000000 --- a/com.io7m.jeucreader.documentation/src/main/resources/com/io7m/jeucreader/documentation/documentation.xml +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - ${project.parent.name} ${project.version} Documentation - documentation.css - - - - Package Information - - - Orientation - - Overview - - The ${project.parent.name} package - implements an easy-to-use character-by-character reader for Unicode - streams. - - - - - - Installation - - Source compilation - - The project can be compiled and installed with - Maven: - - - - - - - - Maven - - Regular releases are made to the - Central Repository, - so it's possible to use the ${project.parent.name} - package in your projects with the following Maven dependency: - - - - ${project.groupId} - ${project.parent.artifactId}-core - ${project.version} -]]> - - - All io7m.com - packages use Semantic Versioning - - http://semver.org - , which implies that it is always safe to use version ranges - with an exclusive upper bound equal to the next major version - the API of - the package will not change in a backwards-incompatible manner before the - next major version. - - - - - - Platform Specific Issues - - There are currently no known platform-specific issues. - - - - - License - - All files distributed with the ${project.parent.name} - package are placed under the following license: - http://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.]]> - - - - - - - API Reference - - - Javadoc - - API documentation for the package is provided via the - included Javadoc. - - - - - diff --git a/com.io7m.jeucreader.tests/pom.xml b/com.io7m.jeucreader.tests/pom.xml index 82a81db..0e500ad 100644 --- a/com.io7m.jeucreader.tests/pom.xml +++ b/com.io7m.jeucreader.tests/pom.xml @@ -18,9 +18,10 @@ https://www.io7m.com/software/jeucreader - true - true + true true + true + true diff --git a/pom.xml b/pom.xml index dbbeddf..39aa67d 100644 --- a/pom.xml +++ b/pom.xml @@ -22,7 +22,6 @@ com.io7m.jeucreader.core - com.io7m.jeucreader.documentation com.io7m.jeucreader.tests @@ -107,13 +106,6 @@ - - - com.io7m.jstructural - io7m-jstructural-maven-plugin - 5.0.0 - - com.github.spotbugs diff --git a/src/site/resources/documentation.xml b/src/site/resources/documentation.xml index 5c0c663..6330d71 100644 --- a/src/site/resources/documentation.xml +++ b/src/site/resources/documentation.xml @@ -2,8 +2,7 @@

User documentation

- +

+ See the README. +