Add some documentation for the CMakeLists instructions

Author: NlightNFotis

cpp_api/CMakeLists.txt

@@ -1,10 +1,9 @@
-
-
+# This step builds a binary driving the API (to be used for testing)
 add_executable(api_bin call_bmc.cpp api.cpp)
+target_link_libraries(bmc_api goto-programs util langapi ansi-c)
 
+# This step builds the API in the form of a statically linked library (libbmc_api.a)
 add_library(bmc_api api.cpp)
-
-target_link_libraries(bmc_api goto-programs util langapi ansi-c)
 target_link_libraries(api_bin goto-programs util langapi ansi-c)
 
 install(TARGETS bmc_api RUNTIME DESTINATION lib)

cpp_api/api.cpp

@@ -14,7 +14,7 @@
 api_depst api_deps;
 extern configt config;
 
-void initialize_api() {
+void initialize() {
     // Initialise a null-message handler (we don't print anything in the API)
     api_deps.msg_handler = new null_message_handlert();
     // Initialise default options

cpp_api/api.h

@@ -13,7 +13,7 @@ struct api_depst {
 };
 
 /// Initialise API dependencies
-void initialize_api();
+void initialize();
 
 /// Load a goto_model from a given vector of filenames.
 /// \param files: A vector<string> containing the filenames to be loaded

cpp_api/call_bmc.cpp

@@ -25,14 +25,8 @@ int main(int argc, char *argv[])
         // Convert argv to vector of strings for initialize_goto_model
         std::vector<std::string> arguments(argv + 1, argv + argc);
 
-        // Needed to initialise the language options correctly
-        cmdlinet cmdline;
-
-        // config is global in config.cpp
-        config.set(cmdline);
-
-        // Initialise C language mode
-        register_language(new_ansi_c_language);
+        // Initialise API dependencies and global configuration in one step.
+        initialize();
 
         auto model = load_model_from_files(arguments, *api_deps.opts);