[ Reference Manual | Alphabetic Index ]

# Obsolete

Obsolete built-ins which should not be used in new code

## Predicates

> abolish_op(+Name, +Associativity)
>   Remove the declaration of the visible operator +Name of associativity Associativity.
> abolish_record(++Key)
>   Remove the local record Key and all its recorded values.
> autoload(+Library, ++ListOfPredSpecList)
>   Declares the predicates in ListOfPredSpec to be autoloading from the module Library, which is in the file Library.pl in one of the library directories.
> autoload_tool(+Library, ++ListOfPredSpecList)
>   Declares the predicates in ListOfPredSpec to be autoloading tools from the module (file) Library.pl.
> b_external(++PredSpec)
>   Declares PredSpec to be a non-deterministic external predicate.
> b_external(++PredSpec, +CName)
>   Defines PredSpec to be a nondeterministic external predicate linked to the C function whose system name is CName.
> begin_module(+Module)
>   Start the definition of the body of the Module.
> block(?Goal, ?Catcher, ?Recovery)
>   Equivalent to call(Goal) if Goal succeeds or fails. If Goal throws an exception that unifies with Catcher, Recovery is executed
> call(+Goal, +Module)
>   Succeeds if Goal (which is visible in module Module) succeeds.
> call_explicit(+Goal, +Module)
>   Succeeds if Goal which is defined in module Module succeeds.
> cancel_after_event(+Event)
>   Cancel all pending instances of after event Event.
> char_int(?Char, ?Integer)
>   Succeeds if Integer is the ASCII code of the one-character string Char.
> coroutine
>   Switches on the coroutine flag, equivalent to set_flag(coroutine, on).
> current_after_event(?Event)
>   Check or find currently pending after events (inside handler).
> current_stream(-Name, -Mode, ?Stream)
>   Succeeds if there is currently an open stream Stream open to the file Name in the mode Mode. This predicate is obsolete, use current_stream/1 and get_stream_info/3 instead.
> current_struct(?Struct)
>   Succeeds if Struct is a currently visible structure specification.
> dbgcomp
>   Tells the compiler to generate code with debug instructions. Equivalent to the call to set_flag(debug_compile, on).
> define_error(+Message, -N)
>   Error number N is newly defined to give the message Message.
> define_macro(++TermClass, ++TransPred, ++Options)
>   Defines a macro transformation for the functor or type specified by TermClass. The transformation predicate is TransPred and Options is a list of options.
> delay(?Variables, +Goal)
>   Delay the Goal on all variables in the term Variables.
> erase_macro(+TransTerm)
>   Erases the macro definition for TransTerm done in the current module
> errno_id(+N, -Message)
>   Message is bound to the message string that corresponds to the UNIX message for a system call error when the UNIX errno has the value N.
> event_create(+Goal, -EventHandle)
>   Create an ECLiPSe event from an arbitrary goal.
> event_retrieve(+EventHandle, -Goal)
>   Given the handle with which an event is associated, retrieve the event goal.
> exit_block(+Ball)
>   Throw an exception described by Ball. Continue execution at the recovery procedure of a matching ancestor catch/3 or block/3
> fail_if(+Goal)
>   Succeeds if Goal cannot be satisfied. Uses negation as failure (synonym of not/1 and \+/1).
> flatten_array(+Array, -List)
>   Returns a flat list of the elements of a multi-dimensional array.
> get_error_handler(+Number, -PredSpec, -Module)
>   Returns the error_handler for error number Number and its home module Module.
> get_prompt(+InStream, -Prompt, -OutStream)
>   Succeeds if the prompt for the stream InStream is Prompt and is written to the stream OutStream.
> get_timer(+Timer, -Interval)
>   Succeed if the specified Timer is running and sends signals in intervals of Interval seconds.
> global ++SpecList
>   Declares the procedure(s) and other modular items specified by SpecList to be global.
> global_op(+Precedence, +Associativity, ++Name)
>   Defines the global operator(s) in Name to have precedence Precedence and associativity Associativity. If Precedence is 0 then the operator definition is removed.
> is_built_in(++PredSpec)
>   Succeeds if PredSpec is a system built-in predicate.
> is_locked(+Module)
>   Succeeds if the module Module is locked.
> lib(++LibraryName, +ModuleName)
>   The library LibraryName is loaded into the module ModuleName if not loaded already.
> local_record(++Key)
>   Declare the record with key Key to be local to the context module
> lock(+Module)
>   Locks the access to the module Module.
> lock(+Module, +Password)
>   Locks the access to the module Module, but allow unlocking with the password Password
> make_array(++Array)
>   Creates the untyped array or global variable Array.
> make_array(++Array, +Type)
>   Creates the global array or global variable Array of type Type.
> make_local_array(++Array)
>   Creates an array or global variable Array visible only in the context module.
> make_local_array(++Array, +Type)
>   Creates an array or global variable Array of type Type visible only in the context module.
> module_interface(+Module)
>   Create the module Module and start defining its interface.
> mutex(+MutexId, +Goal)
>   Equivalent to once(Goal) but with mutual exclusion among parallel workers.
> mutex_init(+MutexId)
>   Initialise the mutual exclusion lock MutexId
> name(?Atomnumber, ?List)
>   Succeeds if List is the corresponding list of ASCII codes for the atom or number Atomnumber.
> nodbgcomp
>   Tells the compiler to generate code without debug instructions and not to retain the source variable names.
> number_merge(+Key, +Order, +List1, +List2, -List3)
>   Succeeds if List3 is a merged list of List1 and List2. If both lists are sorted, List3 will be sorted. The sort is done according to the Key and Order specifications.
> number_sort(+Key, +Order, +Random, -Sorted)
>   Succeeds if Sorted is the numerically sorted list version of Random. The sort is done according to the Key and Order specifications.
> pathname(+FilePath, -Path)
>   Succeeds if the pathname FilePath, if stripped of its file name, gives Path, the path up to the parent directory of the file.
> pipe(?StreamIn, ?StreamOut)
>   Creates a pipe and two streams StreamIn and StreamOut to its read and write ends
> portray_goal(+Term, -TransTerm)
>   Apply the goal portray (write macro) transformation to Term
> readvar(+Stream, -Term, -VarList)
>   Succeeds if the next Prolog term from the input stream Stream is successfully read and unified with Term, and any variables in Term are collected in the list VarList, together with their names.
> local reference(+Name)
>   Creates a named reference called Name.
> reset_error_handler(+Number)
>   Resets the handler for error number Number to its default value.
> retract_all(+Head)
>   Removes from the database all clauses whose heads match Head
> schedule_woken(++SuspList)
>   Pass the suspension list SuspList to the waking scheduler.
> select(++StreamList, +Timeout, -ReadyStreams)
>   Obsolete synonym for stream_select/3
> set_error_handler(+Number, ++PredSpec)
>   Set an error handler PredSpec for the error with number Number.
> set_prompt(+InStream, +Prompt, +OutStream)
>   The prompt Prompt is output on the stream OutStream for input to the input stream InStream.
> set_suspension_priority(+Susp, +Priority)
>   Change the priority of the suspended goal Susp to Priority.
> set_timer(+Timer, +Interval)
>   Start (or stop) the specified Timer to send signals in intervals of Interval seconds.
> suffix(+FileName, -Suffix)
>   Succeeds if the string Suffix is the extension part of the input string FileName.
> suspension_to_goal(+Susp, -Goal, -Module)
>   Succeeds for an unwoken suspension and returns the corresponding Goal structure and context module.
> tool(++PredSpec)
>   Declares PredSpec as a tool interface procedure.

Generated from obsolete.eci on 2022-09-03 14:26