[cling] Startup script support #11262

jiangyilism · 2022-08-27T19:24:14Z

Changes or fixes:

Implement startup script support according to this post:
https://root-forum.cern.ch/t/cling-startup-scripts-support/51358

Checklist:

tested changes locally
updated the docs (if necessary)

phsft-bot · 2022-08-27T19:24:17Z

Can one of the admins verify this patch?

jiangyilism · 2022-08-27T19:41:44Z

cling startup scripts are different from rootlogon.C and rootrc .
rootrc is a config file while .clingrc is a regular cling script. cling startup scripts are executed also in invocation of standalone cling binary (not from root interpreter).

Question:

Renaming .cling_profile and .clingrc with suffix .C ?
Rename .clingrc to something else so that .clingrc can be reserved for cling config file in the future (if any)?
Making it a config file instead of a cling script aligns with rootrc but not with bashrc, zshrc.
Drop .clingrc for now and keep .cling_profile only ? If a cling script can easily tell if it is in interactive mode then keeping only 1 script makes sense. Otherwise it is better to keep both to align with bash and other interpreter inspired by bash design. By easily telling I mean a macro like CLING_INTERACTIVE or something simple that does not access gCling.

vgvassilev · 2022-08-29T09:09:10Z

@phsft-bot build!

@jiangyilism, thanks for you PR, can you add some tests for the new functionality under cling/test?

phsft-bot · 2022-08-29T09:09:17Z

Starting build on ROOT-debian10-i386/soversion, ROOT-performance-centos8-multicore/cxx17, ROOT-ubuntu18.04/nortcxxmod, ROOT-ubuntu2004/python3, mac1015/cxx17, mac11/cxx14, windows10/cxx14
How to customize builds

jiangyilism · 2022-08-30T10:30:46Z

Hi @vgvassilev, cling/test/StratupFile.C is added. However it only covers usage of .cling_profile.C.

To proceed further, I would like to clerify the above decisions first.

Let me summarize again here:

Should we .x execute the startup file(s) or execute it in shebang #! way?
@eguiraud, @vgvassilev, @Axel-Naumann, what is the designed/documented difference between the 2?
Will it effect project root (which I have not tried out myself. I am experimenting standalone cling only)
As far as I read from the web, rootlogon.C and .rootrc are executed in shebang way.
Their filename-functions rootlogon(), rootrc() are not executed.

My proposal: Execute startup files in .x way
How should the startup files be named? .cling_profile, .cling_login, .cling_logon like bash and root?

https://www.gnu.org/software/bash/manual/html_node/Bash-Startup-Files.html

Should we adopt file suffix .C ?

My proposal: .cling_profile.C to align with rootlogon.C (to be honest I just want the editor syntax highlighting...)
Do we need .cling_profile and .clingrc as the original draft implementation?
If inside the script we can tell if cling is in interactive mode by a macro like CLING_INTERACTIVE then
only 1 file is needed.

My proposal: keep .cling_profile.C as the only startup file. Forget about #define CLING_INTERACTIVE 1 for now.

I mentioned this support just because bash and other shells/interpreters have it.
But unless someone wants this feature right now, I prefer not to implement it and
reserve CLING_INTERACTIVE and .clingrc/.clingrc.C for future design.

jiangyilism · 2022-09-19T13:43:51Z

@Axel-Naumann , @vgvassilev Could you provide some feedback?

vgvassilev · 2022-09-19T18:35:13Z

@jiangyilism, thanks for your patch. I am a bit worried about the fact that upon startup cling will execute "random" code. Can you elaborate a little more about your usecase?

I suspect python does something similar, can we model the feature following their approach?

jiangyilism · 2022-09-21T08:43:56Z

My use case is to #include <...> some standard headers I often use. e.g. filesystem and thread.
I will also put namespace fs = std::filesystem; in my startup file.
cling already implicitly includes some standard headers so I think letting users to customize it makes sense.

About "execute random code", is there risk if the executed code/script is in user's home directory or XDG_CONFIG_HOME ?

vgvassilev · 2022-09-22T19:34:46Z

My use case is to #include <...> some standard headers I often use. e.g. filesystem and thread. I will also put namespace fs = std::filesystem; in my startup file. cling already implicitly includes some standard headers so I think letting users to customize it makes sense.

Thanks for explaining. It all makes sense.

About "execute random code", is there risk if the executed code/script is in user's home directory or XDG_CONFIG_HOME ?

Well, I guess bash and python suffer from the same issue. As long as we are consistent to their practices it should be no issue.

vgvassilev · 2022-09-22T19:47:14Z

cling startup scripts are different from rootlogon.C and rootrc . rootrc is a config file while .clingrc is a regular cling script. cling startup scripts are executed also in invocation of standalone cling binary (not from root interpreter).

Question:

1. Renaming `.cling_profile` and `.clingrc` with suffix `.C` ?

2. Rename  `.clingrc` to something else so that `.clingrc` can be reserved for cling config file in the future (if any)?
   Making it a config file instead of a cling script aligns with rootrc but not with bashrc, zshrc.

3. Drop `.clingrc`  for now and keep `.cling_profile` only ?  If a cling script can easily tell if it is in interactive mode then keeping only 1 script makes sense. Otherwise it is better to keep both to align with bash and other interpreter inspired by bash design. By easily telling I mean a macro like `CLING_INTERACTIVE` or something simple that does not access `gCling`.

How about a ~/.cling.d folder where we glob all files and execute?

jiangyilism · 2022-09-23T12:36:07Z

How about a ~/.cling.d folder where we glob all files and execute?

Sounds good to me too.

I will enumerate .C files in .cling.d/ (if dir exists) with llvm::vfs::directory_iterator like CompilerInstance.cpp. So the enumeration does not guarantee specific orderings.

Search order of .cling.d/ is still

${CLING_HOME} envvar
${XDG_CONFIG_HOME}/cling/
${HOME}/.config/cling/
${HOME}/

Does that look good to you?

Axel-Naumann · 2023-06-07T14:12:38Z

Apologies for not reacting - this sounds terrific! Could you update the PR?

jiangyilism · 2023-06-09T13:26:34Z

So the enumeration does not guarantee specific orderings.

Updated. However the behavior is slightly different: the startup files are sorted after enumeration so the execution order is deterministic.

Axel-Naumann

LGTM, please just address the spelling mistake and I'll merge!

Axel-Naumann · 2023-06-09T16:39:23Z

interpreter/cling/tools/driver/cling.cpp

 #include <fstream>
-#include <vector>
+#include <iostream>


interpreter/cling/tools/driver/cling.cpp

Axel-Naumann · 2023-06-09T16:41:30Z

@phsft-bot build

phsft-bot · 2023-06-09T16:41:36Z

Starting build on ROOT-debian10-i386/soversion, ROOT-performance-centos8-multicore/cxx17, ROOT-ubuntu18.04/nortcxxmod, ROOT-ubuntu2004/python3, mac12/noimt, mac11/cxx14, windows10/cxx14
How to customize builds

Before showing command promt or executing scripts from argv, enumerate .C files in the directory ${CLING_HOME}/.cling.d/ in alphabetic order then .x them. Search order of ${CLING_HOME}: 1. ${CLING_HOME} envvar 2. ${XDG_CONFIG_HOME}/cling/ 3. ${HOME}/.config/cling/ 4. ${HOME}/

phsft-bot · 2023-06-09T19:12:29Z

Build failed on mac11/cxx14.
Running on macphsft23.dyndns.cern.ch:/Users/sftnight/build/workspace/root-pullrequests-build
See console output.

Failing tests:

vgvassilev · 2023-06-14T09:11:24Z

@jiangyilism I was wondering what's the status of this PR?

jiangyilism · 2023-06-14T09:21:54Z

@jiangyilism I was wondering what's the status of this PR?

There is no pending issue as far as I know. The mac11/cxx14 test fail above is due to (flaky?) timeout so it seems irrelevant to this PR.

vgvassilev · 2023-06-14T11:25:26Z

@Axel-Naumann, should we merge this then?

github-actions · 2023-06-14T21:06:26Z

Test Results

      11 files       11 suites 2d 5h 55m 22s ⏱️
  2 469 tests   2 460 ✔️ 0 💤   9 ❌
25 472 runs 25 461 ✔️ 0 💤 11 ❌

For more details on these failures, see this check.

Results for commit f816fae.

Axel-Naumann · 2023-06-16T14:11:21Z

Thanks for your very nice contribution!

jiangyilism requested a review from Axel-Naumann as a code owner August 27, 2022 19:24

jiangyilism force-pushed the startup_script_support branch from 05397d3 to 652e9d0 Compare August 27, 2022 21:22

eguiraud requested a review from vgvassilev August 29, 2022 08:55

eguiraud assigned Axel-Naumann and vgvassilev Aug 29, 2022

jiangyilism force-pushed the startup_script_support branch from 652e9d0 to e867534 Compare August 30, 2022 10:27

jiangyilism force-pushed the startup_script_support branch from e867534 to 86ef309 Compare August 31, 2022 12:08

jiangyilism mentioned this pull request Sep 1, 2022

[cling] script/library support entry function independent of filename #11299

Open

jiangyilism force-pushed the startup_script_support branch from 86ef309 to 6aabddb Compare June 9, 2023 13:23

Axel-Naumann approved these changes Jun 9, 2023

View reviewed changes

jiangyilism force-pushed the startup_script_support branch from 6aabddb to f816fae Compare June 9, 2023 17:19

Axel-Naumann merged commit fd991ce into root-project:master Jun 16, 2023
11 of 15 checks passed

Axel-Naumann mentioned this pull request Jul 1, 2023

init config root-project/cling#498

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[cling] Startup script support #11262

[cling] Startup script support #11262

jiangyilism commented Aug 27, 2022

phsft-bot commented Aug 27, 2022

jiangyilism commented Aug 27, 2022

vgvassilev commented Aug 29, 2022

phsft-bot commented Aug 29, 2022

jiangyilism commented Aug 30, 2022

jiangyilism commented Sep 19, 2022

vgvassilev commented Sep 19, 2022

jiangyilism commented Sep 21, 2022

vgvassilev commented Sep 22, 2022

vgvassilev commented Sep 22, 2022

jiangyilism commented Sep 23, 2022

Axel-Naumann commented Jun 7, 2023

jiangyilism commented Jun 9, 2023

Axel-Naumann left a comment

Axel-Naumann Jun 9, 2023

Axel-Naumann commented Jun 9, 2023

phsft-bot commented Jun 9, 2023

phsft-bot commented Jun 9, 2023

vgvassilev commented Jun 14, 2023

jiangyilism commented Jun 14, 2023

vgvassilev commented Jun 14, 2023

github-actions bot commented Jun 14, 2023

Axel-Naumann commented Jun 16, 2023

[cling] Startup script support #11262

[cling] Startup script support #11262

Conversation

jiangyilism commented Aug 27, 2022

Changes or fixes:

Checklist:

phsft-bot commented Aug 27, 2022

jiangyilism commented Aug 27, 2022

vgvassilev commented Aug 29, 2022

phsft-bot commented Aug 29, 2022

jiangyilism commented Aug 30, 2022

jiangyilism commented Sep 19, 2022

vgvassilev commented Sep 19, 2022

jiangyilism commented Sep 21, 2022

vgvassilev commented Sep 22, 2022

vgvassilev commented Sep 22, 2022

jiangyilism commented Sep 23, 2022

Axel-Naumann commented Jun 7, 2023

jiangyilism commented Jun 9, 2023

Axel-Naumann left a comment

Choose a reason for hiding this comment

Axel-Naumann Jun 9, 2023

Choose a reason for hiding this comment

Axel-Naumann commented Jun 9, 2023

phsft-bot commented Jun 9, 2023

phsft-bot commented Jun 9, 2023

Failing tests:

vgvassilev commented Jun 14, 2023

jiangyilism commented Jun 14, 2023

vgvassilev commented Jun 14, 2023

github-actions bot commented Jun 14, 2023

Test Results

Axel-Naumann commented Jun 16, 2023