implement functionality to store a qualifier location to the database

2019-03-26 11:33:01 +01:00
parent 702330265f
commit 24668448f5
4 changed files with 48 additions and 1 deletions
@@ -349,6 +349,26 @@ namespace sourcetrail
 		 */
 		bool recordReferenceLocation(int referenceId, const SourceRange& location);

+		/**
+		* Stores a location for the usage of a symbol's name as qualifier to the database
+		*
+		* This method allows to store a location where a specific symbol is used as a qualifier to the
+		* database. Calling this method with the same referencedSymbolId multiple times adds multiple locations
+		* for the respective reference. The stored location will be clickable but not displayable: When the
+		* reference location is clicked Sourcetrail will activate the symbol referenced by the respective
+		* reference. When the symbol with the specified id is activated, this location will NOT be displayed and
+		* highlighted by Sourcetrail.
+		*
+		*  param: referencedSymbolId - the id of the symbol that is used as qualifier at the current location.
+		*  param: location - the SourceRange that shall be recorded as location for the symbol's occurrence as
+		*    qualifier
+		*
+		*  return: true if successful. false on failure. getLastError() provides the error message.
+		*
+		*  see: SourceRange
+		*/
+		bool recordQualifierLocation(int referencedSymbolId, const SourceRange& location);
+
 		/**
 		 * Stores a file to the database
 		 *