#include <kdevcoderepository.h>
Inherits TQObject.
Signals | |
void | catalogRegistered (Catalog *catalog) |
void | catalogUnregistered (Catalog *catalog) |
void | catalogChanged (Catalog *catalog) |
Public Member Functions | |
KDevCodeRepository () | |
virtual | ~KDevCodeRepository () |
Catalog * | mainCatalog () |
void | setMainCatalog (Catalog *mainCatalog) |
TQValueList< Catalog * > | registeredCatalogs () |
void | registerCatalog (Catalog *catalog) |
void | unregisterCatalog (Catalog *catalog) |
void | touchCatalog (Catalog *catalog) |
Detailed Description
Code repository - the persistent symbol store accessor.
Symbols from parsed files can be saved to the persistent symbol store. Persistence in this case means that symbol database is never loaded into memory and works like a usual database which executes queries.
Code repository consists from Catalog objects that 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. Symbols from code contained in project files are better stored in memory symbol store like CodeModel.
Definition at line 48 of file kdevcoderepository.h.
Constructor & Destructor Documentation
◆ KDevCodeRepository()
KDevCodeRepository::KDevCodeRepository | ( | ) |
Constructor.
Definition at line 29 of file kdevcoderepository.cpp.
◆ ~KDevCodeRepository()
|
virtual |
Destructor.
Definition at line 34 of file kdevcoderepository.cpp.
Member Function Documentation
◆ catalogChanged
|
signal |
Emitted when the contens of catalog is changed.
- Parameters
-
catalog Changed catalog.
◆ catalogRegistered
|
signal |
Emitted when a new catalog is registered.
- Parameters
-
catalog The new catalog.
◆ catalogUnregistered
|
signal |
Emitted when a catalog in removed.
- Parameters
-
catalog The catalog that was removed.
◆ mainCatalog()
Catalog * KDevCodeRepository::mainCatalog | ( | ) |
- Returns
- The main catalog. Each catalog can be marked is main to provide easy access to it.
Definition at line 39 of file kdevcoderepository.cpp.
◆ registerCatalog()
void KDevCodeRepository::registerCatalog | ( | Catalog * | catalog | ) |
Registers catalog in the repository.
- Parameters
-
catalog The catalog to register.
Definition at line 49 of file kdevcoderepository.cpp.
◆ registeredCatalogs()
TQValueList< Catalog *> KDevCodeRepository::registeredCatalogs | ( | ) |
- Returns
- The list of registered catalogs.
Definition at line 66 of file kdevcoderepository.cpp.
◆ setMainCatalog()
void KDevCodeRepository::setMainCatalog | ( | Catalog * | mainCatalog | ) |
Sets the main catalog.
- Parameters
-
mainCatalog The catalog to be marked as main.
Definition at line 44 of file kdevcoderepository.cpp.
◆ touchCatalog()
void KDevCodeRepository::touchCatalog | ( | Catalog * | catalog | ) |
Marks catalog as changed and emits catalogChanged signal.
- Parameters
-
catalog The catalog to touch.
Definition at line 61 of file kdevcoderepository.cpp.
◆ unregisterCatalog()
void KDevCodeRepository::unregisterCatalog | ( | Catalog * | catalog | ) |
Unregisters catalog from the repository.
- Parameters
-
catalog The catalog to unregister.
Definition at line 55 of file kdevcoderepository.cpp.
The documentation for this class was generated from the following files: