Home › Packages › common-rails

Package common-rails

This package contains 14 source unit(s) defining 14 class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.

common-rails #sleela 2.5 (lib/common-rails/common-rails.sleela)

PrintRail class

the self-contained, runnable build of the SLeeLa common-rails

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
SQUARE_SIZEint SQUARE_SIZE = 21No description in source.
OID_WIDTHint OID_WIDTH = 10No description in source.
CURRENT_WIDTHint CURRENT_WIDTH = 39No description in source.
PRINT_WIDTHint PRINT_WIDTH = 80No description in source.
STATE_FIELDint STATE_FIELD = 10No description in source.
FULLString FULL = "█"Progress-square glyphs: FULL is the filled cell, LIGHT the empty cell.
LIGHTString LIGHT = "░"No description in source.
BOX_TLString BOX_TL = "┌"; String BOX_TM = "┬"; String BOX_TR = "┐"Box-drawing glyph set that frames a table (meaning survives without color).
BOX_MLString BOX_ML = "├"; String BOX_MM = "┼"; String BOX_MR = "┤"No description in source.
BOX_BLString BOX_BL = "└"; String BOX_BM = "┴"; String BOX_BR = "┘"No description in source.
BOX_HString BOX_H = "─"; String BOX_V = "│"No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
repeatString repeat(String s, int n)repeat(s, n): the core String has no repeat; build it by concatenation.
digitCountint digitCount(int v)digitCount(v): number of decimal digits in a non-negative int.
padZerosString padZeros(int value, int width)No description in source.
groupIntString groupInt(int value)No description in source.
padRightString padRight(String content, int contentChars, int width)padRight(content, contentChars, width): content then right-pad spaces.
padLeftString padLeft(String content, int contentChars, int width)padLeft(content, contentChars, width): left-pad spaces then content.
widthLineString widthLine(String content, int contentChars)A fixed-width content line, PRINT_WIDTH columns wide.
padCurrentString padCurrent(String name, int nameChars)padCurrent(name, nameChars): "[Current: @Name" + spaces + "]".
componentLineString componentLine(String name, int nameChars, int oid, int dateSeq, String message)No description in source.
stateLineTextString stateLineText(String state, int stateChars, String message, int messageChars)No description in source.
tableRuleString tableRule(String left, String mid, String right, int w0, int w1)No description in source.
tableRowTextString tableRowText(A table row "│ cell0 │ cell1 │"; leftAlign selects alignment for both cells.
printComponentvoid printComponent(String name, int nameChars, int oid, int dateSeq, String message)No description in source.
printStatevoid printState(String state, int stateChars, String message, int messageChars)No description in source.
printTableTopvoid printTableTop(int w0, int w1)No description in source.
printTableSeparatorvoid printTableSeparator(int w0, int w1)No description in source.
printTableBottomvoid printTableBottom(int w0, int w1)No description in source.
printTableRowvoid printTableRow(No description in source.
printTablevoid printTable(A complete two-column table: top, header, separator, two rows, bottom.
printPairvoid printPair(String field, int fieldChars, String value, int valueChars, boolean table)Field/value renderer with a `table` switch: framed table vs plain line.
clampPercentint clampPercent(int percent)No description in source.
percentToCellsint percentToCells(int percent)No description in source.
printSquarevoid printSquare(int filledCells)`filled` cells are filled in order bottom-right to left, then up a row.
printSquarePercentvoid printSquarePercent(int percent)No description in source.
printPixelvoid printPixel(int filledCells)Single-pixel indicator: the most compact rendering, one glyph.
printPixelPercentvoid printPixelPercent(int percent)No description in source.
toolLineString toolLine(String tool, int toolChars, String message, int messageChars)A tool banner line, for example: sleelvac, then the source and artifact.
compilerStatevoid compilerState(String state, int stateChars, String message, int messageChars)The COMPILER (Sleelvac) rail.
nordshriftStatevoid nordshriftState(String state, int stateChars, String message, int messageChars)The NORDSHRIFT rail.
debugFramevoid debugFrame(String symbol, int symbolChars, String location, int locationChars)The DEBUGGER rail: one stack frame rendered into the two-column table.
mainvoid main()No description in source.

PrintComponent #sleela 2.5 (lib/common-rails/PrintComponent.sleela)

PrintComponent class

Defines the SLeeLa standard-library type PrintComponent used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueString value=""No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(String v)No description in source.
getString get()No description in source.

PrintContractTest #sleela 2.5 (lib/common-rails/PrintContractTest.sleela)

PrintContractTest class

Defines the SLeeLa standard-library type PrintContractTest used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueString value=""No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(String v)No description in source.
getString get()No description in source.

PrintField #sleela 2.5 (lib/common-rails/PrintField.sleela)

PrintField class

Defines the SLeeLa standard-library type PrintField used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueString value=""No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(String v)No description in source.
getString get()No description in source.

PrintFormatter #sleela 2.5 (lib/common-rails/PrintFormatter.sleela)

PrintFormatter class

Defines the SLeeLa standard-library type PrintFormatter used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueString value=""No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(String v)No description in source.
getString get()No description in source.

PrintGlyphs #sleela 2.5 (lib/common-rails/PrintGlyphs.sleela)

PrintGlyphs class

Defines the SLeeLa standard-library type PrintGlyphs used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

PrintLayout #sleela 2.5 (lib/common-rails/PrintLayout.sleela)

PrintLayout class

Defines the SLeeLa standard-library type PrintLayout used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueString value=""No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(String v)No description in source.
getString get()No description in source.

PrintLine #sleela 2.5 (lib/common-rails/PrintLine.sleela)

PrintLine class

Defines the SLeeLa standard-library type PrintLine used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueString value=""No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(String v)No description in source.
getString get()No description in source.

PrintProgress #sleela 2.5 (lib/common-rails/PrintProgress.sleela)

PrintProgress class

Defines the SLeeLa standard-library type PrintProgress used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
sideint side=21No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
cellsint cells()No description in source.
clampint clamp(int percent)No description in source.
percentToCellsint percentToCells(int percent)No description in source.

PrintRail #sleela 2.5 (lib/common-rails/PrintRail.sleela)

PrintRail class

PrintRail -- the one professional-printing surface the SLeeLa

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
SQUARE_SIZEint SQUARE_SIZE = 21No description in source.
OID_WIDTHint OID_WIDTH = 10No description in source.
CURRENT_WIDTHint CURRENT_WIDTH = 39No description in source.
PRINT_WIDTHint PRINT_WIDTH = 80No description in source.
STATE_FIELDint STATE_FIELD = 10No description in source.
FULLString FULL = "█"Progress-square glyphs: FULL is the filled cell, LIGHT the empty cell.
LIGHTString LIGHT = "░"No description in source.
BOX_TLString BOX_TL = "┌"; String BOX_TM = "┬"; String BOX_TR = "┐"Box-drawing glyph set that frames a table (meaning survives without color).
BOX_MLString BOX_ML = "├"; String BOX_MM = "┼"; String BOX_MR = "┤"No description in source.
BOX_BLString BOX_BL = "└"; String BOX_BM = "┴"; String BOX_BR = "┘"No description in source.
BOX_HString BOX_H = "─"; String BOX_V = "│"No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
repeatString repeat(String s, int n)repeat(s, n): the core String has no repeat; build it by concatenation.
digitCountint digitCount(int v)digitCount(v): number of decimal digits in a non-negative int.
padZerosString padZeros(int value, int width)No description in source.
groupIntString groupInt(int value)No description in source.
padRightString padRight(String content, int contentChars, int width)padRight(content, contentChars, width): content then right-pad spaces.
padLeftString padLeft(String content, int contentChars, int width)padLeft(content, contentChars, width): left-pad spaces then content.
widthLineString widthLine(String content, int contentChars)A fixed-width content line, PRINT_WIDTH columns wide.
padCurrentString padCurrent(String name, int nameChars)padCurrent(name, nameChars): "[Current: @Name" + spaces + "]".
componentLineString componentLine(String name, int nameChars, int oid, int dateSeq, String message)No description in source.
stateLineTextString stateLineText(String state, int stateChars, String message, int messageChars)No description in source.
tableRuleString tableRule(String left, String mid, String right, int w0, int w1)No description in source.
tableRowTextString tableRowText(A table row "│ cell0 │ cell1 │"; leftAlign selects alignment for both cells.
printComponentvoid printComponent(String name, int nameChars, int oid, int dateSeq, String message)No description in source.
printStatevoid printState(String state, int stateChars, String message, int messageChars)No description in source.
printTableTopvoid printTableTop(int w0, int w1)No description in source.
printTableSeparatorvoid printTableSeparator(int w0, int w1)No description in source.
printTableBottomvoid printTableBottom(int w0, int w1)No description in source.
printTableRowvoid printTableRow(No description in source.
printTablevoid printTable(A complete two-column table: top, header, separator, two rows, bottom.
printPairvoid printPair(String field, int fieldChars, String value, int valueChars, boolean table)Field/value renderer with a `table` switch: framed table vs plain line.
clampPercentint clampPercent(int percent)No description in source.
percentToCellsint percentToCells(int percent)No description in source.
printSquarevoid printSquare(int filledCells)`filled` cells are filled in order bottom-right to left, then up a row.
printSquarePercentvoid printSquarePercent(int percent)No description in source.
printPixelvoid printPixel(int filledCells)Single-pixel indicator: the most compact rendering, one glyph.
printPixelPercentvoid printPixelPercent(int percent)No description in source.
toolLineString toolLine(String tool, int toolChars, String message, int messageChars)A tool banner line, for example: sleelvac, then the source and artifact.
compilerStatevoid compilerState(String state, int stateChars, String message, int messageChars)The COMPILER (Sleelvac) rail.
nordshriftStatevoid nordshriftState(String state, int stateChars, String message, int messageChars)The NORDSHRIFT rail.
debugFramevoid debugFrame(String symbol, int symbolChars, String location, int locationChars)The DEBUGGER rail: one stack frame rendered into the two-column table.

PrintRenderer #sleela 2.5 (lib/common-rails/PrintRenderer.sleela)

PrintRenderer class

Defines the SLeeLa standard-library type PrintRenderer used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueString value=""No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(String v)No description in source.
getString get()No description in source.

PrintState #sleela 2.5 (lib/common-rails/PrintState.sleela)

PrintState class

Defines the SLeeLa standard-library type PrintState used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueString value=""No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(String v)No description in source.
getString get()No description in source.

PrintWriter #sleela 2.5 (lib/common-rails/PrintWriter.sleela)

PrintWriter class

Defines the SLeeLa standard-library type PrintWriter used within the common-rails library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
valueString value=""No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
setvoid set(String v)No description in source.
getString get()No description in source.

SLPackage #sleela 2.5 (lib/common-rails/SLPackage.sleela)

CommonRails class

Defines the SLeeLa standard-library package for common-rails.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
sourceString source = "lib/common-rails/PrintRail.sleela"No description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
entryClassString entryClass()No description in source.
configurevoid configure(String path)No description in source.
pathString path()No description in source.
availableboolean available()No description in source.