GSoC #10 font tools
PATCH 1/1 GSoC #10 font tools
This patch provides the font converter and viewer tools. The converter can convert BDF fonts to PFF2 format, and the viewer can view either BDF or PFF2 fonts.
The tools are written in Java. A simple shell script, 'build.sh', is provided which builds the JAR file containing the compiled Java code. See util/fonttool/README.txt for complete instructions and information on running the tools.
Regards,
Colin
2008-09-01 Colin D Bennett <[email protected]>
Added BDF->PFF2 font conversion and BDF/PFF2 viewing tool.
* util/fonttool: New directory.
* util/fonttool/README.txt: New file.
* util/fonttool/build.sh: New file.
* util/fonttool/build.xml: New file.
* util/fonttool/fonttool.iml: New file.
* util/fonttool/fonttool.ipr: New file.
* util/fonttool/makepf2.sh: New file.
* util/fonttool/src: New directory.
* util/fonttool/src/org: New directory.
* util/fonttool/src/org/gnu: New directory.
* util/fonttool/src/org/gnu/grub: New directory.
* util/fonttool/src/org/gnu/grub/fonttool: New directory.
* util/fonttool/src/org/gnu/grub/fonttool/BDFFont.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/BDFLoader.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/CharDefs.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/CharMatrix.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/CharStorageInfo.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/CharView.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/Converter.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/FileFormatException.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/Font.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/Glyph.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/PFF2Loader.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/PFF2Sections.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/PFF2Writer.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/Viewer.java: New file.
* util/fonttool/src/org/gnu/grub/fonttool/ViewerFrame.java: New file.
* util/fonttool/test: New directory.
* util/fonttool/test/org: New directory.
* util/fonttool/test/org/gnu: New directory.
* util/fonttool/test/org/gnu/grub: New directory.
* util/fonttool/test/org/gnu/grub/fonttool: New directory.
* util/fonttool/test/org/gnu/grub/fonttool/TestGlyph.java: New file.
=== added directory 'util/fonttool'
=== added file 'util/fonttool/README.txt'
fonttool/README.txt +48 -0
@@ -0,0 +1,48 @@ +============== +GRUB Font Tool +============== + +Building +======== + +You can build the sources using the ``build.sh`` shell script, with:: + + sh build.sh + +or, you can use the Apache Ant tool to build the sources. The main benefit +using Ant is its incremental compilation when files are modified. Simply run:: + + ant + +Using either method, the file 'build/fonttool.jar' is generated, and the Java +'.class' files are stored in 'build/src/'. + + +Running +======= + +The font tool currently contains two programs: a viewer and a converter. + + +Running the viewer +------------------ + +Run: + + java -cp build/fonttool.jar org.gnu.grub.fonttool.Viewer myfont.pf2 + +The font viewer can view either PFF2 or BDF format font files. + + +Running the converter +--------------------- + +You can either run the converter directly, as :: + + java -cp build/fonttool.jar org.gnu.grub.fonttool.Converter \ + --in=a.bdf --out=b.pf2 + +or you can use the 'makepf2.sh' script to do a batch conversion of multiple +font files. This script converts all the BDF fonts specified on the command +line into PFF2 (.pf2) fonts, storing them in the current directory. +
=== added file 'util/fonttool/build.sh'
fonttool/build.sh +27 -0
@@ -0,0 +1,27 @@ +#!/bin/sh +# Build script for font tool. + +die() { + echo "Error: $1" + exit 1 +} + +O=build +SRC=src + +if [ -e "${O}" ]; then + echo "Cleaning output directory ${O}..." + rm -rf "${O}" || die "Can't delete output directory ${O}" +fi + +mkdir -p "${O}" || die "Can't create output directory ${O}" + +echo "Compiling Java sources..." +mkdir -p "${O}/src" || die "Can't create output src directory ${O}/src" +javac -source 1.5 -target 1.5 -g -deprecation -encoding UTF-8 \ + -d "${O}/src" \ + $(find "${SRC}" -name '*.java') || die "Java compiler failed" + +echo "Building JAR file..." +jar cf "${O}/fonttool.jar" -C "${O}/src" . || die "Could not create JAR file" +
=== added file 'util/fonttool/build.xml'
fonttool/build.xml +23 -0
@@ -0,0 +1,23 @@ +<project name="fonttool" default="jar" basedir="."> + <description>GRUB 2 font tool.</description> + + <target name="clean"> + <delete dir="build"/> + </target> + + <target name="compile"> + <mkdir dir="build/src"/> + <javac srcdir="src" destdir="build/src" source="1.5" target="1.5" + optimize="yes" debug="yes" encoding="UTF-8"/> + </target> + + <target name="jar" depends="compile"> + <jar jarfile="build/fonttool.jar" compress="yes"> + <fileset dir="build/src"/> + <fileset dir="src"> + <include name="*.txt"/> + <include name="*.png"/> + </fileset> + </jar> + </target> +</project>
=== added file 'util/fonttool/fonttool.iml'
fonttool/fonttool.iml +24 -0
@@ -0,0 +1,24 @@ +<?xml version="1.0" encoding="UTF-8"?> +<module version="4" relativePaths="true" type="JAVA_MODULE"> + <component name="ModuleRootManager" /> + <component name="NewModuleRootManager" inherit-compiler-output="true"> + <exclude-output /> + <content url="file://$MODULE_DIR$"> + <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" /> + <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" /> + </content> + <orderEntry type="inheritedJdk" /> + <orderEntry type="sourceFolder" forTests="false" /> + <orderEntry type="module-library"> + <library> + <CLASSES> + <root url="jar://$APPLICATION_HOME_DIR$/lib/junit-4.4.jar!/" /> + </CLASSES> + <JAVADOC /> + <SOURCES /> + </library> + </orderEntry> + <orderEntryProperties /> + </component> +</module> +
=== added file 'util/fonttool/fonttool.ipr'
fonttool/fonttool.ipr +306 -0
306 lines not on this page · raw message
=== added file 'util/fonttool/makepf2.sh'
fonttool/makepf2.sh +17 -0
@@ -0,0 +1,17 @@ +#!/bin/sh + +# This script will generate GRUB 2 PFF2 font files out of BDF. +# You need the GRUB font utilities "Converter" program for this. + +DIR=$( dirname $0 ) + +for font in "$@" +do + out=`basename "${font}" | cut -d'.' -f1` + out="${out}.pf2" + echo "Converting ${font} -> ${out} ..." + java -cp "${DIR}/build/fonttool.jar" \ + org.gnu.grub.fonttool.Converter \ + --in="${font}" \ + --out="${out}" +done
=== added directory 'util/fonttool/src'
=== added directory 'util/fonttool/src/org'
=== added directory 'util/fonttool/src/org/gnu'
=== added directory 'util/fonttool/src/org/gnu/grub'
=== added directory 'util/fonttool/src/org/gnu/grub/fonttool' === added file 'util/fonttool/src/org/gnu/grub/fonttool/BDFFont.java'
fonttool/src/org/gnu/grub/fonttool/BDFFont.java +24 -0
@@ -0,0 +1,24 @@ +package org.gnu.grub.fonttool; + +import java.awt.image.BufferedImage; +import java.util.HashMap; +import java.util.Map; + +public class BDFFont { + private Map<Character, BufferedImage> glyphs = new HashMap<Character, BufferedImage>(); + private int height = 0; + + void putGlyph(char ch, BufferedImage glyph) { + glyphs.put(ch, glyph); + if (glyph.getHeight() > height) + height = glyph.getHeight(); + } + + public BufferedImage getGlyph(char c) { + return glyphs.get(c); + } + + public int getHeight() { + return height; + } +}
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/BDFLoader.java'
fonttool/src/org/gnu/grub/fonttool/BDFLoader.java +254 -0
254 lines not on this page · raw message
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/CharDefs.java'
fonttool/src/org/gnu/grub/fonttool/CharDefs.java +135 -0
135 lines not on this page · raw message
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/CharMatrix.java'
fonttool/src/org/gnu/grub/fonttool/CharMatrix.java +139 -0
139 lines not on this page · raw message
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/CharStorageInfo.java'
fonttool/src/org/gnu/grub/fonttool/CharStorageInfo.java +19 -0
@@ -0,0 +1,19 @@ +package org.gnu.grub.fonttool; + +class CharStorageInfo { + private final int codePoint; + private final int fileOffset; + + public CharStorageInfo(int codePoint, int fileOffset) { + this.codePoint = codePoint; + this.fileOffset = fileOffset; + } + + public int getCodePoint() { + return codePoint; + } + + public int getFileOffset() { + return fileOffset; + } +}
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/CharView.java'
fonttool/src/org/gnu/grub/fonttool/CharView.java +101 -0
101 lines not on this page · raw message
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/Converter.java'
fonttool/src/org/gnu/grub/fonttool/Converter.java +78 -0
78 lines not on this page · raw message
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/FileFormatException.java'
fonttool/src/org/gnu/grub/fonttool/FileFormatException.java +9 -0
@@ -0,0 +1,9 @@ +package org.gnu.grub.fonttool; + +import java.io.IOException; + +public class FileFormatException extends IOException { + public FileFormatException(String msg) { + super(msg); + } +}
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/Font.java'
fonttool/src/org/gnu/grub/fonttool/Font.java +106 -0
106 lines not on this page · raw message
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/Glyph.java'
fonttool/src/org/gnu/grub/fonttool/Glyph.java +83 -0
83 lines not on this page · raw message
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/PFF2Loader.java'
fonttool/src/org/gnu/grub/fonttool/PFF2Loader.java +203 -0
203 lines not on this page · raw message
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/PFF2Sections.java'
fonttool/src/org/gnu/grub/fonttool/PFF2Sections.java +19 -0
@@ -0,0 +1,19 @@ +package org.gnu.grub.fonttool; + +/** + * Section name constants for the PFF2 file format. + */ +public class PFF2Sections { + static final String FILE = "FILE"; + static final String FONT_NAME = "NAME"; + static final String FONT_FAMILY = "FAMI"; + static final String FONT_WEIGHT = "WEIG"; + static final String FONT_SLANT = "SLAN"; + static final String FONT_POINT_SIZE = "PTSZ"; + static final String MAX_CHAR_WIDTH = "MAXW"; + static final String MAX_CHAR_HEIGHT = "MAXH"; + static final String FONT_ASCENT = "ASCE"; + static final String FONT_DESCENT = "DESC"; + static final String CHAR_INDEX = "CHIX"; + static final String REMAINDER_IS_DATA = "DATA"; +}
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/PFF2Writer.java'
fonttool/src/org/gnu/grub/fonttool/PFF2Writer.java +133 -0
133 lines not on this page · raw message
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/Viewer.java'
fonttool/src/org/gnu/grub/fonttool/Viewer.java +135 -0
135 lines not on this page · raw message
=== added file 'util/fonttool/src/org/gnu/grub/fonttool/ViewerFrame.java'
fonttool/src/org/gnu/grub/fonttool/ViewerFrame.java +61 -0
61 lines not on this page · raw message
=== added directory 'util/fonttool/test'
=== added directory 'util/fonttool/test/org'
=== added directory 'util/fonttool/test/org/gnu'
=== added directory 'util/fonttool/test/org/gnu/grub'
=== added directory 'util/fonttool/test/org/gnu/grub/fonttool' === added file 'util/fonttool/test/org/gnu/grub/fonttool/TestGlyph.java'
fonttool/test/org/gnu/grub/fonttool/TestGlyph.java +110 -0
110 lines not on this page · raw message