Added automatic formatting and GitHub workflows

Author: mmottl

.clang-format

@@ -0,0 +1 @@
+BasedOnStyle: LLVM

.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig: https://EditorConfig.org
+
+# Top-most EditorConfig file
+root = true
+
+# Default settings for all files
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+max_line_length = 80
+
+# Makefile
+[Makefile]
+# Makefiles require tabs instead of spaces
+indent_style = tab

.github/workflows/main.yml

@@ -0,0 +1,35 @@
+name: Main workflow
+
+on:
+  - pull_request
+  - push
+  - workflow_dispatch
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            ocaml-compiler: 5.2.0
+          - os: macos-latest
+            ocaml-compiler: 5.2.0
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Use OCaml ${{ matrix.ocaml-compiler }}
+        uses: ocaml/setup-ocaml@v2
+        with:
+          ocaml-compiler: ${{ matrix.ocaml-compiler }}
+
+      - run: opam install -t --deps-only .
+
+      - run: opam exec -- make
+
+      - run: opam exec -- make -C test
+# vim: filetype=yaml

.ocamlformat

@@ -0,0 +1,6 @@
+version = 0.26.2
+profile = conventional
+
+# Default overrides
+wrap-comments = true
+parse-docstrings = true

dune

@@ -1,6 +1,9 @@
 (env
-  (dev
-    (flags (:standard -w -9 -principal))
-    (c_flags (:standard -Wall -pedantic -Wextra -Wunused)))
-  (release (ocamlopt_flags (:standard -O3)))
-)
+ (dev
+  (flags
+   (:standard -w -9 -principal))
+  (c_flags
+   (:standard -Wall -pedantic -Wextra -Wunused)))
+ (release
+  (ocamlopt_flags
+   (:standard -O3))))

examples/async.ml

@@ -5,82 +5,81 @@ let failwith_f fmt = ksprintf failwith fmt
 
 let _ =
   if Array.length Sys.argv <> 2 then (
-    Printf.printf "\
-      Usage:  async conninfo\n\
-      Connect to PostgreSQL with [conninfo] (e.g. \"host=localhost\"),\n\
-      and run async tests on a temporary table\n";
+    Printf.printf
+      "Usage:  async conninfo\n\
+       Connect to PostgreSQL with [conninfo] (e.g. \"host=localhost\"),\n\
+       and run async tests on a temporary table\n";
     exit 1)
 
 let wait_for_result c =
   c#consume_input;
   while c#is_busy do
-    ignore (Unix.select [Obj.magic c#socket] [] [] (-.1.0));
+    ignore (Unix.select [ Obj.magic c#socket ] [] [] (-1.0));
     c#consume_input
   done
 
-let fetch_result c = wait_for_result c; c#get_result
+let fetch_result c =
+  wait_for_result c;
+  c#get_result
 
 let fetch_single_result c =
   match fetch_result c with
   | None -> assert false
-  | Some r -> assert (fetch_result c = None); r
+  | Some r ->
+      assert (fetch_result c = None);
+      r
 
 (* See http://www.postgresql.org/docs/devel/static/libpq-connect.html *)
 let rec finish_conn socket_fd connect_poll = function
-  | Polling_failed ->
-    printf "f\n%!"
+  | Polling_failed -> printf "f\n%!"
   | Polling_reading ->
-    printf "r,%!";
-    ignore (Unix.select [socket_fd] [] [] (-1.0));
-    finish_conn socket_fd connect_poll (connect_poll ())
+      printf "r,%!";
+      ignore (Unix.select [ socket_fd ] [] [] (-1.0));
+      finish_conn socket_fd connect_poll (connect_poll ())
   | Polling_writing ->
-    printf "w,%!";
-    ignore (Unix.select [] [socket_fd] [] (-1.0));
-    finish_conn socket_fd connect_poll (connect_poll ())
-  | Polling_ok ->
-    printf "c\n%!"
+      printf "w,%!";
+      ignore (Unix.select [] [ socket_fd ] [] (-1.0));
+      finish_conn socket_fd connect_poll (connect_poll ())
+  | Polling_ok -> printf "c\n%!"
 
 let test (c : connection) =
   (* Create a table using a non-prepared statement. *)
-  c#send_query "\
-    CREATE TEMPORARY TABLE postgresql_ocaml_async \
-      (id SERIAL PRIMARY KEY, a INTEGER NOT NULL, b TEXT NOT NULL)";
+  c#send_query
+    "CREATE TEMPORARY TABLE postgresql_ocaml_async (id SERIAL PRIMARY KEY, a \
+     INTEGER NOT NULL, b TEXT NOT NULL)";
   assert ((fetch_single_result c)#status = Command_ok);
 
   (* Create another table which will trigger a notice. *)
-  c#send_query "\
-    CREATE TEMPORARY TABLE postgresql_ocaml_async_2 \
-      (id INTEGER PRIMARY KEY \
-        REFERENCES postgresql_ocaml_async ON DELETE CASCADE)";
+  c#send_query
+    "CREATE TEMPORARY TABLE postgresql_ocaml_async_2 (id INTEGER PRIMARY KEY \
+     REFERENCES postgresql_ocaml_async ON DELETE CASCADE)";
   assert ((fetch_single_result c)#status = Command_ok);
 
-  begin
-    c#send_query
-      ~param_types:Postgresql.[|oid_of_ftype INT8; oid_of_ftype INT8|]
-      ~params:[|"4100100100"; "5100100100"|]
-      "SELECT $1 + $2";
-    let r = fetch_single_result c in
-    assert (r#status = Tuples_ok);
-    assert (r#nfields = 1);
-    assert (r#ntuples = 1);
-    assert (r#getvalue 0 0 = "9200200200");
-  end;
+  (c#send_query
+     ~param_types:Postgresql.[| oid_of_ftype INT8; oid_of_ftype INT8 |]
+     ~params:[| "4100100100"; "5100100100" |]
+     "SELECT $1 + $2";
+   let r = fetch_single_result c in
+   assert (r#status = Tuples_ok);
+   assert (r#nfields = 1);
+   assert (r#ntuples = 1);
+   assert (r#getvalue 0 0 = "9200200200"));
 
   (* Populate using a prepared statement. *)
   let shown_ntuples = 10 in
   let expected_ntuples = 3 * 100 in
   for i = 0 to 2 do
     let stmt = sprintf "test_ins_%d" i in
     let param_types =
-      Array.sub Postgresql.[|oid_of_ftype INT4; oid_of_ftype TEXT|] 0 i
+      Array.sub Postgresql.[| oid_of_ftype INT4; oid_of_ftype TEXT |] 0 i
     in
     c#send_prepare stmt ~param_types
       "INSERT INTO postgresql_ocaml_async (a, b) VALUES ($1, $2)";
     assert ((fetch_single_result c)#status = Command_ok);
     for j = 1 to 100 do
-      let c0 = string_of_int (i + 3 * j) in
-      let c1 = sprintf "The number %d." (i + 3 * j) in
-      c#send_query_prepared ~params:[|c0; c1|] stmt;
+      let c0 = string_of_int (i + (3 * j)) in
+      let c1 = sprintf "The number %d." (i + (3 * j)) in
+      c#send_query_prepared ~params:[| c0; c1 |] stmt;
       assert ((fetch_single_result c)#status = Command_ok)
     done
   done;
@@ -116,11 +115,11 @@ let test (c : connection) =
     match fetch_result c with
     | None -> assert false
     | Some r when i < expected_ntuples ->
-      assert (r#status = Single_tuple);
-      if i < shown_ntuples then
-        printf "%s, %s, %s\n" (r#getvalue 0 0) (r#getvalue 0 1) (r#getvalue 0 2)
-    | Some r ->
-      assert (r#status = Tuples_ok)
+        assert (r#status = Single_tuple);
+        if i < shown_ntuples then
+          printf "%s, %s, %s\n" (r#getvalue 0 0) (r#getvalue 0 1)
+            (r#getvalue 0 2)
+    | Some r -> assert (r#status = Tuples_ok)
   done;
   printf "[...]\n";
   assert (fetch_result c = None);

examples/binary.ml

@@ -1,103 +1,87 @@
-(* Create a table, insert a binary string various ways, and read it various ways *)
+(* Create a table, insert a binary string various ways, and read it various
+   ways *)
 
 open! Postgresql
 
 let _ =
   if Array.length Sys.argv <> 3 then (
-    Printf.printf "\
-      Usage:  dump conninfo table\n\
-      Connect to PostgreSQL with [conninfo] (e.g. \"host=localhost\"),\n\
-      and create, write to, read from, and then DELETE [table]\n";
+    Printf.printf
+      "Usage:  dump conninfo table\n\
+       Connect to PostgreSQL with [conninfo] (e.g. \"host=localhost\"),\n\
+       and create, write to, read from, and then DELETE [table]\n";
     exit 1)
 
 let table = Sys.argv.(2)
+
 let c =
   try new connection ~conninfo:Sys.argv.(1) () with
   | Error e ->
-    prerr_endline (string_of_error e);
-    exit 34
+      prerr_endline (string_of_error e);
+      exit 34
   | e ->
-    prerr_endline (Printexc.to_string e);
-    exit 35
-
+      prerr_endline (Printexc.to_string e);
+      exit 35
 
 let create_table () : unit =
-  c#exec ~expect:[Command_ok]
-    ("create table " ^ table ^ " (data bytea)")
+  c#exec ~expect:[ Command_ok ] ("create table " ^ table ^ " (data bytea)")
   |> ignore
 
 let write_escaped data : unit =
-  c#exec ~expect:[Command_ok]
-    ("insert into " ^ table
-     ^ " (data)"
-     ^ " VALUES ('"
-     ^ c#escape_bytea data
-     ^ "')")
+  c#exec ~expect:[ Command_ok ]
+    ("insert into " ^ table ^ " (data)" ^ " VALUES ('" ^ c#escape_bytea data
+   ^ "')")
   |> ignore
 
 let write_binary data : unit =
-  c#exec ~expect:[Command_ok]
-    ~params:[|data|] ~binary_params:[|true|]
-    ("insert into " ^ table
-     ^ " (data)"
-     ^ " VALUES ($1)")
+  c#exec ~expect:[ Command_ok ] ~params:[| data |] ~binary_params:[| true |]
+    ("insert into " ^ table ^ " (data)" ^ " VALUES ($1)")
   |> ignore
 
 let read_escaped () : string list =
-  let result =
-    c#exec ~expect:[Tuples_ok]
-      ("select data from " ^ table)
-  in
-  result#get_all_lst
-  |> List.map List.hd
-  |> List.map unescape_bytea
+  let result = c#exec ~expect:[ Tuples_ok ] ("select data from " ^ table) in
+  result#get_all_lst |> List.map List.hd |> List.map unescape_bytea
 
 let read_binary () : string list =
   let result =
-    c#exec ~expect:[Tuples_ok] ~binary_result:true
+    c#exec ~expect:[ Tuples_ok ] ~binary_result:true
       ("select data from " ^ table)
   in
-  result#get_all_lst
-  |> List.map List.hd
+  result#get_all_lst |> List.map List.hd
 
 let delete_table () : unit =
-  c#exec ~expect:[Command_ok]
-    ("drop table if exists " ^ table ^ " cascade")
+  c#exec ~expect:[ Command_ok ] ("drop table if exists " ^ table ^ " cascade")
   |> ignore
 
-let string_list_to_string  l =
-  "["
-  ^ (String.concat ", " l)
-  ^ "]"
+let string_list_to_string l = "[" ^ String.concat ", " l ^ "]"
 
 let main () =
   delete_table ();
   create_table ();
   (* first 'line' of a compiled binary, pasted in *)
-  let data = "ELF>0L@–„$@8	@%$@@@¯¯888†¿†¿ p√p√0p√0ÿ‚! (ƒ(ƒ0(ƒ000TTTDDPÂtd`‘`‘`‘Ã[Ã[QÂtdRÂtdp√p√0p√0êê∑Åù[»·≥¢l∆'„¶•0ë5!@ÇÄ%$ √ bFÄ@ê Ú0êÄàê‡ÄÉê– " in
+  let data =
+    "ELF>0L@–„$@8\t@%$@@@¯¯888†¿†¿ p√p√0p√0ÿ‚! \
+     (ƒ(ƒ0(ƒ000TTTDDPÂtd`‘`‘`‘Ã[Ã[QÂtdRÂtdp√p√0p√0êê∑Åù[»·≥¢l∆'„¶•0ë5!@ÇÄ%$ \
+     √ bFÄ@ê Ú0êÄàê‡ÄÉê– "
+  in
   write_escaped data;
   write_binary data;
   let read_esc = read_escaped () in
   let read_bin = read_binary () in
-  let expected = [data; data] in
+  let expected = [ data; data ] in
   (* print_endline ("expected: " ^ string_list_to_string expected); *)
   (* print_endline ("read_escaped: " ^ string_list_to_string read_esc); *)
   (* print_endline ("read_binary: " ^ string_list_to_string read_bin); *)
-  if read_esc <> expected
-  then prerr_endline "read_escaped <> expected";
-  if read_bin <> expected
-  then prerr_endline "read_binary <> expected";
-  if read_esc <> read_bin
-  then prerr_endline "read_escaped <> read_binary";
+  if read_esc <> expected then prerr_endline "read_escaped <> expected";
+  if read_bin <> expected then prerr_endline "read_binary <> expected";
+  if read_esc <> read_bin then prerr_endline "read_escaped <> read_binary";
   delete_table ();
   ()
 
-
 let _ =
   try main () with
   | Error e ->
-    prerr_endline (string_of_error e);
-    exit 23
+      prerr_endline (string_of_error e);
+      exit 23
   | e ->
-    prerr_endline (Printexc.to_string e);
-    exit 24
+      prerr_endline (Printexc.to_string e);
+      exit 24