Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package pacomb
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
A module providing efficient input buffers with preprocessing.
Type
Information for a file for reopening
val phantom_infos : infosdummy infos
val stream_infos : infos -> stream_infosreturns the stream_infos stored in infos
val filename : infos -> stringreturns the filename if it exists, the empty string otherwise
val utf8 : infos -> Utf8.contextutf8 infos return the unicode context in use for this file
val init_idx : idxposition at the beginning of a buffer
val int_of_byte_pos : byte_pos -> intconvert byte_pos to natural number
val init_byte_pos : byte_poszero
val phantom_byte_pos : byte_posdummy value, to initiaize references for instance
val phantom_spos : sposdummy value, to initiaize references for instance
Reading from a buffer
read buf idx returns the character at position idx in the buffer buf, together with the new buffer and position. Read infinitely many '\255' at end of buffer
sub b i len returns len characters from position idx. If the end of buffer is reached, the string is filed with eof '\255'
Creating a buffer
type context = Utf8.contextfrom_file fn returns a buffer constructed using the file fn.
If utf8 is Utf8.UTF8 or Utf8.CJK_UTF8 (Utf8.ASCII is the default), positions are reported according to utf8. read is still reading bytes.
Getting line number and column number requires rescanning the file and if the file is not a regular file, it is kept in memory. Setting rescan to false avoid this, but only byte position and file name will be available.
val from_channel : ?utf8:context -> ?filename:string -> in_channel -> bufferfrom_channel ~filename ch returns a buffer constructed using the channel ch. The optional filename is only used as a reference to the channel in error messages.
uft8 and rescan as in from_file.
val from_fd : ?utf8:context -> ?filename:string -> Unix.file_descr -> bufferSame as above for file descriptor
from_string ~filename str returns a buffer constructed using the string str. The optional filename is only used as a reference to the channel in error messages.
Buffer manipulation functions
val is_empty : buffer -> int -> boolis_empty buf test whether the buffer buf is empty.
get spos from buffer and idx, to get line_num and col_num if needed later.
val buffer_uid : buffer -> intbuffer_uid buf returns a unique identifier. Input.read does not change the uid. The uid is created when creating the initial buffer.
buffer_before b1 i1 b2 i2 returns true if the position b1, i1 is before b2, i2. Gives meaningless result if b1 and b2 do not refer to the same file, i.e. do not have the same uid.
module Tbl : sig ... endTable to associate value to positions in input buffers. The complexity of access in the table is O(ln(N)) where N is the number of tables.