Feat/plugin interface touchup by TimHeldmann · Pull Request #138 · tudasc/MetaCG

TimHeldmann · 2026-03-27T12:58:32Z

This PR adds two Demoplugins, one for CaGe and one for CGC2.
They are also added to the CI, to test whether we can correctly link and run plugins in CaGe and CGC2.
To add the Demoplugins the PR adds an interface library to link against, as well as changin the CMake files to install the necessary header files.

It lastly moved the existing FileInfoMetadata+Collector combo, which served as a demo plugin for CGC2 to the graphlib core-metadata.
This is because legacy CGC outputs FileInfoMD by default.

Looking forward to your feedback.

…congestions

…tadata and global metadata

… easily

pearzt

I only did a rough sweep over your changes, but everything looks sensible to me.

pearzt · 2026-04-08T13:11:36Z

+      abort();
+    }
+    assert(false && "This metadata can not be exported and therefore is not mergeable");
+    // const ASTNodeMetadata* toMergeDerived = static_cast<const ASTNodeMetadata*>(&toMerge);


nitpick: This looks like a leftover.

jplehr

I think this is basically two changes smushed into one PR together with more formatting NFC changes.

I would appreciate better separation in the future and left some comments.

jplehr · 2026-04-17T08:10:07Z

+#include "metacg/Callgraph.h"
+#include "metacg/LoggerUtil.h"


Unrelated NFC change?
(we can keep it in, but I think it is unrelated)

Yes this is unrelated and should have probably be part of: #136.

I agree to keep it.

jplehr · 2026-04-17T08:11:18Z

+      abort();
+    }
+    assert(false && "This metadata can not be exported and therefore is not mergeable");
+    // const ASTNodeMetadata* toMergeDerived = static_cast<const ASTNodeMetadata*>(&toMerge);


debug leftover? remove

jplehr · 2026-04-17T08:11:36Z

+  }
+
+  /**
+   * Specify how to clone your metadat


Suggested change

* Specify how to clone your metadat

* Specify how to clone your metadata

jplehr · 2026-04-17T08:13:22Z

 * https://github.com/tudasc/metacg/LICENSE.txt
 */
-#include "../interface/CaGePlugin.h"
+#include "cage/interface/CaGePlugin.h"


Unrelated NFC change
see above

Yes, same as above

jplehr · 2026-04-17T08:15:43Z

+   *
+   * @param g A map how to rename the old node-id to a new node-id, which is valid in the merged graph
+   */
+  void applyMapping(const metacg::GraphMapping& g) final {}


Mark g as [[maybe_unused]] or remove it?

You can not add param documentation to an unnamed parameter.
I therefore will mark it as [[maybe_unused]].

jplehr · 2026-04-17T08:16:24Z

+  }
+
+  /**
+   * Specify how to clone your metadat


Suggested change

* Specify how to clone your metadat

* Specify how to clone your metadata

jplehr · 2026-04-17T08:23:41Z

+  /**
+   * Returns mangled names for all named decls, including Ctor/Dtor.
+   */
+  static std::vector<std::string> getMangledName(clang::NamedDecl const* const nd) {


Is this the same logic that we use in the old cgcollector? I assume that there is no easy way to share code between such components, right?
If we wanted to do that we would require another shared lib that provides such things.

Yes this is the same logic used in cgc1.
There is currently no way (except linking the cgc2 against the cgc1's lib), to share this logic.
I am initially against having cgc1 and cgc2 share parts of their code in a shared library.
But I am open to reasons and to discuss if there is a need for smth. like a "ASTUtilitys.so", but this should be a different PR.

Oh yeah, this is a matter of understanding the situation. Certainly for future PR.

jplehr · 2026-04-17T08:25:21Z


 #include "metacg/metadata/MetaData.h"
-#include <SharedDefs.h>
+#include <cgcollector2/SharedDefs.h>


Suggested change

#include <cgcollector2/SharedDefs.h>

#include "cgcollector2/SharedDefs.h"

jplehr · 2026-04-17T08:26:12Z

-    mightCall.reserve(mightCall.size()+toMergeDerived->mightCall.size());
-    for(const auto& elem : toMergeDerived->mightCall){
-      if(std::find(mightCall.begin(), mightCall.end(), elem)!=mightCall.end()){
+    // This might be faster when using


I think all of this is unrelated formatting NFC only, right?

yes, looks like it.
I think I can take this whole file out of the PR.
It probably got included during reformatting.
The above change is also NFC.

That would be great!

jplehr · 2026-04-17T08:28:16Z

+    metacg::MCGLogger::instance().getErrConsole()->error("cannot locate the library at {}!", pluginPath);
+    metacg::MCGLogger::instance().getErrConsole()->error("Reason: {}", err);


Should we first construct a single string and then pass that to the error function to avoid splitting the info in log files when multiple processes run?

TimHeldmann added 22 commits March 27, 2026 10:24

Promote fileInfoMetadata to first party MD, remove demo plugin

59ce1b8

move cgcollector includes to own cgcollector namespace to avoid name …

c580f65

…congestions

Move Plugin header to interface folder

bd7644c

Install interface header via cmake

6f5ccac

Remove unneeded header file

d0f90a3

Add comment explaining predeclaration

7b63859

Rename CGC2's Plugin.h to CGC2Plugin.h

197f7d2

Update plugin interface to allow computeForGraph to add edges, edgeme…

0469a74

…tadata and global metadata

Export cgcollector2 specific metadata to allow plugins to use it more…

67f1236

… easily

Add cgc2 demo plugin

d9415d4

Fix copy paste error in cmdline option registering

f5fa157

Fix plugin loader function in interface

eef23a0

Remove unused include

afbf521

Add CaGeDemoPlugin

36ed4a1

Add basic compile test for demo plugins

b4930aa

Add plugin tests to full builds, remove from graph lib build

cdf0397

More sensible plugin names

22f4f0e

Update github action and modify container to build plugins

252d883

Fix rebase errors

a63280c

Remove relative path from pgis test

d948007

Modify plugins to adhere to new include structure

2611019

Reformat

781bd01

TimHeldmann force-pushed the feat/pluginInterfaceTouchup branch from 5e4783f to 781bd01 Compare March 27, 2026 13:26

pearzt approved these changes Apr 8, 2026

View reviewed changes

jplehr reviewed Apr 17, 2026

View reviewed changes

	* Specify how to clone your metadat
	* Specify how to clone your metadata

	#include <cgcollector2/SharedDefs.h>
	#include "cgcollector2/SharedDefs.h"

		metacg::MCGLogger::instance().getErrConsole()->error("cannot locate the library at {}!", pluginPath);
		metacg::MCGLogger::instance().getErrConsole()->error("Reason: {}", err);

Conversation

TimHeldmann commented Mar 27, 2026

Uh oh!

pearzt left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jplehr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants