Possible bug stork.sh script

[sahu07]

Dear MOOSE team,

I tried to create a new MOOSE app called "Test" using the stork script and added an action called "CustomAction".

./moose/scripts/stork.sh Test

I added the action to my app using the method registerAll(Factory & f, ActionFactory & af, Syntax & s) as discussed in MOOSE-workshop slides.

void
TestApp::registerAll(Factory & f, ActionFactory & af, Syntax & s)
{
  ModulesApp::registerAll(f, af, s);
  Registry::registerObjectsTo(f, {"TestApp"});
  Registry::registerActionsTo(af, {"TestApp"});

  /* register custom execute flags, action syntax, etc. here */
 registerSyntax("CustomAction","TestCustom");
}

But it gives me the following error

Rebuilding symlinks in /users/PAS1784/sarita/projects/test/build/header_symlinks
Compiling C++ with suffix (in opt mode) /users/PAS1784/sarita/projects/moose/modules/module_loader/src/ModulesApp.C...
Compiling C++ (in opt mode) /users/PAS1784/sarita/projects/test/src/base/TestApp.C...
Compiling C++ (in opt mode) /users/PAS1784/sarita/projects/test/src/main.C...
Compiling C++ (in opt mode) /users/PAS1784/sarita/projects/test/test/src/base/TestTestApp.C...
In file included from /users/PAS1784/sarita/projects/moose/framework/build/header_symlinks/MooseApp.h:17,
                 from /users/PAS1784/sarita/projects/test/build/header_symlinks/TestApp.h:12,
                 from /users/PAS1784/sarita/projects/test/src/base/TestApp.C:1:
/users/PAS1784/sarita/projects/test/src/base/TestApp.C: In static member function 'static void TestApp::registerAll(Factory&, ActionFactory&, Syntax&)':
/users/PAS1784/sarita/projects/moose/framework/build/header_symlinks/ActionFactory.h:28:3: error: invalid use of member function 'Syntax& MooseApp::syntax()' (did you forget the '()' ?)
   syntax.registerActionSyntax(action, action_syntax, "", __FILE__, __LINE__)
   ^~~~~~
/users/PAS1784/sarita/projects/test/src/base/TestApp.C:33:3: note: in expansion of macro 'registerSyntax'
   registerSyntax("CustomAction","TestCustom");
   ^~~~~~~~~~~~~~
make: *** [/users/PAS1784/sarita/projects/moose/framework/build.mk:118: /users/PAS1784/sarita/projects/test/src/base/TestApp.x86_64-pc-linux-gnu.opt.lo] Error 1
make: *** Waiting for unfinished jobs....

But if I change the name of the third argument to registerAll to "syntax" then it works fine as shown below.

void
TestApp::registerAll(Factory & f, ActionFactory & af, Syntax & syntax)
{
  ModulesApp::registerAll(f, af, syntax);
  Registry::registerObjectsTo(f, {"TestApp"});
  Registry::registerActionsTo(af, {"TestApp"});

  /* register custom execute flags, action syntax, etc. here */
  registerSyntax("CustomAction","TestCustom");
}

I think the name of the third argument should be "syntax". What do you think ?

Regards,
Sarita

[cticenhour]

registerSyntax is a function-like macro, and you can see its definition here:

moose/framework/include/actions/ActionFactory.h

Lines 27 to 28 in 6437ec8

	#define registerSyntax(action, action_syntax) \
	syntax.registerActionSyntax(action, action_syntax, "", __FILE__, __LINE__)

This is why changing s to syntax worked, since the macro definition holds a Syntax object called syntax. By looking at the definition above, it suggests that you could also leave the s and do this:

void
TestApp::registerAll(Factory & f, ActionFactory & af, Syntax & s)
{
  ModulesApp::registerAll(f, af, s);
  Registry::registerObjectsTo(f, {"TestApp"});
  Registry::registerActionsTo(af, {"TestApp"});

  /* register custom execute flags, action syntax, etc. here */
  s.registerActionSyntax("CustomAction", "TestCustom");
}

which should be equivalent. I can see how this is confusing, judging from the usage of this particular macro in MOOSE examples. I will make a PR to change this piece of stork source code, so that users can properly use this macro by default. Thank you!

[cticenhour]

PR is #17154