[PythonService] Cleanup

Author: Barnabás Domozi

plugins/python/service/include/service/pythonservice.h

@@ -49,7 +49,7 @@ class PythonServiceHandler : virtual public LanguageServiceIf
 
   void getDocumentation(
     std::string& return_,
-    const core::AstNodeId& astNodeId_) override;
+    const core::AstNodeId& astNodeId_) override {};
 
   void getProperties(
     std::map<std::string, std::string>& return_,
@@ -100,121 +100,46 @@ class PythonServiceHandler : virtual public LanguageServiceIf
     const core::AstNodeId& astNodeId_,
     const std::int32_t referenceId_,
     const core::FileId& fileId_,
-    const std::vector<std::string>& tags_) override;
+    const std::vector<std::string>& tags_) override {};
 
   void getReferencesPage(
     std::vector<AstNodeInfo>& return_,
     const core::AstNodeId& astNodeId_,
     const std::int32_t referenceId_,
     const std::int32_t pageSize_,
-    const std::int32_t pageNo_) override;
+    const std::int32_t pageNo_) override {};
 
   void getFileReferenceTypes(
     std::map<std::string, std::int32_t>& return_,
-    const core::FileId& fileId_) override;
+    const core::FileId& fileId_) override {};
 
   void getFileReferences(
     std::vector<AstNodeInfo>& return_,
     const core::FileId& fileId_,
-    const std::int32_t referenceId_) override;
+    const std::int32_t referenceId_) override {};
 
   std::int32_t getFileReferenceCount(
     const core::FileId& fileId_,
-    const std::int32_t referenceId_) override;
+    const std::int32_t referenceId_) override {};
 
   void getSyntaxHighlight(
     std::vector<SyntaxHighlight>& return_,
-    const core::FileRange& range_) override;
+    const core::FileRange& range_) override {};
 
   enum ReferenceType
   {
-    DEFINITION, /*!< By this option the definition(s) of the AST node can be
-      queried. However according to the "one definition rule" a named entity
-      can have only one definition, in a parsing several definitions might be
-      available. This is the case when the project is built for several targets
-      and in the different builds different definitions are defined for an
-      entity (e.g. because of an #ifdef section). */
-
-    DECLARATION, /*!< By this options the declaration(s) of the AST node can be
-      queried. */
-
-    USAGE, /*!< By this option the usages of the AST node can be queried, i.e.
-      the nodes of which the entity hash is identical to the queried one. */
-
-    THIS_CALLS, /*!< Get function calls in a function. WARNING: If the
-      definition of the AST node is not unique then it returns the callees of
-      one of them. */
-
-    CALLS_OF_THIS, /*!< Get calls of a function. */
-
-    CALLEE, /*!< Get called functions definitions. WARNING: If the definition of
-      the AST node is not unique then it returns the callees of one of them. */
-
-    CALLER, /*!< Get caller functions. */
-
-    VIRTUAL_CALL, /*!< A function may be used virtually on a base type object.
-      The exact type of the object is based on dynamic information, which can't
-      be determined statically. Weak usage returns these possible calls. */
-
-    FUNC_PTR_CALL, /*!< Functions can be assigned to function pointers which
-      can be invoked later. This option returns these invocations. */
-
-    PARAMETER, /*!< This option returns the parameters of a function. */
-
-    LOCAL_VAR, /*!< This option returns the local variables of a function. */
-
-    RETURN_TYPE, /*!< This option returns the return type of a function. */
-
-    OVERRIDE, /*!< This option returns the functions which the given function
-      overrides. */
-
-    OVERRIDDEN_BY, /*!< This option returns the overrides of a function. */
-
-    READ, /*!< This option returns the places where a variable is read. */
-
-    WRITE, /*!< This option returns the places where a variable is written. */
-
-    TYPE, /*!< This option returns the type of a variable. */
-
-    ALIAS, /*!< Types may have aliases, e.g. by typedefs. */
-
-    INHERIT_FROM, /*!< Types from which the queried type inherits. */
-
-    INHERIT_BY, /*!< Types by which the queried type is inherited. */
-
-    DATA_MEMBER, /*!< Data members of a class. */
-
-    METHOD, /*!< Members of a class. */
-
-    FRIEND, /*!< The friends of a class. */
-
-    UNDERLYING_TYPE, /*!< Underlying type of a typedef. */
-
-    ENUM_CONSTANTS, /*!< Enum constants. */
-
-    EXPANSION, /*!< Macro expansion. */
-
-    UNDEFINITION, /*!< Macro undefinition. */
-
+    DEFINITION,
+    USAGE,
+    THIS_CALLS,
+    CALLER,
+    PARAMETER,
+    LOCAL_VAR,
+    DATA_MEMBER,
+    METHOD,
     PARENT,
-
     PARENT_FUNCTION,
-
     ANNOTATION,
-
-    BASE_CLASS,
-  };
-
-  enum FileReferenceType
-  {
-    INCLUDES, /*!< Included source files in the current source file after the
-      inclusion directive. */
-
-    TYPES, /*!< User defined data types such as classes, structs etc. */
-
-    FUNCTIONS, /*!< Functions in the current source file. */
-
-    MACROS, /*!< Macros in the current source file. */
+    BASE_CLASS
   };
 
   enum DiagramType

plugins/python/service/src/pythonservice.cpp

@@ -21,6 +21,9 @@ PythonServiceHandler::PythonServiceHandler(
 void PythonServiceHandler::getFileTypes(
   std::vector<std::string>& return_) 
 {
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   return_.push_back("PY");
   return_.push_back("Dir");
   return;
@@ -30,7 +33,9 @@ void PythonServiceHandler::getAstNodeInfo(
   AstNodeInfo& return_,
   const core::AstNodeId& astNodeId_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   model::PYName pyname = PythonServiceHandler::queryNodeByID(astNodeId_);
 
   PythonServiceHandler::setInfoProperties(return_, pyname);
@@ -41,7 +46,9 @@ void PythonServiceHandler::getAstNodeInfoByPosition(
   AstNodeInfo& return_,
   const core::FilePosition& fpos_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   model::PYName node = PythonServiceHandler::queryNodeByPosition(fpos_);
   PythonServiceHandler::setInfoProperties(return_, node);
   return;
@@ -51,7 +58,9 @@ void PythonServiceHandler::getSourceText(
   std::string& return_,
   const core::AstNodeId& astNodeId_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   model::PYName pyname = PythonServiceHandler::queryNodeByID(astNodeId_);
 
   core::ProjectServiceHandler projectService(_db, _datadir, _context);
@@ -70,19 +79,11 @@ void PythonServiceHandler::getSourceText(
   return;
 }
 
-void PythonServiceHandler::getDocumentation(
-  std::string& return_,
-  const core::AstNodeId& astNodeId_) 
-{
-  LOG(info) << "[PYSERVICE] " << __func__;
-  return;
-}
-
 void PythonServiceHandler::getProperties(
   std::map<std::string, std::string>& return_,
   const core::AstNodeId& astNodeId_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
   model::PYName pyname = PythonServiceHandler::queryNodeByID(astNodeId_);
 
   if(!pyname.full_name.empty())
@@ -112,7 +113,9 @@ void PythonServiceHandler::getDiagramTypes(
   std::map<std::string, std::int32_t>& return_,
   const core::AstNodeId& astNodeId_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   const model::PYName pyname = PythonServiceHandler::queryNodeByID(astNodeId_);
 
   if (pyname.is_import == true) return;
@@ -144,7 +147,9 @@ void PythonServiceHandler::getDiagram(
   const core::AstNodeId& astNodeId_,
   const std::int32_t diagramId_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   python::Diagram diagram(_db, _datadir, _context);
 
   model::PYName pyname = PythonServiceHandler::queryNodeByID(astNodeId_);
@@ -179,7 +184,9 @@ void PythonServiceHandler::getDiagramLegend(
   std::string& return_,
   const std::int32_t diagramId_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   python::Diagram diagram(_db, _datadir, _context);
 
   util::Graph graph = [&]()
@@ -206,7 +213,9 @@ void PythonServiceHandler::getFileDiagramTypes(
   std::map<std::string, std::int32_t>& return_,
   const core::FileId& fileId_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   return_.emplace("Module dependency", MODULE_DEPENDENCY);
   return;
 }
@@ -216,7 +225,9 @@ void PythonServiceHandler::getFileDiagram(
   const core::FileId& fileId_,
   const int32_t diagramId_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   python::Diagram diagram(_db, _datadir, _context);
 
   util::Graph graph = [&]()
@@ -240,7 +251,9 @@ void PythonServiceHandler::getFileDiagramLegend(
   std::string& return_,
   const std::int32_t diagramId_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   python::Diagram diagram(_db, _datadir, _context);
 
   util::Graph graph = [&]()
@@ -264,7 +277,9 @@ void PythonServiceHandler::getReferenceTypes(
   std::map<std::string, std::int32_t>& return_,
   const core::AstNodeId& astNodeId) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
+#endif
   return_.emplace("Definition", DEFINITION);
   return_.emplace("Usage", USAGE);
   return_.emplace("Parent", PARENT);
@@ -302,9 +317,10 @@ void PythonServiceHandler::getReferences(
   const std::int32_t referenceId_,
   const std::vector<std::string>& tags_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
   LOG(info) << "astNodeID: " << astNodeId_;
-
+#endif
   std::vector<model::PYName> nodes = PythonServiceHandler::queryReferences(astNodeId_, referenceId_);
 
   for(const model::PYName& pyname : nodes)
@@ -321,67 +337,14 @@ std::int32_t PythonServiceHandler::getReferenceCount(
   const core::AstNodeId& astNodeId_,
   const std::int32_t referenceId_) 
 {
-  LOG(info) << "[PYSERVICE] " << __func__;
+#ifndef NDEBUG
+  LOG(info) << "[PYTHONSERVICE]" << __func__;
   LOG(info) << "astNodeID: " << astNodeId_;
+#endif
 
   return PythonServiceHandler::queryReferences(astNodeId_, referenceId_).size();
 }
 
-void PythonServiceHandler::getReferencesInFile(
-  std::vector<AstNodeInfo>& return_,
-  const core::AstNodeId& astNodeId_,
-  const std::int32_t referenceId_,
-  const core::FileId& fileId_,
-  const std::vector<std::string>& tags_) 
-{
-  LOG(info) << "[PYSERVICE] " << __func__;
-  return;
-}
-
-void PythonServiceHandler::getReferencesPage(
-  std::vector<AstNodeInfo>& return_,
-  const core::AstNodeId& astNodeId_,
-  const std::int32_t referenceId_,
-  const std::int32_t pageSize_,
-  const std::int32_t pageNo_) 
-{
-  LOG(info) << "[PYSERVICE] " << __func__;
-  return;
-}
-
-void PythonServiceHandler::getFileReferenceTypes(
-  std::map<std::string, std::int32_t>& return_,
-  const core::FileId& fileId_) 
-{
-  LOG(info) << "[PYSERVICE] " << __func__;
-  return;
-}
-
-void PythonServiceHandler::getFileReferences(
-  std::vector<AstNodeInfo>& return_,
-  const core::FileId& fileId_,
-  const std::int32_t referenceId_) 
-{
-  LOG(info) << "[PYSERVICE] " << __func__;
-  return;
-}
-
-std::int32_t PythonServiceHandler::getFileReferenceCount(
-  const core::FileId& fileId_,
-  const std::int32_t referenceId_) 
-{
-  LOG(info) << "[PYSERVICE] " << __func__;
-  return 0;
-}
-
-void PythonServiceHandler::getSyntaxHighlight(
-  std::vector<SyntaxHighlight>& return_,
-  const core::FileRange& range_) 
-{
-  LOG(info) << "[PYSERVICE] " << __func__;
-  return;
-}
-
 model::PYName PythonServiceHandler::queryNodeByID(const std::string& id)
 {
   return _transaction([&]()
@@ -393,7 +356,7 @@ model::PYName PythonServiceHandler::queryNodeByID(const std::string& id)
     {
       pyname = *nodes.begin();
     }else{
-      LOG(info) << "[PYSERVICE] Node not found! (id = " << id << ")";
+      LOG(info) << "[PYTHONSERVICE] Node not found! (id = " << id << ")";
       core::InvalidId ex;
       ex.__set_msg("Node not found!");
       throw ex;
@@ -427,7 +390,7 @@ model::PYName PythonServiceHandler::queryNodeByPosition(const core::FilePosition
         }
       }
     }else{
-      LOG(info) << "[PYSERVICE] Node not found! (line = " << fpos.pos.line << " column = " << fpos.pos.column << ")";
+      LOG(info) << "[PYTHONSERVICE] Node not found! (line = " << fpos.pos.line << " column = " << fpos.pos.column << ")";
       core::InvalidInput ex;
       ex.__set_msg("Node not found!");
       throw ex;