annotate vext.sml @ 1775:4281d7059f3a

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