com.cyc.cycjava.cycl
Class kb_indexing_declarations

java.lang.Object
  extended by com.cyc.tool.subl.util.SubLTrampolineFile
      extended by com.cyc.tool.subl.util.SubLTranslatedFile
          extended by com.cyc.cycjava.cycl.kb_indexing_declarations
All Implemented Interfaces:
CommonSymbols, SubLFile

public final class kb_indexing_declarations
extends SubLTranslatedFile


Nested Class Summary
 
Nested classes/interfaces inherited from class com.cyc.tool.subl.util.SubLTranslatedFile
SubLTranslatedFile.SubL
 
Field Summary
static SubLSymbol $kw12$KEYS
           
static SubLSymbol $kw13$EQUAL_TEST
           
static SubLSymbol $kw14$GAF_ARG
           
static SubLSymbol $kw16$NART_ARG
           
static SubLSymbol $kw18$PREDICATE_EXTENT
           
static SubLSymbol $kw20$FUNCTION_EXTENT
           
static SubLSymbol $kw22$PREDICATE_RULE
           
static SubLSymbol $kw24$DECONTEXTUALIZED_IST_PREDICATE_RULE
           
static SubLSymbol $kw26$ISA_RULE
           
static SubLSymbol $kw28$QUOTED_ISA_RULE
           
static SubLSymbol $kw3$ALLOW_OTHER_KEYS
           
static SubLSymbol $kw30$GENLS_RULE
           
static SubLSymbol $kw32$GENL_MT_RULE
           
static SubLSymbol $kw34$FUNCTION_RULE
           
static SubLSymbol $kw36$EXCEPTION_RULE
           
static SubLSymbol $kw38$PRAGMA_RULE
           
static SubLSymbol $kw4$DONE
           
static SubLSymbol $kw40$MICROTHEORY_CONTENTS
           
static SubLSymbol $kw42$MISCELLANEOUS
           
static SubLSymbol $kw9$TOP_LEVEL_KEY
           
static SubLList $list1
           
static SubLList $list10
           
static SubLList $list15
           
static SubLList $list17
           
static SubLList $list19
           
static SubLList $list2
           
static SubLList $list21
           
static SubLList $list23
           
static SubLList $list25
           
static SubLList $list27
           
static SubLList $list29
           
static SubLList $list31
           
static SubLList $list33
           
static SubLList $list35
           
static SubLList $list37
           
static SubLList $list39
           
static SubLList $list41
           
static SubLList $list43
           
static SubLList $list6
           
static SubLString $str11$Could_not_find_an_index_with_top_
           
static SubLSymbol $sym0$_KB_INDEXING_DECLARATION_STORE_
           
static SubLSymbol $sym5$DO_DICTIONARY
           
static SubLSymbol $sym7$KB_INDEXING_DECLARATION_STORE
           
static SubLSymbol $sym8$DO_KB_INDICES
           
static SubLFile me
           
static java.lang.String myName
           
 
Fields inherited from class com.cyc.tool.subl.util.SubLTranslatedFile
EMPTY_SUBL_OBJECT_ARRAY
 
Fields inherited from interface com.cyc.tool.subl.jrtl.nativeCode.subLisp.CommonSymbols
ANSWER_TAG, APPEND_KEYWORD, APPEND_STACK_TRACES_TO_ERROR_MESSAGES, AREF, ASSEMBLE_FIXNUMS_TO_INTEGER, ATOM, BIGNUMP, BINARY_KEYWORD, BINDING_TYPE, BOOLEANP, CAAR, CADR, CAND, CAR, CCATCH, CDEC, CDESTRUCTURING_BIND, CDO, CDO_ALL_SYMBOLS, CDO_EXTERNAL_SYMBOLS, CDO_SYMBOLS, CDOHASH, CDOLIST, CDOTIMES, CDR, CHAR, CHAR_E_SYMBOL, CHAR_EQUAL_SYMBOL, CHAR_GREATER_THAN_OR_EQUAL_SYMBOL, CHAR_GREATER_THAN_SYMBOL, CHAR_GT_SYMBOL, CHAR_GTE_SYMBOL, CHAR_LESS_THAN_OR_EQUAL_SYMBOL, CHAR_LESS_THAN_SYMBOL, CHAR_LT_SYMBOL, CHAR_LTE_SYMBOL, CHAR_NE_SYMBOL, CHAR_NOT_EQUAL_SYMBOL, CHARACTERP, CHECK_TYPE, CINC, CLET, CMULTIPLE_VALUE_BIND, CNOT, CONS, CONSP, CONSTANT, COR, CPOP, CPROGV, CPUSH, CPUSHNEW, CREATE_KEYWORD, CSETF, CSETQ, CSOME, CTIME, CUNWIND_PROTECT, CVS_ID, DEBUG_IO, DECLAIM, DECLARE, DEFCONSTANT, DEFINE, DEFLEXICAL, DEFMACRO, DEFPARAMETER, DEFVAR, DIRECTION_KEYWORD, DYNAMIC, EIGHT_INTEGER, EIGHTEEN_INTEGER, ELEMENT_TYPE_KEYWORD, ELEVEN_INTEGER, END_KEYWORD, ENFORCE_MUST, ENFORCE_TYPE, EQ, EQL, EQUAL, EQUALP, ERROR, ERROR_KEYWORD, ERROR_OUTPUT, EVAL, EXTERNAL_FORMAT_KEYWORD, EXTERNAL_KEYWORD, FIF, FIFTEEN_INTEGER, FIRST, FIVE_INTEGER, FIXNUMP, FLOATP, FOUR_INTEGER, FOURTEEN_INTEGER, FUNCTION, FUNCTION_SPEC_P, FUNCTIONP, FUNLESS, FWHEN, GET, GETHASH, GETHASH_WITHOUT_VALUES, GUID_P, HASH_TABLE_ITERATOR_P, HASH_TABLE_P, IDENTITY, IF_DOES_NOT_EXIST_KEYWORD, IF_EXISTS_KEYWORD, IGNORE, INITIALIZATION_TYPE, INITIALIZER, INPUT_KEYWORD, INPUT_STREAM_P, INTEGERP, INTERNAL_KEYWORD, IO_KEYWORD, KEYWORDP, KILL_KEYWORD, LAMBDA_SYMBOL, LEXICAL, LIST, LISTP, LISTS, LOCK_P, LONG_BIGNUM_P, MACRO_ENV, MACRO_FORM, MEDIUM_BIGNUM_P, MEMBER, MINUS_ONE_INTEGER, MULTIPLE_VALUE_LIST, MUST, NCONC, NEW_VERSION_KEYWORD, NIL, NINE_INTEGER, NINETEEN_INTEGER, NREVERSE, NTH, NTH_VALUE, NULL, NULL_INPUT, NULL_OUTPUT, NUM_E_SYMBOL, NUM_GT_SYMBOL, NUM_GTE_SYMBOL, NUM_LT_SYMBOL, NUM_LTE_SYMBOL, NUM_NE_SYMBOL, NUMBERP, ONE_HUNDRED_THIRTY_SEVEN_INTEGER, ONE_HUNDRED_TWENTY_SEVEN_INTEGER, ONE_INTEGER, ONE_THOUSAND_INTEGER, OPTIONAL_SYMBOL, OTHERWISE, OUTPUT_KEYWORD, OUTPUT_STREAM_P, OVERWRITE_KEYWORD, PACKAGEP, PCASE, PCOND, PIF, PROBE_KEYWORD, PROCESS_TO_END, PROCESSP, PROCLAIM, PROGN, PUNLESS, PWHEN, QUERY_IO, QUIT, QUOTE, RENAME_AND_DELETE_KEYWORD, REST_SYMBOL, RET, RET_NIL, RET_T, RETURN_TAG, REVERSE, RW_LOCK_P, SECOND, SEQUENCEP, SEVEN_INTEGER, SEVENTEEN_INTEGER, SHORT_BIGNUM_P, SHOW_STACK_TRACES, SIX_INTEGER, SIXTEEN_INTEGER, SIXTY_FOUR_INTEGER, SORT, SSS, STANDARD_INPUT, STANDARD_OUTPUT, START_KEYWORD, STREAMP, STRING_E_SYMBOL, STRING_EQUAL_SYMBOL, STRING_GREATER_THAN_OR_EQUAL_SYMBOL, STRING_GREATER_THAN_SYMBOL, STRING_GT_SYMBOL, STRING_GTE_SYMBOL, STRING_LESS_THAN_OR_EQUAL_SYMBOL, STRING_LESS_THAN_SYMBOL, STRING_LT_SYMBOL, STRING_LTE_SYMBOL, STRING_NE_SYMBOL, STRING_NOT_EQUAL_SYMBOL, STRINGP, STRUCTURE_P, SUPERSEDE_KEYWORD, SUSPEND_TYPE_CHECKING, SYMBOL_FUNCTION, SYMBOL_VALUE, SYMBOLP, T, TEN_INTEGER, TERMINAL_IO, TEXT_KEYWORD, THIRTEEN_INTEGER, THIRTY_FOUR_INTEGER, THIRTY_THREE_INTEGER, THIRTY_TWO_INTEGER, THREE_INTEGER, TRACE_OUTPUT, TRUE, TWELVE_INTEGER, TWENTY_INTEGER, TWO_HUNDRED_FIFTY_FOUR_INTEGER, TWO_HUNDRED_FORTY_FOUR_INTEGER, TWO_INTEGER, UNDECLARED, UNPROVIDED, VALUES, VECTOR, VECTORP, WITH_ERROR_HANDLER, WITH_STATIC_AREA, WITH_THREAD_PRIVATE_AREA, WITH_WORKING_AREA, WORLD, ZERO_DOUBLE, ZERO_INTEGER
 
Method Summary
static SubLObject add_index_to_kb_indexing_declaration_store(SubLObject index, SubLObject plist)
           
static SubLObject declare_index(SubLObject index, SubLObject plist)
          See below for an explanation of what fields go in the plist, what they mean, and a bunch of examples.
static SubLObject declare_kb_indexing_declarations_file()
           
 void declareFunctions()
          Declares the mapping between functions and symbols for all named functions defined in the file.
static SubLObject find_index_by_top_level_key(SubLObject top_level_key)
          Returns the index with a top-level key of TOP-LEVEL-KEY
static SubLObject get_index_from_kb_indexing_declaration_store(SubLObject index)
           
static SubLObject get_index_key_prop(SubLObject key_info, SubLObject indicator, SubLObject v_default)
           
static SubLObject get_index_prop(SubLObject index, SubLObject indicator)
           
static SubLObject index_equality_test_for_keys(SubLObject keys)
           
static SubLObject init_kb_indexing_declarations_file()
           
 void initializeVariables()
          Initializes all global variables and private internal variables for constants defined in the file.
static SubLObject kb_indexing_declaration_store()
           
 void runTopLevelForms()
          Runs all top-level forms in order.
static SubLObject setup_kb_indexing_declarations_file()
           
 
Methods inherited from class com.cyc.tool.subl.util.SubLTranslatedFile
extractFunctionNamed
 
Methods inherited from class com.cyc.tool.subl.util.SubLTrampolineFile
checkType, enforceType, extractBinaryFunc, extractCount, extractEnd, extractEndUsingSize, extractPackage, extractStart, extractUnaryFunc, main
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

me

public static final SubLFile me

myName

public static final java.lang.String myName
See Also:
Constant Field Values

$sym0$_KB_INDEXING_DECLARATION_STORE_

public static final SubLSymbol $sym0$_KB_INDEXING_DECLARATION_STORE_

$list1

public static final SubLList $list1

$list2

public static final SubLList $list2

$kw3$ALLOW_OTHER_KEYS

public static final SubLSymbol $kw3$ALLOW_OTHER_KEYS

$kw4$DONE

public static final SubLSymbol $kw4$DONE

$sym5$DO_DICTIONARY

public static final SubLSymbol $sym5$DO_DICTIONARY

$list6

public static final SubLList $list6

$sym7$KB_INDEXING_DECLARATION_STORE

public static final SubLSymbol $sym7$KB_INDEXING_DECLARATION_STORE

$sym8$DO_KB_INDICES

public static final SubLSymbol $sym8$DO_KB_INDICES

$kw9$TOP_LEVEL_KEY

public static final SubLSymbol $kw9$TOP_LEVEL_KEY

$list10

public static final SubLList $list10

$str11$Could_not_find_an_index_with_top_

public static final SubLString $str11$Could_not_find_an_index_with_top_

$kw12$KEYS

public static final SubLSymbol $kw12$KEYS

$kw13$EQUAL_TEST

public static final SubLSymbol $kw13$EQUAL_TEST

$kw14$GAF_ARG

public static final SubLSymbol $kw14$GAF_ARG

$list15

public static final SubLList $list15

$kw16$NART_ARG

public static final SubLSymbol $kw16$NART_ARG

$list17

public static final SubLList $list17

$kw18$PREDICATE_EXTENT

public static final SubLSymbol $kw18$PREDICATE_EXTENT

$list19

public static final SubLList $list19

$kw20$FUNCTION_EXTENT

public static final SubLSymbol $kw20$FUNCTION_EXTENT

$list21

public static final SubLList $list21

$kw22$PREDICATE_RULE

public static final SubLSymbol $kw22$PREDICATE_RULE

$list23

public static final SubLList $list23

$kw24$DECONTEXTUALIZED_IST_PREDICATE_RULE

public static final SubLSymbol $kw24$DECONTEXTUALIZED_IST_PREDICATE_RULE

$list25

public static final SubLList $list25

$kw26$ISA_RULE

public static final SubLSymbol $kw26$ISA_RULE

$list27

public static final SubLList $list27

$kw28$QUOTED_ISA_RULE

public static final SubLSymbol $kw28$QUOTED_ISA_RULE

$list29

public static final SubLList $list29

$kw30$GENLS_RULE

public static final SubLSymbol $kw30$GENLS_RULE

$list31

public static final SubLList $list31

$kw32$GENL_MT_RULE

public static final SubLSymbol $kw32$GENL_MT_RULE

$list33

public static final SubLList $list33

$kw34$FUNCTION_RULE

public static final SubLSymbol $kw34$FUNCTION_RULE

$list35

public static final SubLList $list35

$kw36$EXCEPTION_RULE

public static final SubLSymbol $kw36$EXCEPTION_RULE

$list37

public static final SubLList $list37

$kw38$PRAGMA_RULE

public static final SubLSymbol $kw38$PRAGMA_RULE

$list39

public static final SubLList $list39

$kw40$MICROTHEORY_CONTENTS

public static final SubLSymbol $kw40$MICROTHEORY_CONTENTS

$list41

public static final SubLList $list41

$kw42$MISCELLANEOUS

public static final SubLSymbol $kw42$MISCELLANEOUS

$list43

public static final SubLList $list43
Method Detail

kb_indexing_declaration_store

public static final SubLObject kb_indexing_declaration_store()

add_index_to_kb_indexing_declaration_store

public static final SubLObject add_index_to_kb_indexing_declaration_store(SubLObject index,
                                                                          SubLObject plist)

get_index_from_kb_indexing_declaration_store

public static final SubLObject get_index_from_kb_indexing_declaration_store(SubLObject index)

find_index_by_top_level_key

public static final SubLObject find_index_by_top_level_key(SubLObject top_level_key)
Returns the index with a top-level key of TOP-LEVEL-KEY


get_index_key_prop

public static final SubLObject get_index_key_prop(SubLObject key_info,
                                                  SubLObject indicator,
                                                  SubLObject v_default)

get_index_prop

public static final SubLObject get_index_prop(SubLObject index,
                                              SubLObject indicator)

declare_index

public static final SubLObject declare_index(SubLObject index,
                                             SubLObject plist)
See below for an explanation of what fields go in the plist, what they mean, and a bunch of examples.


index_equality_test_for_keys

public static final SubLObject index_equality_test_for_keys(SubLObject keys)
Parameters:
KEYS; - a list of keys, starting from the top level.
Returns:
valid-hash-table-test?; the test appropriate for distinguishing the last key in KEYS.

declare_kb_indexing_declarations_file

public static final SubLObject declare_kb_indexing_declarations_file()

init_kb_indexing_declarations_file

public static final SubLObject init_kb_indexing_declarations_file()

setup_kb_indexing_declarations_file

public static final SubLObject setup_kb_indexing_declarations_file()

declareFunctions

public void declareFunctions()
Description copied from interface: SubLFile
Declares the mapping between functions and symbols for all named functions defined in the file. Like CRTL define.


initializeVariables

public void initializeVariables()
Description copied from interface: SubLFile
Initializes all global variables and private internal variables for constants defined in the file. Like CRTL init.


runTopLevelForms

public void runTopLevelForms()
Description copied from interface: SubLFile
Runs all top-level forms in order. Like CRTL setup.