com.cyc.cycjava.cycl
Class api_kernel

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

All Implemented Interfaces:

CommonSymbols, SubLFile

public final class api_kernel
extends SubLTranslatedFile

Nested Class Summary

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

SubLTranslatedFile.SubL

Field Summary

static SubLSymbol	$api_in_stream$ the api input stream (for use by the java-api-kernel).
static SubLSymbol	$api_message_sink$ Either a list or a stream.
static SubLSymbol	$api_out_stream$ the api output stream (for use by the java-api-kernel).
static SubLSymbol	$api_result_method$ When non-nil, a function which is called to transform any API result before returning the output.
static SubLSymbol	$api_validate_method$ When non-nil, a function which is called to validate any API request before evaluation.
static SubLSymbol	$default_api_input_protocol$ The default API input protocol to use.
static SubLSymbol	$default_api_output_protocol$ The default API output protocol to use.
static SubLSymbol	$default_api_validate_method$ The default API input validator to use.
static SubLInteger	$int26$200
static SubLInteger	$int27$500
static SubLSymbol	$kw0$CYC_API
static SubLSymbol	$kw2$TEXT
static SubLSymbol	$kw33$PRIVATE
static SubLSymbol	$kw41$EOF
static SubLSymbol	$kw5$API_QUIT
static SubLList	$list12
static SubLList	$list16
static SubLList	$list37
static SubLList	$list39
static SubLSymbol	$record_api_messagesP$
static SubLString	$str13$
static SubLString	$str18$API_Input_EOF_Marker
static SubLString	$str19$Invalid_API_Request___S_is_not_a_
static SubLString	$str20$Invalid_API_Request___S_is_not_a_
static SubLString	$str22$___A_is_not_an_existing_constant
static SubLString	$str23$API_request_references_an_invalid
static SubLString	$str28$_D__S
static SubLString	$str3$CYC
static SubLString	$str34$_api_quit__
static SubLString	$str35$_A
static SubLString	$str38$Evaluate_API_REQUEST_on_MACHINE_u
static SubLString	$str42$_S_
static SubLString	$str7$Explicitly_quit_this_api_connecti
static SubLSymbol	$sym1$API_SERVER_HANDLER
static SubLSymbol	$sym10$DEFAULT_API_OUTPUT_PROTOCOL
static SubLSymbol	$sym11$CLET
static SubLSymbol	$sym14$CATCH_ERROR_MESSAGE_HANDLER
static SubLSymbol	$sym15$TASK_PROCESSOR_REQUEST
static SubLSymbol	$sym17$_API_INPUT_EOF_MARKER_
static SubLSymbol	$sym21$INVALID_CONSTANT_
static SubLSymbol	$sym24$GUID_P
static SubLSymbol	$sym25$GUID_TO_STRING
static SubLSymbol	$sym29$FUNCTION_SPEC_P
static SubLSymbol	$sym30$CONSP
static SubLSymbol	$sym31$STRINGP
static SubLSymbol	$sym32$INTEGERP
static SubLSymbol	$sym36$CYC_API_REMOTE_EVAL
static SubLSymbol	$sym4$DOUBLE_FLOAT
static SubLSymbol	$sym40$STREAMP
static SubLSymbol	$sym6$API_QUIT
static SubLSymbol	$sym8$DEFAULT_API_INPUT_PROTOCOL
static SubLSymbol	$sym9$DEFAULT_VALIDATE_API_REQUEST
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	api_input_protocol()
static SubLObject	api_port() Returns the local api-port according to defined system parameters.
static SubLObject	api_quit() Explicitly quit this api connection.
static SubLObject	api_server_handler(SubLObject in_stream, SubLObject out_stream)
static SubLObject	api_server_loop(SubLObject in_stream, SubLObject out_stream)
static SubLObject	api_server_one_complete_request(SubLObject in_stream, SubLObject out_stream)
static SubLObject	api_server_top_level(SubLObject in_stream, SubLObject out_stream)
static SubLObject	declare_api_kernel_file()
void	declareFunctions() Declares the mapping between functions and symbols for all named functions defined in the file.
static SubLObject	default_api_output_protocol(SubLObject out_stream, SubLObject api_result, SubLObject errorP)
static SubLObject	init_api_kernel_file()
void	initializeVariables() Initializes all global variables and private internal variables for constants defined in the file.
static SubLObject	perform_api_request(SubLObject api_request)
static SubLObject	read_api_request(SubLObject in_stream)
static SubLObject	record_api_request(SubLObject api_request)
static SubLObject	record_api_result(SubLObject result, SubLObject errorP)
void	runTopLevelForms() Runs all top-level forms in order.
static SubLObject	send_api_result(SubLObject out_stream, SubLObject api_result, SubLObject errorP) Send API-RESULT to OUT-STREAM respecting ERROR?.
static SubLObject	set_api_input_protocol(SubLObject input_protocol)
static SubLObject	set_api_output_protocol(SubLObject output_protocol)
static SubLObject	setup_api_kernel_file()
static SubLObject	update_api_protocol()
static SubLObject	valid_api_function_symbol(SubLObject symbol)
static SubLObject	validate_api_request(SubLObject api_request)

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

$default_api_input_protocol$

public static SubLSymbol $default_api_input_protocol$

The default API input protocol to use.

$default_api_validate_method$

public static SubLSymbol $default_api_validate_method$

The default API input validator to use.

$api_validate_method$

public static SubLSymbol $api_validate_method$

When non-nil, a function which is called to validate any API request before evaluation.

$api_result_method$

public static SubLSymbol $api_result_method$

When non-nil, a function which is called to transform any API result before returning the output.

$default_api_output_protocol$

public static SubLSymbol $default_api_output_protocol$

The default API output protocol to use.

$api_in_stream$

public static SubLSymbol $api_in_stream$

the api input stream (for use by the java-api-kernel).

$api_out_stream$

public static SubLSymbol $api_out_stream$

the api output stream (for use by the java-api-kernel).

$record_api_messagesP$

public static SubLSymbol $record_api_messagesP$

$api_message_sink$

public static SubLSymbol $api_message_sink$

Either a list or a stream. If a list, the messages are stuck on the list. If a stream, the messages are output to it.

$kw0$CYC_API

public static final SubLSymbol $kw0$CYC_API

$sym1$API_SERVER_HANDLER

public static final SubLSymbol $sym1$API_SERVER_HANDLER

$kw2$TEXT

public static final SubLSymbol $kw2$TEXT

$str3$CYC

public static final SubLString $str3$CYC

$sym4$DOUBLE_FLOAT

public static final SubLSymbol $sym4$DOUBLE_FLOAT

$kw5$API_QUIT

public static final SubLSymbol $kw5$API_QUIT

$sym6$API_QUIT

public static final SubLSymbol $sym6$API_QUIT

$str7$Explicitly_quit_this_api_connecti

public static final SubLString $str7$Explicitly_quit_this_api_connecti

$sym8$DEFAULT_API_INPUT_PROTOCOL

public static final SubLSymbol $sym8$DEFAULT_API_INPUT_PROTOCOL

$sym9$DEFAULT_VALIDATE_API_REQUEST

public static final SubLSymbol $sym9$DEFAULT_VALIDATE_API_REQUEST

$sym10$DEFAULT_API_OUTPUT_PROTOCOL

public static final SubLSymbol $sym10$DEFAULT_API_OUTPUT_PROTOCOL

$sym11$CLET

public static final SubLSymbol $sym11$CLET

$list12

public static final SubLList $list12

$str13$

public static final SubLString $str13$

$sym14$CATCH_ERROR_MESSAGE_HANDLER

public static final SubLSymbol $sym14$CATCH_ERROR_MESSAGE_HANDLER

$sym15$TASK_PROCESSOR_REQUEST

public static final SubLSymbol $sym15$TASK_PROCESSOR_REQUEST

$list16

public static final SubLList $list16

$sym17$_API_INPUT_EOF_MARKER_

public static final SubLSymbol $sym17$_API_INPUT_EOF_MARKER_

$str18$API_Input_EOF_Marker

public static final SubLString $str18$API_Input_EOF_Marker

$str19$Invalid_API_Request___S_is_not_a_

public static final SubLString $str19$Invalid_API_Request___S_is_not_a_

$str20$Invalid_API_Request___S_is_not_a_

public static final SubLString $str20$Invalid_API_Request___S_is_not_a_

$sym21$INVALID_CONSTANT_

public static final SubLSymbol $sym21$INVALID_CONSTANT_

$str22$___A_is_not_an_existing_constant

public static final SubLString $str22$___A_is_not_an_existing_constant

$str23$API_request_references_an_invalid

public static final SubLString $str23$API_request_references_an_invalid

$sym24$GUID_P

public static final SubLSymbol $sym24$GUID_P

$sym25$GUID_TO_STRING

public static final SubLSymbol $sym25$GUID_TO_STRING

$int26$200

public static final SubLInteger $int26$200

$int27$500

public static final SubLInteger $int27$500

$str28$_D__S

public static final SubLString $str28$_D__S

$sym29$FUNCTION_SPEC_P

public static final SubLSymbol $sym29$FUNCTION_SPEC_P

$sym30$CONSP

public static final SubLSymbol $sym30$CONSP

$sym31$STRINGP

public static final SubLSymbol $sym31$STRINGP

$sym32$INTEGERP

public static final SubLSymbol $sym32$INTEGERP

$kw33$PRIVATE

public static final SubLSymbol $kw33$PRIVATE

$str34$_api_quit__

public static final SubLString $str34$_api_quit__

$str35$_A

public static final SubLString $str35$_A

$sym36$CYC_API_REMOTE_EVAL

public static final SubLSymbol $sym36$CYC_API_REMOTE_EVAL

$list37

public static final SubLList $list37

$str38$Evaluate_API_REQUEST_on_MACHINE_u

public static final SubLString $str38$Evaluate_API_REQUEST_on_MACHINE_u

$list39

public static final SubLList $list39

$sym40$STREAMP

public static final SubLSymbol $sym40$STREAMP

$kw41$EOF

public static final SubLSymbol $kw41$EOF

$str42$_S_

public static final SubLString $str42$_S_

Method Detail

api_server_handler

public static final SubLObject api_server_handler(SubLObject in_stream,
                                                  SubLObject out_stream)

api_server_top_level

public static final SubLObject api_server_top_level(SubLObject in_stream,
                                                    SubLObject out_stream)

api_quit

public static final SubLObject api_quit()

Explicitly quit this api connection.

api_server_loop

public static final SubLObject api_server_loop(SubLObject in_stream,
                                               SubLObject out_stream)

api_server_one_complete_request

public static final SubLObject api_server_one_complete_request(SubLObject in_stream,
                                                               SubLObject out_stream)

read_api_request

public static final SubLObject read_api_request(SubLObject in_stream)

validate_api_request

public static final SubLObject validate_api_request(SubLObject api_request)

valid_api_function_symbol

public static final SubLObject valid_api_function_symbol(SubLObject symbol)

record_api_request

public static final SubLObject record_api_request(SubLObject api_request)

record_api_result

public static final SubLObject record_api_result(SubLObject result,
                                                 SubLObject errorP)

perform_api_request

public static final SubLObject perform_api_request(SubLObject api_request)

send_api_result

public static final SubLObject send_api_result(SubLObject out_stream,
                                               SubLObject api_result,
                                               SubLObject errorP)

Send API-RESULT to OUT-STREAM respecting ERROR?.

default_api_output_protocol

public static final SubLObject default_api_output_protocol(SubLObject out_stream,
                                                           SubLObject api_result,
                                                           SubLObject errorP)

update_api_protocol

public static final SubLObject update_api_protocol()

api_input_protocol

public static final SubLObject api_input_protocol()

set_api_input_protocol

public static final SubLObject set_api_input_protocol(SubLObject input_protocol)

set_api_output_protocol

public static final SubLObject set_api_output_protocol(SubLObject output_protocol)

api_port

public static final SubLObject api_port()

Returns the local api-port according to defined system parameters.

declare_api_kernel_file

public static final SubLObject declare_api_kernel_file()

init_api_kernel_file

public static final SubLObject init_api_kernel_file()

setup_api_kernel_file

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