How can I customize the colors for custom command parameters?

[xgipota]

I need the modpoll command to have colored parameters. What do I need to change for this?

[akinomyoga]

Could you explain what you want to achieve in a bit more detail?

I tried to search the internet for whether command-line arguments or options of modpoll are associated with specific colors, but I couldn't find relevant information. Instead, I found the following question raised in a Russian forum (I used Google translate):

• Изменение цветов вводимой команды в Bash. — General — Форум

The page shows an example with modpoll -c 1300.

ble.sh already highlights the command-line options in general. In the above case, the -c part is highlighted with cyan by default. So, if you haven't installed ble.sh, please just install and set ble.sh up as described in README. The -c option in the above example will be highlighted out of the box.

If you would like to change the color of the options, you can change it using ble-face argument_option (see README for examples, and Manual §2 for the comprehensive descriptions).

If you want to change the color of specific options or arguments (instead of changing the color of the same type of arguments all together), you need to write a chroma for modpoll. This can be achieved by defining the shell function ble/cmdinfo/cmd:modpoll/chroma. An example chroma for declare is found here. However, the API for the chroma hasn't yet been fixed and thus is undocumented. If you can describe what you want to do precisely, I can describe the relevant API.

[xgipota]

Thank you. And yes, this is my message on that forum, I am originally from Russia.

[akinomyoga]

Thank you for your reply. I'd appreciate it if you could explain what you want to achieve using the example modpoll -c 1300.

• For example, do you want to highlight all the options of the form -<something> with a specific color? In this case, ble.sh does that by default, and the color can be configured by ble-face argument_option.
• Or do you consider highlighting 1300 with a color depending on its value? Such as red for 1300, blue for 1400, green for 1500? (Note: these are just examples. I'm not sure values like 1400 or 1500 makes sense for modpoll as I'm not familiar with the command modpoll). In that case, the only way is to define ble/cmdinfo/cmd:modpoll/chroma. I can show an example if you describe the detailed design and behavior of the coloring.

[xgipota]

I would like the modpoll command not to be filled in red, and also the yellow color of the number 1300. By the way, the modpoll command is the program needed for Modbus automation.

[akinomyoga]

I would like the modpoll command not to be filled in red,

This must be the installation issue of the modpoll command. The red highlighting means is that modpoll is not found in PATH in your environment. If you install modpoll and set PATH accordingly, the red highlighting should disappear.

and also the yellow color of the number 1300.

If you want to change the color of the normal arguments in general, you can put the following setting in your ~/.blerc (please create it if you haven't created it):

# blerc

ble-face syntax_default='fg=yellow'

If you want to change the color of the specific word "1300" in an arbitrary command line, you may define and register a custom pattern highlighting layer as

# blerc

ble-import layer/pattern
ble/highlight/layer:{pattern}/declare yellow1300
ble/highlight/layer:{pattern}/register pattern1 '\b1300\b' 'fg=yellow'
ble/array#insert-after _ble_highlight_layer_list syntax yellow1300

If you want to change the color of the arguments of modpoll in a specific condition, you need to specify the exact condition. The following is an example to highlight 1300 after -c appearing in the arguments of modpoll:

# blerc

function ble/cmdinfo/cmd:modpoll/chroma/1300.wattr {
  local ret
  ble/color/gspec2g 'fg=yellow'
  ble/progcolor/wattr#setg "$wget" "$ret"
}

function ble/cmdinfo/cmd:modpoll/chroma {
  local i "${_ble_syntax_progcolor_vars[@]/%/=}"
  for ((i = 1; i < ${#comp_words[@]}; i++)); do
    local ref=${tree_words[i]}
    [[ $ref ]] || continue
    local progcolor_iword=$i
    ble/progcolor/load-word-data "$ref"
    if [[ ${comp_words[i-1]-} == '-c' && ${comp_words[i]-} == '1300' ]]; then
      ble/progcolor/@wattr ble/cmdinfo/cmd:modpoll/chroma/1300.wattr
    else
      ble/progcolor/word:default
    fi
  done
}

[xgipota]

Big thanks!