X-Git-Url: http://git.annexia.org/?a=blobdiff_plain;f=csv.mli;h=14901e48120b68715cb95f83b9bb65a21fa85a75;hb=3a2b495714080c9f72b89cada8bc45b22768a059;hp=a8e570db10ff07a43b7c00267a73c04f86f0d25f;hpb=f6dbacda332fa9a11a36b3424516409d387058a1;p=ocaml-csv.git

diff --git a/csv.mli b/csv.mli
index a8e570d..14901e4 100644
--- a/csv.mli
+++ b/csv.mli
@@ -1,6 +1,6 @@
 (** csv.mli - comma separated values parser
   *
-  * $Id: csv.mli,v 1.6 2005-11-25 14:06:58 rich Exp $
+  * $Id: csv.mli,v 1.10 2006-11-24 15:49:24 rich Exp $
   *)
 
 type t = string list list
@@ -26,6 +26,7 @@ val load_in : ?separator:char -> in_channel -> t
 val load : ?separator:char -> string -> t
 (** Load a CSV file.
   * @param filename CSV filename.
+  * If [filename] is ["-"] then load from [stdin].
   *)
 
 val load_rows : ?separator:char -> (string list -> unit) -> in_channel -> unit
@@ -69,7 +70,7 @@ val square : t -> t
 (** Make the CSV data "square" (actually rectangular).  This pads out
   * each row with empty cells so that all rows are the same length as
   * the longest row.  After this operation, every row will have length
-  * {!columns}.
+  * {!Csv.columns}.
   *)
 
 val is_square : t -> bool
@@ -105,6 +106,22 @@ val sub : int -> int -> int -> int -> t -> t
   * The returned CSV will be square.
   *)
 
+val compare : t -> t -> int
+(** Compare two CSV files for equality, ignoring blank cells at the end
+  * of a row, and empty rows appended to one or the other.  This is
+  * "semantic" equality - roughly speaking, the two CSV files would
+  * look the same if opened in a spreadsheet program.
+  *)
+
+val concat : t list -> t
+(** Concatenate CSV files so that they appear side by side, arranged
+  * left to right across the page.  Each CSV file (except the final
+  * one) is first squared.
+  *
+  * (To concatenate CSV files so that they appear from top to bottom,
+  * just use {!List.concat}).
+  *)
+
 val to_array : t -> string array array
 val of_array : string array array -> t
 (** Convenience functions to convert to and from a matrix representation.
@@ -133,7 +150,7 @@ val associate : string list -> t -> (string * string) list list
   *     etc. ]
   * v}
   *
-  * Each row is turned into an assoc list (see {!List.assoc}).
+  * Each row is turned into an assoc list (see [List.assoc]).
   *
   * If a row is too short, it is padded with empty cells ([""]).  If
   * a row is too long, it is truncated.
@@ -161,9 +178,10 @@ val save : ?separator:char -> string -> t -> unit
 val print_readable : t -> unit
 (** Print the CSV data to [stdout] in a human-readable format.  Not much
   * is guaranteed about how the CSV is printed, except that it will be
-  * easier to follow than a "raw" output done with {!print}.  This is
+  * easier to follow than a "raw" output done with {!Csv.print}.  This is
   * a one-way operation.  There is no easy way to parse the output of
   * this command back into CSV data.
   *)
 val save_out_readable : out_channel -> t -> unit
-(** As for {!print_readable}, allowing the output to be sent to a channel. *)
+(** As for {!Csv.print_readable}, allowing the output to be sent to a channel.
+  *)