Package-level declarations

Panopset Flywheel package.

Types

Link copied to clipboard
abstract class Command(val template: Template, val templateLine: TemplateLine)
Link copied to clipboard
Link copied to clipboard
class CommandExecute(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : TemplateDirectiveCommand

e - Execute

Link copied to clipboard
class CommandFile(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : MatchableCommand

f - File

Link copied to clipboard
class CommandList(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : MatchableCommand, UserMatchableCommand

l - List

Link copied to clipboard
class CommandMap(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : TemplateDirectiveCommand
Link copied to clipboard
class CommandPush(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : MatchableCommand, UserMatchableCommand

p - Push

Link copied to clipboard
open class CommandQuit(val templateLine: TemplateLine, val template: Template) : TemplateDirectiveCommand

q - Quit

Link copied to clipboard
class CommandRaw(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : TemplateDirectiveCommand
Link copied to clipboard
class CommandReplace(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : MatchableCommand, UserMatchableCommand

p - Replace

Link copied to clipboard

Enumeration of all commands.

Link copied to clipboard
class CommandTemplate(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : TemplateDirectiveCommand

t - Template

Link copied to clipboard
class CommandText(val template: Template, val templateLine: TemplateLine, text: String) : Command

Command to handle normal text entry.

Link copied to clipboard
class CommandUnkown(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : TemplateDirectiveCommand
Link copied to clipboard
class CommandVariable(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : TemplateCommand

Variable

There is no command associated with a variable, so you drop the **@** directive indicator, and then you specify a variable just as you would in any ant script or unix shell. The variable must have been defined either in a map provided to the script through Flywheel.Builder.mergeMap, or a Push command. Please do not define numbers as variable names, as they are used in list processing.
Link copied to clipboard
class Control
Flywheel control flags.
Link copied to clipboard
class Driver
Link copied to clipboard
object Filter
Link copied to clipboard
class Flywheel(val sls: TemplateSource?) : MapProvider

Panopset Flywheel.

Commands

There are 7 commands that you may use in a Flywheel template. Commands have a default syntax that starts with ${@, followed by the letter associated with the command, followed by a space, followed by a parameter, followed by the default closing syntax of }.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class ImpliedQuit(val template: Template) : CommandQuit
Link copied to clipboard
object Javop
Link copied to clipboard
data class LineFeedRules(var lineBreaks: Boolean, var listBreaks: Boolean)
Link copied to clipboard
class ListAudit
Link copied to clipboard

Any command that is after burner processed with the QuitCommand must extend this class.

Link copied to clipboard
class NamedMap<K, V>(name: String, val map: MutableMap<K, V> = Collections.synchronizedMap(HashMap()))

Map wrapper with a map name.

Link copied to clipboard
object Passenger
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Flywheel reserved words, all in the com.panopset namespace.
Link copied to clipboard
object Rezop
Link copied to clipboard

Flywheel source file, all paths relative to the primary script file.

Link copied to clipboard
class Syntax
Flywheel script syntax.
Link copied to clipboard
class Template(val flywheel: Flywheel, val templateSource: TemplateSource, val templateRules: LineFeedRules)

Once a Flywheel Script file is read, it becomes a template to be processed. Templates may also be processed using the template directive within any template.

Link copied to clipboard
Link copied to clipboard
abstract class TemplateCommand : Command

A template command is specified in a script, and has a source.

Link copied to clipboard
open class TemplateDirectiveCommand(val templateLine: TemplateLine, val innerPiece: String, val template: Template) : TemplateCommand

Command that is created from a directive.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class TemplateLine(val line: String, val templateCharIndex: Int, val templateLineNumber: Int)
Link copied to clipboard
interface TemplateSource
Link copied to clipboard
Link copied to clipboard

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
const val lineBreaksFalse: Boolean = false
Link copied to clipboard
const val lineBreaksTrue: Boolean = true
Link copied to clipboard
Link copied to clipboard
const val listBreaksFalse: Boolean = false
Link copied to clipboard
const val listBreaksTrue: Boolean = true

Functions

Link copied to clipboard
fun addStructure(commands: List<Command>)
Link copied to clipboard
Link copied to clipboard
fun main()