src/main.cpp

   1 /*\r
   2  * Copyright (C) 2015, 2016 "IoT.bzh"\r
   3  * Author "Loïc Collignon" <loic.collignon@iot.bzh>\r
   4  * Author "Romain Forlot" <romain.forlot@iot.bzh>\r
   5  *\r
   6  * Licensed under the Apache License, Version 2.0 (the "License");\r
   7  * you may not use this file except in compliance with the License.\r
   8  * You may obtain a copy of the License at\r
   9  *\r
  10  *       http://www.apache.org/licenses/LICENSE-2.0\r
  11  *\r
  12  * Unless required by applicable law or agreed to in writing, software\r
  13  * distributed under the License is distributed on an "AS IS" BASIS,\r
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  15  * See the License for the specific language governing permissions and\r
  16  * limitations under the License.\r
  17  */\r
  18 \r
  19 #include <unistd.h>\r
  20 #include <stdlib.h>\r
  21 #include <libgen.h>\r
  22 #include <exception>\r
  23 #include <fstream>\r
  24 #include <iostream>\r
  25 #include <string>\r
  26 #include <numeric>\r
  27 #include <iterator>\r
  28 #include <json.hpp>\r
  29 #include "openxc/message_set.hpp"\r
  30 \r
  31 #define EXIT_SUCCESS                            0\r
  32 #define EXIT_UNKNOWN_ERROR                      1\r
  33 #define EXIT_COMMAND_LINE_ERROR         2\r
  34 #define EXIT_PROGRAM_ERROR                      3\r
  35 \r
  36 template <typename T>\r
  37 struct generator\r
  38 {\r
  39         T v_;\r
  40         std::string line_prefix_;\r
  41         generator(T v, std::string line_prefix = "") : v_{v}, line_prefix_{line_prefix} {}\r
  42 };\r
  43 \r
  44 template <>\r
  45 struct generator<openxc::signal>\r
  46 {\r
  47         const openxc::signal& v_;\r
  48         std::uint32_t index_;\r
  49         std::string line_prefix_;\r
  50         generator(const openxc::signal& v, std::uint32_t index, std::string line_prefix = "")\r
  51                 : v_{v}, index_{index}, line_prefix_{line_prefix}\r
  52         {\r
  53         }\r
  54 };\r
  55 \r
  56 template <typename T>\r
  57 generator<T> gen(const T& v, std::string line_prefix = "") { return generator<T>(v, line_prefix); }\r
  58 \r
  59 generator<openxc::signal> gen(const openxc::signal& v, std::uint32_t index, std::string line_prefix = "")\r
  60 {\r
  61         return generator<openxc::signal>(v, index, line_prefix);\r
  62 }\r
  63 \r
  64 template <typename T>\r
  65 std::ostream& operator<<(std::ostream& o, const generator<T>& v)\r
  66 {\r
  67         o << v.line_prefix_ << v.v_;\r
  68         return o;\r
  69 }\r
  70 \r
  71 template <>\r
  72 std::ostream& operator<<(std::ostream& o, const generator<bool>& v)\r
  73 {\r
  74         o << v.line_prefix_ << (v.v_ ? "true" : "false");\r
  75         return o;\r
  76 }\r
  77 \r
  78 template <>\r
  79 std::ostream& operator<<(std::ostream& o, const generator<float>& v)\r
  80 {\r
  81         o << v.line_prefix_ << std::showpoint << v.v_ << "f";\r
  82         return o;\r
  83 }\r
  84 \r
  85 template <>\r
  86 std::ostream& operator<<(std::ostream& o, const generator<std::string>& v)\r
  87 {\r
  88         o << v.line_prefix_ << '\"' << v.v_ << '\"';\r
  89         return o;\r
  90 }\r
  91 \r
  92 template <typename T>\r
  93 std::ostream& operator<<(std::ostream& o, const generator<std::vector<T>>& v)\r
  94 {\r
  95 //      o << v.line_prefix_;\r
  96         auto sz = v.v_.size();\r
  97         for(const T& i : v.v_)\r
  98         {\r
  99                 o << gen(i, v.line_prefix_ + '\t');\r
 100                 if (sz > 1) o << ",";\r
 101                 --sz;\r
 102 //              o << '\n';\r
 103         }\r
 104 //      o << v.line_prefix_;\r
 105         return o;\r
 106 }\r
 107 \r
 108 template <>\r
 109 std::ostream& operator<<(std::ostream& o, const generator<openxc::message_set>& v)\r
 110 {\r
 111         o       << v.line_prefix_\r
 112                 << "{std::make_shared<message_set_t>(message_set_t{"\r
 113                 << "0,"\r
 114                 << gen(v.v_.name()) << ",\n"\r
 115                 << "\t\t\t{ // beginning message_definition_ vector\n"\r
 116                 << gen(v.v_.messages(), "\t\t\t")\r
 117                 << "\n\t\t}, // end message_definition vector\n"\r
 118                 << "\t\t\t{ // beginning diagnostic_messages_ vector\n"\r
 119                 << gen(v.v_.diagnostic_messages(),"\t\t\t") << "\n"\r
 120                 << "\t\t\t} // end diagnostic_messages_ vector\n"\r
 121                 << "\t\t})} // end message_set entry\n";\r
 122         return o;\r
 123 }\r
 124 \r
 125 template <>\r
 126 std::ostream& operator<<(std::ostream& o, const generator<std::map<std::string, std::vector<std::uint32_t>>>& v)\r
 127 {\r
 128         o << v.line_prefix_ << "{\n";\r
 129         std::uint32_t c1 = (uint32_t)v.v_.size();\r
 130         for(const auto& state : v.v_)\r
 131         {\r
 132                 std::uint32_t c2 = (uint32_t)state.second.size();\r
 133                 for(const auto& i : state.second)\r
 134                 {\r
 135                         o << v.line_prefix_ << "\t" << "{" << i << "," << gen(state.first) << "}";\r
 136                         if (c1 > 1 || c2 > 1) o << ',';\r
 137                         o << '\n';\r
 138                         --c2;\r
 139                 }\r
 140                 --c1;\r
 141         }\r
 142         o << v.line_prefix_ << "}";\r
 143         return o;\r
 144 }\r
 145 \r
 146 template <>\r
 147 std::ostream& operator<<(std::ostream& o, const generator<openxc::signal>& v)\r
 148 {\r
 149         o       << v.line_prefix_ << "{std::make_shared<signal_t> (signal_t{\n"\r
 150                 << v.line_prefix_ << "\t" << gen(v.v_.generic_name()) << ",// generic_name\n"\r
 151                 << v.line_prefix_ << "\t" << v.v_.bit_position() << ",// bit_position\n"\r
 152                 << v.line_prefix_ << "\t" << v.v_.bit_size() << ",// bit_size\n"\r
 153                 << v.line_prefix_ << "\t" << gen(v.v_.factor()) << ",// factor\n"\r
 154                 << v.line_prefix_ << "\t" << v.v_.offset() << ",// offset\n"\r
 155                 << v.line_prefix_ << "\t" << "0,// min_value\n"\r
 156                 << v.line_prefix_ << "\t" << "0,// max_value\n"\r
 157                 << v.line_prefix_ << "\tfrequency_clock_t(" << gen(v.v_.max_frequency()) << "),// frequency\n"\r
 158                 << v.line_prefix_ << "\t" << gen(v.v_.send_same()) << ",// send_same\n"\r
 159                 << v.line_prefix_ << "\t" << gen(v.v_.force_send_changed()) << ",// force_send_changed\n"\r
 160                 << gen(v.v_.states(), v.line_prefix_ + '\t') << ",// states\n"\r
 161                 << v.line_prefix_ << '\t' << gen(v.v_.writable()) << ",// writable\n"\r
 162                 << v.line_prefix_ << '\t' << (v.v_.decoder().size() ? v.v_.decoder() : "nullptr") << ",// decoder\n"\r
 163                 << v.line_prefix_ << '\t' << (v.v_.encoder().size() ? v.v_.encoder() : "nullptr") << ",// encoder\n"\r
 164                 << v.line_prefix_ << '\t' << "false,// received\n";\r
 165                 std::string multi_first = "";\r
 166                 if(v.v_.multiplex().first){\r
 167                         multi_first = "true";\r
 168                 }else{\r
 169                         multi_first = "false";\r
 170                 }\r
 171                 std::string multi = "std::make_pair<bool, int>(" + multi_first + "," + std::to_string(v.v_.multiplex().second) + ")";\r
 172         o       << v.line_prefix_ << '\t' << multi << ",// multiplex\n"\r
 173                 << v.line_prefix_ << '\t' << v.v_.is_big_endian() << ",// is_big_endian\n"\r
 174                 << v.line_prefix_ << '\t' << v.v_.is_signed() << ",// is_signed\n"\r
 175                 << v.line_prefix_ << "\t" << gen(v.v_.unit()) << ",// unit\n"\r
 176                 << v.line_prefix_ << "})}";\r
 177         return o;\r
 178 }\r
 179 \r
 180 template <>\r
 181 std::ostream& operator<<(std::ostream& o, const generator<openxc::can_message>& v)\r
 182 {\r
 183         o       << v.line_prefix_\r
 184                 << "{std::make_shared<message_definition_t>(message_definition_t{"\r
 185                 << gen(v.v_.bus()) << ","\r
 186                 << v.v_.id() << ","\r
 187                 << "\"" << v.v_.name() << "\","\r
 188                 << v.v_.length() << ","\r
 189                 << v.v_.is_fd() << ",";\r
 190                 if(v.v_.is_j1939()){\r
 191                         o << "message_format_t::J1939,";\r
 192                 }else{\r
 193                         o << "message_format_t::STANDARD,";\r
 194                 }\r
 195         o       << "frequency_clock_t(" << gen(v.v_.max_frequency()) << "),"\r
 196                 << gen(v.v_.force_send_changed()) << ",";\r
 197                 std::uint32_t index = 0;\r
 198         o       << "\t\t\t\t\t{ // beginning signals vector\n";\r
 199                         std::uint32_t signal_count = (uint32_t)v.v_.signals().size();\r
 200                         for(const openxc::signal& s : v.v_.signals())\r
 201                         {\r
 202         o                       << gen(s, index,"\t\t\t\t\t\t");\r
 203                                 if (signal_count > 1) o << ',';\r
 204                                 --signal_count;\r
 205         o                       << '\n';\r
 206                         }\r
 207         o       << "\t\t\t\t\t} // end signals vector\n"\r
 208                 << "\t\t\t\t})} // end message_definition entry\n";\r
 209         return o;\r
 210 }\r
 211 \r
 212 template <>\r
 213 std::ostream& operator<<(std::ostream& o, const generator<openxc::diagnostic_message>& v)\r
 214 {\r
 215         o       << v.line_prefix_ << "{std::make_shared<diagnostic_message_t>(diagnostic_message_t{\n"\r
 216                 << v.line_prefix_ << "\t" << v.v_.pid() << ",\n"\r
 217                 << v.line_prefix_ << "\t" << gen(v.v_.name()) << ",\n"\r
 218                 << v.line_prefix_ << "\t" << 0 << ",\n"\r
 219                 << v.line_prefix_ << "\t" << 0 << ",\n"\r
 220                 << v.line_prefix_ << "\t" << "UNIT::INVALID" << ",\n"\r
 221                 << v.line_prefix_ << "\t" << gen(v.v_.frequency()) << ",\n"\r
 222                 << v.line_prefix_ << "\t" << (v.v_.decoder().size() ? v.v_.decoder() : "nullptr") << ",\n"\r
 223                 << v.line_prefix_ << "\t" << (v.v_.callback().size() ? v.v_.callback() : "nullptr") << ",\n"\r
 224                 << v.line_prefix_ << "\t" << "true" << ",\n"\r
 225                 << v.line_prefix_ << "\t" << "false" << "\n"\r
 226                 << v.line_prefix_ << "})}\n";\r
 227         return o;\r
 228 }\r
 229 \r
 230 /// @brief Generate the application code.\r
 231 /// @param[in] header Content to be inserted as a header.\r
 232 /// @param[in] footer Content to be inserted as a footer.\r
 233 /// @param[in] message_set application read from the json file.\r
 234 /// @param[in] out Stream to write on.\r
 235 void generate(const std::string& header, const std::string& footer, const openxc::message_set& message_set, std::ostream& out)\r
 236 {\r
 237         out << "#include \"application.hpp\"\n"\r
 238                 << "#include \"../can/can-decoder.hpp\"\n"\r
 239                 << "#include \"../can/can-encoder.hpp\"\n\n";\r
 240 \r
 241         if (header.size()) out << header << "\n";\r
 242 \r
 243         out     << "application_t::application_t()\n"\r
 244                 << "    : can_bus_manager_{utils::config_parser_t{\"/etc/dev-mapping.conf\"}}\n"\r
 245                 << "    , message_set_{\n"\r
 246                 << gen(message_set, "\t\t")\r
 247                 << "\t} // end message_set vector\n"\r
 248                 << "{\n"\r
 249                 << "    for(std::shared_ptr<message_set_t> cms: message_set_)\n"\r
 250                 << "    {\n"\r
 251                 << "            std::vector<std::shared_ptr<message_definition_t>> messages_definition = cms->get_messages_definition();\n"\r
 252                 << "            for(std::shared_ptr<message_definition_t> cmd : messages_definition)\n"\r
 253                 << "            {\n"\r
 254                 << "                    cmd->set_parent(cms);\n"\r
 255                 << "                    std::vector<std::shared_ptr<signal_t>> signals = cmd->get_signals();\n"\r
 256                 << "                    for(std::shared_ptr<signal_t> sig: signals)\n"\r
 257                 << "                    {\n"\r
 258                 << "                            sig->set_parent(cmd);\n"\r
 259                 << "                    }\n"\r
 260                 << "            }\n\n"\r
 261                 << "            std::vector<std::shared_ptr<diagnostic_message_t>> diagnostic_messages = cms->get_diagnostic_messages();\n"\r
 262                 << "            for(std::shared_ptr<diagnostic_message_t> dm : diagnostic_messages)\n"\r
 263                 << "            {\n"\r
 264                 << "                    dm->set_parent(cms);\n"\r
 265                 << "            }\n"\r
 266                 << "    }\n"\r
 267                 << "            }\n\n"\r
 268                 << "const std::string application_t::get_diagnostic_bus() const\n"\r
 269                 << "{\n";\r
 270 \r
 271                 std::string active_bus = "";\r
 272                 for (const auto& d : message_set.diagnostic_messages())\r
 273                 {\r
 274                         if (d.bus().size() == 0) std::cerr << "ERROR: The bus name should be set for each diagnostic message." << std::endl;\r
 275                         if (active_bus.size() == 0) active_bus = d.bus();\r
 276                         if (active_bus != d.bus()) std::cerr << "ERROR: The bus name should be the same for each diagnostic message." << std::endl;\r
 277                 }\r
 278 \r
 279         out     << "\treturn " << gen(active_bus) << ";\n"\r
 280                 << "}\n\n";\r
 281         out     << footer << std::endl;\r
 282 }\r
 283 \r
 284 /// @brief Read whole file content to a string.\r
 285 /// @param[in] file Path to the file.\r
 286 /// @return A std::string which contains the file content. If @c file is an empty string, the return value is also empty.\r
 287 /// @exception std::runtime_error Throw this exception if the specified file is not found or cannot be opened.\r
 288 std::string read_file(const std::string& file)\r
 289 {\r
 290         if(file.size() == 0) return std::string();\r
 291 \r
 292         std::string content;\r
 293         std::ifstream stream(file);\r
 294         if (stream)\r
 295         {\r
 296                 stream.seekg(0, std::ios::end);\r
 297                 content.reserve(stream.tellg());\r
 298                 stream.seekg(0, std::ios::beg);\r
 299                 content.assign((std::istreambuf_iterator<char>(stream)), std::istreambuf_iterator<char>());\r
 300                 return content;\r
 301         }\r
 302         std::stringstream ss;\r
 303         ss << "The specified file (" << file << ") is not found!";\r
 304         throw std::runtime_error(ss.str());\r
 305 }\r
 306 \r
 307 /// @brief Read whole file content as a json document.\r
 308 /// @param[in] file Path to the file.\r
 309 /// @return A @c nlohmann::json object.\r
 310 /// @exception std::runtime_error Throw this exception if the specified file is not found or cannot be opened.\r
 311 nlohmann::json read_json(const std::string& file)\r
 312 {\r
 313         std::ifstream stream(file);\r
 314         if (stream)\r
 315         {\r
 316                 nlohmann::json result;\r
 317                 stream >> result;\r
 318                 return result;\r
 319         }\r
 320         std::stringstream ss;\r
 321         ss << "The specified file (" << file << ") is not found!";\r
 322         throw std::runtime_error(ss.str());\r
 323 }\r
 324 \r
 325 // function that show the help information\r
 326 void showhelpinfo(char *s)\r
 327 {\r
 328 std::cout<<"Usage:   "<<s<<" <-m inpout.json> [-o application-generated.cpp]"<< std::endl;\r
 329 std::cout<<"option:  "<<"-m  input.json : JSON file describing CAN messages and signals"<< std::endl;\r
 330 std::cout<<"         "<<"-h header.cpp : header source file insert at the beginning of generated file"<< std::endl;\r
 331 std::cout<<"         "<<"-f footer.cpp : footer source file append to generated file."<< std::endl;\r
 332 std::cout<<"         "<<"-o application-generated.cpp : output source file. Name has to be application-generated.cpp"<< std::endl;\r
 333 }\r
 334 \r
 335 /// @brief Entry point.\r
 336 /// @param[in] argc Argument's count.\r
 337 /// @param[in] argv Argument's array.\r
 338 /// @return Exit code, zero if success.\r
 339 int main(int argc, char *argv[])\r
 340 {\r
 341         try\r
 342         {\r
 343                 std::string appName = argv[0];\r
 344                 std::string message_set_file;\r
 345                 std::string output_file;\r
 346                 std::string header_file;\r
 347                 std::string footer_file;\r
 348 \r
 349                 char tmp;\r
 350                 /*if the program is ran witout options ,it will show the usgage and exit*/\r
 351                 if(argc == 1)\r
 352                 {\r
 353                         showhelpinfo(argv[0]);\r
 354                         exit(1);\r
 355                 }\r
 356                 /*use function getopt to get the arguments with option."hu:p:s:v" indicate\r
 357                 that option h,v are the options without arguments while u,p,s are the\r
 358                 options with arguments*/\r
 359                 while((tmp=(char)getopt(argc,argv,"m:h:f:o:"))!=-1)\r
 360                 {\r
 361                         switch(tmp)\r
 362                         {\r
 363                         case 'h':\r
 364                                 header_file = optarg;\r
 365                                 break;\r
 366                         case 'f':\r
 367                                 footer_file = optarg;\r
 368                                 break;\r
 369                         case 'm':\r
 370                                 message_set_file = optarg;\r
 371                                 break;\r
 372                         case 'o':\r
 373                                 output_file = optarg;\r
 374                                 break;\r
 375                         default:\r
 376                                 showhelpinfo(argv[0]);\r
 377                         break;\r
 378                         }\r
 379                 }\r
 380 \r
 381                 std::stringstream header;\r
 382                 header << read_file(header_file);\r
 383 \r
 384                 std::string footer = read_file(footer_file);\r
 385                 openxc::message_set message_set;\r
 386                 message_set.from_json(read_json(message_set_file));\r
 387 \r
 388                 std::string message_set_path = dirname(strdup(message_set_file.c_str()));\r
 389                 for(const auto& s : message_set.extra_sources())\r
 390                 {\r
 391                         std::string extra_source = s;\r
 392                         extra_source = message_set_path + "/" + extra_source;\r
 393                         header << "\n// >>>>> " << s << " >>>>>\n" << read_file(extra_source) << "\n// <<<<< " << s << " <<<<<\n";\r
 394                 }\r
 395 \r
 396                 std::ofstream out;\r
 397                 if (output_file.size())\r
 398                 {\r
 399                         out.open(output_file);\r
 400                         if(!out)\r
 401                         {\r
 402                                 std::stringstream ss;\r
 403                                 ss << "Can't open the ouput file (" << output_file << ") for writing!";\r
 404                                 throw std::runtime_error(ss.str());\r
 405                         }\r
 406                 }\r
 407                 generate(header.str(), footer, message_set, output_file.size() ? out : std::cout);\r
 408         }\r
 409         catch (std::exception& e)\r
 410         {\r
 411                 std::cerr << "ERROR: Unhandled exception - " << e.what() << std::endl;\r
 412                 return EXIT_UNKNOWN_ERROR;\r
 413         }\r
 414         return EXIT_SUCCESS;\r
 415 }\r