diff options
Diffstat (limited to 'lib/catalog/catalog.h')
-rw-r--r-- | lib/catalog/catalog.h | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/lib/catalog/catalog.h b/lib/catalog/catalog.h new file mode 100644 index 00000000..8183acaf --- /dev/null +++ b/lib/catalog/catalog.h @@ -0,0 +1,80 @@ +/* This file is part of KDevelop + Copyright (C) 2003 Roberto Raggi <[email protected]> + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public License + along with this library; see the file COPYING.LIB. If not, write to + the Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. +*/ + +#ifndef CATALOG_H +#define CATALOG_H + +#include <qvaluelist.h> +#include <qpair.h> +#include <qvariant.h> + + +#include "tag.h" +/** +@file catalog.h +Catalog database - the persistent symbol store database. +*/ + +/** +Catalog objects represent separate symbol databases. +Catalogs can be created/loaded/unloaded dynamically. +To find a symbol in the repository each catalog should be queried. + +Persistent symbol store is useful to keep information about code that +never or rarely changes. System libraries are perfect examples of such code. +*/ +class Catalog +{ +public: + typedef QPair<QCString, QVariant> QueryArgument; + +public: + Catalog(); + virtual ~Catalog(); + + bool isValid() const; + QString dbName() const; + + bool enabled() const; + void setEnabled( bool en ); + + virtual void open( const QString& dbName ); + virtual void close(); + virtual void sync(); + + QValueList<QCString> indexList() const; + void addIndex( const QCString& name ); + + void addItem( Tag& tag ); + + Tag getItemById( const QCString& id ); + QValueList<Tag> query( const QValueList<QueryArgument>& args ); + + QCString generateId(); + +private: + class _Catalog_Private* d; + +private: + Catalog( const Catalog& source ); + void operator = ( const Catalog& source ); +}; + + +#endif |