@bytesnz

Jack Farley, Computer Engineer

The ESP-IDF has a concept of components, allowing you to split your code into separate parts. Developing the trap-watch, I have created quite a few components.

The components themselves are by default made up of a header file (components/<component>/include/<component>.h), a c file (components/<component>/<component>.c) and a CMakeList.txt file (components/<component>/CMakeList.txt). Starting off the component, you need to edit all three files to set it up correctly.

The process of setting up a component is something I haven't committed to memory, so I always have to look at a CMakeList.txt file for another component. I had the thought of surely I can make a simple command for opening all these files in vim… surely…

So I set about making it.

vimc <component>

I created the command as a function in my esp environment file. I wanted the ability to optionally open the CMakeList.txt file, either split with the header file, or alongside the other files, and to be able to open another components files at the same time.

To do the first part was nice and simple (once I figured out how to parse arguments again): If I passed an option to the command, change the command to open the files in vim

function vimc {
  if [ $# -eq 0 ]; then
    echo "Edit ESP-IDF component"
    echo "  usage $0 [-13] [-c <component_folder>] <component_name>"
    echo "    -1 CMakeList.txt split with .h file or -3 for all vertical"
    echo "    -c <component_folder> Path to component folder"
    exit 1
  fi 
        
  FOLDER=components        
       
  set -- $(getopt -u --options "c:,1,3" -- "$@")
       
  while :; do 
    case "$1" in
      -c)
        FOLDER=$2          
        shift 2
        ;;
      -1)
        POSITION=1         
        shift
        ;;
      -3)
        POSITION=3         
        shift
        ;;
      --)
        shift              
        break
        ;;
      *)
        echo unhandled option $1
        exit 1
        ;;
    esac  
  done
        
  if [ -d $FOLDER ]; then
    if [ -d $FOLDER/$1 ]; then
      if [ "$POSITION" == "1" ]; then
        vim -O -c 'sp $FOLDER/$1/CMakeLists.txt' $FOLDER/$1/include/$1.h $FOLDER/$1/$1.c
      else
        if [ "$POSITION" == "3" ]; then
          vim -O $FOLDER/$1/CMakeLists.txt $FOLDER/$1/include/$1.h $FOLDER/$1/$1.c
        else
          vim -O $FOLDER/$1/include/$1.h $FOLDER/$1/$1.c
        fi
      fi
    else
      echo Component $component does not exist
      exit 1
    fi
        
  else
    echo "Can't find the components folder"
  fi 
}

The second part, opening the other components files, was a little more of a challenge. How do you move windows in the VIM command line? Turns out you can use exe "normal" to do it.

:exe "normal \<C-W>l"

will "type" <C-W>l (Ctrl+W, L) to move to the window to the right, so you can simply write a command to split, then move to the right, split etc. Below is the final function.

function vimc {            
  if [ $# -eq 0 ]; then    
    echo "Edit ESP-IDF component"         
    echo "  usage $0 [-13] [-c <component_folder>] <component_name> [<component_name>]"
    echo "    -1 CMakeList.txt split with .h file or -3 for all vertical"
    echo "    -c <component_folder> Path to component folder"            
    return
  fi   
       
  FOLDER=components
  # Key command to move to the window to the right
  MOVE_RIGHT="exe \"normal \\<C-W>l\""
  # Command to split and open the file below the current window
  SPLIT="belowright sp"
       
  set -- $(getopt -u --options "c:,1,3" -- "$@")
       
  while :; do 
    case "$1" in
      -c)
        FOLDER=$2          
        shift 2
        ;;
      -1)
        POSITION=1         
        shift
        ;;
      -3)
        POSITION=3         
        shift
        ;;
      --)
        shift              
        break
        ;;
      *)
        echo unhandled option $1
        exit 1
        ;;
    esac
  done 
       
  if [ "$POSITION" == "1" ] && [ $# -gt 1 ]; then
    echo "Can't use option -1 with multiple components"
    return
  fi   
       
  if [ -d $FOLDER ]; then  
    if [ $# -gt 1 ]; then
      if [ -d $FOLDER/$2 ]; then
        if [ "$POSITION" == "3" ]; then
          COMMAND="-c '$SPLIT $FOLDER/$2/CMakeLists.txt | $MOVE_RIGHT | $SPLIT $FOLDER/$2/include/$2.h | $MOVE_RIGHT | $SPLIT $FOLDER/$2/$2.c'"
        else
          COMMAND="-c '$SPLIT $FOLDER/$2/include/$2.h | $MOVE_RIGHT | $FOLDER/$2/$2.c'"
        fi
      else
        echo Second component $FOLDER/$2 does not exist
        return
      fi
    fi 
       
    if [ -d $FOLDER/$1 ]; then
      if [ "$POSITION" == "1" ]; then
        vim -O -c "sp $FOLDER/$1/CMakeLists.txt" $FOLDER/$1/include/$1.h $FOLDER/$1/$1.c
      else
        if [ "$POSITION" == "3" ]; then
          eval vim -O $COMMAND $FOLDER/$1/CMakeLists.txt $FOLDER/$1/include/$1.h $FOLDER/$1/$1.c
        else
          eval vim -O $COMMAND $FOLDER/$1/include/$1.h $FOLDER/$1/$1.c
        fi
      fi  
    else
      echo Component $FOLDER/$1 does not exist
      return
    fi
       
  else
    echo "Can't find the components folder $FOLDER"
  fi
} 

So now I can open the wifi component including it's CMakeList.txt file with

$ vimc -1 wifi

or open both the wifi component and the sd component with

$ vimc -3 wifi sd

or

$ vimc wifi sd -3

if I'm feeling rebelious.

Now that I have done it, I'm wondering where else I could use similar…