Skip to content

Commit c068c7c

Browse files
ogma-core: Correct name in documentation. Refs #176.
The documentation of ogma-core/src/Language/Trans/SMV2Copilot.hs does not refer to the boolean expressions as those in the SMV language, but incorrectly refers to them as FRET expressions, which was old documentation left over after renaming the module. This commit renames all occurrences to SMV in the module documentation.
1 parent 36ee4d5 commit c068c7c

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

ogma-core/src/Language/Trans/SMV2Copilot.hs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
-- AGREEMENT.
3030
--
3131

32-
-- | Transform a FRET TL specification into a Copilot specification.
32+
-- | Transform an SMV TL specification into a Copilot specification.
3333
--
3434
-- Normally, this module would be implemented as a conversion between ASTs,
3535
-- but we want to add comments to the generated code, which are not
@@ -40,7 +40,7 @@ import Language.SMV.AbsSMV (AdditiveOp (..), BoolConst (..), BoolSpec (..),
4040
Ident (..), MultOp (..), NumExpr (..), Number (..),
4141
Op1Name (..), OpOne (..), OpTwo (..), OrdOp (..))
4242

43-
-- | Return the Copilot representation of a FRET BoolSpec.
43+
-- | Return the Copilot representation of an SMV BoolSpec.
4444
--
4545
-- This function returns the temporal property only. The string does not
4646
-- contain any top-level names, any imports, or auxiliary definitions that may
@@ -96,7 +96,7 @@ boolSpec2Copilot b = case b of
9696
++ " " ++ boolSpec2Copilot spec2
9797
++ ")"
9898

99-
-- | Return the Copilot representation of a FRET boolean constant.
99+
-- | Return the Copilot representation of an SMV boolean constant.
100100
const2Copilot :: BoolConst -> String
101101
const2Copilot BoolConstTrue = "true"
102102
const2Copilot BoolConstFalse = "false"
@@ -119,17 +119,17 @@ numExpr2Copilot (NumMult x op y) = "("
119119
++ numExpr2Copilot y
120120
++ ")"
121121

122-
-- | Return the Copilot representation of a FRET additive operator.
122+
-- | Return the Copilot representation of an SMV additive operator.
123123
additiveOp2Copilot :: AdditiveOp -> String
124124
additiveOp2Copilot OpPlus = "+"
125125
additiveOp2Copilot OpMinus = "-"
126126

127-
-- | Return the Copilot representation of a FRET multiplicative operator.
127+
-- | Return the Copilot representation of an SMV multiplicative operator.
128128
multOp2Copilot :: MultOp -> String
129129
multOp2Copilot OpTimes = "*"
130130
multOp2Copilot OpDiv = "/"
131131

132-
-- | Return the Copilot representation of a FRET comparison operator.
132+
-- | Return the Copilot representation of an SMV comparison operator.
133133
ordOp2Copilot :: OrdOp -> String
134134
ordOp2Copilot OrdOpLT = "<"
135135
ordOp2Copilot OrdOpLE = "<="
@@ -138,13 +138,13 @@ ordOp2Copilot OrdOpNE = "/="
138138
ordOp2Copilot OrdOpGT = ">"
139139
ordOp2Copilot OrdOpGE = ">="
140140

141-
-- | Return the Copilot representation of a unary logical FRET operator.
141+
-- | Return the Copilot representation of a unary logical SMV operator.
142142
opOne2Copilot :: OpOne -> String
143143
opOne2Copilot (Op1Alone x) = opOneAlone2Copilot x
144144
opOne2Copilot (Op1MTL x op v) = opOneMTL2Copilot x op v
145145
opOne2Copilot (Op1MTLRange op mn mx) = opOneMTLRange2Copilot op mn mx
146146

147-
-- | Return the Copilot representation of a unary logical non-MTL FRET
147+
-- | Return the Copilot representation of a unary logical non-MTL SMV
148148
-- operator.
149149
opOneAlone2Copilot :: Op1Name -> String
150150
opOneAlone2Copilot Op1Pre = "pre"
@@ -156,15 +156,15 @@ opOneAlone2Copilot Op1Z = "notPreviousNot"
156156
opOneAlone2Copilot Op1Hist = "PTLTL.alwaysBeen"
157157
opOneAlone2Copilot Op1O = "PTLTL.eventuallyPrev"
158158

159-
-- | Return the Copilot representation of a unary logical MTL FRET operator.
159+
-- | Return the Copilot representation of a unary logical MTL SMV operator.
160160
opOneMTL2Copilot :: Op1Name -> OrdOp -> Number -> String
161161
opOneMTL2Copilot operator _comparison number =
162162
opOneMTL2Copilot' operator ++ " " ++ show (0 :: Int)
163163
++ " " ++ number2Copilot number
164164
++ " " ++ "clock" ++ " "
165165
++ show (1 :: Int)
166166

167-
-- | Return the Copilot representation of a unary logical MTL FRET operator
167+
-- | Return the Copilot representation of a unary logical MTL SMV operator
168168
-- that uses an explicit range.
169169
opOneMTLRange2Copilot :: Op1Name -> Number -> Number -> String
170170
opOneMTLRange2Copilot operator mn mx =
@@ -173,7 +173,7 @@ opOneMTLRange2Copilot operator mn mx =
173173
++ " " ++ "clock" ++ " "
174174
++ show (1 :: Int)
175175

176-
-- | Return the Copilot representation of a unary logical possibly MTL FRET
176+
-- | Return the Copilot representation of a unary logical possibly MTL SMV
177177
-- operator.
178178
opOneMTL2Copilot' :: Op1Name -> String
179179
opOneMTL2Copilot' Op1Pre = "pre"
@@ -185,19 +185,19 @@ opOneMTL2Copilot' Op1Z = "notPreviousNot"
185185
opOneMTL2Copilot' Op1Hist = "MTL.alwaysBeen"
186186
opOneMTL2Copilot' Op1O = "MTL.eventuallyPrev"
187187

188-
-- | Return the Copilot representation of a FRET number.
188+
-- | Return the Copilot representation of an SMV number.
189189
number2Copilot :: Number -> String
190190
number2Copilot (NumberInt n) = show n
191191

192-
-- | Return the Copilot representation of a binary logical non-MTL FRET
192+
-- | Return the Copilot representation of a binary logical non-MTL SMV
193193
-- operator.
194194
opTwo2Copilot :: OpTwo -> String
195195
opTwo2Copilot Op2S = "`since`"
196196
opTwo2Copilot Op2T = "`triggers`"
197197
opTwo2Copilot Op2V = "`releases`"
198198
opTwo2Copilot Op2U = "`until`"
199199

200-
-- | Return the Copilot representation of a FRET identifier.
200+
-- | Return the Copilot representation of an SMV identifier.
201201
ident2Copilot :: Ident -> String
202202
ident2Copilot (Ident i) = i
203203

0 commit comments

Comments
 (0)