RiGrammarX (RiTa)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

rita
Class RiGrammarX

java.lang.Object
  rita.RiObject
      rita.RiGrammarX

All Implemented Interfaces:: processing.core.PConstants, RiGrammarIF, RiConstants

public class RiGrammarX
extends RiObject
implements RiGrammarIF
extends RiObject
implements RiGrammarIF

Implementation of a (probabilistic) context-free grammar (with specific literary extensions) that performs generation from user-specified grammars.

 
    RiGrammar rg = new RiGrammar(this, "mygrammar.g");
    String result = rg.expand();
    System.out.println(result);

RiTa grammar files are plain text files (generally ending with the '.g' extension and residing in the 'data' folder) that follow the format below (< and > are optional):

 
      <start> => <rule1> | <rule2> | <rule3>

      <rule2> => terminal1 | terminal2 | <rule1>  

      <rule3> => terminal3 | terminal4 \
      terminal5 | terminal6

      # this is a comment 
    }
    ...

Primary methods of interest:

expand() which simply begins at the <start> state and generates a string of terminals from the grammar.
expandFrom(String) which begins with the argument String (which can consist of both non-terminals and terminals,) and expands from there. Notice that expand() is simply a convenient version of expandFrom("<start>");.
expandWith(String, String) takes 2 String arguments, the 1st (a terminal) is guaranteed to be substituted for the 2nd (a non-terminal). Once this substitution is made, the algorithm then works backwards (up the tree from the leaf) ensuring that the terminal (terminal1) appears in the output string. For example, with the grammar fragment above, one might call:
```
      grammar.expandWith(terminal1, "<rule2>");
 
```
assuring not only that <rule2>will be used at least once in the generation process, but that when it is, it will be replaced by the terminal "hello".

Other items of note:

Grammar files should be plain-text files placed in the 'data' directory of a Processing sketch, along with images, fonts, and other resources.
A RiGrammar object will assign (by default) equal weights to all choices in a rule. One can adjust the weights by adding 'probabilities' as follows: (in the rule below, 'rule1' will be chosen half as often as the 2 other choices).
```
    
   <start> => <rule1> [0.5] | <rule2> | <rule3>
 
```

The RiGrammar object supports callbacks, from your grammar, back into your Java code. To generate a callback, add a method call in your grammar, surrounded by back-ticks, as follows:

   
       <rule2> => \
       The cat ran after the `getRhyme("cat");` | \
       The <noun> ran after the `pluralize(<noun>);` 
     }

Any number of arguments may be passed in a callback, but for each call, there must be a corresponding method (with the same number and type or arguments) in the sketch, e.g.,

    String pluralize(String s) {
      ...
    }

Invisible:

Field Summary
`RiGrammarEditor`	`editor`
`static java.lang.String`	`ENCODING`
`static java.lang.String`	`EXEC_CHAR`
`static java.lang.String`	`EXEC_POST`
`int`	`maxIterations`
`static java.lang.String`	`PROB_PATTERN`
`java.util.regex.Pattern`	`probabilityPattern`
`RuleList`	`rules`
`static java.lang.String`	`START`
`java.lang.String`	`startRule`

Fields inherited from interface rita.support.RiConstants
BEHAVIOR_COMPLETED, BOUNDING_BOX_ALPHA, BRILL_POS_TAGGER, EASE_IN, EASE_IN_CUBIC, EASE_IN_EXPO, EASE_IN_OUT, EASE_IN_OUT_CUBIC, EASE_IN_OUT_EXPO, EASE_IN_OUT_QUARTIC, EASE_IN_OUT_SINE, EASE_IN_QUARTIC, EASE_IN_SINE, EASE_OUT, EASE_OUT_CUBIC, EASE_OUT_EXPO, EASE_OUT_QUARTIC, EASE_OUT_SINE, ESS, FADE_COLOR, FADE_IN, FADE_OUT, FADE_TO_TEXT, FIRST_PERSON, FUTURE_TENSE, ID, LERP, LINEAR, MAXENT_POS_TAGGER, MINIM, MOVE, MUTABLE, PAST_TENSE, PHONEME_BOUNDARY, PHONEMES, PLING_STEMMER, PLURAL, PORTER_STEMMER, POS, PRESENT_TENSE, SCALE_TO, SECOND_PERSON, SENTENCE_BOUNDARY, SINGULAR, SONIA, SPEECH_COMPLETED, STRESSES, SYLLABLE_BOUNDARY, SYLLABLES, TEXT, TEXT_ENTERED, THIRD_PERSON, TIMER, TIMER_COMPLETED, TIMER_TICK, TOKENS, UNKNOWN, WORD_BOUNDARY

Fields inherited from interface rita.support.RiConstants

BEHAVIOR_COMPLETED, BOUNDING_BOX_ALPHA, BRILL_POS_TAGGER, EASE_IN, EASE_IN_CUBIC, EASE_IN_EXPO, EASE_IN_OUT, EASE_IN_OUT_CUBIC, EASE_IN_OUT_EXPO, EASE_IN_OUT_QUARTIC, EASE_IN_OUT_SINE, EASE_IN_QUARTIC, EASE_IN_SINE, EASE_OUT, EASE_OUT_CUBIC, EASE_OUT_EXPO, EASE_OUT_QUARTIC, EASE_OUT_SINE, ESS, FADE_COLOR, FADE_IN, FADE_OUT, FADE_TO_TEXT, FIRST_PERSON, FUTURE_TENSE, ID, LERP, LINEAR, MAXENT_POS_TAGGER, MINIM, MOVE, MUTABLE, PAST_TENSE, PHONEME_BOUNDARY, PHONEMES, PLING_STEMMER, PLURAL, PORTER_STEMMER, POS, PRESENT_TENSE, SCALE_TO, SECOND_PERSON, SENTENCE_BOUNDARY, SINGULAR, SONIA, SPEECH_COMPLETED, STRESSES, SYLLABLE_BOUNDARY, SYLLABLES, TEXT, TEXT_ENTERED, THIRD_PERSON, TIMER, TIMER_COMPLETED, TIMER_TICK, TOKENS, UNKNOWN, WORD_BOUNDARY

Fields inherited from interface processing.core.PConstants
A, AB, ADD, AG, ALPHA, ALPHA_MASK, ALT, AMBIENT, AR, ARC, ARGB, ARROW, B, BACKSPACE, BASELINE, BEEN_LIT, BEVEL, BLEND, BLUE_MASK, BLUR, BOTTOM, BOX, BURN, CENTER, CENTER_DIAMETER, CENTER_RADIUS, CHATTER, CLOSE, CMYK, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CUSTOM, DA, DARKEST, DB, DEG_TO_RAD, DELETE, DG, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_ACCURATE_TEXTURES, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_OPENGL_2X_SMOOTH, DISABLE_OPENGL_ERROR_REPORT, DODGE, DOWN, DR, DXF, EB, EDGE, EG, ELLIPSE, ENABLE_ACCURATE_TEXTURES, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_2X_SMOOTH, ENABLE_OPENGL_4X_SMOOTH, ENABLE_OPENGL_ERROR_REPORT, ENTER, EPSILON, ER, ERODE, ERROR_BACKGROUND_IMAGE_FORMAT, ERROR_BACKGROUND_IMAGE_SIZE, ERROR_PUSHMATRIX_OVERFLOW, ERROR_PUSHMATRIX_UNDERFLOW, ERROR_TEXTFONT_NULL_PFONT, ESC, EXCLUSION, G, GIF, GRAY, GREEN_MASK, HALF_PI, HAND, HARD_LIGHT, HINT_COUNT, HSB, IMAGE, INVERT, JAVA2D, JPEG, LEFT, LIGHTEST, LINE, LINES, LINUX, MACOSX, MAX_FLOAT, MAX_INT, MIN_FLOAT, MIN_INT, MITER, MODEL, MULTIPLY, NORMAL, NORMALIZED, NX, NY, NZ, OPAQUE, OPEN, OPENGL, ORTHOGRAPHIC, OTHER, OVERLAY, P2D, P3D, PATH, PDF, PERSPECTIVE, PI, platformNames, POINT, POINTS, POLYGON, POSTERIZE, PROBLEM, PROJECT, QUAD, QUAD_STRIP, QUADS, QUARTER_PI, R, RAD_TO_DEG, RADIUS, RECT, RED_MASK, REPLACE, RETURN, RGB, RIGHT, ROUND, SA, SB, SCREEN, SG, SHAPE, SHIFT, SHINE, SOFT_LIGHT, SPB, SPG, SPHERE, SPOT, SPR, SQUARE, SR, SUBTRACT, SW, TAB, TARGA, THIRD_PI, THRESHOLD, TIFF, TOP, TRIANGLE, TRIANGLE_FAN, TRIANGLE_STRIP, TRIANGLES, TWO_PI, TX, TY, TZ, U, UP, V, VERTEX_FIELD_COUNT, VW, VX, VY, VZ, WAIT, WHITESPACE, WINDOWS, X, Y, Z

Fields inherited from interface processing.core.PConstants

A, AB, ADD, AG, ALPHA, ALPHA_MASK, ALT, AMBIENT, AR, ARC, ARGB, ARROW, B, BACKSPACE, BASELINE, BEEN_LIT, BEVEL, BLEND, BLUE_MASK, BLUR, BOTTOM, BOX, BURN, CENTER, CENTER_DIAMETER, CENTER_RADIUS, CHATTER, CLOSE, CMYK, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CUSTOM, DA, DARKEST, DB, DEG_TO_RAD, DELETE, DG, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_ACCURATE_TEXTURES, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_OPENGL_2X_SMOOTH, DISABLE_OPENGL_ERROR_REPORT, DODGE, DOWN, DR, DXF, EB, EDGE, EG, ELLIPSE, ENABLE_ACCURATE_TEXTURES, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_2X_SMOOTH, ENABLE_OPENGL_4X_SMOOTH, ENABLE_OPENGL_ERROR_REPORT, ENTER, EPSILON, ER, ERODE, ERROR_BACKGROUND_IMAGE_FORMAT, ERROR_BACKGROUND_IMAGE_SIZE, ERROR_PUSHMATRIX_OVERFLOW, ERROR_PUSHMATRIX_UNDERFLOW, ERROR_TEXTFONT_NULL_PFONT, ESC, EXCLUSION, G, GIF, GRAY, GREEN_MASK, HALF_PI, HAND, HARD_LIGHT, HINT_COUNT, HSB, IMAGE, INVERT, JAVA2D, JPEG, LEFT, LIGHTEST, LINE, LINES, LINUX, MACOSX, MAX_FLOAT, MAX_INT, MIN_FLOAT, MIN_INT, MITER, MODEL, MULTIPLY, NORMAL, NORMALIZED, NX, NY, NZ, OPAQUE, OPEN, OPENGL, ORTHOGRAPHIC, OTHER, OVERLAY, P2D, P3D, PATH, PDF, PERSPECTIVE, PI, platformNames, POINT, POINTS, POLYGON, POSTERIZE, PROBLEM, PROJECT, QUAD, QUAD_STRIP, QUADS, QUARTER_PI, R, RAD_TO_DEG, RADIUS, RECT, RED_MASK, REPLACE, RETURN, RGB, RIGHT, ROUND, SA, SB, SCREEN, SG, SHAPE, SHIFT, SHINE, SOFT_LIGHT, SPB, SPG, SPHERE, SPOT, SPR, SQUARE, SR, SUBTRACT, SW, TAB, TARGA, THIRD_PI, THRESHOLD, TIFF, TOP, TRIANGLE, TRIANGLE_FAN, TRIANGLE_STRIP, TRIANGLES, TWO_PI, TX, TY, TZ, U, UP, V, VERTEX_FIELD_COUNT, VW, VX, VY, VZ, WAIT, WHITESPACE, WINDOWS, X, Y, Z

Constructor Summary
`RiGrammarX(processing.core.PApplet parent)` New/experimental version of RiGrammar with simpler syntax...
`RiGrammarX(processing.core.PApplet parent, java.lang.String grammarFileName)`

Method Summary
`void`	`addRule(java.lang.String name, java.lang.String rule)`
`void`	`addRule(java.lang.String key, java.lang.String rule, float prob)`
`java.lang.String`	`expand()`
`java.lang.String`	`expandFrom(java.lang.String rule)`
`java.lang.String`	`expandWith(java.lang.String literalString, java.lang.String ruleName)`
`java.lang.String`	`getGrammarFileName()`
`java.lang.String`	`getRule(java.lang.String name)`
`boolean`	`hasRule(java.lang.String name)`
`static void`	`main(java.lang.String[] args)`
`static void`	`mainLSys(java.lang.String[] args)`
`RiGrammarEditor`	`openGrammarEditor()` Provides a live, editable view of a RiGrammar text file that can be dynamically loaded into a sketch without stopping and restarting it.
`RiGrammarEditor`	`openGrammarEditor(int width, int height)` Provides a live, editable view of a RiGrammar text file that can be dynamically loaded into a sketch without stopping and restarting it.
`void`	`reset()`
`void`	`setCallbackHandler(java.lang.Object handler)`
`void`	`setGrammarFromProperties(java.util.Properties grammarRules)`
`void`	`setGrammarFromProps(MultiMap grammarRules)`
`void`	`setGrammarFromString(java.lang.String grammarRulesAsString)`
`java.lang.String`	`toString()`

Methods inherited from class rita.RiObject
`dispose, getId, getPApplet, nextId`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

PROB_PATTERN

public static final java.lang.String PROB_PATTERN

See Also:: Constant Field Values

EXEC_CHAR

public static final java.lang.String EXEC_CHAR

See Also:: Constant Field Values

EXEC_POST

public static final java.lang.String EXEC_POST

See Also:: Constant Field Values

ENCODING

public static final java.lang.String ENCODING

See Also:: Constant Field Values

START

public static final java.lang.String START

See Also:: Constant Field Values

rules

public RuleList rules

Invisible:

maxIterations

public int maxIterations

startRule

public java.lang.String startRule

probabilityPattern

public java.util.regex.Pattern probabilityPattern

editor

public RiGrammarEditor editor

Invisible:

Constructor Detail

RiGrammarX

public RiGrammarX(processing.core.PApplet parent)

New/experimental version of RiGrammar with simpler syntax...

Invisible:

RiGrammarX

public RiGrammarX(processing.core.PApplet parent,
                  java.lang.String grammarFileName)

Method Detail

expandWith

public java.lang.String expandWith(java.lang.String literalString,
                                   java.lang.String ruleName)

Specified by:: expandWith in interface RiGrammarIF

openGrammarEditor

public RiGrammarEditor openGrammarEditor()

Provides a live, editable view of a RiGrammar text file that can be dynamically loaded into a sketch without stopping and restarting it.

openGrammarEditor

public RiGrammarEditor openGrammarEditor(int width,
                                         int height)

Provides a live, editable view of a RiGrammar text file that can be dynamically loaded into a sketch without stopping and restarting it.

addRule

public void addRule(java.lang.String name,
                    java.lang.String rule)

getRule

public java.lang.String getRule(java.lang.String name)

hasRule

public boolean hasRule(java.lang.String name)

expandFrom

public java.lang.String expandFrom(java.lang.String rule)

Specified by:: expandFrom in interface RiGrammarIF

setCallbackHandler

public void setCallbackHandler(java.lang.Object handler)

expand

public java.lang.String expand()

Specified by:: expand in interface RiGrammarIF

reset

public void reset()

toString

public java.lang.String toString()

Overrides:: toString in class java.lang.Object

setGrammarFromString

public void setGrammarFromString(java.lang.String grammarRulesAsString)

Specified by:: setGrammarFromString in interface RiGrammarIF

setGrammarFromProps

public void setGrammarFromProps(MultiMap grammarRules)

addRule

public void addRule(java.lang.String key,
                    java.lang.String rule,
                    float prob)

setGrammarFromProperties

public void setGrammarFromProperties(java.util.Properties grammarRules)

getGrammarFileName

public java.lang.String getGrammarFileName()

Specified by:: getGrammarFileName in interface RiGrammarIF

mainLSys

public static void mainLSys(java.lang.String[] args)

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Throws:: java.io.IOException

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

rita Class RiGrammarX

PROB_PATTERN

EXEC_CHAR

EXEC_POST

ENCODING

START

rules

maxIterations

startRule

probabilityPattern

editor

RiGrammarX

RiGrammarX

expandWith

openGrammarEditor

openGrammarEditor

addRule

getRule

hasRule

expandFrom

setCallbackHandler

expand

reset

toString

setGrammarFromString

setGrammarFromProps

addRule

setGrammarFromProperties

getGrammarFileName

mainLSys

main

rita
Class RiGrammarX