MSScanGram.h

Go to the documentation of this file.
00001 //# MSScanGram.h: Grammar for ms scan 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$
00027 
00028 #ifndef MS_MSSCANGRAM_H
00029 #define MS_MSSCANGRAM_H
00030 
00031 
00032 //# Includes
00033 #include <casacore/casa/aips.h>
00034 #include <casacore/casa/BasicSL/String.h>
00035 #include <casacore/ms/MSSel/MSScanParse.h> // routines used by bison actions
00036 
00037 namespace casacore { //# NAMESPACE CASACORE - BEGIN
00038 
00039 //# Forward Declarations
00040 class MeasurementSet;
00041 class TableExprNode;
00042 
00043 // <summary>
00044 // Global functions for flex/bison scanner/parser for MSScanGram
00045 // </summary>
00046 
00047 // <use visibility=local>
00048 
00049 // <reviewed reviewer="" date="" tests="">
00050 // </reviewed>
00051 
00052 // <prerequisite>
00053 //# Classes you should understand before using this one.
00054 //  <li> MSScanGram.l and .y  (flex and bison grammar)
00055 // </prerequisite>
00056 
00057 // <synopsis> 
00058 // Global functions are needed to define the input of the flex scanner
00059 // and to start the bison parser.
00060 // The input is taken from a string.
00061 // </synopsis> 
00062 
00063 // <motivation>
00064 // It is necessary to be able to give an image expression in ASCII.
00065 // This can be used in glish.
00066 // </motivation>
00067 // <todo asof="$DATE:$">
00068 //# A List of bugs, limitations, extensions or planned refinements.
00069 // </todo>
00070 
00071 
00072 // <group name=MSScanGramFunctions>
00073 
00074 // Declare the bison parser (is implemented by bison command).
00075   TableExprNode baseMSScanGramParseCommand (MSScanParse* parser, const String& command, 
00076                                             Vector<Int>& idList, Int maxScans=1000);
00077   TableExprNode msScanGramParseCommand (const MeasurementSet *ms, const String& command, 
00078                                         Vector<Int>& idList, Int maxScans=1000);
00079   TableExprNode msScanGramParseCommand (const MeasurementSet* ms,
00080                                         const TableExprNode& colAsTEN,
00081                                         const String& command, 
00082                                         Vector<Int>& selectedIDs, Int maxScans) ;
00083 
00084 // The yyerror function for the parser.
00085 // It throws an exception with the current token.
00086 void MSScanGramerror (const char*);
00087 
00088 // Give the table expression node.
00089 //const TableExprNode *msScanGramParseNode();
00090 void msScanGramParseDeleteNode();
00091 
00092 // Give the current position in the string.
00093 // This can be used when parse errors occur.
00094 Int& msScanGramPosition();
00095 
00096 // Declare the input routine for flex/bison.
00097 int msScanGramInput (char* buf, int max_size);
00098 
00099 // A function to remove escaped characters.
00100 //String msScanGramRemoveEscapes (const String& in);
00101 
00102 // A function to remove quotes from a quoted string.
00103 //String msScanGramRemoveQuotes (const String& in);
00104 
00105 // </group>
00106 
00107 } //# NAMESPACE CASACORE - END
00108 
00109 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1