File: new_flag.doc

package info (click to toggle)
hol88 2.02.19940316dfsg-5
  • links: PTS
  • area: main
  • in suites: bookworm
  • size: 65,816 kB
  • sloc: ml: 199,939; ansic: 9,666; sh: 6,913; makefile: 6,032; lisp: 2,747; yacc: 894; sed: 201; cpp: 87; awk: 5
file content (29 lines) | stat: -rw-r--r-- 644 bytes parent folder | download | duplicates (11)
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
\DOC new_flag

\TYPE {new_flag : ((string # bool) -> void)}

\SYNOPSIS
Creates a new settable flag.

\DESCRIBE
A call {new_flag(`flagname`,init)} declares a new settable flag called
{flagname}, with an initial setting of {init} (either {true} or {false}).
Like a system flag, it can be read and written to with {get_flag_value} and
{set_flag_value} respectively, and will be listed along with the others by
{flags()}.

\FAILURE
Fails if there is already a flag of the given name.

\EXAMPLE
{
#new_flag(`parser hacked`,false);;
() : void

#get_flag_value `parser hacked`;;
false : bool
}
\SEEALSO
flags, get_flag_value, set_flag_value.

\ENDDOC