Vamp Plugin Tester

install:

  - cinst --allow-empty-checksums smlnj

  - ps: '"[hostfingerprints]" | Out-File -Encoding "ASCII" -Append $env:USERPROFILE\mercurial.ini'

  - ps: '"code.soundsoftware.ac.uk = 66:ef:e2:0e:e3:55:93:9a:33:aa:2a:e9:fe:be:21:c2:a2:8d:4f:f1" | Out-File -Encoding "ASCII" -Append $env:USERPROFILE\mercurial.ini'

  - ps: '"[hostsecurity]" | Out-File -Encoding "ASCII" -Append $env:USERPROFILE\mercurial.ini'

  - ps: '"code.soundsoftware.ac.uk = code.soundsoftware.ac.uk:fingerprints=sha256:64:75:f6:47:15:de:b4:51:ea:96:e2:f4:8a:f5:53:a5:11:c8:dd:82:73:5d:bd:54:18:cb:c8:9d:10:37:28:85" | Out-File -Encoding "ASCII" -Append $env:USERPROFILE\mercurial.ini'

before_build:

  - set PATH=%PATH%;C:\Program Files (x86)\SMLNJ\bin

  - vext install

glob:.vext-*.bin

vamp-plugin-tester:	vamp-plugin-sdk/README $(OBJECTS) $(VAMP_OBJECTS)

vamp-plugin-sdk/README:

	./vext install

#!/bin/bash

# Disable shellcheck warnings for useless-use-of-cat. UUOC is good

# practice, not bad: clearer, safer, less error-prone.

# shellcheck disable=SC2002

sml="$VEXT_SML"

set -eu

mydir=$(dirname "$0")

program="$mydir/vext.sml"

hasher=

local_install=

if [ -w "$mydir" ]; then

    if echo | sha256sum >/dev/null 2>&1 ; then

	hasher=sha256sum

        local_install=true

    elif echo | shasum >/dev/null 2>&1 ; then

	hasher=shasum

	local_install=true

    else

        echo "WARNING: sha256sum or shasum program not found" 1>&2

    fi

fi

if [ -n "$local_install" ]; then

    hash=$(echo "$sml" | cat "$program" - | $hasher | cut -c1-16)

    gen_sml=$mydir/.vext-$hash.sml

    gen_out=$mydir/.vext-$hash.bin

    trap 'rm -f $gen_sml' 0

else

    gen_sml=$(mktemp /tmp/vext-XXXXXXXX.sml)

    gen_out=$(mktemp /tmp/vext-XXXXXXXX.bin)

    trap 'rm -f $gen_sml $gen_out' 0

fi

if [ -x "$gen_out" ]; then

    exec "$gen_out" "$@"

fi

# We need one of Poly/ML, SML/NJ, or MLton. Since we're running a

# single-file SML program as if it were a script, our order of

# preference is based on startup speed, except in the local_install

# case where we retain a persistent binary.

if [ -z "$sml" ]; then

    if [ -n "$local_install" ] && mlton 2>&1 | grep -q 'MLton'; then

	sml="mlton"

    elif sml -h 2>&1 | grep -q 'Standard ML of New Jersey'; then

	sml="smlnj"

    # We would prefer Poly/ML to SML/NJ, except that Poly v5.7 has a

    # nasty bug that occasionally causes it to deadlock on startup.

    # That appears to be fixed in their repo, so we could promote it

    # up the order again at some point in future

    elif echo | poly -v 2>/dev/null | grep -q 'Poly/ML'; then

	sml="poly"

    elif mlton 2>&1 | grep -q 'MLton'; then

	sml="mlton"

    else cat 1>&2 <<EOF

ERROR: No supported SML compiler or interpreter found       

EOF

	cat 1>&2 <<EOF

  The Vext external source code manager needs a Standard ML (SML)

  compiler or interpreter to run.

  Please ensure you have one of the following SML implementations

  installed and present in your PATH, and try again.

    1. Standard ML of New Jersey

       - often found in a distribution package called: smlnj

       - executable name: sml

    2. Poly/ML

       - often found in a distribution package called: polyml

       - executable name: poly

    3. MLton

       - often found in a distribution package called: mlton

       - executable name: mlton

EOF

	exit 2

    fi

fi

arglist=""

for arg in "$@"; do

    if [ -n "$arglist" ]; then arglist="$arglist,"; fi

    if echo "$arg" | grep -q '["'"'"']' ; then

	arglist="$arglist\"usage\""

    else

	arglist="$arglist\"$arg\""

    fi

done

case "$sml" in

    poly)

        if [ -n "$local_install" ] && polyc --help >/dev/null 2>&1 ; then

            if [ ! -x "$gen_out" ]; then

                polyc -o "$gen_out" "$program"

            fi

	    "$gen_out" "$@"

        else

            echo 'use "'"$program"'"; vext ['"$arglist"'];' |

                poly -q --error-exit

        fi ;;

    mlton)

        if [ ! -x "$gen_out" ]; then

	    echo "[Precompiling Vext binary...]" 1>&2

	    echo "val _ = main ()" | cat "$program" - > "$gen_sml"

	    mlton -output "$gen_out" "$gen_sml"

        fi

	"$gen_out" "$@" ;;

    smlnj)

	cat "$program" | (

	    cat <<EOF

val smlrun__cp = 

    let val x = !Control.Print.out in

        Control.Print.out := { say = fn _ => (), flush = fn () => () };

        x

    end;

val smlrun__prev = ref "";

Control.Print.out := { 

    say = fn s => 

        (if String.isSubstring " Error" s

         then (Control.Print.out := smlrun__cp;

               (#say smlrun__cp) (!smlrun__prev);

               (#say smlrun__cp) s)

         else (smlrun__prev := s; ())),

    flush = fn s => ()

};

EOF

	    cat -

	    cat <<EOF

val _ = vext [$arglist];

val _ = OS.Process.exit (OS.Process.success);

EOF

            ) > "$gen_sml"

	CM_VERBOSE=false sml "$gen_sml" ;;

    *)

	echo "ERROR: Unknown SML implementation name: $sml" 1>&2;

	exit 2 ;;

esac

{

  "libraries": {

    "vamp-plugin-sdk": {

      "pin": "d129bf797f24"

    }

  }

}

{

    "config": {

        "extdir": "."

    },

    "services": {

	"soundsoftware": {

	    "vcs": ["hg", "git"],

	    "anonymous": "https://code.soundsoftware.ac.uk/{vcs}/{repository}",

	    "authenticated": "https://{account}@code.soundsoftware.ac.uk/{vcs}/{repository}"

	}

    },

    "libraries": {

        "vamp-plugin-sdk": {

            "vcs": "hg",

            "service": "soundsoftware"

        }

    }

}

@echo off

PowerShell -NoProfile -ExecutionPolicy Bypass -Command "& '%~dpn0.ps1' %*";

<#

.SYNOPSIS

A simple manager for third-party source code dependencies.

Run "vext help" for more documentation.

#>

Set-StrictMode -Version 2.0

$ErrorActionPreference = "Stop"

$sml = $env:VEXT_SML

$mydir = Split-Path $MyInvocation.MyCommand.Path -Parent

$program = "$mydir/vext.sml"

# We need either Poly/ML or SML/NJ. No great preference as to which.

if (!$sml) {

    if (Get-Command "sml" -ErrorAction SilentlyContinue) {

       $sml = "smlnj"

    } elseif (Get-Command "polyml" -ErrorAction SilentlyContinue) {

       $sml = "poly"

    } else {

       echo @"

ERROR: No supported SML compiler or interpreter found       

  The Vext external source code manager needs a Standard ML (SML)

  compiler or interpreter to run.

  Please ensure you have one of the following SML implementations

  installed and present in your PATH, and try again.

    1. Standard ML of New Jersey

       - executable name: sml

    2. Poly/ML

       - executable name: polyml

"@

       exit 1

    }

}

if ($args -match "'""") {

    $arglist = '["usage"]'

} else {

    $arglist = '["' + ($args -join '","') + '"]'

}

if ($sml -eq "poly") {

    $program = $program -replace "\\","\\\\"

    echo "use ""$program""; vext $arglist" | polyml -q --error-exit | Out-Host

    if (-not $?) {

        exit $LastExitCode

    }

} elseif ($sml -eq "smlnj") {

    $lines = @(Get-Content $program)

    $lines = $lines -notmatch "val _ = main ()"

    $intro = @"

val smlrun__cp = 

    let val x = !Control.Print.out in

        Control.Print.out := { say = fn _ => (), flush = fn () => () };

        x

    end;

val smlrun__prev = ref "";

Control.Print.out := { 

    say = fn s => 

        (if String.isSubstring "Error" s orelse String.isSubstring "Fail" s

         then (Control.Print.out := smlrun__cp;

               (#say smlrun__cp) (!smlrun__prev);

               (#say smlrun__cp) s)

         else (smlrun__prev := s; ())),

    flush = fn s => ()

};

"@ -split "[\r\n]+"

    $outro = @"

val _ = vext $arglist;

val _ = OS.Process.exit (OS.Process.success);

"@ -split "[\r\n]+"

    $script = @()

    $script += $intro

    $script += $lines

    $script += $outro

    $tmpfile = ([System.IO.Path]::GetTempFileName()) -replace "[.]tmp",".sml"

    $script | Out-File -Encoding "ASCII" $tmpfile

    $env:CM_VERBOSE="false"

    sml $tmpfile

    if (-not $?) {

        del $tmpfile

        exit $LastExitCode

    }

    del $tmpfile

} else {

    "Unknown SML implementation name: $sml"

    exit 2

}

(*

    DO NOT EDIT THIS FILE.

    This file is automatically generated from the individual

    source files in the Vext repository.

*)

(* 

    Vext

    A simple manager for third-party source code dependencies

    Copyright 2018 Chris Cannam, Particular Programs Ltd,

    and Queen Mary, University of London

    Permission is hereby granted, free of charge, to any person

    obtaining a copy of this software and associated documentation

    files (the "Software"), to deal in the Software without

    restriction, including without limitation the rights to use, copy,

    modify, merge, publish, distribute, sublicense, and/or sell copies

    of the Software, and to permit persons to whom the Software is

    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be

    included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR

    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF

    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION

    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Except as contained in this notice, the names of Chris Cannam,

    Particular Programs Ltd, and Queen Mary, University of London

    shall not be used in advertising or otherwise to promote the sale,

    use or other dealings in this Software without prior written

    authorization.

*)

val vext_version = "0.9.95"

datatype vcs =

         HG |

         GIT |

         SVN

datatype source =

         URL_SOURCE of string |

         SERVICE_SOURCE of {

             service : string,

             owner : string option,

             repo : string option

         }

type id_or_tag = string

datatype pin =

         UNPINNED |

         PINNED of id_or_tag

datatype libstate =

         ABSENT |

         CORRECT |

         SUPERSEDED |

         WRONG

datatype localstate =

         MODIFIED |

         LOCK_MISMATCHED |

         CLEAN

datatype branch =

         BRANCH of string |

         DEFAULT_BRANCH

(* If we can recover from an error, for example by reporting failure

   for this one thing and going on to the next thing, then the error

   should usually be returned through a result type rather than an

   exception. *)

datatype 'a result =

         OK of 'a |

         ERROR of string

type libname = string

type libspec = {

    libname : libname,

    vcs : vcs,

    source : source,

    branch : branch,

    project_pin : pin,

    lock_pin : pin

}

type lock = {

    libname : libname,

    id_or_tag : id_or_tag

}

type remote_spec = {

    anon : string option,

    auth : string option

}

type provider = {

    service : string,

    supports : vcs list,

    remote_spec : remote_spec

}

type account = {

    service : string,

    login : string

}

type context = {

    rootpath : string,

    extdir : string,

    providers : provider list,

    accounts : account list

}

type userconfig = {

    providers : provider list,

    accounts : account list

}

type project = {

    context : context,

    libs : libspec list

}

structure VextFilenames = struct

    val project_file = "vext-project.json"

    val project_lock_file = "vext-lock.json"

    val user_config_file = ".vext.json"

    val archive_dir = ".vext-archive"

end

signature VCS_CONTROL = sig

    (** Test whether the library is present locally at all *)

    val exists : context -> libname -> bool result

    (** Return the id (hash) of the current revision for the library *)

    val id_of : context -> libname -> id_or_tag result

    (** Test whether the library is at the given id *)

    val is_at : context -> libname * id_or_tag -> bool result

    (** Test whether the library is on the given branch, i.e. is at

        the branch tip or an ancestor of it *)

    val is_on_branch : context -> libname * branch -> bool result

    (** Test whether the library is at the newest revision for the

        given branch. False may indicate that the branch has advanced

        or that the library is not on the branch at all. This function

        may use the network to check for new revisions *)

    val is_newest : context -> libname * source * branch -> bool result

    (** Test whether the library is at the newest revision available

        locally for the given branch. False may indicate that the

        branch has advanced or that the library is not on the branch

        at all. This function must not use the network *)

    val is_newest_locally : context -> libname * branch -> bool result

    (** Test whether the library has been modified in the local

        working copy *)

    val is_modified_locally : context -> libname -> bool result

    (** Check out, i.e. clone a fresh copy of, the repo for the given

        library on the given branch *)

    val checkout : context -> libname * source * branch -> unit result

    (** Update the library to the given branch tip. Assumes that a

        local copy of the library already exists *)

    val update : context -> libname * source * branch -> unit result

    (** Update the library to the given specific id or tag *)

    val update_to : context -> libname * source * id_or_tag -> unit result

    (** Return a URL from which the library can be cloned, given that

        the local copy already exists. For a DVCS this can be the

        local copy, but for a centralised VCS it will have to be the

        remote repository URL. Used for archiving *)

    val copy_url_for : context -> libname -> string result

end

signature LIB_CONTROL = sig

    val review : context -> libspec -> (libstate * localstate) result

    val status : context -> libspec -> (libstate * localstate) result

    val update : context -> libspec -> unit result

    val id_of : context -> libspec -> id_or_tag result

end

structure FileBits :> sig

    val extpath : context -> string

    val libpath : context -> libname -> string

    val subpath : context -> libname -> string -> string

    val command_output : context -> libname -> string list -> string result

    val command : context -> libname -> string list -> unit result

    val file_url : string -> string

    val file_contents : string -> string

    val mydir : unit -> string

    val homedir : unit -> string

    val mkpath : string -> unit result

    val rmpath : string -> unit result

    val nonempty_dir_exists : string -> bool

    val project_spec_path : string -> string

    val project_lock_path : string -> string

    val verbose : unit -> bool

end = struct

    fun verbose () =

        case OS.Process.getEnv "VEXT_VERBOSE" of

            SOME "0" => false

          | SOME _ => true

          | NONE => false

    fun split_relative path desc =

        case OS.Path.fromString path of

            { isAbs = true, ... } => raise Fail (desc ^ " may not be absolute")

          | { arcs, ... } => arcs

    fun extpath ({ rootpath, extdir, ... } : context) =

        let val { isAbs, vol, arcs } = OS.Path.fromString rootpath

        in OS.Path.toString {

                isAbs = isAbs,

                vol = vol,

                arcs = arcs @

                       split_relative extdir "extdir"

            }

        end

    fun subpath ({ rootpath, extdir, ... } : context) libname remainder =

        (* NB libname is allowed to be a path fragment, e.g. foo/bar *)

        let val { isAbs, vol, arcs } = OS.Path.fromString rootpath

        in OS.Path.toString {

                isAbs = isAbs,

                vol = vol,

                arcs = arcs @

                       split_relative extdir "extdir" @

                       split_relative libname "library path" @

                       split_relative remainder "subpath"

            }

        end

    fun libpath context "" =

        extpath context

      | libpath context libname =

        subpath context libname ""

    fun project_file_path rootpath filename =

        let val { isAbs, vol, arcs } = OS.Path.fromString rootpath

        in OS.Path.toString {

                isAbs = isAbs,

                vol = vol,

                arcs = arcs @ [ filename ]

            }

        end

    fun project_spec_path rootpath =

        project_file_path rootpath (VextFilenames.project_file)

    fun project_lock_path rootpath =

        project_file_path rootpath (VextFilenames.project_lock_file)

    fun trim str =

        hd (String.fields (fn x => x = #"\n" orelse x = #"\r") str)

    fun file_url path =

        let val forward_path = 

                String.translate (fn #"\\" => "/" |

                                  c => Char.toString c)

                                 (OS.Path.mkCanonical path)

        in

            (* Path is expected to be absolute already, but if it

               starts with a drive letter, we'll need an extra slash *)

            case explode forward_path of

                #"/"::rest => "file:///" ^ implode rest

              | _ => "file:///" ^ forward_path

        end

    fun file_contents filename =

        let val stream = TextIO.openIn filename

            fun read_all str acc =

                case TextIO.inputLine str of

                    SOME line => read_all str (trim line :: acc)

                  | NONE => rev acc

            val contents = read_all stream []

            val _ = TextIO.closeIn stream

        in

            String.concatWith "\n" contents

        end

    fun expand_commandline cmdlist =

        (* We are quite [too] strict about what we accept here, except

           for the first element in cmdlist which is assumed to be a

           known command location rather than arbitrary user input. NB

           only ASCII accepted at this point. *)

        let open Char

            fun quote arg =

                if List.all

                       (fn c => isAlphaNum c orelse c = #"-" orelse c = #"_")

                       (explode arg)

                then arg

                else "\"" ^ arg ^ "\""

            fun check arg =

                let val valid = explode " /#:;?,._-{}@=+"

                in

                    app (fn c =>

                            if isAlphaNum c orelse

                               List.exists (fn v => v = c) valid orelse

                               c > chr 127

                            then ()

                            else raise Fail ("Invalid character '" ^

                                             (Char.toString c) ^

                                             "' in command list"))

                        (explode arg);

                    arg

                end

        in

            String.concatWith " "

                              (map quote

                                   (hd cmdlist :: map check (tl cmdlist)))

        end

    val tick_cycle = ref 0

    val tick_chars = Vector.fromList (map String.str (explode "|/-\\"))

    fun tick libname cmdlist =

        let val n = Vector.length tick_chars

            fun pad_to n str =

                if n <= String.size str then str

                else pad_to n (str ^ " ")

            val name = if libname <> "" then libname

                       else if cmdlist = nil then ""

                       else hd (rev cmdlist)

        in

            print ("  " ^

                   Vector.sub(tick_chars, !tick_cycle) ^ " " ^

                   pad_to 70 name ^

                   "\r");

            tick_cycle := (if !tick_cycle = n - 1 then 0 else 1 + !tick_cycle)

        end

    fun run_command context libname cmdlist redirect =

        let open OS

            val dir = libpath context libname

            val cmd = expand_commandline cmdlist

            val _ = if verbose ()

                    then print ("\n=== " ^ dir ^ "\n<<< " ^ cmd ^ "\n")

                    else tick libname cmdlist

            val _ = FileSys.chDir dir

            val status = case redirect of

                             NONE => Process.system cmd

                           | SOME file => Process.system (cmd ^ ">" ^ file)

        in

            if Process.isSuccess status

            then OK ()

            else ERROR ("Command failed: " ^ cmd ^ " (in dir " ^ dir ^ ")")

        end

        handle ex => ERROR ("Unable to run command: " ^ exnMessage ex)

    fun command context libname cmdlist =

        run_command context libname cmdlist NONE

    fun command_output context libname cmdlist =

        let open OS

            val tmpFile = FileSys.tmpName ()

            val result = run_command context libname cmdlist (SOME tmpFile)

            val contents = file_contents tmpFile

            val _ = if verbose ()

                    then print (">>> \"" ^ contents ^ "\"\n")

                    else ()

        in

            FileSys.remove tmpFile handle _ => ();

            case result of

                OK () => OK contents

              | ERROR e => ERROR e

        end

    fun mydir () =

        let open OS

            val { dir, file } = Path.splitDirFile (CommandLine.name ())

        in

            FileSys.realPath

                (if Path.isAbsolute dir

                 then dir

                 else Path.concat (FileSys.getDir (), dir))

        end

    fun homedir () =

        (* Failure is not routine, so we use an exception here *)

        case (OS.Process.getEnv "HOME",

              OS.Process.getEnv "HOMEPATH") of

            (SOME home, _) => home

          | (NONE, SOME home) => home

          | (NONE, NONE) =>

            raise Fail "Failed to look up home directory from environment"

    fun mkpath' path =

        if OS.FileSys.isDir path handle _ => false

        then OK ()

        else case OS.Path.fromString path of

                 { arcs = nil, ... } => OK ()

               | { isAbs = false, ... } => ERROR "mkpath requires absolute path"

               | { isAbs, vol, arcs } => 

                 case mkpath' (OS.Path.toString {      (* parent *)

                                    isAbs = isAbs,

                                    vol = vol,

                                    arcs = rev (tl (rev arcs)) }) of

                     ERROR e => ERROR e

                   | OK () => ((OS.FileSys.mkDir path; OK ())

                               handle OS.SysErr (e, _) =>

                                      ERROR ("Directory creation failed: " ^ e))

    fun mkpath path =

        mkpath' (OS.Path.mkCanonical path)

    fun dir_contents dir =

        let open OS

            fun files_from dirstream =

                case FileSys.readDir dirstream of

                    NONE => []

                  | SOME file =>

                    (* readDir is supposed to filter these, 

                       but let's be extra cautious: *)

                    if file = Path.parentArc orelse file = Path.currentArc

                    then files_from dirstream

                    else file :: files_from dirstream

            val stream = FileSys.openDir dir

            val files = map (fn f => Path.joinDirFile

                                         { dir = dir, file = f })

                            (files_from stream)

            val _ = FileSys.closeDir stream

        in

            files

        end

    fun rmpath' path =

        let open OS

            fun remove path =

                if FileSys.isLink path (* dangling links bother isDir *)

                then FileSys.remove path

                else if FileSys.isDir path

                then (app remove (dir_contents path); FileSys.rmDir path)

                else FileSys.remove path

        in

            (remove path; OK ())

            handle SysErr (e, _) => ERROR ("Path removal failed: " ^ e)

        end

    fun rmpath path =

        rmpath' (OS.Path.mkCanonical path)

    fun nonempty_dir_exists path =

        let open OS.FileSys

        in

            (not (isLink path) andalso

             isDir path andalso

             dir_contents path <> [])

            handle _ => false

        end                                        

end

functor LibControlFn (V: VCS_CONTROL) :> LIB_CONTROL = struct

    (* Valid states for unpinned libraries:

       - CORRECT: We are on the right branch and are up-to-date with

         it as far as we can tell. (If not using the network, this

         should be reported to user as "Present" rather than "Correct"

         as the remote repo may have advanced without us knowing.)

       - SUPERSEDED: We are on the right branch but we can see that

         there is a newer revision either locally or on the remote (in

         Git terms, we are at an ancestor of the desired branch tip).

       - WRONG: We are on the wrong branch (in Git terms, we are not

         at the desired branch tip or any ancestor of it).

       - ABSENT: Repo doesn't exist here at all.

       Valid states for pinned libraries:

       - CORRECT: We are at the pinned revision.

       - WRONG: We are at any revision other than the pinned one.

       - ABSENT: Repo doesn't exist here at all.

    *)

    fun check with_network context

              ({ libname, source, branch,

                 project_pin, lock_pin, ... } : libspec) =

        let fun check_unpinned () =

                let val newest =

                        if with_network

                        then V.is_newest context (libname, source, branch)

                        else V.is_newest_locally context (libname, branch)

                in

                    case newest of

                         ERROR e => ERROR e

                       | OK true => OK CORRECT

                       | OK false =>

                         case V.is_on_branch context (libname, branch) of

                             ERROR e => ERROR e

                           | OK true => OK SUPERSEDED

                           | OK false => OK WRONG

                end

            fun check_pinned target =

                case V.is_at context (libname, target) of

                    ERROR e => ERROR e

                  | OK true => OK CORRECT

                  | OK false => OK WRONG

            fun check_remote () =

                case project_pin of

                    UNPINNED => check_unpinned ()

                  | PINNED target => check_pinned target

            fun check_local () =

                case V.is_modified_locally context libname of

                    ERROR e => ERROR e

                  | OK true  => OK MODIFIED

                  | OK false => 

                    case lock_pin of

                        UNPINNED => OK CLEAN

                      | PINNED target =>

                        case V.is_at context (libname, target) of

                            ERROR e => ERROR e

                          | OK true => OK CLEAN

                          | OK false => OK LOCK_MISMATCHED

        in

            case V.exists context libname of

                ERROR e => ERROR e

              | OK false => OK (ABSENT, CLEAN)

              | OK true =>

                case (check_remote (), check_local ()) of

                    (ERROR e, _) => ERROR e

                  | (_, ERROR e) => ERROR e

                  | (OK r, OK l) => OK (r, l)

        end

    val review = check true

    val status = check false

    fun update context

               ({ libname, source, branch,

                  project_pin, lock_pin, ... } : libspec) =

        let fun update_unpinned () =

                case V.is_newest context (libname, source, branch) of

                    ERROR e => ERROR e

                  | OK true => OK ()

                  | OK false => V.update context (libname, source, branch)

            fun update_pinned target =

                case V.is_at context (libname, target) of

                    ERROR e => ERROR e

                  | OK true => OK ()

                  | OK false => V.update_to context (libname, source, target)

            fun update' () =

                case lock_pin of

                    PINNED target => update_pinned target

                  | UNPINNED =>

                    case project_pin of

                        PINNED target => update_pinned target

                      | UNPINNED => update_unpinned ()

        in

            case V.exists context libname of

                ERROR e => ERROR e

              | OK true => update' ()

              | OK false =>

                case V.checkout context (libname, source, branch) of

                    ERROR e => ERROR e

                  | OK () => update' ()

        end

    fun id_of context ({ libname, ... } : libspec) =

        V.id_of context libname

end

(* Simple Standard ML JSON parser

   https://bitbucket.org/cannam/sml-simplejson

   Copyright 2017 Chris Cannam. BSD licence.

   Parts based on the JSON parser in the Ponyo library by Phil Eaton.

*)

signature JSON = sig

    datatype json = OBJECT of (string * json) list

                  | ARRAY of json list

                  | NUMBER of real

                  | STRING of string

                  | BOOL of bool

                  | NULL

    datatype 'a result = OK of 'a

                       | ERROR of string

    val parse : string -> json result

    val serialise : json -> string

    val serialiseIndented : json -> string

end

structure Json :> JSON = struct

    datatype json = OBJECT of (string * json) list

                  | ARRAY of json list

                  | NUMBER of real

                  | STRING of string

                  | BOOL of bool

                  | NULL

    datatype 'a result = OK of 'a

                       | ERROR of string

    structure T = struct

        datatype token = NUMBER of char list

                       | STRING of string

                       | BOOL of bool

                       | NULL

                       | CURLY_L

                       | CURLY_R

                       | SQUARE_L

                       | SQUARE_R

                       | COLON

                       | COMMA

        fun toString t =

            case t of NUMBER digits => implode digits

                    | STRING s => s

                    | BOOL b => Bool.toString b

                    | NULL => "null"

                    | CURLY_L => "{"

                    | CURLY_R => "}"

                    | SQUARE_L => "["

                    | SQUARE_R => "]"

                    | COLON => ":"

                    | COMMA => ","

    end

    fun bmpToUtf8 cp =  (* convert a codepoint in Unicode BMP to utf8 bytes *)

        let open Word

	    infix 6 orb andb >>

        in

            map (Char.chr o toInt)

                (if cp < 0wx80 then

                     [cp]

                 else if cp < 0wx800 then

                     [0wxc0 orb (cp >> 0w6), 0wx80 orb (cp andb 0wx3f)]

                 else if cp < 0wx10000 then

                     [0wxe0 orb (cp >> 0w12),

                      0wx80 orb ((cp >> 0w6) andb 0wx3f),

		      0wx80 orb (cp andb 0wx3f)]

                 else raise Fail ("Invalid BMP point " ^ (Word.toString cp)))

        end

    fun error pos text = ERROR (text ^ " at character position " ^

                                Int.toString (pos - 1))

    fun token_error pos = error pos ("Unexpected token")

    fun lexNull pos acc (#"u" :: #"l" :: #"l" :: xs) =

        lex (pos + 3) (T.NULL :: acc) xs

      | lexNull pos acc _ = token_error pos

    and lexTrue pos acc (#"r" :: #"u" :: #"e" :: xs) =

        lex (pos + 3) (T.BOOL true :: acc) xs

      | lexTrue pos acc _ = token_error pos

    and lexFalse pos acc (#"a" :: #"l" :: #"s" :: #"e" :: xs) =

        lex (pos + 4) (T.BOOL false :: acc) xs

      | lexFalse pos acc _ = token_error pos

    and lexChar tok pos acc xs =

        lex pos (tok :: acc) xs

    and lexString pos acc cc =

        let datatype escaped = ESCAPED | NORMAL

            fun lexString' pos text ESCAPED [] =

                error pos "End of input during escape sequence"

              | lexString' pos text NORMAL [] = 

                error pos "End of input during string"

              | lexString' pos text ESCAPED (x :: xs) =

                let fun esc c = lexString' (pos + 1) (c :: text) NORMAL xs

                in case x of

                       #"\"" => esc x

                     | #"\\" => esc x

                     | #"/"  => esc x

                     | #"b"  => esc #"\b"

                     | #"f"  => esc #"\f"

                     | #"n"  => esc #"\n"

                     | #"r"  => esc #"\r"

                     | #"t"  => esc #"\t"

                     | _     => error pos ("Invalid escape \\" ^

                                           Char.toString x)

                end

              | lexString' pos text NORMAL (#"\\" :: #"u" ::a::b::c::d:: xs) =

                if List.all Char.isHexDigit [a,b,c,d]

                then case Word.fromString ("0wx" ^ (implode [a,b,c,d])) of

                         SOME w => (let val utf = rev (bmpToUtf8 w) in

                                        lexString' (pos + 6) (utf @ text)

                                                   NORMAL xs

                                    end

                                    handle Fail err => error pos err)

                       | NONE => error pos "Invalid Unicode BMP escape sequence"

                else error pos "Invalid Unicode BMP escape sequence"

              | lexString' pos text NORMAL (x :: xs) =

                if Char.ord x < 0x20

                then error pos "Invalid unescaped control character"

                else

                    case x of

                        #"\"" => OK (rev text, xs, pos + 1)

                      | #"\\" => lexString' (pos + 1) text ESCAPED xs

                      | _     => lexString' (pos + 1) (x :: text) NORMAL xs

        in

            case lexString' pos [] NORMAL cc of

                OK (text, rest, newpos) =>

                lex newpos (T.STRING (implode text) :: acc) rest

              | ERROR e => ERROR e

        end

    and lexNumber firstChar pos acc cc =

        let val valid = explode ".+-e"

            fun lexNumber' pos digits [] = (rev digits, [], pos)

              | lexNumber' pos digits (x :: xs) =

                if x = #"E" then lexNumber' (pos + 1) (#"e" :: digits) xs

                else if Char.isDigit x orelse List.exists (fn c => x = c) valid

                then lexNumber' (pos + 1) (x :: digits) xs

                else (rev digits, x :: xs, pos)

            val (digits, rest, newpos) =

                lexNumber' (pos - 1) [] (firstChar :: cc)

        in

            case digits of

                [] => token_error pos

              | _ => lex newpos (T.NUMBER digits :: acc) rest

        end

    and lex pos acc [] = OK (rev acc)

      | lex pos acc (x::xs) = 

        (case x of

             #" "  => lex

           | #"\t" => lex

           | #"\n" => lex

           | #"\r" => lex

           | #"{"  => lexChar T.CURLY_L

           | #"}"  => lexChar T.CURLY_R

           | #"["  => lexChar T.SQUARE_L

           | #"]"  => lexChar T.SQUARE_R

           | #":"  => lexChar T.COLON

           | #","  => lexChar T.COMMA

           | #"\"" => lexString

           | #"t"  => lexTrue

           | #"f"  => lexFalse

           | #"n"  => lexNull

           | x     => lexNumber x) (pos + 1) acc xs

    fun show [] = "end of input"

      | show (tok :: _) = T.toString tok

    fun parseNumber digits =

        (* Note lexNumber already case-insensitised the E for us *)

        let open Char

            fun okExpDigits [] = false

              | okExpDigits (c :: []) = isDigit c

              | okExpDigits (c :: cs) = isDigit c andalso okExpDigits cs

            fun okExponent [] = false

              | okExponent (#"+" :: cs) = okExpDigits cs

              | okExponent (#"-" :: cs) = okExpDigits cs

              | okExponent cc = okExpDigits cc

            fun okFracTrailing [] = true

              | okFracTrailing (c :: cs) =

                (isDigit c andalso okFracTrailing cs) orelse

                (c = #"e" andalso okExponent cs)

            fun okFraction [] = false

              | okFraction (c :: cs) =

                isDigit c andalso okFracTrailing cs

            fun okPosTrailing [] = true

              | okPosTrailing (#"." :: cs) = okFraction cs

              | okPosTrailing (#"e" :: cs) = okExponent cs

              | okPosTrailing (c :: cs) =

                isDigit c andalso okPosTrailing cs

            fun okPositive [] = false

              | okPositive (#"0" :: []) = true

              | okPositive (#"0" :: #"." :: cs) = okFraction cs

              | okPositive (#"0" :: #"e" :: cs) = okExponent cs

              | okPositive (#"0" :: cs) = false

              | okPositive (c :: cs) = isDigit c andalso okPosTrailing cs

            fun okNumber (#"-" :: cs) = okPositive cs

              | okNumber cc = okPositive cc

        in

            if okNumber digits

            then case Real.fromString (implode digits) of

                     NONE => ERROR "Number out of range"

                   | SOME r => OK r

            else ERROR ("Invalid number \"" ^ (implode digits) ^ "\"")

        end

    fun parseObject (T.CURLY_R :: xs) = OK (OBJECT [], xs)

      | parseObject tokens =

        let fun parsePair (T.STRING key :: T.COLON :: xs) =

                (case parseTokens xs of

                     ERROR e => ERROR e

                   | OK (j, xs) => OK ((key, j), xs))

              | parsePair other =

                ERROR ("Object key/value pair expected around \"" ^

                       show other ^ "\"")

            fun parseObject' acc [] = ERROR "End of input during object"

              | parseObject' acc tokens =

                case parsePair tokens of

                    ERROR e => ERROR e

                  | OK (pair, T.COMMA :: xs) =>

                    parseObject' (pair :: acc) xs

                  | OK (pair, T.CURLY_R :: xs) =>

                    OK (OBJECT (rev (pair :: acc)), xs)

                  | OK (_, _) => ERROR "Expected , or } after object element"

        in

            parseObject' [] tokens

        end

    and parseArray (T.SQUARE_R :: xs) = OK (ARRAY [], xs)

      | parseArray tokens =

        let fun parseArray' acc [] = ERROR "End of input during array"

              | parseArray' acc tokens =

                case parseTokens tokens of

                    ERROR e => ERROR e

                  | OK (j, T.COMMA :: xs) => parseArray' (j :: acc) xs

                  | OK (j, T.SQUARE_R :: xs) => OK (ARRAY (rev (j :: acc)), xs)

                  | OK (_, _) => ERROR "Expected , or ] after array element"

        in

            parseArray' [] tokens

        end

    and parseTokens [] = ERROR "Value expected"

      | parseTokens (tok :: xs) =

        (case tok of

             T.NUMBER d => (case parseNumber d of

                                OK r => OK (NUMBER r, xs)

                              | ERROR e => ERROR e)

           | T.STRING s => OK (STRING s, xs)

           | T.BOOL b   => OK (BOOL b, xs)

           | T.NULL     => OK (NULL, xs)

           | T.CURLY_L  => parseObject xs

           | T.SQUARE_L => parseArray xs

           | _ => ERROR ("Unexpected token " ^ T.toString tok ^

                         " before " ^ show xs))

    fun parse str =

        case lex 1 [] (explode str) of

           ERROR e => ERROR e

         | OK tokens => case parseTokens tokens of

                            OK (value, []) => OK value

                          | OK (_, _) => ERROR "Extra data after input"

                          | ERROR e => ERROR e

    fun stringEscape s =

        let fun esc x = [x, #"\\"]

            fun escape' acc [] = rev acc

              | escape' acc (x :: xs) =

                escape' (case x of

                             #"\"" => esc x @ acc

                           | #"\\" => esc x @ acc

                           | #"\b" => esc #"b" @ acc

                           | #"\f" => esc #"f" @ acc

                           | #"\n" => esc #"n" @ acc

                           | #"\r" => esc #"r" @ acc

                           | #"\t" => esc #"t" @ acc

                           | _ =>

                             let val c = Char.ord x

                             in

                                 if c < 0x20

                                 then let val hex = Word.toString (Word.fromInt c)

                                      in (rev o explode) (if c < 0x10

                                                          then ("\\u000" ^ hex)

                                                          else ("\\u00" ^ hex))

                                      end @ acc

                                 else 

                                     x :: acc

                             end)

                        xs

        in

            implode (escape' [] (explode s))

        end

    fun serialise json =

        case json of

            OBJECT pp => "{" ^ String.concatWith

                                   "," (map (fn (key, value) =>

                                                serialise (STRING key) ^ ":" ^

                                                serialise value) pp) ^

                         "}"

          | ARRAY arr => "[" ^ String.concatWith "," (map serialise arr) ^ "]"

          | NUMBER n => implode (map (fn #"~" => #"-" | c => c) 

                                     (explode (Real.toString n)))

          | STRING s => "\"" ^ stringEscape s ^ "\""

          | BOOL b => Bool.toString b

          | NULL => "null"

    fun serialiseIndented json =

        let fun indent 0 = ""

              | indent i = "  " ^ indent (i - 1)

            fun serialiseIndented' i json =

                let val ser = serialiseIndented' (i + 1)

                in

                    case json of

                        OBJECT [] => "{}"

                      | ARRAY [] => "[]"

                      | OBJECT pp => "{\n" ^ indent (i + 1) ^

                                     String.concatWith

                                         (",\n" ^ indent (i + 1))

                                         (map (fn (key, value) =>

                                                  ser (STRING key) ^ ": " ^

                                                  ser value) pp) ^

                                     "\n" ^ indent i ^ "}"

                      | ARRAY arr => "[\n" ^ indent (i + 1) ^

                                     String.concatWith

                                         (",\n" ^ indent (i + 1))

                                         (map ser arr) ^

                                     "\n" ^ indent i ^ "]"

                      | other => serialise other

                end

        in

            serialiseIndented' 0 json ^ "\n"

        end

end

structure JsonBits :> sig

    val load_json_from : string -> Json.json (* filename -> json *)

    val save_json_to : string -> Json.json -> unit

    val lookup_optional : Json.json -> string list -> Json.json option

    val lookup_optional_string : Json.json -> string list -> string option

    val lookup_mandatory : Json.json -> string list -> Json.json

    val lookup_mandatory_string : Json.json -> string list -> string

end = struct

    fun load_json_from filename =

        case Json.parse (FileBits.file_contents filename) of

            Json.OK json => json

          | Json.ERROR e => raise Fail ("Failed to parse file: " ^ e)

    fun save_json_to filename json =

        (* using binary I/O to avoid ever writing CR/LF line endings *)

        let val jstr = Json.serialiseIndented json

            val stream = BinIO.openOut filename

        in

            BinIO.output (stream, Byte.stringToBytes jstr);

            BinIO.closeOut stream

        end

    fun lookup_optional json kk =

        let fun lookup key =

                case json of

                    Json.OBJECT kvs =>

                    (case List.find (fn (k, v) => k = key) kvs of

                         SOME (k, v) => SOME v

                       | NONE => NONE)

                  | _ => raise Fail "Object expected"

        in

            case kk of

                [] => NONE

              | key::[] => lookup key

              | key::kk => case lookup key of

                               NONE => NONE

                             | SOME j => lookup_optional j kk

        end

    fun lookup_optional_string json kk =

        case lookup_optional json kk of

            SOME (Json.STRING s) => SOME s

          | SOME _ => raise Fail ("Value (if present) must be string: " ^

                                  (String.concatWith " -> " kk))

          | NONE => NONE

    fun lookup_mandatory json kk =

        case lookup_optional json kk of

            SOME v => v

          | NONE => raise Fail ("Value is mandatory: " ^

                                (String.concatWith " -> " kk) ^ " in json: " ^

                                (Json.serialise json))

    fun lookup_mandatory_string json kk =

        case lookup_optional json kk of

            SOME (Json.STRING s) => s

          | _ => raise Fail ("Value must be string: " ^

                             (String.concatWith " -> " kk))

end

structure Provider :> sig

    val load_providers : Json.json -> provider list

    val load_more_providers : provider list -> Json.json -> provider list

    val remote_url : context -> vcs -> source -> libname -> string

end = struct

    val known_providers : provider list =

        [ {

            service = "bitbucket",

            supports = [HG, GIT],

            remote_spec = {

                anon = SOME "https://bitbucket.org/{owner}/{repository}",

                auth = SOME "ssh://{vcs}@bitbucket.org/{owner}/{repository}"

            }

          },

          {

            service = "github",

            supports = [GIT],

            remote_spec = {

                anon = SOME "https://github.com/{owner}/{repository}",

                auth = SOME "ssh://{vcs}@github.com/{owner}/{repository}"

            }

          }

        ]

    fun vcs_name vcs =

        case vcs of HG => "hg"

                  | GIT => "git"

                  | SVN => "svn"

    fun vcs_from_name name =

        case name of "hg" => HG

                   | "git" => GIT 

                   | "svn" => SVN

                   | other => raise Fail ("Unknown vcs name \"" ^ name ^ "\"")

    fun load_more_providers previously_loaded json =

        let open JsonBits

            fun load pjson pname : provider =

                {

                  service = pname,

                  supports =

                  case lookup_mandatory pjson ["vcs"] of

                      Json.ARRAY vv =>

                      map (fn (Json.STRING v) => vcs_from_name v

                          | _ => raise Fail "Strings expected in vcs array")

                          vv

                    | _ => raise Fail "Array expected for vcs",

                  remote_spec = {

                      anon = lookup_optional_string pjson ["anonymous"],

                      auth = lookup_optional_string pjson ["authenticated"]

                  }

                }

            val loaded = 

                case lookup_optional json ["services"] of

                    NONE => []

                  | SOME (Json.OBJECT pl) => map (fn (k, v) => load v k) pl

                  | _ => raise Fail "Object expected for services in config"

            val newly_loaded =

                List.filter (fn p => not (List.exists (fn pp => #service p =

                                                                #service pp)

                                                      previously_loaded))

                            loaded

        in

            previously_loaded @ newly_loaded

        end

    fun load_providers json =

        load_more_providers known_providers json

    fun expand_spec spec { vcs, service, owner, repo } login =

        (* ugly *)

        let fun replace str = 

                case str of

                    "vcs" => vcs_name vcs

                  | "service" => service

                  | "owner" =>

                    (case owner of

                         SOME ostr => ostr

                       | NONE => raise Fail ("Owner not specified for service " ^

                                             service))

                  | "repository" => repo

                  | "account" =>

                    (case login of

                         SOME acc => acc

                       | NONE => raise Fail ("Account not given for service " ^

                                             service))

                  | other => raise Fail ("Unknown variable \"" ^ other ^

                                         "\" in spec for service " ^ service)

            fun expand' acc sstr =

                case Substring.splitl (fn c => c <> #"{") sstr of

                    (pfx, sfx) =>

                    if Substring.isEmpty sfx

                    then rev (pfx :: acc)

                    else 

                        case Substring.splitl (fn c => c <> #"}") sfx of

                            (tok, remainder) =>

                            if Substring.isEmpty remainder

                            then rev (tok :: pfx :: acc)

                            else let val replacement =

                                         replace

                                             (* tok begins with "{": *)

                                             (Substring.string

                                                  (Substring.triml 1 tok))

                                 in

                                     expand' (Substring.full replacement ::

                                              pfx :: acc)

                                             (* remainder begins with "}": *)

                                             (Substring.triml 1 remainder)

                                 end

        in

            Substring.concat (expand' [] (Substring.full spec))

        end

    fun provider_url req login providers =

        case providers of

            [] => raise Fail ("Unknown service \"" ^ (#service req) ^

                              "\" for vcs \"" ^ (vcs_name (#vcs req)) ^ "\"")

          | ({ service, supports, remote_spec : remote_spec } :: rest) =>

            if service <> (#service req) orelse

               not (List.exists (fn v => v = (#vcs req)) supports)

            then provider_url req login rest

            else

                case (login, #auth remote_spec, #anon remote_spec) of

                    (SOME _, SOME auth, _) => expand_spec auth req login

                  | (SOME _, _, SOME anon) => expand_spec anon req NONE

                  | (NONE,   _, SOME anon) => expand_spec anon req NONE

                  | _ => raise Fail ("No suitable anonymous or authenticated " ^

                                     "URL spec provided for service \"" ^

                                     service ^ "\"")