aboutsummaryrefslogtreecommitdiff
path: root/libbutl/manifest-parser.bash.in
blob: b0475c4a7b0a0b193d47c4422912a0d0bd4da571 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# file      : libbutl/manifest-parser.bash.in
# copyright : Copyright (c) 2014-2019 Code Synthesis Ltd
# license   : MIT; see accompanying LICENSE file

if [ "$butl_manifest_parser" ]; then
  return 0
else
  butl_manifest_parser=true
fi

@import libbutl/utility@

# Parse the manifest reading from stdin and writing the binary representation
# to stdout.
#
# Normally you would use the start/finish functions below. But if you don't
# care about errors, the following would be the typical usage:
#
# while IFS=: read -r -d '' n v; do
#   ...
# done < <(butl_parse_manifest)
#
function butl_parse_manifest ()
{
  "$(butl_path)/manifest" parse
}

# Start the manifest parsing co-process setting the following "return"
# variables:
#
#   butl_manifest_parser_ofd
#   butl_manifest_parser_ifd
#   butl_manifest_parser_pid
#
# If <file> is not specified, then read from stdin.
#
# The typical usage:
#
#   butl_manifest_parser_start
#
#   while IFS=: read -ru "$butl_manifest_parser_ofd" -d '' n v; do
#     ...
#   done
#
#   butl_manifest_parser_finish
#
function butl_manifest_parser_start () # [<file>]
{
  if [ "$#" -gt 0 ]; then
    exec {butl_manifest_parser_ifd}<"$1"
  else
    exec {butl_manifest_parser_ifd}<&0
  fi

  # Note that bash co-process facility is racy: as soon as the process
  # finishes, bash unsets COPROC/COPROC_PID (my guess would be it checks after
  # each command in the script). This specific sequence of steps (and the one
  # in *_finish()) seems to work reliably at least from bash 4.3.30 and
  # up. See the following resources for details:
  #
  # http://wiki.bash-hackers.org/syntax/keywords/coproc
  # http://tldp.org/LDP/abs/html/bashver4.html (coproc section)
  # https://lists.gnu.org/archive/html/bug-bash/2014-02/msg00017.html
  # https://lists.gnu.org/archive/html/bug-bash/2012-12/msg00069.html
  # https://lists.gnu.org/archive/html/bug-bash/2012-10/msg00027.html
  #
  # Also note that the bash bug (still present in 5.0) prevents running
  # multiple coprocesses at a time (see the BUGS section of bash(1) man page
  # for details).
  #
  coproc { butl_parse_manifest; } <&"$butl_manifest_parser_ifd"
  exec {butl_manifest_parser_ofd}<&"${COPROC[0]}"
  butl_manifest_parser_pid="$COPROC_PID"
}

# Finish the manifest parsing co-process.
#
function butl_manifest_parser_finish ()
{
  exec {butl_manifest_parser_ofd}<&-
  wait "$butl_manifest_parser_pid"
  exec {butl_manifest_parser_ifd}<&-
}