casacore
MSStateGram.h
Go to the documentation of this file.
1//# MSStateGram.h: Grammar for ms field sub-expressions
2//# Copyright (C) 1998
3//# Associated Universities, Inc. Washington DC, USA.
4//#
5//# This library is free software; you can redistribute it and/or modify it
6//# under the terms of the GNU Library General Public License as published by
7//# the Free Software Foundation; either version 2 of the License, or (at your
8//# option) any later version.
9//#
10//# This library is distributed in the hope that it will be useful, but WITHOUT
11//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13//# License for more details.
14//#
15//# You should have received a copy of the GNU Library General Public License
16//# along with this library; if not, write to the Free Software Foundation,
17//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18//#
19//# Correspondence concerning AIPS++ should be addressed as follows:
20//# Internet email: aips2-request@nrao.edu.
21//# Postal address: AIPS++ Project Office
22//# National Radio Astronomy Observatory
23//# 520 Edgemont Road
24//# Charlottesville, VA 22903-2475 USA
25//#
26//# $Id$
27
28#ifndef MS_MSSTATEGRAM_H
29#define MS_MSSTATEGRAM_H
30
31
32//# Includes
33#include <casacore/casa/aips.h>
34#include <casacore/casa/BasicSL/String.h>
35
36namespace casacore { //# NAMESPACE CASACORE - BEGIN
37
38//# Forward Declarations
39class MeasurementSet;
40class TableExprNode;
41
42// <summary>
43// Global functions for flex/bison scanner/parser for MSStateGram
44// </summary>
45
46// <use visibility=local>
47
48// <reviewed reviewer="" date="" tests="">
49// </reviewed>
50
51// <prerequisite>
52//# Classes you should understand before using this one.
53// <li> MSStateGram.l and .y (flex and bison grammar)
54// </prerequisite>
55
56// <synopsis>
57// Global functions are needed to define the input of the flex scanner
58// and to start the bison parser.
59// The input is taken from a string.
60// </synopsis>
61
62// <motivation>
63// It is necessary to be able to give an image expression in ASCII.
64// This can be used in glish.
65// </motivation>
66// <todo asof="$DATE:$">
67//# A List of bugs, limitations, extensions or planned refinements.
68// </todo>
69
70
71// <group name=MSStateGramFunctions>
73// Declare the bison parser (is implemented by bison command).
74 int msStateGramParseCommand (const MeasurementSet *ms, const String& command);
75 int msStateGramParseCommand (const MeasurementSet *ms, const String& command,Vector<Int>&);
76
77// The yyerror function for the parser.
78// It throws an exception with the current token.
79void MSStateGramerror (const char*);
80
81// Give the table expression node.
84
85// Give the current position in the string.
86// This can be used when parse errors occur.
88
89// Declare the input routine for flex/bison.
90int msStateGramInput (char* buf, int max_size);
91
92// A function to remove escaped characters.
93//String msStateGramRemoveEscapes (const String& in);
94
95// A function to remove quotes from a quoted string.
96//String msStateGramRemoveQuotes (const String& in);
97
98// </group>
99
100} //# NAMESPACE CASACORE - END
101
102#endif
String: the storage and methods of handling collections of characters.
Definition: String.h:225
this file contains all the compiler specific defines
Definition: mainpage.dox:28
int Int
Definition: aipstype.h:50
const TableExprNode * msStateGramParseNode()
Give the table expression node.
int msStateGramInput(char *buf, int max_size)
Declare the input routine for flex/bison.
int msStateGramParseCommand(const MeasurementSet *ms, const String &command)
Declare the bison parser (is implemented by bison command).
void MSStateGramerror(const char *)
The yyerror function for the parser.
int msStateGramParseCommand(const MeasurementSet *ms, const String &command, Vector< Int > &)
Int & msStateGramPosition()
Give the current position in the string.