From c085e9294f096ebcfe3e02f1c9a99959f66ba1a2 Mon Sep 17 00:00:00 2001 From: jebes Date: Tue, 9 Sep 2014 20:18:23 -0400 Subject: [PATCH] commented util.h --- .gitignore | 16 +++++++ src/common/util.cpp | 8 ++-- src/common/util.h | 45 ++++++++++++++++-- src/daemon/daemon.cpp | 69 ++++++++++++++-------------- src/daemon/daemon_commands_handler.h | 8 +++- 5 files changed, 102 insertions(+), 44 deletions(-) diff --git a/.gitignore b/.gitignore index 527864624..4f8766a43 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,23 @@ .DS_Store +/doc /build /tags # vim swap files *.swp *.swo +TAGS +!TAGS/ +tags +!tags/ +gtags.files +GTAGS +GRTAGS +GPATH +cscope.files +cscope.out +cscope.in.out +cscope.po.out + + + diff --git a/src/common/util.cpp b/src/common/util.cpp index e5276d1e4..d2ff90679 100644 --- a/src/common/util.cpp +++ b/src/common/util.cpp @@ -313,17 +313,19 @@ std::string get_nix_version_display_string() return ""; } #endif - + std::string get_default_data_dir() { - //namespace fs = boost::filesystem; + /* Please for the love of god refactor the ifdefs out of this */ + + // namespace fs = boost::filesystem; // Windows < Vista: C:\Documents and Settings\Username\Application Data\CRYPTONOTE_NAME // Windows >= Vista: C:\Users\Username\AppData\Roaming\CRYPTONOTE_NAME // Mac: ~/Library/Application Support/CRYPTONOTE_NAME // Unix: ~/.CRYPTONOTE_NAME std::string config_folder; + #ifdef WIN32 - // Windows config_folder = get_special_folder_path(CSIDL_APPDATA, true) + "/" + CRYPTONOTE_NAME; #else std::string pathRet; diff --git a/src/common/util.h b/src/common/util.h index 92ce7177a..876673d0a 100644 --- a/src/common/util.h +++ b/src/common/util.h @@ -39,11 +39,41 @@ #include "misc_language.h" #include "p2p/p2p_protocol_defs.h" +/*! \brief Various Tools + * + * + * + */ namespace tools { + /*! \brief Returns the default data directory. + * + * \details Windows < Vista: C:\\Documents and Settings\\Username\\Application Data\\CRYPTONOTE_NAME + * + * Windows >= Vista: C:\\Users\\Username\\AppData\\Roaming\\CRYPTONOTE_NAME + * + * Mac: ~/Library/Application Support/CRYPTONOTE_NAME + * + * Unix: ~/.CRYPTONOTE_NAME + */ std::string get_default_data_dir(); + + /*! \breif Returns the OS version string + * + * \details This is a wrapper around the primitives + * get_windows_version_display_string() and + * get_nix_version_display_string() + */ std::string get_os_version_string(); + + /*! \breif creates directories for a path + * + * wrapper around boost::filesyste::create_directories. + * (ensure-directory-exists): greenspun's tenth rule in action! + */ bool create_directories_if_necessary(const std::string& path); + /*! \brief std::rename wrapper for nix and something strange for windows. + */ std::error_code replace_file(const std::string& replacement_name, const std::string& replaced_name); inline crypto::hash get_proof_of_trust_hash(const nodetool::proof_of_trust& pot) @@ -54,10 +84,12 @@ namespace tools return crypto::cn_fast_hash(s.data(), s.size()); } - + /*! \breif Defines a signal handler for win32 and *nix + */ class signal_handler { public: + /*! \brief installs a signal handler */ template static bool install(T t) { @@ -69,6 +101,7 @@ namespace tools } return r; #else + /* Only blocks SIGINT and SIGTERM */ signal(SIGINT, posix_handler); signal(SIGTERM, posix_handler); m_handler = t; @@ -78,12 +111,12 @@ namespace tools private: #if defined(WIN32) + /*! \breif Handler for win */ static BOOL WINAPI win_handler(DWORD type) { if (CTRL_C_EVENT == type || CTRL_BREAK_EVENT == type) { handle_signal(); - return TRUE; } else { @@ -93,20 +126,22 @@ namespace tools return TRUE; } #else + /*! \breif handler for NIX */ static void posix_handler(int /*type*/) { handle_signal(); } #endif + /*! \breif calles m_handler */ static void handle_signal() { - static std::mutex m_mutex; - std::unique_lock lock(m_mutex); + /* static std::mutex m_mutex; */ + /* std::unique_lock lock(m_mutex); */ m_handler(); } - private: + /*! \breif where the installed handler is stored */ static std::function m_handler; }; } diff --git a/src/daemon/daemon.cpp b/src/daemon/daemon.cpp index 3462227dc..55c6bffef 100644 --- a/src/daemon/daemon.cpp +++ b/src/daemon/daemon.cpp @@ -29,7 +29,7 @@ // Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers // node.cpp : Defines the entry point for the console application. -// +// Does this file exist? #include "include_base_utils.h" @@ -64,11 +64,42 @@ namespace const command_line::arg_descriptor arg_console = {"no-console", "Disable daemon console commands"}; } -bool command_line_preprocessor(const boost::program_options::variables_map& vm); +bool command_line_preprocessor(const boost::program_options::variables_map& vm) +{ + bool exit = false; + if (command_line::get_arg(vm, command_line::arg_version)) + { + std::cout << CRYPTONOTE_NAME << " v" << PROJECT_VERSION_LONG << ENDL; + exit = true; + } + if (command_line::get_arg(vm, arg_os_version)) + { + std::cout << "OS: " << tools::get_os_version_string() << ENDL; + exit = true; + } + + if (exit) + { + return true; + } + + int new_log_level = command_line::get_arg(vm, arg_log_level); + if(new_log_level < LOG_LEVEL_MIN || new_log_level > LOG_LEVEL_MAX) + { + LOG_PRINT_L0("Wrong log level value: "); + } + else if (log_space::get_set_log_detalisation_level(false) != new_log_level) + { + log_space::get_set_log_detalisation_level(true, new_log_level); + LOG_PRINT_L0("LOG_LEVEL set to " << new_log_level); + } + + return false; +} int main(int argc, char* argv[]) { - + string_tools::set_module_name_and_folder(argv[0]); #ifdef WIN32 _CrtSetDbgFlag ( _CRTDBG_ALLOC_MEM_DF | _CRTDBG_LEAK_CHECK_DF ); @@ -235,35 +266,3 @@ int main(int argc, char* argv[]) CATCH_ENTRY_L0("main", 1); } -bool command_line_preprocessor(const boost::program_options::variables_map& vm) -{ - bool exit = false; - if (command_line::get_arg(vm, command_line::arg_version)) - { - std::cout << CRYPTONOTE_NAME << " v" << PROJECT_VERSION_LONG << ENDL; - exit = true; - } - if (command_line::get_arg(vm, arg_os_version)) - { - std::cout << "OS: " << tools::get_os_version_string() << ENDL; - exit = true; - } - - if (exit) - { - return true; - } - - int new_log_level = command_line::get_arg(vm, arg_log_level); - if(new_log_level < LOG_LEVEL_MIN || new_log_level > LOG_LEVEL_MAX) - { - LOG_PRINT_L0("Wrong log level value: "); - } - else if (log_space::get_set_log_detalisation_level(false) != new_log_level) - { - log_space::get_set_log_detalisation_level(true, new_log_level); - LOG_PRINT_L0("LOG_LEVEL set to " << new_log_level); - } - - return false; -} diff --git a/src/daemon/daemon_commands_handler.h b/src/daemon/daemon_commands_handler.h index 165cded21..6b6e46e83 100644 --- a/src/daemon/daemon_commands_handler.h +++ b/src/daemon/daemon_commands_handler.h @@ -28,6 +28,8 @@ // // Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers + +/* This isn't a header file, may want to refactor this... */ #pragma once #include @@ -39,7 +41,11 @@ #include "crypto/hash.h" #include "version.h" - +/*! + * \brief I don't really know right now + * + * + */ class daemon_cmmands_handler { nodetool::node_server >& m_srv;