vcs/vcslocation.h

   1 /* This file is part of KDevelop
   2  *
   3  * Copyright 2007 Andreas Pakulat <apaku@gmx.de>
   4  * Copyright 2007 Matthew Woehlke <mw_triad@users.sourceforge.net>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19  * 02110-1301, USA.
  20  */
  21
  22 #ifndef KDEVVCSLOCATION_H
  23 #define KDEVVCSLOCATION_H
  24
  25 #include "vcsexport.h"
  26 #include <QtCore/QList>
  27 #include <kurl.h>
  28
  29
  30 namespace KDevelop
  31 {
  32 /**
  33  * Denotes a local or repository location for a Vcs system
  34  *
  35  * For the RepositoryLocation type most of the informations
  36  * are vcs specific
  37  */
  38 class KDEVPLATFORMVCS_EXPORT VcsLocation
  39 {
  40 public:
  41     enum LocationType
  42     {
  43         LocalLocation = 0      /**< this is a local location */,
  44         RepositoryLocation = 1 /**< this is a repository location */
  45     };
  46
  47     VcsLocation();
  48     VcsLocation( const KUrl& );
  49     VcsLocation( const QString& );
  50     ~VcsLocation();
  51     VcsLocation( const VcsLocation& );
  52     VcsLocation& operator=( const VcsLocation& );
  53
  54     /**
  55      * @returns Local url if this location is a LocalLocation
  56      */
  57     KUrl localUrl() const;
  58
  59     /**
  60      * Returns a string for the repository, usually this identifies the server
  61      * @returns a vcs-implementation-specific string identifying the server
  62      */
  63     QString repositoryServer() const;
  64     /**
  65      * Returns the module or module path inside the server
  66      * @returns a vcs-implementation-specific string identifying the module
  67      */
  68     QString repositoryModule() const;
  69     /**
  70      * identifies the tag which this location belongs to
  71      * @returns a vcs-implementation-specific string identifying the tag
  72      */
  73     QString repositoryTag() const;
  74     /**
  75      * identifies the branch to which this location belongs to
  76      * @returns a vcs-implementation-specific string identifying the branch
  77      */
  78     QString repositoryBranch() const;
  79     /**
  80      * This can define a path relative to the module, this is used
  81      * when identifying a subdirectory or file inside a repository location
  82      * @returns a path relative to module
  83      */
  84     QString repositoryPath() const;
  85     /**
  86      * @returns the type of this location
  87      */
  88     VcsLocation::LocationType type() const;
  89
  90     /**
  91      * Set the local url for this location, automatically sets the type to LocalLocation
  92      * @param url the local url
  93      */
  94     void setLocalUrl( const KUrl& url );
  95
  96     /**
  97      * Set the server string for this location, automatically sets the type to RepositoryLocation
  98      */
  99     void setRepositoryServer( const QString& );
 100     /**
 101      * Set the module for this location, automatically sets the type to RepositoryLocation
 102      */
 103     void setRepositoryModule( const QString& );
 104     /**
 105      * Set the branch string for this location, automatically sets the type to RepositoryLocation
 106      */
 107     void setRepositoryBranch( const QString& );
 108     /**
 109      * Set the tag string for this location, automatically sets the type to RepositoryLocation
 110      */
 111     void setRepositoryTag( const QString& );
 112     /**
 113      * Set the path for this location, automatically sets the type to RepositoryLocation
 114      */
 115     void setRepositoryPath( const QString& );
 116
 117     /**
 118      * Allows to add vcs-specific data to this location
 119      * automatically sets the type to RepositoryLocation
 120      * @param data the vcs-specific data
 121      */
 122     void setUserData( const QVariant& );
 123
 124     /**
 125      * retrieve vcs-specific data
 126      */
 127     QVariant userData() const;
 128
 129     bool operator==( const KDevelop::VcsLocation& );
 130
 131     bool isValid() const;
 132
 133 private:
 134     class VcsLocationPrivate* d;
 135 };
 136
 137 inline uint qHash( const KDevelop::VcsLocation& loc )
 138 {
 139     if( loc.type() == KDevelop::VcsLocation::LocalLocation )
 140     {
 141         return qHash(loc.localUrl());
 142     }else
 143     {
 144         return qHash(loc.repositoryServer());
 145     }
 146 }
 147
 148 inline bool operator==( const KDevelop::VcsLocation& lhs, const KDevelop::VcsLocation& rhs )
 149 {
 150     return( lhs.type() == rhs.type()
 151             && lhs.repositoryServer() == rhs.repositoryServer()
 152             && lhs.localUrl() == rhs.localUrl() );
 153 }
 154
 155 }
 156
 157 Q_DECLARE_METATYPE( KDevelop::VcsLocation )
 158
 159 #endif
 160