edgetx-gx12/radio/src/gui/common/stdlcd/radio_tools.cpp

/*
 * Copyright (C) EdgeTX
 *
 * Based on code named
 *   opentx - https://github.com/opentx/opentx
 *   th9x - http://code.google.com/p/th9x
 *   er9x - http://code.google.com/p/er9x
 *   gruvin9x - http://code.google.com/p/gruvin9x
 *
 * License GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include <algorithm>
#include <vector>
#include "edgetx.h"
#include "hal/module_port.h"

extern uint8_t g_moduleIdx;

struct LuaScript {
  std::string filename;
  std::string label;
  bool operator<(const LuaScript &a) { return label < a.label; }
};

inline bool LuaScript_compare_nocase(LuaScript first, LuaScript second)
{
  return strcasecmp(first.label.c_str(), second.label.c_str()) < 0;
}

static LcdFlags dispTool(uint8_t index)
{
  int8_t sub = menuVerticalPosition - HEADER_LINE;
  LcdFlags attr = (sub == index ? INVERS : 0);
  coord_t y = MENU_HEADER_HEIGHT + (index - menuVerticalOffset) * FH;
  lcdDrawNumber(3, y, index + 1, LEADING0 | LEFT, 2);
  lcdDrawText(3 * FW, y, reusableBuffer.radioTools.script[index - menuVerticalOffset].label, attr);
  return attr;
}

static void displayRadioTool(uint8_t index)
{
  auto attr = dispTool(index);
  if (attr && s_editMode > 0) {
    s_editMode = 0;
    killAllEvents();
    if (reusableBuffer.radioTools.script[index - menuVerticalOffset].tool != nullptr) {
      g_moduleIdx = reusableBuffer.radioTools.script[index - menuVerticalOffset].module;
      pushMenu(reusableBuffer.radioTools.script[index - menuVerticalOffset].tool);
    }
    else if (reusableBuffer.radioTools.script[index - menuVerticalOffset].filename[0]) {
      f_chdir(SCRIPTS_TOOLS_PATH);
      char path[FF_MAX_LFN + 1] = SCRIPTS_TOOLS_PATH "/";
      strcat(path, reusableBuffer.radioTools.script[index - menuVerticalOffset].filename);
      luaExec(path);
    }
  }
}

static void addRadioTool(uint8_t index, const char * label)
{
  strAppend(reusableBuffer.radioTools.script[index - menuVerticalOffset].label, label, TOOL_NAME_MAX_LEN);
  auto attr = dispTool(index);
  if (attr && s_editMode > 0) {
    s_editMode = 0;
    killAllEvents();
  }
}

void addRadioModuleToolHandler(uint8_t index, const char * label, void (* tool)(event_t), uint8_t module)
{
  if (index >= menuVerticalOffset && index < menuVerticalOffset + NUM_BODY_LINES) {
    memclear(&reusableBuffer.radioTools.script[index - menuVerticalOffset], sizeof(reusableBuffer.radioTools.script[0]));
    reusableBuffer.radioTools.script[index - menuVerticalOffset].tool = tool;
    reusableBuffer.radioTools.script[index - menuVerticalOffset].module = module;
    addRadioTool(index, label);
  }
}

#if defined(LUA)
static void addRadioScriptToolHandler(std::vector<LuaScript> luaScripts)
{
  uint8_t index = 0;
  for (auto luaScript : luaScripts) {
    if (index >= menuVerticalOffset && index < menuVerticalOffset + NUM_BODY_LINES) {
      memclear(&reusableBuffer.radioTools.script[index - menuVerticalOffset], sizeof(reusableBuffer.radioTools.script[0]));
      strAppend(reusableBuffer.radioTools.script[index - menuVerticalOffset].filename, luaScript.filename.c_str(), TOOL_PATH_MAX_LEN);
      addRadioTool(index, luaScript.label.c_str());
    }
    index += 1;
  }
}
#endif

void menuRadioTools(event_t event)
{
  if (event == EVT_ENTRY  || event == EVT_ENTRY_UP) {
    memclear(&reusableBuffer.radioTools, sizeof(reusableBuffer.radioTools));
    reusableBuffer.radioTools.oldOffset = 0xFF;
#if defined(PXX2)
    for (uint8_t module = 0; module < NUM_MODULES; module++) {
      if (isModulePXX2(module) && (module == INTERNAL_MODULE ? modulePortPowered(INTERNAL_MODULE) : modulePortPowered(EXTERNAL_MODULE))) {
        moduleState[module].readModuleInformation(&reusableBuffer.radioTools.modules[module], PXX2_HW_INFO_TX_ID, PXX2_HW_INFO_TX_ID);
      }
    }
#endif
  }

  SIMPLE_MENU(STR_MENUTOOLS, menuTabGeneral, MENU_RADIO_TOOLS, HEADER_LINE + reusableBuffer.radioTools.linesCount);

  uint8_t index = 0;

  if (reusableBuffer.radioTools.oldOffset == menuVerticalOffset) {
    for(uint8_t line = 0; line < reusableBuffer.radioTools.linesCount; line++) {
      if (line >= menuVerticalOffset && line < menuVerticalOffset + NUM_BODY_LINES) {
        displayRadioTool(line);
      }
    }
    return;
  }

#if defined(LUA)
  FILINFO fno;
  DIR dir;

  FRESULT res = f_opendir(&dir, SCRIPTS_TOOLS_PATH);
  if (res == FR_OK) {
    std::vector<LuaScript> luaScripts;  // gather and sort before adding to menu

    for (;;) {
      res = f_readdir(&dir, &fno);                   /* Read a directory item */
      if (res != FR_OK || fno.fname[0] == 0) break;  /* Break on error or end of dir */
      if (fno.fattrib & (AM_HID|AM_SYS)) continue;  // skip hidden files and system files
      if (fno.fname[0] == '.') continue;  /* Ignore UNIX hidden files */

      bool inFolder = (fno.fattrib & AM_DIR);

      char path[FF_MAX_LFN + 1] = SCRIPTS_TOOLS_PATH "/";
      strcat(path, fno.fname);
      if (inFolder) {
        // check if .lua with same name exists - skip folder to avoid duplicate entries
        auto plen = strlen(path);
        strcat(path, ".lua");
        if (f_stat(path, nullptr) == FR_OK)
          continue;
        path[plen] = 0;
        strcat(path, "/main.lua");
        if (f_stat(path, nullptr) != FR_OK)
          continue;
      }

      if (isRadioScriptTool(path)) {
        const char *label;
        char toolName[RADIO_TOOL_NAME_MAXLEN + 1] = {0};
        if (readToolName(toolName, path)) {
          label = toolName;
        } else {
          if (!inFolder) {
            char *ext = (char *)getFileExtension(fno.fname);
            if (ext) *ext = '\0';
          }
          label = fno.fname;
        }

        luaScripts.emplace_back(LuaScript{path + DIM(SCRIPTS_TOOLS_PATH "/") - 1, label});
      }
    }
    f_closedir(&dir);

    std::sort(luaScripts.begin(), luaScripts.end(), LuaScript_compare_nocase);
    addRadioScriptToolHandler(luaScripts);
    index += luaScripts.size();
  }
#endif

#if defined(INTERNAL_MODULE_PXX2)
  if (isPXX2ModuleOptionAvailable(reusableBuffer.radioTools.modules[INTERNAL_MODULE].information.modelID, MODULE_OPTION_SPECTRUM_ANALYSER))
    addRadioModuleToolHandler(index++, STR_SPECTRUM_ANALYSER_INT, menuRadioSpectrumAnalyser, INTERNAL_MODULE);

  if (isPXX2ModuleOptionAvailable(reusableBuffer.radioTools.modules[INTERNAL_MODULE].information.modelID, MODULE_OPTION_POWER_METER))
    addRadioModuleToolHandler(index++, STR_POWER_METER_INT, menuRadioPowerMeter, INTERNAL_MODULE);
#endif

#if defined(HARDWARE_INTERNAL_MODULE) && defined(MULTIMODULE)
  if (g_eeGeneral.internalModule == MODULE_TYPE_MULTIMODULE)
    addRadioModuleToolHandler(index++, STR_SPECTRUM_ANALYSER_INT, menuRadioSpectrumAnalyser, INTERNAL_MODULE);
#endif

#if defined(HARDWARE_EXTERNAL_MODULE)

#if (defined(PXX2) || defined(MULTIMODULE))
  bool has_spectrum_analyser = false;
#if defined(PXX2)
  if (isPXX2ModuleOptionAvailable(reusableBuffer.radioTools.modules[EXTERNAL_MODULE].information.modelID, MODULE_OPTION_SPECTRUM_ANALYSER))
    has_spectrum_analyser = true;
#endif
#if defined(MULTIMODULE)
  if (isModuleMultimodule(EXTERNAL_MODULE))
    has_spectrum_analyser = true;
#endif
  if (has_spectrum_analyser)
    addRadioModuleToolHandler(index++, STR_SPECTRUM_ANALYSER_EXT, menuRadioSpectrumAnalyser, EXTERNAL_MODULE);
#endif
#if defined(PXX2)
  if (isPXX2ModuleOptionAvailable(reusableBuffer.radioTools.modules[EXTERNAL_MODULE].information.modelID, MODULE_OPTION_POWER_METER))
    addRadioModuleToolHandler(index++, STR_POWER_METER_EXT, menuRadioPowerMeter, EXTERNAL_MODULE);
#endif

#if defined(GHOST)
  if (isModuleGhost(EXTERNAL_MODULE))
    addRadioModuleToolHandler(index++, "Ghost Menu", menuGhostModuleConfig, EXTERNAL_MODULE);
#endif

#endif

  if (index == 0) {
    lcdDrawCenteredText(LCD_H/2, STR_NO_TOOLS);
  }

  reusableBuffer.radioTools.linesCount = index;
  reusableBuffer.radioTools.oldOffset = menuVerticalOffset;
}