#132 Add a CMake build for C++ port #133

vityaman · 2024-07-24T12:26:29Z

The part of issue #132.

Build a static library with name libantlr4-c3.a that is statically linked with libantlr4-runtime.a.
Test a library using GTest with GMock, Java port test for Expr.g4 was ported.
Get ANTLRv4 Runtime via downloading v4.13.1 distribution.
Get ANTLRv4 Tool via downloading from www.antlr.org.
Support building with sanitazers.
Test debugging with lldb by pressing a F5 key at VSCode, clangd for VSCode support.

Adding this library as a dependency via FetchContent or something like this is not supported, because requiring to write some config and adding some demo project to test it.

There are not all changes here. Planning to add in the nearest future at next PRs:

Add clang-format, clang-tidy - separate PR because will contain formatting changes
Support adding the library as an external dependency
Porting more tests from TypeScript
Refactoring, small fixes with regression tests

vityaman · 2024-07-24T12:46:23Z

ports/cpp/source/antlr4-c3/CodeCompletionCore.cpp

@@ -188,7 +188,7 @@ bool CodeCompletionCore::translateStackToRuleIndex(RuleWithStartTokenList const&
 	if (translateRulesTopDown) {
 		// Loop over the rule stack from lowest to highest rule level. This will prioritize a lower preferred rule
 		// if it is a child of a higher one that is also a preferred rule.
-		for (size_t i = ruleWithStartTokenList.size() - 1; i >= 0; i--) {
+		for (int64_t i = ruleWithStartTokenList.size() - 1; i >= 0; i--) {


Here was a possible bug with overflow, which can cause an infinite loop. Caught by compiler with warnings enabled :)

vityaman · 2024-07-24T12:47:44Z

ports/cpp/source/antlr4-c3/CodeCompletionCore.cpp

 	return {
 		.sets = sets,
+		.combined = combined,
 		.isExhaustive = isExhaustive,
-		.combined = combined
 	};


Changed to fix compiler warning about parameters ordering.

mike-lischke

Wow, what an effort to make this work, but nice to see you have thought about every aspect!

mike-lischke · 2024-07-24T12:52:06Z

ports/cpp/source/antlr4-c3/CodeCompletionCore.cpp

 	return {
 		.sets = sets,
+		.combined = combined,
 		.isExhaustive = isExhaustive,
-		.combined = combined
 	};


I'm not familiar with that syntax. Is that C++20? Only know that from Swift (with a different meaning).

As I understand, it is called Aggregate Initialization and exists to simplify object creation. Something like named args for trivial autogenerated by compiler constructors.

So it lets you initialize plain structs this way:

struct Point { std::size_t x; std::size_t y; } Point point = {.x = 10, .y = 10};

It is since C++20.

vityaman · 2024-07-24T12:53:45Z

ports/cpp/test/expr/ExprTest.cpp

+    // FIXME: it returns empty lists as tokens are ignored, but in TS not
+    // EXPECT_THAT(candidates.tokens[ExprLexer::VAR],
+    //             UnorderedElementsAre(ExprLexer::ID, ExprLexer::EQUAL));
+    // EXPECT_THAT(candidates.tokens[ExprLexer::LET],
+    //             UnorderedElementsAre(ExprLexer::ID, ExprLexer::EQUAL));


Here is an interesting thing, because this port gives us an empty following token list, as that tokens were ignored.

Java port has the same behavior, that can be observed here.

But TypeScript tells us a different story.

What is a desired behavior? I propose just to document this "feature" is in the tests to begin with.

Signed-off-by: vityaman <[email protected]>

vityaman · 2024-07-24T13:17:22Z

ports/cpp/CMakeLists.txt

@@ -0,0 +1,24 @@
+cmake_minimum_required(VERSION 3.7)
+project(antlr4-c3 VERSION 0.1.0)


What is an actual version of C++ port? I would like to keep it with zero major version for now because it is still in progress, because of some major CMake structure changes may be required.

I'm not very fond of a zero major version for published libraries, but ok, let's start with 0.1.0.

vityaman · 2024-07-24T13:21:08Z

This CMake project structure was inspired by the project twist and many others, that I greped in the Internet.

Signed-off-by: vityaman <[email protected]>

vityaman · 2024-07-24T14:14:36Z

Oh, I eventually defeated that problem with an absence of GTest and CTest, checks passed at my fork.

@mike-lischke, the PR is ready for review.

mike-lischke · 2024-07-26T07:01:34Z

ports/cpp/README.md

@@ -0,0 +1 @@
+# ANTLRv4 C3 C++ Port


Can you please add a bit more information, like required C++ and CMake versions and some instructions to build and run the tests?

Signed-off-by: vityaman <[email protected]>

vityaman · 2024-07-27T08:49:03Z

ports/cpp/CMakeLists.txt

@@ -0,0 +1,24 @@
+cmake_minimum_required(VERSION 3.7)
+project(antlr4-c3 VERSION 1.1.0)


Considering the previous version as "1.0.0", "1.1.0" means the addition of CMake build.

mike-lischke · 2024-07-27T10:02:28Z

Thanks!

vityaman force-pushed the 132-port-cpp-cmake branch from 5145871 to 14478bd Compare July 24, 2024 12:36

vityaman commented Jul 24, 2024

View reviewed changes

mike-lischke reviewed Jul 24, 2024

View reviewed changes

vityaman commented Jul 24, 2024

View reviewed changes

vityaman added 13 commits July 24, 2024 16:08

mike-lischke#132 Build C++ port via CMake

62e1452

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Add VSCode launch tests configuration

a0d1951

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Add an empty README

ecbc18e

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Port ExprParser::MostSimpleInput test

131c521

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Port ExprParser::TypicalSetup test

2c23c6e

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Port ExprParser::RecursivePreferredRule test

03ae873

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Port ExprParser::CandidateRulesWithDifferentStartTokens

0f0431a

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Use CMAKE_CURRENT_BINARY_DIR

d3d58c3

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Refactor CMake configs

052b409

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Change a way to add sanitazers

93a2db7

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Add GitHub Workflow

b7fc979

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Fetch GTest from repository

634cacc

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Document different behaviour

9114c2d

Signed-off-by: vityaman <[email protected]>

vityaman force-pushed the 132-port-cpp-cmake branch from c64205c to 9114c2d Compare July 24, 2024 13:09

vityaman commented Jul 24, 2024

View reviewed changes

vityaman added 7 commits July 24, 2024 16:35

mike-lischke#132 Include CTest in CMake

d8c9972

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Install CMake at GitHub Workflow

31ef577

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Install Build Essential at GitHub Workflow

a76cf97

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Fix formatting error at yml

27d2b39

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Add ccache GitHub Action

b21803c

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Fix absent sudo for apt install

95026dc

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Fix invalid path for test log

69ecb34

Signed-off-by: vityaman <[email protected]>

vityaman marked this pull request as ready for review July 24, 2024 14:21

vityaman changed the title ~~[WIP] #132 Add a CMake build for C++ port~~ #132 Add a CMake build for C++ port Jul 24, 2024

mike-lischke requested changes Jul 26, 2024

View reviewed changes

vityaman added 2 commits July 27, 2024 10:59

mike-lischke#132 Bump C++ port version to 1.1.0

18d35f8

Signed-off-by: vityaman <[email protected]>

mike-lischke#132 Write C++ port README.md

5f2d57d

Signed-off-by: vityaman <[email protected]>

vityaman commented Jul 27, 2024

View reviewed changes

mike-lischke approved these changes Jul 27, 2024

View reviewed changes

mike-lischke merged commit b4e1941 into mike-lischke:main Jul 27, 2024
5 checks passed

vityaman deleted the 132-port-cpp-cmake branch July 31, 2024 12:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#132 Add a CMake build for C++ port #133

#132 Add a CMake build for C++ port #133

vityaman commented Jul 24, 2024 •

edited

Loading

vityaman Jul 24, 2024

vityaman Jul 24, 2024

mike-lischke left a comment

mike-lischke Jul 24, 2024

vityaman Jul 24, 2024 •

edited

Loading

vityaman Jul 24, 2024

vityaman Jul 24, 2024 •

edited

Loading

mike-lischke Jul 26, 2024

vityaman commented Jul 24, 2024

vityaman commented Jul 24, 2024

mike-lischke Jul 26, 2024

vityaman Jul 27, 2024

vityaman Jul 27, 2024

mike-lischke commented Jul 27, 2024

		@@ -0,0 +1,24 @@
		cmake_minimum_required(VERSION 3.7)
		project(antlr4-c3 VERSION 0.1.0)

		@@ -0,0 +1,24 @@
		cmake_minimum_required(VERSION 3.7)
		project(antlr4-c3 VERSION 1.1.0)

#132 Add a CMake build for C++ port #133

#132 Add a CMake build for C++ port #133

Conversation

vityaman commented Jul 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mike-lischke left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vityaman Jul 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vityaman Jul 24, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vityaman commented Jul 24, 2024

vityaman commented Jul 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mike-lischke commented Jul 27, 2024

vityaman commented Jul 24, 2024 •

edited

Loading

vityaman Jul 24, 2024 •

edited

Loading

vityaman Jul 24, 2024 •

edited

Loading