1#############################################################################
2####
3##
4#W  anupqios.gd            ANUPQ package                          Greg Gamble
5##
6##  This file declares core functions used with streams.
7##
8#Y  Copyright (C) 2001  Lehrstuhl D fuer Mathematik,  RWTH Aachen,  Germany
9##
10
11#############################################################################
12##
13#F  PQ_START( <workspace>, <setupfile> ) . . . open a stream for a pq process
14##
15DeclareGlobalFunction( "PQ_START" );
16
17#############################################################################
18##
19#F  PqStart(<G>,<workspace> : <options>) . Initiate interactive ANUPQ session
20#F  PqStart(<G> : <options>)
21#F  PqStart(<workspace> : <options>)
22#F  PqStart( : <options>)
23##
24DeclareGlobalFunction( "PqStart" );
25
26#############################################################################
27##
28#F  PqQuit( <i> )  . . . . . . . . . . . . . . . . .  User version of PQ_QUIT
29#F  PqQuit()
30##
31DeclareGlobalFunction( "PqQuit" );
32
33#############################################################################
34##
35#F  PqQuitAll() . . . . . . . . . . . .  Close all interactive ANUPQ sessions
36##
37DeclareGlobalFunction( "PqQuitAll" );
38
39#############################################################################
40##
41#F  ANUPQ_IOINDEX . . . . the number identifying an interactive ANUPQ session
42##
43DeclareGlobalFunction( "ANUPQ_IOINDEX" );
44
45#############################################################################
46##
47#F  ANUPQ_IOINDEX_ARG_CHK .  Checks ANUPQ_IOINDEX has the right no. of arg'ts
48##
49DeclareGlobalFunction( "ANUPQ_IOINDEX_ARG_CHK" );
50
51#############################################################################
52##
53#F  ANUPQDataRecord([<i>]) . . . . . . . returns the data record of a process
54##
55DeclareGlobalFunction( "ANUPQDataRecord" );
56
57#############################################################################
58##
59#F  PqProcessIndex( <i> ) . . . . . . . . . . . User version of ANUPQ_IOINDEX
60#F  PqProcessIndex()
61##
62DeclareGlobalFunction( "PqProcessIndex" );
63
64#############################################################################
65##
66#F  PqProcessIndices() . . . . the list of active interactive ANUPQ processes
67##
68DeclareGlobalFunction( "PqProcessIndices" );
69
70#############################################################################
71##
72#F  IsPqProcessAlive( <i> ) . .  checks an interactive ANUPQ process iostream
73#F  IsPqProcessAlive()
74##
75DeclareGlobalFunction( "IsPqProcessAlive" );
76
77#############################################################################
78##
79#V  PQ_MENUS . . . . . . . . . . . data describing the menus of the pq binary
80##
81DeclareGlobalVariable( "PQ_MENUS",
82  "A record containing data describing the tree of menus of the pq binary"
83  );
84
85#############################################################################
86##
87#F  PQ_MENU( <datarec>, <newmenu> ) . . . . . . change/get menu of pq process
88#F  PQ_MENU( <datarec> )
89##
90DeclareGlobalFunction( "PQ_MENU" );
91
92#############################################################################
93##
94#F  IS_PQ_PROMPT( <line> ) . . . .  checks whether the line is a prompt of pq
95##
96DeclareGlobalFunction( "IS_PQ_PROMPT" );
97
98#############################################################################
99##
100#F  IS_ALL_PQ_LINE( <line> ) . checks whether line is a complete line from pq
101##
102DeclareGlobalFunction( "IS_ALL_PQ_LINE" );
103
104#############################################################################
105##
106#F  PQ_READ_ALL_LINE . . read a line from a stream until a sentinel character
107##
108DeclareGlobalFunction( "PQ_READ_ALL_LINE" );
109
110#############################################################################
111##
112#F  PQ_READ_NEXT_LINE .  read complete line from stream but never return fail
113##
114DeclareGlobalFunction( "PQ_READ_NEXT_LINE" );
115
116#############################################################################
117##
118#F  FLUSH_PQ_STREAM_UNTIL(<stream>,<infoLev>,<infoLevMy>,<readln>,<IsMyLine>)
119##  . . .  . . . . . . . . . . . read lines from a stream until a wanted line
120##
121DeclareGlobalFunction( "FLUSH_PQ_STREAM_UNTIL" );
122
123#############################################################################
124##
125#V  PQ_ERROR_EXIT_MESSAGES . . . error messages emitted by the pq before exit
126##
127##  A list of the error messages the `pq' emits just before exiting.
128##
129DeclareGlobalVariable( "PQ_ERROR_EXIT_MESSAGES",
130  "A list of the error messages the pq emits just before exiting" );
131
132#############################################################################
133##
134#F  FILTER_PQ_STREAM_UNTIL_PROMPT( <datarec> )
135##
136DeclareGlobalFunction( "FILTER_PQ_STREAM_UNTIL_PROMPT" );
137
138#############################################################################
139##
140#F  ToPQk( <datarec>, <cmd>, <comment> ) . . . . . . .  writes to a pq stream
141##
142DeclareGlobalFunction( "ToPQk" );
143
144#############################################################################
145##
146#F  ToPQ(<datarec>, <cmd>, <comment>) . .  write to pq (& for iostream flush)
147##
148DeclareGlobalFunction( "ToPQ" );
149
150#############################################################################
151##
152#F  ToPQ_BOOL( <datarec>, <optval>, <comment> ) . . . .  pass a boolean to pq
153##
154DeclareGlobalFunction( "ToPQ_BOOL" );
155
156#############################################################################
157##
158#F  PqRead( <i> )  . . .  primitive read of a single line from ANUPQ iostream
159#F  PqRead()
160##
161DeclareGlobalFunction( "PqRead" );
162
163#############################################################################
164##
165#F  PqReadAll( <i> ) . . . . . read all current output from an ANUPQ iostream
166#F  PqReadAll()
167##
168DeclareGlobalFunction( "PqReadAll" );
169
170#############################################################################
171##
172#F  PqReadUntil( <i>, <IsMyLine> ) .  read from ANUPQ iostream until a cond'n
173#F  PqReadUntil( <IsMyLine> )
174#F  PqReadUntil( <i>, <IsMyLine>, <Modify> )
175#F  PqReadUntil( <IsMyLine>, <Modify> )
176##
177DeclareGlobalFunction( "PqReadUntil" );
178
179#############################################################################
180##
181#F  PqWrite( <i>, <string> ) . . . . . . .  primitive write to ANUPQ iostream
182#F  PqWrite( <string> )
183##
184DeclareGlobalFunction( "PqWrite" );
185
186#############################################################################
187##
188#F  ANUPQ_ARG_CHK( <funcname>, <args> ) . . . . check args of int/non-int fns
189##
190DeclareGlobalFunction( "ANUPQ_ARG_CHK" );
191
192#############################################################################
193##
194#F  PQ_COMPLETE_NONINTERACTIVE_FUNC_CALL( <datarec> )
195##
196DeclareGlobalFunction( "PQ_COMPLETE_NONINTERACTIVE_FUNC_CALL" );
197
198#############################################################################
199##
200#F  ToPQLog([<filename>]) . . . . . . log or stop logging pq commands to file
201##
202DeclareGlobalFunction( "ToPQLog" );
203
204#E  anupqios.gd . . . . . . . . . . . . . . . . . . . . . . . . . . ends here
205