View source with raw comments or as raw
   1/*  Part of SWI-Prolog
   2
   3    Author:        Jan Wielemaker
   4    E-mail:        J.Wielemaker@vu.nl
   5    WWW:           http://www.swi-prolog.org
   6    Copyright (c)  2001-2014, University of Amsterdam
   7    All rights reserved.
   8
   9    Redistribution and use in source and binary forms, with or without
  10    modification, are permitted provided that the following conditions
  11    are met:
  12
  13    1. Redistributions of source code must retain the above copyright
  14       notice, this list of conditions and the following disclaimer.
  15
  16    2. Redistributions in binary form must reproduce the above copyright
  17       notice, this list of conditions and the following disclaimer in
  18       the documentation and/or other materials provided with the
  19       distribution.
  20
  21    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  29    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32    POSSIBILITY OF SUCH DAMAGE.
  33*/
  34
  35:- module(memory_file,
  36          [ new_memory_file/1,          % -Handle
  37            free_memory_file/1,         % +Handle
  38            size_memory_file/2,         % +Handle, -Size
  39            size_memory_file/3,         % +Handle, -Size, +Encoding
  40            open_memory_file/3,         % +Handle, +Mode, -Stream
  41            open_memory_file/4,         % +Handle, +Mode, -Stream, +Options
  42            insert_memory_file/3,       % +Handle, +Position, +Data
  43            delete_memory_file/3,       % +Handle, +Position, +Length
  44            atom_to_memory_file/2,      % +Atom, -Handle
  45            memory_file_to_atom/2,      % +Handle, -Atom
  46            memory_file_to_codes/2,     % +Handle, -CodeList
  47            memory_file_to_string/2,    % +Handle, -String
  48            memory_file_to_atom/3,      % +Handle, -Atom, +Encoding
  49            memory_file_to_codes/3,     % +Handle, -CodeList, +Encoding
  50            memory_file_to_string/3,    % +Handle, -String, +Encoding
  51            memory_file_substring/5,    % +Handle, +Before, +Length, +After, -String
  52            memory_file_line_position/4,% +Handle, ?Line, ?ListPos, ?Offset
  53            utf8_position_memory_file/3 % +Handle, -Here, -Size
  54          ]).
  55:- use_foreign_library(foreign(memfile)).
  56
  57:- predicate_options(open_memory_file/4, 4,
  58                     [ encoding(encoding),
  59                       free_on_close(boolean)
  60                     ]).