Clean up of app.h

app.h, generated from app.h_in, has unnecessary code duplication
and isn't a header file (it defines globals, static functions
and doesn't have a header guard, moreover, it has a 'using namespace
std;'). Because of this, a real headerfile that declares the stuff
defined in apps.h was missing leading to even more code duplication:
scattered forward declarations in .cpp files and an often repeated
type of std::map<std::string, px4_main_t>.

This patch moves cmake/qurt/apps.h_in to src/platforms/apps.cpp.in
(with some changes) and removes cmake/posix/apps.h_in.
Then src/platforms/apps.cpp.in is split into src/platforms/apps.cpp.in
and src/platforms/apps.h.in, splitting declarations from definitions.

A typedef is defined for the map (apps_map_type).

The main difference between cmake/posix/apps.h_in and
cmake/qurt/apps.h_in was that the first defined a global 'apps',
while qurt stores the apps in QShell. I opted to get rid of
the global variable (which are in general evil for various reasons)
and used the API of cmake/qurt/apps.h_in where a provided 'apps'
map is initialized with a call to init_app_map. Thus removing
the existing code duplication.
This commit is contained in:
Carlo Wood 2016-10-21 15:54:48 +02:00 committed by Julian Oes
parent c200ef88ed
commit 6fc30c76a6
12 changed files with 143 additions and 209 deletions

View File

@ -1,88 +0,0 @@
/* builtin command list - automatically generated, do not edit */
#include <string>
#include <map>
#include <stdio.h>
#include <px4_tasks.h>
#include <px4_posix.h>
#include <px4_log.h>
#include <stdlib.h>
using namespace std;
extern void px4_show_devices(void);
extern "C" {
${builtin_apps_decl_string}
static int shutdown_main(int argc, char *argv[]);
static int list_tasks_main(int argc, char *argv[]);
static int list_files_main(int argc, char *argv[]);
static int list_devices_main(int argc, char *argv[]);
static int list_topics_main(int argc, char *argv[]);
static int sleep_main(int argc, char *argv[]);
}
static map<string,px4_main_t> app_map(void)
{
static map<string,px4_main_t> apps;
${builtin_apps_string}
apps["shutdown"] = shutdown_main;
apps["list_tasks"] = list_tasks_main;
apps["list_files"] = list_files_main;
apps["list_devices"] = list_devices_main;
apps["list_topics"] = list_topics_main;
apps["sleep"] = sleep_main;
return apps;
}
map<string,px4_main_t> apps = app_map();
static void list_builtins(void)
{
cout << "Builtin Commands:" << endl;
for (map<string,px4_main_t>::iterator it=apps.begin(); it!=apps.end(); ++it)
cout << '\t' << it->first << endl;
}
static int shutdown_main(int argc, char *argv[])
{
printf("Shutting down\n");
exit(0);
}
static int list_tasks_main(int argc, char *argv[])
{
px4_show_tasks();
return 0;
}
static int list_devices_main(int argc, char *argv[])
{
px4_show_devices();
return 0;
}
static int list_topics_main(int argc, char *argv[])
{
px4_show_topics();
return 0;
}
static int list_files_main(int argc, char *argv[])
{
px4_show_files();
return 0;
}
static int sleep_main(int argc, char *argv[])
{
if (argc != 2) {
cout << "Usage: sleep <seconds>" << endl;
return 1;
}
sleep(atoi(argv[1]));
return 0;
}

View File

@ -66,7 +66,7 @@ list(APPEND CMAKE_MODULE_PATH ${PX4_SOURCE_DIR}/cmake/posix)
# MODULE_LIST : list of modules
#
# Output:
# OUT : generated builtin_commands.c src
# OUT : stem of generated apps.cpp/apps.h ("apps")
#
# Example:
# px4_posix_generate_builtin_commands(
@ -97,12 +97,14 @@ function(px4_posix_generate_builtin_commands)
set(builtin_apps_string
"${builtin_apps_string}\tapps[\"${MAIN}\"] = ${MAIN}_main;\n")
set(builtin_apps_decl_string
"${builtin_apps_decl_string}extern int ${MAIN}_main(int argc, char *argv[]);\n")
"${builtin_apps_decl_string}int ${MAIN}_main(int argc, char *argv[]);\n")
math(EXPR command_count "${command_count}+1")
endif()
endforeach()
configure_file(${PX4_SOURCE_DIR}/cmake/posix/apps.h_in
${OUT})
configure_file(${PX4_SOURCE_DIR}/src/platforms/apps.cpp.in
${OUT}.cpp)
configure_file(${PX4_SOURCE_DIR}/src/platforms/apps.h.in
${OUT}.h)
endfunction()
#=============================================================================

View File

@ -1,84 +0,0 @@
/* builtin command list - automatically generated, do not edit */
#include <string>
#include <map>
#include <stdio.h>
#include <px4_tasks.h>
#include <px4_posix.h>
#include <px4_log.h>
#include <stdlib.h>
using namespace std;
extern void px4_show_devices(void);
extern "C" {
${builtin_apps_decl_string}
static int shutdown_main(int argc, char *argv[]);
static int list_tasks_main(int argc, char *argv[]);
static int list_files_main(int argc, char *argv[]);
static int list_devices_main(int argc, char *argv[]);
static int list_topics_main(int argc, char *argv[]);
static int sleep_main(int argc, char *argv[]);
}
void init_app_map(map<string,px4_main_t> &apps)
{
${builtin_apps_string}
apps["shutdown"] = shutdown_main;
apps["list_tasks"] = list_tasks_main;
apps["list_files"] = list_files_main;
apps["list_devices"] = list_devices_main;
apps["list_topics"] = list_topics_main;
apps["sleep"] = sleep_main;
}
void list_builtins(map<string,px4_main_t> &apps)
{
PX4_INFO("Builtin Commands:\\n");
for (map<string,px4_main_t>::iterator it=apps.begin(); it!=apps.end(); ++it)
PX4_INFO("%s : 0x%x\n", (it->first).c_str(), it->second);
}
static int shutdown_main(int argc, char *argv[])
{
printf("Shutting down\\n");
exit(0);
}
static int list_tasks_main(int argc, char *argv[])
{
px4_show_tasks();
return 0;
}
static int list_devices_main(int argc, char *argv[])
{
px4_show_devices();
return 0;
}
static int list_topics_main(int argc, char *argv[])
{
px4_show_topics();
return 0;
}
static int list_files_main(int argc, char *argv[])
{
px4_show_files();
return 0;
}
static int sleep_main(int argc, char *argv[])
{
if (argc != 2) {
PX4_WARN( "Usage: sleep <seconds>" );
return 1;
}
unsigned long usecs = ( (unsigned long) atol( argv[1] ) ) * 1000 * 1000;
PX4_WARN("Sleeping for %s, %ld",argv[1],usecs);
usleep( usecs );
return 0;
}

View File

@ -67,7 +67,7 @@ list(APPEND CMAKE_MODULE_PATH ${PX4_SOURCE_DIR}/cmake/qurt)
# MODULE_LIST : list of modules
#
# Output:
# OUT : generated builtin_commands.c src
# OUT : stem of generated apps.cpp/apps.h ("apps").
#
# Example:
# px4_qurt_generate_builtin_commands(
@ -91,11 +91,14 @@ function(px4_qurt_generate_builtin_commands)
set(builtin_apps_string
"${builtin_apps_string}\tapps[\"${MAIN}\"] = ${MAIN}_main;\n")
set(builtin_apps_decl_string
"${builtin_apps_decl_string}extern int ${MAIN}_main(int argc, char *argv[]);\n")
"${builtin_apps_decl_string}int ${MAIN}_main(int argc, char *argv[]);\n")
math(EXPR command_count "${command_count}+1")
endif()
endforeach()
configure_file(${PX4_SOURCE_DIR}/cmake/qurt/apps.h_in ${OUT})
configure_file(${PX4_SOURCE_DIR}/src/platforms/apps.cpp.in
${OUT}.cpp)
configure_file(${PX4_SOURCE_DIR}/src/platforms/apps.h.in
${OUT}.h)
endfunction()
#=============================================================================

View File

@ -41,7 +41,6 @@
#include "qshell.h"
#include <px4_log.h>
#include <px4_tasks.h>
#include <px4_time.h>
#include <px4_posix.h>
#include <px4_middleware.h>
@ -63,17 +62,11 @@
#define MAX_ARGS 8 // max number of whitespace separated args after app name
extern void init_app_map(std::map<std::string, px4_main_t> &apps);
extern void list_builtins(std::map<std::string, px4_main_t> &apps);
using std::map;
using std::string;
px4::AppState QShell::appState;
QShell::QShell()
{
init_app_map(apps);
init_app_map(m_apps);
}
int QShell::main()
@ -150,12 +143,12 @@ int QShell::run_cmd(const std::vector<std::string> &appargs)
std::string command = appargs[0];
if (command.compare("help") == 0) {
list_builtins(apps);
list_builtins(m_apps);
return 0;
}
//replaces app.find with iterator code to avoid null pointer exception
for (map<string, px4_main_t>::iterator it = apps.begin(); it != apps.end(); ++it) {
for (apps_map_type::iterator it = m_apps.begin(); it != m_apps.end(); ++it) {
if (it->first == command) {
// one for command name, one for null terminator
const char *arg[MAX_ARGS + 2];
@ -176,11 +169,11 @@ int QShell::run_cmd(const std::vector<std::string> &appargs)
arg[i] = (char *)0;
//PX4_DEBUG_PRINTF(i);
if (apps[command] == NULL) {
if (m_apps[command] == NULL) {
PX4_ERR("Null function !!\n");
} else {
return apps[command](i, (char **)arg);
return m_apps[command](i, (char **)arg);
}
}

View File

@ -41,11 +41,10 @@
#pragma once
#include <px4_app.h>
#include <px4_defines.h>
#include <map>
#include <string>
#include <vector>
#include "uORB/topics/qshell_req.h"
#include "apps.h"
class QShell
{
@ -61,6 +60,6 @@ public:
private:
struct qshell_req_s m_qshell_req;
std::map<std::string, px4_main_t> apps;
apps_map_type m_apps;
};

View File

@ -1,7 +1,7 @@
include_directories(${CMAKE_CURRENT_BINARY_DIR})
px4_posix_generate_builtin_commands(
OUT apps.h
OUT apps
MODULE_LIST ${module_libraries})
if ("${BOARD}" STREQUAL "eagle" OR ("${BOARD}" STREQUAL "excelsior"))
@ -19,7 +19,7 @@ if ("${BOARD}" STREQUAL "eagle" OR ("${BOARD}" STREQUAL "excelsior"))
SOURCES
px4muorb_stub.c
${PX4_SOURCE_DIR}/src/platforms/posix/main.cpp
apps.h
apps.cpp
LINK_LIBS
-Wl,--start-group
${module_libraries}
@ -41,7 +41,7 @@ elseif ("${BOARD}" STREQUAL "rpi")
px4_add_executable(px4
${PX4_SOURCE_DIR}/src/platforms/posix/main.cpp
apps.h
apps.cpp
)
target_link_libraries(px4
@ -68,7 +68,7 @@ elseif ("${BOARD}" STREQUAL "bebop")
px4_add_executable(px4
${PX4_SOURCE_DIR}/src/platforms/posix/main.cpp
apps.h
apps.cpp
)
if (NOT APPLE)
@ -98,7 +98,7 @@ else()
px4_add_executable(px4
${PX4_SOURCE_DIR}/src/platforms/posix/main.cpp
apps.h
apps.cpp
)
if (NOT APPLE)

View File

@ -9,7 +9,7 @@ include_directories(${CMAKE_CURRENT_BINARY_DIR})
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-missing-prototypes")
px4_qurt_generate_builtin_commands(
OUT ${PX4_BINARY_DIR}/apps.h
OUT ${PX4_BINARY_DIR}/apps
MODULE_LIST ${module_libraries})
FASTRPC_STUB_GEN(px4muorb.idl)
@ -23,7 +23,7 @@ if ("${QURT_ENABLE_STUBS}" STREQUAL "1")
)
add_executable(px4
${PX4_BINARY_DIR}/src/firmware/qurt/px4muorb_skel.c
${PX4_BINARY_DIR}/apps.h)
${PX4_BINARY_DIR}/apps.cpp)
target_link_libraries(px4
-Wl,--start-group
@ -42,7 +42,7 @@ else()
QURT_LIB(LIB_NAME px4
IDL_NAME px4muorb
SOURCES
${PX4_BINARY_DIR}/apps.h
${PX4_BINARY_DIR}/apps.cpp
LINK_LIBS
${module_libraries}
${target_libraries}

74
src/platforms/apps.cpp.in Normal file
View File

@ -0,0 +1,74 @@
/* definitions of builtin command list - automatically generated, do not edit */
#include "px4_posix.h"
#include "px4_log.h"
#include "apps.h"
#include <iostream>
#include <map>
#include <string>
#include <cstdlib>
extern void px4_show_devices(void);
void init_app_map(apps_map_type &apps)
{
${builtin_apps_string}
apps["shutdown"] = shutdown_main;
apps["list_tasks"] = list_tasks_main;
apps["list_files"] = list_files_main;
apps["list_devices"] = list_devices_main;
apps["list_topics"] = list_topics_main;
apps["sleep"] = sleep_main;
}
void list_builtins(apps_map_type &apps)
{
PX4_INFO("Builtin Commands:\n");
for (apps_map_type::iterator it = apps.begin(); it != apps.end(); ++it)
PX4_INFO("%s : 0x%x\n", it->first.c_str(), it->second);
}
int shutdown_main(int argc, char *argv[])
{
std::cout << "Shutting down" << std::endl;
exit(0);
}
int list_tasks_main(int argc, char *argv[])
{
px4_show_tasks();
return 0;
}
int list_devices_main(int argc, char *argv[])
{
px4_show_devices();
return 0;
}
int list_topics_main(int argc, char *argv[])
{
px4_show_topics();
return 0;
}
int list_files_main(int argc, char *argv[])
{
px4_show_files();
return 0;
}
int sleep_main(int argc, char *argv[])
{
if (argc != 2) {
PX4_WARN( "Usage: sleep <seconds>" );
return 1;
}
unsigned long usecs = 1000000UL * atol(argv[1]);
std::cout << "Sleeping for " << argv[1] << " s; (" << usecs << " us)." << std::endl;
usleep(usecs);
return 0;
}

27
src/platforms/apps.h.in Normal file
View File

@ -0,0 +1,27 @@
/* declarations of builtin command list - automatically generated, do not edit */
#pragma once
#include "px4_tasks.h" // px4_main_t
#include <map>
extern "C" {
${builtin_apps_decl_string}
int shutdown_main(int argc, char *argv[]);
int list_tasks_main(int argc, char *argv[]);
int list_files_main(int argc, char *argv[]);
int list_devices_main(int argc, char *argv[]);
int list_topics_main(int argc, char *argv[]);
int sleep_main(int argc, char *argv[]);
}
// Maps an app name to it's function.
typedef std::map<std::string, px4_main_t> apps_map_type;
// Initialize an apps map.
void init_app_map(apps_map_type &apps);
// List an apps map.
void list_builtins(apps_map_type &apps);

View File

@ -48,6 +48,8 @@
#include <stdio.h>
#include "apps.h"
#include "px4_middleware.h"
#include "px4_posix.h"
#include "px4_log.h"
#include "DriverFramework.hpp"
#include <termios.h>
#include <sys/stat.h>
@ -191,6 +193,14 @@ static void print_prompt()
static void run_cmd(const vector<string> &appargs, bool exit_on_fail, bool silently_fail = false)
{
static apps_map_type apps;
static bool initialized = false;
if (!initialized) {
init_app_map(apps);
initialized = true;
}
// command is appargs[0]
string command = appargs[0];
@ -217,7 +227,7 @@ static void run_cmd(const vector<string> &appargs, bool exit_on_fail, bool silen
}
} else if (command.compare("help") == 0) {
list_builtins();
list_builtins(apps);
} else if (command.length() == 0 || command[0] == '#') {
// Do nothing

View File

@ -55,8 +55,6 @@
using namespace std;
extern void init_app_map(map<string, px4_main_t> &apps);
extern void list_builtins(map<string, px4_main_t> &apps);
static px4_task_t g_dspal_task = -1;
__BEGIN_DECLS
@ -70,13 +68,13 @@ void qurt_external_hook(void)
{
}
static void run_cmd(map<string, px4_main_t> &apps, const vector<string> &appargs)
static void run_cmd(apps_map_type &apps, const vector<string> &appargs)
{
// command is appargs[0]
string command = appargs[0];
//replaces app.find with iterator code to avoid null pointer exception
for (map<string, px4_main_t>::iterator it = apps.begin(); it != apps.end(); ++it)
for (apps_map_type::iterator it = apps.begin(); it != apps.end(); ++it)
if (it->first == command) {
// one for command name, one for null terminator
const char *arg[MAX_ARGS + 2];
@ -117,7 +115,7 @@ void eat_whitespace(const char *&b, int &i)
i = 0;
}
static void process_commands(map<string, px4_main_t> &apps, const char *cmds)
static void process_commands(apps_map_type &apps, const char *cmds)
{
vector<string> appargs;
int i = 0;
@ -220,7 +218,7 @@ const char *get_commands()
int dspal_entry(int argc, char *argv[])
{
PX4_INFO("In dspal_entry");
map<string, px4_main_t> apps;
apps_map_type apps;
init_app_map(apps);
DriverFramework::Framework::initialize();
px4::init_once();