com.planet_ink.coffee_mud.Libraries
Class EnglishParser

java.lang.Object
  extended by com.planet_ink.coffee_mud.Libraries.StdLibrary
      extended by com.planet_ink.coffee_mud.Libraries.EnglishParser
All Implemented Interfaces:
CMObject, CMLibrary, EnglishParsing, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class EnglishParser
extends StdLibrary
implements EnglishParsing


Nested Class Summary
protected  class EnglishParser.FetchFlags
           
 
Field Summary
static char[] ALL_CHRS
           
static java.lang.String[] fwords
           
static boolean[] PUNCTUATION_TABLE
           
 
Constructor Summary
EnglishParser()
           
 
Method Summary
 Item bestPossibleGold(MOB mob, Container container, java.lang.String itemID)
           
 java.lang.String bumpDotNumber(java.lang.String srchStr)
           
 int calculateMaxToGive(MOB mob, java.util.List<java.lang.String> commands, boolean breakPackages, Environmental checkWhat, boolean getOnly)
           
 java.lang.String cleanArticles(java.lang.String s)
           
 boolean containsString(java.lang.String toSrchStr, java.lang.String srchStr)
           
 boolean equalsPunctuationless(char[] strC, char[] str2C)
           
 void evoke(MOB mob, java.util.Vector commands)
           
 boolean evokedBy(Ability thisAbility, java.lang.String thisWord)
           
 boolean evokedBy(Ability thisAbility, java.lang.String thisWord, java.lang.String secondWord)
           
 Environmental fetchAvailable(java.util.Collection<? extends Environmental> list, java.lang.String srchStr, Item goodLocation, int wornFilter, boolean exactOnly)
           
 Item fetchAvailableItem(java.util.List<Item> list, java.lang.String srchStr, Item goodLocation, int wornReqCode, boolean exactOnly)
           
 java.util.List<Item> fetchAvailableItems(java.util.List<Item> list, java.lang.String srchStr, Item goodLocation, int wornReqCode, boolean exactOnly)
           
 Environmental fetchEnvironmental(java.util.Collection<? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)
           
 Environmental fetchEnvironmental(java.util.Map<java.lang.String,? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)
           
 java.util.List<Environmental> fetchEnvironmentals(java.util.List<? extends Environmental> list, java.lang.String srchStr, boolean exactOnly)
           
 EnglishParser.FetchFlags fetchFlags(java.lang.String srchStr)
           
 java.util.List<Item> fetchItemList(Environmental from, MOB mob, Item container, java.util.List<java.lang.String> commands, int preferredLoc, boolean visionMatters)
           
 CMObject findCommand(MOB mob, java.util.List<java.lang.String> commands)
           
 java.lang.String getAnEvokeWord(MOB mob, java.lang.String word)
           
 java.lang.String getContextName(java.util.Collection list, Environmental E)
           
 java.lang.String getContextName(java.lang.Object[] list, Environmental E)
           
 int getContextNumber(java.util.Collection list, Environmental E)
           
 int getContextNumber(java.lang.Object[] list, Environmental E)
           
 java.lang.String getContextSameName(java.util.Collection list, Environmental E)
           
 java.lang.String getContextSameName(java.lang.Object[] list, Environmental E)
           
 int getContextSameNumber(java.util.Collection list, Environmental E)
           
 int getContextSameNumber(java.lang.Object[] list, Environmental E)
           
 Ability getToEvoke(MOB mob, java.util.List<java.lang.String> commands)
           
 java.lang.String ID()
          The CoffeeMud Java Class ID shared by all instances of this object.
 java.lang.String insertUnColoredAdjective(java.lang.String str, java.lang.String adjective)
           
 boolean isAnArticle(java.lang.String s)
           
 java.lang.String makePlural(java.lang.String str)
           
 java.lang.String matchAnyCurrencySet(java.lang.String itemID)
           
 double matchAnyDenomination(java.lang.String currency, java.lang.String itemID)
           
 long numPossibleGold(Environmental mine, java.lang.String itemID)
           
 java.lang.String numPossibleGoldCurrency(Environmental mine, java.lang.String itemID)
           
 double numPossibleGoldDenomination(Environmental mine, java.lang.String currency, java.lang.String itemID)
           
 java.lang.Object[] parseMoneyStringSDL(MOB mob, java.lang.String amount, java.lang.String correctCurrency)
           
 Environmental parseShopkeeper(MOB mob, java.util.List<java.lang.String> commands, java.lang.String error)
           
 Item possibleContainer(MOB mob, java.util.List<java.lang.String> commands, boolean withStuff, int wornFilter)
           
 java.util.List<Container> possibleContainers(MOB mob, java.util.List<java.lang.String> commands, int wornFilter, boolean withContentOnly)
           
 Item possibleRoomGold(MOB seer, Room room, Container container, java.lang.String itemID)
           
 boolean preEvoke(MOB mob, java.util.List<java.lang.String> commands, int secondsElapsed, double actionsRemaining)
           
 boolean[] PUNCTUATION_TABLE()
           
 java.lang.String returnTime(long millis, long ticks)
           
 java.lang.String startWithAorAn(java.lang.String str)
           
 java.lang.String stripPunctuation(java.lang.String str)
           
 java.lang.String toEnglishStringList(java.lang.String[] V)
           
 
Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary
activate, compareTo, copyOf, getSupportThread, initializeClass, newInstance, propertiesLoaded, shutdown
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary
activate, getSupportThread, propertiesLoaded, shutdown
 
Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject
copyOf, initializeClass, newInstance
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

PUNCTUATION_TABLE

public static boolean[] PUNCTUATION_TABLE

ALL_CHRS

public static final char[] ALL_CHRS

fwords

public static final java.lang.String[] fwords
Constructor Detail

EnglishParser

public EnglishParser()
Method Detail

ID

public java.lang.String ID()
Description copied from interface: CMObject
The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, MiscTech. The name is typically identical to the class name.

Specified by:
ID in interface CMObject
Overrides:
ID in class StdLibrary
Returns:
the name of this class

toEnglishStringList

public java.lang.String toEnglishStringList(java.lang.String[] V)
Specified by:
toEnglishStringList in interface EnglishParsing

isAnArticle

public boolean isAnArticle(java.lang.String s)
Specified by:
isAnArticle in interface EnglishParsing

makePlural

public java.lang.String makePlural(java.lang.String str)
Specified by:
makePlural in interface EnglishParsing

cleanArticles

public java.lang.String cleanArticles(java.lang.String s)
Specified by:
cleanArticles in interface EnglishParsing

startWithAorAn

public java.lang.String startWithAorAn(java.lang.String str)
Specified by:
startWithAorAn in interface EnglishParsing

insertUnColoredAdjective

public java.lang.String insertUnColoredAdjective(java.lang.String str,
                                                 java.lang.String adjective)
Specified by:
insertUnColoredAdjective in interface EnglishParsing

findCommand

public CMObject findCommand(MOB mob,
                            java.util.List<java.lang.String> commands)
Specified by:
findCommand in interface EnglishParsing

evokedBy

public boolean evokedBy(Ability thisAbility,
                        java.lang.String thisWord)
Specified by:
evokedBy in interface EnglishParsing

evokedBy

public boolean evokedBy(Ability thisAbility,
                        java.lang.String thisWord,
                        java.lang.String secondWord)
Specified by:
evokedBy in interface EnglishParsing

getAnEvokeWord

public java.lang.String getAnEvokeWord(MOB mob,
                                       java.lang.String word)
Specified by:
getAnEvokeWord in interface EnglishParsing

getToEvoke

public Ability getToEvoke(MOB mob,
                          java.util.List<java.lang.String> commands)
Specified by:
getToEvoke in interface EnglishParsing

preEvoke

public boolean preEvoke(MOB mob,
                        java.util.List<java.lang.String> commands,
                        int secondsElapsed,
                        double actionsRemaining)
Specified by:
preEvoke in interface EnglishParsing

evoke

public void evoke(MOB mob,
                  java.util.Vector commands)
Specified by:
evoke in interface EnglishParsing

PUNCTUATION_TABLE

public boolean[] PUNCTUATION_TABLE()

stripPunctuation

public java.lang.String stripPunctuation(java.lang.String str)
Specified by:
stripPunctuation in interface EnglishParsing

equalsPunctuationless

public boolean equalsPunctuationless(char[] strC,
                                     char[] str2C)

containsString

public boolean containsString(java.lang.String toSrchStr,
                              java.lang.String srchStr)
Specified by:
containsString in interface EnglishParsing

bumpDotNumber

public java.lang.String bumpDotNumber(java.lang.String srchStr)
Specified by:
bumpDotNumber in interface EnglishParsing

getContextNumber

public int getContextNumber(java.lang.Object[] list,
                            Environmental E)
Specified by:
getContextNumber in interface EnglishParsing

getContextNumber

public int getContextNumber(java.util.Collection list,
                            Environmental E)
Specified by:
getContextNumber in interface EnglishParsing

getContextSameNumber

public int getContextSameNumber(java.lang.Object[] list,
                                Environmental E)
Specified by:
getContextSameNumber in interface EnglishParsing

getContextSameNumber

public int getContextSameNumber(java.util.Collection list,
                                Environmental E)
Specified by:
getContextSameNumber in interface EnglishParsing

getContextName

public java.lang.String getContextName(java.lang.Object[] list,
                                       Environmental E)
Specified by:
getContextName in interface EnglishParsing

getContextName

public java.lang.String getContextName(java.util.Collection list,
                                       Environmental E)
Specified by:
getContextName in interface EnglishParsing

getContextSameName

public java.lang.String getContextSameName(java.lang.Object[] list,
                                           Environmental E)
Specified by:
getContextSameName in interface EnglishParsing

getContextSameName

public java.lang.String getContextSameName(java.util.Collection list,
                                           Environmental E)
Specified by:
getContextSameName in interface EnglishParsing

parseShopkeeper

public Environmental parseShopkeeper(MOB mob,
                                     java.util.List<java.lang.String> commands,
                                     java.lang.String error)
Specified by:
parseShopkeeper in interface EnglishParsing

fetchItemList

public java.util.List<Item> fetchItemList(Environmental from,
                                          MOB mob,
                                          Item container,
                                          java.util.List<java.lang.String> commands,
                                          int preferredLoc,
                                          boolean visionMatters)
Specified by:
fetchItemList in interface EnglishParsing

numPossibleGold

public long numPossibleGold(Environmental mine,
                            java.lang.String itemID)
Specified by:
numPossibleGold in interface EnglishParsing

numPossibleGoldCurrency

public java.lang.String numPossibleGoldCurrency(Environmental mine,
                                                java.lang.String itemID)
Specified by:
numPossibleGoldCurrency in interface EnglishParsing

numPossibleGoldDenomination

public double numPossibleGoldDenomination(Environmental mine,
                                          java.lang.String currency,
                                          java.lang.String itemID)
Specified by:
numPossibleGoldDenomination in interface EnglishParsing

matchAnyCurrencySet

public java.lang.String matchAnyCurrencySet(java.lang.String itemID)
Specified by:
matchAnyCurrencySet in interface EnglishParsing

matchAnyDenomination

public double matchAnyDenomination(java.lang.String currency,
                                   java.lang.String itemID)
Specified by:
matchAnyDenomination in interface EnglishParsing

possibleRoomGold

public Item possibleRoomGold(MOB seer,
                             Room room,
                             Container container,
                             java.lang.String itemID)
Specified by:
possibleRoomGold in interface EnglishParsing

bestPossibleGold

public Item bestPossibleGold(MOB mob,
                             Container container,
                             java.lang.String itemID)
Specified by:
bestPossibleGold in interface EnglishParsing

possibleContainers

public java.util.List<Container> possibleContainers(MOB mob,
                                                    java.util.List<java.lang.String> commands,
                                                    int wornFilter,
                                                    boolean withContentOnly)
Specified by:
possibleContainers in interface EnglishParsing

possibleContainer

public Item possibleContainer(MOB mob,
                              java.util.List<java.lang.String> commands,
                              boolean withStuff,
                              int wornFilter)
Specified by:
possibleContainer in interface EnglishParsing

returnTime

public java.lang.String returnTime(long millis,
                                   long ticks)
Specified by:
returnTime in interface EnglishParsing

parseMoneyStringSDL

public java.lang.Object[] parseMoneyStringSDL(MOB mob,
                                              java.lang.String amount,
                                              java.lang.String correctCurrency)
Specified by:
parseMoneyStringSDL in interface EnglishParsing

calculateMaxToGive

public int calculateMaxToGive(MOB mob,
                              java.util.List<java.lang.String> commands,
                              boolean breakPackages,
                              Environmental checkWhat,
                              boolean getOnly)
Specified by:
calculateMaxToGive in interface EnglishParsing

fetchFlags

public EnglishParser.FetchFlags fetchFlags(java.lang.String srchStr)

fetchEnvironmental

public Environmental fetchEnvironmental(java.util.Collection<? extends Environmental> list,
                                        java.lang.String srchStr,
                                        boolean exactOnly)
Specified by:
fetchEnvironmental in interface EnglishParsing

fetchEnvironmentals

public java.util.List<Environmental> fetchEnvironmentals(java.util.List<? extends Environmental> list,
                                                         java.lang.String srchStr,
                                                         boolean exactOnly)
Specified by:
fetchEnvironmentals in interface EnglishParsing

fetchEnvironmental

public Environmental fetchEnvironmental(java.util.Map<java.lang.String,? extends Environmental> list,
                                        java.lang.String srchStr,
                                        boolean exactOnly)
Specified by:
fetchEnvironmental in interface EnglishParsing

fetchAvailableItem

public Item fetchAvailableItem(java.util.List<Item> list,
                               java.lang.String srchStr,
                               Item goodLocation,
                               int wornReqCode,
                               boolean exactOnly)
Specified by:
fetchAvailableItem in interface EnglishParsing

fetchAvailableItems

public java.util.List<Item> fetchAvailableItems(java.util.List<Item> list,
                                                java.lang.String srchStr,
                                                Item goodLocation,
                                                int wornReqCode,
                                                boolean exactOnly)
Specified by:
fetchAvailableItems in interface EnglishParsing

fetchAvailable

public Environmental fetchAvailable(java.util.Collection<? extends Environmental> list,
                                    java.lang.String srchStr,
                                    Item goodLocation,
                                    int wornFilter,
                                    boolean exactOnly)
Specified by:
fetchAvailable in interface EnglishParsing