KDevelop API Documentation

CVSDir Class Reference

Helper classes for handling CVS dirs. More...

#include <cvsdir.h>

Inheritance diagram for CVSDir:

Inheritance graph
[legend]
Collaboration diagram for CVSDir:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CVSDir ()
 CVSDir (const QDir &dir)
 CVSDir (const CVSDir &)
CVSDiroperator= (const CVSDir &)
virtual ~CVSDir ()
bool isValid () const
 A client can use this method to validate the directory state.
QStringList registeredEntryList () const
 Returns a list of all the files registered into repository.
CVSEntry fileStatus (const QString &fileName, bool refreshCache=false) const
VCSFileInfoMap dirStatus () const
VCSFileInfoMapcacheableDirStatus () const
bool isRegistered (const QString fileName) const
void ignoreFile (const QString &fileName)
 Check if the specified fileName is in "<CVSDIR>/.cvsignore" and, if not, append it.
void doNotIgnoreFile (const QString &fileName)
 Check if the specified fileName is in "<CVSDIR>/.cvsignore" and, if yes, remove it.
QString repository () const
QString root () const
QString entriesFileName () const
QString rootFileName () const
QString repoFileName () const
QString cvsIgnoreFileName () const

Private Types

typedef QMap< QString, CVSEntryCVSEntriesCacheMap

Private Member Functions

void refreshEntriesCache () const

Static Private Member Functions

QByteArray cacheFile (const QString &fileName)

Private Attributes

QString m_cvsDir
CVSEntriesCacheMap m_cachedEntries

Detailed Description

Helper classes for handling CVS dirs.

Author:
Mario Scalas

Definition at line 26 of file cvsdir.h.


Member Typedef Documentation

typedef QMap<QString,CVSEntry> CVSDir::CVSEntriesCacheMap [private]
 

Definition at line 99 of file cvsdir.h.


Constructor & Destructor Documentation

CVSDir::CVSDir  ) 
 

Definition at line 21 of file cvsdir.cpp.

CVSDir::CVSDir const QDir dir  ) 
 

Definition at line 27 of file cvsdir.cpp.

References isValid(), m_cvsDir, and refreshEntriesCache().

CVSDir::CVSDir const CVSDir  )  [explicit]
 

Definition at line 41 of file cvsdir.cpp.

CVSDir::~CVSDir  )  [virtual]
 

Definition at line 60 of file cvsdir.cpp.


Member Function Documentation

VCSFileInfoMap * CVSDir::cacheableDirStatus  )  const
 

Convert to VCSFileInfoMap:

Fixme:
: any speed improvement here?

Definition at line 305 of file cvsdir.cpp.

References fileStatus(), registeredEntryList(), CVSEntry::toVCSFileInfo(), and VCSFileInfoMap.

Referenced by CVSFileInfoProvider::status().

QByteArray CVSDir::cacheFile const QString fileName  )  [static, private]
 

Definition at line 143 of file cvsdir.cpp.

Referenced by refreshEntriesCache(), registeredEntryList(), repository(), and root().

QString CVSDir::cvsIgnoreFileName  )  const
 

Returns:
full path of "<this-dir>/.cvsignore"

Definition at line 97 of file cvsdir.cpp.

Referenced by doNotIgnoreFile(), and ignoreFile().

VCSFileInfoMap CVSDir::dirStatus  )  const
 

Convert to VCSFileInfoMap:

Fixme:
: any speed improvement here?

Definition at line 287 of file cvsdir.cpp.

References fileStatus(), registeredEntryList(), CVSEntry::toVCSFileInfo(), and VCSFileInfoMap.

void CVSDir::doNotIgnoreFile const QString fileName  ) 
 

Check if the specified fileName is in "<CVSDIR>/.cvsignore" and, if yes, remove it.

Definition at line 250 of file cvsdir.cpp.

References cvsIgnoreFileName(), and isValid().

QString CVSDir::entriesFileName  )  const
 

Returns:
full path of "<this-dir>/CVS/Entries"

Definition at line 76 of file cvsdir.cpp.

References m_cvsDir.

Referenced by isValid(), refreshEntriesCache(), and registeredEntryList().

CVSEntry CVSDir::fileStatus const QString fileName,
bool  refreshCache = false
const
 

Parameters:
fileName is the file name (with no path info, just the file name!)
refreshCache update internal cache re-parsing "<dirPath>/CVS/Entries"
Returns:
an empty CVSEntry if the file is not present

Definition at line 200 of file cvsdir.cpp.

References m_cachedEntries, and refreshEntriesCache().

Referenced by cacheableDirStatus(), dirStatus(), isRegistered(), and CvsServicePartImpl::isRegisteredInRepository().

void CVSDir::ignoreFile const QString fileName  ) 
 

Check if the specified fileName is in "<CVSDIR>/.cvsignore" and, if not, append it.

Definition at line 215 of file cvsdir.cpp.

References cvsIgnoreFileName(), and isValid().

bool CVSDir::isRegistered const QString  fileName  )  const
 

Returns:
true if the file is registered into repository, false otherwise

Definition at line 174 of file cvsdir.cpp.

References CVSEntry::fileName(), fileStatus(), and CVSEntry::isValid().

bool CVSDir::isValid  )  const
 

A client can use this method to validate the directory state.

Returns:
true if the directory is a valid CVS dir, false otherwise

Definition at line 66 of file cvsdir.cpp.

References entriesFileName(), repoFileName(), and rootFileName().

Referenced by CVSDir(), doNotIgnoreFile(), ignoreFile(), CvsServicePartImpl::isRegisteredInRepository(), CvsServicePartImpl::isValidDirectory(), registeredEntryList(), repository(), and root().

CVSDir & CVSDir::operator= const CVSDir  ) 
 

Definition at line 49 of file cvsdir.cpp.

References m_cachedEntries, and m_cvsDir.

void CVSDir::refreshEntriesCache  )  const [private]
 

Definition at line 182 of file cvsdir.cpp.

References cacheFile(), entriesFileName(), CVSEntry::fileName(), CVSEntry::isValid(), m_cachedEntries, and CVSEntry::parse().

Referenced by CVSDir(), and fileStatus().

QStringList CVSDir::registeredEntryList  )  const
 

Returns a list of all the files registered into repository.

Definition at line 153 of file cvsdir.cpp.

References cacheFile(), entriesFileName(), CVSEntry::fileName(), CVSEntry::isValid(), isValid(), and CVSEntry::parse().

Referenced by cacheableDirStatus(), and dirStatus().

QString CVSDir::repoFileName  )  const
 

Returns:
full path of "<this-dir>/CVS/Repository"

Definition at line 90 of file cvsdir.cpp.

References m_cvsDir.

Referenced by isValid(), repository(), and root().

QString CVSDir::repository  )  const
 

Returns:
the content of "<CVSDIR>/CVS/Repository"

Definition at line 104 of file cvsdir.cpp.

References cacheFile(), isValid(), and repoFileName().

QString CVSDir::root  )  const
 

Returns:
the content of "<CVSDIR>/CVS/Root"

Definition at line 124 of file cvsdir.cpp.

References cacheFile(), isValid(), and repoFileName().

QString CVSDir::rootFileName  )  const
 

Returns:
full path of "<this-dir>/CVS/Root"

Definition at line 83 of file cvsdir.cpp.

References m_cvsDir.

Referenced by isValid().


Member Data Documentation

CVSEntriesCacheMap CVSDir::m_cachedEntries [mutable, private]
 

Definition at line 100 of file cvsdir.h.

Referenced by fileStatus(), operator=(), and refreshEntriesCache().

QString CVSDir::m_cvsDir [private]
 

Definition at line 97 of file cvsdir.h.

Referenced by CVSDir(), entriesFileName(), operator=(), repoFileName(), and rootFileName().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 23 00:21:47 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003