(* Copyright (c) 2008, Adam Chlipala
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 * - The names of contributors may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *)

signature LIST_UTIL = sig

    val mapConcat : ('a -> 'b list) -> 'a list -> 'b list

    val mapfold : ('data, 'state, 'abort) Search.mapfolder
                  -> ('data list, 'state, 'abort) Search.mapfolder
    val mapfoldB : ('context * 'data -> 'context * ('state -> ('data * 'state, 'abort) Search.result))
                   -> ('context, 'data list, 'state, 'abort) Search.mapfolderB

    val foldlMap : ('data1 * 'state -> 'data2 * 'state) -> 'state -> 'data1 list -> 'data2 list * 'state
    val foldlMapPartial : ('data1 * 'state -> 'data2 option * 'state) -> 'state -> 'data1 list -> 'data2 list * 'state
    val foldlMapiPartial : (int * 'data1 * 'state -> 'data2 option * 'state)
                           -> 'state -> 'data1 list -> 'data2 list * 'state
    val foldlMapConcat : ('data1 * 'state -> 'data2 list * 'state) -> 'state -> 'data1 list -> 'data2 list * 'state
    val foldlMapAbort : ('data1 * 'state -> ('data2 * 'state) option)
                        -> 'state -> 'data1 list -> ('data2 list * 'state) option

    val search : ('a -> 'b option) -> 'a list -> 'b option
    val searchi : (int * 'a -> 'b option) -> 'a list -> 'b option

    val mapi : (int * 'a -> 'b) -> 'a list -> 'b list
    val mapiPartial : (int * 'a -> 'b option) -> 'a list -> 'b list
    val foldli : (int * 'a * 'b -> 'b) -> 'b -> 'a list -> 'b
    val foldri : (int * 'a * 'b -> 'b) -> 'b -> 'a list -> 'b

    val foldliMap : (int * 'data1 * 'state -> 'data2 * 'state) -> 'state -> 'data1 list -> 'data2 list * 'state

    val appi : (int * 'a -> unit) -> 'a list -> unit

    val appn : (int -> unit) -> int -> unit

end