casacore
MSCorrGram.h
Go to the documentation of this file.
1 //# MSCorrGram.h: Grammar for ms corr 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_MSCORRGRAM_H
29 #define MS_MSCORRGRAM_H
30 
31 
32 //# Includes
33 #include <casacore/casa/aips.h>
34 #include <casacore/casa/BasicSL/String.h>
35 
36 namespace casacore { //# NAMESPACE CASACORE - BEGIN
37 
38 //# Forward Declarations
39 class MeasurementSet;
40 class TableExprNode;
41 
42 // <summary>
43 // Global functions for flex/bison scanner/parser for MSCorrGram
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> MSCorrGram.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=MSCorrGramFunctions>
72 
73 // Declare the bison parser (is implemented by bison command).
74 int msCorrGramParseCommand (const MeasurementSet *ms, const String& command);
75 
76 // The yyerror function for the parser.
77 // It throws an exception with the current token.
78 void MSCorrGramerror (const char*);
79 
80 // Give the table expression node.
81 const TableExprNode *msCorrGramParseNode();
82 void msCorrGramParseDeleteNode();
83 
84 // Give the current position in the string.
85 // This can be used when parse errors occur.
86 Int& msCorrGramPosition();
87 
88 // Declare the input routine for flex/bison.
89 int msCorrGramInput (char* buf, int max_size);
90 
91 // A function to remove escaped characters.
92 String msCorrGramRemoveEscapes (const String& in);
93 
94 // A function to remove quotes from a quoted string.
95 String msCorrGramRemoveQuotes (const String& in);
96 
97 // </group>
98 
99 } //# NAMESPACE CASACORE - END
100 
101 #endif
casacore::MSCorrGram_global_functions_MSCorrGramFunctions
Global functions for flex/bison scanner/parser for MSCorrGram.
Definition: MSCorrGram.h:72
casacore::MSCorrGram_global_functions_MSCorrGramFunctions::msCorrGramRemoveEscapes
String msCorrGramRemoveEscapes(const String &in)
A function to remove escaped characters.
casacore::MSCorrGram_global_functions_MSCorrGramFunctions::msCorrGramParseCommand
int msCorrGramParseCommand(const MeasurementSet *ms, const String &command)
Declare the bison parser (is implemented by bison command).
casacore::MSCorrGram_global_functions_MSCorrGramFunctions::msCorrGramRemoveQuotes
String msCorrGramRemoveQuotes(const String &in)
A function to remove quotes from a quoted string.
casacore::MSCorrGram_global_functions_MSCorrGramFunctions::msCorrGramParseNode
const TableExprNode * msCorrGramParseNode()
Give the table expression node.
casacore::MSCorrGram_global_functions_MSCorrGramFunctions::MSCorrGramerror
void MSCorrGramerror(const char *)
The yyerror function for the parser.
casacore::Int
int Int
Definition: aipstype.h:50
casacore
this file contains all the compiler specific defines
Definition: mainpage.dox:28
casacore::MSCorrGram_global_functions_MSCorrGramFunctions::msCorrGramParseDeleteNode
void msCorrGramParseDeleteNode()
casacore::TableExprNode
Handle class for a table column expression tree.
Definition: ExprNode.h:155
casacore::MSCorrGram_global_functions_MSCorrGramFunctions::msCorrGramInput
int msCorrGramInput(char *buf, int max_size)
Declare the input routine for flex/bison.
casacore::MeasurementSet
A Table intended to hold astronomical data (a set of Measurements).
Definition: MeasurementSet.h:241
casacore::String
String: the storage and methods of handling collections of characters.
Definition: String.h:223
casacore::MSCorrGram_global_functions_MSCorrGramFunctions::msCorrGramPosition
Int & msCorrGramPosition()
Give the current position in the string.