The Iso Byte Char module

Author(s): The CLIP Group, Daniel Cabeza, Documentation written by Edison Mera, based on ISO Prolog standard. Minor mods by M. Hermenegildo..

Version: 1.11#222 (2004/5/24, 13:8:7 CEST)

Version of last change: 1.9#217 (2003/12/21, 15:33:54 CET)

This module provides some basic predicates according to the ISO specification of byte and char manipulation.

• Usage and interface (iso_byte_char)
• Documentation on exports (iso_byte_char)

Usage and interface (iso_byte_char)

Documentation on exports (iso_byte_char)

PREDICATE: char_code/2:

char_code(Char, Code)

Succeeds iff the character code of the one char atom Char is Code.

Usage 1: * ISO *

• Calls should, and exit will be compatible with: Code is an integer which is a character code. (basic_props:character_code/1)
• The following properties should hold at call time: Char is an atom. (basic_props:atm/1)
• The following properties hold upon exit: Code is an integer which is a character code. (basic_props:character_code/1)

Usage 2: * ISO *

• Calls should, and exit will be compatible with: Code is an integer which is a character code. (basic_props:character_code/1)
• The following properties should hold at call time: Char is a free variable. (term_typing:var/1)
• The following properties hold upon exit: Char is an atom. (basic_props:atm/1) Code is an integer which is a character code. (basic_props:character_code/1)

PREDICATE: atom_chars/2:

atom_chars(Atom, Chars)

Succeeds iff Chars is a list whose elements are the one-char atoms whose names are the successive characters of the name of atom Atom

Usage 1: * ISO *

• Calls should, and exit will be compatible with: Chars is a list of character_codes. (basic_props:list/2)
• The following properties should hold at call time: Atom is an atom. (basic_props:atm/1)
• The following properties hold upon exit: Chars is a list of character_codes. (basic_props:list/2)

Usage 2: * ISO *

• The following properties should hold at call time: Atom is a free variable. (term_typing:var/1) Chars is a list of character_codes. (basic_props:list/2)
• The following properties hold upon exit: Atom is an atom. (basic_props:atm/1)

PREDICATE: number_chars/2:

number_chars(Number, Chars)

Success iff Chars is a list whose elements are the one-char atoms corresponding to a character sequence of Number which could be output

Usage 1: * ISO *

• Calls should, and exit will be compatible with: Chars is a list of atms. (basic_props:list/2)
• The following properties should hold at call time: Number is a number. (basic_props:num/1)
• The following properties hold upon exit: Chars is a list of atms. (basic_props:list/2)

Usage 2: * ISO *

• The following properties should hold at call time: Number is a free variable. (term_typing:var/1) Chars is a list of atms. (basic_props:list/2)
• The following properties hold upon exit: Number is a number. (basic_props:num/1)

PREDICATE: get_byte/1:

Usage: * ISO *

• Description: Same as get_byte/2, but use the current input.
• Calls should, and exit will be compatible with: Arg1 is an integer. (basic_props:int/1)
• The following properties hold upon exit: Arg1 is an integer. (basic_props:int/1)

PREDICATE: get_byte/2:

get_byte(Stream, Byte)

Is true iff Byte unifies with the next byte to be input from the target Stream.

Usage: * ISO *

• Calls should, and exit will be compatible with: Byte is an integer. (basic_props:int/1)
• The following properties should hold at call time: Stream is an open stream. (streams_basic:stream/1)
• The following properties hold upon exit: Stream is an open stream. (streams_basic:stream/1) Byte is an integer. (basic_props:int/1)
• The following properties hold globally: Stream is not further instantiated. (basic_props:not_further_inst/2)

PREDICATE: peek_byte/1:

Usage: * ISO *

• Description: Same as peek_byte/2, but use the current input.
• Calls should, and exit will be compatible with: Arg1 is an integer. (basic_props:int/1)
• The following properties hold upon exit: Arg1 is an integer. (basic_props:int/1)

PREDICATE: peek_byte/2:

peek_byte(Stream, Byte)

Is true iff Byte unifies with the next byte to be input from the target Stream.

Usage: * ISO *

• Calls should, and exit will be compatible with: Byte is an integer. (basic_props:int/1)
• The following properties should hold at call time: Stream is an open stream. (streams_basic:stream/1)
• The following properties hold upon exit: Stream is an open stream. (streams_basic:stream/1) Byte is an integer. (basic_props:int/1)
• The following properties hold globally: Stream is not further instantiated. (basic_props:not_further_inst/2)

PREDICATE: put_byte/1:

Usage: * ISO *

• Description: Same as put_byte/2, but use the current input.
• The following properties should hold at call time: Arg1 is an integer. (basic_props:int/1)

PREDICATE: put_byte/2:

put_byte(Stream, Byte)

Is true. Procedurally, putbyte/2 is executed as follows:

a) Outputs the byte Byte to the target stream.

b) Changes the stream position of the target stream to take account of the byte which has been output.

c) The goal succeeds.

Usage: * ISO *

• The following properties should hold at call time: Stream is an open stream. (streams_basic:stream/1) Byte is an integer. (basic_props:int/1)
• The following properties hold upon exit: Stream is an open stream. (streams_basic:stream/1)
• The following properties hold globally: Stream is not further instantiated. (basic_props:not_further_inst/2)

PREDICATE: get_char/1:

Usage: * ISO *

• Description: Same as get_char/2, but use the current input.
• Calls should, and exit will be compatible with: Arg1 is an atom. (basic_props:atm/1)
• The following properties hold upon exit: Arg1 is an atom. (basic_props:atm/1)

PREDICATE: get_char/2:

get_char(Stream, Char)

Is true iif Char unifies with the next character to be input from the target Stream.

Usage: * ISO *

• Calls should, and exit will be compatible with: Char is an atom. (basic_props:atm/1)
• The following properties should hold at call time: Stream is an open stream. (streams_basic:stream/1)
• The following properties hold upon exit: Stream is an open stream. (streams_basic:stream/1) Char is an atom. (basic_props:atm/1)
• The following properties hold globally: Stream is not further instantiated. (basic_props:not_further_inst/2)

PREDICATE: peek_char/1:

Usage: * ISO *

• Description: Similar to peek_code/1, but using char instead of code.
• Calls should, and exit will be compatible with: Arg1 is an atom. (basic_props:atm/1)
• The following properties hold upon exit: Arg1 is an atom. (basic_props:atm/1)

PREDICATE: peek_char/2:

Usage: * ISO *

• Description: Similar to peek_code/2, but using char instead of code.
• Calls should, and exit will be compatible with: Arg2 is an atom. (basic_props:atm/1)
• The following properties should hold at call time: Arg1 is an open stream. (streams_basic:stream/1)
• The following properties hold upon exit: Arg1 is an open stream. (streams_basic:stream/1) Arg2 is an atom. (basic_props:atm/1)
• The following properties hold globally: Arg1 is not further instantiated. (basic_props:not_further_inst/2)

PREDICATE: put_char/1:

Usage: * ISO *

• Description: Similar to put_code/1, but using char instead of code.
• The following properties should hold at call time: Arg1 is an atom. (basic_props:atm/1)

PREDICATE: put_char/2:

Usage: * ISO *

• Description: Similar to put_code/2, but using char instead of code.
• The following properties should hold at call time: Arg1 is an open stream. (streams_basic:stream/1) Arg2 is an atom. (basic_props:atm/1)
• The following properties hold upon exit: Arg1 is an open stream. (streams_basic:stream/1)
• The following properties hold globally: Arg1 is not further instantiated. (basic_props:not_further_inst/2)

Go to the first, previous, next, last section, table of contents.