Pickle

• Index

Contents

• Metamethods
• Methods

Classes

• Bag
• Counter
• Adapt
• Case
• Double
• Spy
• Extractor
• Extractors
• Render
• RenderAdapt
• RenderFrame
• Renders
• RenderAdaptCompact
• RenderFrameCompact
• RenderAdaptFull
• RenderFrameFull
• RenderAdaptVivid
• RenderFrameVivid
• Report
• ReportAdapt
• ReportFrame
• Translator
• Translators

Modules

• Pickle
• util

Topics

• Activities
• Adapt
• Call style
• Log
• Databases
• Dataflow
• Hello World
• Lua classes
• Musings
• Page indicators
• Sources
• Spies
• Statistics
• Test anything protocol
• Frame
• Test doubles
• Testing
• Tracking categories
• Translatewiki
• Vagrant
• VScode extension
• VScode snippets

Examples

• HelloWorld.pickle.nb.lua
• HelloWorld.lua
• HelloWorld.pickle.lua

Class RenderFrame

Intermediate class for case report renderer.

This class follows the pattern with inheritance from Lua classes.

Metamethods

RenderFrame:__index (key)

Lookup of missing class members.

Methods

RenderFrame:create (...)	Create a new instance.
RenderFrame:_init (...)	Initialize a new instance.
RenderFrame:key (str)	Override key construction.
RenderFrame:realizeState (src, lang, counter)	Realize reported data for state.
RenderFrame:realizeSkip (src, lang)	Realize reported data for skip.
RenderFrame:realizeTodo (src, lang)	Realize reported data for todo.
RenderFrame:realizeDescription (src, lang)	Realize reported data for description.
RenderFrame:realizeName (src, lang)	Realize reported data for name.
RenderFrame:realizeHeader (src, lang, counter)	Realize reported data for header.
RenderFrame:realizeBody (src, lang)	Realize reported data for body.

Metamethods

RenderFrame:__index (key)

Lookup of missing class members.

Parameters:

• key string lookup of member

Returns:

any

Raises:

on wrong arguments

Methods

RenderFrame:create (...)

Create a new instance.

Parameters:

• ... vararg forwarded to superclass create method

Returns:

self

See also:

Render:create

RenderFrame:_init (...)

Initialize a new instance.

Parameters:

• ... vararg forwarded to superclass init method

Returns:

self

RenderFrame:key (str)

Override key construction.

Parameters:

• str string to be appended to a base string

Returns:

string

RenderFrame:realizeState (src, lang, counter)

Realize reported data for state.

Parameters:

• src Report that shall be realized
• lang nil or string code used for realization
• counter nil or Counter holding the running count

Returns:

string

RenderFrame:realizeSkip (src, lang)

Realize reported data for skip. The "skip" is a message identified by a key.

Parameters:

• src Report that shall be realized
• lang nil or string code used for realization

Returns:

string

Raises:

on wrong arguments

RenderFrame:realizeTodo (src, lang)

Realize reported data for todo. The "todo" is a text string.

Parameters:

• src Report that shall be realized
• lang nil or string code used for realization

Returns:

string

Raises:

on wrong arguments

RenderFrame:realizeDescription (src, lang)

Realize reported data for description. The "description" is a text string.

Parameters:

• src Report that shall be realized
• lang nil or string code used for realization (unused)

Returns:

string

Raises:

on wrong arguments

RenderFrame:realizeName (src, lang)

Realize reported data for name. The "name" is a text string.

Parameters:

• src Report that shall be realized
• lang nil or string code used for realization (unused)

Returns:

string

Raises:

on wrong arguments

RenderFrame:realizeHeader (src, lang, counter)

Realize reported data for header. The "header" is a composite.

Parameters:

• src Report that shall be realized
• lang nil or string code used for realization
• counter nil or Counter holding the running count

Returns:

string

Raises:

on wrong arguments

RenderFrame:realizeBody (src, lang)

Realize reported data for body. The "body" is a composite.

Parameters:

• src Report that shall be realized
• lang nil or string code used for realization (unused)

Returns:

string

Raises:

on wrong arguments