annotate vext.sml @ 1761:cd10346cc810

Update Vext
author Chris Cannam
date Tue, 23 Jan 2018 12:54:58 +0000
parents 42d57c382e56
children 762ef5d2722a
rev   line source
Chris@1746 1 (*
Chris@1746 2 DO NOT EDIT THIS FILE.
Chris@1746 3 This file is automatically generated from the individual
Chris@1746 4 source files in the Vext repository.
Chris@1746 5 *)
Chris@1706 6
Chris@1706 7 (*
Chris@1706 8 Vext
Chris@1706 9
Chris@1706 10 A simple manager for third-party source code dependencies
Chris@1706 11
Chris@1761 12 Copyright 2018 Chris Cannam, Particular Programs Ltd,
Chris@1746 13 and Queen Mary, University of London
Chris@1706 14
Chris@1706 15 Permission is hereby granted, free of charge, to any person
Chris@1706 16 obtaining a copy of this software and associated documentation
Chris@1706 17 files (the "Software"), to deal in the Software without
Chris@1706 18 restriction, including without limitation the rights to use, copy,
Chris@1706 19 modify, merge, publish, distribute, sublicense, and/or sell copies
Chris@1706 20 of the Software, and to permit persons to whom the Software is
Chris@1706 21 furnished to do so, subject to the following conditions:
Chris@1706 22
Chris@1706 23 The above copyright notice and this permission notice shall be
Chris@1706 24 included in all copies or substantial portions of the Software.
Chris@1706 25
Chris@1706 26 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Chris@1706 27 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Chris@1706 28 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
Chris@1706 29 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
Chris@1706 30 ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
Chris@1706 31 CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
Chris@1706 32 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Chris@1706 33
Chris@1746 34 Except as contained in this notice, the names of Chris Cannam,
Chris@1746 35 Particular Programs Ltd, and Queen Mary, University of London
Chris@1746 36 shall not be used in advertising or otherwise to promote the sale,
Chris@1746 37 use or other dealings in this Software without prior written
Chris@1746 38 authorization.
Chris@1706 39 *)
Chris@1706 40
Chris@1761 41 val vext_version = "0.9.94"
Chris@1706 42
Chris@1706 43
Chris@1706 44 datatype vcs =
Chris@1706 45 HG |
Chris@1756 46 GIT |
Chris@1756 47 SVN
Chris@1706 48
Chris@1706 49 datatype source =
Chris@1721 50 URL_SOURCE of string |
Chris@1721 51 SERVICE_SOURCE of {
Chris@1706 52 service : string,
Chris@1706 53 owner : string option,
Chris@1706 54 repo : string option
Chris@1706 55 }
Chris@1706 56
Chris@1740 57 type id_or_tag = string
Chris@1740 58
Chris@1706 59 datatype pin =
Chris@1706 60 UNPINNED |
Chris@1740 61 PINNED of id_or_tag
Chris@1706 62
Chris@1706 63 datatype libstate =
Chris@1706 64 ABSENT |
Chris@1706 65 CORRECT |
Chris@1706 66 SUPERSEDED |
Chris@1706 67 WRONG
Chris@1706 68
Chris@1706 69 datatype localstate =
Chris@1706 70 MODIFIED |
Chris@1740 71 LOCK_MISMATCHED |
Chris@1740 72 CLEAN
Chris@1706 73
Chris@1706 74 datatype branch =
Chris@1706 75 BRANCH of string |
Chris@1706 76 DEFAULT_BRANCH
Chris@1706 77
Chris@1706 78 (* If we can recover from an error, for example by reporting failure
Chris@1706 79 for this one thing and going on to the next thing, then the error
Chris@1706 80 should usually be returned through a result type rather than an
Chris@1706 81 exception. *)
Chris@1706 82
Chris@1706 83 datatype 'a result =
Chris@1706 84 OK of 'a |
Chris@1706 85 ERROR of string
Chris@1706 86
Chris@1706 87 type libname = string
Chris@1706 88
Chris@1706 89 type libspec = {
Chris@1706 90 libname : libname,
Chris@1706 91 vcs : vcs,
Chris@1706 92 source : source,
Chris@1706 93 branch : branch,
Chris@1740 94 project_pin : pin,
Chris@1740 95 lock_pin : pin
Chris@1706 96 }
Chris@1706 97
Chris@1706 98 type lock = {
Chris@1706 99 libname : libname,
Chris@1706 100 id_or_tag : id_or_tag
Chris@1706 101 }
Chris@1740 102
Chris@1706 103 type remote_spec = {
Chris@1706 104 anon : string option,
Chris@1706 105 auth : string option
Chris@1706 106 }
Chris@1706 107
Chris@1706 108 type provider = {
Chris@1706 109 service : string,
Chris@1706 110 supports : vcs list,
Chris@1706 111 remote_spec : remote_spec
Chris@1706 112 }
Chris@1706 113
Chris@1706 114 type account = {
Chris@1706 115 service : string,
Chris@1706 116 login : string
Chris@1706 117 }
Chris@1706 118
Chris@1706 119 type context = {
Chris@1706 120 rootpath : string,
Chris@1706 121 extdir : string,
Chris@1706 122 providers : provider list,
Chris@1706 123 accounts : account list
Chris@1706 124 }
Chris@1706 125
Chris@1706 126 type userconfig = {
Chris@1706 127 providers : provider list,
Chris@1706 128 accounts : account list
Chris@1706 129 }
Chris@1706 130
Chris@1706 131 type project = {
Chris@1706 132 context : context,
Chris@1706 133 libs : libspec list
Chris@1706 134 }
Chris@1706 135
Chris@1706 136 structure VextFilenames = struct
Chris@1706 137 val project_file = "vext-project.json"
Chris@1706 138 val project_lock_file = "vext-lock.json"
Chris@1706 139 val user_config_file = ".vext.json"
Chris@1746 140 val archive_dir = ".vext-archive"
Chris@1706 141 end
Chris@1706 142
Chris@1706 143 signature VCS_CONTROL = sig
Chris@1706 144
Chris@1706 145 (** Test whether the library is present locally at all *)
Chris@1706 146 val exists : context -> libname -> bool result
Chris@1706 147
Chris@1706 148 (** Return the id (hash) of the current revision for the library *)
Chris@1706 149 val id_of : context -> libname -> id_or_tag result
Chris@1706 150
Chris@1706 151 (** Test whether the library is at the given id *)
Chris@1706 152 val is_at : context -> libname * id_or_tag -> bool result
Chris@1706 153
Chris@1706 154 (** Test whether the library is on the given branch, i.e. is at
Chris@1706 155 the branch tip or an ancestor of it *)
Chris@1706 156 val is_on_branch : context -> libname * branch -> bool result
Chris@1706 157
Chris@1706 158 (** Test whether the library is at the newest revision for the
Chris@1706 159 given branch. False may indicate that the branch has advanced
Chris@1706 160 or that the library is not on the branch at all. This function
Chris@1706 161 may use the network to check for new revisions *)
Chris@1752 162 val is_newest : context -> libname * source * branch -> bool result
Chris@1706 163
Chris@1706 164 (** Test whether the library is at the newest revision available
Chris@1706 165 locally for the given branch. False may indicate that the
Chris@1706 166 branch has advanced or that the library is not on the branch
Chris@1706 167 at all. This function must not use the network *)
Chris@1706 168 val is_newest_locally : context -> libname * branch -> bool result
Chris@1706 169
Chris@1706 170 (** Test whether the library has been modified in the local
Chris@1706 171 working copy *)
Chris@1706 172 val is_modified_locally : context -> libname -> bool result
Chris@1706 173
Chris@1706 174 (** Check out, i.e. clone a fresh copy of, the repo for the given
Chris@1706 175 library on the given branch *)
Chris@1706 176 val checkout : context -> libname * source * branch -> unit result
Chris@1706 177
Chris@1756 178 (** Update the library to the given branch tip. Assumes that a
Chris@1758 179 local copy of the library already exists *)
Chris@1758 180 val update : context -> libname * source * branch -> unit result
Chris@1706 181
Chris@1706 182 (** Update the library to the given specific id or tag *)
Chris@1758 183 val update_to : context -> libname * source * id_or_tag -> unit result
Chris@1756 184
Chris@1756 185 (** Return a URL from which the library can be cloned, given that
Chris@1756 186 the local copy already exists. For a DVCS this can be the
Chris@1756 187 local copy, but for a centralised VCS it will have to be the
Chris@1756 188 remote repository URL. Used for archiving *)
Chris@1756 189 val copy_url_for : context -> libname -> string result
Chris@1706 190 end
Chris@1706 191
Chris@1706 192 signature LIB_CONTROL = sig
Chris@1706 193 val review : context -> libspec -> (libstate * localstate) result
Chris@1706 194 val status : context -> libspec -> (libstate * localstate) result
Chris@1758 195 val update : context -> libspec -> unit result
Chris@1740 196 val id_of : context -> libspec -> id_or_tag result
Chris@1706 197 end
Chris@1706 198
Chris@1706 199 structure FileBits :> sig
Chris@1706 200 val extpath : context -> string
Chris@1706 201 val libpath : context -> libname -> string
Chris@1706 202 val subpath : context -> libname -> string -> string
Chris@1706 203 val command_output : context -> libname -> string list -> string result
Chris@1706 204 val command : context -> libname -> string list -> unit result
Chris@1756 205 val file_url : string -> string
Chris@1706 206 val file_contents : string -> string
Chris@1706 207 val mydir : unit -> string
Chris@1706 208 val homedir : unit -> string
Chris@1706 209 val mkpath : string -> unit result
Chris@1746 210 val rmpath : string -> unit result
Chris@1756 211 val nonempty_dir_exists : string -> bool
Chris@1706 212 val project_spec_path : string -> string
Chris@1706 213 val project_lock_path : string -> string
Chris@1706 214 val verbose : unit -> bool
Chris@1706 215 end = struct
Chris@1706 216
Chris@1706 217 fun verbose () =
Chris@1706 218 case OS.Process.getEnv "VEXT_VERBOSE" of
Chris@1706 219 SOME "0" => false
Chris@1706 220 | SOME _ => true
Chris@1706 221 | NONE => false
Chris@1706 222
Chris@1752 223 fun split_relative path desc =
Chris@1752 224 case OS.Path.fromString path of
Chris@1752 225 { isAbs = true, ... } => raise Fail (desc ^ " may not be absolute")
Chris@1752 226 | { arcs, ... } => arcs
Chris@1752 227
Chris@1706 228 fun extpath ({ rootpath, extdir, ... } : context) =
Chris@1706 229 let val { isAbs, vol, arcs } = OS.Path.fromString rootpath
Chris@1706 230 in OS.Path.toString {
Chris@1706 231 isAbs = isAbs,
Chris@1706 232 vol = vol,
Chris@1752 233 arcs = arcs @
Chris@1752 234 split_relative extdir "extdir"
Chris@1706 235 }
Chris@1706 236 end
Chris@1706 237
Chris@1706 238 fun subpath ({ rootpath, extdir, ... } : context) libname remainder =
Chris@1706 239 (* NB libname is allowed to be a path fragment, e.g. foo/bar *)
Chris@1706 240 let val { isAbs, vol, arcs } = OS.Path.fromString rootpath
Chris@1706 241 in OS.Path.toString {
Chris@1706 242 isAbs = isAbs,
Chris@1706 243 vol = vol,
Chris@1752 244 arcs = arcs @
Chris@1752 245 split_relative extdir "extdir" @
Chris@1752 246 split_relative libname "library path" @
Chris@1752 247 split_relative remainder "subpath"
Chris@1706 248 }
Chris@1706 249 end
Chris@1706 250
Chris@1706 251 fun libpath context "" =
Chris@1706 252 extpath context
Chris@1706 253 | libpath context libname =
Chris@1706 254 subpath context libname ""
Chris@1706 255
Chris@1706 256 fun project_file_path rootpath filename =
Chris@1706 257 let val { isAbs, vol, arcs } = OS.Path.fromString rootpath
Chris@1706 258 in OS.Path.toString {
Chris@1706 259 isAbs = isAbs,
Chris@1706 260 vol = vol,
Chris@1706 261 arcs = arcs @ [ filename ]
Chris@1706 262 }
Chris@1706 263 end
Chris@1706 264
Chris@1706 265 fun project_spec_path rootpath =
Chris@1706 266 project_file_path rootpath (VextFilenames.project_file)
Chris@1706 267
Chris@1706 268 fun project_lock_path rootpath =
Chris@1706 269 project_file_path rootpath (VextFilenames.project_lock_file)
Chris@1706 270
Chris@1706 271 fun trim str =
Chris@1706 272 hd (String.fields (fn x => x = #"\n" orelse x = #"\r") str)
Chris@1756 273
Chris@1756 274 fun file_url path =
Chris@1756 275 let val forward_path =
Chris@1756 276 String.translate (fn #"\\" => "/" |
Chris@1756 277 c => Char.toString c)
Chris@1756 278 (OS.Path.mkCanonical path)
Chris@1756 279 in
Chris@1756 280 (* Path is expected to be absolute already, but if it
Chris@1756 281 starts with a drive letter, we'll need an extra slash *)
Chris@1756 282 case explode forward_path of
Chris@1756 283 #"/"::rest => "file:///" ^ implode rest
Chris@1756 284 | _ => "file:///" ^ forward_path
Chris@1756 285 end
Chris@1706 286
Chris@1706 287 fun file_contents filename =
Chris@1706 288 let val stream = TextIO.openIn filename
Chris@1706 289 fun read_all str acc =
Chris@1706 290 case TextIO.inputLine str of
Chris@1706 291 SOME line => read_all str (trim line :: acc)
Chris@1706 292 | NONE => rev acc
Chris@1706 293 val contents = read_all stream []
Chris@1706 294 val _ = TextIO.closeIn stream
Chris@1706 295 in
Chris@1706 296 String.concatWith "\n" contents
Chris@1706 297 end
Chris@1706 298
Chris@1706 299 fun expand_commandline cmdlist =
Chris@1706 300 (* We are quite [too] strict about what we accept here, except
Chris@1706 301 for the first element in cmdlist which is assumed to be a
Chris@1706 302 known command location rather than arbitrary user input. NB
Chris@1706 303 only ASCII accepted at this point. *)
Chris@1706 304 let open Char
Chris@1706 305 fun quote arg =
Chris@1706 306 if List.all
Chris@1706 307 (fn c => isAlphaNum c orelse c = #"-" orelse c = #"_")
Chris@1706 308 (explode arg)
Chris@1706 309 then arg
Chris@1706 310 else "\"" ^ arg ^ "\""
Chris@1706 311 fun check arg =
Chris@1761 312 let val valid = explode " /#:;?,._-{}@=+"
Chris@1706 313 in
Chris@1706 314 app (fn c =>
Chris@1706 315 if isAlphaNum c orelse
Chris@1761 316 List.exists (fn v => v = c) valid orelse
Chris@1761 317 c > chr 127
Chris@1706 318 then ()
Chris@1706 319 else raise Fail ("Invalid character '" ^
Chris@1706 320 (Char.toString c) ^
Chris@1706 321 "' in command list"))
Chris@1706 322 (explode arg);
Chris@1706 323 arg
Chris@1706 324 end
Chris@1706 325 in
Chris@1706 326 String.concatWith " "
Chris@1706 327 (map quote
Chris@1706 328 (hd cmdlist :: map check (tl cmdlist)))
Chris@1706 329 end
Chris@1706 330
Chris@1706 331 val tick_cycle = ref 0
Chris@1706 332 val tick_chars = Vector.fromList (map String.str (explode "|/-\\"))
Chris@1706 333
Chris@1716 334 fun tick libname cmdlist =
Chris@1706 335 let val n = Vector.length tick_chars
Chris@1706 336 fun pad_to n str =
Chris@1716 337 if n <= String.size str then str
Chris@1716 338 else pad_to n (str ^ " ")
Chris@1716 339 val name = if libname <> "" then libname
Chris@1716 340 else if cmdlist = nil then ""
Chris@1716 341 else hd (rev cmdlist)
Chris@1706 342 in
Chris@1716 343 print (" " ^
Chris@1706 344 Vector.sub(tick_chars, !tick_cycle) ^ " " ^
Chris@1716 345 pad_to 24 name ^
Chris@1716 346 "\r");
Chris@1706 347 tick_cycle := (if !tick_cycle = n - 1 then 0 else 1 + !tick_cycle)
Chris@1706 348 end
Chris@1706 349
Chris@1706 350 fun run_command context libname cmdlist redirect =
Chris@1706 351 let open OS
Chris@1706 352 val dir = libpath context libname
Chris@1706 353 val cmd = expand_commandline cmdlist
Chris@1706 354 val _ = if verbose ()
Chris@1706 355 then print ("Running: " ^ cmd ^
Chris@1706 356 " (in dir " ^ dir ^ ")...\n")
Chris@1716 357 else tick libname cmdlist
Chris@1706 358 val _ = FileSys.chDir dir
Chris@1706 359 val status = case redirect of
Chris@1706 360 NONE => Process.system cmd
Chris@1706 361 | SOME file => Process.system (cmd ^ ">" ^ file)
Chris@1706 362 in
Chris@1706 363 if Process.isSuccess status
Chris@1706 364 then OK ()
Chris@1706 365 else ERROR ("Command failed: " ^ cmd ^ " (in dir " ^ dir ^ ")")
Chris@1706 366 end
Chris@1706 367 handle ex => ERROR ("Unable to run command: " ^ exnMessage ex)
Chris@1706 368
Chris@1706 369 fun command context libname cmdlist =
Chris@1706 370 run_command context libname cmdlist NONE
Chris@1706 371
Chris@1706 372 fun command_output context libname cmdlist =
Chris@1706 373 let open OS
Chris@1706 374 val tmpFile = FileSys.tmpName ()
Chris@1706 375 val result = run_command context libname cmdlist (SOME tmpFile)
Chris@1706 376 val contents = file_contents tmpFile
Chris@1756 377 val _ = if verbose ()
Chris@1756 378 then print ("Output was:\n\"" ^ contents ^ "\"\n")
Chris@1756 379 else ()
Chris@1706 380 in
Chris@1706 381 FileSys.remove tmpFile handle _ => ();
Chris@1706 382 case result of
Chris@1706 383 OK () => OK contents
Chris@1706 384 | ERROR e => ERROR e
Chris@1706 385 end
Chris@1706 386
Chris@1706 387 fun mydir () =
Chris@1706 388 let open OS
Chris@1706 389 val { dir, file } = Path.splitDirFile (CommandLine.name ())
Chris@1706 390 in
Chris@1706 391 FileSys.realPath
Chris@1706 392 (if Path.isAbsolute dir
Chris@1706 393 then dir
Chris@1706 394 else Path.concat (FileSys.getDir (), dir))
Chris@1706 395 end
Chris@1706 396
Chris@1706 397 fun homedir () =
Chris@1706 398 (* Failure is not routine, so we use an exception here *)
Chris@1706 399 case (OS.Process.getEnv "HOME",
Chris@1706 400 OS.Process.getEnv "HOMEPATH") of
Chris@1706 401 (SOME home, _) => home
Chris@1706 402 | (NONE, SOME home) => home
Chris@1706 403 | (NONE, NONE) =>
Chris@1706 404 raise Fail "Failed to look up home directory from environment"
Chris@1706 405
Chris@1747 406 fun mkpath' path =
Chris@1706 407 if OS.FileSys.isDir path handle _ => false
Chris@1706 408 then OK ()
Chris@1706 409 else case OS.Path.fromString path of
Chris@1706 410 { arcs = nil, ... } => OK ()
Chris@1706 411 | { isAbs = false, ... } => ERROR "mkpath requires absolute path"
Chris@1706 412 | { isAbs, vol, arcs } =>
Chris@1747 413 case mkpath' (OS.Path.toString { (* parent *)
Chris@1747 414 isAbs = isAbs,
Chris@1747 415 vol = vol,
Chris@1747 416 arcs = rev (tl (rev arcs)) }) of
Chris@1706 417 ERROR e => ERROR e
Chris@1706 418 | OK () => ((OS.FileSys.mkDir path; OK ())
Chris@1706 419 handle OS.SysErr (e, _) =>
Chris@1706 420 ERROR ("Directory creation failed: " ^ e))
Chris@1746 421
Chris@1747 422 fun mkpath path =
Chris@1752 423 mkpath' (OS.Path.mkCanonical path)
Chris@1747 424
Chris@1756 425 fun dir_contents dir =
Chris@1746 426 let open OS
Chris@1746 427 fun files_from dirstream =
Chris@1746 428 case FileSys.readDir dirstream of
Chris@1746 429 NONE => []
Chris@1746 430 | SOME file =>
Chris@1746 431 (* readDir is supposed to filter these,
Chris@1746 432 but let's be extra cautious: *)
Chris@1746 433 if file = Path.parentArc orelse file = Path.currentArc
Chris@1746 434 then files_from dirstream
Chris@1746 435 else file :: files_from dirstream
Chris@1756 436 val stream = FileSys.openDir dir
Chris@1756 437 val files = map (fn f => Path.joinDirFile
Chris@1756 438 { dir = dir, file = f })
Chris@1756 439 (files_from stream)
Chris@1756 440 val _ = FileSys.closeDir stream
Chris@1756 441 in
Chris@1756 442 files
Chris@1756 443 end
Chris@1756 444
Chris@1756 445 fun rmpath' path =
Chris@1756 446 let open OS
Chris@1746 447 fun remove path =
Chris@1746 448 if FileSys.isLink path (* dangling links bother isDir *)
Chris@1746 449 then FileSys.remove path
Chris@1746 450 else if FileSys.isDir path
Chris@1756 451 then (app remove (dir_contents path); FileSys.rmDir path)
Chris@1746 452 else FileSys.remove path
Chris@1746 453 in
Chris@1746 454 (remove path; OK ())
Chris@1746 455 handle SysErr (e, _) => ERROR ("Path removal failed: " ^ e)
Chris@1746 456 end
Chris@1752 457
Chris@1752 458 fun rmpath path =
Chris@1752 459 rmpath' (OS.Path.mkCanonical path)
Chris@1752 460
Chris@1756 461 fun nonempty_dir_exists path =
Chris@1756 462 let open OS.FileSys
Chris@1756 463 in
Chris@1756 464 (not (isLink path) andalso
Chris@1756 465 isDir path andalso
Chris@1756 466 dir_contents path <> [])
Chris@1756 467 handle _ => false
Chris@1756 468 end
Chris@1756 469
Chris@1706 470 end
Chris@1706 471
Chris@1706 472 functor LibControlFn (V: VCS_CONTROL) :> LIB_CONTROL = struct
Chris@1706 473
Chris@1706 474 (* Valid states for unpinned libraries:
Chris@1706 475
Chris@1706 476 - CORRECT: We are on the right branch and are up-to-date with
Chris@1706 477 it as far as we can tell. (If not using the network, this
Chris@1706 478 should be reported to user as "Present" rather than "Correct"
Chris@1706 479 as the remote repo may have advanced without us knowing.)
Chris@1706 480
Chris@1706 481 - SUPERSEDED: We are on the right branch but we can see that
Chris@1706 482 there is a newer revision either locally or on the remote (in
Chris@1706 483 Git terms, we are at an ancestor of the desired branch tip).
Chris@1706 484
Chris@1706 485 - WRONG: We are on the wrong branch (in Git terms, we are not
Chris@1706 486 at the desired branch tip or any ancestor of it).
Chris@1706 487
Chris@1706 488 - ABSENT: Repo doesn't exist here at all.
Chris@1706 489
Chris@1706 490 Valid states for pinned libraries:
Chris@1706 491
Chris@1706 492 - CORRECT: We are at the pinned revision.
Chris@1706 493
Chris@1706 494 - WRONG: We are at any revision other than the pinned one.
Chris@1706 495
Chris@1706 496 - ABSENT: Repo doesn't exist here at all.
Chris@1706 497 *)
Chris@1706 498
Chris@1740 499 fun check with_network context
Chris@1752 500 ({ libname, source, branch,
Chris@1752 501 project_pin, lock_pin, ... } : libspec) =
Chris@1706 502 let fun check_unpinned () =
Chris@1752 503 let val newest =
Chris@1752 504 if with_network
Chris@1752 505 then V.is_newest context (libname, source, branch)
Chris@1752 506 else V.is_newest_locally context (libname, branch)
Chris@1706 507 in
Chris@1752 508 case newest of
Chris@1706 509 ERROR e => ERROR e
Chris@1706 510 | OK true => OK CORRECT
Chris@1706 511 | OK false =>
Chris@1706 512 case V.is_on_branch context (libname, branch) of
Chris@1706 513 ERROR e => ERROR e
Chris@1706 514 | OK true => OK SUPERSEDED
Chris@1706 515 | OK false => OK WRONG
Chris@1706 516 end
Chris@1706 517 fun check_pinned target =
Chris@1706 518 case V.is_at context (libname, target) of
Chris@1706 519 ERROR e => ERROR e
Chris@1706 520 | OK true => OK CORRECT
Chris@1706 521 | OK false => OK WRONG
Chris@1740 522 fun check_remote () =
Chris@1740 523 case project_pin of
Chris@1706 524 UNPINNED => check_unpinned ()
Chris@1706 525 | PINNED target => check_pinned target
Chris@1740 526 fun check_local () =
Chris@1740 527 case V.is_modified_locally context libname of
Chris@1740 528 ERROR e => ERROR e
Chris@1740 529 | OK true => OK MODIFIED
Chris@1740 530 | OK false =>
Chris@1740 531 case lock_pin of
Chris@1740 532 UNPINNED => OK CLEAN
Chris@1740 533 | PINNED target =>
Chris@1740 534 case V.is_at context (libname, target) of
Chris@1740 535 ERROR e => ERROR e
Chris@1740 536 | OK true => OK CLEAN
Chris@1740 537 | OK false => OK LOCK_MISMATCHED
Chris@1706 538 in
Chris@1706 539 case V.exists context libname of
Chris@1706 540 ERROR e => ERROR e
Chris@1740 541 | OK false => OK (ABSENT, CLEAN)
Chris@1706 542 | OK true =>
Chris@1740 543 case (check_remote (), check_local ()) of
Chris@1706 544 (ERROR e, _) => ERROR e
Chris@1706 545 | (_, ERROR e) => ERROR e
Chris@1740 546 | (OK r, OK l) => OK (r, l)
Chris@1706 547 end
Chris@1706 548
Chris@1706 549 val review = check true
Chris@1706 550 val status = check false
Chris@1740 551
Chris@1740 552 fun update context
Chris@1740 553 ({ libname, source, branch,
Chris@1740 554 project_pin, lock_pin, ... } : libspec) =
Chris@1706 555 let fun update_unpinned () =
Chris@1752 556 case V.is_newest context (libname, source, branch) of
Chris@1706 557 ERROR e => ERROR e
Chris@1758 558 | OK true => OK ()
Chris@1752 559 | OK false => V.update context (libname, source, branch)
Chris@1706 560 fun update_pinned target =
Chris@1706 561 case V.is_at context (libname, target) of
Chris@1706 562 ERROR e => ERROR e
Chris@1758 563 | OK true => OK ()
Chris@1752 564 | OK false => V.update_to context (libname, source, target)
Chris@1706 565 fun update' () =
Chris@1740 566 case lock_pin of
Chris@1740 567 PINNED target => update_pinned target
Chris@1740 568 | UNPINNED =>
Chris@1740 569 case project_pin of
Chris@1740 570 PINNED target => update_pinned target
Chris@1740 571 | UNPINNED => update_unpinned ()
Chris@1706 572 in
Chris@1706 573 case V.exists context libname of
Chris@1706 574 ERROR e => ERROR e
Chris@1706 575 | OK true => update' ()
Chris@1706 576 | OK false =>
Chris@1706 577 case V.checkout context (libname, source, branch) of
Chris@1706 578 ERROR e => ERROR e
Chris@1706 579 | OK () => update' ()
Chris@1706 580 end
Chris@1740 581
Chris@1740 582 fun id_of context ({ libname, ... } : libspec) =
Chris@1740 583 V.id_of context libname
Chris@1740 584
Chris@1706 585 end
Chris@1706 586
Chris@1706 587 (* Simple Standard ML JSON parser
Chris@1706 588 https://bitbucket.org/cannam/sml-simplejson
Chris@1761 589 Copyright 2017 Chris Cannam. BSD licence.
Chris@1706 590 Parts based on the JSON parser in the Ponyo library by Phil Eaton.
Chris@1706 591 *)
Chris@1706 592
Chris@1706 593 signature JSON = sig
Chris@1706 594
Chris@1706 595 datatype json = OBJECT of (string * json) list
Chris@1706 596 | ARRAY of json list
Chris@1706 597 | NUMBER of real
Chris@1706 598 | STRING of string
Chris@1706 599 | BOOL of bool
Chris@1706 600 | NULL
Chris@1706 601
Chris@1706 602 datatype 'a result = OK of 'a
Chris@1706 603 | ERROR of string
Chris@1706 604
Chris@1706 605 val parse : string -> json result
Chris@1706 606 val serialise : json -> string
Chris@1706 607 val serialiseIndented : json -> string
Chris@1706 608
Chris@1706 609 end
Chris@1706 610
Chris@1706 611 structure Json :> JSON = struct
Chris@1706 612
Chris@1706 613 datatype json = OBJECT of (string * json) list
Chris@1706 614 | ARRAY of json list
Chris@1706 615 | NUMBER of real
Chris@1706 616 | STRING of string
Chris@1706 617 | BOOL of bool
Chris@1706 618 | NULL
Chris@1706 619
Chris@1706 620 datatype 'a result = OK of 'a
Chris@1706 621 | ERROR of string
Chris@1706 622
Chris@1706 623 structure T = struct
Chris@1706 624 datatype token = NUMBER of char list
Chris@1706 625 | STRING of string
Chris@1706 626 | BOOL of bool
Chris@1706 627 | NULL
Chris@1706 628 | CURLY_L
Chris@1706 629 | CURLY_R
Chris@1706 630 | SQUARE_L
Chris@1706 631 | SQUARE_R
Chris@1706 632 | COLON
Chris@1706 633 | COMMA
Chris@1706 634
Chris@1706 635 fun toString t =
Chris@1706 636 case t of NUMBER digits => implode digits
Chris@1706 637 | STRING s => s
Chris@1706 638 | BOOL b => Bool.toString b
Chris@1706 639 | NULL => "null"
Chris@1706 640 | CURLY_L => "{"
Chris@1706 641 | CURLY_R => "}"
Chris@1706 642 | SQUARE_L => "["
Chris@1706 643 | SQUARE_R => "]"
Chris@1706 644 | COLON => ":"
Chris@1706 645 | COMMA => ","
Chris@1706 646 end
Chris@1706 647
Chris@1706 648 fun bmpToUtf8 cp = (* convert a codepoint in Unicode BMP to utf8 bytes *)
Chris@1706 649 let open Word
Chris@1706 650 infix 6 orb andb >>
Chris@1706 651 in
Chris@1706 652 map (Char.chr o toInt)
Chris@1706 653 (if cp < 0wx80 then
Chris@1706 654 [cp]
Chris@1706 655 else if cp < 0wx800 then
Chris@1706 656 [0wxc0 orb (cp >> 0w6), 0wx80 orb (cp andb 0wx3f)]
Chris@1706 657 else if cp < 0wx10000 then
Chris@1706 658 [0wxe0 orb (cp >> 0w12),
Chris@1706 659 0wx80 orb ((cp >> 0w6) andb 0wx3f),
Chris@1706 660 0wx80 orb (cp andb 0wx3f)]
Chris@1706 661 else raise Fail ("Invalid BMP point " ^ (Word.toString cp)))
Chris@1706 662 end
Chris@1706 663
Chris@1706 664 fun error pos text = ERROR (text ^ " at character position " ^
Chris@1706 665 Int.toString (pos - 1))
Chris@1706 666 fun token_error pos = error pos ("Unexpected token")
Chris@1706 667
Chris@1706 668 fun lexNull pos acc (#"u" :: #"l" :: #"l" :: xs) =
Chris@1706 669 lex (pos + 3) (T.NULL :: acc) xs
Chris@1706 670 | lexNull pos acc _ = token_error pos
Chris@1706 671
Chris@1706 672 and lexTrue pos acc (#"r" :: #"u" :: #"e" :: xs) =
Chris@1706 673 lex (pos + 3) (T.BOOL true :: acc) xs
Chris@1706 674 | lexTrue pos acc _ = token_error pos
Chris@1706 675
Chris@1706 676 and lexFalse pos acc (#"a" :: #"l" :: #"s" :: #"e" :: xs) =
Chris@1706 677 lex (pos + 4) (T.BOOL false :: acc) xs
Chris@1706 678 | lexFalse pos acc _ = token_error pos
Chris@1706 679
Chris@1706 680 and lexChar tok pos acc xs =
Chris@1706 681 lex pos (tok :: acc) xs
Chris@1706 682
Chris@1706 683 and lexString pos acc cc =
Chris@1706 684 let datatype escaped = ESCAPED | NORMAL
Chris@1706 685 fun lexString' pos text ESCAPED [] =
Chris@1706 686 error pos "End of input during escape sequence"
Chris@1706 687 | lexString' pos text NORMAL [] =
Chris@1706 688 error pos "End of input during string"
Chris@1706 689 | lexString' pos text ESCAPED (x :: xs) =
Chris@1706 690 let fun esc c = lexString' (pos + 1) (c :: text) NORMAL xs
Chris@1706 691 in case x of
Chris@1706 692 #"\"" => esc x
Chris@1706 693 | #"\\" => esc x
Chris@1706 694 | #"/" => esc x
Chris@1706 695 | #"b" => esc #"\b"
Chris@1706 696 | #"f" => esc #"\f"
Chris@1706 697 | #"n" => esc #"\n"
Chris@1706 698 | #"r" => esc #"\r"
Chris@1706 699 | #"t" => esc #"\t"
Chris@1706 700 | _ => error pos ("Invalid escape \\" ^
Chris@1706 701 Char.toString x)
Chris@1706 702 end
Chris@1706 703 | lexString' pos text NORMAL (#"\\" :: #"u" ::a::b::c::d:: xs) =
Chris@1706 704 if List.all Char.isHexDigit [a,b,c,d]
Chris@1706 705 then case Word.fromString ("0wx" ^ (implode [a,b,c,d])) of
Chris@1706 706 SOME w => (let val utf = rev (bmpToUtf8 w) in
Chris@1706 707 lexString' (pos + 6) (utf @ text)
Chris@1706 708 NORMAL xs
Chris@1706 709 end
Chris@1706 710 handle Fail err => error pos err)
Chris@1706 711 | NONE => error pos "Invalid Unicode BMP escape sequence"
Chris@1706 712 else error pos "Invalid Unicode BMP escape sequence"
Chris@1706 713 | lexString' pos text NORMAL (x :: xs) =
Chris@1706 714 if Char.ord x < 0x20
Chris@1706 715 then error pos "Invalid unescaped control character"
Chris@1706 716 else
Chris@1706 717 case x of
Chris@1706 718 #"\"" => OK (rev text, xs, pos + 1)
Chris@1706 719 | #"\\" => lexString' (pos + 1) text ESCAPED xs
Chris@1706 720 | _ => lexString' (pos + 1) (x :: text) NORMAL xs
Chris@1706 721 in
Chris@1706 722 case lexString' pos [] NORMAL cc of
Chris@1706 723 OK (text, rest, newpos) =>
Chris@1706 724 lex newpos (T.STRING (implode text) :: acc) rest
Chris@1706 725 | ERROR e => ERROR e
Chris@1706 726 end
Chris@1706 727
Chris@1706 728 and lexNumber firstChar pos acc cc =
Chris@1706 729 let val valid = explode ".+-e"
Chris@1706 730 fun lexNumber' pos digits [] = (rev digits, [], pos)
Chris@1706 731 | lexNumber' pos digits (x :: xs) =
Chris@1706 732 if x = #"E" then lexNumber' (pos + 1) (#"e" :: digits) xs
Chris@1706 733 else if Char.isDigit x orelse List.exists (fn c => x = c) valid
Chris@1706 734 then lexNumber' (pos + 1) (x :: digits) xs
Chris@1706 735 else (rev digits, x :: xs, pos)
Chris@1706 736 val (digits, rest, newpos) =
Chris@1706 737 lexNumber' (pos - 1) [] (firstChar :: cc)
Chris@1706 738 in
Chris@1706 739 case digits of
Chris@1706 740 [] => token_error pos
Chris@1706 741 | _ => lex newpos (T.NUMBER digits :: acc) rest
Chris@1706 742 end
Chris@1706 743
Chris@1706 744 and lex pos acc [] = OK (rev acc)
Chris@1706 745 | lex pos acc (x::xs) =
Chris@1706 746 (case x of
Chris@1706 747 #" " => lex
Chris@1706 748 | #"\t" => lex
Chris@1706 749 | #"\n" => lex
Chris@1706 750 | #"\r" => lex
Chris@1706 751 | #"{" => lexChar T.CURLY_L
Chris@1706 752 | #"}" => lexChar T.CURLY_R
Chris@1706 753 | #"[" => lexChar T.SQUARE_L
Chris@1706 754 | #"]" => lexChar T.SQUARE_R
Chris@1706 755 | #":" => lexChar T.COLON
Chris@1706 756 | #"," => lexChar T.COMMA
Chris@1706 757 | #"\"" => lexString
Chris@1706 758 | #"t" => lexTrue
Chris@1706 759 | #"f" => lexFalse
Chris@1706 760 | #"n" => lexNull
Chris@1706 761 | x => lexNumber x) (pos + 1) acc xs
Chris@1706 762
Chris@1706 763 fun show [] = "end of input"
Chris@1706 764 | show (tok :: _) = T.toString tok
Chris@1706 765
Chris@1706 766 fun parseNumber digits =
Chris@1706 767 (* Note lexNumber already case-insensitised the E for us *)
Chris@1706 768 let open Char
Chris@1706 769
Chris@1706 770 fun okExpDigits [] = false
Chris@1706 771 | okExpDigits (c :: []) = isDigit c
Chris@1706 772 | okExpDigits (c :: cs) = isDigit c andalso okExpDigits cs
Chris@1706 773
Chris@1706 774 fun okExponent [] = false
Chris@1706 775 | okExponent (#"+" :: cs) = okExpDigits cs
Chris@1706 776 | okExponent (#"-" :: cs) = okExpDigits cs
Chris@1706 777 | okExponent cc = okExpDigits cc
Chris@1706 778
Chris@1706 779 fun okFracTrailing [] = true
Chris@1706 780 | okFracTrailing (c :: cs) =
Chris@1706 781 (isDigit c andalso okFracTrailing cs) orelse
Chris@1706 782 (c = #"e" andalso okExponent cs)
Chris@1706 783
Chris@1706 784 fun okFraction [] = false
Chris@1706 785 | okFraction (c :: cs) =
Chris@1706 786 isDigit c andalso okFracTrailing cs
Chris@1706 787
Chris@1706 788 fun okPosTrailing [] = true
Chris@1706 789 | okPosTrailing (#"." :: cs) = okFraction cs
Chris@1706 790 | okPosTrailing (#"e" :: cs) = okExponent cs
Chris@1706 791 | okPosTrailing (c :: cs) =
Chris@1706 792 isDigit c andalso okPosTrailing cs
Chris@1706 793
Chris@1706 794 fun okPositive [] = false
Chris@1706 795 | okPositive (#"0" :: []) = true
Chris@1706 796 | okPositive (#"0" :: #"." :: cs) = okFraction cs
Chris@1706 797 | okPositive (#"0" :: #"e" :: cs) = okExponent cs
Chris@1706 798 | okPositive (#"0" :: cs) = false
Chris@1706 799 | okPositive (c :: cs) = isDigit c andalso okPosTrailing cs
Chris@1706 800
Chris@1706 801 fun okNumber (#"-" :: cs) = okPositive cs
Chris@1706 802 | okNumber cc = okPositive cc
Chris@1706 803 in
Chris@1706 804 if okNumber digits
Chris@1706 805 then case Real.fromString (implode digits) of
Chris@1706 806 NONE => ERROR "Number out of range"
Chris@1706 807 | SOME r => OK r
Chris@1706 808 else ERROR ("Invalid number \"" ^ (implode digits) ^ "\"")
Chris@1706 809 end
Chris@1706 810
Chris@1706 811 fun parseObject (T.CURLY_R :: xs) = OK (OBJECT [], xs)
Chris@1706 812 | parseObject tokens =
Chris@1706 813 let fun parsePair (T.STRING key :: T.COLON :: xs) =
Chris@1706 814 (case parseTokens xs of
Chris@1706 815 ERROR e => ERROR e
Chris@1706 816 | OK (j, xs) => OK ((key, j), xs))
Chris@1706 817 | parsePair other =
Chris@1706 818 ERROR ("Object key/value pair expected around \"" ^
Chris@1706 819 show other ^ "\"")
Chris@1706 820 fun parseObject' acc [] = ERROR "End of input during object"
Chris@1706 821 | parseObject' acc tokens =
Chris@1706 822 case parsePair tokens of
Chris@1706 823 ERROR e => ERROR e
Chris@1706 824 | OK (pair, T.COMMA :: xs) =>
Chris@1706 825 parseObject' (pair :: acc) xs
Chris@1706 826 | OK (pair, T.CURLY_R :: xs) =>
Chris@1706 827 OK (OBJECT (rev (pair :: acc)), xs)
Chris@1706 828 | OK (_, _) => ERROR "Expected , or } after object element"
Chris@1706 829 in
Chris@1706 830 parseObject' [] tokens
Chris@1706 831 end
Chris@1706 832
Chris@1706 833 and parseArray (T.SQUARE_R :: xs) = OK (ARRAY [], xs)
Chris@1706 834 | parseArray tokens =
Chris@1706 835 let fun parseArray' acc [] = ERROR "End of input during array"
Chris@1706 836 | parseArray' acc tokens =
Chris@1706 837 case parseTokens tokens of
Chris@1706 838 ERROR e => ERROR e
Chris@1706 839 | OK (j, T.COMMA :: xs) => parseArray' (j :: acc) xs
Chris@1706 840 | OK (j, T.SQUARE_R :: xs) => OK (ARRAY (rev (j :: acc)), xs)
Chris@1706 841 | OK (_, _) => ERROR "Expected , or ] after array element"
Chris@1706 842 in
Chris@1706 843 parseArray' [] tokens
Chris@1706 844 end
Chris@1706 845
Chris@1706 846 and parseTokens [] = ERROR "Value expected"
Chris@1706 847 | parseTokens (tok :: xs) =
Chris@1706 848 (case tok of
Chris@1706 849 T.NUMBER d => (case parseNumber d of
Chris@1706 850 OK r => OK (NUMBER r, xs)
Chris@1706 851 | ERROR e => ERROR e)
Chris@1706 852 | T.STRING s => OK (STRING s, xs)
Chris@1706 853 | T.BOOL b => OK (BOOL b, xs)
Chris@1706 854 | T.NULL => OK (NULL, xs)
Chris@1706 855 | T.CURLY_L => parseObject xs
Chris@1706 856 | T.SQUARE_L => parseArray xs
Chris@1706 857 | _ => ERROR ("Unexpected token " ^ T.toString tok ^
Chris@1706 858 " before " ^ show xs))
Chris@1706 859
Chris@1706 860 fun parse str =
Chris@1706 861 case lex 1 [] (explode str) of
Chris@1706 862 ERROR e => ERROR e
Chris@1706 863 | OK tokens => case parseTokens tokens of
Chris@1706 864 OK (value, []) => OK value
Chris@1706 865 | OK (_, _) => ERROR "Extra data after input"
Chris@1706 866 | ERROR e => ERROR e
Chris@1706 867
Chris@1706 868 fun stringEscape s =
Chris@1706 869 let fun esc x = [x, #"\\"]
Chris@1706 870 fun escape' acc [] = rev acc
Chris@1706 871 | escape' acc (x :: xs) =
Chris@1706 872 escape' (case x of
Chris@1706 873 #"\"" => esc x @ acc
Chris@1706 874 | #"\\" => esc x @ acc
Chris@1706 875 | #"\b" => esc #"b" @ acc
Chris@1706 876 | #"\f" => esc #"f" @ acc
Chris@1706 877 | #"\n" => esc #"n" @ acc
Chris@1706 878 | #"\r" => esc #"r" @ acc
Chris@1706 879 | #"\t" => esc #"t" @ acc
Chris@1706 880 | _ =>
Chris@1706 881 let val c = Char.ord x
Chris@1706 882 in
Chris@1706 883 if c < 0x20
Chris@1706 884 then let val hex = Word.toString (Word.fromInt c)
Chris@1706 885 in (rev o explode) (if c < 0x10
Chris@1706 886 then ("\\u000" ^ hex)
Chris@1706 887 else ("\\u00" ^ hex))
Chris@1706 888 end @ acc
Chris@1706 889 else
Chris@1706 890 x :: acc
Chris@1706 891 end)
Chris@1706 892 xs
Chris@1706 893 in
Chris@1706 894 implode (escape' [] (explode s))
Chris@1706 895 end
Chris@1706 896
Chris@1706 897 fun serialise json =
Chris@1706 898 case json of
Chris@1706 899 OBJECT pp => "{" ^ String.concatWith
Chris@1706 900 "," (map (fn (key, value) =>
Chris@1706 901 serialise (STRING key) ^ ":" ^
Chris@1706 902 serialise value) pp) ^
Chris@1706 903 "}"
Chris@1706 904 | ARRAY arr => "[" ^ String.concatWith "," (map serialise arr) ^ "]"
Chris@1706 905 | NUMBER n => implode (map (fn #"~" => #"-" | c => c)
Chris@1706 906 (explode (Real.toString n)))
Chris@1706 907 | STRING s => "\"" ^ stringEscape s ^ "\""
Chris@1706 908 | BOOL b => Bool.toString b
Chris@1706 909 | NULL => "null"
Chris@1706 910
Chris@1706 911 fun serialiseIndented json =
Chris@1706 912 let fun indent 0 = ""
Chris@1706 913 | indent i = " " ^ indent (i - 1)
Chris@1706 914 fun serialiseIndented' i json =
Chris@1706 915 let val ser = serialiseIndented' (i + 1)
Chris@1706 916 in
Chris@1706 917 case json of
Chris@1706 918 OBJECT [] => "{}"
Chris@1706 919 | ARRAY [] => "[]"
Chris@1706 920 | OBJECT pp => "{\n" ^ indent (i + 1) ^
Chris@1706 921 String.concatWith
Chris@1706 922 (",\n" ^ indent (i + 1))
Chris@1706 923 (map (fn (key, value) =>
Chris@1706 924 ser (STRING key) ^ ": " ^
Chris@1706 925 ser value) pp) ^
Chris@1706 926 "\n" ^ indent i ^ "}"
Chris@1706 927 | ARRAY arr => "[\n" ^ indent (i + 1) ^
Chris@1706 928 String.concatWith
Chris@1706 929 (",\n" ^ indent (i + 1))
Chris@1706 930 (map ser arr) ^
Chris@1706 931 "\n" ^ indent i ^ "]"
Chris@1706 932 | other => serialise other
Chris@1706 933 end
Chris@1706 934 in
Chris@1706 935 serialiseIndented' 0 json ^ "\n"
Chris@1706 936 end
Chris@1706 937
Chris@1706 938 end
Chris@1706 939
Chris@1706 940
Chris@1706 941 structure JsonBits :> sig
Chris@1706 942 val load_json_from : string -> Json.json (* filename -> json *)
Chris@1706 943 val save_json_to : string -> Json.json -> unit
Chris@1706 944 val lookup_optional : Json.json -> string list -> Json.json option
Chris@1706 945 val lookup_optional_string : Json.json -> string list -> string option
Chris@1706 946 val lookup_mandatory : Json.json -> string list -> Json.json
Chris@1706 947 val lookup_mandatory_string : Json.json -> string list -> string
Chris@1706 948 end = struct
Chris@1706 949
Chris@1706 950 fun load_json_from filename =
Chris@1706 951 case Json.parse (FileBits.file_contents filename) of
Chris@1706 952 Json.OK json => json
Chris@1706 953 | Json.ERROR e => raise Fail ("Failed to parse file: " ^ e)
Chris@1706 954
Chris@1706 955 fun save_json_to filename json =
Chris@1732 956 (* using binary I/O to avoid ever writing CR/LF line endings *)
Chris@1706 957 let val jstr = Json.serialiseIndented json
Chris@1732 958 val stream = BinIO.openOut filename
Chris@1706 959 in
Chris@1732 960 BinIO.output (stream, Byte.stringToBytes jstr);
Chris@1732 961 BinIO.closeOut stream
Chris@1706 962 end
Chris@1706 963
Chris@1706 964 fun lookup_optional json kk =
Chris@1706 965 let fun lookup key =
Chris@1706 966 case json of
Chris@1706 967 Json.OBJECT kvs =>
Chris@1706 968 (case List.find (fn (k, v) => k = key) kvs of
Chris@1706 969 SOME (k, v) => SOME v
Chris@1706 970 | NONE => NONE)
Chris@1706 971 | _ => raise Fail "Object expected"
Chris@1706 972 in
Chris@1706 973 case kk of
Chris@1706 974 [] => NONE
Chris@1706 975 | key::[] => lookup key
Chris@1706 976 | key::kk => case lookup key of
Chris@1706 977 NONE => NONE
Chris@1706 978 | SOME j => lookup_optional j kk
Chris@1706 979 end
Chris@1706 980
Chris@1706 981 fun lookup_optional_string json kk =
Chris@1706 982 case lookup_optional json kk of
Chris@1706 983 SOME (Json.STRING s) => SOME s
Chris@1706 984 | SOME _ => raise Fail ("Value (if present) must be string: " ^
Chris@1706 985 (String.concatWith " -> " kk))
Chris@1706 986 | NONE => NONE
Chris@1706 987
Chris@1706 988 fun lookup_mandatory json kk =
Chris@1706 989 case lookup_optional json kk of
Chris@1706 990 SOME v => v
Chris@1706 991 | NONE => raise Fail ("Value is mandatory: " ^
Chris@1706 992 (String.concatWith " -> " kk) ^ " in json: " ^
Chris@1706 993 (Json.serialise json))
Chris@1706 994
Chris@1706 995 fun lookup_mandatory_string json kk =
Chris@1706 996 case lookup_optional json kk of
Chris@1706 997 SOME (Json.STRING s) => s
Chris@1706 998 | _ => raise Fail ("Value must be string: " ^
Chris@1706 999 (String.concatWith " -> " kk))
Chris@1706 1000 end
Chris@1706 1001
Chris@1706 1002 structure Provider :> sig
Chris@1706 1003 val load_providers : Json.json -> provider list
Chris@1706 1004 val load_more_providers : provider list -> Json.json -> provider list
Chris@1706 1005 val remote_url : context -> vcs -> source -> libname -> string
Chris@1706 1006 end = struct
Chris@1706 1007
Chris@1706 1008 val known_providers : provider list =
Chris@1706 1009 [ {
Chris@1706 1010 service = "bitbucket",
Chris@1706 1011 supports = [HG, GIT],
Chris@1706 1012 remote_spec = {
Chris@1724 1013 anon = SOME "https://bitbucket.org/{owner}/{repository}",
Chris@1724 1014 auth = SOME "ssh://{vcs}@bitbucket.org/{owner}/{repository}"
Chris@1706 1015 }
Chris@1706 1016 },
Chris@1706 1017 {
Chris@1706 1018 service = "github",
Chris@1706 1019 supports = [GIT],
Chris@1706 1020 remote_spec = {
Chris@1724 1021 anon = SOME "https://github.com/{owner}/{repository}",
Chris@1724 1022 auth = SOME "ssh://{vcs}@github.com/{owner}/{repository}"
Chris@1706 1023 }
Chris@1706 1024 }
Chris@1706 1025 ]
Chris@1706 1026
Chris@1706 1027 fun vcs_name vcs =
Chris@1756 1028 case vcs of HG => "hg"
Chris@1756 1029 | GIT => "git"
Chris@1756 1030 | SVN => "svn"
Chris@1706 1031
Chris@1706 1032 fun vcs_from_name name =
Chris@1756 1033 case name of "hg" => HG
Chris@1756 1034 | "git" => GIT
Chris@1756 1035 | "svn" => SVN
Chris@1706 1036 | other => raise Fail ("Unknown vcs name \"" ^ name ^ "\"")
Chris@1706 1037
Chris@1706 1038 fun load_more_providers previously_loaded json =
Chris@1706 1039 let open JsonBits
Chris@1706 1040 fun load pjson pname : provider =
Chris@1706 1041 {
Chris@1706 1042 service = pname,
Chris@1706 1043 supports =
Chris@1706 1044 case lookup_mandatory pjson ["vcs"] of
Chris@1706 1045 Json.ARRAY vv =>
Chris@1706 1046 map (fn (Json.STRING v) => vcs_from_name v
Chris@1706 1047 | _ => raise Fail "Strings expected in vcs array")
Chris@1706 1048 vv
Chris@1706 1049 | _ => raise Fail "Array expected for vcs",
Chris@1706 1050 remote_spec = {
Chris@1724 1051 anon = lookup_optional_string pjson ["anonymous"],
Chris@1724 1052 auth = lookup_optional_string pjson ["authenticated"]
Chris@1706 1053 }
Chris@1706 1054 }
Chris@1706 1055 val loaded =
Chris@1721 1056 case lookup_optional json ["services"] of
Chris@1706 1057 NONE => []
Chris@1706 1058 | SOME (Json.OBJECT pl) => map (fn (k, v) => load v k) pl
Chris@1721 1059 | _ => raise Fail "Object expected for services in config"
Chris@1706 1060 val newly_loaded =
Chris@1706 1061 List.filter (fn p => not (List.exists (fn pp => #service p =
Chris@1706 1062 #service pp)
Chris@1706 1063 previously_loaded))
Chris@1706 1064 loaded
Chris@1706 1065 in
Chris@1706 1066 previously_loaded @ newly_loaded
Chris@1706 1067 end
Chris@1706 1068
Chris@1706 1069 fun load_providers json =
Chris@1706 1070 load_more_providers known_providers json
Chris@1706 1071
Chris@1706 1072 fun expand_spec spec { vcs, service, owner, repo } login =
Chris@1706 1073 (* ugly *)
Chris@1706 1074 let fun replace str =
Chris@1706 1075 case str of
Chris@1706 1076 "vcs" => vcs_name vcs
Chris@1706 1077 | "service" => service
Chris@1706 1078 | "owner" =>
Chris@1706 1079 (case owner of
Chris@1706 1080 SOME ostr => ostr
Chris@1706 1081 | NONE => raise Fail ("Owner not specified for service " ^
Chris@1706 1082 service))
Chris@1724 1083 | "repository" => repo
Chris@1706 1084 | "account" =>
Chris@1706 1085 (case login of
Chris@1706 1086 SOME acc => acc
Chris@1706 1087 | NONE => raise Fail ("Account not given for service " ^
Chris@1706 1088 service))
Chris@1706 1089 | other => raise Fail ("Unknown variable \"" ^ other ^
Chris@1706 1090 "\" in spec for service " ^ service)
Chris@1706 1091 fun expand' acc sstr =
Chris@1706 1092 case Substring.splitl (fn c => c <> #"{") sstr of
Chris@1706 1093 (pfx, sfx) =>
Chris@1706 1094 if Substring.isEmpty sfx
Chris@1706 1095 then rev (pfx :: acc)
Chris@1706 1096 else
Chris@1706 1097 case Substring.splitl (fn c => c <> #"}") sfx of
Chris@1706 1098 (tok, remainder) =>
Chris@1706 1099 if Substring.isEmpty remainder
Chris@1706 1100 then rev (tok :: pfx :: acc)
Chris@1706 1101 else let val replacement =
Chris@1706 1102 replace
Chris@1706 1103 (* tok begins with "{": *)
Chris@1706 1104 (Substring.string
Chris@1706 1105 (Substring.triml 1 tok))
Chris@1706 1106 in
Chris@1706 1107 expand' (Substring.full replacement ::
Chris@1706 1108 pfx :: acc)
Chris@1706 1109 (* remainder begins with "}": *)
Chris@1706 1110 (Substring.triml 1 remainder)
Chris@1706 1111 end
Chris@1706 1112 in
Chris@1706 1113 Substring.concat (expand' [] (Substring.full spec))
Chris@1706 1114 end
Chris@1706 1115
Chris@1706 1116 fun provider_url req login providers =
Chris@1706 1117 case providers of
Chris@1706 1118 [] => raise Fail ("Unknown service \"" ^ (#service req) ^
Chris@1706 1119 "\" for vcs \"" ^ (vcs_name (#vcs req)) ^ "\"")
Chris@1706 1120 | ({ service, supports, remote_spec : remote_spec } :: rest) =>
Chris@1706 1121 if service <> (#service req) orelse
Chris@1706 1122 not (List.exists (fn v => v = (#vcs req)) supports)
Chris@1706 1123 then provider_url req login rest
Chris@1706 1124 else
Chris@1706 1125 case (login, #auth remote_spec, #anon remote_spec) of
Chris@1706 1126 (SOME _, SOME auth, _) => expand_spec auth req login
Chris@1706 1127 | (SOME _, _, SOME anon) => expand_spec anon req NONE
Chris@1706 1128 | (NONE, _, SOME anon) => expand_spec anon req NONE
Chris@1724 1129 | _ => raise Fail ("No suitable anonymous or authenticated " ^
Chris@1724 1130 "URL spec provided for service \"" ^
Chris@1724 1131 service ^ "\"")
Chris@1706 1132
Chris@1706 1133 fun login_for ({ accounts, ... } : context) service =
Chris@1706 1134 case List.find (fn a => service = #service a) accounts of
Chris@1706 1135 SOME { login, ... } => SOME login
Chris@1706 1136 | NONE => NONE
Chris@1747 1137
Chris@1747 1138 fun reponame_for path =
Chris@1747 1139 case String.tokens (fn c => c = #"/") path of
Chris@1747 1140 [] => raise Fail "Non-empty library path required"
Chris@1747 1141 | toks => hd (rev toks)
Chris@1747 1142
Chris@1706 1143 fun remote_url (context : context) vcs source libname =
Chris@1706 1144 case source of
Chris@1721 1145 URL_SOURCE u => u
Chris@1721 1146 | SERVICE_SOURCE { service, owner, repo } =>
Chris@1706 1147 provider_url { vcs = vcs,
Chris@1706 1148 service = service,
Chris@1706 1149 owner = owner,
Chris@1706 1150 repo = case repo of
Chris@1706 1151 SOME r => r
Chris@1747 1152 | NONE => reponame_for libname }
Chris@1706 1153 (login_for context service)
Chris@1706 1154 (#providers context)
Chris@1706 1155 end
Chris@1706 1156
Chris@1706 1157 structure HgControl :> VCS_CONTROL = struct
Chris@1752 1158
Chris@1752 1159 (* Pulls always use an explicit URL, never just the default
Chris@1752 1160 remote, in order to ensure we update properly if the location
Chris@1752 1161 given in the project file changes. *)
Chris@1752 1162
Chris@1706 1163 type vcsstate = { id: string, modified: bool,
Chris@1706 1164 branch: string, tags: string list }
Chris@1706 1165
Chris@1756 1166 val hg_args = [ "--config", "ui.interactive=true",
Chris@1756 1167 "--config", "ui.merge=:merge" ]
Chris@1706 1168
Chris@1706 1169 fun hg_command context libname args =
Chris@1706 1170 FileBits.command context libname ("hg" :: hg_args @ args)
Chris@1706 1171
Chris@1706 1172 fun hg_command_output context libname args =
Chris@1706 1173 FileBits.command_output context libname ("hg" :: hg_args @ args)
Chris@1706 1174
Chris@1706 1175 fun exists context libname =
Chris@1706 1176 OK (OS.FileSys.isDir (FileBits.subpath context libname ".hg"))
Chris@1706 1177 handle _ => OK false
Chris@1706 1178
Chris@1706 1179 fun remote_for context (libname, source) =
Chris@1706 1180 Provider.remote_url context HG source libname
Chris@1706 1181
Chris@1706 1182 fun current_state context libname : vcsstate result =
Chris@1706 1183 let fun is_branch text = text <> "" andalso #"(" = hd (explode text)
Chris@1706 1184 and extract_branch b =
Chris@1706 1185 if is_branch b (* need to remove enclosing parens *)
Chris@1706 1186 then (implode o rev o tl o rev o tl o explode) b
Chris@1706 1187 else "default"
Chris@1706 1188 and is_modified id = id <> "" andalso #"+" = hd (rev (explode id))
Chris@1706 1189 and extract_id id =
Chris@1706 1190 if is_modified id (* need to remove trailing "+" *)
Chris@1706 1191 then (implode o rev o tl o rev o explode) id
Chris@1706 1192 else id
Chris@1706 1193 and split_tags tags = String.tokens (fn c => c = #"/") tags
Chris@1706 1194 and state_for (id, branch, tags) =
Chris@1706 1195 OK { id = extract_id id,
Chris@1706 1196 modified = is_modified id,
Chris@1706 1197 branch = extract_branch branch,
Chris@1706 1198 tags = split_tags tags }
Chris@1706 1199 in
Chris@1706 1200 case hg_command_output context libname ["id"] of
Chris@1706 1201 ERROR e => ERROR e
Chris@1706 1202 | OK out =>
Chris@1706 1203 case String.tokens (fn x => x = #" ") out of
Chris@1706 1204 [id, branch, tags] => state_for (id, branch, tags)
Chris@1706 1205 | [id, other] => if is_branch other
Chris@1706 1206 then state_for (id, other, "")
Chris@1706 1207 else state_for (id, "", other)
Chris@1706 1208 | [id] => state_for (id, "", "")
Chris@1706 1209 | _ => ERROR ("Unexpected output from hg id: " ^ out)
Chris@1706 1210 end
Chris@1706 1211
Chris@1706 1212 fun branch_name branch = case branch of
Chris@1706 1213 DEFAULT_BRANCH => "default"
Chris@1706 1214 | BRANCH "" => "default"
Chris@1706 1215 | BRANCH b => b
Chris@1706 1216
Chris@1706 1217 fun id_of context libname =
Chris@1706 1218 case current_state context libname of
Chris@1706 1219 ERROR e => ERROR e
Chris@1706 1220 | OK { id, ... } => OK id
Chris@1706 1221
Chris@1706 1222 fun is_at context (libname, id_or_tag) =
Chris@1706 1223 case current_state context libname of
Chris@1706 1224 ERROR e => ERROR e
Chris@1706 1225 | OK { id, tags, ... } =>
Chris@1706 1226 OK (String.isPrefix id_or_tag id orelse
Chris@1706 1227 String.isPrefix id id_or_tag orelse
Chris@1706 1228 List.exists (fn t => t = id_or_tag) tags)
Chris@1706 1229
Chris@1706 1230 fun is_on_branch context (libname, b) =
Chris@1706 1231 case current_state context libname of
Chris@1706 1232 ERROR e => ERROR e
Chris@1706 1233 | OK { branch, ... } => OK (branch = branch_name b)
Chris@1706 1234
Chris@1706 1235 fun is_newest_locally context (libname, branch) =
Chris@1706 1236 case hg_command_output context libname
Chris@1706 1237 ["log", "-l1",
Chris@1706 1238 "-b", branch_name branch,
Chris@1706 1239 "--template", "{node}"] of
Chris@1752 1240 ERROR e => OK false (* desired branch does not exist *)
Chris@1706 1241 | OK newest_in_repo => is_at context (libname, newest_in_repo)
Chris@1706 1242
Chris@1752 1243 fun pull context (libname, source) =
Chris@1752 1244 let val url = remote_for context (libname, source)
Chris@1752 1245 in
Chris@1752 1246 hg_command context libname
Chris@1752 1247 (if FileBits.verbose ()
Chris@1752 1248 then ["pull", url]
Chris@1752 1249 else ["pull", "-q", url])
Chris@1752 1250 end
Chris@1706 1251
Chris@1752 1252 fun is_newest context (libname, source, branch) =
Chris@1706 1253 case is_newest_locally context (libname, branch) of
Chris@1706 1254 ERROR e => ERROR e
Chris@1706 1255 | OK false => OK false
Chris@1706 1256 | OK true =>
Chris@1752 1257 case pull context (libname, source) of
Chris@1706 1258 ERROR e => ERROR e
Chris@1706 1259 | _ => is_newest_locally context (libname, branch)
Chris@1706 1260
Chris@1706 1261 fun is_modified_locally context libname =
Chris@1706 1262 case current_state context libname of
Chris@1706 1263 ERROR e => ERROR e
Chris@1706 1264 | OK { modified, ... } => OK modified
Chris@1706 1265
Chris@1706 1266 fun checkout context (libname, source, branch) =
Chris@1706 1267 let val url = remote_for context (libname, source)
Chris@1706 1268 in
Chris@1747 1269 (* make the lib dir rather than just the ext dir, since
Chris@1747 1270 the lib dir might be nested and hg will happily check
Chris@1747 1271 out into an existing empty dir anyway *)
Chris@1747 1272 case FileBits.mkpath (FileBits.libpath context libname) of
Chris@1706 1273 ERROR e => ERROR e
Chris@1706 1274 | _ => hg_command context ""
Chris@1706 1275 ["clone", "-u", branch_name branch,
Chris@1706 1276 url, libname]
Chris@1706 1277 end
Chris@1706 1278
Chris@1752 1279 fun update context (libname, source, branch) =
Chris@1752 1280 let val pull_result = pull context (libname, source)
Chris@1706 1281 in
Chris@1706 1282 case hg_command context libname ["update", branch_name branch] of
Chris@1706 1283 ERROR e => ERROR e
Chris@1706 1284 | _ =>
Chris@1706 1285 case pull_result of
Chris@1706 1286 ERROR e => ERROR e
Chris@1758 1287 | _ => OK ()
Chris@1706 1288 end
Chris@1706 1289
Chris@1752 1290 fun update_to context (libname, _, "") =
Chris@1706 1291 ERROR "Non-empty id (tag or revision id) required for update_to"
Chris@1752 1292 | update_to context (libname, source, id) =
Chris@1752 1293 let val pull_result = pull context (libname, source)
Chris@1723 1294 in
Chris@1723 1295 case hg_command context libname ["update", "-r", id] of
Chris@1758 1296 OK _ => OK ()
Chris@1723 1297 | ERROR e =>
Chris@1723 1298 case pull_result of
Chris@1723 1299 ERROR e' => ERROR e' (* this was the ur-error *)
Chris@1723 1300 | _ => ERROR e
Chris@1723 1301 end
Chris@1756 1302
Chris@1756 1303 fun copy_url_for context libname =
Chris@1756 1304 OK (FileBits.file_url (FileBits.libpath context libname))
Chris@1756 1305
Chris@1706 1306 end
Chris@1706 1307
Chris@1706 1308 structure GitControl :> VCS_CONTROL = struct
Chris@1706 1309
Chris@1706 1310 (* With Git repos we always operate in detached HEAD state. Even
Chris@1752 1311 the master branch is checked out using a remote reference
Chris@1752 1312 (vext/master). The remote we use is always named vext, and we
Chris@1752 1313 update it to the expected URL each time we fetch, in order to
Chris@1752 1314 ensure we update properly if the location given in the project
Chris@1752 1315 file changes. The origin remote is unused. *)
Chris@1706 1316
Chris@1706 1317 fun git_command context libname args =
Chris@1706 1318 FileBits.command context libname ("git" :: args)
Chris@1706 1319
Chris@1706 1320 fun git_command_output context libname args =
Chris@1706 1321 FileBits.command_output context libname ("git" :: args)
Chris@1706 1322
Chris@1706 1323 fun exists context libname =
Chris@1706 1324 OK (OS.FileSys.isDir (FileBits.subpath context libname ".git"))
Chris@1706 1325 handle _ => OK false
Chris@1706 1326
Chris@1706 1327 fun remote_for context (libname, source) =
Chris@1706 1328 Provider.remote_url context GIT source libname
Chris@1706 1329
Chris@1706 1330 fun branch_name branch = case branch of
Chris@1706 1331 DEFAULT_BRANCH => "master"
Chris@1706 1332 | BRANCH "" => "master"
Chris@1706 1333 | BRANCH b => b
Chris@1706 1334
Chris@1752 1335 val our_remote = "vext"
Chris@1752 1336
Chris@1752 1337 fun remote_branch_name branch = our_remote ^ "/" ^ branch_name branch
Chris@1706 1338
Chris@1706 1339 fun checkout context (libname, source, branch) =
Chris@1706 1340 let val url = remote_for context (libname, source)
Chris@1706 1341 in
Chris@1747 1342 (* make the lib dir rather than just the ext dir, since
Chris@1747 1343 the lib dir might be nested and git will happily check
Chris@1747 1344 out into an existing empty dir anyway *)
Chris@1747 1345 case FileBits.mkpath (FileBits.libpath context libname) of
Chris@1706 1346 OK () => git_command context ""
Chris@1752 1347 ["clone", "--origin", our_remote,
Chris@1752 1348 "--branch", branch_name branch,
Chris@1706 1349 url, libname]
Chris@1706 1350 | ERROR e => ERROR e
Chris@1706 1351 end
Chris@1706 1352
Chris@1752 1353 fun add_our_remote context (libname, source) =
Chris@1752 1354 (* When we do the checkout ourselves (above), we add the
Chris@1752 1355 remote at the same time. But if the repo was cloned by
Chris@1752 1356 someone else, we'll need to do it after the fact. Git
Chris@1752 1357 doesn't seem to have a means to add a remote or change its
Chris@1752 1358 url if it already exists; seems we have to do this: *)
Chris@1752 1359 let val url = remote_for context (libname, source)
Chris@1752 1360 in
Chris@1752 1361 case git_command context libname
Chris@1752 1362 ["remote", "set-url", our_remote, url] of
Chris@1752 1363 OK () => OK ()
Chris@1752 1364 | ERROR e => git_command context libname
Chris@1752 1365 ["remote", "add", "-f", our_remote, url]
Chris@1752 1366 end
Chris@1752 1367
Chris@1706 1368 (* NB git rev-parse HEAD shows revision id of current checkout;
Chris@1706 1369 git rev-list -1 <tag> shows revision id of revision with that tag *)
Chris@1706 1370
Chris@1706 1371 fun id_of context libname =
Chris@1706 1372 git_command_output context libname ["rev-parse", "HEAD"]
Chris@1706 1373
Chris@1706 1374 fun is_at context (libname, id_or_tag) =
Chris@1706 1375 case id_of context libname of
Chris@1752 1376 ERROR e => OK false (* HEAD nonexistent, expected in empty repo *)
Chris@1706 1377 | OK id =>
Chris@1706 1378 if String.isPrefix id_or_tag id orelse
Chris@1706 1379 String.isPrefix id id_or_tag
Chris@1706 1380 then OK true
Chris@1706 1381 else
Chris@1706 1382 case git_command_output context libname
Chris@1723 1383 ["show-ref",
Chris@1752 1384 "refs/tags/" ^ id_or_tag,
Chris@1752 1385 "--"] of
Chris@1723 1386 OK "" => OK false
Chris@1723 1387 | ERROR _ => OK false
Chris@1723 1388 | OK s => OK (id = hd (String.tokens (fn c => c = #" ") s))
Chris@1706 1389
Chris@1706 1390 fun branch_tip context (libname, branch) =
Chris@1752 1391 (* We don't have access to the source info or the network
Chris@1752 1392 here, as this is used by status (e.g. via is_on_branch) as
Chris@1752 1393 well as review. It's possible the remote branch won't exist,
Chris@1752 1394 e.g. if the repo was checked out by something other than
Chris@1752 1395 Vext, and if that's the case, we can't add it here; we'll
Chris@1752 1396 just have to fail, since checking against local branches
Chris@1752 1397 instead could produce the wrong result. *)
Chris@1706 1398 git_command_output context libname
Chris@1706 1399 ["rev-list", "-1",
Chris@1752 1400 remote_branch_name branch, "--"]
Chris@1706 1401
Chris@1706 1402 fun is_newest_locally context (libname, branch) =
Chris@1706 1403 case branch_tip context (libname, branch) of
Chris@1752 1404 ERROR e => OK false
Chris@1706 1405 | OK rev => is_at context (libname, rev)
Chris@1706 1406
Chris@1706 1407 fun is_on_branch context (libname, branch) =
Chris@1706 1408 case branch_tip context (libname, branch) of
Chris@1752 1409 ERROR e => OK false
Chris@1706 1410 | OK rev =>
Chris@1706 1411 case is_at context (libname, rev) of
Chris@1706 1412 ERROR e => ERROR e
Chris@1706 1413 | OK true => OK true
Chris@1706 1414 | OK false =>
Chris@1706 1415 case git_command context libname
Chris@1706 1416 ["merge-base", "--is-ancestor",
Chris@1706 1417 "HEAD", remote_branch_name branch] of
Chris@1706 1418 ERROR e => OK false (* cmd returns non-zero for no *)
Chris@1706 1419 | _ => OK true
Chris@1706 1420
Chris@1752 1421 fun fetch context (libname, source) =
Chris@1752 1422 case add_our_remote context (libname, source) of
Chris@1706 1423 ERROR e => ERROR e
Chris@1752 1424 | _ => git_command context libname ["fetch", our_remote]
Chris@1752 1425
Chris@1752 1426 fun is_newest context (libname, source, branch) =
Chris@1752 1427 case add_our_remote context (libname, source) of
Chris@1752 1428 ERROR e => ERROR e
Chris@1752 1429 | OK () =>
Chris@1752 1430 case is_newest_locally context (libname, branch) of
Chris@1706 1431 ERROR e => ERROR e
Chris@1752 1432 | OK false => OK false
Chris@1752 1433 | OK true =>
Chris@1752 1434 case fetch context (libname, source) of
Chris@1752 1435 ERROR e => ERROR e
Chris@1752 1436 | _ => is_newest_locally context (libname, branch)
Chris@1706 1437
Chris@1706 1438 fun is_modified_locally context libname =
Chris@1706 1439 case git_command_output context libname ["status", "--porcelain"] of
Chris@1706 1440 ERROR e => ERROR e
Chris@1706 1441 | OK "" => OK false
Chris@1706 1442 | OK _ => OK true
Chris@1706 1443
Chris@1706 1444 (* This function updates to the latest revision on a branch rather
Chris@1706 1445 than to a specific id or tag. We can't just checkout the given
Chris@1706 1446 branch, as that will succeed even if the branch isn't up to
Chris@1706 1447 date. We could checkout the branch and then fetch and merge,
Chris@1706 1448 but it's perhaps cleaner not to maintain a local branch at all,
Chris@1706 1449 but instead checkout the remote branch as a detached head. *)
Chris@1706 1450
Chris@1752 1451 fun update context (libname, source, branch) =
Chris@1752 1452 case fetch context (libname, source) of
Chris@1706 1453 ERROR e => ERROR e
Chris@1706 1454 | _ =>
Chris@1706 1455 case git_command context libname ["checkout", "--detach",
Chris@1706 1456 remote_branch_name branch] of
Chris@1706 1457 ERROR e => ERROR e
Chris@1758 1458 | _ => OK ()
Chris@1706 1459
Chris@1706 1460 (* This function is dealing with a specific id or tag, so if we
Chris@1723 1461 can successfully check it out (detached) then that's all we
Chris@1723 1462 need to do, regardless of whether fetch succeeded or not. We do
Chris@1723 1463 attempt the fetch first, though, purely in order to avoid ugly
Chris@1723 1464 error messages in the common case where we're being asked to
Chris@1723 1465 update to a new pin (from the lock file) that hasn't been
Chris@1723 1466 fetched yet. *)
Chris@1706 1467
Chris@1752 1468 fun update_to context (libname, _, "") =
Chris@1706 1469 ERROR "Non-empty id (tag or revision id) required for update_to"
Chris@1752 1470 | update_to context (libname, source, id) =
Chris@1752 1471 let val fetch_result = fetch context (libname, source)
Chris@1723 1472 in
Chris@1723 1473 case git_command context libname ["checkout", "--detach", id] of
Chris@1758 1474 OK _ => OK ()
Chris@1723 1475 | ERROR e =>
Chris@1723 1476 case fetch_result of
Chris@1723 1477 ERROR e' => ERROR e' (* this was the ur-error *)
Chris@1723 1478 | _ => ERROR e
Chris@1723 1479 end
Chris@1756 1480
Chris@1756 1481 fun copy_url_for context libname =
Chris@1756 1482 OK (FileBits.file_url (FileBits.libpath context libname))
Chris@1723 1483
Chris@1706 1484 end
Chris@1706 1485
Chris@1761 1486 (* SubXml - A parser for a subset of XML
Chris@1761 1487 https://bitbucket.org/cannam/sml-simplexml
Chris@1761 1488 Copyright 2018 Chris Cannam. BSD licence.
Chris@1761 1489 *)
Chris@1761 1490
Chris@1761 1491 signature SUBXML = sig
Chris@1761 1492
Chris@1761 1493 datatype node = ELEMENT of { name : string, children : node list }
Chris@1761 1494 | ATTRIBUTE of { name : string, value : string }
Chris@1761 1495 | TEXT of string
Chris@1761 1496 | CDATA of string
Chris@1761 1497 | COMMENT of string
Chris@1761 1498
Chris@1761 1499 datatype document = DOCUMENT of { name : string, children : node list }
Chris@1761 1500
Chris@1761 1501 datatype 'a result = OK of 'a
Chris@1761 1502 | ERROR of string
Chris@1761 1503
Chris@1761 1504 val parse : string -> document result
Chris@1761 1505 val serialise : document -> string
Chris@1761 1506
Chris@1761 1507 end
Chris@1761 1508
Chris@1761 1509 structure SubXml :> SUBXML = struct
Chris@1761 1510
Chris@1761 1511 datatype node = ELEMENT of { name : string, children : node list }
Chris@1761 1512 | ATTRIBUTE of { name : string, value : string }
Chris@1761 1513 | TEXT of string
Chris@1761 1514 | CDATA of string
Chris@1761 1515 | COMMENT of string
Chris@1761 1516
Chris@1761 1517 datatype document = DOCUMENT of { name : string, children : node list }
Chris@1761 1518
Chris@1761 1519 datatype 'a result = OK of 'a
Chris@1761 1520 | ERROR of string
Chris@1761 1521
Chris@1761 1522 structure T = struct
Chris@1761 1523 datatype token = ANGLE_L
Chris@1761 1524 | ANGLE_R
Chris@1761 1525 | ANGLE_SLASH_L
Chris@1761 1526 | SLASH_ANGLE_R
Chris@1761 1527 | EQUAL
Chris@1761 1528 | NAME of string
Chris@1761 1529 | TEXT of string
Chris@1761 1530 | CDATA of string
Chris@1761 1531 | COMMENT of string
Chris@1761 1532
Chris@1761 1533 fun name t =
Chris@1761 1534 case t of ANGLE_L => "<"
Chris@1761 1535 | ANGLE_R => ">"
Chris@1761 1536 | ANGLE_SLASH_L => "</"
Chris@1761 1537 | SLASH_ANGLE_R => "/>"
Chris@1761 1538 | EQUAL => "="
Chris@1761 1539 | NAME s => "name \"" ^ s ^ "\""
Chris@1761 1540 | TEXT s => "text"
Chris@1761 1541 | CDATA _ => "CDATA section"
Chris@1761 1542 | COMMENT _ => "comment"
Chris@1761 1543 end
Chris@1761 1544
Chris@1761 1545 structure Lex :> sig
Chris@1761 1546 val lex : string -> T.token list result
Chris@1761 1547 end = struct
Chris@1761 1548
Chris@1761 1549 fun error pos text =
Chris@1761 1550 ERROR (text ^ " at character position " ^ Int.toString (pos-1))
Chris@1761 1551 fun tokenError pos token =
Chris@1761 1552 error pos ("Unexpected token '" ^ Char.toString token ^ "'")
Chris@1761 1553
Chris@1761 1554 val nameEnd = explode " \t\n\r\"'</>!=?"
Chris@1761 1555
Chris@1761 1556 fun quoted quote pos acc cc =
Chris@1761 1557 let fun quoted' pos text [] =
Chris@1761 1558 error pos "Document ends during quoted string"
Chris@1761 1559 | quoted' pos text (x::xs) =
Chris@1761 1560 if x = quote
Chris@1761 1561 then OK (rev text, xs, pos+1)
Chris@1761 1562 else quoted' (pos+1) (x::text) xs
Chris@1761 1563 in
Chris@1761 1564 case quoted' pos [] cc of
Chris@1761 1565 ERROR e => ERROR e
Chris@1761 1566 | OK (text, rest, newpos) =>
Chris@1761 1567 inside newpos (T.TEXT (implode text) :: acc) rest
Chris@1761 1568 end
Chris@1761 1569
Chris@1761 1570 and name first pos acc cc =
Chris@1761 1571 let fun name' pos text [] =
Chris@1761 1572 error pos "Document ends during name"
Chris@1761 1573 | name' pos text (x::xs) =
Chris@1761 1574 if List.find (fn c => c = x) nameEnd <> NONE
Chris@1761 1575 then OK (rev text, (x::xs), pos)
Chris@1761 1576 else name' (pos+1) (x::text) xs
Chris@1761 1577 in
Chris@1761 1578 case name' (pos-1) [] (first::cc) of
Chris@1761 1579 ERROR e => ERROR e
Chris@1761 1580 | OK ([], [], pos) => error pos "Document ends before name"
Chris@1761 1581 | OK ([], (x::xs), pos) => tokenError pos x
Chris@1761 1582 | OK (text, rest, pos) =>
Chris@1761 1583 inside pos (T.NAME (implode text) :: acc) rest
Chris@1761 1584 end
Chris@1761 1585
Chris@1761 1586 and comment pos acc cc =
Chris@1761 1587 let fun comment' pos text cc =
Chris@1761 1588 case cc of
Chris@1761 1589 #"-" :: #"-" :: #">" :: xs => OK (rev text, xs, pos+3)
Chris@1761 1590 | x :: xs => comment' (pos+1) (x::text) xs
Chris@1761 1591 | [] => error pos "Document ends during comment"
Chris@1761 1592 in
Chris@1761 1593 case comment' pos [] cc of
Chris@1761 1594 ERROR e => ERROR e
Chris@1761 1595 | OK (text, rest, pos) =>
Chris@1761 1596 outside pos (T.COMMENT (implode text) :: acc) rest
Chris@1761 1597 end
Chris@1761 1598
Chris@1761 1599 and instruction pos acc cc =
Chris@1761 1600 case cc of
Chris@1761 1601 #"?" :: #">" :: xs => outside (pos+2) acc xs
Chris@1761 1602 | #">" :: _ => tokenError pos #">"
Chris@1761 1603 | x :: xs => instruction (pos+1) acc xs
Chris@1761 1604 | [] => error pos "Document ends during processing instruction"
Chris@1761 1605
Chris@1761 1606 and cdata pos acc cc =
Chris@1761 1607 let fun cdata' pos text cc =
Chris@1761 1608 case cc of
Chris@1761 1609 #"]" :: #"]" :: #">" :: xs => OK (rev text, xs, pos+3)
Chris@1761 1610 | x :: xs => cdata' (pos+1) (x::text) xs
Chris@1761 1611 | [] => error pos "Document ends during CDATA section"
Chris@1761 1612 in
Chris@1761 1613 case cdata' pos [] cc of
Chris@1761 1614 ERROR e => ERROR e
Chris@1761 1615 | OK (text, rest, pos) =>
Chris@1761 1616 outside pos (T.CDATA (implode text) :: acc) rest
Chris@1761 1617 end
Chris@1761 1618
Chris@1761 1619 and doctype pos acc cc =
Chris@1761 1620 case cc of
Chris@1761 1621 #">" :: xs => outside (pos+1) acc xs
Chris@1761 1622 | x :: xs => doctype (pos+1) acc xs
Chris@1761 1623 | [] => error pos "Document ends during DOCTYPE"
Chris@1761 1624
Chris@1761 1625 and declaration pos acc cc =
Chris@1761 1626 case cc of
Chris@1761 1627 #"-" :: #"-" :: xs =>
Chris@1761 1628 comment (pos+2) acc xs
Chris@1761 1629 | #"[" :: #"C" :: #"D" :: #"A" :: #"T" :: #"A" :: #"[" :: xs =>
Chris@1761 1630 cdata (pos+7) acc xs
Chris@1761 1631 | #"D" :: #"O" :: #"C" :: #"T" :: #"Y" :: #"P" :: #"E" :: xs =>
Chris@1761 1632 doctype (pos+7) acc xs
Chris@1761 1633 | [] => error pos "Document ends during declaration"
Chris@1761 1634 | _ => error pos "Unsupported declaration type"
Chris@1761 1635
Chris@1761 1636 and left pos acc cc =
Chris@1761 1637 case cc of
Chris@1761 1638 #"/" :: xs => inside (pos+1) (T.ANGLE_SLASH_L :: acc) xs
Chris@1761 1639 | #"!" :: xs => declaration (pos+1) acc xs
Chris@1761 1640 | #"?" :: xs => instruction (pos+1) acc xs
Chris@1761 1641 | xs => inside pos (T.ANGLE_L :: acc) xs
Chris@1761 1642
Chris@1761 1643 and slash pos acc cc =
Chris@1761 1644 case cc of
Chris@1761 1645 #">" :: xs => outside (pos+1) (T.SLASH_ANGLE_R :: acc) xs
Chris@1761 1646 | x :: _ => tokenError pos x
Chris@1761 1647 | [] => error pos "Document ends before element closed"
Chris@1761 1648
Chris@1761 1649 and close pos acc xs = outside pos (T.ANGLE_R :: acc) xs
Chris@1761 1650
Chris@1761 1651 and equal pos acc xs = inside pos (T.EQUAL :: acc) xs
Chris@1761 1652
Chris@1761 1653 and outside pos acc [] = OK acc
Chris@1761 1654 | outside pos acc cc =
Chris@1761 1655 let fun textOf text = T.TEXT (implode (rev text))
Chris@1761 1656 fun outside' pos [] acc [] = OK acc
Chris@1761 1657 | outside' pos text acc [] = OK (textOf text :: acc)
Chris@1761 1658 | outside' pos text acc (x::xs) =
Chris@1761 1659 case x of
Chris@1761 1660 #"<" => if text = []
Chris@1761 1661 then left (pos+1) acc xs
Chris@1761 1662 else left (pos+1) (textOf text :: acc) xs
Chris@1761 1663 | x => outside' (pos+1) (x::text) acc xs
Chris@1761 1664 in
Chris@1761 1665 outside' pos [] acc cc
Chris@1761 1666 end
Chris@1761 1667
Chris@1761 1668 and inside pos acc [] = error pos "Document ends within tag"
Chris@1761 1669 | inside pos acc (#"<"::_) = tokenError pos #"<"
Chris@1761 1670 | inside pos acc (x::xs) =
Chris@1761 1671 (case x of
Chris@1761 1672 #" " => inside | #"\t" => inside
Chris@1761 1673 | #"\n" => inside | #"\r" => inside
Chris@1761 1674 | #"\"" => quoted x | #"'" => quoted x
Chris@1761 1675 | #"/" => slash | #">" => close | #"=" => equal
Chris@1761 1676 | x => name x) (pos+1) acc xs
Chris@1761 1677
Chris@1761 1678 fun lex str =
Chris@1761 1679 case outside 1 [] (explode str) of
Chris@1761 1680 ERROR e => ERROR e
Chris@1761 1681 | OK tokens => OK (rev tokens)
Chris@1761 1682 end
Chris@1761 1683
Chris@1761 1684 structure Parse :> sig
Chris@1761 1685 val parse : string -> document result
Chris@1761 1686 end = struct
Chris@1761 1687
Chris@1761 1688 fun show [] = "end of input"
Chris@1761 1689 | show (tok :: _) = T.name tok
Chris@1761 1690
Chris@1761 1691 fun error toks text = ERROR (text ^ " before " ^ show toks)
Chris@1761 1692
Chris@1761 1693 fun attribute elt name toks =
Chris@1761 1694 case toks of
Chris@1761 1695 T.EQUAL :: T.TEXT value :: xs =>
Chris@1761 1696 namedElement {
Chris@1761 1697 name = #name elt,
Chris@1761 1698 children = ATTRIBUTE { name = name, value = value } ::
Chris@1761 1699 #children elt
Chris@1761 1700 } xs
Chris@1761 1701 | T.EQUAL :: xs => error xs "Expected attribute value"
Chris@1761 1702 | toks => error toks "Expected attribute assignment"
Chris@1761 1703
Chris@1761 1704 and content elt toks =
Chris@1761 1705 case toks of
Chris@1761 1706 T.ANGLE_SLASH_L :: T.NAME n :: T.ANGLE_R :: xs =>
Chris@1761 1707 if n = #name elt
Chris@1761 1708 then OK (elt, xs)
Chris@1761 1709 else ERROR ("Closing tag </" ^ n ^ "> " ^
Chris@1761 1710 "does not match opening <" ^ #name elt ^ ">")
Chris@1761 1711 | T.TEXT text :: xs =>
Chris@1761 1712 content {
Chris@1761 1713 name = #name elt,
Chris@1761 1714 children = TEXT text :: #children elt
Chris@1761 1715 } xs
Chris@1761 1716 | T.CDATA text :: xs =>
Chris@1761 1717 content {
Chris@1761 1718 name = #name elt,
Chris@1761 1719 children = CDATA text :: #children elt
Chris@1761 1720 } xs
Chris@1761 1721 | T.COMMENT text :: xs =>
Chris@1761 1722 content {
Chris@1761 1723 name = #name elt,
Chris@1761 1724 children = COMMENT text :: #children elt
Chris@1761 1725 } xs
Chris@1761 1726 | T.ANGLE_L :: xs =>
Chris@1761 1727 (case element xs of
Chris@1761 1728 ERROR e => ERROR e
Chris@1761 1729 | OK (child, xs) =>
Chris@1761 1730 content {
Chris@1761 1731 name = #name elt,
Chris@1761 1732 children = ELEMENT child :: #children elt
Chris@1761 1733 } xs)
Chris@1761 1734 | tok :: xs =>
Chris@1761 1735 error xs ("Unexpected token " ^ T.name tok)
Chris@1761 1736 | [] =>
Chris@1761 1737 ERROR ("Document ends within element \"" ^ #name elt ^ "\"")
Chris@1761 1738
Chris@1761 1739 and namedElement elt toks =
Chris@1761 1740 case toks of
Chris@1761 1741 T.SLASH_ANGLE_R :: xs => OK (elt, xs)
Chris@1761 1742 | T.NAME name :: xs => attribute elt name xs
Chris@1761 1743 | T.ANGLE_R :: xs => content elt xs
Chris@1761 1744 | x :: xs => error xs ("Unexpected token " ^ T.name x)
Chris@1761 1745 | [] => ERROR "Document ends within opening tag"
Chris@1761 1746
Chris@1761 1747 and element toks =
Chris@1761 1748 case toks of
Chris@1761 1749 T.NAME name :: xs =>
Chris@1761 1750 (case namedElement { name = name, children = [] } xs of
Chris@1761 1751 ERROR e => ERROR e
Chris@1761 1752 | OK ({ name, children }, xs) =>
Chris@1761 1753 OK ({ name = name, children = rev children }, xs))
Chris@1761 1754 | toks => error toks "Expected element name"
Chris@1761 1755
Chris@1761 1756 and document [] = ERROR "Empty document"
Chris@1761 1757 | document (tok :: xs) =
Chris@1761 1758 case tok of
Chris@1761 1759 T.TEXT _ => document xs
Chris@1761 1760 | T.COMMENT _ => document xs
Chris@1761 1761 | T.ANGLE_L =>
Chris@1761 1762 (case element xs of
Chris@1761 1763 ERROR e => ERROR e
Chris@1761 1764 | OK (elt, []) => OK (DOCUMENT elt)
Chris@1761 1765 | OK (elt, (T.TEXT _ :: xs)) => OK (DOCUMENT elt)
Chris@1761 1766 | OK (elt, xs) => error xs "Extra data after document")
Chris@1761 1767 | _ => error xs ("Unexpected token " ^ T.name tok)
Chris@1761 1768
Chris@1761 1769 fun parse str =
Chris@1761 1770 case Lex.lex str of
Chris@1761 1771 ERROR e => ERROR e
Chris@1761 1772 | OK tokens => document tokens
Chris@1761 1773 end
Chris@1761 1774
Chris@1761 1775 structure Serialise :> sig
Chris@1761 1776 val serialise : document -> string
Chris@1761 1777 end = struct
Chris@1761 1778
Chris@1761 1779 fun attributes nodes =
Chris@1761 1780 String.concatWith
Chris@1761 1781 " "
Chris@1761 1782 (map node (List.filter
Chris@1761 1783 (fn ATTRIBUTE _ => true | _ => false)
Chris@1761 1784 nodes))
Chris@1761 1785
Chris@1761 1786 and nonAttributes nodes =
Chris@1761 1787 String.concat
Chris@1761 1788 (map node (List.filter
Chris@1761 1789 (fn ATTRIBUTE _ => false | _ => true)
Chris@1761 1790 nodes))
Chris@1761 1791
Chris@1761 1792 and node n =
Chris@1761 1793 case n of
Chris@1761 1794 TEXT string =>
Chris@1761 1795 string
Chris@1761 1796 | CDATA string =>
Chris@1761 1797 "<![CDATA[" ^ string ^ "]]>"
Chris@1761 1798 | COMMENT string =>
Chris@1761 1799 "<!-- " ^ string ^ "-->"
Chris@1761 1800 | ATTRIBUTE { name, value } =>
Chris@1761 1801 name ^ "=" ^ "\"" ^ value ^ "\"" (*!!!*)
Chris@1761 1802 | ELEMENT { name, children } =>
Chris@1761 1803 "<" ^ name ^
Chris@1761 1804 (case (attributes children) of
Chris@1761 1805 "" => ""
Chris@1761 1806 | s => " " ^ s) ^
Chris@1761 1807 (case (nonAttributes children) of
Chris@1761 1808 "" => "/>"
Chris@1761 1809 | s => ">" ^ s ^ "</" ^ name ^ ">")
Chris@1761 1810
Chris@1761 1811 fun serialise (DOCUMENT { name, children }) =
Chris@1761 1812 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" ^
Chris@1761 1813 node (ELEMENT { name = name, children = children })
Chris@1761 1814 end
Chris@1761 1815
Chris@1761 1816 val parse = Parse.parse
Chris@1761 1817 val serialise = Serialise.serialise
Chris@1761 1818
Chris@1761 1819 end
Chris@1761 1820
Chris@1761 1821
Chris@1756 1822 structure SvnControl :> VCS_CONTROL = struct
Chris@1756 1823
Chris@1756 1824 fun svn_command context libname args =
Chris@1756 1825 FileBits.command context libname ("svn" :: args)
Chris@1756 1826
Chris@1756 1827 fun svn_command_output context libname args =
Chris@1756 1828 FileBits.command_output context libname ("svn" :: args)
Chris@1756 1829
Chris@1756 1830 fun svn_command_lines context libname args =
Chris@1756 1831 case svn_command_output context libname args of
Chris@1756 1832 ERROR e => ERROR e
Chris@1756 1833 | OK s => OK (String.tokens (fn c => c = #"\n" orelse c = #"\r") s)
Chris@1756 1834
Chris@1756 1835 fun split_line_pair line =
Chris@1756 1836 let fun strip_leading_ws str = case explode str of
Chris@1756 1837 #" "::rest => implode rest
Chris@1756 1838 | _ => str
Chris@1756 1839 in
Chris@1756 1840 case String.tokens (fn c => c = #":") line of
Chris@1756 1841 [] => ("", "")
Chris@1756 1842 | first::rest =>
Chris@1756 1843 (first, strip_leading_ws (String.concatWith ":" rest))
Chris@1756 1844 end
Chris@1761 1845
Chris@1761 1846 structure X = SubXml
Chris@1761 1847
Chris@1761 1848 fun svn_info context libname route =
Chris@1761 1849 (* SVN 1.9 has info --show-item which is just what we need,
Chris@1761 1850 but at this point we still have 1.8 on the CI boxes so we
Chris@1761 1851 might as well aim to support it. For that we really have to
Chris@1761 1852 use the XML output format, since the default info output is
Chris@1761 1853 localised. This is the only thing our mini-XML parser is
Chris@1761 1854 used for though, so it would be good to trim it at some
Chris@1761 1855 point *)
Chris@1761 1856 let fun find elt [] = OK elt
Chris@1761 1857 | find { children, ... } (first :: rest) =
Chris@1761 1858 case List.find (fn (X.ELEMENT { name, ... }) => name = first
Chris@1761 1859 | _ => false)
Chris@1761 1860 children of
Chris@1761 1861 NONE => ERROR ("No element \"" ^ first ^ "\" in SVN XML")
Chris@1761 1862 | SOME (X.ELEMENT e) => find e rest
Chris@1761 1863 | SOME _ => ERROR "Internal error"
Chris@1761 1864 in
Chris@1761 1865 case svn_command_output context libname ["info", "--xml"] of
Chris@1761 1866 ERROR e => ERROR e
Chris@1761 1867 | OK xml =>
Chris@1761 1868 case X.parse xml of
Chris@1761 1869 X.ERROR e => ERROR e
Chris@1761 1870 | X.OK (X.DOCUMENT doc) => find doc route
Chris@1761 1871 end
Chris@1756 1872
Chris@1756 1873 fun exists context libname =
Chris@1756 1874 OK (OS.FileSys.isDir (FileBits.subpath context libname ".svn"))
Chris@1756 1875 handle _ => OK false
Chris@1756 1876
Chris@1756 1877 fun remote_for context (libname, source) =
Chris@1756 1878 Provider.remote_url context SVN source libname
Chris@1756 1879
Chris@1761 1880 (* Remote the checkout came from, not necessarily the one we want *)
Chris@1761 1881 fun actual_remote_for context libname =
Chris@1761 1882 case svn_info context libname ["entry", "url"] of
Chris@1761 1883 ERROR e => ERROR e
Chris@1761 1884 | OK { children, ... } =>
Chris@1761 1885 case List.find (fn (X.TEXT _) => true | _ => false) children of
Chris@1761 1886 NONE => ERROR "No content for URL in SVN info XML"
Chris@1761 1887 | SOME (X.TEXT url) => OK url
Chris@1761 1888 | SOME _ => ERROR "Internal error"
Chris@1761 1889
Chris@1756 1890 fun id_of context libname =
Chris@1761 1891 case svn_info context libname ["entry"] of
Chris@1761 1892 ERROR e => ERROR e
Chris@1761 1893 | OK { children, ... } =>
Chris@1761 1894 case List.find
Chris@1761 1895 (fn (X.ATTRIBUTE { name = "revision", ... }) => true
Chris@1761 1896 | _ => false)
Chris@1761 1897 children of
Chris@1761 1898 NONE => ERROR "No revision for entry in SVN info XML"
Chris@1761 1899 | SOME (X.ATTRIBUTE { value, ... }) => OK value
Chris@1761 1900 | SOME _ => ERROR "Internal error"
Chris@1756 1901
Chris@1756 1902 fun is_at context (libname, id_or_tag) =
Chris@1756 1903 case id_of context libname of
Chris@1756 1904 ERROR e => ERROR e
Chris@1756 1905 | OK id => OK (id = id_or_tag)
Chris@1756 1906
Chris@1756 1907 fun is_on_branch context (libname, b) =
Chris@1756 1908 OK (b = DEFAULT_BRANCH)
Chris@1761 1909
Chris@1761 1910 fun check_remote context (libname, source) =
Chris@1761 1911 case (remote_for context (libname, source),
Chris@1761 1912 actual_remote_for context libname) of
Chris@1761 1913 (_, ERROR e) => ERROR e
Chris@1761 1914 | (url, OK actual) =>
Chris@1761 1915 if actual = url
Chris@1761 1916 then OK ()
Chris@1761 1917 else svn_command context libname ["relocate", url]
Chris@1756 1918
Chris@1756 1919 fun is_newest context (libname, source, branch) =
Chris@1761 1920 case check_remote context (libname, source) of
Chris@1756 1921 ERROR e => ERROR e
Chris@1761 1922 | OK () =>
Chris@1761 1923 case svn_command_lines context libname
Chris@1761 1924 ["status", "--show-updates"] of
Chris@1761 1925 ERROR e => ERROR e
Chris@1761 1926 | OK lines =>
Chris@1761 1927 case rev lines of
Chris@1761 1928 [] => ERROR "No result returned for server status"
Chris@1761 1929 | last_line::_ =>
Chris@1761 1930 case rev (String.tokens (fn c => c = #" ") last_line) of
Chris@1761 1931 [] => ERROR "No revision field found in server status"
Chris@1761 1932 | server_id::_ => is_at context (libname, server_id)
Chris@1756 1933
Chris@1756 1934 fun is_newest_locally context (libname, branch) =
Chris@1756 1935 OK true (* no local history *)
Chris@1756 1936
Chris@1756 1937 fun is_modified_locally context libname =
Chris@1756 1938 case svn_command_output context libname ["status"] of
Chris@1756 1939 ERROR e => ERROR e
Chris@1756 1940 | OK "" => OK false
Chris@1756 1941 | OK _ => OK true
Chris@1756 1942
Chris@1756 1943 fun checkout context (libname, source, branch) =
Chris@1756 1944 let val url = remote_for context (libname, source)
Chris@1756 1945 val path = FileBits.libpath context libname
Chris@1756 1946 in
Chris@1756 1947 if FileBits.nonempty_dir_exists path
Chris@1756 1948 then (* Surprisingly, SVN itself has no problem with
Chris@1756 1949 this. But for consistency with other VCSes we
Chris@1756 1950 don't allow it *)
Chris@1756 1951 ERROR ("Refusing checkout to nonempty dir \"" ^ path ^ "\"")
Chris@1756 1952 else
Chris@1756 1953 (* make the lib dir rather than just the ext dir, since
Chris@1756 1954 the lib dir might be nested and svn will happily check
Chris@1756 1955 out into an existing empty dir anyway *)
Chris@1756 1956 case FileBits.mkpath (FileBits.libpath context libname) of
Chris@1756 1957 ERROR e => ERROR e
Chris@1756 1958 | _ => svn_command context "" ["checkout", url, libname]
Chris@1756 1959 end
Chris@1756 1960
Chris@1756 1961 fun update context (libname, source, branch) =
Chris@1761 1962 case check_remote context (libname, source) of
Chris@1756 1963 ERROR e => ERROR e
Chris@1761 1964 | OK () =>
Chris@1761 1965 case svn_command context libname
Chris@1761 1966 ["update", "--accept", "postpone"] of
Chris@1761 1967 ERROR e => ERROR e
Chris@1761 1968 | _ => OK ()
Chris@1756 1969
Chris@1756 1970 fun update_to context (libname, _, "") =
Chris@1756 1971 ERROR "Non-empty id (tag or revision id) required for update_to"
Chris@1756 1972 | update_to context (libname, source, id) =
Chris@1761 1973 case check_remote context (libname, source) of
Chris@1756 1974 ERROR e => ERROR e
Chris@1761 1975 | OK () =>
Chris@1761 1976 case svn_command context libname
Chris@1761 1977 ["update", "-r", id, "--accept", "postpone"] of
Chris@1761 1978 ERROR e => ERROR e
Chris@1761 1979 | OK _ => OK ()
Chris@1756 1980
Chris@1756 1981 fun copy_url_for context libname =
Chris@1761 1982 actual_remote_for context libname
Chris@1756 1983
Chris@1756 1984 end
Chris@1756 1985
Chris@1706 1986 structure AnyLibControl :> LIB_CONTROL = struct
Chris@1706 1987
Chris@1706 1988 structure H = LibControlFn(HgControl)
Chris@1706 1989 structure G = LibControlFn(GitControl)
Chris@1756 1990 structure S = LibControlFn(SvnControl)
Chris@1706 1991
Chris@1706 1992 fun review context (spec as { vcs, ... } : libspec) =
Chris@1756 1993 (fn HG => H.review | GIT => G.review | SVN => S.review) vcs context spec
Chris@1706 1994
Chris@1706 1995 fun status context (spec as { vcs, ... } : libspec) =
Chris@1756 1996 (fn HG => H.status | GIT => G.status | SVN => S.status) vcs context spec
Chris@1706 1997
Chris@1706 1998 fun update context (spec as { vcs, ... } : libspec) =
Chris@1756 1999 (fn HG => H.update | GIT => G.update | SVN => S.update) vcs context spec
Chris@1740 2000
Chris@1740 2001 fun id_of context (spec as { vcs, ... } : libspec) =
Chris@1756 2002 (fn HG => H.id_of | GIT => G.id_of | SVN => S.id_of) vcs context spec
Chris@1756 2003
Chris@1706 2004 end
Chris@1706 2005
Chris@1746 2006
Chris@1746 2007 type exclusions = string list
Chris@1746 2008
Chris@1746 2009 structure Archive :> sig
Chris@1746 2010
Chris@1746 2011 val archive : string * exclusions -> project -> OS.Process.status
Chris@1746 2012
Chris@1746 2013 end = struct
Chris@1746 2014
Chris@1746 2015 (* The idea of "archive" is to replace hg/git archive, which won't
Chris@1746 2016 include files, like the Vext-introduced external libraries,
Chris@1746 2017 that are not under version control with the main repo.
Chris@1746 2018
Chris@1746 2019 The process goes like this:
Chris@1746 2020
Chris@1746 2021 - Make sure we have a target filename from the user, and take
Chris@1746 2022 its basename as our archive directory name
Chris@1746 2023
Chris@1746 2024 - Make an "archive root" subdir of the project repo, named
Chris@1746 2025 typically .vext-archive
Chris@1746 2026
Chris@1746 2027 - Identify the VCS used for the project repo. Note that any
Chris@1746 2028 explicit references to VCS type in this structure are to
Chris@1746 2029 the VCS used for the project (something Vext doesn't
Chris@1746 2030 otherwise care about), not for an individual library
Chris@1746 2031
Chris@1746 2032 - Synthesise a Vext project with the archive root as its
Chris@1746 2033 root path, "." as its extdir, with one library whose
Chris@1746 2034 name is the user-supplied basename and whose explicit
Chris@1746 2035 source URL is the original project root; update that
Chris@1746 2036 project -- thus cloning the original project to a subdir
Chris@1746 2037 of the archive root
Chris@1746 2038
Chris@1746 2039 - Synthesise a Vext project identical to the original one for
Chris@1746 2040 this project, but with the newly-cloned copy as its root
Chris@1746 2041 path; update that project -- thus checking out clean copies
Chris@1746 2042 of the external library dirs
Chris@1746 2043
Chris@1746 2044 - Call out to an archive program to archive up the new copy,
Chris@1746 2045 running e.g.
Chris@1746 2046 tar cvzf project-release.tar.gz \
Chris@1746 2047 --exclude=.hg --exclude=.git project-release
Chris@1746 2048 in the archive root dir
Chris@1746 2049
Chris@1746 2050 - (We also omit the vext-project.json file and any trace of
Chris@1746 2051 Vext. It can't properly be run in a directory where the
Chris@1746 2052 external project folders already exist but their repo history
Chris@1746 2053 does not. End users shouldn't get to see Vext)
Chris@1746 2054
Chris@1746 2055 - Clean up by deleting the new copy
Chris@1746 2056 *)
Chris@1746 2057
Chris@1756 2058 fun project_vcs_id_and_url dir =
Chris@1746 2059 let val context = {
Chris@1746 2060 rootpath = dir,
Chris@1746 2061 extdir = ".",
Chris@1746 2062 providers = [],
Chris@1746 2063 accounts = []
Chris@1746 2064 }
Chris@1746 2065 val vcs_maybe =
Chris@1746 2066 case [HgControl.exists context ".",
Chris@1756 2067 GitControl.exists context ".",
Chris@1756 2068 SvnControl.exists context "."] of
Chris@1756 2069 [OK true, OK false, OK false] => OK HG
Chris@1756 2070 | [OK false, OK true, OK false] => OK GIT
Chris@1756 2071 | [OK false, OK false, OK true] => OK SVN
Chris@1746 2072 | _ => ERROR ("Unable to identify VCS for directory " ^ dir)
Chris@1746 2073 in
Chris@1746 2074 case vcs_maybe of
Chris@1746 2075 ERROR e => ERROR e
Chris@1746 2076 | OK vcs =>
Chris@1756 2077 case (fn HG => HgControl.id_of
Chris@1756 2078 | GIT => GitControl.id_of
Chris@1756 2079 | SVN => SvnControl.id_of)
Chris@1746 2080 vcs context "." of
Chris@1756 2081 ERROR e => ERROR ("Unable to find id of project repo: " ^ e)
Chris@1756 2082 | OK id =>
Chris@1756 2083 case (fn HG => HgControl.copy_url_for
Chris@1756 2084 | GIT => GitControl.copy_url_for
Chris@1756 2085 | SVN => SvnControl.copy_url_for)
Chris@1756 2086 vcs context "." of
Chris@1756 2087 ERROR e => ERROR ("Unable to find URL of project repo: "
Chris@1756 2088 ^ e)
Chris@1756 2089 | OK url => OK (vcs, id, url)
Chris@1746 2090 end
Chris@1746 2091
Chris@1746 2092 fun make_archive_root (context : context) =
Chris@1746 2093 let val path = OS.Path.joinDirFile {
Chris@1746 2094 dir = #rootpath context,
Chris@1746 2095 file = VextFilenames.archive_dir
Chris@1746 2096 }
Chris@1746 2097 in
Chris@1746 2098 case FileBits.mkpath path of
Chris@1746 2099 ERROR e => raise Fail ("Failed to create archive directory \""
Chris@1746 2100 ^ path ^ "\": " ^ e)
Chris@1746 2101 | OK () => path
Chris@1746 2102 end
Chris@1746 2103
Chris@1746 2104 fun archive_path archive_dir target_name =
Chris@1746 2105 OS.Path.joinDirFile {
Chris@1746 2106 dir = archive_dir,
Chris@1746 2107 file = target_name
Chris@1746 2108 }
Chris@1746 2109
Chris@1746 2110 fun check_nonexistent path =
Chris@1746 2111 case SOME (OS.FileSys.fileSize path) handle OS.SysErr _ => NONE of
Chris@1746 2112 NONE => ()
Chris@1746 2113 | _ => raise Fail ("Path " ^ path ^ " exists, not overwriting")
Chris@1746 2114
Chris@1756 2115 fun make_archive_copy target_name (vcs, project_id, source_url)
Chris@1746 2116 ({ context, ... } : project) =
Chris@1746 2117 let val archive_root = make_archive_root context
Chris@1746 2118 val synthetic_context = {
Chris@1746 2119 rootpath = archive_root,
Chris@1746 2120 extdir = ".",
Chris@1746 2121 providers = [],
Chris@1746 2122 accounts = []
Chris@1746 2123 }
Chris@1746 2124 val synthetic_library = {
Chris@1746 2125 libname = target_name,
Chris@1746 2126 vcs = vcs,
Chris@1756 2127 source = URL_SOURCE source_url,
Chris@1746 2128 branch = DEFAULT_BRANCH, (* overridden by pinned id below *)
Chris@1746 2129 project_pin = PINNED project_id,
Chris@1746 2130 lock_pin = PINNED project_id
Chris@1746 2131 }
Chris@1746 2132 val path = archive_path archive_root target_name
Chris@1746 2133 val _ = print ("Cloning original project to " ^ path
Chris@1746 2134 ^ " at revision " ^ project_id ^ "...\n");
Chris@1746 2135 val _ = check_nonexistent path
Chris@1746 2136 in
Chris@1746 2137 case AnyLibControl.update synthetic_context synthetic_library of
Chris@1746 2138 ERROR e => ERROR ("Failed to clone original project to "
Chris@1746 2139 ^ path ^ ": " ^ e)
Chris@1746 2140 | OK _ => OK archive_root
Chris@1746 2141 end
Chris@1746 2142
Chris@1746 2143 fun update_archive archive_root target_name
Chris@1746 2144 (project as { context, ... } : project) =
Chris@1746 2145 let val synthetic_context = {
Chris@1746 2146 rootpath = archive_path archive_root target_name,
Chris@1746 2147 extdir = #extdir context,
Chris@1746 2148 providers = #providers context,
Chris@1746 2149 accounts = #accounts context
Chris@1746 2150 }
Chris@1746 2151 in
Chris@1746 2152 foldl (fn (lib, acc) =>
Chris@1746 2153 case acc of
Chris@1746 2154 ERROR e => ERROR e
Chris@1758 2155 | OK () => AnyLibControl.update synthetic_context lib)
Chris@1758 2156 (OK ())
Chris@1746 2157 (#libs project)
Chris@1746 2158 end
Chris@1746 2159
Chris@1746 2160 datatype packer = TAR
Chris@1746 2161 | TAR_GZ
Chris@1746 2162 | TAR_BZ2
Chris@1746 2163 | TAR_XZ
Chris@1746 2164 (* could add other packers, e.g. zip, if we knew how to
Chris@1746 2165 handle the file omissions etc properly in pack_archive *)
Chris@1746 2166
Chris@1746 2167 fun packer_and_basename path =
Chris@1746 2168 let val extensions = [ (".tar", TAR),
Chris@1746 2169 (".tar.gz", TAR_GZ),
Chris@1746 2170 (".tar.bz2", TAR_BZ2),
Chris@1746 2171 (".tar.xz", TAR_XZ)]
Chris@1746 2172 val filename = OS.Path.file path
Chris@1746 2173 in
Chris@1746 2174 foldl (fn ((ext, packer), acc) =>
Chris@1746 2175 if String.isSuffix ext filename
Chris@1746 2176 then SOME (packer,
Chris@1746 2177 String.substring (filename, 0,
Chris@1746 2178 String.size filename -
Chris@1746 2179 String.size ext))
Chris@1746 2180 else acc)
Chris@1746 2181 NONE
Chris@1746 2182 extensions
Chris@1746 2183 end
Chris@1746 2184
Chris@1746 2185 fun pack_archive archive_root target_name target_path packer exclusions =
Chris@1746 2186 case FileBits.command {
Chris@1746 2187 rootpath = archive_root,
Chris@1746 2188 extdir = ".",
Chris@1746 2189 providers = [],
Chris@1746 2190 accounts = []
Chris@1746 2191 } "" ([
Chris@1746 2192 "tar",
Chris@1746 2193 case packer of
Chris@1746 2194 TAR => "cf"
Chris@1746 2195 | TAR_GZ => "czf"
Chris@1746 2196 | TAR_BZ2 => "cjf"
Chris@1746 2197 | TAR_XZ => "cJf",
Chris@1746 2198 target_path,
Chris@1746 2199 "--exclude=.hg",
Chris@1746 2200 "--exclude=.git",
Chris@1756 2201 "--exclude=.svn",
Chris@1746 2202 "--exclude=vext",
Chris@1746 2203 "--exclude=vext.sml",
Chris@1746 2204 "--exclude=vext.ps1",
Chris@1746 2205 "--exclude=vext.bat",
Chris@1746 2206 "--exclude=vext-project.json",
Chris@1746 2207 "--exclude=vext-lock.json"
Chris@1746 2208 ] @ (map (fn e => "--exclude=" ^ e) exclusions) @
Chris@1746 2209 [ target_name ])
Chris@1746 2210 of
Chris@1746 2211 ERROR e => ERROR e
Chris@1746 2212 | OK _ => FileBits.rmpath (archive_path archive_root target_name)
Chris@1746 2213
Chris@1746 2214 fun archive (target_path, exclusions) (project : project) =
Chris@1746 2215 let val _ = check_nonexistent target_path
Chris@1746 2216 val (packer, name) =
Chris@1746 2217 case packer_and_basename target_path of
Chris@1746 2218 NONE => raise Fail ("Unsupported archive file extension in "
Chris@1746 2219 ^ target_path)
Chris@1746 2220 | SOME pn => pn
Chris@1746 2221 val details =
Chris@1756 2222 case project_vcs_id_and_url (#rootpath (#context project)) of
Chris@1746 2223 ERROR e => raise Fail e
Chris@1746 2224 | OK details => details
Chris@1746 2225 val archive_root =
Chris@1746 2226 case make_archive_copy name details project of
Chris@1746 2227 ERROR e => raise Fail e
Chris@1746 2228 | OK archive_root => archive_root
Chris@1746 2229 val outcome =
Chris@1746 2230 case update_archive archive_root name project of
Chris@1746 2231 ERROR e => ERROR e
Chris@1746 2232 | OK _ =>
Chris@1746 2233 case pack_archive archive_root name
Chris@1746 2234 target_path packer exclusions of
Chris@1746 2235 ERROR e => ERROR e
Chris@1746 2236 | OK _ => OK ()
Chris@1746 2237 in
Chris@1746 2238 case outcome of
Chris@1746 2239 ERROR e => raise Fail e
Chris@1746 2240 | OK () => OS.Process.success
Chris@1746 2241 end
Chris@1746 2242
Chris@1746 2243 end
Chris@1746 2244
Chris@1724 2245 val libobjname = "libraries"
Chris@1724 2246
Chris@1706 2247 fun load_libspec spec_json lock_json libname : libspec =
Chris@1706 2248 let open JsonBits
Chris@1724 2249 val libobj = lookup_mandatory spec_json [libobjname, libname]
Chris@1706 2250 val vcs = lookup_mandatory_string libobj ["vcs"]
Chris@1706 2251 val retrieve = lookup_optional_string libobj
Chris@1706 2252 val service = retrieve ["service"]
Chris@1706 2253 val owner = retrieve ["owner"]
Chris@1706 2254 val repo = retrieve ["repository"]
Chris@1706 2255 val url = retrieve ["url"]
Chris@1706 2256 val branch = retrieve ["branch"]
Chris@1740 2257 val project_pin = case retrieve ["pin"] of
Chris@1740 2258 NONE => UNPINNED
Chris@1740 2259 | SOME p => PINNED p
Chris@1724 2260 val lock_pin = case lookup_optional lock_json [libobjname, libname] of
Chris@1740 2261 NONE => UNPINNED
Chris@1740 2262 | SOME ll => case lookup_optional_string ll ["pin"] of
Chris@1740 2263 SOME p => PINNED p
Chris@1740 2264 | NONE => UNPINNED
Chris@1706 2265 in
Chris@1706 2266 {
Chris@1706 2267 libname = libname,
Chris@1706 2268 vcs = case vcs of
Chris@1706 2269 "hg" => HG
Chris@1706 2270 | "git" => GIT
Chris@1756 2271 | "svn" => SVN
Chris@1706 2272 | other => raise Fail ("Unknown version-control system \"" ^
Chris@1706 2273 other ^ "\""),
Chris@1706 2274 source = case (url, service, owner, repo) of
Chris@1721 2275 (SOME u, NONE, _, _) => URL_SOURCE u
Chris@1706 2276 | (NONE, SOME ss, owner, repo) =>
Chris@1721 2277 SERVICE_SOURCE { service = ss, owner = owner, repo = repo }
Chris@1706 2278 | _ => raise Fail ("Must have exactly one of service " ^
Chris@1706 2279 "or url string"),
Chris@1740 2280 project_pin = project_pin,
Chris@1740 2281 lock_pin = lock_pin,
Chris@1706 2282 branch = case branch of
Chris@1756 2283 NONE => DEFAULT_BRANCH
Chris@1756 2284 | SOME b =>
Chris@1756 2285 case vcs of
Chris@1756 2286 "svn" => raise Fail ("Branches not supported for " ^
Chris@1756 2287 "svn repositories; change " ^
Chris@1756 2288 "URL instead")
Chris@1756 2289 | _ => BRANCH b
Chris@1706 2290 }
Chris@1706 2291 end
Chris@1706 2292
Chris@1706 2293 fun load_userconfig () : userconfig =
Chris@1706 2294 let val home = FileBits.homedir ()
Chris@1706 2295 val conf_json =
Chris@1706 2296 JsonBits.load_json_from
Chris@1706 2297 (OS.Path.joinDirFile {
Chris@1706 2298 dir = home,
Chris@1706 2299 file = VextFilenames.user_config_file })
Chris@1706 2300 handle IO.Io _ => Json.OBJECT []
Chris@1706 2301 in
Chris@1706 2302 {
Chris@1706 2303 accounts = case JsonBits.lookup_optional conf_json ["accounts"] of
Chris@1706 2304 NONE => []
Chris@1706 2305 | SOME (Json.OBJECT aa) =>
Chris@1706 2306 map (fn (k, (Json.STRING v)) =>
Chris@1706 2307 { service = k, login = v }
Chris@1706 2308 | _ => raise Fail
Chris@1706 2309 "String expected for account name")
Chris@1706 2310 aa
Chris@1706 2311 | _ => raise Fail "Array expected for accounts",
Chris@1706 2312 providers = Provider.load_providers conf_json
Chris@1706 2313 }
Chris@1706 2314 end
Chris@1706 2315
Chris@1732 2316 datatype pintype =
Chris@1732 2317 NO_LOCKFILE |
Chris@1732 2318 USE_LOCKFILE
Chris@1732 2319
Chris@1732 2320 fun load_project (userconfig : userconfig) rootpath pintype : project =
Chris@1706 2321 let val spec_file = FileBits.project_spec_path rootpath
Chris@1706 2322 val lock_file = FileBits.project_lock_path rootpath
Chris@1706 2323 val _ = if OS.FileSys.access (spec_file, [OS.FileSys.A_READ])
Chris@1706 2324 handle OS.SysErr _ => false
Chris@1706 2325 then ()
Chris@1706 2326 else raise Fail ("Failed to open project spec file " ^
Chris@1706 2327 (VextFilenames.project_file) ^ " in " ^
Chris@1706 2328 rootpath ^
Chris@1706 2329 ".\nPlease ensure the spec file is in the " ^
Chris@1706 2330 "project root and run this from there.")
Chris@1706 2331 val spec_json = JsonBits.load_json_from spec_file
Chris@1732 2332 val lock_json = if pintype = USE_LOCKFILE
Chris@1706 2333 then JsonBits.load_json_from lock_file
Chris@1706 2334 handle IO.Io _ => Json.OBJECT []
Chris@1706 2335 else Json.OBJECT []
Chris@1706 2336 val extdir = JsonBits.lookup_mandatory_string spec_json
Chris@1706 2337 ["config", "extdir"]
Chris@1724 2338 val spec_libs = JsonBits.lookup_optional spec_json [libobjname]
Chris@1724 2339 val lock_libs = JsonBits.lookup_optional lock_json [libobjname]
Chris@1706 2340 val providers = Provider.load_more_providers
Chris@1706 2341 (#providers userconfig) spec_json
Chris@1706 2342 val libnames = case spec_libs of
Chris@1706 2343 NONE => []
Chris@1706 2344 | SOME (Json.OBJECT ll) => map (fn (k, v) => k) ll
Chris@1706 2345 | _ => raise Fail "Object expected for libs"
Chris@1706 2346 in
Chris@1706 2347 {
Chris@1706 2348 context = {
Chris@1706 2349 rootpath = rootpath,
Chris@1706 2350 extdir = extdir,
Chris@1706 2351 providers = providers,
Chris@1706 2352 accounts = #accounts userconfig
Chris@1706 2353 },
Chris@1706 2354 libs = map (load_libspec spec_json lock_json) libnames
Chris@1706 2355 }
Chris@1706 2356 end
Chris@1706 2357
Chris@1706 2358 fun save_lock_file rootpath locks =
Chris@1706 2359 let val lock_file = FileBits.project_lock_path rootpath
Chris@1706 2360 open Json
Chris@1706 2361 val lock_json =
Chris@1706 2362 OBJECT [
Chris@1724 2363 (libobjname,
Chris@1724 2364 OBJECT (map (fn { libname, id_or_tag } =>
Chris@1724 2365 (libname,
Chris@1724 2366 OBJECT [ ("pin", STRING id_or_tag) ]))
Chris@1724 2367 locks))
Chris@1706 2368 ]
Chris@1706 2369 in
Chris@1706 2370 JsonBits.save_json_to lock_file lock_json
Chris@1706 2371 end
Chris@1706 2372
Chris@1706 2373 fun pad_to n str =
Chris@1706 2374 if n <= String.size str then str
Chris@1706 2375 else pad_to n (str ^ " ")
Chris@1706 2376
Chris@1706 2377 fun hline_to 0 = ""
Chris@1706 2378 | hline_to n = "-" ^ hline_to (n-1)
Chris@1706 2379
Chris@1706 2380 val libname_width = 25
Chris@1706 2381 val libstate_width = 11
Chris@1740 2382 val localstate_width = 17
Chris@1706 2383 val notes_width = 5
Chris@1706 2384 val divider = " | "
Chris@1740 2385 val clear_line = "\r" ^ pad_to 80 "";
Chris@1706 2386
Chris@1706 2387 fun print_status_header () =
Chris@1740 2388 print (clear_line ^ "\n " ^
Chris@1706 2389 pad_to libname_width "Library" ^ divider ^
Chris@1706 2390 pad_to libstate_width "State" ^ divider ^
Chris@1706 2391 pad_to localstate_width "Local" ^ divider ^
Chris@1706 2392 "Notes" ^ "\n " ^
Chris@1706 2393 hline_to libname_width ^ "-+-" ^
Chris@1706 2394 hline_to libstate_width ^ "-+-" ^
Chris@1706 2395 hline_to localstate_width ^ "-+-" ^
Chris@1706 2396 hline_to notes_width ^ "\n")
Chris@1706 2397
Chris@1706 2398 fun print_outcome_header () =
Chris@1740 2399 print (clear_line ^ "\n " ^
Chris@1706 2400 pad_to libname_width "Library" ^ divider ^
Chris@1706 2401 pad_to libstate_width "Outcome" ^ divider ^
Chris@1706 2402 "Notes" ^ "\n " ^
Chris@1706 2403 hline_to libname_width ^ "-+-" ^
Chris@1706 2404 hline_to libstate_width ^ "-+-" ^
Chris@1706 2405 hline_to notes_width ^ "\n")
Chris@1706 2406
Chris@1706 2407 fun print_status with_network (libname, status) =
Chris@1706 2408 let val libstate_str =
Chris@1706 2409 case status of
Chris@1706 2410 OK (ABSENT, _) => "Absent"
Chris@1706 2411 | OK (CORRECT, _) => if with_network then "Correct" else "Present"
Chris@1706 2412 | OK (SUPERSEDED, _) => "Superseded"
Chris@1706 2413 | OK (WRONG, _) => "Wrong"
Chris@1706 2414 | ERROR _ => "Error"
Chris@1706 2415 val localstate_str =
Chris@1706 2416 case status of
Chris@1706 2417 OK (_, MODIFIED) => "Modified"
Chris@1740 2418 | OK (_, LOCK_MISMATCHED) => "Differs from Lock"
Chris@1740 2419 | OK (_, CLEAN) => "Clean"
Chris@1740 2420 | ERROR _ => ""
Chris@1706 2421 val error_str =
Chris@1706 2422 case status of
Chris@1706 2423 ERROR e => e
Chris@1706 2424 | _ => ""
Chris@1706 2425 in
Chris@1706 2426 print (" " ^
Chris@1706 2427 pad_to libname_width libname ^ divider ^
Chris@1706 2428 pad_to libstate_width libstate_str ^ divider ^
Chris@1706 2429 pad_to localstate_width localstate_str ^ divider ^
Chris@1706 2430 error_str ^ "\n")
Chris@1706 2431 end
Chris@1706 2432
Chris@1706 2433 fun print_update_outcome (libname, outcome) =
Chris@1706 2434 let val outcome_str =
Chris@1706 2435 case outcome of
Chris@1706 2436 OK id => "Ok"
Chris@1706 2437 | ERROR e => "Failed"
Chris@1706 2438 val error_str =
Chris@1706 2439 case outcome of
Chris@1706 2440 ERROR e => e
Chris@1706 2441 | _ => ""
Chris@1706 2442 in
Chris@1706 2443 print (" " ^
Chris@1706 2444 pad_to libname_width libname ^ divider ^
Chris@1706 2445 pad_to libstate_width outcome_str ^ divider ^
Chris@1706 2446 error_str ^ "\n")
Chris@1706 2447 end
Chris@1706 2448
Chris@1706 2449 fun act_and_print action print_header print_line (libs : libspec list) =
Chris@1706 2450 let val lines = map (fn lib => (#libname lib, action lib)) libs
Chris@1706 2451 val _ = print_header ()
Chris@1706 2452 in
Chris@1706 2453 app print_line lines;
Chris@1706 2454 lines
Chris@1706 2455 end
Chris@1708 2456
Chris@1708 2457 fun return_code_for outcomes =
Chris@1708 2458 foldl (fn ((_, result), acc) =>
Chris@1708 2459 case result of
Chris@1708 2460 ERROR _ => OS.Process.failure
Chris@1708 2461 | _ => acc)
Chris@1708 2462 OS.Process.success
Chris@1708 2463 outcomes
Chris@1706 2464
Chris@1706 2465 fun status_of_project ({ context, libs } : project) =
Chris@1708 2466 return_code_for (act_and_print (AnyLibControl.status context)
Chris@1708 2467 print_status_header (print_status false)
Chris@1708 2468 libs)
Chris@1706 2469
Chris@1706 2470 fun review_project ({ context, libs } : project) =
Chris@1708 2471 return_code_for (act_and_print (AnyLibControl.review context)
Chris@1708 2472 print_status_header (print_status true)
Chris@1708 2473 libs)
Chris@1706 2474
Chris@1740 2475 fun lock_project ({ context, libs } : project) =
Chris@1756 2476 let val _ = if FileBits.verbose ()
Chris@1756 2477 then print ("Scanning IDs for lock file...\n")
Chris@1756 2478 else ()
Chris@1756 2479 val outcomes = map (fn lib =>
Chris@1740 2480 (#libname lib, AnyLibControl.id_of context lib))
Chris@1740 2481 libs
Chris@1740 2482 val locks =
Chris@1740 2483 List.concat
Chris@1740 2484 (map (fn (libname, result) =>
Chris@1740 2485 case result of
Chris@1740 2486 ERROR _ => []
Chris@1740 2487 | OK id => [{ libname = libname, id_or_tag = id }])
Chris@1740 2488 outcomes)
Chris@1740 2489 val return_code = return_code_for outcomes
Chris@1740 2490 val _ = print clear_line
Chris@1740 2491 in
Chris@1740 2492 if OS.Process.isSuccess return_code
Chris@1740 2493 then save_lock_file (#rootpath context) locks
Chris@1740 2494 else ();
Chris@1740 2495 return_code
Chris@1740 2496 end
Chris@1756 2497
Chris@1756 2498 fun update_project (project as { context, libs }) =
Chris@1756 2499 let val outcomes = act_and_print
Chris@1756 2500 (AnyLibControl.update context)
Chris@1756 2501 print_outcome_header print_update_outcome libs
Chris@1756 2502 val _ = if List.exists (fn (_, OK _) => true | _ => false) outcomes
Chris@1756 2503 then lock_project project
Chris@1756 2504 else OS.Process.success
Chris@1756 2505 in
Chris@1756 2506 return_code_for outcomes
Chris@1756 2507 end
Chris@1746 2508
Chris@1732 2509 fun load_local_project pintype =
Chris@1706 2510 let val userconfig = load_userconfig ()
Chris@1706 2511 val rootpath = OS.FileSys.getDir ()
Chris@1706 2512 in
Chris@1732 2513 load_project userconfig rootpath pintype
Chris@1706 2514 end
Chris@1706 2515
Chris@1732 2516 fun with_local_project pintype f =
Chris@1732 2517 let val return_code = f (load_local_project pintype)
Chris@1746 2518 handle e => (print ("Error: " ^ exnMessage e);
Chris@1746 2519 OS.Process.failure)
Chris@1708 2520 val _ = print "\n";
Chris@1708 2521 in
Chris@1708 2522 return_code
Chris@1708 2523 end
Chris@1706 2524
Chris@1740 2525 fun review () = with_local_project USE_LOCKFILE review_project
Chris@1740 2526 fun status () = with_local_project USE_LOCKFILE status_of_project
Chris@1732 2527 fun update () = with_local_project NO_LOCKFILE update_project
Chris@1740 2528 fun lock () = with_local_project NO_LOCKFILE lock_project
Chris@1732 2529 fun install () = with_local_project USE_LOCKFILE update_project
Chris@1706 2530
Chris@1706 2531 fun version () =
Chris@1708 2532 (print ("v" ^ vext_version ^ "\n");
Chris@1708 2533 OS.Process.success)
Chris@1706 2534
Chris@1706 2535 fun usage () =
Chris@1706 2536 (print "\nVext ";
Chris@1706 2537 version ();
Chris@1706 2538 print ("\nA simple manager for third-party source code dependencies.\n\n"
Chris@1706 2539 ^ "Usage:\n\n"
Chris@1706 2540 ^ " vext <command>\n\n"
Chris@1706 2541 ^ "where <command> is one of:\n\n"
Chris@1716 2542 ^ " status print quick report on local status only, without using network\n"
Chris@1706 2543 ^ " review check configured libraries against their providers, and report\n"
Chris@1706 2544 ^ " install update configured libraries according to project specs and lock file\n"
Chris@1706 2545 ^ " update update configured libraries and lock file according to project specs\n"
Chris@1740 2546 ^ " lock update lock file to match local library status\n"
Chris@1746 2547 ^ " archive pack up project and all libraries into an archive file\n"
Chris@1746 2548 ^ " (invoke as 'vext archive target-file.tar.gz')\n"
Chris@1708 2549 ^ " version print the Vext version number and exit\n\n");
Chris@1708 2550 OS.Process.failure)
Chris@1706 2551
Chris@1746 2552 fun archive target args =
Chris@1746 2553 case args of
Chris@1746 2554 [] =>
Chris@1746 2555 with_local_project USE_LOCKFILE (Archive.archive (target, []))
Chris@1746 2556 | "--exclude"::xs =>
Chris@1746 2557 with_local_project USE_LOCKFILE (Archive.archive (target, xs))
Chris@1746 2558 | _ => usage ()
Chris@1746 2559
Chris@1706 2560 fun vext args =
Chris@1708 2561 let val return_code =
Chris@1708 2562 case args of
Chris@1708 2563 ["review"] => review ()
Chris@1708 2564 | ["status"] => status ()
Chris@1708 2565 | ["install"] => install ()
Chris@1708 2566 | ["update"] => update ()
Chris@1740 2567 | ["lock"] => lock ()
Chris@1708 2568 | ["version"] => version ()
Chris@1746 2569 | "archive"::target::args => archive target args
Chris@1708 2570 | _ => usage ()
Chris@1708 2571 in
Chris@1708 2572 OS.Process.exit return_code;
Chris@1708 2573 ()
Chris@1708 2574 end
Chris@1706 2575
Chris@1706 2576 fun main () =
Chris@1706 2577 vext (CommandLine.arguments ())