casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
MSFieldGram.h
Go to the documentation of this file.
00001 //# MSFieldGram.h: Grammar for ms field sub-expressions
00002 //# Copyright (C) 1998
00003 //# Associated Universities, Inc. Washington DC, USA.
00004 //#
00005 //# This library is free software; you can redistribute it and/or modify it
00006 //# under the terms of the GNU Library General Public License as published by
00007 //# the Free Software Foundation; either version 2 of the License, or (at your
00008 //# option) any later version.
00009 //#
00010 //# This library is distributed in the hope that it will be useful, but WITHOUT
00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00013 //# License for more details.
00014 //#
00015 //# You should have received a copy of the GNU Library General Public License
00016 //# along with this library; if not, write to the Free Software Foundation,
00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00018 //#
00019 //# Correspondence concerning AIPS++ should be addressed as follows:
00020 //#        Internet email: aips2-request@nrao.edu.
00021 //#        Postal address: AIPS++ Project Office
00022 //#                        National Radio Astronomy Observatory
00023 //#                        520 Edgemont Road
00024 //#                        Charlottesville, VA 22903-2475 USA
00025 //#
00026 //# $Id: MSFieldGram.h 20652 2009-07-06 05:04:32Z Malte.Marquarding $
00027 
00028 #ifndef MS_MSFIELDGRAM_H
00029 #define MS_MSFIELDGRAM_H
00030 
00031 
00032 //# Includes
00033 #include <casa/BasicSL/String.h>
00034 #include <ms/MeasurementSets/MSFieldParse.h>
00035 
00036 namespace casa { //# NAMESPACE CASA - BEGIN
00037 
00038 //# Forward Declarations
00039 class MeasurementSet;
00040 class TableExprNode;
00041 
00042 // <summary>
00043 // Global functions for flex/bison scanner/parser for MSFieldGram
00044 // </summary>
00045 
00046 // <use visibility=local>
00047 
00048 // <reviewed reviewer="" date="" tests="">
00049 // </reviewed>
00050 
00051 // <prerequisite>
00052 //# Classes you should understand before using this one.
00053 //  <li> MSFieldGram.l and .y  (flex and bison grammar)
00054 // </prerequisite>
00055 
00056 // <synopsis> 
00057 // Global functions are needed to define the input of the flex scanner
00058 // and to start the bison parser.
00059 // The input is taken from a string.
00060 // </synopsis> 
00061 
00062 // <motivation>
00063 // It is necessary to be able to give an image expression in ASCII.
00064 // This can be used in glish.
00065 // </motivation>
00066 // <todo asof="$DATE:$">
00067 //# A List of bugs, limitations, extensions or planned refinements.
00068 // </todo>
00069 
00070 
00071 // <group name=MSFieldGramFunctions>
00072 
00073 // Declare the bison parser (is implemented by bison command).
00074   // TableExprNode msFieldGramParseCommand (const MeasurementSet *ms, const String& command);
00075   // TableExprNode msFieldGramParseCommand (MSSelectableTable *ms, const String& command,Vector<Int>&);
00076   // TableExprNode msFieldGramParseCommand (const MeasurementSet *ms, const String& command,Vector<Int>&);
00077   TableExprNode msFieldGramParseCommand (const MSField& fieldSubTable, const TableExprNode& colAsTEN, 
00078                                          const String& command,Vector<Int>&);
00079   TableExprNode baseMSFieldGramParseCommand (MSFieldParse *parser, const String& command,Vector<Int>&);
00080 
00081 // The yyerror function for the parser.
00082 // It throws an exception with the current token.
00083 void MSFieldGramerror (const char*);
00084 
00085 // Give the table expression node.
00086 const TableExprNode *msFieldGramParseNode();
00087 void msFieldGramParseDeleteNode() ;
00088 
00089 // Give the current position in the string.
00090 // This can be used when parse errors occur.
00091 Int& msFieldGramPosition();
00092 
00093 // Declare the input routine for flex/bison.
00094 int msFieldGramInput (char* buf, int max_size);
00095 
00096 // A function to remove escaped characters.
00097 //String msFieldGramRemoveEscapes (const String& in);
00098 
00099 // A function to remove quotes from a quoted string.
00100 //String msFieldGramRemoveQuotes (const String& in);
00101 
00102 // </group>
00103 
00104 } //# NAMESPACE CASA - END
00105 
00106 #endif