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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
\documentclass{article}
\usepackage{axiom}
\author{Gabriel Dos~Reis}
\begin{document}
\begin{abstract}
\end{abstract}
\tableofcontents
\eject
\section{The Conduit category}
<<category CONDUIT Conduit>>=
)abbrev category CONDUIT Conduit
++ Author: Gabriel Dos Reis
++ Date Created: August 24, 2008
++ Date Last Modified: August 24, 2008
++ Description:
++ This category is the root of the I/O conduits.
Conduit(): Category == with
close!: % -> %
++ close!(c) closes the conduit c, changing its state to one
++ that is invalid for future read or write operations.
@
\subsection{The InputByteConduit category}
<<category INBCON InputByteConduit>>=
)abbrev category INBCON InputByteConduit
++ Author: Gabriel Dos Reis
++ Date Created: August 24, 2008
++ Date Last Modified: August 24, 2008
++ Description:
++ This category describes input byte stream conduits.
InputByteConduit(): Category == Conduit with
readByteIfCan!: % -> SingleInteger
++ readByteIfCan!(cond) attempts to read a byte from the
++ input conduit `cond'. Returns the read byte if successful,
++ otherwise return -1.
++ Note: Ideally, the return value should have been of type
++ Maybe Byte; but that would have implied allocating
++ a cons cell for every read attempt, which is overkill.
readBytes!: (%,ByteArray) -> SingleInteger
++ readBytes!(c,b) reads byte sequences from conduit `c' into
++ the byte buffer `b'. The actual number of bytes written
++ is returned.
add
readBytes!(cond,ary) ==
count: SingleInteger := 0
b : SingleInteger
while count < #ary and ((b := readByteIfCan! cond) >= 0) repeat
qsetelt!(ary,count,b : Byte)
count := count + 1
count
@
\subsection{The OutputByteConduit category}
<<category OUTBCON OutputByteConduit>>=
)abbrev category OUTBCON OutputByteConduit
++ Author: Gabriel Dos Reis
++ Date Created: August 24, 2008
++ Date Last Modified: August 24, 2008
++ Description:
++ This category describes output byte stream conduits.
OutputByteConduit(): Category == Conduit with
writeByteIfCan!: (%,Byte) -> SingleInteger
++ writeByteIfCan!(c,b) attempts to write the byte `b' on
++ the conduit `c'. Returns the written byte if successful,
++ otherwise, returns -1.
++ Note: Ideally, the return value should have been of type
++ Maybe Byte; but that would have implied allocating
++ a cons cell for every write attempt, which is overkill.
writeBytes!: (%,ByteArray) -> SingleInteger
++ writeBytes!(c,b) write bytes from buffer `b'
++ onto the conduit `c'. The actual number of written
++ bytes is returned.
add
writeBytes!(cond,ary) ==
count: SingleInteger := 0
while count < #ary and
writeByteIfCan!(cond,qelt(ary,count)) >= 0 repeat
count := count + 1
count
@
\subsection{The InputOutputByteConduit category}
<<category IOBCON InputOutputByteConduit>>=
)abbrev category IOBCON InputOutputByteConduit
++ Author: Gabriel Dos Reis
++ Date Created: August 24, 2008
++ Date Last Modified: August 24, 2008
++ See Also: InputByteConduit, OutputByteConduit.
++ Description:
++ This category describes byte stream conduits supporting
++ both input and output operations.
InputOutputByteConduit(): Category ==
Join(InputByteConduit,OutputByteConduit)
@
\section{The Hostname domain}
<<domain HOSTNAME Hostname>>=
)abbrev domain HOSTNAME Hostname
++ Author: Gabriel Dos Reis
++ Date Created: August 23, 2008
++ Date Last Modified: August 23, 2008
++ References: RFC 1034, RFC 1035
++ Description:
++ This domain represents hostnames on computer network.
Hostname(): Public == Private where
Public == Join(SetCategory, CoercibleTo String) with
host: String -> %
++ host(n) constructs a Hostname from the name `n'.
Private == add
Rep == String
host n == per n
x = y == rep x = rep y
coerce(x: %): String == rep x
coerce(x: %): OutputForm == rep(x)::OutputForm
@
\section{The PortNumber domain}
<<domain PORTNUM PortNumber>>=
)abbrev domain PORTNUM PortNumber
++ Author: Gabriel Dos Reis
++ Date Created: August 23, 2008
++ Date Last Modified: August 23, 2008
++ Description:
++ This domain represents network port numbers (notable TCP and UDP).
PortNumber(): Public == Private where
Public == Join(SetCategory,CoercibleTo SingleInteger) with
port: SingleInteger -> %
++ port(n) constructs a PortNumber from the integer `n'.
Private == add
Rep == SingleInteger
port n == per n
x = y == rep x = rep y
coerce(x: %): SingleInteger == rep x
coerce(x: %): OutputForm == rep(x)::OutputForm
@
\section{License}
<<license>>=
-- Copyright (C) 2007-2008, Gabriel Dos Reis.
-- All rights reserved.
--
-- Redistribution and use in source and binary forms, with or without
-- modification, are permitted provided that the following conditions are
-- met:
--
-- - Redistributions of source code must retain the above copyright
-- notice, this list of conditions and the following disclaimer.
--
-- - Redistributions in binary form must reproduce the above copyright
-- notice, this list of conditions and the following disclaimer in
-- the documentation and/or other materials provided with the
-- distribution.
--
-- - Neither the name of The Numerical Algorithms Group Ltd. nor the
-- names of its contributors may be used to endorse or promote products
-- derived from this software without specific prior written permission.
--
-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
-- IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
-- TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
-- PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
-- OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-- EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-- PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-- PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-- NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@
<<*>>=
<<license>>
<<category CONDUIT Conduit>>
<<category INBCON InputByteConduit>>
<<category OUTBCON OutputByteConduit>>
<<category IOBCON InputOutputByteConduit>>
<<domain HOSTNAME Hostname>>
<<domain PORTNUM PortNumber>>
@
\end{document}
|