core/it.unibo.tuprolog.core/TermFormatter

TermFormatter

interface TermFormatter : Formatter<Term> , TermVisitor<String>

A Formatter specialized in rendering Terms as Strings, implemented as a TermVisitor (each visitX method renders the corresponding sub-type). The companion offers ready-made formatters covering the usual combinations of options (canonical, default, readable, prettyVariables, prettyExpressions); of is the general entry point when a custom combination of VarFormat/OpFormat/FuncFormat is needed.

Types

object Companion

enum FuncFormat : Enum<TermFormatter.FuncFormat>

How Struct.functors should be rendered.

enum OpFormat : Enum<TermFormatter.OpFormat>

Whether/how known it.unibo.tuprolog.core.operators.Operators should affect rendering.

TagsFormattingOptions

data class TagsFormattingOptions(val showTags: Boolean = false, val delimiters: Pair<String, String> = "<" to ">", val separator: String = ", ", val showKeys: Boolean = true, val showDelimitersIfEmpty: Boolean = false, val keyFilter: (String) -> Boolean = { true }, val tagFormatter: Formatter<Any>? = null)

Options controlling whether/how a Term's tags (see it.unibo.tuprolog.utils.Taggable) are rendered alongside it.

enum VarFormat : Enum<TermFormatter.VarFormat>

How Variables should be rendered.

Functions

abstract fun defaultValue(term: Term): String

The value produced for any Term whose specific type has no dedicated, overridden visitX method.

open override fun format(value: Term): String

Converts a Term into a String

open fun visitAtom(term: Atom): String

open fun visitBlock(term: Block): String

open fun visitClause(term: Clause): String

visitCollection

open fun visitCollection(term: Recursive): String

open fun visitCons(term: Cons): String

open fun visitConstant(term: Constant): String

open fun visitDirective(term: Directive): String

open fun visitEmpty(term: Empty): String

visitEmptyBlock

open fun visitEmptyBlock(term: EmptyBlock): String

open fun visitEmptyList(term: EmptyList): String

open fun visitFact(term: Fact): String

open fun visitIndicator(term: Indicator): String

open fun visitInteger(term: Integer): String

open fun visitList(term: List): String

open fun visitNumeric(term: Numeric): String

open fun visitReal(term: Real): String

open fun visitRule(term: Rule): String

open fun visitStruct(term: Struct): String

open fun visitTerm(term: Term): String

Visits a generic Term, regardless of its specific sub-type. Falls back to defaultValue.

open fun visitTruth(term: Truth): String

open fun visitTuple(term: Tuple): String

open fun visitVar(term: Var): String