1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
|
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
//
// copyright : (C) 2008 by Eran Ifrah
// file name : tags_database.h
//
// -------------------------------------------------------------------------
// A
// _____ _ _ _ _
// / __ \ | | | | (_) |
// | / \/ ___ __| | ___| | _| |_ ___
// | | / _ \ / _ |/ _ \ | | | __/ _ )
// | \__/\ (_) | (_| | __/ |___| | || __/
// \____/\___/ \__,_|\___\_____/_|\__\___|
//
// F i l e
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
//////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////
#ifndef CODELITE_TAGS_DATABASE_H
#define CODELITE_TAGS_DATABASE_H
#include "codelite_exports.h"
#include "entry.h"
#include "fileentry.h"
#include "istorage.h"
#include "tag_tree.h"
#include "wxStringHash.h"
#include <unordered_map>
#include <wx/filename.h>
#include <wx/wxsqlite3.h>
/**
* TagsDatabase is a wrapper around wxSQLite3 database with tags specific functions.
* It allows caller to query and populate the SQLite database for tags with a set of convinient functions.
* this class is responsible for creating the schema for the CodeLite library.
*
* The tables are automatically created once a database is created
*
* Database tables:
*
* Table Name: TAGS
*
* || Column Name || Type || Description
* |id | Number | ID
* |Name | String | Tag name is appears in ctags output file
* |File | String | File that this tag was found in
* |Line | Number | Line number
* |Kind | String | Tag kind, can be one of: function, prototype, class, namespace, variable, member, enum,
* enumerator, macro, project, union, typedef
* |Access | String | Can be one of public, private protected
* |Signature | String | For functions, this column holds the function signature
* |Pattern | String | pattern that can be used to located this tag in the file
* |Parent | String | tag direct parent, can be its class parent (for members or functions), namespace or the
* literal "<global>"
* |Inherits | String | If this class/struct inherits from other class, it will cotain the name of the base class
* |Path | String | full name including path, (e.g. Project::ClassName::FunctionName
* |Typeref | String | Special type of tag, that points to other Tag (i.e. typedef)
*
* Table Name: TAGS_VERSION
*
* || Column Name || Type || Description
* | Version | String | contains the current database schema
*
* Table Name: FILES
*
* || Column Name || Type || Description
* | id | Number | ID
* | file | String | Full path of the file
* | last_retagged| Number | Timestamp for the last time this file was retagged
*
* Table Name: MACROS
*
* || Column Name || Type || Description
* | id | Number | ID
* | File | String | The file where this macro was found
* | Line | int | The line number where this macro was found
* | Name | String | The macro name
* | IsFunctionLike | int | Contains 1 if this entry is "function" like macro, 0 otherwise
* | Replacement | String | the replacement string (processed. i.e. %0..%N as placeholders for the arguments)
* | Signature | String | For macro of type 'IsFunctionLike', contains the signature in the form of (%0,...%N)
*
* @date 08-22-2006
* @author Eran
* @ingroup CodeLite
*/
class TagsStorageSQLiteCache
{
std::unordered_map<wxString, std::vector<TagEntryPtr>> m_cache;
protected:
bool DoGet(const wxString& key, std::vector<TagEntryPtr>& tags);
void DoStore(const wxString& key, const std::vector<TagEntryPtr>& tags);
public:
TagsStorageSQLiteCache();
virtual ~TagsStorageSQLiteCache();
bool Get(const wxString& sql, std::vector<TagEntryPtr>& tags);
bool Get(const wxString& sql, const wxArrayString& kind, std::vector<TagEntryPtr>& tags);
void Store(const wxString& sql, const std::vector<TagEntryPtr>& tags);
void Store(const wxString& sql, const wxArrayString& kind, const std::vector<TagEntryPtr>& tags);
void Clear();
};
class WXDLLIMPEXP_CL clSqliteDB : public wxSQLite3Database
{
std::unordered_map<wxString, wxSQLite3Statement> m_statements;
public:
clSqliteDB()
: wxSQLite3Database()
{
}
void Close()
{
if(IsOpen()) wxSQLite3Database::Close();
m_statements.clear();
}
wxSQLite3Statement GetPrepareStatement(const wxString& sql) { return wxSQLite3Database::PrepareStatement(sql); }
};
class WXDLLIMPEXP_CL TagsStorageSQLite : public ITagsStorage
{
clSqliteDB* m_db;
TagsStorageSQLiteCache m_cache;
private:
/**
* @brief fetch tags from the database
* @param sql
* @param tags
*/
void DoFetchTags(const wxString& sql, std::vector<TagEntryPtr>& tags);
/**
* @brief
* @param sql
* @param tags
*/
void DoFetchTags(const wxString& sql, std::vector<TagEntryPtr>& tags, const wxArrayString& kinds);
void DoAddNamePartToQuery(wxString& sql, const wxString& name, bool partial, bool prependAnd);
void DoAddLimitPartToQuery(wxString& sql, const std::vector<TagEntryPtr>& tags);
int DoInsertTagEntry(const TagEntry& tag);
public:
static TagEntry* FromSQLite3ResultSet(wxSQLite3ResultSet& rs);
static void PPTokenFromSQlite3ResultSet(wxSQLite3ResultSet& rs, PPToken& token);
public:
/**
* Execute a query sql and return result set.
* @param sql Select statement
* @param path Database file to use
* @return result set
*/
wxSQLite3ResultSet Query(const wxString& sql, const wxFileName& path = wxFileName());
/**
* Construct a tags database.
*/
TagsStorageSQLite();
/**
*
* Destructor
*/
virtual ~TagsStorageSQLite();
virtual void SetUseCache(bool useCache);
/**
* Return the currently opened database.
* @return Currently open database
*/
const wxFileName& GetDatabaseFileName() const { return m_fileName; }
/**
* Open sqlite database.
* @param fileName Database file name
*/
void OpenDatabase(const wxFileName& fileName);
/**
* @brief reopen the database. If it is already opened - close it before
*/
void ReOpenDatabase();
long LastRowId() const;
/**
* Create database if not existed already.
*/
void CreateSchema();
/**
* Store tree of tags into db.
* @param tree Tags tree to store
* @param path Database file name
* @param autoCommit handle the Store operation inside a transaction or let the user hadle it
*/
void Store(TagTreePtr tree, const wxFileName& path, bool autoCommit = true);
/**
* Return a result set of tags according to file name.
* @param file Source file name
* @param path Database file name
* @return result set
*/
virtual void SelectTagsByFile(const wxString& file, std::vector<TagEntryPtr>& tags,
const wxFileName& path = wxFileName());
/**
* Delete all entries from database that are related to filename.
* @param path Database name
* @param fileName File name
* @param autoCommit handle the Delete operation inside a transaction or let the user hadle it
*/
void DeleteByFileName(const wxFileName& path, const wxString& fileName, bool autoCommit = true);
/**
* @brief delete all tags from database which their file's path begins with a given prefix
* @param dbpath database file name
* @param filePrefix prefix criterion
*/
void DeleteByFilePrefix(const wxFileName& dbpath, const wxString& filePrefix);
/**
* @brief delete all files from FILES table which starts with filePrefix
* @param dbpath database file name
* @param filePrefix prefix criterion
*/
void DeleteFromFilesByPrefix(const wxFileName& dbpath, const wxString& filePrefix);
/**
* @brief delete files from FILES table
* @param files
*/
void DeleteFromFiles(const wxArrayString& files);
/**
* @brief return list of tags of type 'dereference operator (->)' for a given scope
* @param scope
* @param tags [output]
*/
virtual void GetDereferenceOperator(const wxString& scope, std::vector<TagEntryPtr>& tags);
/**
* @brief return list of tags of type 'subscript operator' for a given scope
* @param scope
* @param tags [output]
*/
virtual void GetSubscriptOperator(const wxString& scope, std::vector<TagEntryPtr>& tags);
/**
* Begin transaction.
*/
void Begin()
{
try {
m_db->Begin();
} catch(wxSQLite3Exception& e) {
wxUnusedVar(e);
}
}
/**
* Commit transaction.
*/
void Commit()
{
try {
m_db->Commit();
} catch(wxSQLite3Exception& e) {
wxUnusedVar(e);
}
}
/**
* Rollback transaction.
*/
void Rollback() { return m_db->Rollback(); }
/**
* Test whether the database is opened
* @return true if database is attached to a file
*/
const bool IsOpen() const;
/**
* Return SQLite3 preapre statement object
* @param sql sql
* @return wxSQLite3ResultSet object
*/
wxSQLite3Statement PrepareStatement(const wxString& sql) { return m_db->PrepareStatement(sql); }
/**
* Execute query
* @param sql sql to execute
*/
void ExecuteUpdate(const wxString& sql);
/**
* A very dengerous API call, which drops all tables from the database
* and recreate the schema from fresh. It is used when upgrading database between different
* versions
*/
void RecreateDatabase();
/**
* return list of files from the database. The returned list is ordered
* by name (ascending)
* @param partialName part of the file name to act as a filter
* @param files [output] array of files
*/
void GetFiles(const wxString& partialName, std::vector<FileEntryPtr>& files);
/**
* @brief this function is for supporting CC inside an include statement
* line
*/
virtual void GetFilesForCC(const wxString& userTyped, wxArrayString& matches);
/**
* @brief return list of files from the database
* @param files vector of database record
*/
void GetFiles(std::vector<FileEntryPtr>& files);
//----------------------------------------------------------
//----------------------------------------------------------
//----------------------------------------------------------
// Implementation of the IStorage methods
//----------------------------------------------------------
//----------------------------------------------------------
//----------------------------------------------------------
//----------------------------- Meta Data ---------------------------------------
/**
* Return the current version of the database library .
* @return current version of the database library
*/
const wxString& GetVersion() const;
/**
* Schema version as appears in TAGS_VERSION table
* @return schema's version
*/
wxString GetSchemaVersion() const;
// --------------------------------------------------------------------------------------------
/**
* @brief return list of tags based on scope and name
* @param scope the scope to search. If 'scope' is empty the scope is ommited from the search
* @param name
* @param partialNameAllowed
* @param tags [output]
*/
virtual void GetTagsByScopeAndName(const wxString& scope, const wxString& name, bool partialNameAllowed,
std::vector<TagEntryPtr>& tags);
virtual void GetTagsByScopeAndName(const wxArrayString& scope, const wxString& name, bool partialNameAllowed,
std::vector<TagEntryPtr>& tags);
/**
* @brief return list of tags by scope. If the cache is enabled, tags will be fetched from the
* cache instead of accessing the disk
* @param scope
* @param tags [output]
*/
virtual void GetTagsByScope(const wxString& scope, std::vector<TagEntryPtr>& tags);
/**
* @brief return array of tags by kind.
* @param kinds array of kinds
* @param orderingColumn the column that the output should be ordered by (leave empty for no sorting)
* @param order OrderAsc, OrderDesc or use OrderNone for no ordering the results
* @param tags [output]
*/
virtual void GetTagsByKind(const wxArrayString& kinds, const wxString& orderingColumn, int order,
std::vector<TagEntryPtr>& tags);
/**
* \brief
* \param kinds
* \param orderingColumn
* \param order
* \param limit
* \param tags
*/
virtual void GetTagsByKindLimit(const wxArrayString& kinds, const wxString& orderingColumn, int order, int limit,
const wxString& partName, std::vector<TagEntryPtr>& tags);
/**
* @brief return array of items by path
* @param path
* @param tags
*/
virtual void GetTagsByPath(const wxArrayString& path, std::vector<TagEntryPtr>& tags);
virtual void GetTagsByPath(const wxString& path, std::vector<TagEntryPtr>& tags, int limit = 1);
/**
* @brief return array of items by name and parent
* @param path
* @param tags
*/
virtual void GetTagsByNameAndParent(const wxString& name, const wxString& parent, std::vector<TagEntryPtr>& tags);
/**
* @brief reutnr array of tags by kind and path
* @param kinds array of kind
* @param path
* @param tags [output]
*/
virtual void GetTagsByKindAndPath(const wxArrayString& kinds, const wxString& path, std::vector<TagEntryPtr>& tags);
/**
* @brief return tags by file and line number
* @param file
* @param line
* @param tags
*/
virtual void GetTagsByFileAndLine(const wxString& file, int line, std::vector<TagEntryPtr>& tags);
/**
* @brief return tag entry above (or equal) line
*/
TagEntryPtr GetTagAboveFileAndLine(const wxString& file, int line);
/**
* @brief return list by kind and scope
* @param scope
* @param kinds
* @param tags [output]
*/
virtual void GetTagsByScopeAndKind(const wxString& scope, const wxArrayString& kinds,
std::vector<TagEntryPtr>& tags, bool applyLimit = true);
/**
* @see ITagsStorage::GetTagsByName
*/
virtual void GetTagsByName(const wxString& prefix, std::vector<TagEntryPtr>& tags, bool exactMatch = false);
/**
* @brief return list of tags by scopes and kinds
* @param scopes array of possible scopes
* @param kinds array of possible kinds
* @param tags [output]
*/
virtual void GetTagsByScopesAndKind(const wxArrayString& scopes, const wxArrayString& kinds,
std::vector<TagEntryPtr>& tags);
virtual void GetTagsByScopesAndKindNoLimit(const wxArrayString& scopes, const wxArrayString& kinds,
std::vector<TagEntryPtr>& tags);
/**
* @brief return list of tags by typerefs and kinds
* @param typerefs array of possible typerefs
* @param kinds array of possible kinds
* @param tags [output]
*/
virtual void GetTagsByTyperefAndKind(const wxArrayString& typerefs, const wxArrayString& kinds,
std::vector<TagEntryPtr>& tags);
/**
* @brief get list of tags by kind and file
* @param kind
* @param orderingColumn the column that the output should be ordered by (leave empty for no sorting)
* @param order OrderAsc, OrderDesc or use OrderNone for no ordering the results
* @param tags
*/
virtual void GetTagsByKindAndFile(const wxArrayString& kind, const wxString& fileName,
const wxString& orderingColumn, int order, std::vector<TagEntryPtr>& tags);
/**
* @brief
* @param tags
*/
virtual void GetGlobalFunctions(std::vector<TagEntryPtr>& tags);
/**
* @brief delete an entry by file name
* @param filename
* @return
*/
virtual int DeleteFileEntry(const wxString& filename);
/**
* @brief insert entry by file name
* @param filename
* @return
*/
virtual int InsertFileEntry(const wxString& filename, int timestamp);
/**
* @brief update file entry using file name as key
* @param filename
* @param timestamp new timestamp
* @return
*/
virtual int UpdateFileEntry(const wxString& filename, int timestamp);
/**
* @brief return true if type exist under a given scope.
* Incase it exist but under the <global> scope, 'scope' will be modified
* @param typeName type to search
* @param scope [intput/output]
* @return true on success
*/
virtual bool IsTypeAndScopeContainer(wxString& typeName, wxString& scope);
/**
* @brief
* @param typeName
* @param scope
* @return
*/
virtual bool IsTypeAndScopeExistLimitOne(const wxString& typeName, const wxString& scope);
/**
* @brief return true if type & scope do exist in the symbols database and is container
* @param typeName
* @param scope
* @return
*/
virtual bool IsTypeAndScopeExist(wxString& typeName, wxString& scope);
/**
* @brief return list of scopes (classes, namespaces, structs) from a given file as a unique and ascended ordered
* vector of strings
* @param fileName
* @param scopes
*/
virtual void GetScopesFromFileAsc(const wxFileName& fileName, std::vector<wxString>& scopes);
/**
* @brief
*/
virtual void ClearCache();
/**
* @brief
* @param fileName
* @param scopeName
* @param tags
*/
virtual void GetTagsByFileScopeAndKind(const wxFileName& fileName, const wxString& scopeName,
const wxArrayString& kind, std::vector<TagEntryPtr>& tags);
virtual void GetAllTagsNames(wxArrayString& names);
virtual void GetTagsNames(const wxArrayString& kind, wxArrayString& names);
/**
* @brief
* @param files
* @param tags
*/
virtual void GetTagsByFiles(const wxArrayString& files, std::vector<TagEntryPtr>& tags);
/**
* @brief
* @param files
* @param scope
* @param tags
*/
virtual void GetTagsByFilesAndScope(const wxArrayString& files, const wxString& scope,
std::vector<TagEntryPtr>& tags);
/**
* @brief
* @param files
* @param kinds
* @param scope
* @param tags
*/
virtual void GetTagsByFilesKindAndScope(const wxArrayString& files, const wxArrayString& kinds,
const wxString& scope, std::vector<TagEntryPtr>& tags);
/**
* @brief
* @param files
* @param kinds
* @param scope
* @param typeref
* @param tags
*/
virtual void GetTagsByFilesScopeTyperefAndKind(const wxArrayString& files, const wxArrayString& kinds,
const wxString& scope, const wxString& typeref,
std::vector<TagEntryPtr>& tags);
/**
* @brief
* @param name
* @return
*/
virtual PPToken GetMacro(const wxString& name);
/**
* @brief
* @param table
*/
virtual void StoreMacros(const std::map<wxString, PPToken>& table);
/**
* @copydoc ITagStorage::GetMacrosDefined
*/
virtual void GetMacrosDefined(const std::set<std::string>& files, const std::set<wxString>& usedMacros,
wxArrayString& defMacros);
/**
* @brief search for a single match in the database for an entry with a given name
*/
TagEntryPtr GetTagsByNameLimitOne(const wxString& name);
void GetTagsByPartName(const wxString& partname, std::vector<TagEntryPtr>& tags);
/**
* @brief same as above, but allow multiple name parts
*/
void GetTagsByPartName(const wxArrayString& parts, std::vector<TagEntryPtr>& tags);
/**
* @brief this function takes as input argument array of symbols and removes from it all the
* symbols that are not part of the workspace. A symbol must be in the tags database and its type
* should be in the 'kinds' array
*/
void RemoveNonWorkspaceSymbols(const std::vector<wxString>& symbols, std::vector<wxString>& workspaceSymbols,
std::vector<wxString>& nonWorkspaceSymbols);
};
#endif // CODELITE_TAGS_DATABASE_H
|