← Back to branch summary

~ubuntu-branches/debian/sid/kdevelop/sid

« back to all changes in this revision

Viewing changes to lib/catalog/catalog.h

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Lainé
  • Date: 2010-05-05 07:21:55 UTC
  • mfrom: (1.2.3 upstream) (5.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100505072155-h78lx19pu04sbhtn
Tags: 4:4.0.0-2
http://bugs.debian.org/579947
http://bugs.debian.org/481832
http://bugs.debian.org/562410
http://bugs.debian.org/546961
* Upload to unstable (Closes: #579947, #481832).
* Acknowledge obsolete NMU fixes (Closes: #562410, #546961).

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/catalog/catalog.h
1
 
/* This file is part of KDevelop
2
 
    Copyright (C) 2003 Roberto Raggi <roberto@kdevelop.org>
3
 
 
4
 
    This library is free software; you can redistribute it and/or
5
 
    modify it under the terms of the GNU Library General Public
6
 
    License as published by the Free Software Foundation; either
7
 
    version 2 of the License, or (at your option) any later version.
8
 
 
9
 
    This library is distributed in the hope that it will be useful,
10
 
    but WITHOUT ANY WARRANTY; without even the implied warranty of
11
 
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 
    Library General Public License for more details.
13
 
 
14
 
    You should have received a copy of the GNU Library General Public License
15
 
    along with this library; see the file COPYING.LIB.  If not, write to
16
 
    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17
 
    Boston, MA 02111-1307, USA.
18
 
*/
19
 
 
20
 
#ifndef CATALOG_H
21
 
#define CATALOG_H
22
 
 
23
 
#include <qvaluelist.h>
24
 
#include <qpair.h>
25
 
#include <qvariant.h>
26
 
 
27
 
 
28
 
#include "tag.h"
29
 
/**
30
 
@file catalog.h
31
 
Catalog database - the persistent symbol store database.
32
 
*/
33
 
 
34
 
/**
35
 
Catalog objects represent separate symbol databases.
36
 
Catalogs can be created/loaded/unloaded dynamically.
37
 
To find a symbol in the repository each catalog should be queried.
38
 
 
39
 
Persistent symbol store is useful to keep information about code that
40
 
never or rarely changes. System libraries are perfect examples of such code.
41
 
*/
42
 
class Catalog
43
 
{
44
 
public:
45
 
    typedef QPair<QCString, QVariant> QueryArgument;
46
 
 
47
 
public:
48
 
    Catalog();
49
 
    virtual ~Catalog();
50
 
 
51
 
    bool isValid() const;
52
 
    QString dbName() const;
53
 
 
54
 
    bool enabled() const;
55
 
    void setEnabled( bool en );
56
 
 
57
 
    virtual void open( const QString& dbName );
58
 
    virtual void close();
59
 
    virtual void sync();
60
 
 
61
 
    QValueList<QCString> indexList() const;
62
 
    void addIndex( const QCString& name );
63
 
 
64
 
    void addItem( Tag& tag );
65
 
 
66
 
    Tag getItemById( const QCString& id );
67
 
    QValueList<Tag> query( const QValueList<QueryArgument>& args );
68
 
 
69
 
    QCString generateId();
70
 
 
71
 
private:
72
 
   class _Catalog_Private* d;
73
 
 
74
 
private:
75
 
    Catalog( const Catalog& source );
76
 
    void operator = ( const Catalog& source );
77
 
};
78
 
 
79
 
 
80
 
#endif