query_location.h
Go to the documentation of this file.
1 /*
2  * Copyright 2006-2008 The FLWOR Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef QUERYLOCATION_H
18 #define QUERYLOCATION_H
19 
20 #include <zorba/config.h>
21 #include <zorba/smart_ptr.h>
22 #include <zorba/api_shared_types.h>
23 
24 namespace zorba{
25 
26  /**
27  * Representation of the current location location
28  * in the remote query.
29  * This location goes from the starting line and column
30  * to the ending line and column.
31  */
32  class ZORBA_DLL_PUBLIC QueryLocation: public SmartObject
33  {
34  public:
35 
36  virtual
38 
39  virtual String
40  getFileName() const = 0;
41 
42  virtual unsigned int
43  getLineBegin() const = 0;
44 
45  virtual unsigned int
46  getLineEnd() const = 0;
47 
48  virtual unsigned int
49  getColumnBegin() const = 0;
50 
51  virtual unsigned int
52  getColumnEnd() const = 0;
53 
54  virtual String
55  toString() const = 0;
56  };
57 
58 } // namespace zorba
59 
60 #endif // QUERYLOCATION_H
61 /* vim:set et sw=2 ts=2: */