version.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 #ifndef ZORBA_VERSION_API_H
00017 #define ZORBA_VERSION_API_H
00018 
00019 #include <string>
00020 
00021 namespace zorba {
00022 
00023   /**
00024    * Provide access to the version of %Zorba that is used
00025    */
00026   class Version
00027   { 
00028     protected:
00029       static int theMajorVersion;
00030       static int theMinorVersion;
00031       static int thePatchVersion;
00032 
00033     public:
00034       /** \brief Get the major version
00035        */
00036       static int 
00037       getMajorVersion();
00038 
00039       /** \brief Get the minor version
00040        */
00041       static int 
00042       getMinorVersion();
00043 
00044       /** \brief Get the patch version
00045        */
00046       static int 
00047       getPatchVersion();
00048 
00049       /** \brief Get the %Zorba version as std::string
00050        *
00051        * Form: MajorVersion.MinorVersion.PatchVersion
00052        */
00053       static std::string
00054       getVersion();
00055 
00056   };
00057 
00058   /** \brief Write the result of calling aVersiongetVersion() to the given
00059    *         output stream.
00060    */
00061   std::ostream& 
00062   operator<< (std::ostream& os, const Version& aVersion);
00063 
00064 
00065 } /* end namespace zorba */
00066 #endif