com.cyc.cycjava.cycl
Class cyc_bookkeeping

java.lang.Object
  com.cyc.tool.subl.util.SubLTrampolineFile
      com.cyc.tool.subl.util.SubLTranslatedFile
          com.cyc.cycjava.cycl.cyc_bookkeeping

All Implemented Interfaces:

CommonSymbols, SubLFile

public final class cyc_bookkeeping
extends SubLTranslatedFile

Nested Class Summary

Nested classes/interfaces inherited from class com.cyc.tool.subl.util.SubLTranslatedFile

SubLTranslatedFile.SubL

Field Summary

static SubLSymbol	$bookkeeping_enabledP$ If T, bookkeeping information, if any, is considered.
static SubLSymbol	$cyc_bookkeeping_info$ Can be dynamically bound to the right bookkeeping information (a plist).
static SubLSymbol	$kw19$SECOND
static SubLSymbol	$kw20$PURPOSE
static SubLSymbol	$kw21$WHEN
static SubLSymbol	$kw22$WHO
static SubLList	$list15
static SubLList	$list17
static SubLList	$list2
static SubLList	$list5
static SubLSymbol	$sym0$_BOOKKEEPING_ENABLED__
static SubLSymbol	$sym1$WITH_BOOKKEEPING_INFO
static SubLSymbol	$sym10$ASSERTED_WHEN
static SubLSymbol	$sym11$_KE_PURPOSE_
static SubLSymbol	$sym12$ASSERTED_WHY
static SubLSymbol	$sym13$_THE_SECOND_
static SubLSymbol	$sym14$ASSERTED_SECOND
static SubLSymbol	$sym16$PROGN
static SubLSymbol	$sym18$NEW_BOOKKEEPING_INFO
static SubLSymbol	$sym23$ASSERTION_P
static SubLSymbol	$sym3$CLET
static SubLSymbol	$sym4$_CYC_BOOKKEEPING_INFO_
static SubLSymbol	$sym6$ASSERTION_VAR
static SubLSymbol	$sym7$_THE_CYCLIST_
static SubLSymbol	$sym8$ASSERTED_BY
static SubLSymbol	$sym9$_THE_DATE_
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	cyc_bookkeeping_info_for(SubLObject what) Assumes that equality of WHAT can be tested with #'eql.
static SubLObject	cyc_bookkeeping_info() Public accessor for *cyc-bookkeeping-info*
static SubLObject	declare_cyc_bookkeeping_file()
void	declareFunctions() Declares the mapping between functions and symbols for all named functions defined in the file.
static SubLObject	do_bookkeepingP()
static SubLObject	init_cyc_bookkeeping_file()
void	initializeVariables() Initializes all global variables and private internal variables for constants defined in the file.
static SubLObject	new_bookkeeping_info(SubLObject who, SubLObject when, SubLObject why, SubLObject when_sec) Constructs a plist from any or all of the arguments passed in, suitable for passing to @xref with-bookkeeping-info
static SubLObject	perform_assertion_bookkeeping(SubLObject assertion)
static SubLObject	perform_constant_bookkeeping(SubLObject constant)
void	runTopLevelForms() Runs all top-level forms in order.
static SubLObject	setup_cyc_bookkeeping_file()
static SubLObject	with_bookkeeping_info(SubLObject macroform, SubLObject environment) Binds *cyc-bookkeeping-info* to BOOKKEEPING-INFO, which must be a plist.

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

$bookkeeping_enabledP$

public static SubLSymbol $bookkeeping_enabledP$

If T, bookkeeping information, if any, is considered. Can be set to nil by applications that don't care about bookkeeping.

$cyc_bookkeeping_info$

public static SubLSymbol $cyc_bookkeeping_info$

Can be dynamically bound to the right bookkeeping information (a plist).

$sym0$_BOOKKEEPING_ENABLED__

public static final SubLSymbol $sym0$_BOOKKEEPING_ENABLED__

$sym1$WITH_BOOKKEEPING_INFO

public static final SubLSymbol $sym1$WITH_BOOKKEEPING_INFO

$list2

public static final SubLList $list2

$sym3$CLET

public static final SubLSymbol $sym3$CLET

$sym4$_CYC_BOOKKEEPING_INFO_

public static final SubLSymbol $sym4$_CYC_BOOKKEEPING_INFO_

$list5

public static final SubLList $list5

$sym6$ASSERTION_VAR

public static final SubLSymbol $sym6$ASSERTION_VAR

$sym7$_THE_CYCLIST_

public static final SubLSymbol $sym7$_THE_CYCLIST_

$sym8$ASSERTED_BY

public static final SubLSymbol $sym8$ASSERTED_BY

$sym9$_THE_DATE_

public static final SubLSymbol $sym9$_THE_DATE_

$sym10$ASSERTED_WHEN

public static final SubLSymbol $sym10$ASSERTED_WHEN

$sym11$_KE_PURPOSE_

public static final SubLSymbol $sym11$_KE_PURPOSE_

$sym12$ASSERTED_WHY

public static final SubLSymbol $sym12$ASSERTED_WHY

$sym13$_THE_SECOND_

public static final SubLSymbol $sym13$_THE_SECOND_

$sym14$ASSERTED_SECOND

public static final SubLSymbol $sym14$ASSERTED_SECOND

$list15

public static final SubLList $list15

$sym16$PROGN

public static final SubLSymbol $sym16$PROGN

$list17

public static final SubLList $list17

$sym18$NEW_BOOKKEEPING_INFO

public static final SubLSymbol $sym18$NEW_BOOKKEEPING_INFO

$kw19$SECOND

public static final SubLSymbol $kw19$SECOND

$kw20$PURPOSE

public static final SubLSymbol $kw20$PURPOSE

$kw21$WHEN

public static final SubLSymbol $kw21$WHEN

$kw22$WHO

public static final SubLSymbol $kw22$WHO

$sym23$ASSERTION_P

public static final SubLSymbol $sym23$ASSERTION_P

Method Detail

with_bookkeeping_info

public static final SubLObject with_bookkeeping_info(SubLObject macroform,
                                                     SubLObject environment)

Binds *cyc-bookkeeping-info* to BOOKKEEPING-INFO, which must be a plist. The cyc-* functions will use this bookkeeping info if it is bound. Supported bookkeeping properties for the plist include: :who The Cyclist who performed the operation :when The universal date on which the operation was performed :purpose The #$Cyc-BasedProject for which the operation was performed :second The universal second at which the operation was performed

cyc_bookkeeping_info

public static final SubLObject cyc_bookkeeping_info()

Public accessor for *cyc-bookkeeping-info*

do_bookkeepingP

public static final SubLObject do_bookkeepingP()

new_bookkeeping_info

public static final SubLObject new_bookkeeping_info(SubLObject who,
                                                    SubLObject when,
                                                    SubLObject why,
                                                    SubLObject when_sec)

Constructs a plist from any or all of the arguments passed in, suitable for passing to @xref with-bookkeeping-info

cyc_bookkeeping_info_for

public static final SubLObject cyc_bookkeeping_info_for(SubLObject what)

Assumes that equality of WHAT can be tested with #'eql.

perform_constant_bookkeeping

public static final SubLObject perform_constant_bookkeeping(SubLObject constant)

perform_assertion_bookkeeping

public static final SubLObject perform_assertion_bookkeeping(SubLObject assertion)

declare_cyc_bookkeeping_file

public static final SubLObject declare_cyc_bookkeeping_file()

init_cyc_bookkeeping_file

public static final SubLObject init_cyc_bookkeeping_file()

setup_cyc_bookkeeping_file

public static final SubLObject setup_cyc_bookkeeping_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.