xiaoxiang781216 commented on code in PR #2300: URL: https://github.com/apache/nuttx-apps/pull/2300#discussion_r1501470565
########## nshlib/nsh_prompt.c: ########## @@ -0,0 +1,108 @@ +/**************************************************************************** + * apps/nshlib/nsh_prompt.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <string.h> + +#ifndef CONFIG_NSH_CLE +# include "system/readline.h" +#endif + +#include "nsh.h" + +/**************************************************************************** + * Preprocessor Macros + ****************************************************************************/ + +#define PROMPT_SIZE CONFIG_NSH_PROMPT_MAX +#define SUFFIX_SIZE CONFIG_NSH_PROMPT_SUFFIX_MAX + +#define SUF_POS_MAX (PROMPT_SIZE - SUFFIX_SIZE) + +/**************************************************************************** + * Private Variables + ****************************************************************************/ + +static char g_nshprompt[PROMPT_SIZE] = CONFIG_NSH_PROMPT_STRING; +static const char g_prompt_suffix[SUFFIX_SIZE] = CONFIG_NSH_PROMPT_SUFFIX; + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Name: nsh_update_prompt + * + * Description: + * This function updates g_nshprompt with latest data based on prioritized + * sources, from highest to lowest priority: + * + * - non-empty NSH_PROMPT_STRING w/o appending suffix + * - non-empty NSH_PROMPT_ENV variable value with suffix appended + * - non-empty HOSTNAME with g_prompt_suffix appended + * - g_prompt_suffix + * + * Results: + * - updated g_nsh_prompt value if necessary. + * + ****************************************************************************/ + +void nsh_update_prompt(void) +{ + size_t j; /* position to appending the suffix */ + + if (CONFIG_NSH_PROMPT_STRING[0] == '\0') + { +#ifndef CONFIG_DISABLE_ENVIRON + if (getenv(CONFIG_NSH_PROMPT_ENV)) + { + strlcpy(g_nshprompt, getenv(CONFIG_NSH_PROMPT_ENV), + sizeof(g_nshprompt)); + } + else +#endif + { + gethostname(g_nshprompt, sizeof(g_nshprompt)); + } + + j = strlen(g_nshprompt); + j = (j <= SUF_POS_MAX) ? j : SUF_POS_MAX; + strlcpy(&g_nshprompt[j], g_prompt_suffix, PROMPT_SIZE - j); + } +} + +/**************************************************************************** + * Name: nsh_prompt + * + * Description: + * This function returns latest prompt string. + * It is needed as g_nshprompt is no longer public. + * + ****************************************************************************/ + +char *nsh_prompt(void) Review Comment: ```suggestion FAR const char *nsh_prompt(void) ``` ########## nshlib/nsh_prompt.c: ########## @@ -0,0 +1,108 @@ +/**************************************************************************** + * apps/nshlib/nsh_prompt.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <string.h> + +#ifndef CONFIG_NSH_CLE +# include "system/readline.h" +#endif + +#include "nsh.h" + +/**************************************************************************** + * Preprocessor Macros + ****************************************************************************/ + +#define PROMPT_SIZE CONFIG_NSH_PROMPT_MAX +#define SUFFIX_SIZE CONFIG_NSH_PROMPT_SUFFIX_MAX + +#define SUF_POS_MAX (PROMPT_SIZE - SUFFIX_SIZE) Review Comment: ```suggestion #define SUFFIX_MAX (CONFIG_NSH_PROMPT_MAX - sizeof(CONFIG_NSH_PROMPT_SUFFIX)) ``` and remove NSH_PROMPT_SUFFIX_MAX from Kconfig ########## nshlib/Kconfig: ########## @@ -66,7 +66,39 @@ config NSH_PROMPT_STRING string "Prompt String" default "nsh> " ---help--- - Provide the shell prompt string, default is "nsh> ". + Provide the shell prompt string with size limit NSH_PROMPT_MAX. + default is "nsh> ". + +config NSH_PROMPT_MAX + int "Maximum Size of Prompt String" + default 16 + range 1 NAME_MAX Review Comment: why limit NSH_PROMPT_MAX range? ########## nshlib/nsh_prompt.c: ########## @@ -0,0 +1,108 @@ +/**************************************************************************** + * apps/nshlib/nsh_prompt.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <string.h> + +#ifndef CONFIG_NSH_CLE +# include "system/readline.h" +#endif + +#include "nsh.h" + +/**************************************************************************** + * Preprocessor Macros + ****************************************************************************/ + +#define PROMPT_SIZE CONFIG_NSH_PROMPT_MAX +#define SUFFIX_SIZE CONFIG_NSH_PROMPT_SUFFIX_MAX + +#define SUF_POS_MAX (PROMPT_SIZE - SUFFIX_SIZE) + +/**************************************************************************** + * Private Variables + ****************************************************************************/ + +static char g_nshprompt[PROMPT_SIZE] = CONFIG_NSH_PROMPT_STRING; +static const char g_prompt_suffix[SUFFIX_SIZE] = CONFIG_NSH_PROMPT_SUFFIX; + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Name: nsh_update_prompt + * + * Description: + * This function updates g_nshprompt with latest data based on prioritized + * sources, from highest to lowest priority: + * + * - non-empty NSH_PROMPT_STRING w/o appending suffix + * - non-empty NSH_PROMPT_ENV variable value with suffix appended + * - non-empty HOSTNAME with g_prompt_suffix appended + * - g_prompt_suffix + * + * Results: + * - updated g_nsh_prompt value if necessary. + * + ****************************************************************************/ + +void nsh_update_prompt(void) +{ + size_t j; /* position to appending the suffix */ Review Comment: ```suggestion size_t i; /* position to appending the suffix */ ``` ########## nshlib/nsh_prompt.c: ########## @@ -0,0 +1,108 @@ +/**************************************************************************** + * apps/nshlib/nsh_prompt.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <string.h> + +#ifndef CONFIG_NSH_CLE +# include "system/readline.h" +#endif + +#include "nsh.h" + +/**************************************************************************** + * Preprocessor Macros + ****************************************************************************/ + +#define PROMPT_SIZE CONFIG_NSH_PROMPT_MAX +#define SUFFIX_SIZE CONFIG_NSH_PROMPT_SUFFIX_MAX + +#define SUF_POS_MAX (PROMPT_SIZE - SUFFIX_SIZE) + +/**************************************************************************** + * Private Variables + ****************************************************************************/ + +static char g_nshprompt[PROMPT_SIZE] = CONFIG_NSH_PROMPT_STRING; +static const char g_prompt_suffix[SUFFIX_SIZE] = CONFIG_NSH_PROMPT_SUFFIX; + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Name: nsh_update_prompt + * + * Description: + * This function updates g_nshprompt with latest data based on prioritized + * sources, from highest to lowest priority: + * + * - non-empty NSH_PROMPT_STRING w/o appending suffix + * - non-empty NSH_PROMPT_ENV variable value with suffix appended + * - non-empty HOSTNAME with g_prompt_suffix appended + * - g_prompt_suffix + * + * Results: + * - updated g_nsh_prompt value if necessary. + * + ****************************************************************************/ + +void nsh_update_prompt(void) +{ + size_t j; /* position to appending the suffix */ + + if (CONFIG_NSH_PROMPT_STRING[0] == '\0') + { +#ifndef CONFIG_DISABLE_ENVIRON + if (getenv(CONFIG_NSH_PROMPT_ENV)) + { + strlcpy(g_nshprompt, getenv(CONFIG_NSH_PROMPT_ENV), + sizeof(g_nshprompt)); + } + else +#endif + { + gethostname(g_nshprompt, sizeof(g_nshprompt)); + } + + j = strlen(g_nshprompt); + j = (j <= SUF_POS_MAX) ? j : SUF_POS_MAX; + strlcpy(&g_nshprompt[j], g_prompt_suffix, PROMPT_SIZE - j); Review Comment: g_prompt_suffix to CONFIG_NSH_PROMPT_SUFFIX ########## nshlib/nsh_prompt.c: ########## @@ -0,0 +1,108 @@ +/**************************************************************************** + * apps/nshlib/nsh_prompt.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <string.h> + +#ifndef CONFIG_NSH_CLE +# include "system/readline.h" +#endif + +#include "nsh.h" + +/**************************************************************************** + * Preprocessor Macros + ****************************************************************************/ + +#define PROMPT_SIZE CONFIG_NSH_PROMPT_MAX +#define SUFFIX_SIZE CONFIG_NSH_PROMPT_SUFFIX_MAX + +#define SUF_POS_MAX (PROMPT_SIZE - SUFFIX_SIZE) + +/**************************************************************************** + * Private Variables + ****************************************************************************/ + +static char g_nshprompt[PROMPT_SIZE] = CONFIG_NSH_PROMPT_STRING; +static const char g_prompt_suffix[SUFFIX_SIZE] = CONFIG_NSH_PROMPT_SUFFIX; Review Comment: remove g_prompt_suffix, let's use CONFIG_NSH_PROMPT_SUFFIX directly ########## nshlib/nsh_init.c: ########## @@ -110,10 +110,14 @@ void nsh_initialize(void) FAR struct console_stdio_s *pstate; #endif + /* populate NSH prompt string */ + + nsh_update_prompt(); + #if defined(CONFIG_NSH_READLINE) && defined(CONFIG_READLINE_TABCOMPLETION) - /* Configure the NSH prompt */ + /* Configure readline prompt */ - readline_prompt(g_nshprompt); + readline_prompt(nshprompt()); Review Comment: ```suggestion readline_prompt(nsh_prompt()); ``` ########## nshlib/nsh_prompt.c: ########## @@ -0,0 +1,108 @@ +/**************************************************************************** + * apps/nshlib/nsh_prompt.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <string.h> + +#ifndef CONFIG_NSH_CLE +# include "system/readline.h" +#endif + +#include "nsh.h" + +/**************************************************************************** + * Preprocessor Macros + ****************************************************************************/ + +#define PROMPT_SIZE CONFIG_NSH_PROMPT_MAX +#define SUFFIX_SIZE CONFIG_NSH_PROMPT_SUFFIX_MAX + +#define SUF_POS_MAX (PROMPT_SIZE - SUFFIX_SIZE) + +/**************************************************************************** + * Private Variables + ****************************************************************************/ + +static char g_nshprompt[PROMPT_SIZE] = CONFIG_NSH_PROMPT_STRING; Review Comment: remove PROMPT_SIZE, let's use CONFIG_NSH_PROMPT_MAX directly ########## nshlib/nsh_prompt.c: ########## @@ -0,0 +1,108 @@ +/**************************************************************************** + * apps/nshlib/nsh_prompt.c + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. The + * ASF licenses this file to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance with the + * License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + * License for the specific language governing permissions and limitations + * under the License. + * + ****************************************************************************/ + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +#include <string.h> + +#ifndef CONFIG_NSH_CLE +# include "system/readline.h" +#endif + +#include "nsh.h" + +/**************************************************************************** + * Preprocessor Macros + ****************************************************************************/ + +#define PROMPT_SIZE CONFIG_NSH_PROMPT_MAX +#define SUFFIX_SIZE CONFIG_NSH_PROMPT_SUFFIX_MAX + +#define SUF_POS_MAX (PROMPT_SIZE - SUFFIX_SIZE) + +/**************************************************************************** + * Private Variables + ****************************************************************************/ + +static char g_nshprompt[PROMPT_SIZE] = CONFIG_NSH_PROMPT_STRING; +static const char g_prompt_suffix[SUFFIX_SIZE] = CONFIG_NSH_PROMPT_SUFFIX; + +/**************************************************************************** + * Public Functions + ****************************************************************************/ + +/**************************************************************************** + * Name: nsh_update_prompt + * + * Description: + * This function updates g_nshprompt with latest data based on prioritized + * sources, from highest to lowest priority: + * + * - non-empty NSH_PROMPT_STRING w/o appending suffix + * - non-empty NSH_PROMPT_ENV variable value with suffix appended + * - non-empty HOSTNAME with g_prompt_suffix appended + * - g_prompt_suffix + * + * Results: + * - updated g_nsh_prompt value if necessary. + * + ****************************************************************************/ + +void nsh_update_prompt(void) +{ + size_t j; /* position to appending the suffix */ + + if (CONFIG_NSH_PROMPT_STRING[0] == '\0') + { +#ifndef CONFIG_DISABLE_ENVIRON + if (getenv(CONFIG_NSH_PROMPT_ENV)) + { + strlcpy(g_nshprompt, getenv(CONFIG_NSH_PROMPT_ENV), + sizeof(g_nshprompt)); + } + else +#endif + { + gethostname(g_nshprompt, sizeof(g_nshprompt)); + } + + j = strlen(g_nshprompt); + j = (j <= SUF_POS_MAX) ? j : SUF_POS_MAX; + strlcpy(&g_nshprompt[j], g_prompt_suffix, PROMPT_SIZE - j); Review Comment: it's safe to call strcpy ########## nshlib/Kconfig: ########## @@ -66,7 +66,39 @@ config NSH_PROMPT_STRING string "Prompt String" default "nsh> " ---help--- - Provide the shell prompt string, default is "nsh> ". + Provide the shell prompt string with size limit NSH_PROMPT_MAX. + default is "nsh> ". + +config NSH_PROMPT_MAX + int "Maximum Size of Prompt String" + default 16 Review Comment: ```suggestion default NAME_MAX ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@nuttx.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
