A C D E F G I K M N P R S T V X

A

apply(C, A) - Method in interface com.io7m.kstructural.core.KSMatcherType

C

call() - Method in class com.io7m.kstructural.frontend.KSOpCheck

call() - Method in class com.io7m.kstructural.frontend.KSOpCompileLaTeX

call() - Method in class com.io7m.kstructural.frontend.KSOpCompilePlain

call() - Method in class com.io7m.kstructural.frontend.KSOpCompileXHTML

call() - Method in class com.io7m.kstructural.frontend.KSOpConvert

com.io7m.kstructural.cmdline - package com.io7m.kstructural.cmdline

Command-line frontend.

com.io7m.kstructural.core - package com.io7m.kstructural.core

Core types and functions.

com.io7m.kstructural.core.evaluator - package com.io7m.kstructural.core.evaluator

Evaluator/annotator

com.io7m.kstructural.documentation - package com.io7m.kstructural.documentation

Documentation.

com.io7m.kstructural.frontend - package com.io7m.kstructural.frontend

Frontend API

com.io7m.kstructural.latex - package com.io7m.kstructural.latex

LaTeX backend.

com.io7m.kstructural.parser - package com.io7m.kstructural.parser

Core parser.

com.io7m.kstructural.parser.canon - package com.io7m.kstructural.parser.canon

Parsers for the canon s-expression encoding.

com.io7m.kstructural.parser.imperative - package com.io7m.kstructural.parser.imperative

Parser for the imperative encoding.

com.io7m.kstructural.plain - package com.io7m.kstructural.plain

Plain text backend.

com.io7m.kstructural.pretty - package com.io7m.kstructural.pretty

Pretty printing for documents as s-expressions.

com.io7m.kstructural.schema - package com.io7m.kstructural.schema

com.io7m.kstructural.xom - package com.io7m.kstructural.xom

XOM backend.

convert(String) - Method in class com.io7m.kstructural.cmdline.KSCLInputFormatConverter

convert(String) - Method in class com.io7m.kstructural.cmdline.KSCLLogLevelConverter

convert(String) - Method in class com.io7m.kstructural.cmdline.KSCLXHTMLPaginationConverter

create(Path) - Static method in class com.io7m.kstructural.frontend.KSOpCheck

create(Path, Path, KSLaTeXSettings) - Static method in class com.io7m.kstructural.frontend.KSOpCompileLaTeX

Construct a new operation.

create(Path, Path, KSPlainSettings) - Static method in class com.io7m.kstructural.frontend.KSOpCompilePlain

Construct a new operation.

create(Path, Path, KSXOMSettings, KSOpCompileXHTML.XHTMLPagination, boolean) - Static method in class com.io7m.kstructural.frontend.KSOpCompileXHTML

Construct a new operation.

create(Path, Path, KSInputFormat, boolean, int, int) - Static method in class com.io7m.kstructural.frontend.KSOpConvert

create(KSParseContextType, Path) - Method in class com.io7m.kstructural.frontend.KSParsers

createCanonical(KSParseContextType) - Static method in class com.io7m.kstructural.frontend.KSParsers

Create a new canonical format parser.

createImperative(KSParseContextType) - Static method in class com.io7m.kstructural.frontend.KSParsers

Create a new imperative format parser.

createXML(KSParseContextType) - Static method in class com.io7m.kstructural.frontend.KSParsers

Create a new XML format parser.

D

Documentation - Class in com.io7m.kstructural.documentation

Marker class for looking up files by resource.

E

escapeAll(String) - Static method in class com.io7m.kstructural.latex.KSLaTeXEscapes

Escape all characters that cannot appear as arbitrary text in a LaTeX document.

escapeForVerbatim(String) - Static method in class com.io7m.kstructural.latex.KSLaTeXEscapes

Escape all characters that cannot appear as arbitrary text in LaTeX verbatim elements.

exitCode() - Method in class com.io7m.kstructural.cmdline.KSCLMain

export(Path, KSElement.KSBlock.KSBlockDocument<KSEvaluation>, Path, boolean) - Method in class com.io7m.kstructural.frontend.KSExporter

export(Path, KSElement.KSBlock.KSBlockDocument<KSEvaluation>, Path, boolean) - Method in interface com.io7m.kstructural.frontend.KSExporterType

Export a document.

F

fail(E) - Static method in class com.io7m.kstructural.core.KSResults

filterXML10(String) - Static method in class com.io7m.kstructural.xom.KSXOMEscapeCharacters

fromStream(Path, InputStream) - Static method in class com.io7m.kstructural.latex.KSLaTeXTypeMap

Read a set of mappings from type names to emphasis types from the given stream.

G

getAppenderEnd() - Method in class com.io7m.kstructural.frontend.KSBrandAppender

getAppenderStart() - Method in class com.io7m.kstructural.frontend.KSBrandAppender

getInstance() - Static method in class com.io7m.kstructural.core.KSResults

getInstance() - Static method in class com.io7m.kstructural.frontend.KSParsers

getName() - Method in enum com.io7m.kstructural.cmdline.KSCLLogLevel

getName() - Method in enum com.io7m.kstructural.frontend.KSInputFormat

getName() - Method in enum com.io7m.kstructural.frontend.KSOpCompileXHTML.XHTMLPagination

getSchemaAsStream() - Static method in class com.io7m.kstructural.schema.KSSchemaResources

I

isAllowedXML1_0(int) - Static method in class com.io7m.kstructural.xom.KSXOMEscapeCharacters

K

KSBrandAppender - Class in com.io7m.kstructural.frontend

Code for appending and/or prepending branding to XHTML documents.

KSCanonParserDriver - Class in com.io7m.kstructural.parser.canon

A parser driver for a canonical format parser.

KSCLInputFormatConverter - Class in com.io7m.kstructural.cmdline

A converter for KSInputFormat values.

KSCLInputFormatConverter() - Constructor for class com.io7m.kstructural.cmdline.KSCLInputFormatConverter

Construct a new converter.

KSCLLogLevel - Enum in com.io7m.kstructural.cmdline

Log level.

KSCLLogLevelConverter - Class in com.io7m.kstructural.cmdline

A converter for KSCLLogLevel values.

KSCLLogLevelConverter() - Constructor for class com.io7m.kstructural.cmdline.KSCLLogLevelConverter

Construct a new converter.

KSCLMain - Class in com.io7m.kstructural.cmdline

The main command line program.

KSCLXHTMLPaginationConverter - Class in com.io7m.kstructural.cmdline

A converter for KSOpCompileXHTML.XHTMLPagination values.

KSCLXHTMLPaginationConverter() - Constructor for class com.io7m.kstructural.cmdline.KSCLXHTMLPaginationConverter

Construct a new converter.

KSCoreMarker - Class in com.io7m.kstructural.core

Marker class for locating resources by class lookup.

KSExporter - Class in com.io7m.kstructural.frontend

The default implementation of the KSExporterType interface.

KSExporterType - Interface in com.io7m.kstructural.frontend

The type of document exporters/converts.

KSExpressionParserType - Interface in com.io7m.kstructural.parser

The type of s-expression parsers.

KSImperativeParserDriver - Class in com.io7m.kstructural.parser.imperative

A driver for imperative parsers.

KSInputFormat - Enum in com.io7m.kstructural.frontend

The supported input formats for documents.

KSJingValidation - Class in com.io7m.kstructural.xom

Convenient RELAX-NG validation with Jing.

KSLaTeXEscapes - Class in com.io7m.kstructural.latex

Functions to escape characters that should not appear in LaTeX documents.

KSLaTeXTypeMap - Class in com.io7m.kstructural.latex

A map from type names to LaTeX emphasis types.

KSMatcherType<C,A,B,E extends Throwable> - Interface in com.io7m.kstructural.core

KSOpCheck - Class in com.io7m.kstructural.frontend

The document checking operation.

KSOpCompileLaTeX - Class in com.io7m.kstructural.frontend

An operation that compiles a document to LaTeX.

KSOpCompilePlain - Class in com.io7m.kstructural.frontend

An operation that compiles a document to plain text.

KSOpCompileXHTML - Class in com.io7m.kstructural.frontend

An operation that compiles a document to XHTML.

KSOpCompileXHTML.XHTMLPagination - Enum in com.io7m.kstructural.frontend

The type of XHTML pagination.

KSOpConvert - Class in com.io7m.kstructural.frontend

An operation that converts documents.

KSOpFailed - Exception in com.io7m.kstructural.frontend

A generic exception indicating that an operation failed.

KSOpFailed() - Constructor for exception com.io7m.kstructural.frontend.KSOpFailed

Construct an exception with the default message.

KSOpType - Interface in com.io7m.kstructural.frontend

The type of operations executed by the frontend.

KSParseAndEvaluate - Class in com.io7m.kstructural.frontend

Convenient functions to parse and evaluate documents.

KSParserMarker - Class in com.io7m.kstructural.parser

Marker class for locating resources by class lookup.

KSParsers - Class in com.io7m.kstructural.frontend

The default set of provided parsers.

KSPlain - Class in com.io7m.kstructural.plain

Marker interface for looking up resources by class.

KSRestrictedEntityResolver - Class in com.io7m.kstructural.xom

A restricted entity resolver that refuses to resolve URIs that are either not file URIs or refer to files that are not descendants of a given base directory.

KSRestrictedEntityResolver(Path) - Constructor for class com.io7m.kstructural.xom.KSRestrictedEntityResolver

Construct a new resolver that will only allow access to files that are descendants of the given base directory.

KSResults - Class in com.io7m.kstructural.core

KSSchemaNamespaces - Class in com.io7m.kstructural.schema

KSSchemaResources - Class in com.io7m.kstructural.schema

KSSExprEscape - Class in com.io7m.kstructural.pretty

Functions to escape strings.

KSXOMEscapeCharacters - Class in com.io7m.kstructural.xom

Functions to escape illegal XML characters.

KSXOMMarker - Class in com.io7m.kstructural.xom

Marker class for locating resources by class lookup.

KSXOMXMLParserDriver - Class in com.io7m.kstructural.xom

A driver for XML parsers.

M

main(String[]) - Static method in class com.io7m.kstructural.cmdline.KSCLMain

The main entry point.

N

NAMESPACE_URI - Static variable in class com.io7m.kstructural.schema.KSSchemaNamespaces

NAMESPACE_URI_TEXT - Static variable in class com.io7m.kstructural.schema.KSSchemaNamespaces

newAppender(Optional<Path>, Optional<Path>) - Static method in class com.io7m.kstructural.frontend.KSBrandAppender

Construct a new appender.

newDriver(KSParserDriverConstructorType) - Static method in class com.io7m.kstructural.parser.canon.KSCanonParserDriver

Construct a new driver for canonical parsers.

newDriver(KSParserDriverConstructorType) - Static method in class com.io7m.kstructural.parser.imperative.KSImperativeParserDriver

Construct a new driver for imperative parsers.

newDriver(KSParserDriverConstructorType) - Static method in class com.io7m.kstructural.xom.KSXOMXMLParserDriver

Construct a new driver for XML parsers.

newExporter(KSInputFormat, int, int) - Static method in class com.io7m.kstructural.frontend.KSExporter

Construct a new importer

P

parse() - Method in interface com.io7m.kstructural.parser.KSExpressionParserType

parseAndEvaluate(Path, Path) - Static method in class com.io7m.kstructural.frontend.KSParseAndEvaluate

Parse and evaluate the given file.

parseBlock(KSParseContextType, Path) - Method in class com.io7m.kstructural.parser.canon.KSCanonParserDriver

parseBlock(KSParseContextType, Path) - Method in class com.io7m.kstructural.parser.imperative.KSImperativeParserDriver

parseBlock(KSParseContextType, Path) - Method in class com.io7m.kstructural.xom.KSXOMXMLParserDriver

R

requiresQuoting(String) - Static method in class com.io7m.kstructural.pretty.KSSExprEscape

resolveEntity(String, String) - Method in class com.io7m.kstructural.xom.KSRestrictedEntityResolver

run() - Method in class com.io7m.kstructural.cmdline.KSCLMain

S

SEXPR_STRING_ESCAPE - Static variable in class com.io7m.kstructural.pretty.KSSExprEscape

A translator to escape quotes in strings.

T

toString() - Method in enum com.io7m.kstructural.cmdline.KSCLLogLevel

toString() - Method in enum com.io7m.kstructural.frontend.KSInputFormat

toString() - Method in enum com.io7m.kstructural.frontend.KSOpCompileXHTML.XHTMLPagination

V

validate(Path, Path, InputStream) - Static method in class com.io7m.kstructural.xom.KSJingValidation

Validate the file p using the base directory base_directory.

valueOf(String) - Static method in enum com.io7m.kstructural.cmdline.KSCLLogLevel

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.io7m.kstructural.frontend.KSInputFormat

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.io7m.kstructural.frontend.KSOpCompileXHTML.XHTMLPagination

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.io7m.kstructural.cmdline.KSCLLogLevel

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.io7m.kstructural.frontend.KSInputFormat

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.io7m.kstructural.frontend.KSOpCompileXHTML.XHTMLPagination

Returns an array containing the constants of this enum type, in the order they are declared.

X

XINCLUDE_NAMESPACE_URI - Static variable in class com.io7m.kstructural.schema.KSSchemaNamespaces

XINCLUDE_NAMESPACE_URI_TEXT - Static variable in class com.io7m.kstructural.schema.KSSchemaNamespaces

XML_NAMESPACE_URI - Static variable in class com.io7m.kstructural.schema.KSSchemaNamespaces

XML_NAMESPACE_URI_TEXT - Static variable in class com.io7m.kstructural.schema.KSSchemaNamespaces

A C D E F G I K M N P R S T V X