!bestlib.doc

supplementary source file 1 for The BESTLibrary

scan_str_not......X.search for any other string of characters
scan_strs.........X.search for one of several strings of characters
scan_strs_not.....X.search for any other string of characters
scan_word...........search for a one-word (two-byte) value
scan_word_not.......search for any other one-word (two-byte) value
scan_words..........search for one of several one-word (two-byte) values
scan_words_not......search for any other one-word (two-byte) value
sign................return the sign of a number
str_add...........X.adds to a number stored as an ASCII string
str_case_down.......convert all characters in a string to lowercase
str_case_down_pr....convert all characters in "prdata.string" to lowercase
str_case_flip.......convert all characters in a string to the opposite case
str_case_flip_pr....convert all characters in "prdata.string" to opposite case
str_case_up.........convert all characters in a string to uppercase
str_case_up_pr......convert all characters in "prdata.string" to uppercase
str_cmp.............compares two strings for equality
str_copy............copies a string
str_dec.............decrements a number stored as an ASCII string
str_del_byte........delete all occurrences of a byte from a string
str_del_bytes.......delete bytes from a string
str_del_str.......X.delete all occurences of a string from a string
str_del_word........delete all occurrences of a word from a word-value array
str_del_words.......delete word from an array of word-values
str_div...........X.divides a number stored as an ASCII string
str_fill_byte.......fill memory with a one-byte value
str_fill_str........fill memory with a string of characters
str_fill_word.......fill memory with a one-word (two-byte) value
str_inc.............increments a number stored as an ASCII string
str_ins_byte........insert a one-byte value into a string
str_ins_str.........insert a string of characters into a string
str_ins_word........insert a one-word (two-byte) value into an array of words
str_len.............return the length of a string
str_len_pr..........return the length of "prdata.string"
str_mul...........X.multiplies a number stored as an ASCII string
str_next_str........return the next string from a string
str_next_word.......return the next word from a string
str_rep_byte_byte...search for a byte and replaces it with a different byte
str_rep_byte_word...search for a byte and replaces it with a word
str_rep_byte_str....search for a byte and replaces it with a string
str_rep_str_byte....search for a string and replaces it with a byte
str_rep_str_str.....search for a string and replaces it with another string
str_rep_word_byte...search for a word and replaces it with a byte
str_rep_word_word...search for a word and replaces it with a different word
str_right...........read one string character, counting from the right
str_right_pr........read one "prdata.string" character, counting from the right
str_sub...........X.subtracts from a number stored as an ASCII string

- - - - - - - - - - - - - - - - -  CHARACTER - - - - - - - - - - - - - - - - - -
is_alpha............check if a character is an alphabet letter
is_alpha_down.......check if a character is a lowercase alphabet letter
is_alpha_up.........check if a character is an uppercase alphabet letter
is_alphanum.........check if a character is an alphanumeric character
is_ascii............check if a character is a standard ASCII character
is_case_down........check if a character is a lowercase letter
is_case_up..........check if a character is an uppercase letter
is_ctrlchar.........check if a character is a control character (0-31 or 127)
is_digit_dec........check if a character is a decimal digit
is_digit_hex........check if a character is a hexadecimal digit
is_letter...........check if a character is an alphabet letter, ', or -
is_letternum........check if a character is an alphanumeric letter, ', or -
is_greek............check if a character is a greek letter
is_print............check if a character is a printable character (ASCII symbol)
is_punc.............check if a character is a punctuation character

- - - - - - - - - - - - - - - - - CONVERSION - - - - - - - - - - - - - - - - - -
con_bool_to_str.....convert a numerical boolean value into its string equivalent
con_color_to_str....convert a numerical color value into its string equivalent
con_str_to_bool.....convert a boolean word into its numerical equivalent
con_str_to_color....convert a color name into its numerical equivalent

  ----------------------------------------------------------------------------
-----------------------------------  TEXT  -------------------------------------

txt_ascii_get..,,.X.read in ASCII character patterns
txt_ascii_set.......redefine ASCII character patterns to allow for new characters
txt_blink...........set 16 background colors or blinking characters
txt_char_height.....return the height of text mode characters (in pixels)
txt_char_length.....return the length of text mode characters (in pixels)
txt_cls.............clear the screen
txt_erase...........overwrite a region of characters with spaces
txt_erase_col.......overwrite one column of characters with spaces
txt_erase_row.......overwrite one row of characters with spaces
txt_fill_area.......fill a screen region according to the structure "fidata"
txt_fill_col........fill a screen column with a string in a defined color
txt_fill_row........fill a screen row with a string in a defined color
txt_flood...........flood the screen with a character in a fg/bg color
txt_get_abs.........return the absolute address of the text page
txt_get_act.........return the active text page
txt_get_vis.........return the visual text page
txt_last............return the last text page
txt_mem.............store or restore the text screen
txt_print...........print to the text screen according to the structure "prdata"
txt_rows............return the [number of rows per page]-1
txt_scroll..........smoothly scrolls, in any direction, the entire screen
txt_scroll_fast.....quickly smoothly scrolls (may be some flicker) the screen
txt_scroll_off....X.smoothly scrolls the screen off in a direction
txt_scroll_on.....X.smoothly scrolls a screen on in a direction
txt_scroll_over.....smoothly scrolls a screen overtop another screen
txt_scroll_rows.....smoothly scrolls certain rows
txt_scroll_window.X.smoothly scrolls, in any direction, a window of the screen
txt_set_abs.........set the absolute offset of the text page
txt_set_act.........set the active text page
txt_set_rel.........set the relative offset of the text page
txt_set_vis.........set the visual text page
txt_split...........split the visual screen into two mirror images

- - - - - - - - - - - - - - - - -  ANIMATION - - - - - - - - - - - - - - - - - -
NONE YET :(

- - - - - - - - - - - - - - - - -  ATTRIBUTE - - - - - - - - - - - - - - - - - -
txt_attr_save.......save one attribute
txt_attr_show.......print a specific number of one attribute
txt_attrs_fill......fill a screen region with a foreground and background color
txt_attrs_need......return memory requirement for a "txt_attrs_save"ed image
txt_attrs_save......read a region of attributes
txt_attrs_show......print a region of attributes
txt_attrs_show_char...X.print only one attribute from a region of attributes
txt_attrs_show_str....X.print only one string of attributes from a region
txt_attrs_show_region.X.print only one region from a region of attributes
txt_bg_get..........save the background color at specified coordinates
txt_fg_get..........save the foreground color at specified coordinates

- - - - - - - - - - - - - - - - -  CHARACTER - - - - - - - - - - - - - - - - - -
txt_chr_attr_save...save a character and its attribute
txt_chr_attr_show...print a specific number of one character in a defined color
txt_chr_erase.......overwrite a specific number of characters with spaces
txt_chr_get.........read one character
txt_chr_show........print a specific number of one character
txt_chrattr_save....read a character with its attribute
txt_chrattr_show....print a specific number of characters with attributes
txt_chrattrs_fill...fill a screen region with a fg/bg color and a character
txt_chrattrs_need...return memory requirement for "txt_chrattrs_save"ed image
txt_chrattrs_save...read a region of characters with their attributes
txt_chrattrs_show...print a region of characters with their attributes
txt_chrattrs_show_char.....print only one character from a region
txt_chrattrs_show_str......print only a string of characters from a region
txt_chrattrs_show_region.X.print only a region from a region
txt_chrs_erase......overwrite a "textimagedata"ed image with spaces
txt_chrs_fill.......fill a screen with with a character
txt_chrs_need.......return the memory requirement for a "txt_chrs_save"ed image
txt_chrs_save.......read a region of characters
txt_chrs_show.......print a region of characters
txt_chrs_show_char...X.print only one character from a region of characters
txt_chrs_show_str....X.print only one string of characters from a region
txt_chrs_show_region.X.print only one region from a region of characters

- - - - - - - - - - - - - - - - - - CURSOR - - - - - - - - - - - - - - - - - - -
cur_get_coord.......store the cursor location
cur_get_coord_abs...store the cursor location as reported by the VGA card
cur_get.............store all cursor information
cur_get_abs.........store all cursor information as reported by the VGA card
cur_get_x...........return the cursor abscissa
cur_get_x_abs.......return the cursor abscissa as reported by the VGA card
cur_get_y...........return the cursor ordinate
cur_get_y_abs.......return the cursor ordinate as reported by the VGA card
cur_is_on...........check if the cursor is on
cur_off.............turns cursor off
cur_on..............turns cursor on
cur_set.............set all the cursor's statistics
cur_set_bios........set all the cursor's statistics via BIOS
cur_set_coord.......set the cursor's abscissa and ordinate
cur_set_coord_bios..set the cursor's abscissa and ordinate via BIOS
cur_get_shape.......store the cursor's shape on the active page
cur_get_shape_abs...store the cursor's shape as reported by the VGA card
cur_set_shape.......define a new cursor shape on the active page
cur_set_shape_bios..define a new cursor shape on the active page via BIOS
cur_set_x...........set the cursor's abscissa
cur_set_x_bios......set the cursor's abscissa via BIOS
cur_set_y...........set the cursor'r ordinate
cur_set_y_bios......set the cursor's ordinate via BIOS

- - - - - - - - - - - - - - - - - - - GET  - - - - - - - - - - - - - - - - - - -
txt_get_let.........prompts the user for input -- accepts only alphabet letters
txt_get_num.........prompts the user for input -- accepts only digits and signs
txt_get_numu........prompts the user for unsigned input -- accepts only digits
txt_get_numl......X.prompts user for long input -- accepts only digits and signs
txt_get_numlu.....X.prompts user for unsigned long input -- accepts only digits
txt_get_str.........prompts the user for input -- accepts all ASCII characters

- - - - - - - - - - - - - - - - - - STRING - - - - - - - - - - - - - - - - - - -
txt_str_attr_show...print a string with attributes
txt_str_erase.......overwrite a string with spaces
txt_str_erase_pr....overwrite "prdata.string" with spaces
txt_str_save........read a string from the text screen
txt_str_show........print a string
txt_strattr_need....return memory requirement for a "txt_strattr_save"ed image
txt_strattr_save....read a string with its attributes from the text screen
txt_strattr_show....print a "txt_strattr_save"ed string with its attributes

- - - - - - - - - - - - - - - - - - WINDOW - - - - - - - - - - - - - - - - - - -
win_define..........define a new window
win_move............move a window to absolute coordinates
win_move_rel........move a window relative to its current position
win_scroll..........scrolls a window

  ----------------------------------------------------------------------------
------------------------------------  VGA  -------------------------------------

fade_in.............fade into a screen
fade_out............fade a screen out to black
isit_color..........check if current display adapter is color capable
isit_ega............check if current display adapter is EGA capable
isit_vga............check if current display adapter is VGA capable
isit_svga.........X.check if current display adapter is SuperVGA capable

  ----------------------------------------------------------------------------
-----------------------------------  VGA16  ------------------------------------

_16_boxfill.........draw a solid box
_16_boxfillxy.....X.draw a solid box
_16_boxoutline......draw a box outline
_16_boxoutlinexy..X.draw a box outline
_16_floodall........flood the screen all one color
_16_floodallall.....flood a 640x816 region of video memory all one color
_16_linebiglen....X.draw a line using a specific block size
_16_linebigxy.......draw a line using a specific block size
_16_linelen.........draw a line
_16_linexy..........draw a line
_16_pixel...........change the color of a pixel
_16_pixel_avg.......return the average color of nine pixels surrounding a point
_16_pixel_color.....read the color of a pixel
_16_pixel_is........check if a specific pixel is a specific color
_16_popupcolumn.....same as "popupmenu" except only one column is used
_16_popupmenu.......creates a menu system in graphics mode
_16_scrollevel......read the number of rows currently scrolled
_16_scrollrow.......scrolls a specific number of rows
_16_thermal.........generate a thermal equilibrium style spread

- - - - - - - - - - - - - - - - -  ANIMATION - - - - - - - - - - - - - - - - - -
_16_animat_rect...B.animate any solid rectangular "_16_i_save"ed image
_16_i_move........B.move any "_16_i_save"ed image
_16_move..........X.move using true 32-bit data transfers
_16_p_move........B.move any "_16_p_save"ed image

- - - - - - - - - - - - - - - - - -  IMAGE - - - - - - - - - - - - - - - - - - -
_16_copy............copy any "_16_c_save"ed/"_16_i_save"ed/"_16_p_save"ed image

- - - - - - - - - - - - - - - - COMPRESS IMAGE - - - - - - - - - - - - - - - - -
_16_c_move........B.move any "_16_c_save"ed image
_16_c_need_scrn.....memory need for any screen image that is to be "_16_c_save"ed
_16_c_need_wrst.....worst-case compression for a theoretical "_16_c_save"ed image
_16_c_percent.......calculate how much percent smaller a "_16_c_save"ed image is
_16_c_read_off....X.read a pixel color of any "_16_c_save"ed image by offset
_16_c_read_xy.....X.read a pixel color of any "_16_c_save"ed image by (x,y)
_16_c_save..........store an image into memory from the screen using compression
_16_c_show..........write any "_16_c_save"ed image to the screen
_16_i_to_c........X.convert any "_16_i_save"ed image to a "_16_c_save"ed image
_16_p_to_c........X.convert any "_16_p_save"ed image to a "_16_c_save"ed image

- - - - - - - - - - - - - - - - - PIXEL IMAGE  - - - - - - - - - - - - - - - - -
_16_c_to_p........X.convert any "_16_c_save"ed image to a "_16_p_save"ed image
_16_i_to_p........X.convert any "_16_i_save"ed image to a "_16_p_save"ed image
_16_p_need..........calculate the memory requirement of any "_16_p_save"ed image
_16_p_save..........store an image from the screen on a pixel by pixel algorithm
_16_p_read_off......read a pixel color of any "_16_p_save"ed image by offset