name: ProductionRule

synopsis:

 
g++ [flags ...] file ... -l /isip/tools/lib/$ISIP_BINARY/lib_mmedia.a

#include <ProductionRule.h>

ProductionRuleTokenType::TYPE getType();
String getValue();
Float getWeight();

quick start:

ProductionRule prdrl;
prdrl.setRuleName(L"A");

prdrl.append(ProductionRuleTokenType::NONTERMINAL, L"a");
prdrl.append(ProductionRuleTokenType::KLEENE_STAR);

description:

The purpose of the ProductionRule class is to provide a uniform method for representing ABNF and BNF production rules in the LanguageModel classes and to form the basis of the RuleModel typedef that serves as a common grammar format.

Each ProductionRule is stored as a right-hand side (RHS) and a left-hand side (LHS). The RHS is stored as a String, and the LHS is stored as a DoubleLinkedList< Triple >. The first field of each entry in the LHS is the token type. The second field of each entry is the token value (typically the name of a terminal or nonterminal). The final field of each entry is used for the storage of weights (on concatenation, alternation, and kleene operators).

dependencies:

public constants:

define the class name:

static const String ProductionRule::CLASS_NAME = L"ProductionRule";

definition of rule types:

enum TYPE {NORMAL=0, START, DEF_TYPE = NORMAL};

static const String ProductionRule::TYPE_MAP(L"NORMAL, START");

define the file parameters:

static const String ProductionRule::DEF_PARAM = L"";

static const long ProductionRule::DEF_TAG = 0;

static const String ProductionRule::PARAM_RULE_NAME = L"rule_name";

static const String ProductionRule::RULE_NAME_BASE = L"R";

static const String ProductionRule::START_RULE_NAME = L"RS";

static const String ProductionRule::TERM_RULE_NAME= L"RT";

static const String ProductionRule::DEF_RULE_NAME= L"";

static const String ProductionRule::PARAM_RULE = L"rule";

error codes:

protected data:

declare a string to hold the rule name
```
String rule_name_d;
```
declare the rule type
```
String rule_type_d;
```

declare the RHS of the production rule

DoubleLinkedList< Triple< ProductionRuleTokenType, String, Float> > rule_d;

declare the debug level
```
DebugLevel debug_level_d;
```

required public methods:

static methods:

static const String& name();

static boolean diagnose(Integral::DEBUG debug_level);

debug methods:

boolean setDebug(Integral::DEBUG debug_level);

boolean debug(const unichar* msg) const;

constructor:
```
ProductionRule();
```

i/o methods:

boolean read(Sof& sof, long tag, const String& cname = CLASS_NAME);

boolean readData(Sof& sof, const String& pname = DEF_PARAM, long size = SofParser::FULL_OBJECT, boolean param = true, boolean nested = false);

boolean write(Sof& sof, long tag, const String& cname = CLASS_NAME) const;

boolean writeData(Sof& sof, const String& pname = DEF_PARAM) const;

long sofSize() const;

assign methods:

boolean assign(const ProductionRule& prdrl_a);

operator= methods:

ProductionRule& operator=(const ProductionRule& prdrl_a);

equality methods:

boolean eq(const ProductionRule& prdrl_a) const;

operator== methods:

ProductionRule& operator==(const ProductionRule& prdrl_a);

clear methods:
```
boolean clear(Integral::CMODE ctype);
```

class-specific public methods:

traversal methods:

boolean gotoFirst();

boolean gotoNext();

boolean gotoPrev();

boolean gotoPosition(long position);

operation methods:

boolean removeCurr();

ProductionRuleTokenType::TYPE getType();

String getValue();

Float getWeight();

boolean insert(const ProductionRuleTokenType::TYPE& type_a, const String& value_a=L"", Float weight_a=0);

boolean append(const ProductionRuleTokenType::TYPE& type_a, const String& value_a, Float weight_a);

boolean append(const ProductionRuleTokenType::TYPE& type_a, const String& value_a=L"");

get methods:

String getRuleName();

String getRule();

TYPE getRuleType();

set methods:

boolean setRuleName(const String& rule_name_a);

boolean setDebug(Integral::DEBUG level);

boolean setRuleType(TYPE type);

class-specific protected methods:

string conversion methods:

String convertToString(Triple< ProductionRuleTokenType, String, Float >& item_a);

examples:

This example shows how create a ProductionRule for "A::=(a B)+" and retrieve the string representation.


// declare the ProductionRule
//
ProductionRule prdrl;

// set the name
//
prdrl.setRuleName(L"A");

// construct the RHS
//
prdrl.append(ProductionRuleTokenType::OPEN_PAREN);
prdrl.append(ProductionRuleTokenType::TERMINAL, L"a");
prdrl.append(ProductionRuleTokenType::CONCATENATION);
prdrl.append(ProductionRuleTokenType::NON_TERMINAL, L"B");
prdrl.append(ProductionRuleTokenType::CONCATENATION);
prdrl.append(ProductionRuleTokenType::KLEENE_PLUS);

// output the string representation of the rule
//
Console::put(prdrl.getRule());

notes: