commit 9ec6dd74fc7b91501d359cefc1466a06b2dcb934
parent bbebe1e47af179befc777518d2ec2f8f9111d47c
Author: Jan Pobrislo <ccx@te2000.cz>
Date: Tue, 29 Apr 2025 01:58:41 +0000
Reorganize code, no semantic changes besides restricted module imports
Diffstat:
3 files changed, 177 insertions(+), 157 deletions(-)
diff --git a/doc/miniroon_spec.html b/doc/miniroon_spec.html
@@ -18,8 +18,8 @@
<tr><td>11</td><td><code> , miniroon_header/3</code></td></tr>
<tr><td>12</td><td><code> , miniroon_v0_caveat_list/3</code></td></tr>
<tr><td>13</td><td><code> ]).</code></td></tr>
-<tr><td>14</td><td><code>:- use_module(library(error)).</code></td></tr>
-<tr><td>15</td><td><code>:- use_module(library(dcg/basics)).</code></td></tr>
+<tr><td>14</td><td><code>:- use_module(library(debug), [assertion/1]).</code></td></tr>
+<tr><td>15</td><td><code>:- use_module(library(dcg/basics), [digits/3]).</code></td></tr>
<tr><td>16</td><td><code></code></td><td rowspan="4"></td></tr>
<tr><td>17</td><td><code>% pack_install(delay). => https://storage.googleapis.com/packs.ndrix.com/delay/delay-0.3.3.zip</code></td></tr>
<tr><td>18</td><td><code>% Also at: https://github.com/mndrix/delay</code></td></tr>
@@ -51,136 +51,146 @@
<tr><td>44</td><td><code>delay:mode(miniroon_spec:phrase_length(nonvar, ground, _, _)).</code></td></tr>
<tr><td>45</td><td><code>delay:mode(miniroon_spec:phrase_length(ground, _, _, _)).</code></td></tr>
<tr><td>46</td><td><code></code></td><td rowspan="3"></td></tr>
-<tr><td>47</td><td><code>:- op(950, xfx, will_be).</code></td></tr>
-<tr><td>48</td><td><code>:- op(800, fx, ~).</code></td></tr>
+<tr><td>47</td><td><code>:- op(950, xfx, will_be). %< Shorthand operator for type and value checking</code></td></tr>
+<tr><td>48</td><td><code>:- op(800, fx, ~). %< Shorthand operator for delayed goal</code></td></tr>
<tr><td>49</td><td><code></code></td><td rowspan="2"></td></tr>
-<tr><td>50</td><td><code>%%% Basic definitions</code></td></tr>
-<tr><td>51</td><td><code></code></td><td rowspan="7"></td></tr>
-<tr><td>52</td><td><code>% swapped arguments append for use in DCGs</code></td></tr>
-<tr><td>53</td><td><code>% when called with instanced list as first argument it unifies it's content with DCG.</code></td></tr>
-<tr><td>54</td><td><code>dcgappend([], L, L) :- !.</code></td></tr>
-<tr><td>55</td><td><code>dcgappend([H|T], [H|R], L) :-</code></td></tr>
-<tr><td>56</td><td><code> dcgappend(T, R, L).</code></td></tr>
-<tr><td>57</td><td><code>%dcgappend(List, L0, L1) :- append(List, L1, L0).</code></td></tr>
-<tr><td>58</td><td><code></code></td><td rowspan="2"></td></tr>
-<tr><td>59</td><td><code>~(Goal) :- delay(Goal).</code></td></tr>
-<tr><td>60</td><td><code></code></td><td rowspan="4"></td></tr>
-<tr><td>61</td><td><code>% apply check to value when bound</code></td></tr>
-<tr><td>62</td><td><code>will_be(Value, Goal) :-</code></td></tr>
-<tr><td>63</td><td><code> freeze(Value, assertion(call(Goal, Value))).</code></td></tr>
-<tr><td>64</td><td><code></code></td><td rowspan="2"></td></tr>
-<tr><td>65</td><td><code>byte(Value) :- must_be(between(0, 255), Value).</code></td></tr>
-<tr><td>66</td><td><code></code></td><td rowspan="2"></td></tr>
-<tr><td>67</td><td><code>nonnegative_integer(Value) :- must_be(nonneg, Value).</code></td></tr>
-<tr><td>68</td><td><code></code></td><td rowspan="5"></td></tr>
-<tr><td>69</td><td><code>sequence_of_bytes([]).</code></td></tr>
-<tr><td>70</td><td><code>sequence_of_bytes([First|Rest]) :-</code></td></tr>
-<tr><td>71</td><td><code> First will_be byte,</code></td></tr>
-<tr><td>72</td><td><code> Rest will_be sequence_of_bytes.</code></td></tr>
-<tr><td>73</td><td><code></code></td><td rowspan="1"></td></tr>
-<tr><td>74</td><td><code>netstring_bytes(PayloadBytes) --> </code></td><td rowspan="1">Netstring is a sequence of bytes.</td></tr>
-<tr><td>75</td><td><code> netstring_prefix_for_payload(PayloadBytes), </code></td><td rowspan="1">It consists of prefix,</td></tr>
-<tr><td>76</td><td><code> PayloadBytes, </code></td><td rowspan="1">payload,</td></tr>
-<tr><td>77</td><td><code> `,`. </code></td><td rowspan="5">and terminator. Terminator is single ASCII comma `,`.</td></tr>
-<tr><td>78</td><td><code>netstring_encoding(netstring(PayloadBytes), Bytes) :-</code></td></tr>
-<tr><td>79</td><td><code> assertion(ground(PayloadBytes); ground(Bytes)),</code></td></tr>
-<tr><td>80</td><td><code> Bytes will_be sequence_of_bytes,</code></td></tr>
-<tr><td>81</td><td><code> phrase(netstring_bytes(PayloadBytes), Bytes).</code></td></tr>
-<tr><td>82</td><td><code></code></td><td rowspan="4"></td></tr>
-<tr><td>83</td><td><code>netstring_string(PayloadString) --></code></td></tr>
-<tr><td>84</td><td><code> { ~ string_bytes(PayloadString, PayloadBytes, octet) },</code></td></tr>
-<tr><td>85</td><td><code> netstring_bytes(PayloadBytes).</code></td></tr>
-<tr><td>86</td><td><code></code></td><td rowspan="1"></td></tr>
-<tr><td>87</td><td><code></code></td><td rowspan="8">Netstring prefix is the shortest ASCII decimal representation for length of
+<tr><td>50</td><td><code>~(Goal) :- delay(Goal).</code></td></tr>
+<tr><td>51</td><td><code></code></td><td rowspan="2"></td></tr>
+<tr><td>52</td><td><code>%%% Helpers for DCGs:</code></td></tr>
+<tr><td>53</td><td><code></code></td><td rowspan="6"></td></tr>
+<tr><td>54</td><td><code>% swapped arguments append for use in DCGs</code></td></tr>
+<tr><td>55</td><td><code>% when called with instanced list as first argument it unifies it's content with DCG.</code></td></tr>
+<tr><td>56</td><td><code>dcgappend([], L, L) :- !.</code></td></tr>
+<tr><td>57</td><td><code>dcgappend([H|T], [H|R], L) :-</code></td></tr>
+<tr><td>58</td><td><code> dcgappend(T, R, L).</code></td></tr>
+<tr><td>59</td><td><code></code></td><td rowspan="3"></td></tr>
+<tr><td>60</td><td><code>% Non-cutting variant:</code></td></tr>
+<tr><td>61</td><td><code>%dcgappend(List, L0, L1) :- append(List, L1, L0).</code></td></tr>
+<tr><td>62</td><td><code></code></td><td rowspan="9"></td></tr>
+<tr><td>63</td><td><code>phrase_length_agg(List, Terminator, CurrentDepth, Length) :-</code></td></tr>
+<tr><td>64</td><td><code> ( List == Terminator</code></td></tr>
+<tr><td>65</td><td><code> -> CurrentDepth = Length</code></td></tr>
+<tr><td>66</td><td><code> ; NextDepth is CurrentDepth + 1,</code></td></tr>
+<tr><td>67</td><td><code> assertion(compound(List)),</code></td></tr>
+<tr><td>68</td><td><code> List = [_|NextList],</code></td></tr>
+<tr><td>69</td><td><code> phrase_length_agg(NextList, Terminator, NextDepth, Length)</code></td></tr>
+<tr><td>70</td><td><code> ).</code></td></tr>
+<tr><td>71</td><td><code></code></td><td rowspan="5"></td></tr>
+<tr><td>72</td><td><code>phrase_length(DCGBody, List, Rest, Length) :-</code></td></tr>
+<tr><td>73</td><td><code> phrase(DCGBody, List, Terminator),</code></td></tr>
+<tr><td>74</td><td><code> phrase_length_agg(List, Terminator, 0, Length),</code></td></tr>
+<tr><td>75</td><td><code> Terminator = Rest.</code></td></tr>
+<tr><td>76</td><td><code></code></td><td rowspan="2"></td></tr>
+<tr><td>77</td><td><code>%%% Helpers for type and value checking:</code></td></tr>
+<tr><td>78</td><td><code></code></td><td rowspan="4"></td></tr>
+<tr><td>79</td><td><code>% apply check to value when bound</code></td></tr>
+<tr><td>80</td><td><code>will_be(Value, Goal) :-</code></td></tr>
+<tr><td>81</td><td><code> freeze(Value, assertion(call(Goal, Value))).</code></td></tr>
+<tr><td>82</td><td><code></code></td><td rowspan="2"></td></tr>
+<tr><td>83</td><td><code>byte(Value) :- must_be(between(0, 255), Value).</code></td></tr>
+<tr><td>84</td><td><code></code></td><td rowspan="2"></td></tr>
+<tr><td>85</td><td><code>nonnegative_integer(Value) :- must_be(nonneg, Value).</code></td></tr>
+<tr><td>86</td><td><code></code></td><td rowspan="5"></td></tr>
+<tr><td>87</td><td><code>sequence_of_bytes([]).</code></td></tr>
+<tr><td>88</td><td><code>sequence_of_bytes([First|Rest]) :-</code></td></tr>
+<tr><td>89</td><td><code> First will_be byte,</code></td></tr>
+<tr><td>90</td><td><code> Rest will_be sequence_of_bytes.</code></td></tr>
+<tr><td>91</td><td><code></code></td><td rowspan="2"></td></tr>
+<tr><td>92</td><td><code>%%% Generic grammar definitions:</code></td></tr>
+<tr><td>93</td><td><code></code></td><td rowspan="5"></td></tr>
+<tr><td>94</td><td><code>nonzero_digit(Code) --></code></td></tr>
+<tr><td>95</td><td><code> [Code],</code></td></tr>
+<tr><td>96</td><td><code> { assertion(ground(Code)) },</code></td></tr>
+<tr><td>97</td><td><code> { member(Code, `123456789`) }.</code></td></tr>
+<tr><td>98</td><td><code></code></td><td rowspan="2"></td></tr>
+<tr><td>99</td><td><code>%%% Netstring definitions:</code></td></tr>
+<tr><td>100</td><td><code></code></td><td rowspan="1"></td></tr>
+<tr><td>101</td><td><code>netstring_bytes(PayloadBytes) --> </code></td><td rowspan="1">Netstring is a sequence of bytes.</td></tr>
+<tr><td>102</td><td><code> netstring_prefix_for_payload(PayloadBytes), </code></td><td rowspan="1">It consists of prefix,</td></tr>
+<tr><td>103</td><td><code> PayloadBytes, </code></td><td rowspan="1">payload,</td></tr>
+<tr><td>104</td><td><code> `,`. </code></td><td rowspan="5">and terminator. Terminator is single ASCII comma `,`.</td></tr>
+<tr><td>105</td><td><code>netstring_encoding(netstring(PayloadBytes), Bytes) :-</code></td></tr>
+<tr><td>106</td><td><code> assertion(ground(PayloadBytes); ground(Bytes)),</code></td></tr>
+<tr><td>107</td><td><code> Bytes will_be sequence_of_bytes,</code></td></tr>
+<tr><td>108</td><td><code> phrase(netstring_bytes(PayloadBytes), Bytes).</code></td></tr>
+<tr><td>109</td><td><code></code></td><td rowspan="4"></td></tr>
+<tr><td>110</td><td><code>netstring_string(PayloadString) --></code></td></tr>
+<tr><td>111</td><td><code> { ~ string_bytes(PayloadString, PayloadBytes, octet) },</code></td></tr>
+<tr><td>112</td><td><code> netstring_bytes(PayloadBytes).</code></td></tr>
+<tr><td>113</td><td><code></code></td><td rowspan="1"></td></tr>
+<tr><td>114</td><td><code></code></td><td rowspan="8">Netstring prefix is the shortest ASCII decimal representation for length of
payload in bytes, followed by ASCII colon `:`.
That is number starting with non-zero digit unless payload is empty,
in which case it's `0`.</td></tr>
-<tr><td>88</td><td><code></code></td></tr>
-<tr><td>89</td><td><code></code></td></tr>
-<tr><td>90</td><td><code></code></td></tr>
-<tr><td>91</td><td><code>netstring_prefix_for_payload(PayloadBytes, A, B) :-</code></td></tr>
-<tr><td>92</td><td><code> ~ netstring_prefix_digits(Prefix, A, B),</code></td></tr>
-<tr><td>93</td><td><code> ~ number_codes(PayloadLength, Prefix),</code></td></tr>
-<tr><td>94</td><td><code> length(PayloadBytes, PayloadLength).</code></td></tr>
-<tr><td>95</td><td><code></code></td><td rowspan="7"></td></tr>
-<tr><td>96</td><td><code>netstring_prefix_digits(`0`) --> `0:`, !.</code></td></tr>
-<tr><td>97</td><td><code>netstring_prefix_digits([C|Cs]) --></code></td></tr>
-<tr><td>98</td><td><code> nonzero_digit(C),</code></td></tr>
-<tr><td>99</td><td><code> !,</code></td></tr>
-<tr><td>100</td><td><code> digits(Cs),</code></td></tr>
-<tr><td>101</td><td><code> `:`.</code></td></tr>
-<tr><td>102</td><td><code></code></td><td rowspan="5"></td></tr>
-<tr><td>103</td><td><code>nonzero_digit(Code) --></code></td></tr>
-<tr><td>104</td><td><code> [Code],</code></td></tr>
-<tr><td>105</td><td><code> { assertion(ground(Code)) },</code></td></tr>
-<tr><td>106</td><td><code> { member(Code, `123456789`) }.</code></td></tr>
-<tr><td>107</td><td><code></code></td><td rowspan="4"></td></tr>
-<tr><td>108</td><td><code>netstring_of(Goal, Bytes) :-</code></td></tr>
-<tr><td>109</td><td><code> ~ netstring_encoding(netstring(PayloadBytes), Bytes),</code></td></tr>
-<tr><td>110</td><td><code> call(Goal, PayloadBytes).</code></td></tr>
-<tr><td>111</td><td><code></code></td><td rowspan="9"></td></tr>
-<tr><td>112</td><td><code>phrase_length_agg(List, Terminator, CurrentDepth, Length) :-</code></td></tr>
-<tr><td>113</td><td><code> ( List == Terminator</code></td></tr>
-<tr><td>114</td><td><code> -> CurrentDepth = Length</code></td></tr>
-<tr><td>115</td><td><code> ; NextDepth is CurrentDepth + 1,</code></td></tr>
-<tr><td>116</td><td><code> assertion(compound(List)),</code></td></tr>
-<tr><td>117</td><td><code> List = [_|NextList],</code></td></tr>
-<tr><td>118</td><td><code> phrase_length_agg(NextList, Terminator, NextDepth, Length)</code></td></tr>
-<tr><td>119</td><td><code> ).</code></td></tr>
-<tr><td>120</td><td><code></code></td><td rowspan="5"></td></tr>
-<tr><td>121</td><td><code>phrase_length(DCGBody, List, Rest, Length) :-</code></td></tr>
-<tr><td>122</td><td><code> phrase(DCGBody, List, Terminator),</code></td></tr>
-<tr><td>123</td><td><code> phrase_length_agg(List, Terminator, 0, Length),</code></td></tr>
-<tr><td>124</td><td><code> Terminator = Rest.</code></td></tr>
-<tr><td>125</td><td><code></code></td><td rowspan="5"></td></tr>
-<tr><td>126</td><td><code>netstring_call_dcg(DCGBody, L0, Rest) :-</code></td></tr>
-<tr><td>127</td><td><code> ~ phrase_length(DCGBody,Payload,[44|Rest],PayloadLength),</code></td></tr>
-<tr><td>128</td><td><code> ~ number_codes(PayloadLength, PrefixDigits),</code></td></tr>
-<tr><td>129</td><td><code> netstring_prefix_digits(PrefixDigits, L0, Payload).</code></td></tr>
-<tr><td>130</td><td><code></code></td><td rowspan="5"></td></tr>
-<tr><td>131</td><td><code>netstring_maplist_dcg(_, []) --> {true}.</code></td></tr>
-<tr><td>132</td><td><code>netstring_maplist_dcg(DCGBody, [Item|Rest]) --></code></td></tr>
-<tr><td>133</td><td><code> netstring_call_dcg(call(DCGBody, Item)),</code></td></tr>
-<tr><td>134</td><td><code> netstring_maplist_dcg(DCGBody, Rest).</code></td></tr>
-<tr><td>135</td><td><code></code></td><td rowspan="7"></td></tr>
-<tr><td>136</td><td><code>% Miniroon is a netstring whose payload is concatenation of three parts: header, caveat list and signature.</code></td></tr>
-<tr><td>137</td><td><code>miniroon_content(miniroon_v0(Identifier, Action, Caveats, Signature)) --></code></td></tr>
-<tr><td>138</td><td><code> netstring_call_dcg(miniroon_header(header_v0(Identifier, Action))),</code></td></tr>
-<tr><td>139</td><td><code> %netstring_call_dcg(miniroon_v0_caveat_list(Caveats)),</code></td></tr>
-<tr><td>140</td><td><code> netstring_call_dcg(netstring_maplist_dcg(miniroon_v0_caveat, Caveats)),</code></td></tr>
-<tr><td>141</td><td><code> netstring_bytes(Signature).</code></td></tr>
-<tr><td>142</td><td><code></code></td><td rowspan="3"></td></tr>
-<tr><td>143</td><td><code>miniroon_encoding(Miniroon, Bytes) :-</code></td></tr>
-<tr><td>144</td><td><code> phrase(netstring_call_dcg(miniroon_content(Miniroon)), Bytes).</code></td></tr>
-<tr><td>145</td><td><code></code></td><td rowspan="4"></td></tr>
-<tr><td>146</td><td><code>miniroon_v0_action(revoke, `revoke`).</code></td></tr>
-<tr><td>147</td><td><code>miniroon_v0_action(invoke, `invoke`).</code></td></tr>
-<tr><td>148</td><td><code>miniroon_v0_action(invoke_once, `invoke-once`).</code></td></tr>
-<tr><td>149</td><td><code></code></td><td rowspan="6"></td></tr>
-<tr><td>150</td><td><code>miniroon_header(header_v0(Identifier, Action)) --></code></td></tr>
-<tr><td>151</td><td><code> netstring_bytes(`capv0`),</code></td></tr>
-<tr><td>152</td><td><code> netstring_bytes(Identifier),</code></td></tr>
-<tr><td>153</td><td><code> { ~ miniroon_v0_action(Action, ActionBytes) },</code></td></tr>
-<tr><td>154</td><td><code> netstring_bytes(ActionBytes).</code></td></tr>
-<tr><td>155</td><td><code></code></td><td rowspan="16"></td></tr>
-<tr><td>156</td><td><code>miniroon_v0_caveat(caveat_v0_env_is(VarName, Value)) --></code></td></tr>
-<tr><td>157</td><td><code> netstring_bytes(`env-is`),</code></td></tr>
-<tr><td>158</td><td><code> netstring_string(VarName),</code></td></tr>
-<tr><td>159</td><td><code> netstring_string(Value).</code></td></tr>
-<tr><td>160</td><td><code>miniroon_v0_caveat(caveat_v0_env_absent(VarName)) --></code></td></tr>
-<tr><td>161</td><td><code> netstring_bytes(`env-absent`),</code></td></tr>
-<tr><td>162</td><td><code> netstring_string(VarName).</code></td></tr>
-<tr><td>163</td><td><code>miniroon_v0_caveat(caveat_v0_env_regmatch(VarName, Pattern)) --></code></td></tr>
-<tr><td>164</td><td><code> netstring_bytes(`env-re`),</code></td></tr>
-<tr><td>165</td><td><code> netstring_string(VarName),</code></td></tr>
-<tr><td>166</td><td><code> netstring_string(Pattern).</code></td></tr>
-<tr><td>167</td><td><code>miniroon_v0_caveat(caveat_v0_env_glob(VarName, Pattern)) --></code></td></tr>
-<tr><td>168</td><td><code> netstring_bytes(`env-glob`),</code></td></tr>
-<tr><td>169</td><td><code> netstring_string(VarName),</code></td></tr>
-<tr><td>170</td><td><code> netstring_string(Pattern).</code></td></tr>
-<tr><td>171</td><td><code></code></td><td rowspan="5"></td></tr>
-<tr><td>172</td><td><code>miniroon_v0_caveat_list([]) --> {true}.</code></td></tr>
-<tr><td>173</td><td><code>miniroon_v0_caveat_list([Caveat|Rest]) --></code></td></tr>
-<tr><td>174</td><td><code> netstring_call_dcg(miniroon_v0_caveat(Caveat)),</code></td></tr>
-<tr><td>175</td><td><code> miniroon_v0_caveat_list(Rest).</code></td></tr>
+<tr><td>115</td><td><code></code></td></tr>
+<tr><td>116</td><td><code></code></td></tr>
+<tr><td>117</td><td><code></code></td></tr>
+<tr><td>118</td><td><code>netstring_prefix_for_payload(PayloadBytes, A, B) :-</code></td></tr>
+<tr><td>119</td><td><code> ~ netstring_prefix_digits(Prefix, A, B),</code></td></tr>
+<tr><td>120</td><td><code> ~ number_codes(PayloadLength, Prefix),</code></td></tr>
+<tr><td>121</td><td><code> length(PayloadBytes, PayloadLength).</code></td></tr>
+<tr><td>122</td><td><code></code></td><td rowspan="7"></td></tr>
+<tr><td>123</td><td><code>netstring_prefix_digits(`0`) --> `0:`, !.</code></td></tr>
+<tr><td>124</td><td><code>netstring_prefix_digits([C|Cs]) --></code></td></tr>
+<tr><td>125</td><td><code> nonzero_digit(C),</code></td></tr>
+<tr><td>126</td><td><code> !,</code></td></tr>
+<tr><td>127</td><td><code> digits(Cs),</code></td></tr>
+<tr><td>128</td><td><code> `:`.</code></td></tr>
+<tr><td>129</td><td><code></code></td><td rowspan="4"></td></tr>
+<tr><td>130</td><td><code>netstring_of(Goal, Bytes) :-</code></td></tr>
+<tr><td>131</td><td><code> ~ netstring_encoding(netstring(PayloadBytes), Bytes),</code></td></tr>
+<tr><td>132</td><td><code> call(Goal, PayloadBytes).</code></td></tr>
+<tr><td>133</td><td><code></code></td><td rowspan="5"></td></tr>
+<tr><td>134</td><td><code>netstring_call_dcg(DCGBody, L0, Rest) :-</code></td></tr>
+<tr><td>135</td><td><code> ~ phrase_length(DCGBody,Payload,[44|Rest],PayloadLength),</code></td></tr>
+<tr><td>136</td><td><code> ~ number_codes(PayloadLength, PrefixDigits),</code></td></tr>
+<tr><td>137</td><td><code> netstring_prefix_digits(PrefixDigits, L0, Payload).</code></td></tr>
+<tr><td>138</td><td><code></code></td><td rowspan="5"></td></tr>
+<tr><td>139</td><td><code>netstring_maplist_dcg(_, []) --> {true}.</code></td></tr>
+<tr><td>140</td><td><code>netstring_maplist_dcg(DCGBody, [Item|Rest]) --></code></td></tr>
+<tr><td>141</td><td><code> netstring_call_dcg(call(DCGBody, Item)),</code></td></tr>
+<tr><td>142</td><td><code> netstring_maplist_dcg(DCGBody, Rest).</code></td></tr>
+<tr><td>143</td><td><code></code></td><td rowspan="2"></td></tr>
+<tr><td>144</td><td><code>%%% Miniroon definitions:</code></td></tr>
+<tr><td>145</td><td><code></code></td><td rowspan="7"></td></tr>
+<tr><td>146</td><td><code>% Miniroon is a netstring whose payload is concatenation of three parts: header, caveat list and signature.</code></td></tr>
+<tr><td>147</td><td><code>miniroon_content(miniroon_v0(Identifier, Action, Caveats, Signature)) --></code></td></tr>
+<tr><td>148</td><td><code> netstring_call_dcg(miniroon_header(header_v0(Identifier, Action))),</code></td></tr>
+<tr><td>149</td><td><code> %netstring_call_dcg(miniroon_v0_caveat_list(Caveats)),</code></td></tr>
+<tr><td>150</td><td><code> netstring_call_dcg(netstring_maplist_dcg(miniroon_v0_caveat, Caveats)),</code></td></tr>
+<tr><td>151</td><td><code> netstring_bytes(Signature).</code></td></tr>
+<tr><td>152</td><td><code></code></td><td rowspan="3"></td></tr>
+<tr><td>153</td><td><code>miniroon_encoding(Miniroon, Bytes) :-</code></td></tr>
+<tr><td>154</td><td><code> phrase(netstring_call_dcg(miniroon_content(Miniroon)), Bytes).</code></td></tr>
+<tr><td>155</td><td><code></code></td><td rowspan="4"></td></tr>
+<tr><td>156</td><td><code>miniroon_v0_action(revoke, `revoke`).</code></td></tr>
+<tr><td>157</td><td><code>miniroon_v0_action(invoke, `invoke`).</code></td></tr>
+<tr><td>158</td><td><code>miniroon_v0_action(invoke_once, `invoke-once`).</code></td></tr>
+<tr><td>159</td><td><code></code></td><td rowspan="6"></td></tr>
+<tr><td>160</td><td><code>miniroon_header(header_v0(Identifier, Action)) --></code></td></tr>
+<tr><td>161</td><td><code> netstring_bytes(`capv0`),</code></td></tr>
+<tr><td>162</td><td><code> netstring_bytes(Identifier),</code></td></tr>
+<tr><td>163</td><td><code> { ~ miniroon_v0_action(Action, ActionBytes) },</code></td></tr>
+<tr><td>164</td><td><code> netstring_bytes(ActionBytes).</code></td></tr>
+<tr><td>165</td><td><code></code></td><td rowspan="16"></td></tr>
+<tr><td>166</td><td><code>miniroon_v0_caveat(caveat_v0_env_is(VarName, Value)) --></code></td></tr>
+<tr><td>167</td><td><code> netstring_bytes(`env-is`),</code></td></tr>
+<tr><td>168</td><td><code> netstring_string(VarName),</code></td></tr>
+<tr><td>169</td><td><code> netstring_string(Value).</code></td></tr>
+<tr><td>170</td><td><code>miniroon_v0_caveat(caveat_v0_env_absent(VarName)) --></code></td></tr>
+<tr><td>171</td><td><code> netstring_bytes(`env-absent`),</code></td></tr>
+<tr><td>172</td><td><code> netstring_string(VarName).</code></td></tr>
+<tr><td>173</td><td><code>miniroon_v0_caveat(caveat_v0_env_regmatch(VarName, Pattern)) --></code></td></tr>
+<tr><td>174</td><td><code> netstring_bytes(`env-re`),</code></td></tr>
+<tr><td>175</td><td><code> netstring_string(VarName),</code></td></tr>
+<tr><td>176</td><td><code> netstring_string(Pattern).</code></td></tr>
+<tr><td>177</td><td><code>miniroon_v0_caveat(caveat_v0_env_glob(VarName, Pattern)) --></code></td></tr>
+<tr><td>178</td><td><code> netstring_bytes(`env-glob`),</code></td></tr>
+<tr><td>179</td><td><code> netstring_string(VarName),</code></td></tr>
+<tr><td>180</td><td><code> netstring_string(Pattern).</code></td></tr>
+<tr><td>181</td><td><code></code></td><td rowspan="5"></td></tr>
+<tr><td>182</td><td><code>miniroon_v0_caveat_list([]) --> {true}.</code></td></tr>
+<tr><td>183</td><td><code>miniroon_v0_caveat_list([Caveat|Rest]) --></code></td></tr>
+<tr><td>184</td><td><code> netstring_call_dcg(miniroon_v0_caveat(Caveat)),</code></td></tr>
+<tr><td>185</td><td><code> miniroon_v0_caveat_list(Rest).</code></td></tr>
</table></body></html>
diff --git a/doc/miniroon_spec.pl b/doc/miniroon_spec.pl
@@ -11,8 +11,8 @@
, miniroon_header/3
, miniroon_v0_caveat_list/3
]).
-:- use_module(library(error)).
-:- use_module(library(dcg/basics)).
+:- use_module(library(debug), [assertion/1]).
+:- use_module(library(dcg/basics), [digits/3]).
% pack_install(delay). => https://storage.googleapis.com/packs.ndrix.com/delay/delay-0.3.3.zip
% Also at: https://github.com/mndrix/delay
@@ -44,19 +44,37 @@ delay:mode(miniroon_spec:miniroon_v0_action(_, list)).
delay:mode(miniroon_spec:phrase_length(nonvar, ground, _, _)).
delay:mode(miniroon_spec:phrase_length(ground, _, _, _)).
-:- op(950, xfx, will_be).
-:- op(800, fx, ~).
+:- op(950, xfx, will_be). %< Shorthand operator for type and value checking
+:- op(800, fx, ~). %< Shorthand operator for delayed goal
-%%% Basic definitions
+~(Goal) :- delay(Goal).
+
+%%% Helpers for DCGs:
% swapped arguments append for use in DCGs
% when called with instanced list as first argument it unifies it's content with DCG.
dcgappend([], L, L) :- !.
dcgappend([H|T], [H|R], L) :-
- dcgappend(T, R, L).
+ dcgappend(T, R, L).
+
+% Non-cutting variant:
%dcgappend(List, L0, L1) :- append(List, L1, L0).
-~(Goal) :- delay(Goal).
+phrase_length_agg(List, Terminator, CurrentDepth, Length) :-
+ ( List == Terminator
+ -> CurrentDepth = Length
+ ; NextDepth is CurrentDepth + 1,
+ assertion(compound(List)),
+ List = [_|NextList],
+ phrase_length_agg(NextList, Terminator, NextDepth, Length)
+ ).
+
+phrase_length(DCGBody, List, Rest, Length) :-
+ phrase(DCGBody, List, Terminator),
+ phrase_length_agg(List, Terminator, 0, Length),
+ Terminator = Rest.
+
+%%% Helpers for type and value checking:
% apply check to value when bound
will_be(Value, Goal) :-
@@ -71,6 +89,15 @@ sequence_of_bytes([First|Rest]) :-
First will_be byte,
Rest will_be sequence_of_bytes.
+%%% Generic grammar definitions:
+
+nonzero_digit(Code) -->
+ [Code],
+ { assertion(ground(Code)) },
+ { member(Code, `123456789`) }.
+
+%%% Netstring definitions:
+
netstring_bytes(PayloadBytes) --> %> Netstring is a sequence of bytes.
netstring_prefix_for_payload(PayloadBytes), %> It consists of prefix,
PayloadBytes, %> payload,
@@ -100,29 +127,10 @@ netstring_prefix_digits([C|Cs]) -->
digits(Cs),
`:`.
-nonzero_digit(Code) -->
- [Code],
- { assertion(ground(Code)) },
- { member(Code, `123456789`) }.
-
netstring_of(Goal, Bytes) :-
~ netstring_encoding(netstring(PayloadBytes), Bytes),
call(Goal, PayloadBytes).
-phrase_length_agg(List, Terminator, CurrentDepth, Length) :-
- ( List == Terminator
- -> CurrentDepth = Length
- ; NextDepth is CurrentDepth + 1,
- assertion(compound(List)),
- List = [_|NextList],
- phrase_length_agg(NextList, Terminator, NextDepth, Length)
- ).
-
-phrase_length(DCGBody, List, Rest, Length) :-
- phrase(DCGBody, List, Terminator),
- phrase_length_agg(List, Terminator, 0, Length),
- Terminator = Rest.
-
netstring_call_dcg(DCGBody, L0, Rest) :-
~ phrase_length(DCGBody,Payload,[44|Rest],PayloadLength),
~ number_codes(PayloadLength, PrefixDigits),
@@ -133,6 +141,8 @@ netstring_maplist_dcg(DCGBody, [Item|Rest]) -->
netstring_call_dcg(call(DCGBody, Item)),
netstring_maplist_dcg(DCGBody, Rest).
+%%% Miniroon definitions:
+
% Miniroon is a netstring whose payload is concatenation of three parts: header, caveat list and signature.
miniroon_content(miniroon_v0(Identifier, Action, Caveats, Signature)) -->
netstring_call_dcg(miniroon_header(header_v0(Identifier, Action))),
diff --git a/doc/tests.pl b/doc/tests.pl
@@ -1,4 +1,4 @@
-:- use_module(library(error)).
+:- use_module(library(debug), [assertion/1]).
:- use_module(library(yall)).
:- use_module(miniroon_spec).
