[readline] readline port builds for MacOS

[zekoz]

Describe the pull request

• What does your PR fix?

Adding readline package for Mac

• Which triplets are supported/not supported? Have you updated the CI baseline?

x64-osx-rel, x64-osx-dbg only supported

• Does your PR follow the maintainer guide?

  Yes

• If you have added/updated a port: Have you run ./vcpkg x-add-version --all and committed the result?

Yes

If you are still working on the PR, open it as a Draft: https://github.blog/2019-02-14-introducing-draft-pull-requests/

[ghost]

All CLA requirements met.

[github-actions]

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

Error: Local changes detected for readline but no changes to version or port version.
-- Version: 0#1
-- Old SHA: 1e0a62b3927f5b41e7861093dba7d2e2aa4de0b2
-- New SHA: 5cc311cc776f442ca29031b15d7b12b8ae34a77d
-- Did you remember to update the version or port version?
-- Pass `--overwrite-version` to bypass this check.
***No files were updated.***

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 48bba4f9c3b42e238382f79f9db1a6cdbd8a09f6 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/r-/readline.json b/versions/r-/readline.json
index 51d048d..672cc6f 100644
--- a/versions/r-/readline.json
+++ b/versions/r-/readline.json
@@ -1,7 +1,7 @@
 {
   "versions": [
     {
-      "git-tree": "5cc311cc776f442ca29031b15d7b12b8ae34a77d",
+      "git-tree": "1e0a62b3927f5b41e7861093dba7d2e2aa4de0b2",
       "version-string": "0",
       "port-version": 1
     },

[github-actions]

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

Error: Local changes detected for readline but no changes to version or port version.
-- Version: 0#1
-- Old SHA: 1e0a62b3927f5b41e7861093dba7d2e2aa4de0b2
-- New SHA: 5cc311cc776f442ca29031b15d7b12b8ae34a77d
-- Did you remember to update the version or port version?
-- Pass `--overwrite-version` to bypass this check.
***No files were updated.***

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 48bba4f9c3b42e238382f79f9db1a6cdbd8a09f6 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/r-/readline.json b/versions/r-/readline.json
index 51d048d..672cc6f 100644
--- a/versions/r-/readline.json
+++ b/versions/r-/readline.json
@@ -1,7 +1,7 @@
 {
   "versions": [
     {
-      "git-tree": "5cc311cc776f442ca29031b15d7b12b8ae34a77d",
+      "git-tree": "1e0a62b3927f5b41e7861093dba7d2e2aa4de0b2",
       "version-string": "0",
       "port-version": 1
     },

[github-actions]

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

Error: Local changes detected for readline but no changes to version or port version.
-- Version: 0#1
-- Old SHA: 1e0a62b3927f5b41e7861093dba7d2e2aa4de0b2
-- New SHA: 5cc311cc776f442ca29031b15d7b12b8ae34a77d
-- Did you remember to update the version or port version?
-- Pass `--overwrite-version` to bypass this check.
***No files were updated.***

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout fdb170fda2daa456a843aa3614e5aca6fffa4d52 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/r-/readline.json b/versions/r-/readline.json
index 51d048d..672cc6f 100644
--- a/versions/r-/readline.json
+++ b/versions/r-/readline.json
@@ -1,7 +1,7 @@
 {
   "versions": [
     {
-      "git-tree": "5cc311cc776f442ca29031b15d7b12b8ae34a77d",
+      "git-tree": "1e0a62b3927f5b41e7861093dba7d2e2aa4de0b2",
       "version-string": "0",
       "port-version": 1
     },

[dg0yt]

Port readline is described as "GNU readline and history libraries". So why is this implemented as a separate port, and not using upstream's build system?
win32 is a different case, because it actually uses different sources.

[zekoz]

Port readline is described as "GNU readline and history libraries". So why is this implemented as a separate port, and not using upstream's build system? win32 is a different case, because it actually uses different sources.

Now it is readline. Will keep using cmake because https://github.com/microsoft/vcpkg/blob/master/docs/maintainers/maintainer-guide.md#prefer-using-cmake

[JackBoosY]

Readline was moved to readline-win32 in PR #3504.
@qmfrederik I wish to listen some suggestions.

[github-actions]

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout fdb170fda2daa456a843aa3614e5aca6fffa4d52 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/r-/readline.json b/versions/r-/readline.json
index 5e4800b..42f408e 100644
--- a/versions/r-/readline.json
+++ b/versions/r-/readline.json
@@ -6,7 +6,7 @@
       "port-version": 0
     },
     {
-      "git-tree": "5cc311cc776f442ca29031b15d7b12b8ae34a77d",
+      "git-tree": "1e0a62b3927f5b41e7861093dba7d2e2aa4de0b2",
       "version-string": "0",
       "port-version": 1
     },

[github-actions]

This is a new experimental fast check for PR issues. Please let us know if this bot is helpful!

PRs must add only one version and must not modify any published versions

When making any changes to a library, the version or port-version in vcpkg.json or CONTROL must be modified.

Error: Local changes detected for readline but no changes to version or port version.
-- Version: 0#1
-- Old SHA: 1e0a62b3927f5b41e7861093dba7d2e2aa4de0b2
-- New SHA: 5cc311cc776f442ca29031b15d7b12b8ae34a77d
-- Did you remember to update the version or port version?
-- Pass `--overwrite-version` to bypass this check.
***No files were updated.***

After committing all other changes, the version database must be updated

git add -u && git commit
git checkout 977c4b612d72b02eda9693d9207a5007f055d721 -- versions
./vcpkg x-add-version --all

Diff

diff --git a/versions/r-/readline.json b/versions/r-/readline.json
index 51d048d..672cc6f 100644
--- a/versions/r-/readline.json
+++ b/versions/r-/readline.json
@@ -1,7 +1,7 @@
 {
   "versions": [
     {
-      "git-tree": "5cc311cc776f442ca29031b15d7b12b8ae34a77d",
+      "git-tree": "1e0a62b3927f5b41e7861093dba7d2e2aa4de0b2",
       "version-string": "0",
       "port-version": 1
     },

[JackBoosY]

Back to start. Please update the port descriptions to make clear that "readline" is a "metapackage", and that "readline-osx" is GNU readline for osx. Think of the visibility for users, e.g. on https://vcpkg.io/en/packages.html.

I still think it would be better to not add a custom build system. It is fragmentation. It creates a maintenance burden. It is not necessary.

If we ensure that the cmake configuration is the same as the make configuration, we can accept the use of cmake.
The source of this port contains configure and makefile.

[JonLiu1993]

@zekoz ,Readline was moved to 'readline-win32', I think we need a readline-osx dependency port .

[dg0yt]

Readline was moved to 'readline-win32'

This was a fork of GNU readline 5.0 for windows. Not updated since 2017.

The source of this port contains configure and makefile.

So GNU readline version 8.1 can be build with vcpkg_configure_make and friends. Across platforms, maybe even for windows.

[zekoz]

@JonLiu1993 do you want to me to reset my branch back to f99800c or are there still issues remaining?

[JonLiu1993]

@JonLiu1993 do you want to me to reset my branch back to f99800c or are there still issues remaining?

I think this pr is ready to merge, of course my colleague will review it again before the final merge

[BillyONeal]

I'm not a huge fan of checking in a config file like this but that's what readline-win32 was already doing.

[BillyONeal]

So GNU readline version 8.1 can be build with vcpkg_configure_make and friends. Across platforms, maybe even for windows.

I think we can merge this but would much prefer this solution suggested by @dg0yt . Would you be willing to try that?

[BillyONeal]

(Will merge this Dec 23 if no response)

[dg0yt]

Upstream readline still doesn't support windows. Not even mingw. It lacks at least signal handling and DLL exports.

It also needs termcap or curses, but isn't prepared to work with pdcurses. Is termcap a system library on macOS?

readline-win32 contains changes for signal handling and exports (https://github.com/lltcggie/readline/blob/vs/src/readline/5.0/readline-5.0/patches/readline-5.0-src.diff). This could probably be adjusted for readline 8.1 but I assume it is not easy to make a derived change part of upstream or of vcpkg, due to contribution policies.

[JackBoosY]

I think there are some problems here.

[BillyONeal]

Can you be more specific?

[JackBoosY]

I can confirm that those 2 macros are only supported in Windows. I checked the source code.

[JackBoosY]

In readline.h or rlstdc.h:

#if (defined __WIN32__) || (defined _WIN32)
# ifdef BUILD_READLINE_DLL
#  define READLINE_DLL_IMPEXP     __DLL_EXPORT__
# elif defined(READLINE_STATIC)
#  define READLINE_DLL_IMPEXP      
# elif defined (USE_READLINE_DLL)
#  define READLINE_DLL_IMPEXP     __DLL_IMPORT__
# elif defined (USE_READLINE_STATIC)
#  define READLINE_DLL_IMPEXP      
# else /* assume USE_READLINE_DLL */
#  define READLINE_DLL_IMPEXP     __DLL_IMPORT__
# endif
#else /* __WIN32__ */
# define READLINE_DLL_IMPEXP  
#endif

You can see thoses 2 macros are only avaliable in Windows build.

[BillyONeal]

I see you already addressed in #22321

[BillyONeal]

Thanks for the improvements!