Dave Jarvis' Repositories

git clone https://repo.autonoma.ca/repo/keenwrite.git
keenwrite / Commits / 02b7108

Use builder to configure typesetter, reorg many class internals

AuthorDaveJarvis <email>
Date2021-12-12 22:57:50 GMT-0800
Commit02b710836d1f2599d18b6bf15e9e4fe8b7ad08ed
Parentb540197
src/main/java/com/keenwrite/AbstractFileFactory.java
final var predicate = createFileTypePredicate( patterns );
- if( found = predicate.test( path.toFile() ) ) {
+ if( predicate.test( path.toFile() ) ) {
// Remove the EXTENSIONS_PREFIX to get the file name extension mapped
// to a standard name (as defined in the settings.properties file).
final String suffix = key.replace( prefix + '.', "" );
fileType = FileType.from( suffix );
+ found = true;
}
}
src/main/java/com/keenwrite/Caret.java
public class Caret {
+ private final Mutator mMutator;
+
public static GenericBuilder<Caret.Mutator, Caret> builder() {
return GenericBuilder.of( Caret.Mutator::new, Caret::new );
}
}
-
- private final Mutator mMutator;
/**
src/main/java/com/keenwrite/DefinitionNameInjector.java
/**
- * Prevent instantiation.
- */
- private DefinitionNameInjector() {
- }
-
- /**
* Find a node that matches the current word and substitute the definition
* reference.
return leaf;
+ }
+
+ /**
+ * Prevent instantiation.
+ */
+ private DefinitionNameInjector() {
}
}
src/main/java/com/keenwrite/ExportFormat.java
private final String mExtension;
- ExportFormat( final String extension ) {
- mExtension = extension;
- }
-
/**
* Looks up the {@link ExportFormat} based on the given format type and
) );
};
+ }
+
+ ExportFormat( final String extension ) {
+ mExtension = extension;
}
src/main/java/com/keenwrite/Launcher.java
private final String[] mArgs;
- /**
- * Delegates running the application via the command-line argument parser.
- * This is the main entry point for the application, regardless of whether
- * run from the command-line or as a GUI.
- *
- * @param args Command-line arguments.
- */
- public static void main( final String[] args ) {
- installTrustManager();
- parse( args );
- }
-
- /**
- * @param args Command-line arguments (passed into the GUI).
- */
- public Launcher( final String[] args ) {
- mArgs = args;
- }
-
- /**
- * Called after the arguments have been parsed.
- *
- * @param args The parsed command-line arguments.
- */
- @Override
- public void accept( final Arguments args ) {
- assert args != null;
-
- try {
- int argCount = mArgs.length;
-
- if( args.quiet() ) {
- argCount--;
- }
- else {
- showAppInfo();
- }
-
- if( args.debug() ) {
- argCount--;
- }
- else {
- disableLogging();
- }
-
- if( argCount <= 0 ) {
- // When no command-line arguments are provided, launch the GUI.
- MainApp.main( mArgs );
- }
- else {
- // When command-line arguments are supplied, run in headless mode.
- HeadlessApp.main( args );
- }
- } catch( final Throwable t ) {
- log( t );
- }
- }
-
private static void parse( final String[] args ) {
assert args != null;
private static void out( final String message, final Object... args ) {
System.out.printf( format( "%s%n", message ), args );
+ }
+
+ /**
+ * Delegates running the application via the command-line argument parser.
+ * This is the main entry point for the application, regardless of whether
+ * run from the command-line or as a GUI.
+ *
+ * @param args Command-line arguments.
+ */
+ public static void main( final String[] args ) {
+ installTrustManager();
+ parse( args );
+ }
+
+ /**
+ * @param args Command-line arguments (passed into the GUI).
+ */
+ public Launcher( final String[] args ) {
+ mArgs = args;
+ }
+
+ /**
+ * Called after the arguments have been parsed.
+ *
+ * @param args The parsed command-line arguments.
+ */
+ @Override
+ public void accept( final Arguments args ) {
+ assert args != null;
+
+ try {
+ int argCount = mArgs.length;
+
+ if( args.quiet() ) {
+ argCount--;
+ }
+ else {
+ showAppInfo();
+ }
+
+ if( args.debug() ) {
+ argCount--;
+ }
+ else {
+ disableLogging();
+ }
+
+ if( argCount <= 0 ) {
+ // When no command-line arguments are provided, launch the GUI.
+ MainApp.main( mArgs );
+ }
+ else {
+ // When command-line arguments are supplied, run in headless mode.
+ HeadlessApp.main( args );
+ }
+ } catch( final Throwable t ) {
+ log( t );
+ }
}
+
}
src/main/java/com/keenwrite/MainApp.java
/**
+ * Creates an instance of {@link KeyEvent} that represents pressing a key.
+ *
+ * @param code The key to simulate being pressed down.
+ * @param shift Whether shift key modifier shall modify the key code.
+ * @return An instance of {@link KeyEvent} that may be used to simulate
+ * a key being pressed.
+ */
+ public static Event keyDown( final KeyCode code, final boolean shift ) {
+ return keyEvent( KEY_PRESSED, code, shift );
+ }
+
+ /**
+ * Creates an instance of {@link KeyEvent} that represents releasing a key.
+ *
+ * @param code The key to simulate being released up.
+ * @param shift Whether shift key modifier shall modify the key code.
+ * @return An instance of {@link KeyEvent} that may be used to simulate
+ * a key being released.
+ */
+ public static Event keyUp( final KeyCode code, final boolean shift ) {
+ return keyEvent( KEY_RELEASED, code, shift );
+ }
+
+ /**
+ * Creates an instance of {@link KeyEvent} that represents a key released
+ * event without any modifier keys held.
+ *
+ * @param code The key code representing a key to simulate releasing.
+ * @return An instance of {@link KeyEvent}.
+ */
+ public static Event keyUp( final KeyCode code ) {
+ return keyUp( code, false );
+ }
+
+ private static Event keyEvent(
+ final EventType<KeyEvent> type, final KeyCode code, final boolean shift ) {
+ return new KeyEvent(
+ type, "", "", code, shift, false, false, false
+ );
+ }
+
+ /**
* JavaFX entry point.
*
return () ->
!(stage.isMaximized() || stage.isFullScreen() || stage.isIconified());
- }
-
- /**
- * Creates an instance of {@link KeyEvent} that represents pressing a key.
- *
- * @param code The key to simulate being pressed down.
- * @param shift Whether shift key modifier shall modify the key code.
- * @return An instance of {@link KeyEvent} that may be used to simulate
- * a key being pressed.
- */
- public static Event keyDown( final KeyCode code, final boolean shift ) {
- return keyEvent( KEY_PRESSED, code, shift );
- }
-
- /**
- * Creates an instance of {@link KeyEvent} that represents releasing a key.
- *
- * @param code The key to simulate being released up.
- * @param shift Whether shift key modifier shall modify the key code.
- * @return An instance of {@link KeyEvent} that may be used to simulate
- * a key being released.
- */
- public static Event keyUp( final KeyCode code, final boolean shift ) {
- return keyEvent( KEY_RELEASED, code, shift );
- }
-
- /**
- * Creates an instance of {@link KeyEvent} that represents a key released
- * event without any modifier keys held.
- *
- * @param code The key code representing a key to simulate releasing.
- * @return An instance of {@link KeyEvent}.
- */
- public static Event keyUp( final KeyCode code ) {
- return keyUp( code, false );
- }
-
- private static Event keyEvent(
- final EventType<KeyEvent> type, final KeyCode code, final boolean shift ) {
- return new KeyEvent(
- type, "", "", code, shift, false, false, false
- );
}
}
src/main/java/com/keenwrite/MainPane.java
*/
public final class MainPane extends SplitPane {
- private static final ExecutorService sExecutor = newFixedThreadPool( 1 );
-
- private final ScheduledExecutorService mSaver = newScheduledThreadPool( 1 );
- private final AtomicReference<ScheduledFuture<?>> mSaveTask =
- new AtomicReference<>();
+ private static final ExecutorService sExecutor = newFixedThreadPool( 1 );
private static final Notifier sNotifier = Services.load( Notifier.class );
/**
* Used when opening files to determine how each file should be binned and
* therefore what tab pane to be opened within.
*/
private static final Set<MediaType> PLAIN_TEXT_FORMAT = Set.of(
TEXT_MARKDOWN, TEXT_R_MARKDOWN, UNDEFINED
);
+
+ private final ScheduledExecutorService mSaver = newScheduledThreadPool( 1 );
+ private final AtomicReference<ScheduledFuture<?>> mSaveTask =
+ new AtomicReference<>();
/**
src/main/java/com/keenwrite/MainScene.java
*/
public final class MainScene {
+
private final Scene mScene;
private final MenuBar mMenuBar;
src/main/java/com/keenwrite/Messages.java
}
- private Messages() {
- }
-
/**
* Returns the value for a key from the message bundle. If the value cannot
private static SigilOperator createBundleSigilOperator() {
return new SigilOperator( "${", "}" );
+ }
+
+ private Messages() {
}
}
src/main/java/com/keenwrite/PermissiveCertificate.java
/**
- * Use {@link #installTrustManager()}.
- */
- private PermissiveCertificate() {
- }
-
- /**
* Install the all-trusting trust manager. If this fails it means that in
* certain situations the HTML preview may fail to render diagrams. A way
- * to work-around the issue is to install a local server for generating
+ * to work around the issue is to install a local server for generating
* diagrams.
*/
return false;
}
+ }
+
+ /**
+ * Use {@link #installTrustManager()}.
+ */
+ private PermissiveCertificate() {
}
}
src/main/java/com/keenwrite/cmdline/ColourScheme.java
*/
public class ColourScheme {
+
+ /**
+ * Creates a new color scheme for use with command-line parsing.
+ *
+ * @return The new color scheme to apply to the parsesr.
+ */
public static ColorScheme create() {
return new Builder()
src/main/java/com/keenwrite/io/SysFile.java
/**
- * Creates a new instance for a given file name.
- *
- * @param pathname File name to represent for subsequent operations.
- */
- public SysFile( final String pathname ) {
- super( pathname );
- }
-
- /**
* For a file name that represents an executable (without an extension)
* file, this determines whether the executable is found in the PATH
}
);
+ }
+
+ /**
+ * Creates a new instance for a given file name.
+ *
+ * @param pathname File name to represent for subsequent operations.
+ */
+ public SysFile( final String pathname ) {
+ super( pathname );
}
}
src/main/java/com/keenwrite/preferences/Workspace.java
public SigilOperator createRSigilOperator() {
- final var antecedent = createYamlSigilOperator();
return new RSigilOperator(
createSigils( KEY_R_DELIM_BEGAN, KEY_R_DELIM_ENDED ),
- antecedent
+ createYamlSigilOperator()
);
}
src/main/java/com/keenwrite/processors/PdfProcessor.java
package com.keenwrite.processors;
-import com.keenwrite.typesetting.Typesetter;
-
import java.io.IOException;
import static com.keenwrite.Bootstrap.APP_TITLE_LOWERCASE;
import static com.keenwrite.events.StatusEvent.clue;
import static com.keenwrite.io.MediaType.TEXT_XML;
+import static com.keenwrite.preferences.WorkspaceKeys.*;
+import static com.keenwrite.typesetting.Typesetter.Mutator;
+import static com.keenwrite.typesetting.Typesetter.builder;
import static java.nio.file.Files.deleteIfExists;
import static java.nio.file.Files.writeString;
try {
clue( "Main.status.typeset.create" );
+ final var workspace = mContext.getWorkspace();
final var document = TEXT_XML.createTemporaryFile( APP_TITLE_LOWERCASE );
- final var pathInput = writeString( document, xhtml );
- final var pathOutput = mContext.getOutputPath();
- final var typesetter = new Typesetter( mContext.getWorkspace() );
+ final var typesetter = builder()
+ .with( Mutator::setInputPath,
+ writeString( document, xhtml ) )
+ .with( Mutator::setOutputPath,
+ mContext.getOutputPath() )
+ .with( Mutator::setThemePath,
+ workspace.toFile( KEY_TYPESET_CONTEXT_THEMES_PATH ) )
+ .with( Mutator::setThemeName,
+ workspace.toString( KEY_TYPESET_CONTEXT_THEME_SELECTION ) )
+ .with( Mutator::setAutoclean,
+ workspace.toBoolean( KEY_TYPESET_CONTEXT_CLEAN ) )
+ .build();
- typesetter.typeset( pathInput, pathOutput );
+ typesetter.typeset();
// Smote the temporary file after typesetting the document.
src/main/java/com/keenwrite/processors/ProcessorContext.java
private final Mutator mMutator;
- /**
- * Creates a new context for use by the {@link ProcessorFactory} when
- * instantiating new {@link Processor} instances. Although all the
- * parameters are required, not all {@link Processor} instances will use
- * all parameters.
- */
- private ProcessorContext( final Mutator mutator ) {
- assert mutator != null;
-
- mMutator = mutator;
- }
-
public static class Mutator {
private HtmlPreview mHtmlPreview;
.with( Mutator::setExportFormat, format )
.build();
+ }
+
+ /**
+ * Creates a new context for use by the {@link ProcessorFactory} when
+ * instantiating new {@link Processor} instances. Although all the
+ * parameters are required, not all {@link Processor} instances will use
+ * all parameters.
+ */
+ private ProcessorContext( final Mutator mutator ) {
+ assert mutator != null;
+
+ mMutator = mutator;
}
src/main/java/com/keenwrite/typesetting/Typesetter.java
import com.keenwrite.io.SysFile;
-import com.keenwrite.preferences.Workspace;
-import com.keenwrite.util.BoundedCache;
-
-import java.io.*;
-import java.nio.file.NoSuchFileException;
-import java.nio.file.Path;
-import java.util.ArrayList;
-import java.util.List;
-import java.util.Map;
-import java.util.Scanner;
-import java.util.concurrent.Callable;
-import java.util.regex.Pattern;
-
-import static com.keenwrite.constants.Constants.DEFAULT_DIRECTORY;
-import static com.keenwrite.events.StatusEvent.clue;
-import static com.keenwrite.preferences.WorkspaceKeys.*;
-import static java.lang.ProcessBuilder.Redirect.DISCARD;
-import static java.lang.String.format;
-import static java.lang.System.currentTimeMillis;
-import static java.lang.System.getProperty;
-import static java.nio.file.Files.*;
-import static java.util.Arrays.asList;
-import static java.util.concurrent.TimeUnit.*;
-import static org.apache.commons.io.FilenameUtils.removeExtension;
-
-/**
- * Responsible for invoking an executable to typeset text. This will
- * construct suitable command-line arguments to invoke the typesetting engine.
- */
-public class Typesetter {
- private static final SysFile TYPESETTER = new SysFile( "mtxrun" );
-
- private final Workspace mWorkspace;
-
- /**
- * Creates a new {@link Typesetter} instance capable of configuring the
- * typesetter used to generate a typeset document.
- */
- public Typesetter( final Workspace workspace ) {
- mWorkspace = workspace;
- }
-
- public static boolean canRun() {
- return TYPESETTER.canRun();
- }
-
- /**
- * This will typeset the document using a new process. The return value only
- * indicates whether the typesetter exists, not whether the typesetting was
- * successful.
- *
- * @param inputPath The input document to typeset.
- * @param outputPath Path to the finished typeset document.
- * @throws IOException If the process could not be started.
- * @throws InterruptedException If the process was killed.
- * @throws TypesetterNotFoundException When no typesetter is along the PATH.
- */
- public void typeset( final Path inputPath, final Path outputPath )
- throws IOException, InterruptedException, TypesetterNotFoundException {
- if( TYPESETTER.canRun() ) {
- clue( "Main.status.typeset.began", outputPath );
- final var task = new TypesetTask( inputPath, outputPath );
- final var time = currentTimeMillis();
- final var success = task.typeset();
-
- clue( "Main.status.typeset.ended." + (success ? "success" : "failure"),
- outputPath, since( time )
- );
- }
- else {
- throw new TypesetterNotFoundException( TYPESETTER.toString() );
- }
- }
-
- /**
- * Calculates the time that has elapsed from the current time to the
- * given moment in time.
- *
- * @param start The starting time, which should be before the current time.
- * @return A human-readable formatted time.
- * @see #asElapsed(long)
- */
- private static String since( final long start ) {
- return asElapsed( currentTimeMillis() - start );
- }
-
- /**
- * Converts an elapsed time to a human-readable format (hours, minutes,
- * seconds, and milliseconds).
- *
- * @param elapsed An elapsed time, in milliseconds.
- * @return Human-readable elapsed time.
- */
- private static String asElapsed( final long elapsed ) {
- final var hours = MILLISECONDS.toHours( elapsed );
- final var eHours = elapsed - HOURS.toMillis( hours );
- final var minutes = MILLISECONDS.toMinutes( eHours );
- final var eMinutes = eHours - MINUTES.toMillis( minutes );
- final var seconds = MILLISECONDS.toSeconds( eMinutes );
- final var eSeconds = eMinutes - SECONDS.toMillis( seconds );
- final var milliseconds = MILLISECONDS.toMillis( eSeconds );
-
- return format( "%02d:%02d:%02d.%03d",
- hours, minutes, seconds, milliseconds );
- }
-
- /**
- * Launches a task to typeset a document.
- */
- private class TypesetTask implements Callable<Boolean> {
- private final List<String> mArgs = new ArrayList<>();
- private final Path mInput;
- private final Path mOutput;
-
- /**
- * Working directory must be set because ConTeXt cannot write the
- * result to an arbitrary location.
- */
- private final Path mDirectory;
-
- private TypesetTask( final Path input, final Path output ) {
- assert input != null;
- assert output != null;
-
- final var parentDir = output.getParent();
- mInput = input;
- mOutput = output;
- mDirectory = parentDir == null ? DEFAULT_DIRECTORY : parentDir;
- }
-
- /**
- * Initializes ConTeXt, which means creating the cache directory if it
- * doesn't already exist. The theme entry point must be named 'main.tex'.
- *
- * @return {@code true} if the cache directory exists.
- */
- private boolean reinitialize() {
- final var filename = mOutput.getFileName();
- final var themes = getThemesPath();
- final var theme = getThemesSelection();
- final var cacheExists = !isEmpty( getCacheDir().toPath() );
-
- // Ensure invoking multiple times will load the correct arguments.
- mArgs.clear();
- mArgs.add( TYPESETTER.getName() );
-
- if( cacheExists ) {
- mArgs.add( "--autogenerate" );
- mArgs.add( "--script" );
- mArgs.add( "mtx-context" );
- mArgs.add( "--batchmode" );
- mArgs.add( "--nonstopmode" );
- mArgs.add( "--purgeall" );
- mArgs.add( "--path='" + Path.of( themes.toString(), theme ) + "'" );
- mArgs.add( "--environment='main'" );
- mArgs.add( "--result='" + filename + "'" );
- mArgs.add( mInput.toString() );
-
- final var sb = new StringBuilder( 128 );
- mArgs.forEach( arg -> sb.append( arg ).append( " " ) );
- clue( sb.toString() );
- }
- else {
- mArgs.add( "--generate" );
- }
-
- return cacheExists;
- }
-
- /**
- * Setting {@code TEXMFCACHE} when run on a fresh system fails on the first
- * try. If the cache directory doesn't exist, attempt to create it, then
- * call ConTeXt to generate the PDF. This is brittle because if the
- * directory is empty, or not populated with cached data, a false positive
- * will be returned, resulting in no PDF being created.
- *
- * @return {@code true} if the document was typeset successfully.
- * @throws IOException If the process could not be started.
- * @throws InterruptedException If the process was killed.
- */
- private boolean typeset() throws IOException, InterruptedException {
- return reinitialize() ? call() : call() && reinitialize() && call();
- }
-
- @Override
- public Boolean call() throws IOException, InterruptedException {
- final var stdout = new BoundedCache<String, String>( 150 );
- final var builder = new ProcessBuilder( mArgs );
- builder.directory( mDirectory.toFile() );
- builder.environment().put( "TEXMFCACHE", getCacheDir().toString() );
-
- // Without redirecting (or draining) stderr, the command may not
- // terminate successfully.
- builder.redirectError( DISCARD );
-
- final var process = builder.start();
- final var stream = process.getInputStream();
-
- // Reading from stdout allows slurping page numbers while generating.
- final var listener = new PaginationListener( stream, stdout );
- listener.start();
-
- // Even though the process has completed, there may be incomplete I/O.
- process.waitFor();
-
- // Allow time for any incomplete I/O to take place.
- process.waitFor( 1, SECONDS );
-
- final var exit = process.exitValue();
- process.destroy();
-
- // If there was an error, the typesetter will leave behind log, pdf, and
- // error files.
- if( exit > 0 ) {
- final var xmlName = mInput.getFileName().toString();
- final var srcName = mOutput.getFileName().toString();
- final var logName = newExtension( xmlName, ".log" );
- final var errName = newExtension( xmlName, "-error.log" );
- final var pdfName = newExtension( xmlName, ".pdf" );
- final var tuaName = newExtension( xmlName, ".tua" );
- final var badName = newExtension( srcName, ".log" );
-
- log( badName );
- log( logName );
- log( errName );
- log( stdout.keySet().stream().toList() );
-
- // Users may opt to keep these files around for debugging purposes.
- if( autoclean() ) {
- deleteIfExists( logName );
- deleteIfExists( errName );
- deleteIfExists( pdfName );
- deleteIfExists( badName );
- deleteIfExists( tuaName );
- }
- }
-
- // Exit value for a successful invocation of the typesetter. This value
- // value is returned when creating the cache on the first run as well as
- // creating PDFs on subsequent runs (after the cache has been created).
- // Users don't care about exit codes, only whether the PDF was generated.
- return exit == 0;
- }
-
- private Path newExtension( final String baseName, final String ext ) {
- return mOutput.resolveSibling( removeExtension( baseName ) + ext );
- }
-
- /**
- * Fires a status message for each line in the given file. The file format
- * is somewhat machine-readable, but no effort beyond line splitting is
- * made to parse the text.
- *
- * @param path Path to the file containing error messages.
- */
- private void log( final Path path ) throws IOException {
- if( exists( path ) ) {
- log( readAllLines( path ) );
- }
- }
-
- private void log( final List<String> lines ) {
- final var splits = new ArrayList<String>( lines.size() * 2 );
-
- for( final var line : lines ) {
- splits.addAll( asList( line.split( "\\\\n" ) ) );
- }
-
- clue( splits );
- }
-
- /**
- * Returns the location of the cache directory.
- *
- * @return A fully qualified path to the location to store temporary
- * files between typesetting runs.
- */
- private java.io.File getCacheDir() {
- final var temp = getProperty( "java.io.tmpdir" );
- final var cache = Path.of( temp, "luatex-cache" );
- return cache.toFile();
- }
-
- /**
- * Answers whether the given directory is empty. The typesetting software
- * creates a non-empty directory by default. The return value from this
- * method is a proxy to answering whether the typesetter has been run for
- * the first time or not.
- *
- * @param path The directory to check for emptiness.
- * @return {@code true} if the directory is empty.
- */
- private boolean isEmpty( final Path path ) {
- try( final var stream = newDirectoryStream( path ) ) {
- return !stream.iterator().hasNext();
- } catch( final NoSuchFileException | FileNotFoundException ex ) {
- // A missing directory means it doesn't exist, ergo is empty.
- return true;
- } catch( final IOException ex ) {
- throw new RuntimeException( ex );
- }
- }
- }
-
- /**
- * Responsible for parsing the output from the typesetting engine and
- * updating the status bar to provide assurance that typesetting is
- * executing.
- *
- * <p>
- * Example lines written to standard output:
- * </p>
- * <pre>{@code
- * pages > flushing realpage 15, userpage 15, subpage 15
- * pages > flushing realpage 16, userpage 16, subpage 16
- * pages > flushing realpage 1, userpage 1, subpage 1
- * pages > flushing realpage 2, userpage 2, subpage 2
- * }</pre>
- * <p>
- * The lines are parsed; the first number is displayed in a status bar
- * message.
- * </p>
- */
- private static class PaginationListener extends Thread {
- private static final Pattern DIGITS = Pattern.compile( "[^\\d]+" );
-
- private final InputStream mInputStream;
-
- private final Map<String, String> mCache;
-
- public PaginationListener(
- final InputStream in, final Map<String, String> cache ) {
- mInputStream = in;
- mCache = cache;
- }
-
- @Override
- public void run() {
- try( final var reader = createReader( mInputStream ) ) {
- int pageCount = 1;
- int passCount = 1;
- int pageTotal = 0;
- String line;
-
- while( (line = reader.readLine()) != null ) {
- mCache.put( line, "" );
-
- if( line.startsWith( "pages" ) ) {
- // The bottleneck will be the typesetting engine writing to stdout,
- // not the parsing of stdout.
- final var scanner = new Scanner( line ).useDelimiter( DIGITS );
- final var digits = scanner.next();
- final var page = Integer.parseInt( digits );
-
- // If the page number is less than the previous page count, it
- // means that the typesetting engine has started another pass.
- if( page < pageCount ) {
- passCount++;
- pageTotal = pageCount;
- }
-
- pageCount = page;
-
- // Inform the user of pages being typeset.
- clue( "Main.status.typeset.page",
- pageCount, pageTotal < 1 ? "?" : pageTotal, passCount
- );
- }
- }
- } catch( final IOException ex ) {
- clue( ex );
- throw new RuntimeException( ex );
- }
- }
-
- private BufferedReader createReader( final InputStream inputStream ) {
- return new BufferedReader( new InputStreamReader( inputStream ) );
- }
- }
-
- private File getThemesPath() {
- return mWorkspace.toFile( KEY_TYPESET_CONTEXT_THEMES_PATH );
- }
-
- private String getThemesSelection() {
- return mWorkspace.toString( KEY_TYPESET_CONTEXT_THEME_SELECTION );
- }
-
- /**
- * Answers whether logs and other files should be deleted upon error. The
- * log files are useful for debugging.
- *
- * @return {@code true} to delete generated files.
- */
- public boolean autoclean() {
- return mWorkspace.toBoolean( KEY_TYPESET_CONTEXT_CLEAN );
+import com.keenwrite.util.BoundedCache;
+import com.keenwrite.util.GenericBuilder;
+
+import java.io.*;
+import java.nio.file.NoSuchFileException;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.Scanner;
+import java.util.concurrent.Callable;
+import java.util.regex.Pattern;
+
+import static com.keenwrite.constants.Constants.DEFAULT_DIRECTORY;
+import static com.keenwrite.events.StatusEvent.clue;
+import static java.lang.ProcessBuilder.Redirect.DISCARD;
+import static java.lang.String.format;
+import static java.lang.System.currentTimeMillis;
+import static java.lang.System.getProperty;
+import static java.nio.file.Files.*;
+import static java.util.Arrays.asList;
+import static java.util.concurrent.TimeUnit.*;
+import static org.apache.commons.io.FilenameUtils.removeExtension;
+
+/**
+ * Responsible for invoking an executable to typeset text. This will
+ * construct suitable command-line arguments to invoke the typesetting engine.
+ */
+public class Typesetter {
+ private static final SysFile TYPESETTER = new SysFile( "mtxrun" );
+
+ private final Mutator mMutator;
+
+ public static GenericBuilder<Mutator, Typesetter> builder() {
+ return GenericBuilder.of( Mutator::new, Typesetter::new );
+ }
+
+ public static final class Mutator {
+ private Path mInputPath;
+ private Path mOutputPath;
+ private Path mThemePath;
+ private String mThemeName;
+ private boolean mAutoclean;
+
+ /**
+ * @param inputPath The input document to typeset.
+ */
+ public void setInputPath( final Path inputPath ) {
+ mInputPath = inputPath;
+ }
+
+ /**
+ * @param outputPath Path to the finished typeset document to create.
+ */
+ public void setOutputPath( final Path outputPath ) {
+ mOutputPath = outputPath;
+ }
+
+ /**
+ * @param themePath Fully qualified path to the theme directory.
+ */
+ public void setThemePath( final Path themePath ) {
+ mThemePath = themePath;
+ }
+
+ /**
+ * @param themePath Fully qualified path to the theme directory.
+ */
+ public void setThemePath( final File themePath ) {
+ setThemePath( themePath.toPath() );
+ }
+
+ /**
+ * @param themeName Name of theme to apply when generating the PDF file.
+ */
+ public void setThemeName( final String themeName ) {
+ mThemeName = themeName;
+ }
+
+ /**
+ * @param autoclean {@code true} to remove all temporary files after
+ * typesetter produces a PDF file.
+ */
+ public void setAutoclean( final boolean autoclean ) {
+ mAutoclean = autoclean;
+ }
+ }
+
+ public static boolean canRun() {
+ return TYPESETTER.canRun();
+ }
+
+ /**
+ * Calculates the time that has elapsed from the current time to the
+ * given moment in time.
+ *
+ * @param start The starting time, which should be before the current time.
+ * @return A human-readable formatted time.
+ * @see #asElapsed(long)
+ */
+ private static String since( final long start ) {
+ return asElapsed( currentTimeMillis() - start );
+ }
+
+ /**
+ * Converts an elapsed time to a human-readable format (hours, minutes,
+ * seconds, and milliseconds).
+ *
+ * @param elapsed An elapsed time, in milliseconds.
+ * @return Human-readable elapsed time.
+ */
+ private static String asElapsed( final long elapsed ) {
+ final var hours = MILLISECONDS.toHours( elapsed );
+ final var eHours = elapsed - HOURS.toMillis( hours );
+ final var minutes = MILLISECONDS.toMinutes( eHours );
+ final var eMinutes = eHours - MINUTES.toMillis( minutes );
+ final var seconds = MILLISECONDS.toSeconds( eMinutes );
+ final var eSeconds = eMinutes - SECONDS.toMillis( seconds );
+ final var milliseconds = MILLISECONDS.toMillis( eSeconds );
+
+ return format( "%02d:%02d:%02d.%03d",
+ hours, minutes, seconds, milliseconds );
+ }
+
+ /**
+ * Launches a task to typeset a document.
+ */
+ private class TypesetTask implements Callable<Boolean> {
+ private final List<String> mArgs = new ArrayList<>();
+
+ /**
+ * Working directory must be set because ConTeXt cannot write the
+ * result to an arbitrary location.
+ */
+ private final Path mDirectory;
+
+ private TypesetTask() {
+ final var parentDir = getOutputPath().getParent();
+ mDirectory = parentDir == null ? DEFAULT_DIRECTORY : parentDir;
+ }
+
+ /**
+ * Initializes ConTeXt, which means creating the cache directory if it
+ * doesn't already exist. The theme entry point must be named 'main.tex'.
+ *
+ * @return {@code true} if the cache directory exists.
+ */
+ private boolean reinitialize() {
+ final var filename = getOutputPath().getFileName();
+ final var themes = getThemePath();
+ final var theme = getThemeName();
+ final var cacheExists = !isEmpty( getCacheDir().toPath() );
+
+ // Ensure invoking multiple times will load the correct arguments.
+ mArgs.clear();
+ mArgs.add( TYPESETTER.getName() );
+
+ if( cacheExists ) {
+ mArgs.add( "--autogenerate" );
+ mArgs.add( "--script" );
+ mArgs.add( "mtx-context" );
+ mArgs.add( "--batchmode" );
+ mArgs.add( "--nonstopmode" );
+ mArgs.add( "--purgeall" );
+ mArgs.add( "--path='" + Path.of( themes.toString(), theme ) + "'" );
+ mArgs.add( "--environment='main'" );
+ mArgs.add( "--result='" + filename + "'" );
+ mArgs.add( getInputPath().toString() );
+
+ final var sb = new StringBuilder( 128 );
+ mArgs.forEach( arg -> sb.append( arg ).append( " " ) );
+ clue( sb.toString() );
+ }
+ else {
+ mArgs.add( "--generate" );
+ }
+
+ return cacheExists;
+ }
+
+ /**
+ * Setting {@code TEXMFCACHE} when run on a fresh system fails on the first
+ * try. If the cache directory doesn't exist, attempt to create it, then
+ * call ConTeXt to generate the PDF. This is brittle because if the
+ * directory is empty, or not populated with cached data, a false positive
+ * will be returned, resulting in no PDF being created.
+ *
+ * @return {@code true} if the document was typeset successfully.
+ * @throws IOException If the process could not be started.
+ * @throws InterruptedException If the process was killed.
+ */
+ private boolean typeset() throws IOException, InterruptedException {
+ return reinitialize() ? call() : call() && reinitialize() && call();
+ }
+
+ @Override
+ public Boolean call() throws IOException, InterruptedException {
+ final var stdout = new BoundedCache<String, String>( 150 );
+ final var builder = new ProcessBuilder( mArgs );
+ builder.directory( mDirectory.toFile() );
+ builder.environment().put( "TEXMFCACHE", getCacheDir().toString() );
+
+ // Without redirecting (or draining) stderr, the command may not
+ // terminate successfully.
+ builder.redirectError( DISCARD );
+
+ final var process = builder.start();
+ final var stream = process.getInputStream();
+
+ // Reading from stdout allows slurping page numbers while generating.
+ final var listener = new PaginationListener( stream, stdout );
+ listener.start();
+
+ // Even though the process has completed, there may be incomplete I/O.
+ process.waitFor();
+
+ // Allow time for any incomplete I/O to take place.
+ process.waitFor( 1, SECONDS );
+
+ final var exit = process.exitValue();
+ process.destroy();
+
+ // If there was an error, the typesetter will leave behind log, pdf, and
+ // error files.
+ if( exit > 0 ) {
+ final var xmlName = getInputPath().getFileName().toString();
+ final var srcName = getOutputPath().getFileName().toString();
+ final var logName = newExtension( xmlName, ".log" );
+ final var errName = newExtension( xmlName, "-error.log" );
+ final var pdfName = newExtension( xmlName, ".pdf" );
+ final var tuaName = newExtension( xmlName, ".tua" );
+ final var badName = newExtension( srcName, ".log" );
+
+ log( badName );
+ log( logName );
+ log( errName );
+ log( stdout.keySet().stream().toList() );
+
+ // Users may opt to keep these files around for debugging purposes.
+ if( autoclean() ) {
+ deleteIfExists( logName );
+ deleteIfExists( errName );
+ deleteIfExists( pdfName );
+ deleteIfExists( badName );
+ deleteIfExists( tuaName );
+ }
+ }
+
+ // Exit value for a successful invocation of the typesetter. This value
+ // value is returned when creating the cache on the first run as well as
+ // creating PDFs on subsequent runs (after the cache has been created).
+ // Users don't care about exit codes, only whether the PDF was generated.
+ return exit == 0;
+ }
+
+ private Path newExtension( final String baseName, final String ext ) {
+ return getOutputPath().resolveSibling( removeExtension( baseName ) + ext );
+ }
+
+ /**
+ * Fires a status message for each line in the given file. The file format
+ * is somewhat machine-readable, but no effort beyond line splitting is
+ * made to parse the text.
+ *
+ * @param path Path to the file containing error messages.
+ */
+ private void log( final Path path ) throws IOException {
+ if( exists( path ) ) {
+ log( readAllLines( path ) );
+ }
+ }
+
+ private void log( final List<String> lines ) {
+ final var splits = new ArrayList<String>( lines.size() * 2 );
+
+ for( final var line : lines ) {
+ splits.addAll( asList( line.split( "\\\\n" ) ) );
+ }
+
+ clue( splits );
+ }
+
+ /**
+ * Returns the location of the cache directory.
+ *
+ * @return A fully qualified path to the location to store temporary
+ * files between typesetting runs.
+ */
+ private java.io.File getCacheDir() {
+ final var temp = getProperty( "java.io.tmpdir" );
+ final var cache = Path.of( temp, "luatex-cache" );
+ return cache.toFile();
+ }
+
+ /**
+ * Answers whether the given directory is empty. The typesetting software
+ * creates a non-empty directory by default. The return value from this
+ * method is a proxy to answering whether the typesetter has been run for
+ * the first time or not.
+ *
+ * @param path The directory to check for emptiness.
+ * @return {@code true} if the directory is empty.
+ */
+ private boolean isEmpty( final Path path ) {
+ try( final var stream = newDirectoryStream( path ) ) {
+ return !stream.iterator().hasNext();
+ } catch( final NoSuchFileException | FileNotFoundException ex ) {
+ // A missing directory means it doesn't exist, ergo is empty.
+ return true;
+ } catch( final IOException ex ) {
+ throw new RuntimeException( ex );
+ }
+ }
+ }
+
+ /**
+ * Responsible for parsing the output from the typesetting engine and
+ * updating the status bar to provide assurance that typesetting is
+ * executing.
+ *
+ * <p>
+ * Example lines written to standard output:
+ * </p>
+ * <pre>{@code
+ * pages > flushing realpage 15, userpage 15, subpage 15
+ * pages > flushing realpage 16, userpage 16, subpage 16
+ * pages > flushing realpage 1, userpage 1, subpage 1
+ * pages > flushing realpage 2, userpage 2, subpage 2
+ * }</pre>
+ * <p>
+ * The lines are parsed; the first number is displayed in a status bar
+ * message.
+ * </p>
+ */
+ private static class PaginationListener extends Thread {
+ private static final Pattern DIGITS = Pattern.compile( "[^\\d]+" );
+
+ private final InputStream mInputStream;
+
+ private final Map<String, String> mCache;
+
+ public PaginationListener(
+ final InputStream in, final Map<String, String> cache ) {
+ mInputStream = in;
+ mCache = cache;
+ }
+
+ @Override
+ public void run() {
+ try( final var reader = createReader( mInputStream ) ) {
+ int pageCount = 1;
+ int passCount = 1;
+ int pageTotal = 0;
+ String line;
+
+ while( (line = reader.readLine()) != null ) {
+ mCache.put( line, "" );
+
+ if( line.startsWith( "pages" ) ) {
+ // The bottleneck will be the typesetting engine writing to stdout,
+ // not the parsing of stdout.
+ final var scanner = new Scanner( line ).useDelimiter( DIGITS );
+ final var digits = scanner.next();
+ final var page = Integer.parseInt( digits );
+
+ // If the page number is less than the previous page count, it
+ // means that the typesetting engine has started another pass.
+ if( page < pageCount ) {
+ passCount++;
+ pageTotal = pageCount;
+ }
+
+ pageCount = page;
+
+ // Inform the user of pages being typeset.
+ clue( "Main.status.typeset.page",
+ pageCount, pageTotal < 1 ? "?" : pageTotal, passCount
+ );
+ }
+ }
+ } catch( final IOException ex ) {
+ clue( ex );
+ throw new RuntimeException( ex );
+ }
+ }
+
+ private BufferedReader createReader( final InputStream inputStream ) {
+ return new BufferedReader( new InputStreamReader( inputStream ) );
+ }
+ }
+
+ /**
+ * Creates a new {@link Typesetter} instance capable of configuring the
+ * typesetter used to generate a typeset document.
+ */
+ private Typesetter( final Mutator mutator ) {
+ assert mutator != null;
+
+ mMutator = mutator;
+ }
+
+ /**
+ * This will typeset the document using a new process. The return value only
+ * indicates whether the typesetter exists, not whether the typesetting was
+ * successful.
+ *
+ * @throws IOException If the process could not be started.
+ * @throws InterruptedException If the process was killed.
+ * @throws TypesetterNotFoundException When no typesetter is along the PATH.
+ */
+ public void typeset()
+ throws IOException, InterruptedException, TypesetterNotFoundException {
+ if( TYPESETTER.canRun() ) {
+ final var outputPath = getOutputPath();
+
+ clue( "Main.status.typeset.began", outputPath );
+ final var task = new TypesetTask();
+ final var time = currentTimeMillis();
+ final var success = task.typeset();
+
+ clue( "Main.status.typeset.ended." + (success ? "success" : "failure"),
+ outputPath, since( time )
+ );
+ }
+ else {
+ throw new TypesetterNotFoundException( TYPESETTER.toString() );
+ }
+ }
+
+ private Path getInputPath() {
+ return mMutator.mInputPath;
+ }
+
+ private Path getOutputPath() {
+ return mMutator.mOutputPath;
+ }
+
+ private Path getThemePath() {
+ return mMutator.mThemePath;
+ }
+
+ private String getThemeName() {
+ return mMutator.mThemeName;
+ }
+
+ /**
+ * Answers whether logs and other files should be deleted upon error. The
+ * log files are useful for debugging.
+ *
+ * @return {@code true} to delete generated files.
+ */
+ public boolean autoclean() {
+ return mMutator.mAutoclean;
}
}
src/main/java/com/keenwrite/util/CyclicIterator.java
// Ensure the invariant holds.
- assert 0 <= result && result < size || size == 0 && result <= 0;
+ assert 0 <= result && result < size || size == 0;
return result;
src/main/java/com/keenwrite/util/GenericBuilder.java
/**
+ * Starting point for building an instance of a particular class.
+ *
+ * @param supplier Returns the instance to build.
+ * @param <MT> The type of class to build.
+ * @return A new {@link GenericBuilder} capable of populating data for an
+ * instance of the class provided by the {@link Supplier}.
+ */
+ public static <MT, IT> GenericBuilder<MT, IT> of(
+ final Supplier<MT> supplier, final Function<MT, IT> immutable ) {
+ return new GenericBuilder<>( supplier, immutable );
+ }
+
+ /**
* Constructs a new builder instance that is capable of populating values for
* any type of object.
mMutable = mutator;
mImmutable = immutable;
- }
-
- /**
- * Starting point for building an instance of a particular class.
- *
- * @param supplier Returns the instance to build.
- * @param <MT> The type of class to build.
- * @return A new {@link GenericBuilder} capable of populating data for an
- * instance of the class provided by the {@link Supplier}.
- */
- public static <MT, IT> GenericBuilder<MT, IT> of(
- final Supplier<MT> supplier, final Function<MT, IT> immutable ) {
- return new GenericBuilder<>( supplier, immutable );
}
Delta643 lines added, 567 lines removed, 76-line increase