query_location.h
Go to the documentation of this file.
00001 /*
00002  * Copyright 2006-2008 The FLWOR Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  * 
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 #ifndef QUERYLOCATION_H
00018 #define QUERYLOCATION_H
00019 
00020 #include <zorba/config.h>
00021 #include <zorba/smart_ptr.h>
00022 #include <zorba/api_shared_types.h>
00023 
00024 namespace zorba{
00025 
00026   /**
00027    * Representation of the current location location
00028    * in the remote query.
00029    * This location goes from the starting line and column
00030    * to the ending line and column.
00031    */
00032   class ZORBA_DLL_PUBLIC QueryLocation: public SmartObject
00033   {
00034     public:
00035 
00036       virtual
00037       ~QueryLocation(){}
00038 
00039       virtual String
00040       getFileName() const = 0;
00041 
00042       virtual unsigned int
00043       getLineBegin() const = 0;
00044 
00045       virtual unsigned int
00046       getLineEnd() const = 0;
00047 
00048       virtual unsigned int
00049       getColumnBegin() const = 0;
00050 
00051       virtual unsigned int
00052       getColumnEnd() const = 0;
00053 
00054       virtual String
00055       toString() const = 0;
00056   };
00057 
00058 } // namespace zorba
00059 
00060 #endif // QUERYLOCATION_H
00061 /* vim:set et sw=2 ts=2: */
blog comments powered by Disqus